/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-23 07:17:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080823071728-wo1k2mtbje5910np
* Makefile (MANPOST): Bug fix: corrected patterns.

* mandos-options.xml: Bug fix: also change root node tag name in
                      DOCTYPE declaration.
  (interface, address): Improved wording.

* overview.xml: Changed "host computer" to "computer".

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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2016-03-05">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
6
]>
9
7
 
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
9
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
10
    <title>&COMMANDNAME;</title>
 
11
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
12
    <productname>&COMMANDNAME;</productname>
 
13
    <productnumber>&VERSION;</productnumber>
17
14
    <authorgroup>
18
15
      <author>
19
16
        <firstname>Björn</firstname>
20
17
        <surname>Påhlsson</surname>
21
18
        <address>
22
 
          <email>belorn@recompile.se</email>
 
19
          <email>belorn@fukt.bsnet.se</email>
23
20
        </address>
24
21
      </author>
25
22
      <author>
26
23
        <firstname>Teddy</firstname>
27
24
        <surname>Hogeborn</surname>
28
25
        <address>
29
 
          <email>teddy@recompile.se</email>
 
26
          <email>teddy@fukt.bsnet.se</email>
30
27
        </address>
31
28
      </author>
32
29
    </authorgroup>
33
30
    <copyright>
34
31
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <holder>Teddy Hogeborn</holder>
44
 
      <holder>Björn Påhlsson</holder>
 
32
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
45
33
    </copyright>
46
 
    <xi:include href="legalnotice.xml"/>
 
34
    <legalnotice>
 
35
      <para>
 
36
        This manual page is free software: you can redistribute it
 
37
        and/or modify it under the terms of the GNU General Public
 
38
        License as published by the Free Software Foundation,
 
39
        either version 3 of the License, or (at your option) any
 
40
        later version.
 
41
      </para>
 
42
 
 
43
      <para>
 
44
        This manual page is distributed in the hope that it will
 
45
        be useful, but WITHOUT ANY WARRANTY; without even the
 
46
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
47
        PARTICULAR PURPOSE.  See the GNU General Public License
 
48
        for more details.
 
49
      </para>
 
50
 
 
51
      <para>
 
52
        You should have received a copy of the GNU General Public
 
53
        License along with this program; If not, see
 
54
        <ulink url="http://www.gnu.org/licenses/"/>.
 
55
      </para>
 
56
    </legalnotice>
47
57
  </refentryinfo>
48
 
  
 
58
 
49
59
  <refmeta>
50
60
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
61
    <manvolnum>8</manvolnum>
54
64
  <refnamediv>
55
65
    <refname><command>&COMMANDNAME;</command></refname>
56
66
    <refpurpose>
57
 
      Generate key and password for Mandos client and server.
 
67
      Generate keys for <citerefentry><refentrytitle>password-request
 
68
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
58
69
    </refpurpose>
59
70
  </refnamediv>
60
 
  
 
71
 
61
72
  <refsynopsisdiv>
62
73
    <cmdsynopsis>
63
74
      <command>&COMMANDNAME;</command>
64
 
      <group>
65
 
        <arg choice="plain"><option>--dir
66
 
        <replaceable>DIRECTORY</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-d
68
 
        <replaceable>DIRECTORY</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--type
73
 
        <replaceable>KEYTYPE</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-t
75
 
        <replaceable>KEYTYPE</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <group>
79
 
        <arg choice="plain"><option>--length
80
 
        <replaceable>BITS</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-l
82
 
        <replaceable>BITS</replaceable></option></arg>
83
 
      </group>
84
 
      <sbr/>
85
 
      <group>
86
 
        <arg choice="plain"><option>--subtype
87
 
        <replaceable>KEYTYPE</replaceable></option></arg>
88
 
        <arg choice="plain"><option>-s
89
 
        <replaceable>KEYTYPE</replaceable></option></arg>
90
 
      </group>
91
 
      <sbr/>
92
 
      <group>
93
 
        <arg choice="plain"><option>--sublength
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>--name
101
 
        <replaceable>NAME</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-n
103
 
        <replaceable>NAME</replaceable></option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group>
107
 
        <arg choice="plain"><option>--email
108
 
        <replaceable>ADDRESS</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-e
110
 
        <replaceable>ADDRESS</replaceable></option></arg>
