/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: 2017-09-03 09:00:31 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 362.
  • Revision ID: teddy@recompile.se-20170903090031-zhxw13lca97zuysr
Plymouth plugin bug fix: Actually try the old PID file location

* plugins.d/plymouth.c (get_pid): Try both plymouth_pid and
  plymouth_old_pid, not just plymouth_pid twice.

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 "2017-02-23">
 
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>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <holder>Teddy Hogeborn</holder>
 
45
      <holder>Björn Påhlsson</holder>
 
46
    </copyright>
 
47
    <xi:include href="legalnotice.xml"/>
 
48
  </refentryinfo>
 
49
  
 
50
  <refmeta>
 
51
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
52
    <manvolnum>8</manvolnum>
 
53
  </refmeta>
 
54
  
 
55
  <refnamediv>
 
56
    <refname><command>&COMMANDNAME;</command></refname>
 
57
    <refpurpose>
 
58
      Generate key and password for Mandos client and server.
 
59
    </refpurpose>
 
60
  </refnamediv>
 
61
  
 
62
  <refsynopsisdiv>
 
63
    <cmdsynopsis>
 
64
      <command>&COMMANDNAME;</command>
 
65
      <group>
 
66
        <arg choice="plain"><option>--dir
 
67
        <replaceable>DIRECTORY</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-d
 
69
        <replaceable>DIRECTORY</replaceable></option></arg>
 
70
      </group>
 
71
      <sbr/>
 
72
      <group>
 
73
        <arg choice="plain"><option>--type
 
74
        <replaceable>KEYTYPE</replaceable></option></arg>
 
75
        <arg choice="plain"><option>-t
 
76
        <replaceable>KEYTYPE</replaceable></option></arg>
 
77
      </group>
 
78
      <sbr/>
 
79
      <group>
 
80
        <arg choice="plain"><option>--length
 
81
        <replaceable>BITS</replaceable></option></arg>
 
82
        <arg choice="plain"><option>-l
 
83
        <replaceable>BITS</replaceable></option></arg>
 
84
      </group>
 
85
      <sbr/>
 
86
      <group>
 
87
        <arg choice="plain"><option>--subtype
 
88
        <replaceable>KEYTYPE</replaceable></option></arg>
 
89
        <arg choice="plain"><option>-s
 
90
        <replaceable>KEYTYPE</replaceable></option></arg>
 
91
      </group>
 
92
      <sbr/>
 
93
      <group>
 
94
        <arg choice="plain"><option>--sublength
 
95
        <replaceable>BITS</replaceable></option></arg>
 
96
        <arg choice="plain"><option>-L
 
97
        <replaceable>BITS</replaceable></option></arg>
 
98
      </group>
 
99
      <sbr/>
 
100
      <group>
 
101
        <arg choice="plain"><option>--name
 
102
        <replaceable>NAME</replaceable></option></arg>
 
103
        <arg choice="plain"><option>-n
 
104
        <replaceable>NAME</replaceable></option></arg>
 
105
      </group>
 
106
      <sbr/>
 
107
      <group>
 
108
        <arg choice="plain"><option>--email
 
109
        <replaceable>ADDRESS</replaceable></option></arg>
 
110
        <arg choice="plain"><option>-e
 
111
        <replaceable>ADDRESS</replaceable></option></arg>
 
112
      </group>
 
113
      <sbr/>
 
114
      <group>
 
115
        <arg choice="plain"><option>--comment
 
116
        <replaceable>TEXT</replaceable></option></arg>
 
117
        <arg choice="plain"><option>-c
 
118
        <replaceable>TEXT</replaceable></option></arg>
 
119
      </group>
 
120
      <sbr/>
 
121
      <group>
 
122
        <arg choice="plain"><option>--expire
 
123
        <replaceable>TIME</replaceable></option></arg>
 
124
        <arg choice="plain"><option>-x
 
125
        <replaceable>TIME</replaceable></option></arg>
 
126
      </group>
 
