/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-03-08 22:04:44 UTC
  • mfrom: (561.1.1 dbus-annotations)
  • Revision ID: teddy@recompile.se-20120308220444-8jjcgoxka6xz1tss
Merge general D-Bus annotations support.

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-2016 Teddy Hogeborn
7
 
# Copyright © 2008-2016 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
 
import json
43
 
 
44
 
import dbus
45
 
 
46
 
if sys.version_info.major == 2:
47
 
    str = unicode
48
35
 
49
36
locale.setlocale(locale.LC_ALL, "")
50
37
 
65
52
    "ApprovalDelay": "Approval Delay",
66
53
    "ApprovalDuration": "Approval Duration",
67
54
    "Checker": "Checker",
68
 
    "ExtendedTimeout": "Extended Timeout"
69
 
}
 
55
    "ExtendedTimeout" : "Extended Timeout"
 
56
    }
70
57
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
71
58
domain = "se.recompile"
72
59
busname = domain + ".Mandos"
73
60
server_path = "/"
74
61
server_interface = domain + ".Mandos"
75
62
client_interface = domain + ".Mandos.Client"
76
 
version = "1.7.10"
77
 
 
78
 
 
79
 
try:
80
 
    dbus.OBJECT_MANAGER_IFACE
81
 
except AttributeError:
82
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
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))
83
70
 
84
71
def milliseconds_to_string(ms):
85
72
    td = datetime.timedelta(0, 0, 0, ms)
86
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
87
 
        days = "{}T".format(td.days) if td.days else "",
88
 
        hours = td.seconds // 3600,
89
 
        minutes = (td.seconds % 3600) // 60,
90
 
        seconds = td.seconds % 60))
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 "value" is not None, must have
122
 
                   # a "group" containing digits
123
 
        "value",   # datetime.timedelta or None
124
 
        "followers"))           # Tokens valid after this token
125
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
126
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
127
 
    token_end = Token(re.compile(r"$"), None, frozenset())
128
 
    token_second = Token(re.compile(r"(\d+)S"),
129
 
                         datetime.timedelta(seconds=1),
130
 
                         frozenset((token_end, )))
131
 
    token_minute = Token(re.compile(r"(\d+)M"),
132
 
                         datetime.timedelta(minutes=1),
133
 
                         frozenset((token_second, token_end)))
134
 
    token_hour = Token(re.compile(r"(\d+)H"),
135
 
                       datetime.timedelta(hours=1),
136
 
                       frozenset((token_minute, token_end)))
137
 
    token_time = Token(re.compile(r"T"),
138
 
                       None,
139
 
                       frozenset((token_hour, token_minute,
140
 
                                  token_second)))
141
 
    token_day = Token(re.compile(r"(\d+)D"),
142
 
                      datetime.timedelta(days=1),
143
 
                      frozenset((token_time, token_end)))
144
 
    token_month = Token(re.compile(r"(\d+)M"),
145
 
                        datetime.timedelta(weeks=4),
146
 
                        frozenset((token_day, token_end)))
147
 
    token_year = Token(re.compile(r"(\d+)Y"),
148
 
                       datetime.timedelta(weeks=52),
149
 
                       frozenset((token_month, token_end)))
150
 
    token_week = Token(re.compile(r"(\d+)W"),
151
 
                       datetime.timedelta(weeks=1),
152
 
                       frozenset((token_end, )))
153
 
    token_duration = Token(re.compile(r"P"), None,
154
 
                           frozenset((token_year, token_month,
155
 
                                      token_day, token_time,
156
 
                                      token_week)))
157
 
    # Define starting values
158
 
    value = datetime.timedelta() # Value so far
159
 
    found_token = None
160
 
    followers = frozenset((token_duration, )) # Following valid tokens
161
 
    s = duration                # String left to parse
162
 
    # Loop until end token is found
163
 
    while found_token is not token_end:
164
 
        # Search for any currently valid tokens
165
 
        for token in followers:
166
 
            match = token.regexp.match(s)
167
 
            if match is not None:
168
 
                # Token found
169
 
                if token.value is not None:
170
 
                    # Value found, parse digits
171
 
                    factor = int(match.group(1), 10)
