/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-24 07:42:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824074214-odju7g3115le171c
* mandos-keygen: Bug fix: Recognize new options --subtype and
                 --sublength.  New option "--password" which prompts
                 for and encrypts a password with an already existing
                 key.

* mandos-keygen.xml (SYNOPSIS): Added separate synopsis for
                                "--password" option.
  (DESCRIPTION): Added text about password creation.
  (OPTIONS): Document default value for "--dir" option.  Document new
             "--password" option.

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 OVERVIEW SYSTEM "overview.xml">
7
6
]>
8
7
 
9
 
<refentry>
 
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
9
  <refentryinfo>
11
10
    <title>&COMMANDNAME;</title>
12
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
12
    <productname>&COMMANDNAME;</productname>
14
13
    <productnumber>&VERSION;</productnumber>
15
14
    <authorgroup>
30
29
    </authorgroup>
31
30
    <copyright>
32
31
      <year>2008</year>
33
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
32
      <holder>Teddy Hogeborn</holder>
 
33
      <holder>Björn Påhlsson</holder>
34
34
    </copyright>
35
35
    <legalnotice>
36
36
      <para>
86
86
        <replaceable>bits</replaceable></arg>
87
87
      </group>
88
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">
89
97
        <arg choice="plain"><option>--name</option>
90
98
        <replaceable>NAME</replaceable></arg>
91
99
      </group>
120
128
        <replaceable>bits</replaceable></arg>
121
129
      </group>
122
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">
123
139
        <arg choice="plain"><option>-n</option>
124
140
        <replaceable>NAME</replaceable></arg>
125
141
      </group>
142
158
    <cmdsynopsis>
143
159
      <command>&COMMANDNAME;</command>
144
160
      <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>
 
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>
154
185
      </group>
155
186
    </cmdsynopsis>
156
187
  </refsynopsisdiv>
166
197
      initrd image, but this, like most things, can be changed with
167
198
      command line options.
168
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>
169
206
  </refsect1>
170
207
  
171
208
  <refsect1 id="purpose">
198
235
        <replaceable>directory</replaceable></literal></term>
199
236
        <listitem>
200
237
          <para>
201
 
            Target directory for key files.
 
238
            Target directory for key files.  Default is
 
239
            <filename>/etc/mandos</filename>.
202
240
          </para>
203
241
        </listitem>
204
242
      </varlistentry>
208
246
        <replaceable>type</replaceable></literal></term>
209
247
        <listitem>
210
248
          <para>
211
 
            Key type.  Default is DSA.
 
249
            Key type.  Default is <quote>DSA</quote>.
212
250
          </para>
213
251
        </listitem>
214
252
      </varlistentry>
224
262
      </varlistentry>
225
263
 
226
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.
 
281
          </para>
 
282
        </listitem>
 
283
      </varlistentry>
 
284
 
 
285
      <varlistentry>
227
286
        <term><literal>-e</literal>, <literal>--email</literal>
228
287
        <replaceable>address</replaceable></term>
229
288
        <listitem>
239
298
        <listitem>
240
299
          <para>
241
300
            Comment field for key.  The default value is
242
 
            "<literal>Mandos client key</literal>".
 
301
            <quote><literal>Mandos client key</literal></quote>.
243
302
          </para>
244
303
        </listitem>
245
304
      </varlistentry>
264
323
          </para>
265
324
        </listitem>
266
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>
267
344
    </variablelist>
268
345
  </refsect1>
269
346
 
270
347
  <refsect1 id="overview">
271
348
    <title>OVERVIEW</title>
272
 
    &OVERVIEW;
 
349
    <xi:include href="overview.xml"/>
273
350
    <para>
274
 
      This program is a small program to generate new OpenPGP keys for
 
351
      This program is a small utility to generate new OpenPGP keys for
275
352
      new Mandos clients.
276
353
    </para>
277
354
  </refsect1>
372
449
  <refsect1 id="security">
373
450
    <title>SECURITY</title>
374
451
    <para>
375
 
      The <option>--type</option> and <option>--length</option>
 
452
      The <option>--type</option>, <option>--length</option>,
 
453
      <option>--subtype</option>, and <option>--sublength</option>
376
454
      options can be used to create keys of insufficient security.  If
377
455
      in doubt, leave them to the default values.
378
456
    </para>
389
467
      <citerefentry><refentrytitle>password-request</refentrytitle>
390
468
      <manvolnum>8mandos</manvolnum></citerefentry>,
391
469
      <citerefentry><refentrytitle>mandos</refentrytitle>
392
 
      <manvolnum>8</manvolnum></citerefentry>, and
 
470
      <manvolnum>8</manvolnum></citerefentry>,
393
471
      <citerefentry><refentrytitle>gpg</refentrytitle>
394
472
      <manvolnum>1</manvolnum></citerefentry>
395
473
    </para>