/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: 2019-02-28 21:45:13 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190228214513-58glsld2x80fq684
mandos-ctl: Refactor and add more tests

* mandos-ctl (string_to_delta): Factor out old-style parsing to its
                                own function.  Log a warning if
                                old-style parsing is invoked.
  (parse_pre_1_6_1_interval): New; factored out of string_to_delta.
                              Also added more tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
3
 
 
2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
 
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
 
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
42
import json
 
43
import unittest
 
44
import logging
43
45
 
44
46
import dbus
45
47
 
 
48
# Show warnings by default
 
49
if not sys.warnoptions:
 
50
    import warnings
 
51
    warnings.simplefilter("default")
 
52
 
 
53
log = logging.getLogger(sys.argv[0])
 
54
logging.basicConfig(level="INFO", # Show info level messages
 
55
                    format="%(message)s") # Show basic log messages
 
56
 
 
57
logging.captureWarnings(True)   # Show warnings via the logging system
 
58
 
46
59
if sys.version_info.major == 2:
47
60
    str = unicode
48
61
 
58
71
    "Interval": "Interval",
59
72
    "Host": "Host",
60
73
    "Fingerprint": "Fingerprint",
 
74
    "KeyID": "Key ID",
61
75
    "CheckerRunning": "Check Is Running",
62
76
    "LastEnabled": "Last Enabled",
63
77
    "ApprovalPending": "Approval Is Pending",
65
79
    "ApprovalDelay": "Approval Delay",
66
80
    "ApprovalDuration": "Approval Duration",
67
81
    "Checker": "Checker",
68
 
    "ExtendedTimeout": "Extended Timeout"
 
82
    "ExtendedTimeout": "Extended Timeout",
 
83
    "Expires": "Expires",
 
84
    "LastCheckerStatus": "Last Checker Status",
69
85
}
70
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
71
87
domain = "se.recompile"
73
89
server_path = "/"
74
90
server_interface = domain + ".Mandos"
75
91
client_interface = domain + ".Mandos.Client"
76
 
version = "1.7.10"
 
92
version = "1.8.3"
77
93
 
78
94
 
79
95
try:
81
97
except AttributeError:
82
98
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
83
99
 
 
100
 
84
101
def milliseconds_to_string(ms):
85
102
    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))
 
103
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
104
            .format(days="{}T".format(td.days) if td.days else "",
 
105
                    hours=td.seconds // 3600,
 
106
                    minutes=(td.seconds % 3600) // 60,
 
107
                    seconds=td.seconds % 60))
91
108
 
92
109
 
93
110
def rfc3339_duration_to_delta(duration):
94
111
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
95
 
    
 
112
 
96
113
    >>> rfc3339_duration_to_delta("P7D")
97
114
    datetime.timedelta(7)
98
115
    >>> rfc3339_duration_to_delta("PT60S")
99
116
    datetime.timedelta(0, 60)
100
117
    >>> rfc3339_duration_to_delta("PT60M")
101
118
    datetime.timedelta(0, 3600)
 
119
    >>> rfc3339_duration_to_delta("P60M")
 
120
    datetime.timedelta(1680)
102
121
    >>> rfc3339_duration_to_delta("PT24H")
103
122
    datetime.timedelta(1)
104
123
    >>> rfc3339_duration_to_delta("P1W")
107
126
    datetime.timedelta(0, 330)
108
127
    >>> rfc3339_duration_to_delta("P1DT3M20S")
109
128
    datetime.timedelta(1, 200)
 
129
    >>> # Can not be empty:
 
130
    >>> rfc3339_duration_to_delta("")
 
131
    Traceback (most recent call last):
 
132
    ...
 
133
    ValueError: Invalid RFC 3339 duration: u''
 
134
    >>> # Must start with "P":
 
135
    >>> rfc3339_duration_to_delta("1D")
 
136
    Traceback (most recent call last):
 
137
    ...
 
138
    ValueError: Invalid RFC 3339 duration: u'1D'
 
139
    >>> # Must use correct order
 
140
    >>> rfc3339_duration_to_delta("PT1S2M")
 
141
    Traceback (most recent call last):
 
142
    ...
 
143
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
 
144
    >>> # Time needs time marker
 
145
    >>> rfc3339_duration_to_delta("P1H2S")
 
146
    Traceback (most recent call last):
 
147
    ...
 
148
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
 
149
    >>> # Weeks can not be combined with anything else
 
150
    >>> rfc3339_duration_to_delta("P1D2W")
 
151
    Traceback (most recent call last):
 
