Files
docs/auth-server/wiki/index.html
Vishesh 'ironeagle' Bangotra a115df113d chore: collect auth-server wiki and lib refresh
Picks up the rewritten auth-server wiki (platform anatomy theme) and the
regenerated lib artifacts, including the new pep-typed marker bounce.
2026-09-16 19:51:24 +05:30

726 lines
18 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="next" href="01_centralized_auth/">
<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Aetoskia Auth Server</title>
<link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.css">
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="teal">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#aetoskia-auth-server-central-identity-for-the-aetos-platform" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="." title="Aetoskia Auth Server" class="md-header__button md-logo" aria-label="Aetoskia Auth Server" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7 14c-1.1 0-2-.9-2-2s.9-2 2-2 2 .9 2 2-.9 2-2 2m5.6-4c-.8-2.3-3-4-5.6-4-3.3 0-6 2.7-6 6s2.7 6 6 6c2.6 0 4.8-1.7 5.6-4H16v4h4v-4h3v-4z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Aetoskia Auth Server
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Home
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item md-tabs__item--active">
<a href="." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="01_centralized_auth/" class="md-tabs__link">
Centralized Auth
</a>
</li>
<li class="md-tabs__item">
<a href="02_how_to_use/" class="md-tabs__link">
How To Use
</a>
</li>
<li class="md-tabs__item">
<a href="03_platform_integration/" class="md-tabs__link">
Platform Integration
</a>
</li>
<li class="md-tabs__item">
<a href="04_deployment/" class="md-tabs__link">
Deployment
</a>
</li>
<li class="md-tabs__item">
<a href="05_development/" class="md-tabs__link">
Development
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="." title="Aetoskia Auth Server" class="md-nav__button md-logo" aria-label="Aetoskia Auth Server" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7 14c-1.1 0-2-.9-2-2s.9-2 2-2 2 .9 2 2-.9 2-2 2m5.6-4c-.8-2.3-3-4-5.6-4-3.3 0-6 2.7-6 6s2.7 6 6 6c2.6 0 4.8-1.7 5.6-4H16v4h4v-4h3v-4z"/></svg>
</a>
Aetoskia Auth Server
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Home
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Home
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#key-features" class="md-nav__link">
<span class="md-ellipsis">
🚀 Key Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#endpoints-at-a-glance" class="md-nav__link">
<span class="md-ellipsis">
⚡ Endpoints at a Glance
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation-structure" class="md-nav__link">
<span class="md-ellipsis">
📁 Documentation Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#related-resources" class="md-nav__link">
<span class="md-ellipsis">
🔗 Related Resources
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="01_centralized_auth/" class="md-nav__link">
<span class="md-ellipsis">
Centralized Auth
</span>
</a>
</li>
<li class="md-nav__item">
<a href="02_how_to_use/" class="md-nav__link">
<span class="md-ellipsis">
How To Use
</span>
</a>
</li>
<li class="md-nav__item">
<a href="03_platform_integration/" class="md-nav__link">
<span class="md-ellipsis">
Platform Integration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="04_deployment/" class="md-nav__link">
<span class="md-ellipsis">
Deployment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="05_development/" class="md-nav__link">
<span class="md-ellipsis">
Development
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="aetoskia-auth-server-central-identity-for-the-aetos-platform">🔐 Aetoskia Auth Server — Central Identity for the Aetos Platform</h1>
<p>The <strong>Aetoskia Auth Server</strong> is the central identity service of the Aetos
Platform ecosystem. It issues, validates, and introspects short-lived JWT
access tokens against a single shared user store backed by MongoDB, so every
service can trust one issuer instead of shipping its own auth logic.</p>
<blockquote>
<p><strong>Doc model:</strong> this wiki is written for humans — howto guides, examples,
and deployment recipes. The authoritative API contracts live in the code
(GSDFC docstrings) and the interactive OpenAPI reference under <code>docs/api/</code>.</p>
</blockquote>
<hr />
<h2 id="key-features">🚀 Key Features</h2>
<ul>
<li>🔑 <strong>Centralized identity</strong> — one user database, one issuer, one secret</li>
<li>🎟️ <strong>Uniform token contract</strong> — every service verifies the same HS256 JWT</li>
<li>🧩 <strong>No auth code duplication</strong> — services delegate with <code>jwtlib</code> or a
generated OpenAPI dependency</li>
<li><strong>Instant revocation surface</strong><code>/introspect</code> gives services a live
<code>active</code> check rather than trusting expiry alone</li>
<li>🔓 <strong>Stateless logout</strong> — no server-side sessions; the client discards the token</li>
</ul>
<hr />
<h2 id="endpoints-at-a-glance">⚡ Endpoints at a Glance</h2>
<table>
<thead>
<tr>
<th>Method</th>
<th>Path</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td>POST</td>
<td><code>/register</code></td>
<td>Create a user account</td>
</tr>
<tr>
<td>POST</td>
<td><code>/login</code></td>
<td>Authenticate and issue a JWT</td>
</tr>
<tr>
<td>GET</td>
<td><code>/me</code></td>
<td>Current user (Bearer)</td>
</tr>
<tr>
<td>POST</td>
<td><code>/logout</code></td>
<td>Stateless logout (Bearer)</td>
</tr>
<tr>
<td>POST</td>
<td><code>/introspect</code></td>
<td>Service-to-service token verification</td>
</tr>
<tr>
<td>GET</td>
<td><code>/health</code></td>
<td>Health check</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="documentation-structure">📁 Documentation Structure</h2>
<table>
<thead>
<tr>
<th>Section</th>
<th>What you'll find</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="01_centralized_auth/">Centralized Auth</a></td>
<td>The identity model and how the ecosystem trusts the server</td>
</tr>
<tr>
<td><a href="02_how_to_use/">How to Use</a></td>
<td>Register, login, and call endpoints with tokens</td>
</tr>
<tr>
<td><a href="03_platform_integration/">Platform Integration</a></td>
<td>How services authenticate requests</td>
</tr>
<tr>
<td><a href="04_deployment/">Deployment</a></td>
<td>Environment, Docker, and CI/CD</td>
</tr>
<tr>
<td><a href="05_development/">Development</a></td>
<td>Local setup, tests, and regenerating docs</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="related-resources">🔗 Related Resources</h2>
<ul>
<li><strong>Source Code:</strong> <a href="https://git.aetoskia.com/aetos/auth-server">Gitea Repository</a></li>
<li><strong>API Reference:</strong> interactive Swagger UI rendered from <code>docs/api/openapi.json</code></li>
<li><strong>CI/CD:</strong> Drone pipeline ships tagged releases as <code>aetos/auth-server</code> images</li>
</ul>
<hr />
<p>© Aetoskia Internal — <code>auth-server</code> 0.0.5</p>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest", "navigation.tabs", "toc.integrate", "header.autohide", "announce.dismiss", "footer.social", "content.code.select", "content.code.line_numbers", "content.tooltips"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>