/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 20:57:45 UTC
  • Revision ID: teddy@recompile.se-20190228205745-zl3bd1yoz0q343lm
mandos-ctl: Use isinstance(x, X) instead of type(x) is X

* mandos-ctl (print_clients): Don't use type(value) and check for
                              dbus.Boolean instances exactly; use
                              isinstance() to be more generic.

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")
102
125
    >>> rfc3339_duration_to_delta("P1DT3M20S")
103
126
    datetime.timedelta(1, 200)
104
127
    """
105
 
    
 
128
 
106
129
    # Parsing an RFC 3339 duration with regular expressions is not
107
130
    # possible - there would have to be multiple places for the same
108
131
    # values, like seconds.  The current code, while more esoteric, is
109
132
    # cleaner without depending on a parsing library.  If Python had a
110
133
    # built-in library for parsing we would use it, but we'd like to
111
134
    # avoid excessive use of external libraries.
112
 
    
 
135
 
113
136
    # New type for defining tokens, syntax, and semantics all-in-one
114
137
    Token = collections.namedtuple("Token", (
115
138
        "regexp",  # To match token; if "value" is not None, must have
148
171
                           frozenset((token_year, token_month,
149
172
                                      token_day, token_time,
150
173
                                      token_week)))
151
 
    # Define starting values
152
 
    value = datetime.timedelta() # Value so far
 
174
    # Define starting values:
 
175
    # Value so far
 
176
    value = datetime.timedelta()
153
177
    found_token = None
154
 
    followers = frozenset((token_duration, )) # Following valid tokens
155
 
    s = duration                # String left to parse
 
178
    # Following valid tokens
 
179
    followers = frozenset((token_duration, ))
 
180
    # String left to parse
 
181
    s = duration
156
182
    # Loop until end token is found
157
183
    while found_token is not token_end:
158
184
        # Search for any currently valid tokens
182
208
 
183
209
def string_to_delta(interval):
184
210
    """Parse a string and return a datetime.timedelta
185
 
    
 
211
 
186
212
    >>> string_to_delta('7d')
187
213
    datetime.timedelta(7)
188
214
    >>> string_to_delta('60s')
196
222
    >>> string_to_delta('5m 30s')
197
223
    datetime.timedelta(0, 330)
