/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-23 14:59:54 UTC
  • Revision ID: teddy@recompile.se-20190323145954-latqk2bg6xt989d5
mandos: Refactor; use classes, not instances, as namespaces

* mandos (Avahi): Rename to "avahi".
  (avahi.string_array_to_txt_array): Make static method.
  (GnuTLS): Rename to "gnutls".
  (gnutls.__init__): Remove; move version check up to class body.
  (gnutls.Error): Don't use class name anymore.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -bb
2
 
# -*- after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
 
1
#!/usr/bin/python
 
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
#
46
46
import tempfile
47
47
import contextlib
48
48
 
49
 
if sys.version_info.major == 2:
50
 
    __metaclass__ = type
51
 
 
52
 
try:
53
 
    import pydbus
54
 
    import gi
55
 
    dbus_python = None
56
 
except ImportError:
57
 
    import dbus as dbus_python
58
 
    pydbus = None
59
 
    class gi:
60
 
        """Dummy gi module, for the tests"""
61
 
        class repository:
62
 
            class GLib:
63
 
                class Error(Exception):
64
 
                    pass
 
49
import dbus
65
50
 
66
51
# Show warnings by default
67
52
if not sys.warnoptions:
81
66
 
82
67
locale.setlocale(locale.LC_ALL, "")
83
68
 
84
 
version = "1.8.9"
 
69
dbus_busname_domain = "se.recompile"
 
70
dbus_busname = dbus_busname_domain + ".Mandos"
 
71
server_dbus_path = "/"
 
72
server_dbus_interface = dbus_busname_domain + ".Mandos"
 
73
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
 
74
del dbus_busname_domain
 
75
version = "1.8.3"
 
76
 
 
77
 
 
78
try:
 
79
    dbus.OBJECT_MANAGER_IFACE
 
80
except AttributeError:
 
81
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
82
 
86
83
 
87
84
def main():
96
93
    if options.debug:
97
94
        log.setLevel(logging.DEBUG)
98
95
 
99
 
    if pydbus is not None:
100
 
        bus = pydbus_adapter.CachingBus(pydbus)
101
 
    else:
102
 
        bus = dbus_python_adapter.CachingBus(dbus_python)
103
 
 
104
 
    try:
105
 
        all_clients = bus.get_clients_and_properties()
106
 
    except dbus.ConnectFailed as e:
107
 
        log.critical("Could not connect to Mandos server: %s", e)
108
 
        sys.exit(1)
109
 
    except dbus.Error as e:
110
 
        log.critical(
111
 
            "Failed to access Mandos server through D-Bus:\n%s", e)
112
 
        sys.exit(1)
 
96
    bus = dbus.SystemBus()
 
97
 
 
98
    mandos_dbus_object = get_mandos_dbus_object(bus)
 
99
 
 
100
    mandos_serv = dbus.Interface(
 
101
        mandos_dbus_object, dbus_interface=server_dbus_interface)
 
102
    mandos_serv_object_manager = dbus.Interface(
 
103
        mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
104
 
 
105
    managed_objects = get_managed_objects(mandos_serv_object_manager)
 
106
 
 
107
    all_clients = {}
 
108
    for path, ifs_and_props in managed_objects.items():
 
109
        try:
 
110
            all_clients[path] = ifs_and_props[client_dbus_interface]
 
111
        except KeyError:
 
112
            pass
113
113
 
114
114
    # Compile dict of (clientpath: properties) to process
115
115
    if not clientnames:
128
128
    commands = commands_from_options(options)
129
129
 
130
130
    for command in commands:
131
 
        command.run(clients, bus)
 
131
        command.run(clients, bus, mandos_serv)
132
132
 
133
133
 
134
134
def add_command_line_options(parser):
139
139
                        help="Select all clients")
140
140
    parser.add_argument("-v", "--verbose", action="store_true",
141
141
                        help="Print all fields")
