0.x/reference/derivepassphrase.1/index.html (5e5cfc6) - derivepassphrase.git

index.html

<!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/derivepassphrase.1/">
      
      
        <link rel="prev" href="../">
      
      
        <link rel="next" href="../derivepassphrase/">
      
      
      <link rel="icon" href="../../assets/images/favicon.png">
      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
    
    
      
        <title>Man page: derivepassphrase - derivepassphrase</title>
      
    
    
      <link rel="stylesheet" href="../../assets/stylesheets/main.3cba04c6.min.css">

</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">

</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"><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.81z"/></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>
        
          
          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Reference
  </span>

<span class="md-nav__icon md-icon"></span>
          </label>
        
        <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="../" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Reference overview
  </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">
    Man page: derivepassphrase
  </span>

<span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="./" class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    Man page: derivepassphrase
  </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="#name" class="md-nav__link">
    <span class="md-ellipsis">
      NAME
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#synopsis" class="md-nav__link">
    <span class="md-ellipsis">
      SYNOPSIS
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#description" class="md-nav__link">
    <span class="md-ellipsis">
      DESCRIPTION
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#options" class="md-nav__link">
    <span class="md-ellipsis">
      OPTIONS
    </span>
  </a>
  
    <nav class="md-nav" aria-label="OPTIONS">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#password-generation" class="md-nav__link">
    <span class="md-ellipsis">
      Password generation
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#configuration" class="md-nav__link">
    <span class="md-ellipsis">
      Configuration
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#storage-management" class="md-nav__link">
    <span class="md-ellipsis">
      Storage management
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#other-options" class="md-nav__link">
    <span class="md-ellipsis">
      Other Options
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#warnings" class="md-nav__link">
    <span class="md-ellipsis">
      WARNINGS
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#configuration_1" class="md-nav__link">
    <span class="md-ellipsis">
      CONFIGURATION
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#see-also" class="md-nav__link">
    <span class="md-ellipsis">
      SEE ALSO
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>

<li class="md-nav__item">
      <a href="../derivepassphrase/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Module derivepassphrase
  </span>

</a>
    </li>

<li class="md-nav__item">
      <a href="../sequin/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Module sequin
  </span>

</a>
    </li>

<li class="md-nav__item">
      <a href="../ssh_agent_client/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Module ssh_agent_client
  </span>

</a>
    </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">

