/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:54:11 UTC
  • Revision ID: teddy@recompile.se-20190228185411-71f49cg8plsvdkub
Add tests to mandos-ctl's milliseconds_to_string function

* mandos-ctl (Test_milliseconds_to_string): New.

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
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.7.2"
 
80
version = "1.8.3"
76
81
 
77
82
 
78
83
try:
80
85
except AttributeError:
81
86
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
82
87
 
 
88
 
83
89
def milliseconds_to_string(ms):
84
90
    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))
 
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))
90
96
 
91
97
 
92
98
def rfc3339_duration_to_delta(duration):
93
99
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
94
 
    
 
100
 
95
101
    >>> rfc3339_duration_to_delta("P7D")
96
102
    datetime.timedelta(7)
97
103
    >>> rfc3339_duration_to_delta("PT60S")
107
113
    >>> rfc3339_duration_to_delta("P1DT3M20S")
108
114
    datetime.timedelta(1, 200)
109
115
    """
110
 
    
 
116
 
111
117
    # Parsing an RFC 3339 duration with regular expressions is not
112
118
    # possible - there would have to be multiple places for the same
113
119
    # values, like seconds.  The current code, while more esoteric, is
114
120
    # cleaner without depending on a parsing library.  If Python had a
115
121
    # built-in library for parsing we would use it, but we'd like to
116
122
    # avoid excessive use of external libraries.
117
 
    
 
123
 
118
124
    # New type for defining tokens, syntax, and semantics all-in-one
119
125
    Token = collections.namedtuple("Token", (
120
126
        "regexp",  # To match token; if "value" is not None, must have
153
159
                           frozenset((token_year, token_month,
154
160
                                      token_day, token_time,
155
161
                                      token_week)))
156
 
    # Define starting values
157
 
    value = datetime.timedelta() # Value so far
 
162
    # Define starting values:
 
163
    # Value so far
 
164
    value = datetime.timedelta()
158
165
    found_token = None
159
 
    followers = frozenset((token_duration, )) # Following valid tokens
160
 
    s = duration                # String left to parse
 
166
    # Following valid tokens
 
167
    followers = frozenset((token_duration, ))
 
168
    # String left to parse
 
169
    s = duration
161
170
    # Loop until end token is found
162
171
    while found_token is not token_end:
163
172
        # Search for any currently valid tokens
187
196
 
188
197
def string_to_delta(interval):
189
198
    """Parse a string and return a datetime.timedelta
190
 
    
 
199
 
191
200
    >>> string_to_delta('7d')
192
201
    datetime.timedelta(7)
193
202
    >>> string_to_delta('60s')
201
210
    >>> string_to_delta('5m 30s')
202
211
    datetime.timedelta(0, 330)
