/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-02 01:56:35 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190302015635-xgodxd3ivltju7qn
mandos-ctl: Refactor

* mandos-ctl (global tablewords): Refactor into TableOfClients.
  (TableOfClients.tablewords): New overrideable class attribute.

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.12"
 
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]?)")
234
270
 
235
271
 
236
272
def print_clients(clients, keywords):
 
273
    print('\n'.join(TableOfClients(clients, keywords).rows()))
 
274
 
 
275
class TableOfClients(object):
 
276
    tablewords = {
 
277
        "Name": "Name",
 
278
        "Enabled": "Enabled",
 
279
        "Timeout": "Timeout",
 
280
        "LastCheckedOK": "Last Successful Check",
 
281
        "LastApprovalRequest": "Last Approval Request",
 
282
        "Created": "Created",
 
283
        "Interval": "Interval",
 
284
        "Host": "Host",
 
285
        "Fingerprint": "Fingerprint",
 
286
        "KeyID": "Key ID",
 
287
        "CheckerRunning": "Check Is Running",
 
288
        "LastEnabled": "Last Enabled",
 
289
        "ApprovalPending": "Approval Is Pending",
 
290
        "ApprovedByDefault": "Approved By Default",
 
291
        "ApprovalDelay": "Approval Delay",
 
292
        "ApprovalDuration": "Approval Duration",
 
293
        "Checker": "Checker",
 
294
        "ExtendedTimeout": "Extended Timeout",
 
295
        "Expires": "Expires",
 
296
        "LastCheckerStatus": "Last Checker Status",
 
297
    }
 
298
 
 
299
    def __init__(self, clients, keywords, tablewords=None):
 
300
        self.clients = clients
 
301
        self.keywords = keywords
 
302
        if tablewords is not None:
 
303
            self.tablewords = tablewords
 
304
 
 
305
    @staticmethod
237
306
    def valuetostring(value, keyword):
238
 
        if type(value) is dbus.Boolean:
 
307
        if isinstance(value, dbus.Boolean):
239
308
            return "Yes" if value else "No"
240
309
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
241
310
                       "ApprovalDuration", "ExtendedTimeout"):
242
311
            return milliseconds_to_string(value)
243
312
        return str(value)
244
313
 
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}))
 
314
    def rows(self):
 
315
        # Create format string to format table rows
 
316
        format_string = " ".join("{{{key}:{width}}}".format(
 
317
            width=max(len(self.tablewords[key]),
 
318
                      max(len(self.valuetostring(client[key], key))
 
319
                          for client in self.clients)),
 
320
            key=key)
 
321
                                 for key in self.keywords)
 
322
        # Start with header line
 
323
        rows = [format_string.format(**self.tablewords)]
 
324
        for client in self.clients:
 
325
            rows.append(format_string
 
326
                        .format(**{key: self.valuetostring(client[key], key)
 
327
                                   for key in self.keywords}))
 
328
        return rows
258
329
 
259
330
 
260
331
def has_actions(options):
344
415
    if options.all and not has_actions(options):
345
416
        parser.error("--all requires an action.")
346
417
 
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
418
    try:
352
419
        bus = dbus.SystemBus()
353
420
        mandos_dbus_objc = bus.get_object(busname, server_path)
354
421
    except dbus.exceptions.DBusException:
355
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
422
        log.critical("Could not connect to Mandos server")
356
423
        sys.exit(1)
357
424
 
358
425
    mandos_serv = dbus.Interface(mandos_dbus_objc,
377
444
            os.dup2(stderrcopy, sys.stderr.fileno())
378
445
            os.close(stderrcopy)
379
446
    except dbus.exceptions.DBusException as e:
380
 
        print("Access denied: "
381
 
              "Accessing mandos server through D-Bus: {}".format(e),
382
 
              file=sys.stderr)
 
447
        log.critical("Failed to access Mandos server through D-Bus:"
 
448
                     "\n%s", e)
383
449
        sys.exit(1)
384
450
 
385
451
    # Compile dict of (clients: properties) to process
396
462
                    clients[client_objc] = client
397
463
                    break
398
464
            else:
399
 
                print("Client not found on server: {!r}"
400
 
                      .format(name), file=sys.stderr)
 
465
                log.critical("Client not found on server: %r", name)
401
466
                sys.exit(1)
402
467
 
403
468
    if not has_actions(options) and clients:
404
469
        if options.verbose or options.dump_json:
405
470
            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",
 
471
                        "Created", "Interval", "Host", "KeyID",
 
472
                        "Fingerprint", "CheckerRunning",
 
473
                        "LastEnabled", "ApprovalPending",
 
474
                        "ApprovedByDefault", "LastApprovalRequest",
 
475
                        "ApprovalDelay", "ApprovalDuration",
 
476
                        "Checker", "ExtendedTimeout", "Expires",
412
477
                        "LastCheckerStatus")
413
478
        else:
414
479
            keywords = defaultkeywords
491
556
                client.Approve(dbus.Boolean(False),
492
557
                               dbus_interface=client_interface)
493
558
 
 
559
 
 
560
class Test_milliseconds_to_string(unittest.TestCase):
 
561
    def test_all(self):
 
562
        self.assertEqual(milliseconds_to_string(93785000),
 
563
                         "1T02:03:05")
 
564
    def test_no_days(self):
 
565
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
566
    def test_all_zero(self):
 
