/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-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
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
 
33
 
29
34
import sys
30
 
import dbus
31
35
import argparse
32
36
import locale
33
37
import datetime
34
38
import re
35
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
36
48
 
37
49
locale.setlocale(locale.LC_ALL, "")
38
50
 
53
65
    "ApprovalDelay": "Approval Delay",
54
66
    "ApprovalDuration": "Approval Duration",
55
67
    "Checker": "Checker",
56
 
    "ExtendedTimeout" : "Extended Timeout"
57
 
    }
 
68
    "ExtendedTimeout": "Extended Timeout"
 
69
}
58
70
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
59
71
domain = "se.recompile"
60
72
busname = domain + ".Mandos"
61
73
server_path = "/"
62
74
server_interface = domain + ".Mandos"
63
75
client_interface = domain + ".Mandos.Client"
64
 
version = "1.5.3"
65
 
 
66
 
def timedelta_to_milliseconds(td):
67
 
    """Convert a datetime.timedelta object to milliseconds"""
68
 
    return ((td.days * 24 * 60 * 60 * 1000)
69
 
            + (td.seconds * 1000)
70
 
            + (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"
71
83
 
72
84
def milliseconds_to_string(ms):
73
85
    td = datetime.timedelta(0, 0, 0, ms)
74
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
75
 
            .format(days = "{0}T".format(td.days) if td.days else "",
76
 
                    hours = td.seconds // 3600,
77
 
                    minutes = (td.seconds % 3600) // 60,
78
 
                    seconds = td.seconds % 60,
79
 
                    ))
 
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
 
80
188
 
81
189
def string_to_delta(interval):
82
190
    """Parse a string and return a datetime.timedelta
83
191
    
84
 
    >>> string_to_delta("7d")
 
192
    >>> string_to_delta('7d')
85
193
    datetime.timedelta(7)
86
 
    >>> string_to_delta("60s")
 
194
    >>> string_to_delta('60s')
87
195
    datetime.timedelta(0, 60)
88
 
    >>> string_to_delta("60m")
 
196
    >>> string_to_delta('60m')
89
197
    datetime.timedelta(0, 3600)
90
 
    >>> string_to_delta("24h")
 
198
    >>> string_to_delta('24h')
91
199
    datetime.timedelta(1)
92
 
    >>> string_to_delta("1w")
 
200
    >>> string_to_delta('1w')
93
201
    datetime.timedelta(7)
94
 
    >>> string_to_delta("5m 30s")
 
202
    >>> string_to_delta('5m 30s')
95
203
    datetime.timedelta(0, 330)
96
204
    """
 
205
    
 
206
    try:
 
207
        return rfc3339_duration_to_delta(interval)
 
208
    except ValueError:
 
209
        pass
 
210
    
97
211
    value = datetime.timedelta(0)
98
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
212
    regexp = re.compile(r"(\d+)([dsmhw]?)")
99
213
    
100
214
    for num, suffix in regexp.findall(interval):
101
215
        if suffix == "d":
112
226
            value += datetime.timedelta(0, 0, 0, int(num))
113
227
    return value
114
228
 
 
229
 
115
230
def print_clients(clients, keywords):
116
231
    def valuetostring(value, keyword):
117
232
        if type(value) is dbus.Boolean:
119
234
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
120
235
                       "ApprovalDuration", "ExtendedTimeout"):
121
236
            return milliseconds_to_string(value)
122
 
        return unicode(value)
 
237
        return str(value)
123
238
    
124
239
    # Create format string to print table rows
