/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 04:02:00 UTC
  • Revision ID: teddy@recompile.se-20120101040200-8wgma707v4gi7hxn
* debian/rules (binary-common): Exclude network-hooks.d from
                                dh_fixperms.
* mandos (DBusObjectWithProperties.Set): Bug fix: handle byte arrays.
* mandos-clients.conf.xml (DESCRIPTION): Add reference to persistent
                                         state.
* mandos-options.xml (restore): Adjust wording slightly.
* mandos.xml (OPTIONS/--no-restore): Refer to "PERSISTENT STATE"
                                     section.
  (PERSISTENT STATE): New section.

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">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-08-30">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
 
37
      <year>2012</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
60
42
  </refentryinfo>
61
 
 
 
43
  
62
44
  <refmeta>
63
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
    <manvolnum>8</manvolnum>
67
49
  <refnamediv>
68
50
    <refname><command>&COMMANDNAME;</command></refname>
69
51
    <refpurpose>
70
 
      Generate keys for <citerefentry><refentrytitle>password-request
71
 
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
 
52
      Generate key and password for Mandos client and server.
72
53
    </refpurpose>
73
54
  </refnamediv>
74
 
 
 
55
  
75
56
  <refsynopsisdiv>
76
57
    <cmdsynopsis>
77
58
      <command>&COMMANDNAME;</command>
143
124
    <cmdsynopsis>
144
125
      <command>&COMMANDNAME;</command>
145
126
      <group choice="req">
 
127
        <arg choice="plain"><option>--password</option></arg>
146
128
        <arg choice="plain"><option>-p</option></arg>
147
 
        <arg choice="plain"><option>--password</option></arg>
 
129
        <arg choice="plain"><option>--passfile
 
130
        <replaceable>FILE</replaceable></option></arg>
 
131
        <arg choice="plain"><option>-F</option>
 
132
        <replaceable>FILE</replaceable></arg>
148
133
      </group>
149
134
      <sbr/>
150
135
      <group>
164
149
    <cmdsynopsis>
165
150
      <command>&COMMANDNAME;</command>
166
151
      <group choice="req">
 
152
        <arg choice="plain"><option>--help</option></arg>
167
153
        <arg choice="plain"><option>-h</option></arg>
168
 
        <arg choice="plain"><option>--help</option></arg>
169
154
      </group>
170
155
    </cmdsynopsis>
171
156
    <cmdsynopsis>
172
157
      <command>&COMMANDNAME;</command>
173
158
      <group choice="req">
 
159
        <arg choice="plain"><option>--version</option></arg>
174
160
        <arg choice="plain"><option>-v</option></arg>
175
 
        <arg choice="plain"><option>--version</option></arg>
176
161
      </group>
177
162
    </cmdsynopsis>
178
163
  </refsynopsisdiv>
179
 
 
 
164
  
180
165
  <refsect1 id="description">
181
166
    <title>DESCRIPTION</title>
182
167
    <para>
183
168
      <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
 
169
      OpenPGP key used by
 
170
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
171
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
187
172
      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.
 
173
      initrd image, but this, and most other things, can be changed
 
174
      with command line options.
190
175
    </para>
191
176
    <para>
192
 
      It can also be used to generate ready-made sections for
 
177
      This program can also be used with the
 
178
      <option>--password</option> or <option>--passfile</option>
 
179
      options to generate a ready-made section for
 
180
      <filename>clients.conf</filename> (see
193
181
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
194
 
      <manvolnum>5</manvolnum></citerefentry> using the
195
 
      <option>--password</option> option.
 
182
      <manvolnum>5</manvolnum></citerefentry>).
196
183
    </para>
197
184
  </refsect1>
198
185
  
199
186
  <refsect1 id="purpose">
200
187
    <title>PURPOSE</title>
201
 
 
202
188
    <para>
203
189
      The purpose of this is to enable <emphasis>remote and unattended
