/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: 2016-06-23 19:46:41 UTC
  • Revision ID: teddy@recompile.se-20160623194641-dsokb8mz3wki07mv
Fix permissions of /etc/mandos/plugin-helpers.

* debian/rules (override_dh_fixperms-arch): Also exclude
  "etc/mandos/plugin-helpers" from changes by dh_fixperms.
* debian/mandos-client.postinst: Fix the permissions of
  "/etc/mandos/plugin-helpers" for those systems which had a fresh
  install of an older version.

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 "2016-03-05">
 
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>
32
43
      <holder>Teddy Hogeborn</holder>
33
44
      <holder>Björn Påhlsson</holder>
34
45
    </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>
 
46
    <xi:include href="legalnotice.xml"/>
58
47
  </refentryinfo>
59
 
 
 
48
  
60
49
  <refmeta>
61
50
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
51
    <manvolnum>8</manvolnum>
65
54
  <refnamediv>
66
55
    <refname><command>&COMMANDNAME;</command></refname>
67
56
    <refpurpose>
68
 
      Generate keys for <citerefentry><refentrytitle>password-request
69
 
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
 
57
      Generate key and password for Mandos client and server.
70
58
    </refpurpose>
71
59
  </refnamediv>
72
 
 
 
60
  
73
61
  <refsynopsisdiv>
74
62
    <cmdsynopsis>
75
63
      <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">
 
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>
113
128
        <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
129
        <arg choice="plain"><option>-f</option></arg>
156
130
      </group>
157
131
    </cmdsynopsis>
158
132
    <cmdsynopsis>
159
133
      <command>&COMMANDNAME;</command>
160
134
      <group choice="req">
 
135
        <arg choice="plain"><option>--password</option></arg>
161
136
        <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>
 
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>
171
159
      </group>
172
160
    </cmdsynopsis>
173
161
    <cmdsynopsis>
174
162
      <command>&COMMANDNAME;</command>
175
163
      <group choice="req">
 
164
        <arg choice="plain"><option>--help</option></arg>
176
165
        <arg choice="plain"><option>-h</option></arg>
177
 
        <arg choice="plain"><option>--help</option></arg>
178
166
      </group>
179
167
    </cmdsynopsis>
180
168
    <cmdsynopsis>
181
169
      <command>&COMMANDNAME;</command>
182
170
      <group choice="req">
 
171
        <arg choice="plain"><option>--version</option></arg>
183
172
        <arg choice="plain"><option>-v</option></arg>
184
 
        <arg choice="plain"><option>--version</option></arg>
185
173
      </group>
186
174
    </cmdsynopsis>
187
175
  </refsynopsisdiv>
188
 
 
 
176
  
189
177
  <refsect1 id="description">
190
178
    <title>DESCRIPTION</title>
191
179
    <para>
192
180
      <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
 
181
      OpenPGP key used by
 
182
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
183
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
196
184
      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.
 
185
      initrd image, but this, and most other things, can be changed
 
186
      with command line options.
199
187
    </para>
200
188
    <para>
201
 
      It can also be used to generate ready-made sections for
 
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
202
193
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
203
 
      <manvolnum>5</manvolnum></citerefentry> using the
204
 
      <option>--password</option> option.
 
194
      <manvolnum>5</manvolnum></citerefentry>).
205
195
    </para>
206
196
  </refsect1>
207
197
  
208
198
  <refsect1 id="purpose">
209
199
    <title>PURPOSE</title>
210
 
 
211
200
    <para>
212
201
      The purpose of this is to enable <emphasis>remote and unattended
213
202
      rebooting</emphasis> of client host computer with an
214
203
      <emphasis>encrypted root file system</emphasis>.  See <xref
215
204
      linkend="overview"/> for details.
216
205
    </para>
217
 
 
218
206
  </refsect1>
219
207
  
220
208
  <refsect1 id="options">
221
209
    <title>OPTIONS</title>
222
 
 
 
210
    
223
211
    <variablelist>
224
212
      <varlistentry>
225
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
213
        <term><option>--help</option></term>
 
214
        <term><option>-h</option></term>
226
215
        <listitem>
227
216
          <para>
228
217
            Show a help message and exit
229
218
          </para>
230
219
        </listitem>
231
220
      </varlistentry>
232
 
 
 
221
      
233
222
      <varlistentry>
234
 
        <term><literal>-d</literal>, <literal>--dir
