No description
  • HTML 57%
  • JavaScript 40.6%
  • Shell 2.4%
Find a file
JP.Böhm c1c6c0f21f fix: clear errors in publish-release.sh instead of a JSON crash
HTTP 409 (release for the tag exists, e.g. an earlier draft), 401/403
(token permission) and other codes now print a plain message.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 00:00:33 +01:00
cli feat: format v2 with Argon2id in the CLI, release 1.3.0 2026-11-01 23:33:42 +01:00
dist feat: format v2 with Argon2id in the CLI, release 1.3.0 2026-11-01 23:33:42 +01:00
docs feat: format v2 with Argon2id in the CLI, release 1.3.0 2026-11-01 23:33:42 +01:00
scripts fix: clear errors in publish-release.sh instead of a JSON crash 2026-11-02 00:00:33 +01:00
tests feat: format v2 with Argon2id in the CLI, release 1.3.0 2026-11-01 23:33:42 +01:00
tool feat: format v2 with Argon2id in the CLI, release 1.3.0 2026-11-01 23:33:42 +01:00
.gitignore build: release packaging and Forgejo draft publishing 2026-11-01 21:46:26 +01:00
CHANGELOG.md feat: format v2 with Argon2id in the CLI, release 1.3.0 2026-11-01 23:33:42 +01:00
README.md feat: format v2 with Argon2id in the CLI, release 1.3.0 2026-11-01 23:33:42 +01:00
test-vault.uvf feat: implement decrypt command in CLI for vault decryption 2026-05-06 01:25:11 +02:00

UVF — Universal Vault Format

Version: 1.2
Getestet: Node.js 26 · Chrome 124 · Firefox 125 · Safari 17 (Node 26 und Chromium via Playwright zuletzt am 2026-11-01)
CLI benötigt: Node.js 26 oder neuer (die HTML-Tools brauchen kein Node)


Was ist UVF?

UVF ist ein portables, browsernatives Verschlüsselungssystem. Dateien und ganze Ordnerstrukturen werden in einem einzigen binären Container (.uvf) gespeichert, verschlüsselt mit AES-256-GCM. Der Schlüssel wird aus einem Passwort via PBKDF2-SHA-256 abgeleitet. Verschlüsselung und Entschlüsselung laufen vollständig im Browser — keine Installation, keine Adminrechte, kein Server.

USB-Stick
├── decrypt.html          ← Vault öffnen & entschlüsseln (self-contained, ~70 KB)
├── uvf-creator.html      ← Vault erstellen & verschlüsseln (self-contained, ~64 KB)
├── vault.uvf             ← verschlüsselter Container
└── LIESMICH.txt         ← Anleitung für Endnutzer (Klartext, mit SHA-256-Prüfsummen)

Für Endnutzer: Den Inhalt des Ordners dist/ einfach auf den USB-Stick kopieren. Er enthält genau die beiden HTML-Dateien und die LIESMICH.txt. Eine CLI oder Node.js braucht man dafür nicht.

Beide HTML-Dateien sind vollständig eigenständig und verlinken sich gegenseitig über einen Toggle im Header — sofern sie im gleichen Verzeichnis liegen.


Kerndesign-Entscheidungen

Anforderung Entscheidung
Keine Installation Zwei selbst­ständige HTML-Dateien, null externe Dependencies
Kein Server Alle Crypto-Operationen via WebCrypto API
OS-unabhängig Windows, macOS, Linux, ChromeOS
Keine Adminrechte FileReader / File System Access API, kein Schreibzugriff nötig
Ordner-Support Drag & Drop mit FileSystem Entry API; Pfade im Metadaten-Block
ZIP-Export Pure-JS ZipBuilder (stored, keine Kompression)
Toggle zwischen Apps Sibling-Erkennung via sandboxed iframe, kein Netzwerk

Browser-Kompatibilität

Browser Min-Version Status
Chrome / Chromium 90+ ✓ Empfohlen
Firefox 88+ ✓ Vollständig
Safari 14+ ✓ Vollständig
Edge (Chromium) 90+ ✓ Vollständig
IE / Legacy Edge — ✗ Nicht unterstützt

Schnellstart

Vault öffnen (Browser)

  1. USB-Stick einstecken.
  2. decrypt.html im Browser öffnen (Doppelklick oder Datei → Öffnen).
  3. Vault-Datei per Drag-and-Drop oder Klick auswählen.
  4. Passwort eingeben → Entsperren.
  5. Inhalt durchsuchen — einzelne Dateien herunterladen oder Ordner bzw. alles als ZIP.

Vault erstellen (Browser)

  1. uvf-creator.html im Browser öffnen.
  2. Dateien oder Ordner per Drag-and-Drop oder Klick hinzufügen (inkl. Unterordner-Rekursion).
  3. Vault-Name und Schutzstufe wählen.
  4. Passwort (mindestens 15 Zeichen, am besten 4–5 zufällige Wörter) eingeben und wiederholen.
  5. Vault verschlüsseln → .uvf-Datei herunterladen.

