diff options
| author | Christophe Besson <cbesson@gmail.com> | 2026-09-01 01:03:43 +0200 |
|---|---|---|
| committer | Christophe Besson <cbesson@gmail.com> | 2026-09-01 01:03:43 +0200 |
| commit | fe30860c58e0f1b1efd457ff5eb5146d1e592da0 (patch) | |
| tree | 99a3e96994738c4e96f969a365679475dc4cf5cd /packages/meshbay-hub/tests/test_recovery_email.py | |
| parent | 51d2d734c228f1e46670962480258abfe586d6c4 (diff) | |
| download | meshbay-fe30860c58e0f1b1efd457ff5eb5146d1e592da0.tar.gz | |
feat: passphrase change and account recovery (auth-confirm)
The passphrase derives two independent client-side values: auth_key (the
hub verifier) and bundle_key (AES-GCM key for the per-node identity
bundles, which live on nodes and never on the hub). Changing or
recovering a passphrase is therefore two operations — swap the hub
verifier, and re-wrap every reachable node's identity bundle.
Flow A — change a known passphrase (Profile page)
- POST /v1/users/password re-proves the current passphrase, swaps
pw_hash/salt/version, revokes every refresh token and returns a fresh
pair so the tab that made the change stays signed in.
- MeshBayTransport.rewrapAllNodes: for every group's online node, connect
with the old key, read the identity off the handshake, store it back
under the new key. Returns updated / unreachable / failed so the UI can
point at the operator-unpin fallback for the gaps. Always-shown
confirmation dialog listing reachable and unreachable groups.
Recovery key
- keyderive.js generateRecoveryKey (32 random bytes, grouped Base32) and
deriveRecoveryKey (HKDF-SHA256, domain meshbay:recovery:v1:<username>).
- Every per-node identity gets a second copy wrapped under the recovery
key: keypair_bundles.bundle_enc_recovery (node-only column, added in
_SCHEMA_KEYPAIR and via a PRAGMA-guarded ALTER for existing DBs),
carried on keypair_bundle_store / _resp. MNP 0.13 -> 0.14, additive.
- session.recoveryKey is persisted in IndexedDB (slot rk) and lazy-loaded
on connect, so a group joined in any later session still leaves a
recovery copy.
- Shown once at registration; optionally folded into the verification
e-mail as a pass-through the hub never stores or logs, with an opt-out.
- Profile -> Recovery key re-loads R and backfills every reachable node
via rewrapAllNodes in bundleKey mode (no passphrase re-entry).
Flow B — recover a lost passphrase (#/reset, linked from sign-in)
- POST /v1/users/password/reset-request {username, email}: both must be
the pair on file, checked against the blind email_hash (never
decrypted). A mismatch — wrong e-mail, unknown username, non-active
account — takes the identical no-op path (no code, no mail, same 200),
so it reveals nothing and cannot be used to spray reset mail from a
username alone. 5/min, 1-hour single-use code.
- POST /v1/users/password/reset {username, code, new_auth_key}: same
expiry / attempts / single-use checks as e-mail verification; revokes
every session and deletes every registered device key so a stored one
cannot sign back in past the reset.
- ResetPasswordPage: request code -> code + optional recovery key + new
passphrase -> reset + sign-in -> fan-out. connect() falls back to the
recovery-wrapped copy when the passphrase key cannot open bundle_enc.
Without a recovery key: sign-in is restored and each group needs the
operator-unpin fallback.
Supporting fixes (found in live testing)
- member unpin now also deletes the keypair bundle; connect() mints a
fresh identity when handed a bundle it cannot open (unless _rewrapOnly,
set by rewrapAllNodes), so a rejoin completes instead of dead-ending
before the invite-code prompt.
- A browser with no bundle key gets a passphrase prompt on the group page
instead of a "go back to the browser you registered on" message.
- RegisterPage / LoginPage / ResetPasswordPage trim the username so every
key derivation matches the hub's stored form.
Docs: docs/auth-confirm.md. Locale keys across all ten catalogues.
Tests: test_password_change, test_password_reset, test_recovery_email,
test_recovery_key, test_rewrap_fanout, test_bundle_store_recovery, plus
additions to test_admin_ops_mnp and test_webrtc_transport. Hub suite 492
passed; node suite 741 passed (the lone test_packaging_units failure is a
pre-existing RPM-spec flake, reproducible on main).
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GGkxJW9br8Y9bhT8ywJ3oc
Diffstat (limited to 'packages/meshbay-hub/tests/test_recovery_email.py')
| -rw-r--r-- | packages/meshbay-hub/tests/test_recovery_email.py | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/packages/meshbay-hub/tests/test_recovery_email.py b/packages/meshbay-hub/tests/test_recovery_email.py new file mode 100644 index 0000000..e4288a1 --- /dev/null +++ b/packages/meshbay-hub/tests/test_recovery_email.py @@ -0,0 +1,99 @@ +""" +The recovery key in the registration e-mail (docs/auth-confirm.md §4.4). + +When the client sends `recovery_key`, the hub appends it to the verification +e-mail and stores it nowhere. When it does not, the e-mail carries only the +code. `recovery_key` is a pass-through — no column, no log line beyond a +boolean. +""" + +import base64 +import hashlib + +import pytest +from meshbay_hub import mail +from meshbay_hub.db.models import EmailVerification, User +from sqlalchemy import select + +RECOVERY = "ABCD EFGH JKLM NPQR STUV WXYZ 2345 6789 ABCD EFGH JKLM NPQR STUV" + + +def _auth_key(password: str, username: str) -> str: + salt = hashlib.sha256(f"meshbay:auth:v1:{username}".encode()).digest() + return base64.b64encode( + hashlib.pbkdf2_hmac("sha512", password.encode(), salt, 600_000, 32)).decode() + + +@pytest.fixture(autouse=True) +def _skip_email_verification(monkeypatch): + """ + Override conftest's skip: this module needs the real verification path to + run so the e-mail is actually built. Capture it instead of sending. + """ + sent = [] + monkeypatch.setattr("meshbay_hub.mail._send", lambda msg: sent.append(msg) or True) + return sent + + +@pytest.mark.asyncio +async def test_register_appends_the_recovery_key_to_the_email( + client, _skip_email_verification): + r = await client.post("/v1/users/register", json={ + "username": "rk1", "email": "rk1@example.com", + "auth_key": _auth_key("a-long-enough-passphrase", "rk1"), + "recovery_key": RECOVERY, + }) + assert r.status_code in (200, 201), r.text + assert len(_skip_email_verification) == 1 + body = _skip_email_verification[0].get_content() + assert RECOVERY in body + assert "recovery key" in body.lower() + + +@pytest.mark.asyncio +async def test_register_without_recovery_key_sends_only_the_code( + client, _skip_email_verification): + r = await client.post("/v1/users/register", json={ + "username": "rk2", "email": "rk2@example.com", + "auth_key": _auth_key("a-long-enough-passphrase", "rk2"), + }) + assert r.status_code in (200, 201), r.text + body = _skip_email_verification[0].get_content() + assert "recovery key" not in body.lower() + assert "verification code is" in body.lower() + + +@pytest.mark.asyncio +async def test_the_recovery_key_is_not_persisted( + client, db_session, _skip_email_verification): + await client.post("/v1/users/register", json={ + "username": "rk3", "email": "rk3@example.com", + "auth_key": _auth_key("a-long-enough-passphrase", "rk3"), + "recovery_key": RECOVERY, + }) + rows = (await db_session.execute(select(EmailVerification))).scalars().all() + assert rows + for row in rows: + assert RECOVERY not in (row.code or "") + assert RECOVERY not in (row.email_encrypted or "") + user = (await db_session.execute( + select(User).where(User.username == "rk3"))).scalar_one() + assert RECOVERY not in repr(vars(user)) + + +def test_mail_body_with_and_without_the_key(monkeypatch): + captured = [] + monkeypatch.setattr("meshbay_hub.mail._send", + lambda msg: captured.append(msg) or True) + + mail.send_verification_code("x@example.com", "123456", + recovery_key="MY-RECOVERY-KEY") + body = captured[-1].get_content() + assert "123456" in body + assert "MY-RECOVERY-KEY" in body + assert "recovery key" in body.lower() + + mail.send_verification_code("x@example.com", "123456") + body = captured[-1].get_content() + assert "123456" in body + assert "recovery key" not in body.lower() |