/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-23 07:17:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080823071728-wo1k2mtbje5910np
* Makefile (MANPOST): Bug fix: corrected patterns.

* mandos-options.xml: Bug fix: also change root node tag name in
                      DOCTYPE declaration.
  (interface, address): Improved wording.

* overview.xml: Changed "host computer" to "computer".

Show diffs side-by-side

added added

removed removed

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