/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 16:13:39 UTC
  • Revision ID: teddy@recompile.se-20150531161339-igb3l0ip3c10ejpz
mandos-ctl: Generate better messages in exceptions.

mandos (rfc3339_duration_to_delta): Remove dead code.  Adjust white
                                    space.
mandos-ctl (rfc3339_duration_to_delta): Do minor formatting and
                                        whitespace adjustments, and
                                        Generate better message in
                                        exception.
(string_to_delta): Adjust quote character in doc string.

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-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.0"
 
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 "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
 
78
182
 
79
183
def string_to_delta(interval):
80
184
    """Parse a string and return a datetime.timedelta
81
185
    
82
 
    >>> string_to_delta("7d")
 
186
    >>> string_to_delta('7d')
83
187
    datetime.timedelta(7)
84
 
    >>> string_to_delta("60s")
 
188
    >>> string_to_delta('60s')
85
189
    datetime.timedelta(0, 60)
86
 
    >>> string_to_delta("60m")
 
190
    >>> string_to_delta('60m')
87
191
    datetime.timedelta(0, 3600)
88
 
    >>> string_to_delta("24h")
 
192
    >>> string_to_delta('24h')
89
193
    datetime.timedelta(1)
90
 
    >>> string_to_delta("1w")
 
194
    >>> string_to_delta('1w')
91
195
    datetime.timedelta(7)
92
 
    >>> string_to_delta("5m 30s")
 
196
    >>> string_to_delta('5m 30s')
93
197
    datetime.timedelta(0, 330)
94
198
    """
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
 
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
 
118
223
 
119
224
def print_clients(clients, keywords):
120
225
    def valuetostring(value, keyword):
121
226
        if type(value) is dbus.Boolean:
122
227
            return "Yes" if value else "No"
123
228
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
 
                       "ApprovalDuration"):
 
229
                       "ApprovalDuration", "ExtendedTimeout"):
125
230
            return milliseconds_to_string(value)
126
 
        return unicode(value)
 
231
        return str(value)
127
232
    
128
233
    # 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))
 
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)
135
239
                             for key in keywords)
136
240
    # Print header line
137
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
241
    print(format_string.format(**tablewords))
138
242
    for client in clients:
139
 
        print(format_string % tuple(valuetostring(client[key], key)
140
 
                                    for key in keywords))
 
243
        print(format_string.format(**{
 
244
            key: valuetostring(client[key], key)
 
245
            for key in keywords }))
 
246
 
141
247
 
142
248
def has_actions(options):
143
249
    return any((options.enable,
149
255
                options.remove,
150
256
                options.checker is not None,
151
257
                options.timeout is not None,
 
258
                options.extended_timeout is not None,
152
259
                options.interval is not None,
153
260
                options.approved_by_default is not None,
154
261
                options.approval_delay is not None,
158
265
                options.approve,
159
266
                options.deny))
160
267
 
 
268
 
161
269
def main():
162
270
    parser = argparse.ArgumentParser()
163
271
    parser.add_argument("--version", action="version",
164
 
                        version = "%%prog %s" % version,
 
272
                        version = "%(prog)s {}".format(version),
165
273
                        help="show version number and exit")
166
274
    parser.add_argument("-a", "--all", action="store_true",
167
275
                        help="Select all clients")
185
293
                        help="Set checker command for client")
186
294
    parser.add_argument("-t", "--timeout",
187
295
                        help="Set timeout for client")
 
296
    parser.add_argument("--extended-timeout",
 
297
                        help="Set extended timeout for client")
188
298
    parser.add_argument("-i", "--interval",
189
299
                        help="Set checker interval for client")
