/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 00:26:04 UTC
  • Revision ID: teddy@recompile.se-20190302002604-r9kpfc7n8qllwg62
mandos-ctl (print_clients): Factor out making strings from printing

* mandos-ctl (table_rows_of_clients): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
    
186
 
    >>> string_to_delta('7d')
187
 
    datetime.timedelta(7)
188
 
    >>> string_to_delta('60s')
189
 
    datetime.timedelta(0, 60)
190
 
    >>> string_to_delta('60m')
191
 
    datetime.timedelta(0, 3600)
192
 
    >>> string_to_delta('24h')
193
 
    datetime.timedelta(1)
194
 
    >>> string_to_delta('1w')
195
 
    datetime.timedelta(7)
196
 
    >>> string_to_delta('5m 30s')
197
 
    datetime.timedelta(0, 330)
198
242
    """
199
 
    
 
243
 
200
244
    try:
201
245
        return rfc3339_duration_to_delta(interval)
202
 
    except ValueError:
203
 
        pass
204
 
    
 
246
    except ValueError as e:
 
247
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
248
                    ' '.join(e.args))
 
249
    return parse_pre_1_6_1_interval(interval)
 
250
 
 
251
 
 
252
def parse_pre_1_6_1_interval(interval):
 
253
    """Parse an interval string as documented by Mandos before 1.6.1, and
 
254
    return a datetime.timedelta
 
255
    >>> parse_pre_1_6_1_interval('7d')
 
256
    datetime.timedelta(7)
 
257
    >>> parse_pre_1_6_1_interval('60s')
 
258
    datetime.timedelta(0, 60)
 
259
    >>> parse_pre_1_6_1_interval('60m')
 
260
    datetime.timedelta(0, 3600)
 
261
    >>> parse_pre_1_6_1_interval('24h')
 
262
    datetime.timedelta(1)
 
263
    >>> parse_pre_1_6_1_interval('1w')
 
264
    datetime.timedelta(7)
 
265
    >>> parse_pre_1_6_1_interval('5m 30s')
 
266
    datetime.timedelta(0, 330)
 
267
    >>> parse_pre_1_6_1_interval('')
 
268
    datetime.timedelta(0)
 
269
    >>> # Ignore unknown characters, allow any order and repetitions
 
270
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
 
271
    datetime.timedelta(2, 480, 18000)
 
