/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
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
#
 
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2008-2017 Teddy Hogeborn
7
 
# Copyright © 2008-2017 Björn Påhlsson
8
 
#
 
5
# 
 
6
# Copyright © 2008-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 Björn Påhlsson
 
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
11
11
# the Free Software Foundation, either version 3 of the License, or
15
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
16
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
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
20
# along with this program.  If not, see
21
21
# <http://www.gnu.org/licenses/>.
22
 
#
 
22
# 
23
23
# Contact the authors at <mandos@recompile.se>.
24
 
#
 
24
# 
25
25
 
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
38
38
import re
39
39
import os
40
40
import collections
 
41
import doctest
41
42
import json
42
43
 
43
44
import dbus
64
65
    "ApprovalDelay": "Approval Delay",
65
66
    "ApprovalDuration": "Approval Duration",
66
67
    "Checker": "Checker",
67
 
    "ExtendedTimeout": "Extended Timeout",
68
 
    "Expires": "Expires",
69
 
    "LastCheckerStatus": "Last Checker Status",
 
68
    "ExtendedTimeout": "Extended Timeout"
70
69
}
71
70
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
72
71
domain = "se.recompile"
74
73
server_path = "/"
75
74
server_interface = domain + ".Mandos"
76
75
client_interface = domain + ".Mandos.Client"
77
 
version = "1.7.15"
 
76
version = "1.7.10"
78
77
 
79
78
 
80
79
try:
82
81
except AttributeError:
83
82
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
84
83
 
85
 
 
86
84
def milliseconds_to_string(ms):
87
85
    td = datetime.timedelta(0, 0, 0, ms)
88
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
89
 
            .format(days="{}T".format(td.days) if td.days else "",
90
 
                    hours=td.seconds // 3600,
91
 
                    minutes=(td.seconds % 3600) // 60,
92
 
                    seconds=td.seconds % 60))
 
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))
93
91
 
94
92
 
95
93
def rfc3339_duration_to_delta(duration):
96
94
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
97
 
 
 
95
    
98
96
    >>> rfc3339_duration_to_delta("P7D")
99
97
    datetime.timedelta(7)
100
98
    >>> rfc3339_duration_to_delta("PT60S")
110
108
    >>> rfc3339_duration_to_delta("P1DT3M20S")
111
109
    datetime.timedelta(1, 200)
112
110
    """
113
 
 
 
111
    
114
112
    # Parsing an RFC 3339 duration with regular expressions is not
115
113
    # possible - there would have to be multiple places for the same
116
114
    # values, like seconds.  The current code, while more esoteric, is
117
115
    # cleaner without depending on a parsing library.  If Python had a
118
116
    # built-in library for parsing we would use it, but we'd like to
119
117
    # avoid excessive use of external libraries.
120
 
 
 
118
    
121
119
    # New type for defining tokens, syntax, and semantics all-in-one
122
120
    Token = collections.namedtuple("Token", (
123
121
        "regexp",  # To match token; if "value" is not None, must have
156
154
                           frozenset((token_year, token_month,
157
155
                                      token_day, token_time,
158
156
                                      token_week)))
159
 
    # Define starting values:
160
 
    # Value so far
161
 
    value = datetime.timedelta()
 
157
    # Define starting values
 
158
    value = datetime.timedelta() # Value so far
162
159
    found_token = None
163
 
    # Following valid tokens
164
 
    followers = frozenset((token_duration, ))
165
 
    # String left to parse
166
 
    s = duration
 
160
    followers = frozenset((token_duration, )) # Following valid tokens
 
161
    s = duration                # String left to parse
167
162
    # Loop until end token is found
168
163
    while found_token is not token_end:
169
164
        # Search for any currently valid tokens
193
188
 
194
189
def string_to_delta(interval):
195
190
    """Parse a string and return a datetime.timedelta
196
 
 
 
191
    
197
192
    >>> string_to_delta('7d')
198
193
    datetime.timedelta(7)
199
194
    >>> string_to_delta('60s')
207
202
    >>> string_to_delta('5m 30s')