204
190
      rebooting</emphasis> of client host computer with an
205
191
      <emphasis>encrypted root file system</emphasis>.  See <xref
206
192
      linkend="overview"/> for details.
207
193
    </para>
208
 
 
209
194
  </refsect1>
210
195
  
211
196
  <refsect1 id="options">
212
197
    <title>OPTIONS</title>
213
 
 
 
198
    
214
199
    <variablelist>
215
200
      <varlistentry>
216
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
201
        <term><option>--help</option></term>
 
202
        <term><option>-h</option></term>
217
203
        <listitem>
218
204
          <para>
219
205
            Show a help message and exit
220
206
          </para>
221
207
        </listitem>
222
208
      </varlistentry>
223
 
 
 
209
      
224
210
      <varlistentry>
225
 
        <term><literal>-d</literal>, <literal>--dir
226
 
        <replaceable>directory</replaceable></literal></term>
 
211
        <term><option>--dir
 
212
        <replaceable>DIRECTORY</replaceable></option></term>
 
213
        <term><option>-d
 
214
        <replaceable>DIRECTORY</replaceable></option></term>
227
215
        <listitem>
228
216
          <para>
229
217
            Target directory for key files.  Default is
230
 
            <filename>/etc/mandos</filename>.
 
218
            <filename class="directory">/etc/mandos</filename>.
231
219
          </para>
232
220
        </listitem>
233
221
      </varlistentry>
234
 
 
 
222
      
235
223
      <varlistentry>
236
 
        <term><literal>-t</literal>, <literal>--type
237
 
        <replaceable>type</replaceable></literal></term>
 
224
        <term><option>--type
 
225
        <replaceable>TYPE</replaceable></option></term>
 
226
        <term><option>-t
 
227
        <replaceable>TYPE</replaceable></option></term>
238
228
        <listitem>
239
229
          <para>
240
230
            Key type.  Default is <quote>DSA</quote>.
241
231
          </para>
242
232
        </listitem>
243
233
      </varlistentry>
244
 
 
 
234
      
245
235
      <varlistentry>
246
 
        <term><literal>-l</literal>, <literal>--length
247
 
        <replaceable>bits</replaceable></literal></term>
 
236
        <term><option>--length
 
237
        <replaceable>BITS</replaceable></option></term>
 
238
        <term><option>-l
 
239
        <replaceable>BITS</replaceable></option></term>
248
240
        <listitem>
249
241
          <para>
250
242
            Key length in bits.  Default is 2048.
251
243
          </para>
252
244
        </listitem>
253
245
      </varlistentry>
254
 
 
 
246
      
255
247
      <varlistentry>
256
 
        <term><literal>-s</literal>, <literal>--subtype
257
 
        <replaceable>type</replaceable></literal></term>
 
248
        <term><option>--subtype
 
249
        <replaceable>KEYTYPE</replaceable></option></term>
 
250
        <term><option>-s
 
251
        <replaceable>KEYTYPE</replaceable></option></term>
258
252
        <listitem>
259
253
          <para>
260
254
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
262
256
          </para>
263
257
        </listitem>
264
258
      </varlistentry>
265
 
 
 
259
      
266
260
      <varlistentry>
267
 
        <term><literal>-L</literal>, <literal>--sublength
268
 
        <replaceable>bits</replaceable></literal></term>
 
261
        <term><option>--sublength
 
262
        <replaceable>BITS</replaceable></option></term>
 
263
        <term><option>-L
 
264
        <replaceable>BITS</replaceable></option></term>
269
265
        <listitem>
270
266
          <para>
271
267
            Subkey length in bits.  Default is 2048.
272
268
          </para>
273
269
        </listitem>
274
270
      </varlistentry>
275
 
 
 
271
      
276
272
      <varlistentry>
277
 
        <term><literal>-e</literal>, <literal>--email</literal>
278
 
        <replaceable>address</replaceable></term>
 
