/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: 2018-02-10 18:58:32 UTC
  • Revision ID: teddy@recompile.se-20180210185832-fz2a92274niyrn44
Update lintian override to use correct line number

* debian/mandos.lintian-overrides
  (init.d-script-needs-depends-on-lsb-base): Change line number to
  "46".

Show diffs side-by-side

added added

removed removed

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