The interop contract for multiple applications operating one deterministic account tree -- SeedPass as the reference superset, narrower identity clients (BitLogin) implementing a subset. Extracted from working code, not designed on paper: every derivation path, container format, and merge rule in it is the one the cross-impl suite already enforces between Python and TypeScript, so a new implementation tests against ground truth rather than prose. The load-bearing sections: the index-immutability rule (now backed by the allocation watermark), the two index namespaces (entry id vs totp), the interop rules that keep applications from needing each other (preservation, namespacing, no shadow account numbers, round-trip conformance), and a deliberately scoped-out list -- policy, orgs, payments, workflows are application features that store data IN the format, not format features. Includes an honest gap ledger: TS currently fails-closed on unknown entry kinds where the spec prefers carry-through; that and a round-trip CI check are recorded as follow-ups in TODO.md. Co-Authored-By: Claude Opus 5 <[email protected]> Claude-Session: https://claude.ai/code/session_01Tkj4rzKBA3uhfgk7kqjsb8
17 KiB
SeedPass TODO
This file tracks the remaining work from the latest bug search and security evaluation.
Entropy audit (2026-07-31)
docs/entropy_audit_2026-07-31.md — RNG and
randomness-integration audit. No predictable-fallback defect: every non-deterministic secret
uses os.urandom / secrets, and the random module is not imported anywhere in non-test source.
Read the compatibility constraint in that document before touching
core/password_generation.py. Passwords are never stored — they are re-derived on demand from
(seed, index, length, policy, gen_version). Entries now carry gen_version, and an absent field
means v1. The rule is permanent: never alter the output of a version that already exists in the
wild. v1 is frozen; a fix that changes derivation goes into a new version, never into an old one.
src/tests/test_entropy_integrity.py enforces this with 18 v1 vectors — a failure there is never
"update the expected value".
-
M4 (done) — v1 password vectors frozen, plus fail-closed RNG tests, in
src/tests/test_entropy_integrity.py(26 tests, inside the--determinism-onlyCI gate). 18 vectors cover every policy and both sides of the 32-byte stream-wrap boundary. Mutation-verified: removing_balance_distribution(M1), altering theDeterministicStreamwrap (M3) and changing the character mapping (M2) each turn all 18 red; adding a hash-of-timestamp fallback togenerate_bip85_seedturns the fail-closed test red. M1/M2/M3 are now safe to attempt. -
L1 (done) — deleted the dead HKDF block in
_derive_password_entropy, dropped the three now-unused imports (HKDF,hashes,default_backend), and corrected the docstrings that named HKDF instead of PBKDF2. Verified as a negative control: all 18 v1 vectors stayed green, confirming the harness does not produce false alarms on behaviour-preserving edits. -
M1 / M2 / M3 (done) — password generation is now versioned.
gen_versiondefaults to 1 everywhere, so existing entries and every untouched caller keep deriving v1 byte-identically; new password entries are stampedgen_version: 2. v2 drops the forced equal-quarters class quota (M1), draws by rejection sampling (M2) from an unbounded HMAC-expanded stream (M3), and enforces only the policy minima — choosing donor positions from classes that have a surplus, so raising one minimum can no longer break another.Measured at length 16 over 200 samples: v1 produced **1** distinct class composition, v2 produces **82**. Per-character entropy 6.42 → 6.53 bits against a 6.555 ceiling. Chi-square 96.1 (df=93) confirms the modulo bias is gone; lag-32 repeat rate sits within one standard error of chance, confirming the repeating pad is gone. -
Opt-in upgrade UX for existing entries — a per-entry action that re-derives at v2, with a confirmation making the consequence unmissable ("this changes the password; update it at the site first"). Never bulk-migrate. Until this ships, existing entries stay on v1 by design.
-
L2 (done) —
generate_bip85_seed(words_num=...)accepts 12 or 24 and rejects anything else; threaded throughcreate_profile_from_generated_seed. Default stays 12 so existing profiles and callers are unaffected. -
L3 (done for the RNG path) —
os.urandom(32)moved outside the try block ingenerate_bip85_seed, so no handler can stand between the entropy draw and the caller, and the redundant duplicateexcept Exceptionis gone. A test asserts theOSErrorarrives as the same object that was thrown, which is only true if nothing repackaged it. -
L4 (code fixes done) —
torch/temp filename now usesrandomBytes(8); theMath.randomvalue misnamednonceinrelay-health.mjsis nowprobeSuffixfromrandomBytes(6). -
⚠️ Decision needed:
torch/_backups/holds 5240 tracked files across six dated snapshots. Untracking is a large deletion, so it is not an audit side effect. Costs today: duplicates every security grep hit, and barenode --testintorch/discovers them and fails 18 tests from stale snapshot code (npm testuses explicit paths, so CI is unaffected). Separately:torch/has notest/directory in the repo, so itsnpm testcannot run as written. -
L5 (done) —
dependency-audit.ymlgenerates and uploads a CycloneDX SBOM fromrequirements.lock. Verified with the real tool: CycloneDX 1.6, 96 components, crypto chain recorded at exact versions.
The remaining broad except Exception handlers in password_generation.py wrap deterministic
derivation with no RNG in it and re-raise rather than substituting; they belong to the Robustness
item further down, not to this audit.
Security
- Complete checklist item #8 (Supply chain and release integrity):
- run one tagged release through
.github/workflows/release-integrity.ymland link evidence indocs/security_readiness_checklist.md - resolve or formally time-box/own the
GHSA-wj6h-64fc-37mpexception (docs/supply_chain_release_integrity.md) - enforce release/tag protections requiring
Release Integrity+ dependency audit checks - publish maintainer/consumer verification runbook (checksum + cosign verification with expected issuer/identity) ✅
docs/release_verification_runbook.md
- run one tagged release through
- Upgrade vulnerable runtime dependencies in lockfiles and packaging inputs:
aiohttp->>=3.13.3cryptography->>=46.0.5starlette->>=0.49.1python-multipart->>=0.0.22urllib3->>=2.6.3pynacl->>=1.6.2pillow->>=12.1.1orjson,pyasn1,cbor2and otherpip-auditfindings
- Regenerate
requirements.lockafter upgrades and re-run the full test suite. - Re-run
pip-audit -r requirements.lockand ensure zero actionable runtime vulnerabilities. - Evaluate the
Crypto.*imports insrc/seedpass/core/password_generation.pyand either:- keep
pycryptodomeintentionally with explicit documentation, or - migrate RSA generation to
cryptographyAPIs.
- keep
Robustness
- Replace broad
except Exception: passblocks with explicit exceptions + logging:src/main.pysrc/seedpass/core/manager.pysrc/seedpass/core/menu_handler.py
- Add telemetry-safe logs for swallowed error paths without exposing secrets.
- Harden startup/restore prompt flows against
EOFError/ cancellation loops:- startup options (
Continue/Restore from backup) - restore-backup fingerprint/path prompts
- ensure graceful return-to-menu instead of process-level failure.
- startup options (
Tests To Add
- Add deterministic tests for
derive_pgp_key(..., key_type="rsa")covering:- stable output across repeated runs
- key fingerprint format and validity
- Add API rate-limit tests for:
- per-client isolation
- window expiry behavior
- restart/reset behavior after
start_server()
- Add API import tests for boundary conditions:
- exactly-at-limit upload size
- malformed multipart payload
- invalid JSON body for path-based import
- Add regression tests for manager notification/logging fallback paths currently guarded by broad exception handling.
Documentation
- Document API import upload limit (
SEEDPASS_MAX_IMPORT_BYTES) in user docs. - Add a security maintenance section describing dependency-audit cadence and update policy.
TypeScript port (port/typescript-web-extension)
Branch state as of 2026-08-17: core + CLI + interactive TUI are feature-complete for daily use and cross-verified against Python on every change. What follows is everything still open, in the order it should be tackled.
Blockers before real secrets
- Independent security review of the TypeScript branch. No one but the
authoring agent has read this code. Two earlier review rounds on this
project each found criticals that self-review missed, so a green suite and
an author's sign-off are not evidence of much. Scope it to
js/packages/core/src/crypto,js/packages/core/src/derive, andjs/packages/cli/src/agent.tsfirst: a derivation bug does not throw, it quietly produces a secret that cannot be recovered. Blocks the merge below. - Fix the findings from the 2026-08-17 self-review (next section). Do these before handing the branch to an outside reviewer so their time goes on what an author cannot see.
Findings from the 2026-08-17 self-review
Found by reading and probing, not by the suite — all 128 CLI tests passed before and after each was confirmed. Ordered by severity.
- (fixed 2026-08-17) The agent can be left holding a parent seed
forever, after reporting failure.
AgentDaemon.handle'sputwrites tothis.heldbefore awaiting the audit append. A non-numericttlmakesexpiresAtNaN; the audit write then throws on the non-finite number, so the caller is told the unlock failed — but the seed is resident,expire()'sheld.expiresAt <= nowis false forever, and no audit record exists saying the vault was ever unlocked. Confirmed:owner-mnemonicreturned the full phrase 3.5s after a "failed" put on an agent with a 1s TTL. Fix: validatettl/uses/expires_atas finite positive integers at the daemon boundary, and order every op so state is committed only after its audit record lands. The CLI'sparseIntOptionalready blocks this path, which is exactly why the daemon must not rely on it —agent.ts:1-22states the CLI is untrusted, and the browser extension will be the next thing speaking this protocol. - (fixed 2026-08-17) A
use-scoped token holder can kill the agent and drop every held seed.stdinSinkwrites tochild.stdinwith noerrorlistener, so a command that exits before draining stdin raises an unhandled EPIPE. Confirmed as an uncaught exception inside the agent process via ause-sinkrequest naming/bin/true;main.tsinstalls nouncaughtExceptionhandler, so the realagent startprocess exits. The exec allowlist does not help — any allowlisted command that exits early does it. This is the least-privileged principal in the model taking down the enforcement point. Fix: handlestdinerrors the wayfeedClipboardToolalready does, and treat EPIPE as a delivery failure. - (fixed 2026-08-17) Secrets sent to the clipboard are never cleared. Python's
copy_to_clipboard(text, timeout)starts a timer and clears the clipboard if the value is unchanged; the TypeScriptclipboardSinkjust writes and returns.clipboard_clear_delay: 45is in the default config, is settable, and is read by nothing. This makes TUI Secret Mode — whose entire purpose is to route secrets away from the screen — strictly less safe than Python's, because it parks them on a session-wide clipboard indefinitely. - (fixed 2026-08-17)
kdf_iterationsis inert. Settings displays it, stores it, and tells the user "use Change password to re-wrap this profile's seed at the new strength".changePasswordtakes aniterationsparameter and the TUI never passes it, andcreateProfilehardcodesDEFAULT_PBKDF2_ITERATIONS. Raising it changes nothing anywhere. Either wire it through both paths or remove the setting — a security control that silently does nothing is worse than an absent one. - (fixed 2026-08-17)
inactivity_timeoutis inert. Stored, displayed, settable as Settings item 12, enforced nowhere. Python's TUI locks the vault after it lapses; the TypeScript TUI leaves an unattended terminal unlocked indefinitely. - (fixed 2026-08-17) TUI file exports do not get the 0600 they claim.
menus.tswrites document exports, database exports and the 2FA export withwriteFile(..., {mode: 0o600}).modeapplies only at creation, so writing over an existing 0644 file leaves it 0644 — verified. The 2FA export is every TOTP secret in the vault in plaintext, and its comment asserts the 0600. The CLI already does this correctly withatomicWrite(fresh inode + rename, symlink-safe) and explains why; the TUI regressed it. The TUI exports also silently overwrite, where the CLI requires--overwrite. - (fixed 2026-08-17) Audit-log truncation detection is defeated by deleting one more file.
AuditLog.verifyskips the count check entirely whenaudit.log.headis absent, so removing the head and truncating the log verifies clean. The head sits beside the log with the same permissions, so anyone who can alter one can remove the other. The doc comment claims the head "pins the expected length" against exactly this attack. Either require the head once the log exists, or keep it somewhere the log's writer cannot reach. - (fixed 2026-08-17) Unvalidated token constraint shapes.
token-issuecastskindsandscopeswithout checking they are arrays.kinds: "totp"makesArray.includesbecomeString.includes, turning an exact kind match into a substring match — inert today only because no SeedPass kind is a substring of another.scopes: "reveal"throws a raw TypeError back to the caller. Owner-gated, so this is hardening, not a live hole. - (fixed 2026-08-17) Dead code that reads as a control.
authorize()'sif (entry)branch is never reached (both call sites omit the argument; the real check istokenMaySee), andsinkEnv'sFORBIDDEN_ENVdelete loop runs against an allowlist that never contains those keys. Both look like defenses on inspection. Remove them or make them load-bearing. - (resolved 2026-08-17: confirmed deliberate, documented in authorize()) A denied entry lookup still burns a token use.
resolveForTokenconsumes a use at pre-auth, before the entry is known, so probing for non-existent ids exhausts a token. That ordering is deliberate anti-enumeration; confirm it is the trade wanted and write it down.
Cutover
- Fold the CLI bundle's
.sha256into therelease-integritysigning workflow (the remaining item of cutover gate 6). - Merge to
mainand move the Python implementation tolegacy/. Blocked by the independent review above.
Unbuilt milestones
- Milestone 6 (static/PWA web app) and Milestone 7 (browser
extension) of
docs/typescript_web_extension_port_plan.mdare not started —js/packages/holdscore,cliandtest-vectorsonly. The branch is named for a web extension that does not exist yet; the CLI was the proving ground for the core. - Decide whether the
api(FastAPI) surface gets a TypeScript port at all. It is currently excluded from cutover gate 5 as "a separate surface, not vault behavior", and the session agent (unix socket, 0600, scoped tokens) covers agent automation without binding a port — a smaller attack surface for a process holding unlocked seeds.src/seedpass/api.pyis 2093 lines and much of it hangs off features that are deliberately not ported (high-risk partitions, agent job profiles, recovery split, semantic). A faithful port means porting those first; the genuinely useful subset is entry CRUD, search, lock/unlock and config. Options: leave it Python-only, port the subset, or drop it. Decide before the extension lands, since the extension needs some transport.
Shared vault/identity spec (BitLogin groundwork)
- (done 2026-08-18) Entry-id allocation watermark — ids are never
reused after deletion;
_sync_meta.next_index, merged as max, in both implementations with cross-impl parity. The precondition for "account #N" as a recovery coordinate. - (done 2026-08-18)
docs/seedpass_vault_identity_spec.md— v1 draft extracted from working code: canonicalization, containers, derivation table, the two index namespaces, allocation rule, interop rules (preservation, namespacing, no-translation-table, round-trip conformance), capability profiles, sync/backup, and an honest gap ledger. - Unknown-kind passthrough (spec §8.2/§12). TS
entryUnionSchemafails the whole index parse on an unrecognized entry kind — fail-closed where the spec prefers carry-through-untouched. Add an opaque-record branch (preserve verbatim, exclude from typed operations) so a future client (e.g. BitLogin) can add namespaced kinds without stranding vaults on older SeedPass builds. Python is naturally tolerant; add a test pinning that. - Round-trip conformance check as CI (spec §8.6). A phase in cross_impl_check.py: vault with unknown fields + unknown kinds survives A→B→A open/save unchanged. Cheap once the passthrough lands.