/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-03-02 02:43:59 UTC
  • Revision ID: teddy@recompile.se-20190302024359-x3p601t67ki2h2mn
mandos-ctl: Refactor

* mandos-ctl (Test_TableOfClients): Don't test rows() method; test
                                    string representation directly.

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 -*-
 
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
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
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
 
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
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
22
23
#
23
24
# Contact the authors at <mandos@recompile.se>.
24
25
#
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
 
49
62
locale.setlocale(locale.LC_ALL, "")
50
63
 
51
 
tablewords = {
52
 
    "Name": "Name",
53
 
    "Enabled": "Enabled",
54
 
    "Timeout": "Timeout",
55
 
    "LastCheckedOK": "Last Successful Check",
56
 
    "LastApprovalRequest": "Last Approval Request",
57
 
    "Created": "Created",
58
 
    "Interval": "Interval",
59
 
    "Host": "Host",
60
 
    "Fingerprint": "Fingerprint",
61
 
    "CheckerRunning": "Check Is Running",
62
 
    "LastEnabled": "Last Enabled",
63
 
    "ApprovalPending": "Approval Is Pending",
64
 
    "ApprovedByDefault": "Approved By Default",
65
 
    "ApprovalDelay": "Approval Delay",
66
 
    "ApprovalDuration": "Approval Duration",
67
 
    "Checker": "Checker",
68
 
    "ExtendedTimeout": "Extended Timeout",
69
 
    "Expires": "Expires",
70
 
    "LastCheckerStatus": "Last Checker Status",
71
 
}
72
64
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
65
domain = "se.recompile"
74
66
busname = domain + ".Mandos"
75
67
server_path = "/"
76
68
server_interface = domain + ".Mandos"
77
69
client_interface = domain + ".Mandos.Client"
78
 
version = "1.7.14"
 
70
version = "1.8.3"
79
71
 
80
72
 
81
73
try:
102
94
    datetime.timedelta(0, 60)
103
95
    >>> rfc3339_duration_to_delta("PT60M")
104
96
    datetime.timedelta(0, 3600)
 
97
    >>> rfc3339_duration_to_delta("P60M")
 
98
    datetime.timedelta(1680)
105
99
    >>> rfc3339_duration_to_delta("PT24H")
106
100
    datetime.timedelta(1)
107
101
    >>> rfc3339_duration_to_delta("P1W")
110
104
    datetime.timedelta(0, 330)
111
105
    >>> rfc3339_duration_to_delta("P1DT3M20S")
112
106
    datetime.timedelta(1, 200)
 
107
    >>> # Can not be empty:
 
108
    >>> rfc3339_duration_to_delta("")
 
109
    Traceback (most recent call last):
 
110
    ...
 
111
    ValueError: Invalid RFC 3339 duration: u''
 
112
    >>> # Must start with "P":
 
113
    >>> rfc3339_duration_to_delta("1D")
 
114
    Traceback (most recent call last):
 
115
    ...
 
116
    ValueError: Invalid RFC 3339 duration: u'1D'
 
117
    >>> # Must use correct order
 
118
    >>> rfc3339_duration_to_delta("PT1S2M")
 
119
    Traceback (most recent call last):
 
120
    ...
 
121
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
 
122
    >>> # Time needs time marker
 
123
    >>> rfc3339_duration_to_delta("P1H2S")
 
124
    Traceback (most recent call last):
 
125
    ...
 
126
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
 
127
    >>> # Weeks can not be combined with anything else
 
128
    >>> rfc3339_duration_to_delta("P1D2W")
 
129
    Traceback (most recent call last):
 
130
    ...
 
131
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
 
132
    >>> rfc3339_duration_to_delta("P2W2H")
 
133
    Traceback (most recent call last):
 
134
    ...
 
135
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
113
136
    """
114
137
 
115
138
    # Parsing an RFC 3339 duration with regular expressions is not
194
217
 
195
218
def string_to_delta(interval):
196
219
    """Parse a string and return a datetime.timedelta
197
 
 
198
 
    >>> string_to_delta('7d')
199
 
    datetime.timedelta(7)
200
 
    >>> string_to_delta('60s')
201
 
    datetime.timedelta(0, 60)
202
 
    >>> string_to_delta('60m')
203
 
    datetime.timedelta(0, 3600)
204
 
    >>> string_to_delta('24h')
205
 
    datetime.timedelta(1)
206
 
    >>> string_to_delta('1w')
207
 
    datetime.timedelta(7)
208
 
    >>> string_to_delta('5m 30s')
209
 
    datetime.timedelta(0, 330)
