# enigma

**Repository Path**: lucasliu71/enigma

## Basic Information

- **Project Name**: enigma
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-04
- **Last Updated**: 2025-12-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Enigma

Enigma M3 machine cipher tool

```bash
usage: enigma [-h] command ...

███████╗███╗   ██╗██╗ ██████╗ ███╗   ███╗ █████╗     ███╗   ███╗██████╗ 
██╔════╝████╗  ██║██║██╔════╝ ████╗ ████║██╔══██╗    ████╗ ████║╚════██╗
█████╗  ██╔██╗ ██║██║██║  ███╗██╔████╔██║███████║    ██╔████╔██║ █████╔╝
██╔══╝  ██║╚██╗██║██║██║   ██║██║╚██╔╝██║██╔══██║    ██║╚██╔╝██║ ╚═══██╗
███████╗██║ ╚████║██║╚██████╔╝██║ ╚═╝ ██║██║  ██║    ██║ ╚═╝ ██║██████╔╝
╚══════╝╚═╝  ╚═══╝╚═╝ ╚═════╝ ╚═╝     ╚═╝╚═╝  ╚═╝    ╚═╝     ╚═╝╚═════╝ 
════════════════════════════════════════════════════════════════════════
If no arguments are provided, the program will encrypt/decrypt with the
code book settings.
════════════════════════════════════════════════════════════════════════

positional arguments:
  command
    cbk       Generate or show code book
    enc       Message encryption
    dec       Message decryption

options:
  -h, --help  show this help message and exit
```

* `cbk`: Enigma machine code book for encryption and decryption
  * `-r, --reset`: Reset code book settings

* `enc`: Message encryption with code book settings or DIY

* `dec`: Message decryption with code book settings or DIY

```bash
usage: enigma enc [-h] [-ref REF] [-rotor ROTOR ROTOR ROTOR] [-ring RING] [-rpos RPOS] [-plug PLUG [PLUG ...]] [message]

positional arguments:
  message               Message to encrypt

options:
  -h, --help            show this help message and exit
  -ref REF              Reflector type, e.g. B/C
  -rotor ROTOR ROTOR ROTOR
                        Rotor settings, (I-V), e.g. I, II, III
  -ring RING            Ring settings, (A-Z), e.g. ABC
  -rpos RPOS            Initial ring positions, (A-Z), e.g. DEF
  -plug PLUG [PLUG ...]
                        Plugboard connections, (A-Z), e.g. AB, CD, EF, ...
```

* `message`: Message to encrypt or decrypt
* `-ref`: Reflector type, `B/C`
* `-rotor`: Rotor setting, `I-V` five rotors
* `-ring`: Rotor ring setting, `A-Z` 3 letters
* `-rpos`: Initial ring position, `A-Z` 3 letters
* `-plug`: Plugboard connection, `A-Z` 2 letters, can connect `1-13` pairs

> [!TIP]
>
> If code book setting (`code_book.json`) found and no arguments required, reflector, rotor, ring, initial ring position, plugboard connection will use today's setting

```bash
                             Enigma M3 Code Book                             
┏━━━━━━┳━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ DATE ┃ ROTOR     ┃ R_SET ┃ R_POS ┃ PLUGBOARD                              ┃
┡━━━━━━╇━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│    1 │ V III IV  │ GLD   │ VRA   │ FE HI KO MQ NR US VX WZ                │
│    2 │ II V I    │ MRN   │ VWT   │ BA DC GE LF OH PI RJ TK UM VS WX YZ    │
│    3 │ II V III  │ YZJ   │ ICF   │ AB CH KL SP TQ UX                      │
│    4 │ I III IV  │ YAG   │ RGZ   │ DE FN JQ TS UY VZ                      │
│    5 │ I III IV  │ UAL   │ NQK   │ AC BE FG NK PO TQ VU ZY                │
│    6 │ I V II    │ UPW   │ DKI   │ AC BD GE HF KI NM SO WQ XR ZV          │
│    7 │ I III II  │ DOT   │ QOS   │ ME RI WS XU ZV                         │
│    8 │ II III IV │ YBP   │ IDW   │ AB ED GF KH NI QJ SL TM UO VR XW YZ    │
│    9 │ II III IV │ YVI   │ ACT   │ AC BD FE HG JI KL MN SO TP VQ WR XU    │
│   10 │ II III I  │ OJH   │ MWJ   │ FE GK JN VP XR                         │
│   11 │ II III IV │ VTZ   │ NFL   │ BA FD HE IG JK LM NO PS RT UW VY XZ    │
│   12 │ I V IV    │ BAQ   │ KJV   │ AC DE HG NI PJ RL UM XO YS ZT          │
│   13 │ I V IV    │ EQT   │ HMG   │ DA JG MK OL RS WV YX                   │
│   14 │ I II IV   │ IQG   │ ZDI   │ AC BE DF LG NH PI QK RM SO VT XW YZ    │
│   15 │ II V IV   │ SIT   │ WUA   │ BA DC GE HF IJ MK PL QN RO TS VU WY XZ │
│   16 │ II III IV │ HUO   │ MGD   │ BA EC FD HG IK PL QN RO TS XV          │
│   17 │ I V II    │ EQY   │ ZGB   │ CF EG NH RS VW XY                      │
│   18 │ II I IV   │ SFT   │ PKX   │ CE PI QK TL UR VZ                      │
│   19 │ I V III   │ QOH   │ KHF   │ AC BF DG EI HK JL OM PN QS RT UW VX ZY │
│   20 │ I V III   │ BTM   │ DIV   │ FA GB HD JI MK ON QS RU TW VX ZY       │
│   21 │ I V III   │ DDG   │ EBT   │ BH CP SV TW UY                         │
│   22 │ I V III   │ WHU   │ TBU   │ CB GE LF QH SI UJ WO XT ZY             │
│   23 │ II V IV   │ ALN   │ KPJ   │ FE LH QK RN SV ZY                      │
│   24 │ I V II    │ ASW   │ EYZ   │ BF DG LH OM PN RQ TX UY                │
│   25 │ II III IV │ CUI   │ VMH   │ EB HK IM VR YX                         │
│   26 │ I V III   │ SUR   │ VXL   │ MA NE OG QH WP YS ZX                   │
│   27 │ I V II    │ SKZ   │ LCC   │ GA HB JI MK SL UO WP YT ZX             │
│   28 │ I V III   │ DGX   │ LMS   │ DA FE JG LH MI PK SN TO UQ VR XZ       │
│   29 │ I II IV   │ CLN   │ HAO   │ AJ BQ CU IX KY                         │
│   30 │ I III IV  │ IOO   │ RLF   │ AB FD JE KG LH PI RN TO UW XY          │
│   31 │ II III IV │ KEH   │ UFT   │ BA GC HD KF LI OJ PM TN VQ XR YU ZW    │
└──────┴───────────┴───────┴───────┴────────────────────────────────────────┘
```