pb-mapper-cli 0.12.0

Unified CLI and relay server for pb-mapper
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
//! The `register` and `connect` roles: their flags, the tunnel they start,
//! and the log they keep of it until it stops.

use std::error::Error;
use std::time::Duration;

use clap::{Args, ValueEnum};
use pb_mapper_client::sdk::{
    Client, ConnectOptions, ConnectRequest, LanTransport, PathPolicy, PortMapping, RegisterOptions,
    RegisterRequest, RelayTransport, TunnelDiagnostics, TunnelEventKind, TunnelEvents,
    TunnelMetrics, TunnelStatus,
};
use pb_mapper_core::config::{keep_alive_from_env, pb_mapper_server_addr};

use crate::stop_requests;

#[derive(Debug, Args)]
pub(super) struct RegisterArgs {
    /// Keep every session to this service on the relay; refuse direct ones.
    #[arg(long, conflicts_with = "allow_direct")]
    relay_only: bool,
    /// Accepted for 0.7 scripts: direct sessions are allowed by default.
    #[arg(long, hide = true)]
    allow_direct: bool,
    /// When to ask the router (PCP, NAT-PMP or UPnP) to map the direct UDP
    /// port: `auto` once punching through fails (the default), `always` from
    /// the start, or `off`. Alone, `always`.
    #[arg(
        long,
        value_enum,
        default_value_t = PortMappingArg::Auto,
        num_args = 0..=1,
        default_missing_value = "always",
        conflicts_with = "relay_only"
    )]
    port_mapping: PortMappingArg,
    /// Probe a consumer's addresses in the order it offered them, rather than
    /// those on a local network shared with it first.
    #[arg(
        long = "no-lan-first",
        action = clap::ArgAction::SetFalse,
        conflicts_with = "relay_only"
    )]
    lan_first: bool,
    /// Refuse a consumer that asks for TCP within a local network shared
    /// with it; it then takes QUIC. Otherwise a TCP listener opens the first
    /// time one asks, on the direct port's number, offered on LANs only.
    #[arg(
        long = "no-lan-tcp",
        action = clap::ArgAction::SetFalse,
        conflicts_with = "relay_only"
    )]
    lan_tcp: bool,
    /// Transport used by the local service.
    #[arg(value_enum)]
    transport: Transport,
    /// Service key registered with the relay.
    #[arg(short, long)]
    key: String,
    /// Local service address to forward to.
    #[arg(short, long, visible_alias = "local")]
    addr: String,
    #[command(flatten)]
    relay: RelayArgs,
    /// Encrypt forwarded traffic with the configured MSG_HEADER_KEY.
    #[arg(short, long, default_value_t = false)]
    codec: bool,
    /// Administrator-only target namespace. Temporary credentials always use their own key id.
    #[arg(long)]
    namespace: Option<u64>,
    /// Required when an administrator registers a service inside a temporary-key namespace.
    #[arg(long, requires = "namespace", default_value_t = false)]
    force: bool,
}

#[derive(Debug, Args)]
pub(super) struct ConnectArgs {
    /// Try direct first with automatic relay fallback, or use the relay only.
    #[arg(long, value_enum, default_value_t = PathArg::Auto)]
    path: PathArg,
    /// Shorthand for `--path relay-only`.
    #[arg(long, conflicts_with = "path")]
    relay_only: bool,
    /// When to ask the router (PCP, NAT-PMP or UPnP) to map the direct UDP
    /// port: `auto` once punching through fails (the default), `always` from
    /// the start, or `off`. Alone, `always`.
    #[arg(
        long,
        value_enum,
        default_value_t = PortMappingArg::Auto,
        num_args = 0..=1,
        default_missing_value = "always",
        conflicts_with = "relay_only"
    )]
    port_mapping: PortMappingArg,
    /// Dial every direct path as soon as it answers, rather than trying a
    /// local network shared with the publisher first.
    #[arg(
        long = "no-lan-first",
        action = clap::ArgAction::SetFalse,
        conflicts_with = "relay_only"
    )]
    lan_first: bool,
    /// What a path within a local network shared with the publisher runs
    /// over: `quic` (the default), or `tcp`, tried 300 ms ahead of QUIC and
    /// falling back to it. A path across the internet is always QUIC.
    #[arg(
        long,
        value_enum,
        default_value_t = LanTransportArg::Quic,
        conflicts_with = "relay_only"
    )]
    lan_transport: LanTransportArg,
    /// Transport exposed by the local listener.
    #[arg(value_enum)]
    transport: Transport,
    /// Registered service key to subscribe to.
    #[arg(short, long)]
    key: String,
    /// Local address on which downstream clients connect.
    #[arg(short, long, visible_alias = "local")]
    addr: String,
    #[command(flatten)]
    relay: RelayArgs,
    /// Administrator-only target namespace. Temporary credentials always use their own key id.
    #[arg(long)]
    namespace: Option<u64>,
}