210
220
    """
211
221
 
212
222
    try:
213
223
        return rfc3339_duration_to_delta(interval)
214
 
    except ValueError:
215
 
        pass
 
224
    except ValueError as e:
 
225
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
226
                    ' '.join(e.args))
 
227
    return parse_pre_1_6_1_interval(interval)
 
228
 
 
229
 
 
230
def parse_pre_1_6_1_interval(interval):
 
231
    """Parse an interval string as documented by Mandos before 1.6.1, and
 
232
    return a datetime.timedelta
 
233
    >>> parse_pre_1_6_1_interval('7d')
 
234
    datetime.timedelta(7)
 
235
    >>> parse_pre_1_6_1_interval('60s')
 
236
    datetime.timedelta(0, 60)
 
237
    >>> parse_pre_1_6_1_interval('60m')
 
238
    datetime.timedelta(0, 3600)
 
239
    >>> parse_pre_1_6_1_interval('24h')
 
240
    datetime.timedelta(1)
 
241
    >>> parse_pre_1_6_1_interval('1w')
 
242
    datetime.timedelta(7)
 
243
    >>> parse_pre_1_6_1_interval('5m 30s')
 
244
    datetime.timedelta(0, 330)
 
245
    >>> parse_pre_1_6_1_interval('')
 
246
    datetime.timedelta(0)
 
247
    >>> # Ignore unknown characters, allow any order and repetitions
 
248
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
 
249
    datetime.timedelta(2, 480, 18000)
 
