/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: 2016-06-21 19:47:08 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 344.
  • Revision ID: teddy@recompile.se-20160621194708-bmsd15fu32llgb4s
Fix typo in README.Debian for mandos-client package.

* debian/mandos.README.Debian: Replace "it it" with "it is", and make
  lintian warning tag "spelling-error-in-readme-debian" go away.

Show diffs side-by-side

added added

removed removed

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