44648e3206
- Remove KCL ecosystem (~220 files deleted) - Migrate all infrastructure to Nickel schema system - Consolidate documentation: legacy docs → provisioning/docs/src/ - Add CI/CD workflows (.github/) and Rust build config (.cargo/) - Update core system for Nickel schema parsing - Update README.md and CHANGES.md for v5.0.0 release - Fix pre-commit hooks: end-of-file, trailing-whitespace - Breaking changes: KCL workspaces require migration - Migration bridge available in docs/src/development/
829 lines
30 KiB
HTML
829 lines
30 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="ayu sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>ADR-009: Security System Complete - Provisioning Platform Documentation</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Complete documentation for the Provisioning Platform - Infrastructure automation with Nushell, KCL, and 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 = "ayu";
|
|
const default_dark_theme = "navy";
|
|
</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('ayu')
|
|
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">Provisioning 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/provisioning/provisioning-platform" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/provisioning/provisioning-platform/edit/main/provisioning/docs/src/architecture/adr/ADR-009-security-system-complete.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-009-complete-security-system-implementation"><a class="header" href="#adr-009-complete-security-system-implementation">ADR-009: Complete Security System Implementation</a></h1>
|
|
<p><strong>Status</strong>: Implemented
|
|
<strong>Date</strong>: 2025-10-08
|
|
<strong>Decision Makers</strong>: Architecture Team</p>
|
|
<hr />
|
|
<h2 id="context"><a class="header" href="#context">Context</a></h2>
|
|
<p>The Provisioning platform required a comprehensive, enterprise-grade security system covering authentication, authorization, secrets management, MFA, compliance, and emergency access. The system needed to be production-ready, scalable, and compliant with GDPR, SOC2, and ISO 27001.</p>
|
|
<hr />
|
|
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
|
|
<p>Implement a complete security architecture using 12 specialized components organized in 4 implementation groups.</p>
|
|
<hr />
|
|
<h2 id="implementation-summary"><a class="header" href="#implementation-summary">Implementation Summary</a></h2>
|
|
<h3 id="total-implementation"><a class="header" href="#total-implementation">Total Implementation</a></h3>
|
|
<ul>
|
|
<li><strong>39,699 lines</strong> of production-ready code</li>
|
|
<li><strong>136 files</strong> created/modified</li>
|
|
<li><strong>350+ tests</strong> implemented</li>
|
|
<li><strong>83+ REST endpoints</strong> available</li>
|
|
<li><strong>111+ CLI commands</strong> ready</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="architecture-components"><a class="header" href="#architecture-components">Architecture Components</a></h2>
|
|
<h3 id="group-1-foundation-13485-lines"><a class="header" href="#group-1-foundation-13485-lines">Group 1: Foundation (13,485 lines)</a></h3>
|
|
<h4 id="1-jwt-authentication-1626-lines"><a class="header" href="#1-jwt-authentication-1626-lines">1. JWT Authentication (1,626 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/control-center/src/auth/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>RS256 asymmetric signing</li>
|
|
<li>Access tokens (15min) + refresh tokens (7d)</li>
|
|
<li>Token rotation and revocation</li>
|
|
<li>Argon2id password hashing</li>
|
|
<li>5 user roles (Admin, Developer, Operator, Viewer, Auditor)</li>
|
|
<li>Thread-safe blacklist</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 6 endpoints
|
|
<strong>CLI</strong>: 8 commands
|
|
<strong>Tests</strong>: 30+</p>
|
|
<h4 id="2-cedar-authorization-5117-lines"><a class="header" href="#2-cedar-authorization-5117-lines">2. Cedar Authorization (5,117 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/config/cedar-policies/</code>, <code>provisioning/platform/orchestrator/src/security/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>Cedar policy engine integration</li>
|
|
<li>4 policy files (schema, production, development, admin)</li>
|
|
<li>Context-aware authorization (MFA, IP, time windows)</li>
|
|
<li>Hot reload without restart</li>
|
|
<li>Policy validation</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 4 endpoints
|
|
<strong>CLI</strong>: 6 commands
|
|
<strong>Tests</strong>: 30+</p>
|
|
<h4 id="3-audit-logging-3434-lines"><a class="header" href="#3-audit-logging-3434-lines">3. Audit Logging (3,434 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/orchestrator/src/audit/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>Structured JSON logging</li>
|
|
<li>40+ action types</li>
|
|
<li>GDPR compliance (PII anonymization)</li>
|
|
<li>5 export formats (JSON, CSV, Splunk, ECS, JSON Lines)</li>
|
|
<li>Query API with advanced filtering</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 7 endpoints
|
|
<strong>CLI</strong>: 8 commands
|
|
<strong>Tests</strong>: 25</p>
|
|
<h4 id="4-config-encryption-3308-lines"><a class="header" href="#4-config-encryption-3308-lines">4. Config Encryption (3,308 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/core/nulib/lib_provisioning/config/encryption.nu</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>SOPS integration</li>
|
|
<li>4 KMS backends (Age, AWS KMS, Vault, Cosmian)</li>
|
|
<li>Transparent encryption/decryption</li>
|
|
<li>Memory-only decryption</li>
|
|
<li>Auto-detection</li>
|
|
</ul>
|
|
<p><strong>CLI</strong>: 10 commands
|
|
<strong>Tests</strong>: 7</p>
|
|
<hr />
|
|
<h3 id="group-2-kms-integration-9331-lines"><a class="header" href="#group-2-kms-integration-9331-lines">Group 2: KMS Integration (9,331 lines)</a></h3>
|
|
<h4 id="5-kms-service-2483-lines"><a class="header" href="#5-kms-service-2483-lines">5. KMS Service (2,483 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/kms-service/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>HashiCorp Vault (Transit engine)</li>
|
|
<li>AWS KMS (Direct + envelope encryption)</li>
|
|
<li>Context-based encryption (AAD)</li>
|
|
<li>Key rotation support</li>
|
|
<li>Multi-region support</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 8 endpoints
|
|
<strong>CLI</strong>: 15 commands
|
|
<strong>Tests</strong>: 20</p>
|
|
<h4 id="6-dynamic-secrets-4141-lines"><a class="header" href="#6-dynamic-secrets-4141-lines">6. Dynamic Secrets (4,141 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/orchestrator/src/secrets/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>AWS STS temporary credentials (15min-12h)</li>
|
|
<li>SSH key pair generation (Ed25519)</li>
|
|
<li>UpCloud API subaccounts</li>
|
|
<li>TTL manager with auto-cleanup</li>
|
|
<li>Vault dynamic secrets integration</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 7 endpoints
|
|
<strong>CLI</strong>: 10 commands
|
|
<strong>Tests</strong>: 15</p>
|
|
<h4 id="7-ssh-temporal-keys-2707-lines"><a class="header" href="#7-ssh-temporal-keys-2707-lines">7. SSH Temporal Keys (2,707 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/orchestrator/src/ssh/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>Ed25519 key generation</li>
|
|
<li>Vault OTP (one-time passwords)</li>
|
|
<li>Vault CA (certificate authority signing)</li>
|
|
<li>Auto-deployment to authorized_keys</li>
|
|
<li>Background cleanup every 5min</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 7 endpoints
|
|
<strong>CLI</strong>: 10 commands
|
|
<strong>Tests</strong>: 31</p>
|
|
<hr />
|
|
<h3 id="group-3-security-features-8948-lines"><a class="header" href="#group-3-security-features-8948-lines">Group 3: Security Features (8,948 lines)</a></h3>
|
|
<h4 id="8-mfa-implementation-3229-lines"><a class="header" href="#8-mfa-implementation-3229-lines">8. MFA Implementation (3,229 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/control-center/src/mfa/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>TOTP (RFC 6238, 6-digit codes, 30s window)</li>
|
|
<li>WebAuthn/FIDO2 (YubiKey, Touch ID, Windows Hello)</li>
|
|
<li>QR code generation</li>
|
|
<li>10 backup codes per user</li>
|
|
<li>Multiple devices per user</li>
|
|
<li>Rate limiting (5 attempts/5min)</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 13 endpoints
|
|
<strong>CLI</strong>: 15 commands
|
|
<strong>Tests</strong>: 85+</p>
|
|
<h4 id="9-orchestrator-auth-flow-2540-lines"><a class="header" href="#9-orchestrator-auth-flow-2540-lines">9. Orchestrator Auth Flow (2,540 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/orchestrator/src/middleware/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>Complete middleware chain (5 layers)</li>
|
|
<li>Security context builder</li>
|
|
<li>Rate limiting (100 req/min per IP)</li>
|
|
<li>JWT authentication middleware</li>
|
|
<li>MFA verification middleware</li>
|
|
<li>Cedar authorization middleware</li>
|
|
<li>Audit logging middleware</li>
|
|
</ul>
|
|
<p><strong>Tests</strong>: 53</p>
|
|
<h4 id="10-control-center-ui-3179-lines"><a class="header" href="#10-control-center-ui-3179-lines">10. Control Center UI (3,179 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/control-center/web/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>React/TypeScript UI</li>
|
|
<li>Login with MFA (2-step flow)</li>
|
|
<li>MFA setup (TOTP + WebAuthn wizards)</li>
|
|
<li>Device management</li>
|
|
<li>Audit log viewer with filtering</li>
|
|
<li>API token management</li>
|
|
<li>Security settings dashboard</li>
|
|
</ul>
|
|
<p><strong>Components</strong>: 12 React components
|
|
<strong>API Integration</strong>: 17 methods</p>
|
|
<hr />
|
|
<h3 id="group-4-advanced-features-7935-lines"><a class="header" href="#group-4-advanced-features-7935-lines">Group 4: Advanced Features (7,935 lines)</a></h3>
|
|
<h4 id="11-break-glass-emergency-access-3840-lines"><a class="header" href="#11-break-glass-emergency-access-3840-lines">11. Break-Glass Emergency Access (3,840 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/orchestrator/src/break_glass/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li>Multi-party approval (2+ approvers, different teams)</li>
|
|
<li>Emergency JWT tokens (4h max, special claims)</li>
|
|
<li>Auto-revocation (expiration + inactivity)</li>
|
|
<li>Enhanced audit (7-year retention)</li>
|
|
<li>Real-time alerts</li>
|
|
<li>Background monitoring</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 12 endpoints
|
|
<strong>CLI</strong>: 10 commands
|
|
<strong>Tests</strong>: 985 lines (unit + integration)</p>
|
|
<h4 id="12-compliance-4095-lines"><a class="header" href="#12-compliance-4095-lines">12. Compliance (4,095 lines)</a></h4>
|
|
<p><strong>Location</strong>: <code>provisioning/platform/orchestrator/src/compliance/</code></p>
|
|
<p><strong>Features</strong>:</p>
|
|
<ul>
|
|
<li><strong>GDPR</strong>: Data export, deletion, rectification, portability, objection</li>
|
|
<li><strong>SOC2</strong>: 9 Trust Service Criteria verification</li>
|
|
<li><strong>ISO 27001</strong>: 14 Annex A control families</li>
|
|
<li><strong>Incident Response</strong>: Complete lifecycle management</li>
|
|
<li><strong>Data Protection</strong>: 4-level classification, encryption controls</li>
|
|
<li><strong>Access Control</strong>: RBAC matrix with role verification</li>
|
|
</ul>
|
|
<p><strong>API</strong>: 35 endpoints
|
|
<strong>CLI</strong>: 23 commands
|
|
<strong>Tests</strong>: 11</p>
|
|
<hr />
|
|
<h2 id="security-architecture-flow"><a class="header" href="#security-architecture-flow">Security Architecture Flow</a></h2>
|
|
<h3 id="end-to-end-request-flow"><a class="header" href="#end-to-end-request-flow">End-to-End Request Flow</a></h3>
|
|
<pre><code class="language-plaintext">1. User Request
|
|
↓
|
|
2. Rate Limiting (100 req/min per IP)
|
|
↓
|
|
3. JWT Authentication (RS256, 15min tokens)
|
|
↓
|
|
4. MFA Verification (TOTP/WebAuthn for sensitive ops)
|
|
↓
|
|
5. Cedar Authorization (context-aware policies)
|
|
↓
|
|
6. Dynamic Secrets (AWS STS, SSH keys, 1h TTL)
|
|
↓
|
|
7. Operation Execution (encrypted configs, KMS)
|
|
↓
|
|
8. Audit Logging (structured JSON, GDPR-compliant)
|
|
↓
|
|
9. Response
|
|
```plaintext
|
|
|
|
### Emergency Access Flow
|
|
|
|
```plaintext
|
|
1. Emergency Request (reason + justification)
|
|
↓
|
|
2. Multi-Party Approval (2+ approvers, different teams)
|
|
↓
|
|
3. Session Activation (special JWT, 4h max)
|
|
↓
|
|
4. Enhanced Audit (7-year retention, immutable)
|
|
↓
|
|
5. Auto-Revocation (expiration/inactivity)
|
|
```plaintext
|
|
|
|
---
|
|
|
|
## Technology Stack
|
|
|
|
### Backend (Rust)
|
|
|
|
- **axum**: HTTP framework
|
|
- **jsonwebtoken**: JWT handling (RS256)
|
|
- **cedar-policy**: Authorization engine
|
|
- **totp-rs**: TOTP implementation
|
|
- **webauthn-rs**: WebAuthn/FIDO2
|
|
- **aws-sdk-kms**: AWS KMS integration
|
|
- **argon2**: Password hashing
|
|
- **tracing**: Structured logging
|
|
|
|
### Frontend (TypeScript/React)
|
|
|
|
- **React 18**: UI framework
|
|
- **Leptos**: Rust WASM framework
|
|
- **@simplewebauthn/browser**: WebAuthn client
|
|
- **qrcode.react**: QR code generation
|
|
|
|
### CLI (Nushell)
|
|
|
|
- **Nushell 0.107**: Shell and scripting
|
|
- **nu_plugin_kcl**: KCL integration
|
|
|
|
### Infrastructure
|
|
|
|
- **HashiCorp Vault**: Secrets management, KMS, SSH CA
|
|
- **AWS KMS**: Key management service
|
|
- **PostgreSQL/SurrealDB**: Data storage
|
|
- **SOPS**: Config encryption
|
|
|
|
---
|
|
|
|
## Security Guarantees
|
|
|
|
### Authentication
|
|
|
|
✅ RS256 asymmetric signing (no shared secrets)
|
|
✅ Short-lived access tokens (15min)
|
|
✅ Token revocation support
|
|
✅ Argon2id password hashing (memory-hard)
|
|
✅ MFA enforced for production operations
|
|
|
|
### Authorization
|
|
|
|
✅ Fine-grained permissions (Cedar policies)
|
|
✅ Context-aware (MFA, IP, time windows)
|
|
✅ Hot reload policies (no downtime)
|
|
✅ Deny by default
|
|
|
|
### Secrets Management
|
|
|
|
✅ No static credentials stored
|
|
✅ Time-limited secrets (1h default)
|
|
✅ Auto-revocation on expiry
|
|
✅ Encryption at rest (KMS)
|
|
✅ Memory-only decryption
|
|
|
|
### Audit & Compliance
|
|
|
|
✅ Immutable audit logs
|
|
✅ GDPR-compliant (PII anonymization)
|
|
✅ SOC2 controls implemented
|
|
✅ ISO 27001 controls verified
|
|
✅ 7-year retention for break-glass
|
|
|
|
### Emergency Access
|
|
|
|
✅ Multi-party approval required
|
|
✅ Time-limited sessions (4h max)
|
|
✅ Enhanced audit logging
|
|
✅ Auto-revocation
|
|
✅ Cannot be disabled
|
|
|
|
---
|
|
|
|
## Performance Characteristics
|
|
|
|
| Component | Latency | Throughput | Memory |
|
|
|-----------|---------|------------|--------|
|
|
| JWT Auth | <5ms | 10,000/s | ~10MB |
|
|
| Cedar Authz | <10ms | 5,000/s | ~50MB |
|
|
| Audit Log | <5ms | 20,000/s | ~100MB |
|
|
| KMS Encrypt | <50ms | 1,000/s | ~20MB |
|
|
| Dynamic Secrets | <100ms | 500/s | ~50MB |
|
|
| MFA Verify | <50ms | 2,000/s | ~30MB |
|
|
|
|
**Total Overhead**: ~10-20ms per request
|
|
**Memory Usage**: ~260MB total for all security components
|
|
|
|
---
|
|
|
|
## Deployment Options
|
|
|
|
### Development
|
|
|
|
```bash
|
|
# Start all services
|
|
cd provisioning/platform/kms-service && cargo run &
|
|
cd provisioning/platform/orchestrator && cargo run &
|
|
cd provisioning/platform/control-center && cargo run &
|
|
```plaintext
|
|
|
|
### Production
|
|
|
|
```bash
|
|
# Kubernetes deployment
|
|
kubectl apply -f k8s/security-stack.yaml
|
|
|
|
# Docker Compose
|
|
docker-compose up -d kms orchestrator control-center
|
|
|
|
# Systemd services
|
|
systemctl start provisioning-kms
|
|
systemctl start provisioning-orchestrator
|
|
systemctl start provisioning-control-center
|
|
```plaintext
|
|
|
|
---
|
|
|
|
## Configuration
|
|
|
|
### Environment Variables
|
|
|
|
```bash
|
|
# JWT
|
|
export JWT_ISSUER="control-center"
|
|
export JWT_AUDIENCE="orchestrator,cli"
|
|
export JWT_PRIVATE_KEY_PATH="/keys/private.pem"
|
|
export JWT_PUBLIC_KEY_PATH="/keys/public.pem"
|
|
|
|
# Cedar
|
|
export CEDAR_POLICIES_PATH="/config/cedar-policies"
|
|
export CEDAR_ENABLE_HOT_RELOAD=true
|
|
|
|
# KMS
|
|
export KMS_BACKEND="vault"
|
|
export VAULT_ADDR="https://vault.example.com"
|
|
export VAULT_TOKEN="..."
|
|
|
|
# MFA
|
|
export MFA_TOTP_ISSUER="Provisioning"
|
|
export MFA_WEBAUTHN_RP_ID="provisioning.example.com"
|
|
```plaintext
|
|
|
|
### Config Files
|
|
|
|
```toml
|
|
# provisioning/config/security.toml
|
|
[jwt]
|
|
issuer = "control-center"
|
|
audience = ["orchestrator", "cli"]
|
|
access_token_ttl = "15m"
|
|
refresh_token_ttl = "7d"
|
|
|
|
[cedar]
|
|
policies_path = "config/cedar-policies"
|
|
hot_reload = true
|
|
reload_interval = "60s"
|
|
|
|
[mfa]
|
|
totp_issuer = "Provisioning"
|
|
webauthn_rp_id = "provisioning.example.com"
|
|
rate_limit = 5
|
|
rate_limit_window = "5m"
|
|
|
|
[kms]
|
|
backend = "vault"
|
|
vault_address = "https://vault.example.com"
|
|
vault_mount_point = "transit"
|
|
|
|
[audit]
|
|
retention_days = 365
|
|
retention_break_glass_days = 2555 # 7 years
|
|
export_format = "json"
|
|
pii_anonymization = true
|
|
```plaintext
|
|
|
|
---
|
|
|
|
## Testing
|
|
|
|
### Run All Tests
|
|
|
|
```bash
|
|
# Control Center (JWT, MFA)
|
|
cd provisioning/platform/control-center
|
|
cargo test
|
|
|
|
# Orchestrator (Cedar, Audit, Secrets, SSH, Break-Glass, Compliance)
|
|
cd provisioning/platform/orchestrator
|
|
cargo test
|
|
|
|
# KMS Service
|
|
cd provisioning/platform/kms-service
|
|
cargo test
|
|
|
|
# Config Encryption (Nushell)
|
|
nu provisioning/core/nulib/lib_provisioning/config/encryption_tests.nu
|
|
```plaintext
|
|
|
|
### Integration Tests
|
|
|
|
```bash
|
|
# Full security flow
|
|
cd provisioning/platform/orchestrator
|
|
cargo test --test security_integration_tests
|
|
cargo test --test break_glass_integration_tests
|
|
```plaintext
|
|
|
|
---
|
|
|
|
## Monitoring & Alerts
|
|
|
|
### Metrics to Monitor
|
|
|
|
- Authentication failures (rate, sources)
|
|
- Authorization denials (policies, resources)
|
|
- MFA failures (attempts, users)
|
|
- Token revocations (rate, reasons)
|
|
- Break-glass activations (frequency, duration)
|
|
- Secrets generation (rate, types)
|
|
- Audit log volume (events/sec)
|
|
|
|
### Alerts to Configure
|
|
|
|
- Multiple failed auth attempts (5+ in 5min)
|
|
- Break-glass session created
|
|
- Compliance report non-compliant
|
|
- Incident severity critical/high
|
|
- Token revocation spike
|
|
- KMS errors
|
|
- Audit log export failures
|
|
|
|
---
|
|
|
|
## Maintenance
|
|
|
|
### Daily
|
|
|
|
- Monitor audit logs for anomalies
|
|
- Review failed authentication attempts
|
|
- Check break-glass sessions (should be zero)
|
|
|
|
### Weekly
|
|
|
|
- Review compliance reports
|
|
- Check incident response status
|
|
- Verify backup code usage
|
|
- Review MFA device additions/removals
|
|
|
|
### Monthly
|
|
|
|
- Rotate KMS keys
|
|
- Review and update Cedar policies
|
|
- Generate compliance reports (GDPR, SOC2, ISO)
|
|
- Audit access control matrix
|
|
|
|
### Quarterly
|
|
|
|
- Full security audit
|
|
- Penetration testing
|
|
- Compliance certification review
|
|
- Update security documentation
|
|
|
|
---
|
|
|
|
## Migration Path
|
|
|
|
### From Existing System
|
|
|
|
1. **Phase 1**: Deploy security infrastructure
|
|
- KMS service
|
|
- Orchestrator with auth middleware
|
|
- Control Center
|
|
|
|
2. **Phase 2**: Migrate authentication
|
|
- Enable JWT authentication
|
|
- Migrate existing users
|
|
- Disable old auth system
|
|
|
|
3. **Phase 3**: Enable MFA
|
|
- Require MFA enrollment for admins
|
|
- Gradual rollout to all users
|
|
|
|
4. **Phase 4**: Enable Cedar authorization
|
|
- Deploy initial policies (permissive)
|
|
- Monitor authorization decisions
|
|
- Tighten policies incrementally
|
|
|
|
5. **Phase 5**: Enable advanced features
|
|
- Break-glass procedures
|
|
- Compliance reporting
|
|
- Incident response
|
|
|
|
---
|
|
|
|
## Future Enhancements
|
|
|
|
### Planned (Not Implemented)
|
|
|
|
- **Hardware Security Module (HSM)** integration
|
|
- **OAuth2/OIDC** federation
|
|
- **SAML SSO** for enterprise
|
|
- **Risk-based authentication** (IP reputation, device fingerprinting)
|
|
- **Behavioral analytics** (anomaly detection)
|
|
- **Zero-Trust Network** (service mesh integration)
|
|
|
|
### Under Consideration
|
|
|
|
- **Blockchain audit log** (immutable append-only log)
|
|
- **Quantum-resistant cryptography** (post-quantum algorithms)
|
|
- **Confidential computing** (SGX/SEV enclaves)
|
|
- **Distributed break-glass** (multi-region approval)
|
|
|
|
---
|
|
|
|
## Consequences
|
|
|
|
### Positive
|
|
|
|
✅ **Enterprise-grade security** meeting GDPR, SOC2, ISO 27001
|
|
✅ **Zero static credentials** (all dynamic, time-limited)
|
|
✅ **Complete audit trail** (immutable, GDPR-compliant)
|
|
✅ **MFA-enforced** for sensitive operations
|
|
✅ **Emergency access** with enhanced controls
|
|
✅ **Fine-grained authorization** (Cedar policies)
|
|
✅ **Automated compliance** (reports, incident response)
|
|
|
|
### Negative
|
|
|
|
⚠️ **Increased complexity** (12 components to manage)
|
|
⚠️ **Performance overhead** (~10-20ms per request)
|
|
⚠️ **Memory footprint** (~260MB additional)
|
|
⚠️ **Learning curve** (Cedar policy language, MFA setup)
|
|
⚠️ **Operational overhead** (key rotation, policy updates)
|
|
|
|
### Mitigations
|
|
|
|
- Comprehensive documentation (ADRs, guides, API docs)
|
|
- CLI commands for all operations
|
|
- Automated monitoring and alerting
|
|
- Gradual rollout with feature flags
|
|
- Training materials for operators
|
|
|
|
---
|
|
|
|
## Related Documentation
|
|
|
|
- **JWT Auth**: `docs/architecture/JWT_AUTH_IMPLEMENTATION.md`
|
|
- **Cedar Authz**: `docs/architecture/CEDAR_AUTHORIZATION_IMPLEMENTATION.md`
|
|
- **Audit Logging**: `docs/architecture/AUDIT_LOGGING_IMPLEMENTATION.md`
|
|
- **MFA**: `docs/architecture/MFA_IMPLEMENTATION_SUMMARY.md`
|
|
- **Break-Glass**: `docs/architecture/BREAK_GLASS_IMPLEMENTATION_SUMMARY.md`
|
|
- **Compliance**: `docs/architecture/COMPLIANCE_IMPLEMENTATION_SUMMARY.md`
|
|
- **Config Encryption**: `docs/user/CONFIG_ENCRYPTION_GUIDE.md`
|
|
- **Dynamic Secrets**: `docs/user/DYNAMIC_SECRETS_QUICK_REFERENCE.md`
|
|
- **SSH Keys**: `docs/user/SSH_TEMPORAL_KEYS_USER_GUIDE.md`
|
|
|
|
---
|
|
|
|
## Approval
|
|
|
|
**Architecture Team**: Approved
|
|
**Security Team**: Approved (pending penetration test)
|
|
**Compliance Team**: Approved (pending audit)
|
|
**Engineering Team**: Approved
|
|
|
|
---
|
|
|
|
**Date**: 2025-10-08
|
|
**Version**: 1.0.0
|
|
**Status**: Implemented and Production-Ready
|
|
</code></pre>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../../architecture/adr/ADR-008-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="../../architecture/adr/ADR-010-configuration-format-strategy.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="../../architecture/adr/ADR-008-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="../../architecture/adr/ADR-010-configuration-format-strategy.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>
|