/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-08-18 03:25:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818032501-2cl874fi3uvsqn1b
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
                         tags.  Also show the "-h" option.
  (OPTIONS): Note that failure to obey the "--interface" option is not
             considered critical.
  (ENVIRONMENT): New section to document the use of PATH by /bin/sh.
  (FILES): Added "/bin/sh".
  (BUGS): Add five bugs from the TODO file.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).
  (SERVER, CLIENTS): Added "id" attribute.
  (CLIENT): Document the security implications of one of the five
            bugs added to the BUGS section.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-08-30">
7
8
]>
8
9
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
10
11
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
14
15
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
35
    </copyright>
37
36
    <legalnotice>
38
37
      <para>
75
74
  <refsynopsisdiv>
76
75
    <cmdsynopsis>
77
76
      <command>&COMMANDNAME;</command>
78
 
      <group>
79
 
        <arg choice="plain"><option>--dir
80
 
        <replaceable>DIRECTORY</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-d
82
 
        <replaceable>DIRECTORY</replaceable></option></arg>
83
 
      </group>
84
 
      <sbr/>
85
 
      <group>
86
 
        <arg choice="plain"><option>--type
87
 
        <replaceable>KEYTYPE</replaceable></option></arg>
88
 
        <arg choice="plain"><option>-t
89
 
        <replaceable>KEYTYPE</replaceable></option></arg>
90
 
      </group>
91
 
      <sbr/>
92
 
      <group>
93
 
        <arg choice="plain"><option>--length
94
 
        <replaceable>BITS</replaceable></option></arg>
95
 
        <arg choice="plain"><option>-l
96
 
        <replaceable>BITS</replaceable></option></arg>
97
 
      </group>
98
 
      <sbr/>
99
 
      <group>
100
 
        <arg choice="plain"><option>--subtype
101
 
        <replaceable>KEYTYPE</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-s
103
 
        <replaceable>KEYTYPE</replaceable></option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group>
107
 
        <arg choice="plain"><option>--sublength
108
 
        <replaceable>BITS</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-L
110
 
        <replaceable>BITS</replaceable></option></arg>
111
 
      </group>
112
 
      <sbr/>
113
 
      <group>
114
 
        <arg choice="plain"><option>--name
115
 
        <replaceable>NAME</replaceable></option></arg>
116
 
        <arg choice="plain"><option>-n
117
 
        <replaceable>NAME</replaceable></option></arg>
118
 
      </group>
119
 
      <sbr/>
120
 
      <group>
121
 
        <arg choice="plain"><option>--email
122
 
        <replaceable>ADDRESS</replaceable></option></arg>
123
 
        <arg choice="plain"><option>-e
124
 
        <replaceable>ADDRESS</replaceable></option></arg>
125
 
      </group>
126
 
      <sbr/>
127
 
      <group>
128
 
        <arg choice="plain"><option>--comment
129
 
        <replaceable>TEXT</replaceable></option></arg>
130
 
        <arg choice="plain"><option>-c
131
 
        <replaceable>TEXT</replaceable></option></arg>
132
 
      </group>
133
 
      <sbr/>
134
 
      <group>
135
 
        <arg choice="plain"><option>--expire
136
 
        <replaceable>TIME</replaceable></option></arg>
137
 
        <arg choice="plain"><option>-x
138
 
        <replaceable>TIME</replaceable></option></arg>
139
 
      </group>
140
 
      <sbr/>
141
 
      <arg><option>--force</option></arg>
142
 
    </cmdsynopsis>
143
 
    <cmdsynopsis>
144
 
      <command>&COMMANDNAME;</command>
145
 
      <group choice="req">
146
 
        <arg choice="plain"><option>-p</option></arg>
147
 
        <arg choice="plain"><option>--password</option></arg>
148
 
      </group>
149
 
      <sbr/>
150
 
      <group>
151
 
        <arg choice="plain"><option>--dir
152
 
        <replaceable>DIRECTORY</replaceable></option></arg>
153
 
        <arg choice="plain"><option>-d
154
 
        <replaceable>DIRECTORY</replaceable></option></arg>
155
 
      </group>
156
 
      <sbr/>
157
 
      <group>
158
 
        <arg choice="plain"><option>--name
159
 
        <replaceable>NAME</replaceable></option></arg>
160
 
        <arg choice="plain"><option>-n
