/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:07:58 UTC
  • Revision ID: teddy@recompile.se-20190228210758-zt2bfeer3v66porp
mandos-ctl (rfc3339_duration_to_delta): Improve tests

* mandos-ctl (rfc3339_duration_to_delta): Add test for month-only
                                          value, and tests that
                                          invalid values raises
                                          ValueError.

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-2015 Teddy Hogeborn
7
 
# Copyright © 2008-2015 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.6.9"
 
92
version = "1.8.3"
 
93
 
 
94
 
 
95
try:
 
96
    dbus.OBJECT_MANAGER_IFACE
 
97
except AttributeError:
 
98
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
76
99
 
77
100
 
78
101
def milliseconds_to_string(ms):
79
102
    td = datetime.timedelta(0, 0, 0, ms)
80
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
81
 
        days = "{}T".format(td.days) if td.days else "",
82
 
        hours = td.seconds // 3600,
83
 
        minutes = (td.seconds % 3600) // 60,
84
 
        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))
85
108
 
86
109
 
87
110
def rfc3339_duration_to_delta(duration):
88
111
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
89
 
    
 
112
 
90
113
    >>> rfc3339_duration_to_delta("P7D")
91
114
    datetime.timedelta(7)
92
115
    >>> rfc3339_duration_to_delta("PT60S")
93
116
    datetime.timedelta(0, 60)
94
117
    >>> rfc3339_duration_to_delta("PT60M")
95
118
    datetime.timedelta(0, 3600)
 
119
    >>> rfc3339_duration_to_delta("P60M")
 
120
    datetime.timedelta(1680)
96
121
    >>> rfc3339_duration_to_delta("PT24H")
97
122
    datetime.timedelta(1)
98
123
    >>> rfc3339_duration_to_delta("P1W")
101
126
    datetime.timedelta(0, 330)
102
127
    >>> rfc3339_duration_to_delta("P1DT3M20S")
103
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'
104
158
    """
105
 
    
 
159
 
106
160
    # Parsing an RFC 3339 duration with regular expressions is not
107
161
    # possible - there would have to be multiple places for the same
108
162
    # values, like seconds.  The current code, while more esoteric, is
109
163
    # cleaner without depending on a parsing library.  If Python had a
110
164
    # built-in library for parsing we would use it, but we'd like to
111
165
    # avoid excessive use of external libraries.
112
 
    
 
166
 
113
167
    # New type for defining tokens, syntax, and semantics all-in-one
114
168
    Token = collections.namedtuple("Token", (
115
169
        "regexp",  # To match token; if "value" is not None, must have
148
202
                           frozenset((token_year, token_month,
149
203
                                      token_day, token_time,
150
204
                                      token_week)))
151
 
    # Define starting values
152
 
    value = datetime.timedelta() # Value so far
 
205
    # Define starting values:
 
206
    # Value so far
 
207
    value = datetime.timedelta()
153
208
    found_token = None
154
 
    followers = frozenset((token_duration, )) # Following valid tokens
155
 
    s = duration                # String left to parse
 
209
    # Following valid tokens
 
210
    followers = frozenset((token_duration, ))
 
211
    # String left to parse
 
212
    s = duration
156
213
    # Loop until end token is found
157
214
    while found_token is not token_end:
158
215
        # Search for any currently valid tokens
182
239
 
183
240
def string_to_delta(interval):
184
241
    """Parse a string and return a datetime.timedelta
185
 
    
 
242
 
186
243
    >>> string_to_delta('7d')
187
244
    datetime.timedelta(7)
188
245
    >>> string_to_delta('60s')
196
253
    >>> string_to_delta('5m 30s')
197
254
    datetime.timedelta(0, 330)