127
      <sbr/>
 
128
      <group>
 
129
        <arg choice="plain"><option>--force</option></arg>
 
130
        <arg choice="plain"><option>-f</option></arg>
 
131
      </group>
 
132
    </cmdsynopsis>
 
133
    <cmdsynopsis>
 
134
      <command>&COMMANDNAME;</command>
 
135
      <group choice="req">
 
136
        <arg choice="plain"><option>--password</option></arg>
 
137
        <arg choice="plain"><option>-p</option></arg>
 
138
        <arg choice="plain"><option>--passfile
 
139
        <replaceable>FILE</replaceable></option></arg>
 
140
        <arg choice="plain"><option>-F</option>
 
141
        <replaceable>FILE</replaceable></arg>
 
142
      </group>
 
143
      <sbr/>
 
144
      <group>
 
145
        <arg choice="plain"><option>--dir
 
146
        <replaceable>DIRECTORY</replaceable></option></arg>
 
147
        <arg choice="plain"><option>-d
 
148
        <replaceable>DIRECTORY</replaceable></option></arg>
 
149
      </group>
 
150
      <sbr/>
 
151
      <group>
 
152
        <arg choice="plain"><option>--name
 
153
        <replaceable>NAME</replaceable></option></arg>
 
154
        <arg choice="plain"><option>-n
 
155
        <replaceable>NAME</replaceable></option></arg>
 
156
      </group>
 
157
      <group>
 
158
        <arg choice="plain"><option>--no-ssh</option></arg>
 
159
        <arg choice="plain"><option>-S</option></arg>
 
160
      </group>
 
161
    </cmdsynopsis>
 
162
    <cmdsynopsis>
 
163
      <command>&COMMANDNAME;</command>
 
164
      <group choice="req">
 
165
        <arg choice="plain"><option>--help</option></arg>
 
166
        <arg choice="plain"><option>-h</option></arg>
 
167
      </group>
 
168
    </cmdsynopsis>
 
169
    <cmdsynopsis>
 
170
      <command>&COMMANDNAME;</command>
 
171
      <group choice="req">
 
172
        <arg choice="plain"><option>--version</option></arg>
 
173
        <arg choice="plain"><option>-v</option></arg>
 
174
      </group>
 
175
    </cmdsynopsis>
 
176
  </refsynopsisdiv>
 
177
  
 
178
  <refsect1 id="description">
 
179
    <title>DESCRIPTION</title>
 
180
    <para>
 
181
      <command>&COMMANDNAME;</command> is a program to generate the
 
182
      OpenPGP key used by
 
183
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
185
      normally written to /etc/mandos for later installation into the
 
186
      initrd image, but this, and most other things, can be changed
 
187
      with command line options.
 
188
    </para>
 
189
    <para>
 
190
      This program can also be used with the
 
191
      <option>--password</option> or <option>--passfile</option>
 
192
      options to generate a ready-made section for
 
193
      <filename>clients.conf</filename> (see
 
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
195
      <manvolnum>5</manvolnum></citerefentry>).
 
196
    </para>
 
197
  </refsect1>
 
198
  
 
199
  <refsect1 id="purpose">
 
200
    <title>PURPOSE</title>
 
201
    <para>
 
202
      The purpose of this is to enable <emphasis>remote and unattended
 
203
      rebooting</emphasis> of client host computer with an
 
204
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
205
      linkend="overview"/> for details.
 
206
    </para>
 
207
  </refsect1>
 
208
  
 
209
  <refsect1 id="options">
 
210
    <title>OPTIONS</title>
 
211
    
 
212
    <variablelist>
 
213
      <varlistentry>
 
214
        <term><option>--help</option></term>
 
215
        <term><option>-h</option></term>
 
216
        <listitem>
 
217
          <para>
 
218
            Show a help message and exit
 
219
          </para>
 
220
        </listitem>
 
221
      </varlistentry>
 
222
      
 
223
      <varlistentry>
 
