derivepassphrase.git

@@ -104,7 +104,7 @@

       <li class="md-tabs__item">

-        <a href="/derivepassphrase/0.x/tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="/derivepassphrase/0.x/tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -270,7 +270,7 @@

     <li class="md-nav__item">

-      <a href="/derivepassphrase/0.x/tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="/derivepassphrase/0.x/tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -22,7 +22,7 @@

-        <title>Some ideas for documentation that might be missing, or nice to have - derivepassphrase</title>

+        <title>Some ideas for future work - derivepassphrase</title>

@@ -61,7 +61,7 @@

     <div data-md-component="skip">

-        <a href="#some-ideas-for-documentation-that-might-be-missing-or-nice-to-have" class="md-skip">

+        <a href="#some-ideas-for-future-work" class="md-skip">

           Skip to content

         </a>

@@ -111,7 +111,7 @@

       <li class="md-tabs__item">

-        <a href="../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -277,7 +277,7 @@

     <li class="md-nav__item">

-      <a href="../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -689,6 +689,49 @@

     </label>

     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

+        <li class="md-nav__item">

+  <a href="#subcommands" class="md-nav__link">

+    <span class="md-ellipsis">

+      Subcommands

+    </span>

+  </a>

+  

+    <nav class="md-nav" aria-label="Subcommands">

+      <ul class="md-nav__list">

+        

+          <li class="md-nav__item">

+  <a href="#derivation-schemes" class="md-nav__link">

+    <span class="md-ellipsis">

+      Derivation schemes

+    </span>

+  </a>

+  

+</li>

+        

+          <li class="md-nav__item">

+  <a href="#other-functionality" class="md-nav__link">

+    <span class="md-ellipsis">

+      Other functionality

+    </span>

+  </a>

+  

+</li>

+        

+      </ul>

+    </nav>

+  

+</li>

+      

+        <li class="md-nav__item">

+  <a href="#documentation" class="md-nav__link">

+    <span class="md-ellipsis">

+      Documentation

+    </span>

+  </a>

+  

+    <nav class="md-nav" aria-label="Documentation">

+      <ul class="md-nav__list">

+        

           <li class="md-nav__item">

   <a href="#tutorials" class="md-nav__link">

     <span class="md-ellipsis">

@@ -723,6 +766,11 @@

     </span>

   </a>

+</li>

+        

+      </ul>

+    </nav>

+  

 </li>

     </ul>

@@ -751,27 +799,71 @@

-<h1 id="some-ideas-for-documentation-that-might-be-missing-or-nice-to-have">Some ideas for documentation that might be missing, or nice to have<a class="headerlink" href="#some-ideas-for-documentation-that-might-be-missing-or-nice-to-have" title="Permanent link">&para;</a></h1>

+<h1 id="some-ideas-for-future-work">Some ideas for future work<a class="headerlink" href="#some-ideas-for-future-work" title="Permanent link">&para;</a></h1>

+<h2 id="subcommands">Subcommands<a class="headerlink" href="#subcommands" title="Permanent link">&para;</a></h2>

+<p>(In no particular order.)</p>

+<h3 id="derivation-schemes">Derivation schemes<a class="headerlink" href="#derivation-schemes" title="Permanent link">&para;</a></h3>

+<ul>