208
203
    datetime.timedelta(0, 330)
209
204
    """
210
 
 
 
205
    
211
206
    try:
212
207
        return rfc3339_duration_to_delta(interval)
213
208
    except ValueError:
214
209
        pass
215
 
 
 
210
    
216
211
    value = datetime.timedelta(0)
217
212
    regexp = re.compile(r"(\d+)([dsmhw]?)")
218
 
 
 
213
    
219
214
    for num, suffix in regexp.findall(interval):
220
215
        if suffix == "d":
221
216
            value += datetime.timedelta(int(num))
240
235
                       "ApprovalDuration", "ExtendedTimeout"):
241
236
            return milliseconds_to_string(value)
242
237
        return str(value)
243
 
 
 
238
    
244
239
    # Create format string to print table rows
245
240
    format_string = " ".join("{{{key}:{width}}}".format(
246
 
        width=max(len(tablewords[key]),
247
 
                  max(len(valuetostring(client[key], key))
248
 
                      for client in clients)),
249
 
        key=key)
 
241
        width = max(len(tablewords[key]),
 
242
                    max(len(valuetostring(client[key], key))
 
243
                        for client in clients)),
 
244
        key = key)
250
245
                             for key in keywords)
251
246
    # Print header line
252
247
    print(format_string.format(**tablewords))
253
248
    for client in clients:
254
 
        print(format_string
255
 
              .format(**{key: valuetostring(client[key], key)
256
 
                         for key in keywords}))
 
249
        print(format_string.format(**{
 
250
            key: valuetostring(client[key], key)
 
251
            for key in keywords }))
257
252
 
258
253
 
259
254
def has_actions(options):
280
275
def main():
281
276
    parser = argparse.ArgumentParser()
282
277
    parser.add_argument("--version", action="version",
283
 
                        version="%(prog)s {}".format(version),
 
278
                        version = "%(prog)s {}".format(version),
284
279
                        help="show version number and exit")
285
280
    parser.add_argument("-a", "--all", action="store_true",
286
281
                        help="Select all clients")
332
327
                        help="Run self-test")
333
328
    parser.add_argument("client", nargs="*", help="Client name")
334
329
    options = parser.parse_args()
335
 
 
 
330
    
336
331
    if has_actions(options) and not (options.client or options.all):
337
332
        parser.error("Options require clients names or --all.")
338
333
    if options.verbose and has_actions(options):
339
334
        parser.error("--verbose can only be used alone.")
340
 
    if options.dump_json and (options.verbose
341
 
                              or has_actions(options)):
 
335
    if options.dump_json and (options.verbose or has_actions(options)):
342
336
        parser.error("--dump-json can only be used alone.")
343
337
    if options.all and not has_actions(options):
344
338
        parser.error("--all requires an action.")
345
 
 
 
339
    
346
340
    if options.check:
347
 
        import doctest
348
341
        fail_count, test_count = doctest.testmod()
349
342
        sys.exit(os.EX_OK if fail_count == 0 else 1)
350
 
 
 
343
    
351
344
    try:
352
345
        bus = dbus.SystemBus()
353
346
        mandos_dbus_objc = bus.get_object(busname, server_path)
354
347
    except dbus.exceptions.DBusException:
355
348
        print("Could not connect to Mandos server", file=sys.stderr)
356
349
        sys.exit(1)
357
 
 
 
350
    
358
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
359
 
                                 dbus_interface=server_interface)
 
352
                                 dbus_interface = server_interface)
360
353
    mandos_serv_object_manager = dbus.Interface(
361
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
362
 
 
363
 
    # block stderr since dbus library prints to stderr
 
354
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
355
    
 
356
    #block stderr since dbus library prints to stderr
364
357
    null = os.open(os.path.devnull, os.O_RDWR)
365
358
    stderrcopy = os.dup(sys.stderr.fileno())
366
359
    os.dup2(null, sys.stderr.fileno())
367
360
    os.close(null)
368
361
    try:
369
362
        try:
370
 
            mandos_clients = {path: ifs_and_props[client_interface]
371
 
                              for path, ifs_and_props in
372
 
                              mandos_serv_object_manager
373
 
                              .GetManagedObjects().items()
374
 
                              if client_interface in ifs_and_props}
 
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 }
375
368
        finally:
376
 
            # restore stderr
 
369
            #restore stderr
377
370
            os.dup2(stderrcopy, sys.stderr.fileno())
378
371
            os.close(stderrcopy)
379
372
    except dbus.exceptions.DBusException as e:
380
 
        print("Access denied: "
381
 
              "Accessing mandos server through D-Bus: {}".format(e),
382
 
              file=sys.stderr)
 
373
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
374
              .format(e), file=sys.stderr)
383
375
        sys.exit(1)
384
 
 
 
376
    
385
377
    # Compile dict of (clients: properties) to process
386
 
    clients = {}
387
 
 
 
378
    clients={}
 
379
    
388
380
    if options.all or not options.client:
389
 
        clients = {bus.get_object(busname, path): properties
390
 
                   for path, properties in mandos_clients.items()}
 
381
        clients = { bus.get_object(busname, path): properties
 
382
                    for path, properties in mandos_clients.items() }
391
383
    else:
392
384
        for name in options.client:
393
385
            for path, client in mandos_clients.items():
399
391
                print("Client not found on server: {!r}"
400
392
                      .format(name), file=sys.stderr)
401
393
                sys.exit(1)
402
 
 
 
394
    
403
395
    if not has_actions(options) and clients:
404
396
        if options.verbose or options.dump_json:
405
397
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
408
400
                        "ApprovalPending", "ApprovedByDefault",
409
401
                        "LastApprovalRequest", "ApprovalDelay",
410
402
                        "ApprovalDuration", "Checker",
411
 
                        "ExtendedTimeout", "Expires",
412
 
                        "LastCheckerStatus")
 
403
                        "ExtendedTimeout")
413
404
        else:
414
405
            keywords = defaultkeywords
415
 
 
 
406
        
416
407
        if options.dump_json:
417
 
            json.dump({client["Name"]: {key:
418
 
                                        bool(client[key])
419
 
                                        if isinstance(client[key],
420
 
                                                      dbus.Boolean)
421
 
                                        else client[key]
422
 
                                        for key in keywords}
423
 
                       for client in clients.values()},
424
 
                      fp=sys.stdout, indent=4,
425
 
                      separators=(',', ': '))
 
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 = (',', ': '))
426
413
            print()
427
414
        else:
428
415
            print_clients(clients.values(), keywords)
429
416
    else:
430
417
        # Process each client in the list by all selected options
431
418
        for client in clients:
432
 
 
 
419
            
433
420
            def set_client_prop(prop, value):
434
421
                """Set a Client D-Bus property"""
435
422
                client.Set(client_interface, prop, value,
436
423
                           dbus_interface=dbus.PROPERTIES_IFACE)
437
 
 
 
424
            
438
425
            def set_client_prop_ms(prop, value):
439
426
                """Set a Client D-Bus property, converted
440
427
                from a string to milliseconds."""
441
428
                set_client_prop(prop,
442
429
                                string_to_delta(value).total_seconds()
443
430
                                * 1000)
444
 
 
 
431
            
445
432
            if options.remove:
446
433
                mandos_serv.RemoveClient(client.__dbus_object_path__)
447
434
            if options.enable:
455
442
            if options.stop_checker:
456
443
                set_client_prop("CheckerRunning", dbus.Boolean(False))
457
444
            if options.is_enabled:
458
 
                if client.Get(client_interface, "Enabled",
459
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
460
 
                    sys.exit(0)
461
 
                else:
462
 
                    sys.exit(1)
 
445
                sys.exit(0 if client.Get(client_interface,
 
446
                                         "Enabled",
 
447
                                         dbus_interface=
 
448
                                         dbus.PROPERTIES_IFACE)
 
449
                         else 1)
463
450
            if options.checker is not None:
464
451
                set_client_prop("Checker", options.checker)
465
452
            if options.host is not None: