273
 
## Classes for commands.
 
275
 
# Abstract classes first
 
276
 
class Command(object):
 
277
 
    """Abstract class for commands"""
 
278
 
    def run(self, mandos, clients):
 
279
 
        """Normal commands should implement run_on_one_client(), but
 
280
 
        commands which want to operate on all clients at the same time
 
281
 
        can override this run() method instead."""
 
283
 
        for client, properties in clients.items():
 
284
 
            self.run_on_one_client(client, properties)
 
286
 
class PrintCmd(Command):
 
287
 
    """Abstract class for commands printing client details"""
 
288
 
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
289
 
                    "Created", "Interval", "Host", "KeyID",
 
290
 
                    "Fingerprint", "CheckerRunning", "LastEnabled",
 
291
 
                    "ApprovalPending", "ApprovedByDefault",
 
292
 
                    "LastApprovalRequest", "ApprovalDelay",
 
293
 
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
 
294
 
                    "Expires", "LastCheckerStatus")
 
295
 
    def run(self, mandos, clients):
 
296
 
        print(self.output(clients))
 
298
 
class PropertyCmd(Command):
 
299
 
    """Abstract class for Actions for setting one client property"""
 
300
 
    def run_on_one_client(self, client, properties):
 
301
 
        """Set the Client's D-Bus property"""
 
302
 
        client.Set(client_interface, self.property, self.value_to_set,
 
303
 
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
305
 
class ValueArgumentMixIn(object):
 
306
 
    """Mixin class for commands taking a value as argument"""
 
307
 
    def __init__(self, value):
 
308
 
        self.value_to_set = value
 
310
 
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
 
311
 
    """Mixin class for commands taking a value argument as
 
314
 
    def value_to_set(self):
 
317
 
    def value_to_set(self, value):
 
318
 
        """When setting, convert value to a datetime.timedelta"""
 
319
 
        self._vts = int(round(value.total_seconds() * 1000))
 
321
 
# Actual (non-abstract) command classes
 
323
 
class PrintTableCmd(PrintCmd):
 
324
 
    def __init__(self, verbose=False):
 
325
 
        self.verbose = verbose
 
327
 
    def output(self, clients):
 
328
 
        default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
 
329
 
        keywords = default_keywords
 
331
 
            keywords = self.all_keywords
 
332
 
        return str(self.TableOfClients(clients.values(), keywords))
 
334
 
    class TableOfClients(object):
 
337
 
            "Enabled": "Enabled",
 
338
 
            "Timeout": "Timeout",
 
339
 
            "LastCheckedOK": "Last Successful Check",
 
340
 
            "LastApprovalRequest": "Last Approval Request",
 
341
 
            "Created": "Created",
 
342
 
            "Interval": "Interval",
 
344
 
            "Fingerprint": "Fingerprint",
 
346
 
            "CheckerRunning": "Check Is Running",
 
347
 
            "LastEnabled": "Last Enabled",
 
348
 
            "ApprovalPending": "Approval Is Pending",
 
349
 
            "ApprovedByDefault": "Approved By Default",
 
350
 
            "ApprovalDelay": "Approval Delay",
 
351
 
            "ApprovalDuration": "Approval Duration",
 
352
 
            "Checker": "Checker",
 
353
 
            "ExtendedTimeout": "Extended Timeout",
 
354
 
            "Expires": "Expires",
 
355
 
            "LastCheckerStatus": "Last Checker Status",
 
358
 
        def __init__(self, clients, keywords, tableheaders=None):
 
359
 
            self.clients = clients
 
360
 
            self.keywords = keywords
 
361
 
            if tableheaders is not None:
 
362
 
                self.tableheaders = tableheaders
 
365
 
            return "\n".join(self.rows())
 
367
 
        if sys.version_info.major == 2:
 
368
 
            __unicode__ = __str__
 
370
 
                return str(self).encode(locale.getpreferredencoding())
 
373
 
            format_string = self.row_formatting_string()
 
374
 
            rows = [self.header_line(format_string)]
 
375
 
            rows.extend(self.client_line(client, format_string)
 
376
 
                        for client in self.clients)
 
379
 
        def row_formatting_string(self):
 
380
 
            "Format string used to format table rows"
 
381
 
            return " ".join("{{{key}:{width}}}".format(
 
382
 
                width=max(len(self.tableheaders[key]),
 
383
 
                          *(len(self.string_from_client(client, key))
 
384
 
                            for client in self.clients)),
 
386
 
                            for key in self.keywords)
 
388
 
        def string_from_client(self, client, key):
 
389
 
            return self.valuetostring(client[key], key)
 
392
 
        def valuetostring(value, keyword):
 
393
 
            if isinstance(value, dbus.Boolean):
 
394
 
                return "Yes" if value else "No"
 
395
 
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
396
 
                           "ApprovalDuration", "ExtendedTimeout"):
 
397
 
                return milliseconds_to_string(value)
 
400
 
        def header_line(self, format_string):
 
401
 
            return format_string.format(**self.tableheaders)
 
403
 
        def client_line(self, client, format_string):
 
404
 
            return format_string.format(
 
405
 
                **{key: self.string_from_client(client, key)
 
406
 
                   for key in self.keywords})
 
410
 
class DumpJSONCmd(PrintCmd):
 
411
 
    def output(self, clients):
 
412
 
        data = {client["Name"]:
 
413
 
                {key: self.dbus_boolean_to_bool(client[key])
 
414
 
                 for key in self.all_keywords}
 
415
 
                for client in clients.values()}
 
416
 
        return json.dumps(data, indent=4, separators=(',', ': '))
 
418
 
    def dbus_boolean_to_bool(value):
 
419
 
        if isinstance(value, dbus.Boolean):
 
423
 
class IsEnabledCmd(Command):
 
424
 
    def run_on_one_client(self, client, properties):
 
425
 
        if self.is_enabled(client, properties):
 
428
 
    def is_enabled(self, client, properties):
 
429
 
        return bool(properties["Enabled"])
 
431
 
class RemoveCmd(Command):
 
432
 
    def run_on_one_client(self, client, properties):
 
433
 
        self.mandos.RemoveClient(client.__dbus_object_path__)
 
435
 
class ApproveCmd(Command):
 
436
 
    def run_on_one_client(self, client, properties):
 
437
 
        client.Approve(dbus.Boolean(True),
 
438
 
                       dbus_interface=client_interface)
 
440
 
class DenyCmd(Command):
 
441
 
    def run_on_one_client(self, client, properties):
 
442
 
        client.Approve(dbus.Boolean(False),
 
443
 
                       dbus_interface=client_interface)
 
445
 
class EnableCmd(PropertyCmd):
 
447
 
    value_to_set = dbus.Boolean(True)
 
449
 
class DisableCmd(PropertyCmd):
 
451
 
    value_to_set = dbus.Boolean(False)
 
453
 
class BumpTimeoutCmd(PropertyCmd):
 
454
 
    property = "LastCheckedOK"
 
457
 
class StartCheckerCmd(PropertyCmd):
 
458
 
    property = "CheckerRunning"
 
459
 
    value_to_set = dbus.Boolean(True)
 
461
 
class StopCheckerCmd(PropertyCmd):
 
462
 
    property = "CheckerRunning"
 
463
 
    value_to_set = dbus.Boolean(False)
 
465
 
class ApproveByDefaultCmd(PropertyCmd):
 
466
 
    property = "ApprovedByDefault"
 
467
 
    value_to_set = dbus.Boolean(True)
 
469
 
class DenyByDefaultCmd(PropertyCmd):
 
470
 
    property = "ApprovedByDefault"
 
471
 
    value_to_set = dbus.Boolean(False)
 
473
 
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
 
476
 
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
 
479
 
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
 
481
 
    def value_to_set(self):
 
484
 
    def value_to_set(self, value):
 
485
 
        """When setting, read data from supplied file object"""
 
486
 
        self._vts = value.read()
 
490
 
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
 
493
 
class SetExtendedTimeoutCmd(PropertyCmd,
 
494
 
                            MillisecondsValueArgumentMixIn):
 
495
 
    property = "ExtendedTimeout"
 
497
 
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
 
498
 
    property = "Interval"
 
500
 
class SetApprovalDelayCmd(PropertyCmd,
 
501
 
                          MillisecondsValueArgumentMixIn):
 
502
 
    property = "ApprovalDelay"
 
504
 
class SetApprovalDurationCmd(PropertyCmd,
 
505
 
                             MillisecondsValueArgumentMixIn):
 
506
 
    property = "ApprovalDuration"
 
508
 
def add_command_line_options(parser):
 
509
 
    parser.add_argument("--version", action="version",
 
510
 
                        version="%(prog)s {}".format(version),
 
511
 
                        help="show version number and exit")
 
512
 
    parser.add_argument("-a", "--all", action="store_true",
 
513
 
                        help="Select all clients")
 
514
 
    parser.add_argument("-v", "--verbose", action="store_true",
 
515
 
                        help="Print all fields")
 
516
 
    parser.add_argument("-j", "--dump-json", action="store_true",
 
517
 
                        help="Dump client data in JSON format")
 
518
 
    enable_disable = parser.add_mutually_exclusive_group()
 
519
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
520
 
                                help="Enable client")
 
521
 
    enable_disable.add_argument("-d", "--disable",
 
523
 
                                help="disable client")
 
524
 
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
525
 
                        help="Bump timeout for client")
 
526
 
    start_stop_checker = parser.add_mutually_exclusive_group()
 
527
 
    start_stop_checker.add_argument("--start-checker",
 
529
 
                                    help="Start checker for client")
 
530
 
    start_stop_checker.add_argument("--stop-checker",
 
532
 
                                    help="Stop checker for client")
 
533
 
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
534
 
                        help="Check if client is enabled")
 
535
 
    parser.add_argument("-r", "--remove", action="store_true",
 
536
 
                        help="Remove client")
 
537
 
    parser.add_argument("-c", "--checker",
 
538
 
                        help="Set checker command for client")
 
539
 
    parser.add_argument("-t", "--timeout", type=string_to_delta,
 
540
 
                        help="Set timeout for client")
 
541
 
    parser.add_argument("--extended-timeout", type=string_to_delta,
 
542
 
                        help="Set extended timeout for client")
 
543
 
    parser.add_argument("-i", "--interval", type=string_to_delta,
 
544
 
                        help="Set checker interval for client")
 
545
 
    approve_deny_default = parser.add_mutually_exclusive_group()
 
546
 
    approve_deny_default.add_argument(
 
547
 
        "--approve-by-default", action="store_true",
 
548
 
        default=None, dest="approved_by_default",
 
549
 
        help="Set client to be approved by default")
 
550
 
    approve_deny_default.add_argument(
 
551
 
        "--deny-by-default", action="store_false",
 
552
 
        dest="approved_by_default",
 
553
 
        help="Set client to be denied by default")
 
554
 
    parser.add_argument("--approval-delay", type=string_to_delta,
 
555
 
                        help="Set delay before client approve/deny")
 
556
 
    parser.add_argument("--approval-duration", type=string_to_delta,
 
557
 
                        help="Set duration of one client approval")
 
558
 
    parser.add_argument("-H", "--host", help="Set host for client")
 
559
 
    parser.add_argument("-s", "--secret",
 
560
 
                        type=argparse.FileType(mode="rb"),
 
561
 
                        help="Set password blob (file) for client")
 
562
 
    approve_deny = parser.add_mutually_exclusive_group()
 
563
 
    approve_deny.add_argument(
 
564
 
        "-A", "--approve", action="store_true",
 
565
 
        help="Approve any current client request")
 
566
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
567
 
                              help="Deny any current client request")
 
568
 
    parser.add_argument("--check", action="store_true",
 
569
 
                        help="Run self-test")
 
570
 
    parser.add_argument("client", nargs="*", help="Client name")
 
 
423
def check_option_syntax(parser, options):
 
 
424
    """Apply additional restrictions on options, not expressible in
 
 
427
    def has_commands(options, commands=None):
 
 
429
            commands = (command.Enable,
 
 
432
                        command.StartChecker,
 
 
438
                        command.SetExtendedTimeout,
 
 
440
                        command.ApproveByDefault,
 
 
441
                        command.DenyByDefault,
 
 
442
                        command.SetApprovalDelay,
 
 
443
                        command.SetApprovalDuration,
 
 
448
        return any(isinstance(cmd, commands)
 
 
449
                   for cmd in options.commands)
 
 
451
    if has_commands(options) and not (options.client or options.all):
 
 
452
        parser.error("Options require clients names or --all.")
 
 
453
    if options.verbose and has_commands(options):
 
 
454
        parser.error("--verbose can only be used alone.")
 
 
455
    if (has_commands(options, (command.DumpJSON,))
 
 
456
        and (options.verbose or len(options.commands) > 1)):
 
 
457
        parser.error("--dump-json can only be used alone.")
 
 
458
    if options.all and not has_commands(options):
 
 
459
        parser.error("--all requires an action.")
 
 
460
    if (has_commands(options, (command.IsEnabled,))
 
 
461
        and len(options.client) > 1):
 
 
462
        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")
 
 
471
    class SystemBus(object):
 
 
473
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
 
 
474
        def get_managed_objects(self, busname, objectpath):
 
 
475
            return self.call_method("GetManagedObjects", busname,
 
 
477
                                    self.object_manager_iface)
 
 
479
        properties_iface = "org.freedesktop.DBus.Properties"
 
 
480
        def set_property(self, busname, objectpath, interface, key,
 
 
482
            self.call_method("Set", busname, objectpath,
 
 
483
                             self.properties_iface, interface, key,
 
 
487
    class MandosBus(SystemBus):
 
 
488
        busname_domain = "se.recompile"
 
 
489
        busname = busname_domain + ".Mandos"
 
 
491
        server_interface = busname_domain + ".Mandos"
 
 
492
        client_interface = busname_domain + ".Mandos.Client"
 
 
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}
 
 
502
        def set_client_property(self, objectpath, key, value):
 
 
503
            return self.set_property(self.busname, objectpath,
 
 
504
                                     self.client_interface, key,
 
 
507
        def call_client_method(self, objectpath, method, *args):
 
 
508
            return self.call_method(method, self.busname, objectpath,
 
 
509
                                    self.client_interface, *args)
 
 
511
        def call_server_method(self, method, *args):
 
 
512
            return self.call_method(method, self.busname,
 
 
514
                                    self.server_interface, *args)
 
 
516
    class Error(Exception):
 
 
519
    class ConnectFailed(Error):
 
 
523
class dbus_python_adapter(object):
 
 
525
    class SystemBus(dbus.MandosBus):
 
 
526
        """Use dbus-python"""
 
 
528
        def __init__(self, module=dbus_python):
 
 
529
            self.dbus_python = module
 
 
530
            self.bus = self.dbus_python.SystemBus()
 
 
532
        @contextlib.contextmanager
 
 
533
        def convert_exception(self, exception_class=dbus.Error):
 
 
536
            except self.dbus_python.exceptions.DBusException as e:
 
 
537
                # This does what "raise from" would do
 
 
538
                exc = exception_class(*e.args)
 
 
542
        def call_method(self, methodname, busname, objectpath,
 
 
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(
 
 
552
                    value = method(*args, dbus_interface=interface)
 
 
553
            return self.type_filter(value)
 
 
555
        def get_object(self, busname, objectpath):
 
 
556
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
 
558
            with self.convert_exception(dbus.ConnectFailed):
 
 
559
                return self.bus.get_object(busname, objectpath)
 
 
561
        def type_filter(self, value):
 
 
562
            """Convert the most bothersome types to Python types"""
 
 
563
            if isinstance(value, self.dbus_python.Boolean):
 
 
565
            if isinstance(value, self.dbus_python.ObjectPath):
 
 
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()}
 
 
574
        def set_client_property(self, objectpath, key, value):
 
 
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,
 
 
583
    class SilenceLogger(object):
 
 
584
        "Simple context manager to silence a particular logger"
 
 
585
        def __init__(self, loggername):
 
 
586
            self.logger = logging.getLogger(loggername)
 
 
589
            self.logger.addFilter(self.nullfilter)
 
 
591
        class NullFilter(logging.Filter):
 
 
592
            def filter(self, record):
 
 
595
        nullfilter = NullFilter()
 
 
597
        def __exit__(self, exc_type, exc_val, exc_tb):
 
 
598
            self.logger.removeFilter(self.nullfilter)
 
 
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):
 
 
609
                return self.object_cache[(busname, objectpath)]
 
 
612
                    dbus_python_adapter.CachingBus,
 
 
613
                    self).get_object(busname, objectpath)
 
 
614
                self.object_cache[(busname, objectpath)]  = new_object
 
 
618
class pydbus_adapter(object):
 
 
619
    class SystemBus(dbus.MandosBus):
 
 
620
        def __init__(self, module=pydbus):
 
 
622
            self.bus = self.pydbus.SystemBus()
 
 
624
        @contextlib.contextmanager
 
 
625
        def convert_exception(self, exception_class=dbus.Error):
 
 
628
            except gi.repository.GLib.Error as e:
 
 
629
                # This does what "raise from" would do
 
 
630
                exc = exception_class(*e.args)
 
 
634
        def call_method(self, methodname, busname, objectpath,
 
 
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():
 
 
644
        def get(self, busname, objectpath):
 
 
645
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
 
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)
 
 
655
                    return self.bus.get(busname, objectpath)
 
 
657
        def set_property(self, busname, objectpath, interface, key,
 
 
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,
 
 
663
            setattr(proxy_object[interface], key, value)
 
 
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):
 
 
673
                return self.object_cache[(busname, objectpath)]
 
 
675
                new_object = (super(pydbus_adapter.CachingBus, self)
 
 
676
                              .get(busname, objectpath))
 
 
677
                self.object_cache[(busname, objectpath)]  = new_object
 
573
681
def commands_from_options(options):
 
577
 
    if options.dump_json:
 
578
 
        commands.append(DumpJSONCmd())
 
581
 
        commands.append(EnableCmd())
 
584
 
        commands.append(DisableCmd())
 
586
 
    if options.bump_timeout:
 
587
 
        commands.append(BumpTimeoutCmd())
 
589
 
    if options.start_checker:
 
590
 
        commands.append(StartCheckerCmd())
 
592
 
    if options.stop_checker:
 
593
 
        commands.append(StopCheckerCmd())
 
595
 
    if options.is_enabled:
 
596
 
        commands.append(IsEnabledCmd())
 
599
 
        commands.append(RemoveCmd())
 
601
 
    if options.checker is not None:
 
602
 
        commands.append(SetCheckerCmd(options.checker))
 
604
 
    if options.timeout is not None:
 
605
 
        commands.append(SetTimeoutCmd(options.timeout))
 
607
 
    if options.extended_timeout:
 
609
 
            SetExtendedTimeoutCmd(options.extended_timeout))
 
611
 
    if options.interval is not None:
 
612
 
        commands.append(SetIntervalCmd(options.interval))
 
614
 
    if options.approved_by_default is not None:
 
615
 
        if options.approved_by_default:
 
616
 
            commands.append(ApproveByDefaultCmd())
 
 
683
    commands = list(options.commands)
 
 
685
    def find_cmd(cmd, commands):
 
 
687
        for i, c in enumerate(commands):
 
 
688
            if isinstance(c, cmd):
 
 
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:]
 
 
698
    for cmd in after_remove:
 
 
699
        if isinstance(cmd, command.Deny):
 
 
700
            before_remove.append(cmd)
 
618
 
            commands.append(DenyByDefaultCmd())
 
620
 
    if options.approval_delay is not None:
 
621
 
        commands.append(SetApprovalDelayCmd(options.approval_delay))
 
623
 
    if options.approval_duration is not None:
 
625
 
            SetApprovalDurationCmd(options.approval_duration))
 