+<li><code>spectre</code> (<code>master-password</code>): derive passphrases according to the &ldquo;Master Password&rdquo; scheme as used by the Spectre app. (<a href="https://github.com/the-13th-letter/derivepassphrase/issues/2">#2</a>)</li>

+</ul>

+<h3 id="other-functionality">Other functionality<a class="headerlink" href="#other-functionality" title="Permanent link">&para;</a></h3>

+<ul>

+<li><code>explore-permitted-special-characters</code>: generate new configurations starting from a base configuration until one of them passes the &ldquo;special characters&rdquo; constraints.</li>

+<li><code>rotate</code>: generate a new configuration suitable for passphrase rotation, compatible with the base configuration&rsquo;s constraints.</li>

+<li>

+<p><code>service-plugins</code>: manage plugins that automate certain tasks, as outlined in the notes of the queried service.</p>

+<ul>

+<li>

+<p><code>load-ssh-key</code>: if the service uses an SSH key, autoload the key from a well-known location into the SSH agent if it isn&rsquo;t already loaded.</p>

+<p><code>vault</code>-specific.</p>

+</li>

+<li>

+<p><code>decrypt-notes</code>: decrypt OpenPGP-encrypted notes with GnuPG or Sequoia <code>sq</code>.</p>

+<p>Open questions:</p>

+<ul>

+<li>Use an automatic, symmetric encryption key, or rely on the standard OpenPGP key store?  (Do <em>not</em> use the derived service passphrase for this: the quality may be arbitrarily bad due to the passphrase constaints, and the service itself could compromise that passphrase.)</li>

+</ul>

+</li>

+<li>

+<p><code>generate-otp</code>: if the service uses two-factor authentication and the configuration contains one-time password settings, call <code>oathtool</code> to obtain one or more OTPs.</p>

+<p>May require the <code>decrypt-notes</code> plugin first.</p>

+</li>

+<li>

+<p><code>manage-runit-services</code>: if the service contains <code>runit</code> service configuration, ensure the specified <code>runit</code> services are running concurrently, and stopped after signalling.</p>

+<p>Typical use case is a service only accessible via VPN or SSH proxy, where the VPN/proxy would run as a <code>runit</code> service.</p>

+<p>Open questions:</p>

+<ul>

+<li>Interface with <code>inotifywait</code> to wait for SSH control socket?</li>

+</ul>

+</li>

+</ul>

+</li>

+</ul>

+<h2 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link">&para;</a></h2>

 <p>(Categorized as per <a href="https://diataxis.fr">the diataxis framework</a>, but otherwise in no particular order.)</p>

-<h2 id="tutorials">Tutorials<a class="headerlink" href="#tutorials" title="Permanent link">&para;</a></h2>

+<h3 id="tutorials">Tutorials<a class="headerlink" href="#tutorials" title="Permanent link">&para;</a></h3>

 <ul>

-<li><a href="../tutorials/basic-setup-password/">Setting up <code>derivepassphrase</code> from scratch for three existing accounts, with a master passphrase</a></li>

+<li><a href="../tutorials/basic-setup-passphrase/">Setting up <code>derivepassphrase</code> from scratch for three existing accounts, with a master passphrase</a></li>

 <li>Setting up <code>derivepassphrase</code> from scratch for three existing accounts, with a new SSH key</li>

 </ul>

-<h2 id="how-tos">How-tos<a class="headerlink" href="#how-tos" title="Permanent link">&para;</a></h2>

+<h3 id="how-tos">How-tos<a class="headerlink" href="#how-tos" title="Permanent link">&para;</a></h3>

 <ul>

 <li>How to set up <code>derivepassphrase</code> with an SSH key</li>

 <li>How to choose a good service name</li>

 <li>How to edit a saved <code>derivepassphrase vault</code> configuration correctly</li>

+<li>How to deal with &ldquo;supported&rdquo; and &ldquo;unsupported&rdquo; special characters</li>

+<li>How to deal with regular passphrase rotation/rollover</li>

 </ul>

-<h2 id="reference">Reference<a class="headerlink" href="#reference" title="Permanent link">&para;</a></h2>

+<h3 id="reference">Reference<a class="headerlink" href="#reference" title="Permanent link">&para;</a></h3>

 <ul>

-<li><code>derivepassphrase-vault.conf</code>(<b>5</b>)</li>

+<li><code>derivepassphrase-vault.json</code>(<b>5</b>)</li>

 </ul>

-<h2 id="explanation">Explanation<a class="headerlink" href="#explanation" title="Permanent link">&para;</a></h2>

+<h3 id="explanation">Explanation<a class="headerlink" href="#explanation" title="Permanent link">&para;</a></h3>

 <ul>

 <li>Security aspects and other tradeoffs when using deterministic password generators</li>

 <li>Tradeoffs between a master passphrase and a master SSH key</li>

+<li>Why is <code>vault</code>&rsquo;s <code>--repeat</code> option named this way if it counts occurrences, not repetitions?</li>

+<li>Why are master SSH keys not supported under Windows?</li>

 </ul>

@@ -113,7 +113,7 @@

       <li class="md-tabs__item">

-        <a href="../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -281,7 +281,7 @@

     <li class="md-nav__item">

-      <a href="../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -699,6 +699,30 @@

     </label>

     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

+        <li class="md-nav__item">

+  <a href="#031-2024-10-21" class="md-nav__link">

+    <span class="md-ellipsis">

+      0.3.1 (2024-10-21)

+    </span>

+  </a>

+  

+    <nav class="md-nav" aria-label="0.3.1 (2024-10-21)">

+      <ul class="md-nav__list">

+        

+          <li class="md-nav__item">

+  <a href="#fixed" class="md-nav__link">

+    <span class="md-ellipsis">

+      Fixed

+    </span>

+  </a>

+  

+</li>

+        

+      </ul>

+    </nav>

+  

+</li>

+      

         <li class="md-nav__item">

   <a href="#030-2024-10-15" class="md-nav__link">

     <span class="md-ellipsis">

@@ -728,7 +752,7 @@

 </li>

           <li class="md-nav__item">

-  <a href="#fixed" class="md-nav__link">

+  <a href="#fixed_1" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -761,7 +785,7 @@

 </li>

           <li class="md-nav__item">

-  <a href="#fixed_1" class="md-nav__link">

+  <a href="#fixed_2" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -803,7 +827,7 @@

       <ul class="md-nav__list">

           <li class="md-nav__item">

-  <a href="#fixed_2" class="md-nav__link">

+  <a href="#fixed_3" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -827,7 +851,7 @@

       <ul class="md-nav__list">

           <li class="md-nav__item">

-  <a href="#fixed_3" class="md-nav__link">

+  <a href="#fixed_4" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -851,7 +875,7 @@

       <ul class="md-nav__list">

           <li class="md-nav__item">

-  <a href="#fixed_4" class="md-nav__link">

+  <a href="#fixed_5" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -922,6 +946,30 @@

     </label>

     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

+        <li class="md-nav__item">

+  <a href="#031-2024-10-21" class="md-nav__link">

+    <span class="md-ellipsis">

+      0.3.1 (2024-10-21)

+    </span>

+  </a>

+  

+    <nav class="md-nav" aria-label="0.3.1 (2024-10-21)">

+      <ul class="md-nav__list">

+        

+          <li class="md-nav__item">

+  <a href="#fixed" class="md-nav__link">

+    <span class="md-ellipsis">

+      Fixed

+    </span>

+  </a>

+  

+</li>

+        

+      </ul>

+    </nav>

+  

+</li>

+      

         <li class="md-nav__item">

   <a href="#030-2024-10-15" class="md-nav__link">

     <span class="md-ellipsis">

@@ -951,7 +999,7 @@

 </li>

           <li class="md-nav__item">

-  <a href="#fixed" class="md-nav__link">

+  <a href="#fixed_1" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -984,7 +1032,7 @@

 </li>

           <li class="md-nav__item">

-  <a href="#fixed_1" class="md-nav__link">

+  <a href="#fixed_2" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -1026,7 +1074,7 @@

       <ul class="md-nav__list">

           <li class="md-nav__item">

-  <a href="#fixed_2" class="md-nav__link">

+  <a href="#fixed_3" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -1050,7 +1098,7 @@

       <ul class="md-nav__list">

           <li class="md-nav__item">

-  <a href="#fixed_3" class="md-nav__link">

+  <a href="#fixed_4" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -1074,7 +1122,7 @@

       <ul class="md-nav__list">

           <li class="md-nav__item">

-  <a href="#fixed_4" class="md-nav__link">

+  <a href="#fixed_5" class="md-nav__link">

     <span class="md-ellipsis">

       Fixed

     </span>

@@ -1161,6 +1209,15 @@ effectively constitute a new <q>major</q> release.)

 </aside>

 <!-- scriv changelog start -->

