/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-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

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 "2018-02-08">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
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
 
      <year>2017</year>
44
 
      <year>2018</year>
45
34
      <holder>Teddy Hogeborn</holder>
46
35
      <holder>Björn Påhlsson</holder>
47
36
    </copyright>
48
 
    <xi:include href="legalnotice.xml"/>
 
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>
49
60
  </refentryinfo>
50
 
  
 
61
 
51
62
  <refmeta>
52
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
53
64
    <manvolnum>8</manvolnum>
59
70
      Generate key and password for Mandos client and server.
60
71
    </refpurpose>
61
72
  </refnamediv>
62
 
  
 
73
 
63
74
  <refsynopsisdiv>
64
75
    <cmdsynopsis>
65
76
      <command>&COMMANDNAME;</command>
126
137
        <replaceable>TIME</replaceable></option></arg>
127
138
      </group>
128
139
      <sbr/>
129
 
      <group>
130
 
        <arg choice="plain"><option>--force</option></arg>
131
 
        <arg choice="plain"><option>-f</option></arg>
132
 
      </group>
 
140
      <arg><option>--force</option></arg>
133
141
    </cmdsynopsis>
134
142
    <cmdsynopsis>
135
143
      <command>&COMMANDNAME;</command>
136
144
      <group choice="req">
137
145
        <arg choice="plain"><option>--password</option></arg>
138
146
        <arg choice="plain"><option>-p</option></arg>
139
 
        <arg choice="plain"><option>--passfile
140
 
        <replaceable>FILE</replaceable></option></arg>
141
 
        <arg choice="plain"><option>-F</option>
142
 
        <replaceable>FILE</replaceable></arg>
143
147
      </group>
144
148
      <sbr/>
145
149
      <group>
155
159
        <arg choice="plain"><option>-n
156
160
        <replaceable>NAME</replaceable></option></arg>
157
161
      </group>
158
 
      <group>
159
 
        <arg choice="plain"><option>--no-ssh</option></arg>
160
 
        <arg choice="plain"><option>-S</option></arg>
161
 
      </group>
162
162
    </cmdsynopsis>
163
163
    <cmdsynopsis>
164
164
      <command>&COMMANDNAME;</command>
181
181
    <para>
182
182
      <command>&COMMANDNAME;</command> is a program to generate the
183
183
      OpenPGP key used by
184
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
185
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
186
      normally written to /etc/mandos for later installation into the
187
187
      initrd image, but this, and most other things, can be changed
189
189
    </para>
190
190
    <para>
191
191
      This program can also be used with the
192
 
      <option>--password</option> or <option>--passfile</option>
193
 
      options to generate a ready-made section for
194
 
      <filename>clients.conf</filename> (see
 
192
      <option>--password</option> option to generate a ready-made
 
193
      section for <filename>clients.conf</filename> (see
195
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
196
195
      <manvolnum>5</manvolnum></citerefentry>).
197
196
    </para>
220
219
          </para>
221
220
        </listitem>
222
221
      </varlistentry>
223
 
      
 
222
 
224
223
      <varlistentry>
225
224
        <term><option>--dir
226
225
        <replaceable>DIRECTORY</replaceable></option></term>
229
228
        <listitem>
230
229
          <para>
231
230
            Target directory for key files.  Default is
232
 
            <filename class="directory">/etc/mandos</filename>.
 
231
            <filename>/etc/mandos</filename>.
233
232
          </para>
234
233
        </listitem>
235
234
      </varlistentry>
236
 
      
 
235
 
237
236
      <varlistentry>
238
237
        <term><option>--type
239
238
        <replaceable>TYPE</replaceable></option></term>
241
240
        <replaceable>TYPE</replaceable></option></term>
242
241
        <listitem>
243
242
          <para>
244
 
            Key type.  Default is <quote>RSA</quote>.
 
243
            Key type.  Default is <quote>DSA</quote>.
245
244
          </para>
246
245
        </listitem>
247
246
      </varlistentry>
248
 
      
 
247
 
249
248
      <varlistentry>
250
249
        <term><option>--length
251
250
        <replaceable>BITS</replaceable></option></term>
253
252
        <replaceable>BITS</replaceable></option></term>
254
253
        <listitem>
255
254
          <para>
256
 
            Key length in bits.  Default is 4096.
 
255
            Key length in bits.  Default is 2048.
257
256
          </para>
258
257
        </listitem>
259
258
      </varlistentry>
260
 
      
 
259
 
261
260
      <varlistentry>
262
261
        <term><option>--subtype
263
262
        <replaceable>KEYTYPE</replaceable></option></term>
265
264
        <replaceable>KEYTYPE</replaceable></option></term>
266
265
        <listitem>
267
266
          <para>
268
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
269
268
            encryption-only).
270
269
          </para>
271
270
        </listitem>
272
271
      </varlistentry>
273
 
      
 
272
 
274
273
      <varlistentry>
275
274
        <term><option>--sublength
276
275
        <replaceable>BITS</replaceable></option></term>
278
277
        <replaceable>BITS</replaceable></option></term>
279
278
        <listitem>
280
279
          <para>
281
 
            Subkey length in bits.  Default is 4096.
 
280
            Subkey length in bits.  Default is 2048.
282
281
          </para>
283
282
        </listitem>
284
283
      </varlistentry>
285
 
      
 
284
 
