/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-31 20:12:27 UTC
  • mfrom: (749.1.2 multiprocessing-exec)
  • Revision ID: teddy@recompile.se-20150531201227-u3n1z1ito5siqh7c
Merge change to use multiprocessing module to run checkers.

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 "value" is not None, must have
 
116
                   # a "group" containing digits
 
117
        "value",   # datetime.timedelta or None
 
118
        "followers"))           # Tokens valid after this token
 
119
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
120
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
121
    token_end = Token(re.compile(r"$"), None, frozenset())
 
122
    token_second = Token(re.compile(r"(\d+)S"),
 
123
                         datetime.timedelta(seconds=1),
 
124
                         frozenset((token_end, )))
 
125
    token_minute = Token(re.compile(r"(\d+)M"),
 
126
                         datetime.timedelta(minutes=1),
 
127
                         frozenset((token_second, token_end)))
 
128
    token_hour = Token(re.compile(r"(\d+)H"),
 
129
                       datetime.timedelta(hours=1),
 
130
                       frozenset((token_minute, token_end)))
 
131
    token_time = Token(re.compile(r"T"),
 
132
                       None,
 
133
                       frozenset((token_hour, token_minute,
 
134
                                  token_second)))
 
135
    token_day = Token(re.compile(r"(\d+)D"),
 
136
                      datetime.timedelta(days=1),
 
137
                      frozenset((token_time, token_end)))
 
138
    token_month = Token(re.compile(r"(\d+)M"),
 
139
                        datetime.timedelta(weeks=4),
 
140
                        frozenset((token_day, token_end)))
 
141
    token_year = Token(re.compile(r"(\d+)Y"),
 
142
                       datetime.timedelta(weeks=52),
 
143
                       frozenset((token_month, token_end)))
 
144
    token_week = Token(re.compile(r"(\d+)W"),
 
145
                       datetime.timedelta(weeks=1),
 
146
                       frozenset((token_end, )))
 
147
    token_duration = Token(re.compile(r"P"), None,
 
148
                           frozenset((token_year, token_month,
 
149
                                      token_day, token_time,
 
150
                                      token_week)))
 
151
    # Define starting values
 
152
    value = datetime.timedelta() # Value so far
 
153
    found_token = None
 
154
    followers = frozenset((token_duration, )) # Following valid tokens
 
155
    s = duration                # String left to parse
 
156
    # Loop until end token is found
 
157
    while found_token is not token_end:
 
158
        # Search for any currently valid tokens
 
159
        for token in followers:
 
160
            match = token.regexp.match(s)
 
161
            if match is not None:
 
162
                # Token found
 
163
                if token.value is not None:
 
164
                    # Value found, parse digits
 
165
                    factor = int(match.group(1), 10)
 
166
                    # Add to value so far
 
167
                    value += factor * token.value
 
168
                # Strip token from string
 
169
                s = token.regexp.sub("", s, 1)
 
170
                # Go to found token
 
171
                found_token = token
 
172
                # Set valid next tokens
 
173
                followers = found_token.followers
 
174
                break
 
175
        else:
 
176
            # No currently valid tokens were found
 
177
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
178
                             .format(duration))
 
179
    # End token found
 
180
    return value
 
181
 
79
182
 
80
183
def string_to_delta(interval):
81
184
    """Parse a string and return a datetime.timedelta
82
185
    
83
 
    >>> string_to_delta("7d")
 
186
    >>> string_to_delta('7d')
84
187
    datetime.timedelta(7)
85
 
    >>> string_to_delta("60s")
 
188
    >>> string_to_delta('60s')
86
189
    datetime.timedelta(0, 60)
87
 
    >>> string_to_delta("60m")
 
190
    >>> string_to_delta('60m')
88
191
    datetime.timedelta(0, 3600)
89
 
    >>> string_to_delta("24h")
 
192
    >>> string_to_delta('24h')
90
193
    datetime.timedelta(1)
91
 
    >>> string_to_delta("1w")
 
194
    >>> string_to_delta('1w')
92
195
    datetime.timedelta(7)
93
 
    >>> string_to_delta("5m 30s")
 
196
    >>> string_to_delta('5m 30s')
94
197
    datetime.timedelta(0, 330)
95
198
    """