627
 
    if options.host is not None:
 
628
 
        commands.append(SetHostCmd(options.host))
 
630
 
    if options.secret is not None:
 
631
 
        commands.append(SetSecretCmd(options.secret))
 
634
 
        commands.append(ApproveCmd())
 
637
 
        commands.append(DenyCmd())
 
 
702
            cleaned_after.append(cmd)
 
 
703
    if cleaned_after != after_remove:
 
 
704
        commands = before_remove + cleaned_after
 
639
706
    # If no command option has been given, show table of clients,
 
640
707
    # optionally verbosely
 
642
 
        commands.append(PrintTableCmd(verbose=options.verbose))
 
 
709
        commands.append(command.PrintTable(verbose=options.verbose))
 
648
 
    parser = argparse.ArgumentParser()
 
650
 
    add_command_line_options(parser)
 
652
 
    options = parser.parse_args()
 
654
 
    def has_actions(options):
 
655
 
        return any((options.enable,
 
657
 
                    options.bump_timeout,
 
658
 
                    options.start_checker,
 
659
 
                    options.stop_checker,
 
662
 
                    options.checker is not None,
 
663
 
                    options.timeout is not None,
 
664
 
                    options.extended_timeout is not None,
 
665
 
                    options.interval is not None,
 
666
 
                    options.approved_by_default is not None,
 
667
 
                    options.approval_delay is not None,
 
668
 
                    options.approval_duration is not None,
 
669
 
                    options.host is not None,
 
670
 
                    options.secret is not None,
 
674
 
    if has_actions(options) and not (options.client or options.all):
 
675
 
        parser.error("Options require clients names or --all.")
 
676
 
    if options.verbose and has_actions(options):
 
677
 
        parser.error("--verbose can only be used alone.")
 
678
 
    if options.dump_json and (options.verbose
 
679
 
                              or has_actions(options)):
 
680
 
        parser.error("--dump-json can only be used alone.")
 
681
 
    if options.all and not has_actions(options):
 
682
 
        parser.error("--all requires an action.")
 
683
 
    if options.is_enabled and len(options.client) > 1:
 
684
 
        parser.error("--is-enabled requires exactly one client")
 
686
 
    clientnames = options.client
 
689
 
        bus = dbus.SystemBus()
 
690
 
        mandos_dbus_objc = bus.get_object(busname, server_path)
 
691
 
    except dbus.exceptions.DBusException:
 
692
 
        log.critical("Could not connect to Mandos server")
 
695
 
    mandos_serv = dbus.Interface(mandos_dbus_objc,
 
696
 
                                 dbus_interface=server_interface)
 
697
 
    mandos_serv_object_manager = dbus.Interface(
 
698
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
700
 
    # Filter out log message from dbus module
 
701
 
    dbus_logger = logging.getLogger("dbus.proxies")
 
702
 
    class NullFilter(logging.Filter):
 
703
 
        def filter(self, record):
 
705
 
    dbus_filter = NullFilter()
 
707
 
        dbus_logger.addFilter(dbus_filter)
 
708
 
        mandos_clients = {path: ifs_and_props[client_interface]
 
709
 
                          for path, ifs_and_props in
 
710
 
                          mandos_serv_object_manager
 
711
 
                          .GetManagedObjects().items()
 
712
 
                          if client_interface in ifs_and_props}
 
713
 
    except dbus.exceptions.DBusException as e:
 
714
 
        log.critical("Failed to access Mandos server through D-Bus:"
 
718
 
        # restore dbus logger
 
719
 
        dbus_logger.removeFilter(dbus_filter)
 
721
 
    # Compile dict of (clients: properties) to process
 
725
 
        clients = {bus.get_object(busname, path): properties
 
726
 
                   for path, properties in mandos_clients.items()}
 
728
 
        for name in clientnames:
 
729
 
            for path, client in mandos_clients.items():
 
730
 
                if client["Name"] == name:
 
731
 
                    client_objc = bus.get_object(busname, path)
 
732
 
                    clients[client_objc] = client
 
735
 
                log.critical("Client not found on server: %r", name)
 
738
 
    # Run all commands on clients
 
739
 
    commands = commands_from_options(options)
 
740
 
    for command in commands:
 
741
 
        command.run(mandos_serv, clients)
 
 
714
class command(object):
 
 
715
    """A namespace for command classes"""
 
 
718
        """Abstract base class for commands"""
 
 
719
        def run(self, clients, bus=None):
 
 
720
            """Normal commands should implement run_on_one_client(),
 
 
721
but commands which want to operate on all clients at the same time can
 
 
722
override this run() method instead.
 
 
725
            for client, properties in clients.items():
 
 
726
                self.run_on_one_client(client, properties)
 
 
729
    class IsEnabled(Base):
 
 
730
        def run(self, clients, bus=None):
 
 
731
            properties = next(iter(clients.values()))
 
 
732
            if properties["Enabled"]:
 
 
738
        def run_on_one_client(self, client, properties):
 
 
739
            self.bus.call_client_method(client, "Approve", True)
 
 
743
        def run_on_one_client(self, client, properties):
 
 
744
            self.bus.call_client_method(client, "Approve", False)
 
 
748
        def run(self, clients, bus):
 
 
749
            for clientpath in frozenset(clients.keys()):
 
 
750
                bus.call_server_method("RemoveClient", clientpath)
 
 
754
        """Abstract class for commands outputting client details"""
 
 
755
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
 
756
                        "Created", "Interval", "Host", "KeyID",
 
 
757
                        "Fingerprint", "CheckerRunning",
 
 
758
                        "LastEnabled", "ApprovalPending",
 
 
759
                        "ApprovedByDefault", "LastApprovalRequest",
 
 
760
                        "ApprovalDelay", "ApprovalDuration",
 
 
761
                        "Checker", "ExtendedTimeout", "Expires",
 
 
765
    class DumpJSON(Output):
 
 
766
        def run(self, clients, bus=None):
 
 
767
            data = {properties["Name"]:
 
 
768
                    {key: properties[key]
 
 
769
                     for key in self.all_keywords}
 
 
770
                    for properties in clients.values()}
 
 
771
            print(json.dumps(data, indent=4, separators=(',', ': ')))
 
 
774
    class PrintTable(Output):
 
 
775
        def __init__(self, verbose=False):
 
 
776
            self.verbose = verbose
 
 
778
        def run(self, clients, bus=None):
 
 
779
            default_keywords = ("Name", "Enabled", "Timeout",
 
 
781
            keywords = default_keywords
 
 
783
                keywords = self.all_keywords
 
 
784
            print(self.TableOfClients(clients.values(), keywords))
 
 
786
        class TableOfClients(object):
 
 
789
                "Enabled": "Enabled",
 
 
790
                "Timeout": "Timeout",
 
 
791
                "LastCheckedOK": "Last Successful Check",
 
 
792
                "LastApprovalRequest": "Last Approval Request",
 
 
793
                "Created": "Created",
 
 
794
                "Interval": "Interval",
 
 
796
                "Fingerprint": "Fingerprint",
 
 
798
                "CheckerRunning": "Check Is Running",
 
 
799
                "LastEnabled": "Last Enabled",
 
 
800
                "ApprovalPending": "Approval Is Pending",
 
 
801
                "ApprovedByDefault": "Approved By Default",
 
 
802
                "ApprovalDelay": "Approval Delay",
 
 
803
                "ApprovalDuration": "Approval Duration",
 
 
804
                "Checker": "Checker",
 
 
805
                "ExtendedTimeout": "Extended Timeout",
 
 
806
                "Expires": "Expires",
 
 
807
                "LastCheckerStatus": "Last Checker Status",
 
 
810
            def __init__(self, clients, keywords):
 
 
811
                self.clients = clients
 
 
812
                self.keywords = keywords
 
 
815
                return "\n".join(self.rows())
 
 
817
            if sys.version_info.major == 2:
 
 
818
                __unicode__ = __str__
 
 
820
                    return str(self).encode(
 
 
821
                        locale.getpreferredencoding())
 
 
824
                format_string = self.row_formatting_string()
 
 
825
                rows = [self.header_line(format_string)]
 
 
826
                rows.extend(self.client_line(client, format_string)
 
 
827
                            for client in self.clients)
 
 
830
            def row_formatting_string(self):
 
 
831
                "Format string used to format table rows"
 
 
832
                return " ".join("{{{key}:{width}}}".format(
 
 
833
                    width=max(len(self.tableheaders[key]),
 
 
834
                              *(len(self.string_from_client(client,
 
 
836
                                for client in self.clients)),
 
 
838
                                for key in self.keywords)
 
 
840
            def string_from_client(self, client, key):
 
 
841
                return self.valuetostring(client[key], key)
 
 
844
            def valuetostring(cls, value, keyword):
 
 
845
                if isinstance(value, bool):
 
 
846
                    return "Yes" if value else "No"
 
 
847
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
 
848
                               "ApprovalDuration", "ExtendedTimeout"):
 
 
849
                    return cls.milliseconds_to_string(value)
 
 
852
            def header_line(self, format_string):
 
 
853
                return format_string.format(**self.tableheaders)
 
 
855
            def client_line(self, client, format_string):
 
 
856
                return format_string.format(
 
 
857
                    **{key: self.string_from_client(client, key)
 
 
858
                       for key in self.keywords})
 
 
861
            def milliseconds_to_string(ms):
 
 
862
                td = datetime.timedelta(0, 0, 0, ms)
 
 
863
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
 
864
                        .format(days="{}T".format(td.days)
 
 
866
                                hours=td.seconds // 3600,
 
 
867
                                minutes=(td.seconds % 3600) // 60,
 
 
868
                                seconds=td.seconds % 60))
 
 
871
    class PropertySetter(Base):
 
 
872
        "Abstract class for Actions for setting one client property"
 
 
874
        def run_on_one_client(self, client, properties=None):
 
 
875
            """Set the Client's D-Bus property"""
 
 
876
            self.bus.set_client_property(client, self.propname,
 
 
881
            raise NotImplementedError()
 
 
884
    class Enable(PropertySetter):
 
 
889
    class Disable(PropertySetter):
 
 
894
    class BumpTimeout(PropertySetter):
 
 
895
        propname = "LastCheckedOK"
 
 
899
    class StartChecker(PropertySetter):
 
 
900
        propname = "CheckerRunning"
 
 
904
    class StopChecker(PropertySetter):
 
 
905
        propname = "CheckerRunning"
 
 
909
    class ApproveByDefault(PropertySetter):
 
 
910
        propname = "ApprovedByDefault"
 
 
914
    class DenyByDefault(PropertySetter):
 
 
915
        propname = "ApprovedByDefault"
 
 
919
    class PropertySetterValue(PropertySetter):
 
 
920
        """Abstract class for PropertySetter recieving a value as
 
 
921
constructor argument instead of a class attribute."""
 
 
922
        def __init__(self, value):
 
 
923
            self.value_to_set = value
 
 
926
        def argparse(cls, argtype):
 
 
928
                return cls(argtype(arg))
 
 
931
    class SetChecker(PropertySetterValue):
 
 
935
    class SetHost(PropertySetterValue):
 
 
939
    class SetSecret(PropertySetterValue):
 
 
943
        def value_to_set(self):
 
 
947
        def value_to_set(self, value):
 
 
948
            """When setting, read data from supplied file object"""
 
 
949
            self._vts = value.read()
 
 
953
    class PropertySetterValueMilliseconds(PropertySetterValue):
 
 
954
        """Abstract class for PropertySetterValue taking a value
 
 
955
argument as a datetime.timedelta() but should store it as
 
 
959
        def value_to_set(self):
 
 
963
        def value_to_set(self, value):
 
 
964
            "When setting, convert value from a datetime.timedelta"
 
 
965
            self._vts = int(round(value.total_seconds() * 1000))
 
 
968
    class SetTimeout(PropertySetterValueMilliseconds):
 
 
972
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
 
 
973
        propname = "ExtendedTimeout"
 
 
976
    class SetInterval(PropertySetterValueMilliseconds):
 
 
977
        propname = "Interval"
 
 
980
    class SetApprovalDelay(PropertySetterValueMilliseconds):
 
 
981
        propname = "ApprovalDelay"
 
 
984
    class SetApprovalDuration(PropertySetterValueMilliseconds):
 
 
985
        propname = "ApprovalDuration"
 
744
 
class Test_milliseconds_to_string(unittest.TestCase):
 
746
 
        self.assertEqual(milliseconds_to_string(93785000),
 
748
 
    def test_no_days(self):
 
749
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
750
 
    def test_all_zero(self):
 
751
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
752
 
    def test_no_fractional_seconds(self):
 
753
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
754
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
755
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
757
 
class Test_string_to_delta(unittest.TestCase):
 
758
 
    def test_handles_basic_rfc3339(self):
 
759
 
        self.assertEqual(string_to_delta("PT0S"),
 
760
 
                         datetime.timedelta())
 
761
 
        self.assertEqual(string_to_delta("P0D"),
 
762
 
                         datetime.timedelta())
 
763
 
        self.assertEqual(string_to_delta("PT1S"),
 
764
 
                         datetime.timedelta(0, 1))
 
765
 
        self.assertEqual(string_to_delta("PT2H"),
 
766
 
                         datetime.timedelta(0, 7200))
 
 
989
class TestCaseWithAssertLogs(unittest.TestCase):
 
 
990
    """unittest.TestCase.assertLogs only exists in Python 3.4"""
 
 
992
    if not hasattr(unittest.TestCase, "assertLogs"):
 
 
993
        @contextlib.contextmanager
 
 
994
        def assertLogs(self, logger, level=logging.INFO):
 
 
995
            capturing_handler = self.CapturingLevelHandler(level)
 
 
996
            old_level = logger.level
 
 
997
            old_propagate = logger.propagate
 
 
998
            logger.addHandler(capturing_handler)
 
 
999
            logger.setLevel(level)
 
 
1000
            logger.propagate = False
 
 
1002
                yield capturing_handler.watcher
 
 
1004
                logger.propagate = old_propagate
 
 
1005
                logger.removeHandler(capturing_handler)
 
 
1006
                logger.setLevel(old_level)
 
 
1007
            self.assertGreater(len(capturing_handler.watcher.records),
 
 
1010
        class CapturingLevelHandler(logging.Handler):
 
 
1011
            def __init__(self, level, *args, **kwargs):
 
 
1012
                logging.Handler.__init__(self, *args, **kwargs)
 
 
1013
                self.watcher = self.LoggingWatcher([], [])
 
 
1014
            def emit(self, record):
 
 
1015
                self.watcher.records.append(record)
 
 
1016
                self.watcher.output.append(self.format(record))
 
 
1018
            LoggingWatcher = collections.namedtuple("LoggingWatcher",
 
 
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"""
 
 
1028
class Test_string_to_delta(TestCaseWithAssertLogs):
 
 
1029
    # Just test basic RFC 3339 functionality here, the doc string for
 
 
1030
    # rfc3339_duration_to_delta() already has more comprehensive
 
 
1031
    # tests, which are run by doctest.
 
 
1033
    def test_rfc3339_zero_seconds(self):
 
 
1034
        self.assertEqual(datetime.timedelta(),
 
 
1035
                         string_to_delta("PT0S"))
 
 
1037
    def test_rfc3339_zero_days(self):
 
 
1038
        self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
 
 
1040
    def test_rfc3339_one_second(self):
 
 
1041
        self.assertEqual(datetime.timedelta(0, 1),
 
 
1042
                         string_to_delta("PT1S"))
 
 
1044
    def test_rfc3339_two_hours(self):
 
 
1045
        self.assertEqual(datetime.timedelta(0, 7200),
 
 
1046
                         string_to_delta("PT2H"))
 
767
1048
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
768
 
        # assertLogs only exists in Python 3.4
 
769
 
        if hasattr(self, "assertLogs"):
 
770
 
            with self.assertLogs(log, logging.WARNING):
 
771
 
                value = string_to_delta("2h")
 
 
1049
        with self.assertLogs(log, logging.WARNING):
 
 
1050
            value = string_to_delta("2h")
 
 
1051
        self.assertEqual(datetime.timedelta(0, 7200), value)
 
 
1054
class Test_check_option_syntax(unittest.TestCase):
 
 
1056
        self.parser = argparse.ArgumentParser()
 
 
1057
        add_command_line_options(self.parser)
 
 
1059
    def test_actions_requires_client_or_all(self):
 
 
1060
        for action, value in self.actions.items():
 
 
1061
            args = self.actionargs(action, value)
 
 
1062
            with self.assertParseError():
 
 
1063
                self.parse_args(args)
 
 
1065
    # This mostly corresponds to the definition from has_commands() in
 
 
1066
    # check_option_syntax()
 
 
1070
        "--bump-timeout": None,
 
 
1071
        "--start-checker": None,
 
 
1072
        "--stop-checker": None,
 
 
1073
        "--is-enabled": None,
 
 
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",
 
 
1090
    def actionargs(action, value, *args):
 
 
1091
        if value is not None:
 
 
1092
            return [action, value] + list(args)
 
773
 
            class WarningFilter(logging.Filter):
 
774
 
                """Don't show, but record the presence of, warnings"""
 
775
 
                def filter(self, record):
 
776
 
                    is_warning = record.levelno >= logging.WARNING
 
777
 
                    self.found = is_warning or getattr(self, "found",
 
779
 
                    return not is_warning
 
780
 
            warning_filter = WarningFilter()
 
781
 
            log.addFilter(warning_filter)
 
 
1094
            return [action] + list(args)
 
 
1096
    @contextlib.contextmanager
 
 
1097
    def assertParseError(self):
 
 
1098
        with self.assertRaises(SystemExit) as e:
 
 
1099
            with self.redirect_stderr_to_devnull():
 
 
1101
        # Exit code from argparse is guaranteed to be "2".  Reference:
 
 
1102
        # https://docs.python.org/3/library
 
 
1103
        # /argparse.html#exiting-methods
 
 
1104
        self.assertEqual(2, e.exception.code)
 
 
1106
    def parse_args(self, args):
 
 
1107
        options = self.parser.parse_args(args)
 
 
1108
        check_option_syntax(self.parser, options)
 
 
1111
    @contextlib.contextmanager
 
 
1112
    def redirect_stderr_to_devnull():
 
 
1113
        old_stderr = sys.stderr
 
 
1114
        with contextlib.closing(open(os.devnull, "w")) as null:
 
783
 
                value = string_to_delta("2h")
 
785
 
                log.removeFilter(warning_filter)
 
786
 
            self.assertTrue(getattr(warning_filter, "found", False))
 
787
 
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
790
 
class TestCmd(unittest.TestCase):
 
 
1119
                sys.stderr = old_stderr
 
 
1121
    def check_option_syntax(self, options):
 
 
1122
        check_option_syntax(self.parser, options)
 
 
1124
    def test_actions_all_conflicts_with_verbose(self):
 
 
1125
        for action, value in self.actions.items():
 
 
1126
            args = self.actionargs(action, value, "--all",
 
 
1128
            with self.assertParseError():
 
 
1129
                self.parse_args(args)
 
 
1131
    def test_actions_with_client_conflicts_with_verbose(self):
 
 
1132
        for action, value in self.actions.items():
 
 
1133
            args = self.actionargs(action, value, "--verbose",
 
 
1135
            with self.assertParseError():
 
 
1136
                self.parse_args(args)
 
 
1138
    def test_dump_json_conflicts_with_verbose(self):
 
 
1139
        args = ["--dump-json", "--verbose"]
 
 
1140
        with self.assertParseError():
 
 
1141
            self.parse_args(args)
 
 
1143
    def test_dump_json_conflicts_with_action(self):
 
 
1144
        for action, value in self.actions.items():
 
 
1145
            args = self.actionargs(action, value, "--dump-json")
 
 
1146
            with self.assertParseError():
 
 
1147
                self.parse_args(args)
 
 
1149
    def test_all_can_not_be_alone(self):
 
 
1151
        with self.assertParseError():
 
 
1152
            self.parse_args(args)
 
 
1154
    def test_all_is_ok_with_any_action(self):
 
 
1155
        for action, value in self.actions.items():
 
 
1156
            args = self.actionargs(action, value, "--all")
 
 
1157
            self.parse_args(args)
 
 
1159
    def test_any_action_is_ok_with_one_client(self):
 
 
1160
        for action, value in self.actions.items():
 
 
1161
            args = self.actionargs(action, value, "client")
 
 
1162
            self.parse_args(args)
 
 
1164
    def test_one_client_with_all_actions_except_is_enabled(self):
 
 
1165
        for action, value in self.actions.items():
 
 
1166
            if action == "--is-enabled":
 
 
1168
            args = self.actionargs(action, value, "client")
 
 
1169
            self.parse_args(args)
 
 
1171
    def test_two_clients_with_all_actions_except_is_enabled(self):
 
 
1172
        for action, value in self.actions.items():
 
 
1173
            if action == "--is-enabled":
 
 
1175
            args = self.actionargs(action, value, "client1",
 
 
1177
            self.parse_args(args)
 
 
1179
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
 
 
1180
        for action, value in self.actions.items():
 
 
1181
            if action == "--is-enabled":
 
 
1183
            args = self.actionargs(action, value, "client1",
 
 
1185
            self.parse_args(args)
 
 
1187
    def test_is_enabled_fails_without_client(self):
 
 
1188
        args = ["--is-enabled"]
 
 
1189
        with self.assertParseError():
 
 
1190
            self.parse_args(args)
 
 
1192
    def test_is_enabled_fails_with_two_clients(self):
 
 
1193
        args = ["--is-enabled", "client1", "client2"]
 
 
1194
        with self.assertParseError():
 
 
1195
            self.parse_args(args)
 
 
1197
    def test_remove_can_only_be_combined_with_action_deny(self):
 
 
1198
        for action, value in self.actions.items():
 
 
1199
            if action in {"--remove", "--deny"}:
 
 
1201
            args = self.actionargs(action, value, "--all",
 
 
1203
            with self.assertParseError():
 
 
1204
                self.parse_args(args)
 
 
1207
class Test_dbus_exceptions(unittest.TestCase):
 
 
1209
    def test_dbus_ConnectFailed_is_Error(self):
 
 
1210
        with self.assertRaises(dbus.Error):
 
 
1211
            raise dbus.ConnectFailed()
 
 
1214
class Test_dbus_MandosBus(unittest.TestCase):
 
 
1216
    class MockMandosBus(dbus.MandosBus):
 
 
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"
 
 
1223
            self.call_method_return = Unique()
 
 
1225
        def call_method(self, methodname, busname, objectpath,
 
 
1227
            self.calls.append((methodname, busname, objectpath,
 
 
1229
            return self.call_method_return
 
 
1232
        self.bus = self.MockMandosBus()
 
 
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)
 
 
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)
 
 
1248
    def test_call_client_method_with_args(self):
 
 
1249
        args = (Unique(), Unique())
 
 
1250
        ret = self.bus.call_client_method("objectpath", "methodname",
 
 
1252
        self.assertIs(self.bus.call_method_return, ret)
 
 
1253
        expected_call = ("methodname", self.bus._name, "objectpath",
 
 
1254
                         self.bus._client_interface,
 
 
1256
        self.assertIn(expected_call, self.bus.calls)
 
 
1258
    def test_get_clients_and_properties(self):
 
 
1261
                self.bus._client_interface: {
 
 
1265
                "irrelevant_interface": {
 
 
1266
                    "key": "othervalue",
 
 
1270
            "other_objectpath": {
 
 
1271
                "other_irrelevant_interface": {
 
 
1277
        expected_clients_and_properties = {
 
 
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)
 
 
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)
 
 
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,
 
 
1307
        self.assertIn(expected_call, self.bus.calls)
 
 
1310
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
 
 
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):
 
 
1319
            class SystemBus(object):
 
 
1321
                def get_object(busname, objectpath):
 
 
1322
                    DBusObject = collections.namedtuple(
 
 
1323
                        "DBusObject", ("methodname", "Set"))
 
 
1324
                    def method(*args, **kwargs):
 
 
1325
                        self.assertEqual({"dbus_interface":
 
 
1329
                    def set_property(interface, key, value,
 
 
1330
                                     dbus_interface=None):
 
 
1332
                            "org.freedesktop.DBus.Properties",
 
 
1334
                        self.assertEqual("Secret", key)
 
 
1335
                        return func(interface, key, value,
 
 
1336
                                    dbus_interface=dbus_interface)
 
 
1337
                    return DBusObject(methodname=method,
 
 
1339
            class Boolean(object):
 
 
1340
                def __init__(self, value):
 
 
1341
                    self.value = bool(value)
 
 
1344
                if sys.version_info.major == 2:
 
 
1345
                    __nonzero__ = __bool__
 
 
1346
            class ObjectPath(str):
 
 
1348
            class Dictionary(dict):
 
 
1350
            class ByteArray(bytes):
 
 
1352
        return mock_dbus_python
 
 
1354
    def call_method(self, bus, methodname, busname, objectpath,
 
 
1356
        with self.assertLogs(log, logging.DEBUG):
 
 
1357
            return bus.call_method(methodname, busname, objectpath,
 
 
1360
    def test_call_method_returns(self):
 
 
1361
        expected_method_return = Unique()
 
 
1362
        method_args = (Unique(), Unique())
 
 
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",
 
 
1373
        self.assertIs(ret, expected_method_return)
 
 
1375
    def test_call_method_filters_bool_true(self):
 
 
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)
 
 
1386
    def test_call_method_filters_bool_false(self):
 
 
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)
 
 
1397
    def test_call_method_filters_objectpath(self):
 
 
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)
 
 
1409
    def test_call_method_filters_booleans_in_dict(self):
 
 
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,
 
 
1423
        self.assertEqual(expected_method_return, ret)
 
 
1424
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
 
1426
    def test_call_method_filters_objectpaths_in_dict(self):
 
 
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)
 
 
1440
                                  method_return.items()}
 
 
1441
        self.assertEqual(expected_method_return, ret)
 
 
1442
        self.assertIsInstance(ret, dict)
 
 
1443
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
 
1445
    def test_call_method_filters_dict_in_dict(self):
 
 
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"},
 
 
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)
 
 
1472
    def test_call_method_filters_dict_three_deep(self):
 
 
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(
 
 
1479
             mock_dbus_python.Dictionary(
 
 
1481
                  mock_dbus_python.Dictionary(
 
 
1483
                       mock_dbus_python.Boolean(True),
 
 
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)
 
 
1503
    def test_call_method_handles_exception(self):
 
 
1504
        dbus_logger = logging.getLogger("dbus.proxies")
 
 
1507
            dbus_logger.error("Test")
 
 
1508
            raise mock_dbus_python.exceptions.DBusException()
 
 
1510
        mock_dbus_python = self.MockDBusPython_func(func)
 
 
1511
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
 
1513
        class CountingHandler(logging.Handler):
 
 
1515
            def emit(self, record):
 
 
1518
        counting_handler = CountingHandler()
 
 
1520
        dbus_logger.addHandler(counting_handler)
 
 
1523
            with self.assertRaises(dbus.Error) as e:
 
 
1524
                self.call_method(bus, "methodname", "busname",
 
 
1525
                                 "objectpath", "interface")
 
 
1527
            dbus_logger.removeFilter(counting_handler)
 
 
1529
        self.assertNotIsInstance(e, dbus.ConnectFailed)
 
 
1531
        # Make sure the dbus logger was suppressed
 
 
1532
        self.assertEqual(0, counting_handler.count)
 
 
1534
    def test_Set_Secret_sends_bytearray(self):
 
 
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")),
 
 
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)
 
 
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")
 
 
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):
 
 
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)
 
 
1572
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
 
 
1573
    class mock_dbus_python(object):
 
 
1574
        """mock dbus-python modules"""
 
 
1575
        class SystemBus(object):
 
 
1577
            def get_object(busname, objectpath):
 
 
1581
        self.bus = dbus_python_adapter.CachingBus(
 
 
1582
            self.mock_dbus_python)
 
 
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)
 
 
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)
 
 
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)
 
 
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)
 
 
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)
 
 
1624
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
 
 
1626
    def Stub_pydbus_func(self, func):
 
 
1627
        class stub_pydbus(object):
 
 
1628
            """stub pydbus module"""
 
 
1629
            class SystemBus(object):
 
 
1631
                def get(busname, objectpath):
 
 
1632
                    DBusObject = collections.namedtuple(
 
 
1633
                        "DBusObject", ("methodname",))
 
 
1634
                    return {"interface":
 
 
1635
                            DBusObject(methodname=func)}
 
 
1638
    def call_method(self, bus, methodname, busname, objectpath,
 
 
1640
        with self.assertLogs(log, logging.DEBUG):
 
 
1641
            return bus.call_method(methodname, busname, objectpath,
 
 
1644
    def test_call_method_returns(self):
 
 
1645
        expected_method_return = Unique()
 
 
1646
        method_args = (Unique(), Unique())
 
 
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",
 
 
1657
        self.assertIs(ret, expected_method_return)
 
 
1659
    def test_call_method_handles_exception(self):
 
 
1660
        dbus_logger = logging.getLogger("dbus.proxies")
 
 
1663
            raise gi.repository.GLib.Error()
 
 
1665
        stub_pydbus = self.Stub_pydbus_func(func)
 
 
1666
        bus = pydbus_adapter.SystemBus(stub_pydbus)
 
 
1668
        with self.assertRaises(dbus.Error) as e:
 
 
1669
            self.call_method(bus, "methodname", "busname",
 
 
1670
                             "objectpath", "interface")
 
 
1672
        self.assertNotIsInstance(e, dbus.ConnectFailed)
 
 
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")
 
 
1681
    class fake_pydbus_raises_exception_on_connect(object):
 
 
1682
        """fake dbus-python module"""
 
 
1685
            def get(busname, objectpath):
 
 
1686
                raise gi.repository.GLib.Error()
 
 
1687
            Bus = collections.namedtuple("Bus", ["get"])
 
 
1690
    def test_set_property_uses_setattr(self):
 
 
1691
        class Object(object):
 
 
1694
        class pydbus_spy(object):
 
 
1695
            class SystemBus(object):
 
 
1697
                def get(busname, objectpath):
 
 
1698
                    return {"interface": obj}
 
 
1699
        bus = pydbus_adapter.SystemBus(pydbus_spy)
 
 
1701
        bus.set_property("busname", "objectpath", "interface", "key",
 
 
1703
        self.assertIs(value, obj.key)
 
 
1705
    def test_get_suppresses_xml_deprecation_warning(self):
 
 
1706
        if sys.version_info.major >= 3:
 
 
1708
        class stub_pydbus_get(object):
 
 
1709
            class SystemBus(object):
 
 
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))
 
 
1722
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
 
 
1723
    class stub_pydbus(object):
 
 
1724
        """stub pydbus module"""
 
 
1725
        class SystemBus(object):
 
 
1727
            def get(busname, objectpath):
 
 
1731
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
 
 
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)
 
 
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)
 
 
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)
 
 
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)
 
 
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)
 
 
1773
class Test_commands_from_options(unittest.TestCase):
 
 
1776
        self.parser = argparse.ArgumentParser()
 
 
1777
        add_command_line_options(self.parser)
 
 
1779
    def test_is_enabled(self):
 
 
1780
        self.assert_command_from_args(["--is-enabled", "client"],
 
 
1783
    def assert_command_from_args(self, args, command_cls, length=1,
 
 
1784
                                 clients=None, **cmd_attrs):
 
 
1785
        """Assert that parsing ARGS should result in an instance of
 
 
1786
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
 
 
1787
        options = self.parser.parse_args(args)
 
 
1788
        check_option_syntax(self.parser, options)
 
 
1789
        commands = commands_from_options(options)
 
 
1790
        self.assertEqual(length, len(commands))
 
 
1791
        for command in commands:
 
 
1792
            if isinstance(command, command_cls):
 
 
1795
            self.assertIsInstance(command, command_cls)
 
 
1796
        if clients is not None:
 
 
1797
            self.assertEqual(clients, options.client)
 
 
1798
        for key, value in cmd_attrs.items():
 
 
1799
            self.assertEqual(value, getattr(command, key))
 
 
1801
    def assert_commands_from_args(self, args, commands, clients=None):
 
 
1802
        for cmd in commands:
 
 
1803
            self.assert_command_from_args(args, cmd,
 
 
1804
                                          length=len(commands),
 
 
1807
    def test_is_enabled_short(self):
 
 
1808
        self.assert_command_from_args(["-V", "client"],
 
 
1811
    def test_approve(self):
 
 
1812
        self.assert_command_from_args(["--approve", "client"],
 
 
1815
    def test_approve_short(self):
 
 
1816
        self.assert_command_from_args(["-A", "client"],
 
 
1819
    def test_deny(self):
 
 
1820
        self.assert_command_from_args(["--deny", "client"],
 
 
1823
    def test_deny_short(self):
 
 
1824
        self.assert_command_from_args(["-D", "client"], command.Deny)
 
 
1826
    def test_remove(self):
 
 
1827
        self.assert_command_from_args(["--remove", "client"],
 
 
1830
    def test_deny_before_remove(self):
 
 
1831
        options = self.parser.parse_args(["--deny", "--remove",
 
 
1833
        check_option_syntax(self.parser, options)
 
 
1834
        commands = commands_from_options(options)
 
 
1835
        self.assertEqual(2, len(commands))
 
 
1836
        self.assertIsInstance(commands[0], command.Deny)
 
 
1837
        self.assertIsInstance(commands[1], command.Remove)
 
 
1839
    def test_deny_before_remove_reversed(self):
 
 
1840
        options = self.parser.parse_args(["--remove", "--deny",
 
 
1842
        check_option_syntax(self.parser, options)
 
 
1843
        commands = commands_from_options(options)
 
 
1844
        self.assertEqual(2, len(commands))
 
 
1845
        self.assertIsInstance(commands[0], command.Deny)
 
 
1846
        self.assertIsInstance(commands[1], command.Remove)
 
 
1848
    def test_remove_short(self):
 
 
1849
        self.assert_command_from_args(["-r", "client"],
 
 
1852
    def test_dump_json(self):
 
 
1853
        self.assert_command_from_args(["--dump-json"],
 
 
1856
    def test_enable(self):
 
 
1857
        self.assert_command_from_args(["--enable", "client"],
 
 
1860
    def test_enable_short(self):
 
 
1861
        self.assert_command_from_args(["-e", "client"],
 
 
1864
    def test_disable(self):
 
 
1865
        self.assert_command_from_args(["--disable", "client"],
 
 
1868
    def test_disable_short(self):
 
 
1869
        self.assert_command_from_args(["-d", "client"],
 
 
1872
    def test_bump_timeout(self):
 
 
1873
        self.assert_command_from_args(["--bump-timeout", "client"],
 
 
1874
                                      command.BumpTimeout)
 
 
1876
    def test_bump_timeout_short(self):
 
 
1877
        self.assert_command_from_args(["-b", "client"],
 
 
1878
                                      command.BumpTimeout)
 
 
1880
    def test_start_checker(self):
 
 
1881
        self.assert_command_from_args(["--start-checker", "client"],
 
 
1882
                                      command.StartChecker)
 
 
1884
    def test_stop_checker(self):
 
 
1885
        self.assert_command_from_args(["--stop-checker", "client"],
 
 
1886
                                      command.StopChecker)
 
 
1888
    def test_approve_by_default(self):
 
 
1889
        self.assert_command_from_args(["--approve-by-default",
 
 
1891
                                      command.ApproveByDefault)
 
 
1893
    def test_deny_by_default(self):
 
 
1894
        self.assert_command_from_args(["--deny-by-default", "client"],
 
 
1895
                                      command.DenyByDefault)
 
 
1897
    def test_checker(self):
 
 
1898
        self.assert_command_from_args(["--checker", ":", "client"],
 
 
1902
    def test_checker_empty(self):
 
 
1903
        self.assert_command_from_args(["--checker", "", "client"],
 
 
1907
    def test_checker_short(self):
 
 
1908
        self.assert_command_from_args(["-c", ":", "client"],
 
 
1912
    def test_host(self):
 
 
1913
        self.assert_command_from_args(
 
 
1914
            ["--host", "client.example.org", "client"],
 
 
1915
            command.SetHost, value_to_set="client.example.org")
 
 
1917
    def test_host_short(self):
 
 
1918
        self.assert_command_from_args(
 
 
1919
            ["-H", "client.example.org", "client"], command.SetHost,
 
 
1920
            value_to_set="client.example.org")
 
 
1922
    def test_secret_devnull(self):
 
 
1923
        self.assert_command_from_args(["--secret", os.path.devnull,
 
 
1924
                                       "client"], command.SetSecret,
 
 
1927
    def test_secret_tempfile(self):
 
 
1928
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
 
1929
            value = b"secret\0xyzzy\nbar"
 
 
1932
            self.assert_command_from_args(["--secret", f.name,
 
 
1937
    def test_secret_devnull_short(self):
 
 
1938
        self.assert_command_from_args(["-s", os.path.devnull,
 
 
1939
                                       "client"], command.SetSecret,
 
 
1942
    def test_secret_tempfile_short(self):
 
 
1943
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
 
1944
            value = b"secret\0xyzzy\nbar"
 
 
1947
            self.assert_command_from_args(["-s", f.name, "client"],
 
 
1951
    def test_timeout(self):
 
 
1952
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
 
 
1954
                                      value_to_set=300000)
 
 
1956
    def test_timeout_short(self):
 
 
1957
        self.assert_command_from_args(["-t", "PT5M", "client"],
 
 
1959
                                      value_to_set=300000)
 
 
1961
    def test_extended_timeout(self):
 
 
1962
        self.assert_command_from_args(["--extended-timeout", "PT15M",
 
 
1964
                                      command.SetExtendedTimeout,
 
 
1965
                                      value_to_set=900000)
 
 
1967
    def test_interval(self):
 
 
1968
        self.assert_command_from_args(["--interval", "PT2M",
 
 
1969
                                       "client"], command.SetInterval,
 
 
1970
                                      value_to_set=120000)
 
 
1972
    def test_interval_short(self):
 
 
1973
        self.assert_command_from_args(["-i", "PT2M", "client"],
 
 
1974
                                      command.SetInterval,
 
 
1975
                                      value_to_set=120000)
 
 
1977
    def test_approval_delay(self):
 
 
1978
        self.assert_command_from_args(["--approval-delay", "PT30S",
 
 
1980
                                      command.SetApprovalDelay,
 
 
1983
    def test_approval_duration(self):
 
 
1984
        self.assert_command_from_args(["--approval-duration", "PT1S",
 
 
1986
                                      command.SetApprovalDuration,
 
 
1989
    def test_print_table(self):
 
 
1990
        self.assert_command_from_args([], command.PrintTable,
 
 
1993
    def test_print_table_verbose(self):
 
 
1994
        self.assert_command_from_args(["--verbose"],
 
 
1998
    def test_print_table_verbose_short(self):
 
 
1999
        self.assert_command_from_args(["-v"], command.PrintTable,
 
 
2003
    def test_manual_page_example_1(self):
 
 
2004
        self.assert_command_from_args("--verbose".split(),
 
 
2009
    def test_manual_page_example_2(self):
 
 
2010
        self.assert_command_from_args(
 
 
2011
            "--verbose foo1.example.org foo2.example.org".split(),
 
 
2012
            command.PrintTable, clients=["foo1.example.org",
 
 
2013
                                         "foo2.example.org"],
 
 
2016
    def test_manual_page_example_3(self):
 
 
2017
        self.assert_command_from_args("--enable --all".split(),
 
 
2021
    def test_manual_page_example_4(self):
 
 
2022
        self.assert_commands_from_args(
 
 
2023
            ("--timeout=PT5M --interval=PT1M foo1.example.org"
 
 
2024
             " foo2.example.org").split(),
 
 
2025
            [command.SetTimeout, command.SetInterval],
 
 
2026
            clients=["foo1.example.org", "foo2.example.org"])
 
 
2028
    def test_manual_page_example_5(self):
 
 
2029
        self.assert_command_from_args("--approve --all".split(),
 
 
2034
class TestCommand(unittest.TestCase):
 
791
2035
    """Abstract class for tests of command classes"""
 
794
 
        class MockClient(object):
 
795
 
            def __init__(self, name, **attributes):
 
796
 
                self.__dbus_object_path__ = "objpath_{}".format(name)
 
797
 
                self.attributes = attributes
 
798
 
                self.attributes["Name"] = name
 
800
 
            def Set(self, interface, property, value, dbus_interface):
 
801
 
                testcase.assertEqual(interface, client_interface)
 
802
 
                testcase.assertEqual(dbus_interface,
 
803
 
                                     dbus.PROPERTIES_IFACE)
 
804
 
                self.attributes[property] = value
 
805
 
            def Get(self, interface, property, dbus_interface):
 
806
 
                testcase.assertEqual(interface, client_interface)
 
807
 
                testcase.assertEqual(dbus_interface,
 
808
 
                                     dbus.PROPERTIES_IFACE)
 
809
 
                return self.attributes[property]
 
810
 
            def Approve(self, approve, dbus_interface):
 
811
 
                testcase.assertEqual(dbus_interface, client_interface)
 
812
 
                self.calls.append(("Approve", (approve,
 
814
 
        self.client = MockClient(
 
816
 
            KeyID=("92ed150794387c03ce684574b1139a65"
 
817
 
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
819
 
            Host="foo.example.org",
 
820
 
            Enabled=dbus.Boolean(True),
 
822
 
            LastCheckedOK="2019-02-03T00:00:00",
 
823
 
            Created="2019-01-02T00:00:00",
 
825
 
            Fingerprint=("778827225BA7DE539C5A"
 
826
 
                         "7CFA59CFF7CDBD9A5920"),
 
827
 
            CheckerRunning=dbus.Boolean(False),
 
828
 
            LastEnabled="2019-01-03T00:00:00",
 
829
 
            ApprovalPending=dbus.Boolean(False),
 
830
 
            ApprovedByDefault=dbus.Boolean(True),
 
831
 
            LastApprovalRequest="",
 
833
 
            ApprovalDuration=1000,
 
834
 
            Checker="fping -q -- %(host)s",
 
835
 
            ExtendedTimeout=900000,
 
836
 
            Expires="2019-02-04T00:00:00",
 
838
 
        self.other_client = MockClient(
 
840
 
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
841
 
                   "6ab612cff5ad227247e46c2b020f441c"),
 
844
 
            Enabled=dbus.Boolean(True),
 
846
 
            LastCheckedOK="2019-02-04T00:00:00",
 
847
 
            Created="2019-01-03T00:00:00",
 
849
 
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
850
 
                         "F547B3A107558FCA3A27"),
 
851
 
            CheckerRunning=dbus.Boolean(True),
 
852
 
            LastEnabled="2019-01-04T00:00:00",
 
853
 
            ApprovalPending=dbus.Boolean(False),
 
854
 
            ApprovedByDefault=dbus.Boolean(False),
 
855
 
            LastApprovalRequest="2019-01-03T00:00:00",
 
857
 
            ApprovalDuration=1000,
 
859
 
            ExtendedTimeout=900000,
 
860
 
            Expires="2019-02-05T00:00:00",
 
861
 
            LastCheckerStatus=-2)
 
862
 
        self.clients =  collections.OrderedDict(
 
864
 
                (self.client, self.client.attributes),
 
865
 
                (self.other_client, self.other_client.attributes),
 
867
 
        self.one_client = {self.client: self.client.attributes}
 
869
 
class TestPrintTableCmd(TestCmd):
 
870
 
    def test_normal(self):
 
871
 
        output = PrintTableCmd().output(self.clients)
 
872
 
        expected_output = """
 
873
 
Name   Enabled Timeout  Last Successful Check
 
874
 
foo    Yes     00:05:00 2019-02-03T00:00:00  
 
875
 
barbar Yes     00:05:00 2019-02-04T00:00:00  
 
877
 
        self.assertEqual(output, expected_output)
 
878
 
    def test_verbose(self):
 
879
 
        output = PrintTableCmd(verbose=True).output(self.clients)
 
880
 
        expected_output = """
 
881
 
Name   Enabled Timeout  Last Successful Check Created             Interval Host            Key ID                                                           Fingerprint                              Check Is Running Last Enabled        Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker              Extended Timeout Expires             Last Checker Status
 
882
 
foo    Yes     00:05:00 2019-02-03T00:00:00   2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No               2019-01-03T00:00:00 No                  Yes                                       00:00:00       00:00:01          fping -q -- %(host)s 00:15:00         2019-02-04T00:00:00 0                  
 
883
 
barbar Yes     00:05:00 2019-02-04T00:00:00   2019-01-03T00:00:00 00:02:00 192.0.2.3       0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes              2019-01-04T00:00:00 No                  No                  2019-01-03T00:00:00   00:00:30       00:00:01          :                    00:15:00         2019-02-05T00:00:00 -2                 
 
885
 
        self.assertEqual(output, expected_output)
 
886
 
    def test_one_client(self):
 
887
 
        output = PrintTableCmd().output(self.one_client)
 
888
 
        expected_output = """
 
889
 
Name Enabled Timeout  Last Successful Check
 
890
 
foo  Yes     00:05:00 2019-02-03T00:00:00  
 
892
 
        self.assertEqual(output, expected_output)
 
894
 
class TestDumpJSONCmd(TestCmd):
 
896
 
        self.expected_json = {
 
 
2037
    class FakeMandosBus(dbus.MandosBus):
 
 
2038
        def __init__(self, testcase):
 
 
2039
            self.client_properties = {
 
899
2041
                "KeyID": ("92ed150794387c03ce684574b1139a65"
 
900
2042
                          "94a34f895daaaf09fd8ea90a27cddb12"),
 
 
2043
                "Secret": b"secret",
 
901
2044
                "Host": "foo.example.org",
 
902
2045
                "Enabled": True,
 
903
2046
                "Timeout": 300000,
 
 
936
2080
                "ApprovedByDefault": False,
 
937
2081
                "LastApprovalRequest": "2019-01-03T00:00:00",
 
938
2082
                "ApprovalDelay": 30000,
 
939
 
                "ApprovalDuration": 1000,
 
 
2083
                "ApprovalDuration": 93785000,
 
941
2085
                "ExtendedTimeout": 900000,
 
942
2086
                "Expires": "2019-02-05T00:00:00",
 
943
2087
                "LastCheckerStatus": -2,
 
946
 
        return super(TestDumpJSONCmd, self).setUp()
 
947
 
    def test_normal(self):
 
948
 
        json_data = json.loads(DumpJSONCmd().output(self.clients))
 
949
 
        self.assertDictEqual(json_data, self.expected_json)
 
950
 
    def test_one_client(self):
 
951
 
        clients = self.one_client
 
952
 
        json_data = json.loads(DumpJSONCmd().output(clients))
 
953
 
        expected_json = {"foo": self.expected_json["foo"]}
 
954
 
        self.assertDictEqual(json_data, expected_json)
 
956
 
class TestIsEnabledCmd(TestCmd):
 
957
 
    def test_is_enabled(self):
 
958
 
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
 
959
 
                            for client, properties in self.clients.items()))
 
960
 
    def test_is_enabled_run_exits_successfully(self):
 
 
2089
            self.clients =  collections.OrderedDict(
 
 
2091
                    ("client_objectpath", self.client_properties),
 
 
2092
                    ("other_client_objectpath",
 
 
2093
                     self.other_client_properties),
 
 
2095
            self.one_client = {"client_objectpath":
 
 
2096
                               self.client_properties}
 
 
2097
            self.testcase = testcase
 
 
2100
        def call_method(self, methodname, busname, objectpath,
 
 
2102
            self.testcase.assertEqual("se.recompile.Mandos", busname)
 
 
2103
            self.calls.append((methodname, busname, objectpath,
 
 
2105
            if interface == "org.freedesktop.DBus.Properties":
 
 
2106
                if methodname == "Set":
 
 
2107
                    self.testcase.assertEqual(3, len(args))
 
 
2108
                    interface, key, value = args
 
 
2109
                    self.testcase.assertEqual(
 
 
2110
                        "se.recompile.Mandos.Client", interface)
 
 
2111
                    self.clients[objectpath][key] = value
 
 
2113
            elif interface == "se.recompile.Mandos":
 
 
2114
                self.testcase.assertEqual("RemoveClient", methodname)
 
 
2115
                self.testcase.assertEqual(1, len(args))
 
 
2116
                clientpath = args[0]
 
 
2117
                del self.clients[clientpath]
 
 
2119
            elif interface == "se.recompile.Mandos.Client":
 
 
2120
                if methodname == "Approve":
 
 
2121
                    self.testcase.assertEqual(1, len(args))
 
 
2126
        self.bus = self.FakeMandosBus(self)
 
 
2129
class TestBaseCommands(TestCommand):
 
 
2131
    def test_IsEnabled_exits_successfully(self):
 
961
2132
        with self.assertRaises(SystemExit) as e:
 
962
 
            IsEnabledCmd().run(None, self.one_client)
 
 
2133
            command.IsEnabled().run(self.bus.one_client)
 
963
2134
        if e.exception.code is not None:
 
964
 
            self.assertEqual(e.exception.code, 0)
 
 
2135
            self.assertEqual(0, e.exception.code)
 
966
2137
            self.assertIsNone(e.exception.code)
 
967
 
    def test_is_enabled_run_exits_with_failure(self):
 
968
 
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
 
2139
    def test_IsEnabled_exits_with_failure(self):
 
 
2140
        self.bus.client_properties["Enabled"] = False
 
969
2141
        with self.assertRaises(SystemExit) as e:
 
970
 
            IsEnabledCmd().run(None, self.one_client)
 
 
2142
            command.IsEnabled().run(self.bus.one_client)
 
971
2143
        if isinstance(e.exception.code, int):
 
972
 
            self.assertNotEqual(e.exception.code, 0)
 
 
2144
            self.assertNotEqual(0, e.exception.code)
 
974
2146
            self.assertIsNotNone(e.exception.code)
 
976
 
class TestRemoveCmd(TestCmd):
 
977
 
    def test_remove(self):
 
978
 
        class MockMandos(object):
 
981
 
            def RemoveClient(self, dbus_path):
 
982
 
                self.calls.append(("RemoveClient", (dbus_path,)))
 
983
 
        mandos = MockMandos()
 
984
 
        super(TestRemoveCmd, self).setUp()
 
985
 
        RemoveCmd().run(mandos, self.clients)
 
986
 
        self.assertEqual(len(mandos.calls), 2)
 
987
 
        for client in self.clients:
 
988
 
            self.assertIn(("RemoveClient",
 
989
 
                           (client.__dbus_object_path__,)),
 
992
 
class TestApproveCmd(TestCmd):
 
993
 
    def test_approve(self):
 
994
 
        ApproveCmd().run(None, self.clients)
 
995
 
        for client in self.clients:
 
996
 
            self.assertIn(("Approve", (True, client_interface)),
 
999
 
class TestDenyCmd(TestCmd):
 
1000
 
    def test_deny(self):
 
1001
 
        DenyCmd().run(None, self.clients)
 
1002
 
        for client in self.clients:
 
1003
 
            self.assertIn(("Approve", (False, client_interface)),
 
1006
 
class TestEnableCmd(TestCmd):
 
1007
 
    def test_enable(self):
 
1008
 
        for client in self.clients:
 
1009
 
            client.attributes["Enabled"] = False
 
1011
 
        EnableCmd().run(None, self.clients)
 
1013
 
        for client in self.clients:
 
1014
 
            self.assertTrue(client.attributes["Enabled"])
 
1016
 
class TestDisableCmd(TestCmd):
 
1017
 
    def test_disable(self):
 
1018
 
        DisableCmd().run(None, self.clients)
 
1020
 
        for client in self.clients:
 
1021
 
            self.assertFalse(client.attributes["Enabled"])
 
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"""
 
1027
 
class TestPropertyCmd(TestCmd):
 
1028
 
    """Abstract class for tests of PropertyCmd classes"""
 
 
2148
    def test_Approve(self):
 
 
2149
        busname = "se.recompile.Mandos"
 
 
2150
        client_interface = "se.recompile.Mandos.Client"
 
 
2151
        command.Approve().run(self.bus.clients, self.bus)
 
 
2152
        for clientpath in self.bus.clients:
 
 
2153
            self.assertIn(("Approve", busname, clientpath,
 
 
2154
                           client_interface, (True,)), self.bus.calls)
 
 
2156
    def test_Deny(self):
 
 
2157
        busname = "se.recompile.Mandos"
 
 
2158
        client_interface = "se.recompile.Mandos.Client"
 
 
2159
        command.Deny().run(self.bus.clients, self.bus)
 
 
2160
        for clientpath in self.bus.clients:
 
 
2161
            self.assertIn(("Approve", busname, clientpath,
 
 
2162
                           client_interface, (False,)),
 
 
2165
    def test_Remove(self):
 
 
2166
        command.Remove().run(self.bus.clients, self.bus)
 
 
2167
        for clientpath in self.bus.clients:
 
 
2168
            self.assertIn(("RemoveClient", dbus_busname,
 
 
2169
                           dbus_server_path, dbus_server_interface,
 
 
2170
                           (clientpath,)), self.bus.calls)
 
 
2175
            "KeyID": ("92ed150794387c03ce684574b1139a65"
 
 
2176
                      "94a34f895daaaf09fd8ea90a27cddb12"),
 
 
2177
            "Host": "foo.example.org",
 
 
2180
            "LastCheckedOK": "2019-02-03T00:00:00",
 
 
2181
            "Created": "2019-01-02T00:00:00",
 
 
2183
            "Fingerprint": ("778827225BA7DE539C5A"
 
 
2184
                            "7CFA59CFF7CDBD9A5920"),
 
 
2185
            "CheckerRunning": False,
 
 
2186
            "LastEnabled": "2019-01-03T00:00:00",
 
 
2187
            "ApprovalPending": False,
 
 
2188
            "ApprovedByDefault": True,
 
 
2189
            "LastApprovalRequest": "",
 
 
2191
            "ApprovalDuration": 1000,
 
 
2192
            "Checker": "fping -q -- %(host)s",
 
 
2193
            "ExtendedTimeout": 900000,
 
 
2194
            "Expires": "2019-02-04T00:00:00",
 
 
2195
            "LastCheckerStatus": 0,
 
 
2199
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
 
2200
                      "6ab612cff5ad227247e46c2b020f441c"),
 
 
2201
            "Host": "192.0.2.3",
 
 
2204
            "LastCheckedOK": "2019-02-04T00:00:00",
 
 
2205
            "Created": "2019-01-03T00:00:00",
 
 
2207
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
 
2208
                            "F547B3A107558FCA3A27"),
 
 
2209
            "CheckerRunning": True,
 
 
2210
            "LastEnabled": "2019-01-04T00:00:00",
 
 
2211
            "ApprovalPending": False,
 
 
2212
            "ApprovedByDefault": False,
 
 
2213
            "LastApprovalRequest": "2019-01-03T00:00:00",
 
 
2214
            "ApprovalDelay": 30000,
 
 
2215
            "ApprovalDuration": 93785000,
 
 
2217
            "ExtendedTimeout": 900000,
 
 
2218
            "Expires": "2019-02-05T00:00:00",
 
 
2219
            "LastCheckerStatus": -2,
 
 
2223
    def test_DumpJSON_normal(self):
 
 
2224
        with self.capture_stdout_to_buffer() as buffer:
 
 
2225
            command.DumpJSON().run(self.bus.clients)
 
 
2226
        json_data = json.loads(buffer.getvalue())
 
 
2227
        self.assertDictEqual(self.expected_json, json_data)
 
 
2230
    @contextlib.contextmanager
 
 
2231
    def capture_stdout_to_buffer():
 
 
2232
        capture_buffer = io.StringIO()
 
 
2233
        old_stdout = sys.stdout
 
 
2234
        sys.stdout = capture_buffer
 
 
2236
            yield capture_buffer
 
 
2238
            sys.stdout = old_stdout
 
 
2240
    def test_DumpJSON_one_client(self):
 
 
2241
        with self.capture_stdout_to_buffer() as buffer:
 
 
2242
            command.DumpJSON().run(self.bus.one_client)
 
 
2243
        json_data = json.loads(buffer.getvalue())
 
 
2244
        expected_json = {"foo": self.expected_json["foo"]}
 
 
2245
        self.assertDictEqual(expected_json, json_data)
 
 
2247
    def test_PrintTable_normal(self):
 
 
2248
        with self.capture_stdout_to_buffer() as buffer:
 
 
2249
            command.PrintTable().run(self.bus.clients)
 
 
2250
        expected_output = "\n".join((
 
 
2251
            "Name   Enabled Timeout  Last Successful Check",
 
 
2252
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
 
 
2253
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
 
 
2255
        self.assertEqual(expected_output, buffer.getvalue())
 
 
2257
    def test_PrintTable_verbose(self):
 
 
2258
        with self.capture_stdout_to_buffer() as buffer:
 
 
2259
            command.PrintTable(verbose=True).run(self.bus.clients)
 
 
2274
                "Last Successful Check ",
 
 
2275
                "2019-02-03T00:00:00   ",
 
 
2276
                "2019-02-04T00:00:00   ",
 
 
2279
                "2019-01-02T00:00:00 ",
 
 
2280
                "2019-01-03T00:00:00 ",
 
 
2292
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
 
 
2294
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
 
 
2298
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
 
 
2299
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
 
 
2301
                "Check Is Running ",
 
 
2306
                "2019-01-03T00:00:00 ",
 
 
2307
                "2019-01-04T00:00:00 ",
 
 
2309
                "Approval Is Pending ",
 
 
2313
                "Approved By Default ",
 
 
2317
                "Last Approval Request ",
 
 
2319
                "2019-01-03T00:00:00   ",
 
 
2325
                "Approval Duration ",
 
 
2330
                "fping -q -- %(host)s ",
 
 
2333
                "Extended Timeout ",
 
 
2338
                "2019-02-04T00:00:00 ",
 
 
2339
                "2019-02-05T00:00:00 ",
 
 
2341
                "Last Checker Status",
 
 
2346
        num_lines = max(len(rows) for rows in columns)
 
 
2347
        expected_output = ("\n".join("".join(rows[line]
 
 
2348
                                             for rows in columns)
 
 
2349
                                     for line in range(num_lines))
 
 
2351
        self.assertEqual(expected_output, buffer.getvalue())
 
 
2353
    def test_PrintTable_one_client(self):
 
 
2354
        with self.capture_stdout_to_buffer() as buffer:
 
 
2355
            command.PrintTable().run(self.bus.one_client)
 
 
2356
        expected_output = "\n".join((
 
 
2357
            "Name Enabled Timeout  Last Successful Check",
 
 
2358
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
 
 
2360
        self.assertEqual(expected_output, buffer.getvalue())
 
 
2363
class TestPropertySetterCmd(TestCommand):
 
 
2364
    """Abstract class for tests of command.PropertySetter classes"""
 
1029
2366
    def runTest(self):
 
1030
2367
        if not hasattr(self, "command"):
 
1032
 
        values_to_get = getattr(self, "values_to_get",
 
1034
 
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1036
 
            for client in self.clients:
 
1037
 
                old_value = client.attributes[self.property]
 
1038
 
                self.assertNotIsInstance(old_value, Unique)
 
1039
 
                client.attributes[self.property] = Unique()
 
1040
 
            self.run_command(value_to_set, self.clients)
 
1041
 
            for client in self.clients:
 
1042
 
                value = client.attributes[self.property]
 
 
2368
            return              # Abstract TestCase class
 
 
2370
        if hasattr(self, "values_to_set"):
 
 
2371
            cmd_args = [(value,) for value in self.values_to_set]
 
 
2372
            values_to_get = getattr(self, "values_to_get",
 
 
2375
            cmd_args = [() for x in range(len(self.values_to_get))]
 
 
2376
            values_to_get = self.values_to_get
 
 
2377
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
 
 
2378
            for clientpath in self.bus.clients:
 
 
2379
                self.bus.clients[clientpath][self.propname] = (
 
 
2381
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
 
 
2382
            for clientpath in self.bus.clients:
 
 
2383
                value = (self.bus.clients[clientpath]
 
1043
2385
                self.assertNotIsInstance(value, Unique)
 
1044
 
                self.assertEqual(value, value_to_get)
 
1045
 
    def run_command(self, value, clients):
 
1046
 
        self.command().run(None, clients)
 
1048
 
class TestBumpTimeoutCmd(TestPropertyCmd):
 
1049
 
    command = BumpTimeoutCmd
 
1050
 
    property = "LastCheckedOK"
 
1051
 
    values_to_set = [""]
 
1053
 
class TestStartCheckerCmd(TestPropertyCmd):
 
1054
 
    command = StartCheckerCmd
 
1055
 
    property = "CheckerRunning"
 
1056
 
    values_to_set = [dbus.Boolean(True)]
 
1058
 
class TestStopCheckerCmd(TestPropertyCmd):
 
1059
 
    command = StopCheckerCmd
 
1060
 
    property = "CheckerRunning"
 
1061
 
    values_to_set = [dbus.Boolean(False)]
 
1063
 
class TestApproveByDefaultCmd(TestPropertyCmd):
 
1064
 
    command = ApproveByDefaultCmd
 
1065
 
    property = "ApprovedByDefault"
 
1066
 
    values_to_set = [dbus.Boolean(True)]
 
1068
 
class TestDenyByDefaultCmd(TestPropertyCmd):
 
1069
 
    command = DenyByDefaultCmd
 
1070
 
    property = "ApprovedByDefault"
 
1071
 
    values_to_set = [dbus.Boolean(False)]
 
1073
 
class TestValueArgumentPropertyCmd(TestPropertyCmd):
 
1074
 
    """Abstract class for tests of PropertyCmd classes using the
 
1075
 
ValueArgumentMixIn"""
 
1077
 
        if type(self) is TestValueArgumentPropertyCmd:
 
1079
 
        return super(TestValueArgumentPropertyCmd, self).runTest()
 
1080
 
    def run_command(self, value, clients):
 
1081
 
        self.command(value).run(None, clients)
 
1083
 
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
 
1084
 
    command = SetCheckerCmd
 
1085
 
    property = "Checker"
 
 
2386
                self.assertEqual(value_to_get, value)
 
 
2389
class TestEnableCmd(TestPropertySetterCmd):
 
 
2390
    command = command.Enable
 
 
2391
    propname = "Enabled"
 
 
2392
    values_to_get = [True]
 
 
2395
class TestDisableCmd(TestPropertySetterCmd):
 
 
2396
    command = command.Disable
 
 
2397
    propname = "Enabled"
 
 
2398
    values_to_get = [False]
 
 
2401
class TestBumpTimeoutCmd(TestPropertySetterCmd):
 
 
2402
    command = command.BumpTimeout
 
 
2403
    propname = "LastCheckedOK"
 
 
2404
    values_to_get = [""]
 
 
2407
class TestStartCheckerCmd(TestPropertySetterCmd):
 
 
2408
    command = command.StartChecker
 
 
2409
    propname = "CheckerRunning"
 
 
2410
    values_to_get = [True]
 
 
2413
class TestStopCheckerCmd(TestPropertySetterCmd):
 
 
2414
    command = command.StopChecker
 
 
2415
    propname = "CheckerRunning"
 
 
2416
    values_to_get = [False]
 
 
2419
class TestApproveByDefaultCmd(TestPropertySetterCmd):
 
 
2420
    command = command.ApproveByDefault
 
 
2421
    propname = "ApprovedByDefault"
 
 
2422
    values_to_get = [True]
 
 
2425
class TestDenyByDefaultCmd(TestPropertySetterCmd):
 
 
2426
    command = command.DenyByDefault
 
 
2427
    propname = "ApprovedByDefault"
 
 
2428
    values_to_get = [False]
 
 
2431
class TestSetCheckerCmd(TestPropertySetterCmd):
 
 
2432
    command = command.SetChecker
 
 
2433
    propname = "Checker"
 
1086
2434
    values_to_set = ["", ":", "fping -q -- %s"]
 
1088
 
class TestSetHostCmd(TestValueArgumentPropertyCmd):
 
1089
 
    command = SetHostCmd
 
1091
 
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1093
 
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
 
1094
 
    command = SetSecretCmd
 
1096
 
    values_to_set = [open("/dev/null", "rb"),
 
 
2437
class TestSetHostCmd(TestPropertySetterCmd):
 
 
2438
    command = command.SetHost
 
 
2440
    values_to_set = ["192.0.2.3", "client.example.org"]
 
 
2443
class TestSetSecretCmd(TestPropertySetterCmd):
 
 
2444
    command = command.SetSecret
 
 
2446
    values_to_set = [io.BytesIO(b""),
 
1097
2447
                     io.BytesIO(b"secret\0xyzzy\nbar")]
 
1098
 
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1100
 
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
 
1101
 
    command = SetTimeoutCmd
 
1102
 
    property = "Timeout"
 
1103
 
    values_to_set = [datetime.timedelta(),
 
1104
 
                     datetime.timedelta(minutes=5),
 
1105
 
                     datetime.timedelta(seconds=1),
 
1106
 
                     datetime.timedelta(weeks=1),
 
1107
 
                     datetime.timedelta(weeks=52)]
 
1108
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1110
 
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
 
1111
 
    command = SetExtendedTimeoutCmd
 
1112
 
    property = "ExtendedTimeout"
 
1113
 
    values_to_set = [datetime.timedelta(),
 
1114
 
                     datetime.timedelta(minutes=5),
 
1115
 
                     datetime.timedelta(seconds=1),
 
1116
 
                     datetime.timedelta(weeks=1),
 
1117
 
                     datetime.timedelta(weeks=52)]
 
1118
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1120
 
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
 
1121
 
    command = SetIntervalCmd
 
1122
 
    property = "Interval"
 
1123
 
    values_to_set = [datetime.timedelta(),
 
1124
 
                     datetime.timedelta(minutes=5),
 
1125
 
                     datetime.timedelta(seconds=1),
 
1126
 
                     datetime.timedelta(weeks=1),
 
1127
 
                     datetime.timedelta(weeks=52)]
 
1128
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1130
 
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
 
1131
 
    command = SetApprovalDelayCmd
 
1132
 
    property = "ApprovalDelay"
 
1133
 
    values_to_set = [datetime.timedelta(),
 
1134
 
                     datetime.timedelta(minutes=5),
 
1135
 
                     datetime.timedelta(seconds=1),
 
1136
 
                     datetime.timedelta(weeks=1),
 
1137
 
                     datetime.timedelta(weeks=52)]
 
1138
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1140
 
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
 
1141
 
    command = SetApprovalDurationCmd
 
1142
 
    property = "ApprovalDuration"
 
1143
 
    values_to_set = [datetime.timedelta(),
 
1144
 
                     datetime.timedelta(minutes=5),
 
1145
 
                     datetime.timedelta(seconds=1),
 
1146
 
                     datetime.timedelta(weeks=1),
 
1147
 
                     datetime.timedelta(weeks=52)]
 
1148
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1150
 
class Test_command_from_options(unittest.TestCase):
 
1152
 
        self.parser = argparse.ArgumentParser()
 
1153
 
        add_command_line_options(self.parser)
 
1154
 
    def assert_command_from_args(self, args, command_cls, **cmd_attrs):
 
1155
 
        """Assert that parsing ARGS should result in an instance of
 
1156
 
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
 
1157
 
        options = self.parser.parse_args(args)
 
1158
 
        commands = commands_from_options(options)
 
1159
 
        self.assertEqual(len(commands), 1)
 
1160
 
        command = commands[0]
 
1161
 
        self.assertIsInstance(command, command_cls)
 
1162
 
        for key, value in cmd_attrs.items():
 
1163
 
            self.assertEqual(getattr(command, key), value)
 
1164
 
    def test_print_table(self):
 
1165
 
        self.assert_command_from_args([], PrintTableCmd,
 
1168
 
    def test_print_table_verbose(self):
 
1169
 
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
 
1172
 
    def test_print_table_verbose_short(self):
 
1173
 
        self.assert_command_from_args(["-v"], PrintTableCmd,
 
1176
 
    def test_enable(self):
 
1177
 
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
 
1179
 
    def test_enable_short(self):
 
1180
 
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
 
1182
 
    def test_disable(self):
 
1183
 
        self.assert_command_from_args(["--disable", "foo"],
 
1186
 
    def test_disable_short(self):
 
1187
 
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
 
1189
 
    def test_bump_timeout(self):
 
1190
 
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1193
 
    def test_bump_timeout_short(self):
 
1194
 
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
 
1196
 
    def test_start_checker(self):
 
1197
 
        self.assert_command_from_args(["--start-checker", "foo"],
 
1200
 
    def test_stop_checker(self):
 
1201
 
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1204
 
    def test_remove(self):
 
1205
 
        self.assert_command_from_args(["--remove", "foo"],
 
1208
 
    def test_remove_short(self):
 
1209
 
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
 
1211
 
    def test_checker(self):
 
1212
 
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1213
 
                                      SetCheckerCmd, value_to_set=":")
 
1215
 
    def test_checker_empty(self):
 
1216
 
        self.assert_command_from_args(["--checker", "", "foo"],
 
1217
 
                                      SetCheckerCmd, value_to_set="")
 
1219
 
    def test_checker_short(self):
 
1220
 
        self.assert_command_from_args(["-c", ":", "foo"],
 
1221
 
                                      SetCheckerCmd, value_to_set=":")
 
1223
 
    def test_timeout(self):
 
1224
 
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1226
 
                                      value_to_set=300000)
 
1228
 
    def test_timeout_short(self):
 
1229
 
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1231
 
                                      value_to_set=300000)
 
1233
 
    def test_extended_timeout(self):
 
1234
 
        self.assert_command_from_args(["--extended-timeout", "PT15M",
 
1236
 
                                      SetExtendedTimeoutCmd,
 
1237
 
                                      value_to_set=900000)
 
1239
 
    def test_interval(self):
 
1240
 
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1242
 
                                      value_to_set=120000)
 
1244
 
    def test_interval_short(self):
 
1245
 
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1247
 
                                      value_to_set=120000)
 
1249
 
    def test_approve_by_default(self):
 
1250
 
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1251
 
                                      ApproveByDefaultCmd)
 
1253
 
    def test_deny_by_default(self):
 
1254
 
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1257
 
    def test_approval_delay(self):
 
1258
 
        self.assert_command_from_args(["--approval-delay", "PT30S",
 
1259
 
                                       "foo"], SetApprovalDelayCmd,
 
1262
 
    def test_approval_duration(self):
 
1263
 
        self.assert_command_from_args(["--approval-duration", "PT1S",
 
1264
 
                                       "foo"], SetApprovalDurationCmd,
 
1267
 
    def test_host(self):
 
1268
 
        self.assert_command_from_args(["--host", "foo.example.org",
 
1270
 
                                      value_to_set="foo.example.org")
 
1272
 
    def test_host_short(self):
 
1273
 
        self.assert_command_from_args(["-H", "foo.example.org",
 
1275
 
                                      value_to_set="foo.example.org")
 
1277
 
    def test_secret_devnull(self):
 
1278
 
        self.assert_command_from_args(["--secret", os.path.devnull,
 
1279
 
                                       "foo"], SetSecretCmd,
 
1282
 
    def test_secret_tempfile(self):
 
1283
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1284
 
            value = b"secret\0xyzzy\nbar"
 
1287
 
            self.assert_command_from_args(["--secret", f.name,
 
1288
 
                                           "foo"], SetSecretCmd,
 
1291
 
    def test_secret_devnull_short(self):
 
1292
 
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1293
 
                                      SetSecretCmd, value_to_set=b"")
 
1295
 
    def test_secret_tempfile_short(self):
 
1296
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1297
 
            value = b"secret\0xyzzy\nbar"
 
1300
 
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1304
 
    def test_approve(self):
 
1305
 
        self.assert_command_from_args(["--approve", "foo"],
 
1308
 
    def test_approve_short(self):
 
1309
 
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
 
1311
 
    def test_deny(self):
 
1312
 
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
 
1314
 
    def test_deny_short(self):
 
1315
 
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
 
1317
 
    def test_dump_json(self):
 
1318
 
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
 
1320
 
    def test_is_enabled(self):
 
1321
 
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1324
 
    def test_is_enabled_short(self):
 
1325
 
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
 
 
2448
    values_to_get = [f.getvalue() for f in values_to_set]
 
 
2451
class TestSetTimeoutCmd(TestPropertySetterCmd):
 
 
2452
    command = command.SetTimeout
 
 
2453
    propname = "Timeout"
 
 
2454
    values_to_set = [datetime.timedelta(),
 
 
2455
                     datetime.timedelta(minutes=5),
 
 
2456
                     datetime.timedelta(seconds=1),
 
 
2457
                     datetime.timedelta(weeks=1),
 
 
2458
                     datetime.timedelta(weeks=52)]
 
 
2459
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
 
2462
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
 
 
2463
    command = command.SetExtendedTimeout
 
 
2464
    propname = "ExtendedTimeout"
 
 
2465
    values_to_set = [datetime.timedelta(),
 
 
2466
                     datetime.timedelta(minutes=5),
 
 
2467
                     datetime.timedelta(seconds=1),
 
 
2468
                     datetime.timedelta(weeks=1),
 
 
2469
                     datetime.timedelta(weeks=52)]
 
 
2470
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
 
2473
class TestSetIntervalCmd(TestPropertySetterCmd):
 
 
2474
    command = command.SetInterval
 
 
2475
    propname = "Interval"
 
 
2476
    values_to_set = [datetime.timedelta(),
 
 
2477
                     datetime.timedelta(minutes=5),
 
 
2478
                     datetime.timedelta(seconds=1),
 
 
2479
                     datetime.timedelta(weeks=1),
 
 
2480
                     datetime.timedelta(weeks=52)]
 
 
2481
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
 
2484
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
 
 
2485
    command = command.SetApprovalDelay
 
 
2486
    propname = "ApprovalDelay"
 
 
2487
    values_to_set = [datetime.timedelta(),
 
 
2488
                     datetime.timedelta(minutes=5),
 
 
2489
                     datetime.timedelta(seconds=1),
 
 
2490
                     datetime.timedelta(weeks=1),
 
 
2491
                     datetime.timedelta(weeks=52)]
 
 
2492
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
 
2495
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
 
 
2496
    command = command.SetApprovalDuration
 
 
2497
    propname = "ApprovalDuration"
 
 
2498
    values_to_set = [datetime.timedelta(),
 
 
2499
                     datetime.timedelta(minutes=5),
 
 
2500
                     datetime.timedelta(seconds=1),
 
 
2501
                     datetime.timedelta(weeks=1),
 
 
2502
                     datetime.timedelta(weeks=52)]
 
 
2503
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]