enigmapython 1.0.0__tar.gz → 1.1.0__tar.gz

{enigmapython-1.0.0 → enigmapython-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: enigmapython
-Version: 1.0.0
+Version: 1.1.0
 Summary: A simple yet faithful library to emulate different Enigma machines models using Python
 Home-page: https://github.com/denismaggior8/enigma-python
 Author: Denis Maggiorotto
@@ -24,6 +24,17 @@ Welcome to **enigmapython**, a Python package designed to emulate the legendary
 
 The following Enigma machine models (along with their rotors, reflectors and plugboards) have been implemented:
 
+### Enigma D
+
+| Scrambler 	             | Wiring                    	        | Notch 	| Implemented 	    |
+|-------	                 |----------------------------	        |-------	|-------------      |
+| ETW "QWERTZ"               | qwertzuioasdfghjkpyxcvbnml 	        | N/A     	|   ✅           	|
+| ETW "JWULCM"               | jwulcmnohpqzyxiradkegvbtsf 	        | N/A     	|   ✅           	|
+| Rotor I                    | lpgszmhaeoqkvxrfybutnicjdw 	        | y     	|   ✅           	|
+| Rotor II                   | slvgbtfxjqohewirzyamkpcndu 	        | e     	|   ✅           	|
+| Rotor III                  | bdfhjlcprtxvznyeiwgakmusqo 	        | n     	|   ✅           	|
+| Reflector UKW              | imetcgfraysqbzxwlhkdvupojn 	        | N/A     	|   ✅           	|
+
 ### Enigma I 
 
 | Scrambler 	             | Wiring                    	        | Notch 	| Implemented 	    |
@@ -109,17 +120,36 @@ Please have a look of the [examples](https://github.com/denismaggior8/enigma-pyt
 
 ## Documentation
 
-TBD, for now... code (and comments) are the documentation
+An initial documentation draft can be found [here](./docs/README.md), but in most cases examples, code (and comments) are better than the documentation
+
+## Known implementations
+
+Here's a list containing all the known Enigma simulators that use the **enigmapython** API.
+
+- [Retrocampus BBS Enigma simulator](https://retrocampus.com/bbs/). When connected to the BBS, type E to access an Enigma M3 cypher machine. ![](img/retrocampus_enigma.png)
+
+In the case you leveraged **enigmapython** API in a project, either public or not, drop me an email at __denis.maggiorotto[at]gmail.com__ and I'll be happy to list you here.
+
+
+## Known implementations
+
+Here's a list containing all the known Enigma simulators that use the **enigmapython** API.
+
+- [Retrocampus BBS Enigma simulator](https://retrocampus.com/bbs/). When connected to the BBS, type E to access an Enigma M3 cypher machine. ![](img/retrocampus_enigma.png)
+
+In the case you leveraged **enigmapython** API in a project, either public or not, drop me an email at __denis.maggiorotto[at]gmail.com__ and I'll be happy to list you here.
+
 
 ## Credits/references
 
 - Early days experiments with Python and Enigma (where this repo comes from) can be found at: https://github.com/denismaggior8/enigma-cypher
-- Rotors wirings have been taken from Crypto Museum at this link  https://www.cryptomuseum.com/crypto/enigma/wiring.htm
+- Rotors wirings have been taken from **Crypto Museum** at this link  https://www.cryptomuseum.com/crypto/enigma/wiring.htm
 - Thanks to 
     - Piotte13 https://piotte13.github.io/enigma-cipher/
     - Cryptii https://cryptii.com
     - PyEnigma https://pypi.org/project/pyenigma/
     - 101 computing https://www.101computing.net/enigma-machine-emulator/ 
+    - DenCode Enigma simulator https://dencode.com/cipher/enigma
     
     for having helped me testing the correctness of the generated ciphertexts 
 

{enigmapython-1.0.0 → enigmapython-1.1.0}/enigmapython/Enigma.py

@@ -11,14 +11,15 @@ class Enigma(Observer):
     etw = None
     auto_increment_rotors = False
 
-    alphabet = list(ascii_lowercase)
+    alphabet_list = None
 
-    def __init__(self, plugboard, rotors, reflector,etw,auto_increment_rotors=False):
+    def __init__(self, plugboard, rotors, reflector,etw,auto_increment_rotors=False, alphabet=ascii_lowercase):
         self.plugboard = plugboard
         self.rotors = rotors
         self.reflector = reflector
         self.etw = etw
         self.auto_increment_rotors = auto_increment_rotors
+        self.alphabet_list = list(alphabet)
         if auto_increment_rotors == True:
             for rotor in rotors:
                 rotor.add_observer(self)
@@ -42,28 +43,45 @@ class Enigma(Observer):
         scrambled_char = self.process_char(char)
         return scrambled_char           
 
+    """
+         UKW   Rotor  Rotor  Rotor   ETW  PLUGBOARD
+                 N      2      1      
+         ___    ___    ___    ___    ___    ___
+        |   |  |   |  |   |  |   |  |   |  |   |
+        |  -|--|---|--|---|--|---|--|---|--|---|-- < Key
+        | | |  |   |  |   |  |   |  |   |  |   |
+        | | |  |   |  |   |  |   |  |   |  |   |
+        |  -|--|---|--|---|--|---|--|---|--|---|-- > Lamp
+        |   |  |   |  |   |  |   |  |   |  |   |
+         ---    ---    ---    ---    ---    ---
+    """
     def process_char(self, char):
         scrambled_char = self.plugboard.switch_char(char)
         logging.debug("Scrambled letter from plugboard: {}".format(scrambled_char))
+        scrambled_char = self.etw.process_char_forward(scrambled_char,0)
+        logging.debug("Scrambled letter from ETW: {}".format(scrambled_char))
         iteration = 0
         for rotor in self.rotors:
             if iteration == 0:
-                scrambled_char = rotor.scramble_letter_index(rotor.wiring,Enigma.alphabet.index(scrambled_char))
+                scrambled_char = rotor.scramble_letter_index(rotor.wiring,self.alphabet_list.index(scrambled_char))
             else:
-                scrambled_char = rotor.scramble_letter_index(rotor.wiring,Enigma.alphabet.index(scrambled_char)-self.rotors[iteration-1].position) 
+                scrambled_char = rotor.scramble_letter_index(rotor.wiring,self.alphabet_list.index(scrambled_char)-self.rotors[iteration-1].position) 
             iteration +=1
             logging.debug("Scrambled letter from rotor{}: {}".format(str(iteration),scrambled_char))
-        scrambled_char = self.reflector.scramble_letter_index(self.reflector.wiring,(Enigma.alphabet.index(scrambled_char)-self.rotors[iteration-1].position))
+        scrambled_char = self.reflector.scramble_letter_index(self.reflector.wiring,(self.alphabet_list.index(scrambled_char)-self.rotors[iteration-1].position))
         logging.debug("Scrambled letter from reflector: {}".format(scrambled_char))
         for rotor in reversed(self.rotors):
             if iteration == len(self.rotors):
-                scrambled_char = rotor.scramble_letter_index(Enigma.alphabet,(rotor.wiring.index(Enigma.shift_letter(scrambled_char,rotor.position))-rotor.position))
+                scrambled_char = rotor.scramble_letter_index(self.alphabet_list,(rotor.wiring.index(self.shift_letter(scrambled_char,rotor.position,self.alphabet_list))-rotor.position))
             else:
-                scrambled_char = rotor.scramble_letter_index(Enigma.alphabet,(rotor.wiring.index(Enigma.shift_letter(scrambled_char, (rotor.position - self.rotors[iteration].position))) - rotor.position))
+                scrambled_char = rotor.scramble_letter_index(self.alphabet_list,(rotor.wiring.index(self.shift_letter(scrambled_char, (rotor.position - self.rotors[iteration].position),self.alphabet_list)) - rotor.position))
             iteration -=1
             logging.debug("Scrambled letter from rotor{}: {}".format(str(iteration+1),scrambled_char))   
-        scrambled_char = self.etw.switch_char(scrambled_char,-self.rotors[iteration].position)
+        
+        # Processing rotor 1 returning signal by ETW
+        scrambled_char = self.etw.process_char_backward(scrambled_char,self.rotors[iteration].position)
         logging.debug("Scrambled letter from ETW: {}".format(scrambled_char))
+        
         scrambled_char = self.plugboard.switch_char(scrambled_char)
         logging.debug("Scrambled letter from plugboard: {}".format(scrambled_char))
         logging.info("Scrambled letter to lamp: {}".format(scrambled_char))
@@ -78,8 +96,8 @@ class Enigma(Observer):
                 self.rotors[self.rotors.index(observable)+1].double_step_triggered = True
         
     @staticmethod        
-    def shift_letter(letter,shift):
-	    return Enigma.alphabet[(Enigma.alphabet.index(letter)+shift) % len(Enigma.alphabet)]
+    def shift_letter(letter,shift,alphabet_list):
+        return alphabet_list[(alphabet_list.index(letter)+shift) % len(alphabet_list)]
     
 
 

enigmapython-1.1.0/enigmapython/EnigmaD.py

@@ -0,0 +1,9 @@
+from .Enigma import Enigma
+from .PlugboardPassthrough import PlugboardPassthrough
+
+
+class EnigmaD(Enigma):
+   
+    def __init__(self,rotor1, rotor2, rotor3,reflector,etw,auto_increment_rotors=False):
+         rotors = [rotor1, rotor2, rotor3]
+         super().__init__(PlugboardPassthrough(),rotors,reflector,etw,auto_increment_rotors)

enigmapython-1.1.0/enigmapython/EnigmaDEtw_JWULCM.py

@@ -0,0 +1,6 @@
+from .Etw import Etw
+
+class EnigmaDEtw_JWULCM(Etw):
+    wiring = "jwulcmnohpqzyxiradkegvbtsf"
+    def __init__(self):
+         super().__init__(self.wiring)

enigmapython-1.1.0/enigmapython/EnigmaDEtw_QWERTZ.py

@@ -0,0 +1,6 @@
+from .Etw import Etw
+
+class EnigmaDEtw_QWERTZ(Etw):
+    wiring = "qwertzuioasdfghjkpyxcvbnml"
+    def __init__(self):
+         super().__init__(self.wiring)

enigmapython-1.1.0/enigmapython/EnigmaDRotorI.py

@@ -0,0 +1,11 @@
+from .Rotor import Rotor
+
+class EnigmaDRotorI(Rotor):
+    
+    wiring = 'lpgszmhaeoqkvxrfybutnicjdw'
+    notch_indexes = [24]
+    tag = "D_I"
+    
+    def __init__(self, position = 0, ring = 0):
+        super().__init__(self.wiring, position, ring, self.notch_indexes)
+    

enigmapython-1.1.0/enigmapython/EnigmaDRotorII.py

@@ -0,0 +1,11 @@
+from .Rotor import Rotor
+
+class EnigmaDRotorII(Rotor):
+    
+    wiring = 'slvgbtfxjqohewirzyamkpcndu'
+    notch_indexes = [4]
+    tag = "D_II"
+    
+    def __init__(self, position = 0, ring = 0):
+        super().__init__(self.wiring, position, ring, self.notch_indexes)
+    

enigmapython-1.1.0/enigmapython/EnigmaDRotorIII.py

@@ -0,0 +1,11 @@
+from .Rotor import Rotor
+
+class EnigmaDRotorIII(Rotor):
+    
+    wiring = 'cjgdpshkturawzxfmynqobvlie'
+    notch_indexes = [13]
+    tag = "D_III"
+    
+    def __init__(self, position = 0, ring = 0):
+        super().__init__(self.wiring, position, ring, self.notch_indexes)
+    

enigmapython-1.1.0/enigmapython/Etw.py

@@ -0,0 +1,22 @@
+
+from string import ascii_lowercase
+
+class Etw:
+    wiring = None
+    alphabet_list = None
+
+    def process_char_forward(self,char,shift):
+        return self.wiring[self.alphabet_list.index(char)+shift]
+    
+    def process_char_backward(self,char,shift):
+        myint = (self.alphabet_list.index(char)-shift) % len(self.alphabet_list)
+        myletter = self.alphabet_list[myint]
+        myint1 = self.wiring.index(myletter)
+        return self.alphabet_list[myint1]
+    
+    def __init__(self, wiring, alphabet=ascii_lowercase):
+        self.wiring = wiring
+        self.alphabet_list = list(alphabet)
+
+    def __str__(self):
+        return self.wiring

enigmapython-1.1.0/enigmapython/ReflectorDUKW.py

@@ -0,0 +1,9 @@
+from .Rotor import Rotor
+from .Reflector import Reflector
+class ReflectorDUKW(Reflector):
+    
+    wiring = 'imetcgfraysqbzxwlhkdvupojn'
+    tag = "D_UKW"
+    
+    def __init__(self):
+        super().__init__(self.wiring,0)

{enigmapython-1.0.0 → enigmapython-1.1.0}/enigmapython/Rotor.py

@@ -13,6 +13,7 @@ class Rotor(Observable):
     ring = None
     dot_position = None
     lookup = {}
+    alphabet_list = None
 
     @staticmethod
     def register(tag, class_name):
@@ -38,7 +39,7 @@ class Rotor(Observable):
         scrambled_letter_index_from_rotor = dictionary.index(dictionary[(self.position + letter_index) % len(dictionary)])
         return dictionary[scrambled_letter_index_from_rotor]
 
-    def __init__(self, wiring, position = 0, ring = 0, notch_indexes=[]):
+    def __init__(self, wiring, position = 0, ring = 0, notch_indexes=[], alphabet=ascii_lowercase):
         self.wiring = wiring
         self.position = position % len(wiring)
         self.notch_indexes = notch_indexes
@@ -46,6 +47,7 @@ class Rotor(Observable):
         self.rotations_counter = 0
         self.original_wiring = self.wiring
         self.ring = ring
+        self.alphabet_list = list(alphabet)
         self.set_rotor_ring(ring)
 
     def __str__(self):
@@ -59,7 +61,6 @@ class Rotor(Observable):
         self.wiring = self.original_wiring
         self.dot_position = list(self.wiring).index("a")
         logging.debug("Dot position: " + str(self.dot_position))
-        alphabet = list(ascii_lowercase)
         for i in range(0, ring):
         # Set temporary wiring variable
             temp_wiring = self.wiring
@@ -68,25 +69,25 @@ class Rotor(Observable):
             # Loop over chars in temporary wiring
             for char in temp_wiring:
                 # Shift the char by one and add that shifted char to wiring variable
-                wiring += Rotor.shift(char, 1, alphabet)
+                wiring += Rotor.shift(char, 1, self.alphabet_list)
             # Add one to dot position, make sure we don't exceed the lenght of the alphabet
             self.wiring = wiring
-            self.dot_position = (self.dot_position + 1) % len(alphabet)
+            self.dot_position = (self.dot_position + 1) % len(self.alphabet_list)
             logging.debug("Wiring shifted up the alphabet: " + wiring)
             logging.debug("New dot position: " + str(self.dot_position))
         i = 0
         # While the letter at the dot position doesn't match with the ringstellung
-        while not self.wiring[self.dot_position] == alphabet[ring % len(self.wiring)]:
+        while not self.wiring[self.dot_position] == self.alphabet_list[ring % len(self.wiring)]:
             i += 1
             # Rotate the wiring
             self.wiring = self.wiring[-1:] + self.wiring[:-1]
             logging.debug("Rotation " + str(i).zfill(2) + "; Wiring: " + self.wiring)
          
     @staticmethod
-    def shift(letter, shift, alphabet):
-        for i in range(0, len(alphabet)):
-            if alphabet[i] == letter:
-                return alphabet[(i + shift) % len(alphabet)]
+    def shift(letter, shift, alphabet_list):
+        for i in range(0, len(alphabet_list)):
+            if alphabet_list[i] == letter:
+                return alphabet_list[(i + shift) % len(alphabet_list)]
             
     @staticmethod
     def get_instance_from_tag(tag: str):

{enigmapython-1.0.0 → enigmapython-1.1.0}/enigmapython.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: enigmapython
-Version: 1.0.0
+Version: 1.1.0
 Summary: A simple yet faithful library to emulate different Enigma machines models using Python
 Home-page: https://github.com/denismaggior8/enigma-python
 Author: Denis Maggiorotto
@@ -24,6 +24,17 @@ Welcome to **enigmapython**, a Python package designed to emulate the legendary
 
 The following Enigma machine models (along with their rotors, reflectors and plugboards) have been implemented:
 
+### Enigma D
+
+| Scrambler 	             | Wiring                    	        | Notch 	| Implemented 	    |
+|-------	                 |----------------------------	        |-------	|-------------      |
+| ETW "QWERTZ"               | qwertzuioasdfghjkpyxcvbnml 	        | N/A     	|   ✅           	|
+| ETW "JWULCM"               | jwulcmnohpqzyxiradkegvbtsf 	        | N/A     	|   ✅           	|
+| Rotor I                    | lpgszmhaeoqkvxrfybutnicjdw 	        | y     	|   ✅           	|
+| Rotor II                   | slvgbtfxjqohewirzyamkpcndu 	        | e     	|   ✅           	|
+| Rotor III                  | bdfhjlcprtxvznyeiwgakmusqo 	        | n     	|   ✅           	|
+| Reflector UKW              | imetcgfraysqbzxwlhkdvupojn 	        | N/A     	|   ✅           	|
+
 ### Enigma I 
 
 | Scrambler 	             | Wiring                    	        | Notch 	| Implemented 	    |
@@ -109,17 +120,36 @@ Please have a look of the [examples](https://github.com/denismaggior8/enigma-pyt
 
 ## Documentation
 
-TBD, for now... code (and comments) are the documentation
+An initial documentation draft can be found [here](./docs/README.md), but in most cases examples, code (and comments) are better than the documentation
+
+## Known implementations
+
+Here's a list containing all the known Enigma simulators that use the **enigmapython** API.
+
+- [Retrocampus BBS Enigma simulator](https://retrocampus.com/bbs/). When connected to the BBS, type E to access an Enigma M3 cypher machine. ![](img/retrocampus_enigma.png)
+
+In the case you leveraged **enigmapython** API in a project, either public or not, drop me an email at __denis.maggiorotto[at]gmail.com__ and I'll be happy to list you here.
+
+
+## Known implementations
+
+Here's a list containing all the known Enigma simulators that use the **enigmapython** API.
+
+- [Retrocampus BBS Enigma simulator](https://retrocampus.com/bbs/). When connected to the BBS, type E to access an Enigma M3 cypher machine. ![](img/retrocampus_enigma.png)
+
+In the case you leveraged **enigmapython** API in a project, either public or not, drop me an email at __denis.maggiorotto[at]gmail.com__ and I'll be happy to list you here.
+
 
 ## Credits/references
 
 - Early days experiments with Python and Enigma (where this repo comes from) can be found at: https://github.com/denismaggior8/enigma-cypher
-- Rotors wirings have been taken from Crypto Museum at this link  https://www.cryptomuseum.com/crypto/enigma/wiring.htm
+- Rotors wirings have been taken from **Crypto Museum** at this link  https://www.cryptomuseum.com/crypto/enigma/wiring.htm
 - Thanks to 
     - Piotte13 https://piotte13.github.io/enigma-cipher/
     - Cryptii https://cryptii.com
     - PyEnigma https://pypi.org/project/pyenigma/
     - 101 computing https://www.101computing.net/enigma-machine-emulator/ 
+    - DenCode Enigma simulator https://dencode.com/cipher/enigma
     
     for having helped me testing the correctness of the generated ciphertexts 
 

{enigmapython-1.0.0 → enigmapython-1.1.0}/enigmapython.egg-info/SOURCES.txt

@@ -1,5 +1,11 @@
 setup.py
 enigmapython/Enigma.py
+enigmapython/EnigmaD.py
+enigmapython/EnigmaDEtw_JWULCM.py
+enigmapython/EnigmaDEtw_QWERTZ.py
+enigmapython/EnigmaDRotorI.py
+enigmapython/EnigmaDRotorII.py
+enigmapython/EnigmaDRotorIII.py
 enigmapython/EnigmaI.py
 enigmapython/EnigmaINorway.py
 enigmapython/EnigmaINorwayRotorI.py
@@ -43,6 +49,7 @@ enigmapython/Observer.py
 enigmapython/Plugboard.py
 enigmapython/PlugboardPassthrough.py
 enigmapython/Reflector.py
+enigmapython/ReflectorDUKW.py
 enigmapython/ReflectorNorwayUKW.py
 enigmapython/ReflectorSonderUKW.py
 enigmapython/ReflectorUKWA.py

{enigmapython-1.0.0 → enigmapython-1.1.0}/setup.py

@@ -12,7 +12,7 @@ setup(
     long_description_content_type='text/markdown',
     url="https://github.com/denismaggior8/enigma-python",
     name="enigmapython",
-    version="1.0.0",
+    version="1.1.0",
     packages=find_packages(
         # All keyword arguments below are optional:
         where='.',  # '.' by default

enigmapython-1.0.0/enigmapython/Etw.py

@@ -1,14 +0,0 @@
-
-from string import ascii_lowercase
-
-class Etw:
-    wiring = None
-
-    def switch_char(self,char,shift):
-        return self.wiring[self.wiring.index(char)+shift]
-
-    def __init__(self, wiring):
-        self.wiring = wiring
-
-    def __str__(self):
-        return self.wiring