/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-08 18:18:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908181849-ogydhr0m4axi3dnu
* INSTALL: More text.  Better text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2019-02-10">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-06">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
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
 
      <year>2019</year>
46
34
      <holder>Teddy Hogeborn</holder>
47
35
      <holder>Björn Påhlsson</holder>
48
36
    </copyright>
49
37
    <xi:include href="legalnotice.xml"/>
50
38
  </refentryinfo>
51
 
  
 
39
 
52
40
  <refmeta>
53
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
42
    <manvolnum>8</manvolnum>
60
48
      Generate key and password for Mandos client and server.
61
49
    </refpurpose>
62
50
  </refnamediv>
63
 
  
 
51
 
64
52
  <refsynopsisdiv>
65
53
    <cmdsynopsis>
66
54
      <command>&COMMANDNAME;</command>
127
115
        <replaceable>TIME</replaceable></option></arg>
128
116
      </group>
129
117
      <sbr/>
130
 
      <group>
131
 
        <arg choice="plain"><option>--tls-keytype
132
 
        <replaceable>KEYTYPE</replaceable></option></arg>
133
 
        <arg choice="plain"><option>-T
134
 
        <replaceable>KEYTYPE</replaceable></option></arg>
135
 
      </group>
136
 
      <sbr/>
137
 
      <group>
138
 
        <arg choice="plain"><option>--force</option></arg>
139
 
        <arg choice="plain"><option>-f</option></arg>
140
 
      </group>
 
118
      <arg><option>--force</option></arg>
141
119
    </cmdsynopsis>
142
120
    <cmdsynopsis>
143
121
      <command>&COMMANDNAME;</command>
144
122
      <group choice="req">
145
123
        <arg choice="plain"><option>--password</option></arg>
146
124
        <arg choice="plain"><option>-p</option></arg>
147
 
        <arg choice="plain"><option>--passfile
148
 
        <replaceable>FILE</replaceable></option></arg>
149
 
        <arg choice="plain"><option>-F</option>
150
 
        <replaceable>FILE</replaceable></arg>
151
125
      </group>
152
126
      <sbr/>
153
127
      <group>
163
137
        <arg choice="plain"><option>-n
164
138
        <replaceable>NAME</replaceable></option></arg>
165
139
      </group>
166
 
      <group>
167
 
        <arg choice="plain"><option>--no-ssh</option></arg>
168
 
        <arg choice="plain"><option>-S</option></arg>
169
 
      </group>
170
140
    </cmdsynopsis>
171
141
    <cmdsynopsis>
172
142
      <command>&COMMANDNAME;</command>
188
158
    <title>DESCRIPTION</title>
189
159
    <para>
190
160
      <command>&COMMANDNAME;</command> is a program to generate the
191
 
      TLS and OpenPGP keys used by
 
161
      OpenPGP key used by
192
162
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
193
 
      <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.
 
163
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
164
      normally written to /etc/mandos for later installation into the
 
165
      initrd image, but this, and most other things, can be changed
 
166
      with command line options.
197
167
    </para>
198
168
    <para>
199
169
      This program can also be used with the
200
 
      <option>--password</option> or <option>--passfile</option>
201
 
      options to generate a ready-made section for
202
 
      <filename>clients.conf</filename> (see
 
170
      <option>--password</option> option to generate a ready-made
 
171
      section for <filename>clients.conf</filename> (see
203
172
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
204
173
      <manvolnum>5</manvolnum></citerefentry>).
205
174
    </para>
228
197
          </para>
229
198
        </listitem>
230
199
      </varlistentry>
231
 
      
 
200
 
232
201
      <varlistentry>
233
202
        <term><option>--dir
234
203
        <replaceable>DIRECTORY</replaceable></option></term>
236
205
        <replaceable>DIRECTORY</replaceable></option></term>
237
206
        <listitem>
238
207
          <para>
239
 
            Target directory for key files.  Default is <filename
240
 
            class="directory">/etc/keys/mandos</filename>.
 
208
            Target directory for key files.  Default is
 
209
            <filename>/etc/mandos</filename>.
241
210
          </para>
242
211
        </listitem>
243
212
      </varlistentry>
244
 
      
 
213
 
245
214
      <varlistentry>
246
215
        <term><option>--type
247
216
        <replaceable>TYPE</replaceable></option></term>
249
218
        <replaceable>TYPE</replaceable></option></term>
250
219
        <listitem>
251
220
          <para>
252
 
            OpenPGP key type.  Default is <quote>RSA</quote>.
 
221
            Key type.  Default is <quote>DSA</quote>.
253
222
          </para>
254
223
        </listitem>
255
224
      </varlistentry>
256
 
      
 
225
 
257
226
      <varlistentry>
258
227
        <term><option>--length
259
228
        <replaceable>BITS</replaceable></option></term>
261
230
        <replaceable>BITS</replaceable></option></term>
262
231
        <listitem>
263
232
          <para>
264
 
            OpenPGP key length in bits.  Default is 4096.
 
233
            Key length in bits.  Default is 2048.
265
234
          </para>
266
235
        </listitem>
267
236
      </varlistentry>
268
 
      
 
237
 
269
238
      <varlistentry>
270
239
        <term><option>--subtype
271
240
        <replaceable>KEYTYPE</replaceable></option></term>
273
242
        <replaceable>KEYTYPE</replaceable></option></term>
274
243
        <listitem>
275
244
          <para>
276
 
            OpenPGP subkey type.  Default is <quote>RSA</quote>
 
245
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
246
            encryption-only).
