yip-mesh 0.1.0

High-performance userspace WireGuard-alternative overlay network protocol and SDK
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

# yip-mesh

[![Crates.io](https://img.shields.io/crates/v/yip-mesh.svg)](https://crates.io/crates/yip-mesh)
[![Documentation](https://docs.rs/yip-mesh/badge.svg)](https://docs.rs/yip-mesh)
[![License: AGPL-3.0-or-later](https://img.shields.io/badge/License-AGPL--3.0--or--later-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.html)

The unified Rust library and SDK for the **yip** high-performance overlay network protocol.

## Features

The `yip-mesh` crate provides modular facade access to all underlying protocol components:

- **`crypto`** (default): AEAD ciphers (ChaCha20-Poly1305, AES-256-GCM, AES-128-GCM), Noise-IK handshakes, BLAKE2s hashing, and key derivations.
- **`wire`** (default): Zero-allocation framing, wire codec parsing, header obfuscation, and control frame encoding.
- **`transport`** (default): Slotted Reed-Solomon Forward Error Correction (FEC), sliding window packet reassembly, and selective ARQ.
- **`membership`** (default): Cryptographic node identity, self-certifying IPv6 mesh addresses, certificate verification, root sets, and anti-entropy gossip.
- **`device`**: TUN/TAP virtual network device abstractions across Linux.
- **`io`**: High-throughput I/O engines supporting Linux `epoll` and `io_uring` with ring buffer pools.
- **`rendezvous`**: STUN/TURN-independent symmetric NAT traversal with authenticated ticket exchange.
- **`obf`**: Steganographic wire framing, padding transforms, and timing-jitter obfuscation.
- **`utls`**: TLS 1.3 browser mimicry and REALITY camouflage transport.
- **`ca`**: RFC 9591 FROST threshold certificate authority signer and coordinator protocols.
- **`full`**: Enables all modules above.

## Quickstart

Add `yip-mesh` to your `Cargo.toml`:

```toml
[dependencies]
yip-mesh = { version = "0.1", features = ["full"] }
```

### Self-Certifying Mesh Address Generation

```rust
use yip_mesh::membership::cert::Cert;
use yip_mesh::membership::addr::MeshAddr;
```