172
 
                    # Add to value so far
173
 
                    value += factor * token.value
174
 
                # Strip token from string
175
 
                s = token.regexp.sub("", s, 1)
176
 
                # Go to found token
177
 
                found_token = token
178
 
                # Set valid next tokens
179
 
                followers = found_token.followers
180
 
                break
181
 
        else:
182
 
            # No currently valid tokens were found
183
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
184
 
                             .format(duration))
185
 
    # End token found
186
 
    return value
187
 
 
 
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
                })
188
79
 
189
80
def string_to_delta(interval):
190
81
    """Parse a string and return a datetime.timedelta
191
82
    
192
 
    >>> string_to_delta('7d')
 
83
    >>> string_to_delta("7d")
193
84
    datetime.timedelta(7)
194
 
    >>> string_to_delta('60s')
 
85
    >>> string_to_delta("60s")
195
86
    datetime.timedelta(0, 60)
196
 
    >>> string_to_delta('60m')
 
87
    >>> string_to_delta("60m")
197
88
    datetime.timedelta(0, 3600)
198
 
    >>> string_to_delta('24h')
 
89
    >>> string_to_delta("24h")
199
90
    datetime.timedelta(1)
200
 
    >>> string_to_delta('1w')
 
91
    >>> string_to_delta("1w")
201
92
    datetime.timedelta(7)
202
 
    >>> string_to_delta('5m 30s')
 
93
    >>> string_to_delta("5m 30s")
203
94
    datetime.timedelta(0, 330)
204
95
    """
205
 
    
206
 
    try:
207
 
        return rfc3339_duration_to_delta(interval)
208
 
    except ValueError:
209
 
        pass
210
 
    
211
96
    value = datetime.timedelta(0)
212
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
97
    regexp = re.compile("(\d+)([dsmhw]?)")
213
98
    
214
99
    for num, suffix in regexp.findall(interval):
215
100
        if suffix == "d":
226
111
            value += datetime.timedelta(0, 0, 0, int(num))
227
112
    return value
228
113
 
229
 
 
230
114
def print_clients(clients, keywords):
231
115
    def valuetostring(value, keyword):
232
116
        if type(value) is dbus.Boolean:
233
117
            return "Yes" if value else "No"
234
118
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
235
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
119
                       "ApprovalDuration"):
236
120
            return milliseconds_to_string(value)
237
 
        return str(value)
 
121
        return unicode(value)
238
122
    
239
123
    # Create format string to print table rows
