/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-10-05 17:38:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081005173831-fysrfayl4yvhlo6x
* INSTALL: Add instructions on how to set the correct network
           interface on the cient, and also how to test the server and
           verify the password.

* TODO: Clean up old stuff.

* debian/mandos-client.README.Debian: Separate into sections with
                                      headlines.  Add instructions on
                                      how to test the server and
                                      verify the password.

* plugin-runner.conf: Add reminder to update initrd image.

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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2008-10-03">
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
 
      <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
35
      <holder>Teddy Hogeborn</holder>
43
36
      <holder>Björn Påhlsson</holder>
44
37
    </copyright>
123
116
        <replaceable>TIME</replaceable></option></arg>
124
117
      </group>
125
118
      <sbr/>
126
 
      <group>
127
 
        <arg choice="plain"><option>--force</option></arg>
128
 
        <arg choice="plain"><option>-f</option></arg>
129
 
      </group>
 
119
      <arg><option>--force</option></arg>
130
120
    </cmdsynopsis>
131
121
    <cmdsynopsis>
132
122
      <command>&COMMANDNAME;</command>
152
142
        <arg choice="plain"><option>-n
153
143
        <replaceable>NAME</replaceable></option></arg>
154
144
      </group>
155
 
      <group>
156
 
        <arg choice="plain"><option>--no-ssh</option></arg>
157
 
        <arg choice="plain"><option>-S</option></arg>
158
 
      </group>
159
145
    </cmdsynopsis>
160
146
    <cmdsynopsis>
161
147
      <command>&COMMANDNAME;</command>
226
212
        <listitem>
227
213
          <para>
228
214
            Target directory for key files.  Default is
229
 
            <filename class="directory">/etc/mandos</filename>.
 
215
            <filename>/etc/mandos</filename>.
230
216
          </para>
231
217
        </listitem>
232
218
      </varlistentry>
238
224
        <replaceable>TYPE</replaceable></option></term>
239
225
        <listitem>
240
226
          <para>
241
 
            Key type.  Default is <quote>RSA</quote>.
 
227
            Key type.  Default is <quote>DSA</quote>.
242
228
          </para>
243
229
        </listitem>
244
230
      </varlistentry>
250
236
        <replaceable>BITS</replaceable></option></term>
251
237
        <listitem>
252
238
          <para>
253
 
            Key length in bits.  Default is 4096.
 
239
            Key length in bits.  Default is 2048.
254
240
          </para>
255
241
        </listitem>
256
242
      </varlistentry>
262
248
        <replaceable>KEYTYPE</replaceable></option></term>
263
249
        <listitem>
264
250
          <para>
265
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
251
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
266
252
            encryption-only).
267
253
          </para>
268
254
        </listitem>
275
261
        <replaceable>BITS</replaceable></option></term>
276
262
        <listitem>
277
263
          <para>
278
 
            Subkey length in bits.  Default is 4096.
 
264
            Subkey length in bits.  Default is 2048.
279
265
          </para>
280
266
        </listitem>
281
267
      </varlistentry>
299
285
        <replaceable>TEXT</replaceable></option></term>
300
286
        <listitem>
301
287
          <para>
302
 
            Comment field for key.  Default is empty.
 
288
            Comment field for key.  The default value is
 
289
            <quote><literal>Mandos client key</literal></quote>.
303
290
          </para>
304
291
        </listitem>
305
292
      </varlistentry>
357
344
          </para>
358
345
        </listitem>
359
346
      </varlistentry>
360
 
      <varlistentry>
361
 
        <term><option>--no-ssh</option></term>
362
 
        <term><option>-S</option></term>
363
 
        <listitem>
364
 
          <para>
365
 
            When <option>--password</option> or
366
 
            <option>--passfile</option> is given, this option will
367
 
            prevent <command>&COMMANDNAME;</command> from calling
368
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
369
 
            for this host and, if successful, output suitable config
370
 
            options to use this fingerprint as a
371
 
            <option>checker</option> option in the output.  This is
372
 
            otherwise the default behavior.
373
 
          </para>
374
 
        </listitem>
375
 
      </varlistentry>
376
347
    </variablelist>
377
348
  </refsect1>
378
349
  
438
409
        </listitem>
439
410
      </varlistentry>
440
411
      <varlistentry>
441
 
        <term><filename class="directory">/tmp</filename></term>
 
412
        <term><filename>/tmp</filename></term>
442
413
        <listitem>
443
414
          <para>
444
415
            Temporary files will be written here if
479
450
    </informalexample>
480
451
    <informalexample>
481
452
      <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>.
 
453
        Prompt for a password, encrypt it with the key in
 
454
        <filename>/etc/mandos</filename> and output a section suitable
 
455
        for <filename>clients.conf</filename>.
485
456
      </para>
486
457
      <para>
487
458
        <userinput>&COMMANDNAME; --password</userinput>
520
491
  <refsect1 id="see_also">
521
492
    <title>SEE ALSO</title>
522
493
    <para>
523
 
      <citerefentry><refentrytitle>intro</refentrytitle>
524
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
525
494
      <citerefentry><refentrytitle>gpg</refentrytitle>
526
495
      <manvolnum>1</manvolnum></citerefentry>,
527
496
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
498
      <citerefentry><refentrytitle>mandos</refentrytitle>
530
499
      <manvolnum>8</manvolnum></citerefentry>,
531
500
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
533
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
534
 
      <manvolnum>1</manvolnum></citerefentry>
 
501
      <manvolnum>8mandos</manvolnum></citerefentry>
535
502
    </para>
536
503
  </refsect1>
537
504