mirror of
https://github.com/block/buzz.git
synced 2026-10-27 12:40:30 +00:00
feat(desktop): locally stored NIP-49 encrypted key backup (#2937)
## Summary
Adds a locally stored **NIP-49 encrypted key backup** (`ncryptsec`) to
the desktop app, per the plan reviewed in buzz-development (Rev 3,
approved 9/10 by Wren; implementation also reviewed and approved 9/10).
**Two-artifact design — canonical bytes originate entirely in Rust:**
- `create_ncryptsec_backup` runs under the `identity_mutation` lock:
encrypt → decrypt-verify against the live pubkey → atomic `0o600` write
to `{app_data_dir}/identity.ncryptsec` → reread/byte-compare → return
the exact persisted bytes. The frontend never re-derives or re-encrypts.
- `save_ncryptsec_copy` writes a portable copy via the save dialog
(parse-gated, secret-file semantics) and never mutates canonical state.
- `generate_backup_passphrase`: 6 words from the EFF short wordlist via
`OsRng` (custom passphrases min 12 chars).
- Import accepts `ncryptsec1` with optional password; the raw-`nsec`
path is untouched. Different-pubkey import and sign-out wipe the
app-managed backup (post-commit, best-effort — a failed import can never
destroy the still-live identity's backup; regression-tested).
**Never-relay guarantee (egress guard + tripwires):**
- `egress_guard.rs` fail-closed at all 8 `/events` submission boundaries
(relay submit funnel, 3× `relay.rs`, huddle STT, both engram submitters,
native WS choke point), rejecting `ncryptsec1`/`NCRYPTSEC1` in text and
binary frames. Scope is deliberately ncryptsec-only: pairing
intentionally carries raw nsec inside its encrypted session.
- Site-granular `/events` inventory tripwire: per-file (`/events` count,
guard-call count) pairs; unlisted files expect zero. Mutation-style
tests prove a ninth site in an existing file, a removed guard, and a new
unlisted file all fail the scan.
- ncryptsec source-allowlist scans in **both** trees (Rust + TS).
**Frontend:** onboarding `BackupStep` is encrypted-by-default — the
default path never invokes `get_nsec` (e2e asserts the command log).
Raw-nsec export stays behind an explicit click with prior semantics.
Shared `EncryptedBackupCreator` powers onboarding + a new settings row;
the import form auto-switches to encrypted mode on `ncryptsec1` paste
(case-insensitive HRP).
**Open product call for @tlongwell-block:** onboarding default is
*encrypted* in this PR; flipping to raw-default is a small change either
way (documented in the plan).
Review history: plan Rev 3 and the implementation were both iterated
with Wren to 9/10 (two blockers from round 1 — import ordering,
inventory granularity — plus an uppercase-bech32 hardening gap, all
fixed in `dde37183e`). Thread: buzz-development.
### Related issue
Follow-up to the direction explored in #385 (NIP-PB, closed) — this
ships local NIP-49 (the standard) instead of a new NIP. No open
duplicate found.
### Testing
All at exactly `dde37183e` (same shell, HEAD verified):
- `cargo test` — 1680 passed / 0 failed / 14 ignored (includes a
deliberate ~70s log_n-18 NIP-49 round trip, spec vector, wrong-password,
NFKC, uppercase-vector decrypt, injection test per egress boundary,
inventory mutation tests, import-ordering regression tests)
- `cargo clippy --all-targets -- -D warnings` — clean; `cargo fmt
--check` — clean
- `pnpm typecheck` — clean; JS unit suite 3529/3529; biome (repo-pinned
2.4.16) clean
- Playwright `onboarding-backup` / `onboarding` /
`onboarding-agent-defaults` / `profile-nsec-reveal` — 86 passed, 1 known
avatar-reservation flake (passed on rerun; untouched by this diff).
`passThroughBackupStep` now exercises the encrypted default, so every
downstream onboarding spec covers the new path.
- Note: browser e2e fakes the crypto via the mock bridge (fixed
spec-vector blob); decryption correctness is proven in the Rust tests.
## Latest onboarding integration
The current head adds an additive `IdentityInfo.storage` field
(`ephemeral`, `system-keyring`, `local-file`, or `environment`) so
onboarding can accurately explain where the active identity is
protected. It surfaces storage metadata only—never key material—and
leaves the existing lost/keyring-locked recovery behavior intact.
---------
Signed-off-by: Tyler Longwell <tlongwell@block.xyz>
Signed-off-by: Taylor Ho <taylorkmho@gmail.com>
Co-authored-by: npub1qyvc0c5kl4gqv2fd97fsk46tu378sqgy35vc83rvgfwne90sel7s0ed67d <011987e296fd5006292d2f930b574be47c7801048d1983c46c425d3c95f0cffd@buzz.block.builderlab.xyz>
Co-authored-by: Tyler Longwell <tlongwell@block.xyz>
Co-authored-by: Taylor Ho <taylorkmho@gmail.com>
Co-authored-by: npub1223z34hd7vtwc6qj4s7flsxkj644nlre2nthu7lrrmkumhu3xddsrx9r6w <52a228d6edf316ec6812ac3c9fc0d696ab59fc7954d77e7be31eedcddf91335b@buzz.block.builderlab.xyz>
This commit is contained in:
Tyler
@@ -12,83 +12,116 @@ import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const HERE = path.dirname(fileURLToPath(import.meta.url));
|
||||
const OUTPUT = path.resolve(
|
||||
HERE,
|
||||
"../../src/shared/ui/assets/card-texture.png",
|
||||
);
|
||||
|
||||
// CSS-pixel source geometry. Screenshotting at DPR 2 produces a crisp asset.
|
||||
const CARD_SIZE = 640;
|
||||
const OUTSET = 96;
|
||||
const CAPTURE_SIZE = CARD_SIZE + OUTSET * 2;
|
||||
const OUTPUT_DIRECTORY = path.resolve(HERE, "../../src/shared/ui/assets");
|
||||
const DPR = 2;
|
||||
|
||||
// Approved texture parameters, archived from the former runtime SVG filter.
|
||||
const BLUR = 66;
|
||||
const DILATE = Math.round(BLUR * 0.85);
|
||||
const THRESHOLD_BIAS = 0.302;
|
||||
const SLOPE = 8;
|
||||
const FREQUENCY = 0.999;
|
||||
const OCTAVES = 3;
|
||||
const SEED = 5315;
|
||||
|
||||
await mkdir(path.dirname(OUTPUT), { recursive: true });
|
||||
const TEXTURES = [
|
||||
{
|
||||
filename: "card-texture.png",
|
||||
color: "white",
|
||||
cardSize: 640,
|
||||
outset: 96,
|
||||
blur: 66,
|
||||
innerBand: 112,
|
||||
},
|
||||
{
|
||||
filename: "card-texture-dark.png",
|
||||
color: "#171b21",
|
||||
cardSize: 640,
|
||||
outset: 96,
|
||||
blur: 66,
|
||||
innerBand: 112,
|
||||
},
|
||||
{
|
||||
filename: "card-texture-compact.png",
|
||||
color: "white",
|
||||
cardSize: 320,
|
||||
outset: 24,
|
||||
blur: 24,
|
||||
innerBand: 44,
|
||||
},
|
||||
{
|
||||
filename: "card-texture-dark-compact.png",
|
||||
color: "#171b21",
|
||||
cardSize: 320,
|
||||
outset: 24,
|
||||
blur: 24,
|
||||
innerBand: 44,
|
||||
},
|
||||
];
|
||||
|
||||
await mkdir(OUTPUT_DIRECTORY, { recursive: true });
|
||||
|
||||
const browser = await chromium.launch();
|
||||
try {
|
||||
const page = await browser.newPage({
|
||||
deviceScaleFactor: DPR,
|
||||
viewport: { height: CAPTURE_SIZE, width: CAPTURE_SIZE },
|
||||
});
|
||||
for (const texture of TEXTURES) {
|
||||
const captureSize = texture.cardSize + texture.outset * 2;
|
||||
const dilate = Math.round(texture.blur * 0.85);
|
||||
const output = path.join(OUTPUT_DIRECTORY, texture.filename);
|
||||
const page = await browser.newPage({
|
||||
deviceScaleFactor: DPR,
|
||||
viewport: { height: captureSize, width: captureSize },
|
||||
});
|
||||
|
||||
await page.setContent(`<!doctype html>
|
||||
<style>
|
||||
html, body { margin: 0; width: 100%; height: 100%; background: transparent; }
|
||||
#stage { position: relative; width: ${CAPTURE_SIZE}px; height: ${CAPTURE_SIZE}px; }
|
||||
#core {
|
||||
position: absolute;
|
||||
inset: ${OUTSET + BLUR / 2}px;
|
||||
background: white;
|
||||
filter: blur(${BLUR / 3}px);
|
||||
}
|
||||
</style>
|
||||
<div id="stage">
|
||||
<svg width="${CAPTURE_SIZE}" height="${CAPTURE_SIZE}" aria-hidden="true">
|
||||
<defs>
|
||||
<filter id="texture" x="0" y="0" width="100%" height="100%"
|
||||
filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
|
||||
<feMorphology in="SourceAlpha" operator="dilate" radius="${DILATE}" result="squared" />
|
||||
<feGaussianBlur in="squared" stdDeviation="${BLUR}" result="ramp" />
|
||||
<feTurbulence type="fractalNoise" baseFrequency="${FREQUENCY}"
|
||||
numOctaves="${OCTAVES}" seed="${SEED}" result="grain" />
|
||||
<feColorMatrix in="grain" result="grainAlpha" type="matrix"
|
||||
values="0 0 0 0 0
|
||||
0 0 0 0 0
|
||||
0 0 0 0 0
|
||||
1 0 0 0 0" />
|
||||
<feComposite in="ramp" in2="grainAlpha" operator="arithmetic"
|
||||
k1="0" k2="1" k3="-1" k4="${-THRESHOLD_BIAS}" result="dithered" />
|
||||
<feComponentTransfer in="dithered" result="specks">
|
||||
<feFuncA type="linear" slope="${SLOPE}" intercept="0" />
|
||||
</feComponentTransfer>
|
||||
<feFlood flood-color="white" result="white" />
|
||||
<feComposite in="white" in2="specks" operator="in" />
|
||||
</filter>
|
||||
</defs>
|
||||
<rect x="${OUTSET}" y="${OUTSET}" width="${CARD_SIZE}" height="${CARD_SIZE}"
|
||||
fill="white" filter="url(#texture)" />
|
||||
</svg>
|
||||
<span id="core"></span>
|
||||
</div>`);
|
||||
await page.setContent(`<!doctype html>
|
||||
<style>
|
||||
html, body { margin: 0; width: 100%; height: 100%; background: transparent; }
|
||||
#stage { position: relative; width: ${captureSize}px; height: ${captureSize}px; }
|
||||
#core {
|
||||
position: absolute;
|
||||
inset: ${texture.outset + texture.blur / 2}px;
|
||||
background: ${texture.color};
|
||||
filter: blur(${texture.blur / 3}px);
|
||||
}
|
||||
</style>
|
||||
<div id="stage">
|
||||
<svg width="${captureSize}" height="${captureSize}" aria-hidden="true">
|
||||
<defs>
|
||||
<filter id="texture" x="0" y="0" width="100%" height="100%"
|
||||
filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
|
||||
<feMorphology in="SourceAlpha" operator="dilate" radius="${dilate}" result="squared" />
|
||||
<feGaussianBlur in="squared" stdDeviation="${texture.blur}" result="ramp" />
|
||||
<feTurbulence type="fractalNoise" baseFrequency="${FREQUENCY}"
|
||||
numOctaves="${OCTAVES}" seed="${SEED}" result="grain" />
|
||||
<feColorMatrix in="grain" result="grainAlpha" type="matrix"
|
||||
values="0 0 0 0 0
|
||||
0 0 0 0 0
|
||||
0 0 0 0 0
|
||||
1 0 0 0 0" />
|
||||
<feComposite in="ramp" in2="grainAlpha" operator="arithmetic"
|
||||
k1="0" k2="1" k3="-1" k4="${-THRESHOLD_BIAS}" result="dithered" />
|
||||
<feComponentTransfer in="dithered" result="specks">
|
||||
<feFuncA type="linear" slope="${SLOPE}" intercept="0" />
|
||||
</feComponentTransfer>
|
||||
<feFlood flood-color="${texture.color}" result="surfaceColor" />
|
||||
<feComposite in="surfaceColor" in2="specks" operator="in" />
|
||||
</filter>
|
||||
</defs>
|
||||
<rect x="${texture.outset}" y="${texture.outset}" width="${texture.cardSize}" height="${texture.cardSize}"
|
||||
fill="${texture.color}" filter="url(#texture)" />
|
||||
</svg>
|
||||
<span id="core"></span>
|
||||
</div>`);
|
||||
|
||||
await page.locator("#stage").screenshot({
|
||||
omitBackground: true,
|
||||
path: OUTPUT,
|
||||
});
|
||||
await page.locator("#stage").screenshot({
|
||||
omitBackground: true,
|
||||
path: output,
|
||||
});
|
||||
await page.close();
|
||||
|
||||
console.log(`Generated ${output}`);
|
||||
console.log(`Asset: ${captureSize * DPR}×${captureSize * DPR}px @${DPR}x`);
|
||||
console.log(
|
||||
`Runtime slice: ${(texture.outset + texture.innerBand) * DPR}px; outset: ${texture.outset}px`,
|
||||
);
|
||||
}
|
||||
} finally {
|
||||
await browser.close();
|
||||
}
|
||||
|
||||
console.log(`Generated ${OUTPUT}`);
|
||||
console.log(`Asset: ${CAPTURE_SIZE * DPR}×${CAPTURE_SIZE * DPR}px @${DPR}x`);
|
||||
console.log(`Runtime slice: ${(OUTSET + 112) * DPR}px; outset: ${OUTSET}px`);
|
||||
|
||||
Reference in New Issue
Block a user