/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-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-08-30">
 
6
<!ENTITY TIMESTAMP "2008-09-12">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
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>
 
37
    <xi:include href="legalnotice.xml"/>
60
38
  </refentryinfo>
61
 
 
 
39
  
62
40
  <refmeta>
63
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
42
    <manvolnum>8</manvolnum>
67
45
  <refnamediv>
68
46
    <refname><command>&COMMANDNAME;</command></refname>
69
47
    <refpurpose>
70
 
      Generate keys for <citerefentry><refentrytitle>password-request
71
 
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
 
48
      Generate key and password for Mandos client and server.
72
49
    </refpurpose>
73
50
  </refnamediv>
74
 
 
 
51
  
75
52
  <refsynopsisdiv>
76
53
    <cmdsynopsis>
77
54
      <command>&COMMANDNAME;</command>
143
120
    <cmdsynopsis>
144
121
      <command>&COMMANDNAME;</command>
145
122
      <group choice="req">
 
123
        <arg choice="plain"><option>--password</option></arg>
146
124
        <arg choice="plain"><option>-p</option></arg>
147
 
        <arg choice="plain"><option>--password</option></arg>
148
125
      </group>
149
126
      <sbr/>
150
127
      <group>
164
141
    <cmdsynopsis>
165
142
      <command>&COMMANDNAME;</command>
166
143
      <group choice="req">
 
144
        <arg choice="plain"><option>--help</option></arg>
167
145
        <arg choice="plain"><option>-h</option></arg>
168
 
        <arg choice="plain"><option>--help</option></arg>
169
146
      </group>
170
147
    </cmdsynopsis>
171
148
    <cmdsynopsis>
172
149
      <command>&COMMANDNAME;</command>
173
150
      <group choice="req">
 
151
        <arg choice="plain"><option>--version</option></arg>
174
152
        <arg choice="plain"><option>-v</option></arg>
175
 
        <arg choice="plain"><option>--version</option></arg>
176
153
      </group>
177
154
    </cmdsynopsis>
178
155
  </refsynopsisdiv>
179
 
 
 
156
  
180
157
  <refsect1 id="description">
181
158
    <title>DESCRIPTION</title>
182
159
    <para>
183
160
      <command>&COMMANDNAME;</command> is a program to generate the
184
 
      OpenPGP keys used by
185
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
186
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
 
161
      OpenPGP key used by
 
162
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
163
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
187
164
      normally written to /etc/mandos for later installation into the
188
 
      initrd image, but this, like most things, can be changed with
189
 
      command line options.
 
165
      initrd image, but this, and most other things, can be changed
 
166
      with command line options.
190
167
    </para>
191
168
    <para>
192
 
      It can also be used to generate ready-made sections for
 
169
      This program can also be used with the
 
170
      <option>--password</option> option to generate a ready-made
 
171
      section for <filename>clients.conf</filename> (see
193
172
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
194
 
      <manvolnum>5</manvolnum></citerefentry> using the
195
 
      <option>--password</option> option.
 
173
      <manvolnum>5</manvolnum></citerefentry>).
196
174
    </para>
197
175
  </refsect1>
198
176
  
199
177
  <refsect1 id="purpose">
200
178
    <title>PURPOSE</title>
201
 
 
202
179
    <para>
203
180
      The purpose of this is to enable <emphasis>remote and unattended
204
181
      rebooting</emphasis> of client host computer with an
205
182
      <emphasis>encrypted root file system</emphasis>.  See <xref
206
183
      linkend="overview"/> for details.
207
184
    </para>
208
 
 
209
185
  </refsect1>
210
186
  
211
187
  <refsect1 id="options">
212
188
    <title>OPTIONS</title>
213
 
 
 
189
    
214
190
    <variablelist>
215
191
      <varlistentry>
216
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
192
        <term><option>--help</option></term>
 
193
        <term><option>-h</option></term>
217
194
        <listitem>
218
195
          <para>
219
196
            Show a help message and exit
220
197
          </para>
221
198
        </listitem>
222
199
      </varlistentry>
223
 
 
 
200
      
224
201
      <varlistentry>
225
 
        <term><literal>-d</literal>, <literal>--dir
226
 
        <replaceable>directory</replaceable></literal></term>
 
202
        <term><option>--dir
 
203
        <replaceable>DIRECTORY</replaceable></option></term>
 
204
        <term><option>-d
 
205
        <replaceable>DIRECTORY</replaceable></option></term>
227
206
        <listitem>
228
207
          <para>
229
208
            Target directory for key files.  Default is
231
210
          </para>
232
211
        </listitem>
233
212
      </varlistentry>
234
 
 
 
