Encrypt and decrypt files and streams in AES Crypt format (version 2)
Project description
About pyAesCrypt
pyAesCrypt is a Python 3 file-encryption module and script that uses AES256-CBC to encrypt/decrypt files and binary streams.
pyAesCrypt is compatible with the AES Crypt file format (version 2).
It is Free Software, released under the Apache License, Version 2.0.
pyAesCrypt is brought to you by Marco Bellaccini - marco.bellaccini(at!)gmail.com.
IMPORTANT SECURITY NOTE: version 2 of the AES Crypt file format does not authenticate the “file size modulo 16” byte. This implies that an attacker with write access to the encrypted file may alter the corresponding plaintext file size by up to 15 bytes.
NOTE: there is no low-level memory management in Python, hence it is not possible to wipe memory areas were sensitive information was stored.
Module usage example
Here is an example showing encryption and decryption of a file:
import pyAesCrypt
password = "please-use-a-long-and-random-password"
# encrypt
pyAesCrypt.encryptFile("data.txt", "data.txt.aes", password)
# decrypt
pyAesCrypt.decryptFile("data.txt.aes", "dataout.txt", password)
This is the most straightforward way to use pyAesCrypt, and should be preferred.
If you need to specify a custom buffer size (default is 64KB), you can pass it as an optional argument:
import pyAesCrypt
# custom encryption/decryption buffer size (default is 64KB)
bufferSize = 128 * 1024
password = "please-use-a-long-and-random-password"
# encrypt
pyAesCrypt.encryptFile("data.txt", "data.txt.aes", password, bufferSize)
# decrypt
pyAesCrypt.decryptFile("data.txt.aes", "dataout.txt", password, bufferSize)
In case you need it, you can work with binary streams too:
import pyAesCrypt
from os import stat, remove
# encryption/decryption buffer size - 64K
# with stream-oriented functions, setting buffer size is mandatory
bufferSize = 64 * 1024
password = "please-use-a-long-and-random-password"
# encrypt
with open("data.txt", "rb") as fIn:
with open("data.txt.aes", "wb") as fOut:
pyAesCrypt.encryptStream(fIn, fOut, password, bufferSize)
# decrypt
with open("data.txt.aes", "rb") as fIn:
try:
with open("dataout.txt", "wb") as fOut:
# decrypt file stream
pyAesCrypt.decryptStream(fIn, fOut, password, bufferSize)
except ValueError:
# remove output file on error
remove("dataout.txt")
you can also perform in-memory encryption/decryption (using BytesIO):
import pyAesCrypt
import io
bufferSize = 64 * 1024
password = "please-use-a-long-and-random-password"
# binary data to be encrypted
pbdata = b"This is binary plaintext \x00\x01"
# input plaintext binary stream
fIn = io.BytesIO(pbdata)
# initialize ciphertext binary stream
fCiph = io.BytesIO()
# initialize decrypted binary stream
fDec = io.BytesIO()
# encrypt stream
pyAesCrypt.encryptStream(fIn, fCiph, password, bufferSize)
# print encrypted data
print("This is the ciphertext:\n" + str(fCiph.getvalue()))
# go back to the start of the ciphertext stream
fCiph.seek(0)
# decrypt stream
pyAesCrypt.decryptStream(fCiph, fDec, password, bufferSize)
# print decrypted data
print("Decrypted data:\n" + str(fDec.getvalue()))
Script usage examples
Encrypt file test.txt in test.txt.aes:
pyAesCrypt -e test.txt
Decrypt file test.txt.aes in test.txt:
pyAesCrypt -d test.txt.aes
Encrypt file test.txt in test2.txt.aes:
pyAesCrypt -e test.txt -o test2.txt.aes
Decrypt file test.txt.aes in test2.txt:
pyAesCrypt -d test.txt.aes -o test2.txt
FAQs
Is pyAesCrypt malware?
NO! Of course it isn’t!
Nevertheless, being a module, it can be used by any other software, including malware.
In fact, it has been reported that it is used as crypto library by some ransomware.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pyAesCrypt-6.1.1.tar.gz
.
File metadata
- Download URL: pyAesCrypt-6.1.1.tar.gz
- Upload date:
- Size: 14.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6bf8f97c03ec0e42008da911ac25e523f11f160f684d5f2bc9579ce501be9eae |
|
MD5 | 303279ab48538621e4f908b8b427c6d8 |
|
BLAKE2b-256 | 291759bdb5f36bcf376d11ea16f5d1b4113b783a3ff0b201ff34cec91f836bde |
File details
Details for the file pyAesCrypt-6.1.1-py3-none-any.whl
.
File metadata
- Download URL: pyAesCrypt-6.1.1-py3-none-any.whl
- Upload date:
- Size: 16.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 302ac75aa76d70e3e42c56c445e2581e24fabac7ae2e309deb7b8b2c6da95e39 |
|
MD5 | 88e3b075a3a0cb5890311f87ed254969 |
|
BLAKE2b-256 | e9b07ec8433044d6e178fb6cc5e559d8027dad72f6d6b17b56e955013413ba21 |