stochastic-routing-extended 1.0.2

SRX (Stochastic Routing eXtended) — a next-generation VPN protocol with stochastic routing, DPI evasion, post-quantum cryptography, and multi-transport channel splitting
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
//! High-level entry point: ties handshake, session, and pipeline into a single API.
//!
//! [`SrxNode`] is the primary type an application uses to establish a connection
//! and send/receive data through the full SRX protocol stack.
//!
//! ```text
//! Application
//!   └─ SrxNode
//!        ├─ Handshake  (Kyber + X25519 + optional Ed25519)
//!        ├─ Session    (seed, data key, packet counter)
//!        └─ SrxPipeline (pad → encrypt → frame → mimicry → jitter → transport)
//! ```

use std::sync::Arc;

use crate::client::policy::TransportPolicy;
use crate::client::selfheal::SelfHealing;
use crate::config::SrxConfig;
use crate::crypto::{AeadPipeline, ReplayState};
use crate::error::Result;
use crate::pipeline::{Payload, SrxPipeline};
use crate::replay_storage::{
    ReplayStoreMetricsSnapshot, decode_replay_envelope, merge_and_persist_replay_state,
    replay_store_metrics_snapshot, storage_from_config,
};
use crate::session::{Handshake, Session};
use crate::signaling::inband::Signal;
use crate::transport::{TransportKind, TransportManager};

/// High-level SRX protocol node (client or server).
///
/// Holds the active [`SrxPipeline`] and exposes simple `send` / `recv_from` methods.
pub struct SrxNode {
    config: SrxConfig,
    pipe: SrxPipeline,
    self_healing: SelfHealing,
    policy: TransportPolicy,
}

impl SrxNode {
    /// Perform a client-side handshake and build the pipeline.
    ///
    /// `exchange` is a closure that carries the three handshake messages over the
    /// network (transport-agnostic so the caller can use any channel).
    ///
    /// ```text
    /// exchange(ClientHello) → ServerHello
    /// exchange(ClientFinished) → ()
    /// ```
    pub fn client_connect<F>(
        config: SrxConfig,
        transport_mgr: TransportManager,
        exchange: F,
    ) -> Result<Self>
    where
        F: FnOnce(&[u8]) -> Result<(Vec<u8>, Vec<u8>)>,
    {
        let mut hs = Handshake::new_initiator();
        let ch = hs.client_hello()?;
        let (sh, _ack) = exchange(&ch)?;
        let cf = hs.finalize(&sh)?;
        // The caller is expected to send `cf` and receive an ack via `exchange`,
        // but the second leg returns `_ack` which we ignore (server derives master
        // secret from cf internally).
        let _ = cf; // cf was already computed; drop silently

        let master = hs.master_secret().ok_or_else(|| {
            crate::error::SrxError::Session(crate::error::SessionError::HandshakeFailed(
                "master secret not available after finalize".into(),
            ))
        })?;

        Self::from_master_secret(config, master, transport_mgr)
    }

    /// Build a node directly from a shared master secret (e.g. after an external
    /// handshake or for testing).
    pub fn from_master_secret(
        config: SrxConfig,
        master: [u8; 32],
        transport_mgr: TransportManager,
    ) -> Result<Self> {
        let timestamp = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .unwrap_or_default()
            .as_secs();

        let session = Session::from_master_secret(0, &master, timestamp, b"srx-node")?;
        let aead = Arc::new(config.build_aead_pipeline(&session.data_key)?);
        let pipe = SrxPipeline::from_config(&config, session, aead, transport_mgr);

        let node = Self {
            config,
            pipe,
            self_healing: SelfHealing::new(),
            policy: TransportPolicy::default(),
        };
        node.restore_replay_state_from_disk()?;
        Ok(node)
    }

    /// Build a node from a pre-established [`Session`] and [`AeadPipeline`].
    pub fn from_session(
        config: SrxConfig,
        session: Session,
        aead: Arc<AeadPipeline>,
        transport_mgr: TransportManager,
    ) -> Result<Self> {
        let pipe = SrxPipeline::from_config(&config, session, aead, transport_mgr);
        let node = Self {
            config,
            pipe,
            self_healing: SelfHealing::new(),
            policy: TransportPolicy::default(),
        };
        node.restore_replay_state_from_disk()?;
        Ok(node)
    }

    /// Send application payload through the full protocol stack.
    pub async fn send(&mut self, payload: &[u8]) -> Result<TransportKind> {
        self.pipe.send(payload).await
    }

    /// Receive and decrypt from a specific transport.
    pub async fn recv_from(&mut self, kind: TransportKind) -> Result<Vec<u8>> {
        let payload = self.pipe.recv_from(kind).await?;
        self.persist_replay_state_to_disk()?;
        Ok(payload)
    }

    /// Process raw bytes received externally (e.g. from a worker queue).
    pub fn process_incoming(&self, envelope: &[u8]) -> Result<Vec<u8>> {
        let payload = self.pipe.process_incoming(envelope)?;
        self.persist_replay_state_to_disk()?;
        Ok(payload)
    }