Die Oberfläche gibt es auf Deutsch und Englisch (Umschalter DE | EN).

Kein Node.js nötig. Alles läuft im Browser, nichts verlässt das Gerät.

Vault erstellen (CLI, Node.js 26+)

Das Passwort wird interaktiv abgefragt (ohne Echo) oder per --password-file / UVF_PASSWORD bereitgestellt. --password als Argument gibt es seit 1.2 nicht mehr (es leakte in Shell-History und ps). Beim Erstellen sind mindestens 15 Zeichen erforderlich.

# Einzelnen Ordner verschlüsseln (Passwort wird interaktiv abgefragt)
node cli/uvf-cli.js create --output vault.uvf ./MeinProjekt

# Mehrere Pfade mischen (Dateien + Verzeichnisse), Passwort aus Umgebungsvariable
UVF_PASSWORD="mein-langes-passwort" node cli/uvf-cli.js create --output vault.uvf Fotos/ Dokumente/ config.json

# Ohne Verzeichnisstruktur (alle Dateien auf Root-Ebene)
node cli/uvf-cli.js create --output vault.uvf --flatten ./src

# Dateimuster ausschließen, Passwort aus Datei
node cli/uvf-cli.js create --output vault.uvf --password-file pw.txt --exclude "*.log" --exclude "*.tmp" ./Projekt

# Testvault mit Beispiel-Ordnerstruktur erzeugen (Passwort: uvf-testvault-1234)
node cli/uvf-cli.js test

Vault inspizieren (CLI)

# Header-Infos ohne Entschlüsselung
node cli/uvf-cli.js inspect vault.uvf

# Vollständige Metadaten + Verzeichnisbaum
node cli/uvf-cli.js inspect vault.uvf --password-file pw.txt

Sicherheitszusammenfassung

Parameter Wert Begründung
Cipher AES-256-GCM Authenticated Encryption, WebCrypto-nativ
KDF PBKDF2-SHA-256 (Format 1, Standard) WebCrypto-nativ, öffnet in allen Werkzeugen
KDF Format 2 Argon2id, 64 MiB (nur CLI, create --format 2) speicherhart gegen GPU-Angriffe; ganzer Header authentifiziert; Browser öffnen v2 noch nicht (ADR 0003)
KDF-Iterationen 600.000 (default), 100.000 – 10.000.000 OWASP-Empfehlung; Obergrenze gegen KDF-DoS durch fremde Vaults (ADR 0001)
Passwort-Minimum 15 Zeichen (create) Erzwungen in Browser und CLI; NIST SP 800-63B-4 (ADR 0002)
Integrität GCM-Auth-Tag pro Block Tampering erkennbar vor Entschlüsselung
Metadaten-Validierung Fail-closed vor Verwendung Schutz gegen böswillige/inkonsistente Vaults (CLI decrypt + inspect, Browser)
Path-Traversal / Zip-Slip Blockiert CLI lehnt Ausbrüche ab & überschreibt nie; Browser bereinigt ZIP-Pfade (/ und \)
Terminal-Ausgabe (CLI) Bereinigt Steuerzeichen aus Vault-Strings werden ersetzt (kein ANSI-Escape-Injection)
Per-File-Keys 32 Byte, CSPRNG Schlüssel-Isolation zwischen Dateien
Plaintext Nur RAM, best-effort genullt Uint8Array.fill(0) für Chunks, Datei-Puffer und ZIP-Kopien
CLI-Passwort Nie als Argument nötig Interaktiv / --password-file / UVF_PASSWORD
Browser-Storage Keiner Kein localStorage/sessionStorage/IDB/Cookie
Netzwerk Gesperrt CSP default-src 'none' + connect-src 'none'

Architektur (Text-Diagramm)

