/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:31:44 UTC
  • Revision ID: teddy@recompile.se-20190209233144-5ewmrgezdqridssj
* TODO (Use raw public keys): Remove.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2019-07-18">
 
5
<!ENTITY TIMESTAMP "2019-02-10">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
42
42
      <year>2016</year>
43
43
      <year>2017</year>
44
44
      <year>2018</year>
45
 
      <year>2019</year>
46
45
      <holder>Teddy Hogeborn</holder>
47
46
      <holder>Björn Påhlsson</holder>
48
47
    </copyright>
191
190
      TLS and OpenPGP keys used by
192
191
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
193
192
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
194
 
      normally written to /etc/keys/mandos for later installation into
195
 
      the initrd image, but this, and most other things, can be
196
 
      changed with command line options.
 
193
      normally written to /etc/mandos for later installation into the
 
194
      initrd image, but this, and most other things, can be changed
 
195
      with command line options.
197
196
    </para>
198
197
    <para>
199
198
      This program can also be used with the
236
235
        <replaceable>DIRECTORY</replaceable></option></term>
237
236
        <listitem>
238
237
          <para>
239
 
            Target directory for key files.  Default is <filename
240
 
            class="directory">/etc/keys/mandos</filename>.
 
238
            Target directory for key files.  Default is
 
239
            <filename class="directory">/etc/mandos</filename>.
241
240
          </para>
242
241
        </listitem>
243
242
      </varlistentry>
355
354
        <listitem>
356
355
          <para>
357
356
            Prompt for a password and encrypt it with the key already
358
 
            present in either <filename>/etc/keys/mandos</filename> or
359
 
            the directory specified with the <option>--dir</option>
 
357
            present in either <filename>/etc/mandos</filename> or the
 
358
            directory specified with the <option>--dir</option>
360
359
            option.  Outputs, on standard output, a section suitable
361
360
            for inclusion in <citerefentry><refentrytitle
362
361
            >mandos-clients.conf</refentrytitle><manvolnum
363
362
            >8</manvolnum></citerefentry>.  The host name or the name
364
363
            specified with the <option>--name</option> option is used
365
364
            for the section header.  All other options are ignored,
366
 
            and no key is created.  Note: white space is stripped from
367
 
            the beginning and from the end of the password; See <xref
368
 
            linkend="bugs"/>.
 
365
            and no key is created.
369
366
          </para>
370
367
        </listitem>
371
368
      </varlistentry>
377
374
        <listitem>
378
375
          <para>
379
376
            The same as <option>--password</option>, but read from
380
 
            <replaceable>FILE</replaceable>, not the terminal, and
381
 
            white space is not stripped from the password in any way.
 
377
            <replaceable>FILE</replaceable>, not the terminal.
382
378
          </para>
383
379
        </listitem>
384
380
      </varlistentry>
445
441
    </para>
446
442
    <variablelist>
447
443
      <varlistentry>
448
 
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
 
444
        <term><filename>/etc/mandos/seckey.txt</filename></term>
449
445
        <listitem>
450
446
          <para>
451
447
            OpenPGP secret key file which will be created or
454
450
        </listitem>
455
451
      </varlistentry>
456
452
      <varlistentry>
457
 
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
 
453
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
458
454
        <listitem>
459
455
          <para>
460
456
            OpenPGP public key file which will be created or
492
488
  
493
489
  <refsect1 id="bugs">
494
490
    <title>BUGS</title>
495
 
    <para>
496
 
      The <option>--password</option>/<option>-p</option> option
497
 
      strips white space from the start and from the end of the
498
 
      password before using it.  If this is a problem, use the
499
 
      <option>--passfile</option> option instead, which does not do
500
 
      this.
501
 
    </para>
502
491
    <xi:include href="bugs.xml"/>
503
492
  </refsect1>
504
493
  
526
515
    </informalexample>
527
516
    <informalexample>
528
517
      <para>
529
 
        Prompt for a password, encrypt it with the keys in <filename
530
 
        class="directory">/etc/keys/mandos</filename> and output a
531
 
        section suitable for <filename>clients.conf</filename>.
 
518
        Prompt for a password, encrypt it with the key in <filename
 
519
        class="directory">/etc/mandos</filename> and output a section
 
520
        suitable for <filename>clients.conf</filename>.
532
521
      </para>
533
522
      <para>
534
523
        <userinput>&COMMANDNAME; --password</userinput>
536
525
    </informalexample>
537
526
    <informalexample>
538
527
      <para>
539
 
        Prompt for a password, encrypt it with the keys in the
 
528
        Prompt for a password, encrypt it with the key in the
540
529
        <filename>client-key</filename> directory and output a section
541
530
        suitable for <filename>clients.conf</filename>.
542
531
      </para>