/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: 2015-08-02 16:45:29 UTC
  • Revision ID: teddy@recompile.se-20150802164529-pemtk1agiqluoiua
Deprecate some D-Bus methods in favor of D-Bus properties.

The following D-Bus methods on the interface
"se.recompile.Mandos.Client" are redundant, and are therefore
deprecated:  "Disable", "Enable", "StartChecker", and "StopChecker".
Instead, the D-Bus properties "Enabled" and "CheckerRunning" should be
set, as was always also possible.

* DBUS-API (se.recompile.Mandos.Client.Disable): Remove; deprecated.
  (se.recompile.Mandos.Client.Enable): - '' -
  (se.recompile.Mandos.Client.StartChecker): - '' -
  (se.recompile.Mandos.Client.StopChecker): - '' -
* mandos (ClientDBus.Enable): Annotate as deprecated.
  (ClientDBus.StartChecker): - '' -
  (ClientDBus.Disable): - '' -
  (ClientDBus.StopChecker): - '' -
* mandos-monitor (MandosClientWidget.keypress): Set properties instead
                                                of calling deprecated
                                                methods.

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