python3-cyberfusion-file-support 1.1.1.2__tar.gz → 1.2__tar.gz

{python3_cyberfusion_file_support-1.1.1.2 → python3_cyberfusion_file_support-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python3-cyberfusion-file-support
-Version: 1.1.1.2
+Version: 1.2
 Summary: Library for idempotent writing to files.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-file-support

{python3_cyberfusion_file_support-1.1.1.2 → python3_cyberfusion_file_support-1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python3-cyberfusion-file-support"
-version = "1.1.1.2"
+version = "1.2"
 description = "Library for idempotent writing to files."
 readme = "README.md"
 authors = [

{python3_cyberfusion_file_support-1.1.1.2 → python3_cyberfusion_file_support-1.2}/src/cyberfusion/FileSupport/__init__.py

@@ -1,8 +1,9 @@
 """Classes for files."""
 
 import difflib
-import filecmp
+
 import os
+
 from typing import List, Optional, Union
 
 from cyberfusion.Common import get_tmp_file
@@ -11,13 +12,27 @@ from cyberfusion.QueueSupport.items.command import CommandItem
 from cyberfusion.QueueSupport.items.copy import CopyItem
 from cyberfusion.QueueSupport.items.unlink import UnlinkItem
 
+from cyberfusion.FileSupport.encryption import (
+    EncryptionProperties,
+    encrypt_file,
+    decrypt_file,
+)
+from cyberfusion.FileSupport.exceptions import DecryptionError
+
 
 class _DestinationFile:
     """Represents destination file."""
 
-    def __init__(self, *, path: str) -> None:
-        """Set attributes."""
+    def __init__(
+        self, *, path: str, encryption_properties: Optional[EncryptionProperties] = None
+    ) -> None:
+        """Set attributes.
+
+        If 'encryption_properties' is specified, and the destination file already
+        exists, it must be encrypted using the same properties (it is decrypted).
+        """
         self.path = path
+        self.encryption_properties = encryption_properties
 
     @property
     def exists(self) -> bool:
@@ -27,11 +42,19 @@ class _DestinationFile:
     @property
     def contents(self) -> Optional[str]:
         """Get contents."""
-        if self.exists:
+        if not self.exists:
+            return None
+
+        if not self.encryption_properties:
             with open(self.path, "r") as f:
                 return f.read()
 
-        return None
+        try:
+            return decrypt_file(self.encryption_properties, self.path)
+        except DecryptionError as e:
+            raise DecryptionError(
+                f"Decrypting the destination file at '{self.path}' failed. Note that the file must already be encrypted using the specified encryption properties."
+            ) from e
 
 
 class DestinationFileReplacement:
@@ -41,33 +64,37 @@ class DestinationFileReplacement:
         self,
         queue: Queue,
         *,
-        contents: Union[str, bytes],
+        contents: str,
         destination_file_path: str,
         default_comment_character: Optional[str] = None,
         command: Optional[List[str]] = None,
         reference: Optional[str] = None,
+        encryption_properties: Optional[EncryptionProperties] = None,
     ) -> None:
         """Set attributes.
 
         'default_comment_character' has no effect when 'contents' is not string.
+
+        If 'encryption_properties' is specified, and the destination file already
+        exists, it must be encrypted using the same properties (it is decrypted).
         """
         self.queue = queue
         self._contents = contents
         self.default_comment_character = default_comment_character
         self.command = command
         self.reference = reference
+        self.encryption_properties = encryption_properties
 
         self.tmp_path = get_tmp_file()
-        self.destination_file = _DestinationFile(path=destination_file_path)
+        self.destination_file = _DestinationFile(
+            path=destination_file_path, encryption_properties=encryption_properties
+        )
 
-        self._write_to_tmp_file()
+        self.write_to_file(self.tmp_path)
 
     @property
-    def contents(self) -> Union[str, bytes]:
+    def contents(self) -> str:
         """Get contents."""
-        if not isinstance(self._contents, str):
-            return self._contents
-
         if self._contents != "" and not self._contents.endswith(
             "\n"
         ):  # Some programs require newline to consider last line completed
@@ -84,22 +111,32 @@ class DestinationFileReplacement:
 
         return default_comment + self._contents
 
-    def _write_to_tmp_file(self) -> None:
-        """Write contents to tmp file."""
-        if isinstance(self.contents, bytes):
+    def write_to_file(self, path: str) -> None:
+        """Write contents to file."""
+        contents: Union[str, bytes]
+
+        if self.encryption_properties:
             open_mode = "wb"
+
+            contents = encrypt_file(
+                self.encryption_properties,
+                self.contents,
+            )
         else:
             open_mode = "w"
 
-        with open(self.tmp_path, open_mode) as f:
-            f.write(self.contents)
+            contents = self.contents
+
+        with open(path, open_mode) as f:
+            f.write(contents)
 
     @property
     def changed(self) -> bool:
         """Get if destination file will change."""
-        return not self.destination_file.exists or not filecmp.cmp(
-            self.tmp_path, self.destination_file.path
-        )
+        if not self.destination_file.exists:
+            return True
+
+        return self.destination_file.contents != self.contents
 
     @property
     def differences(self) -> List[str]:
@@ -107,9 +144,6 @@ class DestinationFileReplacement:
 
         No differences are returned when contents is not string.
         """
-        if not isinstance(self._contents, str):
-            return []
-
         results = []
 
         for line in difflib.unified_diff(
@@ -118,7 +152,7 @@ class DestinationFileReplacement:
                 if self.destination_file.contents
                 else []
             ),
-            self.contents.splitlines(),  # type: ignore[arg-type]
+            self.contents.splitlines(),
             fromfile=self.tmp_path,
             tofile=self.destination_file.path,
             lineterm="",

python3_cyberfusion_file_support-1.2/src/cyberfusion/FileSupport/encryption.py

@@ -0,0 +1,65 @@
+"""Utilities for file encryption."""
+
+import subprocess
+from dataclasses import dataclass
+from enum import Enum
+
+from cyberfusion.FileSupport.exceptions import EncryptionError, DecryptionError
+
+
+class MessageDigestEnum(str, Enum):
+    """Message digests supported by OpenSSL."""
+
+    MD2 = "md2"
+    MD5 = "md5"
+    SHA = "sha"
+    SHA1 = "sha1"
+
+
+@dataclass
+class EncryptionProperties:
+    """Properties to encrypt files, needed by OpenSSL."""
+
+    cipher_name: str  # Get options with `openssl list -cipher-algorithms`
+    message_digest: MessageDigestEnum
+    password_file_path: str  # Create password with `openssl rand -hex 128`
+
+
+def encrypt_file(encryption_properties: EncryptionProperties, contents: str) -> bytes:
+    """Get contents for file to encrypt."""
+    try:
+        return subprocess.check_output(
+            [
+                "openssl",
+                "enc",
+                "-" + encryption_properties.cipher_name,
+                "-md",
+                encryption_properties.message_digest,
+                "-pass",
+                "file:" + encryption_properties.password_file_path,
+            ],
+            input=contents.encode(),
+        )
+    except subprocess.CalledProcessError as e:
+        raise EncryptionError from e
+
+
+def decrypt_file(encryption_properties: EncryptionProperties, path: str) -> str:
+    """Get contents of encrypted file."""
+    try:
+        return subprocess.check_output(
+            [
+                "openssl",
+                "enc",
+                "-d",
+                "-" + encryption_properties.cipher_name,
+                "-md",
+                encryption_properties.message_digest,
+                "-pass",
+                "file:" + encryption_properties.password_file_path,
+                "-in",
+                path,
+            ]
+        ).decode()
+    except subprocess.CalledProcessError as e:
+        raise DecryptionError from e

python3_cyberfusion_file_support-1.2/src/cyberfusion/FileSupport/exceptions.py

@@ -0,0 +1,13 @@
+"""Exceptions."""
+
+
+class EncryptionError(Exception):
+    """Encrypting failed."""
+
+    pass
+
+
+class DecryptionError(Exception):
+    """Decrypting failed."""
+
+    pass

{python3_cyberfusion_file_support-1.1.1.2 → python3_cyberfusion_file_support-1.2}/src/python3_cyberfusion_file_support.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python3-cyberfusion-file-support
-Version: 1.1.1.2
+Version: 1.2
 Summary: Library for idempotent writing to files.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-file-support

{python3_cyberfusion_file_support-1.1.1.2 → python3_cyberfusion_file_support-1.2}/src/python3_cyberfusion_file_support.egg-info/SOURCES.txt

@@ -2,6 +2,8 @@ README.md
 pyproject.toml
 setup.cfg
 src/cyberfusion/FileSupport/__init__.py
+src/cyberfusion/FileSupport/encryption.py
+src/cyberfusion/FileSupport/exceptions.py
 src/python3_cyberfusion_file_support.egg-info/PKG-INFO
 src/python3_cyberfusion_file_support.egg-info/SOURCES.txt
 src/python3_cyberfusion_file_support.egg-info/dependency_links.txt