/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 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

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-30">
 
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>
75
73
  <refsynopsisdiv>
76
74
    <cmdsynopsis>
77
75
      <command>&COMMANDNAME;</command>
78
 
      <group>
79
 
        <arg choice="plain"><option>--dir
80
 
        <replaceable>DIRECTORY</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-d
82
 
        <replaceable>DIRECTORY</replaceable></option></arg>
83
 
      </group>
84
 
      <sbr/>
85
 
      <group>
86
 
        <arg choice="plain"><option>--type
87
 
        <replaceable>KEYTYPE</replaceable></option></arg>
88
 
        <arg choice="plain"><option>-t
89
 
        <replaceable>KEYTYPE</replaceable></option></arg>
90
 
      </group>
91
 
      <sbr/>
92
 
      <group>
93
 
        <arg choice="plain"><option>--length
94
 
        <replaceable>BITS</replaceable></option></arg>
95
 
        <arg choice="plain"><option>-l
96
 
        <replaceable>BITS</replaceable></option></arg>
97
 
      </group>
98
 
      <sbr/>
99
 
      <group>
100
 
        <arg choice="plain"><option>--subtype
101
 
        <replaceable>KEYTYPE</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-s
103
 
        <replaceable>KEYTYPE</replaceable></option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group>
107
 
        <arg choice="plain"><option>--sublength
108
 
        <replaceable>BITS</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-L
110
 
        <replaceable>BITS</replaceable></option></arg>
111
 
      </group>
112
 
      <sbr/>
113
 
      <group>
114
 
        <arg choice="plain"><option>--name
115
 
        <replaceable>NAME</replaceable></option></arg>
116
 
        <arg choice="plain"><option>-n
117
 
        <replaceable>NAME</replaceable></option></arg>
118
 
      </group>
119
 
      <sbr/>
120
 
      <group>
121
 
        <arg choice="plain"><option>--email
122
 
        <replaceable>ADDRESS</replaceable></option></arg>
123
 
        <arg choice="plain"><option>-e
124
 
        <replaceable>ADDRESS</replaceable></option></arg>
125
 
      </group>
126
 
      <sbr/>
127
 
      <group>
128
 
        <arg choice="plain"><option>--comment
129
 
        <replaceable>TEXT</replaceable></option></arg>
130
 
        <arg choice="plain"><option>-c
131
 
        <replaceable>TEXT</replaceable></option></arg>
132
 
      </group>
133
 
      <sbr/>
134
 
      <group>
135
 
        <arg choice="plain"><option>--expire
136
 
        <replaceable>TIME</replaceable></option></arg>
137
 
        <arg choice="plain"><option>-x
138
 
        <replaceable>TIME</replaceable></option></arg>
139
 
      </group>
140
 
      <sbr/>
141
 
      <arg><option>--force</option></arg>
142
 
    </cmdsynopsis>
143
 
    <cmdsynopsis>
144
 
      <command>&COMMANDNAME;</command>
145
 
      <group choice="req">
146
 
        <arg choice="plain"><option>-p</option></arg>
147
 
        <arg choice="plain"><option>--password</option></arg>
148
 
      </group>
149
 
      <sbr/>
150
 
      <group>
151
 
        <arg choice="plain"><option>--dir
152
 
        <replaceable>DIRECTORY</replaceable></option></arg>
153
 
        <arg choice="plain"><option>-d
154
 
        <replaceable>DIRECTORY</replaceable></option></arg>
155
 
      </group>
156
 
      <sbr/>
157
 
      <group>
158
 
        <arg choice="plain"><option>--name
159
 
        <replaceable>NAME</replaceable></option></arg>
160
 
        <arg choice="plain"><option>-n
161
 
        <replaceable>NAME</replaceable></option></arg>
162
 
      </group>
163
 
    </cmdsynopsis>
164
 
    <cmdsynopsis>
165
 
      <command>&COMMANDNAME;</command>
166
 
      <group choice="req">
167
 
        <arg choice="plain"><option>-h</option></arg>
168
 
        <arg choice="plain"><option>--help</option></arg>
169
 
      </group>
170
 
    </cmdsynopsis>
171
 
    <cmdsynopsis>
172
 
      <command>&COMMANDNAME;</command>
173
 
      <group choice="req">
174
 
        <arg choice="plain"><option>-v</option></arg>
175
 
        <arg choice="plain"><option>--version</option></arg>
 
76
      <group choice="opt">
 
