/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: 2010-10-13 06:12:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20101013061252-3a918xedja5caya8
* debian/mandos-client.lintian-overrides: Added plugins.d/plymouth.

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 "2009-01-04">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
36
      <holder>Teddy Hogeborn</holder>
46
37
      <holder>Björn Påhlsson</holder>
47
38
    </copyright>
126
117
        <replaceable>TIME</replaceable></option></arg>
127
118
      </group>
128
119
      <sbr/>
129
 
      <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
 
        <arg choice="plain"><option>--force</option></arg>
138
 
        <arg choice="plain"><option>-f</option></arg>
139
 
      </group>
 
120
      <arg><option>--force</option></arg>
140
121
    </cmdsynopsis>
141
122
    <cmdsynopsis>
142
123
      <command>&COMMANDNAME;</command>
162
143
        <arg choice="plain"><option>-n
163
144
        <replaceable>NAME</replaceable></option></arg>
164
145
      </group>
165
 
      <group>
166
 
        <arg choice="plain"><option>--no-ssh</option></arg>
167
 
        <arg choice="plain"><option>-S</option></arg>
168
 
      </group>
169
146
    </cmdsynopsis>
170
147
    <cmdsynopsis>
171
148
      <command>&COMMANDNAME;</command>
187
164
    <title>DESCRIPTION</title>
188
165
    <para>
189
166
      <command>&COMMANDNAME;</command> is a program to generate the
190
 
      TLS and OpenPGP keys used by
 
167
      OpenPGP key used by
191
168
      <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.
 
169
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
170
      normally written to /etc/mandos for later installation into the
 
171
      initrd image, but this, and most other things, can be changed
 
172
      with command line options.
196
173
    </para>
197
174
    <para>
198
175
      This program can also be used with the
235
212
        <replaceable>DIRECTORY</replaceable></option></term>
236
213
        <listitem>
237
214
          <para>
238
 
            Target directory for key files.  Default is <filename
239
 
            class="directory">/etc/keys/mandos</filename>.
 
215
            Target directory for key files.  Default is
 
216
            <filename>/etc/mandos</filename>.
240
217
          </para>
241
218
        </listitem>
242
219
      </varlistentry>
248
225
        <replaceable>TYPE</replaceable></option></term>
249
226
        <listitem>
250
227
          <para>
251
 
            OpenPGP key type.  Default is <quote>RSA</quote>.
 
228
            Key type.  Default is <quote>DSA</quote>.
252
229
          </para>
253
230
        </listitem>
254
231
      </varlistentry>
260
237
        <replaceable>BITS</replaceable></option></term>
261
238
        <listitem>
262
239
          <para>
263
 
            OpenPGP key length in bits.  Default is 4096.
 
240
            Key length in bits.  Default is 2048.
264
241
          </para>
265
242
        </listitem>
266
243
      </varlistentry>
272
249
        <replaceable>KEYTYPE</replaceable></option></term>
273
250
        <listitem>
274
251
          <para>
275
 
            OpenPGP subkey type.  Default is <quote>RSA</quote>
 
252
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
253
            encryption-only).
276
254
          </para>
277
255
        </listitem>
278
256
      </varlistentry>
284
262
        <replaceable>BITS</replaceable></option></term>
285
263
        <listitem>
286
264
          <para>
287
 
            OpenPGP subkey length in bits.  Default is 4096.
 
265
            Subkey length in bits.  Default is 2048.
288
266
          </para>
289
267
        </listitem>
290
268
      </varlistentry>
308
286
        <replaceable>TEXT</replaceable></option></term>
309
287
        <listitem>
310
288
          <para>
311
 
            Comment field for key.  Default is empty.
 
289
            Comment field for key.  The default value is
 
290
            <quote><literal>Mandos client key</literal></quote>.
312
291
          </para>
313
292
        </listitem>
314
293
      </varlistentry>
328
307
      </varlistentry>
329
308
      
330
309
      <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
310
        <term><option>--force</option></term>
344
311
        <term><option>-f</option></term>
345
312
        <listitem>
354
321
        <listitem>
355
322
          <para>
356
323
            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>
 
324
            present in either <filename>/etc/mandos</filename> or the
 
325
            directory specified with the <option>--dir</option>
