Files
bitlogin/docs
thePR0M3TH3ANandClaude Fable 5 7d2209d706 Second-audit hardening: phrase-gated sudo key, deterministic migration, policy tests
Authored by ChatGPT/Codex in a separate review pass. Reviewed and verified
here before committing rather than taken on trust; findings below.

The substantive change is that the vault sudo key now lives ONLY in the
phrase-gated recovery capsule. A newly written password credential capsule
carries just connection_vault_root, so an ordinary login restores
connectable-tier records without putting personal-tier material behind a
password capsule that is downloadable and therefore offline-guessable forever.
Pre-hardening capsules stay readable, password login does not return their
sudo key, and the next rotation scrubs it. That closes the gate this project
had explicitly set on personal-tier UI.

Legacy vault-enable migration now derives roots deterministically from
phrase-protected material and account_id, so two concurrent attempts cannot
mint divergent roots -- the failure mode the docs previously mitigated with
"enable the vault once, from one device".

Manual (user-chosen) passwords are REMOVED, not merely discouraged, and a new
securityPolicy.test.ts pins that along with several things tests do not
usually reach: the deployment CSP (default-src 'none', frame-ancestors
'none') plus six baseline headers, demo pages free of inline scripts and
remote fonts, and README documenting same-origin self-hosting only rather
than a remote demo embed. llms.txt was updated to match, which I checked
because that test only reads README.

What I verified, since a passing suite proves less than it appears to:

- All 12 fixes from the 2026-07-30 audit survived the rewrite of recover.ts,
  changePassword.ts, validation.ts, relay.ts, session.ts and element.ts.
  Checked semantically where grep cannot help: changePassword still checks
  publish success BEFORE building the tombstone, and vaultSetBinding still
  unbinds on origin === null rather than silently rebinding to the worker
  global.
- No dependency changes; the package.json diff is scripts only.
- Argon2id and KDF parameters unchanged. The NIP-44 diff ADDS a base64 length
  cap before decoding, a memory-DoS guard.
- Validation increased rather than decreased: 44 throws added, 33 removed.
- No disabled or skipped tests, no secrets in the diff.

typecheck clean, 165/165 tests, build green, and the account manager exercised
in a browser: creation correctly refused when relay quorum could not be met,
and on retry failed at the recovery capsule with "No login credential was
published" -- the §18.1 fail-closed ordering doing its job against a flaky
public relay set.

Co-Authored-By: Claude Fable 5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01CMr9Yt8SYmZcfgrg3CV2G1
2026-07-31 13:54:36 -04:00
..

BitLogin Documentation

BitLogin is a static, relay-backed portable account protocol that gives users a familiar login name and password while preserving a user-controlled Nostr identity and independent phrase recovery.

This directory contains the core protocol specification, implementation notes, and experimental designs for expanding BitLogin into a portable account layer for compatible applications.

Core protocol

Portable account layer

These documents describe proposed capabilities that build on BitLogin's core identity and recovery model.

  • account-switching.md — multiple independent accounts on one device, fast switching, locking, logout, and account-aware signer behavior
  • portable-app-state.md — encrypted, user-owned application settings and lightweight state that follow the account across devices
  • portable-entitlements.md — discovery, verification, recovery, and presentation of purchases, licenses, memberships, and access rights
  • relay-and-messaging-portability.md — relay-role management, DM inbox and outbox synchronization, sent-message recovery, and conversation reconstruction

Connection Vault

The Connection Vault stores portable application credentials outside the core identity capsules as independently encrypted records. Its protocol layer (records, key hierarchy, relay sync, migration, tiers) is implemented in @bitlogin/core's src/vault/; the widget authorization layer shipped 2026-07-30 in REVEAL mode (requestNwcConnection, offerNwcConnection, and a Wallet-connections screen). Durable per-origin grants and a Connected-apps page are still to come; see connection-vault.md §19 for the open limitations.

  • connection-vault.md — overall vault architecture, key hierarchy, relay storage, authorization, recovery, and deletion; §18 records the implementation-time decisions (tier model, sudo key)
  • vault-ux.md — the agreed user-experience walkthroughs, serving as the authorization layer's acceptance criteria
  • nwc-connections.md — Nostr Wallet Connect credential profile (parser/exporter implemented in src/vault/nwc.ts)
  • s3c-format.md — portable s3c1: format for S3-compatible storage connections

How the pieces fit together

BitLogin account
├── Identity and recovery
│   ├── Credential capsule
│   ├── Recovery capsule
│   └── Everyday Nostr identity
│
├── Accounts and sessions
│   └── Multiple-account switching
│
├── Communication
│   ├── Relay preferences
│   ├── DM inbox synchronization
│   ├── DM outbox and sent-message recovery
│   └── Conversation reconstruction
│
├── Portable application experience
│   ├── App settings
│   ├── Saved state
│   └── Per-app authorization
│
├── Ownership
│   ├── Purchases
│   ├── Licenses
│   ├── Memberships
│   └── Access entitlements
│
└── Connection Vault
    ├── NWC wallet connections
    ├── S3-compatible storage connections
    └── Future service credentials

Status terminology

Documents use these labels:

  • Implemented — available in the current codebase
  • Partially implemented — some required primitives or flows exist, but the complete user-facing feature does not
  • Experimental design — documented for review and future implementation; wire formats and APIs may change

Experimental documents are not part of the stable BitLogin protocol until their schemas, security properties, migrations, and test vectors are finalized.

A practical development sequence is:

  1. Complete the core account and messaging foundations.
  2. Add independent multi-account sessions and switching.
  3. Add relay management, inbox synchronization, and sent-message recovery.
  4. Add portable application state and per-app permissions.
  5. Add entitlement discovery and a portable ownership library.
  6. Implement the Connection Vault and its NWC and S3 profiles.
  7. Move high-value authorization into stronger extension, native, or cross-origin execution boundaries.

Design principle

BitLogin should coordinate portable identity, state, ownership, and service access without becoming the centralized custodian of the user's identity, money, files, messages, or purchases.