eggtunnel 0.2.0

Embeddable Eggtunnel reverse-session library
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
use super::*;
use eggtunnel_proto::{RequestedBind, ServiceName, TcpTarget};

fn config(server_addr: &str) -> ClientConfig {
    ClientConfig {
        server_addr: server_addr.to_owned(),
        tls_server_name: "localhost".to_owned(),
        ca_pem: None,
        token: SecretToken::new(b"test-token".to_vec()).unwrap(),
        services: vec![ClientService::new(
            ServiceId(1),
            ServiceName::new("one").unwrap(),
            RequestedBind::Loopback { port: 0 },
            TcpTarget::new("127.0.0.1", 80).unwrap(),
        )],
    }
}

#[test]
fn client_validation_rejects_invalid_endpoint_without_server_feature() {
    assert!(validate_config(&config("missing-port"), &Default::default()).is_err());
    assert!(validate_config(&config("localhost:0"), &Default::default()).is_err());
    assert!(validate_config(&config("localhost:443"), &Default::default()).is_ok());
}

#[test]
fn client_validation_rejects_duplicate_service_identity() {
    let mut config = config("localhost:443");
    config.services.push(config.services[0].clone());
    assert!(validate_config(&config, &Default::default()).is_err());
}

#[test]
fn client_config_debug_redacts_bearer_token_for_tracing_callers() {
    let marker = "client-token-must-not-appear";
    let mut config = config("localhost:443");
    config.token = SecretToken::new(marker.as_bytes().to_vec()).unwrap();
    let formatted = format!("{config:?}");
    assert!(!formatted.contains(marker));
    assert!(formatted.contains("REDACTED"));
}

fn service(id: u64, name: &str, target_port: u16) -> ClientService {
    ClientService::new(
        ServiceId(id),
        ServiceName::new(name).unwrap(),
        RequestedBind::Loopback { port: 0 },
        TcpTarget::new("127.0.0.1", target_port).unwrap(),
    )
}

async fn fake_connected_client() -> (
    ClientHandle,
    Counters,
    JoinHandle<Result<(), TunnelError>>,
    BoxStream,
) {
    fake_connected_client_with_policy(crate::RuntimePolicy::default()).await
}

async fn fake_connected_client_with_policy(
    policy: crate::RuntimePolicy,
) -> (
    ClientHandle,
    Counters,
    JoinHandle<Result<(), TunnelError>>,
    BoxStream,
) {
    let token = SecretToken::new(b"dynamic-registration-test".to_vec()).unwrap();
    let counters = Counters::with_policy(policy);
    let cancel = CancellationToken::new();
    let (client_io, server_io) = tokio::io::duplex(64 * 1024);
    let (commands, command_rx) = mpsc::channel(32);
    let handle = ClientHandle {
        cancel: cancel.clone(),
        counters: counters.clone(),
        commands,
        #[cfg(feature = "quic")]
        quic_client: Arc::new(std::sync::Mutex::new(None)),
    };
    let task_counters = counters.clone();
    let task_cancel = cancel.clone();
    let task_token = token.clone();
    let task = tokio::spawn(async move {
        let mut service_state = ServiceState::new(vec![service(1, "initial", 80)]);
        let mut command_rx = command_rx;
        let mut reconnect_delay = Duration::from_millis(500);
        run_session(
            Box::new(client_io),
            SessionRun {
                token: &task_token,
                transport: ClientDataTransport::TcpTls {
                    server_addr: "localhost:443".into(),
                    server_name: "localhost".into(),
                    tls: build_tls_config(None).unwrap(),
                    websocket: false,
                    #[cfg(feature = "outbound-proxy")]
                    outbound: None,
                },
                connector: Arc::new(super::config::TcpTargetConnector),
                cancel: &task_cancel,
                counters: &task_counters,
                reconnect_delay: &mut reconnect_delay,
                service_state: &mut service_state,
                commands: &mut command_rx,
            },
        )
        .await
    });
    let mut peer: BoxStream = Box::new(server_io);
    assert!(matches!(
        read_boxed(&mut peer).await.unwrap(),
        Message::ClientHello(_)
    ));
    write_boxed(
        &mut peer,
        &Message::ServerHello(ServerHello {
            version: ProtocolVersion::CURRENT,
            capabilities: Capabilities::default(),
        }),
    )
    .await
    .unwrap();
    assert!(matches!(
        read_boxed(&mut peer).await.unwrap(),
        Message::Auth(_)
    ));
    write_boxed(
        &mut peer,
        &Message::AuthOk(AuthOk {
            session_id: eggtunnel_proto::SessionId::generate().unwrap(),
        }),
    )
    .await
    .unwrap();
    let Message::RegisterService(initial) = read_boxed(&mut peer).await.unwrap() else {
        panic!("expected initial registration")
    };
    write_boxed(
        &mut peer,
        &Message::RegisterAck(eggtunnel_proto::RegisterAck {
            service_id: initial.service_id,
            effective_bind: EffectiveBind {
                address: std::net::Ipv6Addr::LOCALHOST.octets(),
                port: 31001,
            },
        }),
    )
    .await
    .unwrap();
    (handle, counters, task, peer)
}

