/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 21:45:13 UTC
  • 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:
mandos-ctl
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
import json
 
43
import unittest
 
44
import logging
42
45
 
43
46
import dbus
44
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
 
45
59
if sys.version_info.major == 2:
46
60
    str = unicode
47
61
 
57
71
    "Interval": "Interval",
58
72
    "Host": "Host",
59
73
    "Fingerprint": "Fingerprint",
 
74
    "KeyID": "Key ID",
60
75
    "CheckerRunning": "Check Is Running",
61
76
    "LastEnabled": "Last Enabled",
62
77
    "ApprovalPending": "Approval Is Pending",
64
79
    "ApprovalDelay": "Approval Delay",
65
80
    "ApprovalDuration": "Approval Duration",
66
81
    "Checker": "Checker",
67
 
    "ExtendedTimeout": "Extended Timeout"
 
82
    "ExtendedTimeout": "Extended Timeout",
 
83
    "Expires": "Expires",
 
84
    "LastCheckerStatus": "Last Checker Status",
68
85
}
69
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
87
domain = "se.recompile"
72
89
server_path = "/"
73
90
server_interface = domain + ".Mandos"
74
91
client_interface = domain + ".Mandos.Client"
75
 
version = "1.7.6"
 
92
version = "1.8.3"
76
93
 
77
94
 
78
95
try:
80
97
except AttributeError:
81
98
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
82
99
 
 
100
 
83
101
def milliseconds_to_string(ms):
84
102
    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))
 
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))
90
108
 
91
109
 
92
110
def rfc3339_duration_to_delta(duration):
93
111
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
94
 
    
 
112
 
95
113
    >>> rfc3339_duration_to_delta("P7D")
96
114
    datetime.timedelta(7)
97
115
    >>> rfc3339_duration_to_delta("PT60S")
98
116
    datetime.timedelta(0, 60)
99
117
    >>> rfc3339_duration_to_delta("PT60M")
100
118
    datetime.timedelta(0, 3600)
 
119
    >>> rfc3339_duration_to_delta("P60M")
 
120
    datetime.timedelta(1680)
101
121
    >>> rfc3339_duration_to_delta("PT24H")
102
122
    datetime.timedelta(1)
103
123
    >>> rfc3339_duration_to_delta("P1W")
106
126
    datetime.timedelta(0, 330)
107
127
    >>> rfc3339_duration_to_delta("P1DT3M20S")
108
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'
109
158
    """
110
 
    
 
159
 
111
160
    # Parsing an RFC 3339 duration with regular expressions is not
112
161
    # possible - there would have to be multiple places for the same
113
162
    # values, like seconds.  The current code, while more esoteric, is
114
163
    # cleaner without depending on a parsing library.  If Python had a
115
164
    # built-in library for parsing we would use it, but we'd like to
116
165
    # avoid excessive use of external libraries.
117
 
    
 
166
 
118
167
    # New type for defining tokens, syntax, and semantics all-in-one
119
168
    Token = collections.namedtuple("Token", (
120
169
        "regexp",  # To match token; if "value" is not None, must have
153
202
                           frozenset((token_year, token_month,
154
203
                                      token_day, token_time,
155
204
                                      token_week)))
156
 
    # Define starting values
157
 
    value = datetime.timedelta() # Value so far
 
205
    # Define starting values:
 
206
    # Value so far
 
207
    value = datetime.timedelta()
158
208
    found_token = None
159
 
    followers = frozenset((token_duration, )) # Following valid tokens
160
 
    s = duration                # String left to parse
 
209
    # Following valid tokens
 
210
    followers = frozenset((token_duration, ))
 
211
    # String left to parse
 
212
    s = duration
161
213
    # Loop until end token is found
162
214
    while found_token is not token_end:
163
215
        # Search for any currently valid tokens
187
239
 
188
240
def string_to_delta(interval):
189
241
    """Parse a string and return a datetime.timedelta
190
 
    
191
 
    >>> string_to_delta('7d')
192
 
    datetime.timedelta(7)
193
 
    >>> string_to_delta('60s')
194
 
    datetime.timedelta(0, 60)
195
 
    >>> string_to_delta('60m')
196
 
    datetime.timedelta(0, 3600)
197
 
    >>> string_to_delta('24h')
198
 
    datetime.timedelta(1)
