forked from WikiDeck/wikideck
OIDC PKCE login, ID-token verification against Dex JWKS, a client-built wallet link message, an off-chain account and wallet store, and a mobile-safe login button. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
61 lines
3.3 KiB
Markdown
61 lines
3.3 KiB
Markdown
# eom.dev accounts (Dex SSO) and wallet linking
|
|
|
|
Off-chain only. Nothing here changes blocks, transfers, trades or validation.
|
|
|
|
## Flow
|
|
1. **Browser** (`src/auth/session.ts`):
|
|
- `GET /api/account/config`
|
|
- build the PKCE S256 authorize URL (with `state` and `nonce`)
|
|
- navigate to `https://dex.eom.dev/auth`
|
|
2. Dex redirects to `/auth/callback`. On native, it uses `dev.eom.wikideck:/oauth/callback`.
|
|
3. **Browser** sends `POST /api/account/token {code, codeVerifier, redirectUri, nonce}`. The **node** then:
|
|
- exchanges the code as the public client `wikideck` (no secret)
|
|
- verifies the ID token against the JWKS
|
|
- returns `{idToken, expiresAt, account}`
|
|
|
|
The exchange runs on the node because Dex sends no CORS headers.
|
|
4. The browser keeps the ID token in **sessionStorage** and sends it as `Authorization: Bearer`.
|
|
5. **Linking a wallet:**
|
|
- `POST challenge {address}` → `{nonce, message, expiresAt}`
|
|
- the **client builds the message itself** (`shared/account-link.ts` `clientLinkMessage`). It validates the nonce and expiry, refuses if the node's `message` differs, and signs locally with `src/wallet.ts` `sign`. The wallet never signs node-supplied text.
|
|
- `POST link {nonce, address, publicKey, signature}`
|
|
|
|
Nonces are single use, expire after 5 minutes, and are bound to (sub, address). There are at most 5 pending per account. One wallet belongs to one account.
|
|
|
|
## Endpoints (`/api/account/...`)
|
|
| Method | Path | Auth | Purpose |
|
|
|---|---|---|---|
|
|
| GET | `config` | none | issuer, clientId, scopes, authorization endpoint, allowed redirect URIs |
|
|
| POST | `token` | none | code exchange → ID token + account |
|
|
| GET | `me` | Bearer | account + linked wallets |
|
|
| POST | `challenge` | Bearer | one-time link challenge |
|
|
| POST | `link` | Bearer | prove wallet ownership, store mapping |
|
|
| DELETE | `link/:address` | Bearer | unlink |
|
|
| GET | `names?addresses=a,b` | none | leaderboard display names (`preferred_username`, else `name`; never email) |
|
|
|
|
Signed link message (off-chain, domain-tagged):
|
|
`["wikideck:account-link:v1", NETWORK, issuer, sub, address, nonce, expiresAt]`
|
|
|
|
## Node configuration
|
|
- **`PUBLIC_ORIGIN`** must be the node's UI origin, for example `http://192.168.1.32:3101`. Otherwise the existing POST origin check returns 403.
|
|
- **Outbound HTTPS** to `https://dex.eom.dev` is required.
|
|
- **Optional overrides:**
|
|
- `WIKIDECK_OIDC_ISSUER` (default `https://dex.eom.dev/`)
|
|
- `WIKIDECK_OIDC_CLIENT_ID` (default `wikideck`)
|
|
- `WIKIDECK_OIDC_REDIRECT_URIS` (comma-separated; must match the Dex registration)
|
|
- **Storage:** `$WIKIDECK_DATA_DIR/accounts.sqlite`.
|
|
|
|
## Capacitor
|
|
- The UI is bundled locally, so set `globalThis.WIKIDECK_NODE_URL = 'http://192.168.1.32:3101'` before using `src/auth`. That node's POST origin check must allow the app's WebView origin.
|
|
- Register the URL scheme `dev.eom.wikideck`.
|
|
- Install `@capacitor/browser` and `@capacitor/app`.
|
|
- Add the listener:
|
|
```ts
|
|
App.addListener('appUrlOpen', ({ url }) => { if (isCallback(url)) void completeLogin(url); });
|
|
```
|
|
|
|
## Known limits
|
|
- **Logout is local.** Dex publishes no `end_session_endpoint`, so its SSO cookie remains.
|
|
- **ID tokens aren't refreshed.** The default Dex lifetime is 24 h; after that, log in again.
|
|
- **Challenges live in memory.** A node restart drops pending challenges, so the client just asks again.
|