aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Build: 0.1.8
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-03-08 01:01:39 +05:30
parent 8701bf92ac
commit 9191de9dff
200 changed files with 130793 additions and 18277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

496
libs/py-jwt/site/utils/index.html
View File

@@ -86,7 +86,9 @@
<header class="md-header" data-md-component="header">
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
@@ -151,12 +153,19 @@
</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>
@@ -182,116 +191,6 @@
<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">
<a href="../app/" class="md-tabs__link">
Authentication Logic
</a>
</li>
<li class="md-tabs__item">
<a href="../models/" class="md-tabs__link">
Data & Models
</a>
</li>
<li class="md-tabs__item">
<a href="../repository/" class="md-tabs__link">
Persistence & Security
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Support & Utilities
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
@@ -305,10 +204,8 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
@@ -351,13 +248,21 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -366,7 +271,7 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
@@ -447,13 +352,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -462,8 +381,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../models/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -472,8 +392,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
@@ -483,27 +409,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../models/" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -589,13 +494,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -604,7 +519,7 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -710,13 +625,18 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -813,14 +733,33 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.utils--auth-utilities-token-validation-and-user-resolution" class="md-nav__link">
<a href="#jwtlib.utils--summary" class="md-nav__link">
<span class="md-ellipsis">
Auth Utilities: Token validation and user resolution
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.utils-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.utils-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.utils.get_current_user" class="md-nav__link">
<span class="md-ellipsis">
@@ -828,6 +767,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.utils.get_user_repository" class="md-nav__link">
<span class="md-ellipsis">
get_user_repository
</span>
</a>
</li>
<li class="md-nav__item">
@@ -842,6 +790,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -920,14 +873,33 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.utils--auth-utilities-token-validation-and-user-resolution" class="md-nav__link">
<a href="#jwtlib.utils--summary" class="md-nav__link">
<span class="md-ellipsis">
Auth Utilities: Token validation and user resolution
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.utils-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.utils-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.utils.get_current_user" class="md-nav__link">
<span class="md-ellipsis">
@@ -935,6 +907,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.utils.get_user_repository" class="md-nav__link">
<span class="md-ellipsis">
get_user_repository
</span>
</a>
</li>
<li class="md-nav__item">
@@ -949,6 +930,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -975,14 +961,16 @@
<h2 id="jwtlib.utils" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">jwtlib.utils</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">jwtlib.utils</span>
</h2>
<div class="doc doc-contents first">
<h3 id="jwtlib.utils--auth-utilities-token-validation-and-user-resolution">Auth Utilities: Token validation and user resolution</h3>
<p>Auth Utilities: Token validation and user resolution.</p>
<hr />
<h4 id="jwtlib.utils--summary">Summary</h4>
<p>This module provides high-level helpers for validating JWT payloads and
resolving users, intended for use in dependency injection or middleware.</p>
@@ -995,29 +983,95 @@ resolving users, intended for use in dependency injection or middleware.</p>
<h3 id="jwtlib.utils-classes">Classes</h3>
<h3 id="jwtlib.utils-functions">Functions</h3>
<div class="doc doc-object doc-function">
<h3 id="jwtlib.utils.get_current_user" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_current_user</span>
<h4 id="jwtlib.utils.get_current_user" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_current_user</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-async"><code>async</code></small>
</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_current_user</span><span class="p">(</span><span class="n">token</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">repo</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">UserRepository</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">PublicUser</span>
</code></pre></div>
</h4>
<div class="language-python doc-signature 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></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 class="nf">get_current_user</span><span class="p">(</span><span class="n">token</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">repo</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">UserRepository</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">PublicUser</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Validate token and return authenticated public user.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>token</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>The JWT string to validate.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>repo</code></td>
<td>
<code><a class="autorefs autorefs-internal" title="jwtlib.repository.UserRepository" href="../jwtlib/repository/#jwtlib.repository.UserRepository">UserRepository</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The user repository to use for resolution.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>PublicUser</code></td> <td>
<code><a class="autorefs autorefs-internal" title="jwtlib.models.PublicUser" href="../models/#jwtlib.models.PublicUser">PublicUser</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The resolved and validated user object.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
@@ -1029,7 +1083,7 @@ resolving users, intended for use in dependency injection or middleware.</p>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.InvalidToken" href="../exceptions/#jwtlib.exceptions.InvalidToken">InvalidToken</a></code>
<code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.InvalidToken" href="../jwtlib/exceptions/#jwtlib.exceptions.InvalidToken">InvalidToken</a></code>
</td>
<td>
<div class="doc-md-description">
@@ -1039,7 +1093,7 @@ resolving users, intended for use in dependency injection or middleware.</p>
</tr>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.UserNotFound" href="../exceptions/#jwtlib.exceptions.UserNotFound">UserNotFound</a></code>
<code><a class="autorefs autorefs-internal" title="jwtlib.exceptions.UserNotFound" href="../jwtlib/exceptions/#jwtlib.exceptions.UserNotFound">UserNotFound</a></code>
</td>
<td>
<div class="doc-md-description">
@@ -1057,19 +1111,113 @@ resolving users, intended for use in dependency injection or middleware.</p>
<div class="doc doc-object doc-function">
<h3 id="jwtlib.utils.get_validated_token_payload" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_validated_token_payload</span>
<h4 id="jwtlib.utils.get_user_repository" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_user_repository</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_validated_token_payload</span><span class="p">(</span><span class="n">token</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TokenPayload</span>
</code></pre></div>
</h4>
<div class="language-python doc-signature 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></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 class="nf">get_user_repository</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">UserRepository</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Return a singleton or new instance of the UserRepository.</p>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>UserRepository</code></td> <td>
<code><a class="autorefs autorefs-internal" title="jwtlib.repository.UserRepository" href="../jwtlib/repository/#jwtlib.repository.UserRepository">UserRepository</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The user repository instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc doc-object doc-function">
<h4 id="jwtlib.utils.get_validated_token_payload" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_validated_token_payload</span>
</h4>
<div class="language-python doc-signature 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></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 class="nf">get_validated_token_payload</span><span class="p">(</span><span class="n">token</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TokenPayload</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Validate a JWT and return a typed payload.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>token</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>The JWT string to validate.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>TokenPayload</code></td> <td>
<code><a class="autorefs autorefs-internal" title="jwtlib.models.TokenPayload" href="../models/#jwtlib.models.TokenPayload">TokenPayload</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The validated and typed token payload.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
@@ -1085,7 +1233,7 @@ resolving users, intended for use in dependency injection or middleware.</p>
</td>
<td>
<div class="doc-md-description">
<p>if the token is invalid or malformed</p>
<p>If the token is invalid or malformed.</p>
</div>
</td>
</tr>
@@ -1120,6 +1268,8 @@ resolving users, intended for use in dependency injection or middleware.</p>
</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>
@@ -1157,7 +1307,7 @@ resolving users, intended for use in dependency injection or middleware.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "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 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"], "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>