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