250
 
 
251
    """
216
252
 
217
253
    value = datetime.timedelta(0)
218
254
    regexp = re.compile(r"(\d+)([dsmhw]?)")
233
269
    return value
234
270
 
235
271
 
236
 
def print_clients(clients, keywords):
 
272
class TableOfClients(object):
 
273
    tablewords = {
 
274
        "Name": "Name",
 
275
        "Enabled": "Enabled",
 
276
        "Timeout": "Timeout",
 
277
        "LastCheckedOK": "Last Successful Check",
 
278
        "LastApprovalRequest": "Last Approval Request",
 
279
        "Created": "Created",
 
280
        "Interval": "Interval",
 
281
        "Host": "Host",
 
282
        "Fingerprint": "Fingerprint",
 
283
        "KeyID": "Key ID",
 
284
        "CheckerRunning": "Check Is Running",
 
285
        "LastEnabled": "Last Enabled",
 
286
        "ApprovalPending": "Approval Is Pending",
 
287
        "ApprovedByDefault": "Approved By Default",
 
288
        "ApprovalDelay": "Approval Delay",
 
289
        "ApprovalDuration": "Approval Duration",
 
290
        "Checker": "Checker",
 
291
        "ExtendedTimeout": "Extended Timeout",
 
292
        "Expires": "Expires",
 
293
        "LastCheckerStatus": "Last Checker Status",
 
294
    }
 
295
 
 
296
    def __init__(self, clients, keywords, tablewords=None):
 
297
        self.clients = clients
 
298
        self.keywords = keywords
 
299
        if tablewords is not None:
 
300
            self.tablewords = tablewords
 
301
 
 
302
    def __str__(self):
 
303
        return "\n".join(self.rows())
 
304
 
 
305
    if sys.version_info.major == 2:
 
306
        __unicode__ = __str__
 
307
        def __str__(self):
 
308
            return str(self).encode(locale.getpreferredencoding())
 
309
 
 
310
    def rows(self):
 
311
        format_string = self.row_formatting_string()
 
312
        rows = [self.header_line(format_string)]
 
313
        rows.extend(self.client_line(client, format_string)
 
314
                    for client in self.clients)
 
315
        return rows
 
316
 
 
317
    def row_formatting_string(self):
 
318
        "Format string used to format table rows"
 
319
        return " ".join("{{{key}:{width}}}".format(
 
320
            width=max(len(self.tablewords[key]),
 
321
                      max(len(self.string_from_client(client, key))
 
322
                          for client in self.clients)),
 
323
            key=key)
 
324
                                 for key in self.keywords)
 
325
 
 
326
    def string_from_client(self, client, key):
 
327
        return self.valuetostring(client[key], key)
 
328
 
 
329
    @staticmethod
237
330
    def valuetostring(value, keyword):
238
 
        if type(value) is dbus.Boolean:
 
331
        if isinstance(value, dbus.Boolean):
239
332
            return "Yes" if value else "No"
240
333
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
241
334
                       "ApprovalDuration", "ExtendedTimeout"):
242
335
            return milliseconds_to_string(value)
243
336
        return str(value)
244
337
 
245
 
    # Create format string to print table rows
246
 
    format_string = " ".join("{{{key}:{width}}}".format(
247
 
        width=max(len(tablewords[key]),
248
 
                  max(len(valuetostring(client[key], key))
249
 
                      for client in clients)),
250
 
        key=key)
251
 
                             for key in keywords)
252
 
    # Print header line
253
 
    print(format_string.format(**tablewords))
254
 
    for client in clients:
255
 
        print(format_string
256
 
              .format(**{key: valuetostring(client[key], key)
257
 
                         for key in keywords}))
 
338
    def header_line(self, format_string):
 
339
        return format_string.format(**self.tablewords)
 
340
 
 
341
    def client_line(self, client, format_string):
 
342
        return format_string.format(
 
343
            **{key: self.string_from_client(client, key)
 
344
               for key in self.keywords})
258
345
 
259
346
 
260
347
def has_actions(options):
344
431
    if options.all and not has_actions(options):
345
432
        parser.error("--all requires an action.")
346
433
 
347
 
    if options.check:
348
 
        fail_count, test_count = doctest.testmod()
349
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
350
 
 
351
434
    try:
352
435
        bus = dbus.SystemBus()
353
436
        mandos_dbus_objc = bus.get_object(busname, server_path)
354
437
    except dbus.exceptions.DBusException:
355
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
438
        log.critical("Could not connect to Mandos server")
356
439
        sys.exit(1)
357
440
 
358
441
    mandos_serv = dbus.Interface(mandos_dbus_objc,
377
460
            os.dup2(stderrcopy, sys.stderr.fileno())
378
461
            os.close(stderrcopy)
379
462
    except dbus.exceptions.DBusException as e:
380
 
        print("Access denied: "
381
 
              "Accessing mandos server through D-Bus: {}".format(e),
382
 
              file=sys.stderr)
 
463
        log.critical("Failed to access Mandos server through D-Bus:"
 
464
                     "\n%s", e)
383
465
        sys.exit(1)
384
466
 
385
467
    # Compile dict of (clients: properties) to process
396
478
                    clients[client_objc] = client
397
479
                    break
398
480
            else:
399
 
                print("Client not found on server: {!r}"
400
 
                      .format(name), file=sys.stderr)
 
481
                log.critical("Client not found on server: %r", name)
401
482
                sys.exit(1)
402
483
 
403
484
    if not has_actions(options) and clients:
404
485
        if options.verbose or options.dump_json:
405
486
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
406
 
                        "Created", "Interval", "Host", "Fingerprint",
407
 
                        "CheckerRunning", "LastEnabled",
408
 
                        "ApprovalPending", "ApprovedByDefault",
409
 
                        "LastApprovalRequest", "ApprovalDelay",
410
 
                        "ApprovalDuration", "Checker",
411
 
                        "ExtendedTimeout", "Expires",
 
487
                        "Created", "Interval", "Host", "KeyID",
 
488
                        "Fingerprint", "CheckerRunning",
 
489
                        "LastEnabled", "ApprovalPending",
 
490
                        "ApprovedByDefault", "LastApprovalRequest",
 
491
                        "ApprovalDelay", "ApprovalDuration",
 
492
                        "Checker", "ExtendedTimeout", "Expires",
412
493
                        "LastCheckerStatus")
413
494
        else:
414
495
            keywords = defaultkeywords
425
506
                      separators=(',', ': '))
426
507
            print()
427
508
        else:
428
 
            print_clients(clients.values(), keywords)
 
509
            print(TableOfClients(clients.values(), keywords))
429
510
    else:
430
511
        # Process each client in the list by all selected options
431
512
        for client in clients:
491
572
                client.Approve(dbus.Boolean(False),
492
573
                               dbus_interface=client_interface)
493
574
 
 
575
 
 
576
class Test_milliseconds_to_string(unittest.TestCase):
 
577
    def test_all(self):
 
578
        self.assertEqual(milliseconds_to_string(93785000),
 
579
                         "1T02:03:05")
 
580
    def test_no_days(self):
 
581
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
582
    def test_all_zero(self):
 
583
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
584
    def test_no_fractional_seconds(self):
 
585
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
586
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
587
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
588
 
 
589
class Test_string_to_delta(unittest.TestCase):
 
590
    def test_handles_basic_rfc3339(self):
 
591
        self.assertEqual(string_to_delta("PT2H"),
 
592
                         datetime.timedelta(0, 7200))
 
593
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
594
        # assertLogs only exists in Python 3.4
 
595
        if hasattr(self, "assertLogs"):
 
596
            with self.assertLogs(log, logging.WARNING):
 
597
                value = string_to_delta("2h")
 
598
        else:
 
599
            value = string_to_delta("2h")
 
600
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
601
 
 
602
class Test_TableOfClients(unittest.TestCase):
 
603
    def setUp(self):
 
604
        self.tablewords = {
 
605
            "Attr1": "X",
 
606
            "AttrTwo": "Yy",
 
607
            "AttrThree": "Zzz",
 
608
            "Bool": "A D-BUS Boolean",
 
609
            "NonDbusBoolean": "A Non-D-BUS Boolean",
 
610
            "Integer": "An Integer",
 
611
            "Timeout": "Timedelta 1",
 
612
            "Interval": "Timedelta 2",
 
613
            "ApprovalDelay": "Timedelta 3",
 
614
            "ApprovalDuration": "Timedelta 4",
 
615
            "ExtendedTimeout": "Timedelta 5",
 
616
            "String": "A String",
 
617
        }
 
618
        self.keywords = ["Attr1", "AttrTwo"]
 
619
        self.clients = [
 
620
            {
 
621
                "Attr1": "x1",
 
622
                "AttrTwo": "y1",
 
623
                "AttrThree": "z1",
 
624
                "Bool": dbus.Boolean(False),
 
625
                "NonDbusBoolean": False,
 
626
                "Integer": 0,
 
627
                "Timeout": 0,
 
628
                "Interval": 1000,
 
629
                "ApprovalDelay": 2000,
 
630
                "ApprovalDuration": 3000,
 
631
                "ExtendedTimeout": 4000,
 
632
                "String": "",
 
633
            },
 
634
            {
 
635
                "Attr1": "x2",
 
636
                "AttrTwo": "y2",
 
637
                "AttrThree": "z2",
 
638
                "Bool": dbus.Boolean(True),
 
639
                "NonDbusBoolean": True,
 
640
                "Integer": 1,
 
641
                "Timeout": 93785000,
 
642
                "Interval": 93786000,
 
643
                "ApprovalDelay": 93787000,
 
644
                "ApprovalDuration": 93788000,
 
645
                "ExtendedTimeout": 93789000,
 
646
                "String": "A huge string which will not fit," * 10,
 
647
            },
 
648
        ]
 
649
    def test_short_header(self):
 
650
        text = str(TableOfClients(self.clients, self.keywords,
 
651
                                  self.tablewords))
 
652
        expected_text = """
 
