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

686
libs/py-jwt/site/models/app/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 md-tabs__item--active">
<a href="../" 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">
<a href="../../utils/" 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="">
@@ -448,6 +353,18 @@
@@ -455,7 +372,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -465,8 +381,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -475,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="true">
<label class="md-nav__title" for="__nav_3">
@@ -486,27 +409,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -575,6 +477,25 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.app--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.app-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.app.IntrospectRequest" class="md-nav__link">
<span class="md-ellipsis">
IntrospectRequest
@@ -640,6 +561,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -712,13 +638,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -727,7 +663,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="">
@@ -831,13 +767,21 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -846,7 +790,7 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -956,6 +900,25 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.app--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.app-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.app.IntrospectRequest" class="md-nav__link">
<span class="md-ellipsis">
IntrospectRequest
@@ -1021,6 +984,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1047,7 +1015,7 @@
<h2 id="jwtlib.models.app" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">jwtlib.models.app</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">jwtlib.models.app</span>
</h2>
@@ -1055,20 +1023,31 @@
<div class="doc doc-contents first">
<p>Authentication request and response models.</p>
<hr />
<h4 id="jwtlib.models.app--summary">Summary</h4>
<p>This module defines all <strong>typed data models</strong> used by the authentication
library for user registration, login, logout, and token introspection.</p>
<p>Model categories:
- Request payloads used by authentication workflows
<details class="notes" open>
<summary>Notes</summary>
<p><strong>Model Categories:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code>- Request payloads used by authentication workflows
- Public response models exposed to consumers
- Introspection responses used for service-to-service authentication</p>
<p>These models are:
- Fully typed (Pydantic v2)
- Introspection responses used for service-to-service authentication
</code></pre></div></td></tr></table></div>
<p><strong>Design Principles:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- Fully typed (Pydantic v2)
- Serialization-safe
- Framework-agnostic
- Suitable for both internal logic and external adapters</p>
<p>Persistence-layer models are intentionally excluded, except where explicitly
adapted into public representations.</p>
- Suitable for both internal logic and external adapters
</code></pre></div></td></tr></table></div>
</details>
<div class="doc doc-children">
@@ -1078,17 +1057,17 @@ adapted into public representations.</p>
<h3 id="jwtlib.models.app-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.app.IntrospectRequest" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">IntrospectRequest</span>
<h4 id="jwtlib.models.app.IntrospectRequest" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">IntrospectRequest</span>
</h3>
</h4>
<div class="doc doc-contents ">
@@ -1097,22 +1076,32 @@ adapted into public representations.</p>
<p>Payload for requesting token introspection.</p>
<p>Used by internal services to verify the validity of a JWT and retrieve
the associated public user information.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>token: JWT access token to introspect.</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.IntrospectRequest.token">token</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>JWT access token to introspect.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Intended for service-to-service communication.</li>
<li>Not meant for direct end-user consumption.</li>
</ul>
</details>
@@ -1138,11 +1127,11 @@ the associated public user information.</p>
<h3 id="jwtlib.models.app.IntrospectResponse" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">IntrospectResponse</span>
<h4 id="jwtlib.models.app.IntrospectResponse" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">IntrospectResponse</span>
</h3>
</h4>
<div class="doc doc-contents ">
@@ -1151,23 +1140,43 @@ the associated public user information.</p>
<p>Result of a token introspection operation.</p>
<p>This model communicates whether a JWT is valid and, if so, provides
the associated public user information.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>active: Indicates whether the token is valid and active.
user: Public user details if the token is valid; otherwise null.</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.IntrospectResponse.active">active</span></code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Indicates whether the token is valid and active.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.IntrospectResponse.user">user</span></code></td>
<td>
<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title="jwtlib.models.app.PublicUser" href="#jwtlib.models.app.PublicUser">PublicUser</a>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Public user details if the token is valid; otherwise null.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>This model is designed to avoid raising exceptions.</li>
<li>All introspection outcomes are represented as data.</li>
</ul>
</details>
@@ -1193,35 +1202,56 @@ user: Public user details if the token is valid; otherwise null.</p>
<h3 id="jwtlib.models.app.LoginRequest" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">LoginRequest</span>
<h4 id="jwtlib.models.app.LoginRequest" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">LoginRequest</span>
</h3>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="jwtlib.models.common.IdentityMixin">IdentityMixin</span></code>, <code><span title="jwtlib.models.common.PasswordMixin">PasswordMixin</span></code></p>
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.models.common.IdentityMixin" href="../common/#jwtlib.models.common.IdentityMixin">IdentityMixin</a></code>, <code><a class="autorefs autorefs-internal" title="jwtlib.models.common.PasswordMixin" href="../common/#jwtlib.models.common.PasswordMixin">PasswordMixin</a></code></p>
<p>Payload for authenticating a user and issuing a JWT.</p>
<p>This model is used to verify user credentials and request an access token.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>username: Username identifier.
password: Plain-text password to be verified.</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.LoginRequest.username">username</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Username identifier.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.LoginRequest.password">password</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Plain-text password to be verified.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Successful authentication results in a LoginResponse.</li>
<li>Failed authentication raises an AuthError.</li>
</ul>
</details>
@@ -1247,11 +1277,11 @@ password: Plain-text password to be verified.</p>
<h3 id="jwtlib.models.app.LoginResponse" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">LoginResponse</span>
<h4 id="jwtlib.models.app.LoginResponse" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">LoginResponse</span>
</h3>
</h4>
<div class="doc doc-contents ">
@@ -1260,23 +1290,43 @@ password: Plain-text password to be verified.</p>
<p>Response returned after successful authentication.</p>
<p>Contains the issued JWT access token and the authenticated user's
public profile.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>access_token: JWT access token for authenticated requests.
user: Public profile of the authenticated user.</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.LoginResponse.access_token">access_token</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>JWT access token for authenticated requests.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.LoginResponse.user">user</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="jwtlib.models.app.PublicUser" href="#jwtlib.models.app.PublicUser">PublicUser</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Public profile of the authenticated user.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>The token is stateless and must be stored client-side.</li>
<li>Token expiration and validation are handled elsewhere.</li>
</ul>
</details>
@@ -1302,11 +1352,11 @@ user: Public profile of the authenticated user.</p>
<h3 id="jwtlib.models.app.LogoutResponse" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">LogoutResponse</span>
<h4 id="jwtlib.models.app.LogoutResponse" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">LogoutResponse</span>
</h3>
</h4>
<div class="doc doc-contents ">
@@ -1315,14 +1365,32 @@ user: Public profile of the authenticated user.</p>
<p>Response returned after a logout operation.</p>
<p>Since logout is stateless, this response serves only as a confirmation
message instructing the client to discard its token.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>message: Human-readable logout confirmation.</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.LogoutResponse.message">message</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Human-readable logout confirmation.</p>
</div>
</td>
</tr>
</tbody>
</table>
@@ -1348,37 +1416,67 @@ message instructing the client to discard its token.</p>
<h3 id="jwtlib.models.app.PublicUser" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">PublicUser</span>
<h4 id="jwtlib.models.app.PublicUser" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">PublicUser</span>
</h3>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="jwtlib.models.common.IdentityMixin">IdentityMixin</span></code>, <code><span title="jwtlib.models.common.ActiveStateMixin">ActiveStateMixin</span></code></p>
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.models.common.IdentityMixin" href="../common/#jwtlib.models.common.IdentityMixin">IdentityMixin</a></code>, <code><a class="autorefs autorefs-internal" title="jwtlib.models.common.ActiveStateMixin" href="../common/#jwtlib.models.common.ActiveStateMixin">ActiveStateMixin</a></code></p>
<p>Public-facing user representation returned by authentication APIs.</p>
<p>This model represents a user profile that is safe to expose outside
the authentication system.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>username: Unique username identifier.
email: User's email address.
is_active: Whether the user account is active.</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.PublicUser.username">username</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Unique username identifier.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.PublicUser.email">email</span></code></td>
<td>
<code>EmailStr</code>
</td>
<td>
<div class="doc-md-description">
<p>User's email address.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.PublicUser.is_active">is_active</span></code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether the user account is active.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Contains no sensitive data.</li>
<li>Can be constructed from persistence models via <code>from_attributes</code>.</li>
</ul>
</details>
@@ -1404,37 +1502,67 @@ is_active: Whether the user account is active.</p>
<h3 id="jwtlib.models.app.RegisterRequest" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">RegisterRequest</span>
<h4 id="jwtlib.models.app.RegisterRequest" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">RegisterRequest</span>
</h3>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="jwtlib.models.common.IdentityMixin">IdentityMixin</span></code>, <code><span title="jwtlib.models.common.PasswordMixin">PasswordMixin</span></code></p>
Bases: <code><a class="autorefs autorefs-internal" title="jwtlib.models.common.IdentityMixin" href="../common/#jwtlib.models.common.IdentityMixin">IdentityMixin</a></code>, <code><a class="autorefs autorefs-internal" title="jwtlib.models.common.PasswordMixin" href="../common/#jwtlib.models.common.PasswordMixin">PasswordMixin</a></code></p>
<p>Payload for registering a new user account.</p>
<p>This model contains the minimum required identity and credential
information to create a new user.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>username: Unique username identifier.
email: User's email address.
password: Plain-text password (to be hashed by the repository layer).</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.RegisterRequest.username">username</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Unique username identifier.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.RegisterRequest.email">email</span></code></td>
<td>
<code>EmailStr</code>
</td>
<td>
<div class="doc-md-description">
<p>User's email address.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.app.RegisterRequest.password">password</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Plain-text password (to be hashed by the repository layer).</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Validation and normalization handled by mixins.</li>
<li>This model is never returned in responses.</li>
</ul>
</details>
@@ -1481,6 +1609,8 @@ password: Plain-text password (to be hashed by the repository layer).</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>
@@ -1518,7 +1648,7 @@ password: Plain-text password (to be hashed by the repository layer).</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>

