miscreant.rs

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

Rust implementation of Miscreant: Advanced symmetric encryption using the AES-SIV ([RFC 5297]) and [CHAIN/STREAM] constructions, providing easy-to-use (or rather, hard-to-misuse) 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?

[Gitter]: web-based chat about Miscreant projects including miscreant.rs
[Google Group]: join via web or email ([miscreant-crypto+subscribe@googlegroups.com])

Security Notice

Though this library is written by cryptographic professionals, it has not undergone a thorough security audit, and cryptographic professionals are still humans that make mistakes.

This library makes an effort to use constant time operations throughout its implementation, however actual constant time behavior has not been verified.

Use this library at your own risk.

Requirements

This library presently requires the following:

x86_64 CPU architecture
Rust nightly compiler

This library implements the AES cipher using the [aesni] crate, which uses the [Intel AES-NI] CPU instructions to provide a fast, constant-time hardware-based implementation. No software-only implementation of AES is provided. Additionally it includes Intel assembly language implementations of certain secret-dependent functions which have verified constant-time operation.

This library also makes use of certain nightly-only features including inline assembly and repr_align. Supporting stable Rust will first require upstream changes in the [aesni] crate, which is also nightly-only.

Code of Conduct

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

For more information, please see [CODEOFCONDUCT.md].

Contributing