    /// Prepare outgoing bytes without dispatching (for custom transport handling).
    pub fn prepare_outgoing(&mut self, payload: &[u8]) -> Result<Vec<u8>> {
        self.pipe.prepare_outgoing(payload)
    }

    /// Access the underlying pipeline.
    pub fn pipeline(&self) -> &SrxPipeline {
        &self.pipe
    }

    /// Mutable access to the underlying pipeline.
    pub fn pipeline_mut(&mut self) -> &mut SrxPipeline {
        &mut self.pipe
    }

    /// Access the node configuration.
    pub fn config(&self) -> &SrxConfig {
        &self.config
    }

    fn replay_persistence_enabled(&self) -> bool {
        self.config.replay.persist_enabled
    }

    fn restore_replay_state_from_disk(&self) -> Result<()> {
        if !self.replay_persistence_enabled() {
            return Ok(());
        }
        let storage = storage_from_config(&self.config.replay)?;
        let Some(raw) = storage.load_raw(&self.config.replay)? else {
            return Ok(());
        };
        let Some(state) =
            decode_replay_envelope(&self.config.replay, &self.replay_session_binding(), &raw)?
        else {
            return Ok(());
        };
        self.pipe.set_replay_state(&state)
    }

    fn replay_session_binding(&self) -> String {
        use sha2::{Digest, Sha256};
        let seed = self.pipe.session.rng.seed_bytes();
        let digest = Sha256::digest(seed);
        let mut out = String::with_capacity(24);
        for b in digest.iter().take(12) {
            out.push(char::from(b"0123456789abcdef"[(b >> 4) as usize]));
            out.push(char::from(b"0123456789abcdef"[(b & 0x0f) as usize]));
        }
        out
    }

    fn persist_replay_state_to_disk(&self) -> Result<()> {
        if !self.replay_persistence_enabled() {
            return Ok(());
        }
        let state = self.replay_state();
        let storage = storage_from_config(&self.config.replay)?;
        merge_and_persist_replay_state(
            &self.config.replay,
            storage.as_ref(),
            &self.replay_session_binding(),
            state,
        )
    }

    /// Snapshot anti-replay state so it can be restored after a restart.
    pub fn replay_state(&self) -> ReplayState {
        self.pipe.replay_state()
    }

    /// Restore anti-replay state captured from a previous process instance.
    pub fn set_replay_state(&self, state: &ReplayState) -> Result<()> {
        self.pipe.set_replay_state(state)?;
        self.persist_replay_state_to_disk()
    }

    // ── In-band signaling ───────────────────────────────────────────────

    /// Send a control signal through the full pipeline (encrypted, framed,
    /// mimicry-wrapped — indistinguishable from data on the wire).
    pub fn send_signal(&mut self, signal: &Signal) -> Result<Vec<u8>> {
        self.pipe.prepare_signal(signal)
    }

    /// Process raw bytes and dispatch into [`Payload::Data`] or [`Payload::Signal`].
    pub fn process_incoming_dispatched(&self, envelope: &[u8]) -> Result<Payload> {
        let payload = self.process_incoming(envelope)?;
        match self.pipe.try_decode_signal(&payload) {
            Some(sig) => Ok(Payload::Signal(sig)),
            None => Ok(Payload::Data(payload)),
        }
    }

    // ── Self-healing ────────────────────────────────────────────────────

    /// Check if self-healing should trigger and, if so, reseed and return
    /// a new transport order.
    ///
    /// Returns `Some(order)` when healing was performed, `None` otherwise.
    pub fn heal_if_needed(&mut self) -> Option<Vec<TransportKind>> {
        if !self.self_healing.should_heal(self.pipe.transport_mgr()) {
            return None;
        }
        // Snapshot health data before taking &mut session.rng (avoids
        // overlapping borrows on `self.pipe`).
        let healthy = self.pipe.transport_mgr().healthy_kinds();
        let active = self.pipe.transport_mgr().active_kinds();
        let blocked: Vec<_> = active
            .iter()
            .filter(|k| !healthy.contains(k))
            .copied()
            .collect();

        // Reseed RNG + bump backoff (separate from TransportManager borrow).
        self.self_healing.reseed_only(&mut self.pipe.session.rng);

        // Build the order: healthy first (policy-sorted), then blocked.
        let mut order = self.policy.recommend(&healthy);
        order.extend(self.policy.recommend(&blocked));
        Some(order)
    }

    /// Notify the self-healing controller that traffic succeeded.
    pub fn record_success(&mut self) {
        self.self_healing.record_success();
    }

    /// Number of self-healing events triggered so far.
    pub fn heal_count(&self) -> u32 {
        self.self_healing.heal_count
    }

    // ── Transport policy ────────────────────────────────────────────────

    /// Set the network environment for transport policy.
    pub fn set_environment(&mut self, env: crate::client::policy::NetworkEnvironment) {
        self.policy.set_environment(env);
    }

    /// Access the transport policy.
    pub fn policy(&self) -> &TransportPolicy {
        &self.policy
    }

