noise-framework 0.4.0

Noise protocol framework in functional style
Documentation 
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

# Noise protocol framework in rust

![Build](https://github.com/Cyphernet-DAO/rust-cyphernet/workflows/Build/badge.svg)
![Tests](https://github.com/Cyphernet-DAO/rust-cyphernet/workflows/Tests/badge.svg)
![Lints](https://github.com/Cyphernet-DAO/rust-cyphernet/workflows/Lints/badge.svg)
[![codecov](https://codecov.io/gh/Cyphernet-DAO/rust-cyphernet/branch/master/graph/badge.svg)](https://codecov.io/gh/Cyphernet-DAO/rust-cyphernet)

[![crates.io](https://img.shields.io/crates/v/noise-framework)](https://crates.io/crates/noise-framework)
[![Docs](https://docs.rs/noise-framework/badge.svg)](https://docs.rs/noise-framework)
[![Apache-2 licensed](https://img.shields.io/crates/l/noise-framework)](./LICENSE)


## Overview

The library provides pure rust implementation of 
[Noise protocol framework](http://noiseprotocol.org/) with minimal dependencies
made in functional style, where a specific Noise scheme is constructed as a
concrete type (like `Noise_XK<Secp256,ChaChaPoly,Sha256>`).

The library is a part of [rust cyphernet suite](https://github.com/Cyphernet-DAO/rust-cyphernet).


## Manifest

```yaml
Name: noise-framework
Type: Library
Kind: Free software
License: Apache-2.0
Language: Rust
Compiler: 1.65
Author: Maxim Orlovsky
Maintained: Cyphernet DAO, Switzerland
Maintainers:
  Maxim Orlovsky:
    GitHub: @dr-orlovsky
    GPG: EAE730CEC0C663763F028A5860094BAF18A26EC9
    SSH: BoSGFzbyOKC7Jm28MJElFboGepihCpHop60nS8OoG/A
    EMail: dr@orlovsky.ch
  Alexis Sellier:
    GitHub: @cloudhead
    SSH: iTDjRHSIaoL8dpHbQ0mv+y0IQqPufGl2hQwk4TbXFlw
```


## Features

Currently, the library supports following handshake patterns and construction 
primitives:
- All interactive handshake fundamental patterns: 
  NN, NK, NX, XN, XK, XX, KN, KK, KX, IN, IK, IX
- Streaming cipher `ChaCha20Poly1305`
- Elliptic curves `Secp256k1` and `Edward25519`
- Digest functions `SHA2-256`, `SHA2-512`, `SHA3-256`, `SHA3-512`, `BLAKE3`

The library currently DOES NOT provide:
- Other AEAD ciphers than ChaCha20Poly1305;
- Support for pre-shared secret keys (PSK);
- Interactive handshake deferred patterns.


## Documentation

API reference documentation for the library can be accessed at
<https://docs.rs/noise-framework/>.


## Licensing

The libraries are distributed on the terms of Apache 2.0 opensource license.
See [LICENCE](LICENSE) file for the license details.

[noise spec]: http://noiseprotocol.org/noise.html