#[tokio::test]
async fn dynamic_registration_returns_disconnected_if_ack_is_lost() {
    let (handle, _, task, mut peer) = fake_connected_client().await;

    let register_handle = handle.clone();
    let register = tokio::spawn(async move {
        register_handle
            .register_service(service(2, "dynamic", 81))
            .await
    });
    let dynamic = tokio::time::timeout(Duration::from_secs(2), read_boxed(&mut peer))
        .await
        .unwrap()
        .unwrap();
    assert!(matches!(dynamic, Message::RegisterService(_)));
    drop(peer);
    assert!(matches!(
        register.await.unwrap(),
        Err(TunnelError::Disconnected)
    ));
    assert!(task.await.unwrap().is_err());
}

#[tokio::test]
async fn cancelled_registration_is_unregistered_and_never_becomes_desired_state() {
    let (handle, counters, task, mut peer) = fake_connected_client().await;
    let register_handle = handle.clone();
    let register = tokio::spawn(async move {
        register_handle
            .register_service(service(2, "cancelled", 81))
            .await
    });
    assert!(matches!(
        tokio::time::timeout(Duration::from_secs(2), read_boxed(&mut peer))
            .await
            .unwrap()
            .unwrap(),
        Message::RegisterService(_)
    ));
    register.abort();
    write_boxed(
        &mut peer,
        &Message::RegisterAck(eggtunnel_proto::RegisterAck {
            service_id: ServiceId(2),
            effective_bind: EffectiveBind {
                address: std::net::Ipv6Addr::LOCALHOST.octets(),
                port: 31002,
            },
        }),
    )
    .await
    .unwrap();
    assert!(matches!(
        tokio::time::timeout(Duration::from_secs(2), read_boxed(&mut peer))
            .await
            .unwrap()
            .unwrap(),
        Message::UnregisterService(eggtunnel_proto::UnregisterService {
            service_id: ServiceId(2)
        })
    ));
    assert_eq!(counters.snapshot().registered_services, 1);
    assert!(
        counters
            .snapshot()
            .effective_binds
            .iter()
            .all(|(_, service_id, _)| *service_id != ServiceId(2))
    );
    drop(peer);
    assert!(task.await.unwrap().is_err());
}

