/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: 2008-08-17 20:34:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817203418-l691ahxyc7vmezad
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".

* mandos.xml: More improvements.  Replaced " with <quote>'s.
  (NETWORK PROTOCOL): Replaced <informaltable> with <table> with a
                      <title>.
  (CHECKING): New section describing the continual checking of
              clients.
  (LOGGING): We log to /dev/log, not syslog(3).
  (FILES): Changed to use a <variablelist> instead of an
           <itemizedlist>.  Added "/dev/log" and brief descriptions of
           all files.
  (BUGS): Added content.
  (EXAMPLES): - '' -
  (SECURITY): Added content to subsections "SERVER" and "CLIENTS".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "mandos-keygen">
6
8
]>
7
9
 
8
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
9
11
  <refentryinfo>
10
12
    <title>&COMMANDNAME;</title>
11
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
12
14
    <productname>&COMMANDNAME;</productname>
13
15
    <productnumber>&VERSION;</productnumber>
14
16
    <authorgroup>
29
31
    </authorgroup>
30
32
    <copyright>
31
33
      <year>2008</year>
32
 
      <holder>Teddy Hogeborn</holder>
33
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
34
35
    </copyright>
35
36
    <legalnotice>
36
37
      <para>
86
87
        <replaceable>bits</replaceable></arg>
87
88
      </group>
88
89
      <group choice="opt">
89
 
        <arg choice="plain"><option>--subtype</option>
90
 
        <replaceable>type</replaceable></arg>
91
 
      </group>
92
 
      <group choice="opt">
93
 
        <arg choice="plain"><option>--sublength</option>
94
 
        <replaceable>bits</replaceable></arg>
95
 
      </group>
96
 
      <group choice="opt">
97
90
        <arg choice="plain"><option>--name</option>
98
91
        <replaceable>NAME</replaceable></arg>
99
92
      </group>
128
121
        <replaceable>bits</replaceable></arg>
129
122
      </group>
130
123
      <group choice="opt">
131
 
        <arg choice="plain"><option>-s</option>
132
 
        <replaceable>type</replaceable></arg>
133
 
      </group>
134
 
      <group choice="opt">
135
 
        <arg choice="plain"><option>-L</option>
136
 
        <replaceable>bits</replaceable></arg>
137
 
      </group>
138
 
      <group choice="opt">
139
124
        <arg choice="plain"><option>-n</option>
140
125
        <replaceable>NAME</replaceable></arg>
141
126
      </group>
158
143
    <cmdsynopsis>
159
144
      <command>&COMMANDNAME;</command>
160
145
      <group choice="req">
161
 
        <arg choice="plain"><option>-p</option></arg>
162
 
        <arg choice="plain"><option>--password</option></arg>
163
 
      </group>
164
 
      <group choice="opt">
165
 
        <arg choice="plain"><option>--dir</option>
166
 
        <replaceable>directory</replaceable></arg>
167
 
      </group>
168
 
      <group choice="opt">
169
 
        <arg choice="plain"><option>--name</option>
170
 
        <replaceable>NAME</replaceable></arg>
171
 
      </group>
172
 
    </cmdsynopsis>
173
 
    <cmdsynopsis>
174
 
      <command>&COMMANDNAME;</command>
175
 
      <group choice="req">
176
 
        <arg choice="plain"><option>-h</option></arg>
177
 
        <arg choice="plain"><option>--help</option></arg>
178
 
      </group>
179
 
    </cmdsynopsis>
180
 
    <cmdsynopsis>
181
 
      <command>&COMMANDNAME;</command>
182
 
      <group choice="req">
183
 
        <arg choice="plain"><option>-v</option></arg>
184
 
        <arg choice="plain"><option>--version</option></arg>
 
146
        <arg choice='plain'><option>-h</option></arg>
 
147
        <arg choice='plain'><option>--help</option></arg>
 
148
      </group>
 
149
    </cmdsynopsis>
 
150
    <cmdsynopsis>
 
151
      <command>&COMMANDNAME;</command>
 
152
      <group choice="req">
 
153
        <arg choice='plain'><option>-v</option></arg>
 
154
        <arg choice='plain'><option>--version</option></arg>
185
155
      </group>
186
156
    </cmdsynopsis>