161
 
        <replaceable>NAME</replaceable></option></arg>
162
 
      </group>
163
 
    </cmdsynopsis>
164
 
    <cmdsynopsis>
165
 
      <command>&COMMANDNAME;</command>
166
 
      <group choice="req">
167
 
        <arg choice="plain"><option>-h</option></arg>
168
 
        <arg choice="plain"><option>--help</option></arg>
169
 
      </group>
170
 
    </cmdsynopsis>
171
 
    <cmdsynopsis>
172
 
      <command>&COMMANDNAME;</command>
173
 
      <group choice="req">
174
 
        <arg choice="plain"><option>-v</option></arg>
175
 
        <arg choice="plain"><option>--version</option></arg>
 
77
      <group choice="opt">
 
78
        <arg choice="plain"><option>--dir</option>
 
79
        <replaceable>directory</replaceable></arg>
 
80
      </group>
 
81
      <group choice="opt">
 
82
        <arg choice="plain"><option>--type</option>
 
83
        <replaceable>type</replaceable></arg>
 
84
      </group>
 
85
      <group choice="opt">
 
86
        <arg choice="plain"><option>--length</option>
 
87
        <replaceable>bits</replaceable></arg>
 
88
      </group>
 
89
      <group choice="opt">
 
90
        <arg choice="plain"><option>--name</option>
 
91
        <replaceable>NAME</replaceable></arg>
 
92
      </group>
 
93
      <group choice="opt">
 
94
        <arg choice="plain"><option>--email</option>
 
95
        <replaceable>EMAIL</replaceable></arg>
 
96
      </group>
 
97
      <group choice="opt">
 
98
        <arg choice="plain"><option>--comment</option>
 
99
        <replaceable>COMMENT</replaceable></arg>
 
100
      </group>
 
101
      <group choice="opt">
 
102
        <arg choice="plain"><option>--expire</option>
 
103
        <replaceable>TIME</replaceable></arg>
 
104
      </group>
 
105
      <group choice="opt">
 
106
        <arg choice="plain"><option>--force</option></arg>
 
107
      </group>
 
108
    </cmdsynopsis>
 
109
    <cmdsynopsis>
 
110
      <command>&COMMANDNAME;</command>
 
111
      <group choice="opt">
 
112
        <arg choice="plain"><option>-d</option>
 
113
        <replaceable>directory</replaceable></arg>
 
114
      </group>
 
115
      <group choice="opt">
 
116
        <arg choice="plain"><option>-t</option>
 
117
        <replaceable>type</replaceable></arg>
 
118
      </group>
 
119
      <group choice="opt">
 
120
        <arg choice="plain"><option>-l</option>
 
121
        <replaceable>bits</replaceable></arg>
 
122
      </group>
 
123
      <group choice="opt">
 
124
        <arg choice="plain"><option>-n</option>
 
125
        <replaceable>NAME</replaceable></arg>
 
126
      </group>
 
127
      <group choice="opt">
 
128
        <arg choice="plain"><option>-e</option>
 
129
        <replaceable>EMAIL</replaceable></arg>
 
130
      </group>
 
131
      <group choice="opt">
 
132
        <arg choice="plain"><option>-c</option>
 
133
        <replaceable>COMMENT</replaceable></arg>
 
134
      </group>
 
135
      <group choice="opt">
 
136
        <arg choice="plain"><option>-x</option>
 
137
        <replaceable>TIME</replaceable></arg>
 
138
      </group>
 
139
      <group choice="opt">
 
140
        <arg choice="plain"><option>-f</option></arg>
 
141
      </group>
 
142
    </cmdsynopsis>
 
143
    <cmdsynopsis>
 
144
      <command>&COMMANDNAME;</command>
 
145
      <group choice="req">
 
146
        <arg choice='plain'><option>-h</option></arg>
 
147
        <arg choice='plain'><option>--help</option></arg>
 
148
      </group>
 
149
    </cmdsynopsis>
 
150
    <cmdsynopsis>
 
151
      <command>&COMMANDNAME;</command>
 
152
      <group choice="req">
 
153
        <arg choice='plain'><option>-v</option></arg>
 
154
        <arg choice='plain'><option>--version</option></arg>
176
155
      </group>
177
156
    </cmdsynopsis>
178
157
  </refsynopsisdiv>
188
167
      initrd image, but this, like most things, can be changed with
