/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2017-08-20 16:25:42 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820162542-bj2bmwfbbsph8oq8
Change Debian package priority from "extra" to "optional".

* debian/control (Priority): Change from "extra" to "optional".

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