111
 
      </group>
112
 
      <sbr/>
113
 
      <group>
114
 
        <arg choice="plain"><option>--comment
115
 
        <replaceable>TEXT</replaceable></option></arg>
116
 
        <arg choice="plain"><option>-c
117
 
        <replaceable>TEXT</replaceable></option></arg>
118
 
      </group>
119
 
      <sbr/>
120
 
      <group>
121
 
        <arg choice="plain"><option>--expire
122
 
        <replaceable>TIME</replaceable></option></arg>
123
 
        <arg choice="plain"><option>-x
124
 
        <replaceable>TIME</replaceable></option></arg>
125
 
      </group>
126
 
      <sbr/>
127
 
      <group>
 
75
      <group choice="opt">
 
76
        <arg choice="plain"><option>--dir</option>
 
77
        <replaceable>directory</replaceable></arg>
 
78
      </group>
 
79
      <group choice="opt">
 
80
        <arg choice="plain"><option>--type</option>
 
81
        <replaceable>type</replaceable></arg>
 
82
      </group>
 
83
      <group choice="opt">
 
84
        <arg choice="plain"><option>--length</option>
 
85
        <replaceable>bits</replaceable></arg>
 
86
      </group>
 
87
      <group choice="opt">
 
88
        <arg choice="plain"><option>--name</option>
 
89
        <replaceable>NAME</replaceable></arg>
 
90
      </group>
 
91
      <group choice="opt">
 
92
        <arg choice="plain"><option>--email</option>
 
93
        <replaceable>EMAIL</replaceable></arg>
 
94
      </group>
 
95
      <group choice="opt">
 
96
        <arg choice="plain"><option>--comment</option>
 
97
        <replaceable>COMMENT</replaceable></arg>
 
98
      </group>
 
99
      <group choice="opt">
 
100
        <arg choice="plain"><option>--expire</option>
 
101
        <replaceable>TIME</replaceable></arg>
 
102
      </group>
 
103
      <group choice="opt">
128
104
        <arg choice="plain"><option>--force</option></arg>
 
105
      </group>
 
106
    </cmdsynopsis>
 
107
    <cmdsynopsis>
 
108
      <command>&COMMANDNAME;</command>
 
109
      <group choice="opt">
 
110
        <arg choice="plain"><option>-d</option>
 
111
        <replaceable>directory</replaceable></arg>
 
112
      </group>
 
113
      <group choice="opt">
 
114
        <arg choice="plain"><option>-t</option>
 
115
        <replaceable>type</replaceable></arg>
 
116
      </group>
 
117
      <group choice="opt">
 
118
        <arg choice="plain"><option>-l</option>
 
119
        <replaceable>bits</replaceable></arg>
 
120
      </group>
 
121
      <group choice="opt">
 
122
        <arg choice="plain"><option>-n</option>
 
123
        <replaceable>NAME</replaceable></arg>
 
124
      </group>
 
125
      <group choice="opt">
 
126
        <arg choice="plain"><option>-e</option>
 
127
        <replaceable>EMAIL</replaceable></arg>
 
128
      </group>
 
129
      <group choice="opt">
 
130
        <arg choice="plain"><option>-c</option>
 
131
        <replaceable>COMMENT</replaceable></arg>
 
132
      </group>
 
133
      <group choice="opt">
 
134
        <arg choice="plain"><option>-x</option>
 
135
        <replaceable>TIME</replaceable></arg>
 
136
      </group>
 
137
      <group choice="opt">
129
138
        <arg choice="plain"><option>-f</option></arg>
130
139
      </group>
131
140
    </cmdsynopsis>
132
141
    <cmdsynopsis>
133
142
      <command>&COMMANDNAME;</command>
134
143
      <group choice="req">
135
 
        <arg choice="plain"><option>--password</option></arg>
136
 
        <arg choice="plain"><option>-p</option></arg>
137
 
        <arg choice="plain"><option>--passfile
138
 
        <replaceable>FILE</replaceable></option></arg>
139
 
        <arg choice="plain"><option>-F</option>
140
 
        <replaceable>FILE</replaceable></arg>
141
 
      </group>
142
 
      <sbr/>
143
 
      <group>
144
 
        <arg choice="plain"><option>--dir