142
 
    parser.add_argument("-j", "--dump-json", dest="commands",
143
 
                        action="append_const", default=[],
144
 
                        const=command.DumpJSON(),
 
142
    parser.add_argument("-j", "--dump-json", action="store_true",
145
143
                        help="Dump client data in JSON format")
146
144
    enable_disable = parser.add_mutually_exclusive_group()
147
 
    enable_disable.add_argument("-e", "--enable", dest="commands",
148
 
                                action="append_const", default=[],
149
 
                                const=command.Enable(),
 
145
    enable_disable.add_argument("-e", "--enable", action="store_true",
150
146
                                help="Enable client")
151
 
    enable_disable.add_argument("-d", "--disable", dest="commands",
152
 
                                action="append_const", default=[],
153
 
                                const=command.Disable(),
 
147
    enable_disable.add_argument("-d", "--disable",
 
148
                                action="store_true",
154
149
                                help="disable client")
155
 
    parser.add_argument("-b", "--bump-timeout", dest="commands",
156
 
                        action="append_const", default=[],
157
 
                        const=command.BumpTimeout(),
 
150
    parser.add_argument("-b", "--bump-timeout", action="store_true",
158
151
                        help="Bump timeout for client")
159
152
    start_stop_checker = parser.add_mutually_exclusive_group()
160
153
    start_stop_checker.add_argument("--start-checker",
161
 
                                    dest="commands",
162
 
                                    action="append_const", default=[],
163
 
                                    const=command.StartChecker(),
 
154
                                    action="store_true",
164
155
                                    help="Start checker for client")
165
 
    start_stop_checker.add_argument("--stop-checker", dest="commands",
166
 
                                    action="append_const", default=[],
167
 
                                    const=command.StopChecker(),
 
156
    start_stop_checker.add_argument("--stop-checker",
 
157
                                    action="store_true",
168
158
                                    help="Stop checker for client")
169
 
    parser.add_argument("-V", "--is-enabled", dest="commands",
170
 
                        action="append_const", default=[],
171
 
                        const=command.IsEnabled(),
 
159
    parser.add_argument("-V", "--is-enabled", action="store_true",
172
160
                        help="Check if client is enabled")
173
 
    parser.add_argument("-r", "--remove", dest="commands",
174
 
                        action="append_const", default=[],
175
 
                        const=command.Remove(),
 
161
    parser.add_argument("-r", "--remove", action="store_true",
176
162
                        help="Remove client")
177
 
    parser.add_argument("-c", "--checker", dest="commands",
178
 
                        action="append", default=[],
179
 
                        metavar="COMMAND", type=command.SetChecker,
 
163
    parser.add_argument("-c", "--checker",
180
164
                        help="Set checker command for client")
181
 
    parser.add_argument(
182
 
        "-t", "--timeout", dest="commands", action="append",
183
 
        default=[], metavar="TIME",
184
 
        type=command.SetTimeout.argparse(string_to_delta),
185
 
        help="Set timeout for client")
186
 
    parser.add_argument(
187
 
        "--extended-timeout", dest="commands", action="append",
188
 
        default=[], metavar="TIME",
189
 
        type=command.SetExtendedTimeout.argparse(string_to_delta),
190
 
        help="Set extended timeout for client")
191
 
    parser.add_argument(
192
 
        "-i", "--interval", dest="commands", action="append",
193
 
        default=[], metavar="TIME",
194
 
        type=command.SetInterval.argparse(string_to_delta),
195
 
        help="Set checker interval for client")
 
165
    parser.add_argument("-t", "--timeout", type=string_to_delta,
 
166
                        help="Set timeout for client")
 
167
    parser.add_argument("--extended-timeout", type=string_to_delta,
 
168
                        help="Set extended timeout for client")
 
169
    parser.add_argument("-i", "--interval", type=string_to_delta,
 
170
                        help="Set checker interval for client")
196
171
    approve_deny_default = parser.add_mutually_exclusive_group()
197
172
    approve_deny_default.add_argument(
198
 
        "--approve-by-default", dest="commands",
199
 
        action="append_const", default=[],
200
 
        const=command.ApproveByDefault(),
 
173
        "--approve-by-default", action="store_true",
 
174
        default=None, dest="approved_by_default",
201
175
        help="Set client to be approved by default")
202
176
    approve_deny_default.add_argument(
203
 
        "--deny-by-default", dest="commands",
204
 
        action="append_const", default=[],
205
 
        const=command.DenyByDefault(),
 
177
        "--deny-by-default", action="store_false",
 
178
        dest="approved_by_default",
206
179
        help="Set client to be denied by default")
207
 
    parser.add_argument(
208
 
        "--approval-delay", dest="commands", action="append",
209
 
        default=[], metavar="TIME",
210
 
        type=command.SetApprovalDelay.argparse(string_to_delta),
211
 
        help="Set delay before client approve/deny")
212
 
    parser.add_argument(
213
 
        "--approval-duration", dest="commands", action="append",
214
 
        default=[], metavar="TIME",
215
 
        type=command.SetApprovalDuration.argparse(string_to_delta),
216
 
        help="Set duration of one client approval")
217
 
    parser.add_argument("-H", "--host", dest="commands",
218
 
                        action="append", default=[], metavar="STRING",
219
 
                        type=command.SetHost,
220
 
                        help="Set host for client")
221
 
    parser.add_argument(
222
 
        "-s", "--secret", dest="commands", action="append",
223
 
        default=[], metavar="FILENAME",
224
 
        type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
225
 
        help="Set password blob (file) for client")
 
180
    parser.add_argument("--approval-delay", type=string_to_delta,
 
181
                        help="Set delay before client approve/deny")
 
182
    parser.add_argument("--approval-duration", type=string_to_delta,
 
183
                        help="Set duration of one client approval")
 
184
    parser.add_argument("-H", "--host", help="Set host for client")
 
185
    parser.add_argument("-s", "--secret",
 
186
                        type=argparse.FileType(mode="rb"),
 
187
                        help="Set password blob (file) for client")
226
188
    approve_deny = parser.add_mutually_exclusive_group()
227
189
    approve_deny.add_argument(
228
 
        "-A", "--approve", dest="commands", action="append_const",
229
 
        default=[], const=command.Approve(),
 
190
        "-A", "--approve", action="store_true",
230
191
        help="Approve any current client request")
231
 
    approve_deny.add_argument("-D", "--deny", dest="commands",
232
 
                              action="append_const", default=[],
233
 
                              const=command.Deny(),
 
192
    approve_deny.add_argument("-D", "--deny", action="store_true",
234
193
                              help="Deny any current client request")
235
194
    parser.add_argument("--debug", action="store_true",
236
195
                        help="Debug mode (show D-Bus commands)")
253
212
def rfc3339_duration_to_delta(duration):
254
213
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
255
214
 
256
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
257
 
    True
258
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
259
 
    True
260
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
261
 
    True
262
 
    >>> # 60 months
263
 
    >>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
264
 
    True
265
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
266
 
    True
267
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
268
 
    True
269
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
270
 
    True
271
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
272
 
    True
 
215
    >>> rfc3339_duration_to_delta("P7D")
 
216
    datetime.timedelta(7)
 
217
    >>> rfc3339_duration_to_delta("PT60S")
 
218
    datetime.timedelta(0, 60)
 
219
    >>> rfc3339_duration_to_delta("PT60M")
 
220
    datetime.timedelta(0, 3600)
 
221
    >>> rfc3339_duration_to_delta("P60M")
 
222
    datetime.timedelta(1680)
 
223
    >>> rfc3339_duration_to_delta("PT24H")
 
224
    datetime.timedelta(1)
 
225
    >>> rfc3339_duration_to_delta("P1W")
 
226
    datetime.timedelta(7)
 
227
    >>> rfc3339_duration_to_delta("PT5M30S")
 
228
    datetime.timedelta(0, 330)
 
229
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
230
    datetime.timedelta(1, 200)
273
231
    >>> # Can not be empty:
274
232
    >>> rfc3339_duration_to_delta("")
275
233
    Traceback (most recent call last):
385
343
    """Parse an interval string as documented by Mandos before 1.6.1,
386
344
    and return a datetime.timedelta
387
345
 
388
 
    >>> parse_pre_1_6_1_interval('7d') == datetime.timedelta(days=7)
389
 
    True
390
 
    >>> parse_pre_1_6_1_interval('60s') == datetime.timedelta(0, 60)
391
 
    True
392
 
    >>> parse_pre_1_6_1_interval('60m') == datetime.timedelta(hours=1)
393
 
    True
394
 
    >>> parse_pre_1_6_1_interval('24h') == datetime.timedelta(days=1)
395
 
    True
396
 
    >>> parse_pre_1_6_1_interval('1w') == datetime.timedelta(days=7)
397
 
    True
398
 
    >>> parse_pre_1_6_1_interval('5m 30s') == datetime.timedelta(0, 330)
399
 
    True
400
 
    >>> parse_pre_1_6_1_interval('') == datetime.timedelta(0)
401
 
    True
 
346
    >>> parse_pre_1_6_1_interval('7d')
 
347
    datetime.timedelta(7)
 
348
    >>> parse_pre_1_6_1_interval('60s')
 
349
    datetime.timedelta(0, 60)
 
350
    >>> parse_pre_1_6_1_interval('60m')
 
351
    datetime.timedelta(0, 3600)
 
352
    >>> parse_pre_1_6_1_interval('24h')
 
353
    datetime.timedelta(1)
 
354
    >>> parse_pre_1_6_1_interval('1w')
 
355
    datetime.timedelta(7)
 
356
    >>> parse_pre_1_6_1_interval('5m 30s')
 
357
    datetime.timedelta(0, 330)
 
358
    >>> parse_pre_1_6_1_interval('')
 
359
    datetime.timedelta(0)
402
360
    >>> # Ignore unknown characters, allow any order and repetitions
403
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m') == datetime.timedelta(2, 480, 18000)
404
 
    True
 
361
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
 
362
    datetime.timedelta(2, 480, 18000)
405
363
 
406
364
    """
407
365
 
428
386
    """Apply additional restrictions on options, not expressible in
429
387
argparse"""
430
388
 
431
 
    def has_commands(options, commands=None):
432
 
        if commands is None:
433
 
            commands = (command.Enable,
434
 
                        command.Disable,
435
 
                        command.BumpTimeout,
436
 
                        command.StartChecker,
437
 
                        command.StopChecker,
438
 
                        command.IsEnabled,
439
 
                        command.Remove,
440
 
                        command.SetChecker,
441
 
                        command.SetTimeout,
442
 
                        command.SetExtendedTimeout,
443
 
                        command.SetInterval,
444
 
                        command.ApproveByDefault,
445
 
                        command.DenyByDefault,
446
 
                        command.SetApprovalDelay,
447
 
                        command.SetApprovalDuration,
448
 
                        command.SetHost,
449
 
                        command.SetSecret,
450
 
                        command.Approve,
451
 
                        command.Deny)
452
 
        return any(isinstance(cmd, commands)
453
 
                   for cmd in options.commands)
 
389
    def has_actions(options):
 
390
        return any((options.enable,
 
391
                    options.disable,
 
392
                    options.bump_timeout,
 
393
                    options.start_checker,
 
394
                    options.stop_checker,
 
395
                    options.is_enabled,
 
396
                    options.remove,
 
397
                    options.checker is not None,
 
398
                    options.timeout is not None,
 
399
                    options.extended_timeout is not None,
 
400
                    options.interval is not None,
 
401
                    options.approved_by_default is not None,
 
402
                    options.approval_delay is not None,
 
403
                    options.approval_duration is not None,
 
404
                    options.host is not None,
 
405
                    options.secret is not None,
 
406
                    options.approve,
 
407
                    options.deny))
454
408
 
455
 
    if has_commands(options) and not (options.client or options.all):
 
409
    if has_actions(options) and not (options.client or options.all):
456
410
        parser.error("Options require clients names or --all.")
457
 
    if options.verbose and has_commands(options):
 
411
    if options.verbose and has_actions(options):
458
412
        parser.error("--verbose can only be used alone.")
459
 
    if (has_commands(options, (command.DumpJSON,))
460
 
        and (options.verbose or len(options.commands) > 1)):
 
413
    if options.dump_json and (options.verbose
 
414
                              or has_actions(options)):
461
415
        parser.error("--dump-json can only be used alone.")
462
 
    if options.all and not has_commands(options):
 
416
    if options.all and not has_actions(options):
463
417
        parser.error("--all requires an action.")
464
 
    if (has_commands(options, (command.IsEnabled,))
465
 
        and len(options.client) > 1):
 
418
    if options.is_enabled and len(options.client) > 1:
466
419
        parser.error("--is-enabled requires exactly one client")
467
 
    if (len(options.commands) > 1
468
 
        and has_commands(options, (command.Remove,))
469
 
        and not has_commands(options, (command.Deny,))):
470
 
        parser.error("--remove can only be combined with --deny")
471
 
 
472
 
 
473
 
class dbus:
474
 
 
475
 
    class SystemBus:
476
 
 
477
 
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
478
 
        def get_managed_objects(self, busname, objectpath):
479
 
            return self.call_method("GetManagedObjects", busname,
480
 
                                    objectpath,
481
 
                                    self.object_manager_iface)
482
 
 
483
 
        properties_iface = "org.freedesktop.DBus.Properties"
484
 
        def set_property(self, busname, objectpath, interface, key,
485
 
                         value):
486
 
            self.call_method("Set", busname, objectpath,
487
 
                             self.properties_iface, interface, key,
488
 
                             value)
489
 
 
490
 
 
491
 
    class MandosBus(SystemBus):
492
 
        busname_domain = "se.recompile"
493
 
        busname = busname_domain + ".Mandos"
494
 
        server_path = "/"
495
 
        server_interface = busname_domain + ".Mandos"
496
 
        client_interface = busname_domain + ".Mandos.Client"
497
 
        del busname_domain
498
 
 
499
 
        def get_clients_and_properties(self):
500
 
            managed_objects = self.get_managed_objects(
501
 
                self.busname, self.server_path)
502
 
            return {objpath: properties[self.client_interface]
503
 
                    for objpath, properties in managed_objects.items()
504
 
                    if self.client_interface in properties}
505
 
 
506
 
        def set_client_property(self, objectpath, key, value):
507
 
            return self.set_property(self.busname, objectpath,
508
 
                                     self.client_interface, key,
509
 
                                     value)
510
 
 
511
 
        def call_client_method(self, objectpath, method, *args):
512
 
            return self.call_method(method, self.busname, objectpath,
513
 
                                    self.client_interface, *args)
514
 
 
515
 
        def call_server_method(self, method, *args):
516
 
            return self.call_method(method, self.busname,
517
 
                                    self.server_path,
518
 
                                    self.server_interface, *args)
519
 
 
520
 
    class Error(Exception):
521
 
        pass
522
 
 
523
 
    class ConnectFailed(Error):
524
 
        pass
525
 
 
526
 
 
527
 
class dbus_python_adapter:
528
 
 
529
 
    class SystemBus(dbus.MandosBus):
530
 
        """Use dbus-python"""
531
 
 
532
 
        def __init__(self, module=dbus_python):
533
 
            self.dbus_python = module
534
 
            self.bus = self.dbus_python.SystemBus()
535
 
 
536
 
        @contextlib.contextmanager
537
 
        def convert_exception(self, exception_class=dbus.Error):
538
 
            try:
539
 
                yield
540
 
            except self.dbus_python.exceptions.DBusException as e:
541
 
                # This does what "raise from" would do
542
 
                exc = exception_class(*e.args)
543
 
                exc.__cause__ = e
544
 
                raise exc
545
 
 
546
 
        def call_method(self, methodname, busname, objectpath,
547
 
                        interface, *args):
548
 
            proxy_object = self.get_object(busname, objectpath)
549
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
550
 
                      interface, methodname,
551
 
                      ", ".join(repr(a) for a in args))
552
 
            method = getattr(proxy_object, methodname)
553
 
            with self.convert_exception():
554
 
                with dbus_python_adapter.SilenceLogger(
555
 
                        "dbus.proxies"):
556
 
                    value = method(*args, dbus_interface=interface)
557
 
            return self.type_filter(value)
558
 
 
559
 
        def get_object(self, busname, objectpath):
560
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
561
 
                      busname, objectpath)
562
 
            with self.convert_exception(dbus.ConnectFailed):
563
 
                return self.bus.get_object(busname, objectpath)
564
 
 
565
 
        def type_filter(self, value):
566
 
            """Convert the most bothersome types to Python types"""
567
 
            if isinstance(value, self.dbus_python.Boolean):
568
 
                return bool(value)
569
 
            if isinstance(value, self.dbus_python.ObjectPath):
570
 
                return str(value)
571
 
            # Also recurse into dictionaries
572
 
            if isinstance(value, self.dbus_python.Dictionary):
573
 
                return {self.type_filter(key):
574
 
                        self.type_filter(subval)
575
 
                        for key, subval in value.items()}
576
 
            return value
577
 
 
578
 
        def set_client_property(self, objectpath, key, value):
579
 
            if key == "Secret":
580
 
                if not isinstance(value, bytes):
581
 
                    value = value.encode("utf-8")
582
 
                value = self.dbus_python.ByteArray(value)
583
 
            return self.set_property(self.busname, objectpath,
584
 
                                     self.client_interface, key,
585
 
                                     value)
586
 
 
587
 
    class SilenceLogger:
588
 
        "Simple context manager to silence a particular logger"
589
 
        def __init__(self, loggername):
590
 
            self.logger = logging.getLogger(loggername)
591
 
 
592
 
        def __enter__(self):
593
 
            self.logger.addFilter(self.nullfilter)
594
 
 
595
 
        class NullFilter(logging.Filter):
596
 
            def filter(self, record):
597
 
                return False
598
 
 
599
 
        nullfilter = NullFilter()
600
 
 
601
 
        def __exit__(self, exc_type, exc_val, exc_tb):
602
 
            self.logger.removeFilter(self.nullfilter)
603
 
 
604
 
 
605
 
    class CachingBus(SystemBus):
606
 
        """A caching layer for dbus_python_adapter.SystemBus"""
607
 
        def __init__(self, *args, **kwargs):
608
 
            self.object_cache = {}
609
 
            super(dbus_python_adapter.CachingBus,
610
 
                  self).__init__(*args, **kwargs)
611
 
        def get_object(self, busname, objectpath):
612
 
            try:
613
 
                return self.object_cache[(busname, objectpath)]
614
 
            except KeyError:
615
 
                new_object = super(
616
 
                    dbus_python_adapter.CachingBus,
617
 
                    self).get_object(busname, objectpath)
618
 
                self.object_cache[(busname, objectpath)]  = new_object
619
 
                return new_object
620
 
 
621
 
 
622
 
class pydbus_adapter:
623
 
    class SystemBus(dbus.MandosBus):
624
 
        def __init__(self, module=pydbus):
625
 
            self.pydbus = module
626
 
            self.bus = self.pydbus.SystemBus()
627
 
 
628
 
        @contextlib.contextmanager
629
 
        def convert_exception(self, exception_class=dbus.Error):
630
 
            try:
631
 
                yield
632
 
            except gi.repository.GLib.Error as e:
633
 
                # This does what "raise from" would do
634
 
                exc = exception_class(*e.args)
635
 
                exc.__cause__ = e
636
 
                raise exc
637
 
 
638
 
        def call_method(self, methodname, busname, objectpath,
639
 
                        interface, *args):
640
 
            proxy_object = self.get(busname, objectpath)
641
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
642
 
                      interface, methodname,
643
 
                      ", ".join(repr(a) for a in args))
644
 
            method = getattr(proxy_object[interface], methodname)
645
 
            with self.convert_exception():
646
 
                return method(*args)
647
 
 
648
 
        def get(self, busname, objectpath):
649
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
650
 
                      busname, objectpath)
651
 
            with self.convert_exception(dbus.ConnectFailed):
652
 
                if sys.version_info.major <= 2:
653
 
                    with warnings.catch_warnings():
654
 
                        warnings.filterwarnings(
655
 
                            "ignore", "", DeprecationWarning,
656
 
                            r"^xml\.etree\.ElementTree$")
657
 
                        return self.bus.get(busname, objectpath)
658
 
                else:
659
 
                    return self.bus.get(busname, objectpath)
660
 
 
661
 
        def set_property(self, busname, objectpath, interface, key,
662
 
                         value):
663
 
            proxy_object = self.get(busname, objectpath)
664
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
665
 
                      objectpath, self.properties_iface, interface,
666
 
                      key, value)
667
 
            setattr(proxy_object[interface], key, value)
668
 
 
669
 
    class CachingBus(SystemBus):
670
 
        """A caching layer for pydbus_adapter.SystemBus"""
671
 
        def __init__(self, *args, **kwargs):
672
 
            self.object_cache = {}
673
 
            super(pydbus_adapter.CachingBus,
674
 
                  self).__init__(*args, **kwargs)
675
 
        def get(self, busname, objectpath):
676
 
            try:
677
 
                return self.object_cache[(busname, objectpath)]
678
 
            except KeyError:
679
 
                new_object = (super(pydbus_adapter.CachingBus, self)
680
 
                              .get(busname, objectpath))
681
 
                self.object_cache[(busname, objectpath)]  = new_object
682
 
                return new_object
 
420
    if options.remove:
 
421
        options.remove = False
 
422
        if has_actions(options) and not options.deny:
 
423
            parser.error("--remove can only be combined with --deny")
 
424
        options.remove = True
 
425
 
 
426
 
 
427
def get_mandos_dbus_object(bus):
 
428
    log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
429
              dbus_busname, server_dbus_path)
 
430
    with if_dbus_exception_log_with_exception_and_exit(
 
431
            "Could not connect to Mandos server: %s"):
 
432
        mandos_dbus_object = bus.get_object(dbus_busname,
 
433
                                            server_dbus_path)
 
434
    return mandos_dbus_object
 
435
 
 
436
 
 
437
@contextlib.contextmanager
 
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
 
439
    try:
 
440
        yield
 
441
    except dbus.exceptions.DBusException as e:
 
442
        log.critical(*(args + (e,)), **kwargs)
 
443
        sys.exit(1)
 
444
 
 
445
 
 
446
def get_managed_objects(object_manager):
 
447
    log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
 
448
              server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
 
449
    with if_dbus_exception_log_with_exception_and_exit(
 
450
            "Failed to access Mandos server through D-Bus:\n%s"):
 
451
        with SilenceLogger("dbus.proxies"):
 
452
            managed_objects = object_manager.GetManagedObjects()
 
453
    return managed_objects
 
454
 
 
455
 
 
456
class SilenceLogger(object):
 
457
    "Simple context manager to silence a particular logger"
 
458
    def __init__(self, loggername):
 
459
        self.logger = logging.getLogger(loggername)
 
460
 
 
461
    def __enter__(self):
 
462
        self.logger.addFilter(self.nullfilter)
 
463
 
 
464
    class NullFilter(logging.Filter):
 
465
        def filter(self, record):
 
466
            return False
 
467
 
 
468
    nullfilter = NullFilter()
 
469
 
 
470
    def __exit__(self, exc_type, exc_val, exc_tb):
 
471
        self.logger.removeFilter(self.nullfilter)
683
472
 
684
473
 
685
474
def commands_from_options(options):
686
475
 
687
 
    commands = list(options.commands)
688
 
 
689
 
    def find_cmd(cmd, commands):
690
 
        i = 0
691
 
        for i, c in enumerate(commands):
692
 
            if isinstance(c, cmd):
693
 
                return i
694
 
        return i+1
695
 
 
696
 
    # If command.Remove is present, move any instances of command.Deny
697
 
    # to occur ahead of command.Remove.
698
 
    index_of_remove = find_cmd(command.Remove, commands)
699
 
    before_remove = commands[:index_of_remove]
700
 
    after_remove = commands[index_of_remove:]
701
 
    cleaned_after = []
702
 
    for cmd in after_remove:
703
 
        if isinstance(cmd, command.Deny):
704
 
            before_remove.append(cmd)
 
476
    commands = []
 
477
 
 
478
    if options.is_enabled:
 
479
        commands.append(command.IsEnabled())
 
480
 
 
481
    if options.approve:
 
482
        commands.append(command.Approve())
 
483
 
 
484
    if options.deny:
 
485
        commands.append(command.Deny())
 
486
 
 
487
    if options.remove:
 
488
        commands.append(command.Remove())
 
489
 
 
490
    if options.dump_json:
 
491
        commands.append(command.DumpJSON())
 
492
 
 
493
    if options.enable:
 
494
        commands.append(command.Enable())
 
495
 
 
496
    if options.disable:
 
497
        commands.append(command.Disable())
 
498
 
 
499
    if options.bump_timeout:
 
500
        commands.append(command.BumpTimeout())
 
501
 
 
502
    if options.start_checker:
 
503
        commands.append(command.StartChecker())
 
504
 
 
505
    if options.stop_checker:
 
506
        commands.append(command.StopChecker())
 
507
 
 
508
    if options.approved_by_default is not None:
 
509
        if options.approved_by_default:
 
510
            commands.append(command.ApproveByDefault())
705
511
        else:
706
 
            cleaned_after.append(cmd)
707
 
    if cleaned_after != after_remove:
708
 
        commands = before_remove + cleaned_after
 
512
            commands.append(command.DenyByDefault())
 
513
 
 
514
    if options.checker is not None:
 
515
        commands.append(command.SetChecker(options.checker))
 
516
 
 
517
    if options.host is not None:
 
518
        commands.append(command.SetHost(options.host))
 
519
 
 
520
    if options.secret is not None:
 
521
        commands.append(command.SetSecret(options.secret))
 
522
 
 
523
    if options.timeout is not None:
 
524
        commands.append(command.SetTimeout(options.timeout))
 
525
 
 
526
    if options.extended_timeout:
 
527
        commands.append(
 
528
            command.SetExtendedTimeout(options.extended_timeout))
 
529
 
 
530
    if options.interval is not None:
 
531
        commands.append(command.SetInterval(options.interval))
 
532
 
 
533
    if options.approval_delay is not None:
 
534
        commands.append(
 
535
            command.SetApprovalDelay(options.approval_delay))
 
536
 
 
537
    if options.approval_duration is not None:
 
538
        commands.append(
 
539
            command.SetApprovalDuration(options.approval_duration))
709
540
 
710
541
    # If no command option has been given, show table of clients,
711
542
    # optionally verbosely
715
546
    return commands
716
547
 
717
548
 
718
 
class command:
 
549
class command(object):
719
550
    """A namespace for command classes"""
720
551
 
721
 
    class Base:
 
552
    class Base(object):
722
553
        """Abstract base class for commands"""
723
 
        def run(self, clients, bus=None):
 
554
        def run(self, clients, bus=None, mandos=None):
724
555
            """Normal commands should implement run_on_one_client(),
725
556
but commands which want to operate on all clients at the same time can
726
557
override this run() method instead.
727
558
"""
728
 
            self.bus = bus
729
 
            for client, properties in clients.items():
 
559
            self.mandos = mandos
 
560
            for clientpath, properties in clients.items():
 
561
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
562
                          dbus_busname, str(clientpath))
 
563
                client = bus.get_object(dbus_busname, clientpath)
730
564
                self.run_on_one_client(client, properties)
731
565
 
732
566
 
733
567
    class IsEnabled(Base):
734
 
        def run(self, clients, bus=None):
735
 
            properties = next(iter(clients.values()))
736
 
            if properties["Enabled"]:
 
568
        def run(self, clients, bus=None, mandos=None):
 
569
            client, properties = next(iter(clients.items()))
 
570
            if self.is_enabled(client, properties):
737
571
                sys.exit(0)
738
572
            sys.exit(1)
 
573
        def is_enabled(self, client, properties):
 
574
            return properties["Enabled"]
739
575
 
740
576
 
741
577
    class Approve(Base):
742
578
        def run_on_one_client(self, client, properties):
743
 
            self.bus.call_client_method(client, "Approve", True)
 
579
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
580
                      client.__dbus_object_path__,
 
581
                      client_dbus_interface)
 
582
            client.Approve(dbus.Boolean(True),
 
583
                           dbus_interface=client_dbus_interface)
744
584
 
745
585
 
746
586
    class Deny(Base):
747
587
        def run_on_one_client(self, client, properties):
748
 
            self.bus.call_client_method(client, "Approve", False)
 
588
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
589
                      client.__dbus_object_path__,
 
590
                      client_dbus_interface)
 
