/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 at bsnet
  • Date: 2011-12-23 18:59:19 UTC
  • mto: (237.7.77 trunk)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: teddy@fukt.bsnet.se-20111223185919-ix5d1018ozhsdd87
* mandos (main/cleanup): Write new file, then rename.  Use
                         tempfile.mkstemp().

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