/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-10-03 09:32:30 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081003093230-rshn19e0c19zz12i
* .bzrignore (plugins.d/askpass-fifo): Added.

* Makefile (FORTIFY): Added "-fstack-protector-all".
  (mandos, mandos-keygen): Use more strict regexps when updating the
                           version number.

* mandos (Client.__init__): Use os.path.expandvars() and
                            os.path.expanduser() on the "secfile"
                            config value.

* plugins.d/splashy.c: Update comments and order of #include's.
  (main): Check user and group when looking for running splashy
          process.  Do not ignore ENOENT from execl().  Use _exit()
          instead of "return" when an error happens in child
          processes.  Bug fix: Only wait for splashy_update
          completion if it was started.  Bug fix: detect failing
          waitpid().  Only kill splashy_update if it is running.  Do
          the killing of the old splashy process before the fork().
          Do setsid() and setuid(geteuid()) before starting the new
          splashy.  Report failing execl().

* plugins.d/usplash.c: Update comments and order of #include's.
  (main): Check user and group when looking for running usplash
          process.  Do not report execv() error if interrupted by a
          signal.

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 "2008-09-30">
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
 
      <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
35
      <holder>Teddy Hogeborn</holder>
47
36
      <holder>Björn Påhlsson</holder>
48
37
    </copyright>
127
116
        <replaceable>TIME</replaceable></option></arg>
128
117
      </group>
129
118
      <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>
 
119
      <arg><option>--force</option></arg>
141
120
    </cmdsynopsis>
142
121
    <cmdsynopsis>
143
122
      <command>&COMMANDNAME;</command>
163
142
        <arg choice="plain"><option>-n
164
143
        <replaceable>NAME</replaceable></option></arg>
165
144
      </group>
166
 
      <group>
167
 
        <arg choice="plain"><option>--no-ssh</option></arg>
168
 
        <arg choice="plain"><option>-S</option></arg>
169
 
      </group>
170
145
    </cmdsynopsis>
171
146
    <cmdsynopsis>
172
147
      <command>&COMMANDNAME;</command>
188
163
    <title>DESCRIPTION</title>
189
164
    <para>
190
165
      <command>&COMMANDNAME;</command> is a program to generate the
191
 
      TLS and OpenPGP keys used by
 
166
      OpenPGP key used by
192
167
      <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.
 
168
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
169
      normally written to /etc/mandos for later installation into the
 
170
      initrd image, but this, and most other things, can be changed
 
171
      with command line options.
197
172
    </para>
198
173
    <para>
199
174
      This program can also be used with the
236
211
        <replaceable>DIRECTORY</replaceable></option></term>
237
212
        <listitem>
238
213
          <para>
239
 
            Target directory for key files.  Default is <filename
240
 
            class="directory">/etc/keys/mandos</filename>.
 
214
            Target directory for key files.  Default is
 
215
            <filename>/etc/mandos</filename>.
241
216
          </para>
242
217
        </listitem>
243
218
      </varlistentry>
249
224
        <replaceable>TYPE</replaceable></option></term>
250
225
        <listitem>
251
226
          <para>
252
 
            OpenPGP key type.  Default is <quote>RSA</quote>.
 
227
            Key type.  Default is <quote>DSA</quote>.
253
228
          </para>
254
229
        </listitem>
255
230
      </varlistentry>
261
236
        <replaceable>BITS</replaceable></option></term>
262
237
        <listitem>
263
238
          <para>
264
 
            OpenPGP key length in bits.  Default is 4096.
 
239
            Key length in bits.  Default is 2048.
265
240
          </para>
266
241
        </listitem>
267
242
      </varlistentry>
273
248
        <replaceable>KEYTYPE</replaceable></option></term>
274
249
        <listitem>
275
250
          <para>
276
 
            OpenPGP subkey type.  Default is <quote>RSA</quote>
 
251
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
252
            encryption-only).
277
253
          </para>
278
254
        </listitem>
279
255
      </varlistentry>
285
261
        <replaceable>BITS</replaceable></option></term>
286
262
        <listitem>
287
263
          <para>
288
 
            OpenPGP subkey length in bits.  Default is 4096.
 
264
            Subkey length in bits.  Default is 2048.
289
265
          </para>
290
266
        </listitem>
291
267
      </varlistentry>
309
285
        <replaceable>TEXT</replaceable></option></term>
310
286
        <listitem>
311
287
          <para>