591
            client.Approve(dbus.Boolean(False),
 
592
                           dbus_interface=client_dbus_interface)
749
593
 
750
594
 
751
595
    class Remove(Base):
752
 
        def run(self, clients, bus):
753
 
            for clientpath in frozenset(clients.keys()):
754
 
                bus.call_server_method("RemoveClient", clientpath)
 
596
        def run_on_one_client(self, client, properties):
 
597
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
 
598
                      dbus_busname, server_dbus_path,
 
599
                      server_dbus_interface,
 
600
                      str(client.__dbus_object_path__))
 
601
            self.mandos.RemoveClient(client.__dbus_object_path__)
755
602
 
756
603
 
757
604
    class Output(Base):
767
614
 
768
615
 
769
616
    class DumpJSON(Output):
770
 
        def run(self, clients, bus=None):
771
 
            data = {properties["Name"]:
772
 
                    {key: properties[key]
 
617
        def run(self, clients, bus=None, mandos=None):
 
618
            data = {client["Name"]:
 
619
                    {key: self.dbus_boolean_to_bool(client[key])
773
620
                     for key in self.all_keywords}
774
 
                    for properties in clients.values()}
 
621
                    for client in clients.values()}
775
622
            print(json.dumps(data, indent=4, separators=(',', ': ')))
776
623
 
 
624
        @staticmethod
 
625
        def dbus_boolean_to_bool(value):
 
626
            if isinstance(value, dbus.Boolean):
 
627
                value = bool(value)
 
628
            return value
 
629
 
777
630
 
778
631
    class PrintTable(Output):
779
632
        def __init__(self, verbose=False):
780
633
            self.verbose = verbose
781
634
 
782
 
        def run(self, clients, bus=None):
 
635
        def run(self, clients, bus=None, mandos=None):
783
636
            default_keywords = ("Name", "Enabled", "Timeout",
784
637
                                "LastCheckedOK")
785
638
            keywords = default_keywords
787
640
                keywords = self.all_keywords
788
641
            print(self.TableOfClients(clients.values(), keywords))
789
642
 
790
 
        class TableOfClients:
 
643
        class TableOfClients(object):
791
644
            tableheaders = {
792
645
                "Name": "Name",
793
646
                "Enabled": "Enabled",
846
699
 
847
700
            @classmethod
848
701
            def valuetostring(cls, value, keyword):
849
 
                if isinstance(value, bool):
 
702
                if isinstance(value, dbus.Boolean):
850
703
                    return "Yes" if value else "No"
851
704
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
852
705
                               "ApprovalDuration", "ExtendedTimeout"):
875
728
    class PropertySetter(Base):
876
729
        "Abstract class for Actions for setting one client property"
877
730
 
878
 
        def run_on_one_client(self, client, properties=None):
 
731
        def run_on_one_client(self, client, properties):
879
732
            """Set the Client's D-Bus property"""
880
 
            self.bus.set_client_property(client, self.propname,
881
 
                                         self.value_to_set)
 
733
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
734
                      client.__dbus_object_path__,
 
735
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
 
736
                      self.propname, self.value_to_set
 
737
                      if not isinstance(self.value_to_set,
 
738
                                        dbus.Boolean)
 
739
                      else bool(self.value_to_set))
 
740
            client.Set(client_dbus_interface, self.propname,
 
741
                       self.value_to_set,
 
742
                       dbus_interface=dbus.PROPERTIES_IFACE)
882
743
 
883
744
        @property
884
745
        def propname(self):
887
748
 
888
749
    class Enable(PropertySetter):
889
750
        propname = "Enabled"
890
 
        value_to_set = True
 
751
        value_to_set = dbus.Boolean(True)
891
752
 
892
753
 
893
754
    class Disable(PropertySetter):
894
755
        propname = "Enabled"
895
 
        value_to_set = False
 
756
        value_to_set = dbus.Boolean(False)
896
757
 
897
758
 
898
759
    class BumpTimeout(PropertySetter):
902
763
 
903
764
    class StartChecker(PropertySetter):
904
765
        propname = "CheckerRunning"
905
 
        value_to_set = True
 
766
        value_to_set = dbus.Boolean(True)
906
767
 
907
768
 
908
769
    class StopChecker(PropertySetter):
909
770
        propname = "CheckerRunning"
910
 
        value_to_set = False
 
771
        value_to_set = dbus.Boolean(False)
911
772
 
912
773
 
913
774
    class ApproveByDefault(PropertySetter):
914
775
        propname = "ApprovedByDefault"
915
 
        value_to_set = True
 
776
        value_to_set = dbus.Boolean(True)
916
777
 
917
778
 
918
779
    class DenyByDefault(PropertySetter):
919
780
        propname = "ApprovedByDefault"
920
 
        value_to_set = False
 
781
        value_to_set = dbus.Boolean(False)
921
782
 
922
783
 
923
784
    class PropertySetterValue(PropertySetter):
926
787
        def __init__(self, value):
927
788
            self.value_to_set = value
928
789
 
929
 
        @classmethod
930
 
        def argparse(cls, argtype):
931
 
            def cmdtype(arg):
932
 
                return cls(argtype(arg))
933
 
            return cmdtype
934
790
 
935
791
    class SetChecker(PropertySetterValue):
936
792
        propname = "Checker"
1024
880
                                                     "output"))
1025
881
 
