/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-04-02 21:56:15 UTC
  • Revision ID: teddy@recompile.se-20150402215615-v2ll1pgbae2dqdfx
mandos-ctl: Do minor formatting and whitespace adjustments.

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-2010 Teddy Hogeborn
7
 
# Copyright © 2008-2010 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
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# Contact the authors at <mandos@recompile.se>.
23
24
24
25
 
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
 
    }
 
67
    "ExtendedTimeout": "Extended Timeout"
 
68
}
56
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
57
 
domain = "se.bsnet.fukt"
 
70
domain = "se.recompile"
58
71
busname = domain + ".Mandos"
59
72
server_path = "/"
60
73
server_interface = domain + ".Mandos"
61
74
client_interface = domain + ".Mandos.Client"
62
 
version = "1.3.1"
 
75
version = "1.6.9"
63
76
 
64
 
def timedelta_to_milliseconds(td):
65
 
    """Convert a datetime.timedelta object to milliseconds"""
66
 
    return ((td.days * 24 * 60 * 60 * 1000)
67
 
            + (td.seconds * 1000)
68
 
            + (td.microseconds // 1000))
69
77
 
70
78
def milliseconds_to_string(ms):
71
79
    td = datetime.timedelta(0, 0, 0, ms)
72
 
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
73
 
            % { "days": "%dT" % td.days if td.days else "",
74
 
                "hours": td.seconds // 3600,
75
 
                "minutes": (td.seconds % 3600) // 60,
76
 
                "seconds": td.seconds % 60,
77
 
                })
 
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
 
78
185
 
79
186
def string_to_delta(interval):
80
187
    """Parse a string and return a datetime.timedelta
92
199
    >>> string_to_delta("5m 30s")
93
200
    datetime.timedelta(0, 330)
94
201
    """
95
 
    timevalue = datetime.timedelta(0)
96
 
    regexp = re.compile("\d+[dsmhw]")
97
 
    
98
 
    for s in regexp.findall(interval):
99
 
        try:
100
 
            suffix = unicode(s[-1])
101
 
            value = int(s[:-1])
102
 
            if suffix == "d":
103
 
                delta = datetime.timedelta(value)
104
 
            elif suffix == "s":
105
 
                delta = datetime.timedelta(0, value)
106
 
            elif suffix == "m":
107
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
108
 
            elif suffix == "h":
109
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
110
 
            elif suffix == "w":
111
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
112
 
            else:
113
 
                raise ValueError
114
 
        except (ValueError, IndexError):
115
 
            raise ValueError
116
 
        timevalue += delta
117
 
    return timevalue
 
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
 
118
226
 
119
227
def print_clients(clients, keywords):
120
228
    def valuetostring(value, keyword):
121
229
        if type(value) is dbus.Boolean:
122
230
            return "Yes" if value else "No"
123
231
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
 
                       "ApprovalDuration"):
 
232
                       "ApprovalDuration", "ExtendedTimeout"):
125
233
            return milliseconds_to_string(value)
126
 
        return unicode(value)
 
234
        return str(value)
127
235
    
128
236
    # Create format string to print table rows
129
 
    format_string = " ".join("%%-%ds" %
130
 
                             max(len(tablewords[key]),
131
 
                                 max(len(valuetostring(client[key],
132
 
                                                       key))
133
 
                                     for client in
134
 
                                     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)
135
242
                             for key in keywords)
136
243
    # Print header line
137
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
244
    print(format_string.format(**tablewords))
138
245
    for client in clients:
139
 
        print(format_string % tuple(valuetostring(client[key], key)
140
 
                                    for key in keywords))
 
246
        print(format_string.format(**{
 
247
            key: valuetostring(client[key], key)
 
248
            for key in keywords }))
 
249
 
141
250
 
142
251
def has_actions(options):
143
252
    return any((options.enable,
149
258
                options.remove,
150
259
                options.checker is not None,
151
260
                options.timeout is not None,
 
261
                options.extended_timeout is not None,
152
262
                options.interval is not None,
153
263
                options.approved_by_default is not None,
154
264
                options.approval_delay is not None,
158
268
                options.approve,
159
269
                options.deny))
160
270
 
 
271
 
161
272
def main():
162
273
    parser = argparse.ArgumentParser()
163
274
    parser.add_argument("--version", action="version",
164
 
                        version = "%%prog %s" % version,
 
275
                        version = "%(prog)s {}".format(version),
165
276
                        help="show version number and exit")
166
277
    parser.add_argument("-a", "--all", action="store_true",
167
278
                        help="Select all clients")
185
296
                        help="Set checker command for client")
