passphera-core 0.3.4__py3-none-any.whl → 0.5.0__py3-none-any.whl

passphera_core/__init__.py

@@ -1,2 +1,2 @@
-from .generator import PasswordGenerator
-from .exceptions import InvalidAlgorithmException
+from passphera_core.generator import PasswordGenerator
+from passphera_core.exceptions import InvalidAlgorithmException

passphera_core/exceptions.py

@@ -1,3 +1,3 @@
 class InvalidAlgorithmException(Exception):
     def __init__(self, algorithm: str) -> None:
-        super().__init__(f"Invalid algorithm name {algorithm}")
+        super().__init__(f"Invalid algorithm name [{algorithm}]")

passphera_core/generator.py

@@ -9,29 +9,30 @@ class PasswordGenerator:
     """
     def __init__(
             self,
-            text: str = None,
             shift: int = 3,
             multiplier: int = 3,
-            key_str: str = "secret",
-            key_iter: iter = (9, 4, 5, 7),
-            algorithm: str = 'playfair'
+            key: str = "hill",
+            algorithm: str = 'hill',
+            characters_replacements: dict = None,
+            text: str = None,
     ):
         """
-        :param text: plain text to be ciphered
         :param shift: number of characters to shift each character (default 3)
         :param multiplier: number of characters to shift each character (default 3)
-        :param key_str: cipher key string (default "secret")
-        :param key_iter: cipher key matrix (default (9, 4, 5, 7))
+        :param key: cipher key string (default "secret")
         :param algorithm: main cipher algorithm name (default 'playfair')
+        :param characters_replacements: replace characters with the given values (default {})
+        :param text: plain text to be ciphered
         """
-        self._chars_replacements: dict = {}
-        self._text: str = text
+        if characters_replacements is None:
+            characters_replacements = {}
         self._shift: int = shift
         self._multiplier: int = multiplier
-        self._key_str: str = key_str
-        self._key_iter: iter = key_iter
+        self._key: str = key
         self._algorithm_name: str = algorithm.lower()
         self._algorithm = self._set_algorithm()
+        self._characters_replacements: dict = characters_replacements
+        self._text: str = text
         if text:
             self._password: str = f"secret{self._text.replace(' ', '')}secret"
         else:
@@ -96,42 +97,23 @@ class PasswordGenerator:
         self._multiplier = multiplier
 
     @property
-    def key_str(self) -> str:
+    def key(self) -> str:
         """
         Returns the key string for the cipher algorithm
         Eg: ```key_str = pg.key_str```
         :return: str: The key string for the cipher algorithm
         """
-        return self._key_str
+        return self._key
 
-    @key_str.setter
-    def key_str(self, key_str: str) -> None:
+    @key.setter
+    def key(self, key: str) -> None:
         """
         Sets the key string for the cipher algorithm
-        Eg: ```pg.key_str = 'secret key'```
-        :param key_str: The key string for the cipher algorithm
-        :return:
-        """
-        self._key_str = key_str
-
-    @property
-    def key_iter(self) -> iter:
-        """
-        Returns the key matrix for the cipher algorithm
-        Eg: ```key_iter = pg.key_iter```
-        :return: iter: The key matrix for the cipher algorithm
-        """
-        return self._key_iter
-
-    @key_iter.setter
-    def key_iter(self, key_iter: iter) -> None:
-        """
-        Sets the key matrix for the cipher algorithm
-        Eg: ```pg.key_iter = (9, 5, 2, 4)```
-        :param key_iter: The key matrix for the cipher algorithm
+        Eg: ```pg.key = 'secret key'```
+        :param key: The key string for the cipher algorithm
         :return:
         """
-        self._key_iter = key_iter
+        self._key = key
 
     @property
     def algorithm(self) -> str:
@@ -160,7 +142,7 @@ class PasswordGenerator:
         Eg: ```print(pg.characters_replacements)  # {'a': '@1', 'b': '#2'}```
         :return: dict: The dictionary of the characters replacements
         """
