/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-15 23:55:53 UTC
  • Revision ID: teddy@recompile.se-20190315235553-znbpfn7d8o84tyt6
mandos-ctl: Refactor

* mandos-ctl (main): Do some minor refactoring.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
102
102
    mandos_serv_object_manager = dbus.Interface(
103
103
        mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
104
 
105
 
    managed_objects = get_managed_objects(mandos_serv_object_manager)
 
105
    log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
 
106
              server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
 
107
    try:
 
108
        with SilenceLogger("dbus.proxies"):
 
109
            managed_objects = (mandos_serv_object_manager
 
110
                               .GetManagedObjects())
 
111
    except dbus.exceptions.DBusException as e:
 
112
        log.critical("Failed to access Mandos server through D-Bus:"
 
113
                     "\n%s", e)
 
114
        sys.exit(1)
106
115
 
107
116
    all_clients = {}
108
117
    for path, ifs_and_props in managed_objects.items():
125
134
                log.critical("Client not found on server: %r", name)
126
135
                sys.exit(1)
127
136
 
 
137
    # Run all commands on clients
128
138
    commands = commands_from_options(options)
129
 
 
130
139
    for command in commands:
131
140
        command.run(clients, bus, mandos_serv)
132
141
 
232
241
    >>> rfc3339_duration_to_delta("")
233
242
    Traceback (most recent call last):
234
243
    ...
235
 
    ValueError: Invalid RFC 3339 duration: ""
 
244
    ValueError: Invalid RFC 3339 duration: u''
236
245
    >>> # Must start with "P":
237
246
    >>> rfc3339_duration_to_delta("1D")
238
247
    Traceback (most recent call last):
239
248
    ...
240
 
    ValueError: Invalid RFC 3339 duration: "1D"
 
249
    ValueError: Invalid RFC 3339 duration: u'1D'
241
250
    >>> # Must use correct order
242
251
    >>> rfc3339_duration_to_delta("PT1S2M")
243
252
    Traceback (most recent call last):
244
253
    ...
245
 
    ValueError: Invalid RFC 3339 duration: "PT1S2M"
 
254
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
246
255
    >>> # Time needs time marker
247
256
    >>> rfc3339_duration_to_delta("P1H2S")
248
257
    Traceback (most recent call last):
249
258
    ...
250
 
    ValueError: Invalid RFC 3339 duration: "P1H2S"
 
259
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
251
260
    >>> # Weeks can not be combined with anything else
252
261
    >>> rfc3339_duration_to_delta("P1D2W")
253
262
    Traceback (most recent call last):
254
263
    ...
255
 
    ValueError: Invalid RFC 3339 duration: "P1D2W"
 
264
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
256
265
    >>> rfc3339_duration_to_delta("P2W2H")
257
266
    Traceback (most recent call last):
258
267
    ...
259
 
    ValueError: Invalid RFC 3339 duration: "P2W2H"
 
268
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
260
269
    """
261
270
 
262
271
    # Parsing an RFC 3339 duration with regular expressions is not
333
342
                break
334
343
        else:
335
344
            # No currently valid tokens were found
336
 
            raise ValueError("Invalid RFC 3339 duration: \"{}\""
 
345
            raise ValueError("Invalid RFC 3339 duration: {!r}"
337
346
                             .format(duration))
338
347
    # End token found
339
348
    return value
425
434
 
426
435
 
427
436
def get_mandos_dbus_object(bus):
428
 
    log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
 
              dbus_busname, server_dbus_path)
430
 
    with if_dbus_exception_log_with_exception_and_exit(
431
 
            "Could not connect to Mandos server: %s"):
 
437
    try:
 
438
        log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
439
                  dbus_busname, server_dbus_path)
432
440
        mandos_dbus_object = bus.get_object(dbus_busname,
433
441
                                            server_dbus_path)
 
442
    except dbus.exceptions.DBusException:
 
443
        log.critical("Could not connect to Mandos server")
 
444
        sys.exit(1)
 
445
 
434
446
    return mandos_dbus_object
435
447
 
436
448
 
437
 
@contextlib.contextmanager
438
 
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
439
 
    try:
440
 
        yield
441
 
    except dbus.exceptions.DBusException as e:
442
 
        log.critical(*(args + (e,)), **kwargs)
443
 
        sys.exit(1)
444
 
 
445
 
 
446
 
def get_managed_objects(object_manager):
447
 
    log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
 
              server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
 
    with if_dbus_exception_log_with_exception_and_exit(
450
 
            "Failed to access Mandos server through D-Bus:\n%s"):
451
 
        with SilenceLogger("dbus.proxies"):
452
 
            managed_objects = object_manager.GetManagedObjects()
453
 
    return managed_objects
454
 
 
455
 
 
456
449
class SilenceLogger(object):
457
450
    "Simple context manager to silence a particular logger"
458
451
    def __init__(self, loggername):
477
470
    commands = []
478
471
 
479
472
    if options.is_enabled:
480
 
        commands.append(command.IsEnabled())
 
473
        commands.append(IsEnabledCmd())
481
474
 
482
475
    if options.approve:
483
 
        commands.append(command.Approve())
 
476
        commands.append(ApproveCmd())
484
477
 
485
478
    if options.deny:
486
 
        commands.append(command.Deny())
 
479
        commands.append(DenyCmd())
487
480
 
488
481
    if options.remove:
489
 
        commands.append(command.Remove())
 
482
        commands.append(RemoveCmd())
490
483
 
491
484
    if options.dump_json:
492
 
        commands.append(command.DumpJSON())
 
485
        commands.append(DumpJSONCmd())
493
486
 
494
487
    if options.enable:
495
 
        commands.append(command.Enable())
 
488
        commands.append(EnableCmd())
496
489
 
497
490
    if options.disable:
498
 
        commands.append(command.Disable())
 
491
        commands.append(DisableCmd())
499
492
 
500
493
    if options.bump_timeout:
501
 
        commands.append(command.BumpTimeout())
 
494
        commands.append(BumpTimeoutCmd())
502
495
 
503
496
    if options.start_checker:
504
 
        commands.append(command.StartChecker())
 
497
        commands.append(StartCheckerCmd())
505
498
 
506
499
    if options.stop_checker:
507
 
        commands.append(command.StopChecker())
 
500
        commands.append(StopCheckerCmd())
508
501
 
509
502
    if options.approved_by_default is not None:
510
503
        if options.approved_by_default:
511
 
            commands.append(command.ApproveByDefault())
 
504
            commands.append(ApproveByDefaultCmd())
512
505
        else:
513
 
            commands.append(command.DenyByDefault())
 
506
            commands.append(DenyByDefaultCmd())
514
507
 
515
508
    if options.checker is not None:
516
 
        commands.append(command.SetChecker(options.checker))
 
509
        commands.append(SetCheckerCmd(options.checker))
517
510
 
518
511
    if options.host is not None:
519
 
        commands.append(command.SetHost(options.host))
 
512
        commands.append(SetHostCmd(options.host))
520
513
 
521
514
    if options.secret is not None:
522
 
        commands.append(command.SetSecret(options.secret))
 
515
        commands.append(SetSecretCmd(options.secret))
523
516
 
524
517
    if options.timeout is not None:
525
 
        commands.append(command.SetTimeout(options.timeout))
 
518
        commands.append(SetTimeoutCmd(options.timeout))
526
519
 
527
520
    if options.extended_timeout:
528
521
        commands.append(
529
 
            command.SetExtendedTimeout(options.extended_timeout))
 
522
            SetExtendedTimeoutCmd(options.extended_timeout))
530
523
 
531
524
    if options.interval is not None:
532
 
        commands.append(command.SetInterval(options.interval))
 
525
        commands.append(SetIntervalCmd(options.interval))
533
526
 
534
527
    if options.approval_delay is not None:
535
 
        commands.append(
536
 
            command.SetApprovalDelay(options.approval_delay))
 
528
        commands.append(SetApprovalDelayCmd(options.approval_delay))
537
529
 
538
530
    if options.approval_duration is not None:
539
531
        commands.append(
540
 
            command.SetApprovalDuration(options.approval_duration))
 
532
            SetApprovalDurationCmd(options.approval_duration))
541
533
 
542
534
    # If no command option has been given, show table of clients,
543
535
    # optionally verbosely
544
536
    if not commands:
545
 
        commands.append(command.PrintTable(verbose=options.verbose))
 
537
        commands.append(PrintTableCmd(verbose=options.verbose))
546
538
 
547
539
    return commands
548
540
 
549
541
 
550
 
class command(object):
551
 
    """A namespace for command classes"""
552
 
 
553
 
    class Base(object):
554
 
        """Abstract base class for commands"""
555
 
        def run(self, clients, bus=None, mandos=None):
556
 
            """Normal commands should implement run_on_one_client(),
557
 
but commands which want to operate on all clients at the same time can
558
 
override this run() method instead.
559
 
"""
560
 
            self.mandos = mandos
561
 
            for clientpath, properties in clients.items():
562
 
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
563
 
                          dbus_busname, str(clientpath))
564
 
                client = bus.get_object(dbus_busname, clientpath)
565
 
                self.run_on_one_client(client, properties)
566
 
 
567
 
 
568
 
    class IsEnabled(Base):
569
 
        def run(self, clients, bus=None, mandos=None):
570
 
            client, properties = next(iter(clients.items()))
571
 
            if self.is_enabled(client, properties):
572
 
                sys.exit(0)
573
 
            sys.exit(1)
574
 
        def is_enabled(self, client, properties):
575
 
            return properties["Enabled"]
576
 
 
577
 
 
578
 
    class Approve(Base):
579
 
        def run_on_one_client(self, client, properties):
580
 
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
581
 
                      client.__dbus_object_path__,
582
 
                      client_dbus_interface)
583
 
            client.Approve(dbus.Boolean(True),
584
 
                           dbus_interface=client_dbus_interface)
585
 
 
586
 
 
587
 
    class Deny(Base):
588
 
        def run_on_one_client(self, client, properties):
589
 
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
590
 
                      client.__dbus_object_path__,
591
 
                      client_dbus_interface)
592
 
            client.Approve(dbus.Boolean(False),
593
 
                           dbus_interface=client_dbus_interface)
594
 
 
595
 
 
596
 
    class Remove(Base):
597
 
        def run_on_one_client(self, client, properties):
598
 
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
599
 
                      dbus_busname, server_dbus_path,
600
 
                      server_dbus_interface,
601
 
                      str(client.__dbus_object_path__))
602
 
            self.mandos.RemoveClient(client.__dbus_object_path__)
603
 
 
604
 
 
605
 
    class Output(Base):
606
 
        """Abstract class for commands outputting client details"""
607
 
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
608
 
                        "Created", "Interval", "Host", "KeyID",
609
 
                        "Fingerprint", "CheckerRunning",
610
 
                        "LastEnabled", "ApprovalPending",
611
 
                        "ApprovedByDefault", "LastApprovalRequest",
612
 
                        "ApprovalDelay", "ApprovalDuration",
613
 
                        "Checker", "ExtendedTimeout", "Expires",
614
 
                        "LastCheckerStatus")
615
 
 
616
 
        def run(self, clients, bus=None, mandos=None):
617
 
            print(self.output(clients.values()))
618
 
 
619
 
        def output(self, clients):
620
 
            raise NotImplementedError()
621
 
 
622
 
 
623
 
    class DumpJSON(Output):
624
 
        def output(self, clients):
625
 
            data = {client["Name"]:
626
 
                    {key: self.dbus_boolean_to_bool(client[key])
627
 
                     for key in self.all_keywords}
628
 
                    for client in clients}
629
 
            return json.dumps(data, indent=4, separators=(',', ': '))
 
542
class Command(object):
 
543
    """Abstract class for commands"""
 
544
    def run(self, clients, bus=None, mandos=None):
 
545
        """Normal commands should implement run_on_one_client(), but
 
546
        commands which want to operate on all clients at the same time
 
547
        can override this run() method instead."""
 
548
        self.mandos = mandos
 
549
        for clientpath, properties in clients.items():
 
550
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
551
                      dbus_busname, str(clientpath))
 
552
            client = bus.get_object(dbus_busname, clientpath)
 
553
            self.run_on_one_client(client, properties)
 
554
 
 
555
 
 
556
class IsEnabledCmd(Command):
 
557
    def run(self, clients, bus=None, mandos=None):
 
558
        client, properties = next(iter(clients.items()))
 
559
        if self.is_enabled(client, properties):
 
560
            sys.exit(0)
 
561
        sys.exit(1)
 
562
    def is_enabled(self, client, properties):
 
563
        return properties["Enabled"]
 
564
 
 
565
 
 
566
class ApproveCmd(Command):
 
567
    def run_on_one_client(self, client, properties):
 
568
        log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
569
                  client.__dbus_object_path__, client_dbus_interface)
 
570
        client.Approve(dbus.Boolean(True),
 
571
                       dbus_interface=client_dbus_interface)
 
572
 
 
573
 
 
574
class DenyCmd(Command):
 
575
    def run_on_one_client(self, client, properties):
 
576
        log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
577
                  client.__dbus_object_path__, client_dbus_interface)
 
578
        client.Approve(dbus.Boolean(False),
 
579
                       dbus_interface=client_dbus_interface)
 
580
 
 
581
 
 
582
class RemoveCmd(Command):
 
583
    def run_on_one_client(self, client, properties):
 
584
        log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
 
585
                  server_dbus_path, server_dbus_interface,
 
586
                  str(client.__dbus_object_path__))
 
587
        self.mandos.RemoveClient(client.__dbus_object_path__)
 
588
 
 
589
 
 
590
class OutputCmd(Command):
 
591
    """Abstract class for commands outputting client details"""
 
592
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
593
                    "Created", "Interval", "Host", "KeyID",
 
594
                    "Fingerprint", "CheckerRunning", "LastEnabled",
 
595
                    "ApprovalPending", "ApprovedByDefault",
 
596
                    "LastApprovalRequest", "ApprovalDelay",
 
597
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
 
598
                    "Expires", "LastCheckerStatus")
 
599
 
 
600
    def run(self, clients, bus=None, mandos=None):
 
601
        print(self.output(clients.values()))
 
602
 
 
603
    def output(self, clients):
 
604
        raise NotImplementedError()
 
605
 
 
606
 
 
607
class DumpJSONCmd(OutputCmd):
 
608
    def output(self, clients):
 
609
        data = {client["Name"]:
 
610
                {key: self.dbus_boolean_to_bool(client[key])
 
611
                 for key in self.all_keywords}
 
612
                for client in clients}
 
613
        return json.dumps(data, indent=4, separators=(',', ': '))
 
614
 
 
615
    @staticmethod
 
616
    def dbus_boolean_to_bool(value):
 
617
        if isinstance(value, dbus.Boolean):
 
618
            value = bool(value)
 
619
        return value
 
620
 
 
621
 
 
622
class PrintTableCmd(OutputCmd):
 
623
    def __init__(self, verbose=False):
 
624
        self.verbose = verbose
 
625
 
 
626
    def output(self, clients):
 
627
        default_keywords = ("Name", "Enabled", "Timeout",
 
628
                            "LastCheckedOK")
 
629
        keywords = default_keywords
 
630
        if self.verbose:
 
631
            keywords = self.all_keywords
 
632
        return str(self.TableOfClients(clients, keywords))
 
633
 
 
634
    class TableOfClients(object):
 
635
        tableheaders = {
 
636
            "Name": "Name",
 
637
            "Enabled": "Enabled",
 
638
            "Timeout": "Timeout",
 
639
            "LastCheckedOK": "Last Successful Check",
 
640
            "LastApprovalRequest": "Last Approval Request",
 
641
            "Created": "Created",
 
642
            "Interval": "Interval",
 
643
            "Host": "Host",
 
644
            "Fingerprint": "Fingerprint",
 
645
            "KeyID": "Key ID",
 
646
            "CheckerRunning": "Check Is Running",
 
647
            "LastEnabled": "Last Enabled",
 
648
            "ApprovalPending": "Approval Is Pending",
 
649
            "ApprovedByDefault": "Approved By Default",
 
650
            "ApprovalDelay": "Approval Delay",
 
651
            "ApprovalDuration": "Approval Duration",
 
652
            "Checker": "Checker",
 
653
            "ExtendedTimeout": "Extended Timeout",
 
654
            "Expires": "Expires",
 
655
            "LastCheckerStatus": "Last Checker Status",
 
656
        }
 
657
 
 
658
        def __init__(self, clients, keywords):
 
659
            self.clients = clients
 
660
            self.keywords = keywords
 
661
 
 
662
        def __str__(self):
 
663
            return "\n".join(self.rows())
 
664
 
 
665
        if sys.version_info.major == 2:
 
666
            __unicode__ = __str__
 
667
            def __str__(self):
 
668
                return str(self).encode(locale.getpreferredencoding())
 
669
 
 
670
        def rows(self):
 
671
            format_string = self.row_formatting_string()
 
672
            rows = [self.header_line(format_string)]
 
673
            rows.extend(self.client_line(client, format_string)
 
674
                        for client in self.clients)
 
675
            return rows
 
676
 
 
677
        def row_formatting_string(self):
 
678
            "Format string used to format table rows"
 
679
            return " ".join("{{{key}:{width}}}".format(
 
680
                width=max(len(self.tableheaders[key]),
 
681
                          *(len(self.string_from_client(client, key))
 
682
                            for client in self.clients)),
 
683
                key=key)
 
684
                            for key in self.keywords)
 
685
 
 
686
        def string_from_client(self, client, key):
 
687
            return self.valuetostring(client[key], key)
 
688
 
 
689
        @classmethod
 
690
        def valuetostring(cls, value, keyword):
 
691
            if isinstance(value, dbus.Boolean):
 
692
                return "Yes" if value else "No"
 
693
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
694
                           "ApprovalDuration", "ExtendedTimeout"):
 
695
                return cls.milliseconds_to_string(value)
 
696
            return str(value)
 
697
 
 
698
        def header_line(self, format_string):
 
699
            return format_string.format(**self.tableheaders)
 
700
 
 
701
        def client_line(self, client, format_string):
 
702
            return format_string.format(
 
703
                **{key: self.string_from_client(client, key)
 
704
                   for key in self.keywords})
630
705
 
631
706
        @staticmethod
632
 
        def dbus_boolean_to_bool(value):
633
 
            if isinstance(value, dbus.Boolean):
634
 
                value = bool(value)
635
 
            return value
636
 
 
637
 
 
638
 
    class PrintTable(Output):
639
 
        def __init__(self, verbose=False):
640
 
            self.verbose = verbose
641
 
 
642
 
        def output(self, clients):
643
 
            default_keywords = ("Name", "Enabled", "Timeout",
644
 
                                "LastCheckedOK")
645
 
            keywords = default_keywords
646
 
            if self.verbose:
647
 
                keywords = self.all_keywords
648
 
            return str(self.TableOfClients(clients, keywords))
649
 
 
650
 
        class TableOfClients(object):
651
 
            tableheaders = {
652
 
                "Name": "Name",
653
 
                "Enabled": "Enabled",
654
 
                "Timeout": "Timeout",
655
 
                "LastCheckedOK": "Last Successful Check",
656
 
                "LastApprovalRequest": "Last Approval Request",
657
 
                "Created": "Created",
658
 
                "Interval": "Interval",
659
 
                "Host": "Host",
660
 
                "Fingerprint": "Fingerprint",
661
 
                "KeyID": "Key ID",
662
 
                "CheckerRunning": "Check Is Running",
663
 
                "LastEnabled": "Last Enabled",
664
 
                "ApprovalPending": "Approval Is Pending",
665
 
                "ApprovedByDefault": "Approved By Default",
666
 
                "ApprovalDelay": "Approval Delay",
667
 
                "ApprovalDuration": "Approval Duration",
668
 
                "Checker": "Checker",
669
 
                "ExtendedTimeout": "Extended Timeout",
670
 
                "Expires": "Expires",
671
 
                "LastCheckerStatus": "Last Checker Status",
672
 
            }
673
 
 
674
 
            def __init__(self, clients, keywords):
675
 
                self.clients = clients
676
 
                self.keywords = keywords
677
 
 
678
 
            def __str__(self):
679
 
                return "\n".join(self.rows())
680
 
 
681
 
            if sys.version_info.major == 2:
682
 
                __unicode__ = __str__
683
 
                def __str__(self):
684
 
                    return str(self).encode(
685
 
                        locale.getpreferredencoding())
686
 
 
687
 
            def rows(self):
688
 
                format_string = self.row_formatting_string()
689
 
                rows = [self.header_line(format_string)]
690
 
                rows.extend(self.client_line(client, format_string)
691
 
                            for client in self.clients)
692
 
                return rows
693
 
 
694
 
            def row_formatting_string(self):
695
 
                "Format string used to format table rows"
696
 
                return " ".join("{{{key}:{width}}}".format(
697
 
                    width=max(len(self.tableheaders[key]),
698
 
                              *(len(self.string_from_client(client,
699
 
                                                            key))
700
 
                                for client in self.clients)),
701
 
                    key=key)
702
 
                                for key in self.keywords)
703
 
 
704
 
            def string_from_client(self, client, key):
705
 
                return self.valuetostring(client[key], key)
706
 
 
707
 
            @classmethod
708
 
            def valuetostring(cls, value, keyword):
709
 
                if isinstance(value, dbus.Boolean):
710
 
                    return "Yes" if value else "No"
711
 
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
712
 
                               "ApprovalDuration", "ExtendedTimeout"):
713
 
                    return cls.milliseconds_to_string(value)
714
 
                return str(value)
715
 
 
716
 
            def header_line(self, format_string):
717
 
                return format_string.format(**self.tableheaders)
718
 
 
719
 
            def client_line(self, client, format_string):
720
 
                return format_string.format(
721
 
                    **{key: self.string_from_client(client, key)
722
 
                       for key in self.keywords})
723
 
 
724
 
            @staticmethod
725
 
            def milliseconds_to_string(ms):
726
 
                td = datetime.timedelta(0, 0, 0, ms)
727
 
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
728
 
                        .format(days="{}T".format(td.days)
729
 
                                if td.days else "",
730
 
                                hours=td.seconds // 3600,
731
 
                                minutes=(td.seconds % 3600) // 60,
732
 
                                seconds=td.seconds % 60))
733
 
 
734
 
 
735
 
    class Property(Base):
736
 
        "Abstract class for Actions for setting one client property"
737
 
 
738
 
        def run_on_one_client(self, client, properties):
739
 
            """Set the Client's D-Bus property"""
740
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
741
 
                      client.__dbus_object_path__,
742
 
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
743
 
                      self.propname, self.value_to_set
744
 
                      if not isinstance(self.value_to_set,
745
 
                                        dbus.Boolean)
746
 
                      else bool(self.value_to_set))
