/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

Merge from trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY COMMANDNAME "mandos-keygen">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
 
8
]>
 
9
 
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
  <refentryinfo>
 
12
    <title>Mandos Manual</title>
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
 
17
    <authorgroup>
 
18
      <author>
 
19
        <firstname>Björn</firstname>
 
20
        <surname>Påhlsson</surname>
 
21
        <address>
 
22
          <email>belorn@recompile.se</email>
 
23
        </address>
 
24
      </author>
 
25
      <author>
 
26
        <firstname>Teddy</firstname>
 
27
        <surname>Hogeborn</surname>
 
28
        <address>
 
29
          <email>teddy@recompile.se</email>
 
30
        </address>
 
31
      </author>
 
32
    </authorgroup>
 
33
    <copyright>
 
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
 
37
      <holder>Teddy Hogeborn</holder>
 
38
      <holder>Björn Påhlsson</holder>
 
39
    </copyright>
 
40
    <xi:include href="legalnotice.xml"/>
 
41
  </refentryinfo>
 
42
  
 
43
  <refmeta>
 
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
45
    <manvolnum>8</manvolnum>
 
46
  </refmeta>
 
47
  
 
48
  <refnamediv>
 
49
    <refname><command>&COMMANDNAME;</command></refname>
 
50
    <refpurpose>
 
51
      Generate key and password for Mandos client and server.
 
52
    </refpurpose>
 
53
  </refnamediv>
 
54
  
 
55
  <refsynopsisdiv>
 
56
    <cmdsynopsis>
 
57
      <command>&COMMANDNAME;</command>
 
58
      <group>
 
59
        <arg choice="plain"><option>--dir
 
60
        <replaceable>DIRECTORY</replaceable></option></arg>
 
61
        <arg choice="plain"><option>-d
 
62
        <replaceable>DIRECTORY</replaceable></option></arg>
 
63
      </group>
 
64
      <sbr/>
 
65
      <group>
 
66
        <arg choice="plain"><option>--type
 
67
        <replaceable>KEYTYPE</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-t
 
69
        <replaceable>KEYTYPE</replaceable></option></arg>
 
70
      </group>
 
71
      <sbr/>
 
72
      <group>
 
73
        <arg choice="plain"><option>--length
 
74
        <replaceable>BITS</replaceable></option></arg>
 
75
        <arg choice="plain"><option>-l
 
76
        <replaceable>BITS</replaceable></option></arg>
 
77
      </group>
 
78
      <sbr/>
 
79
      <group>
 
80
        <arg choice="plain"><option>--subtype
 
81
        <replaceable>KEYTYPE</replaceable></option></arg>
 
82
        <arg choice="plain"><option>-s
 
83
        <replaceable>KEYTYPE</replaceable></option></arg>
 
84
      </group>
 
85
      <sbr/>
 
86
      <group>
 
87
        <arg choice="plain"><option>--sublength
 
88
        <replaceable>BITS</replaceable></option></arg>
 
89
        <arg choice="plain"><option>-L
 
90
        <replaceable>BITS</replaceable></option></arg>
 
91
      </group>
 
92
      <sbr/>
 
93
      <group>
 
94
        <arg choice="plain"><option>--name
 
95
        <replaceable>NAME</replaceable></option></arg>
 
96
        <arg choice="plain"><option>-n
 
97
        <replaceable>NAME</replaceable></option></arg>
 
98
      </group>
 
99
      <sbr/>
 
100
      <group>
 
101
        <arg choice="plain"><option>--email
 
102
        <replaceable>ADDRESS</replaceable></option></arg>
 
103
        <arg choice="plain"><option>-e
 
104
        <replaceable>ADDRESS</replaceable></option></arg>
 
105
      </group>
 
106
      <sbr/>
 
107
      <group>
 
108
        <arg choice="plain"><option>--comment
 
109
        <replaceable>TEXT</replaceable></option></arg>
 
110
        <arg choice="plain"><option>-c
 
111
        <replaceable>TEXT</replaceable></option></arg>
 
112
      </group>
 
113
      <sbr/>
 
114
      <group>
 
115
        <arg choice="plain"><option>--expire
 
116
        <replaceable>TIME</replaceable></option></arg>
 
117
        <arg choice="plain"><option>-x
 
118
        <replaceable>TIME</replaceable></option></arg>
 
119
      </group>
 
