Expand description
Wire types and framing for the KROT tunnel protocol.
This crate is the single source of truth for the on-the-wire format defined in wire protocol spec. Server and client implementations MUST route all encoding and decoding through the types exposed here.
Re-exports§
pub use auth::sign_challenge;pub use auth::verify_challenge;pub use auth::AUTH_DOMAIN_SEPARATOR;pub use error::ErrorCode;pub use frames::ClientFrame;pub use frames::HttpMetadata;pub use frames::InspectionPrelude;pub use frames::ServerFrame;pub use frames::TunnelKind;pub use framing::decode_frame;pub use framing::encode_frame;pub use framing::FramingError;pub use ids::Nonce;pub use ids::PubKey;pub use ids::SessionId;pub use ids::Signature;pub use ids::TunnelId;pub use mux::is_client_opened;pub use mux::is_server_opened;pub use mux::MuxFlag;pub use mux::MuxHeader;pub use mux::MuxHeaderError;pub use mux::CONTROL_STREAM_ID;pub use mux::MUX_HEADER_SIZE;pub use stream::DataHeader;pub use stream::StreamKind;pub use stream::StreamKindError;pub use consts::*;
Modules§
- auth
- Ed25519 challenge-response helpers (§7.1).
- consts
- Protocol-level constants. Mirrors wire protocol spec Appendix A.
- error
- Application-level error codes (§8).
- frames
- Control-stream frames (§7, §14.2).
- framing
- Length-prefixed
postcardframing for Control-stream messages (§6). - ids
- Typed identifiers used across the wire protocol.
- mux
krot-tcp/1stream-multiplexing header (§16.1.1).- stream
- Stream discriminator and Data-stream header.