#[derive(Debug, Args)]
struct RelayArgs {
    /// Carrier between this endpoint and the relay; independent of TCP/UDP service type.
    #[arg(long, value_enum, default_value_t = RelayTransportArg::Tcp)]
    relay_transport: RelayTransportArg,
    /// Relay address. Falls back to PB_MAPPER_SERVER.
    #[arg(short, long, visible_alias = "pb-mapper-server", value_name = "ADDR")]
    server: Option<String>,
    /// Enable TCP keep-alive. PB_MAPPER_KEEP_ALIVE=ON is also supported.
    #[arg(long, default_value_t = false)]
    keep_alive: bool,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, ValueEnum)]
enum RelayTransportArg {
    Tcp,
    Quic,
}

impl From<RelayTransportArg> for RelayTransport {
    fn from(value: RelayTransportArg) -> Self {
        match value {
            RelayTransportArg::Tcp => Self::Tcp,
            RelayTransportArg::Quic => Self::Quic,
        }
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, ValueEnum)]
enum PortMappingArg {
    Off,
    Auto,
    Always,
}

impl From<PortMappingArg> for PortMapping {
    fn from(value: PortMappingArg) -> Self {
        match value {
            PortMappingArg::Off => Self::Off,
            PortMappingArg::Auto => Self::Auto,
            PortMappingArg::Always => Self::Always,
        }
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, ValueEnum)]
enum LanTransportArg {
    Quic,
    Tcp,
}

impl From<LanTransportArg> for LanTransport {
    fn from(value: LanTransportArg) -> Self {
        match value {
            LanTransportArg::Quic => Self::Quic,
            LanTransportArg::Tcp => Self::Tcp,
        }
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, ValueEnum)]
enum PathArg {
    RelayOnly,
    Auto,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, ValueEnum)]
enum Transport {
    Tcp,
    Udp,
}

impl From<Transport> for pb_mapper_client::sdk::Transport {
    fn from(value: Transport) -> Self {
        match value {
            Transport::Tcp => Self::Tcp,
            Transport::Udp => Self::Udp,
        }
    }
}

fn tunnel_client(relay: &RelayArgs, namespace: Option<u64>) -> Result<Client, Box<dyn Error>> {
    let credential = pb_mapper_core::checksum::get_process_credential().map_err(|error| {
        std::io::Error::other(format!("tunnel credential is required: {error}"))
    })?;
    Ok(Client::from_credential(
        pb_mapper_server_addr(relay.server.as_deref())?,
        credential,
        relay.keep_alive || keep_alive_from_env(),
        namespace,
    )
    .with_relay_transport(relay.relay_transport.into())?)
}

pub(super) async fn run_register(args: RegisterArgs) -> Result<(), Box<dyn Error>> {
    let stop = stop_requests()?;
    let client = tunnel_client(&args.relay, args.namespace)?;
    let registration = client
        .register_with_options(
            RegisterRequest {
                key: args.key,
                local_addr: args.addr,
                transport: args.transport.into(),
                codec: args.codec,
                force_namespace: args.force,
            },
            RegisterOptions {
                allow_direct: !args.relay_only && RegisterOptions::default().allow_direct,
                idle_timeout: None,
                port_mapping: args.port_mapping.into(),
                lan_first: args.lan_first,
                lan_tcp: args.lan_tcp,
            },
        )
        .await?;
    monitor_tunnel(
        stop,
        &client,
        registration.subscribe(),
        registration.subscribe_events(),
        || registration.metrics(),
        || registration.diagnostics(),
    )
    .await?;
    registration.stop().await?;
    Ok(())
}