+<h2 id="031-2024-10-21">0.3.1 (2024-10-21)<a class="headerlink" href="#031-2024-10-21" title="Permanent link">&para;</a></h2>

+<h3 id="fixed">Fixed<a class="headerlink" href="#fixed" title="Permanent link">&para;</a></h3>

+<ul>

+<li>Improve the <a href="../tutorials/basic-setup-passphrase/">basic setup (passphrase)</a>

+    tutorial.  Also incorporate feedback.</li>

+<li>Fix PyPI classification: Python 3.9 is supported.</li>

+<li><em>Actually</em> remove the <code>derivepassphrase_export</code> program, which was

+    turned into a subcommand in v0.2.0.</li>

+</ul>

 <h2 id="030-2024-10-15">0.3.0 (2024-10-15)<a class="headerlink" href="#030-2024-10-15" title="Permanent link">&para;</a></h2>

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

 <ul>

@@ -1252,7 +1309,7 @@ configuration with such falsy values will still generate errors when

 </ul>

 </li>

 </ul>

-<h3 id="fixed">Fixed<a class="headerlink" href="#fixed" title="Permanent link">&para;</a></h3>

+<h3 id="fixed_1">Fixed<a class="headerlink" href="#fixed_1" title="Permanent link">&para;</a></h3>

 <ul>

 <li>Fixed the textual description of the return value for

     <a class="autorefs autorefs-internal" href="../reference/derivepassphrase.ssh_agent/#derivepassphrase.ssh_agent.SSHAgentClient.request"><code>SSHAgentClient.request</code></a>,

