/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: 2016-10-01 13:56:09 UTC
  • mfrom: (875 trunk)
  • mto: This revision was merged to the branch mainline in revision 876.
  • Revision ID: teddy@recompile.se-20161001135609-y5q39hvf2d95utwf
Merge from trunk

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">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
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>
 
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>
34
43
      <holder>Teddy Hogeborn</holder>
35
44
      <holder>Björn Påhlsson</holder>
36
45
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
46
    <xi:include href="legalnotice.xml"/>
60
47
  </refentryinfo>
61
 
 
 
48
  
62
49
  <refmeta>
63
50
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
51
    <manvolnum>8</manvolnum>
70
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>
137
124
        <replaceable>TIME</replaceable></option></arg>
138
125
      </group>
139
126
      <sbr/>
140
 
      <arg><option>--force</option></arg>
 
127
      <group>
 
128
        <arg choice="plain"><option>--force</option></arg>
 
129
        <arg choice="plain"><option>-f</option></arg>
 
130
      </group>
141
131
    </cmdsynopsis>
142
132
    <cmdsynopsis>
143
133
      <command>&COMMANDNAME;</command>
144
134
      <group choice="req">
145
135
        <arg choice="plain"><option>--password</option></arg>
146
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>
147
141
      </group>
148
142
      <sbr/>
149
143
      <group>
159
153
        <arg choice="plain"><option>-n
160
154
        <replaceable>NAME</replaceable></option></arg>
161
155
      </group>
 
156
      <group>
 
157
        <arg choice="plain"><option>--no-ssh</option></arg>
 
158
        <arg choice="plain"><option>-S</option></arg>
 
159
      </group>
162
160
    </cmdsynopsis>
163
161
    <cmdsynopsis>
164
162
      <command>&COMMANDNAME;</command>
181
179
    <para>
182
180
      <command>&COMMANDNAME;</command> is a program to generate the
183
181
      OpenPGP key used by
184
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
182
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
185
183
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
184
      normally written to /etc/mandos for later installation into the
187
185
      initrd image, but this, and most other things, can be changed
189
187
    </para>
190
188
    <para>
191
189
      This program can also be used with the
192
 
      <option>--password</option> option to generate a ready-made
193
 
      section for <filename>clients.conf</filename> (see
 
190
      <option>--password</option> or <option>--passfile</option>
 
191
      options to generate a ready-made section for
 
192
      <filename>clients.conf</filename> (see
194
193
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
195
194
      <manvolnum>5</manvolnum></citerefentry>).
196
195
    </para>
219
218
          </para>
220
219
        </listitem>
221
220
      </varlistentry>
222
 
 
 
221
      
223
222
      <varlistentry>
224
223
        <term><option>--dir
225
224
        <replaceable>DIRECTORY</replaceable></option></term>
228
227
        <listitem>
229
228
          <para>
230
229
            Target directory for key files.  Default is
231
 
            <filename>/etc/mandos</filename>.
 
230
            <filename class="directory">/etc/mandos</filename>.
232
231
          </para>
233
232
        </listitem>
234
233
      </varlistentry>
235
 
 
 
234
      
236
235
      <varlistentry>
237
236
        <term><option>--type
238
237
        <replaceable>TYPE</replaceable></option></term>
240
239
        <replaceable>TYPE</replaceable></option></term>
241
240
        <listitem>
242
241
          <para>
243
 
            Key type.  Default is <quote>DSA</quote>.
 
242
            Key type.  Default is <quote>RSA</quote>.
244
243
          </para>
245
244
        </listitem>
246
245
      </varlistentry>
247
 
 
 
246
      
248
247
      <varlistentry>
249
248
        <term><option>--length
250
249
        <replaceable>BITS</replaceable></option></term>
252
251
        <replaceable>BITS</replaceable></option></term>
253
252
        <listitem>
254
253
          <para>
255
 
            Key length in bits.  Default is 2048.
 
254
            Key length in bits.  Default is 4096.
256
255
          </para>
257
256
        </listitem>
258
257
      </varlistentry>
259
 
 
 
258
      
260
259
      <varlistentry>
261
260
        <term><option>--subtype
262
261
        <replaceable>KEYTYPE</replaceable></option></term>
264
263
        <replaceable>KEYTYPE</replaceable></option></term>
265
264
        <listitem>
266
265
          <para>
267
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
266
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
268
267
            encryption-only).
269
268
          </para>
270
269
        </listitem>
271
270
      </varlistentry>
272
 
 
 
271
      
273
272
      <varlistentry>
274
273
        <term><option>--sublength
275
274
        <replaceable>BITS</replaceable></option></term>