224
        <term><option>--dir
 
225
        <replaceable>DIRECTORY</replaceable></option></term>
 
226
        <term><option>-d
 
227
        <replaceable>DIRECTORY</replaceable></option></term>
 
228
        <listitem>
 
229
          <para>
 
230
            Target directory for key files.  Default is
 
231
            <filename class="directory">/etc/mandos</filename>.
 
232
          </para>
 
233
        </listitem>
 
234
      </varlistentry>
 
235
      
 
236
      <varlistentry>
 
237
        <term><option>--type
 
238
        <replaceable>TYPE</replaceable></option></term>
 
239
        <term><option>-t
 
240
        <replaceable>TYPE</replaceable></option></term>
 
241
        <listitem>
 
242
          <para>
 
243
            Key type.  Default is <quote>RSA</quote>.
 
244
          </para>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
      
 
248
      <varlistentry>
 
249
        <term><option>--length
 
250
        <replaceable>BITS</replaceable></option></term>
 
251
        <term><option>-l
 
252
        <replaceable>BITS</replaceable></option></term>
 
253
        <listitem>
 
254
          <para>
 
255
            Key length in bits.  Default is 4096.
 
256
          </para>
 
257
        </listitem>
 
258
      </varlistentry>
 
259
      
 
260
      <varlistentry>
 
261
        <term><option>--subtype
 
262
        <replaceable>KEYTYPE</replaceable></option></term>
 
263
        <term><option>-s
 
264
        <replaceable>KEYTYPE</replaceable></option></term>
 
265
        <listitem>
 
266
          <para>
 
267
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
268
            encryption-only).
 
269
          </para>
 
270
        </listitem>
 
271
      </varlistentry>
 
272
      
 
273
      <varlistentry>
 
274
        <term><option>--sublength
 
275
        <replaceable>BITS</replaceable></option></term>
 
276
        <term><option>-L
 
277
        <replaceable>BITS</replaceable></option></term>
 
278
        <listitem>
 
279
          <para>
 
280
            Subkey length in bits.  Default is 4096.
 
281
          </para>
 
282
        </listitem>
 
283
      </varlistentry>
 
284
      
 
285
      <varlistentry>
 
286
        <term><option>--email
 
287
        <replaceable>ADDRESS</replaceable></option></term>
 
288
        <term><option>-e
 
289
        <replaceable>ADDRESS</replaceable></option></term>
 
290
        <listitem>
 
291
          <para>
 
292
            Email address of key.  Default is empty.
 
293
          </para>
 
294
        </listitem>
 
295
      </varlistentry>
 
296
      
 
297
      <varlistentry>
 
298
        <term><option>--comment
 
299
        <replaceable>TEXT</replaceable></option></term>
 
300
        <term><option>-c
 
301
        <replaceable>TEXT</replaceable></option></term>
 
302
        <listitem>
 
303
          <para>
 
304
            Comment field for key.  Default is empty.
 
305
          </para>
 
306
        </listitem>
 
307
      </varlistentry>
 
308
      
 
309
      <varlistentry>
 
310
        <term><option>--expire
 
311
        <replaceable>TIME</replaceable></option></term>
 
312
        <term><option>-x
 
313
        <replaceable>TIME</replaceable></option></term>
 
314
        <listitem>
 
315
          <para>
 
316
            Key expire time.  Default is no expiration.  See
 
317
            <citerefentry><refentrytitle>gpg</refentrytitle>
 
318
            <manvolnum>1</manvolnum></citerefentry> for syntax.
 
319
          </para>
 
320
        </listitem>
 
321
      </varlistentry>
 
322
      
 
323
      <varlistentry>
 
324
        <term><option>--force</option></term>
 
325
        <term><option>-f</option></term>
 
326
        <listitem>
 
327
          <para>
 
328
            Force overwriting old key.
 
329
          </para>
 
330
        </listitem>
 
331
      </varlistentry>
 
332
      <varlistentry>
 