272
 
 
273
    """
 
274
 
205
275
    value = datetime.timedelta(0)
206
276
    regexp = re.compile(r"(\d+)([dsmhw]?)")
207
 
    
 
277
 
208
278
    for num, suffix in regexp.findall(interval):
209
279
        if suffix == "d":
210
280
            value += datetime.timedelta(int(num))
222
292
 
223
293
 
224
294
def print_clients(clients, keywords):
 
295
    print('\n'.join(table_rows_of_clients(clients, keywords)))
 
296
 
 
297
def table_rows_of_clients(clients, keywords):
225
298
    def valuetostring(value, keyword):
226
 
        if type(value) is dbus.Boolean:
 
299
        if isinstance(value, dbus.Boolean):
227
300
            return "Yes" if value else "No"
228
301
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
229
302
                       "ApprovalDuration", "ExtendedTimeout"):
230
303
            return milliseconds_to_string(value)
231
304
        return str(value)
232
 
    
 
305
 
233
306
    # Create format string to print table rows
234
307
    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)
 
308
        width=max(len(tablewords[key]),
 
309
                  max(len(valuetostring(client[key], key))
 
310
                      for client in clients)),
 
311
        key=key)
239
312
                             for key in keywords)
240
 
    # Print header line
241
 
    print(format_string.format(**tablewords))
 
313
    # Start with header line
 
314
    rows = [format_string.format(**tablewords)]
242
315
    for client in clients:
243
 
        print(format_string.format(**{
244
 
            key: valuetostring(client[key], key)
245
 
            for key in keywords }))
 
316
        rows.append(format_string
 
317
                    .format(**{key: valuetostring(client[key], key)
 
318
                               for key in keywords}))
 
319
    return rows
246
320
 
247
321
 
248
322
def has_actions(options):
269
343
def main():
270
344
    parser = argparse.ArgumentParser()
271
345
    parser.add_argument("--version", action="version",
272
 
                        version = "%(prog)s {}".format(version),
 
346
                        version="%(prog)s {}".format(version),
273
347
                        help="show version number and exit")
274
348
    parser.add_argument("-a", "--all", action="store_true",
275
349
                        help="Select all clients")
276
350
    parser.add_argument("-v", "--verbose", action="store_true",
277
351
                        help="Print all fields")
 
352
    parser.add_argument("-j", "--dump-json", action="store_true",
 
353
                        help="Dump client data in JSON format")
278
354
    parser.add_argument("-e", "--enable", action="store_true",
279
355
                        help="Enable client")
280
356
    parser.add_argument("-d", "--disable", action="store_true",
319
395
                        help="Run self-test")
320
396
    parser.add_argument("client", nargs="*", help="Client name")
321
397
    options = parser.parse_args()
322
 
    
 
398
 
323
399
    if has_actions(options) and not (options.client or options.all):
324
400
        parser.error("Options require clients names or --all.")
325
401
    if options.verbose and has_actions(options):
326
 
        parser.error("--verbose can only be used alone or with"
327
 
                     " --all.")
 
402
        parser.error("--verbose can only be used alone.")
 
403
    if options.dump_json and (options.verbose
 
404
                              or has_actions(options)):
 
405
        parser.error("--dump-json can only be used alone.")
328
406
    if options.all and not has_actions(options):
329
407
        parser.error("--all requires an action.")
330
408
 
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
409
    try:
336
410
        bus = dbus.SystemBus()
337
411
        mandos_dbus_objc = bus.get_object(busname, server_path)
338
412
    except dbus.exceptions.DBusException:
339
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
413
        log.critical("Could not connect to Mandos server")
340
414
        sys.exit(1)
341
 
    
 
415
 
342
416
    mandos_serv = dbus.Interface(mandos_dbus_objc,
343
 
                                 dbus_interface = server_interface)
344
 
    
345
 
    #block stderr since dbus library prints to stderr
 
417
                                 dbus_interface=server_interface)
 
418
    mandos_serv_object_manager = dbus.Interface(
 
419
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
420
 
 
421
    # block stderr since dbus library prints to stderr
346
422
    null = os.open(os.path.devnull, os.O_RDWR)
347
423
    stderrcopy = os.dup(sys.stderr.fileno())
348
424
    os.dup2(null, sys.stderr.fileno())
349
425
    os.close(null)
350
426
    try:
351
427
        try:
352
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
428
            mandos_clients = {path: ifs_and_props[client_interface]
 
429
                              for path, ifs_and_props in
 
430
                              mandos_serv_object_manager
 
431
                              .GetManagedObjects().items()
 
432
                              if client_interface in ifs_and_props}
353
433
        finally:
354
 
            #restore stderr
 
434
            # restore stderr
355
435
            os.dup2(stderrcopy, sys.stderr.fileno())
356
436
            os.close(stderrcopy)
357
 
    except dbus.exceptions.DBusException:
358
 
        print("Access denied: Accessing mandos server through dbus.",
359
 
              file=sys.stderr)
 
437
    except dbus.exceptions.DBusException as e:
 
438
        log.critical("Failed to access Mandos server through D-Bus:"
 
439
                     "\n%s", e)
360
440
        sys.exit(1)
361
 
    
 
441
 
362
442
    # Compile dict of (clients: properties) to process
363
 
    clients={}
364
 
    
 
443
    clients = {}
 
444
 
365
445
    if options.all or not options.client:
366
 
        clients = { bus.get_object(busname, path): properties
367
 
                    for path, properties in mandos_clients.items() }
 
446
        clients = {bus.get_object(busname, path): properties
 
447
                   for path, properties in mandos_clients.items()}
368
448
    else:
369
449
        for name in options.client:
370
450
            for path, client in mandos_clients.items():
373
453
                    clients[client_objc] = client
374
454
                    break
375
455
            else:
376
 
                print("Client not found on server: {!r}"
377
 
                      .format(name), file=sys.stderr)
 
456
                log.critical("Client not found on server: %r", name)
378
457
                sys.exit(1)
379
 
    
 
458
 
380
459
    if not has_actions(options) and clients:
381
 
        if options.verbose:
 
460
        if options.verbose or options.dump_json:
382
461
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
383
 
                        "Created", "Interval", "Host", "Fingerprint",
384
 
                        "CheckerRunning", "LastEnabled",
385
 
                        "ApprovalPending", "ApprovedByDefault",
386
 
                        "LastApprovalRequest", "ApprovalDelay",
387
 
                        "ApprovalDuration", "Checker",
388
 
                        "ExtendedTimeout")
 
462
                        "Created", "Interval", "Host", "KeyID",
 
463
                        "Fingerprint", "CheckerRunning",
 
464
                        "LastEnabled", "ApprovalPending",
 
465
                        "ApprovedByDefault", "LastApprovalRequest",
 
466
                        "ApprovalDelay", "ApprovalDuration",
 
467
                        "Checker", "ExtendedTimeout", "Expires",
 
468
                        "LastCheckerStatus")
389
469
        else:
390
470
            keywords = defaultkeywords
391
 
        
392
 
        print_clients(clients.values(), keywords)
 
471
 
 
472
        if options.dump_json:
 
473
            json.dump({client["Name"]: {key:
 
474
                                        bool(client[key])
 
475
                                        if isinstance(client[key],
 
476
                                                      dbus.Boolean)
 
477
                                        else client[key]
 
478
                                        for key in keywords}
 
479
                       for client in clients.values()},
 
480
                      fp=sys.stdout, indent=4,
 
481
                      separators=(',', ': '))
 
482
            print()
 
483
        else:
 
484
            print_clients(clients.values(), keywords)
393
485
    else:
394
486
        # Process each client in the list by all selected options
395
487
        for client in clients:
396
 
            
 
488
 
397
489
            def set_client_prop(prop, value):
398
490
                """Set a Client D-Bus property"""
399
491
                client.Set(client_interface, prop, value,
400
492
                           dbus_interface=dbus.PROPERTIES_IFACE)
401
 
            
 
493
 
402
494
            def set_client_prop_ms(prop, value):
403
495
                """Set a Client D-Bus property, converted
