/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-17 17:34:07 UTC
  • Revision ID: teddy@recompile.se-20190317173407-itlj1a7mzfwb3yz3
mandos-ctl: Refactor tests

* mandos-ctl: Change all calls to assertEqual (and related functions
              assertNotEqual and assertDictEqual) to always pass
              arguments in (expected, actual) order, for consistency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
46
46
import tempfile
47
47
import contextlib
48
48
 
49
 
try:
50
 
    import pydbus
51
 
    import gi
52
 
    dbus_python = None
53
 
except ImportError:
54
 
    import dbus as dbus_python
55
 
    pydbus = None
56
 
    class gi(object):
57
 
        """Dummy gi module, for the tests"""
58
 
        class repository(object):
59
 
            class GLib(object):
60
 
                class Error(Exception):
61
 
                    pass
 
49
import dbus
62
50
 
63
51
# Show warnings by default
64
52
if not sys.warnoptions:
73
61
 
74
62
if sys.version_info.major == 2:
75
63
    str = unicode
76
 
    import StringIO
77
 
    io.StringIO = StringIO.StringIO
78
64
 
79
65
locale.setlocale(locale.LC_ALL, "")
80
66
 
 
67
dbus_busname_domain = "se.recompile"
 
68
dbus_busname = dbus_busname_domain + ".Mandos"
 
69
server_dbus_path = "/"
 
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
 
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
 
72
del dbus_busname_domain
81
73
version = "1.8.3"
82
74
 
83
75
 
 
76
try:
 
77
    dbus.OBJECT_MANAGER_IFACE
 
78
except AttributeError:
 
79
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
80
 
 
81
 
84
82
def main():
85
83
    parser = argparse.ArgumentParser()
 
84
 
86
85
    add_command_line_options(parser)
87
86
 
88
87
    options = parser.parse_args()
 
88
 
89
89
    check_option_syntax(parser, options)
90
90
 
91
91
    clientnames = options.client
93
93
    if options.debug:
94
94
        log.setLevel(logging.DEBUG)
95
95
 
96
 
    if pydbus is not None:
97
 
        bus = pydbus_adapter.CachingBus(pydbus)
98
 
    else:
99
 
        bus = dbus_python_adapter.CachingBus(dbus_python)
100
 
 
101
 
    try:
102
 
        all_clients = bus.get_clients_and_properties()
103
 
    except dbus.ConnectFailed as e:
104
 
        log.critical("Could not connect to Mandos server: %s", e)
105
 
        sys.exit(1)
106
 
    except dbus.Error as e:
107
 
        log.critical(
108
 
            "Failed to access Mandos server through D-Bus:\n%s", e)
109
 
        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
110
113
 
111
114
    # Compile dict of (clientpath: properties) to process
112
115
    if not clientnames:
125
128
    commands = commands_from_options(options)
126
129
 
127
130
    for command in commands:
128
 
        command.run(clients, bus)
 
131
        command.run(clients, bus, mandos_serv)
129
132
 
130
133
 
131
134
def add_command_line_options(parser):
136
139
                        help="Select all clients")
137
140
    parser.add_argument("-v", "--verbose", action="store_true",
138
141
                        help="Print all fields")