747
 
            client.Set(client_dbus_interface, self.propname,
748
 
                       self.value_to_set,
749
 
                       dbus_interface=dbus.PROPERTIES_IFACE)
750
 
 
751
 
        @property
752
 
        def propname(self):
753
 
            raise NotImplementedError()
754
 
 
755
 
 
756
 
    class Enable(Property):
757
 
        propname = "Enabled"
758
 
        value_to_set = dbus.Boolean(True)
759
 
 
760
 
 
761
 
    class Disable(Property):
762
 
        propname = "Enabled"
763
 
        value_to_set = dbus.Boolean(False)
764
 
 
765
 
 
766
 
    class BumpTimeout(Property):
767
 
        propname = "LastCheckedOK"
768
 
        value_to_set = ""
769
 
 
770
 
 
771
 
    class StartChecker(Property):
772
 
        propname = "CheckerRunning"
773
 
        value_to_set = dbus.Boolean(True)
774
 
 
775
 
 
776
 
    class StopChecker(Property):
777
 
        propname = "CheckerRunning"
778
 
        value_to_set = dbus.Boolean(False)
779
 
 
780
 
 
781
 
    class ApproveByDefault(Property):
782
 
        propname = "ApprovedByDefault"
783
 
        value_to_set = dbus.Boolean(True)