152
    ...
 
153
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
 
154
    >>> rfc3339_duration_to_delta("P2W2H")
 
155
    Traceback (most recent call last):
 
156
    ...
 
157
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
110
158
    """
111
 
    
 
159
 
112
160
    # Parsing an RFC 3339 duration with regular expressions is not
113
161
    # possible - there would have to be multiple places for the same
114
162
    # values, like seconds.  The current code, while more esoteric, is
115
163
    # cleaner without depending on a parsing library.  If Python had a
116
164
    # built-in library for parsing we would use it, but we'd like to
117
165
    # avoid excessive use of external libraries.
118
 
    
 
166
 
119
167
    # New type for defining tokens, syntax, and semantics all-in-one
120
168
    Token = collections.namedtuple("Token", (
121
169
        "regexp",  # To match token; if "value" is not None, must have
154
202
                           frozenset((token_year, token_month,
155
203
                                      token_day, token_time,
156
204
                                      token_week)))
157
 
    # Define starting values
158
 
    value = datetime.timedelta() # Value so far
 
205
    # Define starting values:
 
206
    # Value so far
 
207
    value = datetime.timedelta()
159
208
    found_token = None
160
 
    followers = frozenset((token_duration, )) # Following valid tokens
161
 
    s = duration                # String left to parse
 
209
    # Following valid tokens
 
210
    followers = frozenset((token_duration, ))
 
211
    # String left to parse
 
212
    s = duration
162
213
    # Loop until end token is found
163
214
    while found_token is not token_end:
164
215
        # Search for any currently valid tokens
188
239
 
189
240
def string_to_delta(interval):
190
241
    """Parse a string and return a datetime.timedelta
191
 
    
192
 
    >>> string_to_delta('7d')
193
 
    datetime.timedelta(7)
194
 
    >>> string_to_delta('60s')
195
 
    datetime.timedelta(0, 60)
196
 
    >>> string_to_delta('60m')
197
 
    datetime.timedelta(0, 3600)
198
 
    >>> string_to_delta('24h')
199
 
    datetime.timedelta(1)
200
 
    >>> string_to_delta('1w')
201
 
    datetime.timedelta(7)
202
 
    >>> string_to_delta('5m 30s')
203
 
    datetime.timedelta(0, 330)
204
242
    """
205
 
    
 
243
 
206
244
    try:
207
245
        return rfc3339_duration_to_delta(interval)
208
 
    except ValueError:
209
 
        pass
210
 
    
 
246
    except ValueError as e:
 
247
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
248
                    ' '.join(e.args))
 
249
    return parse_pre_1_6_1_interval(interval)
 
250
 
 
251
 
 
252
def parse_pre_1_6_1_interval(interval):
 
253
    """Parse an interval string as documented by Mandos before 1.6.1, and
 
254
    return a datetime.timedelta
 
255
    >>> parse_pre_1_6_1_interval('7d')
 
256
    datetime.timedelta(7)
 
257
    >>> parse_pre_1_6_1_interval('60s')
 
258
    datetime.timedelta(0, 60)
 
259
    >>> parse_pre_1_6_1_interval('60m')
 
260
    datetime.timedelta(0, 3600)
 
261
    >>> parse_pre_1_6_1_interval('24h')
 
262
    datetime.timedelta(1)
 
263
    >>> parse_pre_1_6_1_interval('1w')
 
264
    datetime.timedelta(7)
 
265
    >>> parse_pre_1_6_1_interval('5m 30s')
 
266
    datetime.timedelta(0, 330)
 
267
    >>> parse_pre_1_6_1_interval('')
 
268
    datetime.timedelta(0)
 
269
    >>> # Ignore unknown characters, allow any order and repetitions
 
270
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
 
271
    datetime.timedelta(2, 480, 18000)
 
