/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: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: This revision was merged to the branch mainline in revision 505.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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