enigmapython 1.3.2__tar.gz → 2.0.0__tar.gz

{enigmapython-1.3.2 → enigmapython-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enigmapython
-Version: 1.3.2
+Version: 2.0.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
@@ -27,6 +27,15 @@ Dynamic: summary
 
 Welcome to **enigmapython**, a Python package designed to emulate the legendary Enigma cryptographic machine used during World War II. **enigmapython** provides a faithful implementation of the Enigma machine, allowing users to explore and understand the workings of this historic device.
 
+<br>
+<div class="img-container" style="text-align: center;">
+    <a href="https://asciinema.org/a/761182">
+        <img src="https://asciinema.org/a/761182.svg" alt="asciicast"/>
+    </a>
+</div>
+<br>
+
+
 This project is listed on [Wikipedia](https://en.wikipedia.org/wiki/List_of_Enigma_machine_simulators) as a globally recognized Enigma machine simulator, noted for its historical accuracy.
 
 <div class="img-container" style="text-align: center;"> 
@@ -65,6 +74,7 @@ This project is listed on [Wikipedia](https://en.wikipedia.org/wiki/List_of_Enig
 
 
 - [Authentic German Army Test Message from 1930](https://cryptocellar.org/enigma/e-message-1930.html): Documented by Frode Weierud's CryptoCellar, this test validates that the **Enigma I** implementation correctly handles the complex interaction of rotors, ring settings, and plugboard connections exactly as the original machines did. See the [corresponding unit test](https://github.com/denismaggior8/enigma-python/blob/master/tests/Enigma1930_tests.py) for details.
+- [Authentic U-534 M4 Message P1030700](https://enigma.hoerenberg.com/index.php?cat=The%20U534%20messages&page=P1030700): A message from the U-534 submarine (May 1945), validating the **Enigma M4** implementation (including the Greek rotor and thin reflector) against historical intercepts. See the [corresponding unit test](https://github.com/denismaggior8/enigma-python/blob/master/tests/EnigmaM4_U534_tests.py) for details.
 
 ## Machines implementations
 
@@ -82,12 +92,22 @@ The following Enigma machine models (along with their rotors, reflectors and plu
 
 *given the rarity of this model and the little documentation/simulators available, although I expect an encryption consistency on par with newer models, I was unable to test it as I would have liked
 
+### Enigma K (Commercial Enigma)
+
+| Scrambler 	             | Wiring                    	        | Notch 	| Implemented 	    |
+|-------	                 |----------------------------	        |-------	|-------------      |
+| ETW "QWERTZ"               | qwertzuioasdfghjkpyxcvbnml 	        | N/A     	|   ✅           	|
+| Rotor I                    | lpgszmhaeoqkvxrfybutnicjdw 	        | y     	|   ✅           	|
+| Rotor II                   | slvgbtfxjqohewirzyamkpcndu 	        | e     	|   ✅           	|
+| Rotor III                  | cjgdpshkturawzxfmynqobvlie 	        | n     	|   ✅           	|
+| Reflector UKW              | imetcgfraysqbzxwlhkdvupojn 	        | N/A     	|   ✅           	|
+
+
 ### 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     	|   ✅           	|
@@ -191,7 +211,9 @@ Get started by installing the package from PyPI (`pip install enigmapython`) and
 
 ## 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
+Full API documentation is available on [ReadTheDocs](https://enigmapython.readthedocs.io/).
+
+For additional details, you can also refer to the [local documentation](./docs/README.md), examples, and code comments.
 
 ## Known implementations
 

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/Enigma.py

@@ -3,6 +3,7 @@ from .RotatingReflector import RotatingReflector
 from .Alphabets import Alphabets
 from .Journaled import Journaled
 from .Clonable  import Clonable
+from .Utils import Utils
 import logging
 
 
@@ -41,6 +42,7 @@ class Enigma(Observer,Journaled,Clonable):
         return output_string
 
     def input_char(self,char):
+        char = char.lower()
         logging.info("Input char: {}".format(char))
         ## Triggering rotors extra rotation due to double step issue
         for rotor in self.rotors:
@@ -75,7 +77,11 @@ class Enigma(Observer,Journaled,Clonable):
     def process_char(self, char):
         scrambled_char = self.plugboard.scramble_char(self.plugboard.wiring,self.plugboard.alphabet_list.index(char),0)
         logging.debug("Scrambled letter from plugboard: {}".format(scrambled_char))
-        scrambled_char = self.etw.scramble_char(self.etw.wiring,self.alphabet_list.index(scrambled_char), 0)
+        
+        # Calculate inverted wiring for ETW
+        inverted_wiring = Utils.inverse_string_permutation(self.etw.wiring, ''.join(self.etw.alphabet_list))
+        
+        scrambled_char = self.etw.scramble_char(inverted_wiring, self.alphabet_list.index(scrambled_char), 0)
         logging.debug("Scrambled letter from ETW: {}".format(scrambled_char))
         iteration = 0
         for rotor in self.rotors:
@@ -85,8 +91,14 @@ class Enigma(Observer,Journaled,Clonable):
                 scrambled_char = rotor.scramble_char(rotor.wiring,self.alphabet_list.index(scrambled_char)-self.rotors[iteration-1].position, rotor.position) 
             iteration +=1
             logging.debug("Scrambled letter from rotor{}: {}".format(str(iteration),scrambled_char))
-        scrambled_char = self.reflector.scramble_char(self.reflector.wiring,(self.alphabet_list.index(scrambled_char)-self.rotors[iteration-1].position), 0)
+        reflector_pos = getattr(self.reflector, 'position', 0)
+        scrambled_char = self.reflector.scramble_char(self.reflector.wiring,(self.alphabet_list.index(scrambled_char)-self.rotors[iteration-1].position), reflector_pos)
         logging.debug("Scrambled letter from reflector: {}".format(scrambled_char))
+        
+        # Adjust for reflector position on return path
+        if reflector_pos != 0:
+            scrambled_char = self.shift_letter(scrambled_char, -reflector_pos, self.alphabet_list)
+            
         for rotor in reversed(self.rotors):
             if iteration == len(self.rotors):
                 scrambled_char = rotor.scramble_char(self.alphabet_list,(rotor.wiring.index(self.shift_letter(scrambled_char,rotor.position,self.alphabet_list))-rotor.position), rotor.position)
@@ -96,7 +108,8 @@ class Enigma(Observer,Journaled,Clonable):
             logging.debug("Scrambled letter from rotor{}: {}".format(str(iteration+1),scrambled_char))   
         
         # Processing rotor 1 returning signal by ETW
-        scrambled_char = self.etw.scramble_char(self.alphabet_list,(self.etw.wiring.index(self.shift_letter(scrambled_char, (0 - self.rotors[iteration].position),self.alphabet_list))), 0)
+        # Processing rotor 1 returning signal by ETW
+        scrambled_char = self.etw.scramble_char(self.alphabet_list,(inverted_wiring.index(self.shift_letter(scrambled_char, (0 - self.rotors[iteration].position),self.alphabet_list))), 0)
         logging.debug("Scrambled letter from ETW: {}".format(scrambled_char))
         
         scrambled_char = self.plugboard.scramble_char(self.plugboard.wiring,self.plugboard.alphabet_list.index(scrambled_char),0)

enigmapython-2.0.0/enigmapython/EnigmaDEtw_QWERTZ.py

@@ -0,0 +1,5 @@
+from .EtwQWERTZ import EtwQWERTZ
+
+class EnigmaDEtw_QWERTZ(EtwQWERTZ):
+    """Enigma D ETW with QWERTZ keyboard layout"""
+    pass

enigmapython-2.0.0/enigmapython/EnigmaK.py

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

enigmapython-2.0.0/enigmapython/EnigmaKEtw_QWERTZ.py

@@ -0,0 +1,5 @@
+from .EtwQWERTZ import EtwQWERTZ
+
+class EnigmaKEtw_QWERTZ(EtwQWERTZ):
+    """Enigma K ETW with QWERTZ keyboard layout"""
+    pass

enigmapython-2.0.0/enigmapython/EnigmaKRotorI.py

@@ -0,0 +1,18 @@
+from .Rotor import Rotor
+from .Alphabets import Alphabets
+
+class EnigmaKRotorI(Rotor):
+    
+    wiring = 'lpgszmhaeoqkvxrfybutnicjdw'
+    notch_indexes = [24]  # Y (notch position)
+    tag = "K_I"
+    
+    def __init__(self, position = 0, ring = 0):
+        super().__init__(
+                            wiring = self.wiring, 
+                            position=position, 
+                            ring=ring, 
+                            notch_indexes=self.notch_indexes, 
+                            alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
+                        )
+    

enigmapython-2.0.0/enigmapython/EnigmaKRotorII.py

@@ -0,0 +1,18 @@
+from .Rotor import Rotor
+from .Alphabets import Alphabets
+
+class EnigmaKRotorII(Rotor):
+    
+    wiring = 'slvgbtfxjqohewirzyamkpcndu'
+    notch_indexes = [4]  # E (notch position)
+    tag = "K_II"
+    
+    def __init__(self, position = 0, ring = 0):
+        super().__init__(
+                            wiring = self.wiring, 
+                            position=position, 
+                            ring=ring, 
+                            notch_indexes=self.notch_indexes, 
+                            alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
+                        )
+    

enigmapython-2.0.0/enigmapython/EnigmaKRotorIII.py

@@ -0,0 +1,18 @@
+from .Rotor import Rotor
+from .Alphabets import Alphabets
+
+class EnigmaKRotorIII(Rotor):
+    
+    wiring = 'cjgdpshkturawzxfmynqobvlie'
+    notch_indexes = [13]  # N (position 13)
+    tag = "K_III"
+    
+    def __init__(self, position = 0, ring = 0):
+        super().__init__(
+                            wiring = self.wiring, 
+                            position=position, 
+                            ring=ring, 
+                            notch_indexes=self.notch_indexes, 
+                            alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
+                        )
+    

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/Etw.py

@@ -9,7 +9,6 @@ class Etw(Scrambler):
     def __init__(self, wiring, alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")):
         super().__init__(
             alphabet=alphabet,
-            ring=0,
             wiring=wiring
         )
         self.wiring = wiring

enigmapython-2.0.0/enigmapython/EtwQWERTZ.py

@@ -0,0 +1,7 @@
+from .Etw import Etw
+
+class EtwQWERTZ(Etw):
+    """Shared QWERTZ keyboard layout ETW used by Enigma D and Enigma K"""
+    wiring = "qwertzuioasdfghjkpyxcvbnml"
+    def __init__(self):
+         super().__init__(self.wiring)

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/Plugboard.py

@@ -11,7 +11,6 @@ class Plugboard(Scrambler):
         self.alphabet_list = list(alphabet)
         super().__init__(
             alphabet=alphabet,
-            ring=0,
             wiring=wiring
         )
 

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/ReflectorUKWA.py

@@ -8,6 +8,5 @@ class ReflectorUKWA(Reflector):
     def __init__(self):
         super().__init__(
                             wiring=self.wiring,
-                            ring=0,
                             alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
                         )

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/ReflectorUKWB.py

@@ -8,6 +8,5 @@ class ReflectorUKWB(Reflector):
     def __init__(self):
         super().__init__(
                             wiring=self.wiring,
-                            ring=0,
                             alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
                         )

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/ReflectorUKWBThin.py

@@ -8,6 +8,5 @@ class ReflectorUKWBThin(Reflector):
     def __init__(self):
         super().__init__(
                             wiring=self.wiring,
-                            ring=0,
                             alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
                         )

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/ReflectorUKWC.py

@@ -10,6 +10,5 @@ class ReflectorUKWC(Reflector):
     def __init__(self):
         super().__init__(
                             wiring=self.wiring,
-                            ring=0,
                             alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
                         )

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/ReflectorUKWCThin.py

@@ -10,6 +10,5 @@ class ReflectorUKWCThin(Reflector):
     def __init__(self):
         super().__init__(
                             wiring=self.wiring,
-                            ring=0,
                             alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
                         )

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/ReflectorUKW_EnigmaB_A133.py

@@ -10,6 +10,5 @@ class ReflectorUKW_EnigmaB_A133(Reflector):
     def __init__(self):
         super().__init__(
                             self.wiring,
-                            ring=0, 
                             alphabet=Alphabets.lookup.get("enigma_b_a133_28chars_lowercase")
                         )  

enigmapython-2.0.0/enigmapython/ReflectorUKW_EnigmaCommercial.py

@@ -0,0 +1,15 @@
+from .SettableReflector import SettableReflector
+from .Alphabets import Alphabets
+
+class ReflectorUKW_EnigmaCommercial(SettableReflector):
+    """Shared UKW reflector used by commercial Enigma D and Enigma K"""
+    
+    wiring = 'imetcgfraysqbzxwlhkdvupojn'
+    
+    def __init__(self, position=0, ring=0):
+        super().__init__(
+            wiring=self.wiring,
+            ring=ring,
+            position=position,
+            alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
+        )

enigmapython-1.3.2/enigmapython/ReflectorNorwayUKW.py → enigmapython-2.0.0/enigmapython/ReflectorUKW_EnigmaINorway.py

@@ -1,14 +1,13 @@
 from .Rotor import Rotor
 from .Reflector import Reflector
 from .Alphabets import Alphabets    
-class ReflectorNorwayUKW(Reflector):
+class ReflectorUKW_EnigmaINorway(Reflector):
     
     wiring = 'mowjypuxndsraibfvlkzgqchet'
-    tag = "IN_UKW"
+    tag = "Norway_UKW"
     
     def __init__(self):
         super().__init__(
                             wiring=self.wiring,
-                            ring=0,
                             alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
                         )

enigmapython-1.3.2/enigmapython/ReflectorSonderUKW.py → enigmapython-2.0.0/enigmapython/ReflectorUKW_EnigmaISonder.py

@@ -1,13 +1,12 @@
 from .Alphabets import Alphabets
 from .Reflector import Reflector
-class ReflectorSonderUKW(Reflector):
+class ReflectorUKW_EnigmaISonder(Reflector):
     
     wiring = 'ciagsndrbytpzfulvhekoqxwjm'
-    tag = "IS_UKW"
+    tag = "Sonder_UKW"
     
     def __init__(self):
         super().__init__(
                             wiring=self.wiring,
-                            ring=0,
                             alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
                         )

enigmapython-1.3.2/enigmapython/ReflectorZUKW.py → enigmapython-2.0.0/enigmapython/ReflectorUKW_EnigmaZ.py

@@ -4,7 +4,7 @@ from .Alphabets import Alphabets
 from .RotatingReflector import RotatingReflector
 
 
-class ReflectorZUKW(RotatingReflector):
+class ReflectorUKW_EnigmaZ(RotatingReflector):
     
     wiring = '5079183642'
     notch_indexes = [3]

enigmapython-2.0.0/enigmapython/RotatingReflector.py

@@ -0,0 +1,5 @@
+from .Rotor import Rotor
+from .Reflector import Reflector
+
+class RotatingReflector(Rotor, Reflector):
+    pass

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/Rotor.py

@@ -1,16 +1,13 @@
 from .Observable import Observable
 from .Scrambler import Scrambler
+from .Settable import Settable
 import logging
 
-class Rotor(Scrambler,Observable):
-    position = None
+class Rotor(Scrambler,Observable,Settable):
     rotations_counter = None
     notch_indexes = None
     double_step_triggered = None
 
-    def reset_position(self):
-        self.position = 0
-    
     def increment_position(self):
         self.position = ((self.position + 1) % len(self.wiring))
         self.rotations_counter = self.rotations_counter + 1
@@ -21,18 +18,18 @@ class Rotor(Scrambler,Observable):
                 self.notify_observers(None,None)
 
     def set_position(self,position):
-        self.position = position % len(self.wiring)
+        super().set_position(position % len(self.wiring))
         self.rotations_counter = 0
 
     def __init__(self, wiring, notch_indexes, alphabet, position = 0, ring = 0):
         # Scrambler properties
-        super().__init__(
-            wiring = wiring,
-            ring = ring,
-            alphabet = alphabet
-        )
+        # Scrambler properties
+        Scrambler.__init__(self, wiring=wiring, alphabet=alphabet)
+        # Settable properties
+        Settable.__init__(self, position=position % len(wiring), ring=ring)
+        self.set_ring(self.ring)
+        
         # Rotor properties
-        self.position = position % len(wiring)
         self.notch_indexes = notch_indexes
         self.double_step_triggered = False
         self.rotations_counter = 0

enigmapython-2.0.0/enigmapython/Scrambler.py

@@ -0,0 +1,30 @@
+import logging
+from .Journaled import Journaled
+
+class Scrambler(Journaled):
+    wiring = None
+    alphabet_list = None
+    original_wiring = None
+
+    def scramble_char(self, dictionary, letter_index, shift): 
+        output_char_index = dictionary.index(dictionary[(shift + letter_index) % len(dictionary)])
+        output_char = dictionary[output_char_index]
+        super().append_to_journal({
+            'output_char': output_char
+        })
+        return output_char
+    
+    def __init__(self, wiring, alphabet):
+        #Journaled.__init__(self)
+        super().__init__()
+        self.wiring = wiring
+        self.original_wiring = self.wiring
+        self.alphabet_list = list(alphabet)
+ 
+    def __str__(self):
+        str = ""
+        for char in self.alphabet_list:
+            str += char
+        str += "\n"
+        str += "|" * len(self.alphabet_list)
+        return str

enigmapython-1.3.2/enigmapython/Scrambler.py → enigmapython-2.0.0/enigmapython/Settable.py

@@ -1,35 +1,25 @@
-import logging
-from .Journaled import Journaled
-
-class Scrambler(Journaled):
-    wiring = None
-    alphabet_list = None
-    dot_position = None
-    ring = None
-    set_scrambler_ring = None
-    original_wiring = None
-
-    def scramble_char(self, dictionary, letter_index, shift): 
-        output_char_index = dictionary.index(dictionary[(shift + letter_index) % len(dictionary)])
-        output_char = dictionary[output_char_index]
-        super().append_to_journal({
-            'output_char': output_char
-        })
-        return output_char
+class Settable:
+    position = 0
+    ring = 0
     
-    def __init__(self, wiring, alphabet, ring):
-        #Journaled.__init__(self)
-        super().__init__()
-        self.wiring = wiring
-        self.original_wiring = self.wiring
-        self.alphabet_list = list(alphabet)
+    def __init__(self, position=0, ring=0):
+        self.position = position
         self.ring = ring
-        self.set_scrambler_ring(ring)
+
+    def set_position(self, position):
+        self.position = position
         
+    def reset_position(self):
+        self.position = 0
         
-    def set_scrambler_ring(self, ring):
+    def reset_ring(self):
+        self.set_ring(0)
+        
+    def set_ring(self, ring):
+        self.ring = ring
         self.wiring = self.original_wiring
         self.dot_position = list(self.wiring).index(self.alphabet_list[0])
+        import logging
         logging.debug("Dot position: " + str(self.dot_position))
         for i in range(0, ring):
         # Set temporary wiring variable
@@ -39,7 +29,7 @@ class Scrambler(Journaled):
             # 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 += Scrambler.__shift(char, 1, self.alphabet_list)
+                wiring += self._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(self.alphabet_list)
@@ -53,17 +43,9 @@ class Scrambler(Journaled):
             self.wiring = self.wiring[-1:] + self.wiring[:-1]
             # The following line has been commente out becode not Micropython compatible
             # logging.debug("Rotation " + str(i).zfill(2) + "; Wiring: " + self.wiring)
-         
+
     @staticmethod
-    def __shift(letter, shift, alphabet_list):
+    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)]
-            
-    def __str__(self):
-        str = ""
-        for char in self.alphabet_list:
-            str += char
-        str += "\n"
-        str += "|" * len(self.alphabet_list)
-        return str

enigmapython-2.0.0/enigmapython/SettableReflector.py

@@ -0,0 +1,8 @@
+from .Reflector import Reflector
+from .Settable import Settable
+
+class SettableReflector(Reflector, Settable):
+    def __init__(self, wiring, alphabet, position=0, ring=0):
+        Reflector.__init__(self, wiring=wiring, alphabet=alphabet)
+        Settable.__init__(self, position=position, ring=ring)
+        self.set_ring(self.ring)

enigmapython-2.0.0/enigmapython/Utils.py

@@ -0,0 +1,85 @@
+
+class Utils:
+
+
+    @staticmethod
+    def find_divergence(str1, str2):
+        """
+        Finds the index where two strings first diverge, 
+        and the characters at that index in both strings.
+        
+        Args:
+            str1 (str): The first string.
+            str2 (str): The second string.
+        
+        Returns:
+            tuple: (index, char1, char2) where index is the position of divergence,
+                char1 is the character in str1 at the divergence,
+                and char2 is the character in str2 at the divergence.
+                If the strings only diverge in length, char1 and char2 will be None.
+                If the strings are identical, returns None.
+        """
+        # Iterate through both strings up to the length of the shorter string
+        for i in range(min(len(str1), len(str2))):
+            if str1[i] != str2[i]:
+                return i, str1[i], str2[i]  # Return the index and differing characters
+        
+        # If the strings differ in length
+        if len(str1) != len(str2):
+            return min(len(str1), len(str2)), None, None
+        
+        # If the strings are identical
+        return None
+
+    @staticmethod
+    def find_all_subclasses(cls):
+        return set(cls.__subclasses__()).union(
+            [s for c in cls.__subclasses__() for s in Utils.find_all_subclasses(c)])
+
+    @staticmethod    
+    def swap_chars(string, ch1, ch2):
+        if ch1 == ch2: return string
+        str_list = []
+        for char in string:
+            if char == ch1:
+                str_list.append(ch2)
+            elif char == ch2:
+                str_list.append(ch1)
+            else:
+                str_list.append(char)
+        return ''.join(str_list)
+
+    @staticmethod
+    def inverse_string_permutation(string: str, alphabet: str = None) -> str:
+        """
+        Compute the inverse permutation of a string for any alphabet.
+        
+        string : str
+            A string mapping input -> output
+        alphabet : str, optional
+            The alphabet to use. Defaults to the characters in string length, 
+            starting with the first character of string (e.g., 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
+        
+        Returns
+        -------
+        str
+            The inverse string
+        """
+        n = len(string)
+        
+        # If no alphabet is provided, assume consecutive characters starting from string[0]
+        if alphabet is None:
+            alphabet = ''.join(chr(ord(string[0]) + i) for i in range(n))
+        
+        # Build a dictionary for quick index lookup
+        char_to_index = {char: i for i, char in enumerate(alphabet)}
+        
+        # Initialize inverse list
+        inverse = [''] * n
+        
+        for i, out_char in enumerate(string):
+            index = char_to_index[out_char]
+            inverse[index] = alphabet[i]
+        
+        return ''.join(inverse)
+    

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython/XRay.py

@@ -1,7 +1,7 @@
 from rich.console import Console
 from rich.text import Text
 
-from enigmapython.RotatingReflector import RotatingReflector
+from enigmapython.SettableReflector import SettableReflector
 
 class XRay():
     @staticmethod
@@ -56,8 +56,8 @@ class XRay():
               |     |     {rotor_walls}     |     |     |     |
               +-----+     {rotor_walls_bottom}     +-----+     +-----+
 
-    Pos.:      {"{} ({:02})".format(enigma.alphabet_list[enigma.reflector.position].upper(),enigma.reflector.position) if isinstance(enigma.reflector, RotatingReflector) else ' N/A  '}      {rotors_positions}    
-    Ring:      {"{} ({:02})".format(enigma.alphabet_list[enigma.reflector.ring].upper(),enigma.reflector.ring)}      {rotors_rings}
+    Pos.:      {"{} ({:02})".format(enigma.alphabet_list[enigma.reflector.position].upper(),enigma.reflector.position) if isinstance(enigma.reflector, SettableReflector) else ' N/A  '}      {rotors_positions}    
+    Ring:      {"{} ({:02})".format(enigma.alphabet_list[enigma.reflector.ring].upper(),enigma.reflector.ring) if isinstance(enigma.reflector, SettableReflector) else ' N/A  '}      {rotors_rings}
         """
         console.print(Text(diagram, style="bold"))
         return Text(diagram, style="bold")

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enigmapython
-Version: 1.3.2
+Version: 2.0.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
@@ -27,6 +27,15 @@ Dynamic: summary
 
 Welcome to **enigmapython**, a Python package designed to emulate the legendary Enigma cryptographic machine used during World War II. **enigmapython** provides a faithful implementation of the Enigma machine, allowing users to explore and understand the workings of this historic device.
 
+<br>
+<div class="img-container" style="text-align: center;">
+    <a href="https://asciinema.org/a/761182">
+        <img src="https://asciinema.org/a/761182.svg" alt="asciicast"/>
+    </a>
+</div>
+<br>
+
+
 This project is listed on [Wikipedia](https://en.wikipedia.org/wiki/List_of_Enigma_machine_simulators) as a globally recognized Enigma machine simulator, noted for its historical accuracy.
 
 <div class="img-container" style="text-align: center;"> 
@@ -65,6 +74,7 @@ This project is listed on [Wikipedia](https://en.wikipedia.org/wiki/List_of_Enig
 
 
 - [Authentic German Army Test Message from 1930](https://cryptocellar.org/enigma/e-message-1930.html): Documented by Frode Weierud's CryptoCellar, this test validates that the **Enigma I** implementation correctly handles the complex interaction of rotors, ring settings, and plugboard connections exactly as the original machines did. See the [corresponding unit test](https://github.com/denismaggior8/enigma-python/blob/master/tests/Enigma1930_tests.py) for details.
+- [Authentic U-534 M4 Message P1030700](https://enigma.hoerenberg.com/index.php?cat=The%20U534%20messages&page=P1030700): A message from the U-534 submarine (May 1945), validating the **Enigma M4** implementation (including the Greek rotor and thin reflector) against historical intercepts. See the [corresponding unit test](https://github.com/denismaggior8/enigma-python/blob/master/tests/EnigmaM4_U534_tests.py) for details.
 
 ## Machines implementations
 
@@ -82,12 +92,22 @@ The following Enigma machine models (along with their rotors, reflectors and plu
 
 *given the rarity of this model and the little documentation/simulators available, although I expect an encryption consistency on par with newer models, I was unable to test it as I would have liked
 
+### Enigma K (Commercial Enigma)
+
+| Scrambler 	             | Wiring                    	        | Notch 	| Implemented 	    |
+|-------	                 |----------------------------	        |-------	|-------------      |
+| ETW "QWERTZ"               | qwertzuioasdfghjkpyxcvbnml 	        | N/A     	|   ✅           	|
+| Rotor I                    | lpgszmhaeoqkvxrfybutnicjdw 	        | y     	|   ✅           	|
+| Rotor II                   | slvgbtfxjqohewirzyamkpcndu 	        | e     	|   ✅           	|
+| Rotor III                  | cjgdpshkturawzxfmynqobvlie 	        | n     	|   ✅           	|
+| Reflector UKW              | imetcgfraysqbzxwlhkdvupojn 	        | N/A     	|   ✅           	|
+
+
 ### 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     	|   ✅           	|
@@ -191,7 +211,9 @@ Get started by installing the package from PyPI (`pip install enigmapython`) and
 
 ## 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
+Full API documentation is available on [ReadTheDocs](https://enigmapython.readthedocs.io/).
+
+For additional details, you can also refer to the [local documentation](./docs/README.md), examples, and code comments.
 
 ## Known implementations
 

{enigmapython-1.3.2 → enigmapython-2.0.0}/enigmapython.egg-info/SOURCES.txt

@@ -8,7 +8,6 @@ enigmapython/EnigmaB_A133RotorI.py
 enigmapython/EnigmaB_A133RotorII.py
 enigmapython/EnigmaB_A133RotorIII.py
 enigmapython/EnigmaD.py
-enigmapython/EnigmaDEtw_JWULCM.py
 enigmapython/EnigmaDEtw_QWERTZ.py
 enigmapython/EnigmaDRotorI.py
 enigmapython/EnigmaDRotorII.py
@@ -29,6 +28,11 @@ enigmapython/EnigmaISonder.py
 enigmapython/EnigmaISonderRotorI.py
 enigmapython/EnigmaISonderRotorII.py
 enigmapython/EnigmaISonderRotorIII.py
+enigmapython/EnigmaK.py
+enigmapython/EnigmaKEtw_QWERTZ.py
+enigmapython/EnigmaKRotorI.py
+enigmapython/EnigmaKRotorII.py
+enigmapython/EnigmaKRotorIII.py
 enigmapython/EnigmaM3.py
 enigmapython/EnigmaM3RotorI.py
 enigmapython/EnigmaM3RotorII.py
@@ -56,25 +60,28 @@ enigmapython/EnigmaZRotorII.py
 enigmapython/EnigmaZRotorIII.py
 enigmapython/Etw.py
 enigmapython/EtwPassthrough.py
+enigmapython/EtwQWERTZ.py
 enigmapython/Journaled.py
 enigmapython/Observable.py
 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/ReflectorUKWB.py
 enigmapython/ReflectorUKWBThin.py
 enigmapython/ReflectorUKWC.py
 enigmapython/ReflectorUKWCThin.py
 enigmapython/ReflectorUKW_EnigmaB_A133.py
-enigmapython/ReflectorZUKW.py
+enigmapython/ReflectorUKW_EnigmaCommercial.py
+enigmapython/ReflectorUKW_EnigmaINorway.py
+enigmapython/ReflectorUKW_EnigmaISonder.py
+enigmapython/ReflectorUKW_EnigmaZ.py
 enigmapython/RotatingReflector.py
 enigmapython/Rotor.py
 enigmapython/Scrambler.py
+enigmapython/Settable.py
+enigmapython/SettableReflector.py
 enigmapython/Swappable.py
 enigmapython/SwappablePlugboard.py
 enigmapython/Utils.py

{enigmapython-1.3.2 → enigmapython-2.0.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.3.2",
+    version="2.0.0",
     packages=find_packages(
         # All keyword arguments below are optional:
         where='.',  # '.' by default

enigmapython-1.3.2/enigmapython/EnigmaDEtw_JWULCM.py

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

enigmapython-1.3.2/enigmapython/EnigmaDEtw_QWERTZ.py

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

enigmapython-1.3.2/enigmapython/ReflectorDUKW.py

@@ -1,13 +0,0 @@
-from .Reflector import Reflector
-from .Alphabets import Alphabets    
-class ReflectorDUKW(Reflector):
-    
-    wiring = 'imetcgfraysqbzxwlhkdvupojn'
-    tag = "D_UKW"
-    
-    def __init__(self):
-        super().__init__(
-                            wiring=self.wiring,
-                            ring=0,
-                            alphabet=Alphabets.lookup.get("latin_i18n_26chars_lowercase")
-                        )

enigmapython-1.3.2/enigmapython/RotatingReflector.py

@@ -1,4 +0,0 @@
-from .Rotor import Rotor
-
-class RotatingReflector(Rotor):
-    None

enigmapython-1.3.2/enigmapython/Utils.py

@@ -1,51 +0,0 @@
-
-class Utils:
-
-
-    @staticmethod
-    def find_divergence(str1, str2):
-        """
-        Finds the index where two strings first diverge, 
-        and the characters at that index in both strings.
-        
-        Parameters:
-        str1 (str): The first string.
-        str2 (str): The second string.
-        
-        Returns:
-        tuple: (index, char1, char2) where index is the position of divergence,
-            char1 is the character in str1 at the divergence,
-            and char2 is the character in str2 at the divergence.
-            If the strings only diverge in length, char1 and char2 will be None.
-            If the strings are identical, returns None.
-        """
-        # Iterate through both strings up to the length of the shorter string
-        for i in range(min(len(str1), len(str2))):
-            if str1[i] != str2[i]:
-                return i, str1[i], str2[i]  # Return the index and differing characters
-        
-        # If the strings differ in length
-        if len(str1) != len(str2):
-            return min(len(str1), len(str2)), None, None
-        
-        # If the strings are identical
-        return None
-
-    @staticmethod
-    def find_all_subclasses(cls):
-        return set(cls.__subclasses__()).union(
-            [s for c in cls.__subclasses__() for s in Utils.find_all_subclasses(c)])
-
-    @staticmethod    
-    def swap_chars(string, ch1, ch2):
-        if ch1 == ch2: return string
-        str_list = []
-        for char in string:
-            if char == ch1:
-                str_list.append(ch2)
-            elif char == ch2:
-                str_list.append(ch1)
-            else:
-                str_list.append(char)
-        return ''.join(str_list)
-