1026
882
 
1027
 
class Unique:
1028
 
    """Class for objects which exist only to be unique objects, since
1029
 
unittest.mock.sentinel only exists in Python 3.3"""
1030
 
 
1031
 
 
1032
883
class Test_string_to_delta(TestCaseWithAssertLogs):
1033
884
    # Just test basic RFC 3339 functionality here, the doc string for
1034
885
    # rfc3339_duration_to_delta() already has more comprehensive
1035
 
    # tests, which are run by doctest.
 
886
    # tests, which is run by doctest.
1036
887
 
1037
888
    def test_rfc3339_zero_seconds(self):
1038
889
        self.assertEqual(datetime.timedelta(),
1062
913
 
1063
914
    def test_actions_requires_client_or_all(self):
1064
915
        for action, value in self.actions.items():
1065
 
            args = self.actionargs(action, value)
 
916
            options = self.parser.parse_args()
 
917
            setattr(options, action, value)
1066
918
            with self.assertParseError():
1067
 
                self.parse_args(args)
 
919
                self.check_option_syntax(options)
1068
920
 
1069
 
    # This mostly corresponds to the definition from has_commands() in
 
921
    # This mostly corresponds to the definition from has_actions() in
1070
922
    # check_option_syntax()
1071
923
    actions = {
1072
 
        "--enable": None,
1073
 
        "--disable": None,
1074
 
        "--bump-timeout": None,
1075
 
        "--start-checker": None,
1076
 
        "--stop-checker": None,
1077
 
        "--is-enabled": None,
1078
 
        "--remove": None,
1079
 
        "--checker": "x",
1080
 
        "--timeout": "PT0S",
1081
 
        "--extended-timeout": "PT0S",
1082
 
        "--interval": "PT0S",
1083
 
        "--approve-by-default": None,
1084
 
        "--deny-by-default": None,
1085
 
        "--approval-delay": "PT0S",
1086
 
        "--approval-duration": "PT0S",
1087
 
        "--host": "hostname",
1088
 
        "--secret": "/dev/null",
1089
 
        "--approve": None,
1090
 
        "--deny": None,
 
924
        # The actual values set here are not that important, but we do
 
925
        # at least stick to the correct types, even though they are
 
926
        # never used
 
927
        "enable": True,
 
928
        "disable": True,
 
929
        "bump_timeout": True,
 
930
        "start_checker": True,
 
931
        "stop_checker": True,
 
932
        "is_enabled": True,
 
933
        "remove": True,
 
934
        "checker": "x",
 
935
        "timeout": datetime.timedelta(),
 
936
        "extended_timeout": datetime.timedelta(),
 
937
        "interval": datetime.timedelta(),
 
938
        "approved_by_default": True,
 
939
        "approval_delay": datetime.timedelta(),
 
940
        "approval_duration": datetime.timedelta(),
 
941
        "host": "x",
 
942
        "secret": io.BytesIO(b"x"),
 
943
        "approve": True,
 
944
        "deny": True,
1091
945
    }
1092
946
 
1093
 
    @staticmethod
1094
 
    def actionargs(action, value, *args):
1095
 
        if value is not None:
1096
 
            return [action, value] + list(args)
1097
 
        else:
1098
 
            return [action] + list(args)
1099
 
 
1100
947
    @contextlib.contextmanager
1101
948
    def assertParseError(self):
1102
949
        with self.assertRaises(SystemExit) as e:
1107
954
        # /argparse.html#exiting-methods
1108
955
        self.assertEqual(2, e.exception.code)
1109
956
 
1110
 
    def parse_args(self, args):
1111
 
        options = self.parser.parse_args(args)
1112
 
        check_option_syntax(self.parser, options)
1113
 
 
1114
957
    @staticmethod
1115
958
    @contextlib.contextmanager
1116
959
    def redirect_stderr_to_devnull():
1127
970
 
1128
971
    def test_actions_all_conflicts_with_verbose(self):
1129
972
        for action, value in self.actions.items():
1130
 
            args = self.actionargs(action, value, "--all",
1131
 
                                   "--verbose")
 
973
            options = self.parser.parse_args()
 
974
            setattr(options, action, value)
 
975
            options.all = True
 
976
            options.verbose = True
1132
977
            with self.assertParseError():
1133
 
                self.parse_args(args)
 
978
                self.check_option_syntax(options)
1134
979
 
1135
980
    def test_actions_with_client_conflicts_with_verbose(self):
1136
981
        for action, value in self.actions.items():
1137
 
            args = self.actionargs(action, value, "--verbose",
1138
 
                                   "client")
 
982
            options = self.parser.parse_args()
 
983
            setattr(options, action, value)
 
984
            options.verbose = True
 
985
            options.client = ["client"]
1139
986
            with self.assertParseError():
1140
 
                self.parse_args(args)
 
987
                self.check_option_syntax(options)
1141
988
 
1142
989
    def test_dump_json_conflicts_with_verbose(self):
1143
 
        args = ["--dump-json", "--verbose"]
 
990
        options = self.parser.parse_args()
 
991
        options.dump_json = True
 
992
        options.verbose = True
1144
993
        with self.assertParseError():
1145
 
            self.parse_args(args)
 
994
            self.check_option_syntax(options)
1146
995
 
1147
996
    def test_dump_json_conflicts_with_action(self):
1148
997
        for action, value in self.actions.items():
1149
 
            args = self.actionargs(action, value, "--dump-json")
 
998
            options = self.parser.parse_args()
 
999
            setattr(options, action, value)
 
1000
            options.dump_json = True
1150
1001
            with self.assertParseError():
1151
 
                self.parse_args(args)
 
1002
                self.check_option_syntax(options)
1152
1003
 
1153
1004
    def test_all_can_not_be_alone(self):
1154
 
        args = ["--all"]
 
1005
        options = self.parser.parse_args()
 
1006
        options.all = True
1155
1007
        with self.assertParseError():
1156
 
            self.parse_args(args)
 
1008
            self.check_option_syntax(options)
1157
1009
 
1158
1010
    def test_all_is_ok_with_any_action(self):
1159
1011
        for action, value in self.actions.items():
1160
 
            args = self.actionargs(action, value, "--all")
1161
 
            self.parse_args(args)
 
1012
            options = self.parser.parse_args()
 
1013
            setattr(options, action, value)
 
1014
            options.all = True
 
1015
            self.check_option_syntax(options)
1162
1016
 
1163
1017
    def test_any_action_is_ok_with_one_client(self):
1164
1018
        for action, value in self.actions.items():
1165
 
            args = self.actionargs(action, value, "client")
1166
 
            self.parse_args(args)
 
1019
            options = self.parser.parse_args()
 
1020
            setattr(options, action, value)
 
1021
            options.client = ["client"]
 
1022
            self.check_option_syntax(options)
1167
1023
 
1168
1024
    def test_one_client_with_all_actions_except_is_enabled(self):
 
1025
        options = self.parser.parse_args()
1169
1026
        for action, value in self.actions.items():
1170
 
            if action == "--is-enabled":
 
1027
            if action == "is_enabled":
1171
1028
                continue
1172
 
            args = self.actionargs(action, value, "client")
1173
 
            self.parse_args(args)
 
1029
            setattr(options, action, value)
 
1030
        options.client = ["client"]
 
1031
        self.check_option_syntax(options)
1174
1032
 
1175
1033
    def test_two_clients_with_all_actions_except_is_enabled(self):
 
1034
        options = self.parser.parse_args()
1176
1035
        for action, value in self.actions.items():
1177
 
            if action == "--is-enabled":
 
1036
            if action == "is_enabled":
1178
1037
                continue
1179
 
            args = self.actionargs(action, value, "client1",
1180
 
                                   "client2")
1181
 
            self.parse_args(args)
 
1038
            setattr(options, action, value)
 
1039
        options.client = ["client1", "client2"]
 
1040
        self.check_option_syntax(options)
1182
1041
 
1183
1042
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1184
1043
        for action, value in self.actions.items():
1185
 
            if action == "--is-enabled":
 
1044
            if action == "is_enabled":
1186
1045
                continue
1187
 
            args = self.actionargs(action, value, "client1",
1188
 
                                   "client2")
1189
 
            self.parse_args(args)
 
1046
            options = self.parser.parse_args()
 
1047
            setattr(options, action, value)
 
1048
            options.client = ["client1", "client2"]
 
1049
            self.check_option_syntax(options)
1190
1050
 
1191
1051
    def test_is_enabled_fails_without_client(self):
1192
 
        args = ["--is-enabled"]
 
1052
        options = self.parser.parse_args()
 
1053
        options.is_enabled = True
1193
1054
        with self.assertParseError():
1194
 
            self.parse_args(args)
 
1055
            self.check_option_syntax(options)
1195
1056
 
1196
1057
    def test_is_enabled_fails_with_two_clients(self):
1197
 
        args = ["--is-enabled", "client1", "client2"]
 
1058
        options = self.parser.parse_args()
 
1059
        options.is_enabled = True
 
1060
        options.client = ["client1", "client2"]
1198
1061
        with self.assertParseError():
1199
 
            self.parse_args(args)
 
1062
            self.check_option_syntax(options)
1200
1063
 
1201
1064
    def test_remove_can_only_be_combined_with_action_deny(self):
1202
1065
        for action, value in self.actions.items():
1203
 
            if action in {"--remove", "--deny"}:
 
1066
            if action in {"remove", "deny"}:
1204
1067
                continue
1205
 
            args = self.actionargs(action, value, "--all",
1206
 
                                   "--remove")
 
1068
            options = self.parser.parse_args()
 
1069
            setattr(options, action, value)
 
1070
            options.all = True
 
1071
            options.remove = True
1207
1072
            with self.assertParseError():
1208
 
                self.parse_args(args)
1209
 
 
1210
 
 
1211
 
class Test_dbus_exceptions(unittest.TestCase):
1212
 
 
1213
 
    def test_dbus_ConnectFailed_is_Error(self):
1214
 
        with self.assertRaises(dbus.Error):
1215
 
            raise dbus.ConnectFailed()
1216
 
 
1217
 
 
1218
 
class Test_dbus_MandosBus(unittest.TestCase):
1219
 
 
1220
 
    class MockMandosBus(dbus.MandosBus):
1221
 
        def __init__(self):
1222
 
            self._name = "se.recompile.Mandos"
1223
 
            self._server_path = "/"
1224
 
            self._server_interface = "se.recompile.Mandos"
1225
 
            self._client_interface = "se.recompile.Mandos.Client"
1226
 
            self.calls = []
1227
 
            self.call_method_return = Unique()
1228
 
 
1229
 
        def call_method(self, methodname, busname, objectpath,
1230
 
                        interface, *args):
1231
 
            self.calls.append((methodname, busname, objectpath,
1232
 
                               interface, args))
1233
 
            return self.call_method_return
1234
 
 
1235
 
    def setUp(self):
1236
 
        self.bus = self.MockMandosBus()
1237
 
 
1238
 
    def test_set_client_property(self):
1239
 
        self.bus.set_client_property("objectpath", "key", "value")
1240
 
        expected_call = ("Set", self.bus._name, "objectpath",
1241
 
                         "org.freedesktop.DBus.Properties",
1242
 
                         (self.bus._client_interface, "key", "value"))
1243
 
        self.assertIn(expected_call, self.bus.calls)
1244
 
 
1245
 
    def test_call_client_method(self):
1246
 
        ret = self.bus.call_client_method("objectpath", "methodname")
1247
 
        self.assertIs(self.bus.call_method_return, ret)
1248
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1249
 
                         self.bus._client_interface, ())
1250
 
        self.assertIn(expected_call, self.bus.calls)
1251
 
 
1252
 
    def test_call_client_method_with_args(self):
1253
 
        args = (Unique(), Unique())
1254
 
        ret = self.bus.call_client_method("objectpath", "methodname",
1255
 
                                          *args)
1256
 
        self.assertIs(self.bus.call_method_return, ret)
1257
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1258
 
                         self.bus._client_interface,
1259
 
                         (args[0], args[1]))
1260
 
        self.assertIn(expected_call, self.bus.calls)
1261
 
 
1262
 
    def test_get_clients_and_properties(self):
1263
 
        managed_objects = {
1264
 
            "objectpath": {
1265
 
                self.bus._client_interface: {
1266
 
                    "key": "value",
1267
 
                    "bool": True,
1268
 
                },
1269
 
                "irrelevant_interface": {
1270
 
                    "key": "othervalue",
1271
 
                    "bool": False,
1272
 
                },
1273
 
            },
1274
 
            "other_objectpath": {
1275
 
                "other_irrelevant_interface": {
1276
 
                    "key": "value 3",
1277
 
                    "bool": None,
1278
 
                },
1279
 
            },
1280
 
        }