333
        <term><option>--password</option></term>
 
334
        <term><option>-p</option></term>
 
335
        <listitem>
 
336
          <para>
 
337
            Prompt for a password and encrypt it with the key already
 
338
            present in either <filename>/etc/mandos</filename> or the
 
339
            directory specified with the <option>--dir</option>
 
340
            option.  Outputs, on standard output, a section suitable
 
341
            for inclusion in <citerefentry><refentrytitle
 
342
            >mandos-clients.conf</refentrytitle><manvolnum
 
343
            >8</manvolnum></citerefentry>.  The host name or the name
 
344
            specified with the <option>--name</option> option is used
 
345
            for the section header.  All other options are ignored,
 
346
            and no key is created.
 
347
          </para>
 
348
        </listitem>
 
349
      </varlistentry>
 
350
      <varlistentry>
 
351
        <term><option>--passfile
 
352
        <replaceable>FILE</replaceable></option></term>
 
353
        <term><option>-F
 
354
        <replaceable>FILE</replaceable></option></term>
 
355
        <listitem>
 
356
          <para>
 
357
            The same as <option>--password</option>, but read from
 
358
            <replaceable>FILE</replaceable>, not the terminal.
 
359
          </para>
 
360
        </listitem>
 
361
      </varlistentry>
 
362
      <varlistentry>
 
363
        <term><option>--no-ssh</option></term>
 
364
        <term><option>-S</option></term>
 
365
        <listitem>
 
366
          <para>
 
367
            When <option>--password</option> or
 
368
            <option>--passfile</option> is given, this option will
 
369
            prevent <command>&COMMANDNAME;</command> from calling
 
370
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
371
            for this host and, if successful, output suitable config
 
372
            options to use this fingerprint as a
 
373
            <option>checker</option> option in the output.  This is
 
374
            otherwise the default behavior.
 
375
          </para>
 
376
        </listitem>
 
377
      </varlistentry>
 
378
    </variablelist>
 
379
  </refsect1>
 
380
  
 
381
  <refsect1 id="overview">
 
382
    <title>OVERVIEW</title>
 
383
    <xi:include href="overview.xml"/>
 
384
    <para>
 
385
      This program is a small utility to generate new OpenPGP keys for
 
386
      new Mandos clients, and to generate sections for inclusion in
 
387
      <filename>clients.conf</filename> on the server.
 
388
    </para>
 
389
  </refsect1>
 
390
  
 
391
  <refsect1 id="exit_status">
 
392
    <title>EXIT STATUS</title>
 
393
    <para>
 
394
      The exit status will be 0 if a new key (or password, if the
 
395
      <option>--password</option> option was used) was successfully
 
396
      created, otherwise not.
 
397
    </para>
 
398
  </refsect1>
 
399
  
 
400
  <refsect1 id="environment">
 
401
    <title>ENVIRONMENT</title>
 
402
    <variablelist>
 
403
      <varlistentry>
 
404
        <term><envar>TMPDIR</envar></term>
 
405
        <listitem>
 
406
          <para>
 
407
            If set, temporary files will be created here. See
 
408
            <citerefentry><refentrytitle>mktemp</refentrytitle>
 
409
            <manvolnum>1</manvolnum></citerefentry>.
 
410
          </para>
 
411
        </listitem>
 
412
      </varlistentry>
 
413
    </variablelist>
 
414
  </refsect1>
 
415
  
 
416
  <refsect1 id="files">
 
417
    <title>FILES</title>
 
418
    <para>
 
419
      Use the <option>--dir</option> option to change where
 
420
      <command>&COMMANDNAME;</command> will write the key files.  The
 
421
      default file names are shown here.
 
422
    </para>
 
423
    <variablelist>
 
424
      <varlistentry>
 
425
        <term><filename>/etc/mandos/seckey.txt</filename></term>
 
426
        <listitem>
 
427
          <para>
 
428
            OpenPGP secret key file which will be created or
 
429
            overwritten.
 
430
          </para>
 
