6a59d34bb1
Update configuration files, templates, and internal documentation for the provisioning repository system. Configuration Updates: - KMS configuration modernization - Plugin system settings - Service port mappings - Test cluster topologies - Installation configuration examples - VM configuration defaults - Cedar authorization policies Documentation Updates: - Library module documentation - Extension API guides - AI system documentation - Service management guides - Test environment setup - Plugin usage guides - Validator configuration documentation All changes are backward compatible.
405 lines
20 KiB
HTML
405 lines
20 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="ayu sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>KMS Service - 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/platform/kms-service.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="kms-service---key-management-service"><a class="header" href="#kms-service---key-management-service">KMS Service - Key Management Service</a></h1>
|
|
<p>A unified Key Management Service for the Provisioning platform with support for multiple backends.</p>
|
|
<blockquote>
|
|
<p><strong>Source</strong>: <code>provisioning/platform/kms-service/</code></p>
|
|
</blockquote>
|
|
<h2 id="supported-backends"><a class="header" href="#supported-backends">Supported Backends</a></h2>
|
|
<ul>
|
|
<li><strong>Age</strong>: Fast, offline encryption (development)</li>
|
|
<li><strong>RustyVault</strong>: Self-hosted Vault-compatible API</li>
|
|
<li><strong>Cosmian KMS</strong>: Enterprise-grade with confidential computing</li>
|
|
<li><strong>AWS KMS</strong>: Cloud-native key management</li>
|
|
<li><strong>HashiCorp Vault</strong>: Enterprise secrets management</li>
|
|
</ul>
|
|
<h2 id="architecture"><a class="header" href="#architecture">Architecture</a></h2>
|
|
<pre><code>┌─────────────────────────────────────────────────────────┐
|
|
│ KMS Service │
|
|
├─────────────────────────────────────────────────────────┤
|
|
│ REST API (Axum) │
|
|
│ ├─ /api/v1/kms/encrypt POST │
|
|
│ ├─ /api/v1/kms/decrypt POST │
|
|
│ ├─ /api/v1/kms/generate-key POST │
|
|
│ ├─ /api/v1/kms/status GET │
|
|
│ └─ /api/v1/kms/health GET │
|
|
├─────────────────────────────────────────────────────────┤
|
|
│ Unified KMS Service Interface │
|
|
├─────────────────────────────────────────────────────────┤
|
|
│ Backend Implementations │
|
|
│ ├─ Age Client (local files) │
|
|
│ ├─ RustyVault Client (self-hosted) │
|
|
│ └─ Cosmian KMS Client (enterprise) │
|
|
└─────────────────────────────────────────────────────────┘
|
|
</code></pre>
|
|
<h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2>
|
|
<h3 id="development-setup-age"><a class="header" href="#development-setup-age">Development Setup (Age)</a></h3>
|
|
<pre><code class="language-bash"># 1. Generate Age keys
|
|
mkdir -p ~/.config/provisioning/age
|
|
age-keygen -o ~/.config/provisioning/age/private_key.txt
|
|
age-keygen -y ~/.config/provisioning/age/private_key.txt > ~/.config/provisioning/age/public_key.txt
|
|
|
|
# 2. Set environment
|
|
export PROVISIONING_ENV=dev
|
|
|
|
# 3. Start KMS service
|
|
cd provisioning/platform/kms-service
|
|
cargo run --bin kms-service
|
|
</code></pre>
|
|
<h3 id="production-setup-cosmian"><a class="header" href="#production-setup-cosmian">Production Setup (Cosmian)</a></h3>
|
|
<pre><code class="language-bash"># Set environment variables
|
|
export PROVISIONING_ENV=prod
|
|
export COSMIAN_KMS_URL=https://your-kms.example.com
|
|
export COSMIAN_API_KEY=your-api-key-here
|
|
|
|
# Start KMS service
|
|
cargo run --bin kms-service
|
|
</code></pre>
|
|
<h2 id="rest-api-examples"><a class="header" href="#rest-api-examples">REST API Examples</a></h2>
|
|
<h3 id="encrypt-data"><a class="header" href="#encrypt-data">Encrypt Data</a></h3>
|
|
<pre><code class="language-bash">curl -X POST http://localhost:8082/api/v1/kms/encrypt \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"plaintext": "SGVsbG8sIFdvcmxkIQ==",
|
|
"context": "env=prod,service=api"
|
|
}'
|
|
</code></pre>
|
|
<h3 id="decrypt-data"><a class="header" href="#decrypt-data">Decrypt Data</a></h3>
|
|
<pre><code class="language-bash">curl -X POST http://localhost:8082/api/v1/kms/decrypt \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"ciphertext": "...",
|
|
"context": "env=prod,service=api"
|
|
}'
|
|
</code></pre>
|
|
<h2 id="nushell-cli-integration"><a class="header" href="#nushell-cli-integration">Nushell CLI Integration</a></h2>
|
|
<pre><code class="language-bash"># Encrypt data
|
|
"secret-data" | kms encrypt
|
|
"api-key" | kms encrypt --context "env=prod,service=api"
|
|
|
|
# Decrypt data
|
|
$ciphertext | kms decrypt
|
|
|
|
# Generate data key (Cosmian only)
|
|
kms generate-key
|
|
|
|
# Check service status
|
|
kms status
|
|
kms health
|
|
|
|
# Encrypt/decrypt files
|
|
kms encrypt-file config.yaml
|
|
kms decrypt-file config.yaml.enc
|
|
</code></pre>
|
|
<h2 id="backend-comparison"><a class="header" href="#backend-comparison">Backend Comparison</a></h2>
|
|
<div class="table-wrapper"><table><thead><tr><th>Feature</th><th>Age</th><th>RustyVault</th><th>Cosmian KMS</th><th>AWS KMS</th><th>Vault</th></tr></thead><tbody>
|
|
<tr><td><strong>Setup</strong></td><td>Simple</td><td>Self-hosted</td><td>Server setup</td><td>AWS account</td><td>Enterprise</td></tr>
|
|
<tr><td><strong>Speed</strong></td><td>Very fast</td><td>Fast</td><td>Fast</td><td>Fast</td><td>Fast</td></tr>
|
|
<tr><td><strong>Network</strong></td><td>No</td><td>Yes</td><td>Yes</td><td>Yes</td><td>Yes</td></tr>
|
|
<tr><td><strong>Key Rotation</strong></td><td>Manual</td><td>Automatic</td><td>Automatic</td><td>Automatic</td><td>Automatic</td></tr>
|
|
<tr><td><strong>Data Keys</strong></td><td>No</td><td>Yes</td><td>Yes</td><td>Yes</td><td>Yes</td></tr>
|
|
<tr><td><strong>Audit Logging</strong></td><td>No</td><td>Yes</td><td>Full</td><td>Full</td><td>Full</td></tr>
|
|
<tr><td><strong>Confidential</strong></td><td>No</td><td>No</td><td>Yes (SGX/SEV)</td><td>No</td><td>No</td></tr>
|
|
<tr><td><strong>License</strong></td><td>MIT</td><td>Apache 2.0</td><td>Proprietary</td><td>Proprietary</td><td>BSL/Enterprise</td></tr>
|
|
<tr><td><strong>Cost</strong></td><td>Free</td><td>Free</td><td>Paid</td><td>Paid</td><td>Paid</td></tr>
|
|
<tr><td><strong>Use Case</strong></td><td>Dev/Test</td><td>Self-hosted</td><td>Privacy</td><td>AWS Cloud</td><td>Enterprise</td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<h2 id="integration-points"><a class="header" href="#integration-points">Integration Points</a></h2>
|
|
<ol>
|
|
<li><strong>Config Encryption</strong> (SOPS Integration)</li>
|
|
<li><strong>Dynamic Secrets</strong> (Provider API Keys)</li>
|
|
<li><strong>SSH Key Management</strong></li>
|
|
<li><strong>Orchestrator</strong> (Workflow Data)</li>
|
|
<li><strong>Control Center</strong> (Audit Logs)</li>
|
|
</ol>
|
|
<h2 id="deployment"><a class="header" href="#deployment">Deployment</a></h2>
|
|
<h3 id="docker"><a class="header" href="#docker">Docker</a></h3>
|
|
<pre><code class="language-dockerfile">FROM rust:1.70 as builder
|
|
WORKDIR /app
|
|
COPY . .
|
|
RUN cargo build --release
|
|
|
|
FROM debian:bookworm-slim
|
|
RUN apt-get update && \
|
|
apt-get install -y ca-certificates && \
|
|
rm -rf /var/lib/apt/lists/*
|
|
COPY --from=builder /app/target/release/kms-service /usr/local/bin/
|
|
ENTRYPOINT ["kms-service"]
|
|
</code></pre>
|
|
<h3 id="kubernetes"><a class="header" href="#kubernetes">Kubernetes</a></h3>
|
|
<pre><code class="language-yaml">apiVersion: apps/v1
|
|
kind: Deployment
|
|
metadata:
|
|
name: kms-service
|
|
spec:
|
|
replicas: 2
|
|
template:
|
|
spec:
|
|
containers:
|
|
- name: kms-service
|
|
image: provisioning/kms-service:latest
|
|
env:
|
|
- name: PROVISIONING_ENV
|
|
value: "prod"
|
|
- name: COSMIAN_KMS_URL
|
|
value: "https://kms.example.com"
|
|
ports:
|
|
- containerPort: 8082
|
|
</code></pre>
|
|
<h2 id="security-best-practices"><a class="header" href="#security-best-practices">Security Best Practices</a></h2>
|
|
<ol>
|
|
<li><strong>Development</strong>: Use Age for dev/test only, never for production secrets</li>
|
|
<li><strong>Production</strong>: Always use Cosmian KMS with TLS verification enabled</li>
|
|
<li><strong>API Keys</strong>: Never hardcode, use environment variables</li>
|
|
<li><strong>Key Rotation</strong>: Enable automatic rotation (90 days recommended)</li>
|
|
<li><strong>Context Encryption</strong>: Always use encryption context (AAD)</li>
|
|
<li><strong>Network Access</strong>: Restrict KMS service access with firewall rules</li>
|
|
<li><strong>Monitoring</strong>: Enable health checks and monitor operation metrics</li>
|
|
</ol>
|
|
<h2 id="related-documentation"><a class="header" href="#related-documentation">Related Documentation</a></h2>
|
|
<ul>
|
|
<li><strong>User Guide</strong>: <a href="../user/RUSTYVAULT_KMS_GUIDE.html">KMS Guide</a></li>
|
|
<li><strong>Migration</strong>: <a href="../migration/KMS_SIMPLIFICATION.html">KMS Simplification</a></li>
|
|
</ul>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../platform/mcp-server.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="../platform/extension-registry.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="../platform/mcp-server.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="../platform/extension-registry.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>
|
|
|
|
<!-- Livereload script (if served using the cli tool) -->
|
|
<script>
|
|
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
|
|
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
|
|
const socket = new WebSocket(wsAddress);
|
|
socket.onmessage = function (event) {
|
|
if (event.data === "reload") {
|
|
socket.close();
|
|
location.reload();
|
|
}
|
|
};
|
|
|
|
window.onbeforeunload = function() {
|
|
socket.close();
|
|
}
|
|
</script>
|
|
|
|
|
|
|
|
<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>
|