pub(super) async fn run_connect(args: ConnectArgs) -> Result<(), Box<dyn Error>> {
    let stop = stop_requests()?;
    let client = tunnel_client(&args.relay, args.namespace)?;
    let connection = client
        .connect_with_options(
            ConnectRequest {
                key: args.key,
                local_addr: args.addr,
                transport: args.transport.into(),
            },
            ConnectOptions {
                path: match (args.relay_only, args.path) {
                    (true, _) | (false, PathArg::RelayOnly) => PathPolicy::RelayOnly,
                    // Auto in a build with `p2p`, relay-only in one without.
                    (false, PathArg::Auto) => PathPolicy::default(),
                },
                port_mapping: args.port_mapping.into(),
                lan_first: args.lan_first,
                lan_transport: args.lan_transport.into(),
            },
        )
        .await?;
    monitor_tunnel(
        stop,
        &client,
        connection.subscribe(),
        connection.subscribe_events(),
        || connection.metrics(),
        || connection.diagnostics(),
    )
    .await?;
    connection.stop().await?;
    Ok(())
}

/// Log a running tunnel until it stops: its metrics, its diagnostics and the
/// relay's every 30 s, and as they happen each session that closes, with its
/// bytes, and each setup that found the LAN and went elsewhere. The
/// diagnostics carry what the metrics leave out: port mapping, the retry
/// state, recent events, and the direct link's setup timings and candidate
/// counts, which a LAN-first A/B compares.
async fn monitor_tunnel(
    stop: impl Future<Output = ()>,
    client: &Client,
    mut status: tokio::sync::watch::Receiver<TunnelStatus>,
    mut events: TunnelEvents,
    metrics: impl Fn() -> TunnelMetrics,
    diagnostics: impl Fn() -> TunnelDiagnostics,
) -> Result<(), Box<dyn Error>> {
    let mut interval = tokio::time::interval(Duration::from_secs(30));
    interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
    // One listener for the whole run, made before the tunnel started: one
    // made per pass would be gone while a pass logs, and a request to stop
    // arriving then would be lost.
    let mut stop = std::pin::pin!(stop);
    let mut events_open = true;
    loop {
        let state = status.borrow_and_update().clone();
        match state {
            TunnelStatus::Failed(reason) => return Err(std::io::Error::other(reason).into()),
            TunnelStatus::Stopped => return Ok(()),
            TunnelStatus::Starting | TunnelStatus::Connected | TunnelStatus::Retrying => {}
        }
        // Unbiased: a backlog of events, ready on every pass, must not keep
        // the metrics tick from its turn.
        tokio::select! {
            () = &mut stop => return Ok(()),
            result = status.changed() => { if result.is_err() { return Ok(()); } },
            event = events.recv(), if events_open => match event {
                Some(Ok(event)) => match &event.kind {
                    TunnelEventKind::SessionClosed { .. } => {
                        tracing::info!(event = "tunnel_session_closed", detail = %serde_json::to_string(&event.kind)?, "tunnel session closed");
                    }
                    TunnelEventKind::LanMissed { .. } => {
                        tracing::info!(event = "tunnel_lan_missed", detail = %serde_json::to_string(&event.kind)?, "direct setup found the LAN but did not stay on it");
                    }
                    TunnelEventKind::LanTcpMissed { .. } => {
                        tracing::info!(event = "tunnel_lan_tcp_missed", detail = %serde_json::to_string(&event.kind)?, "direct setup asked for TCP on the LAN and took another way");
                    }
                    _ => {}
                },
                Some(Err(lagged)) => tracing::debug!(%lagged, "tunnel events skipped"),
                None => events_open = false,
            },
            _ = interval.tick() => {
                tracing::info!(event = "tunnel_metrics", status = ?state, metrics = %serde_json::to_string(&metrics())?, diagnostics = %serde_json::to_string(&diagnostics())?, relay = %serde_json::to_string(&client.relay_diagnostics().await)?, "tunnel metrics");
            },
        }
    }
}

