/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: 2009-02-07 04:50:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090207045039-xkr6b80vtqwqrq8l
* Makefile (install-client-nokey): Move "initramfs-tools-script" from
                                   "/scripts/local-top/mandos" to
                                   "/scripts/init-premount/mandos".
  (uninstall-client): - '' -
* debian/mandos-client.dirs: - '' -
* initramfs-tools-script (PREREQ): Added "udev".

Show diffs side-by-side

added added

removed removed

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