/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: Björn Påhlsson
  • Date: 2011-12-26 15:23:45 UTC
  • Revision ID: belorn@recompile.se-20111226152345-cd9mz98e7eiqbfbx
nicer stacktrace when mandos-monitor fail during startup

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-2014 Teddy Hogeborn
7
 
# Copyright © 2008-2014 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[0] == 2:
46
 
    str = unicode
47
35
 
48
36
locale.setlocale(locale.LC_ALL, "")
49
37
 
72
60
server_path = "/"
73
61
server_interface = domain + ".Mandos"
74
62
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.7"
 
63
version = "1.4.1"
76
64
 
77
65
def timedelta_to_milliseconds(td):
78
66
    """Convert a datetime.timedelta object to milliseconds"""
82
70
 
83
71
def milliseconds_to_string(ms):
84
72
    td = datetime.timedelta(0, 0, 0, ms)
85
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
86
 
            .format(days = "{0}T".format(td.days) if td.days else "",
87
 
                    hours = td.seconds // 3600,
88
 
                    minutes = (td.seconds % 3600) // 60,
89
 
                    seconds = td.seconds % 60,
90
 
                    ))
91
 
 
92
 
 
93
 
def rfc3339_duration_to_delta(duration):
94
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
95
 
    
96
 
    >>> rfc3339_duration_to_delta("P7D")
97
 
    datetime.timedelta(7)
98
 
    >>> rfc3339_duration_to_delta("PT60S")
99
 
    datetime.timedelta(0, 60)
100
 
    >>> rfc3339_duration_to_delta("PT60M")
101
 
    datetime.timedelta(0, 3600)
102
 
    >>> rfc3339_duration_to_delta("PT24H")
103
 
    datetime.timedelta(1)
104
 
    >>> rfc3339_duration_to_delta("P1W")
105
 
    datetime.timedelta(7)
106
 
    >>> rfc3339_duration_to_delta("PT5M30S")
107
 
    datetime.timedelta(0, 330)
108
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
109
 
    datetime.timedelta(1, 200)
110
 
    """
111
 
    
112
 
    # Parsing an RFC 3339 duration with regular expressions is not
113
 
    # possible - there would have to be multiple places for the same
114
 
    # values, like seconds.  The current code, while more esoteric, is
115
 
    # cleaner without depending on a parsing library.  If Python had a
116
 
    # built-in library for parsing we would use it, but we'd like to
117
 
    # avoid excessive use of external libraries.
118
 
    
119
 
    # New type for defining tokens, syntax, and semantics all-in-one
120
 
    Token = collections.namedtuple("Token",
121
 
                                   ("regexp", # To match token; if
122
 
                                              # "value" is not None,
123
 
                                              # must have a "group"
124
 
                                              # containing digits
125
 
                                    "value",  # datetime.timedelta or
126
 
                                              # None
127
 
                                    "followers")) # Tokens valid after
128
 
                                                  # this token
129
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
131
 
    token_end = Token(re.compile(r"$"), None, frozenset())
132
 
    token_second = Token(re.compile(r"(\d+)S"),
133
 
                         datetime.timedelta(seconds=1),
134
 
                         frozenset((token_end,)))
135
 
    token_minute = Token(re.compile(r"(\d+)M"),
136
 
                         datetime.timedelta(minutes=1),
137
 
                         frozenset((token_second, token_end)))
138
 
    token_hour = Token(re.compile(r"(\d+)H"),
139
 
                       datetime.timedelta(hours=1),
140
 
                       frozenset((token_minute, token_end)))
141
 
    token_time = Token(re.compile(r"T"),
142
 
                       None,
143
 
                       frozenset((token_hour, token_minute,
144
 
                                  token_second)))
145
 
    token_day = Token(re.compile(r"(\d+)D"),
146
 
                      datetime.timedelta(days=1),
147
 
                      frozenset((token_time, token_end)))
148
 
    token_month = Token(re.compile(r"(\d+)M"),
149
 
                        datetime.timedelta(weeks=4),
150
 
                        frozenset((token_day, token_end)))
151
 
    token_year = Token(re.compile(r"(\d+)Y"),
152
 
                       datetime.timedelta(weeks=52),
153
 
                       frozenset((token_month, token_end)))
154
 
    token_week = Token(re.compile(r"(\d+)W"),
155
 
                       datetime.timedelta(weeks=1),
156
 
                       frozenset((token_end,)))
157
 
    token_duration = Token(re.compile(r"P"), None,
158
 
                           frozenset((token_year, token_month,
159
 
                                      token_day, token_time,
160
 
                                      token_week)))
161
 
    # Define starting values
162
 
    value = datetime.timedelta() # Value so far
163
 
    found_token = None
164
 
    followers = frozenset((token_duration,)) # Following valid tokens
165
 
    s = duration                # String left to parse
166
 
    # Loop until end token is found
167
 
    while found_token is not token_end:
168
 
        # Search for any currently valid tokens
169
 
        for token in followers:
170
 
            match = token.regexp.match(s)
171
 
            if match is not None:
172
 
                # Token found
173
 
                if token.value is not None:
174
 
                    # Value found, parse digits
175
 
                    factor = int(match.group(1), 10)
176
 
                    # Add to value so far
177
 
                    value += factor * token.value
178
 
                # Strip token from string
179
 
                s = token.regexp.sub("", s, 1)
180
 
                # Go to found token
181
 
                found_token = token
182
 
                # Set valid next tokens
183
 
                followers = found_token.followers
184
 
                break
185
 
        else:
186
 
            # No currently valid tokens were found
187
 
            raise ValueError("Invalid RFC 3339 duration")
188
 
    # End token found
189
 
    return value
190
 
 
 
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
                })
191
79
 
192
80
def string_to_delta(interval):
193
81
    """Parse a string and return a datetime.timedelta
