samcunliffe / enigma

Sam's Enigma machine simulator

enigma

Sam's Enigma machine simulator.

Enigma machine. Museo Nazionale Scienza e Tecnologia Leonardo da Vinci, CC BY-SA 4.0, via Wikimedia Commons

Getting started

import enigma

# construct a machine with random configuration
random_enigma = enigma.random_configuration()
print(random_enigma)

# encipher and decipher
ciphertext = random_enigma.encipher("SECRETMESSAGE")
print(ciphertext)
deciphered = random_enigma.encipher(ciphertext)
print(deciphered)

Or, if you want to construct a machine with some specific configuration. There are three possible reflectors (UKW-B, C, and D) to choose from, five possible rotors (I,.. V) to pick three, and three starting positions. Finally, you can connect up to 13 letters together at the plugboard.

import enigma.machine
import enigma.components

my_enigma = enigma.machine.EnigmaMachine(
    enigma.components.ukwb,
    [enigma.components.r1, enigma.components.r2, enigma.components.r3],
    "AAA",
    enigma.components.Plugboard("AB CD EF")
)
print(my_enigma)

# encipher and decipher
ciphertext = my_enigma.encipher("ANOTHERSECRETMESSAGE")
print(ciphertext)
deciphered = my_enigma.encipher(ciphertext)
print(deciphered)

enigma's Issues

Add an examples module with one or two machines set up.

Add starting positions.

Add functionality for the user to choose a set of rotor starting positions.