#noise #protocol #crypto

snow

A pure-rust implementation of the Noise Protocol Framework

41 releases

✓ Uses Rust 2018 edition

new 0.7.0-alpha4 Feb 21, 2020
0.6.2 Dec 2, 2019
0.6.1 Aug 31, 2019
0.6.0 Jul 14, 2019
0.0.1-preview.10 Mar 21, 2017

#10 in Cryptography

Download history 3663/week @ 2019-11-10 3358/week @ 2019-11-17 3038/week @ 2019-11-24 5125/week @ 2019-12-01 6928/week @ 2019-12-08 4296/week @ 2019-12-15 1921/week @ 2019-12-22 2066/week @ 2019-12-29 4159/week @ 2020-01-05 4490/week @ 2020-01-12 4295/week @ 2020-01-19 4405/week @ 2020-01-26 4371/week @ 2020-02-02 5928/week @ 2020-02-09 5056/week @ 2020-02-16

18,414 downloads per month
Used in 20 crates (7 directly)

Unlicense

605KB
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.

libsodium

libsodium is a fork of NaCl focused on improved usability and regular maintenance.

Compatibility caveat

libsodium blacklists a set of low-order points that it deems unsafe because they would output an all-zeroes result.

Noise does not validate Curve25519 points, so if another Noise implementation provides an all-zero (or another low-order) public key for some reason (be it testing, or a real life foot-shot), if you use the libsodium backend of snow, it will error in a way that's not fully compatible with the specification.

Resolver primitives supported

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

Dependencies

~0–2.1MB
~59K SLoC