/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2015-05-23 20:18:34 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • 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:
mandos-ctl
3
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
# 
6
 
# Copyright © 2008-2011 Teddy Hogeborn
7
 
# Copyright © 2008-2011 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
17
17
#     GNU General Public License for more details.
18
18
# 
19
19
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
21
22
# 
22
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
25
26
from __future__ import (division, absolute_import, print_function,
26
27
                        unicode_literals)
27
28
 
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
 
33
 
28
34
import sys
29
 
import dbus
30
35
import argparse
31
36
import locale
32
37
import datetime
33
38
import re
34
39
import os
 
40
import collections
 
41
import doctest
 
42
 
 
43
import dbus
 
44
 
 
45
if sys.version_info.major == 2:
 
46
    str = unicode
35
47
 
36
48
locale.setlocale(locale.LC_ALL, "")
37
49
 
52
64
    "ApprovalDelay": "Approval Delay",
53
65
    "ApprovalDuration": "Approval Duration",
54
66
    "Checker": "Checker",
55
 
    "ExtendedTimeout" : "Extended Timeout"
56
 
    }
 
67
    "ExtendedTimeout": "Extended Timeout"
 
68
}
57
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
58
70
domain = "se.recompile"
59
71
busname = domain + ".Mandos"
60
72
server_path = "/"
61
73
server_interface = domain + ".Mandos"
62
74
client_interface = domain + ".Mandos.Client"
63
 
version = "1.4.1"
 
75
version = "1.6.9"
64
76
 
65
 
def timedelta_to_milliseconds(td):
66
 
    """Convert a datetime.timedelta object to milliseconds"""