77
        <arg choice="plain"><option>--dir</option>
 
78
        <replaceable>directory</replaceable></arg>
 
79
      </group>
 
80
      <group choice="opt">
 
81
        <arg choice="plain"><option>--type</option>
 
82
        <replaceable>type</replaceable></arg>
 
83
      </group>
 
84
      <group choice="opt">
 
85
        <arg choice="plain"><option>--length</option>
 
86
        <replaceable>bits</replaceable></arg>
 
87
      </group>
 
88
      <group choice="opt">
 
89
        <arg choice="plain"><option>--name</option>
 
90
        <replaceable>NAME</replaceable></arg>
 
91
      </group>
 
92
      <group choice="opt">
 
93
        <arg choice="plain"><option>--email</option>
 
94
        <replaceable>EMAIL</replaceable></arg>
 
95
      </group>
 
96
      <group choice="opt">
 
97
        <arg choice="plain"><option>--comment</option>
 
98
        <replaceable>COMMENT</replaceable></arg>
 
99
      </group>
 
100
      <group choice="opt">
 
101
        <arg choice="plain"><option>--expire</option>
 
102
        <replaceable>TIME</replaceable></arg>
 
103
      </group>
 
104
      <group choice="opt">
 
105
        <arg choice="plain"><option>--force</option></arg>
 
106
      </group>
 
107
    </cmdsynopsis>
 
108
    <cmdsynopsis>
 
109
      <command>&COMMANDNAME;</command>
 
110
      <group choice="opt">
 
111
        <arg choice="plain"><option>-d</option>
 
112
        <replaceable>directory</replaceable></arg>
 
113
      </group>
 
114
      <group choice="opt">
 
115
        <arg choice="plain"><option>-t</option>
 
116
        <replaceable>type</replaceable></arg>
 
117
      </group>
 
118
      <group choice="opt">
 
119
        <arg choice="plain"><option>-l</option>
 
120
        <replaceable>bits</replaceable></arg>
 
121
      </group>
 
122
      <group choice="opt">
 
123
        <arg choice="plain"><option>-n</option>
 
124
        <replaceable>NAME</replaceable></arg>
 
125
      </group>
 
126
      <group choice="opt">
 
127
        <arg choice="plain"><option>-e</option>
 
128
        <replaceable>EMAIL</replaceable></arg>
 
129
      </group>
 
130
      <group choice="opt">
 
131
        <arg choice="plain"><option>-c</option>
 
132
        <replaceable>COMMENT</replaceable></arg>
 
133
      </group>
 
134
      <group choice="opt">
 
135
        <arg choice="plain"><option>-x</option>
 
136
        <replaceable>TIME</replaceable></arg>
 
137
      </group>
 
138
      <group choice="opt">
 
139
        <arg choice="plain"><option>-f</option></arg>
 
140
      </group>
 
141
    </cmdsynopsis>
 
142
    <cmdsynopsis>
 
143
      <command>&COMMANDNAME;</command>
 
144
      <group choice="req">
 
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>
176
154
      </group>
177
155
    </cmdsynopsis>
178
156
  </refsynopsisdiv>
188
166
      initrd image, but this, like most things, can be changed with
189
167
      command line options.
190
168
    </para>
191
 
    <para>
192
 
      It can also be used to generate ready-made sections for
193
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
194
 
      <manvolnum>5</manvolnum></citerefentry> using the
195
 
      <option>--password</option> option.
196
 
    </para>
197
169
  </refsect1>
198
170
  
199
171
  <refsect1 id="purpose">
226
198
        <replaceable>directory</replaceable></literal></term>
227
199
        <listitem>
228
200
          <para>
229
 
            Target directory for key files.  Default is
230
 
            <filename>/etc/mandos</filename>.
 
201
            Target directory for key files.
231
202
          </para>
232
203
        </listitem>
233
204
      </varlistentry>
237
208
        <replaceable>type</replaceable></literal></term>
238
209
        <listitem>
239
210
          <para>
240
 
            Key type.  Default is <quote>DSA</quote>.
 
211
            Key type.  Default is DSA.
241
212
          </para>
242
213
        </listitem>
243
214
      </varlistentry>
247
218
        <replaceable>bits</replaceable></literal></term>
248
219
        <listitem>
249
220
          <para>
250
 
            Key length in bits.  Default is 2048.
251
 
          </para>
252
 
        </listitem>
253
 
      </varlistentry>
