/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

* mandos (DBusObjectWithProperties.Introspect): Use
  itertools.chain.from_iterable(foo) instead of itertools.chain(*foo).

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">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
 
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>
18
20
        <surname>Påhlsson</surname>
19
21
        <address>
20
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
21
23
        </address>
22
24
      </author>
23
25
      <author>
24
26
        <firstname>Teddy</firstname>
25
27
        <surname>Hogeborn</surname>
26
28
        <address>
27
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
28
30
        </address>
29
31
      </author>
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
      <year>2011</year>
 
37
      <year>2012</year>
 
38
      <holder>Teddy Hogeborn</holder>
 
39
      <holder>Björn Påhlsson</holder>
34
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
58
42
  </refentryinfo>
59
 
 
 
43
  
60
44
  <refmeta>
61
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
46
    <manvolnum>8</manvolnum>
65
49
  <refnamediv>
66
50
    <refname><command>&COMMANDNAME;</command></refname>
67
51
    <refpurpose>
68
 
      Generate keys for <citerefentry><refentrytitle>password-request
69
 
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
 
52
      Generate key and password for Mandos client and server.
70
53
    </refpurpose>
71
54
  </refnamediv>
72
 
 
 
55
  
73
56
  <refsynopsisdiv>
74
57
    <cmdsynopsis>
75
58
      <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>
 
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>
154
161
      </group>
155
162
    </cmdsynopsis>
156
163
  </refsynopsisdiv>
157
 
 
 
164
  
158
165
  <refsect1 id="description">
159
166
    <title>DESCRIPTION</title>
160
167
    <para>
161
168
      <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
 
169
      OpenPGP key used by
 
170
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
171
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
165
172
      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.
 
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>).
168
183
    </para>
169
184
  </refsect1>
170
185
  
171
186
  <refsect1 id="purpose">
172
187
    <title>PURPOSE</title>
173
 
 
174
188
    <para>
175
189
      The purpose of this is to enable <emphasis>remote and unattended
176
190
      rebooting</emphasis> of client host computer with an
177
191
      <emphasis>encrypted root file system</emphasis>.  See <xref
178
192
      linkend="overview"/> for details.
179
193
    </para>
180
 
 
181
194
  </refsect1>
182
195
  
183
196
  <refsect1 id="options">
184
197
    <title>OPTIONS</title>
185
 
 
 
198
    
186
199
    <variablelist>
187
200
      <varlistentry>
188
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
201
        <term><option>--help</option></term>
 
202
        <term><option>-h</option></term>
189
203
        <listitem>
190
204
          <para>
191
205
            Show a help message and exit
192
206
          </para>
193
207
        </listitem>
194
208
      </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>
 
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>DSA</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 2048.
 
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>ELG-E</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 2048.
 
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>
229
277
        <listitem>
230
278
          <para>
231
279
            Email address of key.  Default is empty.
232
280
          </para>
233
281
        </listitem>
234
282
      </varlistentry>
235
 
 
 
283
      
236
284
      <varlistentry>
237
 
        <term><literal>-c</literal>, <literal>--comment</literal>
238
 
        <replaceable>comment</replaceable></term>
 
285
        <term><option>--comment
 
286
        <replaceable>TEXT</replaceable></option></term>
 
287
        <term><option>-c
 
288
        <replaceable>TEXT</replaceable></option></term>
239
289
        <listitem>
240
290
          <para>
241
291
            Comment field for key.  The default value is
242
 
            "<literal>Mandos client key</literal>".
 
292
            <quote><literal>Mandos client key</literal></quote>.
243
293
          </para>
244
294
        </listitem>
245
295
      </varlistentry>
246
 
 
 
296
      
247
297
      <varlistentry>
248
 
        <term><literal>-x</literal>, <literal>--expire</literal>
249
 
        <replaceable>time</replaceable></term>
 
298
        <term><option>--expire
 
299
        <replaceable>TIME</replaceable></option></term>
 
300
        <term><option>-x
 
301
        <replaceable>TIME</replaceable></option></term>
