/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: 2015-08-10 07:34:37 UTC
  • Revision ID: teddy@recompile.se-20150810073437-3m8jgt13nqric6vf
Revert change to D-Bus API.

The D-Bus API signal CheckerCompleted is documented to provide a
wait(2) status value.  Since the server switched to using subprocess
to run checkers, it no longer has access to a wait(2) status value.  A
previous change to work around this made the D-Bus API incompatible.
Revert this change by constructing a fake wait(2) status value; this
keeps the D-Bus API stable.

* DBUS-API (CheckerCompleted): Revert incompatible change.
* mandos (ClientDBus.checker_callback): Construct fake wait(2) status.
* mandos-monitor (MandosClientWidget.checker_completed): Revert to
                                                         using
                                                         original API
                                                         with wait(2)
                                                         condition
                                                         value.

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 "2011-10-03">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
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>
36
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
37
42
      <holder>Teddy Hogeborn</holder>
38
43
      <holder>Björn Påhlsson</holder>
39
44
    </copyright>
118
123
        <replaceable>TIME</replaceable></option></arg>
119
124
      </group>
120
125
      <sbr/>
121
 
      <arg><option>--force</option></arg>
 
126
      <group>
 
127
        <arg choice="plain"><option>--force</option></arg>
 
128
        <arg choice="plain"><option>-f</option></arg>
 
129
      </group>
122
130
    </cmdsynopsis>
123
131
    <cmdsynopsis>
124
132
      <command>&COMMANDNAME;</command>
144
152
        <arg choice="plain"><option>-n
145
153
        <replaceable>NAME</replaceable></option></arg>
146
154
      </group>
 
155
      <group>
 
156
        <arg choice="plain"><option>--no-ssh</option></arg>
 
157
        <arg choice="plain"><option>-S</option></arg>
 
158
      </group>
147
159
    </cmdsynopsis>
148
160
    <cmdsynopsis>
149
161
      <command>&COMMANDNAME;</command>
214
226
        <listitem>
215
227
          <para>
216
228
            Target directory for key files.  Default is
217
 
            <filename>/etc/mandos</filename>.
 
229
            <filename class="directory">/etc/mandos</filename>.
218
230
          </para>
219
231
        </listitem>
220
232
      </varlistentry>
226
238
        <replaceable>TYPE</replaceable></option></term>
227
239
        <listitem>
228
240
          <para>
229
 
            Key type.  Default is <quote>DSA</quote>.
 
241
            Key type.  Default is <quote>RSA</quote>.
230
242
          </para>
231
243
        </listitem>
232
244
      </varlistentry>
238
250
        <replaceable>BITS</replaceable></option></term>
239
251
        <listitem>
240
252
          <para>
241
 
            Key length in bits.  Default is 2048.
 
253
            Key length in bits.  Default is 4096.
242
254
          </para>
243
255
        </listitem>
244
256
      </varlistentry>
250
262
        <replaceable>KEYTYPE</replaceable></option></term>
251
263
        <listitem>
252
264
          <para>
253
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
265
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
254
266
            encryption-only).
255
267
          </para>
256
268
        </listitem>
263
275
        <replaceable>BITS</replaceable></option></term>
264
276
        <listitem>
265
277
          <para>
266
 
            Subkey length in bits.  Default is 2048.
 
278
            Subkey length in bits.  Default is 4096.
267
279
          </para>
268
280
        </listitem>
269
281
      </varlistentry>
287
299
        <replaceable>TEXT</replaceable></option></term>
288
300
        <listitem>
289
301
          <para>
290
 
            Comment field for key.  The default value is
291
 
            <quote><literal>Mandos client key</literal></quote>.
 
302
            Comment field for key.  Default is empty.
292
303
          </para>
293
304
        </listitem>
294
305
      </varlistentry>
346
357
          </para>
347
358
        </listitem>
348
359
      </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>
349
376
    </variablelist>
350
377
  </refsect1>
351
378
  
411
438
        </listitem>
412
439
      </varlistentry>
413
440
      <varlistentry>
414
 
        <term><filename>/tmp</filename></term>
 
441
        <term><filename class="directory">/tmp</filename></term>
415
442
        <listitem>
416
443
          <para>
417
444
            Temporary files will be written here if
452
479
    </informalexample>
453
480
    <informalexample>
454
481
      <para>
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>.
 
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>.
458
485
      </para>
459
486
      <para>
460
487
        <userinput>&COMMANDNAME; --password</userinput>
502
529
      <citerefentry><refentrytitle>mandos</refentrytitle>
503
530
      <manvolnum>8</manvolnum></citerefentry>,
504
531
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
505
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
532
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
533
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
534
      <manvolnum>1</manvolnum></citerefentry>
506
535
    </para>
507
536
  </refsect1>
508
537