784
 
 
785
 
 
786
 
    class DenyByDefault(Property):
787
 
        propname = "ApprovedByDefault"
788
 
        value_to_set = dbus.Boolean(False)
789
 
 
790
 
 
791
 
    class PropertyValue(Property):
792
 
        "Abstract class for Property recieving a value as argument"
793
 
        def __init__(self, value):
794
 
            self.value_to_set = value
795
 
 
796
 
 
797
 
    class SetChecker(PropertyValue):
798
 
        propname = "Checker"
799
 
 
800
 
 
801
 
    class SetHost(PropertyValue):
802
 
        propname = "Host"
803
 
 
804
 
 
805
 
    class SetSecret(PropertyValue):
806
 
        propname = "Secret"
807
 
 
808
 
        @property
809
 
        def value_to_set(self):
810
 
            return self._vts
811
 
 
812
 
        @value_to_set.setter
813
 
        def value_to_set(self, value):
814
 
            """When setting, read data from supplied file object"""
815
 
            self._vts = value.read()
816
 
            value.close()
817
 
 
818
 
 
819
 
    class MillisecondsPropertyValueArgument(PropertyValue):
820
 
        """Abstract class for PropertyValue taking a value argument as
 
707
        def milliseconds_to_string(ms):
 
708
            td = datetime.timedelta(0, 0, 0, ms)
 
709
            return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
710
                    .format(days="{}T".format(td.days)
 
711
                            if td.days else "",
 
712
                            hours=td.seconds // 3600,
 
713
                            minutes=(td.seconds % 3600) // 60,
 
714
                            seconds=td.seconds % 60))
 
715
 
 
716
 
 
717
class PropertyCmd(Command):
 
718
    """Abstract class for Actions for setting one client property"""
 
719
 
 
720
    def run_on_one_client(self, client, properties):
 
721
        """Set the Client's D-Bus property"""
 
722
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
723
                  client.__dbus_object_path__,
 
724
                  dbus.PROPERTIES_IFACE, client_dbus_interface,
 
725
                  self.propname, self.value_to_set
 
726
                  if not isinstance(self.value_to_set, dbus.Boolean)
 
