/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: 2016-06-28 18:46:40 UTC
  • Revision ID: teddy@recompile.se-20160628184640-22uh54op9nw0908b
mandos-ctl: Dump booleans as booleans in --dump-json output.

* mandos-ctl (main): Detect dbus.Boolean objects and recast them to
                     regular Python bool() objects to make them show
                     as boolean values in dump output.

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-2012 Teddy Hogeborn
7
 
# Copyright © 2008-2012 Björn Påhlsson
 
6
# Copyright © 2008-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 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
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
28
 
29
 
from future_builtins import *
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
30
33
 
31
34
import sys
32
35
import argparse
36
39
import os
37
40
import collections
38
41
import doctest
 
42
import json
39
43
 
40
44
import dbus
41
45
 
 
46
if sys.version_info.major == 2:
 
47
    str = unicode
 
48
 
42
49
locale.setlocale(locale.LC_ALL, "")
43
50
 
44
51
tablewords = {
58
65
    "ApprovalDelay": "Approval Delay",
59
66
    "ApprovalDuration": "Approval Duration",
60
67
    "Checker": "Checker",
61
 
    "ExtendedTimeout" : "Extended Timeout"
62
 
    }
 
68
    "ExtendedTimeout": "Extended Timeout"
 
69
}
63
70
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
71
domain = "se.recompile"
65
72
busname = domain + ".Mandos"
66
73
server_path = "/"
67
74
server_interface = domain + ".Mandos"
68
75
client_interface = domain + ".Mandos.Client"
69
 
version = "1.6.0"
70
 
 
71
 
def timedelta_to_milliseconds(td):
72
 
    """Convert a datetime.timedelta object to milliseconds"""
73
 
    return ((td.days * 24 * 60 * 60 * 1000)
74
 
            + (td.seconds * 1000)
75
 
            + (td.microseconds // 1000))
 
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"
76
83
 
77
84
def milliseconds_to_string(ms):
78
85
    td = datetime.timedelta(0, 0, 0, ms)
79
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
 
            .format(days = "{0}T".format(td.days) if td.days else "",
81
 
                    hours = td.seconds // 3600,
82
 
                    minutes = (td.seconds % 3600) // 60,
83
 
                    seconds = td.seconds % 60,
84
 
                    ))
 
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))
85
91
 
86
92
 
87
93
def rfc3339_duration_to_delta(duration):
88
 
    """Parse a RFC 3339 "duration" and return a datetime.timedelta
 
94
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
89
95
    
90
96
    >>> rfc3339_duration_to_delta("P7D")
91
97
    datetime.timedelta(7)
103
109
    datetime.timedelta(1, 200)
104
110
    """
105
111
    
106
 
    # Parsing a RFC 3339 duration with regular expressions is not
 
112
    # Parsing an RFC 3339 duration with regular expressions is not
107
113
    # possible - there would have to be multiple places for the same
108
 
    # values, like seconds.  This, while more esoteric, is cleaner
109
 
    # without depending on a parsing library.  If Python had a
 
114
    # values, like seconds.  The current code, while more esoteric, is
 
115
    # cleaner without depending on a parsing library.  If Python had a
110
116
    # built-in library for parsing we would use it, but we'd like to
111
117
    # avoid excessive use of external libraries.
112
118
    
113
119
    # 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
 
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
123
125
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
126
    # the "duration" ABNF definition in RFC 3339, Appendix A.
125
127
    token_end = Token(re.compile(r"$"), None, frozenset())
126
128
    token_second = Token(re.compile(r"(\d+)S"),
127
129
                         datetime.timedelta(seconds=1),
128
 
                         frozenset((token_end,)))
 
130
                         frozenset((token_end, )))
129
131
    token_minute = Token(re.compile(r"(\d+)M"),
130
132
                         datetime.timedelta(minutes=1),
131
133
                         frozenset((token_second, token_end)))
147
149
                       frozenset((token_month, token_end)))
148
150
    token_week = Token(re.compile(r"(\d+)W"),
149
151
                       datetime.timedelta(weeks=1),
150
 
                       frozenset((token_end,)))
 
152
                       frozenset((token_end, )))
151
153
    token_duration = Token(re.compile(r"P"), None,
152
154
                           frozenset((token_year, token_month,
153
155
                                      token_day, token_time,
154
 
                                      token_week))),
 
156
                                      token_week)))
155
157
    # Define starting values
156
158
    value = datetime.timedelta() # Value so far
157
159
    found_token = None
158
 
    followers = frozenset(token_duration,) # Following valid tokens
 
160
    followers = frozenset((token_duration, )) # Following valid tokens