#[tokio::test]
async fn command_from_an_older_session_generation_cannot_register() {
    let (handle, counters, task, mut peer) = fake_connected_client().await;
    let (reply, response) = oneshot::channel();
    let generation = counters
        .session_generation
        .load(std::sync::atomic::Ordering::Relaxed);
    handle
        .commands
        .send(ClientCommand::Register {
            service: service(2, "stale-generation", 82),
            generation: generation.saturating_sub(1),
            reply,
        })
        .await
        .unwrap();
    assert!(matches!(
        response.await.unwrap(),
        Err(TunnelError::Disconnected)
    ));
    assert_eq!(counters.snapshot().registered_services, 1);
    assert!(
        tokio::time::timeout(Duration::from_millis(50), read_boxed(&mut peer))
            .await
            .is_err()
    );
    handle.shutdown();
    assert!(task.await.unwrap().is_ok());
}

#[tokio::test]
async fn dynamic_registration_ack_timeout_is_typed_and_closes_session() {
    let mut policy = crate::RuntimePolicy::default();
    policy.timeouts.handshake = Duration::from_millis(100);
    let (handle, _, task, mut peer) = fake_connected_client_with_policy(policy).await;
    let register_handle = handle.clone();
    let register = tokio::spawn(async move {
        register_handle
            .register_service(service(2, "no-ack", 82))
            .await
    });
    assert!(matches!(
        tokio::time::timeout(Duration::from_secs(1), read_boxed(&mut peer))
            .await
            .unwrap()
            .unwrap(),
        Message::RegisterService(_)
    ));
    assert!(matches!(
        tokio::time::timeout(Duration::from_secs(2), register)
            .await
            .unwrap()
            .unwrap(),
        Err(TunnelError::Timeout)
    ));
    assert!(matches!(task.await.unwrap(), Err(TunnelError::Timeout)));
}

#[tokio::test]
async fn heartbeat_tracks_rtt_misses_and_recovery_with_one_probe() {
    let mut policy = crate::RuntimePolicy::default();
    policy.timeouts.control_idle = Duration::from_secs(2);
    policy.timeouts.heartbeat_interval = Duration::from_millis(50);
    let (handle, counters, task, mut peer) = fake_connected_client_with_policy(policy).await;
    let Message::Ping(first) = tokio::time::timeout(Duration::from_secs(1), read_boxed(&mut peer))
        .await
        .unwrap()
        .unwrap()
    else {
        panic!("expected heartbeat Ping")
    };
    write_boxed(
        &mut peer,
        &Message::Pong(eggtunnel_proto::Pong { nonce: first.nonce }),
    )
    .await
    .unwrap();
    tokio::time::timeout(Duration::from_secs(1), async {
        loop {
            if counters.snapshot().heartbeat.latest_rtt_ms.is_some() {
                break;
            }
            tokio::task::yield_now().await;
        }
    })
    .await
    .unwrap();

    let Message::Ping(unanswered) = read_boxed(&mut peer).await.unwrap() else {
        panic!("expected next heartbeat Ping")
    };
    tokio::time::timeout(Duration::from_secs(1), async {
        loop {
            if counters.snapshot().heartbeat.missed_heartbeats > 0 {
                break;
            }
            tokio::task::yield_now().await;
        }
    })
    .await
    .unwrap();
    write_boxed(
        &mut peer,
        &Message::Pong(eggtunnel_proto::Pong {
            nonce: unanswered.nonce,
        }),
    )
    .await
    .unwrap();
    tokio::time::timeout(Duration::from_secs(1), async {
        loop {
            if counters.snapshot().heartbeat.missed_heartbeats == 0 {
                break;
            }
            tokio::task::yield_now().await;
        }
    })
    .await
    .unwrap();
    assert!(counters.snapshot().heartbeat.last_pong_age_ms.is_some());
    handle.shutdown();
    drop(peer);
    let _ = task.await;
}

#[test]
fn client_builder_applies_custom_service_ceiling() {
    let mut config = config("localhost:443");
    config.services.push(ClientService::new(
        ServiceId(2),
        ServiceName::new("two").unwrap(),
        RequestedBind::Loopback { port: 0 },
        TcpTarget::new("127.0.0.1", 81).unwrap(),
    ));
    let mut policy = crate::common::RuntimePolicy::default();
    policy.limits.services_per_session = 1;
    let builder = ClientBuilder::new(config).runtime_policy(policy);
    assert!(builder.validate().is_err());
}

