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