272
 
 
273
    """
 
274
 
211
275
    value = datetime.timedelta(0)
212
276
    regexp = re.compile(r"(\d+)([dsmhw]?)")
213
 
    
 
277
 
214
278
    for num, suffix in regexp.findall(interval):
215
279
        if suffix == "d":
216
280
            value += datetime.timedelta(int(num))
229
293
 
230
294
def print_clients(clients, keywords):
231
295
    def valuetostring(value, keyword):
232
 
        if type(value) is dbus.Boolean:
 
296
        if isinstance(value, dbus.Boolean):
233
297
            return "Yes" if value else "No"
234
298
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
235
299
                       "ApprovalDuration", "ExtendedTimeout"):
236
300
            return milliseconds_to_string(value)
237
301
        return str(value)
238
 
    
 
302
 
239
303
    # Create format string to print table rows
240
304
    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)
 
305
        width=max(len(tablewords[key]),
 
306
                  max(len(valuetostring(client[key], key))
 
307
                      for client in clients)),
 
308
        key=key)
245
309
                             for key in keywords)
246
310
    # Print header line
247
311
    print(format_string.format(**tablewords))
248
312
    for client in clients:
249
 
        print(format_string.format(**{
250
 
            key: valuetostring(client[key], key)
251
 
            for key in keywords }))
 
313
        print(format_string
 
314
              .format(**{key: valuetostring(client[key], key)
 
315
                         for key in keywords}))
252
316
 
253
317
 
254
318
def has_actions(options):
275
339
def main():
276
340
    parser = argparse.ArgumentParser()
277
341
    parser.add_argument("--version", action="version",
278
 
                        version = "%(prog)s {}".format(version),
 
342
                        version="%(prog)s {}".format(version),
279
343
                        help="show version number and exit")
280
344
    parser.add_argument("-a", "--all", action="store_true",
281
345
                        help="Select all clients")
327
391
                        help="Run self-test")
328
392
    parser.add_argument("client", nargs="*", help="Client name")
329
393
    options = parser.parse_args()
330
 
    
 
394
 
331
395
    if has_actions(options) and not (options.client or options.all):
332
396
        parser.error("Options require clients names or --all.")
333
397
    if options.verbose and has_actions(options):
334
398
        parser.error("--verbose can only be used alone.")
335
 
    if options.dump_json and (options.verbose or has_actions(options)):
 
399
    if options.dump_json and (options.verbose
 
400
                              or has_actions(options)):
336
401
        parser.error("--dump-json can only be used alone.")
337
402
    if options.all and not has_actions(options):
338
403
        parser.error("--all requires an action.")
339
 
    
340
 
    if options.check:
341
 
        fail_count, test_count = doctest.testmod()
342
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
343
 
    
 
404
 
344
405
    try:
345
406
        bus = dbus.SystemBus()
346
407
        mandos_dbus_objc = bus.get_object(busname, server_path)
347
408
    except dbus.exceptions.DBusException:
348
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
409
        log.critical("Could not connect to Mandos server")
349
410
        sys.exit(1)
350
 
    
 
411
 
351
412
    mandos_serv = dbus.Interface(mandos_dbus_objc,
352
 
                                 dbus_interface = server_interface)
 
413
                                 dbus_interface=server_interface)
353
414
    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
 
415
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
416
 
 
417
    # block stderr since dbus library prints to stderr
357
418
    null = os.open(os.path.devnull, os.O_RDWR)
358
419
    stderrcopy = os.dup(sys.stderr.fileno())
359
420
    os.dup2(null, sys.stderr.fileno())
360
421
    os.close(null)
361
422
    try:
362
423
        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 }
 
424
            mandos_clients = {path: ifs_and_props[client_interface]
 
425
                              for path, ifs_and_props in
 
426
                              mandos_serv_object_manager
 
427
                              .GetManagedObjects().items()
 
428
                              if client_interface in ifs_and_props}
368
429
        finally:
369
 
            #restore stderr
 
430
            # restore stderr
370
431
            os.dup2(stderrcopy, sys.stderr.fileno())
371
432
            os.close(stderrcopy)
372
433
    except dbus.exceptions.DBusException as e:
373
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
374
 
              .format(e), file=sys.stderr)
 
434
        log.critical("Failed to access Mandos server through D-Bus:"
 
435
                     "\n%s", e)
375
436
        sys.exit(1)
376
 
    
 
437
 
377
438
    # Compile dict of (clients: properties) to process
378
 
    clients={}
379
 
    
 
439
    clients = {}
 
440
 
380
441
    if options.all or not options.client:
381
 
        clients = { bus.get_object(busname, path): properties
382
 
                    for path, properties in mandos_clients.items() }
 
442
        clients = {bus.get_object(busname, path): properties
 
443
                   for path, properties in mandos_clients.items()}
383
444
    else:
384
445
        for name in options.client:
385
446
            for path, client in mandos_clients.items():
388
449
                    clients[client_objc] = client
389
450
                    break
390
451
            else:
391
 
                print("Client not found on server: {!r}"
392
 
                      .format(name), file=sys.stderr)
 
452
                log.critical("Client not found on server: %r", name)
393
453
                sys.exit(1)
394
 
    
 
454
 
395
455
    if not has_actions(options) and clients:
396
456
        if options.verbose or options.dump_json:
397
457
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
398
 
                        "Created", "Interval", "Host", "Fingerprint",
399
 
                        "CheckerRunning", "LastEnabled",
400
 
                        "ApprovalPending", "ApprovedByDefault",
401
 
                        "LastApprovalRequest", "ApprovalDelay",
402
 
                        "ApprovalDuration", "Checker",
403
 
                        "ExtendedTimeout")
 
458
                        "Created", "Interval", "Host", "KeyID",
 
459
                        "Fingerprint", "CheckerRunning",
 
460
                        "LastEnabled", "ApprovalPending",
 
461
                        "ApprovedByDefault", "LastApprovalRequest",
 
462
                        "ApprovalDelay", "ApprovalDuration",
 
463
                        "Checker", "ExtendedTimeout", "Expires",
 
464
                        "LastCheckerStatus")
404
465
        else:
405
466
            keywords = defaultkeywords
406
 
        
 
467
 
407
468
        if options.dump_json:
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 = (',', ': '))
 
469
            json.dump({client["Name"]: {key:
 
470
                                        bool(client[key])
 
471
                                        if isinstance(client[key],
 
472
                                                      dbus.Boolean)
 
473
                                        else client[key]
 
474
                                        for key in keywords}
 
475
                       for client in clients.values()},
 
476
                      fp=sys.stdout, indent=4,
 
477
                      separators=(',', ': '))
413
478
            print()
414
479
        else:
415
480
            print_clients(clients.values(), keywords)
416
481
    else:
417
482
        # Process each client in the list by all selected options
418
483
        for client in clients:
419
 
            
 
484
 
420
485
            def set_client_prop(prop, value):
421
486
                """Set a Client D-Bus property"""
422
487
                client.Set(client_interface, prop, value,
423
488
                           dbus_interface=dbus.PROPERTIES_IFACE)
424
 
            
 
489
 
425
490
            def set_client_prop_ms(prop, value):
426
491
                """Set a Client D-Bus property, converted
