/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-09-21 04:22:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080921042250-r0qqjsbz2ulfo5le
* Makefile: Bug fix: fix syntax error.

* debian/control: Depend on "po-debconf".
  (mandos, mandos-client): Add "${misc:Depends}", used by
                           dh_installdebconf.

* debian/mandos-client.config: New; show note.
* debian/mandos-client.template: New.

* debian/mandos.README.Debian: New.

* debian/mandos.config: New; show note.
* debian/mandos.prerm: New; stop daemon.
* debian/mandos.template: New.

* debian/po/POTFILES.in: New.
* debian/po/sv.po: New.

* debian/rules (clean): Added "debconf-updatepo" as suggested by
                        po-debconf(7).
  (binary-common): Added "dh_installdebconf" to use "debian/*.config"
                   and "debian/*.template" files.

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-07-18">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-20">
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>
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>
163
141
        <arg choice="plain"><option>-n
164
142
        <replaceable>NAME</replaceable></option></arg>
165
143
      </group>
166
 
      <group>
167
 
        <arg choice="plain"><option>--no-ssh</option></arg>
168
 
        <arg choice="plain"><option>-S</option></arg>
169
 
      </group>
170
144
    </cmdsynopsis>
171
145
    <cmdsynopsis>
172
146
      <command>&COMMANDNAME;</command>
188
162
    <title>DESCRIPTION</title>
189
163
    <para>
190
164
      <command>&COMMANDNAME;</command> is a program to generate the
191
 
      TLS and OpenPGP keys used by
 
165
      OpenPGP key used by
192
166
      <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.
 
167
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
168
      normally written to /etc/mandos for later installation into the
 
169
      initrd image, but this, and most other things, can be changed
 
170
      with command line options.
197
171
    </para>
198
172
    <para>
199
173
      This program can also be used with the
236
210
        <replaceable>DIRECTORY</replaceable></option></term>
237
211
        <listitem>
238
212
          <para>
239
 
            Target directory for key files.  Default is <filename
240
 
            class="directory">/etc/keys/mandos</filename>.
 
213
            Target directory for key files.  Default is
 
214
            <filename>/etc/mandos</filename>.
241
215
          </para>
242
216
        </listitem>
243
217
      </varlistentry>
249
223
        <replaceable>TYPE</replaceable></option></term>
250
224
        <listitem>
251
225
          <para>
252
 
            OpenPGP key type.  Default is <quote>RSA</quote>.
 
226
            Key type.  Default is <quote>DSA</quote>.
253
227
          </para>
254
228
        </listitem>
255
229
      </varlistentry>
261
235
        <replaceable>BITS</replaceable></option></term>
262
236
        <listitem>
263
237
          <para>
264
 
            OpenPGP key length in bits.  Default is 4096.
 
238
            Key length in bits.  Default is 2048.
265
239
          </para>
266
240
        </listitem>
267
241
      </varlistentry>
273
247
        <replaceable>KEYTYPE</replaceable></option></term>
274
248
        <listitem>
275
249
          <para>
276
 
            OpenPGP subkey type.  Default is <quote>RSA</quote>
 
250
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
251
            encryption-only).
277
252
          </para>
278
253
        </listitem>
279
254
      </varlistentry>
285
260
        <replaceable>BITS</replaceable></option></term>
286
261
        <listitem>
287
262
          <para>
288
 
            OpenPGP subkey length in bits.  Default is 4096.
 
263
            Subkey length in bits.  Default is 2048.
289
264
          </para>
290
265
        </listitem>
291
266
      </varlistentry>
309
284
        <replaceable>TEXT</replaceable></option></term>
310
285
        <listitem>
311
286
          <para>
312
 
            Comment field for key.  Default is empty.
 
287
            Comment field for key.  The default value is
 
288
            <quote><literal>Mandos client key</literal></quote>.
313
289
          </para>
314
290
        </listitem>
315
291
      </varlistentry>
329
305
      </varlistentry>
330
306
      
331
307
      <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
 
      
343
 
      <varlistentry>
344
308
        <term><option>--force</option></term>
345
309
        <term><option>-f</option></term>
346
310
        <listitem>
355
319
        <listitem>
356
320
          <para>
357
321
            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>
 
322
            present in either <filename>/etc/mandos</filename> or the
 
323
            directory specified with the <option>--dir</option>
360
324
            option.  Outputs, on standard output, a section suitable
361
325
            for inclusion in <citerefentry><refentrytitle
362
326
            >mandos-clients.conf</refentrytitle><manvolnum
363
327
            >8</manvolnum></citerefentry>.  The host name or the name
364
328
            specified with the <option>--name</option> option is used
365
329
            for the section header.  All other options are ignored,
366
 
            and no key is created.  Note: white space is stripped from
367
 
            the beginning and from the end of the password; See <xref
368
 
            linkend="bugs"/>.
 
330
            and no key is created.
369
331
          </para>
370
332
        </listitem>
371
333
      </varlistentry>
377
339
        <listitem>
378
340
          <para>
379
341
            The same as <option>--password</option>, but read from
380
 
            <replaceable>FILE</replaceable>, not the terminal, and
381
 
            white space is not stripped from the password in any way.
382
 
          </para>
383
 
        </listitem>
384
 
      </varlistentry>
385
 
      <varlistentry>
386
 
        <term><option>--no-ssh</option></term>
387
 
        <term><option>-S</option></term>