254
 
 
255
 
      <varlistentry>
256
 
        <term><literal>-s</literal>, <literal>--subtype
257
 
        <replaceable>type</replaceable></literal></term>
258
 
        <listitem>
259
 
          <para>
260
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
261
 
            encryption-only).
262
 
          </para>
263
 
        </listitem>
264
 
      </varlistentry>
265
 
 
266
 
      <varlistentry>
267
 
        <term><literal>-L</literal>, <literal>--sublength
268
 
        <replaceable>bits</replaceable></literal></term>
269
 
        <listitem>
270
 
          <para>
271
 
            Subkey length in bits.  Default is 2048.
 
221
            Key length in bits.  Default is 1024.
272
222
          </para>
273
223
        </listitem>
274
224
      </varlistentry>
289
239
        <listitem>
290
240
          <para>
291
241
            Comment field for key.  The default value is
292
 
            <quote><literal>Mandos client key</literal></quote>.
 
242
            "<literal>Mandos client key</literal>".
293
243
          </para>
294
244
        </listitem>
295
245
      </varlistentry>
314
264
          </para>
315
265
        </listitem>
316
266
      </varlistentry>
317
 
      <varlistentry>
318
 
        <term><literal>-p</literal>, <literal>--password</literal
319
 
        ></term>
320
 
        <listitem>
321
 
          <para>
322
 
            Prompt for a password and encrypt it with the key already
323
 
            present in either <filename>/etc/mandos</filename> or the
324
 
            directory specified with the <option>--dir</option>
325
 
            option.  Outputs, on standard output, a section suitable
326
 
            for inclusion in <citerefentry><refentrytitle
327
 
            >mandos-clients.conf</refentrytitle><manvolnum
328
 
            >8</manvolnum></citerefentry>.  The host name or the name
329
 
            specified with the <option>--name</option> option is used
330
 
            for the section header.  All other options are ignored,
331
 
            and no keys are created.
332
 
          </para>
333
 
        </listitem>
334
 
      </varlistentry>
335
267
    </variablelist>
336
268
  </refsect1>
337
269
 
338
270
  <refsect1 id="overview">
339
271
    <title>OVERVIEW</title>
340
 
    <xi:include href="overview.xml"/>
 
272
    &OVERVIEW;
341
273
    <para>
342
 
      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
343
275
      new Mandos clients.
344
276
    </para>
345
277
  </refsect1>
356
288
    <title>ENVIRONMENT</title>
357
289
    <variablelist>
358
290
      <varlistentry>
359
 
        <term><envar>TMPDIR</envar></term>
 
291
        <term><varname>TMPDIR</varname></term>
360
292
        <listitem>
361
293
          <para>
362
294
            If set, temporary files will be created here. See
420
352
        Normal invocation needs no options:
421
353
      </para>
422
354
      <para>
423
 
        <userinput>&COMMANDNAME;</userinput>
 
355
        <userinput>mandos-keygen</userinput>
424
356
      </para>
425
357
    </informalexample>
426
358
    <informalexample>
431
363
      <para>
432
364
 
433
365
<!-- do not wrap this line -->
434
 
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
 
366
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
435
367
 
436
368
      </para>
437
369
    </informalexample>
440
372
  <refsect1 id="security">
441
373
    <title>SECURITY</title>
442
374
    <para>
443
 
      The <option>--type</option>, <option>--length</option>,
444
 
      <option>--subtype</option>, and <option>--sublength</option>
 
375
      The <option>--type</option> and <option>--length</option>
445
376
      options can be used to create keys of insufficient security.  If
446
377
      in doubt, leave them to the default values.
447
378
    </para>
455
386
  <refsect1 id="see_also">
456
387
    <title>SEE ALSO</title>
457
388
    <para>
 
389
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
390
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
391
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
392
      <manvolnum>8</manvolnum></citerefentry>, and
458
393
      <citerefentry><refentrytitle>gpg</refentrytitle>
459
 
      <manvolnum>1</manvolnum></citerefentry>,
460
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
461
 
      <manvolnum>8</manvolnum></citerefentry>,
462
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
463
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
394
      <manvolnum>1</manvolnum></citerefentry>
464
395
    </para>
465
396
  </refsect1>
466
397
  
467
398
</refentry>
468
 
<!-- Local Variables: -->
469
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
470
 
<!-- time-stamp-end: "[\"']>" -->
471
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
472
 
<!-- End: -->