125
240
    format_string = " ".join("{{{key}:{width}}}".format(
126
 
            width = max(len(tablewords[key]),
127
 
                        max(len(valuetostring(client[key],
128
 
                                              key))
129
 
                            for client in
130
 
                            clients)),
131
 
            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)
132
246
    # Print header line
133
247
    print(format_string.format(**tablewords))
134
248
    for client in clients:
135
 
        print(format_string.format(**dict((key,
136
 
                                           valuetostring(client[key],
137
 
                                                         key))
138
 
                                          for key in keywords)))
 
249
        print(format_string.format(**{
 
250
            key: valuetostring(client[key], key)
 
251
            for key in keywords }))
 
252
 
139
253
 
140
254
def has_actions(options):
141
255
    return any((options.enable,
157
271
                options.approve,
158
272
                options.deny))
159
273
 
 
274
 
160
275
def main():
161
276
    parser = argparse.ArgumentParser()
162
277
    parser.add_argument("--version", action="version",
163
 
                        version = "%(prog)s {0}".format(version),
 
278
                        version = "%(prog)s {}".format(version),
164
279
                        help="show version number and exit")
165
280
    parser.add_argument("-a", "--all", action="store_true",
166
281
                        help="Select all clients")
167
282
    parser.add_argument("-v", "--verbose", action="store_true",
168
283
                        help="Print all fields")
 
284
    parser.add_argument("-j", "--dump-json", action="store_true",
 
285
                        help="Dump client data in JSON format")
169
286
    parser.add_argument("-e", "--enable", action="store_true",
170
287
                        help="Enable client")
171
288
    parser.add_argument("-d", "--disable", action="store_true",
199
316
    parser.add_argument("--approval-duration",
200
317
                        help="Set duration of one client approval")
201
318
    parser.add_argument("-H", "--host", help="Set host for client")
202
 
    parser.add_argument("-s", "--secret", type=file,
 
319
    parser.add_argument("-s", "--secret",
 
320
                        type=argparse.FileType(mode="rb"),
203
321
                        help="Set password blob (file) for client")
204
322
    parser.add_argument("-A", "--approve", action="store_true",
205
323
                        help="Approve any current client request")
206
324
    parser.add_argument("-D", "--deny", action="store_true",
207
325
                        help="Deny any current client request")
 
326
    parser.add_argument("--check", action="store_true",
 
327
                        help="Run self-test")
208
328
    parser.add_argument("client", nargs="*", help="Client name")
209
329
    options = parser.parse_args()
210
330
    
211
331
    if has_actions(options) and not (options.client or options.all):
212
332
        parser.error("Options require clients names or --all.")
213
333
    if options.verbose and has_actions(options):
214
 
        parser.error("--verbose can only be used alone or with"
215
 
                     " --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.")
216
337
    if options.all and not has_actions(options):
217
338
        parser.error("--all requires an action.")
218
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
    
219
344
    try:
220
345
        bus = dbus.SystemBus()
221
346
        mandos_dbus_objc = bus.get_object(busname, server_path)
222
347
    except dbus.exceptions.DBusException:
223
 
        print("Could not connect to Mandos server",
224
 
              file=sys.stderr)
 
348
        print("Could not connect to Mandos server", file=sys.stderr)
225
349
        sys.exit(1)
226
350
    
227
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
228
352
                                 dbus_interface = server_interface)
 
353
    mandos_serv_object_manager = dbus.Interface(
 
354
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
229
355
    
230
356
    #block stderr since dbus library prints to stderr
231
357
    null = os.open(os.path.devnull, os.O_RDWR)
234
360
    os.close(null)
235
361
    try:
236
362
        try:
237
 
            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 }
238
368
        finally:
239
369
            #restore stderr
240
370
            os.dup2(stderrcopy, sys.stderr.fileno())
241
371
            os.close(stderrcopy)
242
 
    except dbus.exceptions.DBusException:
243
 
        print("Access denied: Accessing mandos server through dbus.",
244
 
              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)
245
375
        sys.exit(1)
246
376
    
247
377
    # Compile dict of (clients: properties) to process
248
378
    clients={}
249
379
    
250
380
    if options.all or not options.client:
251
 
        clients = dict((bus.get_object(busname, path), properties)
252
 
                       for path, properties in
253
 
                       mandos_clients.iteritems())
 
381
        clients = { bus.get_object(busname, path): properties
 
382
                    for path, properties in mandos_clients.items() }
254
383
    else:
255
384
        for name in options.client:
256
 
            for path, client in mandos_clients.iteritems():
 
385
            for path, client in mandos_clients.items():
257
386
                if client["Name"] == name:
258
387
                    client_objc = bus.get_object(busname, path)
259
388
                    clients[client_objc] = client
260
389
                    break
261
390
            else:
262
 
                print("Client not found on server: {0!r}"
 
391
                print("Client not found on server: {!r}"
263
392
                      .format(name), file=sys.stderr)
264
393
                sys.exit(1)
265
394
    
266
395
    if not has_actions(options) and clients:
267
 
        if options.verbose:
268
 
            keywords = ("Name", "Enabled", "Timeout",
269
 
                        "LastCheckedOK", "Created", "Interval",
270
 
                        "Host", "Fingerprint", "CheckerRunning",
271
 
                        "LastEnabled", "ApprovalPending",
272
 
                        "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",
273
401
                        "LastApprovalRequest", "ApprovalDelay",
274
402
                        "ApprovalDuration", "Checker",
275
403
                        "ExtendedTimeout")
276
404
        else:
277
405
            keywords = defaultkeywords
278
406
        
279
 
        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)
280
416
    else:
281
417
        # Process each client in the list by all selected options
282
418
        for client in clients:
 
419
            
283
420
            def set_client_prop(prop, value):
284
421
                """Set a Client D-Bus property"""
285
422
                client.Set(client_interface, prop, value,
286
423
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
424
            
287
425
            def set_client_prop_ms(prop, value):
288
426
                """Set a Client D-Bus property, converted
289
427
                from a string to milliseconds."""
290
428
                set_client_prop(prop,
291
 
                                timedelta_to_milliseconds
292
 
                                (string_to_delta(value)))
 
429
                                string_to_delta(value).total_seconds()
 
430
                                * 1000)
 
431
            
293
432
            if options.remove:
294
433
                mandos_serv.RemoveClient(client.__dbus_object_path__)
295
434
            if options.enable:
339
478
                client.Approve(dbus.Boolean(False),
340
479
                               dbus_interface=client_interface)
341
480
 
 
481
 
342
482
if __name__ == "__main__":
343
483
    main()