1281
 
        expected_clients_and_properties = {
1282
 
            "objectpath": {
1283
 
                "key": "value",
1284
 
                "bool": True,
1285
 
            }
1286
 
        }
1287
 
        self.bus.call_method_return = managed_objects
1288
 
        ret = self.bus.get_clients_and_properties()
1289
 
        self.assertDictEqual(expected_clients_and_properties, ret)
1290
 
        expected_call = ("GetManagedObjects", self.bus._name,
1291
 
                         self.bus._server_path,
1292
 
                         "org.freedesktop.DBus.ObjectManager", ())
1293
 
        self.assertIn(expected_call, self.bus.calls)
1294
 
 
1295
 
    def test_call_server_method(self):
1296
 
        ret = self.bus.call_server_method("methodname")
1297
 
        self.assertIs(self.bus.call_method_return, ret)
1298
 
        expected_call = ("methodname", self.bus._name,
1299
 
                         self.bus._server_path,
1300
 
                         self.bus._server_interface, ())
1301
 
        self.assertIn(expected_call, self.bus.calls)
1302
 
 
1303
 
    def test_call_server_method_with_args(self):
1304
 
        args = (Unique(), Unique())
1305
 
        ret = self.bus.call_server_method("methodname", *args)
1306
 
        self.assertIs(self.bus.call_method_return, ret)
1307
 
        expected_call = ("methodname", self.bus._name,
1308
 
                         self.bus._server_path,
1309
 
                         self.bus._server_interface,
1310
 
                         (args[0], args[1]))
1311
 
        self.assertIn(expected_call, self.bus.calls)
1312
 
 
1313
 
 
1314
 
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1315
 
 
1316
 
    def MockDBusPython_func(self, func):
1317
 
        class mock_dbus_python:
1318
 
            """mock dbus-python module"""
1319
 
            class exceptions:
1320
 
                """Pseudo-namespace"""
1321
 
                class DBusException(Exception):
1322
 
                    pass
1323
 
            class SystemBus:
1324
 
                @staticmethod
1325
 
                def get_object(busname, objectpath):
1326
 
                    DBusObject = collections.namedtuple(
1327
 
                        "DBusObject", ("methodname", "Set"))
1328
 
                    def method(*args, **kwargs):
1329
 
                        self.assertEqual({"dbus_interface":
1330
 
                                          "interface"},
1331
 
                                         kwargs)
1332
 
                        return func(*args)
1333
 
                    def set_property(interface, key, value,
1334
 
                                     dbus_interface=None):
1335
 
                        self.assertEqual(
1336
 
                            "org.freedesktop.DBus.Properties",
1337
 
                            dbus_interface)
1338
 
                        self.assertEqual("Secret", key)
1339
 
                        return func(interface, key, value,
1340
 
                                    dbus_interface=dbus_interface)
1341
 
                    return DBusObject(methodname=method,
1342
 
                                      Set=set_property)
1343
 
            class Boolean:
1344
 
                def __init__(self, value):
1345
 
                    self.value = bool(value)
1346
 
                def __bool__(self):
1347
 
                    return self.value
1348
 
                if sys.version_info.major == 2:
1349
 
                    __nonzero__ = __bool__
1350
 
            class ObjectPath(str):
1351
 
                pass
1352
 
            class Dictionary(dict):
1353
 
                pass
1354
 
            class ByteArray(bytes):
1355
 
                pass
1356
 
        return mock_dbus_python
1357
 
 
1358
 
    def call_method(self, bus, methodname, busname, objectpath,
1359
 
                    interface, *args):
1360
 
        with self.assertLogs(log, logging.DEBUG):
1361
 
            return bus.call_method(methodname, busname, objectpath,
1362
 
                                   interface, *args)
1363
 
 
1364
 
    def test_call_method_returns(self):
1365
 
        expected_method_return = Unique()
1366
 
        method_args = (Unique(), Unique())
1367
 
        def func(*args):
1368
 
            self.assertEqual(len(method_args), len(args))
1369
 
            for marg, arg in zip(method_args, args):
1370
 
                self.assertIs(marg, arg)
1371
 
            return expected_method_return
1372
 
        mock_dbus_python = self.MockDBusPython_func(func)
1373
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1374
 
        ret = self.call_method(bus, "methodname", "busname",
1375
 
                               "objectpath", "interface",
1376
 
                               *method_args)
1377
 
        self.assertIs(ret, expected_method_return)
1378
 
 
1379
 
    def test_call_method_filters_bool_true(self):
1380
 
        def func():
1381
 
            return method_return
1382
 
        mock_dbus_python = self.MockDBusPython_func(func)
1383
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1384
 
        method_return = mock_dbus_python.Boolean(True)
1385
 
        ret = self.call_method(bus, "methodname", "busname",
1386
 
                               "objectpath", "interface")
1387
 
        self.assertTrue(ret)
1388
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1389
 
 
1390
 
    def test_call_method_filters_bool_false(self):
1391
 
        def func():
1392
 
            return method_return
1393
 
        mock_dbus_python = self.MockDBusPython_func(func)
1394
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1395
 
        method_return = mock_dbus_python.Boolean(False)
1396
 
        ret = self.call_method(bus, "methodname", "busname",
1397
 
                               "objectpath", "interface")
1398
 
        self.assertFalse(ret)
1399
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1400
 
 
1401
 
    def test_call_method_filters_objectpath(self):
1402
 
        def func():
1403
 
            return method_return
1404
 
        mock_dbus_python = self.MockDBusPython_func(func)
1405
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1406
 
        method_return = mock_dbus_python.ObjectPath("objectpath")
1407
 
        ret = self.call_method(bus, "methodname", "busname",
1408
 
                               "objectpath", "interface")
1409
 
        self.assertEqual("objectpath", ret)
1410
 
        self.assertIsNot("objectpath", ret)
1411
 
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1412
 
 
1413
 
    def test_call_method_filters_booleans_in_dict(self):
1414
 
        def func():
1415
 
            return method_return
1416
 
        mock_dbus_python = self.MockDBusPython_func(func)
1417
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1418
 
        method_return = mock_dbus_python.Dictionary(
1419
 
        {mock_dbus_python.Boolean(True):
1420
 
         mock_dbus_python.Boolean(False),
1421
 
         mock_dbus_python.Boolean(False):
1422
 
         mock_dbus_python.Boolean(True)})
1423
 
        ret = self.call_method(bus, "methodname", "busname",
1424
 
                               "objectpath", "interface")
1425
 
        expected_method_return = {True: False,
1426
 
                                  False: True}
1427
 
        self.assertEqual(expected_method_return, ret)
1428
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1429
 
 
1430
 
    def test_call_method_filters_objectpaths_in_dict(self):
1431
 
        def func():
1432
 
            return method_return
1433
 
        mock_dbus_python = self.MockDBusPython_func(func)
1434
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1435
 
        method_return = mock_dbus_python.Dictionary(
1436
 
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
1437
 
         mock_dbus_python.ObjectPath("objectpath_value_1"),
1438
 
         mock_dbus_python.ObjectPath("objectpath_key_2"):
1439
 
         mock_dbus_python.ObjectPath("objectpath_value_2")})
1440
 
        ret = self.call_method(bus, "methodname", "busname",
1441
 
                               "objectpath", "interface")
1442
 
        expected_method_return = {str(key): str(value)
1443
 
                                  for key, value in
1444
 
                                  method_return.items()}
1445
 
        self.assertEqual(expected_method_return, ret)
1446
 
        self.assertIsInstance(ret, dict)
1447
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1448
 
 
1449
 
    def test_call_method_filters_dict_in_dict(self):
1450
 
        def func():
1451
 
            return method_return
1452
 
        mock_dbus_python = self.MockDBusPython_func(func)
1453
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1454
 
        method_return = mock_dbus_python.Dictionary(
1455
 
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
1456
 
                                              "key12": "value12"}),
1457
 
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
1458
 
                                              "key22": "value22"})})
1459
 
        ret = self.call_method(bus, "methodname", "busname",
1460
 
                               "objectpath", "interface")
1461
 
        expected_method_return = {
1462
 
            "key1": {"key11": "value11",
1463
 
                     "key12": "value12"},
1464
 
            "key2": {"key21": "value21",
1465
 
                     "key22": "value22"},
1466
 
        }
1467
 
        self.assertEqual(expected_method_return, ret)
1468
 
        self.assertIsInstance(ret, dict)
1469
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1470
 
        for key, value in ret.items():
1471
 
            self.assertIsInstance(value, dict)
1472
 
            self.assertEqual(expected_method_return[key], value)
1473
 
            self.assertNotIsInstance(value,
1474
 
                                     mock_dbus_python.Dictionary)
1475
 
 
1476
 
    def test_call_method_filters_dict_three_deep(self):
1477
 
        def func():
1478
 
            return method_return
1479
 
        mock_dbus_python = self.MockDBusPython_func(func)
1480
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1481
 
        method_return = mock_dbus_python.Dictionary(
1482
 
            {"key1":
1483
 
             mock_dbus_python.Dictionary(
1484
 
                 {"key2":
1485
 
                  mock_dbus_python.Dictionary(
1486
 
                      {"key3":
1487
 
                       mock_dbus_python.Boolean(True),
1488
 
                       }),
1489
 
                  }),
1490
 
             })
1491
 
        ret = self.call_method(bus, "methodname", "busname",
1492
 
                               "objectpath", "interface")
1493
 
        expected_method_return = {"key1": {"key2": {"key3": True}}}
1494
 
        self.assertEqual(expected_method_return, ret)
1495
 
        self.assertIsInstance(ret, dict)
1496
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1497
 
        self.assertIsInstance(ret["key1"], dict)
1498
 
        self.assertNotIsInstance(ret["key1"],
1499
 
                                 mock_dbus_python.Dictionary)
1500
 
        self.assertIsInstance(ret["key1"]["key2"], dict)
1501
 
        self.assertNotIsInstance(ret["key1"]["key2"],
1502
 
                                 mock_dbus_python.Dictionary)
1503
 
        self.assertTrue(ret["key1"]["key2"]["key3"])
1504
 
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1505
 
                                 mock_dbus_python.Boolean)
1506
 
 
1507
 
    def test_call_method_handles_exception(self):
 
1073
                self.check_option_syntax(options)
 
1074
 
 
1075
 
 
1076
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
 
1077
    def test_calls_and_returns_get_object_on_bus(self):
 
1078
        class MockBus(object):
 
1079
            called = False
 
1080
            def get_object(mockbus_self, busname, dbus_path):
 
1081
                # Note that "self" is still the testcase instance,
 
1082
                # this MockBus instance is in "mockbus_self".
 
1083
                self.assertEqual(dbus_busname, busname)
 
1084
                self.assertEqual(server_dbus_path, dbus_path)
 
1085
                mockbus_self.called = True
 
1086
                return mockbus_self
 
1087
 
 
1088
        mockbus = get_mandos_dbus_object(bus=MockBus())
 
1089
        self.assertIsInstance(mockbus, MockBus)
 
1090
        self.assertTrue(mockbus.called)
 
1091
 
 
1092
    def test_logs_and_exits_on_dbus_error(self):
 
1093
        class FailingBusStub(object):
 
1094
            def get_object(self, busname, dbus_path):
 
1095
                raise dbus.exceptions.DBusException("Test")
 
1096
 
 
1097
        with self.assertLogs(log, logging.CRITICAL):
 
1098
            with self.assertRaises(SystemExit) as e:
 
1099
                bus = get_mandos_dbus_object(bus=FailingBusStub())
 
1100
 
 
1101
        if isinstance(e.exception.code, int):
 
1102
            self.assertNotEqual(0, e.exception.code)
 
1103
        else:
 
1104
            self.assertIsNotNone(e.exception.code)
 
1105
 
 
1106
 
 
1107
class Test_get_managed_objects(TestCaseWithAssertLogs):
 
1108
    def test_calls_and_returns_GetManagedObjects(self):
 
1109
        managed_objects = {"/clients/client": { "Name": "client"}}
 
1110
        class ObjectManagerStub(object):
 
1111
            def GetManagedObjects(self):
 
1112
                return managed_objects
 
1113
        retval = get_managed_objects(ObjectManagerStub())
 
1114
        self.assertDictEqual(managed_objects, retval)
 
1115
 
 
1116
    def test_logs_and_exits_on_dbus_error(self):
1508
1117
        dbus_logger = logging.getLogger("dbus.proxies")
1509
1118
 