286
285
      <varlistentry>
287
286
        <term><option>--email
288
287
        <replaceable>ADDRESS</replaceable></option></term>
294
293
          </para>
295
294
        </listitem>
296
295
      </varlistentry>
297
 
      
 
296
 
298
297
      <varlistentry>
299
298
        <term><option>--comment
300
299
        <replaceable>TEXT</replaceable></option></term>
302
301
        <replaceable>TEXT</replaceable></option></term>
303
302
        <listitem>
304
303
          <para>
305
 
            Comment field for key.  Default is empty.
 
304
            Comment field for key.  The default value is
 
305
            <quote><literal>Mandos client key</literal></quote>.
306
306
          </para>
307
307
        </listitem>
308
308
      </varlistentry>
309
 
      
 
309
 
310
310
      <varlistentry>
311
311
        <term><option>--expire
312
312
        <replaceable>TIME</replaceable></option></term>
320
320
          </para>
321
321
        </listitem>
322
322
      </varlistentry>
323
 
      
 
323
 
324
324
      <varlistentry>
325
325
        <term><option>--force</option></term>
326
326
        <term><option>-f</option></term>
348
348
          </para>
349
349
        </listitem>
350
350
      </varlistentry>
351
 
      <varlistentry>
352
 
        <term><option>--passfile
353
 
        <replaceable>FILE</replaceable></option></term>
354
 
        <term><option>-F
355
 
        <replaceable>FILE</replaceable></option></term>
356
 
        <listitem>
357
 
          <para>
358
 
            The same as <option>--password</option>, but read from
359
 
            <replaceable>FILE</replaceable>, not the terminal.
360
 
          </para>
361
 
        </listitem>
362
 
      </varlistentry>
363
 
      <varlistentry>
364
 
        <term><option>--no-ssh</option></term>
365
 
        <term><option>-S</option></term>
366
 
        <listitem>
367
 
          <para>
368
 
            When <option>--password</option> or
369
 
            <option>--passfile</option> is given, this option will
370
 
            prevent <command>&COMMANDNAME;</command> from calling
371
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
372
 
            for this host and, if successful, output suitable config
373
 
            options to use this fingerprint as a
374
 
            <option>checker</option> option in the output.  This is
375
 
            otherwise the default behavior.
376
 
          </para>
377
 
        </listitem>
378
 
      </varlistentry>
379
351
    </variablelist>
380
352
  </refsect1>
381
 
  
 
353
 
382
354
  <refsect1 id="overview">
383
355
    <title>OVERVIEW</title>
384
356
    <xi:include href="overview.xml"/>
388
360
      <filename>clients.conf</filename> on the server.
389
361
    </para>
390
362
  </refsect1>
391
 
  
 
363
 
392
364
  <refsect1 id="exit_status">
393
365
    <title>EXIT STATUS</title>
394
366
    <para>
414
386
    </variablelist>
415
387
  </refsect1>
416
388
  
417
 
  <refsect1 id="files">
 
389
  <refsect1 id="file">
418
390
    <title>FILES</title>
419
391
    <para>
420
392
      Use the <option>--dir</option> option to change where
441
413
        </listitem>
442
414
      </varlistentry>
443
415
      <varlistentry>
444
 
        <term><filename class="directory">/tmp</filename></term>
 
416
        <term><filename>/tmp</filename></term>
445
417
        <listitem>
446
418
          <para>
447
419
            Temporary files will be written here if
451
423
      </varlistentry>
452
424
    </variablelist>
453
425
  </refsect1>
454
 
  
 
426
 
455
427
  <refsect1 id="bugs">
456
428
    <title>BUGS</title>
457
 
    <xi:include href="bugs.xml"/>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
458
432
  </refsect1>
459
 
  
 
433
 
460
434
  <refsect1 id="example">
461
435
    <title>EXAMPLE</title>
462
436
    <informalexample>
481
455
    </informalexample>
482
456
    <informalexample>
483
457
      <para>
484
 
        Prompt for a password, encrypt it with the key in <filename
485
 
        class="directory">/etc/mandos</filename> and output a section
486
 
        suitable for <filename>clients.conf</filename>.
 
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>.
487
461
      </para>
488
462
      <para>
489
463
        <userinput>&COMMANDNAME; --password</userinput>
503
477
      </para>
504
478
    </informalexample>
505
479
  </refsect1>
506
 
  
 
480
 
507
481
  <refsect1 id="security">
508
482
    <title>SECURITY</title>
509
483
    <para>
518
492
      <manvolnum>8</manvolnum></citerefentry>.
519
493
    </para>
520
494
  </refsect1>
521
 
  
 
495
 
522
496
  <refsect1 id="see_also">
523
497
    <title>SEE ALSO</title>
524
498
    <para>
525
 
      <citerefentry><refentrytitle>intro</refentrytitle>
526
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
527
499
      <citerefentry><refentrytitle>gpg</refentrytitle>
528
500
      <manvolnum>1</manvolnum></citerefentry>,
529
501
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
530
502
      <manvolnum>5</manvolnum></citerefentry>,
531
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
532
504
      <manvolnum>8</manvolnum></citerefentry>,
533
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
535
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
536
 
      <manvolnum>1</manvolnum></citerefentry>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
506
      <manvolnum>8mandos</manvolnum></citerefentry>
537
507
    </para>
538
508
  </refsect1>
539
509