/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 22:17:56 UTC
  • Revision ID: teddy@recompile.se-20190228221756-qd6ynzhzatmp2g6a
mandos-ctl: Add more tests

* mandos-ctl (string_to_delta): Add some basic 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",
75
89
server_path = "/"
76
90
server_interface = domain + ".Mandos"
77
91
client_interface = domain + ".Mandos.Client"
78
 
version = "1.7.10"
 
92
version = "1.8.3"
79
93
 
80
94
 
81
95
try:
83
97
except AttributeError:
84
98
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
99
 
 
100
 
86
101
def milliseconds_to_string(ms):
87
102
    td = datetime.timedelta(0, 0, 0, ms)
88
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
89
 
        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))
 
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))
93
108
 
94
109
 
95
110
def rfc3339_duration_to_delta(duration):
96
111
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
97
 
    
 
112
 
98
113
    >>> rfc3339_duration_to_delta("P7D")
99
114
    datetime.timedelta(7)
100
115
    >>> rfc3339_duration_to_delta("PT60S")
101
116
    datetime.timedelta(0, 60)
102
117
    >>> rfc3339_duration_to_delta("PT60M")
103
118
    datetime.timedelta(0, 3600)
 
119
    >>> rfc3339_duration_to_delta("P60M")
 
120
    datetime.timedelta(1680)
104
121
    >>> rfc3339_duration_to_delta("PT24H")
105
122
    datetime.timedelta(1)
106
123
    >>> rfc3339_duration_to_delta("P1W")
109
126
    datetime.timedelta(0, 330)
110
127
    >>> rfc3339_duration_to_delta("P1DT3M20S")
111
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'
112
158
    """
113
 
    
 
159
 
114
160
    # Parsing an RFC 3339 duration with regular expressions is not
115
161
    # possible - there would have to be multiple places for the same
116
162
    # values, like seconds.  The current code, while more esoteric, is
117
163
    # cleaner without depending on a parsing library.  If Python had a
118
164
    # built-in library for parsing we would use it, but we'd like to
119
165
    # avoid excessive use of external libraries.
120
 
    
 
166
 
121
167
    # New type for defining tokens, syntax, and semantics all-in-one
122
168
    Token = collections.namedtuple("Token", (
123
169
        "regexp",  # To match token; if "value" is not None, must have
156
202
                           frozenset((token_year, token_month,
157
203
                                      token_day, token_time,
158
204
                                      token_week)))
159
 
    # Define starting values
160
 
    value = datetime.timedelta() # Value so far
 
205
    # Define starting values:
 
206
    # Value so far
 
207
    value = datetime.timedelta()
161
208
    found_token = None
162
 
    followers = frozenset((token_duration, )) # Following valid tokens
163
 
    s = duration                # String left to parse
 
209
    # Following valid tokens
 
210
    followers = frozenset((token_duration, ))
 
211
    # String left to parse
 
212
    s = duration
164
213
    # Loop until end token is found
165
214
    while found_token is not token_end:
166
215
        # Search for any currently valid tokens
190
239
 
191
240
def string_to_delta(interval):
192
241
    """Parse a string and return a datetime.timedelta
193
 
    
194
 
    >>> string_to_delta('7d')
195
 
    datetime.timedelta(7)
196
 
    >>> string_to_delta('60s')
197
 
    datetime.timedelta(0, 60)
198
 
    >>> string_to_delta('60m')
199
 
    datetime.timedelta(0, 3600)
200
 
    >>> string_to_delta('24h')
201
 
    datetime.timedelta(1)
202
 
    >>> string_to_delta('1w')
203
 
    datetime.timedelta(7)
204
 
    >>> string_to_delta('5m 30s')
205
 
    datetime.timedelta(0, 330)