198
224
    """
199
 
    
 
225
 
200
226
    try:
201
227
        return rfc3339_duration_to_delta(interval)
202
228
    except ValueError:
203
229
        pass
204
 
    
 
230
 
205
231
    value = datetime.timedelta(0)
206
232
    regexp = re.compile(r"(\d+)([dsmhw]?)")
207
 
    
 
233
 
208
234
    for num, suffix in regexp.findall(interval):
209
235
        if suffix == "d":
210
236
            value += datetime.timedelta(int(num))
223
249
 
224
250
def print_clients(clients, keywords):
225
251
    def valuetostring(value, keyword):
226
 
        if type(value) is dbus.Boolean:
 
252
        if isinstance(value, dbus.Boolean):
227
253
            return "Yes" if value else "No"
228
254
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
229
255
                       "ApprovalDuration", "ExtendedTimeout"):
230
256
            return milliseconds_to_string(value)
231
257
        return str(value)
232
 
    
 
258
 
233
259
    # Create format string to print table rows
234
260
    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)
 
261
        width=max(len(tablewords[key]),
 
262
                  max(len(valuetostring(client[key], key))
 
263
                      for client in clients)),
 
264
        key=key)
239
265
                             for key in keywords)
240
266
    # Print header line
241
267
    print(format_string.format(**tablewords))
242
268
    for client in clients:
243
 
        print(format_string.format(**{
244
 
            key: valuetostring(client[key], key)
245
 
            for key in keywords }))
 
269
        print(format_string
 
270
              .format(**{key: valuetostring(client[key], key)
 
271
                         for key in keywords}))
246
272
 
247
273
 
248
274
def has_actions(options):
269
295
def main():
270
296
    parser = argparse.ArgumentParser()
271
297
    parser.add_argument("--version", action="version",
272
 
                        version = "%(prog)s {}".format(version),
 
298
                        version="%(prog)s {}".format(version),
273
299
                        help="show version number and exit")
274
300
    parser.add_argument("-a", "--all", action="store_true",
275
301
                        help="Select all clients")
276
302
    parser.add_argument("-v", "--verbose", action="store_true",
277
303
                        help="Print all fields")
 
304
    parser.add_argument("-j", "--dump-json", action="store_true",
 
305
                        help="Dump client data in JSON format")
278
306
    parser.add_argument("-e", "--enable", action="store_true",
279
307
                        help="Enable client")
280
308
    parser.add_argument("-d", "--disable", action="store_true",
319
347
                        help="Run self-test")
320
348
    parser.add_argument("client", nargs="*", help="Client name")
321
349
    options = parser.parse_args()
322
 
    
 
350
 
323
351
    if has_actions(options) and not (options.client or options.all):
324
352
        parser.error("Options require clients names or --all.")
325
353
    if options.verbose and has_actions(options):
326
 
        parser.error("--verbose can only be used alone or with"
327
 
                     " --all.")
 
354
        parser.error("--verbose can only be used alone.")
 
355
    if options.dump_json and (options.verbose
 
356
                              or has_actions(options)):
 
357
        parser.error("--dump-json can only be used alone.")
328
358
    if options.all and not has_actions(options):
329
359
        parser.error("--all requires an action.")
330
360
 
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
361
    try:
336
362
        bus = dbus.SystemBus()
337
363
        mandos_dbus_objc = bus.get_object(busname, server_path)
338
364
    except dbus.exceptions.DBusException:
339
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
365
        log.critical("Could not connect to Mandos server")
340
366
        sys.exit(1)
341
 
    
 
367
 
342
368
    mandos_serv = dbus.Interface(mandos_dbus_objc,
343
 
                                 dbus_interface = server_interface)
344
 
    
345
 
    #block stderr since dbus library prints to stderr
 
369
                                 dbus_interface=server_interface)
 
370
    mandos_serv_object_manager = dbus.Interface(
 
371
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
372
 
 
373
    # block stderr since dbus library prints to stderr
346
374
    null = os.open(os.path.devnull, os.O_RDWR)
347
375
    stderrcopy = os.dup(sys.stderr.fileno())
348
376
    os.dup2(null, sys.stderr.fileno())
349
377
    os.close(null)
350
378
    try:
351
379
        try:
352
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
380
            mandos_clients = {path: ifs_and_props[client_interface]
 
381
                              for path, ifs_and_props in
 
382
                              mandos_serv_object_manager
 
383
                              .GetManagedObjects().items()
 
384
                              if client_interface in ifs_and_props}
353
385
        finally:
354
 
            #restore stderr
 
386
            # restore stderr
355
387
            os.dup2(stderrcopy, sys.stderr.fileno())
356
388
            os.close(stderrcopy)
357
 
    except dbus.exceptions.DBusException:
358
 
        print("Access denied: Accessing mandos server through dbus.",
359
 
              file=sys.stderr)
 
389
    except dbus.exceptions.DBusException as e:
 
390
        log.critical("Failed to access Mandos server through D-Bus:"
 
391
                     "\n%s", e)
360
392
        sys.exit(1)
361
 
    
 
393
 
362
394
    # Compile dict of (clients: properties) to process
363
 
    clients={}
364
 
    
 
395
    clients = {}
 
396
 
365
397
    if options.all or not options.client:
366
 
        clients = { bus.get_object(busname, path): properties
367
 
                    for path, properties in mandos_clients.items() }
 
398
        clients = {bus.get_object(busname, path): properties
 
399
                   for path, properties in mandos_clients.items()}
368
400
    else:
369
401
        for name in options.client:
370
402
            for path, client in mandos_clients.items():
373
405
                    clients[client_objc] = client
374
406
                    break
375
407
            else:
376
 
                print("Client not found on server: {!r}"
377
 
                      .format(name), file=sys.stderr)
 
408
                log.critical("Client not found on server: %r", name)
378
409
                sys.exit(1)
379
 
    
 
410
 
380
411
    if not has_actions(options) and clients:
381
 
        if options.verbose:
 
412
        if options.verbose or options.dump_json:
382
413
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
383
 
                        "Created", "Interval", "Host", "Fingerprint",
384
 
                        "CheckerRunning", "LastEnabled",
385
 
                        "ApprovalPending", "ApprovedByDefault",
386
 
                        "LastApprovalRequest", "ApprovalDelay",
387
 
                        "ApprovalDuration", "Checker",
388
 
                        "ExtendedTimeout")
 
414
                        "Created", "Interval", "Host", "KeyID",
 
415
                        "Fingerprint", "CheckerRunning",
 
416
                        "LastEnabled", "ApprovalPending",
 
417
                        "ApprovedByDefault", "LastApprovalRequest",
 
418
                        "ApprovalDelay", "ApprovalDuration",
 
419
                        "Checker", "ExtendedTimeout", "Expires",
 
420
                        "LastCheckerStatus")
389
421
        else:
390
422
            keywords = defaultkeywords
391
 
        
392
 
        print_clients(clients.values(), keywords)
 
423
 
 
424
        if options.dump_json:
 
425
            json.dump({client["Name"]: {key:
 
426
                                        bool(client[key])
 
427
                                        if isinstance(client[key],
 
428
                                                      dbus.Boolean)
 
429
                                        else client[key]
 
430
                                        for key in keywords}
 
431
                       for client in clients.values()},
 
432
                      fp=sys.stdout, indent=4,
 
433
                      separators=(',', ': '))
 
434
            print()
 
435
        else:
 
436
            print_clients(clients.values(), keywords)
393
437
    else:
394
438
        # Process each client in the list by all selected options
395
439
        for client in clients:
396
 
            
 
440
 
397
441
            def set_client_prop(prop, value):
398
442
                """Set a Client D-Bus property"""
399
443
                client.Set(client_interface, prop, value,
400
444
                           dbus_interface=dbus.PROPERTIES_IFACE)
401
 
            
 
445
 
402
446
            def set_client_prop_ms(prop, value):
403
447
                """Set a Client D-Bus property, converted