96
 
    timevalue = datetime.timedelta(0)
97
 
    regexp = re.compile("\d+[dsmhw]")
98
 
    
99
 
    for s in regexp.findall(interval):
100
 
        try:
101
 
            suffix = unicode(s[-1])
102
 
            value = int(s[:-1])
103
 
            if suffix == "d":
104
 
                delta = datetime.timedelta(value)
105
 
            elif suffix == "s":
106
 
                delta = datetime.timedelta(0, value)
107
 
            elif suffix == "m":
108
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
109
 
            elif suffix == "h":
110
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
111
 
            elif suffix == "w":
112
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
113
 
            else:
114
 
                raise ValueError
115
 
        except (ValueError, IndexError):
116
 
            raise ValueError
117
 
        timevalue += delta
118
 
    return timevalue
 
199
    
 
200
    try:
 
201
        return rfc3339_duration_to_delta(interval)
 
202
    except ValueError:
 
203
        pass
 
204
    
 
205
    value = datetime.timedelta(0)
 
206
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
207
    
 
208
    for num, suffix in regexp.findall(interval):
 
209
        if suffix == "d":
 
210
            value += datetime.timedelta(int(num))
 
211
        elif suffix == "s":
 
212
            value += datetime.timedelta(0, int(num))
 
213
        elif suffix == "m":
 
214
            value += datetime.timedelta(0, 0, 0, 0, int(num))
 
215
        elif suffix == "h":
 
216
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
 
217
        elif suffix == "w":
 
218
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
 
219
        elif suffix == "":
 
220
            value += datetime.timedelta(0, 0, 0, int(num))
 
221
    return value
 
222
 
119
223
 
120
224
def print_clients(clients, keywords):
121
225
    def valuetostring(value, keyword):
122
226
        if type(value) is dbus.Boolean:
123
227
            return "Yes" if value else "No"
124
228
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
125
 
                       "ApprovalDuration"):
 
229
                       "ApprovalDuration", "ExtendedTimeout"):
126
230
            return milliseconds_to_string(value)
127
 
        return unicode(value)
 
231
        return str(value)
128
232
    
129
233
    # Create format string to print table rows