203
212
    """
204
 
    
 
213
 
205
214
    try:
206
215
        return rfc3339_duration_to_delta(interval)
207
216
    except ValueError:
208
217
        pass
209
 
    
 
218
 
210
219
    value = datetime.timedelta(0)
211
220
    regexp = re.compile(r"(\d+)([dsmhw]?)")
212
 
    
 
221
 
213
222
    for num, suffix in regexp.findall(interval):
214
223
        if suffix == "d":
215
224
            value += datetime.timedelta(int(num))
234
243
                       "ApprovalDuration", "ExtendedTimeout"):
235
244
            return milliseconds_to_string(value)
236
245
        return str(value)
237
 
    
 
246
 
238
247
    # Create format string to print table rows
239
248
    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)
 
249
        width=max(len(tablewords[key]),
 
250
                  max(len(valuetostring(client[key], key))
 
251
                      for client in clients)),
 
252
        key=key)
244
253
                             for key in keywords)
245
254
    # Print header line
246
255
    print(format_string.format(**tablewords))
247
256
    for client in clients:
248
 
        print(format_string.format(**{
249
 
            key: valuetostring(client[key], key)
250
 
            for key in keywords }))
 
257
        print(format_string
 
258
              .format(**{key: valuetostring(client[key], key)
 
259
                         for key in keywords}))
251
260
 
252
261
 
253
262
def has_actions(options):
274
283
def main():
275
284
    parser = argparse.ArgumentParser()
276
285
    parser.add_argument("--version", action="version",
277
 
                        version = "%(prog)s {}".format(version),
 
286
                        version="%(prog)s {}".format(version),
278
287
                        help="show version number and exit")
279
288
    parser.add_argument("-a", "--all", action="store_true",
280
289
                        help="Select all clients")
281
290
    parser.add_argument("-v", "--verbose", action="store_true",
282
291
                        help="Print all fields")
 
292
    parser.add_argument("-j", "--dump-json", action="store_true",
 
293
                        help="Dump client data in JSON format")
283
294
    parser.add_argument("-e", "--enable", action="store_true",
284
295
                        help="Enable client")
285
296
    parser.add_argument("-d", "--disable", action="store_true",
324
335
                        help="Run self-test")
325
336
    parser.add_argument("client", nargs="*", help="Client name")
326
337
    options = parser.parse_args()
327
 
    
 
338
 
328
339
    if has_actions(options) and not (options.client or options.all):
329
340
        parser.error("Options require clients names or --all.")
330
341
    if options.verbose and has_actions(options):
331
 
        parser.error("--verbose can only be used alone or with"
332
 
                     " --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.")
333
346
    if options.all and not has_actions(options):
334
347
        parser.error("--all requires an action.")
335
348
 
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
349
    try:
341
350
        bus = dbus.SystemBus()
342
351
        mandos_dbus_objc = bus.get_object(busname, server_path)
343
352
    except dbus.exceptions.DBusException:
344
353
        print("Could not connect to Mandos server", file=sys.stderr)
345
354
        sys.exit(1)
346
 
    
 
355
 
347
356
    mandos_serv = dbus.Interface(mandos_dbus_objc,
348
 
                                 dbus_interface = server_interface)
 
357
                                 dbus_interface=server_interface)
349
358
    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
 
359
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
360
 
 
361
    # block stderr since dbus library prints to stderr
353
362
    null = os.open(os.path.devnull, os.O_RDWR)
354
363
    stderrcopy = os.dup(sys.stderr.fileno())
355
364
    os.dup2(null, sys.stderr.fileno())
356
365
    os.close(null)
357
366
    try:
358
367
        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 }
 
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}
364
373
        finally:
365
 
            #restore stderr
 
374
            # restore stderr
366
375
            os.dup2(stderrcopy, sys.stderr.fileno())
367
376
            os.close(stderrcopy)
368
377
    except dbus.exceptions.DBusException as e:
369
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
370
 
              .format(e), file=sys.stderr)
 
378
        print("Access denied: "
 
379
              "Accessing mandos server through D-Bus: {}".format(e),
 
380
              file=sys.stderr)
371
381
        sys.exit(1)
372
 
    
 
382
 
373
383
    # Compile dict of (clients: properties) to process
374
 
    clients={}
375
 
    
 
384
    clients = {}
 
385
 
376
386
    if options.all or not options.client:
377
 
        clients = { bus.get_object(busname, path): properties
378
 
                    for path, properties in mandos_clients.items() }
 
387
        clients = {bus.get_object(busname, path): properties
 
388
                   for path, properties in mandos_clients.items()}
379
389
    else:
380
390
        for name in options.client:
381
391
            for path, client in mandos_clients.items():
387
397
                print("Client not found on server: {!r}"
388
398
                      .format(name), file=sys.stderr)
389
399
                sys.exit(1)
390
 
    
 
400
 
391
401
    if not has_actions(options) and clients:
392
 
        if options.verbose:
 
402
        if options.verbose or options.dump_json:
393
403
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
 
                        "Created", "Interval", "Host", "Fingerprint",
395
 
                        "CheckerRunning", "LastEnabled",
396
 
                        "ApprovalPending", "ApprovedByDefault",
397
 
                        "LastApprovalRequest", "ApprovalDelay",
398
 
                        "ApprovalDuration", "Checker",
399
 
                        "ExtendedTimeout")
 
404
                        "Created", "Interval", "Host", "KeyID",
 
405
                        "Fingerprint", "CheckerRunning",
 
406
                        "LastEnabled", "ApprovalPending",
 
407
                        "ApprovedByDefault", "LastApprovalRequest",
 
408
                        "ApprovalDelay", "ApprovalDuration",
 
409
                        "Checker", "ExtendedTimeout", "Expires",
 
410
                        "LastCheckerStatus")
400
411
        else:
401
412
            keywords = defaultkeywords
402
 
        
403
 
        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)
404
427
    else:
405
428
        # Process each client in the list by all selected options
406
429
        for client in clients:
407
 
            
 
430
 
408
431
            def set_client_prop(prop, value):
409
432
                """Set a Client D-Bus property"""
410
433
                client.Set(client_interface, prop, value,
411
434
                           dbus_interface=dbus.PROPERTIES_IFACE)
412
 
            
 
435
 
413
436
            def set_client_prop_ms(prop, value):
414
437
                """Set a Client D-Bus property, converted
415
438
                from a string to milliseconds."""
416
439
                set_client_prop(prop,
417
440
                                string_to_delta(value).total_seconds()
418
441
                                * 1000)
419
 
            
 
442
 
420
443
            if options.remove:
421
444
                mandos_serv.RemoveClient(client.__dbus_object_path__)
422
445
            if options.enable:
430
453
            if options.stop_checker:
431
454
                set_client_prop("CheckerRunning", dbus.Boolean(False))
432
455
            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)
 
456
                if client.Get(client_interface, "Enabled",
 
457
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
458
                    sys.exit(0)
 
459
                else:
 
460
                    sys.exit(1)
438
461
            if options.checker is not None:
439
462
                set_client_prop("Checker", options.checker)
440
463
            if options.host is not None:
466
489
                client.Approve(dbus.Boolean(False),
467
490
                               dbus_interface=client_interface)
468
491
 
 
492
 
 
493
class Test_milliseconds_to_string(unittest.TestCase):
 
494
    def test_all(self):
 
495
        self.assertEqual(milliseconds_to_string(93785000),
 
496
                         "1T02:03:05")
 
497
    def test_no_days(self):
 
498
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
499
    def test_all_zero(self):
 
500
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
501
    def test_no_fractional_seconds(self):
 
502
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
503
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
504
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
505
 
 
506
 
 
507
def should_only_run_tests():
 
508
    parser = argparse.ArgumentParser(add_help=False)
 
509
    parser.add_argument("--check", action='store_true')
 
510
    args, unknown_args = parser.parse_known_args()
 
511
    run_tests = args.check
 
512
    if run_tests:
 
513
        # Remove --check argument from sys.argv
 
514
        sys.argv[1:] = unknown_args
 
515
    return run_tests
 
516
 
 
517
# Add all tests from doctest strings
 
518
def load_tests(loader, tests, none):
 
519
    import doctest
 
520
    tests.addTests(doctest.DocTestSuite())
 
521
    return tests
469
522
 
470
523
if __name__ == "__main__":
471
 
    main()
 
524
    if should_only_run_tests():
 
525
        # Call using ./tdd-python-script --check [--verbose]
 
526
        unittest.main()
 
527
    else:
 
528
        main()