Backup: manual full snapshot (opt-in)

Open
#124 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
22/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
rust
Domain
cli, security

Research direction

Start with the existing decrypt path and the .pqkf file handling, which the restore must reuse, and check whether issue #86 overlaps. Before any code, the issue requires a written plan, threat model/ADR and acceptance cases, approved by a maintainer. Done means an opt-in manual snapshot with its own ID and encrypted manifest, plus positive, negative and tamper tests, with existing CLI, API and key files still working.

Written by the indexing model from the issue text.

Description

area:backup priority:P3 type:feature

Ziel

Snapshot mit eigener ID und verschlüsseltem Manifest; atomare Veröffentlichung, keine Überschreibung oder automatische Löschung; Restore als bestehende decrypt-Funktion.

Scope / Grenzen

  • Genau dieser kleine Schritt, kein Big-Bang-Refactoring.
  • Kein Remote-Zugriff, keine neuen offenen Ports, keine automatische Migration.
  • Vor Implementierung kurzer Plan mit Risiko-/Sicherheitsbewertung und Freigabe.

Abhängigkeiten und Überschneidungen

B-1; #86 prüfen.

Tests

  • Unit- und Integrationstests für Erfolgs-, Fehler-, Grenzwert- und Manipulationsfälle.
  • Regression: bestehende CLI, API, Schlüsseldateien und .pqkf-Dateien weiterhin lesbar/nutzbar.
  • Windows/Linux prüfen, sofern betroffen; CI fmt, clippy, tests, audit und relevante Fuzz-/Property-Tests.
  • Keine Secrets in Logs, Fehlermeldungen, Prozessargumenten oder Testfixtures.

Definition of Done

  • Plan, Threat Model/ADR und konkrete Akzeptanzfälle dokumentiert und freigegeben.
  • Funktion isoliert umgesetzt; standardmäßig aus, sofern neue risikobehaftete Funktion.
  • Positiv-/Negativtests und Rückwärtskompatibilität nachgewiesen; CI grün.
  • DE/EN Dokumentation und Einschränkungen aktualisiert.
  • Review und eigenständiger PR, ohne vorgezogene Folgeschritte.

Rollback

  • Bestehender Betriebsweg bleibt erhalten; Feature-Flag/opt-in für neue Funktionen.
  • Keine automatische Format-/Datenmigration oder destruktive Operation.
  • Rücknahme des PR bzw. Abschalten des Features stellt den bisherigen Betrieb wieder her; Test dafür dokumentieren.

Themenreihe: Versionierte verschlüsselte Backups (B-2/5).

Dominant language
Rust
Stars
0
Forks
0
Avg merge
1h 22m
Merged PRs (30d)
72

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SpecterAoD/pqkeep

All issues in SpecterAoD/pqkeep

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.