277
247
          </para>
278
248
        </listitem>
279
249
      </varlistentry>
280
 
      
 
250
 
281
251
      <varlistentry>
282
252
        <term><option>--sublength
283
253
        <replaceable>BITS</replaceable></option></term>
285
255
        <replaceable>BITS</replaceable></option></term>
286
256
        <listitem>
287
257
          <para>
288
 
            OpenPGP subkey length in bits.  Default is 4096.
 
258
            Subkey length in bits.  Default is 2048.
289
259
          </para>
290
260
        </listitem>
291
261
      </varlistentry>
292
 
      
 
262
 
293
263
      <varlistentry>
294
264
        <term><option>--email
295
265
        <replaceable>ADDRESS</replaceable></option></term>
301
271
          </para>
302
272
        </listitem>
303
273
      </varlistentry>
304
 
      
 
274
 
305
275
      <varlistentry>
306
276
        <term><option>--comment
307
277
        <replaceable>TEXT</replaceable></option></term>
309
279
        <replaceable>TEXT</replaceable></option></term>
310
280
        <listitem>
311
281
          <para>
312
 
            Comment field for key.  Default is empty.
 
282
            Comment field for key.  The default value is
 
283
            <quote><literal>Mandos client key</literal></quote>.
313
284
          </para>
314
285
        </listitem>
315
286
      </varlistentry>
316
 
      
 
287
 
317
288
      <varlistentry>
318
289
        <term><option>--expire
319
290
        <replaceable>TIME</replaceable></option></term>
327
298
          </para>
328
299
        </listitem>
329
300
      </varlistentry>
330
 
      
331
 
      <varlistentry>
332
 
        <term><option>--tls-keytype
333
 
        <replaceable>KEYTYPE</replaceable></option></term>
334
 
        <term><option>-T
335
 
        <replaceable>KEYTYPE</replaceable></option></term>
336
 
        <listitem>
337
 
          <para>
338
 
            TLS key type.  Default is <quote>ed25519</quote>
339
 
          </para>
340
 
        </listitem>
341
 
      </varlistentry>
342
 
      
 
301
 
343
302
      <varlistentry>
344
303
        <term><option>--force</option></term>
345
304
        <term><option>-f</option></term>
355
314
        <listitem>
356
315
          <para>
357
316
            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>
 
317
            present in either <filename>/etc/mandos</filename> or the
 
318
            directory specified with the <option>--dir</option>
360
319
            option.  Outputs, on standard output, a section suitable
361
320
            for inclusion in <citerefentry><refentrytitle
362
321
            >mandos-clients.conf</refentrytitle><manvolnum
367
326
          </para>
368
327
        </listitem>
369
328
      </varlistentry>
370
 
      <varlistentry>
371
 
        <term><option>--passfile
372
 
        <replaceable>FILE</replaceable></option></term>
373
 
        <term><option>-F
374
 
        <replaceable>FILE</replaceable></option></term>
375
 
        <listitem>
376
 
          <para>
377
 
            The same as <option>--password</option>, but read from
378
 
            <replaceable>FILE</replaceable>, not the terminal.
379
 
          </para>
380
 
        </listitem>
381
 
      </varlistentry>
382
 
      <varlistentry>
383
 
        <term><option>--no-ssh</option></term>
384
 
        <term><option>-S</option></term>
385
 
        <listitem>
386
 
          <para>
387
 
            When <option>--password</option> or
388
 
            <option>--passfile</option> is given, this option will
389
 
            prevent <command>&COMMANDNAME;</command> from calling
390
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
391
 
            for this host and, if successful, output suitable config
392
 
            options to use this fingerprint as a
393
 
            <option>checker</option> option in the output.  This is
394
 
            otherwise the default behavior.
395
 
          </para>
396
 
        </listitem>
397
 
      </varlistentry>
398
329
    </variablelist>
399
330
  </refsect1>
400
 
  
 
331
 
401
332
  <refsect1 id="overview">
402
333
    <title>OVERVIEW</title>
403
334
    <xi:include href="overview.xml"/>
404
335
    <para>
405
 
      This program is a small utility to generate new TLS and OpenPGP
406
 
      keys for new Mandos clients, and to generate sections for
