https://github.com/mcginty/snow

A Rust implementation of the Noise Protocol Framework
https://github.com/mcginty/snow

crypto cryptography noise noise-protocol noise-protocol-framework rust security

Last synced: 3 days ago
JSON representation

A Rust implementation of the Noise Protocol Framework

• Host: GitHub
• URL: https://github.com/mcginty/snow
• Owner: mcginty
• License: apache-2.0
• Created: 2016-10-16T12:09:30.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-08-19T08:38:36.000Z (5 months ago)
• Last Synced: 2024-12-24T07:07:45.027Z (10 days ago)
• Topics: crypto, cryptography, noise, noise-protocol, noise-protocol-framework, rust, security
• Language: Rust
• Homepage:
• Size: 2.34 MB
• Stars: 907
• Watchers: 25
• Forks: 119
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Snow

[![Crates.io](https://img.shields.io/crates/v/snow.svg)](https://crates.io/crates/snow)

[![Docs.rs](https://docs.rs/snow/badge.svg)](https://docs.rs/snow)

[![Build Status](https://github.com/mcginty/snow/workflows/Build/badge.svg)](https://github.com/mcginty/snow/actions)

[![dependency status](https://deps.rs/repo/github/mcginty/snow/status.svg)](https://deps.rs/repo/github/mcginty/snow)

![totally official snow logo](https://i.imgur.com/gFgvo49.jpg?1)

An implementation of Trevor Perrin's [Noise Protocol](https://noiseprotocol.org/) 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.

```rust

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](https://docs.rs/snow).

## Implemented

Snow is currently tracking against [Noise spec revision 34](https://noiseprotocol.org/noise_rev34.html).

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

- [ ] [The `fallback` modifier](https://noiseprotocol.org/noise_rev34.html#the-fallback-modifier)

## 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](https://github.com/briansmith/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:

- [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)

- [MIT license](https://opensource.org/license/mit/)

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.