thatnerduknow/enigma

A CLI application emulating an Enigma Machine

enigma

An implementation of the Enigma Machine written in rust

The Enigma machine is a cipher device developed and used in the early- to mid-20th century to protect commercial, diplomatic, and military communication. It was employed extensively by Nazi Germany during World War II, in all branches of the German military. The Enigma machine was considered so secure that it was used to encipher the most top-secret messages.

Installation

• Install Rust
• run cargo install libenigma
• run libenigma -h for usage instructions

Tests

run cargo test

Benchmarks

run cargo bench

Usage

• -i Input file: Path to input text file
• -c Config file: Path to config file. If a config file does not exist at this path, a config file will be generated a written to this path
• -o Output file: Path to output ciphertext
• -h Help: Help information- Output information on usage of CLI
• -v Version: Output version information

enigma's Issues

TODO: Better CLI

The current state of main.rs doesn't allow user input. I need to look into allowing the user to configure the machine and pass a message through using the cli alone or possibly through a TUI

TODO: Implement plugboard

I need to implement the plugboard mechanism. I am thinking of defining a struct called Plug which is implemented as [char;2]. The plugs are then collected into a vec of length 0 >= && <= 10. The plugs are then used to build out a cipher string which should pass validation for the RotorCipher type.

Enigma::new() allows arbitrary rotor config length

TODO: use the prae crate to enforce number of rotors

TODO: modify prae verification for better error messages

Currently i'm using the ensure closure for the prae define! macro which only returns a boolean.
If I define a custom error enum and implement the Display trait on that enum I can instead use the verify closure on the define! macro which would enable better error messages and as a side benefit, would make the verification code easier to read

Rotor::new() allows position to be set without any validation

TODO: Use the prae crate to create a custom char type with validation

Enigma::new() allows duplicate rotors

TODO: use the prae crate to enforce validation rule: duplicate rotors are not allowed