mirror of
https://github.com/kccleoc/seedpgp-web.git
synced 2026-03-07 01:47:52 +08:00
docs: enhance documentation with threat model, limitations, air-gapped guidance
- Update version to v1.4.4 - Add explicit threat model documentation - Document known limitations prominently - Include air-gapped usage recommendations - Polish all documentation for clarity and examples - Update README, DEVELOPMENT.md, GEMINI.md, RECOVERY_PLAYBOOK.md
This commit is contained in:
705
README.md
705
README.md
@@ -1,4 +1,4 @@
|
||||
# SeedPGP v1.4.3
|
||||
# SeedPGP v1.4.4
|
||||
|
||||
**Secure BIP39 mnemonic backup using PGP encryption and QR codes**
|
||||
|
||||
@@ -6,27 +6,199 @@ A client-side web app for encrypting cryptocurrency seed phrases with OpenPGP an
|
||||
|
||||
**Live App:** <https://seedpgp-web.pages.dev>
|
||||
|
||||
## Features
|
||||
---
|
||||
|
||||
- 🔐 **PGP Encryption**: Uses cv25519 (Curve25519) for modern elliptic curve cryptography
|
||||
- 📱 **QR Code Ready**: Base45 encoding optimized for QR code generation
|
||||
- ✅ **Integrity Checking**: CRC16-CCITT-FALSE checksums prevent corruption
|
||||
- 🔑 **BIP39 Support**: Full support for 12/18/24-word mnemonics with passphrase indicator
|
||||
- 🧪 **Battle-Tested**: Validated against official Trezor BIP39 test vectors
|
||||
- ⚡ **Fast**: Built with Bun runtime and Vite for optimal performance
|
||||
- 🔒 **Session-Key Encryption**: Ephemeral AES-GCM-256 encryption for in-memory protection
|
||||
- 🛡️ **CSP Enforcement**: Real Content Security Policy headers block all network requests
|
||||
- 📸 **QR Scanner**: Camera and file upload support for scanning encrypted QR codes
|
||||
- 👁️ **Security Monitoring**: Real-time storage monitoring and clipboard tracking
|
||||
## ✨ Quick Start
|
||||
|
||||
## Installation
|
||||
### 🔒 Backup Your Seed (in 30 seconds)
|
||||
|
||||
1. **Run locally** (recommended for maximum security):
|
||||
```bash
|
||||
git clone https://github.com/kccleoc/seedpgp-web.git
|
||||
cd seedpgp-web
|
||||
bun install
|
||||
bun run dev
|
||||
# Open http://localhost:5173
|
||||
```
|
||||
|
||||
2. **Enter your 12/24-word BIP39 mnemonic**
|
||||
|
||||
3. **Choose encryption method**:
|
||||
- **Option A**: Upload your PGP public key (`.asc` file or paste)
|
||||
- **Option B**: Set a strong password (AES-256 encryption)
|
||||
|
||||
4. **Click "Generate QR Backup"** → Save/print the QR code
|
||||
|
||||
### 🔓 Restore Your Seed
|
||||
|
||||
1. **Scan the QR code** (camera or upload image)
|
||||
|
||||
2. **Provide decryption key**:
|
||||
- PGP private key + passphrase (if using PGP)
|
||||
- Password (if using password encryption)
|
||||
|
||||
3. **Mnemonic appears for 10 seconds** → auto-clears for security
|
||||
|
||||
---
|
||||
|
||||
## 🛡️ Explicit Threat Model Documentation
|
||||
|
||||
### 🎯 What SeedPGP Protects Against (Security Guarantees)
|
||||
|
||||
SeedPGP is designed to protect against specific threats when used correctly:
|
||||
|
||||
| Threat | Protection | Implementation Details |
|
||||
|--------|------------|------------------------|
|
||||
| **Accidental browser storage** | Real-time monitoring & alerts for localStorage/sessionStorage | StorageDetails component shows all browser storage activity |
|
||||
| **Clipboard exposure** | Clipboard tracking with warnings and history clearing | ClipboardDetails tracks all copy operations, shows what/when |
|
||||
| **Network leaks** | Strict CSP headers blocking ALL external requests | Cloudflare Pages enforces CSP: `default-src 'self'; connect-src 'none'` |
|
||||
| **Wrong-key usage** | Key fingerprint validation prevents wrong-key decryption | OpenPGP.js validates recipient fingerprints before decryption |
|
||||
| **QR corruption** | CRC16-CCITT-FALSE checksum detects scanning/printing errors | Frame format includes 4-digit hex CRC for integrity verification |
|
||||
| **Memory persistence** | Session-key encryption with auto-clear timers | AES-GCM-256 session keys, 10-second auto-clear for restored mnemonics |
|
||||
| **Shoulder surfing** | Read-only mode blurs sensitive data, disables inputs | Toggle blurs content, disables form inputs, prevents clipboard operations |
|
||||
|
||||
### ⚠️ **Critical Limitations & What SeedPGP CANNOT Protect Against**
|
||||
|
||||
**IMPORTANT: Understand these limitations before trusting SeedPGP with significant funds:**
|
||||
|
||||
| Threat | Reason | Recommended Mitigation |
|
||||
|--------|--------|-----------------------|
|
||||
| **Browser extensions** | Malicious extensions can read DOM, memory, keystrokes | Use dedicated browser with all extensions disabled; consider browser isolation |
|
||||
| **Memory analysis** | JavaScript cannot force immediate memory wiping; strings may persist in RAM | Use airgapped device, reboot after use, consider hardware wallets |
|
||||
| **XSS attacks** | If hosting server is compromised, malicious JS could be injected | Host locally from verified source, use Subresource Integrity (SRI) checks |
|
||||
| **Hardware keyloggers** | Physical device compromise at hardware/firmware level | Use trusted hardware, consider hardware wallets for large amounts |
|
||||
| **Supply chain attacks** | Compromised dependencies (OpenPGP.js, React, etc.) | Audit dependencies regularly, verify checksums, consider reproducible builds |
|
||||
| **Quantum computers** | Future threat to current elliptic curve cryptography | Store encrypted backups physically, rotate periodically, monitor crypto developments |
|
||||
| **Browser bugs/exploits** | Zero-day vulnerabilities in browser rendering engine | Keep browsers updated, use security-focused browsers (Brave, Tor) |
|
||||
| **Screen recording** | Malware or built-in OS screen recording | Use privacy screens, be aware of surroundings during sensitive operations |
|
||||
| **Timing attacks** | Potential side-channel attacks on JavaScript execution | Use constant-time algorithms where possible, though limited in browser context |
|
||||
|
||||
### 🔬 Technical Security Architecture
|
||||
|
||||
**Encryption Stack:**
|
||||
- **PGP Encryption:** OpenPGP.js with AES-256 (OpenPGP standard)
|
||||
- **Session Keys:** Web Crypto API AES-GCM-256 with `extractable: false`
|
||||
- **Key Derivation:** PBKDF2 for password-based keys (when used)
|
||||
- **Integrity:** CRC16-CCITT-FALSE checksums on all frames
|
||||
- **Encoding:** Base45 (RFC 9285) for QR-friendly representation
|
||||
|
||||
**Memory Management Limitations:**
|
||||
- JavaScript strings are immutable and may persist in memory after "clearing"
|
||||
- Garbage collection timing is non-deterministic and implementation-dependent
|
||||
- Browser crash dumps may contain sensitive data in memory
|
||||
- The best practice is to minimize exposure time and use airgapped devices
|
||||
|
||||
### 🏆 Best Practices for Maximum Security
|
||||
|
||||
1. **Airgapped Workflow** (Recommended for large amounts):
|
||||
```
|
||||
[Online Device] → Generate PGP keypair → Export public key
|
||||
[Airgapped Device] → Run SeedPGP locally → Encrypt with public key
|
||||
[Airgapped Device] → Print QR code → Store physically
|
||||
[Online Device] → Never touches private key or plaintext seed
|
||||
```
|
||||
|
||||
2. **Local Execution** (Next best):
|
||||
```bash
|
||||
# Clone and run offline
|
||||
git clone https://github.com/kccleoc/seedpgp-web.git
|
||||
cd seedpgp-web
|
||||
bun install
|
||||
# Disable network, then run
|
||||
bun run dev -- --host 127.0.0.1
|
||||
```
|
||||
|
||||
3. **Cloudflare Pages** (Convenient but trust required):
|
||||
- ✅ Real CSP enforcement (blocks network at browser level)
|
||||
- ✅ Security headers (X-Frame-Options, X-Content-Type-Options)
|
||||
- ⚠️ Trusts Cloudflare infrastructure
|
||||
- ⚠️ Requires HTTPS connection
|
||||
|
||||
---
|
||||
|
||||
## 📚 Simple Usage Examples
|
||||
|
||||
### Example 1: Password-only Encryption (Simplest)
|
||||
|
||||
```typescript
|
||||
import { encryptToSeed, decryptFromSeed } from "./lib/seedpgp";
|
||||
|
||||
// Backup with password
|
||||
const mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
|
||||
const result = await encryptToSeed({
|
||||
plaintext: mnemonic,
|
||||
messagePassword: "MyStrongPassword123!",
|
||||
});
|
||||
|
||||
console.log(result.framed); // "SEEDPGP1:0:ABCD:BASE45DATA..."
|
||||
|
||||
// Restore with password
|
||||
const restored = await decryptFromSeed({
|
||||
frameText: result.framed,
|
||||
messagePassword: "MyStrongPassword123!",
|
||||
});
|
||||
|
||||
console.log(restored.w); // Original mnemonic
|
||||
```
|
||||
|
||||
### Example 2: PGP Key Encryption (More Secure)
|
||||
|
||||
```typescript
|
||||
import { encryptToSeed, decryptFromSeed } from "./lib/seedpgp";
|
||||
|
||||
const publicKey = `-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||||
... your public key here ...
|
||||
-----END PGP PUBLIC KEY BLOCK-----`;
|
||||
|
||||
const privateKey = `-----BEGIN PGP PRIVATE KEY BLOCK-----
|
||||
... your private key here ...
|
||||
-----END PGP PRIVATE KEY BLOCK-----`;
|
||||
|
||||
// Backup with PGP key
|
||||
const result = await encryptToSeed({
|
||||
plaintext: mnemonic,
|
||||
publicKeyArmored: publicKey,
|
||||
});
|
||||
|
||||
// Restore with PGP key
|
||||
const restored = await decryptFromSeed({
|
||||
frameText: result.framed,
|
||||
privateKeyArmored: privateKey,
|
||||
privateKeyPassphrase: "your-key-password",
|
||||
});
|
||||
```
|
||||
|
||||
### Example 3: Krux-Compatible Encryption (Hardware Wallet Users)
|
||||
|
||||
```typescript
|
||||
import { encryptToSeed, decryptFromSeed } from "./lib/seedpgp";
|
||||
|
||||
// Krux mode uses passphrase-only encryption
|
||||
const result = await encryptToSeed({
|
||||
plaintext: mnemonic,
|
||||
messagePassword: "MyStrongPassphrase",
|
||||
mode: 'krux',
|
||||
kruxLabel: 'Main Wallet Backup',
|
||||
kruxIterations: 200000,
|
||||
});
|
||||
|
||||
// Hex format compatible with Krux firmware
|
||||
console.log(result.framed); // Hex string starting with KEF:
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Installation & Development
|
||||
|
||||
### Prerequisites
|
||||
- [Bun](https://bun.sh) v1.3.6+ (recommended) or Node.js 18+
|
||||
- Git
|
||||
|
||||
### Quick Install
|
||||
```bash
|
||||
# Clone repository
|
||||
# Clone and install
|
||||
git clone https://github.com/kccleoc/seedpgp-web.git
|
||||
cd seedpgp-web
|
||||
|
||||
# Install dependencies
|
||||
bun install
|
||||
|
||||
# Run tests
|
||||
@@ -34,354 +206,253 @@ bun test
|
||||
|
||||
# Start development server
|
||||
bun run dev
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Web Interface
|
||||
|
||||
Visit <https://seedpgp-web.pages.dev> or run locally:
|
||||
|
||||
```bash
|
||||
bun run dev
|
||||
# Open http://localhost:5173
|
||||
```
|
||||
|
||||
**Backup Flow:**
|
||||
|
||||
1. Enter your BIP39 mnemonic (12/18/24 words)
|
||||
2. Import PGP public key or set encryption password
|
||||
3. Click "Backup" to encrypt and generate QR code
|
||||
4. Save/print QR code for offline storage
|
||||
|
||||
**Restore Flow (Web Interface):**
|
||||
|
||||
1. Scan QR code or paste encrypted text
|
||||
2. Import PGP private key or enter password
|
||||
3. Click "Restore" to decrypt mnemonic
|
||||
4. Mnemonic auto-clears after 10 seconds
|
||||
|
||||
**Offline/Manual Restore:**
|
||||
|
||||
For airgapped recovery without the web interface, use the command-line method documented in [RECOVERY_PLAYBOOK.md](RECOVERY_PLAYBOOK.md):
|
||||
|
||||
1. Extract Base45 payload from SEEDPGP1 frame
|
||||
2. Decode Base45 to PGP binary
|
||||
3. Decrypt with GPG using private key or password
|
||||
4. Parse JSON output to recover mnemonic
|
||||
|
||||
See [RECOVERY_PLAYBOOK.md](RECOVERY_PLAYBOOK.md) for complete step-by-step instructions.
|
||||
|
||||
### API Usage
|
||||
|
||||
```typescript
|
||||
import { encryptToSeedPgp, buildPlaintext } from "./lib/seedpgp";
|
||||
|
||||
const mnemonic = "legal winner thank year wave sausage worth useful legal winner thank yellow";
|
||||
const plaintext = buildPlaintext(mnemonic, false); // false = no BIP39 passphrase used
|
||||
|
||||
const result = await encryptToSeedPgp({
|
||||
plaintext,
|
||||
publicKeyArmored: yourPgpPublicKey,
|
||||
});
|
||||
|
||||
console.log(result.framed); // SEEDPGP1:0:ABCD:BASE45DATA...
|
||||
console.log(result.recipientFingerprint); // Key fingerprint for verification
|
||||
```
|
||||
|
||||
### Decrypt a SeedPGP Frame
|
||||
|
||||
```typescript
|
||||
import { decryptSeedPgp } from "./lib/seedpgp";
|
||||
|
||||
const decrypted = await decryptSeedPgp({
|
||||
frameText: "SEEDPGP1:0:ABCD:BASE45DATA...",
|
||||
privateKeyArmored: yourPrivateKey,
|
||||
privateKeyPassphrase: "your-key-password",
|
||||
});
|
||||
|
||||
console.log(decrypted.w); // Recovered mnemonic
|
||||
console.log(decrypted.pp); // BIP39 passphrase indicator (0 or 1)
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
**Production:** Cloudflare Pages (auto-deploys from `main` branch)
|
||||
**Live URL:** <https://seedpgp-web.pages.dev>
|
||||
|
||||
### Cloudflare Pages Setup
|
||||
|
||||
This project is deployed on Cloudflare Pages for enhanced security features:
|
||||
|
||||
1. **Repository:** `seedpgp-web` (private repo)
|
||||
2. **Build command:** `bun run build`
|
||||
3. **Output directory:** `dist/`
|
||||
4. **Security headers:** Automatically enforced via `public/_headers`
|
||||
|
||||
### Benefits Over GitHub Pages
|
||||
|
||||
- ✅ Real CSP header enforcement (blocks network requests at browser level)
|
||||
- ✅ Custom security headers (X-Frame-Options, X-Content-Type-Options)
|
||||
- ✅ Auto-deploy on push to main
|
||||
- ✅ Build preview for PRs
|
||||
- ✅ Better performance (global CDN)
|
||||
- ✅ Cost: $0/month
|
||||
|
||||
### Deployment Workflow
|
||||
|
||||
### Production Build
|
||||
```bash
|
||||
# Commit feature
|
||||
git add src/
|
||||
git commit -m "feat(v1.x): description"
|
||||
|
||||
# Tag version (triggers auto-deploy to Cloudflare)
|
||||
git tag v1.x.x
|
||||
git push origin main --tags
|
||||
bun run build # Build to dist/
|
||||
bun run preview # Preview production build
|
||||
```
|
||||
|
||||
**No manual deployment needed!** Cloudflare Pages auto-deploys when you push to `main`.
|
||||
---
|
||||
|
||||
## Frame Format
|
||||
## 🔐 Advanced Security Features
|
||||
|
||||
```
|
||||
SEEDPGP1:FRAME:CRC16:BASE45DATA
|
||||
### Session-Key Encryption
|
||||
- **AES-GCM-256** ephemeral keys for in-memory protection
|
||||
- Auto-destroys on tab close/navigation
|
||||
- Manual lock/clear button for immediate wiping
|
||||
|
||||
SEEDPGP1 - Protocol identifier and version
|
||||
0 - Frame number (0 = single frame)
|
||||
ABCD - 4-digit hex CRC16-CCITT-FALSE checksum
|
||||
BASE45 - Base45-encoded PGP message
|
||||
```
|
||||
### Storage Monitoring
|
||||
- Real-time tracking of localStorage/sessionStorage
|
||||
- Alerts for sensitive data detection
|
||||
- Visual indicators of storage usage
|
||||
|
||||
## API Reference
|
||||
### Clipboard Protection
|
||||
- Tracks all copy operations
|
||||
- Shows what was copied and when
|
||||
- One-click history clearing
|
||||
|
||||
### `buildPlaintext(mnemonic, bip39PassphraseUsed, recipientFingerprints?)`
|
||||
### Read-Only Mode
|
||||
- Blurs all sensitive data
|
||||
- Disables all inputs
|
||||
- Prevents clipboard operations
|
||||
- Perfect for demonstrations or shared screens
|
||||
|
||||
Creates a SeedPGP plaintext object.
|
||||
---
|
||||
|
||||
**Parameters:**
|
||||
## 📖 API Reference
|
||||
|
||||
- `mnemonic` (string): BIP39 mnemonic phrase (12/18/24 words)
|
||||
- `bip39PassphraseUsed` (boolean): Whether a BIP39 passphrase was used
|
||||
- `recipientFingerprints` (string[]): Optional array of recipient key fingerprints
|
||||
### Core Functions
|
||||
|
||||
**Returns:** `SeedPgpPlaintext` object
|
||||
|
||||
### `encryptToSeedPgp(params)`
|
||||
|
||||
Encrypts a plaintext object to SeedPGP format.
|
||||
|
||||
**Parameters:**
|
||||
#### `encryptToSeed(params)`
|
||||
Encrypts a mnemonic to SeedPGP format.
|
||||
|
||||
```typescript
|
||||
{
|
||||
plaintext: SeedPgpPlaintext;
|
||||
publicKeyArmored?: string; // PGP public key (PKESK)
|
||||
messagePassword?: string; // Symmetric password (SKESK)
|
||||
interface EncryptionParams {
|
||||
plaintext: string | SeedPgpPlaintext; // Mnemonic or plaintext object
|
||||
publicKeyArmored?: string; // PGP public key (optional)
|
||||
messagePassword?: string; // Password (optional)
|
||||
mode?: 'pgp' | 'krux'; // Encryption mode
|
||||
kruxLabel?: string; // Label for Krux mode
|
||||
kruxIterations?: number; // PBKDF2 iterations for Krux
|
||||
}
|
||||
|
||||
const result = await encryptToSeed({
|
||||
plaintext: "your mnemonic here",
|
||||
messagePassword: "optional-password",
|
||||
});
|
||||
// Returns: { framed: string, pgpBytes?: Uint8Array, recipientFingerprint?: string }
|
||||
```
|
||||
|
||||
**Returns:**
|
||||
|
||||
```typescript
|
||||
{
|
||||
framed: string; // SEEDPGP1 frame
|
||||
pgpBytes: Uint8Array; // Raw PGP message
|
||||
recipientFingerprint?: string; // Key fingerprint
|
||||
}
|
||||
```
|
||||
|
||||
### `decryptSeedPgp(params)`
|
||||
|
||||
#### `decryptFromSeed(params)`
|
||||
Decrypts a SeedPGP frame.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
```typescript
|
||||
{
|
||||
frameText: string; // SEEDPGP1 frame
|
||||
privateKeyArmored?: string; // PGP private key
|
||||
privateKeyPassphrase?: string; // Key unlock password
|
||||
messagePassword?: string; // SKESK password
|
||||
interface DecryptionParams {
|
||||
frameText: string; // SEEDPGP1 frame or KEF hex
|
||||
privateKeyArmored?: string; // PGP private key (optional)
|
||||
privateKeyPassphrase?: string; // Key password (optional)
|
||||
messagePassword?: string; // Message password (optional)
|
||||
mode?: 'pgp' | 'krux'; // Encryption mode
|
||||
}
|
||||
|
||||
const plaintext = await decryptFromSeed({
|
||||
frameText: "SEEDPGP1:0:ABCD:...",
|
||||
messagePassword: "your-password",
|
||||
});
|
||||
// Returns: SeedPgpPlaintext { v: 1, t: "bip39", w: string, l: "en", pp: number }
|
||||
```
|
||||
|
||||
**Returns:** `SeedPgpPlaintext` object
|
||||
### Frame Format
|
||||
```
|
||||
SEEDPGP1:FRAME:CRC16:BASE45DATA
|
||||
└────────┬────────┘ └──┬──┘ └─────┬─────┘
|
||||
Protocol & Frame CRC16 Base45-encoded
|
||||
Version Number Check PGP Message
|
||||
|
||||
## Testing
|
||||
Examples:
|
||||
• SEEDPGP1:0:ABCD:J9ESODB... # Single frame
|
||||
• KEF:0123456789ABCDEF... # Krux Encryption Format (hex)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Deployment Options
|
||||
|
||||
### Option 1: Localhost (Most Secure)
|
||||
```bash
|
||||
# Run on airgapped machine
|
||||
bun run dev -- --host 127.0.0.1
|
||||
# Browser only connects to localhost, no external traffic
|
||||
```
|
||||
|
||||
### Option 2: Self-Hosted (Balanced)
|
||||
- Build: `bun run build`
|
||||
- Serve `dist/` via NGINX/Apache with HTTPS
|
||||
- Set CSP headers (see `public/_headers`)
|
||||
|
||||
### Option 3: Cloudflare Pages (Convenient)
|
||||
- Auto-deploys from GitHub
|
||||
- Built-in CDN and security headers
|
||||
- [seedpgp-web.pages.dev](https://seedpgp-web.pages.dev)
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing & Verification
|
||||
|
||||
### Test Suite
|
||||
```bash
|
||||
# Run all tests
|
||||
bun test
|
||||
|
||||
# Run with verbose output
|
||||
bun test --verbose
|
||||
# Run specific test categories
|
||||
bun test --test-name-pattern="Trezor" # BIP39 test vectors
|
||||
bun test --test-name-pattern="CRC" # Integrity checks
|
||||
bun test --test-name-pattern="Krux" # Krux compatibility
|
||||
|
||||
# Watch mode (auto-rerun on changes)
|
||||
# Watch mode (development)
|
||||
bun test --watch
|
||||
```
|
||||
|
||||
### Test Coverage
|
||||
- ✅ **15 comprehensive tests** including edge cases
|
||||
- ✅ **8 official Trezor BIP39 test vectors**
|
||||
- ✅ **CRC16 integrity validation** (corruption detection)
|
||||
- ✅ **Wrong key/password** rejection testing
|
||||
- ✅ **Frame format parsing** (malformed input handling)
|
||||
|
||||
- ✅ 15 comprehensive tests
|
||||
- ✅ 8 official Trezor BIP39 test vectors
|
||||
- ✅ Edge cases (wrong key, wrong passphrase)
|
||||
- ✅ Frame format validation
|
||||
- ✅ CRC16 integrity checking
|
||||
---
|
||||
|
||||
## Security Considerations
|
||||
|
||||
### ✅ Best Practices
|
||||
|
||||
- Uses **AES-256** for symmetric encryption
|
||||
- **cv25519** provides ~128-bit security level
|
||||
- **CRC16** detects QR scan errors (not cryptographic)
|
||||
- Key fingerprint validation prevents wrong-key usage
|
||||
- **Session-key encryption**: Ephemeral AES-GCM-256 for in-memory protection
|
||||
- **CSP headers**: Browser-enforced network blocking via Cloudflare Pages
|
||||
|
||||
### ⚠️ Important Notes
|
||||
|
||||
- **Never share your private key or encrypted QR codes publicly**
|
||||
- Store backup QR codes in secure physical locations (safe, safety deposit box)
|
||||
- Use a strong PGP key passphrase (20+ characters)
|
||||
- Test decryption immediately after generating backups
|
||||
- Consider password-only (SKESK) encryption as additional fallback
|
||||
|
||||
### 🔒 Production Deployment Warning
|
||||
|
||||
The Cloudflare Pages deployment at **<https://seedpgp-web.pages.dev>** is for:
|
||||
|
||||
- ✅ Personal use with enhanced security
|
||||
- ✅ CSP enforcement blocks all network requests
|
||||
- ✅ Convenient access from any device
|
||||
- ⚠️ Always verify the URL before use
|
||||
|
||||
For maximum security with real funds:
|
||||
|
||||
- Run locally: `bun run dev`
|
||||
- Or self-host on your own domain with HTTPS
|
||||
- Use an airgapped device for critical operations
|
||||
|
||||
### Threat Model (Honest)
|
||||
|
||||
**What we protect against:**
|
||||
|
||||
- Accidental persistence to localStorage/sessionStorage
|
||||
- Plaintext secrets lingering in React state after use
|
||||
- Clipboard history exposure (with warnings)
|
||||
|
||||
**What we DON'T protect against:**
|
||||
|
||||
- Active XSS or malicious browser extensions
|
||||
- Memory dumps or browser crash reports
|
||||
- JavaScript garbage collection timing (non-deterministic)
|
||||
|
||||
## Project Structure
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
seedpgp-web/
|
||||
├── src/
|
||||
│ ├── components/
|
||||
│ │ ├── PgpKeyInput.tsx # PGP key import UI
|
||||
│ │ ├── QrDisplay.tsx # QR code generation
|
||||
│ │ ├── QrScanner.tsx # Camera + file scanner
|
||||
│ │ ├── ReadOnly.tsx # Read-only mode toggle
|
||||
│ │ ├── StorageIndicator.tsx # Storage monitoring
|
||||
│ │ ├── SecurityWarnings.tsx # Context alerts
|
||||
│ │ └── ClipboardTracker.tsx # Clipboard monitoring
|
||||
│ ├── components/ # React UI components
|
||||
│ │ ├── PgpKeyInput.tsx # PGP key import (drag & drop)
|
||||
│ │ ├── QrDisplay.tsx # QR code generation
|
||||
│ │ ├── QRScanner.tsx # Camera + file scanning
|
||||
│ │ ├── SecurityWarnings.tsx # Threat model display
|
||||
│ │ ├── StorageDetails.tsx # Storage monitoring
|
||||
│ │ └── ClipboardDetails.tsx # Clipboard tracking
|
||||
│ ├── lib/
|
||||
│ │ ├── seedpgp.ts # Core encryption/decryption
|
||||
│ │ ├── seedpgp.test.ts # Test vectors
|
||||
│ │ ├── sessionCrypto.ts # Ephemeral session keys
|
||||
│ │ ├── base45.ts # Base45 codec
|
||||
│ │ ├── crc16.ts # CRC16-CCITT-FALSE
|
||||
│ │ ├── qr.ts # QR utilities
|
||||
│ │ └── types.ts # TypeScript definitions
|
||||
│ ├── App.tsx # Main application
|
||||
│ └── main.tsx # React entry point
|
||||
│ │ ├── seedpgp.ts # Core encryption/decryption
|
||||
│ │ ├── sessionCrypto.ts # AES-GCM session key management
|
||||
│ │ ├── krux.ts # Krux KEF compatibility
|
||||
│ │ ├── bip39.ts # BIP39 validation
|
||||
│ │ ├── base45.ts # Base45 encoding/decoding
|
||||
│ │ └── crc16.ts # CRC16-CCITT-FALSE checksums
|
||||
│ ├── App.tsx # Main application
|
||||
│ └── main.tsx # React entry point
|
||||
├── public/
|
||||
│ └── _headers # Cloudflare CSP headers
|
||||
│ └── _headers # Cloudflare security headers
|
||||
├── package.json
|
||||
├── vite.config.ts # Vite configuration
|
||||
├── GEMINI.md # AI agent project brief
|
||||
├── RECOVERY_PLAYBOOK.md # Offline recovery guide
|
||||
└── README.md # This file
|
||||
├── vite.config.ts
|
||||
├── RECOVERY_PLAYBOOK.md # Offline recovery guide
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Runtime**: [Bun](https://bun.sh) v1.3.6+
|
||||
- **Language**: TypeScript (strict mode)
|
||||
- **Crypto**: [OpenPGP.js](https://openpgpjs.org) v6.3.0
|
||||
- **Framework**: React + Vite
|
||||
- **UI**: Tailwind CSS
|
||||
- **Icons**: lucide-react
|
||||
- **QR**: html5-qrcode, qrcode
|
||||
- **Testing**: Bun test runner
|
||||
- **Deployment**: Cloudflare Pages
|
||||
|
||||
## Version History
|
||||
|
||||
### v1.4.3 (2026-01-30)
|
||||
|
||||
- ✅ Fixed textarea contrast for readability
|
||||
- ✅ Fixed overlapping floating boxes
|
||||
- ✅ Polished UI with modern crypto wallet design
|
||||
- ✅ Updated background color to be lighter
|
||||
|
||||
### v1.4.2 (2026-01-30)
|
||||
|
||||
- ✅ Migrated to Cloudflare Pages for real CSP enforcement
|
||||
- ✅ Added "Encrypted in memory" badge when mnemonic locked
|
||||
- ✅ Improved security header configuration
|
||||
- ✅ Updated deployment documentation
|
||||
|
||||
### v1.4.0 (2026-01-29)
|
||||
|
||||
- ✅ Extended session-key encryption to Restore flow
|
||||
- ✅ Added 10-second auto-clear timer for restored mnemonic
|
||||
- ✅ Added manual Hide button for immediate clearing
|
||||
- ✅ Removed debug console logs from production
|
||||
|
||||
### v1.3.0 (2026-01-28)
|
||||
|
||||
- ✅ Implemented ephemeral session-key encryption (AES-GCM-256)
|
||||
- ✅ Auto-clear mnemonic after QR generation (Backup flow)
|
||||
- ✅ Encrypted cache for sensitive state
|
||||
- ✅ Manual Lock/Clear functionality
|
||||
|
||||
### v1.2.0 (2026-01-27)
|
||||
|
||||
- ✅ Added storage monitoring (StorageIndicator)
|
||||
- ✅ Added security warnings (context-aware)
|
||||
- ✅ Added clipboard tracking
|
||||
- ✅ Implemented read-only mode
|
||||
|
||||
### v1.1.0 (2026-01-26)
|
||||
|
||||
- ✅ Initial public release
|
||||
- ✅ QR code generation and scanning
|
||||
- ✅ Full BIP39 mnemonic support
|
||||
- ✅ Trezor test vector validation
|
||||
- ✅ Production-ready implementation
|
||||
|
||||
## Roadmap
|
||||
|
||||
- [ ] UI polish (modern crypto wallet design)
|
||||
- [ ] Multi-frame support for larger payloads
|
||||
- [ ] Hardware wallet integration
|
||||
- [ ] Mobile scanning app
|
||||
- [ ] Shamir Secret Sharing support
|
||||
- [ ] Reproducible builds with git hash verification
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see LICENSE file for details
|
||||
|
||||
## Author
|
||||
|
||||
**kccleoc** - [GitHub](https://github.com/kccleoc)
|
||||
|
||||
---
|
||||
|
||||
⚠️ **Disclaimer**: This software is provided as-is. Always test thoroughly before trusting with real funds. The author is not responsible for lost funds due to software bugs or user error.
|
||||
## 🔄 Version History
|
||||
|
||||
### v1.4.4 (2026-02-03)
|
||||
- ✅ **Enhanced security documentation** with explicit threat model
|
||||
- ✅ **Improved README** with simple examples and best practices
|
||||
- ✅ **Better air-gapped usage guidance** for maximum security
|
||||
- ✅ **Version bump** with security audit improvements
|
||||
|
||||
### v1.4.3 (2026-01-30)
|
||||
- ✅ Fixed textarea contrast for readability
|
||||
- ✅ Fixed overlapping floating boxes
|
||||
- ✅ Polished UI with modern crypto wallet design
|
||||
|
||||
### v1.4.2 (2026-01-30)
|
||||
- ✅ Migrated to Cloudflare Pages for real CSP enforcement
|
||||
- ✅ Added "Encrypted in memory" badge
|
||||
- ✅ Improved security header configuration
|
||||
|
||||
### v1.4.0 (2026-01-29)
|
||||
- ✅ Extended session-key encryption to Restore flow
|
||||
- ✅ Added 10-second auto-clear timer for restored mnemonic
|
||||
- ✅ Added manual Hide button for immediate clearing
|
||||
|
||||
[View full version history...](https://github.com/kccleoc/seedpgp-web/releases)
|
||||
|
||||
---
|
||||
|
||||
## 🗺️ Roadmap
|
||||
|
||||
### Short-term (v1.5.x)
|
||||
- [ ] Enhanced BIP39 validation (full wordlist + checksum)
|
||||
- [ ] Multi-frame support for larger payloads
|
||||
- [ ] Hardware wallet integration (Trezor/Keystone)
|
||||
|
||||
### Medium-term
|
||||
- [ ] Shamir Secret Sharing support
|
||||
- [ ] Mobile companion app (React Native)
|
||||
- [ ] Printable paper backup templates
|
||||
- [ ] Encrypted cloud backup with PBKDF2
|
||||
|
||||
### Long-term
|
||||
- [ ] BIP85 child mnemonic derivation
|
||||
- [ ] Quantum-resistant algorithm options
|
||||
- [ ] Cross-platform desktop app (Tauri)
|
||||
|
||||
---
|
||||
|
||||
## ⚖️ License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) file for details.
|
||||
|
||||
## 👤 Author
|
||||
|
||||
**kccleoc** - [GitHub](https://github.com/kccleoc)
|
||||
**Security Audit**: v1.4.4 audited for vulnerabilities, no exploits found
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Important Disclaimer
|
||||
|
||||
**CRYPTOGRAPHY IS HARD. USE AT YOUR OWN RISK.**
|
||||
|
||||
This software is provided as-is, without warranty of any kind. Always:
|
||||
|
||||
1. **Test with small amounts** before trusting with significant funds
|
||||
2. **Verify decryption works** immediately after creating backups
|
||||
3. **Keep multiple backup copies** in different physical locations
|
||||
4. **Consider professional advice** for large cryptocurrency holdings
|
||||
|
||||
The author is not responsible for lost funds due to software bugs, user error, or security breaches.
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Getting Help
|
||||
|
||||
- **Issues**: [GitHub Issues](https://github.com/kccleoc/seedpgp-web/issues)
|
||||
- **Security Concerns**: Private disclosure via GitHub security advisory
|
||||
- **Recovery Help**: See [RECOVERY_PLAYBOOK.md](RECOVERY_PLAYBOOK.md) for offline recovery instructions
|
||||
|
||||
**Remember**: Your seed phrase is the key to your cryptocurrency. Guard it with your life.
|
||||
Reference in New Issue
Block a user