/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-18 03:50:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818035028-su31apqs2pv2147v
* mandos-keygen.xml: Removed <?xml-stylesheet>.  New entity
                     "&OVERVIEW;" referring to "overview.xml".
  (PURPOSE, OVERVIEW): New sections, same as in mandos(8).
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* mandos.xml (OPTIONS, CLIENTS): Slight wording change.

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
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
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-08-29">
 
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
7
7
]>
8
8
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
10
10
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
11
    <title>&COMMANDNAME;</title>
 
12
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
13
    <productname>&COMMANDNAME;</productname>
14
14
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
15
    <authorgroup>
17
16
      <author>
18
17
        <firstname>Björn</firstname>
31
30
    </authorgroup>
32
31
    <copyright>
33
32
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
33
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
34
    </copyright>
37
35
    <legalnotice>
38
36
      <para>
88
86
        <replaceable>bits</replaceable></arg>
89
87
      </group>
90
88
      <group choice="opt">
91
 
        <arg choice="plain"><option>--subtype</option>
92
 
        <replaceable>type</replaceable></arg>
93
 
      </group>
94
 
      <group choice="opt">
95
 
        <arg choice="plain"><option>--sublength</option>
96
 
        <replaceable>bits</replaceable></arg>
97
 
      </group>
98
 
      <group choice="opt">
99
89
        <arg choice="plain"><option>--name</option>
100
90
        <replaceable>NAME</replaceable></arg>
101
91
      </group>
130
120
        <replaceable>bits</replaceable></arg>
131
121
      </group>
132
122
      <group choice="opt">
133
 
        <arg choice="plain"><option>-s</option>
134
 
        <replaceable>type</replaceable></arg>
135
 
      </group>
136
 
      <group choice="opt">
137
 
        <arg choice="plain"><option>-L</option>
138
 
        <replaceable>bits</replaceable></arg>
139
 
      </group>
140
 
      <group choice="opt">
141
123
        <arg choice="plain"><option>-n</option>
142
124
        <replaceable>NAME</replaceable></arg>
143
125
      </group>
160
142
    <cmdsynopsis>
161
143
      <command>&COMMANDNAME;</command>
162
144
      <group choice="req">
163
 
        <arg choice="plain"><option>-p</option></arg>
164
 
        <arg choice="plain"><option>--password</option></arg>
165
 
      </group>
166
 
      <group choice="opt">
167
 
        <arg choice="plain"><option>--dir</option>
168
 
        <replaceable>directory</replaceable></arg>
169
 
      </group>
170
 
      <group choice="opt">
171
 
        <arg choice="plain"><option>--name</option>
172
 
        <replaceable>NAME</replaceable></arg>
173
 
      </group>
174
 
    </cmdsynopsis>
175
 
    <cmdsynopsis>
176
 
      <command>&COMMANDNAME;</command>
177
 
      <group choice="req">
178
 
        <arg choice="plain"><option>-h</option></arg>
179
 
        <arg choice="plain"><option>--help</option></arg>
180
 
      </group>
181
 
    </cmdsynopsis>
182
 
    <cmdsynopsis>
183
 
      <command>&COMMANDNAME;</command>
184
 
      <group choice="req">
185
 
        <arg choice="plain"><option>-v</option></arg>
186
 
        <arg choice="plain"><option>--version</option></arg>
 
145
        <arg choice='plain'><option>-h</option></arg>
 
146
        <arg choice='plain'><option>--help</option></arg>
 
147
      </group>
 
148
    </cmdsynopsis>
 
149
    <cmdsynopsis>
 
150
      <command>&COMMANDNAME;</command>
 
151
      <group choice="req">
 
152
        <arg choice='plain'><option>-v</option></arg>
 
153
        <arg choice='plain'><option>--version</option></arg>
187
154
      </group>
188
155
    </cmdsynopsis>
189
156
  </refsynopsisdiv>
199
166
      initrd image, but this, like most things, can be changed with
200
167
      command line options.
201
168
    </para>
202
 
    <para>
203
 
      It can also be used to generate ready-made sections for