145
 
        <replaceable>DIRECTORY</replaceable></option></arg>
146
 
        <arg choice="plain"><option>-d
147
 
        <replaceable>DIRECTORY</replaceable></option></arg>
148
 
      </group>
149
 
      <sbr/>
150
 
      <group>
151
 
        <arg choice="plain"><option>--name
152
 
        <replaceable>NAME</replaceable></option></arg>
153
 
        <arg choice="plain"><option>-n
154
 
        <replaceable>NAME</replaceable></option></arg>
155
 
      </group>
156
 
      <group>
157
 
        <arg choice="plain"><option>--no-ssh</option></arg>
158
 
        <arg choice="plain"><option>-S</option></arg>
159
 
      </group>
160
 
    </cmdsynopsis>
161
 
    <cmdsynopsis>
162
 
      <command>&COMMANDNAME;</command>
163
 
      <group choice="req">
164
 
        <arg choice="plain"><option>--help</option></arg>
165
 
        <arg choice="plain"><option>-h</option></arg>
166
 
      </group>
167
 
    </cmdsynopsis>
168
 
    <cmdsynopsis>
169
 
      <command>&COMMANDNAME;</command>
170
 
      <group choice="req">
171
 
        <arg choice="plain"><option>--version</option></arg>
172
 
        <arg choice="plain"><option>-v</option></arg>
 
144
        <arg choice='plain'><option>-h</option></arg>
 
145
        <arg choice='plain'><option>--help</option></arg>
 
146
      </group>
 
147
    </cmdsynopsis>
 
148
    <cmdsynopsis>
 
149
      <command>&COMMANDNAME;</command>
 
150
      <group choice="req">
 
151
        <arg choice='plain'><option>-v</option></arg>
 
152
        <arg choice='plain'><option>--version</option></arg>
173
153
      </group>
174
154
    </cmdsynopsis>
175
155
  </refsynopsisdiv>
176
 
  
 
156
 
177
157
  <refsect1 id="description">
178
158
    <title>DESCRIPTION</title>
179
159
    <para>
180
160
      <command>&COMMANDNAME;</command> is a program to generate the
181
 
      OpenPGP key used by
182
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
183
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
161
      OpenPGP keys used by
 
162
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
163
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
184
164
      normally written to /etc/mandos for later installation into the
185
 
      initrd image, but this, and most other things, can be changed
186
 
      with command line options.
187
 
    </para>
188
 
    <para>
189
 
      This program can also be used with the
190
 
      <option>--password</option> or <option>--passfile</option>
191
 
      options to generate a ready-made section for
192
 
      <filename>clients.conf</filename> (see
193
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
194
 
      <manvolnum>5</manvolnum></citerefentry>).
 
165
      initrd image, but this, like most things, can be changed with
 
166
      command line options.
195
167
    </para>
196
168
  </refsect1>
197
169
  
198
170
  <refsect1 id="purpose">
199
171
    <title>PURPOSE</title>
 
172
 
200
173
    <para>
201
174
      The purpose of this is to enable <emphasis>remote and unattended
202
175
      rebooting</emphasis> of client host computer with an
203
176
      <emphasis>encrypted root file system</emphasis>.  See <xref
204
177
      linkend="overview"/> for details.
205
178
    </para>
 
179
 
206
180
  </refsect1>
207
181
  
208
182
  <refsect1 id="options">
209
183
    <title>OPTIONS</title>
210
 
    
 
184
 
211
185
    <variablelist>
212
186
      <varlistentry>
213
 
        <term><option>--help</option></term>
214
 
        <term><option>-h</option></term>
 
187
        <term><literal>-h</literal>, <literal>--help</literal></term>
215
188
        <listitem>
216
189
          <para>
217
190
            Show a help message and exit
218
191
          </para>
219
192
        </listitem>
220
193
      </varlistentry>
221
 
      
222
 
      <varlistentry>
223
 
        <term><option>--dir
224
 
        <replaceable>DIRECTORY</replaceable></option></term>
225
 
        <term><option>-d
226
 
        <replaceable>DIRECTORY</replaceable></option></term>
227
 
        <listitem>
228
 
          <para>
229
 
            Target directory for key files.  Default is
230
 
            <filename class="directory">/etc/mandos</filename>.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--type
