/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-ctl

  • 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:
3
3
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
6
 
# Copyright © 2008-2012 Teddy Hogeborn
7
 
# Copyright © 2008-2012 Björn Påhlsson
 
6
# Copyright © 2008-2015 Teddy Hogeborn
 
7
# Copyright © 2008-2015 Björn Påhlsson
8
8
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
28
 
29
 
from future_builtins import *
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
30
33
 
31
34
import sys
32
35
import argparse
39
42
 
40
43
import dbus
41
44
 
 
45
if sys.version_info.major == 2:
 
46
    str = unicode
 
47
 
42
48
locale.setlocale(locale.LC_ALL, "")
43
49
 
44
50
tablewords = {
58
64
    "ApprovalDelay": "Approval Delay",
59
65
    "ApprovalDuration": "Approval Duration",
60
66
    "Checker": "Checker",
61
 
    "ExtendedTimeout" : "Extended Timeout"
62
 
    }
 
67
    "ExtendedTimeout": "Extended Timeout"
 
68
}
63
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
70
domain = "se.recompile"
65
71
busname = domain + ".Mandos"
66
72
server_path = "/"
67
73
server_interface = domain + ".Mandos"
68
74
client_interface = domain + ".Mandos.Client"
69
 
version = "1.6.0"
 
75
version = "1.6.9"
70
76
 
71
 
def timedelta_to_milliseconds(td):
72
 
    """Convert a datetime.timedelta object to milliseconds"""
73
 
    return ((td.days * 24 * 60 * 60 * 1000)
74
 
            + (td.seconds * 1000)
75
 
            + (td.microseconds // 1000))
76
77
 
77
78
def milliseconds_to_string(ms):
78
79
    td = datetime.timedelta(0, 0, 0, ms)
79
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
 
            .format(days = "{0}T".format(td.days) if td.days else "",
81
 
                    hours = td.seconds // 3600,
82
 
                    minutes = (td.seconds % 3600) // 60,
83
 
                    seconds = td.seconds % 60,
84
 
                    ))
 
80
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
81
        days = "{}T".format(td.days) if td.days else "",
 
82
        hours = td.seconds // 3600,
 
83
        minutes = (td.seconds % 3600) // 60,
 
84
        seconds = td.seconds % 60))
85
85
 
86
86
 
87
87
def rfc3339_duration_to_delta(duration):
125
125
    token_end = Token(re.compile(r"$"), None, frozenset())
126
126
    token_second = Token(re.compile(r"(\d+)S"),
127
127
                         datetime.timedelta(seconds=1),
128
 
                         frozenset((token_end,)))
 
128
                         frozenset((token_end, )))
129
129
    token_minute = Token(re.compile(r"(\d+)M"),
130
130
                         datetime.timedelta(minutes=1),
131
131
                         frozenset((token_second, token_end)))
147
147
                       frozenset((token_month, token_end)))
148
148
    token_week = Token(re.compile(r"(\d+)W"),
149
149
                       datetime.timedelta(weeks=1),
150
 
                       frozenset((token_end,)))
 
150
                       frozenset((token_end, )))
151
151
    token_duration = Token(re.compile(r"P"), None,
152
152
                           frozenset((token_year, token_month,
153
153
                                      token_day, token_time,
154
 
                                      token_week))),
 
154
                                      token_week)))
155
155
    # Define starting values
156
156
    value = datetime.timedelta() # Value so far
157
157
    found_token = None
158
 
    followers = frozenset(token_duration,) # Following valid tokens
 
158
    followers = frozenset((token_duration, )) # Following valid tokens
159
159
    s = duration                # String left to parse
160
160
    # Loop until end token is found
161
161
    while found_token is not token_end:
223
223
            value += datetime.timedelta(0, 0, 0, int(num))
224
224
    return value
225
225
 
 
226
 
226
227
def print_clients(clients, keywords):
227
228
    def valuetostring(value, keyword):
228
229
        if type(value) is dbus.Boolean:
230
231
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
231
232
                       "ApprovalDuration", "ExtendedTimeout"):
232
233
            return milliseconds_to_string(value)
233
 
        return unicode(value)
 
234
        return str(value)
234
235
    
235
236
    # Create format string to print table rows
236
237
    format_string = " ".join("{{{key}:{width}}}".format(
237
 
            width = max(len(tablewords[key]),
238
 
                        max(len(valuetostring(client[key],
239
 
                                              key))
240
 
                            for client in
241
 
                            clients)),
242
 
            key = key) for key in keywords)
 
238
        width = max(len(tablewords[key]),
 
239
                    max(len(valuetostring(client[key], key))
 
240
                        for client in clients)),
 
241
        key = key)
 
242
                             for key in keywords)
243
243
    # Print header line
244
244
    print(format_string.format(**tablewords))
245
245
    for client in clients:
246
 
        print(format_string.format(**dict((key,
247
 
                                           valuetostring(client[key],
248
 
                                                         key))
249
 
                                          for key in keywords)))
 
246
        print(format_string.format(**{
 
247
            key: valuetostring(client[key], key)
 
248
            for key in keywords }))
 
249
 
250
250
 
251
251
def has_actions(options):
252
252
    return any((options.enable,
268
268
                options.approve,
269
269
                options.deny))
270
270
 
 
271
 
271
272
def main():
272
273
    parser = argparse.ArgumentParser()
273
274
    parser.add_argument("--version", action="version",
274
 
                        version = "%(prog)s {0}".format(version),
 
275
                        version = "%(prog)s {}".format(version),
275
276
                        help="show version number and exit")
276
277
    parser.add_argument("-a", "--all", action="store_true",
277
278
                        help="Select all clients")
310
311
    parser.add_argument("--approval-duration",
311
312
                        help="Set duration of one client approval")
312
313
    parser.add_argument("-H", "--host", help="Set host for client")
313
 
    parser.add_argument("-s", "--secret", type=file,
 
314
    parser.add_argument("-s", "--secret",
 
315
                        type=argparse.FileType(mode="rb"),
314
316
                        help="Set password blob (file) for client")
315
317
    parser.add_argument("-A", "--approve", action="store_true",
316
318
                        help="Approve any current client request")
331
333
 
332
334
    if options.check:
333
335
        fail_count, test_count = doctest.testmod()
334
 
        sys.exit(0 if fail_count == 0 else 1)
 
336
        sys.exit(os.EX_OK if fail_count == 0 else 1)
335
337
    
336
338
    try:
337
339
        bus = dbus.SystemBus()
338
340
        mandos_dbus_objc = bus.get_object(busname, server_path)
339
341
    except dbus.exceptions.DBusException:
340
 
        print("Could not connect to Mandos server",
341
 
              file=sys.stderr)
 
342
        print("Could not connect to Mandos server", file=sys.stderr)
342
343
        sys.exit(1)
343
344
    
344
345
    mandos_serv = dbus.Interface(mandos_dbus_objc,
365
366
    clients={}
366
367
    
367
368
    if options.all or not options.client:
368
 
        clients = dict((bus.get_object(busname, path), properties)
369
 
                       for path, properties in
370
 
                       mandos_clients.iteritems())
 
369
        clients = { bus.get_object(busname, path): properties
 
370
                    for path, properties in mandos_clients.items() }
371
371
    else:
372
372
        for name in options.client:
373
 
            for path, client in mandos_clients.iteritems():
 
373
            for path, client in mandos_clients.items():
374
374
                if client["Name"] == name:
375
375
                    client_objc = bus.get_object(busname, path)
376
376
                    clients[client_objc] = client
377
377
                    break
378
378
            else:
379
 
                print("Client not found on server: {0!r}"
 
379
                print("Client not found on server: {!r}"
380
380
                      .format(name), file=sys.stderr)
381
381
                sys.exit(1)
382
382
    
383
383
    if not has_actions(options) and clients:
384
384
        if options.verbose:
385
 
            keywords = ("Name", "Enabled", "Timeout",
386
 
                        "LastCheckedOK", "Created", "Interval",
387
 
                        "Host", "Fingerprint", "CheckerRunning",
388
 
                        "LastEnabled", "ApprovalPending",
389
 
                        "ApprovedByDefault",
 
385
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
386
                        "Created", "Interval", "Host", "Fingerprint",
 
387
                        "CheckerRunning", "LastEnabled",
 
388
                        "ApprovalPending", "ApprovedByDefault",
390
389
                        "LastApprovalRequest", "ApprovalDelay",
391
390
                        "ApprovalDuration", "Checker",
392
391
                        "ExtendedTimeout")
397
396
    else:
398
397
        # Process each client in the list by all selected options
399
398
        for client in clients:
 
399
            
400
400
            def set_client_prop(prop, value):
401
401
                """Set a Client D-Bus property"""
402
402
                client.Set(client_interface, prop, value,
403
403
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
404
            
404
405
            def set_client_prop_ms(prop, value):
405
406
                """Set a Client D-Bus property, converted
406
407
                from a string to milliseconds."""
407
408
                set_client_prop(prop,
408
 
                                timedelta_to_milliseconds
409
 
                                (string_to_delta(value)))
 
409
                                string_to_delta(value).total_seconds()
 
410
                                * 1000)
 
411
            
410
412
            if options.remove:
411
413
                mandos_serv.RemoveClient(client.__dbus_object_path__)
412
414
            if options.enable:
456
458
                client.Approve(dbus.Boolean(False),
457
459
                               dbus_interface=client_interface)
458
460
 
 
461
 
459
462
if __name__ == "__main__":
460
463
    main()