407
 
      inclusion in <filename>clients.conf</filename> on the server.
 
336
      This program is a small utility to generate new OpenPGP keys for
 
337
      new Mandos clients, and to generate sections for inclusion in
 
338
      <filename>clients.conf</filename> on the server.
408
339
    </para>
409
340
  </refsect1>
410
 
  
 
341
 
411
342
  <refsect1 id="exit_status">
412
343
    <title>EXIT STATUS</title>
413
344
    <para>
433
364
    </variablelist>
434
365
  </refsect1>
435
366
  
436
 
  <refsect1 id="files">
 
367
  <refsect1 id="file">
437
368
    <title>FILES</title>
438
369
    <para>
439
370
      Use the <option>--dir</option> option to change where
442
373
    </para>
443
374
    <variablelist>
444
375
      <varlistentry>
445
 
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
 
376
        <term><filename>/etc/mandos/seckey.txt</filename></term>
446
377
        <listitem>
447
378
          <para>
448
379
            OpenPGP secret key file which will be created or
451
382
        </listitem>
452
383
      </varlistentry>
453
384
      <varlistentry>
454
 
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
 
385
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
455
386
        <listitem>
456
387
          <para>
457
388
            OpenPGP public key file which will be created or
460
391
        </listitem>
461
392
      </varlistentry>
462
393
      <varlistentry>
463
 
        <term><filename>/etc/keys/mandos/tls-privkey.pem</filename></term>
464
 
        <listitem>
465
 
          <para>
466
 
            Private key file which will be created or overwritten.
467
 
          </para>
468
 
        </listitem>
469
 
      </varlistentry>
470
 
      <varlistentry>
471
 
        <term><filename>/etc/keys/mandos/tls-pubkey.pem</filename></term>
472
 
        <listitem>
473
 
          <para>
474
 
            Public key file which will be created or overwritten.
475
 
          </para>
476
 
        </listitem>
477
 
      </varlistentry>
478
 
      <varlistentry>
479
 
        <term><filename class="directory">/tmp</filename></term>
 
394
        <term><filename>/tmp</filename></term>
480
395
        <listitem>
481
396
          <para>
482
397
            Temporary files will be written here if
486
401
      </varlistentry>
487
402
    </variablelist>
488
403
  </refsect1>
489
 
  
490
 
  <refsect1 id="bugs">
491
 
    <title>BUGS</title>
492
 
    <xi:include href="bugs.xml"/>
493
 
  </refsect1>
494
 
  
 
404
 
 
405
<!--   <refsect1 id="bugs"> -->
 
406
<!--     <title>BUGS</title> -->
 
407
<!--     <para> -->
 
408
<!--     </para> -->
 
409
<!--   </refsect1> -->
 
410
 
495
411
  <refsect1 id="example">
496
412
    <title>EXAMPLE</title>
497
413
    <informalexample>
516
432
    </informalexample>
517
433
    <informalexample>
518
434
      <para>
519
 
        Prompt for a password, encrypt it with the keys in <filename
520
 
        class="directory">/etc/keys/mandos</filename> and output a
521
 
        section suitable for <filename>clients.conf</filename>.
 
435
        Prompt for a password, encrypt it with the key in
 
436
        <filename>/etc/mandos</filename> and output a section suitable
 
437
        for <filename>clients.conf</filename>.
522
438
      </para>
523
439
      <para>
524
440
        <userinput>&COMMANDNAME; --password</userinput>
526
442
    </informalexample>
527
443
    <informalexample>
528
444
      <para>
529
 
        Prompt for a password, encrypt it with the keys in the
 
445
        Prompt for a password, encrypt it with the key in the
530
446
        <filename>client-key</filename> directory and output a section
531
447
        suitable for <filename>clients.conf</filename>.
532
448
      </para>
538
454
      </para>
539
455
    </informalexample>
540
456
  </refsect1>
541
 
  
 
457
 
542
458
  <refsect1 id="security">
543
459
    <title>SECURITY</title>
544
460
    <para>
553
469
      <manvolnum>8</manvolnum></citerefentry>.
554
470
    </para>
555
471
  </refsect1>
556
 
  
 
472
 
557
473
  <refsect1 id="see_also">
558
474
    <title>SEE ALSO</title>
559
475
    <para>
560
 
      <citerefentry><refentrytitle>intro</refentrytitle>
561
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
562
476
      <citerefentry><refentrytitle>gpg</refentrytitle>
563
477
      <manvolnum>1</manvolnum></citerefentry>,
564
478
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
566
480
      <citerefentry><refentrytitle>mandos</refentrytitle>
567
481
      <manvolnum>8</manvolnum></citerefentry>,
568
482
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
569
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
570
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
571
 
      <manvolnum>1</manvolnum></citerefentry>
 
483
      <manvolnum>8mandos</manvolnum></citerefentry>
572
484
    </para>
573
485
  </refsect1>
574
486