204
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
205
 
      <manvolnum>5</manvolnum></citerefentry> using the
206
 
      <option>--password</option> option.
207
 
    </para>
208
169
  </refsect1>
209
170
  
210
171
  <refsect1 id="purpose">
237
198
        <replaceable>directory</replaceable></literal></term>
238
199
        <listitem>
239
200
          <para>
240
 
            Target directory for key files.  Default is
241
 
            <filename>/etc/mandos</filename>.
 
201
            Target directory for key files.
242
202
          </para>
243
203
        </listitem>
244
204
      </varlistentry>
248
208
        <replaceable>type</replaceable></literal></term>
249
209
        <listitem>
250
210
          <para>
251
 
            Key type.  Default is <quote>DSA</quote>.
 
211
            Key type.  Default is DSA.
252
212
          </para>
253
213
        </listitem>
254
214
      </varlistentry>
258
218
        <replaceable>bits</replaceable></literal></term>
259
219
        <listitem>
260
220
          <para>
261
 
            Key length in bits.  Default is 2048.
262
 
          </para>
263
 
        </listitem>
264
 
      </varlistentry>
265
 
 
266
 
      <varlistentry>
267
 
        <term><literal>-s</literal>, <literal>--subtype
268
 
        <replaceable>type</replaceable></literal></term>
269
 
        <listitem>
270
 
          <para>
271
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
272
 
            encryption-only).
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
 
277
 
      <varlistentry>
278
 
        <term><literal>-L</literal>, <literal>--sublength
279
 
        <replaceable>bits</replaceable></literal></term>
280
 
        <listitem>
281
 
          <para>
282
 
            Subkey length in bits.  Default is 2048.
 
221
            Key length in bits.  Default is 1024.
283
222
          </para>
284
223
        </listitem>
285
224
      </varlistentry>
300
239
        <listitem>
301
240
          <para>
302
241
            Comment field for key.  The default value is
303
 
            <quote><literal>Mandos client key</literal></quote>.
 
242
            "<literal>Mandos client key</literal>".
304
243
          </para>
305
244
        </listitem>
306
245
      </varlistentry>
325
264
          </para>
326
265
        </listitem>
327
266
      </varlistentry>
328
 
      <varlistentry>
329
 
        <term><literal>-p</literal>, <literal>--password</literal
330
 
        ></term>
331
 
        <listitem>
332
 
          <para>
333
 
            Prompt for a password and encrypt it with the key already
334
 
            present in either <filename>/etc/mandos</filename> or the
335
 
            directory specified with the <option>--dir</option>
336
 
            option.  Outputs, on standard output, a section suitable
337
 
            for inclusion in <citerefentry><refentrytitle
338
 
            >mandos-clients.conf</refentrytitle><manvolnum
339
 
            >8</manvolnum></citerefentry>.  The host name or the name
340
 
            specified with the <option>--name</option> option is used
341
 
            for the section header.  All other options are ignored,
342
 
            and no keys are created.
343
 
          </para>
344
 
        </listitem>
345
 
      </varlistentry>
346
267
    </variablelist>
347
268
  </refsect1>
348
269
 
349
270
  <refsect1 id="overview">
350
271
    <title>OVERVIEW</title>
351
 
    <xi:include href="overview.xml"/>
 
272
    &OVERVIEW;
352
273
    <para>
353
 
      This program is a small utility to generate new OpenPGP keys for
 
274
      This program is a small program to generate new OpenPGP keys for
354
275
      new Mandos clients.
355
276
    </para>
356
277
  </refsect1>
358
279
  <refsect1 id="exit_status">
359
280
    <title>EXIT STATUS</title>
360
281
    <para>
361
 
      The exit status will be 0 if new keys were successfully created,
362
 
      otherwise not.
363
282
    </para>
364
283
  </refsect1>
365
284
  
366
 
  <refsect1 id="environment">
367
 
    <title>ENVIRONMENT</title>
368
 
    <variablelist>
369
 
      <varlistentry>
370
 
        <term><varname>TMPDIR</varname></term>
371
 
        <listitem>