277
276
        <replaceable>BITS</replaceable></option></term>
278
277
        <listitem>
279
278
          <para>
280
 
            Subkey length in bits.  Default is 2048.
 
279
            Subkey length in bits.  Default is 4096.
281
280
          </para>
282
281
        </listitem>
283
282
      </varlistentry>
284
 
 
 
283
      
285
284
      <varlistentry>
286
285
        <term><option>--email
287
286
        <replaceable>ADDRESS</replaceable></option></term>
293
292
          </para>
294
293
        </listitem>
295
294
      </varlistentry>
296
 
 
 
295
      
297
296
      <varlistentry>
298
297
        <term><option>--comment
299
298
        <replaceable>TEXT</replaceable></option></term>
301
300
        <replaceable>TEXT</replaceable></option></term>
302
301
        <listitem>
303
302
          <para>
304
 
            Comment field for key.  The default value is
305
 
            <quote><literal>Mandos client key</literal></quote>.
 
303
            Comment field for key.  Default is empty.
306
304
          </para>
307
305
        </listitem>
308
306
      </varlistentry>
309
 
 
 
307
      
310
308
      <varlistentry>
311
309
        <term><option>--expire
312
310
        <replaceable>TIME</replaceable></option></term>
320
318
          </para>
321
319
        </listitem>
322
320
      </varlistentry>
323
 
 
 
321
      
324
322
      <varlistentry>
325
323
        <term><option>--force</option></term>
326
324
        <term><option>-f</option></term>
348
346
          </para>
349
347
        </listitem>
350
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.
 
374
          </para>
 
375
        </listitem>
 
376
      </varlistentry>
351
377
    </variablelist>
352
378
  </refsect1>
353
 
 
 
379
  
354
380
  <refsect1 id="overview">
355
381
    <title>OVERVIEW</title>
356
382
    <xi:include href="overview.xml"/>
360
386
      <filename>clients.conf</filename> on the server.
361
387
    </para>
362
388
  </refsect1>
363
 
 
 
389
  
364
390
  <refsect1 id="exit_status">
365
391
    <title>EXIT STATUS</title>
366
392
    <para>
386
412
    </variablelist>
387
413
  </refsect1>
388
414
  
389
 
  <refsect1 id="file">
 
415
  <refsect1 id="files">
390
416
    <title>FILES</title>
391
417
    <para>
392
418
      Use the <option>--dir</option> option to change where
413
439
        </listitem>
414
440
      </varlistentry>
415
441
      <varlistentry>
416
 
        <term><filename>/tmp</filename></term>
 
442
        <term><filename class="directory">/tmp</filename></term>
417
443
        <listitem>
418
444
          <para>
419
445
            Temporary files will be written here if
423
449
      </varlistentry>
424
450
    </variablelist>
425
451
  </refsect1>
426
 
 
 
452
  
427
453
  <refsect1 id="bugs">
428
454
    <title>BUGS</title>
429
 
    <para>
430
 
      None are known at this time.
431
 
    </para>
 
455
    <xi:include href="bugs.xml"/>
432
456
  </refsect1>
433
 
 
 
457
  
434
458
  <refsect1 id="example">
435
459
    <title>EXAMPLE</title>
436
460
    <informalexample>
455
479
    </informalexample>
456
480
    <informalexample>
457
481
      <para>
458
 
        Prompt for a password, encrypt it with the key in
459
 
        <filename>/etc/mandos</filename> and output a section suitable
460
 
        for <filename>clients.conf</filename>.
 
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>.
461
485
      </para>
462
486
      <para>
463
487
        <userinput>&COMMANDNAME; --password</userinput>
477
501
      </para>
478
502
    </informalexample>
479
503
  </refsect1>
480
 
 
 
504
  
481
505
  <refsect1 id="security">
482
506
    <title>SECURITY</title>
483
507
    <para>
492
516
      <manvolnum>8</manvolnum></citerefentry>.
493
517
    </para>
494
518
  </refsect1>
495
 
 
 
519
  
496
520
  <refsect1 id="see_also">
497
521
    <title>SEE ALSO</title>
498
522
    <para>
 
523
      <citerefentry><refentrytitle>intro</refentrytitle>
 
524
      <manvolnum>8mandos</manvolnum></citerefentry>,
499
525
      <citerefentry><refentrytitle>gpg</refentrytitle>
500
526
      <manvolnum>1</manvolnum></citerefentry>,
501
527
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
502
528
      <manvolnum>5</manvolnum></citerefentry>,
503
529
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
530
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
506
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
531
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
533
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
534
      <manvolnum>1</manvolnum></citerefentry>
507
535
    </para>
508
536
  </refsect1>
509
537