120
      <sbr/>
 
121
      <arg><option>--force</option></arg>
 
122
    </cmdsynopsis>
 
123
    <cmdsynopsis>
 
124
      <command>&COMMANDNAME;</command>
 
125
      <group choice="req">
 
126
        <arg choice="plain"><option>--password</option></arg>
 
127
        <arg choice="plain"><option>-p</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>
 
132
      </group>
 
133
      <sbr/>
 
134
      <group>
 
135
        <arg choice="plain"><option>--dir
 
136
        <replaceable>DIRECTORY</replaceable></option></arg>
 
137
        <arg choice="plain"><option>-d
 
138
        <replaceable>DIRECTORY</replaceable></option></arg>
 
139
      </group>
 
140
      <sbr/>
 
141
      <group>
 
142
        <arg choice="plain"><option>--name
 
143
        <replaceable>NAME</replaceable></option></arg>
 
144
        <arg choice="plain"><option>-n
 
145
        <replaceable>NAME</replaceable></option></arg>
 
146
      </group>
 
147
    </cmdsynopsis>
 
148
    <cmdsynopsis>
 
149
      <command>&COMMANDNAME;</command>
 
150
      <group choice="req">
 
151
        <arg choice="plain"><option>--help</option></arg>
 
152
        <arg choice="plain"><option>-h</option></arg>
 
153
      </group>
 
154
    </cmdsynopsis>
 
155
    <cmdsynopsis>
 
156
      <command>&COMMANDNAME;</command>
 
157
      <group choice="req">
 
158
        <arg choice="plain"><option>--version</option></arg>
 
159
        <arg choice="plain"><option>-v</option></arg>
 
160
      </group>
 
161
    </cmdsynopsis>
 
162
  </refsynopsisdiv>
 
163
  
 
164
  <refsect1 id="description">
 
165
    <title>DESCRIPTION</title>
 
166
    <para>
 
167
      <command>&COMMANDNAME;</command> is a program to generate the
 
168
      OpenPGP key used by
 
169
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
170
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
171
      normally written to /etc/mandos for later installation into the
 
172
      initrd image, but this, and most other things, can be changed
 
173
      with command line options.
 
174
    </para>
 
175
    <para>
 
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
 
180
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
181
      <manvolnum>5</manvolnum></citerefentry>).
 
182
    </para>
 
183
  </refsect1>
 
184
  
 
185
  <refsect1 id="purpose">
 
186
    <title>PURPOSE</title>
 
187
    <para>
 
188
      The purpose of this is to enable <emphasis>remote and unattended
 
189
      rebooting</emphasis> of client host computer with an
 
190
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
191
      linkend="overview"/> for details.
 
192
    </para>
 
193
  </refsect1>
 
194
  
 
195
  <refsect1 id="options">
 
196
    <title>OPTIONS</title>
 
197
    
 
198
    <variablelist>
 
199
      <varlistentry>
 
200
        <term><option>--help</option></term>
 
201
        <term><option>-h</option></term>
 
202
        <listitem>
 
203
          <para>
 
204
            Show a help message and exit
 
205
          </para>
 
206
        </listitem>
 
207
      </varlistentry>
 
208
      
 
209
      <varlistentry>
 
210
        <term><option>--dir
 
211
        <replaceable>DIRECTORY</replaceable></option></term>
 
212
        <term><option>-d
 
213
        <replaceable>DIRECTORY</replaceable></option></term>
 
214
        <listitem>
 
215
          <para>
 
216
            Target directory for key files.  Default is
 
217
            <filename>/etc/mandos</filename>.
 
218
          </para>
 
219
        </listitem>
 
220
      </varlistentry>
 
221
      
 
222
      <varlistentry>
 
223
        <term><option>--type
 
224
        <replaceable>TYPE</replaceable></option></term>
 
225
        <term><option>-t
 
226
        <replaceable>TYPE</replaceable></option></term>
 
227
        <listitem>
 
228
          <para>
 
229
            Key type.  Default is <quote>DSA</quote>.
 
230
          </para>
 
231
        </listitem>
 
232
      </varlistentry>
 
233
      
 
234
      <varlistentry>
 
235
        <term><option>--length
 
236
        <replaceable>BITS</replaceable></option></term>
 
237
        <term><option>-l
 
238
        <replaceable>BITS</replaceable></option></term>
 