388
 
        <listitem>
389
 
          <para>
390
 
            When <option>--password</option> or
391
 
            <option>--passfile</option> is given, this option will
392
 
            prevent <command>&COMMANDNAME;</command> from calling
393
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
394
 
            for this host and, if successful, output suitable config
395
 
            options to use this fingerprint as a
396
 
            <option>checker</option> option in the output.  This is
397
 
            otherwise the default behavior.
 
342
            <replaceable>FILE</replaceable>, not the terminal.
398
343
          </para>
399
344
        </listitem>
400
345
      </varlistentry>
405
350
    <title>OVERVIEW</title>
406
351
    <xi:include href="overview.xml"/>
407
352
    <para>
408
 
      This program is a small utility to generate new TLS and OpenPGP
409
 
      keys for new Mandos clients, and to generate sections for
410
 
      inclusion in <filename>clients.conf</filename> on the server.
 
353
      This program is a small utility to generate new OpenPGP keys for
 
354
      new Mandos clients, and to generate sections for inclusion in
 
355
      <filename>clients.conf</filename> on the server.
411
356
    </para>
412
357
  </refsect1>
413
358
  
436
381
    </variablelist>
437
382
  </refsect1>
438
383
  
439
 
  <refsect1 id="files">
 
384
  <refsect1 id="file">
440
385
    <title>FILES</title>
441
386
    <para>
442
387
      Use the <option>--dir</option> option to change where
445
390
    </para>
446
391
    <variablelist>
447
392
      <varlistentry>
448
 
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
 
393
        <term><filename>/etc/mandos/seckey.txt</filename></term>
449
394
        <listitem>
450
395
          <para>
451
396
            OpenPGP secret key file which will be created or
454
399
        </listitem>
455
400
      </varlistentry>
456
401
      <varlistentry>
457
 
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
 
402
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
458
403
        <listitem>
459
404
          <para>
460
405
            OpenPGP public key file which will be created or
463
408
        </listitem>
464
409
      </varlistentry>
465
410
      <varlistentry>
466
 
        <term><filename>/etc/keys/mandos/tls-privkey.pem</filename></term>
467
 
        <listitem>
468
 
          <para>
469
 
            Private key file which will be created or overwritten.
470
 
          </para>
471
 
        </listitem>
472
 
      </varlistentry>
473
 
      <varlistentry>
474
 
        <term><filename>/etc/keys/mandos/tls-pubkey.pem</filename></term>
475
 
        <listitem>
476
 
          <para>
477
 
            Public key file which will be created or overwritten.
478
 
          </para>
479
 
        </listitem>
480
 
      </varlistentry>
481
 
      <varlistentry>
482
 
        <term><filename class="directory">/tmp</filename></term>
 
411
        <term><filename>/tmp</filename></term>
483
412
        <listitem>
484
413
          <para>
485
414
            Temporary files will be written here if
490
419
    </variablelist>
491
420
  </refsect1>
492
421
  
493
 
  <refsect1 id="bugs">
494
 
    <title>BUGS</title>
495
 
    <para>
496
 
      The <option>--password</option>/<option>-p</option> option
497
 
      strips white space from the start and from the end of the
498
 
      password before using it.  If this is a problem, use the
499
 
      <option>--passfile</option> option instead, which does not do
500
 
      this.
501
 
    </para>
502
 
    <xi:include href="bugs.xml"/>
503
 
  </refsect1>
 
422
<!--   <refsect1 id="bugs"> -->
 
423
<!--     <title>BUGS</title> -->
 
424
<!--     <para> -->
 
425
<!--     </para> -->
 
426
<!--   </refsect1> -->
504
427
  
505
428
  <refsect1 id="example">
506
429
    <title>EXAMPLE</title>
526
449
    </informalexample>
527
450
    <informalexample>
528
451
      <para>
529
 
        Prompt for a password, encrypt it with the keys in <filename
530
 
        class="directory">/etc/keys/mandos</filename> and output a
531
 
        section suitable for <filename>clients.conf</filename>.
 
452
        Prompt for a password, encrypt it with the key in
 
453
        <filename>/etc/mandos</filename> and output a section suitable
 
454
        for <filename>clients.conf</filename>.
532
455
      </para>
533
456
      <para>
534
457
        <userinput>&COMMANDNAME; --password</userinput>
536
459
    </informalexample>
537
460
    <informalexample>
538
461
      <para>
539
 
        Prompt for a password, encrypt it with the keys in the
 
462
        Prompt for a password, encrypt it with the key in the
540
463
        <filename>client-key</filename> directory and output a section
541
464
        suitable for <filename>clients.conf</filename>.
542
465
      </para>
567
490
  <refsect1 id="see_also">
568
491
    <title>SEE ALSO</title>
569
492
    <para>
570
 
      <citerefentry><refentrytitle>intro</refentrytitle>
571
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
572
493
      <citerefentry><refentrytitle>gpg</refentrytitle>
573
494
      <manvolnum>1</manvolnum></citerefentry>,
574
495
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
576
497
      <citerefentry><refentrytitle>mandos</refentrytitle>
577
498
      <manvolnum>8</manvolnum></citerefentry>,
578
499
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
579
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
580
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
581
 
      <manvolnum>1</manvolnum></citerefentry>
 
500
      <manvolnum>8mandos</manvolnum></citerefentry>
582
501
    </para>
583
502
  </refsect1>
584
503