727
                  else bool(self.value_to_set))
 
728
        client.Set(client_dbus_interface, self.propname,
 
729
                   self.value_to_set,
 
730
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
731
 
 
732
    @property
 
733
    def propname(self):
 
734
        raise NotImplementedError()
 
735
 
 
736
 
 
737
class EnableCmd(PropertyCmd):
 
738
    propname = "Enabled"
 
739
    value_to_set = dbus.Boolean(True)
 
740
 
 
741
 
 
742
class DisableCmd(PropertyCmd):
 
743
    propname = "Enabled"
 
744
    value_to_set = dbus.Boolean(False)
 
745
 
 
746
 
 
747
class BumpTimeoutCmd(PropertyCmd):
 
748
    propname = "LastCheckedOK"
 
749
    value_to_set = ""
 
750
 
 
751
 
 
752
class StartCheckerCmd(PropertyCmd):
 
753
    propname = "CheckerRunning"
 
754
    value_to_set = dbus.Boolean(True)
 
755
 
 
756
 
 
757
class StopCheckerCmd(PropertyCmd):
 
758
    propname = "CheckerRunning"
 
759
    value_to_set = dbus.Boolean(False)
 
760
 
 
761
 
 
762
class ApproveByDefaultCmd(PropertyCmd):
 
763
    propname = "ApprovedByDefault"
 
764
    value_to_set = dbus.Boolean(True)
 
765
 
 
766
 
 
767
class DenyByDefaultCmd(PropertyCmd):
 
768
    propname = "ApprovedByDefault"
 
769
    value_to_set = dbus.Boolean(False)
 
770
 
 
771
 
 
772
class PropertyValueCmd(PropertyCmd):
 
773
    """Abstract class for PropertyCmd recieving a value as argument"""
 
774
    def __init__(self, value):
 
775
        self.value_to_set = value
 
776
 
 
777
 
 
778
class SetCheckerCmd(PropertyValueCmd):
 
779
    propname = "Checker"
 
780
 
 
781
 
 
782
class SetHostCmd(PropertyValueCmd):
 
783
    propname = "Host"
 
784
 
 
785
 
 
786
class SetSecretCmd(PropertyValueCmd):
 
787
    propname = "Secret"
 
788
 
 
789
    @property
 
790
    def value_to_set(self):
 
791
        return self._vts
 
792
 
 
793
    @value_to_set.setter
 
794
    def value_to_set(self, value):
 
795
        """When setting, read data from supplied file object"""
 
796
        self._vts = value.read()
 
797
        value.close()
 
798
 
 
799
 
 
800
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
 
801
    """Abstract class for PropertyValueCmd taking a value argument as
821
802
a datetime.timedelta() but should store it as milliseconds."""
822
803
 
823
 
        @property
824
 
        def value_to_set(self):
825
 
            return self._vts
826
 
 
827
 
        @value_to_set.setter
828
 
        def value_to_set(self, value):
829
 
            "When setting, convert value from a datetime.timedelta"
830
 
            self._vts = int(round(value.total_seconds() * 1000))
831
 
 
832
 
 
833
 
    class SetTimeout(MillisecondsPropertyValueArgument):
834
 
        propname = "Timeout"
835
 
 
836
 
 
837
 
    class SetExtendedTimeout(MillisecondsPropertyValueArgument):
838
 
        propname = "ExtendedTimeout"
839
 
 
840
 
 
841
 
    class SetInterval(MillisecondsPropertyValueArgument):
842
 
        propname = "Interval"
843
 
 
844
 
 
845
 
    class SetApprovalDelay(MillisecondsPropertyValueArgument):
846
 
        propname = "ApprovalDelay"
847
 
 
848
 
 
849
 
    class SetApprovalDuration(MillisecondsPropertyValueArgument):
850
 
        propname = "ApprovalDuration"
 
804
    @property
 
805
    def value_to_set(self):
 
806
        return self._vts
 
807
 
 
808
    @value_to_set.setter
 
809
    def value_to_set(self, value):
 
810
        """When setting, convert value from a datetime.timedelta"""
 
811
        self._vts = int(round(value.total_seconds() * 1000))
 
812
 
 
813
 
 
814
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
815
    propname = "Timeout"
 
816
 
 
817
 
 
818
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
819
    propname = "ExtendedTimeout"
 
820
 
 
821
 
 
822
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
 
823
    propname = "Interval"
 
824
 
 
825
 
 
826
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
 
827
    propname = "ApprovalDelay"
 
828
 
 
829
 
 
830
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
 
831
    propname = "ApprovalDuration"
851
832
 
852
833
 
853
834
 
854
 
class TestCaseWithAssertLogs(unittest.TestCase):
855
 
    """unittest.TestCase.assertLogs only exists in Python 3.4"""
856
 
 
857
 
    if not hasattr(unittest.TestCase, "assertLogs"):
858
 
        @contextlib.contextmanager
859
 
        def assertLogs(self, logger, level=logging.INFO):
860
 
            capturing_handler = self.CapturingLevelHandler(level)
861
 
            old_level = logger.level
862
 
            old_propagate = logger.propagate
863
 
            logger.addHandler(capturing_handler)
864
 
            logger.setLevel(level)
865
 
            logger.propagate = False
866
 
            try:
867
 
                yield capturing_handler.watcher
868
 
            finally:
869
 
                logger.propagate = old_propagate
870
 
                logger.removeHandler(capturing_handler)
871
 
                logger.setLevel(old_level)
872
 
            self.assertGreater(len(capturing_handler.watcher.records),
873
 
                               0)
874
 
 
875
 
        class CapturingLevelHandler(logging.Handler):
876
 
            def __init__(self, level, *args, **kwargs):
877
 
                logging.Handler.__init__(self, *args, **kwargs)
878
 
                self.watcher = self.LoggingWatcher([], [])
879
 
            def emit(self, record):
880
 
                self.watcher.records.append(record)
881
 
                self.watcher.output.append(self.format(record))
882
 
 
883
 
            LoggingWatcher = collections.namedtuple("LoggingWatcher",
884
 
                                                    ("records",
885
 
                                                     "output"))
886
 
 
887
 
 
888
 
class Test_string_to_delta(TestCaseWithAssertLogs):
 
835
class Test_string_to_delta(unittest.TestCase):
889
836
    def test_handles_basic_rfc3339(self):
890
837
        self.assertEqual(string_to_delta("PT0S"),
891
838
                         datetime.timedelta())
897
844
                         datetime.timedelta(0, 7200))
898
845
 
899
846
    def test_falls_back_to_pre_1_6_1_with_warning(self):
900
 
        with self.assertLogs(log, logging.WARNING):
901
 
            value = string_to_delta("2h")
 
847
        # assertLogs only exists in Python 3.4
 
848
        if hasattr(self, "assertLogs"):
 
849
            with self.assertLogs(log, logging.WARNING):
 
850
                value = string_to_delta("2h")
 
851
        else:
 
852
            class WarningFilter(logging.Filter):
 
853
                """Don't show, but record the presence of, warnings"""
 
854
                def filter(self, record):
 
855
                    is_warning = record.levelno >= logging.WARNING
 
856
                    self.found = is_warning or getattr(self, "found",
 
857
                                                       False)
 
858
                    return not is_warning
 
859
            warning_filter = WarningFilter()
 
860
            log.addFilter(warning_filter)
 
861
            try:
 
862
                value = string_to_delta("2h")
 
863
            finally:
 
864
                log.removeFilter(warning_filter)
 
865
            self.assertTrue(getattr(warning_filter, "found", False))
902
866
        self.assertEqual(value, datetime.timedelta(0, 7200))
903
867
 
904
868
 
943
907
    @contextlib.contextmanager
944
908
    def assertParseError(self):
945
909
        with self.assertRaises(SystemExit) as e:
946
 
            with self.redirect_stderr_to_devnull():
 
910
            with self.temporarily_suppress_stderr():
947
911
                yield
948
912
        # Exit code from argparse is guaranteed to be "2".  Reference:
949
913
        # https://docs.python.org/3/library
952
916
 
953
917
    @staticmethod
954
918
    @contextlib.contextmanager
955
 
    def redirect_stderr_to_devnull():
 
919
    def temporarily_suppress_stderr():
956
920
        null = os.open(os.path.devnull, os.O_RDWR)
957
921
        stderrcopy = os.dup(sys.stderr.fileno())
958
922
        os.dup2(null, sys.stderr.fileno())
967
931
    def check_option_syntax(self, options):
968
932
        check_option_syntax(self.parser, options)
969
933
 
970
 
    def test_actions_all_conflicts_with_verbose(self):
971
 
        for action, value in self.actions.items():
972
 
            options = self.parser.parse_args()
973
 
            setattr(options, action, value)
974
 
            options.all = True
975
 
            options.verbose = True
976
 
            with self.assertParseError():
977
 
                self.check_option_syntax(options)
