407 lines
18 KiB
HTML
407 lines
18 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>0011: SecretumVault - VAPORA Platform Documentation</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="../favicon.svg">
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "../";
|
|
const default_light_theme = "light";
|
|
const default_dark_theme = "dark";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="../toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="mdbook-help-container">
|
|
<div id="mdbook-help-popup">
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
|
<div>
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
let theme = localStorage.getItem('mdbook-theme');
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
|
let theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">VAPORA Platform Documentation</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../adrs/0011-secretumvault.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="adr-011-secretumvault-para-secrets-management"><a class="header" href="#adr-011-secretumvault-para-secrets-management">ADR-011: SecretumVault para Secrets Management</a></h1>
|
|
<p><strong>Status</strong>: Accepted | Implemented
|
|
<strong>Date</strong>: 2024-11-01
|
|
<strong>Deciders</strong>: Security Architecture Team
|
|
<strong>Technical Story</strong>: Securing API keys and credentials with post-quantum cryptography</p>
|
|
<hr />
|
|
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
|
|
<p>Usar <strong>SecretumVault</strong> para gestión de secrets con criptografía post-quantum (no HashiCorp Vault, no plain K8s secrets).</p>
|
|
<hr />
|
|
<h2 id="rationale"><a class="header" href="#rationale">Rationale</a></h2>
|
|
<ol>
|
|
<li><strong>Post-Quantum Cryptography</strong>: Protege contra ataques futuros con quantum computers</li>
|
|
<li><strong>Rust-Native</strong>: Sin dependencias externas, compila a binario standalone</li>
|
|
<li><strong>API Key Security</strong>: Encriptación at-rest para LLM API keys</li>
|
|
<li><strong>Audit Logging</strong>: Todas las operaciones de secretos registradas</li>
|
|
<li><strong>Future-Proof</strong>: Prepara a VAPORA para amenazas de seguridad del futuro</li>
|
|
</ol>
|
|
<hr />
|
|
<h2 id="alternatives-considered"><a class="header" href="#alternatives-considered">Alternatives Considered</a></h2>
|
|
<h3 id="-hashicorp-vault"><a class="header" href="#-hashicorp-vault">❌ HashiCorp Vault</a></h3>
|
|
<ul>
|
|
<li><strong>Pros</strong>: Maduro, enterprise-grade</li>
|
|
<li><strong>Cons</strong>: Externa dependencia, operacional overhead, no post-quantum</li>
|
|
</ul>
|
|
<h3 id="-kubernetes-secrets"><a class="header" href="#-kubernetes-secrets">❌ Kubernetes Secrets</a></h3>
|
|
<ul>
|
|
<li><strong>Pros</strong>: Built-in, simple</li>
|
|
<li><strong>Cons</strong>: Almacenamiento by default sin encripción, no audit logging</li>
|
|
</ul>
|
|
<h3 id="-secretumvault-chosen"><a class="header" href="#-secretumvault-chosen">✅ SecretumVault (CHOSEN)</a></h3>
|
|
<ul>
|
|
<li>Post-quantum cryptography, Rust-native, audit-friendly</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="trade-offs"><a class="header" href="#trade-offs">Trade-offs</a></h2>
|
|
<p><strong>Pros</strong>:</p>
|
|
<ul>
|
|
<li>✅ Post-quantum resistance for future threats</li>
|
|
<li>✅ Built-in audit logging of secret access</li>
|
|
<li>✅ Rust-native (no external dependencies)</li>
|
|
<li>✅ Encryption at-rest for API keys</li>
|
|
<li>✅ Fine-grained access control</li>
|
|
</ul>
|
|
<p><strong>Cons</strong>:</p>
|
|
<ul>
|
|
<li>⚠️ Smaller community than HashiCorp Vault</li>
|
|
<li>⚠️ Fewer integrations with external tools</li>
|
|
<li>⚠️ Post-quantum crypto adds computational overhead</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="implementation"><a class="header" href="#implementation">Implementation</a></h2>
|
|
<p><strong>Secret Storage</strong>:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>// crates/vapora-backend/src/secrets.rs
|
|
use secretumvault::SecretStore;
|
|
|
|
let secret_store = SecretStore::new()?;
|
|
|
|
// Store API key with encryption
|
|
secret_store.store_secret(
|
|
"anthropic_api_key",
|
|
"sk-ant-...",
|
|
SecretMetadata {
|
|
encrypted: true,
|
|
pq_algorithm: "ML-KEM-768", // Post-quantum algorithm
|
|
owner: "llm-router",
|
|
created_at: Utc::now(),
|
|
}
|
|
)?;
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>Secret Retrieval</strong>:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>// Retrieve and decrypt
|
|
let api_key = secret_store
|
|
.get_secret("anthropic_api_key")?
|
|
.decrypt()
|
|
.audit_log("anthropic_api_key_access", &user_id)?;
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>Audit Log</strong>:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>// All secret operations logged
|
|
secret_store.audit_log().query()
|
|
.secret("anthropic_api_key")
|
|
.since(Duration::days(1))
|
|
.await?
|
|
// Returns: Who accessed what secret when
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>Configuration</strong>:</p>
|
|
<pre><code class="language-toml"># config/secrets.toml
|
|
[secretumvault]
|
|
store_path = "/etc/vapora/secrets.db"
|
|
pq_algorithm = "ML-KEM-768" # Post-quantum
|
|
rotation_days = 90
|
|
audit_retention_days = 365
|
|
|
|
[[secret_categories]]
|
|
name = "api_keys"
|
|
encryption = true
|
|
rotation_required = true
|
|
|
|
[[secret_categories]]
|
|
name = "database_credentials"
|
|
encryption = true
|
|
rotation_required = true
|
|
</code></pre>
|
|
<p><strong>Key Files</strong>:</p>
|
|
<ul>
|
|
<li><code>/crates/vapora-backend/src/secrets.rs</code> (secret management)</li>
|
|
<li><code>/crates/vapora-llm-router/src/providers.rs</code> (uses secrets to load API keys)</li>
|
|
<li><code>/config/secrets.toml</code> (configuration)</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="verification"><a class="header" href="#verification">Verification</a></h2>
|
|
<pre><code class="language-bash"># Test secret storage and retrieval
|
|
cargo test -p vapora-backend test_secret_storage
|
|
|
|
# Test encryption/decryption
|
|
cargo test -p vapora-backend test_secret_encryption
|
|
|
|
# Verify audit logging
|
|
cargo test -p vapora-backend test_audit_logging
|
|
|
|
# Test key rotation
|
|
cargo test -p vapora-backend test_secret_rotation
|
|
|
|
# Verify post-quantum algorithms
|
|
cargo test -p vapora-backend test_pq_algorithms
|
|
|
|
# Integration test: load API key from secret store
|
|
cargo test -p vapora-llm-router test_provider_auth -- --nocapture
|
|
</code></pre>
|
|
<p><strong>Expected Output</strong>:</p>
|
|
<ul>
|
|
<li>Secrets stored encrypted with post-quantum algorithm</li>
|
|
<li>Decryption works correctly</li>
|
|
<li>All secret access logged with timestamp, user, resource</li>
|
|
<li>Key rotation works automatically</li>
|
|
<li>API keys loaded securely in providers</li>
|
|
<li>No keys leak in logs or error messages</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="consequences"><a class="header" href="#consequences">Consequences</a></h2>
|
|
<h3 id="security-operations"><a class="header" href="#security-operations">Security Operations</a></h3>
|
|
<ul>
|
|
<li>Secret rotation automated every 90 days</li>
|
|
<li>Audit logs accessible for compliance investigations</li>
|
|
<li>Break-glass procedures for emergency access (logged)</li>
|
|
<li>All secret operations require authentication</li>
|
|
</ul>
|
|
<h3 id="performance"><a class="header" href="#performance">Performance</a></h3>
|
|
<ul>
|
|
<li>Secret retrieval cached (policies don't change)</li>
|
|
<li>Decryption overhead < 1ms per secret</li>
|
|
<li>Audit logging asynchronous (doesn't block requests)</li>
|
|
</ul>
|
|
<h3 id="maintenance"><a class="header" href="#maintenance">Maintenance</a></h3>
|
|
<ul>
|
|
<li>Post-quantum algorithms updated as standards evolve</li>
|
|
<li>Audit logs must be retained per compliance policy</li>
|
|
<li>Key rotation scheduled and tracked</li>
|
|
</ul>
|
|
<h3 id="compliance"><a class="header" href="#compliance">Compliance</a></h3>
|
|
<ul>
|
|
<li>Audit trail for regulatory investigations</li>
|
|
<li>Encryption meets security standards</li>
|
|
<li>Post-quantum protection for long-term security</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="references"><a class="header" href="#references">References</a></h2>
|
|
<ul>
|
|
<li><a href="https://github.com/secretumvault/secretumvault">SecretumVault Documentation</a></li>
|
|
<li><a href="https://csrc.nist.gov/projects/post-quantum-cryptography">Post-Quantum Cryptography (ML-KEM)</a></li>
|
|
<li><code>/crates/vapora-backend/src/secrets.rs</code> (integration code)</li>
|
|
<li><code>/config/secrets.toml</code> (configuration)</li>
|
|
</ul>
|
|
<hr />
|
|
<p><strong>Related ADRs</strong>: ADR-009 (Istio), ADR-025 (Multi-Tenancy)</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../../adrs/0010-cedar-authorization.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../../adrs/0012-llm-routing-tiers.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../../adrs/0010-cedar-authorization.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../../adrs/0012-llm-routing-tiers.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="../elasticlunr.min.js"></script>
|
|
<script src="../mark.min.js"></script>
|
|
<script src="../searcher.js"></script>
|
|
|
|
<script src="../clipboard.min.js"></script>
|
|
<script src="../highlight.js"></script>
|
|
<script src="../book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|