206
242
    """
207
 
    
 
243
 
208
244
    try:
209
245
        return rfc3339_duration_to_delta(interval)
210
 
    except ValueError:
211
 
        pass
212
 
    
 
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
 
213
275
    value = datetime.timedelta(0)
214
276
    regexp = re.compile(r"(\d+)([dsmhw]?)")
215
 
    
 
277
 
216
278
    for num, suffix in regexp.findall(interval):
217
279
        if suffix == "d":
218
280
            value += datetime.timedelta(int(num))
231
293
 
232
294
def print_clients(clients, keywords):
233
295
    def valuetostring(value, keyword):
234
 
        if type(value) is dbus.Boolean:
 
296
        if isinstance(value, dbus.Boolean):
235
297
            return "Yes" if value else "No"
236
298
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
237
299
                       "ApprovalDuration", "ExtendedTimeout"):
238
300
            return milliseconds_to_string(value)
239
301
        return str(value)
240
 
    
 
302
 
241
303
    # Create format string to print table rows
242
304
    format_string = " ".join("{{{key}:{width}}}".format(
243
 
        width = max(len(tablewords[key]),
244
 
                    max(len(valuetostring(client[key], key))
245
 
                        for client in clients)),
246
 
        key = key)
 
305
        width=max(len(tablewords[key]),
 
306
                  max(len(valuetostring(client[key], key))
 
307
                      for client in clients)),
 
308
        key=key)
247
309
                             for key in keywords)
248
310
    # Print header line
249
311
    print(format_string.format(**tablewords))
250
312
    for client in clients:
251
 
        print(format_string.format(**{
252
 
            key: valuetostring(client[key], key)
253
 
            for key in keywords }))
 
313
        print(format_string
 
314
              .format(**{key: valuetostring(client[key], key)
 
315
                         for key in keywords}))
254
316
 
255
317
 
256
318
def has_actions(options):
277
339
def main():
278
340
    parser = argparse.ArgumentParser()
279
341
    parser.add_argument("--version", action="version",
280
 
                        version = "%(prog)s {}".format(version),
 
342
                        version="%(prog)s {}".format(version),
281
343
                        help="show version number and exit")
282
344
    parser.add_argument("-a", "--all", action="store_true",
283
345
                        help="Select all clients")
329
391
                        help="Run self-test")
330
392
    parser.add_argument("client", nargs="*", help="Client name")
331
393
    options = parser.parse_args()
332
 
    
 
394
 
333
395
    if has_actions(options) and not (options.client or options.all):
334
396
        parser.error("Options require clients names or --all.")
335
397
    if options.verbose and has_actions(options):
336
398
        parser.error("--verbose can only be used alone.")
337
 
    if options.dump_json and (options.verbose or has_actions(options)):
 
399
    if options.dump_json and (options.verbose
 
400
                              or has_actions(options)):
338
401
        parser.error("--dump-json can only be used alone.")
339
402
    if options.all and not has_actions(options):
340
403
        parser.error("--all requires an action.")
341
 
    
342
 
    if options.check:
343
 
        fail_count, test_count = doctest.testmod()
344
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
345
 
    
 
404
 
346
405
    try:
347
406
        bus = dbus.SystemBus()
348
407
        mandos_dbus_objc = bus.get_object(busname, server_path)
349
408
    except dbus.exceptions.DBusException:
350
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
409
        log.critical("Could not connect to Mandos server")
351
410
        sys.exit(1)
352
 
    
 
411
 
353
412
    mandos_serv = dbus.Interface(mandos_dbus_objc,
354
 
                                 dbus_interface = server_interface)
 
413
                                 dbus_interface=server_interface)
355
414
    mandos_serv_object_manager = dbus.Interface(
356
 
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
357
 
    
358
 
    #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
359
418
    null = os.open(os.path.devnull, os.O_RDWR)
360
419
    stderrcopy = os.dup(sys.stderr.fileno())
361
420
    os.dup2(null, sys.stderr.fileno())
362
421
    os.close(null)
363
422
    try:
364
423
        try:
365
 
            mandos_clients = { path: ifs_and_props[client_interface]
366
 
                               for path, ifs_and_props in
367
 
                               mandos_serv_object_manager
368
 
                               .GetManagedObjects().items()
369
 
                               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}
370
429
        finally:
371
 
            #restore stderr
 
430
            # restore stderr
372
431
            os.dup2(stderrcopy, sys.stderr.fileno())
373
432
            os.close(stderrcopy)
374
433
    except dbus.exceptions.DBusException as e:
375
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
376
 
              .format(e), file=sys.stderr)
 
434
        log.critical("Failed to access Mandos server through D-Bus:"
 
435
                     "\n%s", e)
377
436
        sys.exit(1)
378
 
    
 
437
 
379
438
    # Compile dict of (clients: properties) to process
380
 
    clients={}
381
 
    
 
439
    clients = {}
 
440
 
382
441
    if options.all or not options.client:
383
 
        clients = { bus.get_object(busname, path): properties
384
 
                    for path, properties in mandos_clients.items() }
 
442
        clients = {bus.get_object(busname, path): properties
 
443
                   for path, properties in mandos_clients.items()}
385
444
    else:
386
445
        for name in options.client:
387
446
            for path, client in mandos_clients.items():
390
449
                    clients[client_objc] = client
391
450
                    break
392
451
            else:
393
 
                print("Client not found on server: {!r}"
394
 
                      .format(name), file=sys.stderr)
 
452
                log.critical("Client not found on server: %r", name)
395
453
                sys.exit(1)
396
 
    
 
454
 
397
455
    if not has_actions(options) and clients:
398
456
        if options.verbose or options.dump_json:
399
457
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
400
 
                        "Created", "Interval", "Host", "Fingerprint",
401
 
                        "CheckerRunning", "LastEnabled",
402
 
                        "ApprovalPending", "ApprovedByDefault",
403
 
                        "LastApprovalRequest", "ApprovalDelay",
404
 
                        "ApprovalDuration", "Checker",
405
 
                        "ExtendedTimeout", "Expires",
 
458
                        "Created", "Interval", "Host", "KeyID",
 
459
                        "Fingerprint", "CheckerRunning",
 
460
                        "LastEnabled", "ApprovalPending",
 
461
                        "ApprovedByDefault", "LastApprovalRequest",
 
462
                        "ApprovalDelay", "ApprovalDuration",
 
463
                        "Checker", "ExtendedTimeout", "Expires",
406
464
                        "LastCheckerStatus")
407
465
        else:
408
466
            keywords = defaultkeywords
409
 
        
 
467
 
410
468
        if options.dump_json:
411
469
            json.dump({client["Name"]: {key:
412
470
                                        bool(client[key])
413
471
                                        if isinstance(client[key],
414
472
                                                      dbus.Boolean)
415
473
                                        else client[key]
416
 
                                        for key in keywords }
417
 
                       for client in clients.values() },
418
 
                      fp = sys.stdout, indent = 4,
419
 
                      separators = (',', ': '))
 
474
                                        for key in keywords}
 
475
                       for client in clients.values()},
 
476
                      fp=sys.stdout, indent=4,
 
477
                      separators=(',', ': '))
420
478
            print()
421
479
        else:
422
480
            print_clients(clients.values(), keywords)
423
481
    else:
424
482
        # Process each client in the list by all selected options
425
483
        for client in clients:
426
 
            
 
484
 
427
485
            def set_client_prop(prop, value):
428
486
                """Set a Client D-Bus property"""
429
487
                client.Set(client_interface, prop, value,
430
488
                           dbus_interface=dbus.PROPERTIES_IFACE)
431
 
            
 
489
 
432
490
            def set_client_prop_ms(prop, value):
433
491
                """Set a Client D-Bus property, converted