978
 
 
979
 
    def test_actions_with_client_conflicts_with_verbose(self):
980
 
        for action, value in self.actions.items():
981
 
            options = self.parser.parse_args()
982
 
            setattr(options, action, value)
983
 
            options.verbose = True
984
 
            options.client = ["foo"]
 
934
    def test_actions_conflicts_with_verbose(self):
 
935
        for action, value in self.actions.items():
 
936
            options = self.parser.parse_args()
 
937
            setattr(options, action, value)
 
938
            options.verbose = True
985
939
            with self.assertParseError():
986
940
                self.check_option_syntax(options)
987
941
 
1013
967
            options.all = True
1014
968
            self.check_option_syntax(options)
1015
969
 
1016
 
    def test_any_action_is_ok_with_one_client(self):
1017
 
        for action, value in self.actions.items():
1018
 
            options = self.parser.parse_args()
1019
 
            setattr(options, action, value)
1020
 
            options.client = ["foo"]
 
970
    def test_is_enabled_fails_without_client(self):
 
971
        options = self.parser.parse_args()
 
972
        options.is_enabled = True
 
973
        with self.assertParseError():
1021
974
            self.check_option_syntax(options)
1022
975
 
1023
 
    def test_one_client_with_all_actions_except_is_enabled(self):
 
976
    def test_is_enabled_works_with_one_client(self):
1024
977
        options = self.parser.parse_args()
1025
 
        for action, value in self.actions.items():
1026
 
            if action == "is_enabled":
1027
 
                continue
1028
 
            setattr(options, action, value)
 
978
        options.is_enabled = True
1029
979
        options.client = ["foo"]
1030
980
        self.check_option_syntax(options)
1031
981
 
1032
 
    def test_two_clients_with_all_actions_except_is_enabled(self):
1033
 
        options = self.parser.parse_args()
1034
 
        for action, value in self.actions.items():
1035
 
            if action == "is_enabled":
1036
 
                continue
1037
 
            setattr(options, action, value)
1038
 
        options.client = ["foo", "barbar"]
1039
 
        self.check_option_syntax(options)
1040
 
 
1041
 
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1042
 
        for action, value in self.actions.items():
1043
 
            if action == "is_enabled":
1044
 
                continue
1045
 
            options = self.parser.parse_args()
1046
 
            setattr(options, action, value)
1047
 
            options.client = ["foo", "barbar"]
1048
 
            self.check_option_syntax(options)
1049
 
 
1050
 
    def test_is_enabled_fails_without_client(self):
1051
 
        options = self.parser.parse_args()
1052
 
        options.is_enabled = True
1053
 
        with self.assertParseError():
1054
 
            self.check_option_syntax(options)
1055
 
 
1056
982
    def test_is_enabled_fails_with_two_clients(self):
1057
983
        options = self.parser.parse_args()
1058
984
        options.is_enabled = True
1072
998
                self.check_option_syntax(options)
1073
999
 
1074
1000
 
1075
 
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
 
1001
class Test_get_mandos_dbus_object(unittest.TestCase):
1076
1002
    def test_calls_and_returns_get_object_on_bus(self):
1077
1003
        class MockBus(object):
1078
1004
            called = False
1093
1019
            def get_object(self, busname, dbus_path):
1094
1020
                raise dbus.exceptions.DBusException("Test")
1095
1021
 
1096
 
        with self.assertLogs(log, logging.CRITICAL):
1097
 
            with self.assertRaises(SystemExit) as e:
1098
 
                bus = get_mandos_dbus_object(bus=MockBusFailing())
1099
 
 
 
1022
        # assertLogs only exists in Python 3.4
 
1023
        if hasattr(self, "assertLogs"):
 
1024
            with self.assertLogs(log, logging.CRITICAL):
 
1025
                with self.assertRaises(SystemExit) as e:
 
1026
                    bus = get_mandos_dbus_object(bus=MockBus())
 
1027
        else:
 
1028
            critical_filter = self.CriticalFilter()
 
1029
            log.addFilter(critical_filter)
 
1030
            try:
 
1031
                with self.assertRaises(SystemExit) as e:
 
1032
                    get_mandos_dbus_object(bus=MockBusFailing())
 
1033
            finally:
 
1034
                log.removeFilter(critical_filter)
 
1035
            self.assertTrue(critical_filter.found)
1100
1036
        if isinstance(e.exception.code, int):
1101
1037
            self.assertNotEqual(e.exception.code, 0)
1102
1038
        else:
1103
1039
            self.assertIsNotNone(e.exception.code)
1104
1040
 
1105
 
 
1106
 
class Test_get_managed_objects(TestCaseWithAssertLogs):
1107
 
    def test_calls_and_returns_GetManagedObjects(self):
1108
 
        managed_objects = {"/clients/foo": { "Name": "foo"}}
1109
 
        class MockObjectManager(object):
1110
 
            def GetManagedObjects(self):
1111
 
                return managed_objects
1112
 
        retval = get_managed_objects(MockObjectManager())
1113
 
        self.assertDictEqual(managed_objects, retval)
1114
 
 
1115
 
    def test_logs_and_exits_on_dbus_error(self):
1116
 
        dbus_logger = logging.getLogger("dbus.proxies")
1117
 
 
1118
 
        class MockObjectManagerFailing(object):
1119
 
            def GetManagedObjects(self):
1120
 
                dbus_logger.error("Test")
1121
 
                raise dbus.exceptions.DBusException("Test")
1122
 
 
1123
 
        class CountingHandler(logging.Handler):
1124
 
            count = 0
1125
 
            def emit(self, record):
1126
 
                self.count += 1
1127
 
 
1128
 
        counting_handler = CountingHandler()
1129
 
 
1130
 
        dbus_logger.addHandler(counting_handler)
1131
 
 
 
1041
    class CriticalFilter(logging.Filter):
 
1042
        """Don't show, but register, critical messages"""
 
1043
        found = False
 
1044
        def filter(self, record):
 
1045
            is_critical = record.levelno >= logging.CRITICAL
 
1046
            self.found = is_critical or self.found
 
1047
            return not is_critical
 
1048
 
 
1049
 
 
1050
class Test_SilenceLogger(unittest.TestCase):
 
1051
    loggername = "mandos-ctl.Test_SilenceLogger"
 
1052
    log = logging.getLogger(loggername)
 
1053
    log.propagate = False
 
1054
    log.addHandler(logging.NullHandler())
 
1055
 
 
1056
    def setUp(self):
 
1057
        self.counting_filter = self.CountingFilter()
 
1058
 
 
1059
    class CountingFilter(logging.Filter):
 
1060
        "Count number of records"
 
1061
        count = 0
 
1062
        def filter(self, record):
 
1063
            self.count += 1
 
1064
            return True
 
1065
 
 
1066
    def test_should_filter_records_only_when_active(self):
1132
1067
        try:
1133
 
            with self.assertLogs(log, logging.CRITICAL) as watcher:
1134
 
                with self.assertRaises(SystemExit) as e:
1135
 
                    get_managed_objects(MockObjectManagerFailing())
 
1068
            with SilenceLogger(self.loggername):
 
1069
                self.log.addFilter(self.counting_filter)
 
1070
                self.log.info("Filtered log message 1")
 
1071
            self.log.info("Non-filtered message 2")
 
1072
            self.log.info("Non-filtered message 3")
1136
1073
        finally:
1137
 
            dbus_logger.removeFilter(counting_handler)
1138
 
 
1139
 
        # Make sure the dbus logger was suppressed
1140
 
        self.assertEqual(counting_handler.count, 0)
1141
 
 
1142
 
        # Test that the dbus_logger still works
1143
 
        with self.assertLogs(dbus_logger, logging.ERROR):
1144
 
            dbus_logger.error("Test")
1145
 
 
1146
 
        if isinstance(e.exception.code, int):
1147
 
            self.assertNotEqual(e.exception.code, 0)
1148
 
        else:
1149
 
            self.assertIsNotNone(e.exception.code)
 
1074
            self.log.removeFilter(self.counting_filter)
 
1075
        self.assertEqual(self.counting_filter.count, 2)
1150
1076
 
1151
1077
 
1152
1078
class Test_commands_from_options(unittest.TestCase):
1156
1082
 
1157
1083
    def test_is_enabled(self):
1158
1084
        self.assert_command_from_args(["--is-enabled", "foo"],
1159
 
                                      command.IsEnabled)
 
1085
                                      IsEnabledCmd)
1160
1086
 
1161
1087
    def assert_command_from_args(self, args, command_cls,
1162
1088
                                 **cmd_attrs):
1172
1098
            self.assertEqual(getattr(command, key), value)
1173
1099
 
1174
1100
    def test_is_enabled_short(self):
1175
 
        self.assert_command_from_args(["-V", "foo"],
1176
 
                                      command.IsEnabled)
 