#[cfg(test)]
mod tests {
    use clap::Parser;

    use super::*;
    use crate::{Cli, Command};

    const REGISTER: [&str; 7] = [
        "pb-mapper",
        "register",
        "tcp",
        "--key",
        "web",
        "--addr",
        "127.0.0.1:8080",
    ];

    const CONNECT: [&str; 7] = [
        "pb-mapper",
        "connect",
        "tcp",
        "--key",
        "web",
        "--addr",
        "127.0.0.1:9090",
    ];

    /// `base`, a whole command line, with `extra` appended.
    fn parse_with(base: &[&str], extra: &[&str]) -> Result<Cli, clap::Error> {
        Cli::try_parse_from(base.iter().chain(extra))
    }

    fn register_args(extra: &[&str]) -> RegisterArgs {
        let cli = parse_with(&REGISTER, extra).expect("register flags should parse");
        let Command::Register(args) = cli.command else {
            panic!("expected register command");
        };
        args
    }

    fn connect_args(extra: &[&str]) -> ConnectArgs {
        let cli = parse_with(&CONNECT, extra).expect("connect flags should parse");
        let Command::Connect(args) = cli.command else {
            panic!("expected connect command");
        };
        args
    }

    #[test]
    fn register_flags_from_0_7_still_parse_and_direct_is_the_default() {
        let defaults = register_args(&[]);
        assert!(!defaults.relay_only);
        assert!(defaults.lan_first && defaults.lan_tcp);
        assert_eq!(defaults.relay.relay_transport, RelayTransportArg::Tcp);
        assert!(
            parse_with(&REGISTER, &["--allow-direct"]).is_ok(),
            "0.7 opt-in flag is accepted"
        );
        let no_tcp = register_args(&["--no-lan-tcp"]);
        assert!(!no_tcp.lan_tcp && no_tcp.lan_first);
        assert!(parse_with(&REGISTER, &["--relay-only", "--no-lan-tcp"]).is_err());
        assert!(!register_args(&["--no-lan-first"]).lan_first);
        assert!(parse_with(&REGISTER, &["--relay-only", "--no-lan-first"]).is_err());
        assert!(register_args(&["--relay-only"]).relay_only);
    }

    #[test]
    fn connect_flags_from_0_7_still_parse_and_direct_is_the_default() {
        let defaults = connect_args(&[]);
        assert_eq!(defaults.path, PathArg::Auto);
        assert_eq!(defaults.relay.relay_transport, RelayTransportArg::Tcp);
        assert!(!defaults.relay_only);
        assert!(parse_with(&CONNECT, &["--path", "auto"]).is_ok());
        assert!(parse_with(&CONNECT, &["--relay-only"]).is_ok());
        assert!(parse_with(&CONNECT, &["--relay-only", "--path", "auto"]).is_err());
        let mapping = |extra: &[&str]| connect_args(extra).port_mapping;
        assert_eq!(defaults.port_mapping, PortMappingArg::Auto);
        assert_eq!(mapping(&["--port-mapping", "off"]), PortMappingArg::Off);
        assert_eq!(mapping(&["--port-mapping"]), PortMappingArg::Always);
        assert_eq!(mapping(&["--port-mapping", "auto"]), PortMappingArg::Auto);
        assert!(defaults.lan_first);
        assert!(!connect_args(&["--no-lan-first"]).lan_first);
        assert!(parse_with(&CONNECT, &["--relay-only", "--no-lan-first"]).is_err());
        assert_eq!(defaults.lan_transport, LanTransportArg::Quic);
        let tcp = connect_args(&["--lan-transport", "tcp"]);
        assert_eq!(LanTransport::from(tcp.lan_transport), LanTransport::Tcp);
        assert!(parse_with(&CONNECT, &["--relay-only", "--lan-transport", "tcp"]).is_err());
    }
}