187
157
  </refsynopsisdiv>
197
167
      initrd image, but this, like most things, can be changed with
198
168
      command line options.
199
169
    </para>
200
 
    <para>
201
 
      It can also be used to generate ready-made sections for
202
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
203
 
      <manvolnum>5</manvolnum></citerefentry> using the
204
 
      <option>--password</option> option.
205
 
    </para>
206
 
  </refsect1>
207
 
  
208
 
  <refsect1 id="purpose">
209
 
    <title>PURPOSE</title>
210
 
 
211
 
    <para>
212
 
      The purpose of this is to enable <emphasis>remote and unattended
213
 
      rebooting</emphasis> of client host computer with an
214
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
215
 
      linkend="overview"/> for details.
216
 
    </para>
217
 
 
218
170
  </refsect1>
219
171
  
220
172
  <refsect1 id="options">
235
187
        <replaceable>directory</replaceable></literal></term>
236
188
        <listitem>
237
189
          <para>
238
 
            Target directory for key files.  Default is
239
 
            <filename>/etc/mandos</filename>.
 
190
            Target directory for key files.
240
191
          </para>
241
192
        </listitem>
242
193
      </varlistentry>
246
197
        <replaceable>type</replaceable></literal></term>
247
198
        <listitem>
248
199
          <para>
249
 
            Key type.  Default is <quote>DSA</quote>.
 
200
            Key type.  Default is DSA.
250
201
          </para>
251
202
        </listitem>
252
203
      </varlistentry>
262
213
      </varlistentry>
263
214
 
264
215
      <varlistentry>
265
 
        <term><literal>-s</literal>, <literal>--subtype
266
 
        <replaceable>type</replaceable></literal></term>
267
 
        <listitem>
268
 
          <para>
269
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
270
 
            encryption-only).
271
 
          </para>
272
 
        </listitem>
273
 
      </varlistentry>
274
 
 
275
 
      <varlistentry>
276
 
        <term><literal>-L</literal>, <literal>--sublength
277
 
        <replaceable>bits</replaceable></literal></term>
278
 
        <listitem>
279
 
          <para>
280
 
            Subkey length in bits.  Default is 2048.
281
 
          </para>
282
 
        </listitem>
283
 
      </varlistentry>
284
 
 
285
 
      <varlistentry>
286
216
        <term><literal>-e</literal>, <literal>--email</literal>
287
217
        <replaceable>address</replaceable></term>
288
218
        <listitem>
298
228
        <listitem>
299
229
          <para>
300
230
            Comment field for key.  The default value is
301
 
            <quote><literal>Mandos client key</literal></quote>.
 
231
            "<literal>Mandos client key</literal>".
302
232
          </para>
303
233
        </listitem>
304
234
      </varlistentry>
323
253
          </para>
324
254
        </listitem>
325
255
      </varlistentry>
326
 
      <varlistentry>
327
 
        <term><literal>-p</literal>, <literal>--password</literal
328
 
        ></term>
329
 
        <listitem>
330
 
          <para>
331
 
            Prompt for a password and encrypt it with the key already
332
 
            present in either <filename>/etc/mandos</filename> or the
333
 
            directory specified with the <option>--dir</option>
334
 
            option.  Outputs, on standard output, a section suitable
335
 
            for inclusion in <citerefentry><refentrytitle
336
 
            >mandos-clients.conf</refentrytitle><manvolnum
337
 
            >8</manvolnum></citerefentry>.  The host name or the name
338
 
            specified with the <option>--name</option> option is used
339
 
            for the section header.  All other options are ignored,
340
 
            and no keys are created.
341
 
          </para>
342
 
        </listitem>
343
 
      </varlistentry>
344
256
    </variablelist>
345
257
  </refsect1>
346
258
 
347
 
  <refsect1 id="overview">
348
 
    <title>OVERVIEW</title>
349
 
    <xi:include href="overview.xml"/>
350
 
    <para>
351
 
      This program is a small utility to generate new OpenPGP keys for
352
 
      new Mandos clients.
353
 
    </para>
354
 
  </refsect1>
355
 
 
356
259
  <refsect1 id="exit_status">
357
260
    <title>EXIT STATUS</title>
358
261
    <para>
359
 
      The exit status will be 0 if new keys were successfully created,