1101
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1177
1102
 
1178
1103
    def test_approve(self):
1179
1104
        self.assert_command_from_args(["--approve", "foo"],
1180
 
                                      command.Approve)
 
1105
                                      ApproveCmd)
1181
1106
 
1182
1107
    def test_approve_short(self):
1183
 
        self.assert_command_from_args(["-A", "foo"], command.Approve)
 
1108
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1184
1109
 
1185
1110
    def test_deny(self):
1186
 
        self.assert_command_from_args(["--deny", "foo"], command.Deny)
 
1111
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1187
1112
 
1188
1113
    def test_deny_short(self):
1189
 
        self.assert_command_from_args(["-D", "foo"], command.Deny)
 
1114
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
1190
1115
 
1191
1116
    def test_remove(self):
1192
1117
        self.assert_command_from_args(["--remove", "foo"],
1193
 
                                      command.Remove)
 
1118
                                      RemoveCmd)
1194
1119
 
1195
1120
    def test_deny_before_remove(self):
1196
1121
        options = self.parser.parse_args(["--deny", "--remove",
1198
1123
        check_option_syntax(self.parser, options)
1199
1124
        commands = commands_from_options(options)
1200
1125
        self.assertEqual(len(commands), 2)
1201
 
        self.assertIsInstance(commands[0], command.Deny)
1202
 
        self.assertIsInstance(commands[1], command.Remove)
 
1126
        self.assertIsInstance(commands[0], DenyCmd)
 
1127
        self.assertIsInstance(commands[1], RemoveCmd)
1203
1128
 
1204
1129
    def test_deny_before_remove_reversed(self):
1205
1130
        options = self.parser.parse_args(["--remove", "--deny",
1207
1132
        check_option_syntax(self.parser, options)
1208
1133
        commands = commands_from_options(options)
1209
1134
        self.assertEqual(len(commands), 2)
1210
 
        self.assertIsInstance(commands[0], command.Deny)
1211
 
        self.assertIsInstance(commands[1], command.Remove)
 
1135
        self.assertIsInstance(commands[0], DenyCmd)
 
1136
        self.assertIsInstance(commands[1], RemoveCmd)
1212
1137
 
1213
1138
    def test_remove_short(self):
1214
 
        self.assert_command_from_args(["-r", "foo"], command.Remove)
 
1139
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1215
1140
 
1216
1141
    def test_dump_json(self):
1217
 
        self.assert_command_from_args(["--dump-json"],
1218
 
                                      command.DumpJSON)
 
1142
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1219
1143
 
1220
1144
    def test_enable(self):
1221
 
        self.assert_command_from_args(["--enable", "foo"],
1222
 
                                      command.Enable)
 
1145
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1223
1146
 
1224
1147
    def test_enable_short(self):
1225
 
        self.assert_command_from_args(["-e", "foo"], command.Enable)
 
1148
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
1226
1149
 
1227
1150
    def test_disable(self):
1228
1151
        self.assert_command_from_args(["--disable", "foo"],
1229
 
                                      command.Disable)
 
1152
                                      DisableCmd)
1230
1153
 
1231
1154
    def test_disable_short(self):
1232
 
        self.assert_command_from_args(["-d", "foo"], command.Disable)
 
1155
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
1233
1156
 
1234
1157
    def test_bump_timeout(self):
1235
1158
        self.assert_command_from_args(["--bump-timeout", "foo"],
1236
 
                                      command.BumpTimeout)
 
1159
                                      BumpTimeoutCmd)
1237
1160
 
1238
1161
    def test_bump_timeout_short(self):
1239
 
        self.assert_command_from_args(["-b", "foo"],
1240
 
                                      command.BumpTimeout)
 
1162
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1241
1163
 
1242
1164
    def test_start_checker(self):
1243
1165
        self.assert_command_from_args(["--start-checker", "foo"],
1244
 
                                      command.StartChecker)
 
1166
                                      StartCheckerCmd)
1245
1167
 
1246
1168
    def test_stop_checker(self):
1247
1169
        self.assert_command_from_args(["--stop-checker", "foo"],
1248
 
                                      command.StopChecker)
 
1170
                                      StopCheckerCmd)
1249
1171
 
1250
1172
    def test_approve_by_default(self):
1251
1173
        self.assert_command_from_args(["--approve-by-default", "foo"],
1252
 
                                      command.ApproveByDefault)
 
1174
                                      ApproveByDefaultCmd)
1253
1175
 
1254
1176
    def test_deny_by_default(self):
1255
1177
        self.assert_command_from_args(["--deny-by-default", "foo"],
1256
 
                                      command.DenyByDefault)
 
1178
                                      DenyByDefaultCmd)
1257
1179
 
1258
1180
    def test_checker(self):
1259
1181
        self.assert_command_from_args(["--checker", ":", "foo"],
1260
 
                                      command.SetChecker,
1261
 
                                      value_to_set=":")
 
1182
                                      SetCheckerCmd, value_to_set=":")
1262
1183
 
1263
1184
    def test_checker_empty(self):
1264
1185
        self.assert_command_from_args(["--checker", "", "foo"],
1265
 
                                      command.SetChecker,
1266
 
                                      value_to_set="")
 
1186
                                      SetCheckerCmd, value_to_set="")
1267
1187
 
1268
1188
    def test_checker_short(self):
1269
1189
        self.assert_command_from_args(["-c", ":", "foo"],
1270
 
                                      command.SetChecker,
1271
 
                                      value_to_set=":")
 
1190
                                      SetCheckerCmd, value_to_set=":")
1272
1191
 
1273
1192
    def test_host(self):
1274
1193
        self.assert_command_from_args(["--host", "foo.example.org",
1275
 
                                       "foo"], command.SetHost,
 
1194
                                       "foo"], SetHostCmd,
1276
1195
                                      value_to_set="foo.example.org")
1277
1196
 
1278
1197
    def test_host_short(self):
1279
1198
        self.assert_command_from_args(["-H", "foo.example.org",
1280
 
                                       "foo"], command.SetHost,
 
1199
                                       "foo"], SetHostCmd,
1281
1200
                                      value_to_set="foo.example.org")
1282
1201
 
1283
1202
    def test_secret_devnull(self):
1284
1203
        self.assert_command_from_args(["--secret", os.path.devnull,
1285
 
                                       "foo"], command.SetSecret,
 
1204
                                       "foo"], SetSecretCmd,
1286
1205
                                      value_to_set=b"")
1287
1206
 
1288
1207
    def test_secret_tempfile(self):
1291
1210
            f.write(value)
1292
1211
            f.seek(0)
1293
1212
            self.assert_command_from_args(["--secret", f.name,
1294
 
                                           "foo"], command.SetSecret,
 
1213
                                           "foo"], SetSecretCmd,
1295
1214
                                          value_to_set=value)
1296
1215
 
1297
1216
    def test_secret_devnull_short(self):
1298
1217
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1299
 
                                      command.SetSecret,
1300
 
                                      value_to_set=b"")
 
1218
                                      SetSecretCmd, value_to_set=b"")
1301
1219
 
1302
1220
    def test_secret_tempfile_short(self):
1303
1221
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1305
1223
            f.write(value)
1306
1224
            f.seek(0)
1307
1225
            self.assert_command_from_args(["-s", f.name, "foo"],
1308
 
                                          command.SetSecret,
 
1226
                                          SetSecretCmd,
1309
1227
                                          value_to_set=value)
1310
1228
 
1311
1229
    def test_timeout(self):
1312
1230
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1313
 
                                      command.SetTimeout,
 
1231
                                      SetTimeoutCmd,
1314
1232
                                      value_to_set=300000)
1315
1233
 
1316
1234
    def test_timeout_short(self):
1317
1235
        self.assert_command_from_args(["-t", "PT5M", "foo"],
1318
 
                                      command.SetTimeout,
 
1236
                                      SetTimeoutCmd,
1319
1237
                                      value_to_set=300000)
1320
1238
 
1321
1239
    def test_extended_timeout(self):
1322
1240
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1323
1241
                                       "foo"],
1324
 
                                      command.SetExtendedTimeout,
 
1242
                                      SetExtendedTimeoutCmd,
1325
1243
                                      value_to_set=900000)
1326
1244
 
1327
1245
    def test_interval(self):
1328
1246
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
1329
 
                                      command.SetInterval,
 
1247
                                      SetIntervalCmd,
1330
1248
                                      value_to_set=120000)
1331
1249
 
1332
1250
    def test_interval_short(self):
1333
1251
        self.assert_command_from_args(["-i", "PT2M", "foo"],
1334
 
                                      command.SetInterval,
 
1252
                                      SetIntervalCmd,
1335
1253
                                      value_to_set=120000)
1336
1254
 
1337
1255
    def test_approval_delay(self):
