1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

//! Rust implementation of the [Noise Protocol
//! Framework](http://www.noiseprotocol.org/).
//!
//! Typically, you use `HandshakeState::new()` or
//! `HandshakeStateBuilder` to initialize a `HandshakeState`, then
//! call `write_message` and `read_message` to complete the
//! handshake. Once the handshake is `completed`, you call
//! `get_ciphers` to get ciphers that you can use to
//! encrypt/decrypt further messages.
//!
//! This crate only contains an abstract implementation of the
//! protocol. Concrete implementations of the crypo primitives,
//! wrapping around some popular libraries, are provided in sibling
//! crates, e.g., `noise-ring`, `noise-sodiumoxide` and
//! `noise-rust-crypto`.

#[warn(missing_docs)]

mod traits;
pub mod rand;
mod cipherstate;
mod symmetricstate;
mod handshakestate;
mod handshakepattern;
mod error;

pub use cipherstate::CipherState;
pub use error::NoiseError;
pub use traits::{U8Array, RandomGen, DH, Cipher, Hash};

/// Handshake patterns.
pub mod patterns {
    pub use handshakepattern::*;
}

pub use handshakestate::{HandshakeState, HandshakeStateBuilder};