404
496
                from a string to milliseconds."""
405
497
                set_client_prop(prop,
406
498
                                string_to_delta(value).total_seconds()
407
499
                                * 1000)
408
 
            
 
500
 
409
501
            if options.remove:
410
502
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
503
            if options.enable:
419
511
            if options.stop_checker:
420
512
                set_client_prop("CheckerRunning", dbus.Boolean(False))
421
513
            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)
 
514
                if client.Get(client_interface, "Enabled",
 
515
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
516
                    sys.exit(0)
 
517
                else:
 
518
                    sys.exit(1)
427
519
            if options.checker is not None:
428
520
                set_client_prop("Checker", options.checker)
429
521
            if options.host is not None:
455
547
                client.Approve(dbus.Boolean(False),
456
548
                               dbus_interface=client_interface)
457
549
 
 
550
 
 
551
class Test_milliseconds_to_string(unittest.TestCase):
 
552
    def test_all(self):
 
553
        self.assertEqual(milliseconds_to_string(93785000),
 
554
                         "1T02:03:05")
 
555
    def test_no_days(self):
 
556
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
557
    def test_all_zero(self):
 
558
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
559
    def test_no_fractional_seconds(self):
 
560
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
561
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
562
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
563
 
 
564
class Test_string_to_delta(unittest.TestCase):
 
565
    def test_handles_basic_rfc3339(self):
 
566
        self.assertEqual(string_to_delta("PT2H"),
 
567
                         datetime.timedelta(0, 7200))
 
568
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
569
        # assertLogs only exists in Python 3.4
 
570
        if hasattr(self, "assertLogs"):
 
571
            with self.assertLogs(log, logging.WARNING):
 
572
                value = string_to_delta("2h")
 
573
        else:
 
574
            value = string_to_delta("2h")
 
575
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
576
 
 
577
 
 
578
def should_only_run_tests():
 
579
    parser = argparse.ArgumentParser(add_help=False)
 
580
    parser.add_argument("--check", action='store_true')
 
581
    args, unknown_args = parser.parse_known_args()
 
582
    run_tests = args.check
 
583
    if run_tests:
 
584
        # Remove --check argument from sys.argv
 
585
        sys.argv[1:] = unknown_args
 
586
    return run_tests
 
587
 
 
588
# Add all tests from doctest strings
 
589
def load_tests(loader, tests, none):
 
590
    import doctest
 
591
    tests.addTests(doctest.DocTestSuite())
 
592
    return tests
458
593
 
459
594
if __name__ == "__main__":
460
 
    main()
 
595
    if should_only_run_tests():
 
596
        # Call using ./tdd-python-script --check [--verbose]
 
597
        unittest.main()
 
598
    else:
 
599
        main()