/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-27 20:21:50 UTC
  • Revision ID: teddy@recompile.se-20160627202150-ml201ilxwjf1g29w
mandos-ctl: Implement --dump-json option

* mandos-ctl (main): Implement --dump-json option
* mandos-ctl.xml (NAME, DESCRIPTION): Change description to the more
                                      accurate "control or query".
  (SYNOPSIS): Add required group around action options and add new
              "--dump-json" option.
  (OPTIONS): Document new "--dump-json" option.

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-2011 Teddy Hogeborn
7
 
# Copyright © 2008-2011 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
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
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
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
import json
 
43
 
 
44
import dbus
 
45
 
 
46
if sys.version_info.major == 2:
 
47
    str = unicode
35
48
 
36
49
locale.setlocale(locale.LC_ALL, "")
37
50
 
52
65
    "ApprovalDelay": "Approval Delay",
53
66
    "ApprovalDuration": "Approval Duration",
54
67
    "Checker": "Checker",
55
 
    "ExtendedTimeout" : "Extended Timeout"
56
 
    }
 
68
    "ExtendedTimeout": "Extended Timeout"
 
69
}
57
70
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
58
71
domain = "se.recompile"
59
72
busname = domain + ".Mandos"
60
73
server_path = "/"
61
74
server_interface = domain + ".Mandos"
62
75
client_interface = domain + ".Mandos.Client"
63
 
version = "1.4.1"
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
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"
70
83
 
71
84
def milliseconds_to_string(ms):
72
85
    td = datetime.timedelta(0, 0, 0, ms)
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
 
                })
 
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
 
79
188
 
80
189
def string_to_delta(interval):
81
190
    """Parse a string and return a datetime.timedelta
82
191
    
83
 
    >>> string_to_delta("7d")
 
192
    >>> string_to_delta('7d')
84
193
    datetime.timedelta(7)
85
 
    >>> string_to_delta("60s")
 
194
    >>> string_to_delta('60s')
86
195
    datetime.timedelta(0, 60)
87
 
    >>> string_to_delta("60m")
 
196
    >>> string_to_delta('60m')
88
197
    datetime.timedelta(0, 3600)
89
 
    >>> string_to_delta("24h")
 
198
    >>> string_to_delta('24h')
90
199
    datetime.timedelta(1)
91
 
    >>> string_to_delta("1w")
 
200
    >>> string_to_delta('1w')
92
201
    datetime.timedelta(7)
93
 
    >>> string_to_delta("5m 30s")
 
202
    >>> string_to_delta('5m 30s')
94
203
    datetime.timedelta(0, 330)
95
204
    """
 
205
    
 
206
    try:
 
207
        return rfc3339_duration_to_delta(interval)
 
208
    except ValueError:
 
209
        pass
 
210
    
96
211
    value = datetime.timedelta(0)
97
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
212
    regexp = re.compile(r"(\d+)([dsmhw]?)")
98
213
    
99
214
    for num, suffix in regexp.findall(interval):
100
215
        if suffix == "d":
111
226
            value += datetime.timedelta(0, 0, 0, int(num))
112
227
    return value
113
228
 
 
229
 
114
230
def print_clients(clients, keywords):
115
231
    def valuetostring(value, keyword):
116
232
        if type(value) is dbus.Boolean:
117
233
            return "Yes" if value else "No"
118
234
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
119
 
                       "ApprovalDuration"):
 
235
                       "ApprovalDuration", "ExtendedTimeout"):
120
236
            return milliseconds_to_string(value)
121
 
        return unicode(value)
 
237
        return str(value)
122
238
    
123
239
    # Create format string to print table rows
124
 
    format_string = " ".join("%%-%ds" %
125
 
                             max(len(tablewords[key]),
126
 
                                 max(len(valuetostring(client[key],
127
 
                                                       key))
128
 
                                     for client in
129
 
                                     clients))
 
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)
130
245
                             for key in keywords)
131
246
    # Print header line
132
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
247
    print(format_string.format(**tablewords))
133
248
    for client in clients:
134
 
        print(format_string % tuple(valuetostring(client[key], key)
135
 
                                    for key in keywords))
 
249
        print(format_string.format(**{
 
250
            key: valuetostring(client[key], key)
 
251
            for key in keywords }))
 
252
 
136
253
 
137
254
def has_actions(options):
138
255
    return any((options.enable,
154
271
                options.approve,
155
272
                options.deny))
156
273
 
 
274
 
157
275
def main():
158
276
    parser = argparse.ArgumentParser()
159
277
    parser.add_argument("--version", action="version",
160
 
                        version = "%%prog %s" % version,
 
278
                        version = "%(prog)s {}".format(version),
161
279
                        help="show version number and exit")
162
280
    parser.add_argument("-a", "--all", action="store_true",
163
281
                        help="Select all clients")