239
        <listitem>
 
240
          <para>
 
241
            Key length in bits.  Default is 2048.
 
242
          </para>
 
243
        </listitem>
 
244
      </varlistentry>
 
245
      
 
246
      <varlistentry>
 
247
        <term><option>--subtype
 
248
        <replaceable>KEYTYPE</replaceable></option></term>
 
249
        <term><option>-s
 
250
        <replaceable>KEYTYPE</replaceable></option></term>
 
251
        <listitem>
 
252
          <para>
 
253
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
254
            encryption-only).
 
255
          </para>
 
256
        </listitem>
 
257
      </varlistentry>
 
258
      
 
259
      <varlistentry>
 
260
        <term><option>--sublength
 
261
        <replaceable>BITS</replaceable></option></term>
 
262
        <term><option>-L
 
263
        <replaceable>BITS</replaceable></option></term>
 
264
        <listitem>
 
265
          <para>
 
266
            Subkey length in bits.  Default is 2048.
 
267
          </para>
 
268
        </listitem>
 
269
      </varlistentry>
 
270
      
 
271
      <varlistentry>
 
272
        <term><option>--email
 
273
        <replaceable>ADDRESS</replaceable></option></term>
 
274
        <term><option>-e
 
275
        <replaceable>ADDRESS</replaceable></option></term>
 
276
        <listitem>
 
277
          <para>
 
278
            Email address of key.  Default is empty.
 
279
          </para>
 
280
        </listitem>
 
281
      </varlistentry>
 
282
      
 
283
      <varlistentry>
 
284
        <term><option>--comment
 
285
        <replaceable>TEXT</replaceable></option></term>
 
286
        <term><option>-c
 
287
        <replaceable>TEXT</replaceable></option></term>
 
288
        <listitem>
 
289
          <para>
 
290
            Comment field for key.  The default value is
 
291
            <quote><literal>Mandos client key</literal></quote>.
 
292
          </para>
 
293
        </listitem>
 
294
      </varlistentry>
 
295
      
 
296
      <varlistentry>
 
297
        <term><option>--expire
 
298
        <replaceable>TIME</replaceable></option></term>
 
299
        <term><option>-x
 
300
        <replaceable>TIME</replaceable></option></term>
 
301
        <listitem>
 
302
          <para>
 
303
            Key expire time.  Default is no expiration.  See
 
304
            <citerefentry><refentrytitle>gpg</refentrytitle>
 
305
            <manvolnum>1</manvolnum></citerefentry> for syntax.
 
306
          </para>
 
307
        </listitem>
 
308
      </varlistentry>
 
309
      
 
310
      <varlistentry>
 
311
        <term><option>--force</option></term>
 
312
        <term><option>-f</option></term>
 
313
        <listitem>
 
314
          <para>
 
315
            Force overwriting old key.
 
316
          </para>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      <varlistentry>
 
320
        <term><option>--password</option></term>
 
321
        <term><option>-p</option></term>
 
322
        <listitem>
 
323
          <para>
 
324
            Prompt for a password and encrypt it with the key already
 
325
            present in either <filename>/etc/mandos</filename> or the
 
326
            directory specified with the <option>--dir</option>
 
327
            option.  Outputs, on standard output, a section suitable
 
328
            for inclusion in <citerefentry><refentrytitle
 
329
            >mandos-clients.conf</refentrytitle><manvolnum
 
330
            >8</manvolnum></citerefentry>.  The host name or the name
 
331
            specified with the <option>--name</option> option is used
 
332
            for the section header.  All other options are ignored,
 
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.
 
346
          </para>
 
347
        </listitem>
 
348
      </varlistentry>
 
349
    </variablelist>
 
350
  </refsect1>
 
351
  
 
352
  <refsect1 id="overview">
 
353
    <title>OVERVIEW</title>
 
354
    <xi:include href="overview.xml"/>
 
355
    <para>
 
356
      This program is a small utility to generate new OpenPGP keys for
 
357
      new Mandos clients, and to generate sections for inclusion in
 
358
      <filename>clients.conf</filename> on the server.
 
359
    </para>
 
360
  </refsect1>
 
361
  
 
362
  <refsect1 id="exit_status">
 
363
    <title>EXIT STATUS</title>
 
364
    <para>
 
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.
 
368
    </para>
 
369
  </refsect1>
 
