/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

* network-hooks.d: New directory.
* network-hooks.d/bridge: New example hook.
* network-hooks.d/bridge.conf: Config file for bridge example hook.

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-2015 Teddy Hogeborn
7
 
# Copyright © 2008-2015 Björn Påhlsson
 
6
# Copyright © 2008-2011 Teddy Hogeborn
 
7
# Copyright © 2008-2011 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
21
 
# <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
21
# 
23
22
# Contact the authors at <mandos@recompile.se>.
24
23
# 
26
25
from __future__ import (division, absolute_import, print_function,
27
26
                        unicode_literals)
28
27
 
29
 
try:
30
 
    from future_builtins import *
31
 
except ImportError:
32
 
    pass
33
 
 
34
28
import sys
 
29
import dbus
35
30
import argparse
36
31
import locale
37
32
import datetime
38
33
import re
39
34
import os
40
 
import collections
41
 
import doctest
42
 
 
43
 
import dbus
44
 
 
45
 
if sys.version_info.major == 2:
46
 
    str = unicode
47
35
 
48
36
locale.setlocale(locale.LC_ALL, "")
49
37
 
64
52
    "ApprovalDelay": "Approval Delay",
65
53
    "ApprovalDuration": "Approval Duration",
66
54
    "Checker": "Checker",
67
 
    "ExtendedTimeout": "Extended Timeout"
68
 
}
 
55
    "ExtendedTimeout" : "Extended Timeout"
 
56
    }
69
57
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
58
domain = "se.recompile"
71
59
busname = domain + ".Mandos"
72
60
server_path = "/"
73
61
server_interface = domain + ".Mandos"
74
62
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.9"
 
63
version = "1.4.1"
76
64
 
 
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))
77
70
 
78
71
def milliseconds_to_string(ms):
79
72
    td = datetime.timedelta(0, 0, 0, ms)
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
 
 
 
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
                })
185
79
 
186
80
def string_to_delta(interval):
187
81
    """Parse a string and return a datetime.timedelta
199
93
    >>> string_to_delta("5m 30s")
200
94
    datetime.timedelta(0, 330)
201
95
    """
202
 
    
203
 
    try:
204
 
        return rfc3339_duration_to_delta(interval)
205
 
    except ValueError:
206
 
        pass
207
 
    
208
 
    value = datetime.timedelta(0)
209
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
210
 
    
211
 
    for num, suffix in regexp.findall(interval):
212
 
        if suffix == "d":
213
 
            value += datetime.timedelta(int(num))
214
 
        elif suffix == "s":
215
 
            value += datetime.timedelta(0, int(num))
216
 
        elif suffix == "m":
217
 
            value += datetime.timedelta(0, 0, 0, 0, int(num))
218
 
        elif suffix == "h":
219
 
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
220
 
        elif suffix == "w":
221
 
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
222
 
        elif suffix == "":
223
 
            value += datetime.timedelta(0, 0, 0, int(num))
224
 
    return value
225
 
 
 
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
226
119
 
227
120
def print_clients(clients, keywords):
228
121
    def valuetostring(value, keyword):
229
122
        if type(value) is dbus.Boolean:
230
123
            return "Yes" if value else "No"
231
124
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
232
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
125
                       "ApprovalDuration"):
233
126
            return milliseconds_to_string(value)
234
 
        return str(value)
 
127
        return unicode(value)
235
128
    
236
129
    # Create format string to print table rows
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
    format_string = " ".join("%%-%ds" %
 
131
                             max(len(tablewords[key]),
 
132
                                 max(len(valuetostring(client[key],
 
133
                                                       key))
 
134
                                     for client in
 
135
                                     clients))
242
136
                             for key in keywords)
243
137
    # Print header line
244
 
    print(format_string.format(**tablewords))
 
138
    print(format_string % tuple(tablewords[key] for key in keywords))
245
139
    for client in clients:
246
 
        print(format_string.format(**{
247
 
            key: valuetostring(client[key], key)
248
 
            for key in keywords }))
249
 
 
 
140
        print(format_string % tuple(valuetostring(client[key], key)
 
141
                                    for key in keywords))
250
142
 
251
143
def has_actions(options):
252
144
    return any((options.enable,
268
160
                options.approve,
269
161
                options.deny))
270
162
 
271
 
 
272
163
def main():
273
164
    parser = argparse.ArgumentParser()