1338
1256
        self.assert_command_from_args(["--approval-delay", "PT30S",
1339
 
                                       "foo"],
1340
 
                                      command.SetApprovalDelay,
 
1257
                                       "foo"], SetApprovalDelayCmd,
1341
1258
                                      value_to_set=30000)
1342
1259
 
1343
1260
    def test_approval_duration(self):
1344
1261
        self.assert_command_from_args(["--approval-duration", "PT1S",
1345
 
                                       "foo"],
1346
 
                                      command.SetApprovalDuration,
 
1262
                                       "foo"], SetApprovalDurationCmd,
1347
1263
                                      value_to_set=1000)
1348
1264
 
1349
1265
    def test_print_table(self):
1350
 
        self.assert_command_from_args([], command.PrintTable,
 
1266
        self.assert_command_from_args([], PrintTableCmd,
1351
1267
                                      verbose=False)
1352
1268
 
1353
1269
    def test_print_table_verbose(self):
1354
 
        self.assert_command_from_args(["--verbose"],
1355
 
                                      command.PrintTable,
 
1270
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
1356
1271
                                      verbose=True)
1357
1272
 
1358
1273
    def test_print_table_verbose_short(self):
1359
 
        self.assert_command_from_args(["-v"], command.PrintTable,
 
1274
        self.assert_command_from_args(["-v"], PrintTableCmd,
1360
1275
                                      verbose=True)
1361
1276
 
1362
1277
 
1363
 
class TestCommand(unittest.TestCase):
 
1278
class TestCmd(unittest.TestCase):
1364
1279
    """Abstract class for tests of command classes"""
1365
1280
 
1366
1281
    def setUp(self):
1456
1371
        return Bus()
1457
1372
 
1458
1373
 
1459
 
class TestBaseCommands(TestCommand):
1460
 
 
 
1374
class TestIsEnabledCmd(TestCmd):
1461
1375
    def test_is_enabled(self):
1462
 
        self.assertTrue(all(command.IsEnabled().is_enabled(client,
 
1376
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1463
1377
                                                      properties)
1464
1378
                            for client, properties
1465
1379
                            in self.clients.items()))
1466
1380
 
1467
1381
    def test_is_enabled_run_exits_successfully(self):
1468
1382
        with self.assertRaises(SystemExit) as e:
1469
 
            command.IsEnabled().run(self.one_client)
 
1383
            IsEnabledCmd().run(self.one_client)
1470
1384
        if e.exception.code is not None:
1471
1385
            self.assertEqual(e.exception.code, 0)
1472
1386
        else:
1475
1389
    def test_is_enabled_run_exits_with_failure(self):
1476
1390
        self.client.attributes["Enabled"] = dbus.Boolean(False)
1477
1391
        with self.assertRaises(SystemExit) as e:
1478
 
            command.IsEnabled().run(self.one_client)
 
1392
            IsEnabledCmd().run(self.one_client)
1479
1393
        if isinstance(e.exception.code, int):
1480
1394
            self.assertNotEqual(e.exception.code, 0)
1481
1395
        else:
1482
1396
            self.assertIsNotNone(e.exception.code)
1483
1397
 
 
1398
 
 
1399
class TestApproveCmd(TestCmd):
1484
1400
    def test_approve(self):
1485
 
        command.Approve().run(self.clients, self.bus)
 
1401
        ApproveCmd().run(self.clients, self.bus)
1486
1402
        for clientpath in self.clients:
1487
1403
            client = self.bus.get_object(dbus_busname, clientpath)
1488
1404
            self.assertIn(("Approve", (True, client_dbus_interface)),
1489
1405
                          client.calls)
1490
1406
 
 
1407
 
 
1408
class TestDenyCmd(TestCmd):
1491
1409
    def test_deny(self):
1492
 
        command.Deny().run(self.clients, self.bus)
 
1410
        DenyCmd().run(self.clients, self.bus)
1493
1411
        for clientpath in self.clients:
1494
1412
            client = self.bus.get_object(dbus_busname, clientpath)
1495
1413
            self.assertIn(("Approve", (False, client_dbus_interface)),
1496
1414
                          client.calls)
1497
1415
 
 
1416
 
 
1417
class TestRemoveCmd(TestCmd):
1498
1418
    def test_remove(self):
1499
1419
        class MockMandos(object):
1500
1420
            def __init__(self):
1502
1422
            def RemoveClient(self, dbus_path):
1503
1423
                self.calls.append(("RemoveClient", (dbus_path,)))
1504
1424
        mandos = MockMandos()
1505
 
        super(TestBaseCommands, self).setUp()
1506
 
        command.Remove().run(self.clients, self.bus, mandos)
 
1425
        super(TestRemoveCmd, self).setUp()
 
1426
        RemoveCmd().run(self.clients, self.bus, mandos)
1507
1427
        self.assertEqual(len(mandos.calls), 2)
1508
1428
        for clientpath in self.clients:
1509
1429
            self.assertIn(("RemoveClient", (clientpath,)),
1510
1430
                          mandos.calls)
1511
1431
 
1512
 
    expected_json = {
1513
 
        "foo": {
1514
 
            "Name": "foo",
1515
 
            "KeyID": ("92ed150794387c03ce684574b1139a65"
1516
 
                      "94a34f895daaaf09fd8ea90a27cddb12"),
1517
 
            "Host": "foo.example.org",
1518
 
            "Enabled": True,
1519
 
            "Timeout": 300000,
1520
 
            "LastCheckedOK": "2019-02-03T00:00:00",
1521
 
            "Created": "2019-01-02T00:00:00",
1522
 
            "Interval": 120000,
1523
 
            "Fingerprint": ("778827225BA7DE539C5A"
1524
 
                            "7CFA59CFF7CDBD9A5920"),
1525
 
            "CheckerRunning": False,
1526
 
            "LastEnabled": "2019-01-03T00:00:00",
1527
 
            "ApprovalPending": False,
1528
 
            "ApprovedByDefault": True,
1529
 
            "LastApprovalRequest": "",
1530
 
            "ApprovalDelay": 0,
1531
 
            "ApprovalDuration": 1000,
1532
 
            "Checker": "fping -q -- %(host)s",
1533
 
            "ExtendedTimeout": 900000,
1534
 
            "Expires": "2019-02-04T00:00:00",
1535
 
            "LastCheckerStatus": 0,
1536
 
        },
1537
 
        "barbar": {
1538
 
            "Name": "barbar",
1539
 
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
1540
 
                      "6ab612cff5ad227247e46c2b020f441c"),
1541
 
            "Host": "192.0.2.3",
1542
 
            "Enabled": True,
1543
 
            "Timeout": 300000,
1544
 
            "LastCheckedOK": "2019-02-04T00:00:00",
1545
 
            "Created": "2019-01-03T00:00:00",
1546
 
            "Interval": 120000,
1547
 
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
1548
 
                            "F547B3A107558FCA3A27"),
1549
 
            "CheckerRunning": True,
1550
 
            "LastEnabled": "2019-01-04T00:00:00",
1551
 
            "ApprovalPending": False,
1552
 
            "ApprovedByDefault": False,
1553
 
            "LastApprovalRequest": "2019-01-03T00:00:00",
1554
 
            "ApprovalDelay": 30000,
1555
 
            "ApprovalDuration": 93785000,
1556
 
            "Checker": ":",
1557
 
            "ExtendedTimeout": 900000,
1558
 
            "Expires": "2019-02-05T00:00:00",
1559
 
            "LastCheckerStatus": -2,
1560
 
        },
1561
 
    }
1562
 
 
1563
 
    def test_DumpJSON_normal(self):
1564
 
        output = command.DumpJSON().output(self.clients.values())
 
1432
 
 
1433
class TestDumpJSONCmd(TestCmd):
 
1434
    def setUp(self):
 
1435
        self.expected_json = {
 
1436
            "foo": {
 
1437
                "Name": "foo",
 
1438
                "KeyID": ("92ed150794387c03ce684574b1139a65"
 
1439
                          "94a34f895daaaf09fd8ea90a27cddb12"),
 
1440
                "Host": "foo.example.org",
 
1441
                "Enabled": True,
 
1442
                "Timeout": 300000,
 
1443
                "LastCheckedOK": "2019-02-03T00:00:00",
 
1444
                "Created": "2019-01-02T00:00:00",
 
1445
                "Interval": 120000,
 
1446
                "Fingerprint": ("778827225BA7DE539C5A"
 
1447
                                "7CFA59CFF7CDBD9A5920"),
 
1448
                "CheckerRunning": False,
 
1449
                "LastEnabled": "2019-01-03T00:00:00",
 
1450
                "ApprovalPending": False,
 
1451
                "ApprovedByDefault": True,
 
1452
                "LastApprovalRequest": "",
 
1453
                "ApprovalDelay": 0,
 
1454
                "ApprovalDuration": 1000,
 
1455
                "Checker": "fping -q -- %(host)s",
 
1456
                "ExtendedTimeout": 900000,
 
1457
                "Expires": "2019-02-04T00:00:00",
 
1458
                "LastCheckerStatus": 0,
 
1459
            },
 
1460
            "barbar": {
 
1461
                "Name": "barbar",
 
1462
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
1463
                          "6ab612cff5ad227247e46c2b020f441c"),
 
1464
                "Host": "192.0.2.3",
 
1465
                "Enabled": True,
 
1466
                "Timeout": 300000,
 
1467
                "LastCheckedOK": "2019-02-04T00:00:00",
 
1468
                "Created": "2019-01-03T00:00:00",
 
1469
                "Interval": 120000,
 
1470
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
1471
                                "F547B3A107558FCA3A27"),
 
