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