235
 
        <replaceable>directory</replaceable></literal></term>
 
223
        <term><option>--dir
 
224
        <replaceable>DIRECTORY</replaceable></option></term>
 
225
        <term><option>-d
 
226
        <replaceable>DIRECTORY</replaceable></option></term>
236
227
        <listitem>
237
228
          <para>
238
229
            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
 
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
270
267
            encryption-only).
271
268
          </para>
272
269
        </listitem>
273
270
      </varlistentry>
274
 
 
 
271
      
275
272
      <varlistentry>
276
 
        <term><literal>-L</literal>, <literal>--sublength
277
 
        <replaceable>bits</replaceable></literal></term>
 
273
        <term><option>--sublength
 
274
        <replaceable>BITS</replaceable></option></term>
 
275
        <term><option>-L
 
276
        <replaceable>BITS</replaceable></option></term>
278
277
        <listitem>
279
278
          <para>
280
 
            Subkey length in bits.  Default is 2048.
 
279
            Subkey length in bits.  Default is 4096.
281
280
          </para>
282
281
        </listitem>
283
282
      </varlistentry>
284
 
 
 
283
      
285
284
      <varlistentry>
286
 
        <term><literal>-e</literal>, <literal>--email</literal>
287
 
        <replaceable>address</replaceable></term>
 
285
        <term><option>--email
 
286
        <replaceable>ADDRESS</replaceable></option></term>
 
287
        <term><option>-e
 
288
        <replaceable>ADDRESS</replaceable></option></term>
288
289
        <listitem>
289
290
          <para>
290
291
            Email address of key.  Default is empty.
291
292
          </para>
292
293
        </listitem>
293
294
      </varlistentry>
294
 
 
 
295
      
295
296
      <varlistentry>
296
 
        <term><literal>-c</literal>, <literal>--comment</literal>
297
 
        <replaceable>comment</replaceable></term>
 
297
        <term><option>--comment
 
298
        <replaceable>TEXT</replaceable></option></term>
 
299
        <term><option>-c
 
300
        <replaceable>TEXT</replaceable></option></term>
298
301
        <listitem>
299
302
          <para>
300
 
            Comment field for key.  The default value is
301
 
            <quote><literal>Mandos client key</literal></quote>.
 
303
            Comment field for key.  Default is empty.
302
304
          </para>
303
305
        </listitem>
304
306
      </varlistentry>
305
 
 
 
307
      
306
308
      <varlistentry>
307
 
        <term><literal>-x</literal>, <literal>--expire</literal>
308
 
        <replaceable>time</replaceable></term>
 
309
        <term><option>--expire
 
310
        <replaceable>TIME</replaceable></option></term>
 
311
        <term><option>-x
 
312
        <replaceable>TIME</replaceable></option></term>
309
313
        <listitem>
310
314
          <para>
311
315
            Key expire time.  Default is no expiration.  See
314
318
          </para>
315
319
        </listitem>
316
320
      </varlistentry>
317
 
 
 
321
      
318
322
      <varlistentry>
319
 
        <term><literal>-f</literal>, <literal>--force</literal></term>
 
323
        <term><option>--force</option></term>
 
324
        <term><option>-f</option></term>
320
325
        <listitem>
321
326
          <para>
322
 
            Force overwriting old keys.
 
327
            Force overwriting old key.
323
328
          </para>
324
329
        </listitem>
325
330
      </varlistentry>
326
331
      <varlistentry>
327
 
        <term><literal>-p</literal>, <literal>--password</literal
328
 
        ></term>
 
332
        <term><option>--password</option></term>
 
333
        <term><option>-p</option></term>
329
334
        <listitem>
330
335
          <para>
331
336
            Prompt for a password and encrypt it with the key already
337
342
            >8</manvolnum></citerefentry>.  The host name or the name
338
343
            specified with the <option>--name</option> option is used
339
344
            for the section header.  All other options are ignored,
340
 
            and no keys are created.
 
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.
341
374
          </para>
342
375
        </listitem>
343
376
      </varlistentry>
344
377
    </variablelist>
345
378
  </refsect1>
346
 
 
 
379
  
347
380
  <refsect1 id="overview">
348
381
    <title>OVERVIEW</title>
349
382
    <xi:include href="overview.xml"/>
350
383
    <para>
351
384
      This program is a small utility to generate new OpenPGP keys for