372
 
          <para>
373
 
            If set, temporary files will be created here. See
374
 
            <citerefentry><refentrytitle>mktemp</refentrytitle>
375
 
            <manvolnum>1</manvolnum></citerefentry>.
376
 
          </para>
377
 
        </listitem>
378
 
      </varlistentry>
379
 
    </variablelist>
380
 
  </refsect1>
381
 
  
382
285
  <refsect1 id="file">
383
286
    <title>FILES</title>
384
287
    <para>
385
 
      Use the <option>--dir</option> option to change where
386
 
      <command>&COMMANDNAME;</command> will write the key files.  The
387
 
      default file names are shown here.
388
288
    </para>
389
 
    <variablelist>
390
 
      <varlistentry>
391
 
        <term><filename>/etc/mandos/seckey.txt</filename></term>
392
 
        <listitem>
393
 
          <para>
394
 
            OpenPGP secret key file which will be created or
395
 
            overwritten.
396
 
          </para>
397
 
        </listitem>
398
 
      </varlistentry>
399
 
      <varlistentry>
400
 
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
401
 
        <listitem>
402
 
          <para>
403
 
            OpenPGP public key file which will be created or
404
 
            overwritten.
405
 
          </para>
406
 
        </listitem>
407
 
      </varlistentry>
408
 
      <varlistentry>
409
 
        <term><filename>/tmp</filename></term>
410
 
        <listitem>
411
 
          <para>
412
 
            Temporary files will be written here if
413
 
            <varname>TMPDIR</varname> is not set.
414
 
          </para>
415
 
        </listitem>
416
 
      </varlistentry>
417
 
    </variablelist>
418
289
  </refsect1>
419
290
 
420
291
  <refsect1 id="bugs">
421
292
    <title>BUGS</title>
422
293
    <para>
423
 
      None are known at this time.
424
294
    </para>
425
295
  </refsect1>
426
296
 
427
297
  <refsect1 id="example">
428
298
    <title>EXAMPLE</title>
429
 
    <informalexample>
430
 
      <para>
431
 
        Normal invocation needs no options:
432
 
      </para>
433
 
      <para>
434
 
        <userinput>&COMMANDNAME;</userinput>
435
 
      </para>
436
 
    </informalexample>
437
 
    <informalexample>
438
 
      <para>
439
 
        Create keys in another directory and of another type.  Force
440
 
        overwriting old key files:
441
 
      </para>
442
 
      <para>
443
 
 
444
 
<!-- do not wrap this line -->
445
 
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
446
 
 
447
 
      </para>
448
 
    </informalexample>
 
299
    <para>
 
300
    </para>
449
301
  </refsect1>
450
302
 
451
303
  <refsect1 id="security">
452
304
    <title>SECURITY</title>
453
305
    <para>
454
 
      The <option>--type</option>, <option>--length</option>,
455
 
      <option>--subtype</option>, and <option>--sublength</option>
456
 
      options can be used to create keys of insufficient security.  If
457
 
      in doubt, leave them to the default values.
458
 
    </para>
459
 
    <para>
460
 
      The key expire time is not guaranteed to be honored by
461
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
462
 
      <manvolnum>8</manvolnum></citerefentry>.
463
306
    </para>
464
307
  </refsect1>
465
308
 
466
309
  <refsect1 id="see_also">
467
310
    <title>SEE ALSO</title>
468
311
    <para>
 
312
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
313
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
314
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
315
      <manvolnum>8</manvolnum></citerefentry>, and
469
316
      <citerefentry><refentrytitle>gpg</refentrytitle>
470
 
      <manvolnum>1</manvolnum></citerefentry>,
471
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
472
 
      <manvolnum>8</manvolnum></citerefentry>,
473
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
474
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
317
      <manvolnum>1</manvolnum></citerefentry>
475
318
    </para>
476
319
  </refsect1>
477
320
  
478
321
</refentry>
479
 
<!-- Local Variables: -->
480
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
481
 
<!-- time-stamp-end: "[\"']>" -->
482
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
483
 
<!-- End: -->