139
 
    parser.add_argument("-j", "--dump-json", dest="commands",
140
 
                        action="append_const", default=[],
141
 
                        const=command.DumpJSON(),
 
142
    parser.add_argument("-j", "--dump-json", action="store_true",
142
143
                        help="Dump client data in JSON format")
143
144
    enable_disable = parser.add_mutually_exclusive_group()
144
 
    enable_disable.add_argument("-e", "--enable", dest="commands",
145
 
                                action="append_const", default=[],
146
 
                                const=command.Enable(),
 
145
    enable_disable.add_argument("-e", "--enable", action="store_true",
147
146
                                help="Enable client")
148
 
    enable_disable.add_argument("-d", "--disable", dest="commands",
149
 
                                action="append_const", default=[],
150
 
                                const=command.Disable(),
 
147
    enable_disable.add_argument("-d", "--disable",
 
148
                                action="store_true",
151
149
                                help="disable client")
152
 
    parser.add_argument("-b", "--bump-timeout", dest="commands",
153
 
                        action="append_const", default=[],
154
 
                        const=command.BumpTimeout(),
 
150
    parser.add_argument("-b", "--bump-timeout", action="store_true",
155
151
                        help="Bump timeout for client")
156
152
    start_stop_checker = parser.add_mutually_exclusive_group()
157
153
    start_stop_checker.add_argument("--start-checker",
158
 
                                    dest="commands",
159
 
                                    action="append_const", default=[],
160
 
                                    const=command.StartChecker(),
 
154
                                    action="store_true",
161
155
                                    help="Start checker for client")
162
 
    start_stop_checker.add_argument("--stop-checker", dest="commands",
163
 
                                    action="append_const", default=[],
164
 
                                    const=command.StopChecker(),
 
156
    start_stop_checker.add_argument("--stop-checker",
 
157
                                    action="store_true",
165
158
                                    help="Stop checker for client")
166
 
    parser.add_argument("-V", "--is-enabled", dest="commands",
167
 
                        action="append_const", default=[],
168
 
                        const=command.IsEnabled(),
 
159
    parser.add_argument("-V", "--is-enabled", action="store_true",
169
160
                        help="Check if client is enabled")
170
 
    parser.add_argument("-r", "--remove", dest="commands",
171
 
                        action="append_const", default=[],
172
 
                        const=command.Remove(),
 
161
    parser.add_argument("-r", "--remove", action="store_true",
173
162
                        help="Remove client")
174
 
    parser.add_argument("-c", "--checker", dest="commands",
175
 
                        action="append", default=[],
176
 
                        metavar="COMMAND", type=command.SetChecker,
 
163
    parser.add_argument("-c", "--checker",
177
164
                        help="Set checker command for client")
178
 
    parser.add_argument(
179
 
        "-t", "--timeout", dest="commands", action="append",
180
 
        default=[], metavar="TIME",
181
 
        type=command.SetTimeout.argparse(string_to_delta),
182
 
        help="Set timeout for client")
183
 
    parser.add_argument(
184
 
        "--extended-timeout", dest="commands", action="append",
185
 
        default=[], metavar="TIME",
186
 
        type=command.SetExtendedTimeout.argparse(string_to_delta),
187
 
        help="Set extended timeout for client")
188
 
    parser.add_argument(
189
 
        "-i", "--interval", dest="commands", action="append",
190
 
        default=[], metavar="TIME",
191
 
        type=command.SetInterval.argparse(string_to_delta),
192
 
        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")
193
171
    approve_deny_default = parser.add_mutually_exclusive_group()
194
172
    approve_deny_default.add_argument(
195
 
        "--approve-by-default", dest="commands",
196
 
        action="append_const", default=[],
197
 
        const=command.ApproveByDefault(),
 
173
        "--approve-by-default", action="store_true",
 
174
        default=None, dest="approved_by_default",
198
175
        help="Set client to be approved by default")
199
176
    approve_deny_default.add_argument(
200
 
        "--deny-by-default", dest="commands",
201
 
        action="append_const", default=[],
202
 
        const=command.DenyByDefault(),
 
177
        "--deny-by-default", action="store_false",
 
178
        dest="approved_by_default",
203
179
        help="Set client to be denied by default")
204
 
    parser.add_argument(
205
 
        "--approval-delay", dest="commands", action="append",
206
 
        default=[], metavar="TIME",
207
 
        type=command.SetApprovalDelay.argparse(string_to_delta),
208
 
        help="Set delay before client approve/deny")
209
 
    parser.add_argument(
210
 
        "--approval-duration", dest="commands", action="append",
211
 
        default=[], metavar="TIME",
212
 
        type=command.SetApprovalDuration.argparse(string_to_delta),
213
 
        help="Set duration of one client approval")
214
 
    parser.add_argument("-H", "--host", dest="commands",
215
 
                        action="append", default=[], metavar="STRING",
216
 
                        type=command.SetHost,
217
 
                        help="Set host for client")
218
 
    parser.add_argument(
219
 
        "-s", "--secret", dest="commands", action="append",
220
 
        default=[], metavar="FILENAME",
221
 
        type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
222
 
        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")
223
188
    approve_deny = parser.add_mutually_exclusive_group()
224
189
    approve_deny.add_argument(
225
 
        "-A", "--approve", dest="commands", action="append_const",
226
 
        default=[], const=command.Approve(),
 
190
        "-A", "--approve", action="store_true",
227
191
        help="Approve any current client request")
228
 
    approve_deny.add_argument("-D", "--deny", dest="commands",
229
 
                              action="append_const", default=[],
230
 
                              const=command.Deny(),
 
192
    approve_deny.add_argument("-D", "--deny", action="store_true",
231
193
                              help="Deny any current client request")
232
194
    parser.add_argument("--debug", action="store_true",
233
195
                        help="Debug mode (show D-Bus commands)")
424
386
    """Apply additional restrictions on options, not expressible in
425
387
argparse"""
426
388
 
427
 
    def has_commands(options, commands=None):
428
 
        if commands is None:
429
 
            commands = (command.Enable,
430
 
                        command.Disable,
431
 
                        command.BumpTimeout,
432
 
                        command.StartChecker,
433
 
                        command.StopChecker,
434
 
                        command.IsEnabled,
435
 
                        command.Remove,
436
 
                        command.SetChecker,
437
 
                        command.SetTimeout,
438
 
                        command.SetExtendedTimeout,
439
 
                        command.SetInterval,
440
 
                        command.ApproveByDefault,
441
 
                        command.DenyByDefault,
442
 
                        command.SetApprovalDelay,
443
 
                        command.SetApprovalDuration,
444
 
                        command.SetHost,
445
 
                        command.SetSecret,
446
 
                        command.Approve,
447
 
                        command.Deny)
448
 
        return any(isinstance(cmd, commands)
449
 
                   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))
450
408
 
451
 
    if has_commands(options) and not (options.client or options.all):
 
409
    if has_actions(options) and not (options.client or options.all):
452
410
        parser.error("Options require clients names or --all.")
453
 
    if options.verbose and has_commands(options):
 
411
    if options.verbose and has_actions(options):
454
412
        parser.error("--verbose can only be used alone.")
455
 
    if (has_commands(options, (command.DumpJSON,))
456
 
        and (options.verbose or len(options.commands) > 1)):
 
413
    if options.dump_json and (options.verbose
 
414
                              or has_actions(options)):
457
415
        parser.error("--dump-json can only be used alone.")
458
 
    if options.all and not has_commands(options):
 
416
    if options.all and not has_actions(options):
459
417
        parser.error("--all requires an action.")
460
 
    if (has_commands(options, (command.IsEnabled,))
461
 
        and len(options.client) > 1):
 
418
    if options.is_enabled and len(options.client) > 1:
462
419
        parser.error("--is-enabled requires exactly one client")
463
 
    if (len(options.commands) > 1
464
 
        and has_commands(options, (command.Remove,))
465
 
        and not has_commands(options, (command.Deny,))):
466
 
        parser.error("--remove can only be combined with --deny")
467
 
 
468
 
 
469
 
class dbus(object):
470
 
 
471
 
    class SystemBus(object):
472
 
 
473
 
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
474
 
        def get_managed_objects(self, busname, objectpath):
475
 
            return self.call_method("GetManagedObjects", busname,
476
 
                                    objectpath,
477
 
                                    self.object_manager_iface)
478
 
 
479
 
        properties_iface = "org.freedesktop.DBus.Properties"
480
 
        def set_property(self, busname, objectpath, interface, key,
481
 
                         value):
482
 
            self.call_method("Set", busname, objectpath,
483
 
                             self.properties_iface, interface, key,
484
 
                             value)
485
 
 
486
 
 
487
 
    class MandosBus(SystemBus):
488
 
        busname_domain = "se.recompile"
489
 
        busname = busname_domain + ".Mandos"
490
 
        server_path = "/"
491
 
        server_interface = busname_domain + ".Mandos"
492
 
        client_interface = busname_domain + ".Mandos.Client"
493
 
        del busname_domain
494
 
 
495
 
        def get_clients_and_properties(self):
496
 
            managed_objects = self.get_managed_objects(
497
 
                self.busname, self.server_path)
498
 
            return {objpath: properties[self.client_interface]
499
 
                    for objpath, properties in managed_objects.items()
500
 
                    if self.client_interface in properties}
501
 
 
502
 
        def set_client_property(self, objectpath, key, value):
503
 
            return self.set_property(self.busname, objectpath,
504
 
                                     self.client_interface, key,
505
 
                                     value)
506
 
 
507
 
        def call_client_method(self, objectpath, method, *args):
508
 
            return self.call_method(method, self.busname, objectpath,
509
 
                                    self.client_interface, *args)
510
 
 
511
 
        def call_server_method(self, method, *args):
512
 
            return self.call_method(method, self.busname,
513
 
                                    self.server_path,
514
 
                                    self.server_interface, *args)
515
 
 
516
 
    class Error(Exception):
517
 
        pass
518
 
 
519
 
    class ConnectFailed(Error):
520
 
        pass
521
 
 
522
 
 
523
 
class dbus_python_adapter(object):
524
 
 
525
 
    class SystemBus(dbus.MandosBus):
526
 
        """Use dbus-python"""
527
 
 
528
 
        def __init__(self, module=dbus_python):
529
 
            self.dbus_python = module
530
 
            self.bus = self.dbus_python.SystemBus()
531
 
 
532
 
        @contextlib.contextmanager
533
 
        def convert_exception(self, exception_class=dbus.Error):
534
 
            try:
535
 
                yield
536
 
            except self.dbus_python.exceptions.DBusException as e:
537
 
                # This does what "raise from" would do
538
 
                exc = exception_class(*e.args)
539
 
                exc.__cause__ = e
540
 
                raise exc
541
 
 
542
 
        def call_method(self, methodname, busname, objectpath,
543
 
                        interface, *args):
544
 
            proxy_object = self.get_object(busname, objectpath)
545
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
546
 
                      interface, methodname,
547
 
                      ", ".join(repr(a) for a in args))
548
 
            method = getattr(proxy_object, methodname)
549
 
            with self.convert_exception():
550
 
                with dbus_python_adapter.SilenceLogger(
551
 
                        "dbus.proxies"):
552
 
                    value = method(*args, dbus_interface=interface)
553
 
            return self.type_filter(value)
554
 
 
555
 
        def get_object(self, busname, objectpath):
556
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
557
 
                      busname, objectpath)
558
 
            with self.convert_exception(dbus.ConnectFailed):
559
 
                return self.bus.get_object(busname, objectpath)
560
 
 
561
 
        def type_filter(self, value):
562
 
            """Convert the most bothersome types to Python types"""
563
 
            if isinstance(value, self.dbus_python.Boolean):
564
 
                return bool(value)
565
 
            if isinstance(value, self.dbus_python.ObjectPath):
566
 
                return str(value)
567
 
            # Also recurse into dictionaries
568
 
            if isinstance(value, self.dbus_python.Dictionary):
569
 
                return {self.type_filter(key):
570
 
                        self.type_filter(subval)
571
 
                        for key, subval in value.items()}
572
 
            return value
573
 
 
574
 
        def set_client_property(self, objectpath, key, value):
575
 
            if key == "Secret":
576
 
                if not isinstance(value, bytes):
577
 
                    value = value.encode("utf-8")
578
 
                value = self.dbus_python.ByteArray(value)
579
 
            return self.set_property(self.busname, objectpath,
580
 
                                     self.client_interface, key,
581
 
                                     value)
582
 
 
583
 
    class SilenceLogger(object):
584
 
        "Simple context manager to silence a particular logger"
585
 
        def __init__(self, loggername):
586
 
            self.logger = logging.getLogger(loggername)
587
 
 
588
 
        def __enter__(self):
589
 
            self.logger.addFilter(self.nullfilter)
590
 
 
591
 
        class NullFilter(logging.Filter):
592
 
            def filter(self, record):
593
 
                return False
594
 
 
595
 
        nullfilter = NullFilter()
596
 
 
597
 
        def __exit__(self, exc_type, exc_val, exc_tb):
598
 
            self.logger.removeFilter(self.nullfilter)
599
 
 
600
 
 
601
 
    class CachingBus(SystemBus):
602
 
        """A caching layer for dbus_python_adapter.SystemBus"""
603
 
        def __init__(self, *args, **kwargs):
604
 
            self.object_cache = {}
605
 
            super(dbus_python_adapter.CachingBus,
606
 
                  self).__init__(*args, **kwargs)
607
 
        def get_object(self, busname, objectpath):
608
 
            try:
609
 
                return self.object_cache[(busname, objectpath)]
610
 
            except KeyError:
611
 
                new_object = super(
612
 
                    dbus_python_adapter.CachingBus,
613
 
                    self).get_object(busname, objectpath)
614
 
                self.object_cache[(busname, objectpath)]  = new_object
615
 
                return new_object
616
 
 
617
 
 
618
 
class pydbus_adapter(object):
619
 
    class SystemBus(dbus.MandosBus):
620
 
        def __init__(self, module=pydbus):
621
 
            self.pydbus = module
622
 
            self.bus = self.pydbus.SystemBus()
623
 
 
624
 
        @contextlib.contextmanager
625
 
        def convert_exception(self, exception_class=dbus.Error):
626
 
            try:
627
 
                yield
628
 
            except gi.repository.GLib.Error as e:
629
 
                # This does what "raise from" would do
630
 
                exc = exception_class(*e.args)
631
 
                exc.__cause__ = e
632
 
                raise exc
633
 
 
634
 
        def call_method(self, methodname, busname, objectpath,
635
 
                        interface, *args):
636
 
            proxy_object = self.get(busname, objectpath)
637
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
638
 
                      interface, methodname,
639
 
                      ", ".join(repr(a) for a in args))
640
 
            method = getattr(proxy_object[interface], methodname)
641
 
            with self.convert_exception():
642
 
                return method(*args)
643
 
 
644
 
        def get(self, busname, objectpath):
645
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
646
 
                      busname, objectpath)
647
 
            with self.convert_exception(dbus.ConnectFailed):
648
 
                if sys.version_info.major <= 2:
649
 
                    with warnings.catch_warnings():
650
 
                        warnings.filterwarnings(
651
 
                            "ignore", "", DeprecationWarning,
652
 
                            r"^xml\.etree\.ElementTree$")
653
 
                        return self.bus.get(busname, objectpath)
654
 
                else:
655
 
                    return self.bus.get(busname, objectpath)
656
 
 
657
 
        def set_property(self, busname, objectpath, interface, key,
658
 
                         value):
659
 
            proxy_object = self.get(busname, objectpath)
660
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
661
 
                      objectpath, self.properties_iface, interface,
662
 
                      key, value)
663
 
            setattr(proxy_object[interface], key, value)
664
 
 
665
 
    class CachingBus(SystemBus):
666
 
        """A caching layer for pydbus_adapter.SystemBus"""
667
 
        def __init__(self, *args, **kwargs):
668
 
            self.object_cache = {}
669
 
            super(pydbus_adapter.CachingBus,
670
 
                  self).__init__(*args, **kwargs)
671
 
        def get(self, busname, objectpath):
672
 
            try:
673
 
                return self.object_cache[(busname, objectpath)]
674
 
            except KeyError:
675
 
                new_object = (super(pydbus_adapter.CachingBus, self)
676
 
                              .get(busname, objectpath))
677
 
                self.object_cache[(busname, objectpath)]  = new_object
678
 
                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
        return self
 
464
 
 
465
    class NullFilter(logging.Filter):
 
466
        def filter(self, record):
 
467
            return False
 
468
 
 
469
    nullfilter = NullFilter()
 
470
 
 
471
    def __exit__(self, exc_type, exc_val, exc_tb):
 
472
        self.logger.removeFilter(self.nullfilter)
679
473
 
680
474
 
681
475
def commands_from_options(options):
682
476
 
683
 
    commands = list(options.commands)
684
 
 
685
 
    def find_cmd(cmd, commands):
686
 
        i = 0
687
 
        for i, c in enumerate(commands):
688
 
            if isinstance(c, cmd):
689
 
                return i
690
 
        return i+1
691
 
 
692
 
    # If command.Remove is present, move any instances of command.Deny
693
 
    # to occur ahead of command.Remove.
694
 
    index_of_remove = find_cmd(command.Remove, commands)
695
 
    before_remove = commands[:index_of_remove]
696
 
    after_remove = commands[index_of_remove:]
697
 
    cleaned_after = []
698
 
    for cmd in after_remove:
699
 
        if isinstance(cmd, command.Deny):
700
 
            before_remove.append(cmd)
 
477
    commands = []
 
478
 
 
479
    if options.is_enabled:
 
480
        commands.append(command.IsEnabled())
 
481
 
 
482
    if options.approve:
 
483
        commands.append(command.Approve())
 
484
 
 
485
    if options.deny:
 
486
        commands.append(command.Deny())
 
487
 
 
488
    if options.remove:
 
489
        commands.append(command.Remove())
 
490
 
 
491
    if options.dump_json:
 
492
        commands.append(command.DumpJSON())
 
493
 
 
494
    if options.enable:
 
495
        commands.append(command.Enable())
 
496
 
 
497
    if options.disable:
 
498
        commands.append(command.Disable())
 
499
 
 
500
    if options.bump_timeout:
 
501
        commands.append(command.BumpTimeout())
 
502
 
 
503
    if options.start_checker:
 
504
        commands.append(command.StartChecker())
 
505
 
 
506
    if options.stop_checker:
 
507
        commands.append(command.StopChecker())
 
508
 
 
509
    if options.approved_by_default is not None:
 
510
        if options.approved_by_default:
 
511
            commands.append(command.ApproveByDefault())
701
512
        else:
702
 
            cleaned_after.append(cmd)
703
 
    if cleaned_after != after_remove:
704
 
        commands = before_remove + cleaned_after
 
513
            commands.append(command.DenyByDefault())
 
514
 
 
515
    if options.checker is not None:
 
516
        commands.append(command.SetChecker(options.checker))
 
517
 
 
518
    if options.host is not None:
 
519
        commands.append(command.SetHost(options.host))
 
520
 
 
521
    if options.secret is not None:
 
522
        commands.append(command.SetSecret(options.secret))
 
523
 
 
524
    if options.timeout is not None:
 
525
        commands.append(command.SetTimeout(options.timeout))
 
526
 
 
527
    if options.extended_timeout:
 
528
        commands.append(
 
529
            command.SetExtendedTimeout(options.extended_timeout))
 
530
 
 
531
    if options.interval is not None:
 
532
        commands.append(command.SetInterval(options.interval))
 
533
 
 
534
    if options.approval_delay is not None:
 
535
        commands.append(
 
536
            command.SetApprovalDelay(options.approval_delay))
 
537
 
 
538
    if options.approval_duration is not None:
 
539
        commands.append(
 
540
            command.SetApprovalDuration(options.approval_duration))
705
541
 
706
542
    # If no command option has been given, show table of clients,
707
543
    # optionally verbosely
716
552
 
717
553
    class Base(object):
718
554
        """Abstract base class for commands"""
719
 
        def run(self, clients, bus=None):
 
555
        def run(self, clients, bus=None, mandos=None):
720
556
            """Normal commands should implement run_on_one_client(),
721
557
but commands which want to operate on all clients at the same time can
722
558
override this run() method instead.
723
559
"""
724
 
            self.bus = bus
725
 
            for client, properties in clients.items():
 
560
            self.mandos = mandos
 
561
            for clientpath, properties in clients.items():
 
562
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
563
                          dbus_busname, str(clientpath))
 
564
                client = bus.get_object(dbus_busname, clientpath)
726
565
                self.run_on_one_client(client, properties)
727
566
 
728
567
 
729
568
    class IsEnabled(Base):
730
 
        def run(self, clients, bus=None):
731
 
            properties = next(iter(clients.values()))
732
 
            if properties["Enabled"]:
 
569
        def run(self, clients, bus=None, mandos=None):
 
570
            client, properties = next(iter(clients.items()))
 
571
            if self.is_enabled(client, properties):
733
572
                sys.exit(0)
734
573
            sys.exit(1)
 
574
        def is_enabled(self, client, properties):
 
575
            return properties["Enabled"]
735
576
 
736
577
 
737
578
    class Approve(Base):
738
579
        def run_on_one_client(self, client, properties):
739
 
            self.bus.call_client_method(client, "Approve", True)
 
580
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
581
                      client.__dbus_object_path__,
 
582
                      client_dbus_interface)
 
583
            client.Approve(dbus.Boolean(True),
 
584
                           dbus_interface=client_dbus_interface)
740
585
 
741
586
 
742
587
    class Deny(Base):
743
588
        def run_on_one_client(self, client, properties):
744
 
            self.bus.call_client_method(client, "Approve", False)
 
589
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
590
                      client.__dbus_object_path__,
 
591
                      client_dbus_interface)
 
592
            client.Approve(dbus.Boolean(False),
 
593
                           dbus_interface=client_dbus_interface)
745
594
 
746
595
 
747
596
    class Remove(Base):
748
 
        def run(self, clients, bus):
749
 
            for clientpath in frozenset(clients.keys()):
750
 
                bus.call_server_method("RemoveClient", clientpath)
 
597
        def run_on_one_client(self, client, properties):
 
598
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
 
599
                      dbus_busname, server_dbus_path,
 
600
                      server_dbus_interface,
 
601
                      str(client.__dbus_object_path__))
 
602
            self.mandos.RemoveClient(client.__dbus_object_path__)
751
603
 
752
604
 
753
605
    class Output(Base):
761
613
                        "Checker", "ExtendedTimeout", "Expires",
762
614
                        "LastCheckerStatus")
763
615
 
 
616
        def run(self, clients, bus=None, mandos=None):
 
617
            print(self.output(clients.values()))
 
618
 
 
619
        def output(self, clients):
 
620
            raise NotImplementedError()
 
621
 
764
622
 
765
623
    class DumpJSON(Output):
766
 
        def run(self, clients, bus=None):
767
 
            data = {properties["Name"]:
768
 
                    {key: properties[key]
 
624
        def output(self, clients):
 
625
            data = {client["Name"]:
 
626
                    {key: self.dbus_boolean_to_bool(client[key])
769
627
                     for key in self.all_keywords}
770
 
                    for properties in clients.values()}
771
 
            print(json.dumps(data, indent=4, separators=(',', ': ')))
 
628
                    for client in clients}
 
629
            return json.dumps(data, indent=4, separators=(',', ': '))
 
630
 
 
631
        @staticmethod
 
632
        def dbus_boolean_to_bool(value):
 
633
            if isinstance(value, dbus.Boolean):
 
634
                value = bool(value)
 
635
            return value
772
636
 
773
637
 
774
638
    class PrintTable(Output):
775
639
        def __init__(self, verbose=False):
776
640
            self.verbose = verbose
777
641
 
778
 
        def run(self, clients, bus=None):
 
642
        def output(self, clients):
779
643
            default_keywords = ("Name", "Enabled", "Timeout",
780
644
                                "LastCheckedOK")
781
645
            keywords = default_keywords
782
646
            if self.verbose:
783
647
                keywords = self.all_keywords
784
 
            print(self.TableOfClients(clients.values(), keywords))
 
648
            return str(self.TableOfClients(clients, keywords))
785
649
 
786
650
        class TableOfClients(object):
787
651
            tableheaders = {
842
706
 
843
707
            @classmethod
844
708
            def valuetostring(cls, value, keyword):
845
 
                if isinstance(value, bool):
 
709
                if isinstance(value, dbus.Boolean):
846
710
                    return "Yes" if value else "No"
847
711
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
848
712
                               "ApprovalDuration", "ExtendedTimeout"):
868
732
                                seconds=td.seconds % 60))