427
492
                from a string to milliseconds."""
428
493
                set_client_prop(prop,
429
494
                                string_to_delta(value).total_seconds()
430
495
                                * 1000)
431
 
            
 
496
 
432
497
            if options.remove:
433
498
                mandos_serv.RemoveClient(client.__dbus_object_path__)
434
499
            if options.enable:
442
507
            if options.stop_checker:
443
508
                set_client_prop("CheckerRunning", dbus.Boolean(False))
444
509
            if options.is_enabled:
445
 
                sys.exit(0 if client.Get(client_interface,
446
 
                                         "Enabled",
447
 
                                         dbus_interface=
448
 
                                         dbus.PROPERTIES_IFACE)
449
 
                         else 1)
 
510
                if client.Get(client_interface, "Enabled",
 
511
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
512
                    sys.exit(0)
 
513
                else:
 
514
                    sys.exit(1)
450
515
            if options.checker is not None:
451
516
                set_client_prop("Checker", options.checker)
452
517
            if options.host is not None:
478
543
                client.Approve(dbus.Boolean(False),
479
544
                               dbus_interface=client_interface)
480
545
 
 
546
 
 
547
class Test_milliseconds_to_string(unittest.TestCase):
 
548
    def test_all(self):
 
549
        self.assertEqual(milliseconds_to_string(93785000),
 
550
                         "1T02:03:05")
 
551
    def test_no_days(self):
 
552
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
553
    def test_all_zero(self):
 
554
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
555
    def test_no_fractional_seconds(self):
 
556
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
557
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
558
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
559
 
 
560
 
 
561
def should_only_run_tests():
 
562
    parser = argparse.ArgumentParser(add_help=False)
 
563
    parser.add_argument("--check", action='store_true')
 
564
    args, unknown_args = parser.parse_known_args()
 
565
    run_tests = args.check
 
566
    if run_tests:
 
567
        # Remove --check argument from sys.argv
 
568
        sys.argv[1:] = unknown_args
 
569
    return run_tests
 
570
 
 
571
# Add all tests from doctest strings
 
572
def load_tests(loader, tests, none):
 
573
    import doctest
 
574
    tests.addTests(doctest.DocTestSuite())
 
575
    return tests
481
576
 
482
577
if __name__ == "__main__":
483
 
    main()
 
578
    if should_only_run_tests():
 
579
        # Call using ./tdd-python-script --check [--verbose]
 
580
        unittest.main()
 
581
    else:
 
582
        main()