p3lib 1.1.100__py3-none-any.whl → 1.1.101__py3-none-any.whl

p3lib/file_io.py

@@ -0,0 +1,154 @@
+import json
+import os
+from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC
+from cryptography.hazmat.primitives.hashes import SHA256
+from cryptography.hazmat.backends import default_backend
+from cryptography.fernet import Fernet
+from base64 import urlsafe_b64encode
+
+class CryptFile(object):
+    """@brief Responsible for encrypting and decrypting data to/from files using a password."""
+
+    def __init__(self,
+                 filename: str,
+                 password: str,
+                 add_enc_extension: bool = True,
+                 dict_data: bool = True):
+        """@brief Constructor
+           @param filename The filename to save the data into.
+           @param password The password to used encrypt data to and load encrypted data from file.
+           @param add_enc_extension If True then the .enc extension is added to the filename
+                                    supplied.
+           @param dict_data If True the data is a python dictionary."""
+        self._filename = filename
+        self._password = password
+        self._add_enc_extension = add_enc_extension
+        self._dict_data = dict_data
+
+        if not self._filename:
+            raise Exception("No filename defined to save data to.")
+
+        if len(self._filename) < 1:
+            raise Exception("No filename defined. String length = 0.")
+
+        if not self._password:
+            raise Exception("No password defined to encrypt/decrypt data.")
+
+        if len(self._password) < 1:
+            raise Exception("No password defined. String length = 0.")
+
+        self._add_extension()
+
+    def save(self,
+             data):
+        """@brief Save the data to an encrypted file.
+           @param data The data to be encrypted.
+        """
+        encrypted_data = self._encrypt_data(data)
+        with open(self._filename, "wb") as file:
+            file.write(encrypted_data)
+
+    def load(self):
+        """@brief Load data from an encrypted file.
+           @return The decrypted data.
+        """
+        with open(self._filename, "rb") as file:
+            data_bytes = file.read()
+        return self._decrypt_data(data_bytes)
+
+    def _decrypt_data(self, encrypted_data):
+        # Extract the salt (first 16 bytes) from the encrypted data
+        salt = encrypted_data[:16]
+        encrypted_content = encrypted_data[16:]
+        key = self._derive_key_from_password(salt)
+        fernet = Fernet(key)
+        decrypted_data = fernet.decrypt(encrypted_content)
+        if self._dict_data:
+             # Convert bytes back to a dict
+            data = json.loads(decrypted_data.decode())
+
+        else:
+            data = decrypted_data
+
+        return  data
+
+    def get_file(self):
+        """@return Get the name of the encrypted file."""
+        return self._filename
+
+    def _add_extension(self):
+        """@brief Add the enc extension to the filename if required."""
+        if self._add_enc_extension and self._filename and not self._filename.endswith('.enc') :
+            self._filename = self._filename + ".enc"
+
+    def _derive_key_from_password(self,
+                                  salt: bytes) -> bytes:
+        kdf = PBKDF2HMAC(
+            algorithm=SHA256(),
+            length=32,
+            salt=salt,
+            iterations=100_000,
+            backend=default_backend(),
+        )
+        return urlsafe_b64encode(kdf.derive(self._password.encode()))
+
+    def _encrypt_data(self,
+                      data):
+        # Generate a random salt for key derivation
+        salt = os.urandom(16)
+        key = self._derive_key_from_password(salt)
+        fernet = Fernet(key)
+        # If we expect a dict
+        if self._dict_data:
+            data_bytes = json.dumps(data).encode()  # Convert JSON to bytes
+
+        # else check we have bytes
+        elif isinstance(data, bytes):
+            data_bytes = data
+
+        else:
+            raise Exception("data to be stored is not a bytes instance.")
+
+        encrypted_data = fernet.encrypt(data_bytes)
+        return salt + encrypted_data  # Store the salt with the encrypted data
+
+# Example usage
+if __name__ == "__main__":
+
+    password = input("Enter a password for encryption: ")
+
+    # JSON data to encrypt
+    json_data = {
+        "name": "Alice",
+        "age": 30,
+        "is_admin": True,
+        "preferences": {
+            "theme": "dark",
+            "language": "English"
+        }
+    }
+
+    filename = "afile.txt"
+
+    # Save and load a python dict
+    cjf = CryptFile(filename=filename,
+                password=password)
+    cjf.save(json_data)
+    print(f"Saved {cjf.get_file()}")
+
+    decrypted_data = cjf.load()
+    print(f"Decrypted data: {decrypted_data}")
+
+
+    # Save and load data bytes
+    data_bytes = "123".encode()
+    cjf = CryptFile(filename=filename,
+                    password=password,
+                    dict_data=False)
+    cjf.save(data_bytes)
+    print(f"Saved {cjf.get_file()}")
+
+    decrypted_data = cjf.load()
+    print("Decrypted data:")
+    for _byte in decrypted_data:
+        print(f"_byte={_byte}")

