/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: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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-02-10">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
41
41
      <year>2015</year>
42
42
      <year>2016</year>
43
43
      <year>2017</year>
44
 
      <year>2018</year>
45
44
      <holder>Teddy Hogeborn</holder>
46
45
      <holder>Björn Påhlsson</holder>
47
46
    </copyright>
127
126
      </group>
128
127
      <sbr/>
129
128
      <group>
130
 
        <arg choice="plain"><option>--tls-keytype
131
 
        <replaceable>KEYTYPE</replaceable></option></arg>
132
 
        <arg choice="plain"><option>-T
133
 
        <replaceable>KEYTYPE</replaceable></option></arg>
134
 
      </group>
135
 
      <sbr/>
136
 
      <group>
137
129
        <arg choice="plain"><option>--force</option></arg>
138
130
        <arg choice="plain"><option>-f</option></arg>
139
131
      </group>
187
179
    <title>DESCRIPTION</title>
188
180
    <para>
189
181
      <command>&COMMANDNAME;</command> is a program to generate the
190
 
      TLS and OpenPGP keys used by
 
182
      OpenPGP key used by
191
183
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
192
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
193
 
      normally written to /etc/keys/mandos for later installation into
194
 
      the initrd image, but this, and most other things, can be
195
 
      changed with command line options.
 
184
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
185
      normally written to /etc/mandos for later installation into the
 
186
      initrd image, but this, and most other things, can be changed
 
187
      with command line options.
196
188
    </para>
197
189
    <para>
198
190
      This program can also be used with the
235
227
        <replaceable>DIRECTORY</replaceable></option></term>
236
228
        <listitem>
237
229
          <para>
238
 
            Target directory for key files.  Default is <filename
239
 
            class="directory">/etc/keys/mandos</filename>.
 
230
            Target directory for key files.  Default is
 
231
            <filename class="directory">/etc/mandos</filename>.
240
232
          </para>
241
233
        </listitem>
242
234
      </varlistentry>
248
240
        <replaceable>TYPE</replaceable></option></term>
249
241
        <listitem>
250
242
          <para>
251
 
            OpenPGP key type.  Default is <quote>RSA</quote>.
 
243
            Key type.  Default is <quote>RSA</quote>.
252
244
          </para>
253
245
        </listitem>
254
246
      </varlistentry>
260
252
        <replaceable>BITS</replaceable></option></term>
261
253
        <listitem>
262
254
          <para>
263
 
            OpenPGP key length in bits.  Default is 4096.
 
255
            Key length in bits.  Default is 4096.
264
256
          </para>
265
257
        </listitem>
266
258
      </varlistentry>
272
264
        <replaceable>KEYTYPE</replaceable></option></term>
273
265
        <listitem>
274
266
          <para>
275
 
            OpenPGP subkey type.  Default is <quote>RSA</quote>
 
267
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
268
            encryption-only).
276
269
          </para>
277
270
        </listitem>
278
271
      </varlistentry>
284
277
        <replaceable>BITS</replaceable></option></term>
285
278
        <listitem>
286
279
          <para>
287
 
            OpenPGP subkey length in bits.  Default is 4096.
 
280
            Subkey length in bits.  Default is 4096.
288
281
          </para>
289
282
        </listitem>
290
283
      </varlistentry>
328
321
      </varlistentry>
329
322
      
330
323
      <varlistentry>
331
 
        <term><option>--tls-keytype
332
 
        <replaceable>KEYTYPE</replaceable></option></term>
333
 
        <term><option>-T
334
 
        <replaceable>KEYTYPE</replaceable></option></term>
335
 
        <listitem>
336
 
          <para>
337
 
            TLS key type.  Default is <quote>ed25519</quote>
338
 
          </para>
339
 
        </listitem>
340
 
      </varlistentry>
341
 
      
342
 
      <varlistentry>
343
324
        <term><option>--force</option></term>
344
325
        <term><option>-f</option></term>
345
326
        <listitem>
354
335
        <listitem>
355
336
          <para>
356
337
            Prompt for a password and encrypt it with the key already
357
 
            present in either <filename>/etc/keys/mandos</filename> or
358
 
            the directory specified with the <option>--dir</option>
 
338
            present in either <filename>/etc/mandos</filename> or the
 
339
            directory specified with the <option>--dir</option>
359
340
            option.  Outputs, on standard output, a section suitable
360
341
            for inclusion in <citerefentry><refentrytitle
361
342
            >mandos-clients.conf</refentrytitle><manvolnum
401
382
    <title>OVERVIEW</title>
402
383
    <xi:include href="overview.xml"/>
403
384
    <para>
404
 
      This program is a small utility to generate new TLS and OpenPGP
405
 
      keys for new Mandos clients, and to generate sections for
406
 
      inclusion in <filename>clients.conf</filename> on the server.
 
385
      This program is a small utility to generate new OpenPGP keys for
 
386
      new Mandos clients, and to generate sections for inclusion in
 
387
      <filename>clients.conf</filename> on the server.
407
388
    </para>
408
389
  </refsect1>
409
390
  
441
422
    </para>
442
423
    <variablelist>
443
424
      <varlistentry>
444
 
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
 
425
        <term><filename>/etc/mandos/seckey.txt</filename></term>
445
426
        <listitem>
446
427
          <para>
447
428
            OpenPGP secret key file which will be created or
450
431
        </listitem>
451
432
      </varlistentry>
452
433
      <varlistentry>
453
 
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
 
434
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
454
435
        <listitem>
455
436
          <para>
456
437
            OpenPGP public key file which will be created or
459
440
        </listitem>
460
441
      </varlistentry>
461
442
      <varlistentry>
462
 
        <term><filename>/etc/keys/mandos/tls-privkey.pem</filename></term>
463
 
        <listitem>
464
 
          <para>
465
 
            Private key file which will be created or overwritten.
466
 
          </para>
467
 
        </listitem>
468
 
      </varlistentry>
469
 
      <varlistentry>
470
 
        <term><filename>/etc/keys/mandos/tls-pubkey.pem</filename></term>
471
 
        <listitem>
472
 
          <para>
473
 
            Public key file which will be created or overwritten.
474
 
          </para>
475
 
        </listitem>
476
 
      </varlistentry>
477
 
      <varlistentry>
478
443
        <term><filename class="directory">/tmp</filename></term>
479
444
        <listitem>
480
445
          <para>
515
480
    </informalexample>
516
481
    <informalexample>
517
482
      <para>
518
 
        Prompt for a password, encrypt it with the keys in <filename
519
 
        class="directory">/etc/keys/mandos</filename> and output a
520
 
        section suitable for <filename>clients.conf</filename>.
 
483
        Prompt for a password, encrypt it with the key in <filename
 
484
        class="directory">/etc/mandos</filename> and output a section
 
485
        suitable for <filename>clients.conf</filename>.
521
486
      </para>
522
487
      <para>
523
488
        <userinput>&COMMANDNAME; --password</userinput>
525
490
    </informalexample>
526
491
    <informalexample>
527
492
      <para>
528
 
        Prompt for a password, encrypt it with the keys in the
 
493
        Prompt for a password, encrypt it with the key in the
529
494
        <filename>client-key</filename> directory and output a section
530
495
        suitable for <filename>clients.conf</filename>.
531
496
      </para>