352
 
      new Mandos clients.
 
385
      new Mandos clients, and to generate sections for inclusion in
 
386
      <filename>clients.conf</filename> on the server.
353
387
    </para>
354
388
  </refsect1>
355
 
 
 
389
  
356
390
  <refsect1 id="exit_status">
357
391
    <title>EXIT STATUS</title>
358
392
    <para>
359
 
      The exit status will be 0 if new keys were successfully created,
360
 
      otherwise not.
 
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.
361
396
    </para>
362
397
  </refsect1>
363
398
  
365
400
    <title>ENVIRONMENT</title>
366
401
    <variablelist>
367
402
      <varlistentry>
368
 
        <term><varname>TMPDIR</varname></term>
 
403
        <term><envar>TMPDIR</envar></term>
369
404
        <listitem>
370
405
          <para>
371
406
            If set, temporary files will be created here. See
377
412
    </variablelist>
378
413
  </refsect1>
379
414
  
380
 
  <refsect1 id="file">
 
415
  <refsect1 id="files">
381
416
    <title>FILES</title>
382
417
    <para>
383
418
      Use the <option>--dir</option> option to change where
404
439
        </listitem>
405
440
      </varlistentry>
406
441
      <varlistentry>
407
 
        <term><filename>/tmp</filename></term>
 
442
        <term><filename class="directory">/tmp</filename></term>
408
443
        <listitem>
409
444
          <para>
410
445
            Temporary files will be written here if
414
449
      </varlistentry>
415
450
    </variablelist>
416
451
  </refsect1>
417
 
 
 
452
  
418
453
  <refsect1 id="bugs">
419
454
    <title>BUGS</title>
420
 
    <para>
421
 
      None are known at this time.
422
 
    </para>
 
455
    <xi:include href="bugs.xml"/>
423
456
  </refsect1>
424
 
 
 
457
  
425
458
  <refsect1 id="example">
426
459
    <title>EXAMPLE</title>
427
460
    <informalexample>
429
462
        Normal invocation needs no options:
430
463
      </para>
431
464
      <para>
432
 
        <userinput>mandos-keygen</userinput>
 
465
        <userinput>&COMMANDNAME;</userinput>
433
466
      </para>
434
467
    </informalexample>
435
468
    <informalexample>
436
469
      <para>
437
 
        Create keys in another directory and of another type.  Force
 
470
        Create key in another directory and of another type.  Force
438
471
        overwriting old key files:
439
472
      </para>
440
473
      <para>
441
474
 
442
475
<!-- do not wrap this line -->
443
 
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
 
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>
444
500
 
445
501
      </para>
446
502
    </informalexample>
447
503
  </refsect1>
448
 
 
 
504
  
449
505
  <refsect1 id="security">
450
506
    <title>SECURITY</title>
451
507
    <para>
452
508
      The <option>--type</option>, <option>--length</option>,
453
509
      <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.
 
510
      options can be used to create keys of low security.  If in
 
511
      doubt, leave them to the default values.
456
512
    </para>
457
513
    <para>
458
 
      The key expire time is not guaranteed to be honored by
459
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
514
      The key expire time is <emphasis>not</emphasis> guaranteed to be
 
515
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
460
516
      <manvolnum>8</manvolnum></citerefentry>.
461
517
    </para>
462
518
  </refsect1>
463
 
 
 
519
  
464
520
  <refsect1 id="see_also">
465
521
    <title>SEE ALSO</title>
466
522
    <para>
467
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
523
      <citerefentry><refentrytitle>intro</refentrytitle>
468
524
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
525
      <citerefentry><refentrytitle>gpg</refentrytitle>
 
526
      <manvolnum>1</manvolnum></citerefentry>,
 
527
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
528
      <manvolnum>5</manvolnum></citerefentry>,
469
529
      <citerefentry><refentrytitle>mandos</refentrytitle>
470
530
      <manvolnum>8</manvolnum></citerefentry>,
471
 
      <citerefentry><refentrytitle>gpg</refentrytitle>
 
531
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
533
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
472
534
      <manvolnum>1</manvolnum></citerefentry>
473
535
    </para>
474
536
  </refsect1>
475
537
  
476
538
</refentry>
 
539
<!-- Local Variables: -->
 
540
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
541
<!-- time-stamp-end: "[\"']>" -->
 
542
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
543
<!-- End: -->