#noise #protocol #crypto

snow

A pure-rust implementation of the Noise Protocol Framework

53 releases

0.9.6 Jan 26, 2024
0.9.4 Nov 11, 2023
0.9.2 Mar 13, 2023
0.9.0 Feb 3, 2022
0.0.1-preview.10 Mar 21, 2017

#29 in Cryptography

Download history 86495/week @ 2023-11-02 105095/week @ 2023-11-09 121551/week @ 2023-11-16 111867/week @ 2023-11-23 101131/week @ 2023-11-30 89493/week @ 2023-12-07 79197/week @ 2023-12-14 43128/week @ 2023-12-21 40118/week @ 2023-12-28 74514/week @ 2024-01-04 81041/week @ 2024-01-11 98776/week @ 2024-01-18 94781/week @ 2024-01-25 76415/week @ 2024-02-01 97761/week @ 2024-02-08 82362/week @ 2024-02-15

369,538 downloads per month
Used in 333 crates (37 directly)

Apache-2.0 OR MIT

615KB
3.5K SLoC

Snow

Crates.io Docs.rs Build Status dependency status

totally official snow logo

An implementation of Trevor Perrin's Noise Protocol that is designed to be Hard To Fuck Up™.

🔥 Warning 🔥 This library has not received any formal audit.

What's it look like?

See examples/simple.rs for a more complete TCP client/server example.

let mut noise = snow::Builder::new("Noise_NN_25519_ChaChaPoly_BLAKE2s".parse()?)
                    .build_initiator()?;

let mut buf = [0u8; 65535];

// write first handshake message
noise.write_message(&[], &mut buf)?;

// receive response message
let incoming = receive_message_from_the_mysterious_ether();
noise.read_message(&incoming, &mut buf)?;

// complete handshake, and transition the state machine into transport mode
let mut noise = noise.into_transport_mode()?;

See the full documentation at https://docs.rs/snow.

Implemented

Snow is currently tracking against Noise spec revision 34.

However, a not all features have been implemented yet (pull requests welcome):

Crypto

Cryptographic providers are swappable through Builder::with_resolver(), but by default it chooses select, artisanal pure-Rust implementations (see Cargo.toml for a quick overview).

Other Providers

ring

ring is a crypto library based off of BoringSSL and is significantly faster than most of the pure-Rust implementations.

If you enable the ring-resolver feature, Snow will include a resolvers::ring module as well as a RingAcceleratedResolver available to be used with Builder::with_resolver().

If you enable the ring-accelerated feature, Snow will default to choosing ring's crypto implementations when available.

Resolver primitives supported

default ring
CSPRNG ✔ ✔
25519 ✔ ✔
448
AESGCM ✔ ✔
ChaChaPoly ✔ ✔
SHA256 ✔ ✔
SHA512 ✔ ✔
BLAKE2s ✔
BLAKE2b ✔

License

Licensed under either of:

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0.1–19MB
~243K SLoC