@@ -1268,7 +1325,7 @@ configuration with such falsy values will still generate errors when

 even if <code>vault</code> is not installed. (<a href="https://github.com/the-13th-letter/derivepassphrase/1">#1</a>)</p>

 </li>

 </ul>

-<h3 id="fixed_1">Fixed<a class="headerlink" href="#fixed_1" title="Permanent link">&para;</a></h3>

+<h3 id="fixed_2">Fixed<a class="headerlink" href="#fixed_2" title="Permanent link">&para;</a></h3>

 <ul>

 <li>Deploy versioned documentation with <a href="https://pypi.org/project/mike">mike</a>.  Set up a &ldquo;latest&rdquo; tag and

     the &ldquo;0.<var>x</var>&rdquo; version of the documentation with the contents so

@@ -1311,7 +1368,7 @@ global settings file if no subsystem-specific configuration was found.

     deprecated, and will be removed in v1.0.</li>

 </ul>

 <h2 id="013-2024-07-28">0.1.3 (2024-07-28)<a class="headerlink" href="#013-2024-07-28" title="Permanent link">&para;</a></h2>

-<h3 id="fixed_2">Fixed<a class="headerlink" href="#fixed_2" title="Permanent link">&para;</a></h3>

+<h3 id="fixed_3">Fixed<a class="headerlink" href="#fixed_3" title="Permanent link">&para;</a></h3>

 <ul>

 <li>Do not crash upon selecting a key on the command-line if there already

     is a key stored in the configuration. (<a href="https://github.com/the-13th-letter/derivepassphrase/5">#5</a>)</li>

@@ -1325,7 +1382,7 @@ global settings file if no subsystem-specific configuration was found.

 <li>Fix typing issues according to <code>mypy</code>&rsquo;s strict mode.</li>

 </ul>

 <h2 id="012-2024-07-22">0.1.2 (2024-07-22)<a class="headerlink" href="#012-2024-07-22" title="Permanent link">&para;</a></h2>

-<h3 id="fixed_3">Fixed<a class="headerlink" href="#fixed_3" title="Permanent link">&para;</a></h3>

+<h3 id="fixed_4">Fixed<a class="headerlink" href="#fixed_4" title="Permanent link">&para;</a></h3>

 <ul>

 <li>Include and exclude the correct files in the <code>sdist</code> and <code>wheel</code>

     distributions.  (Previously, <code>sdist</code> contained VCS artifacts, and

@@ -1340,7 +1397,7 @@ global settings file if no subsystem-specific configuration was found.

     <a href="https://pypi.org/package/towncrier">towncrier</a>.</li>

 </ul>

 <h2 id="011-2024-07-14">0.1.1 (2024-07-14)<a class="headerlink" href="#011-2024-07-14" title="Permanent link">&para;</a></h2>

-<h3 id="fixed_4">Fixed<a class="headerlink" href="#fixed_4" title="Permanent link">&para;</a></h3>

+<h3 id="fixed_5">Fixed<a class="headerlink" href="#fixed_5" title="Permanent link">&para;</a></h3>

 <ul>

 <li>Restore the <code>__version__</code> attribute in all top-level packages.</li>

 <li>Declare compatibility with Python 3.10 in project metadata, and include

@@ -16,7 +16,7 @@

-        <link rel="next" href="tutorials/basic-setup-password/">

+        <link rel="next" href="tutorials/basic-setup-passphrase/">

       <link rel="icon" href="assets/images/favicon.png">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -396,7 +396,7 @@

     <li class="md-nav__item">

-      <a href="tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -1002,7 +1002,7 @@ This choice can be made either specifically for the service (in this case, <code

-          <a href="tutorials/basic-setup-password/" class="md-footer__link md-footer__link--next" aria-label="Next: Tutorial: setting up derivepassphrase vault for three accounts, with a master passphrase">

+          <a href="tutorials/basic-setup-passphrase/" class="md-footer__link md-footer__link--next" aria-label="Next: Tutorial: setting up derivepassphrase vault for three accounts, with a master passphrase">

             <div class="md-footer__title">

               <span class="md-footer__direction">

                 Next

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -15,7 +15,7 @@

         <link rel="canonical" href="https://the13thletter.info/derivepassphrase/0.x/reference/">

-        <link rel="prev" href="../tutorials/basic-setup-password/">

+        <link rel="prev" href="../tutorials/basic-setup-passphrase/">

         <link rel="next" href="derivepassphrase.1/">

@@ -115,7 +115,7 @@

       <li class="md-tabs__item">

-        <a href="../tutorials/basic-setup-password/" class="md-tabs__link">

+        <a href="../tutorials/basic-setup-passphrase/" class="md-tabs__link">

@@ -283,7 +283,7 @@

     <li class="md-nav__item">

-      <a href="../tutorials/basic-setup-password/" class="md-nav__link">

+      <a href="../tutorials/basic-setup-passphrase/" class="md-nav__link">

   <span class="md-ellipsis">

@@ -805,7 +805,7 @@

       <nav class="md-footer__inner md-grid" aria-label="Footer" >

-          <a href="../tutorials/basic-setup-password/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Tutorial: setting up derivepassphrase vault for three accounts, with a master passphrase">

+          <a href="../tutorials/basic-setup-passphrase/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Tutorial: setting up derivepassphrase vault for three accounts, with a master passphrase">

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

@@ -2,62 +2,62 @@

 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/_future/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/changelog/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase-export-vault.1/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase-export.1/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase-vault.1/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase.1/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase._types/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase.cli/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase.exporter/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase.sequin/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase.ssh_agent/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

          <loc>https://the13thletter.info/derivepassphrase/0.x/reference/derivepassphrase.vault/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <lastmod>2024-10-21</lastmod>

     </url>

     <url>

-         <loc>https://the13thletter.info/derivepassphrase/0.x/tutorials/basic-setup-password/</loc>

-         <lastmod>2024-10-15</lastmod>

+         <loc>https://the13thletter.info/derivepassphrase/0.x/tutorials/basic-setup-passphrase/</loc>

+         <lastmod>2024-10-21</lastmod>

     </url>

 </urlset>

\ No newline at end of file

@@ -12,7 +12,7 @@

         <meta name="author" content="Marco Ricci">

-        <link rel="canonical" href="https://the13thletter.info/derivepassphrase/0.x/tutorials/basic-setup-password/">

+        <link rel="canonical" href="https://the13thletter.info/derivepassphrase/0.x/tutorials/basic-setup-passphrase/">

         <link rel="prev" href="../..">

@@ -963,7 +963,7 @@

-    <a href="https://github.com/the-13th-letter/derivepassphrase/raw/master/docs/tutorials/basic-setup-password.md" title="View source of this page" class="md-content__button md-icon">

+    <a href="https://github.com/the-13th-letter/derivepassphrase/raw/master/docs/tutorials/basic-setup-passphrase.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>

@@ -983,7 +983,7 @@ We will assume the following three services with the following passphrase polici

 <li>between 12 and 20 characters</li>

 <li>no spaces</li>

 <li>1 upper case letter, 1 lower case letter, 1 digit</li>

-<li>no character immediately repeated more than 3 times</li>

+<li>no character may appear 3 times (or more) in a row</li>

 </ul>

 </li>

 <li>

@@ -1009,22 +1009,39 @@ We will assume the following three services with the following passphrase polici

 </ul>

 </div>

 <h2 id="installing-derivepassphrase">Installing <code>derivepassphrase</code><a class="headerlink" href="#installing-derivepassphrase" title="Permanent link">&para;</a></h2>

-<p>Install <code>pipx</code>:</p>

-<div class="highlight"><pre><span></span><code><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>~

-<span class="gp">$ </span>python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>.venv

-<span class="gp">$ </span>.<span class="w"> </span>.venv/bin/activate

-<span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>pipx

+<p>You will need Python 3, and a package installer such as <code>pip</code> (bundled with Python), <code>pipx</code> or similar.</p>

+<details class="info">

+<summary>Info: Current supported Python versions</summary>

+<p><img alt="See PyPI." src="https://img.shields.io/pypi/pyversions/derivepassphrase.svg" /></p>

+</details>

+<hr />

+<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">pip</label><label for="__tabbed_1_2">pipx</label></div>

+<div class="tabbed-content">

+<div class="tabbed-block">

+<p>With <code>pip</code>, using a &ldquo;virtual enviroment&rdquo; at <code>~/.venv</code> to avoid clobbering our system configuration:</p>

+<div class="highlight"><pre><span></span><code><span class="gp">$ </span>python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>~/.venv

+<span class="gp">$ </span>.<span class="w"> </span>~/.venv/bin/activate

+<span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>derivepassphrase

 </code></pre></div>

-<p>Install <code>derivepassphrase</code>:</p>

+</div>

+<div class="tabbed-block">

 <div class="highlight"><pre><span></span><code><span class="gp">$ </span>pipx<span class="w"> </span>install<span class="w"> </span>derivepassphrase

 </code></pre></div>

+</div>

+</div>

+</div>

+<hr />

 <p>Check that the installation was successful.</p>

 <div class="highlight"><pre><span></span><code><span class="gp">$ </span>devirepassphrase<span class="w"> </span>--version

-<span class="go">derivepassphrase, version 0.2.0</span>

+<span class="go">derivepassphrase, version 0.3.0</span>

 </code></pre></div>

 <p>(…or similar output.)</p>

+<details class="info">

+<summary>Info: Current <code>derivepassphrase</code> version</summary>

+<p><img alt="See PyPI." src="https://img.shields.io/pypi/v/derivepassphrase.svg?label=derivepassphrase" /></p>

+</details>

 <h2 id="choosing-a-master-passphrase">Choosing a master passphrase<a class="headerlink" href="#choosing-a-master-passphrase" title="Permanent link">&para;</a></h2>

-<p><code>derivepassphrase</code> uses a master passphrase <code>MP</code>, and derives all other passphrases <code>P</code> from <code>MP</code>.

+<p><code>derivepassphrase</code> uses a master passphrase <var>MP</var>, and derives all other passphrases <var>P</var> from <var>MP</var>.

 We shall choose the master passphrase: <code>I am an insecure master passphrase, but easy to type.</code></p>

 <h2 id="setting-up-the-email-account">Setting up the email account<a class="headerlink" href="#setting-up-the-email-account" title="Permanent link">&para;</a></h2>

 <p>In <code>derivepassphrase</code>, each passphrase configuration contains a <em>service name</em>, which is how <code>derivepassphrase</code> distinguishes between configurations.

@@ -1032,15 +1049,48 @@ This service name can be chosen freely, but the resulting passphrase depends on

 For our email account, we choose the straightforward service name <code>email</code>.</p>

 <p>We need to translate the passphrase policy into options for <code>derivepassphrase</code>:</p>

 <ul>

-<li>A policy &ldquo;(at least) <code>n</code> upper case letters&rdquo; translates to the option <code>--lower n</code>, for any <code>n</code> greater than 0.

-  Lower case letters (<code>--upper</code>), digits (<code>--number</code>), symbols (<code>--symbol</code>), spaces (<code>--space</code>) and dashes (<code>--dash</code>) work similarly.</li>

-<li>A policy &ldquo;spaces <em>forbidden</em>&rdquo; translates to the option <code>--space 0</code>.

+<li>A policy &ldquo;(at least) <var>n</var> lower case letters&rdquo; translates to the option <code>-<span/>-lower <var>n</var></code>, for any <var>n</var> &gt; 0.

+  Upper case letters (<code>--upper</code>), digits (<code>--number</code>), symbols (<code>--symbol</code>), spaces (<code>--space</code>) and dashes (<code>--dash</code>) work similarly.</li>

+<li>A policy &ldquo;spaces <em>forbidden</em>&rdquo; translates to the option <code>--space 0</code>.

   Again, other character classes behave similarly.</li>

-<li>A policy &ldquo;no character immediately repeated more than <code>n</code> times&rdquo; translates to the option <code>--repeat n</code>, for any <code>n</code> greater than 0.

-  In particular, <code>--repeat 1</code> means no character may be immediately repeated.</li>

-<li>A policy &ldquo;between <code>n</code> and <code>m</code> characters long&rdquo; translates to <code>--length k</code>, for any <code>k</code> between <code>n</code> and <code>m</code> which you choose.

-  (<code>derivepassphrase</code> does not explicitly choose a passphrase length for you.)</li>

+<li>A policy &ldquo;no character may appear <var>n</var> times (or more) in a row&rdquo; translates to the option <code>-<span/>-repeat (<var>n</var> − 1)</code>, for any <var>n</var> &gt; 1.

+  In particular, <code>--repeat 1</code> means no character may be immediately repeated.

+  (See the mnemonic below.)</li>

+<li>A policy &ldquo;between <var>n</var> and <var>m</var> characters long&rdquo; translates to <code>-<span/>-length <var>k</var></code>, for any choice of <var>k</var> which satisfies <var>n</var> ≤ <var>k</var> ≤ <var>m</var>.

+  (<code>derivepassphrase</code> does not explicitly choose <var>k</var> for you.)</li>

 </ul>

+<details class="note">

+<summary>Mnemonic: the <code>--repeat</code> option</summary>

+<p>The <code>--repeat</code> option denotes the <em>total</em> number of consecutive occurrences of the same character.

+Or alternatively: if you request <code>-<span/>-repeat <var>n</var></code>, then <code>derivepassphrase</code> will <em>avoid</em> deriving any passphrase that repeats a character <em>another <var>n</var> times</em>.</p>

+<p>Examples:</p>

+<table>

+<thead>

+<tr>

+<th style="text-align: left;">option</th>

+<th style="text-align: left;">valid examples</th>

+<th style="text-align: left;">invalid examples</th>

+</tr>

+</thead>

+<tbody>

+<tr>

+<td style="text-align: left;"><code>--repeat 1</code></td>

+<td style="text-align: left;"><code>abc</code>, <code>aba</code>, <code>abcabc</code></td>

+<td style="text-align: left;"><code>aa</code>, <code>abba</code>, <code>ababb</code></td>

+</tr>

+<tr>

+<td style="text-align: left;"><code>--repeat 4</code></td>

+<td style="text-align: left;"><code>122333111123</code>, <code>4444</code></td>

+<td style="text-align: left;"><code>55555</code>, <code>67788888999996</code></td>

+</tr>

+<tr>

+<td style="text-align: left;"><code>--repeat 11</code></td>

+<td style="text-align: left;"><code>01234567899999999999</code></td>

+<td style="text-align: left;"><code>$$$$$$$$$$$$$$$$$$$$$$$</code></td>

+</tr>

+</tbody>

+</table>

+</details>

 <p>For the <code>email</code> service, we choose passphrase length 12.

 This leads to the command-line options <code>--length 12 --space 0 --upper 1 --lower 1 --number 1 --repeat 3</code>.

 Because we are using a master passphrase, we also need the <code>-p</code> option.</p>

@@ -1069,7 +1119,7 @@ Because we are using a master passphrase, we also need the <code>-p</code> optio

 <div class="admonition warning">

 <p class="admonition-title">Warning: <code>-p</code> and <code>--config</code></p>

 <p>Do <strong>not</strong> use the <code>-p</code> and the <code>--config</code> options together to store the master passphrase!

-The configuration is assumed to <em>not contain sensitive contents</em> and is <em>not encrypted</em>, so your master passphrase is then visible to <em>anyone</em> with appropriate priviledges!</p>

+The configuration is assumed to <em>not contain sensitive contents</em> and is <em>not encrypted</em>, so your master passphrase is then visible to <em>anyone</em> with appropriate privileges!</p>

 </div>

 <p>Check that the settings are stored correctly:</p>

 <div class="highlight"><pre><span></span><code><span class="gp">$ </span>derivepassphrase<span class="w"> </span>vault<span class="w"> </span>--export<span class="w"> </span>-