/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 "2012-01-01">
 
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>
37
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
38
42
      <holder>Teddy Hogeborn</holder>
39
43
      <holder>Björn Påhlsson</holder>
40
44
    </copyright>
119
123
        <replaceable>TIME</replaceable></option></arg>
120
124
      </group>
121
125
      <sbr/>
122
 
      <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>
123
130
    </cmdsynopsis>
124
131
    <cmdsynopsis>
125
132
      <command>&COMMANDNAME;</command>
145
152
        <arg choice="plain"><option>-n
146
153
        <replaceable>NAME</replaceable></option></arg>
147
154
      </group>
 
155
      <group>
 
156
        <arg choice="plain"><option>--no-ssh</option></arg>
 
157
        <arg choice="plain"><option>-S</option></arg>
 
158
      </group>
148
159
    </cmdsynopsis>
149
160
    <cmdsynopsis>
150
161
      <command>&COMMANDNAME;</command>
227
238
        <replaceable>TYPE</replaceable></option></term>
228
239
        <listitem>
229
240
          <para>
230
 
            Key type.  Default is <quote>DSA</quote>.
 
241
            Key type.  Default is <quote>RSA</quote>.
231
242
          </para>
232
243
        </listitem>
233
244
      </varlistentry>
239
250
        <replaceable>BITS</replaceable></option></term>
240
251
        <listitem>
241
252
          <para>
242
 
            Key length in bits.  Default is 2048.
 
253
            Key length in bits.  Default is 4096.
243
254
          </para>
244
255
        </listitem>
245
256
      </varlistentry>
251
262
        <replaceable>KEYTYPE</replaceable></option></term>
252
263
        <listitem>
253
264
          <para>
254
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
265
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
255
266
            encryption-only).
256
267
          </para>
257
268
        </listitem>
264
275
        <replaceable>BITS</replaceable></option></term>
265
276
        <listitem>
266
277
          <para>
267
 
            Subkey length in bits.  Default is 2048.
 
278
            Subkey length in bits.  Default is 4096.
268
279
          </para>
269
280
        </listitem>
270
281
      </varlistentry>
288
299
        <replaceable>TEXT</replaceable></option></term>
289
300
        <listitem>
290
301
          <para>
291
 
            Comment field for key.  The default value is
292
 
            <quote><literal>Mandos client key</literal></quote>.
 
302
            Comment field for key.  Default is empty.
293
303
          </para>
294
304
        </listitem>
295
305
      </varlistentry>
347
357
          </para>
348
358
        </listitem>
349
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>
350
376
    </variablelist>
351
377
  </refsect1>
352
378
  
503
529
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
530
      <manvolnum>8</manvolnum></citerefentry>,
505
531
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
506
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
532
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
533
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
534
      <manvolnum>1</manvolnum></citerefentry>
507
535
    </para>
508
536
  </refsect1>
509
537