pyaescbc 0.1.0__tar.gz

pyaescbc-0.1.0/.bumpver.toml

@@ -0,0 +1,9 @@
+[bumpver]
+current_version = "0.1.0"
+version_pattern = "MAJOR.MINOR.PATCH"
+default_level = "patch"
+
+[bumpver.file_patterns]
+"pyaescbc/__version__.py" = [
+    '__version__ = "{version}"'
+]

pyaescbc-0.1.0/.github/workflows/sphinx.yml

@@ -0,0 +1,40 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout the repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.9"
+
+    - name: Install dependencies
+      run: |
+        pip install -r requirements.txt
+        pip install sphinx pydata-sphinx-theme
+
+    - name: Build documentation
+      run: sphinx-build -b html docs/source/ public/
+
+    - name: Deploy to GitHub Pages
+      uses: JamesIves/github-pages-deploy-action@v4
+      
+      with:
+        branch: gh-pages
+        folder: public
+        clean: true

pyaescbc-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Python cache files
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+
+# Virtual environment
+env/
+venv/
+*_pyvenv.cfg
+*.egg-info/
+
+# Laboratory
+laboratory/
+
+# Sphinx documentation
+build/
+
+# Jupyter Notebook checkpoints
+.ipynb_checkpoints/
+
+# IDE files
+.idea/
+.vscode/
+*.sublime-project
+*.sublime-workspace

pyaescbc-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,12 @@
+image: python:3.9
+
+before_script:
+  - pip install -r requirements.txt
+  - pip install sphinx pydata-sphinx-theme
+
+pages:
+  script:
+    - sphinx-build -b html docs/source/ public/
+  artifacts:
+    paths:
+      - public/

pyaescbc-0.1.0/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2025 Artezaru
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

pyaescbc-0.1.0/Makefile

@@ -0,0 +1,60 @@
+# 0. Setting default
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = docs/source
+BUILDDIR      = docs/build
+
+message ?= Default-commit-message
+level ?= patch
+
+# 1. Default help command to list available Sphinx options
+help:
+	@echo "Available commands:"
+	@echo "  help       - Show this help message"
+	@echo "  html       - Generate HTML documentation with sphinx-build (output at docs/build/html/)"
+	@echo "  latexpdf   - Generate LaTeX PDF documentation with Sphinx sphinx-build (output at docs/build/latex/)"
+	@echo "  clean      - Clean the documentation build directory docs/build/"
+	@echo "  bump       - Update the version of the package (default: patch, use level=major/minor/patch)"
+	@echo "  git        - Commit and push changes to master (use message='Your commit message')"
+	@echo "  app        - Build the application with PyInstaller (output at dist/)"
+	@echo "  test       - Run the tests of the package with pytest"
+
+.PHONY: help Makefile
+
+# 2. Generate HTML documentation
+html:
+	$(SPHINXBUILD) -b html $(SOURCEDIR) $(BUILDDIR)/html
+
+# 3. Generate LaTeX PDF documentation
+latexpdf:
+	$(SPHINXBUILD) -b latex $(SOURCEDIR) $(BUILDDIR)/latex
+	cd $(BUILDDIR)/latex && pdflatex pyaescbc.tex && pdflatex pyaescbc.tex
+
+# 4. Clean the documentation
+clean:
+	@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O);
+	cd $(BUILDDIR); mkdir -p html; mkdir -p latex
+
+# 5. Update the version of the package
+bump:
+	bumpver update --$(level) --no-fetch
+
+# 6. Git Push origin Master
+git:
+	git checkout master
+	git add -A .
+	git commit -m "$(message)"
+	git push origin master
+
+# 7. Create the application
+app:
+	echo "from pyaescbc.__main__ import __main_gui__" > run_gui.py
+	echo "__main_gui__()" >> run_gui.py
+	pyinstaller --name pyaescbc --onefile --windowed run_gui.py
+	rm run_gui.py
+	rm -rf build
+	rm run_gui.spec
+
+# 8. Tests the package
+test:
+	pytest tests