198
255
    """
199
 
    
 
256
 
200
257
    try:
201
258
        return rfc3339_duration_to_delta(interval)
202
259
    except ValueError:
203
260
        pass
204
 
    
 
261
 
205
262
    value = datetime.timedelta(0)
206
263
    regexp = re.compile(r"(\d+)([dsmhw]?)")
207
 
    
 
264
 
208
265
    for num, suffix in regexp.findall(interval):
209
266
        if suffix == "d":
210
267
            value += datetime.timedelta(int(num))
223
280
 
224
281
def print_clients(clients, keywords):
225
282
    def valuetostring(value, keyword):
226
 
        if type(value) is dbus.Boolean:
 
283
        if isinstance(value, dbus.Boolean):
227
284
            return "Yes" if value else "No"
228
285
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
229
286
                       "ApprovalDuration", "ExtendedTimeout"):
230
287
            return milliseconds_to_string(value)
231
288
        return str(value)
232
 
    
 
289
 
233
290
    # Create format string to print table rows
234
291
    format_string = " ".join("{{{key}:{width}}}".format(
235
 
        width = max(len(tablewords[key]),
236
 
                    max(len(valuetostring(client[key], key))
237
 
                        for client in clients)),
238
 
        key = key)
 
292
        width=max(len(tablewords[key]),
 
293
                  max(len(valuetostring(client[key], key))
 
294
                      for client in clients)),
 
295
        key=key)
239
296
                             for key in keywords)
240
297
    # Print header line
241
298
    print(format_string.format(**tablewords))
242
299
    for client in clients:
243
 
        print(format_string.format(**{
244
 
            key: valuetostring(client[key], key)
245
 
            for key in keywords }))
 
300
        print(format_string
 
301
              .format(**{key: valuetostring(client[key], key)
 
302
                         for key in keywords}))
246
303
 
247
304
 
248
305
def has_actions(options):
269
326
def main():
270
327
    parser = argparse.ArgumentParser()
271
328
    parser.add_argument("--version", action="version",
272
 
                        version = "%(prog)s {}".format(version),
 
329
                        version="%(prog)s {}".format(version),
273
330
                        help="show version number and exit")
274
331
    parser.add_argument("-a", "--all", action="store_true",
275
332
                        help="Select all clients")
276
333
    parser.add_argument("-v", "--verbose", action="store_true",
277
334
                        help="Print all fields")
 
335
    parser.add_argument("-j", "--dump-json", action="store_true",
 
336
                        help="Dump client data in JSON format")
278
337
    parser.add_argument("-e", "--enable", action="store_true",
279
338
                        help="Enable client")
280
339
    parser.add_argument("-d", "--disable", action="store_true",
319
378
                        help="Run self-test")
320
379
    parser.add_argument("client", nargs="*", help="Client name")
321
380
    options = parser.parse_args()
322
 
    
 
381
 
323
382
    if has_actions(options) and not (options.client or options.all):
324
383
        parser.error("Options require clients names or --all.")
325
384
    if options.verbose and has_actions(options):
326
 
        parser.error("--verbose can only be used alone or with"
327
 
                     " --all.")
 
385
        parser.error("--verbose can only be used alone.")
 
386
    if options.dump_json and (options.verbose
 
387
                              or has_actions(options)):
 
388
        parser.error("--dump-json can only be used alone.")
328
389
    if options.all and not has_actions(options):
329
390
        parser.error("--all requires an action.")
330
391
 
331
 
    if options.check:
332
 
        fail_count, test_count = doctest.testmod()
333
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
334
 
    
335
392
    try:
336
393
        bus = dbus.SystemBus()
337
394
        mandos_dbus_objc = bus.get_object(busname, server_path)
338
395
    except dbus.exceptions.DBusException:
339
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
396
        log.critical("Could not connect to Mandos server")
340
397
        sys.exit(1)
341
 
    
 
398
 
342
399
    mandos_serv = dbus.Interface(mandos_dbus_objc,
343
 
                                 dbus_interface = server_interface)
344
 
    
345
 
    #block stderr since dbus library prints to stderr
 
400
                                 dbus_interface=server_interface)
 
401
    mandos_serv_object_manager = dbus.Interface(
 
402
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
403
 
 
404
    # block stderr since dbus library prints to stderr
346
405
    null = os.open(os.path.devnull, os.O_RDWR)
347
406
    stderrcopy = os.dup(sys.stderr.fileno())
348
407
    os.dup2(null, sys.stderr.fileno())
349
408
    os.close(null)
350
409
    try:
351
410
        try:
352
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
411
            mandos_clients = {path: ifs_and_props[client_interface]
 
412
                              for path, ifs_and_props in
 
413
                              mandos_serv_object_manager
 
414
                              .GetManagedObjects().items()
 
415
                              if client_interface in ifs_and_props}
353
416
        finally:
354
 
            #restore stderr
 
417
            # restore stderr
355
418
            os.dup2(stderrcopy, sys.stderr.fileno())
356
419
            os.close(stderrcopy)
357
 
    except dbus.exceptions.DBusException:
358
 
        print("Access denied: Accessing mandos server through dbus.",
359
 
              file=sys.stderr)
 
420
    except dbus.exceptions.DBusException as e:
 
421
        log.critical("Failed to access Mandos server through D-Bus:"
 
422
                     "\n%s", e)
360
423
        sys.exit(1)
361
 
    
 
424
 
362
425
    # Compile dict of (clients: properties) to process
363
 
    clients={}
364
 
    
 
426
    clients = {}
 
427
 
365
428
    if options.all or not options.client:
366
 
        clients = { bus.get_object(busname, path): properties
367
 
                    for path, properties in mandos_clients.items() }
 
429
        clients = {bus.get_object(busname, path): properties
 
430
                   for path, properties in mandos_clients.items()}
368
431
    else:
369
432
        for name in options.client:
370
433
            for path, client in mandos_clients.items():
373
436
                    clients[client_objc] = client
374
437
                    break
375
438
            else:
376
 
                print("Client not found on server: {!r}"
377
 
                      .format(name), file=sys.stderr)
 
439
                log.critical("Client not found on server: %r", name)
378
440
                sys.exit(1)
379
 
    
 
441
 
380
442
    if not has_actions(options) and clients:
381
 
        if options.verbose:
 
443
        if options.verbose or options.dump_json:
382
444
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
383
 
                        "Created", "Interval", "Host", "Fingerprint",
384
 
                        "CheckerRunning", "LastEnabled",
385
 
                        "ApprovalPending", "ApprovedByDefault",
386
 
                        "LastApprovalRequest", "ApprovalDelay",
387
 
                        "ApprovalDuration", "Checker",
388
 
                        "ExtendedTimeout")
 
445
                        "Created", "Interval", "Host", "KeyID",
 
446
                        "Fingerprint", "CheckerRunning",
 
447
                        "LastEnabled", "ApprovalPending",
 
448
                        "ApprovedByDefault", "LastApprovalRequest",
 
449
                        "ApprovalDelay", "ApprovalDuration",
 
450
                        "Checker", "ExtendedTimeout", "Expires",
 
451
                        "LastCheckerStatus")
389
452
        else:
390
453
            keywords = defaultkeywords
391
 
        
392
 
        print_clients(clients.values(), keywords)
 
454
 
 
455
        if options.dump_json:
 
456
            json.dump({client["Name"]: {key:
 
457
                                        bool(client[key])
 
458
                                        if isinstance(client[key],
 
459
                                                      dbus.Boolean)
 
460
                                        else client[key]
 
461
                                        for key in keywords}
 
462
                       for client in clients.values()},
 
463
                      fp=sys.stdout, indent=4,
 
464
                      separators=(',', ': '))
 
465
            print()
 
466
        else:
 
467
            print_clients(clients.values(), keywords)
393
468
    else:
394
469
        # Process each client in the list by all selected options
395
470
        for client in clients:
396
 
            
 
471
 
397
472
            def set_client_prop(prop, value):
398
473
                """Set a Client D-Bus property"""
399
474
                client.Set(client_interface, prop, value,
400
475
                           dbus_interface=dbus.PROPERTIES_IFACE)
401
 
            
 
476
 
402
477
            def set_client_prop_ms(prop, value):
403
478
                """Set a Client D-Bus property, converted