    /// Snapshot CAS contention metrics for replay-store persistence.
    pub fn replay_store_metrics() -> ReplayStoreMetricsSnapshot {
        replay_store_metrics_snapshot()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::client::policy::NetworkEnvironment;
    use crate::config::SrxConfig;
    use crate::pipeline::Payload;
    use crate::signaling::inband::Signal;
    use tempfile::TempDir;

    fn make_pair() -> (SrxNode, SrxNode) {
        let master = [0xBBu8; 32];
        let mut config = SrxConfig::default();
        config.replay.persist_enabled = false;
        let sender =
            SrxNode::from_master_secret(config.clone(), master, TransportManager::new()).unwrap();
        let receiver =
            SrxNode::from_master_secret(config, master, TransportManager::new()).unwrap();
        (sender, receiver)
    }

    #[test]
    fn from_master_secret_builds_node() {
        let mut config = SrxConfig::default();
        config.replay.persist_enabled = false;
        let master = [0xAAu8; 32];
        let node = SrxNode::from_master_secret(config, master, TransportManager::new()).unwrap();
        assert!(node.pipeline().session.active);
    }

    #[test]
    fn node_prepare_process_roundtrip() {
        let (mut sender, receiver) = make_pair();
        let envelope = sender.prepare_outgoing(b"node-test").unwrap();
        let recovered = receiver.process_incoming(&envelope).unwrap();
        assert_eq!(recovered, b"node-test");
    }

    #[test]
    fn signal_roundtrip_through_node() {
        let (mut sender, receiver) = make_pair();
        let envelope = sender.send_signal(&Signal::SeedRotation).unwrap();
        let payload = receiver.process_incoming_dispatched(&envelope).unwrap();
        match payload {
            Payload::Signal(sig) => assert_eq!(sig, Signal::SeedRotation),
            Payload::Data(_) => panic!("expected signal"),
        }
    }

    #[test]
    fn data_dispatched_as_data() {
        let (mut sender, receiver) = make_pair();
        let envelope = sender.prepare_outgoing(b"app-data").unwrap();
        let payload = receiver.process_incoming_dispatched(&envelope).unwrap();
        match payload {
            Payload::Data(d) => assert_eq!(d, b"app-data"),
            Payload::Signal(_) => panic!("expected data"),
        }
    }

    #[test]
    fn heal_if_needed_returns_none_when_healthy() {
        let (mut node, _) = make_pair();
        // No blocked transports → no healing needed.
        assert!(node.heal_if_needed().is_none());
        assert_eq!(node.heal_count(), 0);
    }

    #[test]
    fn record_success_resets_backoff() {
        let (mut node, _) = make_pair();
        node.record_success();
        // Just ensure it doesn't panic; backoff is internal.
        assert_eq!(node.heal_count(), 0);
    }

    #[test]
    fn set_environment_updates_policy() {
        let (mut node, _) = make_pair();
        node.set_environment(NetworkEnvironment::Corporate);
        assert_eq!(node.policy().environment(), NetworkEnvironment::Corporate);
    }

    #[test]
    fn replay_state_snapshot_restore_on_node() {
        let (mut sender, receiver) = make_pair();

        let env1 = sender.prepare_outgoing(b"r1").unwrap();
        let env2 = sender.prepare_outgoing(b"r2").unwrap();

        assert_eq!(receiver.process_incoming(&env1).unwrap(), b"r1");
        assert_eq!(receiver.process_incoming(&env2).unwrap(), b"r2");

        let state = receiver.replay_state();
        let restored = SrxNode::from_master_secret(
            {
                let mut cfg = SrxConfig::default();
                cfg.replay.persist_enabled = false;
                cfg
            },
            [0xBBu8; 32],
            TransportManager::new(),
        )
        .unwrap();
        restored.set_replay_state(&state).unwrap();

        let replay = restored.process_incoming(&env2);
        assert!(replay.is_err(), "restored node must reject duplicate");
    }

    #[test]
    fn auto_persist_and_restore_replay_state() {
        let temp = TempDir::new().unwrap();
        let state_file = temp.path().join("replay_state.json");

        let mut cfg = SrxConfig::default();
        cfg.replay.persist_enabled = true;
        cfg.replay.state_file = state_file.clone();

        let master = [0xACu8; 32];
        let mut sender =
            SrxNode::from_master_secret(cfg.clone(), master, TransportManager::new()).unwrap();
        let receiver_before =
            SrxNode::from_master_secret(cfg.clone(), master, TransportManager::new()).unwrap();

        let envelope = sender.prepare_outgoing(b"persisted").unwrap();
        assert_eq!(
            receiver_before.process_incoming(&envelope).unwrap(),
            b"persisted"
        );
        assert!(state_file.exists(), "replay state file must be created");

        let receiver_after =
            SrxNode::from_master_secret(cfg, master, TransportManager::new()).unwrap();
        assert!(
            receiver_after.process_incoming(&envelope).is_err(),
            "restored node must reject duplicate from persisted state"
        );
    }
}