431
        </listitem>
 
432
      </varlistentry>
 
433
      <varlistentry>
 
434
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
 
435
        <listitem>
 
436
          <para>
 
437
            OpenPGP public key file which will be created or
 
438
            overwritten.
 
439
          </para>
 
440
        </listitem>
 
441
      </varlistentry>
 
442
      <varlistentry>
 
443
        <term><filename class="directory">/tmp</filename></term>
 
444
        <listitem>
 
445
          <para>
 
446
            Temporary files will be written here if
 
447
            <varname>TMPDIR</varname> is not set.
 
448
          </para>
 
449
        </listitem>
 
450
      </varlistentry>
 
451
    </variablelist>
 
452
  </refsect1>
 
453
  
 
454
  <refsect1 id="bugs">
 
455
    <title>BUGS</title>
 
456
    <xi:include href="bugs.xml"/>
 
457
  </refsect1>
 
458
  
 
459
  <refsect1 id="example">
 
460
    <title>EXAMPLE</title>
 
461
    <informalexample>
 
462
      <para>
 
463
        Normal invocation needs no options:
 
464
      </para>
 
465
      <para>
 
466
        <userinput>&COMMANDNAME;</userinput>
 
467
      </para>
 
468
    </informalexample>
 
469
    <informalexample>
 
470
      <para>
 
471
        Create key in another directory and of another type.  Force
 
472
        overwriting old key files:
 
473
      </para>
 
474
      <para>
 
475
 
 
476
<!-- do not wrap this line -->
 
477
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
 
478
 
 
479
      </para>
 
480
    </informalexample>
 
481
    <informalexample>
 
482
      <para>
 
483
        Prompt for a password, encrypt it with the key in <filename
 
484
        class="directory">/etc/mandos</filename> and output a section
 
485
        suitable for <filename>clients.conf</filename>.
 
486
      </para>
 
487
      <para>
 
488
        <userinput>&COMMANDNAME; --password</userinput>
 
489
      </para>
 
490
    </informalexample>
 
491
    <informalexample>
 
492
      <para>
 
493
        Prompt for a password, encrypt it with the key in the
 
494
        <filename>client-key</filename> directory and output a section
 
495
        suitable for <filename>clients.conf</filename>.
 
496
      </para>
 
497
      <para>
 
498
 
 
499
<!-- do not wrap this line -->
 
500
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
 
501
 
 
502
      </para>
 
503
    </informalexample>
 
504
  </refsect1>
 
505
  
 
506
  <refsect1 id="security">
 
507
    <title>SECURITY</title>
 
508
    <para>
 
509
      The <option>--type</option>, <option>--length</option>,
 
510
      <option>--subtype</option>, and <option>--sublength</option>
 
511
      options can be used to create keys of low security.  If in
 
512
      doubt, leave them to the default values.
 
513
    </para>
 
514
    <para>
 
515
      The key expire time is <emphasis>not</emphasis> guaranteed to be
 
516
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
 
517
      <manvolnum>8</manvolnum></citerefentry>.
 
518
    </para>
 
519
  </refsect1>
 
520
  
 
521
  <refsect1 id="see_also">
 
522
    <title>SEE ALSO</title>
 
523
    <para>
 
524
      <citerefentry><refentrytitle>intro</refentrytitle>
 
525
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
526
      <citerefentry><refentrytitle>gpg</refentrytitle>
 
527
      <manvolnum>1</manvolnum></citerefentry>,
 
528
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
529
      <manvolnum>5</manvolnum></citerefentry>,
 
530
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
531
      <manvolnum>8</manvolnum></citerefentry>,
 
532
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
534
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
535
      <manvolnum>1</manvolnum></citerefentry>
 
536
    </para>
 
537
  </refsect1>
 
538
  
 
539
</refentry>
 
540
<!-- Local Variables: -->
 
541
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
542
<!-- time-stamp-end: "[\"']>" -->
 
543
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
544
<!-- End: -->