/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: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

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 "2009-01-04">
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
 
      <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
36
      <holder>Teddy Hogeborn</holder>
46
37
      <holder>Björn Påhlsson</holder>
47
38
    </copyright>
126
117
        <replaceable>TIME</replaceable></option></arg>
127
118
      </group>
128
119
      <sbr/>
129
 
      <group>
130
 
        <arg choice="plain"><option>--force</option></arg>
131
 
        <arg choice="plain"><option>-f</option></arg>
132
 
      </group>
 
120
      <arg><option>--force</option></arg>
133
121
    </cmdsynopsis>
134
122
    <cmdsynopsis>
135
123
      <command>&COMMANDNAME;</command>
155
143
        <arg choice="plain"><option>-n
156
144
        <replaceable>NAME</replaceable></option></arg>
157
145
      </group>
158
 
      <group>
159
 
        <arg choice="plain"><option>--no-ssh</option></arg>
160
 
        <arg choice="plain"><option>-S</option></arg>
161
 
      </group>
162
146
    </cmdsynopsis>
163
147
    <cmdsynopsis>
164
148
      <command>&COMMANDNAME;</command>
229
213
        <listitem>
230
214
          <para>
231
215
            Target directory for key files.  Default is
232
 
            <filename class="directory">/etc/mandos</filename>.
 
216
            <filename>/etc/mandos</filename>.
233
217
          </para>
234
218
        </listitem>
235
219
      </varlistentry>
241
225
        <replaceable>TYPE</replaceable></option></term>
242
226
        <listitem>
243
227
          <para>
244
 
            Key type.  Default is <quote>RSA</quote>.
 
228
            Key type.  Default is <quote>DSA</quote>.
245
229
          </para>
246
230
        </listitem>
247
231
      </varlistentry>
253
237
        <replaceable>BITS</replaceable></option></term>
254
238
        <listitem>
255
239
          <para>
256
 
            Key length in bits.  Default is 4096.
 
240
            Key length in bits.  Default is 2048.
257
241
          </para>
258
242
        </listitem>
259
243
      </varlistentry>
265
249
        <replaceable>KEYTYPE</replaceable></option></term>
266
250
        <listitem>
267
251
          <para>
268
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
252
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
269
253
            encryption-only).
270
254
          </para>
271
255
        </listitem>
278
262
        <replaceable>BITS</replaceable></option></term>
279
263
        <listitem>
280
264
          <para>
281
 
            Subkey length in bits.  Default is 4096.
 
265
            Subkey length in bits.  Default is 2048.
282
266
          </para>
283
267
        </listitem>
284
268
      </varlistentry>
302
286
        <replaceable>TEXT</replaceable></option></term>
303
287
        <listitem>
304
288
          <para>
305
 
            Comment field for key.  Default is empty.
 
289
            Comment field for key.  The default value is
 
290
            <quote><literal>Mandos client key</literal></quote>.
306
291
          </para>
307
292
        </listitem>
308
293
      </varlistentry>
360
345
          </para>
361
346
        </listitem>
362
347
      </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
348
    </variablelist>
380
349
  </refsect1>
381
350
  
441
410
        </listitem>
442
411
      </varlistentry>
443
412
      <varlistentry>
444
 
        <term><filename class="directory">/tmp</filename></term>
 
413
        <term><filename>/tmp</filename></term>
445
414
        <listitem>
446
415
          <para>
447
416
            Temporary files will be written here if
452
421
    </variablelist>
453
422
  </refsect1>
454
423
  
455
 
  <refsect1 id="bugs">
456
 
    <title>BUGS</title>
457
 
    <xi:include href="bugs.xml"/>
458
 
  </refsect1>
 
424
<!--   <refsect1 id="bugs"> -->
 
425
<!--     <title>BUGS</title> -->
 
426
<!--     <para> -->
 
427
<!--     </para> -->
 
428
<!--   </refsect1> -->
459
429
  
460
430
  <refsect1 id="example">
461
431
    <title>EXAMPLE</title>
481
451
    </informalexample>
482
452
    <informalexample>
483
453
      <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>.
 
454
        Prompt for a password, encrypt it with the key in
 
455
        <filename>/etc/mandos</filename> and output a section suitable
 
456
        for <filename>clients.conf</filename>.
487
457
      </para>
488
458
      <para>
489
459
        <userinput>&COMMANDNAME; --password</userinput>
522
492
  <refsect1 id="see_also">
523
493
    <title>SEE ALSO</title>
524
494
    <para>
525
 
      <citerefentry><refentrytitle>intro</refentrytitle>
526
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
527
495
      <citerefentry><refentrytitle>gpg</refentrytitle>
528
496
      <manvolnum>1</manvolnum></citerefentry>,
529
497
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
531
499
      <citerefentry><refentrytitle>mandos</refentrytitle>
532
500
      <manvolnum>8</manvolnum></citerefentry>,
533
501
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
535
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
536
 
      <manvolnum>1</manvolnum></citerefentry>
 
502
      <manvolnum>8mandos</manvolnum></citerefentry>
537
503
    </para>
538
504
  </refsect1>
539
505