mirror of
https://github.com/jmcorgan/fips.git
synced 2026-08-09 00:04:54 +00:00
Optional peer discovery and NAT hole-punching path gated behind a new
`nostr-discovery` cargo feature. Nodes publish signed overlay endpoint
adverts to public Nostr relays, consume peer adverts to populate
fallback dial addresses, and use STUN-assisted UDP hole punching with
NIP-59 gift-wrap offer/answer signaling to establish direct UDP paths
between NATed peers. Once a punched socket is up, it is handed into
the existing FIPS UDP transport and the standard Noise/FMP session
stack takes over unchanged.
The cargo feature is in the default feature set
(`default = ["nostr-discovery"]`) so stock builds include it; a
build that explicitly disables default features (or selects a
feature set without `nostr-discovery`) does not link the nostr /
nostr-sdk crates and does not emit a no-op poll in the tick loop.
Runtime behavior is independently gated by
`node.discovery.nostr.enabled`, which defaults to false; if the
config enables Nostr on a non-feature build, startup logs a
warning and continues without it.
== Cargo feature and dependencies
- New cargo feature `nostr-discovery = ["dep:nostr", "dep:nostr-sdk"]`.
Not in the default feature set.
- New optional Linux-only dependencies: `nostr 0.44` (features: std,
nip59) and `nostr-sdk 0.44`. Gift-wrap unwrap is hand-rolled in
`src/discovery/nostr/signal.rs` rather than relying on the SDK's
rumor-author check, which FIPS sidesteps by trusting `seal.pubkey`
exclusively.
== Wire format
Overlay advert event: `kind 37195`, parameterized replaceable
(NIP-01 application-defined replaceable range 30000-39999), with
`d = "fips-overlay-v1"`. The digits visually spell FIPS (7=F, 1=I,
9=P, 5=S); a relay survey confirmed the kind is unused.
Advert content carries the version tag, endpoint list
(`udp|tcp|tor` + addr), optional signal-relay and stun-server
metadata, and `issuedAt` / `expiresAt` timestamps. Endpoint
`addr: "nat"` is the sentinel that triggers traversal on the peer
side. NIP-40 `expiration` tag bounds staleness on permanent
shutdown. Lifecycle relies on parameterized-replaceable
supersession; the daemon does not emit NIP-09 kind-5 deletes —
strict relays (Damus, Primal) race delete-against-replace and can
silently drop the replacement.
Gift-wrapped signal event: `kind 21059`. Punch packets carry magic
values `PUNCH_MAGIC` / `PUNCH_ACK_MAGIC`, a sequence number, and a
16-byte session hash.
== Discovery surface
- `src/discovery.rs` (always compiled)
- `EstablishedTraversal`: bound UDP socket + selected remote +
peer npub + optional transport name/config tuning overrides.
- `BootstrapHandoffResult`: returned on successful handoff —
allocated transport id, local/remote addrs, peer NodeAddr,
session id.
- `src/discovery/nostr/` (`#![cfg(feature = "nostr-discovery")]`)
- `types.rs`: wire and control types described above. `ADVERT_KIND`
constant. `BootstrapError` enumerates failure modes (disabled,
missing advert, missing NAT endpoint, no usable relays, invalid
advert, invalid npub, signal timeout, punch timeout, replay,
STUN failure, protocol, nostr, io, serde, event-parse).
- `runtime.rs`: `NostrDiscovery` coordinator. Owns the shared
nostr-sdk `Client`, subscribes to advert + signal event kinds,
maintains a bounded advert cache and a bounded seen-sessions
replay set, drains `BootstrapEvent::{Established, Failed}` for
the node to consume, exposes `update_local_advert`,
`request_connect`, `advert_endpoints_for_peer`,
`cached_open_discovery_candidates`, and `shutdown`.
- `signal.rs`: NIP-59 gift-wrap encode/decode. Outbound wraps are
built against per-attempt ephemeral keys; inbound events are
unwrapped against the node identity.
- `stun.rs`: RFC 5389/8489 Binding Request client with
XOR-MAPPED-ADDRESS parsing for both IPv4 and IPv6; used only to
observe the initiator's own reflexive address against its
locally configured STUN list (peer-advertised STUN is
informational, never an egress target).
- `traversal.rs`: per-attempt candidate-pair punch planner.
Allocates a fresh `0.0.0.0:0` UDP socket per attempt, enumerates
LAN-private and ULA interface addresses alongside the STUN
reflexive address, schedules probe/ack exchanges at the
configured interval for the configured duration, and picks the
first candidate pair that authenticates end-to-end.
Strategy ordering is Reflexive↔Reflexive first, then LAN, then
Mixed. The STUN-observed pair is the only candidate that's reliable
across arbitrary network topologies; trying it first prevents the
planner from latching onto a misleading host-candidate path before
the reflexive path gets a chance. There is no catch-all
Local↔Local strategy: a previous design that paired every local
host candidate from one side with every local host candidate from
the other could declare success on a one-way reachable asymmetric
L3 path (corporate VPN, Tailscale subnet route, overlapping private
address space), only for the FMP handshake to stall because the
return path didn't match. The legitimate `Lan` strategy still pairs
candidates that share a subnet.
== Configuration surface
`node.discovery.nostr.*` (`NostrDiscoveryConfig`), all `serde(default)`
with `deny_unknown_fields`:
- `enabled` (default false), `advertise` (default true)
- `advert_relays`, `dm_relays`, `stun_servers`: defaults are
`wss://relay.damus.io`, `wss://nos.lol`, `wss://offchain.pub`
for both relay lists, and Google / Cloudflare / Twilio for STUN.
Operators are expected to override for production. Other
verified-working public relays for reference:
`nostr.bitcoiner.social`, `nostr-pub.wellorder.net`,
`nostr.oxtr.dev`, `nostr.mom`.
- `app` (default `"fips-overlay-v1"`), `signal_ttl_secs` (120)
- `policy`: `NostrDiscoveryPolicy::{Disabled, ConfiguredOnly (default),
Open}` — controls whether advert-derived endpoints are consumed
only for peers carrying `via_nostr = true`, or also for
non-configured peers within a budget cap.
- `share_local_candidates` (default false) — when false, the offer's
`local_addresses` list is empty and peers see only the reflexive
address. Enable per-node only for genuinely same-LAN deployments;
off-by-default eliminates the misleading-path failure mode for
the common case where peers are not on the same broadcast domain.
- `open_discovery_max_pending` (64) — caps queued open-discovery
retries; bounded by available outbound slots.
- `max_concurrent_incoming_offers` (16) — semaphore against offer
spam; excess offers are debug-logged and dropped.
- `advert_cache_max_entries` (2048) and `seen_sessions_max_entries`
(2048) — bound memory under ambient relay volume; overflow
evictions are debug-logged.
- `attempt_timeout_secs` (10), `replay_window_secs` (300)
- `punch_start_delay_ms` (2000), `punch_interval_ms` (200),
`punch_duration_ms` (10000)
- `advert_ttl_secs` (3600), `advert_refresh_secs` (1800)
Per-peer and per-transport flags:
- `PeerConfig.via_nostr: bool` — when true (and Nostr is enabled),
advert-derived addresses are appended as fallback dial candidates
after static addresses for that peer.
- `PeerConfig.addresses` is now `serde(default)` and may be empty
when `via_nostr: true`; validation requires at least one of the
two to be present per peer, and the error message names the
peer's npub.
- `UdpConfig.advertise_on_nostr: Option<bool>` and
`UdpConfig.public: Option<bool>` — UDP transports can be
advertised either as direct `host:port` (public = true) or as the
`addr: "nat"` sentinel that triggers rendezvous on the peer side.
- `TcpConfig.advertise_on_nostr` and `TorConfig.advertise_on_nostr`
— TCP and Tor onion endpoints can be advertised as directly
reachable.
- A reserved peer address `transport: udp, addr: "nat"` parses without
special-casing in YAML and routes through the bootstrap runtime.
Cross-field validation (`Config::validate`, called from `Node::new`
and `Node::with_identity`):
- Any transport with `advertise_on_nostr = true` requires
`node.discovery.nostr.enabled = true`.
- Any peer with `via_nostr = true` requires
`node.discovery.nostr.enabled = true`.
- A non-public UDP advert (`advertise_on_nostr = true`,
`public = false` — i.e. `udp:nat`) additionally requires at least
one `dm_relay` and at least one `stun_server`.
Surfaced as `ConfigError::Validation`.
== Node integration
`src/node/lifecycle.rs` is the main integration point.
- At node start (after transports are up, before TUN), if Nostr is
enabled and the feature is compiled in, `NostrDiscovery::start` is
invoked, the initial local overlay advert is built from the live
transport set and published, and the runtime handle is stored.
- The rx tick loop calls `poll_nostr_discovery` (feature-gated both
at method definition and call site), which refreshes the local
advert, drains bootstrap events, adopts established traversals,
schedules retries for failed traversals, and — under `policy:
open` — enqueues outbound retries for non-configured peers
visible in the advert cache, bounded by
`open_discovery_max_pending` and the remaining outbound slots.
- Outbound peer dialing is refactored to `try_peer_addresses`, which
first exhausts the static address list in priority order and only
then appends advert-derived fallback addresses; both lists run
through the same `attempt_peer_address_list` code path. The
`udp:nat` sentinel address triggers `NostrDiscovery::request_connect`
for the peer instead of a direct dial and returns `Ok(())`.
- `build_overlay_advert` walks operational transports, consults
per-instance `UdpConfig` / `TcpConfig` / `TorConfig` (matching by
optional transport instance name), and emits an `OverlayAdvert`
including `signalRelays` and `stunServers` when any UDP endpoint
is advertised as NAT.
- `adopt_established_traversal` is the bootstrap handoff API:
allocates a new `TransportId`, constructs a `UdpTransport` with
the user-supplied (or default) `UdpConfig`, calls the new
`adopt_socket_async` to reuse the punched socket verbatim,
registers the transport in the normal transport map, records it
in `bootstrap_transports`, and calls `initiate_connection` so the
normal handshake path runs. On failure, the transport is stopped
and removed cleanly and the set membership is rolled back.
- On clean shutdown, `NostrDiscovery::shutdown` is awaited so
background tasks stop before transports are torn down. (The
advert is not explicitly retracted; NIP-40 expiration plus the
next refresh from any live publisher supersedes it.)
New `Node` fields:
- `nostr_discovery: Option<Arc<NostrDiscovery>>` (feature-gated).
- `bootstrap_transports: HashSet<TransportId>` — per-peer UDP
transports adopted from NAT traversal, cleaned up via
`cleanup_bootstrap_transport_if_unused` whenever the link,
connection, peer, or pending-connect referencing them is removed.
Retry and error surface:
- `RetryState.expires_at_ms: Option<u64>` — optional absolute expiry
for a retry entry. `pump_retries` drops expired entries with an
info log. Used for open-discovery retries, which expire at two
times the advert TTL.
- New `NodeError::BootstrapHandoff(String)` returned from
`adopt_established_traversal` when the underlying transport
adoption fails or local address discovery fails.
- New `ConfigError::Validation(String)`.
- A small refactor extracts `Node::now_ms()` and reuses it across
lifecycle, rx-loop tick, and timeout bookkeeping.
== UDP transport
`src/transport/udp/`:
- `UdpRawSocket::adopt(std::net::UdpSocket, recv_buf, send_buf)`:
adopts an externally bound socket, makes it non-blocking, applies
the configured buffer sizes (warning if the kernel clamps), and
reports the resulting local address. Preserves the NAT mapping —
no rebind.
- `UdpTransport::adopt_socket_async(std::net::UdpSocket)`: the
`start_async` analogue for an already-bound socket, wiring the
async socket and recv task exactly as the fresh-bind path would.
- `Drop` impl for `UdpTransport`: if a transport is dropped while
still holding a recv task or socket (for example on error
teardown), aborts the task, clears the socket, and emits a debug
log so the cleanup is visible in tracing rather than silent.
== Logging and observability
Default `EnvFilter` demotes third-party relay-pool DEBUG output to
TRACE-only: `nostr_relay_pool`, `nostr_sdk`, and `nostr` are pinned
at INFO when our level is anything below TRACE, and at TRACE when
our level is TRACE — so the raw frames are still reachable when
explicitly asked for. RUST_LOG continues to override completely.
Concise one-line DEBUG events are emitted at the meaningful points
in the discovery / hole-punch sequence:
- `advert: published` (event id, relay count, endpoints, ttl)
- `advert: peer cached` (notify-loop ingress for non-self)
- `advert: resolved` (cache hit / relay fetch outcome)
- `traversal: initiator starting`
- `traversal: initiator STUN observed` (reflexive, local count)
- `traversal: offer sent` (session id, relay count, event id)
- `traversal: answer received` (accepted, reflexive, local)
- `traversal: initiator punch succeeded` (remote addr)
- `traversal: offer received` (responder side)
- `traversal: responder STUN observed`
- `traversal: answer sent`
- `traversal: responder punch succeeded`
Npubs are shortened to `npub1<4>..<4>` and event/session ids to
their first 8 hex characters.
Other operator-facing logs:
- `UdpTransport` adoption and drop paths log at info / debug.
- `adopt_established_traversal` logs at debug on entry and info on
successful return, tagged with peer npub, session id, transport
id, and both socket endpoints, so the bootstrap handoff is
traceable end-to-end alongside the `UdpTransport::drop` log.
- `cleanup_bootstrap_transport_if_unused` logs at debug when the
reference-count check drops an adopted transport.
- `connect_peer` tags its entry `debug!` with `peer_npub` so
downstream STUN, punch, and handshake logs for the same peer
correlate for operators.
- Advert-cache and seen-sessions overflow evictions log at debug so
mis-sized caps are visible under ambient relay volume.
- Gift-wrap unwrap failures on `SIGNAL_KIND` events log at trace
(hot path: fires for every unrelated signal event on the same
relay).
- Traversal-offer handler failures log at debug. Expected conditions
such as punch timeout on symmetric NAT are covered there; real
problems are reported upstream via `BootstrapEvent::Failed`.
- Inbound-offer rate-limit messages name the governing config field
(`max_concurrent_incoming_offers`) and state that the offer was
rate-limited rather than failing.
== Tests
- 18 new unit tests in `src/discovery/nostr/tests.rs` covering advert
encoding, signal envelope round-trip, STUN parsing, punch-packet
codec, and replay-window enforcement. Run under the
`nostr-discovery` feature.
- Config-validation tests in `src/config/mod.rs` covering the three
cross-field invariants and YAML parsing of the full
`node.discovery.nostr` block plus `peers[].via_nostr`, empty
`addresses` with `via_nostr: true`, and a `udp: nat` address.
- `src/node/tests/bootstrap.rs` integration tests that drive a
synthetic traversal (bound UDP socket pair + synthetic peer
identity) through `adopt_established_traversal` and assert the
Noise handshake completes over the adopted socket.
- Punch-planner tests assert reflexive-before-LAN ordering and that
same-LAN scenarios still include the LAN target in the plan.
- `testing/nat/` Docker NAT lab harness:
- Local `strfry` relay, local STUN responder, and one or two
router containers performing `iptables` NAT.
- Node LAN interfaces are provisioned with explicit `veth` pairs
injected into the node and router namespaces so every packet
traverses the router namespace (plain Docker bridges are not
used for the LAN).
- `cone` scenario: both peers behind full-cone-emulation NAT
(SNAT with source-port preservation, inbound DNAT back to the
single LAN host regardless of remote source); asserts UDP
traversal succeeds and link remote addresses are on the router
WAN subnet.
- `symmetric` scenario: `MASQUERADE --random-fully`; asserts UDP
traversal fails and TCP fallback converges over router-
published WAN addresses.
- `lan` scenario: both peers share a LAN subnet; asserts LAN
addresses are preferred over reflexive ones.
- Cleanup tears down all profile-gated services
(`--profile cone --profile symmetric --profile lan`) so no
orphan containers survive a run.
- `testing/scripts/build.sh` builds the Docker test image with
`--features "tui nostr-discovery"` by default so NAT-harness
binaries include bootstrap support.
== CI
- Linux release build and nextest unit-test job both use
`--features "gateway nostr-discovery"` so the feature-gated code
and its unit tests compile and run in CI.
- Three new integration matrix entries (`nat-cone`, `nat-symmetric`,
`nat-lan`) invoke `testing/nat/scripts/nat-test.sh`, collect
`docker compose logs` on failure, and always stop containers.
== Packaging and operations
- `packaging/common/fips.yaml` ships a fully commented
`node.discovery.nostr.*` block, plus documented
`advertise_on_nostr` / `public` examples under the UDP transport,
an `advertise_on_nostr` example under TCP, and a `via_nostr: true`
example under the static peer section with both a direct
`host:port` UDP address and a `udp: nat` fallback.
- `.github/workflows/package-openwrt.yml`: NIP-94 release event
publishes target the new default relay set.
== Documentation
- `README.md`: overlay discovery + NAT traversal moved from
"Near-term priorities" into "What works today".
- `docs/design/fips-intro.md`: rewrites the paragraphs that
previously described Nostr discovery and NAT traversal as future
work; describes the shipped mechanism and the feature gate.
- `docs/design/fips-transport-layer.md`: drops the "(future
direction)" qualifier from the Nostr Relay Discovery section,
expands with the `udp:nat` advertisement and bootstrap handoff
description, and updates the Current State callout.
- `docs/design/fips-mesh-layer.md`: notes that mid-session NAT
rebinding (roaming) and initial NAT traversal (Nostr path) are
distinct mechanisms.
- `docs/design/fips-configuration.md`: documents the full
`node.discovery.nostr.*` surface, including the three resource
caps and `share_local_candidates`.
- `docs/design/fips-nostr-discovery.md`: design and configuration
reference for the shipped mechanism, including the empty-
`addresses`-with-`via_nostr` shorthand.
- `docs/proposals/nostr-udp-hole-punch-protocol.md`: adds an
Implemented status callout, clarifies that the punch socket is
per-peer and per-attempt rather than shared with the application
listener, aligns field names with the shipped JSON
(`sessionId`, `issuedAt` / `expiresAt`, `reflexiveAddress`,
`localAddresses`, `stunServer`), sets the `d`-tag to
`fips-overlay-v1`, names the kind as 37195, and notes that
advertised STUN entries are informational.
- `docs/proposals/README.md`: adds a Status column and marks the
hole-punching proposal Implemented.
- `CHANGELOG.md`: Unreleased > Added entry covering the discovery
path, STUN/punch path, configuration surface, and Docker NAT lab.
Co-authored-by: Johnathan Corgan <johnathan@corganlabs.com>
745 lines
26 KiB
Rust
745 lines
26 KiB
Rust
//! Transport configuration types.
|
|
//!
|
|
//! Generic transport instance handling (single vs. named) and
|
|
//! transport-specific configuration structs.
|
|
|
|
use std::collections::HashMap;
|
|
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// Default UDP bind address.
|
|
const DEFAULT_UDP_BIND_ADDR: &str = "0.0.0.0:2121";
|
|
|
|
/// Default UDP MTU (IPv6 minimum).
|
|
const DEFAULT_UDP_MTU: u16 = 1280;
|
|
|
|
/// Default UDP receive buffer size (2 MB).
|
|
const DEFAULT_UDP_RECV_BUF: usize = 2 * 1024 * 1024;
|
|
|
|
/// Default UDP send buffer size (2 MB).
|
|
const DEFAULT_UDP_SEND_BUF: usize = 2 * 1024 * 1024;
|
|
|
|
/// UDP transport instance configuration.
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
#[serde(deny_unknown_fields)]
|
|
pub struct UdpConfig {
|
|
/// Bind address (`bind_addr`). Defaults to "0.0.0.0:2121".
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub bind_addr: Option<String>,
|
|
|
|
/// UDP MTU (`mtu`). Defaults to 1280 (IPv6 minimum).
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub mtu: Option<u16>,
|
|
|
|
/// UDP receive buffer size in bytes (`recv_buf_size`). Defaults to 2 MB.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub recv_buf_size: Option<usize>,
|
|
|
|
/// UDP send buffer size in bytes (`send_buf_size`). Defaults to 2 MB.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub send_buf_size: Option<usize>,
|
|
|
|
/// Whether this transport should be advertised on Nostr overlay discovery.
|
|
/// Default: false.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub advertise_on_nostr: Option<bool>,
|
|
|
|
/// Whether UDP should be advertised as directly reachable (`host:port`) on
|
|
/// Nostr. When false and advertised, UDP is emitted as `addr: "nat"` to
|
|
/// trigger rendezvous traversal.
|
|
///
|
|
/// Default: false.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub public: Option<bool>,
|
|
}
|
|
|
|
impl UdpConfig {
|
|
/// Get the bind address, using default if not configured.
|
|
pub fn bind_addr(&self) -> &str {
|
|
self.bind_addr.as_deref().unwrap_or(DEFAULT_UDP_BIND_ADDR)
|
|
}
|
|
|
|
/// Get the UDP MTU, using default if not configured.
|
|
pub fn mtu(&self) -> u16 {
|
|
self.mtu.unwrap_or(DEFAULT_UDP_MTU)
|
|
}
|
|
|
|
/// Get the receive buffer size, using default if not configured.
|
|
pub fn recv_buf_size(&self) -> usize {
|
|
self.recv_buf_size.unwrap_or(DEFAULT_UDP_RECV_BUF)
|
|
}
|
|
|
|
/// Get the send buffer size, using default if not configured.
|
|
pub fn send_buf_size(&self) -> usize {
|
|
self.send_buf_size.unwrap_or(DEFAULT_UDP_SEND_BUF)
|
|
}
|
|
|
|
/// Whether this UDP transport should be advertised on Nostr discovery.
|
|
pub fn advertise_on_nostr(&self) -> bool {
|
|
self.advertise_on_nostr.unwrap_or(false)
|
|
}
|
|
|
|
/// Whether this UDP transport should be advertised as directly reachable.
|
|
pub fn is_public(&self) -> bool {
|
|
self.public.unwrap_or(false)
|
|
}
|
|
}
|
|
|
|
/// Transport instances - either a single config or named instances.
|
|
///
|
|
/// Allows both simple single-instance config:
|
|
/// ```yaml
|
|
/// transports:
|
|
/// udp:
|
|
/// bind_addr: "0.0.0.0:2121"
|
|
/// ```
|
|
///
|
|
/// And multiple named instances:
|
|
/// ```yaml
|
|
/// transports:
|
|
/// udp:
|
|
/// main:
|
|
/// bind_addr: "0.0.0.0:2121"
|
|
/// backup:
|
|
/// bind_addr: "192.168.1.100:2122"
|
|
/// ```
|
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
|
#[serde(untagged)]
|
|
pub enum TransportInstances<T> {
|
|
/// Single unnamed instance (config fields directly under transport type).
|
|
Single(T),
|
|
/// Multiple named instances.
|
|
Named(HashMap<String, T>),
|
|
}
|
|
|
|
impl<T> TransportInstances<T> {
|
|
/// Get the number of instances.
|
|
pub fn len(&self) -> usize {
|
|
match self {
|
|
TransportInstances::Single(_) => 1,
|
|
TransportInstances::Named(map) => map.len(),
|
|
}
|
|
}
|
|
|
|
/// Check if there are no instances.
|
|
pub fn is_empty(&self) -> bool {
|
|
match self {
|
|
TransportInstances::Single(_) => false,
|
|
TransportInstances::Named(map) => map.is_empty(),
|
|
}
|
|
}
|
|
|
|
/// Iterate over all instances as (name, config) pairs.
|
|
///
|
|
/// Single instances have `None` as the name.
|
|
/// Named instances have `Some(name)`.
|
|
pub fn iter(&self) -> impl Iterator<Item = (Option<&str>, &T)> {
|
|
match self {
|
|
TransportInstances::Single(config) => vec![(None, config)].into_iter(),
|
|
TransportInstances::Named(map) => map
|
|
.iter()
|
|
.map(|(k, v)| (Some(k.as_str()), v))
|
|
.collect::<Vec<_>>()
|
|
.into_iter(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<T> Default for TransportInstances<T> {
|
|
fn default() -> Self {
|
|
TransportInstances::Named(HashMap::new())
|
|
}
|
|
}
|
|
|
|
/// Default Ethernet EtherType (FIPS default).
|
|
const DEFAULT_ETHERNET_ETHERTYPE: u16 = 0x2121;
|
|
|
|
/// Default Ethernet receive buffer size (2 MB).
|
|
const DEFAULT_ETHERNET_RECV_BUF: usize = 2 * 1024 * 1024;
|
|
|
|
/// Default Ethernet send buffer size (2 MB).
|
|
const DEFAULT_ETHERNET_SEND_BUF: usize = 2 * 1024 * 1024;
|
|
|
|
/// Default beacon announcement interval in seconds.
|
|
const DEFAULT_BEACON_INTERVAL_SECS: u64 = 30;
|
|
|
|
/// Minimum beacon announcement interval in seconds.
|
|
const MIN_BEACON_INTERVAL_SECS: u64 = 10;
|
|
|
|
/// Ethernet transport instance configuration.
|
|
///
|
|
/// EthernetConfig is always compiled (for config parsing on any platform),
|
|
/// but the transport runtime requires Linux (`#[cfg(target_os = "linux")]`).
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
#[serde(deny_unknown_fields)]
|
|
pub struct EthernetConfig {
|
|
/// Network interface name (e.g., "eth0", "enp3s0"). Required.
|
|
pub interface: String,
|
|
|
|
/// Custom EtherType (default: 0x2121).
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub ethertype: Option<u16>,
|
|
|
|
/// MTU override. Defaults to the interface's MTU minus 1 (for frame type prefix).
|
|
/// Cannot exceed the interface's actual MTU.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub mtu: Option<u16>,
|
|
|
|
/// Receive buffer size in bytes. Default: 2 MB.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub recv_buf_size: Option<usize>,
|
|
|
|
/// Send buffer size in bytes. Default: 2 MB.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub send_buf_size: Option<usize>,
|
|
|
|
/// Listen for discovery beacons from other nodes. Default: true.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub discovery: Option<bool>,
|
|
|
|
/// Broadcast announcement beacons on the LAN. Default: false.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub announce: Option<bool>,
|
|
|
|
/// Auto-connect to discovered peers. Default: false.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub auto_connect: Option<bool>,
|
|
|
|
/// Accept incoming connection attempts. Default: false.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub accept_connections: Option<bool>,
|
|
|
|
/// Announcement beacon interval in seconds. Default: 30.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub beacon_interval_secs: Option<u64>,
|
|
}
|
|
|
|
impl EthernetConfig {
|
|
/// Get the EtherType, using default if not configured.
|
|
pub fn ethertype(&self) -> u16 {
|
|
self.ethertype.unwrap_or(DEFAULT_ETHERNET_ETHERTYPE)
|
|
}
|
|
|
|
/// Get the receive buffer size, using default if not configured.
|
|
pub fn recv_buf_size(&self) -> usize {
|
|
self.recv_buf_size.unwrap_or(DEFAULT_ETHERNET_RECV_BUF)
|
|
}
|
|
|
|
/// Get the send buffer size, using default if not configured.
|
|
pub fn send_buf_size(&self) -> usize {
|
|
self.send_buf_size.unwrap_or(DEFAULT_ETHERNET_SEND_BUF)
|
|
}
|
|
|
|
/// Whether to listen for discovery beacons. Default: true.
|
|
pub fn discovery(&self) -> bool {
|
|
self.discovery.unwrap_or(true)
|
|
}
|
|
|
|
/// Whether to broadcast announcement beacons. Default: false.
|
|
pub fn announce(&self) -> bool {
|
|
self.announce.unwrap_or(false)
|
|
}
|
|
|
|
/// Whether to auto-connect to discovered peers. Default: false.
|
|
pub fn auto_connect(&self) -> bool {
|
|
self.auto_connect.unwrap_or(false)
|
|
}
|
|
|
|
/// Whether to accept incoming connections. Default: false.
|
|
pub fn accept_connections(&self) -> bool {
|
|
self.accept_connections.unwrap_or(false)
|
|
}
|
|
|
|
/// Get the beacon interval, clamped to minimum. Default: 30s.
|
|
pub fn beacon_interval_secs(&self) -> u64 {
|
|
self.beacon_interval_secs
|
|
.unwrap_or(DEFAULT_BEACON_INTERVAL_SECS)
|
|
.max(MIN_BEACON_INTERVAL_SECS)
|
|
}
|
|
}
|
|
|
|
// ============================================================================
|
|
// TCP Transport Configuration
|
|
// ============================================================================
|
|
|
|
/// Default TCP MTU (conservative, matches typical Ethernet MSS minus overhead).
|
|
const DEFAULT_TCP_MTU: u16 = 1400;
|
|
|
|
/// Default TCP connect timeout in milliseconds.
|
|
const DEFAULT_TCP_CONNECT_TIMEOUT_MS: u64 = 5000;
|
|
|
|
/// Default TCP keepalive interval in seconds.
|
|
const DEFAULT_TCP_KEEPALIVE_SECS: u64 = 30;
|
|
|
|
/// Default TCP receive buffer size (2 MB).
|
|
const DEFAULT_TCP_RECV_BUF: usize = 2 * 1024 * 1024;
|
|
|
|
/// Default TCP send buffer size (2 MB).
|
|
const DEFAULT_TCP_SEND_BUF: usize = 2 * 1024 * 1024;
|
|
|
|
/// Default maximum inbound TCP connections.
|
|
const DEFAULT_TCP_MAX_INBOUND: usize = 256;
|
|
|
|
/// TCP transport instance configuration.
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
#[serde(deny_unknown_fields)]
|
|
pub struct TcpConfig {
|
|
/// Listen address (e.g., "0.0.0.0:443"). If not set, outbound-only.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub bind_addr: Option<String>,
|
|
|
|
/// Default MTU for TCP connections. Defaults to 1400.
|
|
/// Per-connection MTU is derived from TCP_MAXSEG when available.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub mtu: Option<u16>,
|
|
|
|
/// Outbound connect timeout in milliseconds. Defaults to 5000.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub connect_timeout_ms: Option<u64>,
|
|
|
|
/// Enable TCP_NODELAY (disable Nagle). Defaults to true.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub nodelay: Option<bool>,
|
|
|
|
/// TCP keepalive interval in seconds. 0 = disabled. Defaults to 30.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub keepalive_secs: Option<u64>,
|
|
|
|
/// TCP receive buffer size in bytes. Defaults to 2 MB.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub recv_buf_size: Option<usize>,
|
|
|
|
/// TCP send buffer size in bytes. Defaults to 2 MB.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub send_buf_size: Option<usize>,
|
|
|
|
/// Maximum simultaneous inbound connections. Defaults to 256.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub max_inbound_connections: Option<usize>,
|
|
|
|
/// Whether this transport should be advertised on Nostr overlay discovery.
|
|
/// Default: false.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub advertise_on_nostr: Option<bool>,
|
|
}
|
|
|
|
impl TcpConfig {
|
|
/// Get the default MTU.
|
|
pub fn mtu(&self) -> u16 {
|
|
self.mtu.unwrap_or(DEFAULT_TCP_MTU)
|
|
}
|
|
|
|
/// Get the connect timeout in milliseconds.
|
|
pub fn connect_timeout_ms(&self) -> u64 {
|
|
self.connect_timeout_ms
|
|
.unwrap_or(DEFAULT_TCP_CONNECT_TIMEOUT_MS)
|
|
}
|
|
|
|
/// Whether TCP_NODELAY is enabled. Default: true.
|
|
pub fn nodelay(&self) -> bool {
|
|
self.nodelay.unwrap_or(true)
|
|
}
|
|
|
|
/// Get the keepalive interval in seconds. 0 = disabled. Default: 30.
|
|
pub fn keepalive_secs(&self) -> u64 {
|
|
self.keepalive_secs.unwrap_or(DEFAULT_TCP_KEEPALIVE_SECS)
|
|
}
|
|
|
|
/// Get the receive buffer size. Default: 2 MB.
|
|
pub fn recv_buf_size(&self) -> usize {
|
|
self.recv_buf_size.unwrap_or(DEFAULT_TCP_RECV_BUF)
|
|
}
|
|
|
|
/// Get the send buffer size. Default: 2 MB.
|
|
pub fn send_buf_size(&self) -> usize {
|
|
self.send_buf_size.unwrap_or(DEFAULT_TCP_SEND_BUF)
|
|
}
|
|
|
|
/// Get the maximum number of inbound connections. Default: 256.
|
|
pub fn max_inbound_connections(&self) -> usize {
|
|
self.max_inbound_connections
|
|
.unwrap_or(DEFAULT_TCP_MAX_INBOUND)
|
|
}
|
|
|
|
/// Whether this TCP transport should be advertised on Nostr discovery.
|
|
pub fn advertise_on_nostr(&self) -> bool {
|
|
self.advertise_on_nostr.unwrap_or(false)
|
|
}
|
|
}
|
|
|
|
// ============================================================================
|
|
// Tor Transport Configuration
|
|
// ============================================================================
|
|
|
|
/// Default Tor SOCKS5 proxy address.
|
|
const DEFAULT_TOR_SOCKS5_ADDR: &str = "127.0.0.1:9050";
|
|
|
|
/// Default Tor control port address.
|
|
const DEFAULT_TOR_CONTROL_ADDR: &str = "/run/tor/control";
|
|
|
|
/// Default Tor control cookie file path (Debian standard location).
|
|
const DEFAULT_TOR_COOKIE_PATH: &str = "/var/run/tor/control.authcookie";
|
|
|
|
/// Default Tor connect timeout in milliseconds (120s — Tor circuit
|
|
/// establishment can take 30-60s on first connect, plus SOCKS5 handshake).
|
|
const DEFAULT_TOR_CONNECT_TIMEOUT_MS: u64 = 120_000;
|
|
|
|
/// Default Tor MTU (same as TCP).
|
|
const DEFAULT_TOR_MTU: u16 = 1400;
|
|
|
|
/// Default max inbound connections via onion service.
|
|
const DEFAULT_TOR_MAX_INBOUND: usize = 64;
|
|
|
|
/// Default HiddenServiceDir hostname file path.
|
|
const DEFAULT_HOSTNAME_FILE: &str = "/var/lib/tor/fips_onion_service/hostname";
|
|
|
|
/// Default directory mode bind address.
|
|
const DEFAULT_DIRECTORY_BIND_ADDR: &str = "127.0.0.1:8443";
|
|
|
|
/// Tor transport instance configuration.
|
|
///
|
|
/// Supports three modes:
|
|
/// - `socks5`: Outbound-only connections through a Tor SOCKS5 proxy.
|
|
/// - `control_port`: Full bidirectional support — outbound via SOCKS5
|
|
/// plus inbound via Tor onion service managed through the control port.
|
|
/// - `directory`: Full bidirectional support — outbound via SOCKS5,
|
|
/// inbound via a Tor-managed `HiddenServiceDir` onion service. No
|
|
/// control port needed. Enables Tor `Sandbox 1` mode.
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
#[serde(deny_unknown_fields)]
|
|
pub struct TorConfig {
|
|
/// Tor access mode: "socks5", "control_port", or "directory".
|
|
/// Default: "socks5".
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub mode: Option<String>,
|
|
|
|
/// SOCKS5 proxy address (host:port). Defaults to "127.0.0.1:9050".
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub socks5_addr: Option<String>,
|
|
|
|
/// Outbound connect timeout in milliseconds. Defaults to 120000 (120s).
|
|
/// Tor circuit establishment can take 30-60s, so this must be generous.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub connect_timeout_ms: Option<u64>,
|
|
|
|
/// Default MTU for Tor connections. Defaults to 1400.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub mtu: Option<u16>,
|
|
|
|
/// Control port address: a Unix socket path (`/run/tor/control`) or
|
|
/// TCP address (`host:port`). Unix sockets are preferred for security.
|
|
/// Defaults to "/run/tor/control".
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub control_addr: Option<String>,
|
|
|
|
/// Control port authentication method:
|
|
/// `"cookie"` (read from default path),
|
|
/// `"cookie:/path/to/cookie"` (read from specified path), or
|
|
/// `"password:secret"` (password auth). Default: `"cookie"`.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub control_auth: Option<String>,
|
|
|
|
/// Path to the Tor control cookie file. Used when control_auth is "cookie".
|
|
/// Defaults to "/var/run/tor/control.authcookie".
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub cookie_path: Option<String>,
|
|
|
|
/// Maximum number of inbound connections via onion service. Default: 64.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub max_inbound_connections: Option<usize>,
|
|
|
|
/// Directory-mode onion service configuration. Only valid in
|
|
/// "directory" mode. Tor manages the onion service via HiddenServiceDir
|
|
/// in torrc; fips reads the .onion hostname from a file.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub directory_service: Option<DirectoryServiceConfig>,
|
|
|
|
/// Whether this transport should be advertised on Nostr overlay discovery.
|
|
/// Default: false.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub advertise_on_nostr: Option<bool>,
|
|
}
|
|
|
|
/// Directory-mode onion service configuration.
|
|
///
|
|
/// In `directory` mode, Tor manages the onion service via `HiddenServiceDir`
|
|
/// in torrc. FIPS reads the `.onion` address from the hostname file and
|
|
/// binds a local TCP listener for Tor to forward inbound connections to.
|
|
/// This mode requires no control port and enables Tor's `Sandbox 1`.
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
#[serde(deny_unknown_fields)]
|
|
pub struct DirectoryServiceConfig {
|
|
/// Path to the Tor-managed hostname file containing the .onion address.
|
|
/// Defaults to "/var/lib/tor/fips_onion_service/hostname".
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub hostname_file: Option<String>,
|
|
|
|
/// Local bind address for the listener that Tor forwards inbound
|
|
/// connections to. Must match the target in torrc's `HiddenServicePort`.
|
|
/// Defaults to "127.0.0.1:8443".
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub bind_addr: Option<String>,
|
|
}
|
|
|
|
impl DirectoryServiceConfig {
|
|
/// Path to the hostname file. Default: "/var/lib/tor/fips_onion_service/hostname".
|
|
pub fn hostname_file(&self) -> &str {
|
|
self.hostname_file
|
|
.as_deref()
|
|
.unwrap_or(DEFAULT_HOSTNAME_FILE)
|
|
}
|
|
|
|
/// Local bind address for the listener. Default: "127.0.0.1:8443".
|
|
pub fn bind_addr(&self) -> &str {
|
|
self.bind_addr
|
|
.as_deref()
|
|
.unwrap_or(DEFAULT_DIRECTORY_BIND_ADDR)
|
|
}
|
|
}
|
|
|
|
impl TorConfig {
|
|
/// Get the access mode. Default: "socks5".
|
|
pub fn mode(&self) -> &str {
|
|
self.mode.as_deref().unwrap_or("socks5")
|
|
}
|
|
|
|
/// Get the SOCKS5 proxy address. Default: "127.0.0.1:9050".
|
|
pub fn socks5_addr(&self) -> &str {
|
|
self.socks5_addr
|
|
.as_deref()
|
|
.unwrap_or(DEFAULT_TOR_SOCKS5_ADDR)
|
|
}
|
|
|
|
/// Get the control port address. Default: "/run/tor/control".
|
|
pub fn control_addr(&self) -> &str {
|
|
self.control_addr
|
|
.as_deref()
|
|
.unwrap_or(DEFAULT_TOR_CONTROL_ADDR)
|
|
}
|
|
|
|
/// Get the control auth string. Default: "cookie".
|
|
pub fn control_auth(&self) -> &str {
|
|
self.control_auth.as_deref().unwrap_or("cookie")
|
|
}
|
|
|
|
/// Get the cookie file path. Default: "/var/run/tor/control.authcookie".
|
|
pub fn cookie_path(&self) -> &str {
|
|
self.cookie_path
|
|
.as_deref()
|
|
.unwrap_or(DEFAULT_TOR_COOKIE_PATH)
|
|
}
|
|
|
|
/// Get the connect timeout in milliseconds. Default: 120000.
|
|
pub fn connect_timeout_ms(&self) -> u64 {
|
|
self.connect_timeout_ms
|
|
.unwrap_or(DEFAULT_TOR_CONNECT_TIMEOUT_MS)
|
|
}
|
|
|
|
/// Get the default MTU. Default: 1400.
|
|
pub fn mtu(&self) -> u16 {
|
|
self.mtu.unwrap_or(DEFAULT_TOR_MTU)
|
|
}
|
|
|
|
/// Get the max inbound connections. Default: 64.
|
|
pub fn max_inbound_connections(&self) -> usize {
|
|
self.max_inbound_connections
|
|
.unwrap_or(DEFAULT_TOR_MAX_INBOUND)
|
|
}
|
|
|
|
/// Whether this Tor transport should be advertised on Nostr discovery.
|
|
pub fn advertise_on_nostr(&self) -> bool {
|
|
self.advertise_on_nostr.unwrap_or(false)
|
|
}
|
|
}
|
|
|
|
// ============================================================================
|
|
// BLE Transport Configuration
|
|
// ============================================================================
|
|
|
|
/// Default BLE L2CAP PSM (dynamic range).
|
|
const DEFAULT_BLE_PSM: u16 = 0x0085;
|
|
|
|
/// Default BLE MTU for L2CAP CoC connections.
|
|
const DEFAULT_BLE_MTU: u16 = 2048;
|
|
|
|
/// Default maximum concurrent BLE connections.
|
|
const DEFAULT_BLE_MAX_CONNECTIONS: usize = 7;
|
|
|
|
/// Default BLE connect timeout in milliseconds.
|
|
const DEFAULT_BLE_CONNECT_TIMEOUT_MS: u64 = 10_000;
|
|
|
|
/// Default BLE probe cooldown in seconds. After probing an address
|
|
/// (success or failure), wait this long before probing it again.
|
|
const DEFAULT_BLE_PROBE_COOLDOWN_SECS: u64 = 30;
|
|
|
|
/// BLE transport instance configuration.
|
|
///
|
|
/// BleConfig is always compiled (for config parsing on any platform),
|
|
/// but the transport runtime requires Linux and the `ble` feature.
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
#[serde(deny_unknown_fields)]
|
|
pub struct BleConfig {
|
|
/// HCI adapter name (e.g., "hci0"). Required.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub adapter: Option<String>,
|
|
|
|
/// L2CAP PSM for FIPS connections. Default: 0x0085 (133).
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub psm: Option<u16>,
|
|
|
|
/// Default MTU for BLE connections. Default: 2048.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub mtu: Option<u16>,
|
|
|
|
/// Maximum concurrent BLE connections. Default: 7.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub max_connections: Option<usize>,
|
|
|
|
/// Outbound connect timeout in milliseconds. Default: 10000.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub connect_timeout_ms: Option<u64>,
|
|
|
|
/// Broadcast BLE advertisements. Default: true.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub advertise: Option<bool>,
|
|
|
|
/// Listen for BLE advertisements. Default: true.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub scan: Option<bool>,
|
|
|
|
/// Auto-connect to discovered BLE peers. Default: false.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub auto_connect: Option<bool>,
|
|
|
|
/// Accept incoming BLE connections. Default: true.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub accept_connections: Option<bool>,
|
|
|
|
/// Probe cooldown in seconds. After probing a BLE address, wait
|
|
/// this long before probing the same address again. Default: 30.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub probe_cooldown_secs: Option<u64>,
|
|
}
|
|
|
|
impl BleConfig {
|
|
/// Get the adapter name. Default: "hci0".
|
|
pub fn adapter(&self) -> &str {
|
|
self.adapter.as_deref().unwrap_or("hci0")
|
|
}
|
|
|
|
/// Get the L2CAP PSM. Default: 0x0085.
|
|
pub fn psm(&self) -> u16 {
|
|
self.psm.unwrap_or(DEFAULT_BLE_PSM)
|
|
}
|
|
|
|
/// Get the default MTU. Default: 2048.
|
|
pub fn mtu(&self) -> u16 {
|
|
self.mtu.unwrap_or(DEFAULT_BLE_MTU)
|
|
}
|
|
|
|
/// Get the maximum concurrent connections. Default: 7.
|
|
pub fn max_connections(&self) -> usize {
|
|
self.max_connections.unwrap_or(DEFAULT_BLE_MAX_CONNECTIONS)
|
|
}
|
|
|
|
/// Get the connect timeout in milliseconds. Default: 10000.
|
|
pub fn connect_timeout_ms(&self) -> u64 {
|
|
self.connect_timeout_ms
|
|
.unwrap_or(DEFAULT_BLE_CONNECT_TIMEOUT_MS)
|
|
}
|
|
|
|
/// Whether to broadcast advertisements. Default: true.
|
|
pub fn advertise(&self) -> bool {
|
|
self.advertise.unwrap_or(true)
|
|
}
|
|
|
|
/// Whether to scan for advertisements. Default: true.
|
|
pub fn scan(&self) -> bool {
|
|
self.scan.unwrap_or(true)
|
|
}
|
|
|
|
/// Whether to auto-connect to discovered peers. Default: false.
|
|
pub fn auto_connect(&self) -> bool {
|
|
self.auto_connect.unwrap_or(false)
|
|
}
|
|
|
|
/// Whether to accept incoming connections. Default: true.
|
|
pub fn accept_connections(&self) -> bool {
|
|
self.accept_connections.unwrap_or(true)
|
|
}
|
|
|
|
/// Get the probe cooldown in seconds. Default: 30.
|
|
pub fn probe_cooldown_secs(&self) -> u64 {
|
|
self.probe_cooldown_secs
|
|
.unwrap_or(DEFAULT_BLE_PROBE_COOLDOWN_SECS)
|
|
}
|
|
}
|
|
|
|
// ============================================================================
|
|
// TransportsConfig
|
|
// ============================================================================
|
|
|
|
/// Transports configuration section.
|
|
///
|
|
/// Each transport type can have either a single instance (config directly
|
|
/// under the type name) or multiple named instances.
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
pub struct TransportsConfig {
|
|
/// UDP transport instances.
|
|
#[serde(default, skip_serializing_if = "is_transport_empty")]
|
|
pub udp: TransportInstances<UdpConfig>,
|
|
|
|
/// Ethernet transport instances.
|
|
#[serde(default, skip_serializing_if = "is_transport_empty")]
|
|
pub ethernet: TransportInstances<EthernetConfig>,
|
|
|
|
/// TCP transport instances.
|
|
#[serde(default, skip_serializing_if = "is_transport_empty")]
|
|
pub tcp: TransportInstances<TcpConfig>,
|
|
|
|
/// Tor transport instances.
|
|
#[serde(default, skip_serializing_if = "is_transport_empty")]
|
|
pub tor: TransportInstances<TorConfig>,
|
|
|
|
/// BLE transport instances.
|
|
#[serde(default, skip_serializing_if = "is_transport_empty")]
|
|
pub ble: TransportInstances<BleConfig>,
|
|
}
|
|
|
|
/// Helper for skip_serializing_if on TransportInstances.
|
|
fn is_transport_empty<T>(instances: &TransportInstances<T>) -> bool {
|
|
instances.is_empty()
|
|
}
|
|
|
|
impl TransportsConfig {
|
|
/// Check if any transports are configured.
|
|
pub fn is_empty(&self) -> bool {
|
|
self.udp.is_empty()
|
|
&& self.ethernet.is_empty()
|
|
&& self.tcp.is_empty()
|
|
&& self.tor.is_empty()
|
|
&& self.ble.is_empty()
|
|
}
|
|
|
|
/// Merge another TransportsConfig into this one.
|
|
///
|
|
/// Non-empty transport sections from `other` replace those in `self`.
|
|
pub fn merge(&mut self, other: TransportsConfig) {
|
|
if !other.udp.is_empty() {
|
|
self.udp = other.udp;
|
|
}
|
|
if !other.ethernet.is_empty() {
|
|
self.ethernet = other.ethernet;
|
|
}
|
|
if !other.tcp.is_empty() {
|
|
self.tcp = other.tcp;
|
|
}
|
|
if !other.tor.is_empty() {
|
|
self.tor = other.tor;
|
|
}
|
|
if !other.ble.is_empty() {
|
|
self.ble = other.ble;
|
|
}
|
|
}
|
|
}
|