274
165
    parser.add_argument("--version", action="version",
275
 
                        version = "%(prog)s {}".format(version),
 
166
                        version = "%%prog %s" % version,
276
167
                        help="show version number and exit")
277
168
    parser.add_argument("-a", "--all", action="store_true",
278
169
                        help="Select all clients")
311
202
    parser.add_argument("--approval-duration",
312
203
                        help="Set duration of one client approval")
313
204
    parser.add_argument("-H", "--host", help="Set host for client")
314
 
    parser.add_argument("-s", "--secret",
315
 
                        type=argparse.FileType(mode="rb"),
 
205
    parser.add_argument("-s", "--secret", type=file,
316
206
                        help="Set password blob (file) for client")
317
207
    parser.add_argument("-A", "--approve", action="store_true",
318
208
                        help="Approve any current client request")
319
209
    parser.add_argument("-D", "--deny", action="store_true",
320
210
                        help="Deny any current client request")
321
 
    parser.add_argument("--check", action="store_true",
322
 
                        help="Run self-test")
323
211
    parser.add_argument("client", nargs="*", help="Client name")
324
212
    options = parser.parse_args()
325
213
    
326
 
    if has_actions(options) and not (options.client or options.all):
 
214
    if has_actions(options) and not options.client and not options.all:
327
215
        parser.error("Options require clients names or --all.")
328
216
    if options.verbose and has_actions(options):
329
217
        parser.error("--verbose can only be used alone or with"
330
218
                     " --all.")
331
219
    if options.all and not has_actions(options):
332
220
        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)
337
221
    
338
222
    try:
339
223
        bus = dbus.SystemBus()
340
224
        mandos_dbus_objc = bus.get_object(busname, server_path)
341
225
    except dbus.exceptions.DBusException:
342
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
226
        print("Could not connect to Mandos server",
 
227
              file=sys.stderr)
343
228
        sys.exit(1)
344
229
    
