/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: 2008-08-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
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"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "mandos-keygen">
8
6
]>
9
7
 
10
 
<refentry>
 
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
9
  <refentryinfo>
12
10
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
12
    <productname>&COMMANDNAME;</productname>
15
13
    <productnumber>&VERSION;</productnumber>
16
14
    <authorgroup>
31
29
    </authorgroup>
32
30
    <copyright>
33
31
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
32
      <holder>Teddy Hogeborn</holder>
 
33
      <holder>Björn Påhlsson</holder>
35
34
    </copyright>
36
35
    <legalnotice>
37
36
      <para>
87
86
        <replaceable>bits</replaceable></arg>
88
87
      </group>
89
88
      <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">
90
97
        <arg choice="plain"><option>--name</option>
91
98
        <replaceable>NAME</replaceable></arg>
92
99
      </group>
121
128
        <replaceable>bits</replaceable></arg>
122
129
      </group>
123
130
      <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">
124
139
        <arg choice="plain"><option>-n</option>
125
140
        <replaceable>NAME</replaceable></arg>
126
141
      </group>
143
158
    <cmdsynopsis>
144
159
      <command>&COMMANDNAME;</command>
145
160
      <group choice="req">
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>
 
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>
155
185
      </group>
156
186
    </cmdsynopsis>
157
187
  </refsynopsisdiv>
167
197
      initrd image, but this, like most things, can be changed with
168
198
      command line options.
169
199
    </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
 
170
218
  </refsect1>
171
219
  
172
220
  <refsect1 id="options">
187
235
        <replaceable>directory</replaceable></literal></term>
188
236
        <listitem>
189
237
          <para>
190
 
            Target directory for key files.
 
238
            Target directory for key files.  Default is
 
239
            <filename>/etc/mandos</filename>.
191
240
          </para>
192
241
        </listitem>
193
242
      </varlistentry>
197
246
        <replaceable>type</replaceable></literal></term>
198
247
        <listitem>
199
248
          <para>
200
 
            Key type.  Default is DSA.
 
249
            Key type.  Default is <quote>DSA</quote>.
201
250
          </para>
202
251
        </listitem>
203
252
      </varlistentry>
207
256
        <replaceable>bits</replaceable></literal></term>
208
257
        <listitem>
209
258
          <para>
210
 
            Key length in bits.  Default is 1024.
 
259
            Key length in bits.  Default is 2048.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
 
 
264
      <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.
211
281
          </para>
212
282
        </listitem>
213
283
      </varlistentry>
228
298
        <listitem>
229
299
          <para>
230
300
            Comment field for key.  The default value is
231
 
            "<literal>Mandos client key</literal>".
 
301
            <quote><literal>Mandos client key</literal></quote>.
232
302
          </para>
233
303
        </listitem>
234
304
      </varlistentry>
253
323
          </para>
254
324
        </listitem>
255
325
      </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>
256
344
    </variablelist>
257
345
  </refsect1>
258
346
 
 
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
 
259
356
  <refsect1 id="exit_status">
260
357
    <title>EXIT STATUS</title>
261
358
    <para>
 
359
      The exit status will be 0 if new keys were successfully created,
 
360
      otherwise not.
262
361
    </para>
263
362
  </refsect1>
264
363
  
 
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
  
265
380
  <refsect1 id="file">
266
381
    <title>FILES</title>
267
382
    <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.
268
386
    </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>
269
416
  </refsect1>
270
417
 
271
418
  <refsect1 id="bugs">
272
419
    <title>BUGS</title>
273
420
    <para>
 
421
      None are known at this time.
274
422
    </para>
275
423
  </refsect1>
276
424
 
277
 
  <refsect1 id="examples">
278
 
    <title>EXAMPLES</title>
279
 
    <para>
280
 
    </para>
 
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>
281
447
  </refsect1>
282
448
 
283
449
  <refsect1 id="security">
284
450
    <title>SECURITY</title>
285
451
    <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>.
286
461
    </para>
287
462
  </refsect1>
288
463
 
292
467
      <citerefentry><refentrytitle>password-request</refentrytitle>
293
468
      <manvolnum>8mandos</manvolnum></citerefentry>,
294
469
      <citerefentry><refentrytitle>mandos</refentrytitle>
295
 
      <manvolnum>8</manvolnum></citerefentry>, and
 
470
      <manvolnum>8</manvolnum></citerefentry>,
296
471
      <citerefentry><refentrytitle>gpg</refentrytitle>
297
472
      <manvolnum>1</manvolnum></citerefentry>
298
473
    </para>