/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: 2018-01-29 19:21:23 UTC
  • Revision ID: teddy@recompile.se-20180129192123-y6brq6tnnnxm2oi2
http://bugs.debian.org/886595
Fix memory leak in plugin-runner (this fixes Debian bug #886595)

* plugin-runner.c (free_plugin): Bug fix: Also free() plugin name.

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