#[test]
fn client_builder_accepts_tcp_tls_and_default_policy() {
    assert!(
        ClientBuilder::new(config("localhost:443"))
            .validate()
            .is_ok()
    );
    let mut dynamic_only = config("localhost:443");
    dynamic_only.services.clear();
    assert!(ClientBuilder::new(dynamic_only).validate().is_ok());
    let mut custom_ca = config("localhost:443");
    custom_ca.ca_pem = Some(b"custom CA".to_vec());
    assert!(ClientBuilder::new(custom_ca).validate().is_ok());
}

#[cfg(feature = "mtls")]
#[test]
fn client_builder_accepts_tcp_mtls() {
    let builder = ClientBuilder::new(config("localhost:443"))
        .with_identity(ClientIdentity::new(b"cert".to_vec(), b"key".to_vec()));
    assert!(builder.validate().is_ok());
}

#[cfg(feature = "quic")]
#[test]
fn client_profile_validator_rejects_quic_custom_ca() {
    let mut config = config("localhost:443");
    config.ca_pem = Some(b"custom CA".to_vec());
    let builder = ClientBuilder::new(config).transport(ClientTransportProfile::Quic);
    assert!(builder.validate().is_err());
}

#[cfg(feature = "quic")]
#[test]
fn client_profile_validator_accepts_quic_defaults() {
    assert!(
        ClientBuilder::new(config("localhost:443"))
            .transport(ClientTransportProfile::Quic)
            .validate()
            .is_ok()
    );
}

#[cfg(feature = "websocket")]
#[test]
fn client_profile_validator_accepts_websocket_defaults() {
    assert!(
        ClientBuilder::new(config("localhost:443"))
            .transport(ClientTransportProfile::WebSocket)
            .validate()
            .is_ok()
    );
}

#[cfg(all(feature = "quic", feature = "outbound-proxy"))]
#[test]
fn client_profile_validator_rejects_quic_proxy() {
    let builder = ClientBuilder::new(config("localhost:443"))
        .transport(ClientTransportProfile::Quic)
        .outbound_proxy("socks5://localhost:1080");
    assert!(builder.validate().is_err());
}

#[cfg(all(feature = "quic", feature = "mtls"))]
#[test]
fn client_profile_validator_rejects_quic_mtls() {
    let builder = ClientBuilder::new(config("localhost:443"))
        .transport(ClientTransportProfile::Quic)
        .with_identity(ClientIdentity::new(b"cert".to_vec(), b"key".to_vec()));
    assert!(builder.validate().is_err());
}

#[cfg(all(feature = "websocket", feature = "outbound-proxy"))]
#[test]
fn client_profile_validator_accepts_websocket_proxy() {
    let builder = ClientBuilder::new(config("localhost:443"))
        .transport(ClientTransportProfile::WebSocket)
        .outbound_proxy("socks5://localhost:1080");
    assert!(builder.validate().is_ok());
}

#[cfg(all(feature = "websocket", feature = "mtls"))]
#[test]
fn client_profile_validator_rejects_websocket_mtls() {
    let builder = ClientBuilder::new(config("localhost:443"))
        .transport(ClientTransportProfile::WebSocket)
        .with_identity(ClientIdentity::new(b"cert".to_vec(), b"key".to_vec()));
    assert!(builder.validate().is_err());
}

#[cfg(all(feature = "mtls", feature = "outbound-proxy"))]
#[test]
fn client_profile_validator_rejects_mtls_proxy() {
    let builder = ClientBuilder::new(config("localhost:443"))
        .with_identity(ClientIdentity::new(b"cert".to_vec(), b"key".to_vec()))
        .outbound_proxy("socks5://localhost:1080");
    assert!(builder.validate().is_err());
}