189
168
      command line options.
190
169
    </para>
191
 
    <para>
192
 
      It can also be used to generate ready-made sections for
193
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
194
 
      <manvolnum>5</manvolnum></citerefentry> using the
195
 
      <option>--password</option> option.
196
 
    </para>
197
 
  </refsect1>
198
 
  
199
 
  <refsect1 id="purpose">
200
 
    <title>PURPOSE</title>
201
 
 
202
 
    <para>
203
 
      The purpose of this is to enable <emphasis>remote and unattended
204
 
      rebooting</emphasis> of client host computer with an
205
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
206
 
      linkend="overview"/> for details.
207
 
    </para>
208
 
 
209
170
  </refsect1>
210
171
  
211
172
  <refsect1 id="options">
226
187
        <replaceable>directory</replaceable></literal></term>
227
188
        <listitem>
228
189
          <para>
229
 
            Target directory for key files.  Default is
230
 
            <filename>/etc/mandos</filename>.
 
190
            Target directory for key files.
231
191
          </para>
232
192
        </listitem>
233
193
      </varlistentry>
237
197
        <replaceable>type</replaceable></literal></term>
238
198
        <listitem>
239
199
          <para>
240
 
            Key type.  Default is <quote>DSA</quote>.
 
200
            Key type.  Default is DSA.
241
201
          </para>
242
202
        </listitem>
243
203
      </varlistentry>
247
207
        <replaceable>bits</replaceable></literal></term>
248
208
        <listitem>
249
209
          <para>
250
 
            Key length in bits.  Default is 2048.
251
 
          </para>
252
 
        </listitem>
253
 
      </varlistentry>
254
 
 
255
 
      <varlistentry>
256
 
        <term><literal>-s</literal>, <literal>--subtype
257
 
        <replaceable>type</replaceable></literal></term>
258
 
        <listitem>
259
 
          <para>
260
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
261
 
            encryption-only).
262
 
          </para>
263
 
        </listitem>
264
 
      </varlistentry>
265
 
 
266
 
      <varlistentry>
267
 
        <term><literal>-L</literal>, <literal>--sublength
268
 
        <replaceable>bits</replaceable></literal></term>
269
 
        <listitem>
270
 
          <para>
271
 
            Subkey length in bits.  Default is 2048.
 
210
            Key length in bits.  Default is 1024.
272
211
          </para>
273
212
        </listitem>
274
213
      </varlistentry>
289
228
        <listitem>
290
229
          <para>
291
230
            Comment field for key.  The default value is
292
 
            <quote><literal>Mandos client key</literal></quote>.
 
231
            "<literal>Mandos client key</literal>".
293
232
          </para>
294
233
        </listitem>
295
234
      </varlistentry>
314
253
          </para>
315
254
        </listitem>
316
255
      </varlistentry>
317
 
      <varlistentry>
318
 
        <term><literal>-p</literal>, <literal>--password</literal
319
 
        ></term>
320
 
        <listitem>
321
 
          <para>
322
 
            Prompt for a password and encrypt it with the key already
323
 
            present in either <filename>/etc/mandos</filename> or the
324
 
            directory specified with the <option>--dir</option>
325
 
            option.  Outputs, on standard output, a section suitable
326
 
            for inclusion in <citerefentry><refentrytitle
327
 
            >mandos-clients.conf</refentrytitle><manvolnum
328
 
            >8</manvolnum></citerefentry>.  The host name or the name
329
 
            specified with the <option>--name</option> option is used
330
 
            for the section header.  All other options are ignored,
331
 
            and no keys are created.
332
 
          </para>
333
 
        </listitem>
334
 
      </varlistentry>
335
256
    </variablelist>
336
257
  </refsect1>
337
258
 
338
 
  <refsect1 id="overview">
339
 
    <title>OVERVIEW</title>
340
 
    <xi:include href="overview.xml"/>
341
 
    <para>
342
 
      This program is a small utility to generate new OpenPGP keys for
343
 
      new Mandos clients.
344
 
    </para>
345
 
  </refsect1>
346
 
 
347
259
  <refsect1 id="exit_status">
348
260
    <title>EXIT STATUS</title>
349
261
    <para>
350
 
      The exit status will be 0 if new keys were successfully created,
351
 
      otherwise not.
352
262
    </para>
353
263
  </refsect1>
354
264
  
355
 
  <refsect1 id="environment">
