/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
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">
4
5
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2016-03-05">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-03">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
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
34
      <holder>Teddy Hogeborn</holder>
44
35
      <holder>Björn Påhlsson</holder>
45
36
    </copyright>
46
37
    <xi:include href="legalnotice.xml"/>
47
38
  </refentryinfo>
48
 
  
 
39
 
49
40
  <refmeta>
50
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
42
    <manvolnum>8</manvolnum>
57
48
      Generate key and password for Mandos client and server.
58
49
    </refpurpose>
59
50
  </refnamediv>
60
 
  
 
51
 
61
52
  <refsynopsisdiv>
62
53
    <cmdsynopsis>
63
54
      <command>&COMMANDNAME;</command>
124
115
        <replaceable>TIME</replaceable></option></arg>
125
116
      </group>
126
117
      <sbr/>
127
 
      <group>
128
 
        <arg choice="plain"><option>--force</option></arg>
129
 
        <arg choice="plain"><option>-f</option></arg>
130
 
      </group>
 
118
      <arg><option>--force</option></arg>
131
119
    </cmdsynopsis>
132
120
    <cmdsynopsis>
133
121
      <command>&COMMANDNAME;</command>
134
122
      <group choice="req">
135
123
        <arg choice="plain"><option>--password</option></arg>
136
124
        <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
125
      </group>
142
126
      <sbr/>
143
127
      <group>
153
137
        <arg choice="plain"><option>-n
154
138
        <replaceable>NAME</replaceable></option></arg>
155
139
      </group>
156
 
      <group>
157
 
        <arg choice="plain"><option>--no-ssh</option></arg>
158
 
        <arg choice="plain"><option>-S</option></arg>
159
 
      </group>
160
140
    </cmdsynopsis>
161
141
    <cmdsynopsis>
162
142
      <command>&COMMANDNAME;</command>
179
159
    <para>
180
160
      <command>&COMMANDNAME;</command> is a program to generate the
181
161
      OpenPGP key used by
182
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
162
      <citerefentry><refentrytitle>password-request</refentrytitle>
183
163
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
184
164
      normally written to /etc/mandos for later installation into the
185
165
      initrd image, but this, and most other things, can be changed
187
167
    </para>
188
168
    <para>
189
169
      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
 
170
      <option>--password</option> option to generate a ready-made
 
171
      section for <filename>clients.conf</filename> (see
193
172
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
194
173
      <manvolnum>5</manvolnum></citerefentry>).
195
174
    </para>
218
197
          </para>
219
198
        </listitem>
220
199
      </varlistentry>
221
 
      
 
200
 
222
201
      <varlistentry>
223
202
        <term><option>--dir
224
203
        <replaceable>DIRECTORY</replaceable></option></term>
227
206
        <listitem>
228
207
          <para>
229
208
            Target directory for key files.  Default is
230
 
            <filename class="directory">/etc/mandos</filename>.
 
209
            <filename>/etc/mandos</filename>.
231
210
          </para>
232
211
        </listitem>
233
212
      </varlistentry>
234
 
      
 
213
 
235
214
      <varlistentry>
236
215
        <term><option>--type
237
216
        <replaceable>TYPE</replaceable></option></term>
239
218
        <replaceable>TYPE</replaceable></option></term>
240
219
        <listitem>
241
220
          <para>
242
 
            Key type.  Default is <quote>RSA</quote>.
 
221
            Key type.  Default is <quote>DSA</quote>.
243
222
          </para>
244
223
        </listitem>
245
224
      </varlistentry>
246
 
      
 
225
 
247
226
      <varlistentry>
248
227
        <term><option>--length
249
228
        <replaceable>BITS</replaceable></option></term>
251
230
        <replaceable>BITS</replaceable></option></term>
252
231
        <listitem>
253
232
          <para>
254
 
            Key length in bits.  Default is 4096.
 
233
            Key length in bits.  Default is 2048.
255
234
          </para>
256
235
        </listitem>
257
236
      </varlistentry>
258
 
      
 
237
 
259
238
      <varlistentry>
260
239
        <term><option>--subtype
261
240
        <replaceable>KEYTYPE</replaceable></option></term>
263
242
        <replaceable>KEYTYPE</replaceable></option></term>
264
243
        <listitem>
265
244
          <para>
266
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
245
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
267
246
            encryption-only).
268
247
          </para>
269
248
        </listitem>
270
249
      </varlistentry>
271
 
      
 
250
 
272
251
      <varlistentry>
273
252
        <term><option>--sublength
274
253
        <replaceable>BITS</replaceable></option></term>
276
255
        <replaceable>BITS</replaceable></option></term>
277
256
        <listitem>
278
257
          <para>