<h1 id="derivepassphrase1">derivepassphrase(1)<a class="headerlink" href="#derivepassphrase1" title="Permanent link">&para;</a></h1>
<h2 id="name">NAME<a class="headerlink" href="#name" title="Permanent link">&para;</a></h2>
<p>derivepassphrase – derive a strong passphrase, deterministically, from
a master secret</p>
<h2 id="synopsis">SYNOPSIS<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>derivepassphrase [OPTIONS] [SERVICE]
</code></pre></div>
<h2 id="description">DESCRIPTION<a class="headerlink" href="#description" title="Permanent link">&para;</a></h2>
<p>Using a master passphrase or a master SSH key, derive a passphrase for
<i>SERVICE</i>, subject to length, character and character repetition
constraints.  The derivation is cryptographically strong, meaning that even
if a single passphrase is compromised, guessing the master passphrase or
a different service&rsquo;s passphrase is computationally infeasible.  The
derivation is also deterministic, given the same inputs, thus the resulting
passphrase need not be stored explicitly. The service name and constraints
themselves also need not be kept secret; the latter are usually stored in
a world-readable file.</p>
<p>If operating on global settings, or importing/exporting settings, then
<i>SERVICE</i> must be omitted.  Otherwise it is required.</p>
<h2 id="options">OPTIONS<a class="headerlink" href="#options" title="Permanent link">&para;</a></h2>
<h3 id="password-generation">Password generation<a class="headerlink" href="#password-generation" title="Permanent link">&para;</a></h3>
<dl>
<dt><b>-p</b>, <b>-</b><b>-phrase</b></dt>
<dd>prompts you for your passphrase</dd>
<dt><b>-k</b>, <b>-</b><b>-key</b></dt>
<dd>uses your SSH private key to generate passwords</dd>
<dt><b>-l</b>, <b>-</b><b>-length</b> <var>NUMBER</var></dt>
<dd>emits password of length <var>NUMBER</var></dd>
<dt><b>-r</b>, <b>-</b><b>-repeat</b> <var>NUMBER</var></dt>
<dd>allows maximum of <var>NUMBER</var> repeated adjacent chars</dd>
<dt><b>-</b><b>-lower</b> <var>NUMBER</var></dt>
<dd>includes at least <var>NUMBER</var> lowercase letters</dd>
<dt><b>-</b><b>-upper</b> <var>NUMBER</var></dt>
<dd>includes at least <var>NUMBER</var> uppercase letters</dd>
<dt><b>-</b><b>-number</b> <var>NUMBER</var></dt>
<dd>includes at least <var>NUMBER</var> digits</dd>
<dt><b>-</b><b>-space</b> <var>NUMBER</var></dt>
<dd>includes at least <var>NUMBER</var> spaces</dd>
<dt><b>-</b><b>-dash</b> <var>NUMBER</var></dt>
<dd>includes at least <var>NUMBER</var> <code>-</code> or <code>_</code></dd>
<dt><b>-</b><b>-symbol</b> <var>NUMBER</var></dt>
<dd>includes at least <var>NUMBER</var> symbol chars</dd>
</dl>
<p>Use <var>NUMBER</var>=0, e.g. <code>--symbol 0</code>, to exclude a character type from
the output.</p>
<h3 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h3>
<dl>
<dt><b>-n</b>, <b>-</b><b>-notes</b></dt>
<dd>spawn an editor to edit notes for <var>SERVICE</var></dd>
<dt><b>-c</b>, <b>-</b><b>-config</b></dt>
<dd>saves the given settings for <var>SERVICE</var> or global</dd>
<dt><b>-x</b>, <b>-</b><b>-delete</b></dt>
<dd>deletes settings for <var>SERVICE</var></dd>
<dt><b>-</b><b>-delete-globals</b></dt>
<dd>deletes the global shared settings</dd>
<dt><b>-X</b>, <b>-</b><b>-clear</b></dt>
<dd>deletes all settings</dd>
</dl>
<p>Use <code>$VISUAL</code> or <code>$EDITOR</code> to configure the spawned editor.</p>
<h3 id="storage-management">Storage management<a class="headerlink" href="#storage-management" title="Permanent link">&para;</a></h3>
<dl>
<dt><b>-e</b>, <b>-</b><b>-export</b> <var>PATH</var></dt>
<dd>export all saved settings into file <var>PATH</var></dd>
<dt><b>-i</b>, <b>-</b><b>-import</b> <var>PATH</var></dt>
<dd>import saved settings from file <var>PATH</var></dd>
</dl>
<p>Using <code>-</code> as <var>PATH</var> for standard input/standard output is supported.</p>
<h3 id="other-options">Other Options<a class="headerlink" href="#other-options" title="Permanent link">&para;</a></h3>
<dl>
<dt><b>&ndash;version</b></dt>
<dd>Show the version and exit.</dd>
<dt><b>-h</b>, <b>-</b><b>-help</b></dt>
<dd>Show this message and exit.</dd>
</dl>
<h2 id="warnings">WARNINGS<a class="headerlink" href="#warnings" title="Permanent link">&para;</a></h2>
<p>There is <strong>no way</strong> to retrieve the generated passphrases if the master
passphrase, the SSH key, or the exact passphrase settings are lost,
short of trying out all possible combinations.  You are <strong>strongly</strong>
advised to keep independent backups of the settings and the SSH key, if
any.</p>
<h2 id="configuration_1">CONFIGURATION<a class="headerlink" href="#configuration_1" title="Permanent link">&para;</a></h2>
<p>Configuration is stored in a directory according to the
<code>$DERIVEPASSPHRASE_PATH</code> variable, which defaults to <code>~/.derivepassphrase</code> on
UNIX-like systems and <code>C:\Users\&lt;user&gt;\AppData\Roaming\Derivepassphrase</code> on
Windows. The configuration is <strong>not</strong> encrypted, and you are <strong>strongly</strong>
discouraged from using a stored passphrase.</p>
<h2 id="see-also">SEE ALSO<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/jcoglan/vault">vault(1)</a></p>

</article>
            </div>
          
          
        </div>
        
      </main>
      
        <footer class="md-footer">
  
    
      
      <nav class="md-footer__inner md-grid" aria-label="Footer" >
        
          
          <a href="../" class="md-footer__link md-footer__link--prev" aria-label="Previous: Reference overview">
            <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 11h12Z"/></svg>
            </div>
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Previous
              </span>
              <div class="md-ellipsis">
                Reference overview
              </div>
            </div>
          </a>
        
        
          
          <a href="../derivepassphrase/" class="md-footer__link md-footer__link--next" aria-label="Next: Module derivepassphrase">
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Next
              </span>
              <div class="md-ellipsis">
                Module derivepassphrase
              </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 11H4Z"/></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 &copy; 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>

derivepassphrase.git

Deployed df4e33299f05 to 0.x with MkDocs 1.6.0 and mike 2.1.2