enigma-rs

A toy project to implement the Enigma Machine in Rust.

This is a Rust project. Please install Rust before trying to run this project. Visit https://rustup.rs/ to get started.

Installation

This project is not ready to be installed into your environment. Although you can, it is advised against. This project currently uses the repository root as its running environment, and has not yet been updated to utilise a config directory in your ~ dir or something.

To run enigma:

1. Clone from GitHub:

$ git clone https://github.com/MattLimb/enigma-rs.git 

2. Change Directory into enigma-rs:

$ cd enigma-rs

3. Run through Cargo:

$ cargo run -- encrypt "Hello World!"

4. Build Binary:

$ cargo build [--release]

Planned Features

• Variable Number Rotors (more or less than 3). Its currently locked at 3.
• Rotor Offsets
• stdin Support
• Add Home directory support for config
• Generate default config automatically
• Add command-line utilities to show and modify configuration

Example Usage

$ ./target/debug/enigma help
A toy project to implement the Enigma Cipher in Rust.

Usage: enigma [OPTIONS] <COMMAND>

Commands:
  encrypt
  decrypt
  rotors
  help     Print this message or the help of the given subcommand(s)

Options:
  -r, --rotors <FILENAME>  [default: config/Rotors.toml]
  -c, --config <FILENAME>  [default: config/Enigma.toml]
  -h, --help               Print help
  -V, --version            Print version

$ ./target/debug/enigma --rotors config/Rotors.toml --config config/Enigma.toml encrypt "Hello World"
gwxnw ybehj

$ ./target/debug/enigma decrypt "gwxnw ybehj"
hello world

$ echo "Hello World" | ./enigma encrypt -

$ ./target/debug/enigma rotors
-------------------------------------------------------------------------------------------------------------------------------------------
Rotor  : rotor_iii (in use)
-------------------------------------------------------------------------------------------------------------------------------------------
Rotor  : rotor_ii (in use)
-------------------------------------------------------------------------------------------------------------------------------------------
Rotor  : rotor_i (in use)
-------------------------------------------------------------------------------------------------------------------------------------------