/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: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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