From 3f50c42a6ec4dfc4ed48fa63c38fc9679f95e81c Mon Sep 17 00:00:00 2001 From: PlexSheep Date: Tue, 16 May 2023 15:54:24 +0200 Subject: [PATCH] structioning --- src/cplex/cli.rs | 135 +++++++++++++++++++++++++ src/{common_plex => cplex}/mod.rs | 2 +- src/{common_plex => cplex}/printing.rs | 19 ++-- src/lib.rs | 1 + src/main.rs | 53 +++++----- src/math/modred.rs | 10 +- 6 files changed, 182 insertions(+), 38 deletions(-) create mode 100644 src/cplex/cli.rs rename src/{common_plex => cplex}/mod.rs (92%) rename src/{common_plex => cplex}/printing.rs (75%) diff --git a/src/cplex/cli.rs b/src/cplex/cli.rs new file mode 100644 index 0000000..dd36ed5 --- /dev/null +++ b/src/cplex/cli.rs @@ -0,0 +1,135 @@ +/// This is just structures for parsing Cli args +#[derive(Parser, Debug, Clone)] +#[clap(name="plexcryptool", author="Christoph J. Scherr", version, about="Various tools for use with math and cryptology, includes executable and a library.")] +pub struct Cli { + /// Which submodule to use + #[command(subcommand)] + command: Commands, + + /// Machine output + #[arg(short, long, default_value_t = false, global = true)] + machine: bool, + + /// Verbose output + #[arg(short, long, default_value_t = false, global = true)] + verbose: bool, +} + +#[derive(Subcommand, Debug, Clone)] +pub enum Commands { + /// Use math functions + Math(MathCommand), + /// Use binary functions + Binary(BinaryCommand), + /// Use custom algorithms + Algo(AlgoCommand), +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct MathCommand { + #[command(subcommand)] + action: MathActions +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct BinaryCommand { + #[command(subcommand)] + action: BinaryActions +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct AlgoCommand { + #[command(subcommand)] + action: AlgoActions +} + +#[derive(Subcommand, Clone, Debug, PartialEq, Eq)] +pub enum MathActions { + #[command(name="modexp")] + Modexp(ModexpArgs), + Modred(ModredArgs), + Pm1(PM1Args), +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct ModexpArgs { + base: String, + exp: String, + field: String +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct ModredArgs { + #[clap(value_parser=maybe_hex::)] + polynomial: u64, + #[clap(value_parser=maybe_hex::)] + relation: u64, +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct PM1Args { + #[clap(value_parser=maybe_hex::)] + n: u128, + #[clap(value_parser=maybe_hex::)] + max_prime: u128, +} + +#[derive(Subcommand, Clone, Debug, PartialEq, Eq)] +pub enum BinaryActions { + /// bit rotation/circular shifting (only 32bit) + #[command(name="rotate")] + Rotate(RotateArgs), + Xor(XorArgs) +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct RotateArgs { + #[arg(short, long, default_value_t = false)] + left: bool, + #[clap(value_parser=maybe_hex::)] + base: u32, + #[clap(value_parser=maybe_hex::)] + shift_width: u32, +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct XorArgs { + #[clap(value_parser=maybe_hex::)] + a: u128, + #[clap(value_parser=maybe_hex::)] + b: u128, +} + +#[derive(Subcommand, Clone, Debug, PartialEq, Eq)] +pub enum AlgoActions { + #[command(name="feistel0-i")] + Feistel0Inner(Feistel0InnerArgs), + #[command(name="feistel0-sbox")] + Feistel0SBOX(Feistel0SBOXArgs), + #[command(name="feistel0")] + Feistel0(Feistel0Args) +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct Feistel0InnerArgs { + #[clap(value_parser=maybe_hex::)] + input: u16, + #[clap(value_parser=maybe_hex::)] + key: u16, +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct Feistel0SBOXArgs { + #[clap(value_parser=maybe_hex::)] + index: u8, +} + +#[derive(Args, Clone, Debug, PartialEq, Eq)] +pub struct Feistel0Args{ + #[clap(value_parser=maybe_hex::)] + input: u32, + #[clap(value_parser=maybe_hex::)] + key: u32, + #[arg(short, long, default_value_t = false)] + decrypt: bool, +} diff --git a/src/common_plex/mod.rs b/src/cplex/mod.rs similarity index 92% rename from src/common_plex/mod.rs rename to src/cplex/mod.rs index 68f6893..d5b6239 100644 --- a/src/common_plex/mod.rs +++ b/src/cplex/mod.rs @@ -1,4 +1,4 @@ -/// # common module +/// # cplex module /// /// This module implements functionality used by multiple other ones. /// diff --git a/src/common_plex/printing.rs b/src/cplex/printing.rs similarity index 75% rename from src/common_plex/printing.rs rename to src/cplex/printing.rs index 83f6406..478ded2 100644 --- a/src/common_plex/printing.rs +++ b/src/cplex/printing.rs @@ -8,12 +8,15 @@ /// License: MIT /// Source: -use crate::Cli; - use std::fmt::{Debug, LowerHex}; use num::Integer; +/// print a seperator +pub fn seperator() { + println!("{:=<120}", '='); +} + /// process a result with some int pub fn proc_result(result: Result, args: Cli) where @@ -27,7 +30,7 @@ pub fn proc_result(result: Result, args: Cli) println!("{:#x}", res); } else { - println!("======================================================================="); + seperator(); println!("result is {:#x}", res); } } @@ -36,7 +39,7 @@ pub fn proc_result(result: Result, args: Cli) println!("{:#?}", e) } else { - println!("======================================================================="); + seperator(); println!("could not compute:\n{:#?}", e) } } @@ -54,7 +57,7 @@ pub fn proc_num(num: T, args: Cli) println!("{:#x}", num); } else { - println!("======================================================================="); + seperator(); println!("result is {:#x}", num); } } @@ -68,7 +71,7 @@ pub fn proc_vec(vec: Vec, args: Cli) println!("{:#?}", vec); } else { - println!("======================================================================="); + seperator(); println!("result is\n{:#?}", vec); } } @@ -84,7 +87,7 @@ pub fn proc_result_vec(res: Result, String>, args: Cli) println!("{:#?}", vec); } else { - println!("======================================================================="); + seperator(); println!("result is {:#?}", vec); } } @@ -93,7 +96,7 @@ pub fn proc_result_vec(res: Result, String>, args: Cli) println!("{:#?}", e) } else { - println!("======================================================================="); + seperator(); println!("could not compute:\n{:#?}", e) } } diff --git a/src/lib.rs b/src/lib.rs index 8cd3b18..f901b07 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -23,6 +23,7 @@ use pyo3::prelude::*; mod binary; mod math; mod algo; +mod cplex; #[pymodule] fn register_binary_module(py: Python, parent_module: &PyModule) -> PyResult<()> { diff --git a/src/main.rs b/src/main.rs index 3e27a58..4bbcdcb 100644 --- a/src/main.rs +++ b/src/main.rs @@ -21,7 +21,7 @@ mod binary; mod math; mod algo; -mod common_plex; +mod cplex; use std::{str::FromStr, fmt::Debug}; @@ -29,7 +29,7 @@ use clap::{Args, Parser, Subcommand}; use clap_num::maybe_hex; use num_bigint; /*************************************************************************************************/ -// This is just structures for parsing Cli args +/// This is just structures for parsing Cli args #[derive(Parser, Debug, Clone)] #[clap(name="plexcryptool", author="Christoph J. Scherr", version, about="Various tools for use with math and cryptology, includes executable and a library.")] pub struct Cli { @@ -47,7 +47,7 @@ pub struct Cli { } #[derive(Subcommand, Debug, Clone)] -enum Commands { +pub enum Commands { /// Use math functions Math(MathCommand), /// Use binary functions @@ -57,25 +57,25 @@ enum Commands { } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct MathCommand { +pub struct MathCommand { #[command(subcommand)] action: MathActions } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct BinaryCommand { +pub struct BinaryCommand { #[command(subcommand)] action: BinaryActions } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct AlgoCommand { +pub struct AlgoCommand { #[command(subcommand)] action: AlgoActions } #[derive(Subcommand, Clone, Debug, PartialEq, Eq)] -enum MathActions { +pub enum MathActions { #[command(name="modexp")] Modexp(ModexpArgs), Modred(ModredArgs), @@ -83,14 +83,14 @@ enum MathActions { } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct ModexpArgs { +pub struct ModexpArgs { base: String, exp: String, field: String } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct ModredArgs { +pub struct ModredArgs { #[clap(value_parser=maybe_hex::)] polynomial: u64, #[clap(value_parser=maybe_hex::)] @@ -98,7 +98,7 @@ struct ModredArgs { } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct PM1Args { +pub struct PM1Args { #[clap(value_parser=maybe_hex::)] n: u128, #[clap(value_parser=maybe_hex::)] @@ -106,7 +106,7 @@ struct PM1Args { } #[derive(Subcommand, Clone, Debug, PartialEq, Eq)] -enum BinaryActions { +pub enum BinaryActions { /// bit rotation/circular shifting (only 32bit) #[command(name="rotate")] Rotate(RotateArgs), @@ -114,7 +114,7 @@ enum BinaryActions { } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct RotateArgs { +pub struct RotateArgs { #[arg(short, long, default_value_t = false)] left: bool, #[clap(value_parser=maybe_hex::)] @@ -124,7 +124,7 @@ struct RotateArgs { } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct XorArgs { +pub struct XorArgs { #[clap(value_parser=maybe_hex::)] a: u128, #[clap(value_parser=maybe_hex::)] @@ -132,7 +132,7 @@ struct XorArgs { } #[derive(Subcommand, Clone, Debug, PartialEq, Eq)] -enum AlgoActions { +pub enum AlgoActions { #[command(name="feistel0-i")] Feistel0Inner(Feistel0InnerArgs), #[command(name="feistel0-sbox")] @@ -142,7 +142,7 @@ enum AlgoActions { } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct Feistel0InnerArgs { +pub struct Feistel0InnerArgs { #[clap(value_parser=maybe_hex::)] input: u16, #[clap(value_parser=maybe_hex::)] @@ -150,13 +150,13 @@ struct Feistel0InnerArgs { } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct Feistel0SBOXArgs { +pub struct Feistel0SBOXArgs { #[clap(value_parser=maybe_hex::)] index: u8, } #[derive(Args, Clone, Debug, PartialEq, Eq)] -struct Feistel0Args{ +pub struct Feistel0Args{ #[clap(value_parser=maybe_hex::)] input: u32, #[clap(value_parser=maybe_hex::)] @@ -172,6 +172,9 @@ struct Feistel0Args{ /// internal functions with the corresponding values, then shows the results to the user. pub fn main() { let args = Cli::parse(); + if args.verbose { + cplex::printing::seperator(); + } match args.clone().command { Commands::Math(action) => { match action.action { @@ -180,11 +183,11 @@ pub fn main() { let e = num_bigint::BigInt::from_str(&mod_exp_args.exp.as_str()).expect("could not make bigint"); let f = num_bigint::BigInt::from_str(&mod_exp_args.field.as_str()).expect("could not make bigint"); let num = math::modexp::modular_exponentiation(b.clone(), e, f, args.verbose); - common_plex::printing::proc_num(num, args); + cplex::printing::proc_num(num, args); } MathActions::Modred(mod_red_args) => { let result = math::modred::modred(mod_red_args.polynomial, mod_red_args.relation, args.verbose); - common_plex::printing::proc_result(result, args); + cplex::printing::proc_result(result, args); } MathActions::Pm1(pm1_args) => { let vec: Result, String> = math::pm1::p_minus_one( @@ -192,7 +195,7 @@ pub fn main() { pm1_args.max_prime, args.verbose ); - common_plex::printing::proc_result_vec(vec, args); + cplex::printing::proc_result_vec(vec, args); } } } @@ -206,11 +209,11 @@ pub fn main() { else { result = binary::rotr32(bin_rot_args.base, bin_rot_args.shift_width); } - common_plex::printing::proc_num(result, args); + cplex::printing::proc_num(result, args); }, BinaryActions::Xor(bin_xor_args) => { let result: u128 = binary::xor(bin_xor_args.a, bin_xor_args.b); - common_plex::printing::proc_num(result, args); + cplex::printing::proc_num(result, args); } } } @@ -218,11 +221,11 @@ pub fn main() { match action.action { AlgoActions::Feistel0Inner(alg_fei_args) => { let result: u16 = algo::feistel0::inner(alg_fei_args.input, alg_fei_args.key, args.verbose); - common_plex::printing::proc_num(result, args); + cplex::printing::proc_num(result, args); } AlgoActions::Feistel0SBOX(alg_fsb_args) => { let result: u8 = algo::feistel0::sbox(alg_fsb_args.index); - common_plex::printing::proc_num(result, args); + cplex::printing::proc_num(result, args); } AlgoActions::Feistel0(alg_fe0_args) => { let keys = algo::feistel0::key_scheduler(alg_fe0_args.key); @@ -233,7 +236,7 @@ pub fn main() { else { result = algo::feistel0::encrypt(alg_fe0_args.input, keys, args.verbose); } - common_plex::printing::proc_num(result, args); + cplex::printing::proc_num(result, args); } } } diff --git a/src/math/modred.rs b/src/math/modred.rs index 07d9024..2a74ecb 100644 --- a/src/math/modred.rs +++ b/src/math/modred.rs @@ -10,6 +10,8 @@ /// License: MIT /// Source: +use crate::cplex; + #[test] fn test_modred() { let rel: u64 = 0x1053; @@ -22,9 +24,9 @@ pub fn modred(mut poly: u64, relation: u64, verbose: bool) -> Result