653
X  Yy
 
654
x1 y1
 
655
x2 y2
 
656
"""[1:-1]
 
657
        self.assertEqual(text, expected_text)
 
658
    def test_booleans(self):
 
659
        keywords = ["Bool", "NonDbusBoolean"]
 
660
        text = str(TableOfClients(self.clients, keywords,
 
661
                                  self.tablewords))
 
662
        expected_text = """
 
663
A D-BUS Boolean A Non-D-BUS Boolean
 
664
No              False              
 
665
Yes             True               
 
666
"""[1:-1]
 
667
        self.assertEqual(text, expected_text)
 
668
    def test_milliseconds_detection(self):
 
669
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
 
670
                    "ApprovalDuration", "ExtendedTimeout"]
 
671
        text = str(TableOfClients(self.clients, keywords,
 
672
                                  self.tablewords))
 
673
        expected_text = """
 
674
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
 
675
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
 
676
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
 
677
"""[1:-1]
 
678
        self.assertEqual(text, expected_text)
 
679
    def test_empty_and_long_string_values(self):
 
680
        keywords = ["String"]
 
681
        text = str(TableOfClients(self.clients, keywords,
 
682
                                  self.tablewords))
 
683
        expected_text = """
 
684
A String                                                                                                                                                                                                                                                                                                                                  
 
685
                                                                                                                                                                                                                                                                                                                                          
 
686
A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,
 
687
"""[1:-1]
 
688
        self.assertEqual(text, expected_text)
 
689
 
 
690
 
 
691
 
 
692
def should_only_run_tests():
 
693
    parser = argparse.ArgumentParser(add_help=False)
 
694
    parser.add_argument("--check", action='store_true')
 
695
    args, unknown_args = parser.parse_known_args()
 
696
    run_tests = args.check
 
697
    if run_tests:
 
698
        # Remove --check argument from sys.argv
 
699
        sys.argv[1:] = unknown_args
 
700
    return run_tests
 
701
 
 
702
# Add all tests from doctest strings
 
703
def load_tests(loader, tests, none):
 
704
    import doctest
 
705
    tests.addTests(doctest.DocTestSuite())
 
706
    return tests
494
707
 
495
708
if __name__ == "__main__":
496
 
    main()
 
709
    if should_only_run_tests():
 
710
        # Call using ./tdd-python-script --check [--verbose]
 
711
        unittest.main()
 
712
    else:
 
713
        main()