Commit Graph

9 Commits

Author SHA1 Message Date
E. Kaparulin
278cbf4fb4 docs: add a server quickstart and disclose the UDP relay provisioning
Same audit as konduit-public (c61664c), applied to koridor. The conclusion
is the opposite: there is no server binary and no config format, so nothing
can be documented wrongly. The source backs the README - ffi/src/ssh.rs:389
uses per-flow channel_open_direct_tcpip, with no streamlocal, remote TUN or
forwarded-tcpip anywhere in the crate. No contradictions found; the gap was
thinness.

Added docs/server-quickstart.md. The whole server story was previously one
clause in the README:

- The real requirement (AllowTcpForwarding yes), and that it is already the
  OpenSSH default, so most servers need no configuration at all.
- What you do NOT need: ip_forward, masquerade rules, /dev/net/tun, root.
  Anyone who has set up a VPN server before assumes all four are required.
- Keypair generation, since the user supplies the key; koridor does not
  generate one for the tunnel.
- Host key trust on first connect. The connect is refused until the
  fingerprint is accepted, and a later change is fatal rather than retried.

The finding that justified the work: UDP forwarding provisions itself on the
user's server on first enable - it writes ~/.koridor/udp-relay.sh, appends a
forced-command line to ~/.ssh/authorized_keys marked # koridor-udp-relay, and
requires socat (hardcoded in ffi/src/udp_relay/script.rs:12). So "No special
server-side software required" is true for TCP and false once that toggle is
on. Nothing public said so. It is off by default and idempotent, and
remove_marked_line strips only koridor's own line, leaving every other key
untouched - but a user's authorized_keys and home directory are modified
without them being told. The README now carries that caveat inline.

#k-ops/#6/#212
2026-10-10 22:58:19 +03:00
E. Kaparulin
b7e5dad3be docs: fix onboarding copy, QR export isn't built yet v0.1.0-beta.2 2026-08-03 12:26:36 +03:00
E. Kaparulin
002c7452a3 Split bug reports (Gitea issues) from vulnerability reports (email) v0.1.0-beta.1 2026-07-31 12:12:45 +03:00
E. Kaparulin
4d6be63753 Point bug/vulnerability reports to Gitea issues instead of app About screen 2026-07-31 12:08:05 +03:00
3e4c5913a3 Update README.md 2026-07-29 22:03:28 +00:00
E. Kaparulin
1387ac938e Link konduit-platform source 2026-07-30 00:52:02 +03:00
E. Kaparulin
62ceeb4c03 Add README 2026-07-30 00:50:50 +03:00
E. Kaparulin
f22611f8ca Add Play Store feature graphic 2026-07-30 00:48:07 +03:00
E. Kaparulin
e21d14398a Add privacy policy 2026-07-30 00:36:33 +03:00