/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: 2017-08-20 13:50:57 UTC
  • Revision ID: teddy@recompile.se-20170820135057-u069yh7hhk2ha1a2
Don't import doctest module in mandos-ctl unless running tests.

* mandos-ctl: Don't import doctest module unless running tests.

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