205
93
    >>> string_to_delta("5m 30s")
206
94
    datetime.timedelta(0, 330)
207
95
    """
208
 
    
209
 
    try:
210
 
        return rfc3339_duration_to_delta(interval)
211
 
    except ValueError:
212
 
        pass
213
 
    
214
96
    value = datetime.timedelta(0)
215
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
97
    regexp = re.compile("(\d+)([dsmhw]?)")
216
98
    
217
99
    for num, suffix in regexp.findall(interval):
218
100
        if suffix == "d":
234
116
        if type(value) is dbus.Boolean:
235
117
            return "Yes" if value else "No"
236
118
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
237
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
119
                       "ApprovalDuration"):
238
120
            return milliseconds_to_string(value)
239
 
        return str(value)
 
121
        return unicode(value)
240
122
    
241
123
    # Create format string to print table rows
242
 
    format_string = " ".join("{{{key}:{width}}}".format(
243
 
            width = max(len(tablewords[key]),
244
 
                        max(len(valuetostring(client[key],
245
 
                                              key))
246
 
                            for client in
247
 
                            clients)),
248
 
            key = key) for key in keywords)
 
124
    format_string = " ".join("%%-%ds" %
 
125
                             max(len(tablewords[key]),
 
126
                                 max(len(valuetostring(client[key],
 
127
                                                       key))
 
128
                                     for client in
 
129
                                     clients))
 
130
                             for key in keywords)
249
131
    # Print header line
250
 
    print(format_string.format(**tablewords))
 
132
    print(format_string % tuple(tablewords[key] for key in keywords))
251
133
    for client in clients:
252
 
        print(format_string.format(**dict((key,
253
 
                                           valuetostring(client[key],
254
 
                                                         key))
255
 
                                          for key in keywords)))
 
134
        print(format_string % tuple(valuetostring(client[key], key)
 
135
                                    for key in keywords))
256
136
 
257
137
def has_actions(options):
258
138
    return any((options.enable,
277
157
def main():
278
158
    parser = argparse.ArgumentParser()
279
159
    parser.add_argument("--version", action="version",
280
 
                        version = "%(prog)s {0}".format(version),
 
160
                        version = "%%prog %s" % version,
281
161
                        help="show version number and exit")
282
162
    parser.add_argument("-a", "--all", action="store_true",
283
163
                        help="Select all clients")
316
196
    parser.add_argument("--approval-duration",
317
197
                        help="Set duration of one client approval")
318
198
    parser.add_argument("-H", "--host", help="Set host for client")
319
 
    parser.add_argument("-s", "--secret",
320
 
                        type=argparse.FileType(mode="rb"),
 
199
    parser.add_argument("-s", "--secret", type=file,
321
200
                        help="Set password blob (file) for client")
322
201
    parser.add_argument("-A", "--approve", action="store_true",
323
202
                        help="Approve any current client request")
324
203
    parser.add_argument("-D", "--deny", action="store_true",
325
204
                        help="Deny any current client request")
326
 
    parser.add_argument("--check", action="store_true",
327
 
                        help="Run self-test")
328
205
    parser.add_argument("client", nargs="*", help="Client name")
329
206
    options = parser.parse_args()
330
207
    
331
 
    if has_actions(options) and not (options.client or options.all):
 
208
    if has_actions(options) and not options.client and not options.all:
332
209
        parser.error("Options require clients names or --all.")
333
210
    if options.verbose and has_actions(options):
334
211
        parser.error("--verbose can only be used alone or with"
335
212
                     " --all.")
336
213
    if options.all and not has_actions(options):
337
214
        parser.error("--all requires an action.")
338
 
 
339
 
    if options.check:
340
 
        fail_count, test_count = doctest.testmod()
341
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
342
215
    
343
216
    try:
344
217
        bus = dbus.SystemBus()
374
247
    if options.all or not options.client:
375
248
        clients = dict((bus.get_object(busname, path), properties)
376
249
                       for path, properties in
377
 
                       mandos_clients.items())
 
250
                       mandos_clients.iteritems())
378
251
    else:
379
252
        for name in options.client:
380
253
            for path, client in mandos_clients.iteritems():
383
256
                    clients[client_objc] = client
384
257
                    break
385
258
            else:
386
 
                print("Client not found on server: {0!r}"
387
 
                      .format(name), file=sys.stderr)
 
259
                print("Client not found on server: %r" % name,
 
260
                      file=sys.stderr)
388
261
                sys.exit(1)
389
262
    
390
263
    if not has_actions(options) and clients:
404
277
    else:
405
278
        # Process each client in the list by all selected options
406
279
        for client in clients:
407
 
            def set_client_prop(prop, value):
408
 
                """Set a Client D-Bus property"""
409
 
                client.Set(client_interface, prop, value,
410
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
411
 
            def set_client_prop_ms(prop, value):
412
 
                """Set a Client D-Bus property, converted