-        return self._chars_replacements
+        return self._characters_replacements
 
     def _set_algorithm(self):
         """
@@ -173,9 +155,9 @@ class PasswordGenerator:
             case 'affine':
                 return AffineCipher(self._multiplier, self._shift)
             case 'playfair':
-                return PlayfairCipher(self._key_str)
+                return PlayfairCipher(self._key)
             case 'hill':
-                return HillCipher(self._key_iter)
+                return HillCipher(self._key)
             case _:
                 raise InvalidAlgorithmException(self._algorithm_name)
 
@@ -193,7 +175,7 @@ class PasswordGenerator:
         :param replacement: The (character|set of characters) to replace the first one
         :return:
         """
-        self._chars_replacements[char[0]] = replacement
+        self._characters_replacements[char[0]] = replacement
 
     def reset_character(self, char: str) -> None:
         """
@@ -201,8 +183,8 @@ class PasswordGenerator:
         :param char: The character to be reset to its original value
         :return:
         """
-        if char in self._chars_replacements:
-            del self._chars_replacements[char]
+        if char in self._characters_replacements:
+            del self._characters_replacements[char]
 
     def generate_raw_password(self) -> str:
         """
@@ -225,6 +207,6 @@ class PasswordGenerator:
         for char in self._password:
             if char in self._text:
                 self._password = self._password.replace(char, char.upper())
-        for char, replacement in self._chars_replacements.items():
+        for char, replacement in self._characters_replacements.items():
             self._password = self._password.replace(char, replacement)
         return self._password

{passphera_core-0.3.4.dist-info → passphera_core-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: passphera-core
-Version: 0.3.4
+Version: 0.5.0
 Summary: The core system of passphera project
 Home-page: https://github.com/passphera/core
 Author: Fathi Abdelmalek
@@ -14,6 +14,6 @@ Classifier: Topic :: Security
 Classifier: Topic :: Security :: Cryptography
 Description-Content-Type: text/markdown
 
-# passphera-cre
+# passphera-core
 
 The core system of passphera project

passphera_core-0.5.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+passphera_core/__init__.py,sha256=ND2D_sTQk5mroNRsKm03PXhx0HNf0740hOtZ4_U98OQ,119
+passphera_core/exceptions.py,sha256=PPZhy05QMVnN3mm6EGj-RgWanMaF3E6aKN4lcpNOJY8,158
+passphera_core/generator.py,sha256=5jYo38QpFqn7up5pg0dyvJ1VkSvQs3WO5k-xlLVaskg,7317
+passphera_core-0.5.0.dist-info/METADATA,sha256=CbdDfk0MdYDNe1K03yEpPo6l-xI1tyMuxFy3xGKluCY,628
+passphera_core-0.5.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+passphera_core-0.5.0.dist-info/top_level.txt,sha256=aDUX2iWGOyfzyf6XakLWTbgeWqNrypMHO074Qratyds,15
+passphera_core-0.5.0.dist-info/RECORD,,

passphera_core-0.3.4.dist-info/RECORD

@@ -1,7 +0,0 @@
-passphera_core/__init__.py,sha256=zDJS1wcjyfEwO4YifFwghhWE3fM2pZNqodx8B4PkGDA,91
-passphera_core/exceptions.py,sha256=M0wVUORrukx2wIkHAz42Sz4BMMY8JssZp7iuHaEjARc,155
-passphera_core/generator.py,sha256=9Iz9ZCwYk4T0syefhErwWN5TentL2KGR_y7FjwB1l-A,7821
-passphera_core-0.3.4.dist-info/METADATA,sha256=5GV9eRooBYFEtkMFrJR3mYFPenHct_eP4xJ8919D_so,627
-passphera_core-0.3.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-passphera_core-0.3.4.dist-info/top_level.txt,sha256=aDUX2iWGOyfzyf6XakLWTbgeWqNrypMHO074Qratyds,15
-passphera_core-0.3.4.dist-info/RECORD,,