130
 
    format_string = " ".join("%%-%ds" %
131
 
                             max(len(tablewords[key]),
132
 
                                 max(len(valuetostring(client[key],
133
 
                                                       key))
134
 
                                     for client in
135
 
                                     clients))
 
234
    format_string = " ".join("{{{key}:{width}}}".format(
 
235
        width = max(len(tablewords[key]),
 
236
                    max(len(valuetostring(client[key], key))
 
237
                        for client in clients)),
 
238
        key = key)
136
239
                             for key in keywords)
137
240
    # Print header line
138
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
241
    print(format_string.format(**tablewords))
139
242
    for client in clients:
140
 
        print(format_string % tuple(valuetostring(client[key], key)
141
 
                                    for key in keywords))
 
243
        print(format_string.format(**{
 
244
            key: valuetostring(client[key], key)
 
245
            for key in keywords }))
 
246
 
142
247
 
143
248
def has_actions(options):
144
249
    return any((options.enable,
160
265
                options.approve,
161
266
                options.deny))
162
267
 
 
268
 
163
269
def main():
164
270
    parser = argparse.ArgumentParser()
165
271
    parser.add_argument("--version", action="version",
166
 
                        version = "%%prog %s" % version,
 
272
                        version = "%(prog)s {}".format(version),
167
273
                        help="show version number and exit")
168
274
    parser.add_argument("-a", "--all", action="store_true",
169
275
                        help="Select all clients")
202
308
    parser.add_argument("--approval-duration",
203
309
                        help="Set duration of one client approval")
204
310
    parser.add_argument("-H", "--host", help="Set host for client")
205
 
    parser.add_argument("-s", "--secret", type=file,
 
311
    parser.add_argument("-s", "--secret",
 
312
                        type=argparse.FileType(mode="rb"),
206
313
                        help="Set password blob (file) for client")
207
314
    parser.add_argument("-A", "--approve", action="store_true",
208
315
                        help="Approve any current client request")
209
316
    parser.add_argument("-D", "--deny", action="store_true",
210
317
                        help="Deny any current client request")
 
318
    parser.add_argument("--check", action="store_true",
 
319
                        help="Run self-test")
211
320
    parser.add_argument("client", nargs="*", help="Client name")
212
321
    options = parser.parse_args()
213
322
    
214
 
    if has_actions(options) and not options.client and not options.all:
 
323
    if has_actions(options) and not (options.client or options.all):
215
324
        parser.error("Options require clients names or --all.")
216
325
    if options.verbose and has_actions(options):
217
326
        parser.error("--verbose can only be used alone or with"
218
327
                     " --all.")
219
328
    if options.all and not has_actions(options):
220
329
        parser.error("--all requires an action.")
 
330
 
 
331
    if options.check:
 
332
        fail_count, test_count = doctest.testmod()
 
333
        sys.exit(os.EX_OK if fail_count == 0 else 1)
221
334
    
222
335
    try:
223
336
        bus = dbus.SystemBus()
224
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
225
338
    except dbus.exceptions.DBusException:
226
 
        print("Could not connect to Mandos server",
227
 
              file=sys.stderr)
 
339
        print("Could not connect to Mandos server", file=sys.stderr)
228
340
        sys.exit(1)
229
341
    
230
342
    mandos_serv = dbus.Interface(mandos_dbus_objc,
242
354
            #restore stderr
243
355
            os.dup2(stderrcopy, sys.stderr.fileno())
244
356
            os.close(stderrcopy)
245
 
    except dbus.exceptions.DBusException, e:
 
357
    except dbus.exceptions.DBusException:
246
358
        print("Access denied: Accessing mandos server through dbus.",
247
359
              file=sys.stderr)
248
360
        sys.exit(1)
251
363
    clients={}
252
364
    
253
365
    if options.all or not options.client:
254
 
        clients = dict((bus.get_object(busname, path), properties)
255
 
                       for path, properties in
256
 
                       mandos_clients.iteritems())
 
366
        clients = { bus.get_object(busname, path): properties
 
367
                    for path, properties in mandos_clients.items() }
257
368
    else:
258
369
        for name in options.client:
259
 
            for path, client in mandos_clients.iteritems():
 
370
            for path, client in mandos_clients.items():
260
371
                if client["Name"] == name:
261
372
                    client_objc = bus.get_object(busname, path)
262
373
                    clients[client_objc] = client
263
374
                    break
264
375
            else:
265
 
                print("Client not found on server: %r" % name,
266
 
                      file=sys.stderr)
 
376
                print("Client not found on server: {!r}"
 
377
                      .format(name), file=sys.stderr)
267
378
                sys.exit(1)
268
379
    
269
380
    if not has_actions(options) and clients:
270
381
        if options.verbose:
271
 
            keywords = ("Name", "Enabled", "Timeout",
272
 
                        "LastCheckedOK", "Created", "Interval",
273
 
                        "Host", "Fingerprint", "CheckerRunning",
274
 
                        "LastEnabled", "ApprovalPending",
275
 
                        "ApprovedByDefault",
 
382
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
383
                        "Created", "Interval", "Host", "Fingerprint",
 
384
                        "CheckerRunning", "LastEnabled",
 
385
                        "ApprovalPending", "ApprovedByDefault",
276
386
                        "LastApprovalRequest", "ApprovalDelay",
277
387
                        "ApprovalDuration", "Checker",
278
388
                        "ExtendedTimeout")
283
393
    else:
284
394
        # Process each client in the list by all selected options
285
395
        for client in clients:
 
396
            
 
397
            def set_client_prop(prop, value):
 
398
                """Set a Client D-Bus property"""
 
399
                client.Set(client_interface, prop, value,
 
400
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
401
            
 
402
            def set_client_prop_ms(prop, value):
 
403
                """Set a Client D-Bus property, converted
 
404
                from a string to milliseconds."""
 
405
                set_client_prop(prop,
 
406
                                string_to_delta(value).total_seconds()
 
407
                                * 1000)
 
408
            
286
409
            if options.remove:
287
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
288
411
            if options.enable:
289
 
                client.Enable(dbus_interface=client_interface)
 
412
                set_client_prop("Enabled", dbus.Boolean(True))
290
413
            if options.disable:
291
 
                client.Disable(dbus_interface=client_interface)
 
414
                set_client_prop("Enabled", dbus.Boolean(False))
292
415
            if options.bump_timeout:
293
 
                client.CheckedOK(dbus_interface=client_interface)
 
416
                set_client_prop("LastCheckedOK", "")
294
417
            if options.start_checker:
295
 
                client.StartChecker(dbus_interface=client_interface)
 
418
                set_client_prop("CheckerRunning", dbus.Boolean(True))
296
419
            if options.stop_checker:
297
 
                client.StopChecker(dbus_interface=client_interface)
 
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
298
421
            if options.is_enabled:
299
422
                sys.exit(0 if client.Get(client_interface,
300
423
                                         "Enabled",
302
425
                                         dbus.PROPERTIES_IFACE)
303
426
                         else 1)
304
427
            if options.checker is not None:
305
 
                client.Set(client_interface, "Checker",
306
 
                           options.checker,
307
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
428
                set_client_prop("Checker", options.checker)
308
429
            if options.host is not None:
309
 
                client.Set(client_interface, "Host", options.host,
310
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
430
                set_client_prop("Host", options.host)
311
431
            if options.interval is not None:
312
 
                client.Set(client_interface, "Interval",
313
 
                           timedelta_to_milliseconds
314
 
                           (string_to_delta(options.interval)),
315
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
432
                set_client_prop_ms("Interval", options.interval)
316
433
            if options.approval_delay is not None:
317
 
                client.Set(client_interface, "ApprovalDelay",
318
 
                           timedelta_to_milliseconds
319
 
                           (string_to_delta(options.
320
 
                                            approval_delay)),
321
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
434
                set_client_prop_ms("ApprovalDelay",
 
435
                                   options.approval_delay)
322
436
            if options.approval_duration is not None:
323
 
                client.Set(client_interface, "ApprovalDuration",
324
 
                           timedelta_to_milliseconds
325
 
                           (string_to_delta(options.
326
 
                                            approval_duration)),
327
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
437
                set_client_prop_ms("ApprovalDuration",
 
438
                                   options.approval_duration)
328
439
            if options.timeout is not None:
329
 
                client.Set(client_interface, "Timeout",
330
 
                           timedelta_to_milliseconds
331
 
                           (string_to_delta(options.timeout)),
332
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
440
                set_client_prop_ms("Timeout", options.timeout)
333
441
            if options.extended_timeout is not None:
334
 
                client.Set(client_interface, "ExtendedTimeout",
335
 
                           timedelta_to_milliseconds
336
 
                           (string_to_delta(options.extended_timeout)),
337
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
442
                set_client_prop_ms("ExtendedTimeout",
 
443
                                   options.extended_timeout)
338
444
            if options.secret is not None:
339
 
                client.Set(client_interface, "Secret",
340
 
                           dbus.ByteArray(open(options.secret,
341
 
                                               "rb").read()),
342
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
445
                set_client_prop("Secret",
 
446
                                dbus.ByteArray(options.secret.read()))
343
447
            if options.approved_by_default is not None:
344
 
                client.Set(client_interface, "ApprovedByDefault",
345
 
                           dbus.Boolean(options
346
 
                                        .approved_by_default),
347
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
448
                set_client_prop("ApprovedByDefault",
 
449
                                dbus.Boolean(options
 
450
                                             .approved_by_default))
348
451
            if options.approve:
349
452
                client.Approve(dbus.Boolean(True),
350
453
                               dbus_interface=client_interface)
352
455
                client.Approve(dbus.Boolean(False),
353
456
                               dbus_interface=client_interface)
354
457
 
 
458
 
355
459
if __name__ == "__main__":
356
460
    main()