Skip to main content

vcl_protocol/
lib.rs

1//! # VCL Protocol
2//!
3//! Cryptographically chained packet transport protocol with:
4//! - SHA-256 integrity chain
5//! - Ed25519 digital signatures
6//! - X25519 ephemeral key exchange
7//! - XChaCha20-Poly1305 authenticated encryption
8//! - Replay protection
9//! - Connection events, ping/heartbeat, mid-session key rotation
10//! - Connection pool for managing multiple peers
11//!
12//! ## Quick Start
13//!
14//! ```no_run
15//! use vcl_protocol::connection::VCLConnection;
16//!
17//! #[tokio::main]
18//! async fn main() {
19//!     let mut server = VCLConnection::bind("127.0.0.1:8080").await.unwrap();
20//!     server.accept_handshake().await.unwrap();
21//!
22//!     let packet = server.recv().await.unwrap();
23//!     println!("Received: {}", String::from_utf8_lossy(&packet.payload));
24//! }
25//! ```
26
27pub mod error;
28pub mod event;
29pub mod packet;
30pub mod crypto;
31pub mod connection;
32pub mod handshake;
33pub mod pool;
34pub mod config;
35pub mod transport;
36pub mod fragment;
37pub mod flow;
38pub mod metrics;
39pub mod tun_device;
40pub mod ip_packet;
41pub mod multipath;
42pub mod mtu;
43pub mod keepalive;
44pub mod reconnect;
45pub mod dns;
46pub mod obfuscation;
47pub mod tunnel;
48pub mod prometheus_metrics;
49
50// Post-Quantum module is optional and only compiled when the "pq" feature is enabled
51#[cfg(feature = "pq")]
52pub mod pq_crypto;
53
54pub use error::VCLError;
55pub use event::VCLEvent;
56pub use pool::VCLPool;
57pub use config::VCLConfig;
58pub use transport::VCLTransport;
59pub use fragment::{Fragmenter, Reassembler, Fragment};
60pub use flow::FlowController;
61pub use metrics::VCLMetrics;
62pub use tun_device::{VCLTun, TunConfig, IpPacket, IpVersion};
63pub use ip_packet::{ParsedPacket, TransportProtocol};
64pub use multipath::{MultipathSender, MultipathReceiver, PathInfo, SchedulingPolicy};
65pub use mtu::{MtuNegotiator, MtuConfig, PathMtu, MtuState};
66pub use keepalive::{KeepaliveManager, KeepaliveConfig, KeepaliveAction, KeepalivePreset};
67pub use reconnect::{ReconnectManager, ReconnectConfig, ReconnectState};
68pub use dns::{DnsFilter, DnsConfig, DnsAction, DnsPacket};
69pub use obfuscation::{Obfuscator, ObfuscationConfig, ObfuscationMode};
70pub use tunnel::{VCLTunnel, TunnelConfig, TunnelState, TunnelStats};
71pub use prometheus_metrics::VCLPrometheusExporter;
72
73// Export PQ types only if the feature is enabled
74#[cfg(feature = "pq")]
75pub use pq_crypto::{PqKeyPair, PqHandshake, PqPublicBundle, PqServerResponse};