/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

* debian/mandos-client.README.Debian: Document network hook facility.
* debian/mandos-client.docs (network-hooks.d): Added.
* initramfs-tools-hook: Also pass VERBOSITY to network hook.
* plugins.d/mandos-client.xml (DESCRIPTION): Document network
                                             interface selection
                                             algorithm.
  (OPTIONS/--interface): Refer to NETWORK HOOKS section.
  (OVERVIEW): Refer to password-prompt(8mandos) explicitly.
  (NETWORK HOOKS): New section.
  (FILES): Add "/lib/mandos/network-hooks.d".

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
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
 
      <year>2018</year>
45
37
      <holder>Teddy Hogeborn</holder>
46
38
      <holder>Björn Påhlsson</holder>
47
39
    </copyright>
126
118
        <replaceable>TIME</replaceable></option></arg>
127
119
      </group>
128
120
      <sbr/>
129
 
      <group>
130
 
        <arg choice="plain"><option>--force</option></arg>
131
 
        <arg choice="plain"><option>-f</option></arg>
132
 
      </group>
 
121
      <arg><option>--force</option></arg>
133
122
    </cmdsynopsis>
134
123
    <cmdsynopsis>
135
124
      <command>&COMMANDNAME;</command>
155
144
        <arg choice="plain"><option>-n
156
145
        <replaceable>NAME</replaceable></option></arg>
157
146
      </group>
158
 
      <group>
159
 
        <arg choice="plain"><option>--no-ssh</option></arg>
160
 
        <arg choice="plain"><option>-S</option></arg>
161
 
      </group>
162
147
    </cmdsynopsis>
163
148
    <cmdsynopsis>
164
149
      <command>&COMMANDNAME;</command>
229
214
        <listitem>
230
215
          <para>
231
216
            Target directory for key files.  Default is
232
 
            <filename class="directory">/etc/mandos</filename>.
 
217
            <filename>/etc/mandos</filename>.
233
218
          </para>
234
219
        </listitem>
235
220
      </varlistentry>
241
226
        <replaceable>TYPE</replaceable></option></term>
242
227
        <listitem>
243
228
          <para>
244
 
            Key type.  Default is <quote>RSA</quote>.
 
229
            Key type.  Default is <quote>DSA</quote>.
245
230
          </para>
246
231
        </listitem>
247
232
      </varlistentry>
253
238
        <replaceable>BITS</replaceable></option></term>
254
239
        <listitem>
255
240
          <para>
256
 
            Key length in bits.  Default is 4096.
 
241
            Key length in bits.  Default is 2048.
257
242
          </para>
258
243
        </listitem>
259
244
      </varlistentry>
265
250
        <replaceable>KEYTYPE</replaceable></option></term>
266
251
        <listitem>
267
252
          <para>
268
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
253
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
269
254
            encryption-only).
270
255
          </para>
271
256
        </listitem>
278
263
        <replaceable>BITS</replaceable></option></term>
279
264
        <listitem>
280
265
          <para>
281
 
            Subkey length in bits.  Default is 4096.
 
266
            Subkey length in bits.  Default is 2048.
282
267
          </para>
283
268
        </listitem>
284
269
      </varlistentry>
302
287
        <replaceable>TEXT</replaceable></option></term>
303
288
        <listitem>
304
289
          <para>
305
 
            Comment field for key.  Default is empty.
 
290
            Comment field for key.  The default value is
 
291
            <quote><literal>Mandos client key</literal></quote>.
306
292
          </para>
307
293
        </listitem>
308
294
      </varlistentry>
360
346
          </para>
361
347
        </listitem>
362
348
      </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
349
    </variablelist>
380
350
  </refsect1>
381
351
  
441
411
        </listitem>
442
412
      </varlistentry>
443
413
      <varlistentry>
444
 
        <term><filename class="directory">/tmp</filename></term>
 
414
        <term><filename>/tmp</filename></term>
445
415
        <listitem>
446
416
          <para>
447
417
            Temporary files will be written here if
452
422
    </variablelist>
453
423
  </refsect1>
454
424
  
455
 
  <refsect1 id="bugs">
456
 
    <title>BUGS</title>
457
 
    <xi:include href="bugs.xml"/>
458
 
  </refsect1>
 
425
<!--   <refsect1 id="bugs"> -->
 
426
<!--     <title>BUGS</title> -->
 
427
<!--     <para> -->
 
428
<!--     </para> -->
 
429
<!--   </refsect1> -->
459
430
  
460
431
  <refsect1 id="example">
461
432
    <title>EXAMPLE</title>
481
452
    </informalexample>
482
453
    <informalexample>
483
454
      <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>.
 
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>.
487
458
      </para>
488
459
      <para>
489
460
        <userinput>&COMMANDNAME; --password</userinput>
531
502
      <citerefentry><refentrytitle>mandos</refentrytitle>
532
503
      <manvolnum>8</manvolnum></citerefentry>,
533
504
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
535
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
536
 
      <manvolnum>1</manvolnum></citerefentry>
 
505
      <manvolnum>8mandos</manvolnum></citerefentry>
537
506
    </para>
538
507
  </refsect1>
539
508