1510
 
        def func():
1511
 
            dbus_logger.error("Test")
1512
 
            raise mock_dbus_python.exceptions.DBusException()
1513
 
 
1514
 
        mock_dbus_python = self.MockDBusPython_func(func)
1515
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1119
        class ObjectManagerFailingStub(object):
 
1120
            def GetManagedObjects(self):
 
1121
                dbus_logger.error("Test")
 
1122
                raise dbus.exceptions.DBusException("Test")
1516
1123
 
1517
1124
        class CountingHandler(logging.Handler):
1518
1125
            count = 0
1524
1131
        dbus_logger.addHandler(counting_handler)
1525
1132
 
1526
1133
        try:
1527
 
            with self.assertRaises(dbus.Error) as e:
1528
 
                self.call_method(bus, "methodname", "busname",
1529
 
                                 "objectpath", "interface")
 
1134
            with self.assertLogs(log, logging.CRITICAL) as watcher:
 
1135
                with self.assertRaises(SystemExit) as e:
 
1136
                    get_managed_objects(ObjectManagerFailingStub())
1530
1137
        finally:
1531
1138
            dbus_logger.removeFilter(counting_handler)
1532
1139
 
1533
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1534
 
 
1535
1140
        # Make sure the dbus logger was suppressed
1536
1141
        self.assertEqual(0, counting_handler.count)
1537
1142
 
1538
 
    def test_Set_Secret_sends_bytearray(self):
1539
 
        ret = [None]
1540
 
        def func(*args, **kwargs):
1541
 
            ret[0] = (args, kwargs)
1542
 
        mock_dbus_python = self.MockDBusPython_func(func)
1543
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1544
 
        bus.set_client_property("objectpath", "Secret", "value")
1545
 
        expected_call = (("se.recompile.Mandos.Client", "Secret",
1546
 
                          mock_dbus_python.ByteArray(b"value")),
1547
 
                         {"dbus_interface":
1548
 
                          "org.freedesktop.DBus.Properties"})
1549
 
        self.assertEqual(expected_call, ret[0])
1550
 
        if sys.version_info.major == 2:
1551
 
            self.assertIsInstance(ret[0][0][-1],
1552
 
                                  mock_dbus_python.ByteArray)
1553
 
 
1554
 
    def test_get_object_converts_to_correct_exception(self):
1555
 
        bus = dbus_python_adapter.SystemBus(
1556
 
            self.fake_dbus_python_raises_exception_on_connect)
1557
 
        with self.assertRaises(dbus.ConnectFailed):
1558
 
            self.call_method(bus, "methodname", "busname",
1559
 
                             "objectpath", "interface")
1560
 
 
1561
 
    class fake_dbus_python_raises_exception_on_connect:
1562
 
        """fake dbus-python module"""
1563
 
        class exceptions:
1564
 
            """Pseudo-namespace"""
1565
 
            class DBusException(Exception):
1566
 
                pass
1567
 
 
1568
 
        @classmethod
1569
 
        def SystemBus(cls):
1570
 
            def get_object(busname, objectpath):
1571
 
                raise cls.exceptions.DBusException()
1572
 
            Bus = collections.namedtuple("Bus", ["get_object"])
1573
 
            return Bus(get_object=get_object)
1574
 
 
1575
 
 
1576
 
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1577
 
    class mock_dbus_python:
1578
 
        """mock dbus-python modules"""
1579
 
        class SystemBus:
1580
 
            @staticmethod
1581
 
            def get_object(busname, objectpath):
1582
 
                return Unique()
1583
 
 
1584
 
    def setUp(self):
1585
 
        self.bus = dbus_python_adapter.CachingBus(
1586
 
            self.mock_dbus_python)
1587
 
 
1588
 
    def test_returns_distinct_objectpaths(self):
1589
 
        obj1 = self.bus.get_object("busname", "objectpath1")
1590
 
        self.assertIsInstance(obj1, Unique)
1591
 
        obj2 = self.bus.get_object("busname", "objectpath2")
1592
 
        self.assertIsInstance(obj2, Unique)
1593
 
        self.assertIsNot(obj1, obj2)
1594
 
 
1595
 
    def test_returns_distinct_busnames(self):
1596
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1597
 
        self.assertIsInstance(obj1, Unique)
1598
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1599
 
        self.assertIsInstance(obj2, Unique)
1600
 
        self.assertIsNot(obj1, obj2)
1601
 
 
1602
 
    def test_returns_distinct_both(self):
1603
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1604
 
        self.assertIsInstance(obj1, Unique)
1605
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1606
 
        self.assertIsInstance(obj2, Unique)
1607
 
        self.assertIsNot(obj1, obj2)
1608
 
 
1609
 
    def test_returns_same(self):
1610
 
        obj1 = self.bus.get_object("busname", "objectpath")
1611
 
        self.assertIsInstance(obj1, Unique)
1612
 
        obj2 = self.bus.get_object("busname", "objectpath")
1613
 
        self.assertIsInstance(obj2, Unique)
1614
 
        self.assertIs(obj1, obj2)
1615
 
 
1616
 
    def test_returns_same_old(self):
1617
 
        obj1 = self.bus.get_object("busname1", "objectpath1")
1618
 
        self.assertIsInstance(obj1, Unique)
1619
 
        obj2 = self.bus.get_object("busname2", "objectpath2")
1620
 
        self.assertIsInstance(obj2, Unique)
1621
 
        obj1b = self.bus.get_object("busname1", "objectpath1")
1622
 
        self.assertIsInstance(obj1b, Unique)
1623
 
        self.assertIsNot(obj1, obj2)
1624
 
        self.assertIsNot(obj2, obj1b)
1625
 
        self.assertIs(obj1, obj1b)
1626
 
 
1627
 
 
1628
 
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1629
 
 
1630
 
    def Stub_pydbus_func(self, func):
1631
 
        class stub_pydbus:
1632
 
            """stub pydbus module"""
1633
 
            class SystemBus:
1634
 
                @staticmethod
1635
 
                def get(busname, objectpath):
1636
 
                    DBusObject = collections.namedtuple(
1637
 
                        "DBusObject", ("methodname",))
1638
 
                    return {"interface":
1639
 
                            DBusObject(methodname=func)}
1640
 
        return stub_pydbus
1641
 
 
1642
 
    def call_method(self, bus, methodname, busname, objectpath,
1643
 
                    interface, *args):
1644
 
        with self.assertLogs(log, logging.DEBUG):
1645
 
            return bus.call_method(methodname, busname, objectpath,
1646
 
                                   interface, *args)
1647
 
 
1648
 
    def test_call_method_returns(self):
1649
 
        expected_method_return = Unique()
1650
 
        method_args = (Unique(), Unique())
1651
 
        def func(*args):
1652
 
            self.assertEqual(len(method_args), len(args))
1653
 
            for marg, arg in zip(method_args, args):
1654
 
                self.assertIs(marg, arg)
1655
 
            return expected_method_return
1656
 
        stub_pydbus = self.Stub_pydbus_func(func)
1657
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1658
 
        ret = self.call_method(bus, "methodname", "busname",
1659
 
                               "objectpath", "interface",
1660
 
                               *method_args)
1661
 
        self.assertIs(ret, expected_method_return)
1662
 
 
1663
 
    def test_call_method_handles_exception(self):
1664
 
        dbus_logger = logging.getLogger("dbus.proxies")
1665
 
 
1666
 
        def func():
1667
 
            raise gi.repository.GLib.Error()
1668
 
 
1669
 
        stub_pydbus = self.Stub_pydbus_func(func)
1670
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1671
 
 
1672
 
        with self.assertRaises(dbus.Error) as e:
1673
 
            self.call_method(bus, "methodname", "busname",
1674
 
                             "objectpath", "interface")
1675
 
 
1676
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1677
 
 
1678
 
    def test_get_converts_to_correct_exception(self):
1679
 
        bus = pydbus_adapter.SystemBus(
1680
 
            self.fake_pydbus_raises_exception_on_connect)
1681
 
        with self.assertRaises(dbus.ConnectFailed):
1682
 
            self.call_method(bus, "methodname", "busname",
1683
 
                             "objectpath", "interface")
1684
 
 
1685
 
    class fake_pydbus_raises_exception_on_connect:
1686
 
        """fake dbus-python module"""
1687
 
        @classmethod
1688
 
        def SystemBus(cls):
1689
 
            def get(busname, objectpath):
1690
 
                raise gi.repository.GLib.Error()
1691
 
            Bus = collections.namedtuple("Bus", ["get"])
1692
 
            return Bus(get=get)
1693
 
 
1694
 
    def test_set_property_uses_setattr(self):
1695
 
        class Object:
1696
 
            pass
1697
 
        obj = Object()
1698
 
        class pydbus_spy:
1699
 
            class SystemBus:
1700
 
                @staticmethod
1701
 
                def get(busname, objectpath):
1702
 
                    return {"interface": obj}
1703
 
        bus = pydbus_adapter.SystemBus(pydbus_spy)
1704
 
        value = Unique()
1705
 
        bus.set_property("busname", "objectpath", "interface", "key",
1706
 
                         value)
1707
 
        self.assertIs(value, obj.key)
1708
 
 
1709
 
    def test_get_suppresses_xml_deprecation_warning(self):
1710
 
        if sys.version_info.major >= 3:
1711
 
            return
1712
 
        class stub_pydbus_get:
1713
 
            class SystemBus:
1714
 
                @staticmethod
1715
 
                def get(busname, objectpath):
1716
 
                    warnings.warn_explicit(
1717
 
                        "deprecated", DeprecationWarning,
1718
 
                        "xml.etree.ElementTree", 0)
1719
 
        bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1720
 
        with warnings.catch_warnings(record=True) as w:
1721
 
            warnings.simplefilter("always")
1722
 
            bus.get("busname", "objectpath")
1723
 
            self.assertEqual(0, len(w))
1724
 
 
1725
 
 
1726
 
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1727
 
    class stub_pydbus:
1728
 
        """stub pydbus module"""
1729
 
        class SystemBus:
1730
 
            @staticmethod
1731
 
            def get(busname, objectpath):
1732
 
                return Unique()
1733
 
 
1734
 
    def setUp(self):
1735
 
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1736
 
 
1737
 
    def test_returns_distinct_objectpaths(self):
1738
 
        obj1 = self.bus.get("busname", "objectpath1")
1739
 
        self.assertIsInstance(obj1, Unique)
1740
 
        obj2 = self.bus.get("busname", "objectpath2")
1741
 
        self.assertIsInstance(obj2, Unique)
1742
 
        self.assertIsNot(obj1, obj2)
1743
 
 
1744
 
    def test_returns_distinct_busnames(self):
1745
 
        obj1 = self.bus.get("busname1", "objectpath")
1746
 
        self.assertIsInstance(obj1, Unique)
1747
 
        obj2 = self.bus.get("busname2", "objectpath")
1748
 
        self.assertIsInstance(obj2, Unique)
1749
 
        self.assertIsNot(obj1, obj2)
1750
 
 
1751
 
    def test_returns_distinct_both(self):
1752
 
        obj1 = self.bus.get("busname1", "objectpath")
1753
 
        self.assertIsInstance(obj1, Unique)
1754
 
        obj2 = self.bus.get("busname2", "objectpath")
1755
 
        self.assertIsInstance(obj2, Unique)
1756
 
        self.assertIsNot(obj1, obj2)
1757
 
 
1758
 
    def test_returns_same(self):
1759
 
        obj1 = self.bus.get("busname", "objectpath")
1760
 
        self.assertIsInstance(obj1, Unique)
1761
 
        obj2 = self.bus.get("busname", "objectpath")
1762
 
        self.assertIsInstance(obj2, Unique)
1763
 
        self.assertIs(obj1, obj2)
1764
 
 
1765
 
    def test_returns_same_old(self):
1766
 
        obj1 = self.bus.get("busname1", "objectpath1")
1767
 
        self.assertIsInstance(obj1, Unique)
1768
 
        obj2 = self.bus.get("busname2", "objectpath2")
1769
 
        self.assertIsInstance(obj2, Unique)
1770
 
        obj1b = self.bus.get("busname1", "objectpath1")
1771
 
        self.assertIsInstance(obj1b, Unique)
1772
 
        self.assertIsNot(obj1, obj2)
1773
 
        self.assertIsNot(obj2, obj1b)
1774
 
        self.assertIs(obj1, obj1b)
 
1143
        # Test that the dbus_logger still works
 
1144
        with self.assertLogs(dbus_logger, logging.ERROR):
 
1145
            dbus_logger.error("Test")
 
1146
 
 
1147
        if isinstance(e.exception.code, int):
 