1472
                "CheckerRunning": True,
 
1473
                "LastEnabled": "2019-01-04T00:00:00",
 
1474
                "ApprovalPending": False,
 
1475
                "ApprovedByDefault": False,
 
1476
                "LastApprovalRequest": "2019-01-03T00:00:00",
 
1477
                "ApprovalDelay": 30000,
 
1478
                "ApprovalDuration": 93785000,
 
1479
                "Checker": ":",
 
1480
                "ExtendedTimeout": 900000,
 
1481
                "Expires": "2019-02-05T00:00:00",
 
1482
                "LastCheckerStatus": -2,
 
1483
            },
 
1484
        }
 
1485
        return super(TestDumpJSONCmd, self).setUp()
 
1486
 
 
1487
    def test_normal(self):
 
1488
        output = DumpJSONCmd().output(self.clients.values())
1565
1489
        json_data = json.loads(output)
1566
1490
        self.assertDictEqual(json_data, self.expected_json)
1567
1491
 
1568
 
    def test_DumpJSON_one_client(self):
1569
 
        output = command.DumpJSON().output(self.one_client.values())
 
1492
    def test_one_client(self):
 
1493
        output = DumpJSONCmd().output(self.one_client.values())
1570
1494
        json_data = json.loads(output)
1571
1495
        expected_json = {"foo": self.expected_json["foo"]}
1572
1496
        self.assertDictEqual(json_data, expected_json)
1573
1497
 
1574
 
    def test_PrintTable_normal(self):
1575
 
        output = command.PrintTable().output(self.clients.values())
 
1498
 
 
1499
class TestPrintTableCmd(TestCmd):
 
1500
    def test_normal(self):
 
1501
        output = PrintTableCmd().output(self.clients.values())
1576
1502
        expected_output = "\n".join((
1577
1503
            "Name   Enabled Timeout  Last Successful Check",
1578
1504
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1580
1506
        ))
1581
1507
        self.assertEqual(output, expected_output)
1582
1508
 
1583
 
    def test_PrintTable_verbose(self):
1584
 
        output = command.PrintTable(verbose=True).output(
 
1509
    def test_verbose(self):
 
1510
        output = PrintTableCmd(verbose=True).output(
1585
1511
            self.clients.values())
1586
1512
        columns = (
1587
1513
            (
1675
1601
                                    for line in range(num_lines))
1676
1602
        self.assertEqual(output, expected_output)
1677
1603
 
1678
 
    def test_PrintTable_one_client(self):
1679
 
        output = command.PrintTable().output(self.one_client.values())
 
1604
    def test_one_client(self):
 
1605
        output = PrintTableCmd().output(self.one_client.values())
1680
1606
        expected_output = "\n".join((
1681
1607
            "Name Enabled Timeout  Last Successful Check",
1682
1608
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
1684
1610
        self.assertEqual(output, expected_output)
1685
1611
 
1686
1612
 
1687
 
class TestPropertyCmd(TestCommand):
1688
 
    """Abstract class for tests of command.Property classes"""
 
1613
class TestPropertyCmd(TestCmd):
 
1614
    """Abstract class for tests of PropertyCmd classes"""
1689
1615
    def runTest(self):
1690
1616
        if not hasattr(self, "command"):
1691
1617
            return
1714
1640
 
1715
1641
 
1716
1642
class TestEnableCmd(TestPropertyCmd):
1717
 
    command = command.Enable
 
1643
    command = EnableCmd
1718
1644
    propname = "Enabled"
1719
1645
    values_to_set = [dbus.Boolean(True)]
1720
1646
 
1721
1647
 
1722
1648
class TestDisableCmd(TestPropertyCmd):
1723
 
    command = command.Disable
 
1649
    command = DisableCmd
1724
1650
    propname = "Enabled"
1725
1651
    values_to_set = [dbus.Boolean(False)]
1726
1652
 
1727
1653
 
1728
1654
class TestBumpTimeoutCmd(TestPropertyCmd):
1729
 
    command = command.BumpTimeout
 
1655
    command = BumpTimeoutCmd
1730
1656
    propname = "LastCheckedOK"
1731
1657
    values_to_set = [""]
1732
1658
 
1733
1659
 
1734
1660
class TestStartCheckerCmd(TestPropertyCmd):
1735
 
    command = command.StartChecker
 
1661
    command = StartCheckerCmd
1736
1662
    propname = "CheckerRunning"
1737
1663
    values_to_set = [dbus.Boolean(True)]
1738
1664
 
1739
1665
 
1740
1666
class TestStopCheckerCmd(TestPropertyCmd):
1741
 
    command = command.StopChecker
 
1667
    command = StopCheckerCmd
1742
1668
    propname = "CheckerRunning"
1743
1669
    values_to_set = [dbus.Boolean(False)]
1744
1670
 
1745
1671
 
1746
1672
class TestApproveByDefaultCmd(TestPropertyCmd):
1747
 
    command = command.ApproveByDefault
 
1673
    command = ApproveByDefaultCmd
1748
1674
    propname = "ApprovedByDefault"
1749
1675
    values_to_set = [dbus.Boolean(True)]
1750
1676
 
1751
1677
 
1752
1678
class TestDenyByDefaultCmd(TestPropertyCmd):
1753
 
    command = command.DenyByDefault
 
1679
    command = DenyByDefaultCmd
1754
1680
    propname = "ApprovedByDefault"
1755
1681
    values_to_set = [dbus.Boolean(False)]
1756
1682
 
1768
1694
 
1769
1695
 
1770
1696
class TestSetCheckerCmd(TestPropertyValueCmd):
1771
 
    command = command.SetChecker
 
1697
    command = SetCheckerCmd
1772
1698
    propname = "Checker"
1773
1699
    values_to_set = ["", ":", "fping -q -- %s"]
1774
1700
 
1775
1701
 
1776
1702
class TestSetHostCmd(TestPropertyValueCmd):
1777
 
    command = command.SetHost
 
1703
    command = SetHostCmd
1778
1704
    propname = "Host"
1779
1705
    values_to_set = ["192.0.2.3", "foo.example.org"]
1780
1706
 
1781
1707
 
1782
1708
class TestSetSecretCmd(TestPropertyValueCmd):
1783
 
    command = command.SetSecret
 
1709
    command = SetSecretCmd
1784
1710
    propname = "Secret"
1785
1711
    values_to_set = [io.BytesIO(b""),
1786
1712
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1788
1714
 
1789
1715
 
1790
1716
class TestSetTimeoutCmd(TestPropertyValueCmd):
1791
 
    command = command.SetTimeout
 
1717
    command = SetTimeoutCmd
1792
1718
    propname = "Timeout"
1793
1719
    values_to_set = [datetime.timedelta(),
1794
1720
                     datetime.timedelta(minutes=5),
1799
1725
 
1800
1726
 
1801
1727
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1802
 
    command = command.SetExtendedTimeout
 
1728
    command = SetExtendedTimeoutCmd
1803
1729
    propname = "ExtendedTimeout"
1804
1730
    values_to_set = [datetime.timedelta(),
1805
1731
                     datetime.timedelta(minutes=5),
1810
1736
 
1811
1737
 
1812
1738
class TestSetIntervalCmd(TestPropertyValueCmd):
1813
 
    command = command.SetInterval
 
1739
    command = SetIntervalCmd
1814
1740
    propname = "Interval"
1815
1741
    values_to_set = [datetime.timedelta(),
1816
1742
                     datetime.timedelta(minutes=5),
1821
1747
 
1822
1748
 
1823
1749
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1824
 
    command = command.SetApprovalDelay
 
1750
    command = SetApprovalDelayCmd
1825
1751
    propname = "ApprovalDelay"
1826
1752
    values_to_set = [datetime.timedelta(),
1827
1753
                     datetime.timedelta(minutes=5),
1832
1758
 
1833
1759
 
1834
1760
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1835
 
    command = command.SetApprovalDuration
 
1761
    command = SetApprovalDurationCmd
1836
1762
    propname = "ApprovalDuration"
1837
1763
    values_to_set = [datetime.timedelta(),
1838
1764
                     datetime.timedelta(minutes=5),