404
448
                from a string to milliseconds."""
405
449
                set_client_prop(prop,
406
450
                                string_to_delta(value).total_seconds()
407
451
                                * 1000)
408
 
            
 
452
 
409
453
            if options.remove:
410
454
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
455
            if options.enable:
419
463
            if options.stop_checker:
420
464
                set_client_prop("CheckerRunning", dbus.Boolean(False))
421
465
            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)
 
466
                if client.Get(client_interface, "Enabled",
 
467
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
468
                    sys.exit(0)
 
469
                else:
 
470
                    sys.exit(1)
427
471
            if options.checker is not None:
428
472
                set_client_prop("Checker", options.checker)
429
473
            if options.host is not None:
455
499
                client.Approve(dbus.Boolean(False),
456
500
                               dbus_interface=client_interface)
457
501
 
 
502
 
 
503
class Test_milliseconds_to_string(unittest.TestCase):
 
504
    def test_all(self):
 
505
        self.assertEqual(milliseconds_to_string(93785000),
 
506
                         "1T02:03:05")
 
507
    def test_no_days(self):
 
508
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
509
    def test_all_zero(self):
 
510
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
511
    def test_no_fractional_seconds(self):
 
512
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
513
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
514
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
515
 
 
516
 
 
517
def should_only_run_tests():
 
518
    parser = argparse.ArgumentParser(add_help=False)
 
519
    parser.add_argument("--check", action='store_true')
 
520
    args, unknown_args = parser.parse_known_args()
 
521
    run_tests = args.check
 
522
    if run_tests:
 
523
        # Remove --check argument from sys.argv
 
524
        sys.argv[1:] = unknown_args
 
525
    return run_tests
 
526
 
 
527
# Add all tests from doctest strings
 
528
def load_tests(loader, tests, none):
 
529
    import doctest
 
530
    tests.addTests(doctest.DocTestSuite())
 
531
    return tests
458
532
 
459
533
if __name__ == "__main__":
460
 
    main()
 
534
    if should_only_run_tests():
 
535
        # Call using ./tdd-python-script --check [--verbose]
 
536
        unittest.main()
 
537
    else:
 
538
        main()