1148
            self.assertNotEqual(0, e.exception.code)
 
1149
        else:
 
1150
            self.assertIsNotNone(e.exception.code)
1775
1151
 
1776
1152
 
1777
1153
class Test_commands_from_options(unittest.TestCase):
1778
 
 
1779
1154
    def setUp(self):
1780
1155
        self.parser = argparse.ArgumentParser()
1781
1156
        add_command_line_options(self.parser)
1784
1159
        self.assert_command_from_args(["--is-enabled", "client"],
1785
1160
                                      command.IsEnabled)
1786
1161
 
1787
 
    def assert_command_from_args(self, args, command_cls, length=1,
1788
 
                                 clients=None, **cmd_attrs):
 
1162
    def assert_command_from_args(self, args, command_cls,
 
1163
                                 **cmd_attrs):
1789
1164
        """Assert that parsing ARGS should result in an instance of
1790
1165
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1791
1166
        options = self.parser.parse_args(args)
1792
1167
        check_option_syntax(self.parser, options)
1793
1168
        commands = commands_from_options(options)
1794
 
        self.assertEqual(length, len(commands))
1795
 
        for command in commands:
1796
 
            if isinstance(command, command_cls):
1797
 
                break
1798
 
        else:
1799
 
            self.assertIsInstance(command, command_cls)
1800
 
        if clients is not None:
1801
 
            self.assertEqual(clients, options.client)
 
1169
        self.assertEqual(1, len(commands))
 
1170
        command = commands[0]
 
1171
        self.assertIsInstance(command, command_cls)
1802
1172
        for key, value in cmd_attrs.items():
1803
1173
            self.assertEqual(value, getattr(command, key))
1804
1174
 
1805
 
    def assert_commands_from_args(self, args, commands, clients=None):
1806
 
        for cmd in commands:
1807
 
            self.assert_command_from_args(args, cmd,
1808
 
                                          length=len(commands),
1809
 
                                          clients=clients)
1810
 
 
1811
1175
    def test_is_enabled_short(self):
1812
1176
        self.assert_command_from_args(["-V", "client"],
1813
1177
                                      command.IsEnabled)
2004
1368
                                      verbose=True)
2005
1369
 
2006
1370
 
2007
 
    def test_manual_page_example_1(self):
2008
 
        self.assert_command_from_args("",
2009
 
                                      command.PrintTable,
2010
 
                                      clients=[],
2011
 
                                      verbose=False)
2012
 
 
2013
 
    def test_manual_page_example_2(self):
2014
 
        self.assert_command_from_args(
2015
 
            "--verbose foo1.example.org foo2.example.org".split(),
2016
 
            command.PrintTable, clients=["foo1.example.org",
2017
 
                                         "foo2.example.org"],
2018
 
            verbose=True)
2019
 
 
2020
 
    def test_manual_page_example_3(self):
2021
 
        self.assert_command_from_args("--enable --all".split(),
2022
 
                                      command.Enable,
2023
 
                                      clients=[])
2024
 
 
2025
 
    def test_manual_page_example_4(self):
2026
 
        self.assert_commands_from_args(
2027
 
            ("--timeout=PT5M --interval=PT1M foo1.example.org"
2028
 
             " foo2.example.org").split(),
2029
 
            [command.SetTimeout, command.SetInterval],
2030
 
            clients=["foo1.example.org", "foo2.example.org"])
2031
 
 
2032
 
    def test_manual_page_example_5(self):
2033
 
        self.assert_command_from_args("--approve --all".split(),
2034
 
                                      command.Approve,
2035
 
                                      clients=[])
2036
 
 
2037
 
 
2038
1371
class TestCommand(unittest.TestCase):
2039
1372
    """Abstract class for tests of command classes"""
2040
1373
 
2041
 
    class FakeMandosBus(dbus.MandosBus):
2042
 
        def __init__(self, testcase):
2043
 
            self.client_properties = {
2044
 
                "Name": "foo",
2045
 
                "KeyID": ("92ed150794387c03ce684574b1139a65"
2046
 
                          "94a34f895daaaf09fd8ea90a27cddb12"),
2047
 
                "Secret": b"secret",
2048
 
                "Host": "foo.example.org",
2049
 
                "Enabled": True,
2050
 
                "Timeout": 300000,
2051
 
                "LastCheckedOK": "2019-02-03T00:00:00",
2052
 
                "Created": "2019-01-02T00:00:00",
2053
 
                "Interval": 120000,
2054
 
                "Fingerprint": ("778827225BA7DE539C5A"
2055
 
                                "7CFA59CFF7CDBD9A5920"),
2056
 
                "CheckerRunning": False,
2057
 
                "LastEnabled": "2019-01-03T00:00:00",
2058
 
                "ApprovalPending": False,
2059
 
                "ApprovedByDefault": True,
2060
 
                "LastApprovalRequest": "",
2061
 
                "ApprovalDelay": 0,
2062
 
                "ApprovalDuration": 1000,
2063
 
                "Checker": "fping -q -- %(host)s",
2064
 
                "ExtendedTimeout": 900000,
2065
 
                "Expires": "2019-02-04T00:00:00",
2066
 
                "LastCheckerStatus": 0,
2067
 
            }
2068
 
            self.other_client_properties = {
2069
 
                "Name": "barbar",
2070
 
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
2071
 
                          "6ab612cff5ad227247e46c2b020f441c"),
2072
 
                "Secret": b"secretbar",
2073
 
                "Host": "192.0.2.3",
2074
 
                "Enabled": True,
2075
 
                "Timeout": 300000,
2076
 
                "LastCheckedOK": "2019-02-04T00:00:00",
2077
 
                "Created": "2019-01-03T00:00:00",
2078
 
                "Interval": 120000,
2079
 
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
2080
 
                                "F547B3A107558FCA3A27"),
2081
 
                "CheckerRunning": True,
2082
 
                "LastEnabled": "2019-01-04T00:00:00",
2083
 
                "ApprovalPending": False,
2084
 
                "ApprovedByDefault": False,
2085
 
                "LastApprovalRequest": "2019-01-03T00:00:00",
2086
 
                "ApprovalDelay": 30000,
2087
 
                "ApprovalDuration": 93785000,
2088
 
                "Checker": ":",
2089
 
                "ExtendedTimeout": 900000,
2090
 
                "Expires": "2019-02-05T00:00:00",
2091
 
                "LastCheckerStatus": -2,
2092
 
            }
2093
 
            self.clients =  collections.OrderedDict(
2094
 
                [
2095
 
                    ("client_objectpath", self.client_properties),
2096
 
                    ("other_client_objectpath",
2097
 
                     self.other_client_properties),
2098
 
                ])
2099
 
            self.one_client = {"client_objectpath":
2100
 
                               self.client_properties}
2101
 
            self.testcase = testcase
2102
 
            self.calls = []
2103
 
 
2104
 
        def call_method(self, methodname, busname, objectpath,
2105
 
                        interface, *args):
2106
 
            self.testcase.assertEqual("se.recompile.Mandos", busname)
2107
 
            self.calls.append((methodname, busname, objectpath,
2108
 
                               interface, args))
2109
 
            if interface == "org.freedesktop.DBus.Properties":
2110
 
                if methodname == "Set":
2111
 
                    self.testcase.assertEqual(3, len(args))
2112
 
                    interface, key, value = args
2113
 
                    self.testcase.assertEqual(
2114
 
                        "se.recompile.Mandos.Client", interface)
2115
 
                    self.clients[objectpath][key] = value
2116
 
                    return
2117
 
            elif interface == "se.recompile.Mandos":
2118
 
                self.testcase.assertEqual("RemoveClient", methodname)
2119
 
                self.testcase.assertEqual(1, len(args))
2120
 
                clientpath = args[0]
2121
 
                del self.clients[clientpath]
2122
 
                return
2123
 
            elif interface == "se.recompile.Mandos.Client":
2124
 
                if methodname == "Approve":
2125
 
                    self.testcase.assertEqual(1, len(args))
2126
 
                    return
2127
 
            raise ValueError()
2128
 
 
2129
1374
    def setUp(self):
2130
 
        self.bus = self.FakeMandosBus(self)
 
1375
        testcase = self
 
1376
        class MockClient(object):
 
1377
            def __init__(self, name, **attributes):
 
1378
                self.__dbus_object_path__ = "/clients/{}".format(name)
 
1379
                self.attributes = attributes
 
1380
                self.attributes["Name"] = name
 
1381
                self.calls = []
 
1382
            def Set(self, interface, propname, value, dbus_interface):
 
1383
                testcase.assertEqual(client_dbus_interface, interface)
 
1384
                testcase.assertEqual(dbus.PROPERTIES_IFACE,
 
1385
                                     dbus_interface)
 
1386
                self.attributes[propname] = value
 
1387
            def Approve(self, approve, dbus_interface):
 
1388
                testcase.assertEqual(client_dbus_interface,
 
1389
                                     dbus_interface)
 
1390
                self.calls.append(("Approve", (approve,
 
1391
                                               dbus_interface)))
 
1392
        self.client = MockClient(
 
1393
            "foo",
 
1394
            KeyID=("92ed150794387c03ce684574b1139a65"
 
1395
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
1396
            Secret=b"secret",
 
1397
            Host="foo.example.org",
 
1398
            Enabled=dbus.Boolean(True),
 
1399
            Timeout=300000,
 
1400
            LastCheckedOK="2019-02-03T00:00:00",
 
1401
            Created="2019-01-02T00:00:00",
 
1402
            Interval=120000,
 
1403
            Fingerprint=("778827225BA7DE539C5A"
 
1404
                         "7CFA59CFF7CDBD9A5920"),
 
1405
            CheckerRunning=dbus.Boolean(False),
 
1406
            LastEnabled="2019-01-03T00:00:00",
 
1407
            ApprovalPending=dbus.Boolean(False),
 
1408
            ApprovedByDefault=dbus.Boolean(True),
 
1409
            LastApprovalRequest="",
 
1410
            ApprovalDelay=0,
 
1411
            ApprovalDuration=1000,
 
1412
            Checker="fping -q -- %(host)s",
 
1413
            ExtendedTimeout=900000,
 
1414
            Expires="2019-02-04T00:00:00",
 
1415
            LastCheckerStatus=0)
 
1416
        self.other_client = MockClient(
 
1417
            "barbar",
 
1418
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
1419
                   "6ab612cff5ad227247e46c2b020f441c"),
 
1420
            Secret=b"secretbar",
 
1421
            Host="192.0.2.3",
 
1422
            Enabled=dbus.Boolean(True),
 
1423
            Timeout=300000,
 
1424
            LastCheckedOK="2019-02-04T00:00:00",
 
1425
            Created="2019-01-03T00:00:00",
 
1426
            Interval=120000,
 
1427
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
1428
                         "F547B3A107558FCA3A27"),
 
1429
            CheckerRunning=dbus.Boolean(True),
 
1430
            LastEnabled="2019-01-04T00:00:00",
 
1431
            ApprovalPending=dbus.Boolean(False),
 
1432
            ApprovedByDefault=dbus.Boolean(False),
 
1433
            LastApprovalRequest="2019-01-03T00:00:00",
 
1434
            ApprovalDelay=30000,
 
1435
            ApprovalDuration=93785000,
 
1436
            Checker=":",
 
1437
            ExtendedTimeout=900000,
 
1438
            Expires="2019-02-05T00:00:00",
 
1439
            LastCheckerStatus=-2)
 
1440
        self.clients =  collections.OrderedDict(
 
1441
            [
 
1442
                (self.client.__dbus_object_path__,
 
1443
                 self.client.attributes),
 
1444
                (self.other_client.__dbus_object_path__,
 
1445
                 self.other_client.attributes),
 
1446
            ])
 
1447
        self.one_client = {self.client.__dbus_object_path__:
 
1448
                           self.client.attributes}
 
1449
 
 
1450
    @property
 
1451
    def bus(self):
 
1452
        class MockBus(object):
 
1453
            @staticmethod
 
1454
            def get_object(client_bus_name, path):
 
1455
                self.assertEqual(dbus_busname, client_bus_name)
 
1456
                # Note: "self" here is the TestCmd instance, not the
 
1457
                # MockBus instance, since this is a static method!
 
1458
                if path == self.client.__dbus_object_path__:
 
1459
                    return self.client
 
1460
                elif path == self.other_client.__dbus_object_path__:
 
1461
                    return self.other_client
 
1462
        return MockBus()
2131
1463
 
2132
1464
 
2133
1465
class TestBaseCommands(TestCommand):
2134
1466
 
2135
1467
    def test_IsEnabled_exits_successfully(self):
2136
1468
        with self.assertRaises(SystemExit) as e:
2137
 
            command.IsEnabled().run(self.bus.one_client)
 
1469
            command.IsEnabled().run(self.one_client)
2138
1470
        if e.exception.code is not None:
2139
1471
            self.assertEqual(0, e.exception.code)
2140
1472
        else:
2141
1473
            self.assertIsNone(e.exception.code)
2142
1474
 
2143
1475
    def test_IsEnabled_exits_with_failure(self):
2144
 
        self.bus.client_properties["Enabled"] = False
 
1476
        self.client.attributes["Enabled"] = dbus.Boolean(False)
2145
1477
        with self.assertRaises(SystemExit) as e:
2146
 
            command.IsEnabled().run(self.bus.one_client)
 
1478
            command.IsEnabled().run(self.one_client)
2147
1479
        if isinstance(e.exception.code, int):
2148
1480
            self.assertNotEqual(0, e.exception.code)
2149
1481
        else:
2150
1482
            self.assertIsNotNone(e.exception.code)
2151
1483
 
2152
1484
    def test_Approve(self):
2153
 
        busname = "se.recompile.Mandos"
2154
 
        client_interface = "se.recompile.Mandos.Client"
2155
 
        command.Approve().run(self.bus.clients, self.bus)
2156
 
        for clientpath in self.bus.clients:
2157
 
            self.assertIn(("Approve", busname, clientpath,
2158
 
                           client_interface, (True,)), self.bus.calls)
 
1485
        command.Approve().run(self.clients, self.bus)
 
1486
        for clientpath in self.clients:
 
1487
            client = self.bus.get_object(dbus_busname, clientpath)
 
1488
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1489
                          client.calls)
2159
1490
 
2160
1491
    def test_Deny(self):
2161
 
        busname = "se.recompile.Mandos"
2162
 
        client_interface = "se.recompile.Mandos.Client"
2163
 
        command.Deny().run(self.bus.clients, self.bus)
2164
 
        for clientpath in self.bus.clients:
2165
 
            self.assertIn(("Approve", busname, clientpath,
2166
 
                           client_interface, (False,)),
2167
 
                          self.bus.calls)
 
1492
        command.Deny().run(self.clients, self.bus)
 
1493
        for clientpath in self.clients:
 
1494
            client = self.bus.get_object(dbus_busname, clientpath)
 
1495
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1496
                          client.calls)
2168
1497
 
2169
1498
    def test_Remove(self):
2170
 
        command.Remove().run(self.bus.clients, self.bus)
2171
 
        for clientpath in self.bus.clients:
2172
 
            self.assertIn(("RemoveClient", dbus_busname,
2173
 
                           dbus_server_path, dbus_server_interface,
2174
 
                           (clientpath,)), self.bus.calls)
 
1499
        class MandosSpy(object):
 
1500
            def __init__(self):
 
1501
                self.calls = []
 
1502
            def RemoveClient(self, dbus_path):
 
1503
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1504
        mandos = MandosSpy()
 
1505
        command.Remove().run(self.clients, self.bus, mandos)
 
1506
        for clientpath in self.clients:
 
1507
            self.assertIn(("RemoveClient", (clientpath,)),
 
1508
                          mandos.calls)
2175
1509
 
2176
1510
    expected_json = {
2177
1511
        "foo": {
2226
1560
 
2227
1561
    def test_DumpJSON_normal(self):
2228
1562
        with self.capture_stdout_to_buffer() as buffer:
2229
 
            command.DumpJSON().run(self.bus.clients)
 
1563
            command.DumpJSON().run(self.clients)
2230
1564
        json_data = json.loads(buffer.getvalue())
2231
1565
        self.assertDictEqual(self.expected_json, json_data)
2232
1566
 
2243
1577
 
2244
1578
    def test_DumpJSON_one_client(self):
2245
1579
        with self.capture_stdout_to_buffer() as buffer:
2246
 
            command.DumpJSON().run(self.bus.one_client)
 
1580
            command.DumpJSON().run(self.one_client)
2247
1581
        json_data = json.loads(buffer.getvalue())
2248
1582
        expected_json = {"foo": self.expected_json["foo"]}
2249
1583
        self.assertDictEqual(expected_json, json_data)
2250
1584
 
2251
1585
    def test_PrintTable_normal(self):
2252
1586
        with self.capture_stdout_to_buffer() as buffer:
2253
 
            command.PrintTable().run(self.bus.clients)
 
1587
            command.PrintTable().run(self.clients)
2254
1588
        expected_output = "\n".join((
2255
1589
            "Name   Enabled Timeout  Last Successful Check",
2256
1590
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
2260
1594
 
2261
1595
    def test_PrintTable_verbose(self):
2262
1596
        with self.capture_stdout_to_buffer() as buffer:
2263
 
            command.PrintTable(verbose=True).run(self.bus.clients)
 
1597
            command.PrintTable(verbose=True).run(self.clients)
2264
1598
        columns = (
2265
1599
            (
2266
1600
                "Name   ",
2356
1690
 
2357
1691
    def test_PrintTable_one_client(self):
2358
1692
        with self.capture_stdout_to_buffer() as buffer:
2359
 
            command.PrintTable().run(self.bus.one_client)
 
1693
            command.PrintTable().run(self.one_client)
2360
1694
        expected_output = "\n".join((
2361
1695
            "Name Enabled Timeout  Last Successful Check",
2362
1696
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
2366
1700
 
2367
1701
class TestPropertySetterCmd(TestCommand):
2368
1702
    """Abstract class for tests of command.PropertySetter classes"""
2369
 
 
2370
1703
    def runTest(self):
2371
1704
        if not hasattr(self, "command"):
2372
 
            return              # Abstract TestCase class
2373
 
 
2374
 
        if hasattr(self, "values_to_set"):
2375
 
            cmd_args = [(value,) for value in self.values_to_set]
2376
 
            values_to_get = getattr(self, "values_to_get",
2377
 
                                    self.values_to_set)
2378
 
        else:
2379
 
            cmd_args = [() for x in range(len(self.values_to_get))]
2380
 
            values_to_get = self.values_to_get
2381
 
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2382
 
            for clientpath in self.bus.clients:
2383
 
                self.bus.clients[clientpath][self.propname] = (
2384
 
                    Unique())
2385
 
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
2386
 
            for clientpath in self.bus.clients:
2387
 
                value = (self.bus.clients[clientpath]
2388
 
                         [self.propname])
2389
 
                self.assertNotIsInstance(value, Unique)
 
1705
            return
 
1706
        values_to_get = getattr(self, "values_to_get",
 
1707
                                self.values_to_set)
 
1708
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1709
                                              values_to_get):
 
1710
            for clientpath in self.clients:
 
1711
                client = self.bus.get_object(dbus_busname, clientpath)
 
1712
                old_value = client.attributes[self.propname]
 
1713
                client.attributes[self.propname] = self.Unique()
 
1714
            self.run_command(value_to_set, self.clients)
 
1715
            for clientpath in self.clients:
 
1716
                client = self.bus.get_object(dbus_busname, clientpath)
 
1717
                value = client.attributes[self.propname]
 
1718
                self.assertNotIsInstance(value, self.Unique)
2390
1719
                self.assertEqual(value_to_get, value)
2391
1720
 
 
1721
    class Unique(object):
 
1722
        """Class for objects which exist only to be unique objects,
 