{p3lib-1.1.100.dist-info → p3lib-1.1.101.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.100
+Version: 1.1.101
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 Author: Paul Austen

{p3lib-1.1.100.dist-info → p3lib-1.1.101.dist-info}/RECORD

@@ -5,6 +5,7 @@ p3lib/bokeh_gui.py,sha256=55sajP_x9O1lE0uP3w3-T5f2oMzk7jSolLqxlEdLeLg,40245
 p3lib/boot_manager.py,sha256=l7WlaoIRt4cu2jAdCs3FnDeNO2v2jzqideNZ3qg2r_4,19652
 p3lib/conduit.py,sha256=jPkjdtyCx2I6SFqcEo8y2g7rgnZ-jNY7oCuYIETzT5Q,6046
 p3lib/database_if.py,sha256=XKu1w3zftGbj4Rh54wrWJnoCtqHkhCzJUPN2S70XIKg,11915
+p3lib/file_io.py,sha256=A7_GKYPlmjRjq6U1YuWhmB0OhLhNm6cWQfQX8qfgYTk,5041
 p3lib/helper.py,sha256=xTKPgpziwr4zyaoc0sjZRFr0M91fo7Tok_nSAvtiTZE,12020
 p3lib/json_networking.py,sha256=6u4s1SmypjTYPnSxHP712OgQ3ZJaxOqIkgHQ1J7Qews,9738
 p3lib/mqtt_rpc.py,sha256=6LmFA1kR4HSJs9eWbOJORRHNY01L_lHWjvtE2fmY8P8,10511
@@ -15,8 +16,8 @@ p3lib/pconfig.py,sha256=2yZUK5nkqpAm4Y_xcJq5H9Lxmc8dfYei1Pi0Ek2Crh0,35376
 p3lib/ssh.py,sha256=OyoAQ_h1L2RfkjTAChDrvLFfl4Fe_gBNdX5rvK-wKiw,42125
 p3lib/table_plot.py,sha256=RPncwVlGUkkx5Fw0dHQedXo0TSPlTi__VrJBDzaMsuI,32116
 p3lib/uio.py,sha256=Aaxc99XiE3d2f9vLjaN-bZsckoNxay5t0ujdK6PXGrw,23265
-p3lib-1.1.100.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.100.dist-info/METADATA,sha256=z6-lX_HWH1ILG4DcC_z6OssgJQwXN6lhfDplHVAERog,919
-p3lib-1.1.100.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-p3lib-1.1.100.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.100.dist-info/RECORD,,
+p3lib-1.1.101.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.101.dist-info/METADATA,sha256=gdbF0zh48zjUc6LXovhTgsfcFldo1mzLJBClcS9iJL4,919
+p3lib-1.1.101.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
+p3lib-1.1.101.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.101.dist-info/RECORD,,

{p3lib-1.1.100.dist-info → p3lib-1.1.101.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.7.0)
 Root-Is-Purelib: true
 Tag: py3-none-any