Skip to main content

A python xxxFile like ( ie GzipFile, BZ2File, ...) for manipulating AES encrypted files.

Project description

CircleCI codecov PyPI - Downloads

AesFile

A python xxxFile like (ie TarFile, GzipFile, BZ2File, pyzstd.ZstdFile, ...) for encrypting files with cryptography AES.

This project is part of the CofferFile : https://github.com/bibi21000/CofferFile

If you're looking for a more powerfull storage for your sensible datas, look at PyCoffer : https://github.com/bibi21000/PyCoffer.

Install

    pip install aesfile

Create your encryption key

    from Crypto.Random import get_random_bytes

    key = get_random_bytes(16)

and store it in a safe place (disk, database, ...).

This key is essential to encrypt and decrypt data. Losing this key means losing the data.

"open" your encrypted files like normal files

Text files :

    import aesfile

    with aesfile.open('test.txc', mode='wt', aes_key=key, encoding="utf-8") as ff:
        ff.write(data)

    with aesfile.open('test.txc', "rt", aes_key=key, encoding="utf-8") as ff:
        data = ff.read()

    with aesfile.open('test.txc', mode='wt', aes_key=key, encoding="utf-8") as ff:
        ff.writelines(data)

    with aesfile.open('test.txc', "rt", aes_key=key, encoding="utf-8") as ff:
        data = ff.readlines()

Binary files :

    import aesfile

    with aesfile.open('test.dac', mode='wb', aes_key=key) as ff:
        ff.write(data)

    with aesfile.open('test.dac', "rb", aes_key=key) as ff:
        data = ff.read()

Or compress and crypt them with pyzstd

    pip install aesfile[zstd]
    from aesfile.zstd import AesFile

    with AesFile('test.dac', mode='wb', aes_key=key) as ff:
        ff.write(data)

    with AesFile('test.dac', mode='rb', aes_key=key) as ff:
        data = ff.read()

And chain it to tar and bz2

class TarBz2AesFile(tarfile.TarFile):

    def __init__(self, name, mode='r', aes_key=None, chunk_size=aesfile.CHUNK_SIZE, **kwargs):
        compresslevel = kwargs.pop('compresslevel', 9)
        self.fernet_file = aesfile.AesFile(name, mode,
            aes_key=aes_key, chunk_size=chunk_size, **kwargs)
        try:
            self.bz2_file = bz2.BZ2File(self.fernet_file, mode=mode,
                compresslevel=compresslevel, **kwargs)
            try:
                super().__init__(fileobj=self.bz2_file, mode=mode, **kwargs)

            except Exception:
                self.bz2_file.close()
                raise

        except Exception:
            self.fernet_file.close()
            raise

    def close(self):
        try:
            super().close()
        finally:
            try:
                if self.fernet_file is not None:
                    self.bz2_file.close()
            finally:
                if self.fernet_file is not None:
                    self.fernet_file.close()

    with TarBz2AesFile('test.zsc', mode='wb', aes_key=key) as ff:
        ff.add(dataf1, 'file1.out')
        ff.add(dataf2, 'file2.out')

    with TarBz2AesFile('test.zsc', mode='rb', aes_key=key) as ff:
        fdata1 = ff.extractfile('file1.out')
        fdata2 = ff.extractfile('file2.out')

Encrypt / decrypt existing files

Encrypt :

    import aesfile

    with open(source, 'rb') as fin, aesfile.open(destination, mode='wb', aes_key=key) as fout:
        while True:
            data = fin.read(7777)
            if not data:
                break
            fout.write(data)

Decrypt :

    import aesfile

    with aesfile.open(source, mode='rb', aes_key=key) as fin, open(destination, 'wb') as fout :
        while True:
            data = fin.read(8888)
            if not data:
                break
            fout.write(data)

Or to compress and crypt

    import aesfile.zstd

    with open(source, 'rb') as fin, aesfile.zstd.open(destination, mode='wb', aes_key=key) as fout:
        while True:
            data = fin.read(7777)
            if not data:
                break
            fout.write(data)

    with aesfile.zstd.open(source, mode='rb', aes_key=key) as fin, open(destination, 'wb') as fout :
        while True:
            data = fin.read(8888)
            if not data:
                break
            fout.write(data)

Look at documentation : https://bibi21000.github.io/AesFile/

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

aesfile-0.0.5.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

aesfile-0.0.5-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file aesfile-0.0.5.tar.gz.

File metadata

  • Download URL: aesfile-0.0.5.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aesfile-0.0.5.tar.gz
Algorithm Hash digest
SHA256 8f442688da8831a0e49e1d223d16968bf1e3f7644b9c396e2da8ee257fe70034
MD5 a3f6e405cbea3653d060685545eff481
BLAKE2b-256 d03244d8a4e42c999a1c6d01c5026123d5c14384884e0e14b3a5a96ce016bd0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for aesfile-0.0.5.tar.gz:

Publisher: python-publish.yml on bibi21000/AesFile

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aesfile-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: aesfile-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aesfile-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b94a800bc9c35df507c33df286848cfca1c6a0397255b2d7b58a3433c458529b
MD5 bb327a9ce300ce9fd8e17a9a6b5eed0a
BLAKE2b-256 301a7783f9d4c12e540fd26914170dc9eb49c58c97930348494a5edf5e788bf7

See more details on using hashes here.

Provenance

The following attestation bundles were made for aesfile-0.0.5-py3-none-any.whl:

Publisher: python-publish.yml on bibi21000/AesFile

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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