434
492
                from a string to milliseconds."""
435
493
                set_client_prop(prop,
436
494
                                string_to_delta(value).total_seconds()
437
495
                                * 1000)
438
 
            
 
496
 
439
497
            if options.remove:
440
498
                mandos_serv.RemoveClient(client.__dbus_object_path__)
441
499
            if options.enable:
449
507
            if options.stop_checker:
450
508
                set_client_prop("CheckerRunning", dbus.Boolean(False))
451
509
            if options.is_enabled:
452
 
                sys.exit(0 if client.Get(client_interface,
453
 
                                         "Enabled",
454
 
                                         dbus_interface=
455
 
                                         dbus.PROPERTIES_IFACE)
456
 
                         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)
457
515
            if options.checker is not None:
458
516
                set_client_prop("Checker", options.checker)
459
517
            if options.host is not None:
485
543
                client.Approve(dbus.Boolean(False),
486
544
                               dbus_interface=client_interface)
487
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
class Test_string_to_delta(unittest.TestCase):
 
561
    def test_handles_basic_rfc3339(self):
 
562
        self.assertEqual(string_to_delta("PT2H"),
 
563
                         datetime.timedelta(0, 7200))
 
564
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
565
        # assertLogs only exists in Python 3.4
 
566
        if hasattr(self, "assertLogs"):
 
567
            with self.assertLogs(log, logging.WARNING):
 
568
                value = string_to_delta("2h")
 
569
        else:
 
570
            value = string_to_delta("2h")
 
571
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
572
 
 
573
 
 
574
def should_only_run_tests():
 
575
    parser = argparse.ArgumentParser(add_help=False)
 
576
    parser.add_argument("--check", action='store_true')
 
577
    args, unknown_args = parser.parse_known_args()
 
578
    run_tests = args.check
 
579
    if run_tests:
 
580
        # Remove --check argument from sys.argv
 
581
        sys.argv[1:] = unknown_args
 
582
    return run_tests
 
583
 
 
584
# Add all tests from doctest strings
 
585
def load_tests(loader, tests, none):
 
586
    import doctest
 
587
    tests.addTests(doctest.DocTestSuite())
 
588
    return tests
488
589
 
489
590
if __name__ == "__main__":
490
 
    main()
 
591
    if should_only_run_tests():
 
592
        # Call using ./tdd-python-script --check [--verbose]
 
593
        unittest.main()
 
594
    else:
 
595
        main()