derivepassphrase.git

@@ -1266,10 +1266,10 @@

 <p><a href="https://pypi.org/project/derivepassphrase"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/derivepassphrase.svg" /></a>

 <a href="https://pypi.org/project/derivepassphrase"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/derivepassphrase.svg" /></a></p>

 <p>An almost faithful Python reimplementation of <a href="https://www.npmjs.com/package/vault">James Coglan&rsquo;s <code>vault</code></a>, a deterministic password manager/generator.</p>

-<p>Using a master passphrase or a master SSH key, derive a passphrase for a given named service, 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’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>Using a master passphrase or a master SSH key, derive a passphrase for a given named service, subject to length, character and character repetition constraints.</p>

+<p>The derivation is <em>strong</em>: derived passphrases have as much entropy as permitted by the master passphrase and the passphrase constraints (whichever is more restrictive), and even if multiple derived passphrases are compromised, the master passphrase remains cryptographically difficult to discern from these compromised passphrases.

+The derivation is also <em>deterministic</em>, given the same inputs, thus the resulting passphrase need not be stored explicitly.</p>

+<p>The service name and constraints themselves also need not be kept secret; the latter are usually stored in a world-readable file to ease repeated entry of passphrase constraints.</p>

 <hr />

 <h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h2>

 <h3 id="with-pip">With <code>pip</code><a class="headerlink" href="#with-pip" title="Permanent link">&para;</a></h3>

@@ -1282,7 +1282,9 @@ The service name and constraints themselves also need not be kept secret; the la

 <h3 id="manually">Manually<a class="headerlink" href="#manually" title="Permanent link">&para;</a></h3>

 <p><code>derivepassphrase</code> is a pure Python package, and may be easily installed manually by placing the respective files and the package&rsquo;s dependencies into Python&rsquo;s import path.

 <code>derivepassphrase</code> requires Python 3.9 or higher as well as the <a href="https://pypi.org/project/typing-extensions/">typing-extensions package</a> for its core functionality and programmatic interface, and <a href="https://pypi.org/project/click/"><code>click</code></a> 8.1 or higher for its command-line interface.

+On Python 3.9 and 3.10 only, <code>derivepassphrase</code> additionally requires the <a href="https://pypi.org/project/tomli/">tomli package</a>.

 Using the <code>export vault</code> subcommand additionally requires the <a href="https://pypi.org/project/cryptography/">cryptography package</a>, version 38.0 or newer.</p>

+<p><code>derivepassphrase</code> works just fine on PyPy.</p>

 <h2 id="quick-usage">Quick Usage<a class="headerlink" href="#quick-usage" title="Permanent link">&para;</a></h2>

 <p><code>derivepassphrase</code> is designed to principally support multiple passphrase derivation schemes, but currently only the &ldquo;<a href="https://www.npmjs.com/package/vault">vault</a>&rdquo; scheme is implemented.</p>

 <p>Using the passphrase <code>This passphrase is for demonstration purposes only.</code> when prompted:</p>

@@ -1911,7 +1911,7 @@ Further details are contained in the variable part of the message.</p>

 <p>(Exactly what it says.)</p>

 </details>

 <details class="failure">

-<summary><code>Cannot update %s settings without actual settings.</code></summary>

+<summary><code>Cannot update the %s settings without actual settings.</code></summary>

 <p>Using <code>--config</code> requires at least one of the <code>--phrase</code>, <code>--key</code>, <code>--length</code>, etc. options.</p>

 </details>

 <details class="failure">

@@ -3254,6 +3254,29 @@ string is used as the binary password.</p>

     </table>

+<p><span class="doc-section-title">Raises:</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" href="https://docs.python.org/3/library/exceptions.html#ValueError">ValueError</a></code>

+            </td>

+            <td>

+              <div class="doc-md-description">

+                <p>The password must not be empty.</p>

+              </div>

+            </td>

+          </tr>

+      </tbody>

+    </table>

+

+

 <details class="warning" open>

   <summary>Warning</summary>

   <p>Non-public class, provided for didactical and educational

@@ -730,7 +730,7 @@ There was a system error communicating with the SSH agent.

 .It Not saving any new notes: the user aborted the request.

 (Exactly what it says.)

 .

-.It Cannot update %s settings without actual settings.

+.It Cannot update the %s settings without actual settings.

 Using

 .Fl \-config

 requires at least one of the