67
 
    return ((td.days * 24 * 60 * 60 * 1000)
68
 
            + (td.seconds * 1000)
69
 
            + (td.microseconds // 1000))
70
77
 
71
78
def milliseconds_to_string(ms):
72
79
    td = datetime.timedelta(0, 0, 0, ms)
73
 
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
74
 
            % { "days": "%dT" % td.days if td.days else "",
75
 
                "hours": td.seconds // 3600,
76
 
                "minutes": (td.seconds % 3600) // 60,
77
 
                "seconds": td.seconds % 60,
78
 
                })
 
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
 
 
86
 
 
87
def rfc3339_duration_to_delta(duration):
 
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
89
    
 
90
    >>> rfc3339_duration_to_delta("P7D")
 
91
    datetime.timedelta(7)
 
92
    >>> rfc3339_duration_to_delta("PT60S")
 
93
    datetime.timedelta(0, 60)
 
94
    >>> rfc3339_duration_to_delta("PT60M")
 
95
    datetime.timedelta(0, 3600)
 
96
    >>> rfc3339_duration_to_delta("PT24H")
 
97
    datetime.timedelta(1)
 
98
    >>> rfc3339_duration_to_delta("P1W")
 
99
    datetime.timedelta(7)
 
100
    >>> rfc3339_duration_to_delta("PT5M30S")
 
101
    datetime.timedelta(0, 330)
 
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
103
    datetime.timedelta(1, 200)
 
104
    """
 
105
    
 
106
    # Parsing an RFC 3339 duration with regular expressions is not
 
107
    # possible - there would have to be multiple places for the same
 
108
    # values, like seconds.  The current code, while more esoteric, is
 
109
    # cleaner without depending on a parsing library.  If Python had a
 
110
    # built-in library for parsing we would use it, but we'd like to
 
111
    # avoid excessive use of external libraries.
 
112
    
 
113
    # New type for defining tokens, syntax, and semantics all-in-one
 
114
    Token = collections.namedtuple("Token",
 
115
                                   ("regexp", # To match token; if
 
116
                                              # "value" is not None,
 
117
                                              # must have a "group"
 
118
                                              # containing digits
 
119
                                    "value",  # datetime.timedelta or
 
120
                                              # None
 
121
                                    "followers")) # Tokens valid after
 
122
                                                  # this token
 
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
125
    token_end = Token(re.compile(r"$"), None, frozenset())
 
126
    token_second = Token(re.compile(r"(\d+)S"),
 
127
                         datetime.timedelta(seconds=1),
 
128
                         frozenset((token_end, )))
 
129
    token_minute = Token(re.compile(r"(\d+)M"),
 
130
                         datetime.timedelta(minutes=1),
 
131
                         frozenset((token_second, token_end)))
 
132
    token_hour = Token(re.compile(r"(\d+)H"),
 
133
                       datetime.timedelta(hours=1),
 
134
                       frozenset((token_minute, token_end)))
 
135
    token_time = Token(re.compile(r"T"),
 
136
                       None,
 
137
                       frozenset((token_hour, token_minute,
 
138
                                  token_second)))
 
139
    token_day = Token(re.compile(r"(\d+)D"),
 
140
                      datetime.timedelta(days=1),
 
141
                      frozenset((token_time, token_end)))
 
142
    token_month = Token(re.compile(r"(\d+)M"),
 
143
                        datetime.timedelta(weeks=4),
 
144
                        frozenset((token_day, token_end)))
 
145
    token_year = Token(re.compile(r"(\d+)Y"),
 
146
                       datetime.timedelta(weeks=52),
 
147
                       frozenset((token_month, token_end)))
 
148
    token_week = Token(re.compile(r"(\d+)W"),
 
149
                       datetime.timedelta(weeks=1),
 
150
                       frozenset((token_end, )))
 
151
    token_duration = Token(re.compile(r"P"), None,
 
152
                           frozenset((token_year, token_month,
 
153
                                      token_day, token_time,
 
154
                                      token_week)))
 
155
    # Define starting values
 
156
    value = datetime.timedelta() # Value so far
 
157
    found_token = None
 
158
    followers = frozenset((token_duration, )) # Following valid tokens
 
159
    s = duration                # String left to parse
 
160
    # Loop until end token is found
 
161
    while found_token is not token_end:
 
162
        # Search for any currently valid tokens
 
163
        for token in followers:
 
164
            match = token.regexp.match(s)
 
165
            if match is not None:
 
166
                # Token found
 
167
                if token.value is not None:
 
168
                    # Value found, parse digits
 
169
                    factor = int(match.group(1), 10)
 
170
                    # Add to value so far
 
171
                    value += factor * token.value
 
172
                # Strip token from string
 
173
                s = token.regexp.sub("", s, 1)
 
174
                # Go to found token
 
175
                found_token = token
 
176
                # Set valid next tokens
 
177
                followers = found_token.followers
 
178
                break
 
179
        else:
 
180
            # No currently valid tokens were found
 
181
            raise ValueError("Invalid RFC 3339 duration")
 
182
    # End token found
 
183
    return value
 
184
 
79
185
 
80
186
def string_to_delta(interval):
81
187
    """Parse a string and return a datetime.timedelta
93
199
    >>> string_to_delta("5m 30s")
94
200
    datetime.timedelta(0, 330)
95
201
    """
 
202
    
 
203
    try:
 
204
        return rfc3339_duration_to_delta(interval)
 
205
    except ValueError:
 
206
        pass
 
207
    
96
208
    value = datetime.timedelta(0)
97
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
209
    regexp = re.compile(r"(\d+)([dsmhw]?)")
98
210
    
99
211
    for num, suffix in regexp.findall(interval):
100
212
        if suffix == "d":
111
223
            value += datetime.timedelta(0, 0, 0, int(num))
112
224
    return value
113
225
 
 
226
 
114
227
def print_clients(clients, keywords):
115
228
    def valuetostring(value, keyword):
116
229
        if type(value) is dbus.Boolean:
117
230
            return "Yes" if value else "No"
118
231
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
119
 
                       "ApprovalDuration"):
 
232
                       "ApprovalDuration", "ExtendedTimeout"):
120
233
            return milliseconds_to_string(value)
121
 
        return unicode(value)
 
234
        return str(value)
122
235
    
123
236
    # Create format string to print table rows
124
 
    format_string = " ".join("%%-%ds" %
125
 
                             max(len(tablewords[key]),
126
 
                                 max(len(valuetostring(client[key],
127
 
                                                       key))
128
 
                                     for client in
129
 
                                     clients))
 
237
    format_string = " ".join("{{{key}:{width}}}".format(
 
238
        width = max(len(tablewords[key]),
 
239
                    max(len(valuetostring(client[key], key))
 
240
                        for client in clients)),
 
241
        key = key)
130
242
                             for key in keywords)
131
243
    # Print header line
132
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
244
    print(format_string.format(**tablewords))
133
245
    for client in clients:
134
 
        print(format_string % tuple(valuetostring(client[key], key)
135
 
                                    for key in keywords))
 
246
        print(format_string.format(**{
 
247
            key: valuetostring(client[key], key)
 
248
            for key in keywords }))
 
249
 
136
250
 
137
251
def has_actions(options):
138
252
    return any((options.enable,
154
268
                options.approve,
155
269
                options.deny))
156
270
 
 
271
 
157
272
def main():
158
273
    parser = argparse.ArgumentParser()
159
274
    parser.add_argument("--version", action="version",
160
 
                        version = "%%prog %s" % version,
 
275
                        version = "%(prog)s {}".format(version),
161
276
                        help="show version number and exit")
162
277
    parser.add_argument("-a", "--all", action="store_true",
163
278
                        help="Select all clients")
196
311
    parser.add_argument("--approval-duration",
197
312
                        help="Set duration of one client approval")
198
313
    parser.add_argument("-H", "--host", help="Set host for client")
199
 
    parser.add_argument("-s", "--secret", type=file,
 
314
    parser.add_argument("-s", "--secret",
 
315
                        type=argparse.FileType(mode="rb"),
200
316
                        help="Set password blob (file) for client")
201
317
    parser.add_argument("-A", "--approve", action="store_true",
202
318
                        help="Approve any current client request")
203
319
    parser.add_argument("-D", "--deny", action="store_true",
204
320
                        help="Deny any current client request")
 
321
    parser.add_argument("--check", action="store_true",
 
322
                        help="Run self-test")
205
323
    parser.add_argument("client", nargs="*", help="Client name")
206
324
    options = parser.parse_args()
207
325
    
208
 
    if has_actions(options) and not options.client and not options.all:
 
326
    if has_actions(options) and not (options.client or options.all):
209
327
        parser.error("Options require clients names or --all.")
210
328
    if options.verbose and has_actions(options):
211
329
        parser.error("--verbose can only be used alone or with"
212
330
                     " --all.")
213
331
    if options.all and not has_actions(options):
214
332
        parser.error("--all requires an action.")
 
333
 
 
334
    if options.check:
 
335
        fail_count, test_count = doctest.testmod()
 
336
        sys.exit(os.EX_OK if fail_count == 0 else 1)
215
337
    
216
338
    try:
217
339
        bus = dbus.SystemBus()
218
340
        mandos_dbus_objc = bus.get_object(busname, server_path)
219
341
    except dbus.exceptions.DBusException:
220
 
        print("Could not connect to Mandos server",
221
 
              file=sys.stderr)
 
342
        print("Could not connect to Mandos server", file=sys.stderr)
222
343
        sys.exit(1)
223
344
    
224
345
    mandos_serv = dbus.Interface(mandos_dbus_objc,
245
366
    clients={}
246
367
    
247
368
    if options.all or not options.client:
248
 
        clients = dict((bus.get_object(busname, path), properties)
249
 
                       for path, properties in
250
 
                       mandos_clients.iteritems())
 
369
        clients = { bus.get_object(busname, path): properties
 
370
                    for path, properties in mandos_clients.items() }
251
371
    else:
252
372
        for name in options.client:
253
 
            for path, client in mandos_clients.iteritems():
 
373
            for path, client in mandos_clients.items():
254
374
                if client["Name"] == name:
255
375
                    client_objc = bus.get_object(busname, path)
256
376
                    clients[client_objc] = client
257
377
                    break
258
378
            else:
259
 
                print("Client not found on server: %r" % name,
260
 
                      file=sys.stderr)
 
379
                print("Client not found on server: {!r}"
 
380
                      .format(name), file=sys.stderr)
261
381
                sys.exit(1)
262
382
    
263
383
    if not has_actions(options) and clients:
264
384
        if options.verbose:
265
 
            keywords = ("Name", "Enabled", "Timeout",
266
 
                        "LastCheckedOK", "Created", "Interval",
267
 
                        "Host", "Fingerprint", "CheckerRunning",
268
 
                        "LastEnabled", "ApprovalPending",
269
 
                        "ApprovedByDefault",
 
385
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
386
                        "Created", "Interval", "Host", "Fingerprint",
 
387
                        "CheckerRunning", "LastEnabled",
 
388
                        "ApprovalPending", "ApprovedByDefault",
270
389
                        "LastApprovalRequest", "ApprovalDelay",
271
390
                        "ApprovalDuration", "Checker",
272
391
                        "ExtendedTimeout")
277
396
    else:
278
397
        # Process each client in the list by all selected options
279
398
        for client in clients:
 
399
            
 
400
            def set_client_prop(prop, value):
 
401
                """Set a Client D-Bus property"""
 
402
                client.Set(client_interface, prop, value,
 
403
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
404
            
 
405
            def set_client_prop_ms(prop, value):
 
406
                """Set a Client D-Bus property, converted
 
407
                from a string to milliseconds."""
 
408
                set_client_prop(prop,
 
409
                                string_to_delta(value).total_seconds()
 
410
                                * 1000)
 
411
            
280
412
            if options.remove:
281
413
                mandos_serv.RemoveClient(client.__dbus_object_path__)
282
414
            if options.enable:
283
 
                client.Enable(dbus_interface=client_interface)
 
415
                set_client_prop("Enabled", dbus.Boolean(True))
284
416
            if options.disable:
285
 
                client.Disable(dbus_interface=client_interface)
 
417
                set_client_prop("Enabled", dbus.Boolean(False))
286
418
            if options.bump_timeout:
287
 
                client.CheckedOK(dbus_interface=client_interface)
 
419
                set_client_prop("LastCheckedOK", "")
288
420
            if options.start_checker:
289
 
                client.StartChecker(dbus_interface=client_interface)
 
421
                set_client_prop("CheckerRunning", dbus.Boolean(True))
290
422
            if options.stop_checker:
291
 
                client.StopChecker(dbus_interface=client_interface)
 
423
                set_client_prop("CheckerRunning", dbus.Boolean(False))
292
424
            if options.is_enabled:
293
425
                sys.exit(0 if client.Get(client_interface,
294
426
                                         "Enabled",
296
428
                                         dbus.PROPERTIES_IFACE)
297
429
                         else 1)
298
430
            if options.checker is not None:
299
 
                client.Set(client_interface, "Checker",
300
 
                           options.checker,
301
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
431
                set_client_prop("Checker", options.checker)
302
432
            if options.host is not None:
303
 
                client.Set(client_interface, "Host", options.host,
304
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
433
                set_client_prop("Host", options.host)
305
434
            if options.interval is not None:
306
 
                client.Set(client_interface, "Interval",
307
 
                           timedelta_to_milliseconds
308
 
                           (string_to_delta(options.interval)),
309
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
435
                set_client_prop_ms("Interval", options.interval)
310
436
            if options.approval_delay is not None:
311
 
                client.Set(client_interface, "ApprovalDelay",
312
 
                           timedelta_to_milliseconds
313
 
                           (string_to_delta(options.
314
 
                                            approval_delay)),
315
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
437
                set_client_prop_ms("ApprovalDelay",
 
438
                                   options.approval_delay)
316
439
            if options.approval_duration is not None:
317
 
                client.Set(client_interface, "ApprovalDuration",
318
 
                           timedelta_to_milliseconds
319
 
                           (string_to_delta(options.
320
 
                                            approval_duration)),
321
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
440
                set_client_prop_ms("ApprovalDuration",
 
441
                                   options.approval_duration)
322
442
            if options.timeout is not None:
323
 
                client.Set(client_interface, "Timeout",
324
 
                           timedelta_to_milliseconds
325
 
                           (string_to_delta(options.timeout)),
326
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
443
                set_client_prop_ms("Timeout", options.timeout)
327
444
            if options.extended_timeout is not None:
328
 
                client.Set(client_interface, "ExtendedTimeout",
329
 
                           timedelta_to_milliseconds
330
 
                           (string_to_delta(options.extended_timeout)),
331
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
445
                set_client_prop_ms("ExtendedTimeout",
 
446
                                   options.extended_timeout)
332
447
            if options.secret is not None:
333
 
                client.Set(client_interface, "Secret",
334
 
                           dbus.ByteArray(open(options.secret,
335
 
                                               "rb").read()),
336
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
448
                set_client_prop("Secret",
 
449
                                dbus.ByteArray(options.secret.read()))
337
450
            if options.approved_by_default is not None:
338
 
                client.Set(client_interface, "ApprovedByDefault",
339
 
                           dbus.Boolean(options
340
 
                                        .approved_by_default),
341
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
451
                set_client_prop("ApprovedByDefault",
 
452
                                dbus.Boolean(options
 
453
                                             .approved_by_default))
342
454
            if options.approve:
343
455
                client.Approve(dbus.Boolean(True),
344
456
                               dbus_interface=client_interface)
346
458
                client.Approve(dbus.Boolean(False),
347
459
                               dbus_interface=client_interface)
348
460
 
 
461
 
349
462
if __name__ == "__main__":
350
463
    main()