/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: 2008-09-06 16:31:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906163149-1ddq2klhdwwiw1ry
Renamed "password-request" to "mandos-client".

* Makefile: - '' -
* mandos-keygen.xml: - '' -
* mandos-options.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.conf: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/password-request.c: Renamed to "mandos-client.c".
* plugins.d/password-request.xml: Renamed to "mandos-client.xml".

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