Skip to main content

Secure File Encryption Library

Project description

securefilecrypt — Simple AES-GCM File Encryption

SecureFileCrypt is a Python utility for encrypting and decrypting files using AES-256-GCM with password-based key derivation (PBKDF2-HMAC-SHA256).
It is designed for ease of use while providing strong, modern encryption with authentication to ensure data confidentiality and integrity.

Features

  • AES-256 in Galois/Counter Mode (GCM) for authenticated encryption
  • Password-based key derivation using PBKDF2-HMAC-SHA256 with configurable iterations
  • Random salt and nonce generated for each encryption
  • Automatic salt length derived from password characteristics
  • Simple file-based workflow: encrypt and decrypt with one function call
  • Compatible across Python 3.6+ on Windows, Linux, and macOS

Security Design

  • Encryption algorithm: AES-256-GCM (confidentiality + authentication)
  • Key derivation: PBKDF2-HMAC-SHA256, 100,000 iterations
  • Salt: Random per file, length based on password contents
  • Nonce: 12 bytes random per encryption
  • Password requirements: At least 12 base36 characters (0-9a-z)

Installation

pip install securefilecrypt

Quick Start

Encrypt a file

from securefilecrypt import EncryptFile

status, message = EncryptFile("secret.txt", "secret.enc", "mypassword123abc")
if not status:
  print("Error:", message)
else:
  print("File encrypted successfully!")

Decrypt a file

from securefilecrypt import DecryptFile

status, message = DecryptFile("secret.enc", "secret_decrypted.txt", "mypassword123abc")
if not status:
  print("Error:", message)
else:
  print("File decrypted successfully!")

API Reference

EncryptData(input_file, password)

Encrypts input_file using AES-256-GCM with provided password. Returns:

  • `status' (bool): True if successful, False something went wrong
  • message (str): Error message in case of error, otherwise empty
  • data (bytes): Encrypted bytes

DecryptData(input_file, password)

Decrypts input_file using AES-256-GCM with provided password. Returns:

  • `status' (bool): True if successful, False something went wrong
  • message (str): Error message in case of error, otherwise empty
  • data (bytes): Decrypted bytes

EncryptFile(input_file, output_file, password)

Encrypts input_file into output_file using AES-256-GCM with provided password. Returns:

  • `status' (bool): True if successful, False something went wrong
  • message (str): Error message in case of error, otherwise empty

DecryptFile(input_file, output_file, password)

Decrypts input_file into output_file using AES-256-GCM with provided password. Returns:

  • `status' (bool): True if successful, False something went wrong
  • message (str): Error message in case of error, otherwise empty

Security Notes

  • Always use a strong password (long, random, mix of letters/numbers).
  • Store your password securely — if lost, data cannot be recovered.
  • PBKDF2 is secure, but for higher resistance to GPU cracking, consider upgrading to Argon2id in the future.

License

MIT License — do anything with it, but no warranty.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

securefilecrypt-0.1.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

securefilecrypt-0.1.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file securefilecrypt-0.1.0.tar.gz.

File metadata

  • Download URL: securefilecrypt-0.1.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for securefilecrypt-0.1.0.tar.gz
Algorithm Hash digest
SHA256 77b3ce18f151224b88a357c6b15da8e21e32c8ca04e4b9b082dfecdc335cffd9
MD5 34b2f69b99373d6fc059efac6827c424
BLAKE2b-256 ece20619f2ec97f9b55a1332c81c77a9092837d7b69553bce9803621b05dd21c

See more details on using hashes here.

File details

Details for the file securefilecrypt-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for securefilecrypt-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3fcfada46d567d442cd06b49d27d7379845fa74bd8ecd9c7649c97b33433ade0
MD5 46c394e673804e42fc7cac3377e43731
BLAKE2b-256 bb8ddfa1ba8a392a75cc68e71521ed95249162d295ed63a218d4d8e607eacc22

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page