159
161
    s = duration                # String left to parse
160
162
    # Loop until end token is found
161
163
    while found_token is not token_end:
178
180
                break
179
181
        else:
180
182
            # No currently valid tokens were found
181
 
            raise ValueError("Invalid RFC 3339 duration")
 
183
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
184
                             .format(duration))
182
185
    # End token found
183
186
    return value
184
187
 
186
189
def string_to_delta(interval):
187
190
    """Parse a string and return a datetime.timedelta
188
191
    
189
 
    >>> string_to_delta("7d")
 
192
    >>> string_to_delta('7d')
190
193
    datetime.timedelta(7)
191
 
    >>> string_to_delta("60s")
 
194
    >>> string_to_delta('60s')
192
195
    datetime.timedelta(0, 60)
193
 
    >>> string_to_delta("60m")
 
196
    >>> string_to_delta('60m')
194
197
    datetime.timedelta(0, 3600)
195
 
    >>> string_to_delta("24h")
 
198
    >>> string_to_delta('24h')
196
199
    datetime.timedelta(1)
197
 
    >>> string_to_delta("1w")
 
200
    >>> string_to_delta('1w')
198
201
    datetime.timedelta(7)
199
 
    >>> string_to_delta("5m 30s")
 
202
    >>> string_to_delta('5m 30s')
200
203
    datetime.timedelta(0, 330)
201
204
    """
202
 
    value = datetime.timedelta(0)
203
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
204
205
    
205
206
    try:
206
207
        return rfc3339_duration_to_delta(interval)
207
208
    except ValueError:
208
209
        pass
209
210
    
 
211
    value = datetime.timedelta(0)
 
212
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
213
    
210
214
    for num, suffix in regexp.findall(interval):
211
215
        if suffix == "d":
212
216
            value += datetime.timedelta(int(num))
222
226
            value += datetime.timedelta(0, 0, 0, int(num))
223
227
    return value
224
228
 
 
229
 
225
230
def print_clients(clients, keywords):
226
231
    def valuetostring(value, keyword):
227
232
        if type(value) is dbus.Boolean:
229
234
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
230
235
                       "ApprovalDuration", "ExtendedTimeout"):
231
236
            return milliseconds_to_string(value)
232
 
        return unicode(value)
 
237
        return str(value)
233
238
    
234
239
    # Create format string to print table rows
235
240
    format_string = " ".join("{{{key}:{width}}}".format(
236
 
            width = max(len(tablewords[key]),
237
 
                        max(len(valuetostring(client[key],
238
 
                                              key))
239
 
                            for client in
240
 
                            clients)),
241
 
            key = key) for key in keywords)
 
241
        width = max(len(tablewords[key]),
 
242
                    max(len(valuetostring(client[key], key))
 
243
                        for client in clients)),
 
244
        key = key)
 
245
                             for key in keywords)
242
246
    # Print header line
243
247
    print(format_string.format(**tablewords))
244
248
    for client in clients:
245
 
        print(format_string.format(**dict((key,
246
 
                                           valuetostring(client[key],
247
 
                                                         key))
248
 
                                          for key in keywords)))
 
249
        print(format_string.format(**{
 
250
            key: valuetostring(client[key], key)
 
251
            for key in keywords }))
 
252
 
249
253
 
250
254
def has_actions(options):
251
255
    return any((options.enable,
267
271
                options.approve,
268
272
                options.deny))
269
273
 
 
274
 
270
275
def main():
271
276
    parser = argparse.ArgumentParser()
272
277
    parser.add_argument("--version", action="version",
273
 
                        version = "%(prog)s {0}".format(version),
 
278
                        version = "%(prog)s {}".format(version),
274
279
                        help="show version number and exit")
275
280
    parser.add_argument("-a", "--all", action="store_true",
276
281
                        help="Select all clients")
277
282
    parser.add_argument("-v", "--verbose", action="store_true",
278
283
                        help="Print all fields")
 
284
    parser.add_argument("-j", "--dump-json", action="store_true",
 
285
                        help="Dump client data in JSON format")
279
286
    parser.add_argument("-e", "--enable", action="store_true",
280
287
                        help="Enable client")
