/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-02-23 19:11:11 UTC
  • Revision ID: teddy@recompile.se-20170223191111-poodzw0cr26utaz0
Update copyright year to 2017

* DBUS-API: Update copyright year to 2017.
* debian/copyright: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

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