199
 
    >>> string_to_delta('1w')
200
 
    datetime.timedelta(7)
201
 
    >>> string_to_delta('5m 30s')
202
 
    datetime.timedelta(0, 330)
203
242
    """
204
 
    
 
243
 
205
244
    try:
206
245
        return rfc3339_duration_to_delta(interval)
207
 
    except ValueError:
208
 
        pass
209
 
    
 
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
 
210
275
    value = datetime.timedelta(0)
211
276
    regexp = re.compile(r"(\d+)([dsmhw]?)")
212
 
    
 
277
 
213
278
    for num, suffix in regexp.findall(interval):
214
279
        if suffix == "d":
215
280
            value += datetime.timedelta(int(num))
228
293
 
229
294
def print_clients(clients, keywords):
230
295
    def valuetostring(value, keyword):
231
 
        if type(value) is dbus.Boolean:
 
296
        if isinstance(value, dbus.Boolean):
232
297
            return "Yes" if value else "No"
233
298
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
234
299
                       "ApprovalDuration", "ExtendedTimeout"):
235
300
            return milliseconds_to_string(value)
236
301
        return str(value)
237
 
    
 
302
 
238
303
    # Create format string to print table rows
239
304
    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)
 
305
        width=max(len(tablewords[key]),
 
306
                  max(len(valuetostring(client[key], key))
 
307
                      for client in clients)),
 
308
        key=key)
244
309
                             for key in keywords)
245
310
    # Print header line
246
311
    print(format_string.format(**tablewords))
247
312
    for client in clients:
248
 
        print(format_string.format(**{
249
 
            key: valuetostring(client[key], key)
250
 
            for key in keywords }))
 
313
        print(format_string
 
314
              .format(**{key: valuetostring(client[key], key)
 
315
                         for key in keywords}))
251
316
 
252
317
 
253
318
def has_actions(options):
274
339
def main():
275
340
    parser = argparse.ArgumentParser()
276
341
    parser.add_argument("--version", action="version",
277
 
                        version = "%(prog)s {}".format(version),
 
342
                        version="%(prog)s {}".format(version),
278
343
                        help="show version number and exit")
279
344
    parser.add_argument("-a", "--all", action="store_true",
280
345
                        help="Select all clients")
281
346
    parser.add_argument("-v", "--verbose", action="store_true",
282
347
                        help="Print all fields")
 
348
    parser.add_argument("-j", "--dump-json", action="store_true",
 
349
                        help="Dump client data in JSON format")
283
350
    parser.add_argument("-e", "--enable", action="store_true",
284
351
                        help="Enable client")
285
352
    parser.add_argument("-d", "--disable", action="store_true",
324
391
                        help="Run self-test")
325
392
    parser.add_argument("client", nargs="*", help="Client name")
326
393
    options = parser.parse_args()
327
 
    
 
394
 
328
395
    if has_actions(options) and not (options.client or options.all):
329
396
        parser.error("Options require clients names or --all.")
330
397
    if options.verbose and has_actions(options):
331
 
        parser.error("--verbose can only be used alone or with"
332
 
                     " --all.")
 
398
        parser.error("--verbose can only be used alone.")
 
399
    if options.dump_json and (options.verbose
 
400
                              or has_actions(options)):
 
401
        parser.error("--dump-json can only be used alone.")
333
402
    if options.all and not has_actions(options):
334
403
        parser.error("--all requires an action.")
335
404
 
336
 
    if options.check:
337
 
        fail_count, test_count = doctest.testmod()
338
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
339
 
    
340
405
    try:
341
406
        bus = dbus.SystemBus()
342
407
        mandos_dbus_objc = bus.get_object(busname, server_path)
343
408
    except dbus.exceptions.DBusException:
344
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
409
        log.critical("Could not connect to Mandos server")
345
410
        sys.exit(1)
346
 
    
 
411
 
347
412
    mandos_serv = dbus.Interface(mandos_dbus_objc,
348
 
                                 dbus_interface = server_interface)
 
413
                                 dbus_interface=server_interface)
349
414
    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
 
415
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
416
 
 
417
    # block stderr since dbus library prints to stderr
353
418
    null = os.open(os.path.devnull, os.O_RDWR)
354
419
    stderrcopy = os.dup(sys.stderr.fileno())
355
420
    os.dup2(null, sys.stderr.fileno())
356
421
    os.close(null)
357
422
    try:
358
423
        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 }
 
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}
364
429
        finally:
365
 
            #restore stderr
 
430
            # restore stderr
366
431
            os.dup2(stderrcopy, sys.stderr.fileno())
367
432
            os.close(stderrcopy)
368
433
    except dbus.exceptions.DBusException as e:
369
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
370
 
              .format(e), file=sys.stderr)
 
434
        log.critical("Failed to access Mandos server through D-Bus:"
 
435
                     "\n%s", e)
371
436
        sys.exit(1)
372
 
    
 
437
 
373
438
    # Compile dict of (clients: properties) to process
374
 
    clients={}
375
 
    
 
439
    clients = {}
 
440
 
376
441
    if options.all or not options.client:
377
 
        clients = { bus.get_object(busname, path): properties
378
 
                    for path, properties in mandos_clients.items() }
 
442
        clients = {bus.get_object(busname, path): properties
 
443
                   for path, properties in mandos_clients.items()}
379
444
    else:
380
445
        for name in options.client:
381
446
            for path, client in mandos_clients.items():
384
449
                    clients[client_objc] = client
385
450
                    break
386
451
            else:
387
 
                print("Client not found on server: {!r}"
388
 
                      .format(name), file=sys.stderr)
 
452
                log.critical("Client not found on server: %r", name)
389
453
                sys.exit(1)
390
 
    
 
454
 
391
455
    if not has_actions(options) and clients:
392
 
        if options.verbose:
 
456
        if options.verbose or options.dump_json:
393
457
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
 
                        "Created", "Interval", "Host", "Fingerprint",
395
 
                        "CheckerRunning", "LastEnabled",
396
 
                        "ApprovalPending", "ApprovedByDefault",
397
 
                        "LastApprovalRequest", "ApprovalDelay",
398
 
                        "ApprovalDuration", "Checker",
399
 
                        "ExtendedTimeout")
 
458
                        "Created", "Interval", "Host", "KeyID",
 
459
                        "Fingerprint", "CheckerRunning",
 
460
                        "LastEnabled", "ApprovalPending",
 
461
                        "ApprovedByDefault", "LastApprovalRequest",
 
462
                        "ApprovalDelay", "ApprovalDuration",
 
463
                        "Checker", "ExtendedTimeout", "Expires",
 
464
                        "LastCheckerStatus")
400
465
        else:
401
466
            keywords = defaultkeywords
402
 
        
403
 
        print_clients(clients.values(), keywords)
 
467
 
 
468
        if options.dump_json:
 
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=(',', ': '))
 
478
            print()
 
479
        else:
 
480
            print_clients(clients.values(), keywords)
404
481
    else:
405
482
        # Process each client in the list by all selected options
406
483
        for client in clients:
407
 
            
 
484
 
408
485
            def set_client_prop(prop, value):
409
486
                """Set a Client D-Bus property"""
410
487
                client.Set(client_interface, prop, value,
411
488
                           dbus_interface=dbus.PROPERTIES_IFACE)
412
 
            
 
489
 
413
490
            def set_client_prop_ms(prop, value):
414
491
                """Set a Client D-Bus property, converted
415
492
                from a string to milliseconds."""
416
493
                set_client_prop(prop,
417
494
                                string_to_delta(value).total_seconds()
418
495
                                * 1000)
419
 
            
 
496
 
420
497
            if options.remove:
421
498
                mandos_serv.RemoveClient(client.__dbus_object_path__)
422
499
            if options.enable:
430
507
            if options.stop_checker:
431
508
                set_client_prop("CheckerRunning", dbus.Boolean(False))
432
509
            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)
 
510
                if client.Get(client_interface, "Enabled",
 
511
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
512
                    sys.exit(0)
 
513
                else:
 
514
                    sys.exit(1)
438
515
            if options.checker is not None:
439
516
                set_client_prop("Checker", options.checker)
440
517
            if options.host is not None:
466
543
                client.Approve(dbus.Boolean(False),
467
544
                               dbus_interface=client_interface)
468
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
469
576
 
470
577
if __name__ == "__main__":
471
 
    main()
 
578
    if should_only_run_tests():
 
579
        # Call using ./tdd-python-script --check [--verbose]
 
580
        unittest.main()
 
581
    else:
 
582
        main()