/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: 2012-05-05 08:53:14 UTC
  • mto: This revision was merged to the branch mainline in revision 570.
  • Revision ID: teddy@recompile.se-20120505085314-57lf21cjfybyljkl
* mandos-ctl (main): Use D-Bus properties instead of methods.

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-2012 Teddy Hogeborn
 
7
# Copyright © 2008-2012 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
 
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.5.3"
 
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))
76
70
 
77
71
def milliseconds_to_string(ms):
78
72
    td = datetime.timedelta(0, 0, 0, ms)
79
73
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
 
            .format(days = "{}T".format(td.days) if td.days else "",
 
74
            .format(days = "{0}T".format(td.days) if td.days else "",
81
75
                    hours = td.seconds // 3600,
82
76
                    minutes = (td.seconds % 3600) // 60,
83
77
                    seconds = td.seconds % 60,
84
78
                    ))
85
79
 
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
 
 
185
 
 
186
80
def string_to_delta(interval):
187
81
    """Parse a string and return a datetime.timedelta
188
82
    
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
96
    value = datetime.timedelta(0)
209
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
97
    regexp = re.compile("(\d+)([dsmhw]?)")
210
98
    
211
99
    for num, suffix in regexp.findall(interval):
212
100
        if suffix == "d":
228
116
        if type(value) is dbus.Boolean:
229
117
            return "Yes" if value else "No"
230
118
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
231
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
119
                       "ApprovalDuration"):
232
120
            return milliseconds_to_string(value)
233
 
        return str(value)
 
121
        return unicode(value)
234
122
    
235
123
    # Create format string to print table rows
236
124
    format_string = " ".join("{{{key}:{width}}}".format(
243
131
    # Print header line
244
132
    print(format_string.format(**tablewords))
245
133
    for client in clients:
246
 
        print(format_string.format(**{ key:
 
134
        print(format_string.format(**dict((key,
247
135
                                           valuetostring(client[key],
248
 
                                                         key)
249
 
                                       for key in keywords }))
 
136
                                                         key))
 
137
                                          for key in keywords)))
250
138
 
251
139
def has_actions(options):
252
140
    return any((options.enable,
271
159
def main():
272
160
    parser = argparse.ArgumentParser()
273
161
    parser.add_argument("--version", action="version",
274
 
                        version = "%(prog)s {}".format(version),
 
162
                        version = "%(prog)s {0}".format(version),
275
163
                        help="show version number and exit")
276
164
    parser.add_argument("-a", "--all", action="store_true",
277
165
                        help="Select all clients")
310
198
    parser.add_argument("--approval-duration",
311
199
                        help="Set duration of one client approval")
312
200
    parser.add_argument("-H", "--host", help="Set host for client")
313
 
    parser.add_argument("-s", "--secret",
314
 
                        type=argparse.FileType(mode="rb"),
 
201
    parser.add_argument("-s", "--secret", type=file,
315
202
                        help="Set password blob (file) for client")
316
203
    parser.add_argument("-A", "--approve", action="store_true",
317
204
                        help="Approve any current client request")
318
205
    parser.add_argument("-D", "--deny", action="store_true",
319
206
                        help="Deny any current client request")
320
 
    parser.add_argument("--check", action="store_true",
321
 
                        help="Run self-test")
322
207
    parser.add_argument("client", nargs="*", help="Client name")
323
208
    options = parser.parse_args()
324
209
    
325
 
    if has_actions(options) and not (options.client or options.all):
 
210
    if has_actions(options) and not options.client and not options.all:
326
211
        parser.error("Options require clients names or --all.")
327
212
    if options.verbose and has_actions(options):
328
213
        parser.error("--verbose can only be used alone or with"
329
214
                     " --all.")
330
215
    if options.all and not has_actions(options):
331
216
        parser.error("--all requires an action.")
332
 
 
333
 
    if options.check:
334
 
        fail_count, test_count = doctest.testmod()
335
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
336
217
    
337
218
    try:
338
219
        bus = dbus.SystemBus()
366
247
    clients={}
367
248
    
368
249
    if options.all or not options.client:
369
 
        clients = { bus.get_object(busname, path): properties
370
 
                    for path, properties in mandos_clients.items() }
 
250
        clients = dict((bus.get_object(busname, path), properties)
 
251
                       for path, properties in
 
252
                       mandos_clients.iteritems())
371
253
    else:
372
254
        for name in options.client:
373
 
            for path, client in mandos_clients.items():
 
255
            for path, client in mandos_clients.iteritems():
374
256
                if client["Name"] == name:
375
257
                    client_objc = bus.get_object(busname, path)
376
258
                    clients[client_objc] = client
377
259
                    break
378
260
            else:
379
 
                print("Client not found on server: {!r}"
 
261
                print("Client not found on server: {0!r}"
380
262
                      .format(name), file=sys.stderr)
381
263
                sys.exit(1)
382
264
    
397
279
    else:
398
280
        # Process each client in the list by all selected options
399
281
        for client in clients:
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
 
            def set_client_prop_ms(prop, value):
405
 
                """Set a Client D-Bus property, converted