869
733
 
870
734
 
871
 
    class PropertySetter(Base):
 
735
    class Property(Base):
872
736
        "Abstract class for Actions for setting one client property"
873
737
 
874
 
        def run_on_one_client(self, client, properties=None):
 
738
        def run_on_one_client(self, client, properties):
875
739
            """Set the Client's D-Bus property"""
876
 
            self.bus.set_client_property(client, self.propname,
877
 
                                         self.value_to_set)
 
740
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
741
                      client.__dbus_object_path__,
 
742
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
 
743
                      self.propname, self.value_to_set
 
744
                      if not isinstance(self.value_to_set,
 
745
                                        dbus.Boolean)
 
746
                      else bool(self.value_to_set))
 
747
            client.Set(client_dbus_interface, self.propname,
 
748
                       self.value_to_set,
 
749
                       dbus_interface=dbus.PROPERTIES_IFACE)
878
750
 
879
751
        @property
880
752
        def propname(self):
881
753
            raise NotImplementedError()
882
754
 
883
755
 
884
 
    class Enable(PropertySetter):
885
 
        propname = "Enabled"
886
 
        value_to_set = True
887
 
 
888
 
 
889
 
    class Disable(PropertySetter):
890
 
        propname = "Enabled"
891
 
        value_to_set = False
892
 
 
893
 
 
894
 
    class BumpTimeout(PropertySetter):
 
756
    class Enable(Property):
 
757
        propname = "Enabled"
 
758
        value_to_set = dbus.Boolean(True)
 
759
 
 
760
 
 
761
    class Disable(Property):
 
762
        propname = "Enabled"
 
763
        value_to_set = dbus.Boolean(False)
 
764
 
 
765
 
 
766
    class BumpTimeout(Property):
895
767
        propname = "LastCheckedOK"
896
768
        value_to_set = ""
897
769
 
898
770
 
899
 
    class StartChecker(PropertySetter):
900
 
        propname = "CheckerRunning"
901
 
        value_to_set = True
902
 
 
903
 
 
904
 
    class StopChecker(PropertySetter):
905
 
        propname = "CheckerRunning"
906
 
        value_to_set = False
907
 
 
908
 
 
909
 
    class ApproveByDefault(PropertySetter):
910
 
        propname = "ApprovedByDefault"
911
 
        value_to_set = True
912
 
 
913
 
 
914
 
    class DenyByDefault(PropertySetter):
915
 
        propname = "ApprovedByDefault"
916
 
        value_to_set = False
917
 
 
918
 
 
919
 
    class PropertySetterValue(PropertySetter):
920
 
        """Abstract class for PropertySetter recieving a value as
921
 
constructor argument instead of a class attribute."""
 
771
    class StartChecker(Property):
 
772
        propname = "CheckerRunning"
 
773
        value_to_set = dbus.Boolean(True)
 
774
 
 
775
 
 
776
    class StopChecker(Property):
 
777
        propname = "CheckerRunning"
 
778
        value_to_set = dbus.Boolean(False)
 
779
 
 
780
 
 
781
    class ApproveByDefault(Property):
 
782
        propname = "ApprovedByDefault"
 
783
        value_to_set = dbus.Boolean(True)
 
784
 
 
785
 
 
786
    class DenyByDefault(Property):
 
787
        propname = "ApprovedByDefault"
 
788
        value_to_set = dbus.Boolean(False)
 
789
 
 
790
 
 
791
    class PropertyValue(Property):
 
792
        "Abstract class for Property recieving a value as argument"
922
793
        def __init__(self, value):
923
794
            self.value_to_set = value
924
795
 
925
 
        @classmethod
926
 
        def argparse(cls, argtype):
927
 
            def cmdtype(arg):
928
 
                return cls(argtype(arg))
929
 
            return cmdtype
930
796
 
931
 
    class SetChecker(PropertySetterValue):
 
797
    class SetChecker(PropertyValue):
932
798
        propname = "Checker"
933
799
 
934
800
 
935
 
    class SetHost(PropertySetterValue):
 
801
    class SetHost(PropertyValue):
936
802
        propname = "Host"
937
803
 
938
804
 
939
 
    class SetSecret(PropertySetterValue):
 
805
    class SetSecret(PropertyValue):
940
806
        propname = "Secret"
941
807
 
942
808
        @property
950
816
            value.close()
951
817
 
952
818
 
953
 
    class PropertySetterValueMilliseconds(PropertySetterValue):
954
 
        """Abstract class for PropertySetterValue taking a value
955
 
argument as a datetime.timedelta() but should store it as
956
 
milliseconds."""
 
819
    class MillisecondsPropertyValueArgument(PropertyValue):
 
820
        """Abstract class for PropertyValue taking a value argument as
 
821
a datetime.timedelta() but should store it as milliseconds."""
957
822
 
958
823
        @property
959
824
        def value_to_set(self):
965
830
            self._vts = int(round(value.total_seconds() * 1000))
966
831
 
967
832
 
968
 
    class SetTimeout(PropertySetterValueMilliseconds):
 
833
    class SetTimeout(MillisecondsPropertyValueArgument):
969
834
        propname = "Timeout"
970
835
 
971
836
 
972
 
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
 
837
    class SetExtendedTimeout(MillisecondsPropertyValueArgument):
973
838
        propname = "ExtendedTimeout"
974
839
 
975
840
 
976
 
    class SetInterval(PropertySetterValueMilliseconds):
 
841
    class SetInterval(MillisecondsPropertyValueArgument):
977
842
        propname = "Interval"
978
843
 
979
844
 
980
 
    class SetApprovalDelay(PropertySetterValueMilliseconds):
 
845
    class SetApprovalDelay(MillisecondsPropertyValueArgument):
981
846
        propname = "ApprovalDelay"
982
847
 
983
848
 
984
 
    class SetApprovalDuration(PropertySetterValueMilliseconds):
 
849
    class SetApprovalDuration(MillisecondsPropertyValueArgument):
985
850
        propname = "ApprovalDuration"
986
851
 
987
852
 
1020
885
                                                     "output"))
1021
886
 
1022
887
 
1023
 
class Unique(object):
1024
 
    """Class for objects which exist only to be unique objects, since
1025
 
unittest.mock.sentinel only exists in Python 3.3"""
1026
 
 
1027
 
 
1028
888
class Test_string_to_delta(TestCaseWithAssertLogs):
1029
889
    # Just test basic RFC 3339 functionality here, the doc string for
1030
890
    # rfc3339_duration_to_delta() already has more comprehensive
1031
 
    # tests, which are run by doctest.
 
891
    # tests, which is run by doctest.
1032
892
 
1033
893
    def test_rfc3339_zero_seconds(self):
1034
894
        self.assertEqual(datetime.timedelta(),
1058
918
 
1059
919
    def test_actions_requires_client_or_all(self):
1060
920
        for action, value in self.actions.items():
1061
 
            args = self.actionargs(action, value)
 
921
            options = self.parser.parse_args()
 
922
            setattr(options, action, value)
1062
923
            with self.assertParseError():
1063
 
                self.parse_args(args)
 
924
                self.check_option_syntax(options)
1064
925
 
1065
 
    # This mostly corresponds to the definition from has_commands() in
 
926
    # This mostly corresponds to the definition from has_actions() in
1066
927
    # check_option_syntax()
1067
928
    actions = {
1068
 
        "--enable": None,
1069
 
        "--disable": None,
1070
 
        "--bump-timeout": None,
1071
 
        "--start-checker": None,
1072
 
        "--stop-checker": None,
1073
 
        "--is-enabled": None,
1074
 
        "--remove": None,
1075
 
        "--checker": "x",
1076
 
        "--timeout": "PT0S",
1077
 
        "--extended-timeout": "PT0S",
1078
 
        "--interval": "PT0S",
1079
 
        "--approve-by-default": None,
1080
 
        "--deny-by-default": None,
1081
 
        "--approval-delay": "PT0S",
1082
 
        "--approval-duration": "PT0S",
1083
 
        "--host": "hostname",
1084
 
        "--secret": "/dev/null",
1085
 
        "--approve": None,
1086
 
        "--deny": None,
 
929
        # The actual values set here are not that important, but we do
 
930
        # at least stick to the correct types, even though they are
 
931
        # never used
 
932
        "enable": True,
 
933
        "disable": True,
 
934
        "bump_timeout": True,
 
935
        "start_checker": True,
 
936
        "stop_checker": True,
 
937
        "is_enabled": True,
 
938
        "remove": True,
 
939
        "checker": "x",
 
940
        "timeout": datetime.timedelta(),
 
941
        "extended_timeout": datetime.timedelta(),
 
942
        "interval": datetime.timedelta(),
 
943
        "approved_by_default": True,
 
944
        "approval_delay": datetime.timedelta(),
 
945
        "approval_duration": datetime.timedelta(),
 
946
        "host": "x",
 
947
        "secret": io.BytesIO(b"x"),
 
948
        "approve": True,
 
949
        "deny": True,
1087
950
    }
1088
951
 
1089
 
    @staticmethod
1090
 
    def actionargs(action, value, *args):
1091
 
        if value is not None:
1092
 
            return [action, value] + list(args)
1093
 
        else:
1094
 
            return [action] + list(args)
1095
 
 
1096
952
    @contextlib.contextmanager
1097
953
    def assertParseError(self):
1098
954
        with self.assertRaises(SystemExit) as e:
1103
959
        # /argparse.html#exiting-methods
1104
960
        self.assertEqual(2, e.exception.code)
1105
961
 
1106
 
    def parse_args(self, args):
1107
 
        options = self.parser.parse_args(args)
1108
 
        check_option_syntax(self.parser, options)
1109
 
 
1110
962
    @staticmethod
1111
963
    @contextlib.contextmanager
1112
964
    def redirect_stderr_to_devnull():
1113
 
        old_stderr = sys.stderr
1114
 
        with contextlib.closing(open(os.devnull, "w")) as null:
1115
 
            sys.stderr = null
1116
 
            try:
1117
 
                yield
1118
 
            finally:
1119
 
                sys.stderr = old_stderr
 
965
        null = os.open(os.path.devnull, os.O_RDWR)
 
966
        stderrcopy = os.dup(sys.stderr.fileno())
 
967
        os.dup2(null, sys.stderr.fileno())
 
968
        os.close(null)
 
969
        try:
 
970
            yield
 
971
        finally:
 
972
            # restore stderr
 
973
            os.dup2(stderrcopy, sys.stderr.fileno())
 
974
            os.close(stderrcopy)
1120
975
 
1121
976
    def check_option_syntax(self, options):
1122
977
        check_option_syntax(self.parser, options)
1123
978
 
1124
979
    def test_actions_all_conflicts_with_verbose(self):
1125
980
        for action, value in self.actions.items():
1126
 
            args = self.actionargs(action, value, "--all",
1127
 
                                   "--verbose")
 
981
            options = self.parser.parse_args()
 
982
            setattr(options, action, value)
 
983
            options.all = True
 
984
            options.verbose = True
1128
985
            with self.assertParseError():
1129
 
                self.parse_args(args)
 
986
                self.check_option_syntax(options)
1130
987
 
1131
988
    def test_actions_with_client_conflicts_with_verbose(self):
1132
989
        for action, value in self.actions.items():
1133
 
            args = self.actionargs(action, value, "--verbose",
1134
 
                                   "client")
 
990
            options = self.parser.parse_args()
 
991
            setattr(options, action, value)
 
992
            options.verbose = True
 
993
            options.client = ["foo"]
1135
994
            with self.assertParseError():
1136
 
                self.parse_args(args)
 
995
                self.check_option_syntax(options)
1137
996
 
1138
997
    def test_dump_json_conflicts_with_verbose(self):
1139
 
        args = ["--dump-json", "--verbose"]
 
998
        options = self.parser.parse_args()
 
999
        options.dump_json = True
 
1000
        options.verbose = True
1140
1001
        with self.assertParseError():
1141
 
            self.parse_args(args)
 
1002
            self.check_option_syntax(options)
1142
1003
 
1143
1004
    def test_dump_json_conflicts_with_action(self):
1144
1005
        for action, value in self.actions.items():
1145
 
            args = self.actionargs(action, value, "--dump-json")
 
1006
            options = self.parser.parse_args()
 
1007
            setattr(options, action, value)
 
1008
            options.dump_json = True
1146
1009
            with self.assertParseError():
1147
 
                self.parse_args(args)
 
1010
                self.check_option_syntax(options)
1148
1011
 
1149
1012
    def test_all_can_not_be_alone(self):
1150
 
        args = ["--all"]
 
1013
        options = self.parser.parse_args()
 
1014
        options.all = True
1151
1015
        with self.assertParseError():
1152
 
            self.parse_args(args)
 
1016
            self.check_option_syntax(options)
1153
1017
 
1154
1018
    def test_all_is_ok_with_any_action(self):
1155
1019
        for action, value in self.actions.items():
1156
 
            args = self.actionargs(action, value, "--all")
1157
 
            self.parse_args(args)
 
1020
            options = self.parser.parse_args()
 
1021
            setattr(options, action, value)
 
1022
            options.all = True
 
1023
            self.check_option_syntax(options)
1158
1024
 
1159
1025
    def test_any_action_is_ok_with_one_client(self):
1160
1026
        for action, value in self.actions.items():
1161
 
            args = self.actionargs(action, value, "client")
1162
 
            self.parse_args(args)
 
1027
            options = self.parser.parse_args()
 
1028
            setattr(options, action, value)
 
1029
            options.client = ["foo"]
 
1030
            self.check_option_syntax(options)
1163
1031
 
1164
1032
    def test_one_client_with_all_actions_except_is_enabled(self):
 
1033
        options = self.parser.parse_args()
1165
1034
        for action, value in self.actions.items():
1166
 
            if action == "--is-enabled":
 
1035
            if action == "is_enabled":
1167
1036
                continue
1168
 
            args = self.actionargs(action, value, "client")
1169
 
            self.parse_args(args)
 
1037
            setattr(options, action, value)
 
1038
        options.client = ["foo"]
 
1039
        self.check_option_syntax(options)
1170
1040
 
1171
1041
    def test_two_clients_with_all_actions_except_is_enabled(self):
 
1042
        options = self.parser.parse_args()
1172
1043
        for action, value in self.actions.items():
1173
 
            if action == "--is-enabled":
 
1044
            if action == "is_enabled":
1174
1045
                continue
1175
 
            args = self.actionargs(action, value, "client1",
1176
 
                                   "client2")
1177
 
            self.parse_args(args)
 
1046
            setattr(options, action, value)
 
1047
        options.client = ["foo", "barbar"]
 
1048
        self.check_option_syntax(options)
1178
1049
 
1179
1050
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1180
1051
        for action, value in self.actions.items():
1181
 
            if action == "--is-enabled":
 
1052
            if action == "is_enabled":
1182
1053
                continue
1183
 
            args = self.actionargs(action, value, "client1",
1184
 
                                   "client2")
1185
 
            self.parse_args(args)
 
1054
            options = self.parser.parse_args()
 
1055
            setattr(options, action, value)
 
1056
            options.client = ["foo", "barbar"]
 
1057
            self.check_option_syntax(options)
1186
1058
 
1187
1059
    def test_is_enabled_fails_without_client(self):
1188
 
        args = ["--is-enabled"]
 
1060
        options = self.parser.parse_args()
 
1061
        options.is_enabled = True
1189
1062
        with self.assertParseError():
1190
 
            self.parse_args(args)
 
1063
            self.check_option_syntax(options)
1191
1064
 
1192
1065
    def test_is_enabled_fails_with_two_clients(self):
1193
 
        args = ["--is-enabled", "client1", "client2"]
 
1066
        options = self.parser.parse_args()
 
1067
        options.is_enabled = True
 
1068
        options.client = ["foo", "barbar"]
1194
1069
        with self.assertParseError():
1195
 
            self.parse_args(args)
 
1070
            self.check_option_syntax(options)
1196
1071
 
1197
1072
    def test_remove_can_only_be_combined_with_action_deny(self):
1198
1073
        for action, value in self.actions.items():
1199
 
            if action in {"--remove", "--deny"}:
 
1074
            if action in {"remove", "deny"}:
1200
1075
                continue
1201
 
            args = self.actionargs(action, value, "--all",
1202
 
                                   "--remove")
 
1076
            options = self.parser.parse_args()
 
1077
            setattr(options, action, value)
 
1078
            options.all = True
 
1079
            options.remove = True
1203
1080
            with self.assertParseError():
1204
 
                self.parse_args(args)
1205
 
 
1206
 
 
1207
 
class Test_dbus_exceptions(unittest.TestCase):
1208
 
 
1209
 
    def test_dbus_ConnectFailed_is_Error(self):
1210
 
        with self.assertRaises(dbus.Error):
1211
 
            raise dbus.ConnectFailed()
1212
 
 
1213
 
 
1214
 
class Test_dbus_MandosBus(unittest.TestCase):
1215
 
 
1216
 
    class MockMandosBus(dbus.MandosBus):
1217
 
        def __init__(self):
1218
 
            self._name = "se.recompile.Mandos"
1219
 
            self._server_path = "/"
1220
 
            self._server_interface = "se.recompile.Mandos"
1221
 
            self._client_interface = "se.recompile.Mandos.Client"
1222
 
            self.calls = []
1223
 
            self.call_method_return = Unique()
1224
 
 
1225
 
        def call_method(self, methodname, busname, objectpath,
1226
 
                        interface, *args):
1227
 
            self.calls.append((methodname, busname, objectpath,
1228
 
                               interface, args))
1229
 
            return self.call_method_return
1230
 
 
1231
 
    def setUp(self):
1232
 
        self.bus = self.MockMandosBus()
1233
 
 
1234
 
    def test_set_client_property(self):
1235
 
        self.bus.set_client_property("objectpath", "key", "value")
1236
 
        expected_call = ("Set", self.bus._name, "objectpath",
1237
 
                         "org.freedesktop.DBus.Properties",
1238
 
                         (self.bus._client_interface, "key", "value"))
1239
 
        self.assertIn(expected_call, self.bus.calls)
1240
 
 
1241
 
    def test_call_client_method(self):
1242
 
        ret = self.bus.call_client_method("objectpath", "methodname")
1243
 
        self.assertIs(self.bus.call_method_return, ret)
1244
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1245
 
                         self.bus._client_interface, ())