164
282
    parser.add_argument("-v", "--verbose", action="store_true",
165
283
                        help="Print all fields")
 
284
    parser.add_argument("-j", "--dump-json", action="store_true",
 
285
                        help="Dump client data in JSON format")
166
286
    parser.add_argument("-e", "--enable", action="store_true",
167
287
                        help="Enable client")
168
288
    parser.add_argument("-d", "--disable", action="store_true",
196
316
    parser.add_argument("--approval-duration",
197
317
                        help="Set duration of one client approval")
198
318
    parser.add_argument("-H", "--host", help="Set host for client")
199
 
    parser.add_argument("-s", "--secret", type=file,
 
319
    parser.add_argument("-s", "--secret",
 
320
                        type=argparse.FileType(mode="rb"),
200
321
                        help="Set password blob (file) for client")
201
322
    parser.add_argument("-A", "--approve", action="store_true",
202
323
                        help="Approve any current client request")
203
324
    parser.add_argument("-D", "--deny", action="store_true",
204
325
                        help="Deny any current client request")
 
326
    parser.add_argument("--check", action="store_true",
 
327
                        help="Run self-test")
205
328
    parser.add_argument("client", nargs="*", help="Client name")
206
329
    options = parser.parse_args()
207
330
    
208
 
    if has_actions(options) and not options.client and not options.all:
 
331
    if has_actions(options) and not (options.client or options.all):
209
332
        parser.error("Options require clients names or --all.")
210
333
    if options.verbose and has_actions(options):
211
 
        parser.error("--verbose can only be used alone or with"
212
 
                     " --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.")
213
337
    if options.all and not has_actions(options):
214
338
        parser.error("--all requires an action.")
215
339
    
 
340
    if options.check:
 
341
        fail_count, test_count = doctest.testmod()
 
342
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
343
    
216
344
    try:
217
345
        bus = dbus.SystemBus()
218
346
        mandos_dbus_objc = bus.get_object(busname, server_path)
219
347
    except dbus.exceptions.DBusException:
220
 
        print("Could not connect to Mandos server",
221
 
              file=sys.stderr)
 
348
        print("Could not connect to Mandos server", file=sys.stderr)
222
349
        sys.exit(1)
223
350
    
224
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
225
352
                                 dbus_interface = server_interface)
 
353
    mandos_serv_object_manager = dbus.Interface(
 
354
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
226
355
    
227
356
    #block stderr since dbus library prints to stderr
228
357
    null = os.open(os.path.devnull, os.O_RDWR)
231
360
    os.close(null)
232
361
    try:
233
362
        try:
234
 
            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 }
235
368
        finally:
236
369
            #restore stderr
237
370
            os.dup2(stderrcopy, sys.stderr.fileno())
238
371
            os.close(stderrcopy)
239
 
    except dbus.exceptions.DBusException, e:
240
 
        print("Access denied: Accessing mandos server through dbus.",
241
 
              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)
242
375
        sys.exit(1)
243
376
    
244
377
    # Compile dict of (clients: properties) to process
245
378
    clients={}
246
379
    
247
380
    if options.all or not options.client:
248
 
        clients = dict((bus.get_object(busname, path), properties)
249
 
                       for path, properties in
250
 
                       mandos_clients.iteritems())
 
381
        clients = { bus.get_object(busname, path): properties
 
382
                    for path, properties in mandos_clients.items() }
251
383
    else:
252
384
        for name in options.client:
253
 
            for path, client in mandos_clients.iteritems():
 
385
            for path, client in mandos_clients.items():
254
386
                if client["Name"] == name:
255
387
                    client_objc = bus.get_object(busname, path)
256
388
                    clients[client_objc] = client
257
389
                    break
258
390
            else:
259
 
                print("Client not found on server: %r" % name,
260
 
                      file=sys.stderr)
 
391
                print("Client not found on server: {!r}"
 
392
                      .format(name), file=sys.stderr)
261
393
                sys.exit(1)
262
394
    
263
395
    if not has_actions(options) and clients:
264
 
        if options.verbose:
265
 
            keywords = ("Name", "Enabled", "Timeout",
266
 
                        "LastCheckedOK", "Created", "Interval",
267
 
                        "Host", "Fingerprint", "CheckerRunning",
268
 
                        "LastEnabled", "ApprovalPending",
269
 
                        "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",
270
401
                        "LastApprovalRequest", "ApprovalDelay",
271
402
                        "ApprovalDuration", "Checker",
272
403
                        "ExtendedTimeout")
273
404
        else:
274
405
            keywords = defaultkeywords
275
406
        
276
 
        print_clients(clients.values(), keywords)
 
407
        if options.dump_json:
 
408
            json.dump({client["Name"]: {key: client[key]
 
409
                                        for key in keywords }
 
410
                       for client in clients.values() },
 
411
                      fp = sys.stdout, indent = 4,
 
412
                      separators = (',', ': '))
 
413
            print()
 
414
        else:
 
415
            print_clients(clients.values(), keywords)
277
416
    else:
278
417
        # Process each client in the list by all selected options
279
418
        for client in clients:
 
419
            
 
420
            def set_client_prop(prop, value):
 
421
                """Set a Client D-Bus property"""
 
422
                client.Set(client_interface, prop, value,
 
423
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
424
            
 
425
            def set_client_prop_ms(prop, value):
 
426
                """Set a Client D-Bus property, converted
 
427
                from a string to milliseconds."""
 
428
                set_client_prop(prop,
 
429
                                string_to_delta(value).total_seconds()
 
430
                                * 1000)
 
431
            
280
432
            if options.remove:
281
433
                mandos_serv.RemoveClient(client.__dbus_object_path__)
282
434
            if options.enable:
283
 
                client.Enable(dbus_interface=client_interface)
 
435
                set_client_prop("Enabled", dbus.Boolean(True))
284
436
            if options.disable:
285
 
                client.Disable(dbus_interface=client_interface)
 
437
                set_client_prop("Enabled", dbus.Boolean(False))
286
438
            if options.bump_timeout:
287
 
                client.CheckedOK(dbus_interface=client_interface)
 
439
                set_client_prop("LastCheckedOK", "")
288
440
            if options.start_checker:
289
 
                client.StartChecker(dbus_interface=client_interface)
 
441
                set_client_prop("CheckerRunning", dbus.Boolean(True))
290
442
            if options.stop_checker:
291
 
                client.StopChecker(dbus_interface=client_interface)
 
443
                set_client_prop("CheckerRunning", dbus.Boolean(False))
292
444
            if options.is_enabled:
293
445
                sys.exit(0 if client.Get(client_interface,
294
446
                                         "Enabled",
296
448
                                         dbus.PROPERTIES_IFACE)
297
449
                         else 1)
298
450
            if options.checker is not None:
299
 
                client.Set(client_interface, "Checker",
300
 
                           options.checker,
301
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
451
                set_client_prop("Checker", options.checker)
302
452
            if options.host is not None:
303
 
                client.Set(client_interface, "Host", options.host,
304
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
453
                set_client_prop("Host", options.host)
305
454
            if options.interval is not None:
306
 
                client.Set(client_interface, "Interval",
307
 
                           timedelta_to_milliseconds
308
 
                           (string_to_delta(options.interval)),
309
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
455
                set_client_prop_ms("Interval", options.interval)
310
456
            if options.approval_delay is not None:
311
 
                client.Set(client_interface, "ApprovalDelay",
312
 
                           timedelta_to_milliseconds
313
 
                           (string_to_delta(options.
314
 
                                            approval_delay)),
315
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
457
                set_client_prop_ms("ApprovalDelay",
 
458
                                   options.approval_delay)
316
459
            if options.approval_duration is not None:
317
 
                client.Set(client_interface, "ApprovalDuration",
318
 
                           timedelta_to_milliseconds
319
 
                           (string_to_delta(options.
320
 
                                            approval_duration)),
321
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
460
                set_client_prop_ms("ApprovalDuration",
 
461
                                   options.approval_duration)
322
462
            if options.timeout is not None:
323
 
                client.Set(client_interface, "Timeout",
324
 
                           timedelta_to_milliseconds
325
 
                           (string_to_delta(options.timeout)),
326
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
463
                set_client_prop_ms("Timeout", options.timeout)
327
464
            if options.extended_timeout is not None:
328
 
                client.Set(client_interface, "ExtendedTimeout",
329
 
                           timedelta_to_milliseconds
330
 
                           (string_to_delta(options.extended_timeout)),
331
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
465
                set_client_prop_ms("ExtendedTimeout",
 
466
                                   options.extended_timeout)
332
467
            if options.secret is not None:
333
 
                client.Set(client_interface, "Secret",
334
 
                           dbus.ByteArray(open(options.secret,
335
 
                                               "rb").read()),
336
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
468
                set_client_prop("Secret",
 
469
                                dbus.ByteArray(options.secret.read()))
337
470
            if options.approved_by_default is not None:
338
 
                client.Set(client_interface, "ApprovedByDefault",
339
 
                           dbus.Boolean(options
340
 
                                        .approved_by_default),
341
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
471
                set_client_prop("ApprovedByDefault",
 
472
                                dbus.Boolean(options
 
473
                                             .approved_by_default))
342
474
            if options.approve:
343
475
                client.Approve(dbus.Boolean(True),
344
476
                               dbus_interface=client_interface)
346
478
                client.Approve(dbus.Boolean(False),
347
479
                               dbus_interface=client_interface)
348
480
 
 
481
 
349
482
if __name__ == "__main__":
350
483
    main()