/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-2014 Teddy Hogeborn
7
 
# Copyright © 2008-2014 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
 
45
 
if sys.version_info[0] == 2:
 
47
if sys.version_info.major == 2:
46
48
    str = unicode
47
49
 
48
50
locale.setlocale(locale.LC_ALL, "")
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"
68
 
    }
 
70
    "ExtendedTimeout": "Extended Timeout",
 
71
    "Expires": "Expires",
 
72
    "LastCheckerStatus": "Last Checker Status",
 
73
}
69
74
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
75
domain = "se.recompile"
71
76
busname = domain + ".Mandos"
72
77
server_path = "/"
73
78
server_interface = domain + ".Mandos"
74
79
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.6"
76
 
 
77
 
def timedelta_to_milliseconds(td):
78
 
    """Convert a datetime.timedelta object to milliseconds"""
79
 
    return ((td.days * 24 * 60 * 60 * 1000)
80
 
            + (td.seconds * 1000)
81
 
            + (td.microseconds // 1000))
 
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"
 
87
 
82
88
 
83
89
def milliseconds_to_string(ms):
84
90
    td = datetime.timedelta(0, 0, 0, ms)
85
91
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
86
 
            .format(days = "{0}T".format(td.days) if td.days else "",
87
 
                    hours = td.seconds // 3600,
88
 
                    minutes = (td.seconds % 3600) // 60,
89
 
                    seconds = td.seconds % 60,
90
 
                    ))
 
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))
91
96
 
92
97
 
93
98
def rfc3339_duration_to_delta(duration):
94
99
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
95
 
    
 
100
 
96
101
    >>> rfc3339_duration_to_delta("P7D")
97
102
    datetime.timedelta(7)
98
103
    >>> rfc3339_duration_to_delta("PT60S")
108
113
    >>> rfc3339_duration_to_delta("P1DT3M20S")
109
114
    datetime.timedelta(1, 200)
110
115
    """
111
 
    
 
116
 
112
117
    # Parsing an RFC 3339 duration with regular expressions is not
113
118
    # possible - there would have to be multiple places for the same
114
119
    # values, like seconds.  The current code, while more esoteric, is
115
120
    # cleaner without depending on a parsing library.  If Python had a
116
121
    # built-in library for parsing we would use it, but we'd like to
117
122
    # avoid excessive use of external libraries.
118
 
    
 
123
 
119
124
    # New type for defining tokens, syntax, and semantics all-in-one
120
 
    Token = collections.namedtuple("Token",
121
 
                                   ("regexp", # To match token; if
122
 
                                              # "value" is not None,
123
 
                                              # must have a "group"
124
 
                                              # containing digits
125
 
                                    "value",  # datetime.timedelta or
126
 
                                              # None
127
 
                                    "followers")) # Tokens valid after
128
 
                                                  # this token
 
125
    Token = collections.namedtuple("Token", (
 
126
        "regexp",  # To match token; if "value" is not None, must have
 
127
                   # a "group" containing digits
 
128
        "value",   # datetime.timedelta or None
 
129
        "followers"))           # Tokens valid after this token
129
130
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
131
    # the "duration" ABNF definition in RFC 3339, Appendix A.
131
132
    token_end = Token(re.compile(r"$"), None, frozenset())
132
133
    token_second = Token(re.compile(r"(\d+)S"),
133
134
                         datetime.timedelta(seconds=1),
134
 
                         frozenset((token_end,)))
 
135
                         frozenset((token_end, )))
135
136
    token_minute = Token(re.compile(r"(\d+)M"),
136
137
                         datetime.timedelta(minutes=1),
137
138
                         frozenset((token_second, token_end)))
153
154
                       frozenset((token_month, token_end)))
154
155
    token_week = Token(re.compile(r"(\d+)W"),
155
156
                       datetime.timedelta(weeks=1),
156
 
                       frozenset((token_end,)))
 
157
                       frozenset((token_end, )))
157
158
    token_duration = Token(re.compile(r"P"), None,
158
159
                           frozenset((token_year, token_month,
159
160
                                      token_day, token_time,
160
 
                                      token_week))),
161
 
    # Define starting values
162
 
    value = datetime.timedelta() # Value so far
 
161
                                      token_week)))
 
162
    # Define starting values:
 
163
    # Value so far
 
164
    value = datetime.timedelta()
163
165
    found_token = None
164
 
    followers = frozenset(token_duration,) # Following valid tokens
165
 
    s = duration                # String left to parse
 
166
    # Following valid tokens
 
167
    followers = frozenset((token_duration, ))
 
168
    # String left to parse
 
169
    s = duration
166
170
    # Loop until end token is found
167
171
    while found_token is not token_end:
168
172
        # Search for any currently valid tokens
184
188
                break
185
189
        else:
186
190
            # No currently valid tokens were found
187
 
            raise ValueError("Invalid RFC 3339 duration")
 
191
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
192
                             .format(duration))
188
193
    # End token found
189
194
    return value
190
195
 
191
196
 
192
197
def string_to_delta(interval):
193
198
    """Parse a string and return a datetime.timedelta
