/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

* 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 "2014-06-22">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
36
      <year>2011</year>
37
 
      <year>2012</year>
38
37
      <holder>Teddy Hogeborn</holder>
39
38
      <holder>Björn Påhlsson</holder>
40
39
    </copyright>
119
118
        <replaceable>TIME</replaceable></option></arg>
120
119
      </group>
121
120
      <sbr/>
122
 
      <group>
123
 
        <arg choice="plain"><option>--force</option></arg>
124
 
        <arg choice="plain"><option>-f</option></arg>
125
 
      </group>
 
121
      <arg><option>--force</option></arg>
126
122
    </cmdsynopsis>
127
123
    <cmdsynopsis>
128
124
      <command>&COMMANDNAME;</command>
148
144
        <arg choice="plain"><option>-n
149
145
        <replaceable>NAME</replaceable></option></arg>
150
146
      </group>
151
 
      <group>
152
 
        <arg choice="plain"><option>--no-ssh</option></arg>
153
 
        <arg choice="plain"><option>-S</option></arg>
154
 
      </group>
155
147
    </cmdsynopsis>
156
148
    <cmdsynopsis>
157
149
      <command>&COMMANDNAME;</command>
222
214
        <listitem>
223
215
          <para>
224
216
            Target directory for key files.  Default is
225
 
            <filename class="directory">/etc/mandos</filename>.
 
217
            <filename>/etc/mandos</filename>.
226
218
          </para>
227
219
        </listitem>
228
220
      </varlistentry>
234
226
        <replaceable>TYPE</replaceable></option></term>
235
227
        <listitem>
236
228
          <para>
237
 
            Key type.  Default is <quote>RSA</quote>.
 
229
            Key type.  Default is <quote>DSA</quote>.
238
230
          </para>
239
231
        </listitem>
240
232
      </varlistentry>
246
238
        <replaceable>BITS</replaceable></option></term>
247
239
        <listitem>
248
240
          <para>
249
 
            Key length in bits.  Default is 4096.
 
241
            Key length in bits.  Default is 2048.
250
242
          </para>
251
243
        </listitem>
252
244
      </varlistentry>
258
250
        <replaceable>KEYTYPE</replaceable></option></term>
259
251
        <listitem>
260
252
          <para>
261
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
253
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
262
254
            encryption-only).
263
255
          </para>
264
256
        </listitem>
271
263
        <replaceable>BITS</replaceable></option></term>
272
264
        <listitem>
273
265
          <para>
274
 
            Subkey length in bits.  Default is 4096.
 
266
            Subkey length in bits.  Default is 2048.
275
267
          </para>
276
268
        </listitem>
277
269
      </varlistentry>
295
287
        <replaceable>TEXT</replaceable></option></term>
296
288
        <listitem>
297
289
          <para>
298
 
            Comment field for key.  Default is empty.
 
290
            Comment field for key.  The default value is
 
291
            <quote><literal>Mandos client key</literal></quote>.
299
292
          </para>
300
293
        </listitem>
301
294
      </varlistentry>
353
346
          </para>
354
347
        </listitem>
355
348
      </varlistentry>
356
 
      <varlistentry>
357
 
        <term><option>--no-ssh</option></term>
358
 
        <term><option>-S</option></term>
359
 
        <listitem>
360
 
          <para>
361
 
            When <option>--password</option> or
362
 
            <option>--passfile</option> is given, this option will
363
 
            prevent <command>&COMMANDNAME;</command> from calling
364
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
365
 
            for this host and, if successful, output suitable config
366
 
            options to use this fingerprint as a
367
 
            <option>checker</option> option in the output.  This is
368
 
            otherwise the default behavior.
369
 
          </para>
370
 
        </listitem>
371
 
      </varlistentry>
372
349
    </variablelist>
373
350
  </refsect1>
374
351
  
434
411
        </listitem>
435
412
      </varlistentry>
436
413
      <varlistentry>
437
 
        <term><filename class="directory">/tmp</filename></term>
 
414
        <term><filename>/tmp</filename></term>
438
415
        <listitem>
439
416
          <para>
440
417
            Temporary files will be written here if
475
452
    </informalexample>
476
453
    <informalexample>
477
454
      <para>
478
 
        Prompt for a password, encrypt it with the key in <filename
479
 
        class="directory">/etc/mandos</filename> and output a section
480
 
        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>.
481
458
      </para>
482
459
      <para>
483
460
        <userinput>&COMMANDNAME; --password</userinput>
525
502
      <citerefentry><refentrytitle>mandos</refentrytitle>
526
503
      <manvolnum>8</manvolnum></citerefentry>,
527
504
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
528
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
529
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
530
 
      <manvolnum>1</manvolnum></citerefentry>
 
505
      <manvolnum>8mandos</manvolnum></citerefentry>
531
506
    </para>
532
507
  </refsect1>
533
508