360
 
      otherwise not.
361
262
    </para>
362
263
  </refsect1>
363
264
  
364
 
  <refsect1 id="environment">
365
 
    <title>ENVIRONMENT</title>
366
 
    <variablelist>
367
 
      <varlistentry>
368
 
        <term><varname>TMPDIR</varname></term>
369
 
        <listitem>
370
 
          <para>
371
 
            If set, temporary files will be created here. See
372
 
            <citerefentry><refentrytitle>mktemp</refentrytitle>
373
 
            <manvolnum>1</manvolnum></citerefentry>.
374
 
          </para>
375
 
        </listitem>
376
 
      </varlistentry>
377
 
    </variablelist>
378
 
  </refsect1>
379
 
  
380
265
  <refsect1 id="file">
381
266
    <title>FILES</title>
382
267
    <para>
383
 
      Use the <option>--dir</option> option to change where
384
 
      <command>&COMMANDNAME;</command> will write the key files.  The
385
 
      default file names are shown here.
386
268
    </para>
387
 
    <variablelist>
388
 
      <varlistentry>
389
 
        <term><filename>/etc/mandos/seckey.txt</filename></term>
390
 
        <listitem>
391
 
          <para>
392
 
            OpenPGP secret key file which will be created or
393
 
            overwritten.
394
 
          </para>
395
 
        </listitem>
396
 
      </varlistentry>
397
 
      <varlistentry>
398
 
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
399
 
        <listitem>
400
 
          <para>
401
 
            OpenPGP public key file which will be created or
402
 
            overwritten.
403
 
          </para>
404
 
        </listitem>
405
 
      </varlistentry>
406
 
      <varlistentry>
407
 
        <term><filename>/tmp</filename></term>
408
 
        <listitem>
409
 
          <para>
410
 
            Temporary files will be written here if
411
 
            <varname>TMPDIR</varname> is not set.
412
 
          </para>
413
 
        </listitem>
414
 
      </varlistentry>
415
 
    </variablelist>
416
269
  </refsect1>
417
270
 
418
271
  <refsect1 id="bugs">
419
272
    <title>BUGS</title>
420
273
    <para>
421
 
      None are known at this time.
422
274
    </para>
423
275
  </refsect1>
424
276
 
425
 
  <refsect1 id="example">
426
 
    <title>EXAMPLE</title>
427
 
    <informalexample>
428
 
      <para>
429
 
        Normal invocation needs no options:
430
 
      </para>
431
 
      <para>
432
 
        <userinput>mandos-keygen</userinput>
433
 
      </para>
434
 
    </informalexample>
435
 
    <informalexample>
436
 
      <para>
437
 
        Create keys in another directory and of another type.  Force
438
 
        overwriting old key files:
439
 
      </para>
440
 
      <para>
441
 
 
442
 
<!-- do not wrap this line -->
443
 
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
444
 
 
445
 
      </para>
446
 
    </informalexample>
 
277
  <refsect1 id="examples">
 
278
    <title>EXAMPLES</title>
 
279
    <para>
 
280
    </para>
447
281
  </refsect1>
448
282
 
449
283
  <refsect1 id="security">
450
284
    <title>SECURITY</title>
451
285
    <para>
452
 
      The <option>--type</option>, <option>--length</option>,
453
 
      <option>--subtype</option>, and <option>--sublength</option>
454
 
      options can be used to create keys of insufficient security.  If
455
 
      in doubt, leave them to the default values.
456
 
    </para>
457
 
    <para>
458
 
      The key expire time is not guaranteed to be honored by
459
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
460
 
      <manvolnum>8</manvolnum></citerefentry>.
461
286
    </para>
462
287
  </refsect1>
463
288
 
467
292
      <citerefentry><refentrytitle>password-request</refentrytitle>
468
293
      <manvolnum>8mandos</manvolnum></citerefentry>,
469
294
      <citerefentry><refentrytitle>mandos</refentrytitle>
470
 
      <manvolnum>8</manvolnum></citerefentry>,
 
295
      <manvolnum>8</manvolnum></citerefentry>, and
471
296
      <citerefentry><refentrytitle>gpg</refentrytitle>
472
297
      <manvolnum>1</manvolnum></citerefentry>
473
298
    </para>