/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

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