EZ Crypt Tool for Python

Create and used encryption keys to encrypt any sensitive information used for your application. Can be used by command line, in environment variables, within Python code as a module. Simplies the process and makes it easy to kep sensative information safe.

Operations

Install

pip install ez-crypt-tool

USE

ez_crypt_tool

KEY_FILES: ['.ezcrypt.key', './conf/.ezcrypt.key', '~/.ezcrypt/.ezcrypt.key'] ENV: Environment can be used, skipping key file. Example: export EZCRYPT_KEY=

Step 1: Generate Key or Key File

ez_crypt_tool --genkey
NQYiJixqOhkFWOESyttUvP4ChIcNehpTiyXMGA0eifA=

or

ez_crypt_tool --genkeyfile
NQYiJixqOhkFWOESyttUvP4ChIcNehpTiyXMGA0eifA=

Step 2: Place key in file

Place the key into the ezcrypt.key file, then put the file in one of the 3 locations listed above in KEY_FILES.

Step 3: Use command to encrypt password

ez_crypt_tool --encrypt mypassword
Encrypted:gAAAAABi6DbHCEwLiKHIrolX_oUGA9k-3RjB08-5VW0-lg4FdvGgsiwe1HriMkhLfWRFnMJsbJRvmpULEHbu2Q_EQbFDWaPBxA==

Step 4: Store encrypted password

Place encrypted password in configuration file that can be retrieved by the application.

See example under ./sandbox directory.

Notes

• A prefix of "fenc:" can be prepended to key, to denote encrypted string. Not required.
• This project uses an example example test key.
• The key file [.ezcrypt.key] is in the conf directory.
• Its only for this example and can be used by others to decyrpt your informaiton.

!!! DO NOT REUSE THE INCLUDED KEY !!! GENERATE A NEW KEY BEFORE USING EzCryptTool in your environment

Prerequisites (IMPORTANT)

• Python 3.8.x or greater

• PIP 20.x or greater

• virtualenv 20.14.x or greater

Code Examples

EzCryptTool Python Code

# Import EzCrypt
from ez_crypt_tool.ez_crypt_tool import EzCryptTool

# Initialize the EzCryptTool
ezc = EzCryptTool.get_instance()

# Starting with clear text string
clear_text_pw = "MyCoolPassword"
print(f"Clear Text: {clear_text_pw}")

# Encrypting the string
crypted_password = ezc.encrypt(clear_text_pw)
print(f"Encrypted: {password}")

# decrypting the string
clear_text_pw = ezc.decrypt(crypted_password)
print(f"Decrypted: {clear_text_pw}")

Output

Clear Text: MyCoolPassword
Encrypted: fenc:gAAAAABjk4vdeenLsvEp_WXKCD_pw2a0oNaSI11l-5WLIdAJH4X579N8GOyYHefEPeR03yJymwoViqba9jBWucKHc4ffoev7Eyyn3O7wx3LmyUqRznut8Cw=
Decrypted: MyCoolPassword

Info and History

History

• Initial upload

TODO

• Add generate encryption file
• Add code examples in readme

Author

• damonb123@outlook.com

License

Copyright © 2023, damonb123. Released under the APACHE-2.0.