ryke 0.3.0

A clean-room IKEv2 / IKE implementation in Rust — independent client (initiator) and server (responder).
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! # ryke
//!
//! A **clean-room** IKEv2 / IKE implementation in Rust — `ryke` = **R**ust + **IKE**.
//!
//! It implements **both sides independently**: a client ([`Role::Initiator`])
//! that starts exchanges and a server ([`Role::Responder`]) that answers them.
//! The protocol is built from the RFCs; it does not wrap OpenSSL or any existing
//! IKE/IPsec daemon, and copies no third-party code.
//!
//! ## Scope & architecture
//!
//! - **Control plane (this crate):** UDP 500/4500, message framing, exchange
//!   state machines, crypto + key schedule, and authentication (certificate and
//!   EAP-MSCHAPv2 for native iOS/Android clients on the server side).
//! - **Data plane:** a **userspace ESP** implementation in Rust (AES-GCM).
//!   `ryke` encrypts/decrypts the tunneled packets itself — it does not use the
//!   OS kernel's IPsec stack, and no external software is involved. The library
//!   moves packets you hand it (via [`Tunnel`], or the lower-level [`EspSa`] /
//!   [`ChildSa`]); capturing a machine's real traffic (e.g. a TUN device) is the
//!   consumer's job, deliberately out of scope.
//!
//! ## What works today
//!
//! - Message framing: header + generic payload chain (RFC 7296 §3.1–3.2).
//! - Payloads: Security Association (proposals/transforms), Key Exchange, Nonce.
//! - Crypto core for `IKE_SA_INIT`: X25519 (RFC 7748), HMAC-SHA256 PRF
//!   (RFC 4231), `prf+`, and the SKEYSEED / SK_* key schedule (§2.13–2.14).
//!
//! See `docs/implementation-plan.md` for the milestone roadmap.

// Shared crypto core (used by both IKEv1 and IKEv2).
pub mod crypto;
pub mod entropy;
pub mod error;
pub mod esp;
pub mod role;
pub mod transport;
pub mod tunnel;

// Protocol implementations.
pub mod ikev1;
pub mod ikev2;

#[cfg(test)]
pub(crate) mod test_certs;

pub use ikev2::client::Client;
pub use crypto::{
    derive_child_keys, derive_session_keys, prf, prf_plus, ChildKeys, DhGroup, KeyLengths,
    SessionKeys,
};
pub use ikev2::eap_auth::{EapEvent, EapInitiator, EapResponder, ServerAuth, ServerVerify};
pub use entropy::{Entropy, SeedEntropy};
pub use error::IkeError;
pub use esp::{ChildSa, EspSa};
pub use ikev2::exchange::{
    default_offer, ike_cookie, initiator_complete, initiator_request, responder_respond,
    responder_respond_natt, CompletedSaInit, CookiePolicy, LocalSecret, SaInitResult,
};
pub use ikev2::natt::{
    is_ike_on_4500, unwrap_ike_4500, wrap_ike_4500, NON_ESP_MARKER,
};
pub use ikev2::informational::{build_informational, dpd_request, open_informational};
pub use ikev2::rekey::responder_process_rekey;
pub use ikev2::ike_rekey::{is_ike_sa_rekey, responder_process_ike_rekey};
pub use ikev2::ike_auth::{
    client_sent_certreq, esp_offer, initiator_auth_request, initiator_eap_request,
    initiator_verify_auth, is_eap_request, peer_id_from_auth, peer_id_from_request,
    responder_process_auth, AssignedConfig, AuthConfig, LocalAuth, PeerAuth,
};
pub use ikev2::message::{
    payloads, ExchangeType, Flags, IkeHeader, MessageBuilder, PayloadIter, PayloadType, RawPayload,
};
pub use ikev2::negotiate::ChosenSuite;
pub use ikev2::auth::{initiator_signed_octets, psk_auth, responder_signed_octets};
pub use ikev2::payload::{
    cfg_type, config_attr, notify_type, Authentication, CertRequest, Certificate, ConfigAttr,
    Configuration, Delete, Identification, KeyExchange, Nonce, Notify, Proposal,
    SecurityAssociation, TrafficSelector, TrafficSelectors, Transform,
};
pub use ikev2::sign::{SigningKey, VerifyingKey};
pub use role::Role;
pub use ikev2::sk::{build_encrypted_gcm, open_encrypted_gcm};
pub use ikev2::server::{Server, ServerEvent};
pub use transport::{DriverError, UdpTransport};
pub use tunnel::Tunnel;

#[cfg(unix)]
pub use entropy::OsEntropy;