1246
 
        self.assertIn(expected_call, self.bus.calls)
1247
 
 
1248
 
    def test_call_client_method_with_args(self):
1249
 
        args = (Unique(), Unique())
1250
 
        ret = self.bus.call_client_method("objectpath", "methodname",
1251
 
                                          *args)
1252
 
        self.assertIs(self.bus.call_method_return, ret)
1253
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1254
 
                         self.bus._client_interface,
1255
 
                         (args[0], args[1]))
1256
 
        self.assertIn(expected_call, self.bus.calls)
1257
 
 
1258
 
    def test_get_clients_and_properties(self):
1259
 
        managed_objects = {
1260
 
            "objectpath": {
1261
 
                self.bus._client_interface: {
1262
 
                    "key": "value",
1263
 
                    "bool": True,
1264
 
                },
1265
 
                "irrelevant_interface": {
1266
 
                    "key": "othervalue",
1267
 
                    "bool": False,
1268
 
                },
1269
 
            },
1270
 
            "other_objectpath": {
1271
 
                "other_irrelevant_interface": {
1272
 
                    "key": "value 3",
1273
 
                    "bool": None,
1274
 
                },
1275
 
            },
1276
 
        }
1277
 
        expected_clients_and_properties = {
1278
 
            "objectpath": {
1279
 
                "key": "value",
1280
 
                "bool": True,
1281
 
            }
1282
 
        }
1283
 
        self.bus.call_method_return = managed_objects
1284
 
        ret = self.bus.get_clients_and_properties()
1285
 
        self.assertDictEqual(expected_clients_and_properties, ret)
1286
 
        expected_call = ("GetManagedObjects", self.bus._name,
1287
 
                         self.bus._server_path,
1288
 
                         "org.freedesktop.DBus.ObjectManager", ())
1289
 
        self.assertIn(expected_call, self.bus.calls)
1290
 
 
1291
 
    def test_call_server_method(self):
1292
 
        ret = self.bus.call_server_method("methodname")
1293
 
        self.assertIs(self.bus.call_method_return, ret)
1294
 
        expected_call = ("methodname", self.bus._name,
1295
 
                         self.bus._server_path,
1296
 
                         self.bus._server_interface, ())
1297
 
        self.assertIn(expected_call, self.bus.calls)
1298
 
 
1299
 
    def test_call_server_method_with_args(self):
1300
 
        args = (Unique(), Unique())
1301
 
        ret = self.bus.call_server_method("methodname", *args)
1302
 
        self.assertIs(self.bus.call_method_return, ret)
1303
 
        expected_call = ("methodname", self.bus._name,
1304
 
                         self.bus._server_path,
1305
 
                         self.bus._server_interface,
1306
 
                         (args[0], args[1]))
1307
 
        self.assertIn(expected_call, self.bus.calls)
1308
 
 
1309
 
 
1310
 
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1311
 
 
1312
 
    def MockDBusPython_func(self, func):
1313
 
        class mock_dbus_python(object):
1314
 
            """mock dbus-python module"""
1315
 
            class exceptions(object):
1316
 
                """Pseudo-namespace"""
1317
 
                class DBusException(Exception):
1318
 
                    pass
1319
 
            class SystemBus(object):
1320
 
                @staticmethod
1321
 
                def get_object(busname, objectpath):
1322
 
                    DBusObject = collections.namedtuple(
1323
 
                        "DBusObject", ("methodname", "Set"))
1324
 
                    def method(*args, **kwargs):
1325
 
                        self.assertEqual({"dbus_interface":
1326
 
                                          "interface"},
1327
 
                                         kwargs)
1328
 
                        return func(*args)
1329
 
                    def set_property(interface, key, value,
1330
 
                                     dbus_interface=None):
1331
 
                        self.assertEqual(
1332
 
                            "org.freedesktop.DBus.Properties",
1333
 
                            dbus_interface)
1334
 
                        self.assertEqual("Secret", key)
1335
 
                        return func(interface, key, value,
1336
 
                                    dbus_interface=dbus_interface)
1337
 
                    return DBusObject(methodname=method,
1338
 
                                      Set=set_property)
1339
 
            class Boolean(object):
1340
 
                def __init__(self, value):
1341
 
                    self.value = bool(value)
1342
 
                def __bool__(self):
1343
 
                    return self.value
1344
 
                if sys.version_info.major == 2:
1345
 
                    __nonzero__ = __bool__
1346
 
            class ObjectPath(str):
1347
 
                pass
1348
 
            class Dictionary(dict):
1349
 
                pass
1350
 
            class ByteArray(bytes):
1351
 
                pass
1352
 
        return mock_dbus_python
1353
 
 
1354
 
    def call_method(self, bus, methodname, busname, objectpath,
1355
 
                    interface, *args):
1356
 
        with self.assertLogs(log, logging.DEBUG):
1357
 
            return bus.call_method(methodname, busname, objectpath,
1358
 
                                   interface, *args)
1359
 
 
1360
 
    def test_call_method_returns(self):
1361
 
        expected_method_return = Unique()
1362
 
        method_args = (Unique(), Unique())
1363
 
        def func(*args):
1364
 
            self.assertEqual(len(method_args), len(args))
1365
 
            for marg, arg in zip(method_args, args):
1366
 
                self.assertIs(marg, arg)
1367
 
            return expected_method_return
1368
 
        mock_dbus_python = self.MockDBusPython_func(func)
1369
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1370
 
        ret = self.call_method(bus, "methodname", "busname",
1371
 
                               "objectpath", "interface",
1372
 
                               *method_args)
1373
 
        self.assertIs(ret, expected_method_return)
1374
 
 
1375
 
    def test_call_method_filters_bool_true(self):
1376
 
        def func():
1377
 
            return method_return
1378
 
        mock_dbus_python = self.MockDBusPython_func(func)
1379
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1380
 
        method_return = mock_dbus_python.Boolean(True)
1381
 
        ret = self.call_method(bus, "methodname", "busname",
1382
 
                               "objectpath", "interface")
1383
 
        self.assertTrue(ret)
1384
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1385
 
 
1386
 
    def test_call_method_filters_bool_false(self):
1387
 
        def func():
1388
 
            return method_return
1389
 
        mock_dbus_python = self.MockDBusPython_func(func)
1390
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1391
 
        method_return = mock_dbus_python.Boolean(False)
1392
 
        ret = self.call_method(bus, "methodname", "busname",
1393
 
                               "objectpath", "interface")
1394
 
        self.assertFalse(ret)
1395
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1396
 
 
1397
 
    def test_call_method_filters_objectpath(self):
1398
 
        def func():
1399
 
            return method_return
1400
 
        mock_dbus_python = self.MockDBusPython_func(func)
1401
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1402
 
        method_return = mock_dbus_python.ObjectPath("objectpath")
1403
 
        ret = self.call_method(bus, "methodname", "busname",
1404
 
                               "objectpath", "interface")
1405
 
        self.assertEqual("objectpath", ret)
1406
 
        self.assertIsNot("objectpath", ret)
1407
 
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1408
 
 
1409
 
    def test_call_method_filters_booleans_in_dict(self):
1410
 
        def func():
1411
 
            return method_return
1412
 
        mock_dbus_python = self.MockDBusPython_func(func)
1413
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1414
 
        method_return = mock_dbus_python.Dictionary(
1415
 
        {mock_dbus_python.Boolean(True):
1416
 
         mock_dbus_python.Boolean(False),
1417
 
         mock_dbus_python.Boolean(False):
1418
 
         mock_dbus_python.Boolean(True)})
1419
 
        ret = self.call_method(bus, "methodname", "busname",
1420
 
                               "objectpath", "interface")
1421
 
        expected_method_return = {True: False,
1422
 
                                  False: True}
1423
 
        self.assertEqual(expected_method_return, ret)
1424
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1425
 
 
1426
 
    def test_call_method_filters_objectpaths_in_dict(self):
1427
 
        def func():
1428
 
            return method_return
1429
 
        mock_dbus_python = self.MockDBusPython_func(func)