356
 
    <title>ENVIRONMENT</title>
357
 
    <variablelist>
358
 
      <varlistentry>
359
 
        <term><envar>TMPDIR</envar></term>
360
 
        <listitem>
361
 
          <para>
362
 
            If set, temporary files will be created here. See
363
 
            <citerefentry><refentrytitle>mktemp</refentrytitle>
364
 
            <manvolnum>1</manvolnum></citerefentry>.
365
 
          </para>
366
 
        </listitem>
367
 
      </varlistentry>
368
 
    </variablelist>
369
 
  </refsect1>
370
 
  
371
265
  <refsect1 id="file">
372
266
    <title>FILES</title>
373
267
    <para>
374
 
      Use the <option>--dir</option> option to change where
375
 
      <command>&COMMANDNAME;</command> will write the key files.  The
376
 
      default file names are shown here.
377
268
    </para>
378
 
    <variablelist>
379
 
      <varlistentry>
380
 
        <term><filename>/etc/mandos/seckey.txt</filename></term>
381
 
        <listitem>
382
 
          <para>
383
 
            OpenPGP secret key file which will be created or
384
 
            overwritten.
385
 
          </para>
386
 
        </listitem>
387
 
      </varlistentry>
388
 
      <varlistentry>
389
 
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
390
 
        <listitem>
391
 
          <para>
392
 
            OpenPGP public key file which will be created or
393
 
            overwritten.
394
 
          </para>
395
 
        </listitem>
396
 
      </varlistentry>
397
 
      <varlistentry>
398
 
        <term><filename>/tmp</filename></term>
399
 
        <listitem>
400
 
          <para>
401
 
            Temporary files will be written here if
402
 
            <varname>TMPDIR</varname> is not set.
403
 
          </para>
404
 
        </listitem>
405
 
      </varlistentry>
406
 
    </variablelist>
407
269
  </refsect1>
408
270
 
409
271
  <refsect1 id="bugs">
410
272
    <title>BUGS</title>
411
273
    <para>
412
 
      None are known at this time.
413
274
    </para>
414
275
  </refsect1>
415
276
 
416
 
  <refsect1 id="example">
417
 
    <title>EXAMPLE</title>
418
 
    <informalexample>
419
 
      <para>
420
 
        Normal invocation needs no options:
421
 
      </para>
422
 
      <para>
423
 
        <userinput>&COMMANDNAME;</userinput>
424
 
      </para>
425
 
    </informalexample>
426
 
    <informalexample>
427
 
      <para>
428
 
        Create keys in another directory and of another type.  Force
429
 
        overwriting old key files:
430
 
      </para>
431
 
      <para>
432
 
 
433
 
<!-- do not wrap this line -->
434
 
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
435
 
 
436
 
      </para>
437
 
    </informalexample>
 
277
  <refsect1 id="examples">
 
278
    <title>EXAMPLES</title>
 
279
    <para>
 
280
    </para>
438
281
  </refsect1>
439
282
 
440
283
  <refsect1 id="security">
441
284
    <title>SECURITY</title>
442
285
    <para>
443
 
      The <option>--type</option>, <option>--length</option>,
444
 
      <option>--subtype</option>, and <option>--sublength</option>
445
 
      options can be used to create keys of insufficient security.  If
446
 
      in doubt, leave them to the default values.
447
 
    </para>
448
 
    <para>
449
 
      The key expire time is not guaranteed to be honored by
450
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
451
 
      <manvolnum>8</manvolnum></citerefentry>.
452
286
    </para>
453
287
  </refsect1>
454
288
 
455
289
  <refsect1 id="see_also">
456
290
    <title>SEE ALSO</title>
457
291
    <para>
 
292
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
293
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
294
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
295
      <manvolnum>8</manvolnum></citerefentry>, and
458
296
      <citerefentry><refentrytitle>gpg</refentrytitle>
459
 
      <manvolnum>1</manvolnum></citerefentry>,
460
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
461
 
      <manvolnum>8</manvolnum></citerefentry>,
462
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
463
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
297
      <manvolnum>1</manvolnum></citerefentry>
464
298
    </para>
465
299
  </refsect1>
466
300
  
467
301
</refentry>
468
 
<!-- Local Variables: -->
469
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
470
 
<!-- time-stamp-end: "[\"']>" -->
471
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
472
 
<!-- End: -->