213
      
235
214
      <varlistentry>
236
 
        <term><literal>-t</literal>, <literal>--type
237
 
        <replaceable>type</replaceable></literal></term>
 
215
        <term><option>--type
 
216
        <replaceable>TYPE</replaceable></option></term>
 
217
        <term><option>-t
 
218
        <replaceable>TYPE</replaceable></option></term>
238
219
        <listitem>
239
220
          <para>
240
221
            Key type.  Default is <quote>DSA</quote>.
241
222
          </para>
242
223
        </listitem>
243
224
      </varlistentry>
244
 
 
 
225
      
245
226
      <varlistentry>
246
 
        <term><literal>-l</literal>, <literal>--length
247
 
        <replaceable>bits</replaceable></literal></term>
 
227
        <term><option>--length
 
228
        <replaceable>BITS</replaceable></option></term>
 
229
        <term><option>-l
 
230
        <replaceable>BITS</replaceable></option></term>
248
231
        <listitem>
249
232
          <para>
250
233
            Key length in bits.  Default is 2048.
251
234
          </para>
252
235
        </listitem>
253
236
      </varlistentry>
254
 
 
 
237
      
255
238
      <varlistentry>
256
 
        <term><literal>-s</literal>, <literal>--subtype
257
 
        <replaceable>type</replaceable></literal></term>
 
239
        <term><option>--subtype
 
240
        <replaceable>KEYTYPE</replaceable></option></term>
 
241
        <term><option>-s
 
242
        <replaceable>KEYTYPE</replaceable></option></term>
258
243
        <listitem>
259
244
          <para>
260
245
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
262
247
          </para>
263
248
        </listitem>
264
249
      </varlistentry>
265
 
 
 
250
      
266
251
      <varlistentry>
267
 
        <term><literal>-L</literal>, <literal>--sublength
268
 
        <replaceable>bits</replaceable></literal></term>
 
252
        <term><option>--sublength
 
253
        <replaceable>BITS</replaceable></option></term>
 
254
        <term><option>-L
 
255
        <replaceable>BITS</replaceable></option></term>
269
256
        <listitem>
270
257
          <para>
271
258
            Subkey length in bits.  Default is 2048.
272
259
          </para>
273
260
        </listitem>
274
261
      </varlistentry>
275
 
 
 
262
      
276
263
      <varlistentry>
277
 
        <term><literal>-e</literal>, <literal>--email</literal>
278
 
        <replaceable>address</replaceable></term>
 
264
        <term><option>--email
 
265
        <replaceable>ADDRESS</replaceable></option></term>
 
266
        <term><option>-e
 
267
        <replaceable>ADDRESS</replaceable></option></term>
279
268
        <listitem>
280
269
          <para>
281
270
            Email address of key.  Default is empty.
282
271
          </para>
283
272
        </listitem>
284
273
      </varlistentry>
285
 
 
 
274
      
286
275
      <varlistentry>
287
 
        <term><literal>-c</literal>, <literal>--comment</literal>
288
 
        <replaceable>comment</replaceable></term>
 
276
        <term><option>--comment
 
277
        <replaceable>TEXT</replaceable></option></term>
 
278
        <term><option>-c
 
279
        <replaceable>TEXT</replaceable></option></term>
289
280
        <listitem>
290
281
          <para>
291
282
            Comment field for key.  The default value is
293
284
          </para>
294
285
        </listitem>
295
286
      </varlistentry>
296
 
 
 
287
      
297
288
      <varlistentry>
298
 
        <term><literal>-x</literal>, <literal>--expire</literal>
299
 
        <replaceable>time</replaceable></term>
 
289
        <term><option>--expire
 
290
        <replaceable>TIME</replaceable></option></term>
 
291
        <term><option>-x
 
292
        <replaceable>TIME</replaceable></option></term>
300
293
        <listitem>
301
294
          <para>
302
295
            Key expire time.  Default is no expiration.  See
305
298
          </para>
306
299
        </listitem>
307
300
      </varlistentry>
308
 
 
 
301
      
309
302
      <varlistentry>
310
 
        <term><literal>-f</literal>, <literal>--force</literal></term>
 
303
        <term><option>--force</option></term>
 
304
        <term><option>-f</option></term>
311
305
        <listitem>
312
306
          <para>
313
 
            Force overwriting old keys.
 
307
            Force overwriting old key.
314
308
          </para>
315
309
        </listitem>
316
310
      </varlistentry>
317
311
      <varlistentry>
318
 
        <term><literal>-p</literal>, <literal>--password</literal
319
 
        ></term>
 
312
        <term><option>--password</option></term>
 
313
        <term><option>-p</option></term>