194
 
    
195
 
    >>> string_to_delta("7d")
 
199
 
 
200
    >>> string_to_delta('7d')
196
201
    datetime.timedelta(7)
197
 
    >>> string_to_delta("60s")
 
202
    >>> string_to_delta('60s')
198
203
    datetime.timedelta(0, 60)
199
 
    >>> string_to_delta("60m")
 
204
    >>> string_to_delta('60m')
200
205
    datetime.timedelta(0, 3600)
201
 
    >>> string_to_delta("24h")
 
206
    >>> string_to_delta('24h')
202
207
    datetime.timedelta(1)
203
 
    >>> string_to_delta("1w")
 
208
    >>> string_to_delta('1w')
204
209
    datetime.timedelta(7)
205
 
    >>> string_to_delta("5m 30s")
 
210
    >>> string_to_delta('5m 30s')
206
211
    datetime.timedelta(0, 330)
207
212
    """
208
 
    
 
213
 
209
214
    try:
210
215
        return rfc3339_duration_to_delta(interval)
211
216
    except ValueError:
212
217
        pass
213
 
    
 
218
 
214
219
    value = datetime.timedelta(0)
215
220
    regexp = re.compile(r"(\d+)([dsmhw]?)")
216
 
    
 
221
 
217
222
    for num, suffix in regexp.findall(interval):
218
223
        if suffix == "d":
219
224
            value += datetime.timedelta(int(num))
229
234
            value += datetime.timedelta(0, 0, 0, int(num))
230
235
    return value
231
236
 
 
237
 
232
238
def print_clients(clients, keywords):
233
239
    def valuetostring(value, keyword):
234
240
        if type(value) is dbus.Boolean:
237
243
                       "ApprovalDuration", "ExtendedTimeout"):
238
244
            return milliseconds_to_string(value)
239
245
        return str(value)
240
 
    
 
246
 
241
247
    # Create format string to print table rows
242
248
    format_string = " ".join("{{{key}:{width}}}".format(
243
 
            width = max(len(tablewords[key]),
244
 
                        max(len(valuetostring(client[key],
245
 
                                              key))
246
 
                            for client in
247
 
                            clients)),
248
 
            key = key) for key in keywords)
 
249
        width=max(len(tablewords[key]),
 
250
                  max(len(valuetostring(client[key], key))
 
251
                      for client in clients)),
 
252
        key=key)
 
253
                             for key in keywords)
249
254
    # Print header line
250
255
    print(format_string.format(**tablewords))
251
256
    for client in clients:
252
 
        print(format_string.format(**dict((key,
253
 
                                           valuetostring(client[key],
254
 
                                                         key))
255
 
                                          for key in keywords)))
 
257
        print(format_string
 
258
              .format(**{key: valuetostring(client[key], key)
 
259
                         for key in keywords}))
 
260
 
256
261
 
257
262
def has_actions(options):
258
263
    return any((options.enable,
274
279
                options.approve,
275
280
                options.deny))
276
281
 
 
282
 
277
283
def main():
278
284
    parser = argparse.ArgumentParser()
279
285
    parser.add_argument("--version", action="version",
280
 
                        version = "%(prog)s {0}".format(version),
 
286
                        version="%(prog)s {}".format(version),
281
287
                        help="show version number and exit")
282
288
    parser.add_argument("-a", "--all", action="store_true",
283
289
                        help="Select all clients")
284
290
    parser.add_argument("-v", "--verbose", action="store_true",
285
291
                        help="Print all fields")
 
292
    parser.add_argument("-j", "--dump-json", action="store_true",
 
293
                        help="Dump client data in JSON format")
286
294
    parser.add_argument("-e", "--enable", action="store_true",
287
295
                        help="Enable client")
288
296
    parser.add_argument("-d", "--disable", action="store_true",
327
335
                        help="Run self-test")
328
336
    parser.add_argument("client", nargs="*", help="Client name")
329
337
    options = parser.parse_args()
330
 
    
 
338
 
331
339
    if has_actions(options) and not (options.client or options.all):
332
340
        parser.error("Options require clients names or --all.")
333
341
    if options.verbose and has_actions(options):
334
 
        parser.error("--verbose can only be used alone or with"
335
 
                     " --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.")
336
346
    if options.all and not has_actions(options):
337
347
        parser.error("--all requires an action.")
338
348
 
339
 
    if options.check:
340
 
        fail_count, test_count = doctest.testmod()
341
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
342
 
    
343
349
    try:
344
350
        bus = dbus.SystemBus()
345
351
        mandos_dbus_objc = bus.get_object(busname, server_path)
346
352
    except dbus.exceptions.DBusException:
347
 
        print("Could not connect to Mandos server",
348
 
              file=sys.stderr)
 
353
        print("Could not connect to Mandos server", file=sys.stderr)
349
354
        sys.exit(1)
350
 
    
 
355
 
351
356
    mandos_serv = dbus.Interface(mandos_dbus_objc,
352
 
                                 dbus_interface = server_interface)
353
 
    
354
 
    #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
355
362
    null = os.open(os.path.devnull, os.O_RDWR)
356
363
    stderrcopy = os.dup(sys.stderr.fileno())
357
364
    os.dup2(null, sys.stderr.fileno())
358
365
    os.close(null)
359
366
    try:
360
367
        try:
361
 
            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}
362
373
        finally:
363
 
            #restore stderr
 
374
            # restore stderr
364
375
            os.dup2(stderrcopy, sys.stderr.fileno())
365
376
            os.close(stderrcopy)
366
 
    except dbus.exceptions.DBusException:
367
 
        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),
368
380
              file=sys.stderr)
369
381
        sys.exit(1)
370
 
    
 
382
 
371
383
    # Compile dict of (clients: properties) to process
372
 
    clients={}
373
 
    
 
384
    clients = {}
 
385
 
374
386
    if options.all or not options.client:
375
 
        clients = dict((bus.get_object(busname, path), properties)
376
 
                       for path, properties in
377
 
                       mandos_clients.items())
 
387
        clients = {bus.get_object(busname, path): properties
 
388
                   for path, properties in mandos_clients.items()}
378
389
    else:
379
390
        for name in options.client:
380
 
            for path, client in mandos_clients.iteritems():
 
391
            for path, client in mandos_clients.items():
381
392
                if client["Name"] == name:
382
393
                    client_objc = bus.get_object(busname, path)
383
394
                    clients[client_objc] = client
384
395
                    break
385
396
            else:
386
 
                print("Client not found on server: {0!r}"
 
397
                print("Client not found on server: {!r}"
387
398
                      .format(name), file=sys.stderr)
388
399
                sys.exit(1)
389
 
    
 
400
 
390
401
    if not has_actions(options) and clients:
391
 
        if options.verbose:
392
 
            keywords = ("Name", "Enabled", "Timeout",
393
 
                        "LastCheckedOK", "Created", "Interval",
394
 
                        "Host", "Fingerprint", "CheckerRunning",
 
402
        if options.verbose or options.dump_json:
 
403
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
404
                        "Created", "Interval", "Host", "KeyID",
 
405
                        "Fingerprint", "CheckerRunning",
395
406
                        "LastEnabled", "ApprovalPending",
396
 
                        "ApprovedByDefault",
397
 
                        "LastApprovalRequest", "ApprovalDelay",
398
 
                        "ApprovalDuration", "Checker",
399
 
                        "ExtendedTimeout")
 
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:
 
430
 
407
431
            def set_client_prop(prop, value):
408
432
                """Set a Client D-Bus property"""
409
433
                client.Set(client_interface, prop, value,
410
434
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
435
 
411
436
            def set_client_prop_ms(prop, value):
412
437
                """Set a Client D-Bus property, converted