312
 
            Comment field for key.  Default is empty.
 
288
            Comment field for key.  The default value is
 
289
            <quote><literal>Mandos client key</literal></quote>.
313
290
          </para>
314
291
        </listitem>
315
292
      </varlistentry>
329
306
      </varlistentry>
330
307
      
331
308
      <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
309
        <term><option>--force</option></term>
345
310
        <term><option>-f</option></term>
346
311
        <listitem>
355
320
        <listitem>
356
321
          <para>
357
322
            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>
 
323
            present in either <filename>/etc/mandos</filename> or the
 
324
            directory specified with the <option>--dir</option>
360
325
            option.  Outputs, on standard output, a section suitable
361
326
            for inclusion in <citerefentry><refentrytitle
362
327
            >mandos-clients.conf</refentrytitle><manvolnum
379
344
          </para>
380
345
        </listitem>
381
346
      </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
347
    </variablelist>
399
348
  </refsect1>
400
349
  
402
351
    <title>OVERVIEW</title>
403
352
    <xi:include href="overview.xml"/>
404
353
    <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.
 
354
      This program is a small utility to generate new OpenPGP keys for
 
355
      new Mandos clients, and to generate sections for inclusion in
 
356
      <filename>clients.conf</filename> on the server.
408
357
    </para>
409
358
  </refsect1>
410
359
  
433
382
    </variablelist>
434
383
  </refsect1>
435
384
  
436
 
  <refsect1 id="files">
 
385
  <refsect1 id="file">
437
386
    <title>FILES</title>
438
387
    <para>
439
388
      Use the <option>--dir</option> option to change where
442
391
    </para>
443
392
    <variablelist>
444
393
      <varlistentry>
445
 
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
 
394
        <term><filename>/etc/mandos/seckey.txt</filename></term>
446
395
        <listitem>
447
396
          <para>
448
397
            OpenPGP secret key file which will be created or
451
400
        </listitem>
452
401
      </varlistentry>
453
402
      <varlistentry>
454
 
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
 
403
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
455
404
        <listitem>
456
405
          <para>
457
406
            OpenPGP public key file which will be created or
460
409
        </listitem>
461
410
      </varlistentry>
462
411
      <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>
 
412
        <term><filename>/tmp</filename></term>
480
413
        <listitem>
481
414
          <para>
482
415
            Temporary files will be written here if
487
420
    </variablelist>
488
421
  </refsect1>
489
422
  
490
 
  <refsect1 id="bugs">
491
 
    <title>BUGS</title>
492
 
    <xi:include href="bugs.xml"/>
493
 
  </refsect1>
 
423
<!--   <refsect1 id="bugs"> -->
 
424
<!--     <title>BUGS</title> -->
 
425
<!--     <para> -->
 
426
<!--     </para> -->
 
427
<!--   </refsect1> -->
494
428
  
495
429
  <refsect1 id="example">
496
430
    <title>EXAMPLE</title>
516
450
    </informalexample>
517
451
    <informalexample>
518
452
      <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>.
 
453
        Prompt for a password, encrypt it with the key in
 
454
        <filename>/etc/mandos</filename> and output a section suitable
 
455
        for <filename>clients.conf</filename>.
522
456
      </para>
523
457
      <para>
524
458
        <userinput>&COMMANDNAME; --password</userinput>
526
460
    </informalexample>
527
461
    <informalexample>
528
462
      <para>
529
 
        Prompt for a password, encrypt it with the keys in the
 
463
        Prompt for a password, encrypt it with the key in the
530
464
        <filename>client-key</filename> directory and output a section
531
465
        suitable for <filename>clients.conf</filename>.
532
466
      </para>
557
491
  <refsect1 id="see_also">
558
492
    <title>SEE ALSO</title>
559
493
    <para>
560
 
      <citerefentry><refentrytitle>intro</refentrytitle>
561
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
562
494
      <citerefentry><refentrytitle>gpg</refentrytitle>
563
495
      <manvolnum>1</manvolnum></citerefentry>,
564
496
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
566
498
      <citerefentry><refentrytitle>mandos</refentrytitle>
567
499
      <manvolnum>8</manvolnum></citerefentry>,
568
500
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
569
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
570
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
571
 
      <manvolnum>1</manvolnum></citerefentry>
 
501
      <manvolnum>8mandos</manvolnum></citerefentry>
572
502
    </para>
573
503
  </refsect1>
574
504