320
314
        <listitem>
321
315
          <para>
322
316
            Prompt for a password and encrypt it with the key already
328
322
            >8</manvolnum></citerefentry>.  The host name or the name
329
323
            specified with the <option>--name</option> option is used
330
324
            for the section header.  All other options are ignored,
331
 
            and no keys are created.
 
325
            and no key is created.
332
326
          </para>
333
327
        </listitem>
334
328
      </varlistentry>
335
329
    </variablelist>
336
330
  </refsect1>
337
 
 
 
331
  
338
332
  <refsect1 id="overview">
339
333
    <title>OVERVIEW</title>
340
334
    <xi:include href="overview.xml"/>
341
335
    <para>
342
336
      This program is a small utility to generate new OpenPGP keys for
343
 
      new Mandos clients.
 
337
      new Mandos clients, and to generate sections for inclusion in
 
338
      <filename>clients.conf</filename> on the server.
344
339
    </para>
345
340
  </refsect1>
346
 
 
 
341
  
347
342
  <refsect1 id="exit_status">
348
343
    <title>EXIT STATUS</title>
349
344
    <para>
350
 
      The exit status will be 0 if new keys were successfully created,
351
 
      otherwise not.
 
345
      The exit status will be 0 if a new key (or password, if the
 
346
      <option>--password</option> option was used) was successfully
 
347
      created, otherwise not.
352
348
    </para>
353
349
  </refsect1>
354
350
  
405
401
      </varlistentry>
406
402
    </variablelist>
407
403
  </refsect1>
408
 
 
409
 
  <refsect1 id="bugs">
410
 
    <title>BUGS</title>
411
 
    <para>
412
 
      None are known at this time.
413
 
    </para>
414
 
  </refsect1>
415
 
 
 
404
  
 
405
<!--   <refsect1 id="bugs"> -->
 
406
<!--     <title>BUGS</title> -->
 
407
<!--     <para> -->
 
408
<!--     </para> -->
 
409
<!--   </refsect1> -->
 
410
  
416
411
  <refsect1 id="example">
417
412
    <title>EXAMPLE</title>
418
413
    <informalexample>
425
420
    </informalexample>
426
421
    <informalexample>
427
422
      <para>
428
 
        Create keys in another directory and of another type.  Force
 
423
        Create key in another directory and of another type.  Force
429
424
        overwriting old key files:
430
425
      </para>
431
426
      <para>
435
430
 
436
431
      </para>
437
432
    </informalexample>
 
433
    <informalexample>
 
434
      <para>
 
435
        Prompt for a password, encrypt it with the key in
 
436
        <filename>/etc/mandos</filename> and output a section suitable
 
437
        for <filename>clients.conf</filename>.
 
438
      </para>
 
439
      <para>
 
440
        <userinput>&COMMANDNAME; --password</userinput>
 
441
      </para>
 
442
    </informalexample>
 
443
    <informalexample>
 
444
      <para>
 
445
        Prompt for a password, encrypt it with the key in the
 
446
        <filename>client-key</filename> directory and output a section
 
447
        suitable for <filename>clients.conf</filename>.
 
448
      </para>
 
449
      <para>
 
450
 
 
451
<!-- do not wrap this line -->
 
452
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
 
453
 
 
454
      </para>
 
455
    </informalexample>
438
456
  </refsect1>
439
 
 
 
457
  
440
458
  <refsect1 id="security">
441
459
    <title>SECURITY</title>
442
460
    <para>
443
461
      The <option>--type</option>, <option>--length</option>,
444
462
      <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.
 
463
      options can be used to create keys of low security.  If in
 
464
      doubt, leave them to the default values.
447
465
    </para>
448
466
    <para>
449
 
      The key expire time is not guaranteed to be honored by
450
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
467
      The key expire time is <emphasis>not</emphasis> guaranteed to be
 
468
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
451
469
      <manvolnum>8</manvolnum></citerefentry>.
452
470
    </para>
453
471
  </refsect1>
454
 
 
 
472
  
455
473
  <refsect1 id="see_also">
456
474
    <title>SEE ALSO</title>
457
475
    <para>
458
476
      <citerefentry><refentrytitle>gpg</refentrytitle>
459
477
      <manvolnum>1</manvolnum></citerefentry>,
 
478
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
479
      <manvolnum>5</manvolnum></citerefentry>,
460
480
      <citerefentry><refentrytitle>mandos</refentrytitle>
461
481
      <manvolnum>8</manvolnum></citerefentry>,
462
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
482
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
463
483
      <manvolnum>8mandos</manvolnum></citerefentry>
464
484
    </para>
465
485
  </refsect1>