404
479
                from a string to milliseconds."""
405
480
                set_client_prop(prop,
406
481
                                string_to_delta(value).total_seconds()
407
482
                                * 1000)
408
 
            
 
483
 
409
484
            if options.remove:
410
485
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
486
            if options.enable:
419
494
            if options.stop_checker:
420
495
                set_client_prop("CheckerRunning", dbus.Boolean(False))
421
496
            if options.is_enabled:
422
 
                sys.exit(0 if client.Get(client_interface,
423
 
                                         "Enabled",
424
 
                                         dbus_interface=
425
 
                                         dbus.PROPERTIES_IFACE)
426
 
                         else 1)
 
497
                if client.Get(client_interface, "Enabled",
 
498
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
499
                    sys.exit(0)
 
500
                else:
 
501
                    sys.exit(1)
427
502
            if options.checker is not None:
428
503
                set_client_prop("Checker", options.checker)
429
504
            if options.host is not None:
455
530
                client.Approve(dbus.Boolean(False),
456
531
                               dbus_interface=client_interface)
457
532
 
 
533
 
 
534
class Test_milliseconds_to_string(unittest.TestCase):
 
535
    def test_all(self):
 
536
        self.assertEqual(milliseconds_to_string(93785000),
 
537
                         "1T02:03:05")
 
538
    def test_no_days(self):
 
539
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
540
    def test_all_zero(self):
 
541
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
542
    def test_no_fractional_seconds(self):
 
543
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
544
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
545
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
546
 
 
547
 
 
548
def should_only_run_tests():
 
549
    parser = argparse.ArgumentParser(add_help=False)
 
550
    parser.add_argument("--check", action='store_true')
 
551
    args, unknown_args = parser.parse_known_args()
 
552
    run_tests = args.check
 
553
    if run_tests:
 
554
        # Remove --check argument from sys.argv
 
555
        sys.argv[1:] = unknown_args
 
556
    return run_tests
 
557
 
 
558
# Add all tests from doctest strings
 
559
def load_tests(loader, tests, none):
 
560
    import doctest
 
561
    tests.addTests(doctest.DocTestSuite())
 
562
    return tests
458
563
 
459
564
if __name__ == "__main__":
460
 
    main()
 
565
    if should_only_run_tests():
 
566
        # Call using ./tdd-python-script --check [--verbose]
 
567
        unittest.main()
 
568
    else:
 
569
        main()