1430
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1431
 
        method_return = mock_dbus_python.Dictionary(
1432
 
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
1433
 
         mock_dbus_python.ObjectPath("objectpath_value_1"),
1434
 
         mock_dbus_python.ObjectPath("objectpath_key_2"):
1435
 
         mock_dbus_python.ObjectPath("objectpath_value_2")})
1436
 
        ret = self.call_method(bus, "methodname", "busname",
1437
 
                               "objectpath", "interface")
1438
 
        expected_method_return = {str(key): str(value)
1439
 
                                  for key, value in
1440
 
                                  method_return.items()}
1441
 
        self.assertEqual(expected_method_return, ret)
1442
 
        self.assertIsInstance(ret, dict)
1443
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1444
 
 
1445
 
    def test_call_method_filters_dict_in_dict(self):
1446
 
        def func():
1447
 
            return method_return
1448
 
        mock_dbus_python = self.MockDBusPython_func(func)
1449
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1450
 
        method_return = mock_dbus_python.Dictionary(
1451
 
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
1452
 
                                              "key12": "value12"}),
1453
 
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
1454
 
                                              "key22": "value22"})})
1455
 
        ret = self.call_method(bus, "methodname", "busname",
1456
 
                               "objectpath", "interface")
1457
 
        expected_method_return = {
1458
 
            "key1": {"key11": "value11",
1459
 
                     "key12": "value12"},
1460
 
            "key2": {"key21": "value21",
1461
 
                     "key22": "value22"},
1462
 
        }
1463
 
        self.assertEqual(expected_method_return, ret)
1464
 
        self.assertIsInstance(ret, dict)
1465
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1466
 
        for key, value in ret.items():
1467
 
            self.assertIsInstance(value, dict)
1468
 
            self.assertEqual(expected_method_return[key], value)
1469
 
            self.assertNotIsInstance(value,
1470
 
                                     mock_dbus_python.Dictionary)
1471
 
 
1472
 
    def test_call_method_filters_dict_three_deep(self):
1473
 
        def func():
1474
 
            return method_return
1475
 
        mock_dbus_python = self.MockDBusPython_func(func)
1476
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1477
 
        method_return = mock_dbus_python.Dictionary(
1478
 
            {"key1":
1479
 
             mock_dbus_python.Dictionary(
1480
 
                 {"key2":
1481
 
                  mock_dbus_python.Dictionary(
1482
 
                      {"key3":
1483
 
                       mock_dbus_python.Boolean(True),
1484
 
                       }),
1485
 
                  }),
1486
 
             })
1487
 
        ret = self.call_method(bus, "methodname", "busname",
1488
 
                               "objectpath", "interface")
1489
 
        expected_method_return = {"key1": {"key2": {"key3": True}}}
1490
 
        self.assertEqual(expected_method_return, ret)
1491
 
        self.assertIsInstance(ret, dict)
1492
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1493
 
        self.assertIsInstance(ret["key1"], dict)
1494
 
        self.assertNotIsInstance(ret["key1"],
1495
 
                                 mock_dbus_python.Dictionary)
1496
 
        self.assertIsInstance(ret["key1"]["key2"], dict)
1497
 
        self.assertNotIsInstance(ret["key1"]["key2"],
1498
 
                                 mock_dbus_python.Dictionary)
1499
 
        self.assertTrue(ret["key1"]["key2"]["key3"])
1500
 
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1501
 
                                 mock_dbus_python.Boolean)
1502
 
 
1503
 
    def test_call_method_handles_exception(self):
 
1081
                self.check_option_syntax(options)
 
1082
 
 
1083
 
 
1084
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
 
1085
    def test_calls_and_returns_get_object_on_bus(self):
 
1086
        class MockBus(object):
 
1087
            called = False
 
1088
            def get_object(mockbus_self, busname, dbus_path):
 
1089
                # Note that "self" is still the testcase instance,
 
1090
                # this MockBus instance is in "mockbus_self".
 
1091
                self.assertEqual(dbus_busname, busname)
 
1092
                self.assertEqual(server_dbus_path, dbus_path)
 
1093
                mockbus_self.called = True
 
1094
                return mockbus_self
 
1095
 
 
1096
        mockbus = get_mandos_dbus_object(bus=MockBus())
 
1097
        self.assertIsInstance(mockbus, MockBus)
 
1098
        self.assertTrue(mockbus.called)
 
1099
 
 
1100
    def test_logs_and_exits_on_dbus_error(self):
 
1101
        class MockBusFailing(object):
 
1102
            def get_object(self, busname, dbus_path):
 
1103
                raise dbus.exceptions.DBusException("Test")
 
1104
 
 
1105
        with self.assertLogs(log, logging.CRITICAL):
 
1106
            with self.assertRaises(SystemExit) as e:
 
1107
                bus = get_mandos_dbus_object(bus=MockBusFailing())
 
1108
 
 
1109
        if isinstance(e.exception.code, int):
 
1110
            self.assertNotEqual(0, e.exception.code)
 
1111
        else:
 
1112
            self.assertIsNotNone(e.exception.code)
 
1113
 
 
1114
 
 
1115
class Test_get_managed_objects(TestCaseWithAssertLogs):
 
1116
    def test_calls_and_returns_GetManagedObjects(self):
 
1117
        managed_objects = {"/clients/foo": { "Name": "foo"}}
 
1118
        class MockObjectManager(object):
 
1119
            def GetManagedObjects(self):
 
1120
                return managed_objects
 
1121
        retval = get_managed_objects(MockObjectManager())
 
1122
        self.assertDictEqual(managed_objects, retval)
 
1123
 
 
1124
    def test_logs_and_exits_on_dbus_error(self):
1504
1125
        dbus_logger = logging.getLogger("dbus.proxies")
1505
1126
 
1506
 
        def func():
1507
 
            dbus_logger.error("Test")
1508
 
            raise mock_dbus_python.exceptions.DBusException()
1509
 
 
1510
 
        mock_dbus_python = self.MockDBusPython_func(func)
1511
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1127
        class MockObjectManagerFailing(object):
 
1128
            def GetManagedObjects(self):
 
1129
                dbus_logger.error("Test")
 
1130
                raise dbus.exceptions.DBusException("Test")
1512
1131
 
1513
1132
        class CountingHandler(logging.Handler):
1514
1133
            count = 0
1520
1139
        dbus_logger.addHandler(counting_handler)
1521
1140
 
1522
1141
        try:
1523
 
            with self.assertRaises(dbus.Error) as e:
1524
 
                self.call_method(bus, "methodname", "busname",
1525
 
                                 "objectpath", "interface")
 
1142
            with self.assertLogs(log, logging.CRITICAL) as watcher:
 
1143
                with self.assertRaises(SystemExit) as e:
 
1144
                    get_managed_objects(MockObjectManagerFailing())
1526
1145
        finally:
1527
1146
            dbus_logger.removeFilter(counting_handler)
1528
1147
 
1529
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1530
 
 
1531
1148
        # Make sure the dbus logger was suppressed
1532
1149
        self.assertEqual(0, counting_handler.count)
1533
1150
 
1534
 
    def test_Set_Secret_sends_bytearray(self):
1535
 
        ret = [None]
1536
 
        def func(*args, **kwargs):
1537
 
            ret[0] = (args, kwargs)
1538
 
        mock_dbus_python = self.MockDBusPython_func(func)
1539
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1540
 
        bus.set_client_property("objectpath", "Secret", "value")
1541
 
        expected_call = (("se.recompile.Mandos.Client", "Secret",
1542
 
                          mock_dbus_python.ByteArray(b"value")),
1543
 
                         {"dbus_interface":
1544
 
                          "org.freedesktop.DBus.Properties"})
1545
 
        self.assertEqual(expected_call, ret[0])
1546
 
        if sys.version_info.major == 2:
1547
 
            self.assertIsInstance(ret[0][0][-1],
1548
 
                                  mock_dbus_python.ByteArray)
1549
 
 
1550
 
    def test_get_object_converts_to_correct_exception(self):
1551
 
        bus = dbus_python_adapter.SystemBus(
1552
 
            self.fake_dbus_python_raises_exception_on_connect)
1553
 
        with self.assertRaises(dbus.ConnectFailed):
1554
 
            self.call_method(bus, "methodname", "busname",
1555
 
                             "objectpath", "interface")
1556
 
 
1557
 
    class fake_dbus_python_raises_exception_on_connect(object):
1558
 
        """fake dbus-python module"""
1559
 
        class exceptions(object):
1560
 
            """Pseudo-namespace"""
1561
 
            class DBusException(Exception):
1562
 
                pass
1563
 
 
1564
 
        @classmethod
1565
 
        def SystemBus(cls):
1566
 
            def get_object(busname, objectpath):
1567
 
                raise cls.exceptions.DBusException()
1568
 
            Bus = collections.namedtuple("Bus", ["get_object"])
1569
 
            return Bus(get_object=get_object)
1570
 
 
1571
 
 
1572
 
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1573
 
    class mock_dbus_python(object):
1574
 
        """mock dbus-python modules"""
1575
 
        class SystemBus(object):
1576
 
            @staticmethod
1577
 
            def get_object(busname, objectpath):
1578
 
                return Unique()
1579
 
 
1580
 
    def setUp(self):
1581
 
        self.bus = dbus_python_adapter.CachingBus(
1582
 
            self.mock_dbus_python)
1583
 
 
1584
 
    def test_returns_distinct_objectpaths(self):
1585
 
        obj1 = self.bus.get_object("busname", "objectpath1")
1586
 
        self.assertIsInstance(obj1, Unique)
1587
 
        obj2 = self.bus.get_object("busname", "objectpath2")
1588
 
        self.assertIsInstance(obj2, Unique)
1589
 
        self.assertIsNot(obj1, obj2)
1590
 
 
1591
 
    def test_returns_distinct_busnames(self):
1592
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1593
 
        self.assertIsInstance(obj1, Unique)
1594
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1595
 
        self.assertIsInstance(obj2, Unique)
1596
 
        self.assertIsNot(obj1, obj2)
1597
 
 
1598
 
    def test_returns_distinct_both(self):
1599
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1600
 
        self.assertIsInstance(obj1, Unique)
1601
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1602
 
        self.assertIsInstance(obj2, Unique)
1603
 
        self.assertIsNot(obj1, obj2)
1604
 
 
1605
 
    def test_returns_same(self):
1606
 
        obj1 = self.bus.get_object("busname", "objectpath")
1607
 
        self.assertIsInstance(obj1, Unique)
1608
 
        obj2 = self.bus.get_object("busname", "objectpath")
1609
 
        self.assertIsInstance(obj2, Unique)
1610
 
        self.assertIs(obj1, obj2)
1611
 
 
1612
 
    def test_returns_same_old(self):
1613
 
        obj1 = self.bus.get_object("busname1", "objectpath1")
1614
 
        self.assertIsInstance(obj1, Unique)
1615
 
        obj2 = self.bus.get_object("busname2", "objectpath2")
1616
 
        self.assertIsInstance(obj2, Unique)
1617
 
        obj1b = self.bus.get_object("busname1", "objectpath1")
1618
 
        self.assertIsInstance(obj1b, Unique)
1619
 
        self.assertIsNot(obj1, obj2)
1620
 
        self.assertIsNot(obj2, obj1b)
1621
 
        self.assertIs(obj1, obj1b)
1622
 
 
1623
 
 
1624
 
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1625
 
 
1626
 
    def Stub_pydbus_func(self, func):
1627
 
        class stub_pydbus(object):
1628
 
            """stub pydbus module"""
1629
 
            class SystemBus(object):
1630
 
                @staticmethod
1631
 
                def get(busname, objectpath):
1632
 
                    DBusObject = collections.namedtuple(
1633
 
                        "DBusObject", ("methodname",))
1634
 
                    return {"interface":
1635
 
                            DBusObject(methodname=func)}
1636
 
        return stub_pydbus
1637
 
 
1638
 
    def call_method(self, bus, methodname, busname, objectpath,
1639
 
                    interface, *args):
1640
 
        with self.assertLogs(log, logging.DEBUG):
1641
 
            return bus.call_method(methodname, busname, objectpath,
1642
 
                                   interface, *args)
1643
 
 
1644
 
    def test_call_method_returns(self):
1645
 
        expected_method_return = Unique()
1646
 
        method_args = (Unique(), Unique())
1647
 
        def func(*args):
1648
 
            self.assertEqual(len(method_args), len(args))
1649
 
            for marg, arg in zip(method_args, args):
1650
 
                self.assertIs(marg, arg)
1651
 
            return expected_method_return
1652
 
        stub_pydbus = self.Stub_pydbus_func(func)
1653
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1654
 
        ret = self.call_method(bus, "methodname", "busname",
1655
 
                               "objectpath", "interface",
1656
 
                               *method_args)
1657
 
        self.assertIs(ret, expected_method_return)
1658
 
 
1659
 
    def test_call_method_handles_exception(self):
1660
 
        dbus_logger = logging.getLogger("dbus.proxies")
1661
 
 
1662
 
        def func():
1663
 
            raise gi.repository.GLib.Error()
1664
 
 
1665
 
        stub_pydbus = self.Stub_pydbus_func(func)
1666
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1667
 
 
1668
 
        with self.assertRaises(dbus.Error) as e:
1669
 
            self.call_method(bus, "methodname", "busname",
1670
 
                             "objectpath", "interface")
1671
 
 
1672
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1673
 
 
1674
 
    def test_get_converts_to_correct_exception(self):
1675
 
        bus = pydbus_adapter.SystemBus(
1676
 
            self.fake_pydbus_raises_exception_on_connect)