240
 
    format_string = " ".join("{{{key}:{width}}}".format(
241
 
        width = max(len(tablewords[key]),
242
 
                    max(len(valuetostring(client[key], key))
243
 
                        for client in clients)),
244
 
        key = key)
 
124
    format_string = " ".join("%%-%ds" %
 
125
                             max(len(tablewords[key]),
 
126
                                 max(len(valuetostring(client[key],
 
127
                                                       key))
 
128
                                     for client in
 
129
                                     clients))
245
130
                             for key in keywords)
246
131
    # Print header line
247
 
    print(format_string.format(**tablewords))
 
132
    print(format_string % tuple(tablewords[key] for key in keywords))
248
133
    for client in clients:
249
 
        print(format_string.format(**{
250
 
            key: valuetostring(client[key], key)
251
 
            for key in keywords }))
252
 
 
 
134
        print(format_string % tuple(valuetostring(client[key], key)
 
135
                                    for key in keywords))
253
136
 
254
137
def has_actions(options):
255
138
    return any((options.enable,
271
154
                options.approve,
272
155
                options.deny))
273
156
 
274
 
 
275
157
def main():
276
158
    parser = argparse.ArgumentParser()
277
159
    parser.add_argument("--version", action="version",
278
 
                        version = "%(prog)s {}".format(version),
 
160
                        version = "%%prog %s" % version,
279
161
                        help="show version number and exit")
280
162
    parser.add_argument("-a", "--all", action="store_true",
281
163
                        help="Select all clients")
282
164
    parser.add_argument("-v", "--verbose", action="store_true",
283
165
                        help="Print all fields")
284
 
    parser.add_argument("-j", "--dump-json", action="store_true",
285
 
                        help="Dump client data in JSON format")
286
166
    parser.add_argument("-e", "--enable", action="store_true",
287
167
                        help="Enable client")
288
168
    parser.add_argument("-d", "--disable", action="store_true",
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
 
        parser.error("--verbose can only be used alone.")
335
 
    if options.dump_json and (options.verbose or has_actions(options)):
336
 
        parser.error("--dump-json can only be used alone.")
 
211
        parser.error("--verbose can only be used alone or with"
 
212
                     " --all.")
337
213
    if options.all and not has_actions(options):
338
214
        parser.error("--all requires an action.")
339
215
    
340
 
    if options.check:
341
 
        fail_count, test_count = doctest.testmod()
342
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
343
 
    
344
216
    try:
345
217
        bus = dbus.SystemBus()
346
218
        mandos_dbus_objc = bus.get_object(busname, server_path)
347
219
    except dbus.exceptions.DBusException:
348
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
220
        print("Could not connect to Mandos server",
 
221
              file=sys.stderr)
349
222
        sys.exit(1)
350
223
    
351
224
    mandos_serv = dbus.Interface(mandos_dbus_objc,
352
225
                                 dbus_interface = server_interface)
353
 
    mandos_serv_object_manager = dbus.Interface(
354
 
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
355
226
    
356
227
    #block stderr since dbus library prints to stderr
357
228
    null = os.open(os.path.devnull, os.O_RDWR)
360
231
    os.close(null)
361
232
    try:
362
233
        try:
363
 
            mandos_clients = { path: ifs_and_props[client_interface]
364
 
                               for path, ifs_and_props in
365
 
                               mandos_serv_object_manager
366
 
                               .GetManagedObjects().items()
367
 
                               if client_interface in ifs_and_props }
 
234
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
368
235
        finally:
369
236
            #restore stderr
370
237
            os.dup2(stderrcopy, sys.stderr.fileno())
371
238
            os.close(stderrcopy)
372
 
    except dbus.exceptions.DBusException as e:
373
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
374
 
              .format(e), file=sys.stderr)
 
239
    except dbus.exceptions.DBusException:
 
240
        print("Access denied: Accessing mandos server through dbus.",
 
241
              file=sys.stderr)
375
242
        sys.exit(1)
376
243
    
377
244
    # Compile dict of (clients: properties) to process
378
245
    clients={}
379
246
    
380
247
    if options.all or not options.client:
381
 
        clients = { bus.get_object(busname, path): properties
382
 
                    for path, properties in mandos_clients.items() }
 
248
        clients = dict((bus.get_object(busname, path), properties)
 
249
                       for path, properties in
 
250
                       mandos_clients.iteritems())
383
251
    else:
384
252
        for name in options.client:
385
 
            for path, client in mandos_clients.items():
 
253
            for path, client in mandos_clients.iteritems():
386
254
                if client["Name"] == name:
387
255
                    client_objc = bus.get_object(busname, path)
388
256
                    clients[client_objc] = client
389
257
                    break
390
258
            else:
391
 
                print("Client not found on server: {!r}"
392
 
                      .format(name), file=sys.stderr)
 
259
                print("Client not found on server: %r" % name,
 
260
                      file=sys.stderr)
393
261
                sys.exit(1)
394
262
    
395
263
    if not has_actions(options) and clients:
396
 
        if options.verbose or options.dump_json:
397
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
398
 
                        "Created", "Interval", "Host", "Fingerprint",
399
 
                        "CheckerRunning", "LastEnabled",
400
 
                        "ApprovalPending", "ApprovedByDefault",
 
264
        if options.verbose:
 
265
            keywords = ("Name", "Enabled", "Timeout",
 
266
                        "LastCheckedOK", "Created", "Interval",
 
267
                        "Host", "Fingerprint", "CheckerRunning",
 
268
                        "LastEnabled", "ApprovalPending",
 
269
                        "ApprovedByDefault",
401
270
                        "LastApprovalRequest", "ApprovalDelay",
402
271
                        "ApprovalDuration", "Checker",
403
272
                        "ExtendedTimeout")
404
273
        else:
405
274
            keywords = defaultkeywords
406
275
        
407
 
        if options.dump_json:
408
 
            json.dump({client["Name"]: {key:
409
 
                                        bool(client[key])
410
 
                                        if isinstance(client[key],
411
 
                                                      dbus.Boolean)
412
 
                                        else client[key]
413
 
                                        for key in keywords }
414
 
                       for client in clients.values() },
415
 
                      fp = sys.stdout, indent = 4,
416
 
                      separators = (',', ': '))
417
 
            print()
418
 
        else:
419
 
            print_clients(clients.values(), keywords)
 
276
        print_clients(clients.values(), keywords)
420
277
    else:
421
278
        # Process each client in the list by all selected options
422
279
        for client in clients:
423
 
            
424
 
            def set_client_prop(prop, value):
425
 
                """Set a Client D-Bus property"""
426
 
                client.Set(client_interface, prop, value,
427
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
428
 
            
429
 
            def set_client_prop_ms(prop, value):
430
 
                """Set a Client D-Bus property, converted
431
 
                from a string to milliseconds."""
432
 
                set_client_prop(prop,
433
 
                                string_to_delta(value).total_seconds()
434
 
                                * 1000)
435
 
            
436
280
            if options.remove:
437
281
                mandos_serv.RemoveClient(client.__dbus_object_path__)
438
282
            if options.enable:
439
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
283
                client.Enable(dbus_interface=client_interface)
440
284
            if options.disable:
441
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
285
                client.Disable(dbus_interface=client_interface)
442
286
            if options.bump_timeout:
443
 
                set_client_prop("LastCheckedOK", "")
 
287
                client.CheckedOK(dbus_interface=client_interface)
444
288
            if options.start_checker:
445
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
289
                client.StartChecker(dbus_interface=client_interface)
446
290
            if options.stop_checker:
447
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
291
                client.StopChecker(dbus_interface=client_interface)
448
292
            if options.is_enabled:
449
293
                sys.exit(0 if client.Get(client_interface,
450
294
                                         "Enabled",
452
296
                                         dbus.PROPERTIES_IFACE)
453
297
                         else 1)
454
298
            if options.checker is not None:
455
 
                set_client_prop("Checker", options.checker)
 
299
                client.Set(client_interface, "Checker",
 
300
                           options.checker,
 
301
                           dbus_interface=dbus.PROPERTIES_IFACE)
456
302
            if options.host is not None:
457
 
                set_client_prop("Host", options.host)
 
303
                client.Set(client_interface, "Host", options.host,
 
304
                           dbus_interface=dbus.PROPERTIES_IFACE)
458
305
            if options.interval is not None:
459
 
                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)
460
310
            if options.approval_delay is not None:
461
 
                set_client_prop_ms("ApprovalDelay",
462
 
                                   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)
463
316
            if options.approval_duration is not None:
464
 
                set_client_prop_ms("ApprovalDuration",
465
 
                                   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)
466
322
            if options.timeout is not None:
467
 
                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)
468
327
            if options.extended_timeout is not None:
469
 
                set_client_prop_ms("ExtendedTimeout",
470
 
                                   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)
471
332
            if options.secret is not None:
472
 
                set_client_prop("Secret",
473
 
                                dbus.ByteArray(options.secret.read()))
 
333
                client.Set(client_interface, "Secret",
 
334
                           dbus.ByteArray(options.secret.read()),
 
335
                           dbus_interface=dbus.PROPERTIES_IFACE)
474
336
            if options.approved_by_default is not None:
475
 
                set_client_prop("ApprovedByDefault",
476
 
                                dbus.Boolean(options
477
 
                                             .approved_by_default))
 
337
                client.Set(client_interface, "ApprovedByDefault",
 
338
                           dbus.Boolean(options
 
339
                                        .approved_by_default),
 
340
                           dbus_interface=dbus.PROPERTIES_IFACE)
478
341
            if options.approve:
479
342
                client.Approve(dbus.Boolean(True),
480
343
                               dbus_interface=client_interface)
482
345
                client.Approve(dbus.Boolean(False),
483
346
                               dbus_interface=client_interface)
484
347
 
485
 
 
486
348
if __name__ == "__main__":
487
349
    main()