237
 
        <replaceable>TYPE</replaceable></option></term>
238
 
        <term><option>-t
239
 
        <replaceable>TYPE</replaceable></option></term>
240
 
        <listitem>
241
 
          <para>
242
 
            Key type.  Default is <quote>RSA</quote>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--length
249
 
        <replaceable>BITS</replaceable></option></term>
250
 
        <term><option>-l
251
 
        <replaceable>BITS</replaceable></option></term>
252
 
        <listitem>
253
 
          <para>
254
 
            Key length in bits.  Default is 4096.
255
 
          </para>
256
 
        </listitem>
257
 
      </varlistentry>
258
 
      
259
 
      <varlistentry>
260
 
        <term><option>--subtype
261
 
        <replaceable>KEYTYPE</replaceable></option></term>
262
 
        <term><option>-s
263
 
        <replaceable>KEYTYPE</replaceable></option></term>
264
 
        <listitem>
265
 
          <para>
266
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
267
 
            encryption-only).
268
 
          </para>
269
 
        </listitem>
270
 
      </varlistentry>
271
 
      
272
 
      <varlistentry>
273
 
        <term><option>--sublength
274
 
        <replaceable>BITS</replaceable></option></term>
275
 
        <term><option>-L
276
 
        <replaceable>BITS</replaceable></option></term>
277
 
        <listitem>
278
 
          <para>
279
 
            Subkey length in bits.  Default is 4096.
280
 
          </para>
281
 
        </listitem>
282
 
      </varlistentry>
283
 
      
284
 
      <varlistentry>
285
 
        <term><option>--email
286
 
        <replaceable>ADDRESS</replaceable></option></term>
287
 
        <term><option>-e
288
 
        <replaceable>ADDRESS</replaceable></option></term>
 
194
 
 
195
      <varlistentry>
 
196
        <term><literal>-d</literal>, <literal>--dir
 
197
        <replaceable>directory</replaceable></literal></term>
 
198
        <listitem>
 
199
          <para>
 
200
            Target directory for key files.
 
201
          </para>
 
202
        </listitem>
 
203
      </varlistentry>
 
204
 
 
205
      <varlistentry>
 
206
        <term><literal>-t</literal>, <literal>--type
 
207
        <replaceable>type</replaceable></literal></term>
 
208
        <listitem>
 
209
          <para>
 
210
            Key type.  Default is DSA.
 
211
          </para>
 
212
        </listitem>
 
213
      </varlistentry>
 
214
 
 
215
      <varlistentry>
 
216
        <term><literal>-l</literal>, <literal>--length
 
217
        <replaceable>bits</replaceable></literal></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Key length in bits.  Default is 1024.
 
221
          </para>
 
222
        </listitem>
 
223
      </varlistentry>
 
224
 
 
225
      <varlistentry>
 
226
        <term><literal>-e</literal>, <literal>--email</literal>
 
227
        <replaceable>address</replaceable></term>
289
228
        <listitem>
290
229
          <para>
291
230
            Email address of key.  Default is empty.
292
231
          </para>
293
232
        </listitem>
294
233
      </varlistentry>
295
 
      
 
234
 
296
235
      <varlistentry>
297
 
        <term><option>--comment
298
 
        <replaceable>TEXT</replaceable></option></term>
299
 
        <term><option>-c
300
 
        <replaceable>TEXT</replaceable></option></term>
 
236
        <term><literal>-c</literal>, <literal>--comment</literal>
 
237
        <replaceable>comment</replaceable></term>
301
238
        <listitem>
302
239
          <para>
303
 
            Comment field for key.  Default is empty.
 
240
            Comment field for key.  The default value is
 
241
            "<literal>Mandos client key</literal>".
304
242
          </para>
305
243
        </listitem>
306
244
      </varlistentry>
307
 
      
 
245
 
308
246
      <varlistentry>
309
 
        <term><option>--expire
310
 
        <replaceable>TIME</replaceable></option></term>
311
 
        <term><option>-x
312
 
        <replaceable>TIME</replaceable></option></term>
 
247
        <term><literal>-x</literal>, <literal>--expire</literal>
 
248
        <replaceable>time</replaceable></term>
313
249
        <listitem>
314
250
          <para>
315
251
            Key expire time.  Default is no expiration.  See
318
254
          </para>
