/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: 2019-02-28 18:48:33 UTC
  • Revision ID: teddy@recompile.se-20190228184833-nlg1xxlhnldso9ya
Make mandos-ctl use unittest instead of doctest module

* mandos-ctl: Before running main(), check if we should only run tests
              by seeing if the --check option was passed.
  (main): Don't look for the --check option.
  (should_only_run_tests): New.
  (load_tests): New.

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