554
libs/py-jwt/site/models/common/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 md-tabs__item--active">
<a href="../" 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">
<a href="../../utils/" 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="">
@@ -448,6 +353,18 @@
@@ -455,7 +372,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -465,8 +381,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -475,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="true">
<label class="md-nav__title" for="__nav_3">
@@ -486,27 +409,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -617,6 +519,63 @@
</span>
</a>
<nav class="md-nav" aria-label="common">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.common--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.common-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.common.ActiveStateMixin" class="md-nav__link">
<span class="md-ellipsis">
ActiveStateMixin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.common.IdentityMixin" class="md-nav__link">
<span class="md-ellipsis">
IdentityMixin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.common.PasswordMixin" class="md-nav__link">
<span class="md-ellipsis">
PasswordMixin
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -643,13 +602,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -658,7 +627,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="">
@@ -762,13 +731,21 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -777,7 +754,7 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -883,6 +860,63 @@
</span>
</a>
<nav class="md-nav" aria-label="common">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.common--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.common-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.common.ActiveStateMixin" class="md-nav__link">
<span class="md-ellipsis">
ActiveStateMixin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.common.IdentityMixin" class="md-nav__link">
<span class="md-ellipsis">
IdentityMixin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.common.PasswordMixin" class="md-nav__link">
<span class="md-ellipsis">
PasswordMixin
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -909,13 +943,75 @@
<h2 id="jwtlib.models.common" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">jwtlib.models.common</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">jwtlib.models.common</span>
</h2>
<div class="doc doc-contents first">
<p>Common Pydantic mixins for authentication models.</p>
<hr />
<h4 id="jwtlib.models.common--summary">Summary</h4>
<p>This module provides reusable mixins for identity, password, and
account state. These mixes ensure consistency across internal
persistence models and public-facing projection models.</p>
<div class="doc doc-children">
<h3 id="jwtlib.models.common-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h4 id="jwtlib.models.common.ActiveStateMixin" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ActiveStateMixin</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
<p>Mixin for entities with an active status flag.</p>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.common.ActiveStateMixin.is_active">is_active</span></code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Indicates whether the account is active and allowed to authenticate.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
@@ -930,6 +1026,154 @@
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h4 id="jwtlib.models.common.IdentityMixin" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">IdentityMixin</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
<p>Mixin for entities with a username and email.</p>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.common.IdentityMixin.username">username</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Unique username used for authentication and display.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.common.IdentityMixin.email">email</span></code></td>
<td>
<code><span title="typing.Optional">Optional</span>[<span title="pydantic.EmailStr">EmailStr</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Primary email address associated with the account.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h4 id="jwtlib.models.common.PasswordMixin" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">PasswordMixin</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
<p>Mixin for entities with a raw password field.</p>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.common.PasswordMixin.password">password</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>User password (minimum 6 characters).</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
</div>
</div>
</div>
</div>
</div>
@@ -952,6 +1196,8 @@
</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>
@@ -989,7 +1235,7 @@
<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>

1138
libs/py-jwt/site/models/index.html
View File

File diff suppressed because it is too large Load Diff

333
libs/py-jwt/site/models/mongo/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="../" class="md-tabs__link">
Data & Models
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../../repository/" class="md-tabs__link">
Persistence & Security
</a>
</li>
<li class="md-tabs__item">
<a href="../../utils/" 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="../" 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="../" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -590,6 +495,14 @@
@@ -597,7 +510,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -717,6 +629,25 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.mongo--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.mongo-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.mongo.User" class="md-nav__link">
<span class="md-ellipsis">
User
@@ -728,6 +659,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -777,13 +713,21 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -792,7 +736,7 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -902,6 +846,25 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.mongo--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.mongo-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.mongo.User" class="md-nav__link">
<span class="md-ellipsis">
User
@@ -913,6 +876,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -939,14 +907,16 @@
<h2 id="jwtlib.models.mongo" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">jwtlib.models.mongo</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">jwtlib.models.mongo</span>
</h2>
<div class="doc doc-contents first">
<p>Persistence-layer user model.</p>
<p>Persistence-layer user model for MongoDB.</p>
<hr />
<h4 id="jwtlib.models.mongo--summary">Summary</h4>
<p>This module defines the internal database representation of a user.
It is used exclusively by the repository and persistence layers and
must never be exposed directly to consumers.</p>
@@ -961,43 +931,60 @@ must never be exposed directly to consumers.</p>
<h3 id="jwtlib.models.mongo-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.mongo.User" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">User</span>
<h4 id="jwtlib.models.mongo.User" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">User</span>
</h3>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="mongo_ops.BaseDocument">BaseDocument</span></code>, <code><span title="jwtlib.models.common.IdentityMixin">IdentityMixin</span></code>, <code><span title="jwtlib.models.common.ActiveStateMixin">ActiveStateMixin</span></code></p>
Bases: <code><span title="mongo_ops.BaseDocument">BaseDocument</span></code>, <code><a class="autorefs autorefs-internal" title="jwtlib.models.common.IdentityMixin" href="../common/#jwtlib.models.common.IdentityMixin">IdentityMixin</a></code>, <code><a class="autorefs autorefs-internal" title="jwtlib.models.common.ActiveStateMixin" href="../common/#jwtlib.models.common.ActiveStateMixin">ActiveStateMixin</a></code></p>
<p>Internal user persistence model.</p>
<p>Represents a user record as stored in the database. This model
includes sensitive fields and is strictly confined to the
persistence layer.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>hashed_password: Secure hash of the user's password.</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.mongo.User.hashed_password">hashed_password</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Secure hash of the user's password.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>This model MUST NOT be returned from authentication APIs.</li>
<li>Consumers should use <code>PublicUser</code> instead.</li>
<li>Password verification is handled by the repository layer.</li>
<li>Inherits identity and active-state behavior via mixins.</li>
</ul>
<p><strong>Responsibilities:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Represents a user record as stored in the database. Includes sensitive fields and is strictly confined to the persistence layer.
</code></pre></div></td></tr></table></div>
<p><strong>Guarantees:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- This model MUST NOT be returned from authentication APIs. Consumers should use `PublicUser` instead. Password verification is handled by the repository layer.
</code></pre></div></td></tr></table></div>
</details>
@@ -1045,6 +1032,8 @@ persistence layer.</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>
@@ -1082,7 +1071,7 @@ persistence layer.</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>

342
libs/py-jwt/site/models/security/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 md-tabs__item--active">
<a href="../" 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">
<a href="../../utils/" 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="">
@@ -448,6 +353,18 @@
@@ -455,7 +372,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -465,8 +381,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -475,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="true">
<label class="md-nav__title" for="__nav_3">
@@ -486,27 +409,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -598,6 +500,25 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.security--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.security-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.security.TokenPayload" class="md-nav__link">
<span class="md-ellipsis">
TokenPayload
@@ -609,6 +530,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -658,13 +584,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -673,7 +609,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="">
@@ -777,13 +713,21 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -792,7 +736,7 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -902,6 +846,25 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.security--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#jwtlib.models.security-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#jwtlib.models.security.TokenPayload" class="md-nav__link">
<span class="md-ellipsis">
TokenPayload
@@ -913,6 +876,11 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -939,7 +907,7 @@
<h2 id="jwtlib.models.security" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">jwtlib.models.security</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">jwtlib.models.security</span>
</h2>
@@ -947,6 +915,8 @@
<div class="doc doc-contents first">
<p>JWT token payload models.</p>
<hr />
<h4 id="jwtlib.models.security--summary">Summary</h4>
<p>This module defines typed representations of decoded JWT payloads used
internally for token validation and user resolution.</p>
@@ -959,17 +929,17 @@ internally for token validation and user resolution.</p>
<h3 id="jwtlib.models.security-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="jwtlib.models.security.TokenPayload" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">TokenPayload</span>
<h4 id="jwtlib.models.security.TokenPayload" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TokenPayload</span>
</h3>
</h4>
<div class="doc doc-contents ">
@@ -978,24 +948,52 @@ internally for token validation and user resolution.</p>
<p>Decoded JWT payload.</p>
<p>Represents the validated claims extracted from a JWT after signature
verification. This model is used internally to enforce required claims
and provide a typed interface to token data.</p>
<details class="fields" open>
<summary>Fields</summary>
<p>sub: Subject claim identifying the user (typically a username or user ID).
exp: Expiration time as a Unix timestamp (seconds since epoch).</p>
</details>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.security.TokenPayload.sub">sub</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Subject claim identifying the user (typically a username or user ID).</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="jwtlib.models.security.TokenPayload.exp">exp</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Expiration time as a Unix timestamp (seconds since epoch).</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>This model assumes the JWT signature has already been verified.</li>
<li>No authorization decisions should be made solely on this model.</li>
<li>Additional claims may exist but are intentionally ignored.</li>
</ul>
<p><strong>Responsibilities:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Represents the validated claims extracted from a JWT after signature verification. This model is used internally to enforce required claims and provide a typed interface to token data.
</code></pre></div></td></tr></table></div>
<p><strong>Guarantees:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- This model assumes the JWT signature has already been verified. No authorization decisions should be made solely on this model. Additional claims may exist but are intentionally ignored.
</code></pre></div></td></tr></table></div>
</details>
@@ -1043,6 +1041,8 @@ exp: Expiration time as a Unix timestamp (seconds since epoch).</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>
@@ -1080,7 +1080,7 @@ exp: Expiration time as a Unix timestamp (seconds since epoch).</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>