herbal 0.1.3

Python package for the Tiny Encryption Algorithm (TEA).

Herbal TEA

Python package for the Tiny Encryption Algorithm (TEA).

The Tiny Encryption Algorithm (TEA) is a simple and efficient block cipher algorithm.

Features

• Supports Python 3.9+.
• Simple typed Python API.
• No third-party dependencies.
• Uses scrypt to derive encryption keys.
• Allow for input text of any length with PKCS#7 padding.

Installation

# Latest stable release.
pip install herbal
# Most recent (unstable) release.
pip install git+https://gitlab.com/lunardev/herbal.git

Usage

from herbal.tea import encrypt, decrypt

password = "secret"
cipher = encrypt("example message!", password=password)
plain = decrypt(cipher, password=password)
print(plain)  # example message!

To-Do

• Implement the Tiny Encryption Algorithm.
• Add padding to plaintext input.
  • [~] ISO 10126
  • PKCS#7
• Implement extended algorithms.
  • XTEA
  • XXTEA
• Add different block ciper modes.
  • Electronic Code Book (ECB)
  • Cipher Block Chaining (CBC)
  • Cipher Feedback Mode (CFB)
  • Output Feedback Mode (OFB)
  • Counter Mode (CTR)
• Add error handling for bad data.
• Add unit tests.
  • Local pytest cases
  • GitLab CI pipeline
  • Code coverage
• Write documentation.
• Publish project to the Python Package Index.

References

1. Wheeler, David J.; Needham, Roger M. TEA, a Tiny Encryption Algorithm. 16 Dec. 1994 https://link.springer.com/content/pdf/10.1007/3-540-60590-8_29.pdf.
2. Shepherd, Simon. The Tiny Encryption Algorithm (TEA). https://www.tayloredge.com/reference/Mathematics/TEA-XTEA.pdf.
3. Andem, Vikram Reddy. A Cryptanalysis of the Tiny Encryption Algorithm, 2003, https://tayloredge.com/reference/Mathematics/VRAndem.pdf.
4. Wikipedia. Tiny Encryption Algorithm, 6 Nov. 2023, https://wikipedia.org/wiki/Tiny_Encryption_Algorithm.
5. Fandom. Tiny Encryption Algorithm, 24 Sept. 2010, https://antifandom.com/cryptography/wiki/Tiny_Encryption_Algorithm.

License

This project is licensed under the MIT License. Copyright (c) 2024.