8ab262f8f8
apple / swift (push) Successful in 54s
ci / rust (push) Failing after 1m12s
ci / web (push) Successful in 29s
android / android (push) Failing after 1m49s
ci / docs-site (push) Successful in 31s
ci / bench (push) Successful in 1m48s
decky / build-publish (push) Successful in 12s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 5s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 4s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 3s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 4s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 19s
flatpak / build-publish (push) Failing after 3s
deb / build-publish (push) Failing after 2m43s
rpm / build-publish (bazzite, punktfunk-fedora-rpm) (push) Successful in 5m22s
docker / deploy-docs (push) Successful in 17s
rpm / build-publish (fedora-44, punktfunk-fedora44-rpm) (push) Successful in 5m20s
TOFU let anyone who could reach the host click "Trust" and stream, which defeats the point on a LAN. Make SPAKE2 PIN pairing the default and only way to trust a NEW host; TOFU survives as an explicit HOST opt-in (for fully trusted networks), advertised over mDNS so clients render their trust UI from the host's policy rather than offering trust on faith. Contract: - Host advertises pair=required (default) or pair=optional. pair=required rejects unpaired clients at the handshake; pair=optional accepts them (TOFU). - Clients: a pinned host whose fingerprint matches connects silently; a pinned host whose fingerprint CHANGED forces re-pairing via PIN (no re-trust shortcut); a NEW host is offered TOFU only if it advertised pair=optional, otherwise PIN pairing is mandatory; a manually-typed or unknown-policy host is always PIN. Host (crates/punktfunk-host/src/main.rs): - m3-host now REQUIRES pairing by default (was open by default). New --allow-tofu opts into accepting unpaired clients + advertising pair=optional; pairing is always armed (PIN logged at startup). serve --native was already secure-by-default (serve --open). The mDNS advert and the accept loop already mapped require_pairing -> pair=required + reject; only the m3-host CLI default + help text changed. Clients honor the advertised policy: - Android (MainActivity.kt): TOFU only for a discovered pair=optional host; manual/unknown -> PIN; fp-change -> re-pair only (dropped the "Forget & re-TOFU" shortcut). - Apple (HostDiscovery/SessionModel/ContentView/HostCards/HostStore): new allowsTofu (pair==optional, distinct from unknown); connect() gates .awaitingTrust on it; unpinned non-optional hosts route to the PIN sheet; "Forget Identity" re-pairs rather than re-TOFUs. - Linux (app.rs/ui_hosts.rs/session.rs): ConnectRequest.pair_required -> pair_optional; initiate_connect routes pinned/fp-changed/optional/else; manual + --connect unknown -> PIN; a pinned connect rejected on trust grounds re-pairs. Docs (CLAUDE.md, README.md, docs-site/content/docs/pairing.md): describe the gated model — PIN is the default, TOFU an explicit opt-in with an impostor warning. Verified: host cargo check/clippy/fmt clean; Android built + live (emulator -> home-worker-2): a manual connect now opens the PIN dialog (no Trust button) and the PIN ceremony streams; Apple swift build clean; Linux clippy -D warnings + fmt clean on the Linux box. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
189 lines
7.8 KiB
Swift
189 lines
7.8 KiB
Swift
// LAN auto-discovery of punktfunk/1 hosts over mDNS — the client side of the host's
|
|
// `crate::discovery` advert (`_punktfunk._udp`). Browses with NWBrowser (TXT rides in the
|
|
// result metadata), resolves each service to a connectable IP:port with a throwaway
|
|
// NWConnection, and publishes the live set.
|
|
//
|
|
// The advertised `fp` (host cert SHA-256) is ADVISORY: mDNS is unauthenticated, so TOFU /
|
|
// pinning still verifies the host on connect — it's surfaced only so a picker can show it and
|
|
// pre-fill. `pair=required` lets the UI route straight to the pairing ceremony.
|
|
//
|
|
// iOS/tvOS gate Bonjour browsing on Info.plist `NSBonjourServices` listing `_punktfunk._udp`
|
|
// (Config/Info.plist) — without it the system blocks the browse and nothing is returned.
|
|
|
|
#if canImport(Network)
|
|
import Foundation
|
|
import Network
|
|
|
|
/// A punktfunk/1 host found on the LAN. `fingerprintHex` is advisory (see file header).
|
|
public struct DiscoveredHost: Identifiable, Sendable, Equatable {
|
|
/// Stable host id (mDNS `id` TXT); falls back to the Bonjour instance name.
|
|
public let id: String
|
|
/// Bonjour instance name (the host's chosen label).
|
|
public let name: String
|
|
/// Resolved address to hand to `PunktfunkConnection`.
|
|
public let host: String
|
|
public let port: UInt16
|
|
/// Host cert SHA-256 (lowercase hex) the host advertised, or nil if absent.
|
|
public let fingerprintHex: String?
|
|
/// The host advertised `pair=required` — a client must pair before it can stream.
|
|
public let requiresPairing: Bool
|
|
/// The host EXPLICITLY advertised `pair=optional` — only then may the client offer the
|
|
/// reduced-security TOFU "Trust" path. A missing/unknown `pair` field is NOT optional:
|
|
/// pairing is mandatory unless this is true (the policy authority is the host's advert).
|
|
public let allowsTofu: Bool
|
|
}
|
|
|
|
@MainActor
|
|
public final class HostDiscovery: ObservableObject {
|
|
/// Currently-visible hosts, deduped by `id`, sorted by name. Main-actor.
|
|
@Published public private(set) var hosts: [DiscoveredHost] = []
|
|
|
|
private var browser: NWBrowser?
|
|
/// Keyed by the service endpoint's description (a stable, Sendable handle we can capture
|
|
/// into the resolve callbacks without smuggling non-Sendable Network types across hops).
|
|
private var resolved: [String: DiscoveredHost] = [:]
|
|
private var connections: [String: NWConnection] = [:]
|
|
|
|
public init() {}
|
|
|
|
/// Start browsing `_punktfunk._udp`. Idempotent — a second call while live is a no-op.
|
|
public func start() {
|
|
guard browser == nil else { return }
|
|
let browser = NWBrowser(
|
|
for: .bonjourWithTXTRecord(type: "_punktfunk._udp", domain: nil),
|
|
using: NWParameters())
|
|
browser.browseResultsChangedHandler = { results, _ in
|
|
MainActor.assumeIsolated { [weak self] in self?.reconcile(results) }
|
|
}
|
|
browser.stateUpdateHandler = { state in
|
|
// A failed browser never recovers on its own; tear down and re-arm so transient
|
|
// network changes (Wi-Fi flip, VPN) don't leave discovery silently dead.
|
|
MainActor.assumeIsolated { [weak self] in
|
|
if case .failed = state { self?.restart() }
|
|
}
|
|
}
|
|
self.browser = browser
|
|
browser.start(queue: .main)
|
|
}
|
|
|
|
/// Stop browsing and drop all discovered state.
|
|
public func stop() {
|
|
browser?.cancel()
|
|
browser = nil
|
|
for conn in connections.values { conn.cancel() }
|
|
connections.removeAll()
|
|
resolved.removeAll()
|
|
if !hosts.isEmpty { hosts = [] }
|
|
}
|
|
|
|
deinit {
|
|
browser?.cancel()
|
|
for conn in connections.values { conn.cancel() }
|
|
}
|
|
|
|
private func restart() {
|
|
stop()
|
|
start()
|
|
}
|
|
|
|
/// Diff the browser's current result set against what we're tracking: drop departed
|
|
/// services, resolve newly-seen ones.
|
|
private func reconcile(_ results: Set<NWBrowser.Result>) {
|
|
let live = Set(results.map { Self.key($0) })
|
|
for key in resolved.keys where !live.contains(key) { resolved[key] = nil }
|
|
for key in connections.keys where !live.contains(key) {
|
|
connections[key]?.cancel()
|
|
connections[key] = nil
|
|
}
|
|
for result in results {
|
|
let key = Self.key(result)
|
|
if resolved[key] == nil, connections[key] == nil { resolve(result) }
|
|
}
|
|
publish()
|
|
}
|
|
|
|
/// Resolve one service to IP:port via a short UDP connection (it reaches `.ready` once the
|
|
/// path is established — no data is sent), reading the TXT up front so the callback only
|
|
/// captures Sendable values + the endpoint key.
|
|
private func resolve(_ result: NWBrowser.Result) {
|
|
let key = Self.key(result)
|
|
let name = Self.instanceName(result.endpoint)
|
|
var fp: String?
|
|
var pair: String?
|
|
var id: String?
|
|
if case let .bonjour(txt) = result.metadata {
|
|
fp = Self.entry(txt, "fp")
|
|
pair = Self.entry(txt, "pair")
|
|
id = Self.entry(txt, "id")
|
|
}
|
|
let conn = NWConnection(to: result.endpoint, using: .udp)
|
|
connections[key] = conn
|
|
conn.stateUpdateHandler = { state in
|
|
MainActor.assumeIsolated { [weak self] in
|
|
guard let self, let conn = self.connections[key] else { return }
|
|
switch state {
|
|
case .ready:
|
|
if case let .hostPort(host, port)? = conn.currentPath?.remoteEndpoint,
|
|
let address = Self.hostString(host) {
|
|
self.resolved[key] = DiscoveredHost(
|
|
id: (id?.isEmpty == false) ? id! : name,
|
|
name: name, host: address, port: port.rawValue,
|
|
fingerprintHex: fp, requiresPairing: pair == "required",
|
|
allowsTofu: pair == "optional")
|
|
self.publish()
|
|
}
|
|
conn.cancel()
|
|
self.connections[key] = nil
|
|
case .failed, .cancelled:
|
|
self.connections[key] = nil
|
|
default:
|
|
break
|
|
}
|
|
}
|
|
}
|
|
conn.start(queue: .main)
|
|
}
|
|
|
|
/// Publish the resolved set, deduped by `id` (a host on several interfaces / re-advertising
|
|
/// collapses to one row), sorted by name.
|
|
private func publish() {
|
|
var byID: [String: DiscoveredHost] = [:]
|
|
for host in resolved.values { byID[host.id] = host }
|
|
let next = byID.values.sorted {
|
|
$0.name.localizedCaseInsensitiveCompare($1.name) == .orderedAscending
|
|
}
|
|
if next != hosts { hosts = next }
|
|
}
|
|
|
|
private static func key(_ result: NWBrowser.Result) -> String {
|
|
"\(result.endpoint)"
|
|
}
|
|
|
|
private static func instanceName(_ endpoint: NWEndpoint) -> String {
|
|
if case let .service(name, _, _, _) = endpoint { return name }
|
|
return "punktfunk host"
|
|
}
|
|
|
|
private static func entry(_ txt: NWTXTRecord, _ field: String) -> String? {
|
|
if case let .string(value) = txt.getEntry(for: field), !value.isEmpty { return value }
|
|
return nil
|
|
}
|
|
|
|
/// A resolved `NWEndpoint.Host` → a plain address string for `PunktfunkConnection` (the
|
|
/// scope id on a link-local address is stripped — the host+port pair is resolved again on
|
|
/// the Rust side, which can't parse the `%iface` suffix).
|
|
private static func hostString(_ host: NWEndpoint.Host) -> String? {
|
|
switch host {
|
|
case .ipv4(let address):
|
|
return "\(address)".split(separator: "%").first.map(String.init)
|
|
case .ipv6(let address):
|
|
return "\(address)".split(separator: "%").first.map(String.init)
|
|
case .name(let name, _):
|
|
return name
|
|
@unknown default:
|
|
return nil
|
|
}
|
|
}
|
|
}
|
|
#endif
|