273
        <term><option>--email
 
274
        <replaceable>ADDRESS</replaceable></option></term>
 
275
        <term><option>-e
 
276
        <replaceable>ADDRESS</replaceable></option></term>
279
277
        <listitem>
280
278
          <para>
281
279
            Email address of key.  Default is empty.
282
280
          </para>
283
281
        </listitem>
284
282
      </varlistentry>
285
 
 
 
283
      
286
284
      <varlistentry>
287
 
        <term><literal>-c</literal>, <literal>--comment</literal>
288
 
        <replaceable>comment</replaceable></term>
 
285
        <term><option>--comment
 
286
        <replaceable>TEXT</replaceable></option></term>
 
287
        <term><option>-c
 
288
        <replaceable>TEXT</replaceable></option></term>
289
289
        <listitem>
290
290
          <para>
291
291
            Comment field for key.  The default value is
293
293
          </para>
294
294
        </listitem>
295
295
      </varlistentry>
296
 
 
 
296
      
297
297
      <varlistentry>
298
 
        <term><literal>-x</literal>, <literal>--expire</literal>
299
 
        <replaceable>time</replaceable></term>
 
298
        <term><option>--expire
 
299
        <replaceable>TIME</replaceable></option></term>
 
300
        <term><option>-x
 
301
        <replaceable>TIME</replaceable></option></term>
300
302
        <listitem>
301
303
          <para>
302
304
            Key expire time.  Default is no expiration.  See
305
307
          </para>
306
308
        </listitem>
307
309
      </varlistentry>
308
 
 
 
310
      
309
311
      <varlistentry>
310
 
        <term><literal>-f</literal>, <literal>--force</literal></term>
 
312
        <term><option>--force</option></term>
 
313
        <term><option>-f</option></term>
311
314
        <listitem>
312
315
          <para>
313
 
            Force overwriting old keys.
 
316
            Force overwriting old key.
314
317
          </para>
315
318
        </listitem>
316
319
      </varlistentry>
317
320
      <varlistentry>
318
 
        <term><literal>-p</literal>, <literal>--password</literal
319
 
        ></term>
 
321
        <term><option>--password</option></term>
 
322
        <term><option>-p</option></term>
320
323
        <listitem>
321
324
          <para>
322
325
            Prompt for a password and encrypt it with the key already
328
331
            >8</manvolnum></citerefentry>.  The host name or the name
329
332
            specified with the <option>--name</option> option is used
330
333
            for the section header.  All other options are ignored,
331
 
            and no keys are created.
 
334
            and no key is created.
 
335
          </para>
 
336
        </listitem>
 
337
      </varlistentry>
 
338
      <varlistentry>
 
339
        <term><option>--passfile
 
340
        <replaceable>FILE</replaceable></option></term>
 
341
        <term><option>-F
 
342
        <replaceable>FILE</replaceable></option></term>
 
343
        <listitem>
 
344
          <para>
 
345
            The same as <option>--password</option>, but read from
 
346
            <replaceable>FILE</replaceable>, not the terminal.
332
347
          </para>
333
348
        </listitem>
334
349
      </varlistentry>
335
350
    </variablelist>
336
351
  </refsect1>
337
 
 
 
352
  
338
353
  <refsect1 id="overview">
339
354
    <title>OVERVIEW</title>
340
355
    <xi:include href="overview.xml"/>
341
356
    <para>
342
357
      This program is a small utility to generate new OpenPGP keys for
343
 
      new Mandos clients.
 
358
      new Mandos clients, and to generate sections for inclusion in
 
359
      <filename>clients.conf</filename> on the server.
344
360
    </para>
345
361
  </refsect1>
346
 
 
 
362
  
347
363
  <refsect1 id="exit_status">
348
364
    <title>EXIT STATUS</title>
349
365
    <para>
350
 
      The exit status will be 0 if new keys were successfully created,
351
 
      otherwise not.
 