USB-Stick
┌─────────────────────────────────────────────────────────────────┐
│  uvf-creator.html (SPA)              vault.uvf (binär)           │
│                                                                 │
│  ┌─────────────────────┐  erzeugt  ┌─────────────────────┐     │
│  │ VaultBuilder        │ ────────► │ Header  (128 Byte)  │     │
│  │ CryptoEngine        │           ├─────────────────────┤     │
│  │ FileCollector       │           │ Metadaten-Block     │     │
│  └─────────────────────┘           │ (AES-256-GCM)       │     │
│                                    ├─────────────────────┤     │
│  Passwort + Dateien                │ Datenblock [0] …    │     │
│     │ PBKDF2-SHA-256               └─────────────────────┘     │
│     ▼                                          │                │
│  Master Key → Metadaten-Verschlüsselung         │                │
│  Per-File-Keys → Chunk-Verschlüsselung           │                │
│     ▼                                          │                │
│  Blob → vault.uvf Download                      ▼                │
│                                                                 │
│  decrypt.html (SPA)                                             │
│                                                                 │
│  ┌─────────────────────┐   lädt    ┌─────────────────────┐     │
│  │ UVFParser           │ ────────► │ vault.uvf           │     │
│  │ CryptoEngine        │           └─────────────────────┘     │
│  │ VaultSession        │                                        │
│  │ ChunkDecryptor      │  Passwort → PBKDF2 → Master Key        │
│  │ DownloadManager     │  Master Key → Metadaten entschlüsseln  │
│  │ ZipBuilder          │  Per-File-Key → Chunks entschlüsseln   │
│  └─────────────────────┘                                        │
│     ▼                                                           │
│  Blob-URL → Download (Plaintext sofort genullt)                 │
│  oder ZipBuilder → ZIP-Download                                 │
└─────────────────────────────────────────────────────────────────┘

Dokumentations-Index

Dokument Inhalt
README.md Diese Datei
docs/README.md Einstieg und Inhaltsverzeichnis der Doku
docs/UVF_SPEC.md Binäres Containerformat v1 und v2 (§10)
docs/CRYPTO_DESIGN.md Kryptografisches Design
docs/BROWSER_APP_DECRYPT.md SPA-Architektur decrypt.html
docs/CREATOR_APP.md SPA-Architektur uvf-creator.html
docs/THREAT_MODEL.md Bedrohungsmodell und Gegenmaßnahmen
docs/IMPLEMENTATION_GUIDE.md Implementierungsplan mit Pseudocode
docs/CLI.md CLI-Referenz (create, decrypt, inspect, test)
docs/playbook.md Priorisierte Arbeitsliste (was als Nächstes, wie verifiziert)
docs/technical-debt.md Register der technischen Schulden
docs/decisions/ Architecture Decision Records (ADR)
docs/diagrams/ Diagramme (Mermaid): Architektur, Abläufe, Sequenzen
docs/GLOSSAR.md Anhang: Fachbegriffe kurz erklärt
tests/README.md Tests (node --test tests/) und Testpasswörter
CHANGELOG.md Änderungen je Version

Grenzen & Einschränkungen

Browser-App (uvf-creator.html + decrypt.html)

Grenze Wert Ursache
Praktische Vault-Gesamtgröße ≤ ~500 MB empfohlen Browser-Tab-RAM; Warnung ab 200 MB
Einzeldatei-Größe ≤ verfügbarer RAM Chunk wird vollständig in JS-RAM gehalten
ZIP-Export (Entschlüsseln) ≤ ~500 MB Alle entschlüsselten Daten liegen gleichzeitig im RAM
Download-Link (Creator) 5 Minuten Blob-URL wird nach Ablauf widerrufen
Vault-Name 255 Zeichen maxlength-Attribut im Formular
Passwort-Mindestlänge 15 Zeichen Validierung im Creator und in der CLI erzwungen
Chunk-Größe 64 KiB – 16 MiB, Zweierpotenz AES-GCM / Spec-Vorgabe
PBKDF2-Iterationen 100 000 – 10 000 000 Decoder verweigert Vaults außerhalb des Bereichs
Dateinamen-Kodierung UTF-8 ZIP-Builder-Flag 0x0800

RAM-Faustregel (Browser): Vault-Erstellung benötigt ca. 2–3× die unkomprimierte Datenmenge als freien RAM. Beim ZIP-Export werden alle entschlüsselten Dateien gleichzeitig gehalten — für große Vaults einzelne Dateien bevorzugen.

CLI (cli/uvf-cli.js)

Grenze Wert Ursache
Einzeldatei- und Vault-Größe Kein festes Limit Chunkweises Lesen und Schreiben (Streaming); getestet mit 2,2 GiB
Arbeitsspeicher ca. 150–250 MB, unabhängig von der Vault-Größe Gemessen mit 2,2 GiB und 16-MiB-Chunks: create ~225 MB, decrypt ~166 MB
Plattenplatz beim create ca. 2× Vault-Größe, kurzzeitig Datenblöcke gehen erst in eine temporäre Datei neben dem Ziel
Chunk-Größe 64 KiB – 16 MiB, Zweierpotenz Identische Spec-Vorgabe
PBKDF2-Iterationen 600 000 default, 100 000 – 10 000 000 Werte außerhalb werden abgelehnt
Passwort-Mindestlänge 15 Zeichen (create) Abgelehnt mit kurzer Begründung
Anzahl Dateien Kein hartes Limit Durch RAM für Metadaten-JSON begrenzt

Nicht-Ziele

  • Multi-User / geteilte Schlüssel
  • Schlüssel-Wiederherstellung
  • Netzwerk-Sync oder Cloud-Backup
  • Datei-Kompression im Vault