Skip to main content

General purpose Python encrypted file-like object with random IO.

Project description

General purpose Python encrypted file-like object that facilitates random access IO. Uses AES encryption in CTR mode. Can be used with modules such as tarfile, zipfile, lzma, pickle, json and others that accept a file-like object as an alternative to a path. Supports binary IO modes only.

Examples

import cryptfile

with cryptfile.open('data.bin', 'wb+', aes_key=b'256 bit key', block_num=5000) as f:
    f.write(b'Hello, World!')
    f.seek(0)
    print(f.read())

Result:
b'Hello, World!'

Documentation

cryptfile.open(file, mode, aes_key=None, block_num=10000)

Returns a CryptFile object for a specified file.

  • file can either be a string containing a valid path, or a file-like object.
  • Supported mode values are: wb, wb+, rb, rb+, ab, ab+.
  • 256 bit binary aes_key is used for en/decryption, or if none is provided for a new file, a random key is generated and is retrievable with the .aeskey property.
  • block_num sets the number of 16 byte AES blocks per cryptfile block for new files. Each cryptfile block stores its own 8 byte nonce value, and is re-written in whole if any part of the block is altered. Larger block_num values optimize for more sequential IO, whereas smaller values optimize for smaller random IO that jumps around the file. This argument is not needed for opening existing files.

Dependencies

PyCryptodome for AES encryption

Installation

pip install cryptfile

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

cryptfile-1.0.4.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

cryptfile-1.0.4-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file cryptfile-1.0.4.tar.gz.

File metadata

  • Download URL: cryptfile-1.0.4.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for cryptfile-1.0.4.tar.gz
Algorithm Hash digest
SHA256 7c8986a0644511e56e307e2aa4566408e8c7de404d0eab26a9982ad41ae3bba6
MD5 91baa31bab255298414b12d790e97dba
BLAKE2b-256 afc143566796812885d94cb00c4555e9cf69dc7c1247443e4b9404addfd5ad5b

See more details on using hashes here.

File details

Details for the file cryptfile-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: cryptfile-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for cryptfile-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 09388cfe14cd6efcf63b551ef28fb9835e06875b1bc01743654a190cd99b977d
MD5 656cebbc303ea56188b004dadc8f976a
BLAKE2b-256 cefe1d5706871812aff3ab126bfcbc168772f3fb3ac4099511cde31b1dab205f

See more details on using hashes here.

Supported by

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