des-PurePy 1.0.7__tar.gz → 1.0.8__tar.gz

{des_purepy-1.0.7 → des_purepy-1.0.8}/.github/workflows/python-app.yml

@@ -1,39 +1,39 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
-name: DES-Python
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v3
-      with:
-        python-version: "3.10"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test with pytest
-      run: |
-        pytest test.py
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: DES-Python
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest des_PurePy
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

{des_purepy-1.0.7 → des_purepy-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: des_PurePy
-Version: 1.0.7
+Version: 1.0.8
 Summary: A pure python implementation of DES
 Project-URL: Homepage, https://github.com/Perez-Herrera-Luna/DES-Python
 Author-email: Luna Perez-Herrera <lunaperezherrer@gmail.com>
@@ -21,19 +21,26 @@ Data Encryption Standard (DES) implemented in pure Python
 
 ![Demo](https://github.com/user-attachments/assets/aaa905df-d924-4d52-80f4-b06390c1b523)
 
+## Features
+
+- **Encryption and Decryption**
+- **PKCS5 Padding**
+- **ECB Mode of Operation**
+- **Hex String and Bytes Object Support**
+
 ## Installation
 
 Install using your Python package manager of choice:
 ```bash
-pip install des_Py
+pip install des_PurePy
 ```
 
 ## Usage
 ### Encrypting Hex Strings
 Define a `DES` object while passing in your key. The key can be a hex string or a bytes object.
 ```python
-import des_Py
-des = des_Py.DES("0x133457799bbcdff1")
+import des_PurePy
+des = des_PurePy.DES("0x133457799bbcdff1")
 ```
 You can encrypt by calling `encrypt()` and passing in a hex string or bytes object.
 ```python
@@ -43,3 +50,18 @@ You can simarly decrypt by calling `decrypt()` and passing in a hex string or by
 ```python
 des.decrypt("0x85e813540f0ab405fdf2e174492922f8")    # -> "0x0123456789abcdef"
 ```
+By default, encryption input is padded to a multiple of the block size (8 bytes) according to PKCS5. Inputs that are multiple blocks long are encrypted using the Electronic Code Book (ECB) mode of operation.
+### Encrypting Bytes Objects and Text
+Inputs can be hex strings or bytes objects. The key must always be 8 bytes but the encryption input can have any size. 
+Because of the bytes object support, with some work, you can encrypt and decrypt text.
+```python
+import des_PurePy
+
+key = b"password"
+des = des_PurePy.DES(key)
+
+ciphertext = des.encrypt(b"secret message")                 # -> "0x0d417ca7d23582bab5e2c9277f801591"
+cleartext = des.decrypt(ciphertext)                         # -> "0x736563726574206d657373616765"
+cleartext = bytes.fromhex(cleartext[2:]).decode("utf-8")    # -> "secret message"
+```
+Note that all input is validated so if you passing in an inapropriate input the module will raise a corresponding error.

des_purepy-1.0.8/README.md

@@ -0,0 +1,54 @@
+# DES-Python
+
+![made-with-python](https://img.shields.io/badge/Made%20with-Python%203-1f425f.svg)
+[![license: AGPL-3.0](https://img.shields.io/github/license/Perez-Herrera-Luna/DES-Python.svg)](https://github.com/Perez-Herrera-Luna/DES-Python/blob/main/LICENSE)
+[![DES-Python](https://github.com/Perez-Herrera-Luna/DES-Python/actions/workflows/python-app.yml/badge.svg)](https://github.com/Perez-Herrera-Luna/DES-Python/actions/workflows/python-app.yml)
+
+Data Encryption Standard (DES) implemented in pure Python
+
+![Demo](https://github.com/user-attachments/assets/aaa905df-d924-4d52-80f4-b06390c1b523)
+
+## Features
+
+- **Encryption and Decryption**
+- **PKCS5 Padding**
+- **ECB Mode of Operation**
+- **Hex String and Bytes Object Support**
+
+## Installation
+
+Install using your Python package manager of choice:
+```bash
+pip install des_PurePy
+```
+
+## Usage
+### Encrypting Hex Strings
+Define a `DES` object while passing in your key. The key can be a hex string or a bytes object.
+```python
+import des_PurePy
+des = des_PurePy.DES("0x133457799bbcdff1")
+```
+You can encrypt by calling `encrypt()` and passing in a hex string or bytes object.
+```python
+des.encrypt("0x0123456789abcdef")    # -> "0x85e813540f0ab405fdf2e174492922f8"
+```
+You can simarly decrypt by calling `decrypt()` and passing in a hex string or bytes object.
+```python
+des.decrypt("0x85e813540f0ab405fdf2e174492922f8")    # -> "0x0123456789abcdef"
+```
+By default, encryption input is padded to a multiple of the block size (8 bytes) according to PKCS5. Inputs that are multiple blocks long are encrypted using the Electronic Code Book (ECB) mode of operation.
+### Encrypting Bytes Objects and Text
+Inputs can be hex strings or bytes objects. The key must always be 8 bytes but the encryption input can have any size. 
+Because of the bytes object support, with some work, you can encrypt and decrypt text.
+```python
+import des_PurePy
+
+key = b"password"
+des = des_PurePy.DES(key)
+
+ciphertext = des.encrypt(b"secret message")                 # -> "0x0d417ca7d23582bab5e2c9277f801591"
+cleartext = des.decrypt(ciphertext)                         # -> "0x736563726574206d657373616765"
+cleartext = bytes.fromhex(cleartext[2:]).decode("utf-8")    # -> "secret message"
+```
+Note that all input is validated so if you passing in an inapropriate input the module will raise a corresponding error.

{des_purepy-1.0.7 → des_purepy-1.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "des_PurePy"
-version = "1.0.7"
+version = "1.0.8"
 authors = [
     { name="Luna Perez-Herrera", email="lunaperezherrer@gmail.com" },
 ]

des_purepy-1.0.7/README.md

@@ -1,32 +0,0 @@
-# DES-Python
-
-![made-with-python](https://img.shields.io/badge/Made%20with-Python%203-1f425f.svg)
-[![license: AGPL-3.0](https://img.shields.io/github/license/Perez-Herrera-Luna/DES-Python.svg)](https://github.com/Perez-Herrera-Luna/DES-Python/blob/main/LICENSE)
-[![DES-Python](https://github.com/Perez-Herrera-Luna/DES-Python/actions/workflows/python-app.yml/badge.svg)](https://github.com/Perez-Herrera-Luna/DES-Python/actions/workflows/python-app.yml)
-
-Data Encryption Standard (DES) implemented in pure Python
-
-![Demo](https://github.com/user-attachments/assets/aaa905df-d924-4d52-80f4-b06390c1b523)
-
-## Installation
-
-Install using your Python package manager of choice:
-```bash
-pip install des_Py
-```
-
-## Usage
-### Encrypting Hex Strings
-Define a `DES` object while passing in your key. The key can be a hex string or a bytes object.
-```python
-import des_Py
-des = des_Py.DES("0x133457799bbcdff1")
-```
-You can encrypt by calling `encrypt()` and passing in a hex string or bytes object.
-```python
-des.encrypt("0x0123456789abcdef")    # -> "0x85e813540f0ab405fdf2e174492922f8"
-```
-You can simarly decrypt by calling `decrypt()` and passing in a hex string or bytes object.
-```python
-des.decrypt("0x85e813540f0ab405fdf2e174492922f8")    # -> "0x0123456789abcdef"
-```