366
      The exit status will be 0 if a new key (or password, if the
 
367
      <option>--password</option> option was used) was successfully
 
368
      created, otherwise not.
352
369
    </para>
353
370
  </refsect1>
354
371
  
368
385
    </variablelist>
369
386
  </refsect1>
370
387
  
371
 
  <refsect1 id="file">
 
388
  <refsect1 id="files">
372
389
    <title>FILES</title>
373
390
    <para>
374
391
      Use the <option>--dir</option> option to change where
395
412
        </listitem>
396
413
      </varlistentry>
397
414
      <varlistentry>
398
 
        <term><filename>/tmp</filename></term>
 
415
        <term><filename class="directory">/tmp</filename></term>
399
416
        <listitem>
400
417
          <para>
401
418
            Temporary files will be written here if
405
422
      </varlistentry>
406
423
    </variablelist>
407
424
  </refsect1>
408
 
 
409
 
  <refsect1 id="bugs">
410
 
    <title>BUGS</title>
411
 
    <para>
412
 
      None are known at this time.
413
 
    </para>
414
 
  </refsect1>
415
 
 
 
425
  
 
426
<!--   <refsect1 id="bugs"> -->
 
427
<!--     <title>BUGS</title> -->
 
428
<!--     <para> -->
 
429
<!--     </para> -->
 
430
<!--   </refsect1> -->
 
431
  
416
432
  <refsect1 id="example">
417
433
    <title>EXAMPLE</title>
418
434
    <informalexample>
425
441
    </informalexample>
426
442
    <informalexample>
427
443
      <para>
428
 
        Create keys in another directory and of another type.  Force
 
444
        Create key in another directory and of another type.  Force
429
445
        overwriting old key files:
430
446
      </para>
431
447
      <para>
435
451
 
436
452
      </para>
437
453
    </informalexample>
 
454
    <informalexample>
 
455
      <para>
 
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>.
 
459
      </para>
 
460
      <para>
 
461
        <userinput>&COMMANDNAME; --password</userinput>
 
462
      </para>
 
463
    </informalexample>
 
464
    <informalexample>
 
465
      <para>
 
466
        Prompt for a password, encrypt it with the key in the
 
467
        <filename>client-key</filename> directory and output a section
 
468
        suitable for <filename>clients.conf</filename>.
 
469
      </para>
 
470
      <para>
 
471
 
 
472
<!-- do not wrap this line -->
 
473
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
 
474
 
 
475
      </para>
 
476
    </informalexample>
438
477
  </refsect1>
439
 
 
 
478
  
440
479
  <refsect1 id="security">
441
480
    <title>SECURITY</title>
442
481
    <para>
443
482
      The <option>--type</option>, <option>--length</option>,
444
483
      <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.
 
484
      options can be used to create keys of low security.  If in
 
485
      doubt, leave them to the default values.
447
486
    </para>
448
487
    <para>
449
 
      The key expire time is not guaranteed to be honored by
450
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
488
      The key expire time is <emphasis>not</emphasis> guaranteed to be
 
489
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
451
490
      <manvolnum>8</manvolnum></citerefentry>.
452
491
    </para>
453
492
  </refsect1>
454
 
 
 
493
  
455
494
  <refsect1 id="see_also">
456
495
    <title>SEE ALSO</title>
457
496
    <para>
 
497
      <citerefentry><refentrytitle>intro</refentrytitle>
 
498
      <manvolnum>8mandos</manvolnum></citerefentry>,
458
499
      <citerefentry><refentrytitle>gpg</refentrytitle>
459
500
      <manvolnum>1</manvolnum></citerefentry>,
 
501
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
502
      <manvolnum>5</manvolnum></citerefentry>,
460
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
461
504
      <manvolnum>8</manvolnum></citerefentry>,
462
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
505
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
463
506
      <manvolnum>8mandos</manvolnum></citerefentry>
464
507
    </para>
465
508
  </refsect1>