- commit
- 86a73fd79ade9de2918e7123d32d288f9bd3da13
- parent
- d9b2f5d9b67c2e18424c3a31b63d907733065d08
- author
- Dami <dami.etoile@gmail.com>
| M | README.md | 22 | +++++++++++----------- |
@@ -1,29 +1,29 @@
11 # sigil22 3-A native remote desktop app secured by FIDO2 hardware keys. Plug in a YubiKey or Google Titan, tap it, and connect to your machine over an end-to-end encrypted Iroh tunnel. No passwords, no addresses — the key derives the identity.3+Your key is the address. Plug in, tap, connect.44 55 ## What is it?66 7-Sigil is a Tauri v2 desktop app (Rust backend, vanilla JS frontend) that lets you remote into your machine using a FIDO2 security key as the sole authentication factor. The key produces a `hmac-secret` that becomes the 32-byte seed for an Iroh P2P endpoint. Both host and client derive the same identity from the same key — no address sharing, no passwords, no relay configuration.7+Sigil is a Tauri v2 desktop app (Rust backend, vanilla JS frontend) that lets you remote into your machine using a FIDO2 security key as the sole authentication factor. The key produces a `hmac-secret` that becomes the 32-byte seed for an Iroh P2P endpoint. Both host and client derive the same identity from the same key. The key handles addressing.88 99 Screen capture and encoding run through an ffmpeg subprocess with hardware acceleration (NVENC, VAAPI, QSV, AMF, VideoToolbox) up to 60fps. The client decodes via WebCodecs with hardware acceleration for H.264, H.265, and AV1. A software fallback (xcap + openh264) is available if ffmpeg isn't installed.1010 1111 ## Why use it?1212 13-- **No addresses to share.** The FIDO2 key derives the Iroh peer identity. Both sides get the same node ID from the same key.13+- **Shared identity.** The FIDO2 key derives the Iroh peer identity. Both sides get the same node ID from the same key.1414 - **End-to-end encrypted.** Iroh handles the transport with built-in E2EE. The key never leaves the hardware token.15-- **Hardware-accelerated video.** ffmpeg handles capture + encode with your GPU. WebCodecs handles decode on the client. Up to 60fps.15+- **Hardware-accelerated video.** ffmpeg handles capture and encode with your GPU. WebCodecs handles decode on the client. Up to 60fps.1616 - **Cross-platform.** Linux, macOS, Windows. Auto-detects the best encoder for your hardware.17-- **No cloud, no account.** Peer-to-peer via Iroh relay. No third-party services.17+- **Peer-to-peer.** Via Iroh relay. No third-party services or accounts.1818 - **Single binary.** Tauri bundles everything except ffmpeg (system dependency).1919 2020 ## Install2121 2222 ### Prerequisites2323 24-- **Rust 1.85+** — [install](https://rustup.rs)25-- **ffmpeg** — screen capture + hardware encoding26-- **FIDO2 security key** — YubiKey, Google Titan, or any FIDO2 key with hmac-secret support24+- **Rust 1.85+** ([install](https://rustup.rs))25+- **ffmpeg** for screen capture and hardware encoding26+- **FIDO2 security key** with hmac-secret support (YubiKey, Google Titan, etc.)2727 2828 ### Linux (Ubuntu/Debian)2929 @@ -70,9 +70,9 @@ Download from the [releases page](https://github.com/FelineStateMachine/sigil/re
7070 7171 ### Usage7272 73-1. **Register** (one-time per machine) — click register, tap your key. Creates a resident credential.74-2. **Host** — click host. The app starts listening on an Iroh endpoint derived from your key.75-3. **Connect** — on another machine, click connect, tap the same key. The screen appears, input is forwarded.73+1. **Register** (one-time per machine): click register, tap your key. Creates a resident credential.74+2. **Host**: click host. The app starts listening on an Iroh endpoint derived from your key.75+3. **Connect**: on another machine, click connect, tap the same key. The screen appears, input is forwarded.7676 7777 Keyboard shortcuts: type your PIN, then press `c` (connect), `r` (register), or `h` (host).7878