/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-05-23 20:18:34 UTC
  • mto: This revision was merged to the branch mainline in revision 756.
  • Revision ID: teddy@recompile.se-20150523201834-e89ex4ito93yni8x
mandos: Use multiprocessing module to run checkers.

For a long time, the Mandos server has occasionally logged the message
"ERROR: Child process vanished".  This was never a fatal error, but it
has been annoying and slightly worrying, since a definite cause was
not found.  One potential cause could be the "multiprocessing" and
"subprocess" modules conflicting w.r.t. SIGCHLD.  To avoid this,
change the running of checkers from using subprocess.Popen
asynchronously to instead first create a multiprocessing.Process()
(which is asynchronous) calling a function, and have that function
then call subprocess.call() (which is synchronous).  In this way, the
only thing using any asynchronous subprocesses is the multiprocessing
module.

This makes it necessary to change one small thing in the D-Bus API,
since the subprocesses.call() function does not expose the raw wait(2)
status value.

DBUS-API (CheckerCompleted): Change the second value provided by this
                             D-Bus signal from the raw wait(2) status
                             to the actual terminating signal number.
mandos (subprocess_call_pipe): New function to be called by
                               multiprocessing.Process (starting a
                               separate process).
(Client.last_checker signal): New attribute for signal which
                              terminated last checker.  Like
                              last_checker_status, only not accessible
                              via D-Bus.
(Client.checker_callback): Take new "connection" argument and use it
                           to get returncode; set last_checker_signal.
                           Return False so gobject does not call this
                           callback again.
(Client.start_checker): Start checker using a multiprocessing.Process
                        instead of a subprocess.Popen.
(ClientDBus.checker_callback): Take new "connection" argument.        Call
                               Client.checker_callback early to have
                               it set last_checker_status and
                               last_checker_signal; use those.  Change
                               second value provided to D-Bus signal
                               CheckerCompleted to use
                               last_checker_signal if checker was
                               terminated by signal.
mandos-monitor: Update to reflect DBus API change.
(MandosClientWidget.checker_completed): Take "signal" instead of
                                        "condition" argument.  Use it
                                        accordingly.  Remove dead code
                                        (os.WCOREDUMP case).

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2014-06-22">
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>
37
38
      <holder>Teddy Hogeborn</holder>
38
39
      <holder>Björn Påhlsson</holder>
39
40
    </copyright>
118
119
        <replaceable>TIME</replaceable></option></arg>
119
120
      </group>
120
121
      <sbr/>
121
 
      <arg><option>--force</option></arg>
 
122
      <group>
 
123
        <arg choice="plain"><option>--force</option></arg>
 
124
        <arg choice="plain"><option>-f</option></arg>
 
125
      </group>
122
126
    </cmdsynopsis>
123
127
    <cmdsynopsis>
124
128
      <command>&COMMANDNAME;</command>
144
148
        <arg choice="plain"><option>-n
145
149
        <replaceable>NAME</replaceable></option></arg>
146
150
      </group>
 
151
      <group>
 
152
        <arg choice="plain"><option>--no-ssh</option></arg>
 
153
        <arg choice="plain"><option>-S</option></arg>
 
154
      </group>
147
155
    </cmdsynopsis>
148
156
    <cmdsynopsis>
149
157
      <command>&COMMANDNAME;</command>
214
222
        <listitem>
215
223
          <para>
216
224
            Target directory for key files.  Default is
217
 
            <filename>/etc/mandos</filename>.
 
225
            <filename class="directory">/etc/mandos</filename>.
218
226
          </para>
219
227
        </listitem>
220
228
      </varlistentry>
226
234
        <replaceable>TYPE</replaceable></option></term>
227
235
        <listitem>
228
236
          <para>
229
 
            Key type.  Default is <quote>DSA</quote>.
 
237
            Key type.  Default is <quote>RSA</quote>.
230
238
          </para>
231
239
        </listitem>
232
240
      </varlistentry>
238
246
        <replaceable>BITS</replaceable></option></term>
239
247
        <listitem>
240
248
          <para>
241
 
            Key length in bits.  Default is 2048.
 
249
            Key length in bits.  Default is 4096.
242
250
          </para>
243
251
        </listitem>
244
252
      </varlistentry>
250
258
        <replaceable>KEYTYPE</replaceable></option></term>
251
259
        <listitem>
252
260
          <para>
253
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
261
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
254
262
            encryption-only).
255
263
          </para>
256
264
        </listitem>
263
271
        <replaceable>BITS</replaceable></option></term>
264
272
        <listitem>
265
273
          <para>
266
 
            Subkey length in bits.  Default is 2048.
 
274
            Subkey length in bits.  Default is 4096.
267
275
          </para>
268
276
        </listitem>
269
277
      </varlistentry>
287
295
        <replaceable>TEXT</replaceable></option></term>
288
296
        <listitem>
289
297
          <para>
290
 
            Comment field for key.  The default value is
291
 
            <quote><literal>Mandos client key</literal></quote>.
 
298
            Comment field for key.  Default is empty.
292
299
          </para>
293
300
        </listitem>
294
301
      </varlistentry>
346
353
          </para>
347
354
        </listitem>
348
355
      </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>
349
372
    </variablelist>
350
373
  </refsect1>
351
374
  
411
434
        </listitem>
412
435
      </varlistentry>
413
436
      <varlistentry>
414
 
        <term><filename>/tmp</filename></term>
 
437
        <term><filename class="directory">/tmp</filename></term>
415
438
        <listitem>
416
439
          <para>
417
440
            Temporary files will be written here if
452
475
    </informalexample>
453
476
    <informalexample>
454
477
      <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>.
 
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>.
458
481
      </para>
459
482
      <para>
460
483
        <userinput>&COMMANDNAME; --password</userinput>
502
525
      <citerefentry><refentrytitle>mandos</refentrytitle>
503
526
      <manvolnum>8</manvolnum></citerefentry>,
504
527
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
505
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
528
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
529
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
530
      <manvolnum>1</manvolnum></citerefentry>
506
531
    </para>
507
532
  </refsect1>
508
533