279
 
            Subkey length in bits.  Default is 4096.
 
258
            Subkey length in bits.  Default is 2048.
280
259
          </para>
281
260
        </listitem>
282
261
      </varlistentry>
283
 
      
 
262
 
284
263
      <varlistentry>
285
264
        <term><option>--email
286
265
        <replaceable>ADDRESS</replaceable></option></term>
292
271
          </para>
293
272
        </listitem>
294
273
      </varlistentry>
295
 
      
 
274
 
296
275
      <varlistentry>
297
276
        <term><option>--comment
298
277
        <replaceable>TEXT</replaceable></option></term>
300
279
        <replaceable>TEXT</replaceable></option></term>
301
280
        <listitem>
302
281
          <para>
303
 
            Comment field for key.  Default is empty.
 
282
            Comment field for key.  The default value is
 
283
            <quote><literal>Mandos client key</literal></quote>.
304
284
          </para>
305
285
        </listitem>
306
286
      </varlistentry>
307
 
      
 
287
 
308
288
      <varlistentry>
309
289
        <term><option>--expire
310
290
        <replaceable>TIME</replaceable></option></term>
318
298
          </para>
319
299
        </listitem>
320
300
      </varlistentry>
321
 
      
 
301
 
322
302
      <varlistentry>
323
303
        <term><option>--force</option></term>
324
304
        <term><option>-f</option></term>
346
326
          </para>
347
327
        </listitem>
348
328
      </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.
374
 
          </para>
375
 
        </listitem>
376
 
      </varlistentry>
377
329
    </variablelist>
378
330
  </refsect1>
379
 
  
 
331
 
380
332
  <refsect1 id="overview">
381
333
    <title>OVERVIEW</title>
382
334
    <xi:include href="overview.xml"/>
386
338
      <filename>clients.conf</filename> on the server.
387
339
    </para>
388
340
  </refsect1>
389
 
  
 
341
 
390
342
  <refsect1 id="exit_status">
391
343
    <title>EXIT STATUS</title>
392
344
    <para>
412
364
    </variablelist>
413
365
  </refsect1>
414
366
  
415
 
  <refsect1 id="files">
 
367
  <refsect1 id="file">
416
368
    <title>FILES</title>
417
369
    <para>
418
370
      Use the <option>--dir</option> option to change where
439
391
        </listitem>
440
392
      </varlistentry>
441
393
      <varlistentry>
442
 
        <term><filename class="directory">/tmp</filename></term>
 
394
        <term><filename>/tmp</filename></term>
443
395
        <listitem>
444
396
          <para>
445
397
            Temporary files will be written here if
449
401
      </varlistentry>
450
402
    </variablelist>
451
403
  </refsect1>
452
 
  
453
 
  <refsect1 id="bugs">
454
 
    <title>BUGS</title>
455
 
    <xi:include href="bugs.xml"/>
456
 
  </refsect1>
457
 
  
 
404
 
 
405
<!--   <refsect1 id="bugs"> -->
 
406
<!--     <title>BUGS</title> -->
 
407
<!--     <para> -->
 
408
<!--     </para> -->
 
409
<!--   </refsect1> -->
 
410
 
458
411
  <refsect1 id="example">
459
412
    <title>EXAMPLE</title>
460
413
    <informalexample>
479
432
    </informalexample>
480
433
    <informalexample>
481
434
      <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>.
 
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>.
485
438
      </para>
486
439
      <para>
487
440
        <userinput>&COMMANDNAME; --password</userinput>
501
454
      </para>
502
455
    </informalexample>
503
456
  </refsect1>
504
 
  
 
457
 
505
458
  <refsect1 id="security">
506
459
    <title>SECURITY</title>
507
460
    <para>
516
469
      <manvolnum>8</manvolnum></citerefentry>.
517
470
    </para>
518
471
  </refsect1>
519
 
  
 
472
 
520
473
  <refsect1 id="see_also">
521
474
    <title>SEE ALSO</title>
522
475
    <para>
523
 
      <citerefentry><refentrytitle>intro</refentrytitle>
524
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
525
476
      <citerefentry><refentrytitle>gpg</refentrytitle>
526
477
      <manvolnum>1</manvolnum></citerefentry>,
527
478
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
528
479
      <manvolnum>5</manvolnum></citerefentry>,
529
480
      <citerefentry><refentrytitle>mandos</refentrytitle>
530
481
      <manvolnum>8</manvolnum></citerefentry>,
531
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
533
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
534
 
      <manvolnum>1</manvolnum></citerefentry>
 
482
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
483
      <manvolnum>8mandos</manvolnum></citerefentry>
535
484
    </para>
536
485
  </refsect1>
537
486