1723
since unittest.mock.sentinel only exists in Python 3.3"""
 
1724
 
 
1725
    def run_command(self, value, clients):
 
1726
        self.command().run(clients, self.bus)
 
1727
 
2392
1728
 
2393
1729
class TestEnableCmd(TestPropertySetterCmd):
2394
1730
    command = command.Enable
2395
1731
    propname = "Enabled"
2396
 
    values_to_get = [True]
 
1732
    values_to_set = [dbus.Boolean(True)]
2397
1733
 
2398
1734
 
2399
1735
class TestDisableCmd(TestPropertySetterCmd):
2400
1736
    command = command.Disable
2401
1737
    propname = "Enabled"
2402
 
    values_to_get = [False]
 
1738
    values_to_set = [dbus.Boolean(False)]
2403
1739
 
2404
1740
 
2405
1741
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2406
1742
    command = command.BumpTimeout
2407
1743
    propname = "LastCheckedOK"
2408
 
    values_to_get = [""]
 
1744
    values_to_set = [""]
2409
1745
 
2410
1746
 
2411
1747
class TestStartCheckerCmd(TestPropertySetterCmd):
2412
1748
    command = command.StartChecker
2413
1749
    propname = "CheckerRunning"
2414
 
    values_to_get = [True]
 
1750
    values_to_set = [dbus.Boolean(True)]
2415
1751
 
2416
1752
 
2417
1753
class TestStopCheckerCmd(TestPropertySetterCmd):
2418
1754
    command = command.StopChecker
2419
1755
    propname = "CheckerRunning"
2420
 
    values_to_get = [False]
 
1756
    values_to_set = [dbus.Boolean(False)]
2421
1757
 
2422
1758
 
2423
1759
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2424
1760
    command = command.ApproveByDefault
2425
1761
    propname = "ApprovedByDefault"
2426
 
    values_to_get = [True]
 
1762
    values_to_set = [dbus.Boolean(True)]
2427
1763
 
2428
1764
 
2429
1765
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2430
1766
    command = command.DenyByDefault
2431
1767
    propname = "ApprovedByDefault"
2432
 
    values_to_get = [False]
2433
 
 
2434
 
 
2435
 
class TestSetCheckerCmd(TestPropertySetterCmd):
 
1768
    values_to_set = [dbus.Boolean(False)]
 
1769
 
 
1770
 
 
1771
class TestPropertySetterValueCmd(TestPropertySetterCmd):
 
1772
    """Abstract class for tests of PropertySetterValueCmd classes"""
 
1773
 
 
1774
    def runTest(self):
 
1775
        if type(self) is TestPropertySetterValueCmd:
 
1776
            return
 
1777
        return super(TestPropertySetterValueCmd, self).runTest()
 
1778
 
 
1779
    def run_command(self, value, clients):
 
1780
        self.command(value).run(clients, self.bus)
 
1781
 
 
1782
 
 
1783
class TestSetCheckerCmd(TestPropertySetterValueCmd):
2436
1784
    command = command.SetChecker
2437
1785
    propname = "Checker"
2438
1786
    values_to_set = ["", ":", "fping -q -- %s"]
2439
1787
 
2440
1788
 
2441
 
class TestSetHostCmd(TestPropertySetterCmd):
 
1789
class TestSetHostCmd(TestPropertySetterValueCmd):
2442
1790
    command = command.SetHost
2443
1791
    propname = "Host"
2444
1792
    values_to_set = ["192.0.2.3", "client.example.org"]
2445
1793
 
2446
1794
 
2447
 
class TestSetSecretCmd(TestPropertySetterCmd):
 
1795
class TestSetSecretCmd(TestPropertySetterValueCmd):
2448
1796
    command = command.SetSecret
2449
1797
    propname = "Secret"
2450
1798
    values_to_set = [io.BytesIO(b""),
2452
1800
    values_to_get = [f.getvalue() for f in values_to_set]
2453
1801
 
2454
1802
 
2455
 
class TestSetTimeoutCmd(TestPropertySetterCmd):
 
1803
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
2456
1804
    command = command.SetTimeout
2457
1805
    propname = "Timeout"
2458
1806
    values_to_set = [datetime.timedelta(),
2463
1811
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2464
1812
 
2465
1813
 
2466
 
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
 
1814
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
2467
1815
    command = command.SetExtendedTimeout
2468
1816
    propname = "ExtendedTimeout"
2469
1817
    values_to_set = [datetime.timedelta(),
2474
1822
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2475
1823
 
2476
1824
 
2477
 
class TestSetIntervalCmd(TestPropertySetterCmd):
 
1825
class TestSetIntervalCmd(TestPropertySetterValueCmd):
2478
1826
    command = command.SetInterval
2479
1827
    propname = "Interval"
2480
1828
    values_to_set = [datetime.timedelta(),
2485
1833
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2486
1834
 
2487
1835
 
2488
 
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
 
1836
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
2489
1837
    command = command.SetApprovalDelay
2490
1838
    propname = "ApprovalDelay"
2491
1839
    values_to_set = [datetime.timedelta(),
2496
1844
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2497
1845
 
2498
1846
 
2499
 
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
 
1847
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
2500
1848
    command = command.SetApprovalDuration
2501
1849
    propname = "ApprovalDuration"
2502
1850
    values_to_set = [datetime.timedelta(),