190
300
    parser.add_argument("--approve-by-default", action="store_true",
198
308
    parser.add_argument("--approval-duration",
199
309
                        help="Set duration of one client approval")
200
310
    parser.add_argument("-H", "--host", help="Set host for client")
201
 
    parser.add_argument("-s", "--secret", type=file,
 
311
    parser.add_argument("-s", "--secret",
 
312
                        type=argparse.FileType(mode="rb"),
202
313
                        help="Set password blob (file) for client")
203
314
    parser.add_argument("-A", "--approve", action="store_true",
204
315
                        help="Approve any current client request")
205
316
    parser.add_argument("-D", "--deny", action="store_true",
206
317
                        help="Deny any current client request")
 
318
    parser.add_argument("--check", action="store_true",
 
319
                        help="Run self-test")
207
320
    parser.add_argument("client", nargs="*", help="Client name")
208
321
    options = parser.parse_args()
209
322
    
210
 
    if has_actions(options) and not options.client and not options.all:
 
323
    if has_actions(options) and not (options.client or options.all):
211
324
        parser.error("Options require clients names or --all.")
212
325
    if options.verbose and has_actions(options):
213
326
        parser.error("--verbose can only be used alone or with"
214
327
                     " --all.")
215
328
    if options.all and not has_actions(options):
216
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)
217
334
    
218
335
    try:
219
336
        bus = dbus.SystemBus()
220
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
221
338
    except dbus.exceptions.DBusException:
222
 
        print("Could not connect to Mandos server",
223
 
              file=sys.stderr)
 
339
        print("Could not connect to Mandos server", file=sys.stderr)
224
340
        sys.exit(1)
225
341
    
226
342
    mandos_serv = dbus.Interface(mandos_dbus_objc,
238
354
            #restore stderr
239
355
            os.dup2(stderrcopy, sys.stderr.fileno())
240
356
            os.close(stderrcopy)
241
 
    except dbus.exceptions.DBusException, e:
 
357
    except dbus.exceptions.DBusException:
242
358
        print("Access denied: Accessing mandos server through dbus.",
243
359
              file=sys.stderr)
244
360
        sys.exit(1)
247
363
    clients={}
248
364
    
249
365
    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())
 
366
        clients = { bus.get_object(busname, path): properties
 
367
                    for path, properties in mandos_clients.items() }
253
368
    else:
254
369
        for name in options.client:
255
 
            for path, client in mandos_clients.iteritems():
 
370
            for path, client in mandos_clients.items():
256
371
                if client["Name"] == name:
257
372
                    client_objc = bus.get_object(busname, path)
258
373
                    clients[client_objc] = client
259
374
                    break
260
375
            else:
261
 
                print("Client not found on server: %r" % name,
262
 
                      file=sys.stderr)
 
376
                print("Client not found on server: {!r}"
 
377
                      .format(name), file=sys.stderr)
263
378
                sys.exit(1)
264
379
    
265
380
    if not has_actions(options) and clients:
266
381
        if options.verbose:
267
 
            keywords = ("Name", "Enabled", "Timeout",
268
 
                        "LastCheckedOK", "Created", "Interval",
269
 
                        "Host", "Fingerprint", "CheckerRunning",
270
 
                        "LastEnabled", "ApprovalPending",
271
 
                        "ApprovedByDefault",
 
382
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
383
                        "Created", "Interval", "Host", "Fingerprint",
 
384
                        "CheckerRunning", "LastEnabled",
 
385
                        "ApprovalPending", "ApprovedByDefault",
272
386
                        "LastApprovalRequest", "ApprovalDelay",
273
 
                        "ApprovalDuration", "Checker")
 
387
                        "ApprovalDuration", "Checker",
 
388
                        "ExtendedTimeout")
274
389
        else:
275
390
            keywords = defaultkeywords
276
391
        
278
393
    else:
279
394
        # Process each client in the list by all selected options
280
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
            
281
409
            if options.remove:
282
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
283
411
            if options.enable:
284
 
                client.Enable(dbus_interface=client_interface)
 
412
                set_client_prop("Enabled", dbus.Boolean(True))
285
413
            if options.disable:
286
 
                client.Disable(dbus_interface=client_interface)
 
414
                set_client_prop("Enabled", dbus.Boolean(False))
287
415
            if options.bump_timeout:
288
 
                client.CheckedOK(dbus_interface=client_interface)
 
416
                set_client_prop("LastCheckedOK", "")
289
417
            if options.start_checker:
290
 
                client.StartChecker(dbus_interface=client_interface)
 
418
                set_client_prop("CheckerRunning", dbus.Boolean(True))
291
419
            if options.stop_checker:
292
 
                client.StopChecker(dbus_interface=client_interface)
 
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
293
421
            if options.is_enabled:
294
422
                sys.exit(0 if client.Get(client_interface,
295
423
                                         "Enabled",
296
424
                                         dbus_interface=
297
425
                                         dbus.PROPERTIES_IFACE)
298
426
                         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)
 
427
            if options.checker is not None:
 
428
                set_client_prop("Checker", options.checker)
 
429
            if options.host is not None:
 
430
                set_client_prop("Host", options.host)
 
431
            if options.interval is not None:
 
432
                set_client_prop_ms("Interval", options.interval)
 
433
            if options.approval_delay is not None:
 
434
                set_client_prop_ms("ApprovalDelay",
 
435
                                   options.approval_delay)
 
436
            if options.approval_duration is not None:
 
437
                set_client_prop_ms("ApprovalDuration",
 
438
                                   options.approval_duration)
 
439
            if options.timeout is not None:
 
440
                set_client_prop_ms("Timeout", options.timeout)
 
441
            if options.extended_timeout is not None:
 
442
                set_client_prop_ms("ExtendedTimeout",
 
443
                                   options.extended_timeout)
 
444
            if options.secret is not None:
 
445
                set_client_prop("Secret",
 
446
                                dbus.ByteArray(options.secret.read()))
333
447
            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)
 
448
                set_client_prop("ApprovedByDefault",
 
449
                                dbus.Boolean(options
 
450
                                             .approved_by_default))
338
451
            if options.approve:
339
452
                client.Approve(dbus.Boolean(True),
340
453
                               dbus_interface=client_interface)
342
455
                client.Approve(dbus.Boolean(False),
343
456
                               dbus_interface=client_interface)
344
457
 
 
458
 
345
459
if __name__ == "__main__":
346
460
    main()