/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: 2011-09-26 19:34:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110926193423-5yc1fcv4joiwc1gq
* mandos-clients.conf.xml (OPTIONS/timeout): No longer used when
                                             secret key is given;
                                             refer to
                                             "extended_timeout".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
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
4
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2017-02-23">
 
5
<!ENTITY TIMESTAMP "2011-08-08">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2010</year>
37
36
      <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
37
      <holder>Teddy Hogeborn</holder>
45
38
      <holder>Björn Påhlsson</holder>
46
39
    </copyright>
125
118
        <replaceable>TIME</replaceable></option></arg>
126
119
      </group>
127
120
      <sbr/>
128
 
      <group>
129
 
        <arg choice="plain"><option>--force</option></arg>
130
 
        <arg choice="plain"><option>-f</option></arg>
131
 
      </group>
 
121
      <arg><option>--force</option></arg>
132
122
    </cmdsynopsis>
133
123
    <cmdsynopsis>
134
124
      <command>&COMMANDNAME;</command>
154
144
        <arg choice="plain"><option>-n
155
145
        <replaceable>NAME</replaceable></option></arg>
156
146
      </group>
157
 
      <group>
158
 
        <arg choice="plain"><option>--no-ssh</option></arg>
159
 
        <arg choice="plain"><option>-S</option></arg>
160
 
      </group>
161
147
    </cmdsynopsis>
162
148
    <cmdsynopsis>
163
149
      <command>&COMMANDNAME;</command>
228
214
        <listitem>
229
215
          <para>
230
216
            Target directory for key files.  Default is
231
 
            <filename class="directory">/etc/mandos</filename>.
 
217
            <filename>/etc/mandos</filename>.
232
218
          </para>
233
219
        </listitem>
234
220
      </varlistentry>
240
226
        <replaceable>TYPE</replaceable></option></term>
241
227
        <listitem>
242
228
          <para>
243
 
            Key type.  Default is <quote>RSA</quote>.
 
229
            Key type.  Default is <quote>DSA</quote>.
244
230
          </para>
245
231
        </listitem>
246
232
      </varlistentry>
252
238
        <replaceable>BITS</replaceable></option></term>
253
239
        <listitem>
254
240
          <para>
255
 
            Key length in bits.  Default is 4096.
 
241
            Key length in bits.  Default is 2048.
256
242
          </para>
257
243
        </listitem>
258
244
      </varlistentry>
264
250
        <replaceable>KEYTYPE</replaceable></option></term>
265
251
        <listitem>
266
252
          <para>
267
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
253
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
268
254
            encryption-only).
269
255
          </para>
270
256
        </listitem>
277
263
        <replaceable>BITS</replaceable></option></term>
278
264
        <listitem>
279
265
          <para>
280
 
            Subkey length in bits.  Default is 4096.
 
266
            Subkey length in bits.  Default is 2048.
281
267
          </para>
282
268
        </listitem>
283
269
      </varlistentry>
301
287
        <replaceable>TEXT</replaceable></option></term>
302
288
        <listitem>
303
289
          <para>
304
 
            Comment field for key.  Default is empty.
 
290
            Comment field for key.  The default value is
 
291
            <quote><literal>Mandos client key</literal></quote>.
305
292
          </para>
306
293
        </listitem>
307
294
      </varlistentry>
359
346
          </para>
360
347
        </listitem>
361
348
      </varlistentry>
362
 
      <varlistentry>
363
 
        <term><option>--no-ssh</option></term>
364
 
        <term><option>-S</option></term>
365
 
        <listitem>
366
 
          <para>
367
 
            When <option>--password</option> or
368
 
            <option>--passfile</option> is given, this option will
369
 
            prevent <command>&COMMANDNAME;</command> from calling
370
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
371
 
            for this host and, if successful, output suitable config
372
 
            options to use this fingerprint as a
373
 
            <option>checker</option> option in the output.  This is
374
 
            otherwise the default behavior.
375
 
          </para>
376
 
        </listitem>
377
 
      </varlistentry>
378
349
    </variablelist>
379
350
  </refsect1>
380
351
  
440
411
        </listitem>
441
412
      </varlistentry>
442
413
      <varlistentry>
443
 
        <term><filename class="directory">/tmp</filename></term>
 
414
        <term><filename>/tmp</filename></term>
444
415
        <listitem>
445
416
          <para>
446
417
            Temporary files will be written here if
451
422
    </variablelist>
452
423
  </refsect1>
453
424
  
454
 
  <refsect1 id="bugs">
455
 
    <title>BUGS</title>
456
 
    <xi:include href="bugs.xml"/>
457
 
  </refsect1>
 
425
<!--   <refsect1 id="bugs"> -->
 
426
<!--     <title>BUGS</title> -->
 
427
<!--     <para> -->
 
428
<!--     </para> -->
 
429
<!--   </refsect1> -->
458
430
  
459
431
  <refsect1 id="example">
460
432
    <title>EXAMPLE</title>
480
452
    </informalexample>
481
453
    <informalexample>
482
454
      <para>
483
 
        Prompt for a password, encrypt it with the key in <filename
484
 
        class="directory">/etc/mandos</filename> and output a section
485
 
        suitable for <filename>clients.conf</filename>.
 
455
        Prompt for a password, encrypt it with the key in
 
456
        <filename>/etc/mandos</filename> and output a section suitable
 
457
        for <filename>clients.conf</filename>.
486
458
      </para>
487
459
      <para>
488
460
        <userinput>&COMMANDNAME; --password</userinput>
530
502
      <citerefentry><refentrytitle>mandos</refentrytitle>
531
503
      <manvolnum>8</manvolnum></citerefentry>,
532
504
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
534
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
535
 
      <manvolnum>1</manvolnum></citerefentry>
 
505
      <manvolnum>8mandos</manvolnum></citerefentry>
536
506
    </para>
537
507
  </refsect1>
538
508