freehop 0.1.0-alpha.0

package/ARCHITECTURE.md

@@ -0,0 +1,204 @@
+# Freehop architecture
+
+This document explains how Freehop is put together and why. For the normative wire format, see
+[PROTOCOL.md](PROTOCOL.md); for integrating it, see [SDK.md](SDK.md).
+
+## 1. Design goals
+
+| Goal | Consequence |
+|---|---|
+| The operator's servers never carry media | Two separate planes: a **signalling plane** (gates) and a **media plane** (peer paths). Gates are bounded so that media cannot fit through them. |
+| Media cost stays with the session | Fallback routes use only machines that belong to the session: endpoint gateways, the host node, participants. |
+| No single point of failure | Any number of interchangeable gates; signalling moves onto the mesh once peers are linked. |
+| Gates are untrusted | End-to-end sealed envelopes; membership only after authentication. |
+| Zero configuration for users | Tickets from the app backend; automatic path escalation; automatic router port mapping on desktop. |
+| Embeddable | Small modules with no runtime dependency in the browser; one SDK for every consumer. |
+
+**Current scope:** a flexible mesh SDK with an initial target of 2–8 participants, not a benchmarked capacity limit. Larger rooms await capacity testing. Non-goals include guaranteed connectivity on
+networks that can reach only the operator's server; recording or transcoding.
+
+## 2. Components
+
+```mermaid
+flowchart TB
+  subgraph backend["Application backend"]
+    AUTH["authority<br/>(src/sdk/authority.mjs)"]
+  end
+  subgraph ops["Operator / community / public"]
+    GATE["gate + STUN<br/>(src/gate, bin/freehop-gate.mjs)"]
+    TRK["public WebTorrent trackers<br/>(bt+wss://, optional)"]
+  end
+  subgraph client["Every client (browser or desktop renderer)"]
+    SDK["connect()<br/>(src/sdk/client.mjs)"]
+    ROOM["Room + PeerLink<br/>(src/client)"]
+  end
+  subgraph session["Session-owned machines (optional)"]
+    GW["desktop gateway<br/>TURN + port mapping<br/>(src/relay/agent.mjs, src/electron)"]
+    HOST["host node member<br/>(src/sdk/host.mjs, src/relay/member.mjs)"]
+  end
+  AUTH -- "tickets (app's own channel)" --> SDK
+  SDK --> ROOM
+  ROOM -. "sealed envelopes" .- GATE
+  ROOM -. "sealed envelopes" .- TRK
+  ROOM == "media (ICE)" === ROOM
+  ROOM == "relayed media" === GW
+  ROOM == "relayed media" === HOST
+```
+
+### Module map
+
+| Module | Role |
+|---|---|
+| `src/client/crypto.mjs` | HKDF room-tag and key derivation, AES-256-GCM seal/open with AAD binding (room, sender, recipient) |
+| `src/client/gate-client.mjs` | One WebSocket gate: hello/join, keepalive, reconnect with backoff |
+| `src/client/tracker-client.mjs` | WebTorrent tracker used as a gate (offers = hellos, answers = envelopes) |
+| `src/client/room.mjs` | The orchestrator: hints and admission, routing (mesh → gates → introducer → outbox), caps, path ladder, bridging, per-link adaptive video, media controls, departures, rekey |
+| `src/client/peer.mjs` | One `RTCPeerConnection` per remote peer: perfect negotiation, candidate buffering, offer timeout, single-initiator ICE restarts, path classification |
+| `src/sdk/authority.mjs` | Backend: room secrets, tickets, kick-and-rotate |
+| `src/sdk/client.mjs` | `connect(ticket)`: desktop-gateway detection, `update()`, `disconnectPeer()`, `levels()`, `attach()` |
+| `src/sdk/host.mjs` | `hostSession(ticket)`: shared process gateway plus gateway member |
+| `src/sdk/ticket.mjs` | Ticket validation and compact encoding |
+| `src/gate/gate.mjs` | The gate: admission tokens, rooms, routing, byte and message budgets, backpressure |
+| `src/gate/stun-responder.mjs` | RFC 8489 Binding responder (IPv4 and IPv6) |
+| `src/relay/turn-server.mjs` | TURN server (RFC 8656 subset): UDP/TCP/TLS clients, permissions, channels, internal relay↔relay, rate limits |
+| `src/relay/port-mapper.mjs` | PCP → NAT-PMP → UPnP IGD client with renewal and SSRF guards |
+| `src/relay/agent.mjs` | Gateway: TURN + mappings + room-scoped, revocable TURN REST credentials |
+| `src/relay/member.mjs` | Gateway member: joins a room without media and offers its gateway per peer |
+| `src/electron/` | Main-process helper (`installFreehopGateway`) and origin-restricted preload (`window.freehopGateway`) |
+| `src/shared/stun.mjs`, `src/shared/tokens.mjs` | STUN/TURN codec; gate admission tokens |
+
+## 3. The two planes
+
+### Signalling plane
+- **Room identity.** A room is identified to gates only by `roomTag = HKDF(secret, "room-tag")`.
+- **Envelopes.** Every message between peers is an envelope
+  `AES-256-GCM(HKDF(secret, "envelope-key"), payload, AAD = room|from|to)` with a per-sender
+  counter for replay protection.
+- **Routing.** In order of preference:
+  1. the peers' own data channel, used only while the link is connected;
+  2. every gate where the recipient is present;
+  3. a connected neighbour that knows the recipient (the "introducer");
+  4. a short-lived outbox.
+- **Membership.** Gate rosters are hints only. A peer becomes a member once one of its
+  envelopes authenticates.
+
+### Media plane: the path ladder
+
+```mermaid
+stateDiagram-v2
+  [*] --> Endpoint: link created
+  Endpoint: phase 0<br/>direct (host / IPv6 / srflx / prflx)<br/>+ own or partner gateway
+  Session: phase 1<br/>+ gateways of other session members<br/>(participants, host node)
+  Bridged: phase 2<br/>a participant forwards the media
+  Unreachable: no route inside the session<br/>retry with backoff 30 s ... 300 s
+  Endpoint --> Connected: ICE connected
+  Endpoint --> Session: 5 s without connection (+1 grace)
+  Session --> Connected
+  Session --> Bridged: 7 s without connection (+1 grace)
+  Bridged --> Connected: background retry succeeds
+  Session --> Unreachable: no bridge candidate
+  Unreachable --> Endpoint: network change or new member
+  Connected --> [*]
+```
+
+- **Single initiator.** Only the impolite peer restarts ICE. The polite peer applies the same
+  servers and takes over after 2.5 s if nothing arrives. Simultaneous restarts collide (glare)
+  and were observed to silence a browser's RTP senders.
+- **Classification.** Each path is classified from the selected candidate pair:
+  - `direct`: no relay on either side;
+  - `gateway`: the relay is owned by one of the two endpoints;
+  - `relay`: the relay is owned by another session member;
+  - `bridged`: a participant forwards the media.
+- **Refresh.** Classification is retried while browser stats settle and refreshed every 5 s.
+  This also catches later route upgrades.
+
+## 4. Gateways
+
+```mermaid
+sequenceDiagram
+  participant D as Desktop participant (Electron main)
+  participant R as Home router
+  participant P as Remote peer (strict NAT)
+  D->>R: PCP / NAT-PMP / UPnP: map UDP+TCP 3478 (and relay ports on demand)
+  R-->>D: external 203.0.113.7:3478
+  D->>P: caps (sealed): turn:203.0.113.7:3478, user "<exp>:<room>:<peer>", HMAC credential
+  P->>R: TURN Allocate (UDP, or TCP when UDP is blocked)
+  R->>D: forwarded to the gateway (mapped port)
+  Note over D,P: Media stays encrypted end to end while the gateway relays ciphertext
+```
+
+- **Reachability.** The gateway uses a public address directly, or a router mapping. A mapping
+  that returns a private or carrier-grade NAT (CGNAT) external address is not offered.
+- **Credentials.** TURN REST style, scoped to a room and a peer, valid for 2 h by default (configurable from 1 s to 24 h). The signing key stays in the privileged process; renderers request bounded credentials through a broker. Rooms are allowed explicitly; rotation revokes the whole old epoch, including alias allocations.
+- **Policy.**
+  - The TURN server refuses loopback, link-local, multicast, private peers and selected IPv6 transition prefixes (6to4, Teredo, local-use NAT64).
+  - The host's own addresses are reachable only relay↔relay.
+  - Error replies to unauthenticated UDP sources are rate-limited.
+  - TCP connections are capped per source address and have an absolute 10 s deadline to allocate.
+  - Gateway quotas: 6 allocations per username, 32 per room, 64 total; 4 Mbit/s per allocation, 20 Mbit/s per room, 40 Mbit/s total, separately per direction.
+  - Startup reachability does not guarantee continued reachability; mapping-loss and address-change recovery remain pending.
+- **No hairpin dependency.** Traffic between two allocations on the same gateway is delivered
+  internally. The owner reaches remote allocations through its own `self` allocation.
+
+## 5. Host node, bridging and kicks
+
+- **Host node.** The machine hosting a session (an app server, a community server or a hosting
+  desktop app) calls `hostSession(ticket)`. It joins the room with a `gw_…` id, captures no media of its own, relays encrypted packets,
+  and greets each authenticated member with that member's own credentials.
+- **Bridging.** When a pair has no route and no untried session gateway, the lower id asks
+  connected participants that can reach the other side. The forwarder:
+  - accepts only an offer it made, then obtains the second endpoint's consent with `bridge-confirm` / `bridge-ready`;
+  - announces `forward-map` before renegotiating;
+  - adds the origin's tracks, re-encoding them;
+  - stops those transceivers again on release.
+  Endpoints release any duplicate forwarder.
+- **Kick.** The application calls `authority.kick()`, which rotates the room secret.
+  - Remaining members receive new tickets and call `session.update(ticket, {dropped})`.
+    Every old-key link closes and previous-key envelopes are rejected immediately. Gates move to the new room tag and approved members reconnect; media briefly pauses.
+  - Gateways revoke the entire old room epoch, including unreported aliases: the host node through `host.update()`, a desktop participant's own gateway through `session.update()`.
+  - Update every remaining member and host. Machines still on the old key can communicate with old-key holders. Voluntary departures also require rotation via `authority.leave()`.
+
+## 6. Threat model (summary)
+
+| Actor | Can | Cannot |
+|---|---|---|
+| Gate operator | See IP addresses, room tags, peer ids, sizes, timing; drop or delay | Read or forge envelopes, inject members, re-route undetected, carry media |
+| Network observer | See encrypted traffic metadata | Read media (DTLS-SRTP) or signalling (TLS + sealed envelopes) |
+| Room member | Forge envelopes in the room's name (members trust each other); use gateway credentials until expiry or revocation | Reach private networks or loopback services through a gateway; keep access after a kick plus rotation |
+| Gateway owner | Relay ciphertext; see peer IP addresses | Decrypt media |
+
+## 7. Failure handling
+
+| Failure | Mechanism |
+|---|---|
+| Lost offer or answer | Offer timeout (8 s): rollback and re-offer; an ICE restart is re-requested |
+| Envelope delivered out of order | Descriptions applied only in envelope-counter order |
+| Gate down or restarting | Other gates and the mesh carry signalling; outbox for 20 s; client ping keeps NAT and proxies alive |
+| Peer vanished without `bye` | Sweep: absent from every gate and link not connected for 8 s, then dropped as `gone` (can return) |
+| Senders silent after renegotiation | Media watchdog: no packets for 10 s triggers a single-initiator restart |
+| Dead data channel still "open" | Trusted only while the link is connected; gates also carry the envelope |
+
+## 8. Deployment topologies
+
+1. **One gate plus STUN** behind your TLS proxy (`deploy/freehop-gate.service`,
+   `deploy/Caddyfile.snippet`). This is the minimal production setup.
+2. **Several gates** (yours plus community gates) listed in every ticket for resilience.
+3. **Tracker-only.** `bt+wss://` public WebTorrent trackers plus public STUN, with no
+   infrastructure of your own. Useful for demos and prototypes. Availability is not under
+   your control.
+
+## 9. Test architecture
+
+- **Unit tests** (`node --test test/*.test.mjs`): the STUN codec against RFC 5769, the TURN
+  server, the gate, the port mapper against fake routers, and gateway credentials.
+- **Browser suites** (`test/browser/`): real Chromium, Firefox and WebKit through Playwright.
+  They cover the mesh, cross-engine runs over TLS, multi-gate with a gate outage, kick/rekey,
+  the public tracker, and the SDK example.
+- **NAT lab** (`lab/`): a disposable privileged Linux container with network namespaces. Each
+  peer gets a router and client namespace with a NAT profile; miniupnpd plays the home router.
+  Browsers run inside the namespaces with fake capture devices. `lab/qualify.sh` runs every
+  scenario three times plus cross-engine runs and coturn conformance. `lab/summarize.mjs`
+  turns the evidence into the table in [RESULTS.md](RESULTS.md).
+
+---
+Documentation licensed under CC BY 4.0. Copyright 2026 Jolyn Studios.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.