/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: 2008-08-31 10:27:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831102733-2u083dacxul80ynp
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
                               <literal>.  Split <term> tags into one
                               for each option.  Moved long options
                               before short.

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-08-31">
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
34
      <holder>Teddy Hogeborn</holder>
46
35
      <holder>Björn Påhlsson</holder>
47
36
    </copyright>
48
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
49
60
  </refentryinfo>
50
 
  
 
61
 
51
62
  <refmeta>
52
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
53
64
    <manvolnum>8</manvolnum>
59
70
      Generate key and password for Mandos client and server.
60
71
    </refpurpose>
61
72
  </refnamediv>
62
 
  
 
73
 
63
74
  <refsynopsisdiv>
64
75
    <cmdsynopsis>
65
76
      <command>&COMMANDNAME;</command>
126
137
        <replaceable>TIME</replaceable></option></arg>
127
138
      </group>
128
139
      <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>
 
140
      <arg><option>--force</option></arg>
140
141
    </cmdsynopsis>
141
142
    <cmdsynopsis>
142
143
      <command>&COMMANDNAME;</command>
143
144
      <group choice="req">
144
145
        <arg choice="plain"><option>--password</option></arg>
145
146
        <arg choice="plain"><option>-p</option></arg>
146
 
        <arg choice="plain"><option>--passfile
147
 
        <replaceable>FILE</replaceable></option></arg>
148
 
        <arg choice="plain"><option>-F</option>
149
 
        <replaceable>FILE</replaceable></arg>
150
147
      </group>
151
148
      <sbr/>
152
149
      <group>
162
159
        <arg choice="plain"><option>-n
163
160
        <replaceable>NAME</replaceable></option></arg>
164
161
      </group>
165
 
      <group>
166
 
        <arg choice="plain"><option>--no-ssh</option></arg>
167
 
        <arg choice="plain"><option>-S</option></arg>
168
 
      </group>
169
162
    </cmdsynopsis>
170
163
    <cmdsynopsis>
171
164
      <command>&COMMANDNAME;</command>
187
180
    <title>DESCRIPTION</title>
188
181
    <para>
189
182
      <command>&COMMANDNAME;</command> is a program to generate the
190
 
      TLS and OpenPGP keys used by
191
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
192
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
 
183
      OpenPGP key used by
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
193
186
      normally written to /etc/mandos for later installation into the
194
187
      initrd image, but this, and most other things, can be changed
195
188
      with command line options.
196
189
    </para>
197
190
    <para>
198
191
      This program can also be used with the
199
 
      <option>--password</option> or <option>--passfile</option>
200
 
      options to generate a ready-made section for