413
 
                from a string to milliseconds."""
414
 
                set_client_prop(prop,
415
 
                                timedelta_to_milliseconds
416
 
                                (string_to_delta(value)))
417
280
            if options.remove:
418
281
                mandos_serv.RemoveClient(client.__dbus_object_path__)
419
282
            if options.enable:
420
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
283
                client.Enable(dbus_interface=client_interface)
421
284
            if options.disable:
422
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
285
                client.Disable(dbus_interface=client_interface)
423
286
            if options.bump_timeout:
424
 
                set_client_prop("LastCheckedOK", "")
 
287
                client.CheckedOK(dbus_interface=client_interface)
425
288
            if options.start_checker:
426
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
289
                client.StartChecker(dbus_interface=client_interface)
427
290
            if options.stop_checker:
428
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
291
                client.StopChecker(dbus_interface=client_interface)
429
292
            if options.is_enabled:
430
293
                sys.exit(0 if client.Get(client_interface,
431
294
                                         "Enabled",
433
296
                                         dbus.PROPERTIES_IFACE)
434
297
                         else 1)
435
298
            if options.checker is not None:
436
 
                set_client_prop("Checker", options.checker)
 
299
                client.Set(client_interface, "Checker",
 
300
                           options.checker,
 
301
                           dbus_interface=dbus.PROPERTIES_IFACE)
437
302
            if options.host is not None:
438
 
                set_client_prop("Host", options.host)
 
303
                client.Set(client_interface, "Host", options.host,
 
304
                           dbus_interface=dbus.PROPERTIES_IFACE)
439
305
            if options.interval is not None:
440
 
                set_client_prop_ms("Interval", options.interval)
 
306
                client.Set(client_interface, "Interval",
 
307
                           timedelta_to_milliseconds
 
308
                           (string_to_delta(options.interval)),
 
309
                           dbus_interface=dbus.PROPERTIES_IFACE)
441
310
            if options.approval_delay is not None:
442
 
                set_client_prop_ms("ApprovalDelay",
443
 
                                   options.approval_delay)
 
311
                client.Set(client_interface, "ApprovalDelay",
 
312
                           timedelta_to_milliseconds
 
313
                           (string_to_delta(options.
 
314
                                            approval_delay)),
 
315
                           dbus_interface=dbus.PROPERTIES_IFACE)
444
316
            if options.approval_duration is not None:
445
 
                set_client_prop_ms("ApprovalDuration",
446
 
                                   options.approval_duration)
 
317
                client.Set(client_interface, "ApprovalDuration",
 
318
                           timedelta_to_milliseconds
 
319
                           (string_to_delta(options.
 
320
                                            approval_duration)),
 
321
                           dbus_interface=dbus.PROPERTIES_IFACE)
447
322
            if options.timeout is not None:
448
 
                set_client_prop_ms("Timeout", options.timeout)
 
323
                client.Set(client_interface, "Timeout",
 
324
                           timedelta_to_milliseconds
 
325
                           (string_to_delta(options.timeout)),
 
326
                           dbus_interface=dbus.PROPERTIES_IFACE)
449
327
            if options.extended_timeout is not None:
450
 
                set_client_prop_ms("ExtendedTimeout",
451
 
                                   options.extended_timeout)
 
328
                client.Set(client_interface, "ExtendedTimeout",
 
329
                           timedelta_to_milliseconds
 
330
                           (string_to_delta(options.extended_timeout)),
 
331
                           dbus_interface=dbus.PROPERTIES_IFACE)
452
332
            if options.secret is not None:
453
 
                set_client_prop("Secret",
454
 
                                dbus.ByteArray(options.secret.read()))
 
333
                client.Set(client_interface, "Secret",
 
334
                           dbus.ByteArray(open(options.secret,
 
335
                                               "rb").read()),
 
336
                           dbus_interface=dbus.PROPERTIES_IFACE)
455
337
            if options.approved_by_default is not None:
456
 
                set_client_prop("ApprovedByDefault",
457
 
                                dbus.Boolean(options
458
 
                                             .approved_by_default))
 
338
                client.Set(client_interface, "ApprovedByDefault",
 
339
                           dbus.Boolean(options
 
340
                                        .approved_by_default),
 
341
                           dbus_interface=dbus.PROPERTIES_IFACE)
459
342
            if options.approve:
460
343
                client.Approve(dbus.Boolean(True),
461
344
                               dbus_interface=client_interface)