/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: 2012-01-01 01:16:15 UTC
  • Revision ID: teddy@recompile.se-20120101011615-1jzyuxbw1z4700a3
* mandos-ctl (main): Bug fix: Make --secret actually work.

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 "2012-01-01">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2010</year>
37
36
      <year>2011</year>
38
37
      <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
38
      <holder>Teddy Hogeborn</holder>
46
39
      <holder>Björn Påhlsson</holder>
47
40
    </copyright>
126
119
        <replaceable>TIME</replaceable></option></arg>
127
120
      </group>
128
121
      <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>
 
122
      <arg><option>--force</option></arg>
140
123
    </cmdsynopsis>
141
124
    <cmdsynopsis>
142
125
      <command>&COMMANDNAME;</command>
162
145
        <arg choice="plain"><option>-n
163
146
        <replaceable>NAME</replaceable></option></arg>
164
147
      </group>
165
 
      <group>
166
 
        <arg choice="plain"><option>--no-ssh</option></arg>
167
 
        <arg choice="plain"><option>-S</option></arg>
168
 
      </group>
169
148
    </cmdsynopsis>
170
149
    <cmdsynopsis>
171
150
      <command>&COMMANDNAME;</command>
187
166
    <title>DESCRIPTION</title>
188
167
    <para>
189
168
      <command>&COMMANDNAME;</command> is a program to generate the
190
 
      TLS and OpenPGP keys used by
 
169
      OpenPGP key used by
191
170
      <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.
 
171
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
172
      normally written to /etc/mandos for later installation into the
 
173
      initrd image, but this, and most other things, can be changed
 
174
      with command line options.
196
175
    </para>
197
176
    <para>
198
177
      This program can also be used with the
235
214
        <replaceable>DIRECTORY</replaceable></option></term>
236
215
        <listitem>
237
216
          <para>
238
 
            Target directory for key files.  Default is <filename
239
 
            class="directory">/etc/keys/mandos</filename>.
 
217
            Target directory for key files.  Default is
 
218
            <filename class="directory">/etc/mandos</filename>.
240
219
          </para>
241
220
        </listitem>
242
221
      </varlistentry>
248
227
        <replaceable>TYPE</replaceable></option></term>
249
228
        <listitem>
250
229
          <para>
251
 
            OpenPGP key type.  Default is <quote>RSA</quote>.
 
230
            Key type.  Default is <quote>DSA</quote>.
252
231
          </para>
253
232
        </listitem>
254
233
      </varlistentry>
260
239
        <replaceable>BITS</replaceable></option></term>
261
240
        <listitem>
262
241
          <para>
263
 
            OpenPGP key length in bits.  Default is 4096.
 
242
            Key length in bits.  Default is 2048.
264
243
          </para>
265
244
        </listitem>
266
245
      </varlistentry>
272
251
        <replaceable>KEYTYPE</replaceable></option></term>
273
252
        <listitem>
274
253
          <para>
275
 
            OpenPGP subkey type.  Default is <quote>RSA</quote>
 
254
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
255
            encryption-only).
276
256
          </para>
277
257
        </listitem>
278
258
      </varlistentry>
284
264
        <replaceable>BITS</replaceable></option></term>
285
265
        <listitem>
286
266
          <para>
287
 
            OpenPGP subkey length in bits.  Default is 4096.
 
267
            Subkey length in bits.  Default is 2048.
288
268
          </para>
289
269
        </listitem>
290
270
      </varlistentry>
308
288
        <replaceable>TEXT</replaceable></option></term>
309
289
        <listitem>
310
290
          <para>
311
 
            Comment field for key.  Default is empty.
 
291
            Comment field for key.  The default value is
 
292
            <quote><literal>Mandos client key</literal></quote>.
312
293
          </para>
313
294
        </listitem>
314
295
      </varlistentry>
328
309
      </varlistentry>
329
310
      
330
311
      <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
312
        <term><option>--force</option></term>
344
313
        <term><option>-f</option></term>
345
314
        <listitem>
354
323
        <listitem>
355
324
          <para>
356
325
            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>
 
326
            present in either <filename>/etc/mandos</filename> or the
 
327
            directory specified with the <option>--dir</option>
359
328
            option.  Outputs, on standard output, a section suitable
360
329
            for inclusion in <citerefentry><refentrytitle
361
330
            >mandos-clients.conf</refentrytitle><manvolnum
378
347
          </para>
379
348
        </listitem>
380
349
      </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
350
    </variablelist>
398
351
  </refsect1>
399
352
  
401
354
    <title>OVERVIEW</title>
402
355
    <xi:include href="overview.xml"/>
403
356
    <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.
 
357
      This program is a small utility to generate new OpenPGP keys for
 
358
      new Mandos clients, and to generate sections for inclusion in
 
359
      <filename>clients.conf</filename> on the server.
407
360
    </para>
408
361
  </refsect1>
409
362
  
441
394
    </para>
442
395
    <variablelist>
443
396
      <varlistentry>
444
 
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
 
397
        <term><filename>/etc/mandos/seckey.txt</filename></term>
445
398
        <listitem>
446
399
          <para>
447
400
            OpenPGP secret key file which will be created or
450
403
        </listitem>
451
404
      </varlistentry>
452
405
      <varlistentry>
453
 
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
 
406
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
454
407
        <listitem>
455
408
          <para>
456
409
            OpenPGP public key file which will be created or
459
412
        </listitem>
460
413
      </varlistentry>
461
414
      <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
415
        <term><filename class="directory">/tmp</filename></term>
479
416
        <listitem>
480
417
          <para>
486
423
    </variablelist>
487
424
  </refsect1>
488
425
  
489
 
  <refsect1 id="bugs">
490
 
    <title>BUGS</title>
491
 
    <xi:include href="bugs.xml"/>
492
 
  </refsect1>
 
426
<!--   <refsect1 id="bugs"> -->
 
427
<!--     <title>BUGS</title> -->
 
428
<!--     <para> -->
 
429
<!--     </para> -->
 
430
<!--   </refsect1> -->
493
431
  
494
432
  <refsect1 id="example">
495
433
    <title>EXAMPLE</title>
515
453
    </informalexample>
516
454
    <informalexample>
517
455
      <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>.
 
456
        Prompt for a password, encrypt it with the key in <filename
 
457
        class="directory">/etc/mandos</filename> and output a section
 
458
        suitable for <filename>clients.conf</filename>.
521
459
      </para>
522
460
      <para>
523
461
        <userinput>&COMMANDNAME; --password</userinput>
525
463
    </informalexample>
526
464
    <informalexample>
527
465
      <para>
528
 
        Prompt for a password, encrypt it with the keys in the
 
466
        Prompt for a password, encrypt it with the key in the
529
467
        <filename>client-key</filename> directory and output a section
530
468
        suitable for <filename>clients.conf</filename>.
531
469
      </para>
565
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
566
504
      <manvolnum>8</manvolnum></citerefentry>,
567
505
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
568
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
569
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
570
 
      <manvolnum>1</manvolnum></citerefentry>
 
506
      <manvolnum>8mandos</manvolnum></citerefentry>
571
507
    </para>
572
508
  </refsect1>
573
509