319
255
        </listitem>
320
256
      </varlistentry>
321
 
      
322
 
      <varlistentry>
323
 
        <term><option>--force</option></term>
324
 
        <term><option>-f</option></term>
325
 
        <listitem>
326
 
          <para>
327
 
            Force overwriting old key.
328
 
          </para>
329
 
        </listitem>
330
 
      </varlistentry>
331
 
      <varlistentry>
332
 
        <term><option>--password</option></term>
333
 
        <term><option>-p</option></term>
334
 
        <listitem>
335
 
          <para>
336
 
            Prompt for a password and encrypt it with the key already
337
 
            present in either <filename>/etc/mandos</filename> or the
338
 
            directory specified with the <option>--dir</option>
339
 
            option.  Outputs, on standard output, a section suitable
340
 
            for inclusion in <citerefentry><refentrytitle
341
 
            >mandos-clients.conf</refentrytitle><manvolnum
342
 
            >8</manvolnum></citerefentry>.  The host name or the name
343
 
            specified with the <option>--name</option> option is used
344
 
            for the section header.  All other options are ignored,
345
 
            and no key is created.
346
 
          </para>
347
 
        </listitem>
348
 
      </varlistentry>
349
 
      <varlistentry>
350
 
        <term><option>--passfile
351
 
        <replaceable>FILE</replaceable></option></term>
352
 
        <term><option>-F
353
 
        <replaceable>FILE</replaceable></option></term>
354
 
        <listitem>
355
 
          <para>
356
 
            The same as <option>--password</option>, but read from
357
 
            <replaceable>FILE</replaceable>, not the terminal.
358
 
          </para>
359
 
        </listitem>
360
 
      </varlistentry>
361
 
      <varlistentry>
362
 
        <term><option>--no-ssh</option></term>
363
 
        <term><option>-S</option></term>
364
 
        <listitem>
365
 
          <para>
366
 
            When <option>--password</option> or
367
 
            <option>--passfile</option> is given, this option will
368
 
            prevent <command>&COMMANDNAME;</command> from calling
369
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
370
 
            for this host and, if successful, output suitable config
371
 
            options to use this fingerprint as a
372
 
            <option>checker</option> option in the output.  This is
373
 
            otherwise the default behavior.
 
257
 
 
258
      <varlistentry>
 
259
        <term><literal>-f</literal>, <literal>--force</literal></term>
 
260
        <listitem>
 
261
          <para>
 
262
            Force overwriting old keys.
374
263
          </para>
375
264
        </listitem>
376
265
      </varlistentry>
377
266
    </variablelist>
378
267
  </refsect1>
379
 
  
 
268
 
380
269
  <refsect1 id="overview">
381
270
    <title>OVERVIEW</title>
382
271
    <xi:include href="overview.xml"/>
383
272
    <para>
384
 
      This program is a small utility to generate new OpenPGP keys for
385
 
      new Mandos clients, and to generate sections for inclusion in
386
 
      <filename>clients.conf</filename> on the server.
 
273
      This program is a small program to generate new OpenPGP keys for
 
274
      new Mandos clients.
387
275
    </para>
388
276
  </refsect1>
389
 
  
 
277
 
390
278
  <refsect1 id="exit_status">
391
279
    <title>EXIT STATUS</title>
392
280
    <para>
393
 
      The exit status will be 0 if a new key (or password, if the
394
 
      <option>--password</option> option was used) was successfully
395
 
      created, otherwise not.
 
281
      The exit status will be 0 if new keys were successfully created,
 
282
      otherwise not.
396
283
    </para>
397
284
  </refsect1>
398
285
  
400
287
    <title>ENVIRONMENT</title>
401
288
    <variablelist>
402
289
      <varlistentry>
403
 
        <term><envar>TMPDIR</envar></term>
 
290
        <term><varname>TMPDIR</varname></term>
404
291
        <listitem>
405
292
          <para>
406
293
            If set, temporary files will be created here. See
412
299
    </variablelist>
413
300
  </refsect1>
414
301
  
415
 
  <refsect1 id="files">
 
302
  <refsect1 id="file">
416
303
    <title>FILES</title>
417
304
    <para>
418
305
      Use the <option>--dir</option> option to change where
439
326
        </listitem>
440
327
      </varlistentry>
