cryptio: authenticated file encryption library
==============================================

cryptio provides a file-like interface for authenticated encryption.

.. _cryptography: https://cryptography.io/en/latest/


Features
--------

- Uses AES-GCM for data integrity validation
- Automatic GCM initialization vector and authentication tag storage
- cryptography_ primitives

Library Installation
--------------------

.. code-block:: bash

   $ pip install cryptio

Getting Started
---------------

Example::

    import os
    import cryptio

    key = os.urandom(32)

    data = b'binary data'

    with cryptio.open('test', 'wb', key=key) as f:
        f.write(data)

    with cryptio.open('test', 'rb', key=key) as f:
        assert f.read() == data

Contents
--------

.. toctree::
   :maxdepth: 2

   api
   disk-format
   modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`