pyaescbc-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: pyaescbc
+Version: 0.1.0
+Summary: AES-CBC encryption tools based on crytography package.
+Author-email: Artezaru <artezaru.github@proton.me>
+License: Copyright 2025 Artezaru
+        
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+        
+            http://www.apache.org/licenses/LICENSE-2.0
+        
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+Project-URL: Homepage, https://github.com/Artezaru/pyaescbc
+Project-URL: Documentation, https://Artezaru.github.io/pyaescbc
+Project-URL: Source, https://github.com/Artezaru/pyaescbc
+Project-URL: Tracker, https://github.com/Artezaru/pyaescbc/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=39.0.1
+Provides-Extra: dev
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: pydata-sphinx-theme; extra == "dev"
+Requires-Dist: numpydoc; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: bumpver; extra == "dev"
+Dynamic: license-file
+
+# pyaescbc
+
+## Description
+
+AES-CBC encryption tools based on crytography package !
+
+The package `pyaescbc` provides functions to encrypt and decrypt data using the AES-CBC encryption mode. The package is written in Python and uses the `cryptography` library for the AES encryption and decryption. The package also provides functions to generate a derived key from a password and a pin, and to create an HMAC value from the derived key, IV, and ciphertext. The package is designed to be easy to use and secure, and it is suitable for encrypting sensitive data.
+
+General usage of the package includes:
+
+``` python
+import pyaescbc
+
+# Encryption
+cleardata = bytearray("Hello, World!", 'utf-8')
+pin = bytearray("1234", 'utf-8')
+password = bytearray("password", 'utf-8')
+iterations = pyaescbc.generate_pin_iterations(pin, delete_keys=True)
+authdata = bytearray("user=toto", 'utf-8') # Optional authentication data (can be None)
+encrypted_bundle = pyaescbc.encrypt(cleardata, password, iterations, authdata=authdata, delete_keys=True)
+
+# Decryption
+pin = bytearray("1234", 'utf-8')
+password = bytearray("password", 'utf-8')
+iterations = pyaescbc.generate_pin_iterations(pin, delete_keys=True)
+authdata = bytearray("user=toto", 'utf-8') # Optional authentication data (can be None)
+decrypted_data = pyaescbc.decrypt(encrypted_bundle, password, iterations, authdata=authdata, delete_keys=True)
+
+print(decrypted_data)
+```
+
+![Encryption Process](https://raw.githubusercontent.com/Artezaru/pyaescbc/master/pyaescbc/resources/encrypt.png)
+
+![Decryption Process](https://raw.githubusercontent.com/Artezaru/pyaescbc/master/pyaescbc/resources/decrypt.png)
+
+## Authors
+
+- Artezaru <artezaru.github@proton.me>
+
+- **Git Plateform**: https://github.com/Artezaru/pyaescbc.git
+- **Online Documentation**: https://Artezaru.github.io/pyaescbc
+
+## Installation
+
+Install with pip
+
+```
+pip install pyaescbc
+```
+
+```
+pip install git+https://github.com/Artezaru/pyaescbc.git
+```
+
+Clone with git
+
+```
+git clone https://github.com/Artezaru/pyaescbc.git
+```
+
+## License
+
+Copyright 2025 Artezaru
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

pyaescbc-0.1.0/README.md

@@ -0,0 +1,76 @@
+# pyaescbc
+
+## Description
+
+AES-CBC encryption tools based on crytography package !
+
+The package `pyaescbc` provides functions to encrypt and decrypt data using the AES-CBC encryption mode. The package is written in Python and uses the `cryptography` library for the AES encryption and decryption. The package also provides functions to generate a derived key from a password and a pin, and to create an HMAC value from the derived key, IV, and ciphertext. The package is designed to be easy to use and secure, and it is suitable for encrypting sensitive data.
+
+General usage of the package includes:
+
+``` python
+import pyaescbc
+
+# Encryption
+cleardata = bytearray("Hello, World!", 'utf-8')
+pin = bytearray("1234", 'utf-8')
+password = bytearray("password", 'utf-8')
+iterations = pyaescbc.generate_pin_iterations(pin, delete_keys=True)
+authdata = bytearray("user=toto", 'utf-8') # Optional authentication data (can be None)
+encrypted_bundle = pyaescbc.encrypt(cleardata, password, iterations, authdata=authdata, delete_keys=True)
+
+# Decryption
+pin = bytearray("1234", 'utf-8')
+password = bytearray("password", 'utf-8')
+iterations = pyaescbc.generate_pin_iterations(pin, delete_keys=True)
+authdata = bytearray("user=toto", 'utf-8') # Optional authentication data (can be None)
+decrypted_data = pyaescbc.decrypt(encrypted_bundle, password, iterations, authdata=authdata, delete_keys=True)
+
+print(decrypted_data)
+```
+
+![Encryption Process](https://raw.githubusercontent.com/Artezaru/pyaescbc/master/pyaescbc/resources/encrypt.png)
+
+![Decryption Process](https://raw.githubusercontent.com/Artezaru/pyaescbc/master/pyaescbc/resources/decrypt.png)
+
+## Authors
+
+- Artezaru <artezaru.github@proton.me>
+
+- **Git Plateform**: https://github.com/Artezaru/pyaescbc.git
+- **Online Documentation**: https://Artezaru.github.io/pyaescbc
+
+## Installation
+
+Install with pip
+
+```
+pip install pyaescbc
+```
+
+```
+pip install git+https://github.com/Artezaru/pyaescbc.git
+```
+
+Clone with git
+
+```
+git clone https://github.com/Artezaru/pyaescbc.git
+```
+
+## License
+
+Copyright 2025 Artezaru
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

pyaescbc-0.1.0/docs/source/api.rst

@@ -0,0 +1,9 @@
+API Reference
+==============
+
+The package ``pyaescbc`` is composed of the following functions, classes, and modules:
+
+.. automodule:: pyaescbc
+    :members:
+
+To learn how to use the package effectively, refer to the documentation :doc:`../usage`.

pyaescbc-0.1.0/docs/source/conf.py

@@ -0,0 +1,57 @@
+# This file is used to configure the documentation of the package
+# It is used by the Sphinx documentation generator to generate the documentation
+# The documentation is generated in the docs folder of the package
+# The documentation is generated in HTML and LaTeX format
+
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# 0. Import the necessary modules
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath("../.."))
+
+# 1. Set the project informations
+
+def read_version():
+    version_file = os.path.join(os.path.dirname(__file__), '..', '..', 'pyaescbc', '__version__.py')
+    with open(version_file, "r") as file:
+        exec(file.read()) 
+    return locals()["__version__"]
+
+project = "pyaescbc"
+copyright = "2025-%Y, Artezaru"
+author = "Artezaru"
+release = read_version()
+
+# 2. General configuration
+
+import pydata_sphinx_theme
+html_theme = "pydata_sphinx_theme"
+
+extensions = [
+    "sphinx.ext.autodoc", # Automatically document the code
+    "sphinx.ext.viewcode", # Add links to the code
+    "sphinx.ext.napoleon", # Support for Google and Numpy docstring formats
+    "sphinx.ext.githubpages", # Publish the documentation on GitHub
+    "sphinx.ext.autosummary", # Generate summaries of the modules
+]
+
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+
+# 3. Options for Latex output
+
+latex_elements = {
+    "papersize": "a4paper",
+    "pointsize": "10pt",
+    "preamble": "",
+}
+
+latex_documents = [
+    ("index", "pyaescbc.tex", "pyaescbc Documentation",
+     "Artezaru", "manual"),
+]

pyaescbc-0.1.0/docs/source/index.rst

@@ -0,0 +1,57 @@
+Welcome to pyaescbc's documentation!
+=========================================================================================
+
+Description of the package
+--------------------------
+
+AES-CBC encryption tools based on crytography package !
+
+The package `pyaescbc` provides functions to encrypt and decrypt data using the AES-CBC encryption mode. 
+The package is written in Python and uses the `cryptography` library for the AES encryption and decryption. 
+The package also provides functions to generate a derived key from a password and a pin, and to create an HMAC value from the derived key, IV, and ciphertext. 
+The package is designed to be easy to use and secure, and it is suitable for encrypting sensitive data.
+
+The encryption process is designed as follow :
+
+.. image:: ../../pyaescbc/resources/encrypt.png
+    :align: center
+
+The decryption process is designed as follow :
+
+.. image:: ../../pyaescbc/resources/decrypt.png
+    :align: center
+
+Contents
+--------
+
+The documentation is divided into the following sections:
+
+- **Installation**: This section describes how to install the package.
+- **API Reference**: This section contains the documentation of the package's API.
+- **Usage**: This section contains the documentation of how to use the package.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   ./installation
+   ./api
+   ./usage
+
+
+Author
+------
+
+The package ``pyaescbc`` was created by the following authors:
+
+- Artezaru <artezaru.github@proton.me>
+
+You can access the package and the documentation with the following URL:
+
+- **Git Plateform**: https://github.com/Artezaru/pyaescbc.git
+- **Online Documentation**: https://Artezaru.github.io/pyaescbc
+
+License
+-------
+
+Please refer to the [LICENSE] file for the license of the package.

pyaescbc-0.1.0/docs/source/installation.rst

@@ -0,0 +1,31 @@
+Installation
+============
+
+To install ``pyaescbc``, you can use the following command:
+
+.. code-block:: bash
+
+    pip install pyaescbc
+
+Or install it directly from the GitHub repository using:
+
+.. code-block:: bash
+
+    pip install git+https://github.com/Artezaru/pyaescbc.git
+
+Development Installation
+------------------------------
+
+To install the package for development, first clone the repository using:
+
+.. code-block:: bash
+
+    git clone https://github.com/Artezaru/pyaescbc.git
+
+Then, go to the directory and run the following command:
+
+.. code-block:: bash
+
+    pip install -e .
+
+Use ``-e .[dev]`` to install it with the development dependencies.

pyaescbc-0.1.0/docs/source/usage.rst

@@ -0,0 +1,56 @@
+Usage
+==============
+
+Package usage
+-------------
+
+To encrypt a message, use the following code, available in the `examples` directory of the package:
+
+.. literalinclude:: ../../examples/encrypt.py
+
+The iteration can also be generated randomly, using :func:`pyaescbc.generate_random_iterations`.
+
+Type convertion
+-----------------
+
+If your clear data is a string, you can convert them to bytearray using the following code:
+
+.. code-block:: python
+
+    # Convert a string to bytearray
+    string = "Hello, World!"
+    byte_array = bytearray(string, 'utf-8')
+
+Similarly, after decrypting, you can convert the bytearray back to a string using the following code:
+
+.. code-block:: python
+
+    # Convert a bytearray to string
+    decrypted_string = byte_array.decode('utf-8')
+    print(decrypted_string)  # Output: Hello, World!
+
+For encrypted data (ie the ``encrypted_bundle``), the type is a bytearray but it can't be converted to a string using ``utf-8``.
+This is because the encrypted data is not a valid UTF-8 string.
+
+I recommend to save the encrypted data in a file or a database as a bytearray, and then read it back as a bytearray when you need to decrypt it.
+
+Otherwise, you can convert the bytearray to a base64 string using the following code:
+
+.. code-block:: python
+
+    import base64
+
+    # Convert bytearray to base64 string
+    encrypted_bundle = bytearray(b'\x00\x01\x02\x03')
+    base64_string = base64.b64encode(encrypted_bundle).decode('utf-8')
+    print(base64_string) 
+
+The base64 string can be saved in a file or a database as a string, and then read it back as a base64 string when you need to decrypt it.
+To reconvert the base64 string to a bytearray, you can use the following code:
+
+.. code-block:: python
+
+    # Convert base64 string to bytearray
+    base64_string = "AAECAw=="
+    encrypted_bundle = bytearray(base64.b64decode(base64_string))
+    print(encrypted_bundle) 

pyaescbc-0.1.0/examples/encrypt.py

@@ -0,0 +1,18 @@
+import pyaescbc
+
+# Encryption
+cleardata = bytearray("Hello, World!", 'utf-8')
+pin = bytearray("1234", 'utf-8')
+password = bytearray("password", 'utf-8')
+iterations = pyaescbc.generate_pin_iterations(pin, delete_keys=True)
+authdata = bytearray("user=toto", 'utf-8') # Optional authentication data (can be None)
+encrypted_bundle = pyaescbc.encrypt(cleardata, password, iterations, authdata=authdata, delete_keys=True)
+
+# Decryption
+pin = bytearray("1234", 'utf-8')
+password = bytearray("password", 'utf-8')
+iterations = pyaescbc.generate_pin_iterations(pin, delete_keys=True)
+authdata = bytearray("user=toto", 'utf-8') # Optional authentication data (can be None)
+decrypted_data = pyaescbc.decrypt(encrypted_bundle, password, iterations, authdata=authdata, delete_keys=True)
+
+print(decrypted_data)

pyaescbc-0.1.0/pyaescbc/__init__.py

@@ -0,0 +1,64 @@
+# Copyright 2025 Artezaru
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .__version__ import __version__
+
+from .decrypt_AES_CBC import decrypt_AES_CBC
+from .derive_key import derive_key
+from .encrypt_AES_CBC import encrypt_AES_CBC
+
+from .cleardata_to_encrypted_bundle import cleardata_to_encrypted_bundle
+encrypt = cleardata_to_encrypted_bundle
+from .encrypted_bundle_to_cleardata import encrypted_bundle_to_cleardata
+decrypt = encrypted_bundle_to_cleardata
+
+from .create_encrypted_bundle import create_encrypted_bundle
+from .extract_cryptography_components import extract_cryptography_components
+
+from .generate_random_iterations import generate_random_iterations
+from .generate_pin_iterations import generate_pin_iterations
+
+from .random_bytearray import random_bytearray
+from .random_iv import random_iv
+from .random_salt import random_salt
+
+from .create_hmac import create_hmac
+from .check_hmac import check_hmac
+from .auth_error import AuthError
+
+from .delete_bytearray import delete_bytearray
+
+__all__ = [
+    "__version__",
+    "decrypt_AES_CBC",
+    "derive_key",
+    "encrypt_AES_CBC",
+    "cleardata_to_encrypted_bundle",
+    "encrypt",
+    "encrypted_bundle_to_cleardata",
+    "decrypt",
+    "create_encrypted_bundle",
+    "extract_cryptography_components",
+    "generate_random_iterations",
+    "generate_pin_iterations",
+    "random_bytearray",
+    "random_iv",
+    "random_salt",
+    "create_hmac",
+    "check_hmac",
+    "AuthError",
+    "delete_bytearray",
+]
+
+