aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
lib-standardisation
docs/py-jwt/wiki/01_overview/index.html
Vishesh 'ironeagle' Bangotra b3b1c3404b feat: collect py-jwt wiki; register wiki kind; refresh lib and mcp artifacts 
Adds the py-jwt wiki to the hub alongside lib and mcp and picks up
the regenerated flat lib reference and standardized MCP modules.
2026-09-16 20:08:15 +05:30

746 lines
24 KiB
HTML
Raw Permalink Blame History

<!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="prev" href="..">
<link rel="next" href="../02_how_to_use/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Overview - py-jwt Documentation</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="#overview" 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="py-jwt Documentation" class="md-header__button md-logo" aria-label="py-jwt Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 1 3 5v6c0 5.55 3.84 10.74 9 12 5.16-1.26 9-6.45 9-12V5zm0 6c1.4 0 2.8 1.1 2.8 2.5V11c.6 0 1.2.6 1.2 1.3v3.5c0 .6-.6 1.2-1.3 1.2H9.2c-.6 0-1.2-.6-1.2-1.3v-3.5c0-.6.6-1.2 1.2-1.2V9.5C9.2 8.1 10.6 7 12 7m0 1.2c-.8 0-1.5.5-1.5 1.3V11h3V9.5c0-.8-.7-1.3-1.5-1.3"/></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">
py-jwt Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Overview
</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">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Overview
</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_integration/" class="md-tabs__link">
Framework Integration
</a>
</li>
<li class="md-tabs__item">
<a href="../04_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="py-jwt Documentation" class="md-nav__button md-logo" aria-label="py-jwt Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 1 3 5v6c0 5.55 3.84 10.74 9 12 5.16-1.26 9-6.45 9-12V5zm0 6c1.4 0 2.8 1.1 2.8 2.5V11c.6 0 1.2.6 1.2 1.3v3.5c0 .6-.6 1.2-1.3 1.2H9.2c-.6 0-1.2-.6-1.2-1.3v-3.5c0-.6.6-1.2 1.2-1.2V9.5C9.2 8.1 10.6 7 12 7m0 1.2c-.8 0-1.5.5-1.5 1.3V11h3V9.5c0-.8-.7-1.3-1.5-1.3"/></svg>
</a>
py-jwt Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<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">
Overview
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Overview
</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="#architecture" class="md-nav__link">
<span class="md-ellipsis">
🏗️ Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#public-api-layers" class="md-nav__link">
<span class="md-ellipsis">
🧩 Public API layers
</span>
</a>
<nav class="md-nav" aria-label="🧩 Public API layers">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#authentication-operations-jwtlibapp" class="md-nav__link">
<span class="md-ellipsis">
Authentication operations (jwtlib.app)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#introspection-helpers-jwtlibintrospection" class="md-nav__link">
<span class="md-ellipsis">
Introspection helpers (jwtlib.introspection)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#domain-models-jwtlibmodels" class="md-nav__link">
<span class="md-ellipsis">
Domain models (jwtlib.models)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#errors-jwtlibexceptions" class="md-nav__link">
<span class="md-ellipsis">
Errors (jwtlib.exceptions)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#security-posture" class="md-nav__link">
<span class="md-ellipsis">
🔒 Security posture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#read-next" class="md-nav__link">
<span class="md-ellipsis">
📚 Read Next
</span>
</a>
</li>
</ul>
</nav>
</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_integration/" class="md-nav__link">
<span class="md-ellipsis">
Framework Integration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../04_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="overview">🧠 Overview</h1>
<p><code>jwtlib</code> is a small, focused authentication library. It keeps transport
concerns out of auth logic so the same code backs an API service and a CLI or
test harness.</p>
<hr />
<h2 id="architecture">🏗️ Architecture</h2>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1"> 1</a></span>
<span class="normal"><a href="#__codelineno-0-2"> 2</a></span>
<span class="normal"><a href="#__codelineno-0-3"> 3</a></span>
<span class="normal"><a href="#__codelineno-0-4"> 4</a></span>
<span class="normal"><a href="#__codelineno-0-5"> 5</a></span>
<span class="normal"><a href="#__codelineno-0-6"> 6</a></span>
<span class="normal"><a href="#__codelineno-0-7"> 7</a></span>
<span class="normal"><a href="#__codelineno-0-8"> 8</a></span>
<span class="normal"><a href="#__codelineno-0-9"> 9</a></span>
<span class="normal"><a href="#__codelineno-0-10">10</a></span>
<span class="normal"><a href="#__codelineno-0-11">11</a></span>
<span class="normal"><a href="#__codelineno-0-12">12</a></span>
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
<span class="normal"><a href="#__codelineno-0-23">23</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>┌─────────────────────────────────────────────────────────────┐
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>│ Your application │
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a>│ (FastAPI / Flask / CLI / tests) │
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a>└───────────────────────────┬─────────────────────────────────┘
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a> │ coroutine API
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6"></a>┌───────────────────────────▼─────────────────────────────────┐
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7"></a>│ jwtlib.app │
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8"></a>│ register_user · login_user · get_logged_in_user │
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9"></a>│ logout_user · introspect_token │
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10"></a>├───────────────────────────┬─────────────────────────────────┤
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11"></a>│ jwtlib.introspection │ jwtlib.security (token ops) │
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12"></a>│ authenticate_request │ │
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13"></a>├───────────────────────────▼─────────────────────────────────┤
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14"></a>│ jwtlib.models │
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15"></a>│ RegisterRequest · LoginRequest · LoginResponse │
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16"></a>│ PublicUser · IntrospectRequest · IntrospectResponse │
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17"></a>│ TokenPayload · User │
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18"></a>├───────────────────────────┬─────────────────────────────────┤
</span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19"></a>│ jwtlib.repository │
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20"></a>│ UserRepository (MongoDB-backed default) │
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21"></a>│ ▲ │
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22"></a>│ inject your own repository for other backends │
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23"></a>└───────────────────────────┴─────────────────────────────────┘
</span></code></pre></div></td></tr></table></div>
<hr />
<h2 id="public-api-layers">🧩 Public API layers</h2>
<h3 id="authentication-operations-jwtlibapp">Authentication operations (<code>jwtlib.app</code>)</h3>
<table>
<thead>
<tr>
<th>Function</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>register_user(user, repo=None)</code></td>
<td>Create a user from <code>RegisterRequest</code></td>
</tr>
<tr>
<td><code>login_user(user, repo=None)</code></td>
<td>Verify credentials, issue an access token</td>
</tr>
<tr>
<td><code>get_logged_in_user(token, repo=None)</code></td>
<td>Resolve the token's subject to a user</td>
</tr>
<tr>
<td><code>logout_user()</code></td>
<td>Model the client-side logout signal</td>
</tr>
<tr>
<td><code>introspect_token(token, repo=None)</code></td>
<td>Verify a token and produce an introspection verdict</td>
</tr>
</tbody>
</table>
<p>Every operation is an <code>async</code> function; the default <code>UserRepository</code> is a
MongoDB-backed implementation of the repository contract.</p>
<h3 id="introspection-helpers-jwtlibintrospection">Introspection helpers (<code>jwtlib.introspection</code>)</h3>
<ul>
<li><code>introspect_token(token)</code> — decode and validate the JWT.</li>
<li><code>authenticate_request(token)</code> — pure authorization decision for request
guards (no framework context required).</li>
</ul>
<h3 id="domain-models-jwtlibmodels">Domain models (<code>jwtlib.models</code>)</h3>
<ul>
<li><strong>Requests:</strong> <code>RegisterRequest</code> (username, email, password),
<code>LoginRequest</code> (username, password), <code>IntrospectRequest</code> (token).</li>
<li><strong>Responses:</strong> <code>LoginResponse</code> (access_token + user), <code>LogoutResponse</code>
(message), <code>IntrospectResponse</code> (active + user or null).</li>
<li><strong>Payloads:</strong> <code>TokenPayload</code> (subject + expiry).</li>
<li><strong>Persistence:</strong> <code>User</code> (identity, active state) with optional email.</li>
<li><strong>Mixins:</strong> <code>IdentityMixin</code>, <code>PasswordMixin</code>, <code>ActiveStateMixin</code> for custom
repository models.</li>
</ul>
<h3 id="errors-jwtlibexceptions">Errors (<code>jwtlib.exceptions</code>)</h3>
<p><code>AuthError</code> is the base for <code>InvalidToken</code>, <code>InvalidAuthorizationHeader</code>,
<code>UserNotFound</code>, <code>AuthServiceUnavailable</code>, and <code>NotAuthenticated</code>.</p>
<hr />
<h2 id="security-posture">🔒 Security posture</h2>
<ul>
<li>Passwords are hashed during registration and compared only through the
repository's <code>authenticate_user</code>; hashes never leave the persistence layer.</li>
<li>Tokens are validated at introspection time (signature, expiry, subject).</li>
<li>The library returns typed verdict objects instead of raw framework errors, so
callers can map failures to their own HTTP semantics.</li>
</ul>
<hr />
<h2 id="read-next">📚 Read Next</h2>
<ul>
<li><a href="../02_how_to_use/">How to Use</a> — concrete coroutine flows.</li>
<li><a href="../03_integration/">Framework Integration</a> — FastAPI + resource servers.</li>
</ul>
</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>
Reference in New Issue View Git Blame Copy Permalink