91eefc86fa
- Add badges, competitive comparison, and 30-sec demo to README - Add Production Status section showing OQS backend is production-ready - Mark PQC KEM/signing operations complete in roadmap - Fix GitHub URL - Create CHANGELOG.md documenting all recent changes Positions SecretumVault as first Rust vault with production PQC.
Architecture Decision Records (ADRs)
This directory contains Architecture Decision Records (ADRs) for SecretumVault.
ADRs document significant architectural decisions, their context, alternatives considered, and consequences.
Format
Each ADR follows the Nygard format:
- Title: Short noun phrase describing the decision
- Status: Proposed, Accepted, Deprecated, Superseded
- Context: Problem and constraints
- Decision: What we decided to do
- Consequences: Positive and negative outcomes
ADR Index
| ADR | Title | Status | Date |
|---|---|---|---|
| 001 | Real Post-Quantum Cryptography Implementation via OQS Backend | ✅ Accepted & Implemented | 2026-01-17 |
ADR Lifecycle
Proposed → Accepted → Implemented
↓
Deprecated (replaced by newer ADR)
↓
Superseded (points to replacement ADR)
When to Create an ADR
Create an ADR when making decisions about:
- Architecture: Major structural changes (new backend, engine redesign)
- Technology: Choosing libraries, frameworks, or tools (OQS vs RustCrypto)
- Patterns: Establishing coding patterns (wrapper structs, caching strategy)
- Security: Cryptographic algorithms, authentication methods
- Performance: Trade-offs between speed and safety
- Compliance: Standards conformance (NIST FIPS)
How to Create an ADR
- Copy template from existing ADR (e.g., ADR-001)
- Number sequentially (ADR-002, ADR-003, etc.)
- Use kebab-case filename:
NNN-short-descriptive-title.md - Fill in all sections:
- Context (why we need to decide)
- Decision (what we decided)
- Alternatives Considered (what we rejected and why)
- Consequences (pros/cons)
- Update this index with new entry
- Submit for review before marking as Accepted
Related Documentation
- Architecture Overview - High-level system architecture
- Complete Architecture - Detailed architecture reference
- Development Documentation - Build and development guides