250
302
        <listitem>
251
303
          <para>
252
304
            Key expire time.  Default is no expiration.  See
255
307
          </para>
256
308
        </listitem>
257
309
      </varlistentry>
258
 
 
259
 
      <varlistentry>
260
 
        <term><literal>-f</literal>, <literal>--force</literal></term>
261
 
        <listitem>
262
 
          <para>
263
 
            Force overwriting old keys.
 
310
      
 
311
      <varlistentry>
 
312
        <term><option>--force</option></term>
 
313
        <term><option>-f</option></term>
 
314
        <listitem>
 
315
          <para>
 
316
            Force overwriting old key.
 
317
          </para>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
      <varlistentry>
 
321
        <term><option>--password</option></term>
 
322
        <term><option>-p</option></term>
 
323
        <listitem>
 
324
          <para>
 
325
            Prompt for a password and encrypt it with the key already
 
326
            present in either <filename>/etc/mandos</filename> or the
 
327
            directory specified with the <option>--dir</option>
 
328
            option.  Outputs, on standard output, a section suitable
 
329
            for inclusion in <citerefentry><refentrytitle
 
330
            >mandos-clients.conf</refentrytitle><manvolnum
 
331
            >8</manvolnum></citerefentry>.  The host name or the name
 
332
            specified with the <option>--name</option> option is used
 
333
            for the section header.  All other options are ignored,
 
334
            and no key is created.
 
335
          </para>
 
336
        </listitem>
 
337
      </varlistentry>
 
338
      <varlistentry>
 
339
        <term><option>--passfile
 
340
        <replaceable>FILE</replaceable></option></term>
 
341
        <term><option>-F
 
342
        <replaceable>FILE</replaceable></option></term>
 
343
        <listitem>
 
344
          <para>
 
345
            The same as <option>--password</option>, but read from
 
346
            <replaceable>FILE</replaceable>, not the terminal.
264
347
          </para>
265
348
        </listitem>
266
349
      </varlistentry>
267
350
    </variablelist>
268
351
  </refsect1>
269
 
 
 
352
  
270
353
  <refsect1 id="overview">
271
354
    <title>OVERVIEW</title>
272
 
    &OVERVIEW;
 
355
    <xi:include href="overview.xml"/>
273
356
    <para>
274
 
      This program is a small program to generate new OpenPGP keys for
275
 
      new Mandos clients.
 
357
      This program is a small utility to generate new OpenPGP keys for
 
358
      new Mandos clients, and to generate sections for inclusion in
 
359
      <filename>clients.conf</filename> on the server.
276
360
    </para>
277
361
  </refsect1>
278
 
 
 
362
  
279
363
  <refsect1 id="exit_status">
280
364
    <title>EXIT STATUS</title>
281
365
    <para>
282
 
      The exit status will be 0 if new keys were successfully created,
283
 
      otherwise not.
 
366
      The exit status will be 0 if a new key (or password, if the
 
367
      <option>--password</option> option was used) was successfully
 
368
      created, otherwise not.
284
369
    </para>
285
370
  </refsect1>
286
371
  
288
373
    <title>ENVIRONMENT</title>
289
374
    <variablelist>
290
375
      <varlistentry>
291
 
        <term><varname>TMPDIR</varname></term>
 
376
        <term><envar>TMPDIR</envar></term>
292
377
        <listitem>
293
378
          <para>
294
379
            If set, temporary files will be created here. See
300
385
    </variablelist>
301
386
  </refsect1>
302
387
  
303
 
  <refsect1 id="file">
 
388
  <refsect1 id="files">
304
389
    <title>FILES</title>
305
390
    <para>
306
391
      Use the <option>--dir</option> option to change where
327
412
        </listitem>
328
413
      </varlistentry>
329
414
      <varlistentry>
330
 
        <term><filename>/tmp</filename></term>
 
415
        <term><filename class="directory">/tmp</filename></term>
331
416
        <listitem>
332
417
          <para>
333
418
            Temporary files will be written here if