201
 
      <filename>clients.conf</filename> (see
 
192
      <option>--password</option> option to generate a ready-made
 
193
      section for <filename>clients.conf</filename> (see
202
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
203
195
      <manvolnum>5</manvolnum></citerefentry>).
204
196
    </para>
227
219
          </para>
228
220
        </listitem>
229
221
      </varlistentry>
230
 
      
 
222
 
231
223
      <varlistentry>
232
224
        <term><option>--dir
233
225
        <replaceable>DIRECTORY</replaceable></option></term>
236
228
        <listitem>
237
229
          <para>
238
230
            Target directory for key files.  Default is
239
 
            <filename class="directory">/etc/mandos</filename>.
 
231
            <filename>/etc/mandos</filename>.
240
232
          </para>
241
233
        </listitem>
242
234
      </varlistentry>
243
 
      
 
235
 
244
236
      <varlistentry>
245
237
        <term><option>--type
246
238
        <replaceable>TYPE</replaceable></option></term>
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>DSA</quote>.
252
244
          </para>
253
245
        </listitem>
254
246
      </varlistentry>
255
 
      
 
247
 
256
248
      <varlistentry>
257
249
        <term><option>--length
258
250
        <replaceable>BITS</replaceable></option></term>
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 2048.
264
256
          </para>
265
257
        </listitem>
266
258
      </varlistentry>
267
 
      
 
259
 
268
260
      <varlistentry>
269
261
        <term><option>--subtype
270
262
        <replaceable>KEYTYPE</replaceable></option></term>
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>ELG-E</quote> (Elgamal
 
268
            encryption-only).
276
269
          </para>
277
270
        </listitem>
278
271
      </varlistentry>
279
 
      
 
272
 
280
273
      <varlistentry>
281
274
        <term><option>--sublength
282
275
        <replaceable>BITS</replaceable></option></term>
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 2048.
288
281
          </para>
289
282
        </listitem>
290
283
      </varlistentry>
291
 
      
 
284
 
292
285
      <varlistentry>
293
286
        <term><option>--email
294
287
        <replaceable>ADDRESS</replaceable></option></term>
300
293
          </para>
301
294
        </listitem>
302
295
      </varlistentry>
303
 
      
 
296
 
304
297
      <varlistentry>
305
298
        <term><option>--comment
306
299
        <replaceable>TEXT</replaceable></option></term>
308
301
        <replaceable>TEXT</replaceable></option></term>
309
302
        <listitem>
310
303
          <para>
311
 
            Comment field for key.  Default is empty.
 
304
            Comment field for key.  The default value is
 
305
            <quote><literal>Mandos client key</literal></quote>.
312
306
          </para>
313
307
        </listitem>
314
308
      </varlistentry>
315
 
      
 
309
 
316
310
      <varlistentry>
317
311
        <term><option>--expire
318
312
        <replaceable>TIME</replaceable></option></term>
326
320
          </para>
327
321
        </listitem>
328
322
      </varlistentry>
329
 
      
330
 
      <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
 
      
 
323
 
342
324
      <varlistentry>
343
325
        <term><option>--force</option></term>
344
326
        <term><option>-f</option></term>
366
348
          </para>
367
349
        </listitem>
368
350
      </varlistentry>
369
 
      <varlistentry>
370
 
        <term><option>--passfile
371
 
        <replaceable>FILE</replaceable></option></term>
372
 
        <term><option>-F
373
 
        <replaceable>FILE</replaceable></option></term>
374
 
        <listitem>
375
 
          <para>
376
 
            The same as <option>--password</option>, but read from
377
 
            <replaceable>FILE</replaceable>, not the terminal.
378
 
          </para>
379
 
        </listitem>
380
 
      </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
351
    </variablelist>
398
352
  </refsect1>
399
 
  
 
353
 
400
354
  <refsect1 id="overview">
401
355
    <title>OVERVIEW</title>
402
356
    <xi:include href="overview.xml"/>
403
357
    <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.
 
358
      This program is a small utility to generate new OpenPGP keys for
 
359
      new Mandos clients, and to generate sections for inclusion in
 
360
      <filename>clients.conf</filename> on the server.
407
361
    </para>
408
362
  </refsect1>
409
 
  
 
363
 
410
364
  <refsect1 id="exit_status">
411
365
    <title>EXIT STATUS</title>
412
366
    <para>
432
386
    </variablelist>
433
387
  </refsect1>
434
388
  
435
 
  <refsect1 id="files">
 
389
  <refsect1 id="file">
436
390
    <title>FILES</title>
437
391
    <para>
438
392
      Use the <option>--dir</option> option to change where
459
413
        </listitem>
460
414
      </varlistentry>
461
415
      <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>
 
416
        <term><filename>/tmp</filename></term>
479
417
        <listitem>
480
418
          <para>
481
419
            Temporary files will be written here if
485
423
      </varlistentry>
486
424
    </variablelist>
487
425
  </refsect1>
488
 
  
 
426
 
489
427
  <refsect1 id="bugs">
490
428
    <title>BUGS</title>
491
 
    <xi:include href="bugs.xml"/>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
492
432
  </refsect1>
493
 
  
 
433
 
494
434
  <refsect1 id="example">
495
435
    <title>EXAMPLE</title>
496
436
    <informalexample>
515
455
    </informalexample>
516
456
    <informalexample>
517
457
      <para>
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>.
 
458
        Prompt for a password, encrypt it with the key in
 
459
        <filename>/etc/mandos</filename> and output a section suitable
 
460
        for <filename>clients.conf</filename>.
521
461
      </para>
522
462
      <para>
523
463
        <userinput>&COMMANDNAME; --password</userinput>
537
477
      </para>
538
478
    </informalexample>
539
479
  </refsect1>
540
 
  
 
480
 
541
481
  <refsect1 id="security">
542
482
    <title>SECURITY</title>
543
483
    <para>
552
492
      <manvolnum>8</manvolnum></citerefentry>.
553
493
    </para>
554
494
  </refsect1>
555
 
  
 
495
 
556
496
  <refsect1 id="see_also">
557
497
    <title>SEE ALSO</title>
558
498
    <para>
559
 
      <citerefentry><refentrytitle>intro</refentrytitle>
560
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
561
499
      <citerefentry><refentrytitle>gpg</refentrytitle>
562
500
      <manvolnum>1</manvolnum></citerefentry>,
563
501
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
564
502
      <manvolnum>5</manvolnum></citerefentry>,
565
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
566
504
      <manvolnum>8</manvolnum></citerefentry>,
567
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
568
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
569
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
570
 
      <manvolnum>1</manvolnum></citerefentry>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
506
      <manvolnum>8mandos</manvolnum></citerefentry>
571
507
    </para>
572
508
  </refsect1>
573
509