406
 
                from a string to milliseconds."""
407
 
                set_client_prop(prop,
408
 
                                string_to_delta(value).total_seconds()
409
 
                                * 1000)
410
282
            if options.remove:
411
283
                mandos_serv.RemoveClient(client.__dbus_object_path__)
412
284
            if options.enable:
413
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
285
                client.Set(client_interface, "Enabled",
 
286
                           dbus.Boolean(True),
 
287
                           dbus_interface=dbus.PROPERTIES_IFACE)
414
288
            if options.disable:
415
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
289
                client.Set(client_interface, "Enabled",
 
290
                           dbus.Boolean(False),
 
291
                           dbus_interface=dbus.PROPERTIES_IFACE)
416
292
            if options.bump_timeout:
417
 
                set_client_prop("LastCheckedOK", "")
 
293
                client.Set(client_interface, "LastCheckedOK", "",
 
294
                           dbus_interface=dbus.PROPERTIES_IFACE)
418
295
            if options.start_checker:
419
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
296
                client.Set(client_interface, "CheckerRunning",
 
297
                           dbus.Boolean(True),
 
298
                           dbus_interface=dbus.PROPERTIES_IFACE)
420
299
            if options.stop_checker:
421
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
300
                client.Set(client_interface, "CheckerRunning",
 
301
                           dbus.Boolean(False),
 
302
                           dbus_interface=dbus.PROPERTIES_IFACE)
422
303
            if options.is_enabled:
423
304
                sys.exit(0 if client.Get(client_interface,
424
305
                                         "Enabled",
426
307
                                         dbus.PROPERTIES_IFACE)
427
308
                         else 1)
428
309
            if options.checker is not None:
429
 
                set_client_prop("Checker", options.checker)
 
310
                client.Set(client_interface, "Checker",
 
311
                           options.checker,
 
312
                           dbus_interface=dbus.PROPERTIES_IFACE)
430
313
            if options.host is not None:
431
 
                set_client_prop("Host", options.host)
 
314
                client.Set(client_interface, "Host", options.host,
 
315
                           dbus_interface=dbus.PROPERTIES_IFACE)
432
316
            if options.interval is not None:
433
 
                set_client_prop_ms("Interval", options.interval)
 
317
                client.Set(client_interface, "Interval",
 
318
                           timedelta_to_milliseconds
 
319
                           (string_to_delta(options.interval)),
 
320
                           dbus_interface=dbus.PROPERTIES_IFACE)
434
321
            if options.approval_delay is not None:
435
 
                set_client_prop_ms("ApprovalDelay",
436
 
                                   options.approval_delay)
 
322
                client.Set(client_interface, "ApprovalDelay",
 
323
                           timedelta_to_milliseconds
 
324
                           (string_to_delta(options.
 
325
                                            approval_delay)),
 
326
                           dbus_interface=dbus.PROPERTIES_IFACE)
437
327
            if options.approval_duration is not None:
438
 
                set_client_prop_ms("ApprovalDuration",
439
 
                                   options.approval_duration)
 
328
                client.Set(client_interface, "ApprovalDuration",
 
329
                           timedelta_to_milliseconds
 
330
                           (string_to_delta(options.
 
331
                                            approval_duration)),
 
332
                           dbus_interface=dbus.PROPERTIES_IFACE)
440
333
            if options.timeout is not None:
441
 
                set_client_prop_ms("Timeout", options.timeout)
 
334
                client.Set(client_interface, "Timeout",
 
335
                           timedelta_to_milliseconds
 
336
                           (string_to_delta(options.timeout)),
 
337
                           dbus_interface=dbus.PROPERTIES_IFACE)
442
338
            if options.extended_timeout is not None:
443
 
                set_client_prop_ms("ExtendedTimeout",
444
 
                                   options.extended_timeout)
 
339
                client.Set(client_interface, "ExtendedTimeout",
 
340
                           timedelta_to_milliseconds
 
341
                           (string_to_delta(options.extended_timeout)),
 
342
                           dbus_interface=dbus.PROPERTIES_IFACE)
445
343
            if options.secret is not None:
446
 
                set_client_prop("Secret",
447
 
                                dbus.ByteArray(options.secret.read()))
 
344
                client.Set(client_interface, "Secret",
 
345
                           dbus.ByteArray(options.secret.read()),
 
346
                           dbus_interface=dbus.PROPERTIES_IFACE)
448
347
            if options.approved_by_default is not None:
449
 
                set_client_prop("ApprovedByDefault",
450
 
                                dbus.Boolean(options
451
 
                                             .approved_by_default))
 
348
                client.Set(client_interface, "ApprovedByDefault",
 
349
                           dbus.Boolean(options
 
350
                                        .approved_by_default),
 
351
                           dbus_interface=dbus.PROPERTIES_IFACE)
452
352
            if options.approve:
453
353
                client.Approve(dbus.Boolean(True),
454
354
                               dbus_interface=client_interface)