/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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-21 12:20:55 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080921122055-vrs4tmw1az0yr92u
* mandos.xml (SECURITY): Minor wording improvement.

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 "2017-02-23">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-20">
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
34
      <holder>Teddy Hogeborn</holder>
45
35
      <holder>Björn Påhlsson</holder>
46
36
    </copyright>
125
115
        <replaceable>TIME</replaceable></option></arg>
126
116
      </group>
127
117
      <sbr/>
128
 
      <group>
129
 
        <arg choice="plain"><option>--force</option></arg>
130
 
        <arg choice="plain"><option>-f</option></arg>
131
 
      </group>
 
118
      <arg><option>--force</option></arg>
132
119
    </cmdsynopsis>
133
120
    <cmdsynopsis>
134
121
      <command>&COMMANDNAME;</command>
154
141
        <arg choice="plain"><option>-n
155
142
        <replaceable>NAME</replaceable></option></arg>
156
143
      </group>
157
 
      <group>
158
 
        <arg choice="plain"><option>--no-ssh</option></arg>
159
 
        <arg choice="plain"><option>-S</option></arg>
160
 
      </group>
161
144
    </cmdsynopsis>
162
145
    <cmdsynopsis>
163
146
      <command>&COMMANDNAME;</command>
228
211
        <listitem>
229
212
          <para>
230
213
            Target directory for key files.  Default is
231
 
            <filename class="directory">/etc/mandos</filename>.
 
214
            <filename>/etc/mandos</filename>.
232
215
          </para>
233
216
        </listitem>
234
217
      </varlistentry>
240
223
        <replaceable>TYPE</replaceable></option></term>
241
224
        <listitem>
242
225
          <para>
243
 
            Key type.  Default is <quote>RSA</quote>.
 
226
            Key type.  Default is <quote>DSA</quote>.
244
227
          </para>
245
228
        </listitem>
246
229
      </varlistentry>
252
235
        <replaceable>BITS</replaceable></option></term>
253
236
        <listitem>
254
237
          <para>
255
 
            Key length in bits.  Default is 4096.
 
238
            Key length in bits.  Default is 2048.
256
239
          </para>
257
240
        </listitem>
258
241
      </varlistentry>
264
247
        <replaceable>KEYTYPE</replaceable></option></term>
265
248
        <listitem>
266
249
          <para>
267
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
250
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
268
251
            encryption-only).
269
252
          </para>
270
253
        </listitem>
277
260
        <replaceable>BITS</replaceable></option></term>
278
261
        <listitem>
279
262
          <para>
280
 
            Subkey length in bits.  Default is 4096.
 
263
            Subkey length in bits.  Default is 2048.
281
264
          </para>
282
265
        </listitem>
283
266
      </varlistentry>
301
284
        <replaceable>TEXT</replaceable></option></term>
302
285
        <listitem>
303
286
          <para>
304
 
            Comment field for key.  Default is empty.
 
287
            Comment field for key.  The default value is
 
288
            <quote><literal>Mandos client key</literal></quote>.
305
289
          </para>
306
290
        </listitem>
307
291
      </varlistentry>
359
343
          </para>
360
344
        </listitem>
361
345
      </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
346
    </variablelist>
379
347
  </refsect1>
380
348
  
413
381
    </variablelist>
414
382
  </refsect1>
415
383
  
416
 
  <refsect1 id="files">
 
384
  <refsect1 id="file">
417
385
    <title>FILES</title>
418
386
    <para>
419
387
      Use the <option>--dir</option> option to change where
440
408
        </listitem>
441
409
      </varlistentry>
442
410
      <varlistentry>
443
 
        <term><filename class="directory">/tmp</filename></term>
 
411
        <term><filename>/tmp</filename></term>
444
412
        <listitem>
445
413
          <para>
446
414
            Temporary files will be written here if
451
419
    </variablelist>
452
420
  </refsect1>
453
421
  
454
 
  <refsect1 id="bugs">
455
 
    <title>BUGS</title>
456
 
    <xi:include href="bugs.xml"/>
457
 
  </refsect1>
 
422
<!--   <refsect1 id="bugs"> -->
 
423
<!--     <title>BUGS</title> -->
 
424
<!--     <para> -->
 
425
<!--     </para> -->
 
426
<!--   </refsect1> -->
458
427
  
459
428
  <refsect1 id="example">
460
429
    <title>EXAMPLE</title>
480
449
    </informalexample>
481
450
    <informalexample>
482
451
      <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>.
 
452
        Prompt for a password, encrypt it with the key in
 
453
        <filename>/etc/mandos</filename> and output a section suitable
 
454
        for <filename>clients.conf</filename>.
486
455
      </para>
487
456
      <para>
488
457
        <userinput>&COMMANDNAME; --password</userinput>
521
490
  <refsect1 id="see_also">
522
491
    <title>SEE ALSO</title>
523
492
    <para>
524
 
      <citerefentry><refentrytitle>intro</refentrytitle>
525
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
526
493
      <citerefentry><refentrytitle>gpg</refentrytitle>
527
494
      <manvolnum>1</manvolnum></citerefentry>,
528
495
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
530
497
      <citerefentry><refentrytitle>mandos</refentrytitle>
531
498
      <manvolnum>8</manvolnum></citerefentry>,
532
499
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
534
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
535
 
      <manvolnum>1</manvolnum></citerefentry>
 
500
      <manvolnum>8mandos</manvolnum></citerefentry>
536
501
    </para>
537
502
  </refsect1>
538
503