413
438
                from a string to milliseconds."""
414
439
                set_client_prop(prop,
415
 
                                timedelta_to_milliseconds
416
 
                                (string_to_delta(value)))
 
440
                                string_to_delta(value).total_seconds()
 
441
                                * 1000)
 
442
 
417
443
            if options.remove:
418
444
                mandos_serv.RemoveClient(client.__dbus_object_path__)
419
445
            if options.enable:
427
453
            if options.stop_checker:
428
454
                set_client_prop("CheckerRunning", dbus.Boolean(False))
429
455
            if options.is_enabled:
430
 
                sys.exit(0 if client.Get(client_interface,
431
 
                                         "Enabled",
432
 
                                         dbus_interface=
433
 
                                         dbus.PROPERTIES_IFACE)
434
 
                         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)
435
461
            if options.checker is not None:
436
462
                set_client_prop("Checker", options.checker)
437
463
            if options.host is not None:
463
489
                client.Approve(dbus.Boolean(False),
464
490
                               dbus_interface=client_interface)
465
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
 
522
 
466
523
if __name__ == "__main__":
467
 
    main()
 
524
    if should_only_run_tests():
 
525
        # Call using ./tdd-python-script --check [--verbose]
 
526
        unittest.main()
 
527
    else:
 
528
        main()