337
422
      </varlistentry>
338
423
    </variablelist>
339
424
  </refsect1>
340
 
 
341
 
  <refsect1 id="bugs">
342
 
    <title>BUGS</title>
343
 
    <para>
344
 
      None are known at this time.
345
 
    </para>
346
 
  </refsect1>
347
 
 
 
425
  
 
426
<!--   <refsect1 id="bugs"> -->
 
427
<!--     <title>BUGS</title> -->
 
428
<!--     <para> -->
 
429
<!--     </para> -->
 
430
<!--   </refsect1> -->
 
431
  
348
432
  <refsect1 id="example">
349
433
    <title>EXAMPLE</title>
350
434
    <informalexample>
352
436
        Normal invocation needs no options:
353
437
      </para>
354
438
      <para>
355
 
        <userinput>mandos-keygen</userinput>
 
439
        <userinput>&COMMANDNAME;</userinput>
356
440
      </para>
357
441
    </informalexample>
358
442
    <informalexample>
359
443
      <para>
360
 
        Create keys in another directory and of another type.  Force
 
444
        Create key in another directory and of another type.  Force
361
445
        overwriting old key files:
362
446
      </para>
363
447
      <para>
364
448
 
365
449
<!-- do not wrap this line -->
366
 
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
 
450
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
 
451
 
 
452
      </para>
 
453
    </informalexample>
 
454
    <informalexample>
 
455
      <para>
 
456
        Prompt for a password, encrypt it with the key in <filename
 
457
        class="directory">/etc/mandos</filename> and output a section
 
458
        suitable for <filename>clients.conf</filename>.
 
459
      </para>
 
460
      <para>
 
461
        <userinput>&COMMANDNAME; --password</userinput>
 
462
      </para>
 
463
    </informalexample>
 
464
    <informalexample>
 
465
      <para>
 
466
        Prompt for a password, encrypt it with the key in the
 
467
        <filename>client-key</filename> directory and output a section
 
468
        suitable for <filename>clients.conf</filename>.
 
469
      </para>
 
470
      <para>
 
471
 
 
472
<!-- do not wrap this line -->
 
473
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
367
474
 
368
475
      </para>
369
476
    </informalexample>
370
477
  </refsect1>
371
 
 
 
478
  
372
479
  <refsect1 id="security">
373
480
    <title>SECURITY</title>
374
481
    <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.
 
482
      The <option>--type</option>, <option>--length</option>,
 
483
      <option>--subtype</option>, and <option>--sublength</option>
 
484
      options can be used to create keys of low security.  If in
 
485
      doubt, leave them to the default values.
378
486
    </para>
379
487
    <para>
380
 
      The key expire time is not guaranteed to be honored by
381
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
488
      The key expire time is <emphasis>not</emphasis> guaranteed to be
 
489
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
382
490
      <manvolnum>8</manvolnum></citerefentry>.
383
491
    </para>
384
492
  </refsect1>
385
 
 
 
493
  
386
494
  <refsect1 id="see_also">
387
495
    <title>SEE ALSO</title>
388
496
    <para>
389
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
497
      <citerefentry><refentrytitle>intro</refentrytitle>
390
498
      <manvolnum>8mandos</manvolnum></citerefentry>,
391
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
392
 
      <manvolnum>8</manvolnum></citerefentry>, and
393
499
      <citerefentry><refentrytitle>gpg</refentrytitle>
394
 
      <manvolnum>1</manvolnum></citerefentry>
 
500
      <manvolnum>1</manvolnum></citerefentry>,
 
501
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
502
      <manvolnum>5</manvolnum></citerefentry>,
 
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
504
      <manvolnum>8</manvolnum></citerefentry>,
 
505
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
506
      <manvolnum>8mandos</manvolnum></citerefentry>
395
507
    </para>
396
508
  </refsect1>
397
509
  
398
510
</refentry>
 
511
<!-- Local Variables: -->
 
512
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
513
<!-- time-stamp-end: "[\"']>" -->
 
514
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
515
<!-- End: -->