441
328
      <varlistentry>
442
 
        <term><filename class="directory">/tmp</filename></term>
 
329
        <term><filename>/tmp</filename></term>
443
330
        <listitem>
444
331
          <para>
445
332
            Temporary files will be written here if
449
336
      </varlistentry>
450
337
    </variablelist>
451
338
  </refsect1>
452
 
  
 
339
 
453
340
  <refsect1 id="bugs">
454
341
    <title>BUGS</title>
455
 
    <xi:include href="bugs.xml"/>
 
342
    <para>
 
343
      None are known at this time.
 
344
    </para>
456
345
  </refsect1>
457
 
  
 
346
 
458
347
  <refsect1 id="example">
459
348
    <title>EXAMPLE</title>
460
349
    <informalexample>
462
351
        Normal invocation needs no options:
463
352
      </para>
464
353
      <para>
465
 
        <userinput>&COMMANDNAME;</userinput>
 
354
        <userinput>mandos-keygen</userinput>
466
355
      </para>
467
356
    </informalexample>
468
357
    <informalexample>
469
358
      <para>
470
 
        Create key in another directory and of another type.  Force
 
359
        Create keys in another directory and of another type.  Force
471
360
        overwriting old key files:
472
361
      </para>
473
362
      <para>
474
363
 
475
364
<!-- do not wrap this line -->
476
 
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
477
 
 
478
 
      </para>
479
 
    </informalexample>
480
 
    <informalexample>
481
 
      <para>
482
 
        Prompt for a password, encrypt it with the key in <filename
483
 
        class="directory">/etc/mandos</filename> and output a section
484
 
        suitable for <filename>clients.conf</filename>.
485
 
      </para>
486
 
      <para>
487
 
        <userinput>&COMMANDNAME; --password</userinput>
488
 
      </para>
489
 
    </informalexample>
490
 
    <informalexample>
491
 
      <para>
492
 
        Prompt for a password, encrypt it with the key in the
493
 
        <filename>client-key</filename> directory and output a section
494
 
        suitable for <filename>clients.conf</filename>.
495
 
      </para>
496
 
      <para>
497
 
 
498
 
<!-- do not wrap this line -->
499
 
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
 
365
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
500
366
 
501
367
      </para>
502
368
    </informalexample>
503
369
  </refsect1>
504
 
  
 
370
 
505
371
  <refsect1 id="security">
506
372
    <title>SECURITY</title>
507
373
    <para>
508
 
      The <option>--type</option>, <option>--length</option>,
509
 
      <option>--subtype</option>, and <option>--sublength</option>
510
 
      options can be used to create keys of low security.  If in
511
 
      doubt, leave them to the default values.
 
374
      The <option>--type</option> and <option>--length</option>
 
375
      options can be used to create keys of insufficient security.  If
 
376
      in doubt, leave them to the default values.
512
377
    </para>
513
378
    <para>
514
 
      The key expire time is <emphasis>not</emphasis> guaranteed to be
515
 
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
 
379
      The key expire time is not guaranteed to be honored by
 
380
      <citerefentry><refentrytitle>mandos</refentrytitle>
516
381
      <manvolnum>8</manvolnum></citerefentry>.
517
382
    </para>
518
383
  </refsect1>
519
 
  
 
384
 
520
385
  <refsect1 id="see_also">
521
386
    <title>SEE ALSO</title>
522
387
    <para>
523
 
      <citerefentry><refentrytitle>intro</refentrytitle>
 
388
      <citerefentry><refentrytitle>password-request</refentrytitle>
524
389
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
390
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
391
      <manvolnum>8</manvolnum></citerefentry>,
525
392
      <citerefentry><refentrytitle>gpg</refentrytitle>
526
 
      <manvolnum>1</manvolnum></citerefentry>,
527
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
528
 
      <manvolnum>5</manvolnum></citerefentry>,
529
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
530
 
      <manvolnum>8</manvolnum></citerefentry>,
531
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
533
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
534
393
      <manvolnum>1</manvolnum></citerefentry>
535
394
    </para>
536
395
  </refsect1>
537
396
  
538
397
</refentry>
539
 
<!-- Local Variables: -->
540
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
541
 
<!-- time-stamp-end: "[\"']>" -->
542
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
543
 
<!-- End: -->