567
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
568
    def test_no_fractional_seconds(self):
 
569
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
570
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
571
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
572
 
 
573
class Test_string_to_delta(unittest.TestCase):
 
574
    def test_handles_basic_rfc3339(self):
 
575
        self.assertEqual(string_to_delta("PT2H"),
 
576
                         datetime.timedelta(0, 7200))
 
577
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
578
        # assertLogs only exists in Python 3.4
 
579
        if hasattr(self, "assertLogs"):
 
580
            with self.assertLogs(log, logging.WARNING):
 
581
                value = string_to_delta("2h")
 
582
        else:
 
583
            value = string_to_delta("2h")
 
584
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
585
 
 
586
class Test_TableOfClients(unittest.TestCase):
 
587
    def setUp(self):
 
588
        self.tablewords = {
 
589
            "Attr1": "X",
 
590
            "AttrTwo": "Yy",
 
591
            "AttrThree": "Zzz",
 
592
            "Bool": "A D-BUS Boolean",
 
593
            "NonDbusBoolean": "A Non-D-BUS Boolean",
 
594
            "Integer": "An Integer",
 
595
            "Timeout": "Timedelta 1",
 
596
            "Interval": "Timedelta 2",
 
597
            "ApprovalDelay": "Timedelta 3",
 
598
            "ApprovalDuration": "Timedelta 4",
 
599
            "ExtendedTimeout": "Timedelta 5",
 
600
            "String": "A String",
 
601
        }
 
602
        self.keywords = ["Attr1", "AttrTwo"]
 
603
        self.clients = [
 
604
            {
 
605
                "Attr1": "x1",
 
606
                "AttrTwo": "y1",
 
607
                "AttrThree": "z1",
 
608
                "Bool": dbus.Boolean(False),
 
609
                "NonDbusBoolean": False,
 
610
                "Integer": 0,
 
611
                "Timeout": 0,
 
612
                "Interval": 1000,
 
613
                "ApprovalDelay": 2000,
 
614
                "ApprovalDuration": 3000,
 
615
                "ExtendedTimeout": 4000,
 
616
                "String": "",
 
617
            },
 
618
            {
 
619
                "Attr1": "x2",
 
620
                "AttrTwo": "y2",
 
621
                "AttrThree": "z2",
 
622
                "Bool": dbus.Boolean(True),
 
623
                "NonDbusBoolean": True,
 
624
                "Integer": 1,
 
625
                "Timeout": 93785000,
 
626
                "Interval": 93786000,
 
627
                "ApprovalDelay": 93787000,
 
628
                "ApprovalDuration": 93788000,
 
629
                "ExtendedTimeout": 93789000,
 
630
                "String": "A huge string which will not fit," * 10,
 
631
            },
 
632
        ]
 
633
    def test_short_header(self):
 
634
        rows = TableOfClients(self.clients, self.keywords,
 
635
                              self.tablewords).rows()
 
636
        expected_rows = [
 
637
            "X  Yy",
 
638
            "x1 y1",
 
639
            "x2 y2"]
 
640
        self.assertEqual(rows, expected_rows)
 
641
    def test_booleans(self):
 
642
        keywords = ["Bool", "NonDbusBoolean"]
 
643
        rows = TableOfClients(self.clients, keywords,
 
644
                              self.tablewords).rows()
 
645
        expected_rows = [
 
646
            "A D-BUS Boolean A Non-D-BUS Boolean",
 
647
            "No              False              ",
 
648
            "Yes             True               ",
 
649
        ]
 
650
        self.assertEqual(rows, expected_rows)
 
651
    def test_milliseconds_detection(self):
 
652
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
 
653
                    "ApprovalDuration", "ExtendedTimeout"]
 
654
        rows = TableOfClients(self.clients, keywords,
 
655
                              self.tablewords).rows()
 
656
        expected_rows = ("""
 
657
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
 
658
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
 
659
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
 
660
"""
 
661
        ).splitlines()[1:]
 
662
        self.assertEqual(rows, expected_rows)
 
663
    def test_empty_and_long_string_values(self):
 
664
        keywords = ["String"]
 
665
        rows = TableOfClients(self.clients, keywords,
 
666
                              self.tablewords).rows()
 
667
        expected_rows = ("""
 
668
A String                                                                                                                                                                                                                                                                                                                                  
 
669
                                                                                                                                                                                                                                                                                                                                          
 
670
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,
 
671
"""
 
672
        ).splitlines()[1:]
 
673
        self.assertEqual(rows, expected_rows)
 
674
 
 
675
 
 
676
 
 
677
def should_only_run_tests():
 
678
    parser = argparse.ArgumentParser(add_help=False)
 
679
    parser.add_argument("--check", action='store_true')
 
680
    args, unknown_args = parser.parse_known_args()
 
681
    run_tests = args.check
 
682
    if run_tests:
 
683
        # Remove --check argument from sys.argv
 
684
        sys.argv[1:] = unknown_args
 
685
    return run_tests
 
686
 
 
687
# Add all tests from doctest strings
 
688
def load_tests(loader, tests, none):
 
689
    import doctest
 
690
    tests.addTests(doctest.DocTestSuite())
 
691
    return tests
494
692
 
495
693
if __name__ == "__main__":
496
 
    main()
 
694
    if should_only_run_tests():
 
695
        # Call using ./tdd-python-script --check [--verbose]
 
696
        unittest.main()
 
697
    else:
 
698
        main()