359
326
            option.  Outputs, on standard output, a section suitable
360
327
            for inclusion in <citerefentry><refentrytitle
361
328
            >mandos-clients.conf</refentrytitle><manvolnum
378
345
          </para>
379
346
        </listitem>
380
347
      </varlistentry>
381
 
      <varlistentry>
382
 
        <term><option>--no-ssh</option></term>
383
 
        <term><option>-S</option></term>
384
 
        <listitem>
385
 
          <para>
386
 
            When <option>--password</option> or
387
 
            <option>--passfile</option> is given, this option will
388
 
            prevent <command>&COMMANDNAME;</command> from calling
389
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
390
 
            for this host and, if successful, output suitable config
391
 
            options to use this fingerprint as a
392
 
            <option>checker</option> option in the output.  This is
393
 
            otherwise the default behavior.
394
 
          </para>
395
 
        </listitem>
396
 
      </varlistentry>
397
348
    </variablelist>
398
349
  </refsect1>
399
350
  
401
352
    <title>OVERVIEW</title>
402
353
    <xi:include href="overview.xml"/>
403
354
    <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.
 
355
      This program is a small utility to generate new OpenPGP keys for
 
356
      new Mandos clients, and to generate sections for inclusion in
 
357
      <filename>clients.conf</filename> on the server.
407
358
    </para>
408
359
  </refsect1>
409
360
  
441
392
    </para>
442
393
    <variablelist>
443
394
      <varlistentry>
444
 
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
 
395
        <term><filename>/etc/mandos/seckey.txt</filename></term>
445
396
        <listitem>
446
397
          <para>
447
398
            OpenPGP secret key file which will be created or
450
401
        </listitem>
451
402
      </varlistentry>
452
403
      <varlistentry>
453
 
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
 
404
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
454
405
        <listitem>
455
406
          <para>
456
407
            OpenPGP public key file which will be created or
459
410
        </listitem>
460
411
      </varlistentry>
461
412
      <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
 
        <term><filename class="directory">/tmp</filename></term>
 
413
        <term><filename>/tmp</filename></term>
479
414
        <listitem>
480
415
          <para>
481
416
            Temporary files will be written here if
486
421
    </variablelist>
487
422
  </refsect1>
488
423
  
489
 
  <refsect1 id="bugs">
490
 
    <title>BUGS</title>
491
 
    <xi:include href="bugs.xml"/>
492
 
  </refsect1>
 
424
<!--   <refsect1 id="bugs"> -->
 
425
<!--     <title>BUGS</title> -->
 
426
<!--     <para> -->
 
427
<!--     </para> -->
 
428
<!--   </refsect1> -->
493
429
  
494
430
  <refsect1 id="example">
495
431
    <title>EXAMPLE</title>
515
451
    </informalexample>
516
452
    <informalexample>
517
453
      <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>.
 
454
        Prompt for a password, encrypt it with the key in
 
455
        <filename>/etc/mandos</filename> and output a section suitable
 
456
        for <filename>clients.conf</filename>.
521
457
      </para>
522
458
      <para>
523
459
        <userinput>&COMMANDNAME; --password</userinput>
525
461
    </informalexample>
526
462
    <informalexample>
527
463
      <para>
528
 
        Prompt for a password, encrypt it with the keys in the
 
464
        Prompt for a password, encrypt it with the key in the
529
465
        <filename>client-key</filename> directory and output a section
530
466
        suitable for <filename>clients.conf</filename>.
531
467
      </para>
556
492
  <refsect1 id="see_also">
557
493
    <title>SEE ALSO</title>
558
494
    <para>
559
 
      <citerefentry><refentrytitle>intro</refentrytitle>
560
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
561
495
      <citerefentry><refentrytitle>gpg</refentrytitle>
562
496
      <manvolnum>1</manvolnum></citerefentry>,
563
497
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
565
499
      <citerefentry><refentrytitle>mandos</refentrytitle>
566
500
      <manvolnum>8</manvolnum></citerefentry>,
567
501
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
568
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
569
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
570
 
      <manvolnum>1</manvolnum></citerefentry>
 
502
      <manvolnum>8mandos</manvolnum></citerefentry>
571
503
    </para>
572
504
  </refsect1>
573
505