git.schokokeks.org
Repositories
Help
Report an Issue
derivepassphrase.git
Code
Commits
Branches
Tags
Suche
Strukturansicht:
382c592
Branches
Tags
documentation-tree
master
unstable/cli-parser-state-machine
wishlist
0.1.0
0.1.1
0.1.2
0.1.3
0.2.0
0.3.0
0.3.1
0.3.2
0.3.3
0.4.0
0.5
0.5.1
0.5.2
0.6
0.6.1
ssh-agent-socket-provider-1.0
derivepassphrase.git
0.x
reference
types
index.html
Deployed df459996c5d0 to 0.x with MkDocs 1.6.1 and mike 2.1.3
Marco Ricci
commited
382c592
at 2024-09-12 14:12:34
index.html
Blame
History
Raw
<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <meta name="description" content="An almost faithful Python reimplementation of James Coglan's vault."> <meta name="author" content="Marco Ricci"> <link rel="canonical" href="https://the13thletter.info/derivepassphrase/0.x/reference/types/"> <link rel="prev" href="../ssh_agent/"> <link rel="next" href="../vault/"> <link rel="icon" href="../../assets/images/favicon.png"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34"> <title>Submodule _types - derivepassphrase</title> <link rel="stylesheet" href="../../assets/stylesheets/main.35f28582.min.css"> <style>:root{--md-text-font:"Noto Sans";--md-code-font:"Noto Mono"}</style> <link rel="stylesheet" href="../../assets/_mkdocstrings.css"> <link rel="stylesheet" href="../../mkdocstrings_recommended_styles.css"> </head> <body dir="ltr"> <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="#derivepassphrase._types" class="md-skip"> Skip to content </a> </div> <div data-md-component="announce"> </div> <div data-md-color-scheme="default" data-md-component="outdated" hidden> </div> <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"> Overview </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href="../" class="md-tabs__link"> Reference </a> </li> <li class="md-tabs__item"> <a href="../../changelog/" class="md-tabs__link"> Changelog </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" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a href="../.." title="derivepassphrase" class="md-nav__button md-logo" aria-label="derivepassphrase" data-md-component="logo"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> derivepassphrase </label> <div class="md-nav__source"> <a href="https://github.com/the-13th-letter/derivepassphrase" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class="md-source__repository"> the-13th-letter/derivepassphrase </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../.." class="md-nav__link"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked> <div class="md-nav__link md-nav__container"> <a href="../" class="md-nav__link "> <span class="md-ellipsis"> Reference </span> </a> <label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex=""> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_2"> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../derivepassphrase.1/" class="md-nav__link"> <span class="md-ellipsis"> Man page: derivepassphrase </span> </a> </li> <li class="md-nav__item"> <a href="../derivepassphrase-vault.1/" class="md-nav__link"> <span class="md-ellipsis"> Man page: derivepassphrase-vault </span> </a> </li> <li class="md-nav__item"> <a href="../derivepassphrase-export.1/" class="md-nav__link"> <span class="md-ellipsis"> Man page: derivepassphrase-export </span> </a> </li> <li class="md-nav__item"> <a href="../derivepassphrase-export-vault.1/" class="md-nav__link"> <span class="md-ellipsis"> Man page: derivepassphrase-export-vault </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_6" checked> <label class="md-nav__link" for="__nav_2_6" id="__nav_2_6_label" tabindex=""> <span class="md-ellipsis"> Module derivepassphrase </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_6_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_2_6"> <span class="md-nav__icon md-icon"></span> Module derivepassphrase </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../derivepassphrase/" class="md-nav__link"> <span class="md-ellipsis"> Submodule cli </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_6_2" > <label class="md-nav__link" for="__nav_2_6_2" id="__nav_2_6_2_label" tabindex="0"> <span class="md-ellipsis"> Subpackage exporter </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_6_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_6_2"> <span class="md-nav__icon md-icon"></span> Subpackage exporter </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../exporter/" class="md-nav__link"> <span class="md-ellipsis"> Subpackage exporter </span> </a> </li> <li class="md-nav__item"> <a href="../exporter_vault/" class="md-nav__link"> <span class="md-ellipsis"> Exporters for vault </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../sequin/" class="md-nav__link"> <span class="md-ellipsis"> Submodule sequin </span> </a> </li> <li class="md-nav__item"> <a href="../ssh_agent/" class="md-nav__link"> <span class="md-ellipsis"> Submodule ssh_agent </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"> Submodule _types </span> <span class="md-nav__icon md-icon"></span> </label> <a href="./" class="md-nav__link md-nav__link--active"> <span class="md-ellipsis"> Submodule _types </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="#derivepassphrase._types" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> _types </span> </a> <nav class="md-nav" aria-label=" _types"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#derivepassphrase._types.VaultConfigGlobalSettings" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> VaultConfigGlobalSettings </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.VaultConfigServicesSettings" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> VaultConfigServicesSettings </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.VaultConfig" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> VaultConfig </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.KeyCommentPair" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> KeyCommentPair </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.SSH_AGENTC" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> SSH_AGENTC </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.SSH_AGENT" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> SSH_AGENT </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.is_vault_config" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-function"></code> is_vault_config </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../vault/" class="md-nav__link"> <span class="md-ellipsis"> Submodule vault </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../changelog/" class="md-nav__link"> <span class="md-ellipsis"> Changelog </span> </a> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <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="#derivepassphrase._types" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> _types </span> </a> <nav class="md-nav" aria-label=" _types"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#derivepassphrase._types.VaultConfigGlobalSettings" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> VaultConfigGlobalSettings </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.VaultConfigServicesSettings" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> VaultConfigServicesSettings </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.VaultConfig" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> VaultConfig </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.KeyCommentPair" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> KeyCommentPair </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.SSH_AGENTC" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> SSH_AGENTC </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.SSH_AGENT" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> SSH_AGENT </span> </a> </li> <li class="md-nav__item"> <a href="#derivepassphrase._types.is_vault_config" class="md-nav__link"> <span class="md-ellipsis"> <code class="doc-symbol doc-symbol-toc doc-symbol-function"></code> is_vault_config </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <a href="https://github.com/the-13th-letter/derivepassphrase/raw/master/docs/reference/types.md" title="View source of this page" class="md-content__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg> </a> <h1>Submodule _types</h1> <div class="doc doc-object doc-module"> <h2 id="derivepassphrase._types" class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">derivepassphrase._types</span> <a href="#derivepassphrase._types" class="headerlink" title="Permanent link">¶</a></h2> <div class="doc doc-contents first"> <p>Types used by derivepassphrase.</p> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h3 id="derivepassphrase._types.VaultConfigGlobalSettings" class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">VaultConfigGlobalSettings</span> <a href="#derivepassphrase._types.VaultConfigGlobalSettings" class="headerlink" title="Permanent link">¶</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-external" title="typing_extensions.TypedDict" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.TypedDict">TypedDict</a></code></p> <p>Configuration for vault: global settings.</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="derivepassphrase._types.VaultConfigGlobalSettings.key">key</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>]</code> </td> <td> <div class="doc-md-description"> <p>The base64-encoded ssh public key to use, overriding the master passphrase. Optional.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigGlobalSettings.phrase">phrase</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>]</code> </td> <td> <div class="doc-md-description"> <p>The master passphrase. Optional.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigGlobalSettings.unicode_normalization_form">unicode_normalization_form</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" title="typing.Literal" href="https://docs.python.org/3/library/typing.html#typing.Literal">Literal</a>['NFC', 'NFD', 'NFKC', 'NFKD']]</code> </td> <td> <div class="doc-md-description"> <p>The preferred Unicode normalization form; we warn the user if textual passphrases do not match their normalized forms. Optional, and a <code>derivepassphrase</code> extension.</p> </div> </td> </tr> </tbody> </table> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id="derivepassphrase._types.VaultConfigServicesSettings" class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">VaultConfigServicesSettings</span> <a href="#derivepassphrase._types.VaultConfigServicesSettings" class="headerlink" title="Permanent link">¶</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-internal" title="derivepassphrase._types.VaultConfigGlobalSettings" href="#derivepassphrase._types.VaultConfigGlobalSettings">VaultConfigGlobalSettings</a></code></p> <p>Configuration for vault: services settings.</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="derivepassphrase._types.VaultConfigServicesSettings.notes">notes</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>]</code> </td> <td> <div class="doc-md-description"> <p>Optional notes for this service, to display to the user when generating the passphrase.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigServicesSettings.length">length</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</code> </td> <td> <div class="doc-md-description"> <p>Desired passphrase length.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigServicesSettings.repeat">repeat</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</code> </td> <td> <div class="doc-md-description"> <p>The maximum number of immediate character repetitions allowed in the passphrase. Disabled if set to 0.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigServicesSettings.lower">lower</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</code> </td> <td> <div class="doc-md-description"> <p>Optional constraint on ASCII lowercase characters. If positive, include this many lowercase characters somewhere in the passphrase. If 0, avoid lowercase characters altogether.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigServicesSettings.upper">upper</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</code> </td> <td> <div class="doc-md-description"> <p>Same as <code>lower</code>, but for ASCII uppercase characters.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigServicesSettings.number">number</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</code> </td> <td> <div class="doc-md-description"> <p>Same as <code>lower</code>, but for ASCII digits.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigServicesSettings.space">space</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</code> </td> <td> <div class="doc-md-description"> <p>Same as <code>lower</code>, but for the space character.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigServicesSettings.dash">dash</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</code> </td> <td> <div class="doc-md-description"> <p>Same as <code>lower</code>, but for the hyphen-minus and underscore characters.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfigServicesSettings.symbol">symbol</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</code> </td> <td> <div class="doc-md-description"> <p>Same as <code>lower</code>, but for all other hitherto unlisted ASCII printable characters (except backquote).</p> </div> </td> </tr> </tbody> </table> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id="derivepassphrase._types.VaultConfig" class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">VaultConfig</span> <a href="#derivepassphrase._types.VaultConfig" class="headerlink" title="Permanent link">¶</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-external" title="typing_extensions.TypedDict" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.TypedDict">TypedDict</a></code>, <code><span title="derivepassphrase._types._VaultConfig">_VaultConfig</span></code></p> <p>Configuration for vault.</p> <p>Usually stored as JSON.</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="derivepassphrase._types.VaultConfig.global">global</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.NotRequired" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.NotRequired">NotRequired</a>[<a class="autorefs autorefs-internal" title="derivepassphrase._types.VaultConfigGlobalSettings" href="#derivepassphrase._types.VaultConfigGlobalSettings">VaultConfigGlobalSettings</a>]</code> </td> <td> <div class="doc-md-description"> <p>Global settings.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.VaultConfig.services">services</span></code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.Required" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.Required">Required</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#dict">dict</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>, <a class="autorefs autorefs-internal" title="derivepassphrase._types.VaultConfigServicesSettings" href="#derivepassphrase._types.VaultConfigServicesSettings">VaultConfigServicesSettings</a>]]</code> </td> <td> <div class="doc-md-description"> <p>Service-specific settings.</p> </div> </td> </tr> </tbody> </table> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id="derivepassphrase._types.KeyCommentPair" class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">KeyCommentPair</span> <a href="#derivepassphrase._types.KeyCommentPair" class="headerlink" title="Permanent link">¶</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-external" title="typing.NamedTuple" href="https://docs.python.org/3/library/typing.html#typing.NamedTuple">NamedTuple</a></code></p> <p>SSH key plus comment pair. For typing purposes.</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="derivepassphrase._types.KeyCommentPair.key">key</span></code></td> <td> <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#bytes">bytes</a> | <a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#bytearray">bytearray</a></code> </td> <td> <div class="doc-md-description"> <p>SSH key.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.KeyCommentPair.comment">comment</span></code></td> <td> <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#bytes">bytes</a> | <a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#bytearray">bytearray</a></code> </td> <td> <div class="doc-md-description"> <p>SSH key comment.</p> </div> </td> </tr> </tbody> </table> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id="derivepassphrase._types.SSH_AGENTC" class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">SSH_AGENTC</span> <a href="#derivepassphrase._types.SSH_AGENTC" class="headerlink" title="Permanent link">¶</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-external" title="enum.Enum" href="https://docs.python.org/3/library/enum.html#enum.Enum">Enum</a></code></p> <p>SSH agent protocol numbers: client requests.</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="derivepassphrase._types.SSH_AGENTC.REQUEST_IDENTITIES">REQUEST_IDENTITIES</span></code></td> <td> <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a></code> </td> <td> <div class="doc-md-description"> <p>List identities. Expecting <code>SSH_AGENT.IDENTITIES_ANSWER</code>.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.SSH_AGENTC.SIGN_REQUEST">SIGN_REQUEST</span></code></td> <td> <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a></code> </td> <td> <div class="doc-md-description"> <p>Sign data. Expecting <code>SSH_AGENT.SIGN_RESPONSE</code>.</p> </div> </td> </tr> </tbody> </table> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id="derivepassphrase._types.SSH_AGENT" class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">SSH_AGENT</span> <a href="#derivepassphrase._types.SSH_AGENT" class="headerlink" title="Permanent link">¶</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-external" title="enum.Enum" href="https://docs.python.org/3/library/enum.html#enum.Enum">Enum</a></code></p> <p>SSH agent protocol numbers: server replies.</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="derivepassphrase._types.SSH_AGENT.FAILURE">FAILURE</span></code></td> <td> <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a></code> </td> <td> <div class="doc-md-description"> <p>Generic failure code.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.SSH_AGENT.SUCCESS">SUCCESS</span></code></td> <td> <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a></code> </td> <td> <div class="doc-md-description"> <p>Generic success code.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.SSH_AGENT.IDENTITIES_ANSWER">IDENTITIES_ANSWER</span></code></td> <td> <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a></code> </td> <td> <div class="doc-md-description"> <p>Successful answer to <code>SSH_AGENTC.REQUEST_IDENTITIES</code>.</p> </div> </td> </tr> <tr class="doc-section-item"> <td><code><span title="derivepassphrase._types.SSH_AGENT.SIGN_RESPONSE">SIGN_RESPONSE</span></code></td> <td> <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#int">int</a></code> </td> <td> <div class="doc-md-description"> <p>Successful answer to <code>SSH_AGENTC.SIGN_REQUEST</code>.</p> </div> </td> </tr> </tbody> </table> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-function"> <h3 id="derivepassphrase._types.is_vault_config" class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">is_vault_config</span> <a href="#derivepassphrase._types.is_vault_config" class="headerlink" title="Permanent link">¶</a></h3> <div class="doc-signature highlight"><pre><span></span><code><span class="nf">is_vault_config</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">TypeGuard</span><span class="p">[</span><span class="n">VaultConfig</span><span class="p">]</span> </code></pre></div> <div class="doc doc-contents "> <p>Check if <code>obj</code> is a valid vault config, according to typing.</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>obj</code></td> <td> <code><a class="autorefs autorefs-external" title="typing_extensions.Any" href="https://typing-extensions.readthedocs.io/en/latest/index.html#typing_extensions.Any">Any</a></code> </td> <td> <div class="doc-md-description"> <p>The object to test.</p> </div> </td> <td> <em>required</em> </td> </tr> </tbody> </table> <p><span class="doc-section-title">Returns:</span></p> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr class="doc-section-item"> <td> <code><a class="autorefs autorefs-external" title="typing.TypeGuard" href="https://docs.python.org/3/library/typing.html#typing.TypeGuard">TypeGuard</a>[<a class="autorefs autorefs-internal" title="derivepassphrase._types.VaultConfig" href="#derivepassphrase._types.VaultConfig">VaultConfig</a>]</code> </td> <td> <div class="doc-md-description"> <p>True if this is a vault config, false otherwise.</p> </div> </td> </tr> </tbody> </table> </div> </div> </div> </div> </div> </article> </div> </div> </main> <footer class="md-footer"> <nav class="md-footer__inner md-grid" aria-label="Footer" > <a href="../ssh_agent/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Submodule ssh_agent"> <div class="md-footer__button md-icon"> <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> </div> <div class="md-footer__title"> <span class="md-footer__direction"> Previous </span> <div class="md-ellipsis"> Submodule ssh_agent </div> </div> </a> <a href="../vault/" class="md-footer__link md-footer__link--next" aria-label="Next: Submodule vault"> <div class="md-footer__title"> <span class="md-footer__direction"> Next </span> <div class="md-ellipsis"> Submodule vault </div> </div> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> <div class="md-copyright__highlight"> Copyright © 2024 Marco Ricci (the-13th-letter) </div> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> and <a href="https://mkdocstrings.github.io/python/" target="_blank" rel="noopener"> mkdocstrings-python </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> </body> </html>