1677
 
        with self.assertRaises(dbus.ConnectFailed):
1678
 
            self.call_method(bus, "methodname", "busname",
1679
 
                             "objectpath", "interface")
1680
 
 
1681
 
    class fake_pydbus_raises_exception_on_connect(object):
1682
 
        """fake dbus-python module"""
1683
 
        @classmethod
1684
 
        def SystemBus(cls):
1685
 
            def get(busname, objectpath):
1686
 
                raise gi.repository.GLib.Error()
1687
 
            Bus = collections.namedtuple("Bus", ["get"])
1688
 
            return Bus(get=get)
1689
 
 
1690
 
    def test_set_property_uses_setattr(self):
1691
 
        class Object(object):
1692
 
            pass
1693
 
        obj = Object()
1694
 
        class pydbus_spy(object):
1695
 
            class SystemBus(object):
1696
 
                @staticmethod
1697
 
                def get(busname, objectpath):
1698
 
                    return {"interface": obj}
1699
 
        bus = pydbus_adapter.SystemBus(pydbus_spy)
1700
 
        value = Unique()
1701
 
        bus.set_property("busname", "objectpath", "interface", "key",
1702
 
                         value)
1703
 
        self.assertIs(value, obj.key)
1704
 
 
1705
 
    def test_get_suppresses_xml_deprecation_warning(self):
1706
 
        if sys.version_info.major >= 3:
1707
 
            return
1708
 
        class stub_pydbus_get(object):
1709
 
            class SystemBus(object):
1710
 
                @staticmethod
1711
 
                def get(busname, objectpath):
1712
 
                    warnings.warn_explicit(
1713
 
                        "deprecated", DeprecationWarning,
1714
 
                        "xml.etree.ElementTree", 0)
1715
 
        bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1716
 
        with warnings.catch_warnings(record=True) as w:
1717
 
            warnings.simplefilter("always")
1718
 
            bus.get("busname", "objectpath")
1719
 
            self.assertEqual(0, len(w))
1720
 
 
1721
 
 
1722
 
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1723
 
    class stub_pydbus(object):
1724
 
        """stub pydbus module"""
1725
 
        class SystemBus(object):
1726
 
            @staticmethod
1727
 
            def get(busname, objectpath):
1728
 
                return Unique()
1729
 
 
1730
 
    def setUp(self):
1731
 
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1732
 
 
1733
 
    def test_returns_distinct_objectpaths(self):
1734
 
        obj1 = self.bus.get("busname", "objectpath1")
1735
 
        self.assertIsInstance(obj1, Unique)
1736
 
        obj2 = self.bus.get("busname", "objectpath2")
1737
 
        self.assertIsInstance(obj2, Unique)
1738
 
        self.assertIsNot(obj1, obj2)
1739
 
 
1740
 
    def test_returns_distinct_busnames(self):
1741
 
        obj1 = self.bus.get("busname1", "objectpath")
1742
 
        self.assertIsInstance(obj1, Unique)
1743
 
        obj2 = self.bus.get("busname2", "objectpath")
1744
 
        self.assertIsInstance(obj2, Unique)
1745
 
        self.assertIsNot(obj1, obj2)
1746
 
 
1747
 
    def test_returns_distinct_both(self):
1748
 
        obj1 = self.bus.get("busname1", "objectpath")
1749
 
        self.assertIsInstance(obj1, Unique)
1750
 
        obj2 = self.bus.get("busname2", "objectpath")
1751
 
        self.assertIsInstance(obj2, Unique)
1752
 
        self.assertIsNot(obj1, obj2)
1753
 
 
1754
 
    def test_returns_same(self):
1755
 
        obj1 = self.bus.get("busname", "objectpath")
1756
 
        self.assertIsInstance(obj1, Unique)
1757
 
        obj2 = self.bus.get("busname", "objectpath")
1758
 
        self.assertIsInstance(obj2, Unique)
1759
 
        self.assertIs(obj1, obj2)
1760
 
 
1761
 
    def test_returns_same_old(self):
1762
 
        obj1 = self.bus.get("busname1", "objectpath1")
1763
 
        self.assertIsInstance(obj1, Unique)
1764
 
        obj2 = self.bus.get("busname2", "objectpath2")
1765
 
        self.assertIsInstance(obj2, Unique)
1766
 
        obj1b = self.bus.get("busname1", "objectpath1")
1767
 
        self.assertIsInstance(obj1b, Unique)
1768
 
        self.assertIsNot(obj1, obj2)
1769
 
        self.assertIsNot(obj2, obj1b)
1770
 
        self.assertIs(obj1, obj1b)
 
1151
        # Test that the dbus_logger still works
 
1152
        with self.assertLogs(dbus_logger, logging.ERROR):
 
1153
            dbus_logger.error("Test")
 
1154
 
 
1155
        if isinstance(e.exception.code, int):
 
1156
            self.assertNotEqual(0, e.exception.code)
 
1157
        else:
 
1158
            self.assertIsNotNone(e.exception.code)
1771
1159
 
1772
1160
 
1773
1161
class Test_commands_from_options(unittest.TestCase):
1774
 
 
1775
1162
    def setUp(self):
1776
1163
        self.parser = argparse.ArgumentParser()
1777
1164
        add_command_line_options(self.parser)
1778
1165
 
1779
1166
    def test_is_enabled(self):