370
  
 
371
  <refsect1 id="environment">
 
372
    <title>ENVIRONMENT</title>
 
373
    <variablelist>
 
374
      <varlistentry>
 
375
        <term><envar>TMPDIR</envar></term>
 
376
        <listitem>
 
377
          <para>
 
378
            If set, temporary files will be created here. See
 
379
            <citerefentry><refentrytitle>mktemp</refentrytitle>
 
380
            <manvolnum>1</manvolnum></citerefentry>.
 
381
          </para>
 
382
        </listitem>
 
383
      </varlistentry>
 
384
    </variablelist>
 
385
  </refsect1>
 
386
  
 
387
  <refsect1 id="files">
 
388
    <title>FILES</title>
 
389
    <para>
 
390
      Use the <option>--dir</option> option to change where
 
391
      <command>&COMMANDNAME;</command> will write the key files.  The
 
392
      default file names are shown here.
 
393
    </para>
 
394
    <variablelist>
 
395
      <varlistentry>
 
396
        <term><filename>/etc/mandos/seckey.txt</filename></term>
 
397
        <listitem>
 
398
          <para>
 
399
            OpenPGP secret key file which will be created or
 
400
            overwritten.
 
401
          </para>
 
402
        </listitem>
 
403
      </varlistentry>
 
404
      <varlistentry>
 
405
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
 
406
        <listitem>
 
407
          <para>
 
408
            OpenPGP public key file which will be created or
 
409
            overwritten.
 
410
          </para>
 
411
        </listitem>
 
412
      </varlistentry>
 
413
      <varlistentry>
 
414
        <term><filename>/tmp</filename></term>
 
415
        <listitem>
 
416
          <para>
 
417
            Temporary files will be written here if
 
418
            <varname>TMPDIR</varname> is not set.
 
419
          </para>
 
420
        </listitem>
 
421
      </varlistentry>
 
422
    </variablelist>
 
423
  </refsect1>
 
424
  
 
425
<!--   <refsect1 id="bugs"> -->
 
426
<!--     <title>BUGS</title> -->
 
427
<!--     <para> -->
 
428
<!--     </para> -->
 
429
<!--   </refsect1> -->
 
430
  
 
431
  <refsect1 id="example">
 
432
    <title>EXAMPLE</title>
 
433
    <informalexample>
 
434
      <para>
 
435
        Normal invocation needs no options:
 
436
      </para>
 
437
      <para>
 
438
        <userinput>&COMMANDNAME;</userinput>
 
439
      </para>
 
440
    </informalexample>
 
441
    <informalexample>
 
442
      <para>
 
443
        Create key in another directory and of another type.  Force
 
444
        overwriting old key files:
 
445
      </para>
 
446
      <para>
 
447
 
 
448
<!-- do not wrap this line -->
 
449
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
 
450
 
 
451
      </para>
 
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>
 
476
  </refsect1>
 
477
  
 
478
  <refsect1 id="security">
 
479
    <title>SECURITY</title>
 
480
    <para>
 
481
      The <option>--type</option>, <option>--length</option>,
 
482
      <option>--subtype</option>, and <option>--sublength</option>
 
483
      options can be used to create keys of low security.  If in
 
484
      doubt, leave them to the default values.
 
485
    </para>
 
486
    <para>
 
487
      The key expire time is <emphasis>not</emphasis> guaranteed to be
 
488
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
 
489
      <manvolnum>8</manvolnum></citerefentry>.
 
490
    </para>
 
491
  </refsect1>
 
492
  
 
493
  <refsect1 id="see_also">
 
494
    <title>SEE ALSO</title>
 
495
    <para>
 
496
      <citerefentry><refentrytitle>intro</refentrytitle>
 
497
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
498
      <citerefentry><refentrytitle>gpg</refentrytitle>
 
499
      <manvolnum>1</manvolnum></citerefentry>,
 
500
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
501
      <manvolnum>5</manvolnum></citerefentry>,
 
502
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
503
      <manvolnum>8</manvolnum></citerefentry>,
 
504
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
505
      <manvolnum>8mandos</manvolnum></citerefentry>
 
506
    </para>
 
507
  </refsect1>
 
508
  
 
509
</refentry>
 
510
<!-- Local Variables: -->
 
511
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
512
<!-- time-stamp-end: "[\"']>" -->
 
513
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
514
<!-- End: -->