Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
109 lines (74 sloc) 4.42 KB

miscreant.py Latest Version Build Status MIT licensed Gitter Chat

The best crypto you've never heard of, brought to you by Phil Rogaway

Python implementation of Miscreant: Advanced symmetric encryption library which provides the AES-SIV (RFC 5297), AES-PMAC-SIV, and STREAM constructions. These algorithms are easy-to-use (or rather, hard-to-misuse) and support encryption of individual messages or message streams.

AES-SIV provides nonce-reuse misuse-resistance (NRMR): accidentally reusing a nonce with this construction is not a security catastrophe, unlike it is with more popular AES encryption modes like AES-GCM. With AES-SIV, the worst outcome of reusing a nonce is an attacker can see you've sent the same plaintext twice, as opposed to almost all other AES modes where it can facilitate chosen ciphertext attacks and/or full plaintext recovery.

For more information, see the toplevel README.md.

Help and Discussion

Have questions? Want to suggest a feature or change?

Security Notice

This library implements some portions of the construction in pure Python and therefore these parts are not constant time: though the core cryptography is provided by the Python cryptography library including the AES function, various other parts, particularly the s2v and dbl functions are Python.

These functions act on Python integers, which are boxed. They may reveal timing information which may help an attacker compromise this implementation, possibly even facilitating complete plaintext recovery. The exact extent to which this is possible has not been thoroughly investigated, nor has this library been professionally audited by cryptography experts.

Use this library at your own risk.

Requirements

This library is tested on Python 2.7 and 3.6.

It depends on the Python cryptography library. For more information on installing this library, please see:

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

Installation

Install Miscreant with pip using:

$ pip install miscreant

Documentation

Please see the Miscreant Wiki for API documentation.

Code of Conduct

We abide by the Contributor Covenant and ask that you do as well.

For more information, please see CODE_OF_CONDUCT.md.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/miscreant/miscreant

Copyright

Copyright (c) 2017-2018 The Miscreant Developers. See LICENSE.txt for further details.