345
230
    mandos_serv = dbus.Interface(mandos_dbus_objc,
357
242
            #restore stderr
358
243
            os.dup2(stderrcopy, sys.stderr.fileno())
359
244
            os.close(stderrcopy)
360
 
    except dbus.exceptions.DBusException:
 
245
    except dbus.exceptions.DBusException, e:
361
246
        print("Access denied: Accessing mandos server through dbus.",
362
247
              file=sys.stderr)
363
248
        sys.exit(1)
366
251
    clients={}
367
252
    
368
253
    if options.all or not options.client:
369
 
        clients = { bus.get_object(busname, path): properties
370
 
                    for path, properties in mandos_clients.items() }
 
254
        clients = dict((bus.get_object(busname, path), properties)
 
255
                       for path, properties in
 
256
                       mandos_clients.iteritems())
371
257
    else:
372
258
        for name in options.client:
373
 
            for path, client in mandos_clients.items():
 
259
            for path, client in mandos_clients.iteritems():
374
260
                if client["Name"] == name:
375
261
                    client_objc = bus.get_object(busname, path)
376
262
                    clients[client_objc] = client
377
263
                    break
378
264
            else:
379
 
                print("Client not found on server: {!r}"
380
 
                      .format(name), file=sys.stderr)
 
265
                print("Client not found on server: %r" % name,
 
266
                      file=sys.stderr)
381
267
                sys.exit(1)
382
268
    
383
269
    if not has_actions(options) and clients:
384
270
        if options.verbose:
385
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
386
 
                        "Created", "Interval", "Host", "Fingerprint",
387
 
                        "CheckerRunning", "LastEnabled",
388
 
                        "ApprovalPending", "ApprovedByDefault",
 
271
            keywords = ("Name", "Enabled", "Timeout",
 
272
                        "LastCheckedOK", "Created", "Interval",
 
273
                        "Host", "Fingerprint", "CheckerRunning",
 
274
                        "LastEnabled", "ApprovalPending",
 
275
                        "ApprovedByDefault",
389
276
                        "LastApprovalRequest", "ApprovalDelay",
390
277
                        "ApprovalDuration", "Checker",
391
278
                        "ExtendedTimeout")
396
283
    else:
397
284
        # Process each client in the list by all selected options
398
285
        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
 
            
412
286
            if options.remove:
413
287
                mandos_serv.RemoveClient(client.__dbus_object_path__)
414
288
            if options.enable:
415
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
289
                client.Enable(dbus_interface=client_interface)
416
290
            if options.disable:
417
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
291
                client.Disable(dbus_interface=client_interface)
418
292
            if options.bump_timeout:
419
 
                set_client_prop("LastCheckedOK", "")
 
293
                client.CheckedOK(dbus_interface=client_interface)
420
294
            if options.start_checker:
421
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
295
                client.StartChecker(dbus_interface=client_interface)
422
296
            if options.stop_checker:
423
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
297
                client.StopChecker(dbus_interface=client_interface)
424
298
            if options.is_enabled:
425
299
                sys.exit(0 if client.Get(client_interface,
426
300
                                         "Enabled",
428
302
                                         dbus.PROPERTIES_IFACE)
429
303
                         else 1)
430
304
            if options.checker is not None:
431
 
                set_client_prop("Checker", options.checker)
 
305
                client.Set(client_interface, "Checker",
 
306
                           options.checker,
 
307
                           dbus_interface=dbus.PROPERTIES_IFACE)
432
308
            if options.host is not None:
433
 
                set_client_prop("Host", options.host)
 
309
                client.Set(client_interface, "Host", options.host,
 
310
                           dbus_interface=dbus.PROPERTIES_IFACE)
434
311
            if options.interval is not None:
435
 
                set_client_prop_ms("Interval", options.interval)
 
312
                client.Set(client_interface, "Interval",
 
313
                           timedelta_to_milliseconds
 
314
                           (string_to_delta(options.interval)),
 
315
                           dbus_interface=dbus.PROPERTIES_IFACE)
436
316
            if options.approval_delay is not None:
437
 
                set_client_prop_ms("ApprovalDelay",
438
 
                                   options.approval_delay)
 
317
                client.Set(client_interface, "ApprovalDelay",
 
318
                           timedelta_to_milliseconds
 
319
                           (string_to_delta(options.
 
320
                                            approval_delay)),
 
321
                           dbus_interface=dbus.PROPERTIES_IFACE)
439
322
            if options.approval_duration is not None:
440
 
                set_client_prop_ms("ApprovalDuration",
441
 
                                   options.approval_duration)
 
323
                client.Set(client_interface, "ApprovalDuration",
 
324
                           timedelta_to_milliseconds
 
325
                           (string_to_delta(options.
 
326
                                            approval_duration)),
 
327
                           dbus_interface=dbus.PROPERTIES_IFACE)
442
328
            if options.timeout is not None:
443
 
                set_client_prop_ms("Timeout", options.timeout)
 
329
                client.Set(client_interface, "Timeout",
 
330
                           timedelta_to_milliseconds
 
331
                           (string_to_delta(options.timeout)),
 
332
                           dbus_interface=dbus.PROPERTIES_IFACE)
444
333
            if options.extended_timeout is not None:
445
 
                set_client_prop_ms("ExtendedTimeout",
446
 
                                   options.extended_timeout)
 
334
                client.Set(client_interface, "ExtendedTimeout",
 
335
                           timedelta_to_milliseconds
 
336
                           (string_to_delta(options.extended_timeout)),
 
337
                           dbus_interface=dbus.PROPERTIES_IFACE)
447
338
            if options.secret is not None:
448
 
                set_client_prop("Secret",
449
 
                                dbus.ByteArray(options.secret.read()))
 
339
                client.Set(client_interface, "Secret",
 
340
                           dbus.ByteArray(open(options.secret,
 
341
                                               "rb").read()),
 
342
                           dbus_interface=dbus.PROPERTIES_IFACE)
450
343
            if options.approved_by_default is not None:
451
 
                set_client_prop("ApprovedByDefault",
452
 
                                dbus.Boolean(options
453
 
                                             .approved_by_default))
 
344
                client.Set(client_interface, "ApprovedByDefault",
 
345
                           dbus.Boolean(options
 
346
                                        .approved_by_default),
 
347
                           dbus_interface=dbus.PROPERTIES_IFACE)
454
348
            if options.approve:
455
349
                client.Approve(dbus.Boolean(True),
456
350
                               dbus_interface=client_interface)
458
352
                client.Approve(dbus.Boolean(False),
459
353
                               dbus_interface=client_interface)
460
354
 
461
 
 
462
355
if __name__ == "__main__":
463
356
    main()