1780
 
        self.assert_command_from_args(["--is-enabled", "client"],
 
1167
        self.assert_command_from_args(["--is-enabled", "foo"],
1781
1168
                                      command.IsEnabled)
1782
1169
 
1783
1170
    def assert_command_from_args(self, args, command_cls,
1794
1181
            self.assertEqual(value, getattr(command, key))
1795
1182
 
1796
1183
    def test_is_enabled_short(self):
1797
 
        self.assert_command_from_args(["-V", "client"],
 
1184
        self.assert_command_from_args(["-V", "foo"],
1798
1185
                                      command.IsEnabled)
1799
1186
 
1800
1187
    def test_approve(self):
1801
 
        self.assert_command_from_args(["--approve", "client"],
 
1188
        self.assert_command_from_args(["--approve", "foo"],
1802
1189
                                      command.Approve)
1803
1190
 
1804
1191
    def test_approve_short(self):
1805
 
        self.assert_command_from_args(["-A", "client"],
1806
 
                                      command.Approve)
 
1192
        self.assert_command_from_args(["-A", "foo"], command.Approve)
1807
1193
 
1808
1194
    def test_deny(self):
1809
 
        self.assert_command_from_args(["--deny", "client"],
1810
 
                                      command.Deny)
 
1195
        self.assert_command_from_args(["--deny", "foo"], command.Deny)
1811
1196
 
1812
1197
    def test_deny_short(self):
1813
 
        self.assert_command_from_args(["-D", "client"], command.Deny)
 
1198
        self.assert_command_from_args(["-D", "foo"], command.Deny)
1814
1199
 
1815
1200
    def test_remove(self):
1816
 
        self.assert_command_from_args(["--remove", "client"],
 
1201
        self.assert_command_from_args(["--remove", "foo"],
1817
1202
                                      command.Remove)
1818
1203
 
1819
1204
    def test_deny_before_remove(self):
1820
1205
        options = self.parser.parse_args(["--deny", "--remove",
1821
 
                                          "client"])
 
1206
                                          "foo"])
1822
1207
        check_option_syntax(self.parser, options)
1823
1208
        commands = commands_from_options(options)
1824
1209
        self.assertEqual(2, len(commands))
1835
1220
        self.assertIsInstance(commands[1], command.Remove)
1836
1221
 
1837
1222
    def test_remove_short(self):
1838
 
        self.assert_command_from_args(["-r", "client"],
1839
 
                                      command.Remove)
 
1223
        self.assert_command_from_args(["-r", "foo"], command.Remove)
1840
1224
 
1841
1225
    def test_dump_json(self):
1842
1226
        self.assert_command_from_args(["--dump-json"],
1843
1227
                                      command.DumpJSON)
1844
1228
 
1845
1229
    def test_enable(self):
1846
 
        self.assert_command_from_args(["--enable", "client"],
 
1230
        self.assert_command_from_args(["--enable", "foo"],
1847
1231
                                      command.Enable)
1848
1232
 
1849
1233
    def test_enable_short(self):
1850
 
        self.assert_command_from_args(["-e", "client"],
1851
 
                                      command.Enable)
 
1234
        self.assert_command_from_args(["-e", "foo"], command.Enable)
1852
1235
 
1853
1236
    def test_disable(self):
1854
 
        self.assert_command_from_args(["--disable", "client"],
 
1237
        self.assert_command_from_args(["--disable", "foo"],
1855
1238
                                      command.Disable)
1856
1239
 
1857
1240
    def test_disable_short(self):
1858
 
        self.assert_command_from_args(["-d", "client"],
1859
 
                                      command.Disable)
 
1241
        self.assert_command_from_args(["-d", "foo"], command.Disable)
1860
1242
 
1861
1243
    def test_bump_timeout(self):
1862
 
        self.assert_command_from_args(["--bump-timeout", "client"],
 
1244
        self.assert_command_from_args(["--bump-timeout", "foo"],
1863
1245
                                      command.BumpTimeout)
1864
1246
 
1865
1247
    def test_bump_timeout_short(self):
1866
 
        self.assert_command_from_args(["-b", "client"],
 
1248
        self.assert_command_from_args(["-b", "foo"],
1867
1249
                                      command.BumpTimeout)
1868
1250
 
1869
1251
    def test_start_checker(self):
1870
 
        self.assert_command_from_args(["--start-checker", "client"],
 
1252
        self.assert_command_from_args(["--start-checker", "foo"],
1871
1253
                                      command.StartChecker)
1872
1254
 
1873
1255
    def test_stop_checker(self):
1874
 
        self.assert_command_from_args(["--stop-checker", "client"],
 
1256
        self.assert_command_from_args(["--stop-checker", "foo"],
1875
1257
                                      command.StopChecker)
1876
1258
 
1877
1259
    def test_approve_by_default(self):
1878
 
        self.assert_command_from_args(["--approve-by-default",
1879
 
                                       "client"],
 
1260
        self.assert_command_from_args(["--approve-by-default", "foo"],
1880
1261
                                      command.ApproveByDefault)
1881
1262
 
1882
1263
    def test_deny_by_default(self):
1883
 
        self.assert_command_from_args(["--deny-by-default", "client"],
 
1264
        self.assert_command_from_args(["--deny-by-default", "foo"],
1884
1265
                                      command.DenyByDefault)
1885
1266
 
1886
1267
    def test_checker(self):
1887
 
        self.assert_command_from_args(["--checker", ":", "client"],
 
1268
        self.assert_command_from_args(["--checker", ":", "foo"],
1888
1269
                                      command.SetChecker,
1889
1270
                                      value_to_set=":")
1890
1271
 
1891
1272
    def test_checker_empty(self):
1892
 
        self.assert_command_from_args(["--checker", "", "client"],
 
1273
        self.assert_command_from_args(["--checker", "", "foo"],
1893
1274
                                      command.SetChecker,
1894
1275
                                      value_to_set="")
1895
1276
 
1896
1277
    def test_checker_short(self):
1897
 
        self.assert_command_from_args(["-c", ":", "client"],
 
1278
        self.assert_command_from_args(["-c", ":", "foo"],
1898
1279
                                      command.SetChecker,
1899
1280
                                      value_to_set=":")
1900
1281
 
1901
1282
    def test_host(self):
1902
 
        self.assert_command_from_args(
1903
 
            ["--host", "client.example.org", "client"],
1904
 
            command.SetHost, value_to_set="client.example.org")
 
1283
        self.assert_command_from_args(["--host", "foo.example.org",
 
1284
                                       "foo"], command.SetHost,
 
1285
                                      value_to_set="foo.example.org")
1905
1286
 
1906
1287
    def test_host_short(self):
1907
 
        self.assert_command_from_args(
1908
 
            ["-H", "client.example.org", "client"], command.SetHost,
1909
 
            value_to_set="client.example.org")
 
1288
        self.assert_command_from_args(["-H", "foo.example.org",
 
1289
                                       "foo"], command.SetHost,
 
1290
                                      value_to_set="foo.example.org")
1910
1291
 
1911
1292
    def test_secret_devnull(self):
1912
1293
        self.assert_command_from_args(["--secret", os.path.devnull,
1913
 
                                       "client"], command.SetSecret,
 
1294
                                       "foo"], command.SetSecret,
1914
1295
                                      value_to_set=b"")
1915
1296
 
1916
1297
    def test_secret_tempfile(self):
1919
1300
            f.write(value)
1920
1301
            f.seek(0)
1921
1302
            self.assert_command_from_args(["--secret", f.name,
1922
 
                                           "client"],
1923
 
                                          command.SetSecret,
 
1303
                                           "foo"], command.SetSecret,
1924
1304
                                          value_to_set=value)
1925
1305
 
1926
1306
    def test_secret_devnull_short(self):
1927
 
        self.assert_command_from_args(["-s", os.path.devnull,
1928
 
                                       "client"], command.SetSecret,
 
1307
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1308
                                      command.SetSecret,
1929
1309
                                      value_to_set=b"")
1930
1310
 
1931
1311
    def test_secret_tempfile_short(self):
1933
1313
            value = b"secret\0xyzzy\nbar"
1934
1314
            f.write(value)
1935
1315
            f.seek(0)
1936
 
            self.assert_command_from_args(["-s", f.name, "client"],
 
1316
            self.assert_command_from_args(["-s", f.name, "foo"],
1937
1317
                                          command.SetSecret,
1938
1318
                                          value_to_set=value)
1939
1319
 
1940
1320
    def test_timeout(self):
1941
 
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
 
1321
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1942
1322
                                      command.SetTimeout,
1943
1323
                                      value_to_set=300000)
1944
1324
 
1945
1325
    def test_timeout_short(self):
1946
 
        self.assert_command_from_args(["-t", "PT5M", "client"],
 
1326
        self.assert_command_from_args(["-t", "PT5M", "foo"],
1947
1327
                                      command.SetTimeout,
1948
1328
                                      value_to_set=300000)
1949
1329
 
1950
1330
    def test_extended_timeout(self):
1951
1331
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1952
 
                                       "client"],
 
1332
                                       "foo"],
1953
1333
                                      command.SetExtendedTimeout,
1954
1334
                                      value_to_set=900000)
1955
1335
 
1956
1336
    def test_interval(self):
1957
 
        self.assert_command_from_args(["--interval", "PT2M",
1958
 
                                       "client"], command.SetInterval,
 
1337
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1338
                                      command.SetInterval,
1959
1339
                                      value_to_set=120000)
1960
1340
 
1961
1341
    def test_interval_short(self):
1962
 
        self.assert_command_from_args(["-i", "PT2M", "client"],
 
1342
        self.assert_command_from_args(["-i", "PT2M", "foo"],
1963
1343
                                      command.SetInterval,
1964
1344
                                      value_to_set=120000)
1965
1345
 
1966
1346
    def test_approval_delay(self):
1967
1347
        self.assert_command_from_args(["--approval-delay", "PT30S",
1968
 
                                       "client"],
 
1348
                                       "foo"],
1969
1349
                                      command.SetApprovalDelay,
1970
1350
                                      value_to_set=30000)
1971
1351
 
1972
1352
    def test_approval_duration(self):
1973
1353
        self.assert_command_from_args(["--approval-duration", "PT1S",
1974
 
                                       "client"],
 
1354
                                       "foo"],
1975
1355
                                      command.SetApprovalDuration,
1976
1356
                                      value_to_set=1000)
1977
1357
 
1992
1372
class TestCommand(unittest.TestCase):
1993
1373
    """Abstract class for tests of command classes"""
1994
1374
 
1995
 
    class FakeMandosBus(dbus.MandosBus):
1996
 
        def __init__(self, testcase):
1997
 
            self.client_properties = {
1998
 
                "Name": "foo",
1999
 
                "KeyID": ("92ed150794387c03ce684574b1139a65"
2000
 
                          "94a34f895daaaf09fd8ea90a27cddb12"),
2001
 
                "Secret": b"secret",
2002
 
                "Host": "foo.example.org",
2003
 
                "Enabled": True,
2004
 
                "Timeout": 300000,
2005
 
                "LastCheckedOK": "2019-02-03T00:00:00",
2006
 
                "Created": "2019-01-02T00:00:00",
2007
 
                "Interval": 120000,
2008
 
                "Fingerprint": ("778827225BA7DE539C5A"
2009
 
                                "7CFA59CFF7CDBD9A5920"),
2010
 
                "CheckerRunning": False,
2011
 
                "LastEnabled": "2019-01-03T00:00:00",
2012
 
                "ApprovalPending": False,
2013
 
                "ApprovedByDefault": True,
2014
 
                "LastApprovalRequest": "",
2015
 
                "ApprovalDelay": 0,
2016
 
                "ApprovalDuration": 1000,
2017
 
                "Checker": "fping -q -- %(host)s",
2018
 
                "ExtendedTimeout": 900000,
2019
 
                "Expires": "2019-02-04T00:00:00",
2020
 
                "LastCheckerStatus": 0,
2021
 
            }
2022
 
            self.other_client_properties = {
2023
 
                "Name": "barbar",
2024
 
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
2025
 
                          "6ab612cff5ad227247e46c2b020f441c"),
2026
 
                "Secret": b"secretbar",
2027
 
                "Host": "192.0.2.3",
2028
 
                "Enabled": True,
2029
 
                "Timeout": 300000,
2030
 
                "LastCheckedOK": "2019-02-04T00:00:00",
2031
 
                "Created": "2019-01-03T00:00:00",
2032
 
                "Interval": 120000,
2033
 
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
2034
 
                                "F547B3A107558FCA3A27"),
2035
 
                "CheckerRunning": True,
2036
 
                "LastEnabled": "2019-01-04T00:00:00",
2037
 
                "ApprovalPending": False,
2038
 
                "ApprovedByDefault": False,
2039
 
                "LastApprovalRequest": "2019-01-03T00:00:00",
2040
 
                "ApprovalDelay": 30000,
2041
 
                "ApprovalDuration": 93785000,
2042
 
                "Checker": ":",
2043
 
                "ExtendedTimeout": 900000,
2044
 
                "Expires": "2019-02-05T00:00:00",
2045
 
                "LastCheckerStatus": -2,
2046
 
            }
2047
 
            self.clients =  collections.OrderedDict(
2048
 
                [
2049
 
                    ("client_objectpath", self.client_properties),
2050
 
                    ("other_client_objectpath",
2051
 
                     self.other_client_properties),
2052
 
                ])
2053
 
            self.one_client = {"client_objectpath":
2054
 
                               self.client_properties}
2055
 
            self.testcase = testcase
2056
 
            self.calls = []
2057
 
 
2058
 
        def call_method(self, methodname, busname, objectpath,
2059
 
                        interface, *args):
2060
 
            self.testcase.assertEqual("se.recompile.Mandos", busname)
2061
 
            self.calls.append((methodname, busname, objectpath,
2062
 
                               interface, args))
2063
 
            if interface == "org.freedesktop.DBus.Properties":
2064
 
                if methodname == "Set":
2065
 
                    self.testcase.assertEqual(3, len(args))
2066
 
                    interface, key, value = args
2067
 
                    self.testcase.assertEqual(
2068
 
                        "se.recompile.Mandos.Client", interface)
2069
 
                    self.clients[objectpath][key] = value
2070
 
                    return
2071
 
            elif interface == "se.recompile.Mandos":
2072
 
                self.testcase.assertEqual("RemoveClient", methodname)
2073
 
                self.testcase.assertEqual(1, len(args))
2074
 
                clientpath = args[0]
2075
 
                del self.clients[clientpath]
2076
 
                return
2077
 
            elif interface == "se.recompile.Mandos.Client":
2078
 
                if methodname == "Approve":
2079
 
                    self.testcase.assertEqual(1, len(args))
2080
 
                    return
2081
 
            raise ValueError()
2082
 
 
2083
1375
    def setUp(self):
2084
 
        self.bus = self.FakeMandosBus(self)
 
1376
        testcase = self
 
1377
        class MockClient(object):
 
1378
            def __init__(self, name, **attributes):
 
1379
                self.__dbus_object_path__ = "/clients/{}".format(name)
 
1380
                self.attributes = attributes
 
1381
                self.attributes["Name"] = name
 
1382
                self.calls = []
 
1383
            def Set(self, interface, propname, value, dbus_interface):
 
1384
                testcase.assertEqual(client_dbus_interface, interface)
 
1385
                testcase.assertEqual(dbus.PROPERTIES_IFACE,
 
1386
                                     dbus_interface)
 
1387
                self.attributes[propname] = value
 
1388
            def Approve(self, approve, dbus_interface):
 
1389
                testcase.assertEqual(client_dbus_interface,
 
1390
                                     dbus_interface)
 
1391
                self.calls.append(("Approve", (approve,
 
1392
                                               dbus_interface)))
 
1393
        self.client = MockClient(
 
1394
            "foo",
 
1395
            KeyID=("92ed150794387c03ce684574b1139a65"
 
1396
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
1397
            Secret=b"secret",
 
1398
            Host="foo.example.org",
 
1399
            Enabled=dbus.Boolean(True),
 
1400
            Timeout=300000,
 
1401
            LastCheckedOK="2019-02-03T00:00:00",
 
1402
            Created="2019-01-02T00:00:00",
 
1403
            Interval=120000,
 
1404
            Fingerprint=("778827225BA7DE539C5A"
 
1405
                         "7CFA59CFF7CDBD9A5920"),
 
1406
            CheckerRunning=dbus.Boolean(False),
 
1407
            LastEnabled="2019-01-03T00:00:00",
 
1408
            ApprovalPending=dbus.Boolean(False),
 
1409
            ApprovedByDefault=dbus.Boolean(True),
 
1410
            LastApprovalRequest="",
 
1411
            ApprovalDelay=0,
 
1412
            ApprovalDuration=1000,
 
1413
            Checker="fping -q -- %(host)s",
 
1414
            ExtendedTimeout=900000,
 
1415
            Expires="2019-02-04T00:00:00",
 
1416
            LastCheckerStatus=0)
 
1417
        self.other_client = MockClient(
 
1418
            "barbar",
 
1419
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
1420
                   "6ab612cff5ad227247e46c2b020f441c"),
 
1421
            Secret=b"secretbar",
 
1422
            Host="192.0.2.3",
 
1423
            Enabled=dbus.Boolean(True),
 
1424
            Timeout=300000,
 
1425
            LastCheckedOK="2019-02-04T00:00:00",
 
1426
            Created="2019-01-03T00:00:00",
 
1427
            Interval=120000,
 
1428
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
1429
                         "F547B3A107558FCA3A27"),
 
1430
            CheckerRunning=dbus.Boolean(True),
 
1431
            LastEnabled="2019-01-04T00:00:00",
 
1432
            ApprovalPending=dbus.Boolean(False),
 
1433
            ApprovedByDefault=dbus.Boolean(False),
 
1434
            LastApprovalRequest="2019-01-03T00:00:00",
 
1435
            ApprovalDelay=30000,
 
1436
            ApprovalDuration=93785000,
 
1437
            Checker=":",
 
1438
            ExtendedTimeout=900000,
 
1439
            Expires="2019-02-05T00:00:00",
 
1440
            LastCheckerStatus=-2)
 
1441
        self.clients =  collections.OrderedDict(
 
1442
            [
 
1443
                ("/clients/foo", self.client.attributes),
 
1444
                ("/clients/barbar", self.other_client.attributes),
 
1445
            ])
 
1446
        self.one_client = {"/clients/foo": self.client.attributes}
 
1447
 
 
1448
    @property
 
1449
    def bus(self):
 
1450
        class Bus(object):
 
1451
            @staticmethod
 
1452
            def get_object(client_bus_name, path):
 
1453
                self.assertEqual(dbus_busname, client_bus_name)
 
1454
                return {
 
1455
                    # Note: "self" here is the TestCmd instance, not
 
1456
                    # the Bus instance, since this is a static method!
 
1457
                    "/clients/foo": self.client,
 
1458
                    "/clients/barbar": self.other_client,
 
1459
                }[path]
 
1460
        return Bus()
2085
1461
 
2086
1462
 
2087
1463
class TestBaseCommands(TestCommand):
2088
1464
 
2089
1465
    def test_IsEnabled_exits_successfully(self):
2090
1466
        with self.assertRaises(SystemExit) as e:
2091
 
            command.IsEnabled().run(self.bus.one_client)
 
1467
            command.IsEnabled().run(self.one_client)
2092
1468
        if e.exception.code is not None:
2093
1469
            self.assertEqual(0, e.exception.code)
2094
1470
        else:
2095
1471
            self.assertIsNone(e.exception.code)
2096
1472
 
2097
1473
    def test_IsEnabled_exits_with_failure(self):
2098
 
        self.bus.client_properties["Enabled"] = False
 
1474
        self.client.attributes["Enabled"] = dbus.Boolean(False)
2099
1475
        with self.assertRaises(SystemExit) as e:
2100
 
            command.IsEnabled().run(self.bus.one_client)
 
1476
            command.IsEnabled().run(self.one_client)
2101
1477
        if isinstance(e.exception.code, int):
2102
1478
            self.assertNotEqual(0, e.exception.code)
2103
1479
        else:
2104
1480
            self.assertIsNotNone(e.exception.code)
2105
1481
 
2106
1482
    def test_Approve(self):
2107
 
        busname = "se.recompile.Mandos"
2108
 
        client_interface = "se.recompile.Mandos.Client"
2109
 
        command.Approve().run(self.bus.clients, self.bus)
2110
 
        for clientpath in self.bus.clients:
2111
 
            self.assertIn(("Approve", busname, clientpath,
2112
 
                           client_interface, (True,)), self.bus.calls)
 
1483
        command.Approve().run(self.clients, self.bus)
 
1484
        for clientpath in self.clients:
 
1485
            client = self.bus.get_object(dbus_busname, clientpath)
 
1486
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1487
                          client.calls)
2113
1488
 
2114
1489
    def test_Deny(self):
2115
 
        busname = "se.recompile.Mandos"
2116
 
        client_interface = "se.recompile.Mandos.Client"
2117
 
        command.Deny().run(self.bus.clients, self.bus)
2118
 
        for clientpath in self.bus.clients:
2119
 
            self.assertIn(("Approve", busname, clientpath,
2120
 
                           client_interface, (False,)),
2121
 
                          self.bus.calls)
 
1490
        command.Deny().run(self.clients, self.bus)
 
1491
        for clientpath in self.clients:
 
1492
            client = self.bus.get_object(dbus_busname, clientpath)
 
1493
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1494
                          client.calls)
2122
1495
 
2123
1496
    def test_Remove(self):
2124
 
        command.Remove().run(self.bus.clients, self.bus)
2125
 
        for clientpath in self.bus.clients:
2126
 
            self.assertIn(("RemoveClient", dbus_busname,
2127
 
                           dbus_server_path, dbus_server_interface,
2128
 
                           (clientpath,)), self.bus.calls)
 
1497
        class MockMandos(object):
 
1498
            def __init__(self):
 
1499
                self.calls = []
 
1500
            def RemoveClient(self, dbus_path):
 
1501
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1502
        mandos = MockMandos()
 
1503
        command.Remove().run(self.clients, self.bus, mandos)
 
1504
        for clientpath in self.clients:
 
1505
            self.assertIn(("RemoveClient", (clientpath,)),
 
1506
                          mandos.calls)
2129
1507
 
2130
1508
    expected_json = {
2131
1509
        "foo": {
2179
1557
    }
2180
1558
 
2181
1559
    def test_DumpJSON_normal(self):
2182
 
        with self.capture_stdout_to_buffer() as buffer:
2183
 
            command.DumpJSON().run(self.bus.clients)
2184
 
        json_data = json.loads(buffer.getvalue())
 
1560
        output = command.DumpJSON().output(self.clients.values())
 
1561
        json_data = json.loads(output)
2185
1562
        self.assertDictEqual(self.expected_json, json_data)
2186
1563
 
2187
 
    @staticmethod
2188
 
    @contextlib.contextmanager
2189
 
    def capture_stdout_to_buffer():
2190
 
        capture_buffer = io.StringIO()
2191
 
        old_stdout = sys.stdout
2192
 
        sys.stdout = capture_buffer
2193
 
        try:
2194
 
            yield capture_buffer
2195
 
        finally:
2196
 
            sys.stdout = old_stdout
2197
 
 
2198
1564
    def test_DumpJSON_one_client(self):
2199
 
        with self.capture_stdout_to_buffer() as buffer:
2200
 
            command.DumpJSON().run(self.bus.one_client)
2201
 
        json_data = json.loads(buffer.getvalue())
 
1565
        output = command.DumpJSON().output(self.one_client.values())
 
1566
        json_data = json.loads(output)
2202
1567
        expected_json = {"foo": self.expected_json["foo"]}
2203
1568
        self.assertDictEqual(expected_json, json_data)
2204
1569
 
2205
1570
    def test_PrintTable_normal(self):
2206
 
        with self.capture_stdout_to_buffer() as buffer:
2207
 
            command.PrintTable().run(self.bus.clients)
 
1571
        output = command.PrintTable().output(self.clients.values())
2208
1572
        expected_output = "\n".join((
2209
1573
            "Name   Enabled Timeout  Last Successful Check",
2210
1574
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
2211
1575
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
2212
 
        )) + "\n"
2213
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1576
        ))
 
1577
        self.assertEqual(expected_output, output)
2214
1578
 
2215
1579
    def test_PrintTable_verbose(self):
2216
 
        with self.capture_stdout_to_buffer() as buffer:
2217
 
            command.PrintTable(verbose=True).run(self.bus.clients)
 
1580
        output = command.PrintTable(verbose=True).output(
 
1581
            self.clients.values())
2218
1582
        columns = (
2219
1583
            (
2220
1584
                "Name   ",
2302
1666
            )
2303
1667
        )
2304
1668
        num_lines = max(len(rows) for rows in columns)
2305
 
        expected_output = ("\n".join("".join(rows[line]
2306
 
                                             for rows in columns)
2307
 
                                     for line in range(num_lines))
2308
 
                           + "\n")
2309
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1669
        expected_output = "\n".join("".join(rows[line]
 
1670
                                            for rows in columns)
 
1671
                                    for line in range(num_lines))
 
1672
        self.assertEqual(expected_output, output)
2310
1673
 
2311
1674
    def test_PrintTable_one_client(self):
2312
 
        with self.capture_stdout_to_buffer() as buffer:
2313
 
            command.PrintTable().run(self.bus.one_client)
 
1675
        output = command.PrintTable().output(self.one_client.values())
2314
1676
        expected_output = "\n".join((
2315
1677
            "Name Enabled Timeout  Last Successful Check",
2316
1678
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
2317
 
        )) + "\n"
2318
 
        self.assertEqual(expected_output, buffer.getvalue())
2319
 
 
2320
 
 
2321
 
class TestPropertySetterCmd(TestCommand):
2322
 
    """Abstract class for tests of command.PropertySetter classes"""
2323
 
 
 
1679
        ))
 
1680
        self.assertEqual(expected_output, output)
 
1681
 
 
1682
 
 
1683
class TestPropertyCmd(TestCommand):
 
1684
    """Abstract class for tests of command.Property classes"""
2324
1685
    def runTest(self):
2325
1686
        if not hasattr(self, "command"):
2326
 
            return              # Abstract TestCase class
2327
 
 
2328
 
        if hasattr(self, "values_to_set"):
2329
 
            cmd_args = [(value,) for value in self.values_to_set]
2330
 
            values_to_get = getattr(self, "values_to_get",
2331
 
                                    self.values_to_set)
2332
 
        else:
2333
 
            cmd_args = [() for x in range(len(self.values_to_get))]
2334
 
            values_to_get = self.values_to_get
2335
 
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2336
 
            for clientpath in self.bus.clients:
2337
 
                self.bus.clients[clientpath][self.propname] = (
2338
 
                    Unique())
2339
 
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
2340
 
            for clientpath in self.bus.clients:
2341
 
                value = (self.bus.clients[clientpath]
2342
 
                         [self.propname])
2343
 
                self.assertNotIsInstance(value, Unique)
 
1687
            return
 
1688
        values_to_get = getattr(self, "values_to_get",
 
1689
                                self.values_to_set)
 
1690
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1691
                                              values_to_get):
 