186
297
    parser.add_argument("-t", "--timeout",
187
298
                        help="Set timeout for client")
 
299
    parser.add_argument("--extended-timeout",
 
300
                        help="Set extended timeout for client")
188
301
    parser.add_argument("-i", "--interval",
189
302
                        help="Set checker interval for client")
190
303
    parser.add_argument("--approve-by-default", action="store_true",
198
311
    parser.add_argument("--approval-duration",
199
312
                        help="Set duration of one client approval")
200
313
    parser.add_argument("-H", "--host", help="Set host for client")
201
 
    parser.add_argument("-s", "--secret", type=file,
 
314
    parser.add_argument("-s", "--secret",
 
315
                        type=argparse.FileType(mode="rb"),
202
316
                        help="Set password blob (file) for client")
203
317
    parser.add_argument("-A", "--approve", action="store_true",
204
318
                        help="Approve any current client request")
205
319
    parser.add_argument("-D", "--deny", action="store_true",
206
320
                        help="Deny any current client request")
 
321
    parser.add_argument("--check", action="store_true",
 
322
                        help="Run self-test")
207
323
    parser.add_argument("client", nargs="*", help="Client name")
208
324
    options = parser.parse_args()
209
325
    
210
 
    if has_actions(options) and not options.client and not options.all:
 
326
    if has_actions(options) and not (options.client or options.all):
211
327
        parser.error("Options require clients names or --all.")
212
328
    if options.verbose and has_actions(options):
213
329
        parser.error("--verbose can only be used alone or with"
214
330
                     " --all.")
215
331
    if options.all and not has_actions(options):
216
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)
217
337
    
218
338
    try:
219
339
        bus = dbus.SystemBus()
220
340
        mandos_dbus_objc = bus.get_object(busname, server_path)
221
341
    except dbus.exceptions.DBusException:
222
 
        print("Could not connect to Mandos server",
223
 
              file=sys.stderr)
 
342
        print("Could not connect to Mandos server", file=sys.stderr)
224
343
        sys.exit(1)
225
344
    
226
345
    mandos_serv = dbus.Interface(mandos_dbus_objc,
238
357
            #restore stderr
239
358
            os.dup2(stderrcopy, sys.stderr.fileno())
240
359
            os.close(stderrcopy)
241
 
    except dbus.exceptions.DBusException, e:
 
360
    except dbus.exceptions.DBusException:
242
361
        print("Access denied: Accessing mandos server through dbus.",
243
362
              file=sys.stderr)
244
363
        sys.exit(1)
247
366
    clients={}
248
367
    
249
368
    if options.all or not options.client:
250
 
        clients = dict((bus.get_object(busname, path), properties)
251
 
                       for path, properties in
252
 
                       mandos_clients.iteritems())
 
369
        clients = { bus.get_object(busname, path): properties
 
370
                    for path, properties in mandos_clients.items() }
253
371
    else:
254
372
        for name in options.client:
255
 
            for path, client in mandos_clients.iteritems():
 
373
            for path, client in mandos_clients.items():
256
374
                if client["Name"] == name:
257
375
                    client_objc = bus.get_object(busname, path)
258
376
                    clients[client_objc] = client
259
377
                    break
260
378
            else:
261
 
                print("Client not found on server: %r" % name,
262
 
                      file=sys.stderr)
 
379
                print("Client not found on server: {!r}"
 
380
                      .format(name), file=sys.stderr)
263
381
                sys.exit(1)
264
382
    
265
383
    if not has_actions(options) and clients:
266
384
        if options.verbose:
267
 
            keywords = ("Name", "Enabled", "Timeout",
268
 
                        "LastCheckedOK", "Created", "Interval",
269
 
                        "Host", "Fingerprint", "CheckerRunning",
270
 
                        "LastEnabled", "ApprovalPending",
271
 
                        "ApprovedByDefault",
 
385
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
386
                        "Created", "Interval", "Host", "Fingerprint",
 
387
                        "CheckerRunning", "LastEnabled",
 
388
                        "ApprovalPending", "ApprovedByDefault",
272
389
                        "LastApprovalRequest", "ApprovalDelay",
273
 
                        "ApprovalDuration", "Checker")
 
390
                        "ApprovalDuration", "Checker",
 
391
                        "ExtendedTimeout")
274
392
        else:
275
393
            keywords = defaultkeywords
276
394
        
278
396
    else:
279
397
        # Process each client in the list by all selected options
280
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
            
281
412
            if options.remove:
282
413
                mandos_serv.RemoveClient(client.__dbus_object_path__)
283
414
            if options.enable:
284
 
                client.Enable(dbus_interface=client_interface)
 
415
                set_client_prop("Enabled", dbus.Boolean(True))
285
416
            if options.disable:
286
 
                client.Disable(dbus_interface=client_interface)
 
417
                set_client_prop("Enabled", dbus.Boolean(False))
287
418
            if options.bump_timeout:
288
 
                client.CheckedOK(dbus_interface=client_interface)
 
419
                set_client_prop("LastCheckedOK", "")
289
420
            if options.start_checker:
290
 
                client.StartChecker(dbus_interface=client_interface)
 
421
                set_client_prop("CheckerRunning", dbus.Boolean(True))
291
422
            if options.stop_checker:
292
 
                client.StopChecker(dbus_interface=client_interface)
 
423
                set_client_prop("CheckerRunning", dbus.Boolean(False))
293
424
            if options.is_enabled:
294
425
                sys.exit(0 if client.Get(client_interface,
295
426
                                         "Enabled",
296
427
                                         dbus_interface=
297
428
                                         dbus.PROPERTIES_IFACE)
298
429
                         else 1)
299
 
            if options.checker:
300
 
                client.Set(client_interface, "Checker",
301
 
                           options.checker,
302
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
303
 
            if options.host:
304
 
                client.Set(client_interface, "Host", options.host,
305
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
306
 
            if options.interval:
307
 
                client.Set(client_interface, "Interval",
308
 
                           timedelta_to_milliseconds
309
 
                           (string_to_delta(options.interval)),
310
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
311
 
            if options.approval_delay:
312
 
                client.Set(client_interface, "ApprovalDelay",
313
 
                           timedelta_to_milliseconds
314
 
                           (string_to_delta(options.
315
 
                                            approval_delay)),
316
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
317
 
            if options.approval_duration:
318
 
                client.Set(client_interface, "ApprovalDuration",
319
 
                           timedelta_to_milliseconds
320
 
                           (string_to_delta(options.
321
 
                                            approval_duration)),
322
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
323
 
            if options.timeout:
324
 
                client.Set(client_interface, "Timeout",
325
 
                           timedelta_to_milliseconds
326
 
                           (string_to_delta(options.timeout)),
327
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
328
 
            if options.secret:
329
 
                client.Set(client_interface, "Secret",
330
 
                           dbus.ByteArray(open(options.secret,
331
 
                                               "rb").read()),
332
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
430
            if options.checker is not None:
 
431
                set_client_prop("Checker", options.checker)
 
432
            if options.host is not None:
 
433
                set_client_prop("Host", options.host)
 
434
            if options.interval is not None:
 
435
                set_client_prop_ms("Interval", options.interval)
 
436
            if options.approval_delay is not None:
 
437
                set_client_prop_ms("ApprovalDelay",
 
438
                                   options.approval_delay)
 
439
            if options.approval_duration is not None:
 
440
                set_client_prop_ms("ApprovalDuration",
 
441
                                   options.approval_duration)
 
442
            if options.timeout is not None:
 
443
                set_client_prop_ms("Timeout", options.timeout)
 
444
            if options.extended_timeout is not None:
 
445
                set_client_prop_ms("ExtendedTimeout",
 
446
                                   options.extended_timeout)
 
447
            if options.secret is not None:
 
448
                set_client_prop("Secret",
 
449
                                dbus.ByteArray(options.secret.read()))
333
450
            if options.approved_by_default is not None:
334
 
                client.Set(client_interface, "ApprovedByDefault",
335
 
                           dbus.Boolean(options
336
 
                                        .approved_by_default),
337
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
451
                set_client_prop("ApprovedByDefault",
 
452
                                dbus.Boolean(options
 
453
                                             .approved_by_default))
338
454
            if options.approve:
339
455
                client.Approve(dbus.Boolean(True),
340
456
                               dbus_interface=client_interface)
342
458
                client.Approve(dbus.Boolean(False),
343
459
                               dbus_interface=client_interface)
344
460
 
 
461
 
345
462
if __name__ == "__main__":
346
463
    main()