281
288
    parser.add_argument("-d", "--disable", action="store_true",
309
316
    parser.add_argument("--approval-duration",
310
317
                        help="Set duration of one client approval")
311
318
    parser.add_argument("-H", "--host", help="Set host for client")
312
 
    parser.add_argument("-s", "--secret", type=file,
 
319
    parser.add_argument("-s", "--secret",
 
320
                        type=argparse.FileType(mode="rb"),
313
321
                        help="Set password blob (file) for client")
314
322
    parser.add_argument("-A", "--approve", action="store_true",
315
323
                        help="Approve any current client request")
323
331
    if has_actions(options) and not (options.client or options.all):
324
332
        parser.error("Options require clients names or --all.")
325
333
    if options.verbose and has_actions(options):
326
 
        parser.error("--verbose can only be used alone or with"
327
 
                     " --all.")
 
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.")
328
337
    if options.all and not has_actions(options):
329
338
        parser.error("--all requires an action.")
330
 
 
 
339
    
331
340
    if options.check:
332
341
        fail_count, test_count = doctest.testmod()
333
 
        sys.exit(0 if fail_count == 0 else 1)
 
342
        sys.exit(os.EX_OK if fail_count == 0 else 1)
334
343
    
335
344
    try:
336
345
        bus = dbus.SystemBus()
337
346
        mandos_dbus_objc = bus.get_object(busname, server_path)
338
347
    except dbus.exceptions.DBusException:
339
 
        print("Could not connect to Mandos server",
340
 
              file=sys.stderr)
 
348
        print("Could not connect to Mandos server", file=sys.stderr)
341
349
        sys.exit(1)
342
350
    
343
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
344
352
                                 dbus_interface = server_interface)
 
353
    mandos_serv_object_manager = dbus.Interface(
 
354
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
345
355
    
346
356
    #block stderr since dbus library prints to stderr
347
357
    null = os.open(os.path.devnull, os.O_RDWR)
350
360
    os.close(null)
351
361
    try:
352
362
        try:
353
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
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 }
354
368
        finally:
355
369
            #restore stderr
356
370
            os.dup2(stderrcopy, sys.stderr.fileno())
357
371
            os.close(stderrcopy)
358
 
    except dbus.exceptions.DBusException:
359
 
        print("Access denied: Accessing mandos server through dbus.",
360
 
              file=sys.stderr)
 
372
    except dbus.exceptions.DBusException as e:
 
373
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
374
              .format(e), file=sys.stderr)
361
375
        sys.exit(1)
362
376
    
363
377
    # Compile dict of (clients: properties) to process
364
378
    clients={}
365
379
    
366
380
    if options.all or not options.client:
367
 
        clients = dict((bus.get_object(busname, path), properties)
368
 
                       for path, properties in
369
 
                       mandos_clients.iteritems())
 
381
        clients = { bus.get_object(busname, path): properties
 
382
                    for path, properties in mandos_clients.items() }
370
383
    else:
371
384
        for name in options.client:
372
 
            for path, client in mandos_clients.iteritems():
 
385
            for path, client in mandos_clients.items():
373
386
                if client["Name"] == name:
374
387
                    client_objc = bus.get_object(busname, path)
375
388
                    clients[client_objc] = client
376
389
                    break
377
390
            else:
378
 
                print("Client not found on server: {0!r}"
 
391
                print("Client not found on server: {!r}"
379
392
                      .format(name), file=sys.stderr)
380
393
                sys.exit(1)
381
394
    
382
395
    if not has_actions(options) and clients:
383
 
        if options.verbose:
384
 
            keywords = ("Name", "Enabled", "Timeout",
385
 
                        "LastCheckedOK", "Created", "Interval",
386
 
                        "Host", "Fingerprint", "CheckerRunning",
387
 
                        "LastEnabled", "ApprovalPending",
388
 
                        "ApprovedByDefault",
 
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",
389
401
                        "LastApprovalRequest", "ApprovalDelay",
390
402
                        "ApprovalDuration", "Checker",
391
403
                        "ExtendedTimeout")
392
404
        else:
393
405
            keywords = defaultkeywords
394
406
        
395
 
        print_clients(clients.values(), keywords)
 
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)
396
420
    else:
397
421
        # Process each client in the list by all selected options
398
422
        for client in clients:
 
423
            
399
424
            def set_client_prop(prop, value):
400
425
                """Set a Client D-Bus property"""
401
426
                client.Set(client_interface, prop, value,
402
427
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
428
            
403
429
            def set_client_prop_ms(prop, value):
404
430
                """Set a Client D-Bus property, converted
405
431
                from a string to milliseconds."""
406
432
                set_client_prop(prop,
407
 
                                timedelta_to_milliseconds
408
 
                                (string_to_delta(value)))
 
433
                                string_to_delta(value).total_seconds()
 
434
                                * 1000)
 
435
            
409
436
            if options.remove:
410
437
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
438
            if options.enable:
455
482
                client.Approve(dbus.Boolean(False),
456
483
                               dbus_interface=client_interface)
457
484
 
 
485
 
458
486
if __name__ == "__main__":
459
487
    main()