1692
            for clientpath in self.clients:
 
1693
                client = self.bus.get_object(dbus_busname, clientpath)
 
1694
                old_value = client.attributes[self.propname]
 
1695
                client.attributes[self.propname] = self.Unique()
 
1696
            self.run_command(value_to_set, self.clients)
 
1697
            for clientpath in self.clients:
 
1698
                client = self.bus.get_object(dbus_busname, clientpath)
 
1699
                value = client.attributes[self.propname]
 
1700
                self.assertNotIsInstance(value, self.Unique)
2344
1701
                self.assertEqual(value_to_get, value)
2345
1702
 
2346
 
 
2347
 
class TestEnableCmd(TestPropertySetterCmd):
 
1703
    class Unique(object):
 
1704
        """Class for objects which exist only to be unique objects,
 
1705
since unittest.mock.sentinel only exists in Python 3.3"""
 
1706
 
 
1707
    def run_command(self, value, clients):
 
1708
        self.command().run(clients, self.bus)
 
1709
 
 
1710
 
 
1711
class TestEnableCmd(TestPropertyCmd):
2348
1712
    command = command.Enable
2349
1713
    propname = "Enabled"
2350
 
    values_to_get = [True]
2351
 
 
2352
 
 
2353
 
class TestDisableCmd(TestPropertySetterCmd):
 
1714
    values_to_set = [dbus.Boolean(True)]
 
1715
 
 
1716
 
 
1717
class TestDisableCmd(TestPropertyCmd):
2354
1718
    command = command.Disable
2355
1719
    propname = "Enabled"
2356
 
    values_to_get = [False]
2357
 
 
2358
 
 
2359
 
class TestBumpTimeoutCmd(TestPropertySetterCmd):
 
1720
    values_to_set = [dbus.Boolean(False)]
 
1721
 
 
1722
 
 
1723
class TestBumpTimeoutCmd(TestPropertyCmd):
2360
1724
    command = command.BumpTimeout
2361
1725
    propname = "LastCheckedOK"
2362
 
    values_to_get = [""]
2363
 
 
2364
 
 
2365
 
class TestStartCheckerCmd(TestPropertySetterCmd):
 
1726
    values_to_set = [""]
 
1727
 
 
1728
 
 
1729
class TestStartCheckerCmd(TestPropertyCmd):
2366
1730
    command = command.StartChecker
2367
1731
    propname = "CheckerRunning"
2368
 
    values_to_get = [True]
2369
 
 
2370
 
 
2371
 
class TestStopCheckerCmd(TestPropertySetterCmd):
 
1732
    values_to_set = [dbus.Boolean(True)]
 
1733
 
 
1734
 
 
1735
class TestStopCheckerCmd(TestPropertyCmd):
2372
1736
    command = command.StopChecker
2373
1737
    propname = "CheckerRunning"
2374
 
    values_to_get = [False]
2375
 
 
2376
 
 
2377
 
class TestApproveByDefaultCmd(TestPropertySetterCmd):
 
1738
    values_to_set = [dbus.Boolean(False)]
 
1739
 
 
1740
 
 
1741
class TestApproveByDefaultCmd(TestPropertyCmd):
2378
1742
    command = command.ApproveByDefault
2379
1743
    propname = "ApprovedByDefault"
2380
 
    values_to_get = [True]
2381
 
 
2382
 
 
2383
 
class TestDenyByDefaultCmd(TestPropertySetterCmd):
 
1744
    values_to_set = [dbus.Boolean(True)]
 
1745
 
 
1746
 
 
1747
class TestDenyByDefaultCmd(TestPropertyCmd):
2384
1748
    command = command.DenyByDefault
2385
1749
    propname = "ApprovedByDefault"
2386
 
    values_to_get = [False]
2387
 
 
2388
 
 
2389
 
class TestSetCheckerCmd(TestPropertySetterCmd):
 
1750
    values_to_set = [dbus.Boolean(False)]
 
1751
 
 
1752
 
 
1753
class TestPropertyValueCmd(TestPropertyCmd):
 
1754
    """Abstract class for tests of PropertyValueCmd classes"""
 
1755
 
 
1756
    def runTest(self):
 
1757
        if type(self) is TestPropertyValueCmd:
 
1758
            return
 
1759
        return super(TestPropertyValueCmd, self).runTest()
 
1760
 
 
1761
    def run_command(self, value, clients):
 
1762
        self.command(value).run(clients, self.bus)
 
1763
 
 
1764
 
 
1765
class TestSetCheckerCmd(TestPropertyValueCmd):
2390
1766
    command = command.SetChecker
2391
1767
    propname = "Checker"
2392
1768
    values_to_set = ["", ":", "fping -q -- %s"]
2393
1769
 
2394
1770
 
2395
 
class TestSetHostCmd(TestPropertySetterCmd):
 
1771
class TestSetHostCmd(TestPropertyValueCmd):
2396
1772
    command = command.SetHost
2397
1773
    propname = "Host"
2398
 
    values_to_set = ["192.0.2.3", "client.example.org"]
2399
 
 
2400
 
 
2401
 
class TestSetSecretCmd(TestPropertySetterCmd):
 
1774
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1775
 
 
1776
 
 
1777
class TestSetSecretCmd(TestPropertyValueCmd):
2402
1778
    command = command.SetSecret
2403
1779
    propname = "Secret"
2404
1780
    values_to_set = [io.BytesIO(b""),
2405
1781
                     io.BytesIO(b"secret\0xyzzy\nbar")]
2406
 
    values_to_get = [f.getvalue() for f in values_to_set]
2407
 
 
2408
 
 
2409
 
class TestSetTimeoutCmd(TestPropertySetterCmd):
 
1782
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1783
 
 
1784
 
 
1785
class TestSetTimeoutCmd(TestPropertyValueCmd):
2410
1786
    command = command.SetTimeout
2411
1787
    propname = "Timeout"
2412
1788
    values_to_set = [datetime.timedelta(),
2414
1790
                     datetime.timedelta(seconds=1),
2415
1791
                     datetime.timedelta(weeks=1),
2416
1792
                     datetime.timedelta(weeks=52)]
2417
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2418
 
 
2419
 
 
2420
 
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
 
1793
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1794
 
 
1795
 
 
1796
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2421
1797
    command = command.SetExtendedTimeout
2422
1798
    propname = "ExtendedTimeout"
2423
1799
    values_to_set = [datetime.timedelta(),
2425
1801
                     datetime.timedelta(seconds=1),
2426
1802
                     datetime.timedelta(weeks=1),
2427
1803
                     datetime.timedelta(weeks=52)]
2428
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2429
 
 
2430
 
 
2431
 
class TestSetIntervalCmd(TestPropertySetterCmd):
 
1804
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1805
 
 
1806
 
 
1807
class TestSetIntervalCmd(TestPropertyValueCmd):
2432
1808
    command = command.SetInterval
2433
1809
    propname = "Interval"
2434
1810
    values_to_set = [datetime.timedelta(),
2436
1812
                     datetime.timedelta(seconds=1),
2437
1813
                     datetime.timedelta(weeks=1),
2438
1814
                     datetime.timedelta(weeks=52)]
2439
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2440
 
 
2441
 
 
2442
 
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
 
1815
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1816
 
 
1817
 
 
1818
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2443
1819
    command = command.SetApprovalDelay
2444
1820
    propname = "ApprovalDelay"
2445
1821
    values_to_set = [datetime.timedelta(),
2447
1823
                     datetime.timedelta(seconds=1),
2448
1824
                     datetime.timedelta(weeks=1),
2449
1825
                     datetime.timedelta(weeks=52)]
2450
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2451
 
 
2452
 
 
2453
 
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
 
1826
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1827
 
 
1828
 
 
1829
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2454
1830
    command = command.SetApprovalDuration
2455
1831
    propname = "ApprovalDuration"
2456
1832
    values_to_set = [datetime.timedelta(),
2458
1834
                     datetime.timedelta(seconds=1),
2459
1835
                     datetime.timedelta(weeks=1),
2460
1836
                     datetime.timedelta(weeks=52)]
2461
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
1837
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2462
1838
 
2463
1839
 
2464
1840