424
407
options.remove = True
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
434
return mandos_dbus_object
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
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
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
462
self.logger.addFilter(self.nullfilter)
465
class NullFilter(logging.Filter):
466
def filter(self, record):
469
nullfilter = NullFilter()
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
413
class SystemBus(object):
415
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
416
def get_managed_objects(self, busname, objectpath):
417
return self.call_method("GetManagedObjects", busname,
419
self.object_manager_iface)
421
properties_iface = "org.freedesktop.DBus.Properties"
422
def set_property(self, busname, objectpath, interface, key,
424
self.call_method("Set", busname, objectpath,
425
self.properties_iface, interface, key,
429
class MandosBus(SystemBus):
430
busname_domain = "se.recompile"
431
busname = busname_domain + ".Mandos"
433
server_interface = busname_domain + ".Mandos"
434
client_interface = busname_domain + ".Mandos.Client"
437
def get_clients_and_properties(self):
438
managed_objects = self.get_managed_objects(
439
self.busname, self.server_path)
440
return {objpath: properties[self.client_interface]
441
for objpath, properties in managed_objects.items()
442
if self.client_interface in properties}
444
def set_client_property(self, objectpath, key, value):
445
return self.set_property(self.busname, objectpath,
446
self.client_interface, key,
449
def call_client_method(self, objectpath, method, *args):
450
return self.call_method(method, self.busname, objectpath,
451
self.client_interface, *args)
453
def call_server_method(self, method, *args):
454
return self.call_method(method, self.busname,
456
self.server_interface, *args)
458
class Error(Exception):
461
class ConnectFailed(Error):
465
class dbus_python_adapter(object):
467
class SystemBus(dbus.MandosBus):
468
"""Use dbus-python"""
470
def __init__(self, module=dbus_python):
471
self.dbus_python = module
472
self.bus = self.dbus_python.SystemBus()
474
@contextlib.contextmanager
475
def convert_exception(self, exception_class=dbus.Error):
478
except self.dbus_python.exceptions.DBusException as e:
479
# This does what "raise from" would do
480
exc = exception_class(*e.args)
484
def call_method(self, methodname, busname, objectpath,
486
proxy_object = self.get_object(busname, objectpath)
487
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
488
interface, methodname,
489
", ".join(repr(a) for a in args))
490
method = getattr(proxy_object, methodname)
491
with self.convert_exception():
492
with dbus_python_adapter.SilenceLogger(
494
value = method(*args, dbus_interface=interface)
495
return self.type_filter(value)
497
def get_object(self, busname, objectpath):
498
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
500
with self.convert_exception(dbus.ConnectFailed):
501
return self.bus.get_object(busname, objectpath)
503
def type_filter(self, value):
504
"""Convert the most bothersome types to Python types"""
505
if isinstance(value, self.dbus_python.Boolean):
507
if isinstance(value, self.dbus_python.ObjectPath):
509
# Also recurse into dictionaries
510
if isinstance(value, self.dbus_python.Dictionary):
511
return {self.type_filter(key):
512
self.type_filter(subval)
513
for key, subval in value.items()}
517
class SilenceLogger(object):
518
"Simple context manager to silence a particular logger"
519
def __init__(self, loggername):
520
self.logger = logging.getLogger(loggername)
523
self.logger.addFilter(self.nullfilter)
525
class NullFilter(logging.Filter):
526
def filter(self, record):
529
nullfilter = NullFilter()
531
def __exit__(self, exc_type, exc_val, exc_tb):
532
self.logger.removeFilter(self.nullfilter)
535
class CachingBus(SystemBus):
536
"""A caching layer for dbus_python_adapter.SystemBus"""
537
def __init__(self, *args, **kwargs):
538
self.object_cache = {}
539
super(dbus_python_adapter.CachingBus,
540
self).__init__(*args, **kwargs)
541
def get_object(self, busname, objectpath):
543
return self.object_cache[(busname, objectpath)]
546
dbus_python_adapter.CachingBus,
547
self).get_object(busname, objectpath)
548
self.object_cache[(busname, objectpath)] = new_object
475
552
def commands_from_options(options):
479
556
if options.is_enabled:
480
commands.append(IsEnabledCmd())
557
commands.append(command.IsEnabled())
482
559
if options.approve:
483
commands.append(ApproveCmd())
560
commands.append(command.Approve())
486
commands.append(DenyCmd())
563
commands.append(command.Deny())
488
565
if options.remove:
489
commands.append(RemoveCmd())
566
commands.append(command.Remove())
491
568
if options.dump_json:
492
commands.append(DumpJSONCmd())
569
commands.append(command.DumpJSON())
494
571
if options.enable:
495
commands.append(EnableCmd())
572
commands.append(command.Enable())
497
574
if options.disable:
498
commands.append(DisableCmd())
575
commands.append(command.Disable())
500
577
if options.bump_timeout:
501
commands.append(BumpTimeoutCmd())
578
commands.append(command.BumpTimeout())
503
580
if options.start_checker:
504
commands.append(StartCheckerCmd())
581
commands.append(command.StartChecker())
506
583
if options.stop_checker:
507
commands.append(StopCheckerCmd())
584
commands.append(command.StopChecker())
509
586
if options.approved_by_default is not None:
510
587
if options.approved_by_default:
511
commands.append(ApproveByDefaultCmd())
588
commands.append(command.ApproveByDefault())
513
commands.append(DenyByDefaultCmd())
590
commands.append(command.DenyByDefault())
515
592
if options.checker is not None:
516
commands.append(SetCheckerCmd(options.checker))
593
commands.append(command.SetChecker(options.checker))
518
595
if options.host is not None:
519
commands.append(SetHostCmd(options.host))
596
commands.append(command.SetHost(options.host))
521
598
if options.secret is not None:
522
commands.append(SetSecretCmd(options.secret))
599
commands.append(command.SetSecret(options.secret))
524
601
if options.timeout is not None:
525
commands.append(SetTimeoutCmd(options.timeout))
602
commands.append(command.SetTimeout(options.timeout))
527
604
if options.extended_timeout:
529
SetExtendedTimeoutCmd(options.extended_timeout))
606
command.SetExtendedTimeout(options.extended_timeout))
531
608
if options.interval is not None:
532
commands.append(SetIntervalCmd(options.interval))
609
commands.append(command.SetInterval(options.interval))
534
611
if options.approval_delay is not None:
535
commands.append(SetApprovalDelayCmd(options.approval_delay))
613
command.SetApprovalDelay(options.approval_delay))
537
615
if options.approval_duration is not None:
539
SetApprovalDurationCmd(options.approval_duration))
617
command.SetApprovalDuration(options.approval_duration))
541
619
# If no command option has been given, show table of clients,
542
620
# optionally verbosely
544
commands.append(PrintTableCmd(verbose=options.verbose))
622
commands.append(command.PrintTable(verbose=options.verbose))
549
class Command(object):
550
"""Abstract class for commands"""
551
def run(self, clients, bus=None, mandos=None):
552
"""Normal commands should implement run_on_one_client(), but
553
commands which want to operate on all clients at the same time
554
can override this run() method instead."""
556
for clientpath, properties in clients.items():
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
dbus_busname, str(clientpath))
559
client = bus.get_object(dbus_busname, clientpath)
560
self.run_on_one_client(client, properties)
563
class IsEnabledCmd(Command):
564
def run(self, clients, bus=None, mandos=None):
565
client, properties = next(iter(clients.items()))
566
if self.is_enabled(client, properties):
569
def is_enabled(self, client, properties):
570
return properties["Enabled"]
573
class ApproveCmd(Command):
574
def run_on_one_client(self, client, properties):
575
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
576
client.__dbus_object_path__, client_dbus_interface)
577
client.Approve(dbus.Boolean(True),
578
dbus_interface=client_dbus_interface)
581
class DenyCmd(Command):
582
def run_on_one_client(self, client, properties):
583
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
584
client.__dbus_object_path__, client_dbus_interface)
585
client.Approve(dbus.Boolean(False),
586
dbus_interface=client_dbus_interface)
589
class RemoveCmd(Command):
590
def run_on_one_client(self, client, properties):
591
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
592
server_dbus_path, server_dbus_interface,
593
str(client.__dbus_object_path__))
594
self.mandos.RemoveClient(client.__dbus_object_path__)
597
class OutputCmd(Command):
598
"""Abstract class for commands outputting client details"""
599
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
600
"Created", "Interval", "Host", "KeyID",
601
"Fingerprint", "CheckerRunning", "LastEnabled",
602
"ApprovalPending", "ApprovedByDefault",
603
"LastApprovalRequest", "ApprovalDelay",
604
"ApprovalDuration", "Checker", "ExtendedTimeout",
605
"Expires", "LastCheckerStatus")
607
def run(self, clients, bus=None, mandos=None):
608
print(self.output(clients.values()))
610
def output(self, clients):
611
raise NotImplementedError()
614
class DumpJSONCmd(OutputCmd):
615
def output(self, clients):
616
data = {client["Name"]:
617
{key: self.dbus_boolean_to_bool(client[key])
618
for key in self.all_keywords}
619
for client in clients}
620
return json.dumps(data, indent=4, separators=(',', ': '))
623
def dbus_boolean_to_bool(value):
624
if isinstance(value, dbus.Boolean):
629
class PrintTableCmd(OutputCmd):
630
def __init__(self, verbose=False):
631
self.verbose = verbose
633
def output(self, clients):
634
default_keywords = ("Name", "Enabled", "Timeout",
636
keywords = default_keywords
638
keywords = self.all_keywords
639
return str(self.TableOfClients(clients, keywords))
641
class TableOfClients(object):
644
"Enabled": "Enabled",
645
"Timeout": "Timeout",
646
"LastCheckedOK": "Last Successful Check",
647
"LastApprovalRequest": "Last Approval Request",
648
"Created": "Created",
649
"Interval": "Interval",
651
"Fingerprint": "Fingerprint",
653
"CheckerRunning": "Check Is Running",
654
"LastEnabled": "Last Enabled",
655
"ApprovalPending": "Approval Is Pending",
656
"ApprovedByDefault": "Approved By Default",
657
"ApprovalDelay": "Approval Delay",
658
"ApprovalDuration": "Approval Duration",
659
"Checker": "Checker",
660
"ExtendedTimeout": "Extended Timeout",
661
"Expires": "Expires",
662
"LastCheckerStatus": "Last Checker Status",
665
def __init__(self, clients, keywords):
666
self.clients = clients
667
self.keywords = keywords
670
return "\n".join(self.rows())
672
if sys.version_info.major == 2:
673
__unicode__ = __str__
627
class command(object):
628
"""A namespace for command classes"""
631
"""Abstract base class for commands"""
632
def run(self, clients, bus=None):
633
"""Normal commands should implement run_on_one_client(),
634
but commands which want to operate on all clients at the same time can
635
override this run() method instead.
638
for client, properties in clients.items():
639
self.run_on_one_client(client, properties)
642
class IsEnabled(Base):
643
def run(self, clients, bus=None):
644
properties = next(iter(clients.values()))
645
if properties["Enabled"]:
651
def run_on_one_client(self, client, properties):
652
self.bus.call_client_method(client, "Approve", True)
656
def run_on_one_client(self, client, properties):
657
self.bus.call_client_method(client, "Approve", False)
661
def run(self, clients, bus):
662
for clientpath in frozenset(clients.keys()):
663
bus.call_server_method("RemoveClient", clientpath)
667
"""Abstract class for commands outputting client details"""
668
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
669
"Created", "Interval", "Host", "KeyID",
670
"Fingerprint", "CheckerRunning",
671
"LastEnabled", "ApprovalPending",
672
"ApprovedByDefault", "LastApprovalRequest",
673
"ApprovalDelay", "ApprovalDuration",
674
"Checker", "ExtendedTimeout", "Expires",
678
class DumpJSON(Output):
679
def run(self, clients, bus=None):
680
data = {properties["Name"]:
681
{key: properties[key]
682
for key in self.all_keywords}
683
for properties in clients.values()}
684
print(json.dumps(data, indent=4, separators=(',', ': ')))
687
class PrintTable(Output):
688
def __init__(self, verbose=False):
689
self.verbose = verbose
691
def run(self, clients, bus=None):
692
default_keywords = ("Name", "Enabled", "Timeout",
694
keywords = default_keywords
696
keywords = self.all_keywords
697
print(self.TableOfClients(clients.values(), keywords))
699
class TableOfClients(object):
702
"Enabled": "Enabled",
703
"Timeout": "Timeout",
704
"LastCheckedOK": "Last Successful Check",
705
"LastApprovalRequest": "Last Approval Request",
706
"Created": "Created",
707
"Interval": "Interval",
709
"Fingerprint": "Fingerprint",
711
"CheckerRunning": "Check Is Running",
712
"LastEnabled": "Last Enabled",
713
"ApprovalPending": "Approval Is Pending",
714
"ApprovedByDefault": "Approved By Default",
715
"ApprovalDelay": "Approval Delay",
716
"ApprovalDuration": "Approval Duration",
717
"Checker": "Checker",
718
"ExtendedTimeout": "Extended Timeout",
719
"Expires": "Expires",
720
"LastCheckerStatus": "Last Checker Status",
723
def __init__(self, clients, keywords):
724
self.clients = clients
725
self.keywords = keywords
674
727
def __str__(self):
675
return str(self).encode(locale.getpreferredencoding())
678
format_string = self.row_formatting_string()
679
rows = [self.header_line(format_string)]
680
rows.extend(self.client_line(client, format_string)
681
for client in self.clients)
684
def row_formatting_string(self):
685
"Format string used to format table rows"
686
return " ".join("{{{key}:{width}}}".format(
687
width=max(len(self.tableheaders[key]),
688
*(len(self.string_from_client(client, key))
689
for client in self.clients)),
691
for key in self.keywords)
693
def string_from_client(self, client, key):
694
return self.valuetostring(client[key], key)
697
def valuetostring(cls, value, keyword):
698
if isinstance(value, dbus.Boolean):
699
return "Yes" if value else "No"
700
if keyword in ("Timeout", "Interval", "ApprovalDelay",
701
"ApprovalDuration", "ExtendedTimeout"):
702
return cls.milliseconds_to_string(value)
705
def header_line(self, format_string):
706
return format_string.format(**self.tableheaders)
708
def client_line(self, client, format_string):
709
return format_string.format(
710
**{key: self.string_from_client(client, key)
711
for key in self.keywords})
714
def milliseconds_to_string(ms):
715
td = datetime.timedelta(0, 0, 0, ms)
716
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
717
.format(days="{}T".format(td.days)
719
hours=td.seconds // 3600,
720
minutes=(td.seconds % 3600) // 60,
721
seconds=td.seconds % 60))
724
class PropertyCmd(Command):
725
"""Abstract class for Actions for setting one client property"""
727
def run_on_one_client(self, client, properties):
728
"""Set the Client's D-Bus property"""
729
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
730
client.__dbus_object_path__,
731
dbus.PROPERTIES_IFACE, client_dbus_interface,
732
self.propname, self.value_to_set
733
if not isinstance(self.value_to_set, dbus.Boolean)
734
else bool(self.value_to_set))
735
client.Set(client_dbus_interface, self.propname,
737
dbus_interface=dbus.PROPERTIES_IFACE)
741
raise NotImplementedError()
744
class EnableCmd(PropertyCmd):
746
value_to_set = dbus.Boolean(True)
749
class DisableCmd(PropertyCmd):
751
value_to_set = dbus.Boolean(False)
754
class BumpTimeoutCmd(PropertyCmd):
755
propname = "LastCheckedOK"
759
class StartCheckerCmd(PropertyCmd):
760
propname = "CheckerRunning"
761
value_to_set = dbus.Boolean(True)
764
class StopCheckerCmd(PropertyCmd):
765
propname = "CheckerRunning"
766
value_to_set = dbus.Boolean(False)
769
class ApproveByDefaultCmd(PropertyCmd):
770
propname = "ApprovedByDefault"
771
value_to_set = dbus.Boolean(True)
774
class DenyByDefaultCmd(PropertyCmd):
775
propname = "ApprovedByDefault"
776
value_to_set = dbus.Boolean(False)
779
class PropertyValueCmd(PropertyCmd):
780
"""Abstract class for PropertyCmd recieving a value as argument"""
781
def __init__(self, value):
782
self.value_to_set = value
785
class SetCheckerCmd(PropertyValueCmd):
789
class SetHostCmd(PropertyValueCmd):
793
class SetSecretCmd(PropertyValueCmd):
797
def value_to_set(self):
801
def value_to_set(self, value):
802
"""When setting, read data from supplied file object"""
803
self._vts = value.read()
807
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
808
"""Abstract class for PropertyValueCmd taking a value argument as
809
a datetime.timedelta() but should store it as milliseconds."""
812
def value_to_set(self):
816
def value_to_set(self, value):
817
"""When setting, convert value from a datetime.timedelta"""
818
self._vts = int(round(value.total_seconds() * 1000))
821
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
825
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
826
propname = "ExtendedTimeout"
829
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
830
propname = "Interval"
833
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
834
propname = "ApprovalDelay"
837
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
838
propname = "ApprovalDuration"
728
return "\n".join(self.rows())
730
if sys.version_info.major == 2:
731
__unicode__ = __str__
733
return str(self).encode(
734
locale.getpreferredencoding())
737
format_string = self.row_formatting_string()
738
rows = [self.header_line(format_string)]
739
rows.extend(self.client_line(client, format_string)
740
for client in self.clients)
743
def row_formatting_string(self):
744
"Format string used to format table rows"
745
return " ".join("{{{key}:{width}}}".format(
746
width=max(len(self.tableheaders[key]),
747
*(len(self.string_from_client(client,
749
for client in self.clients)),
751
for key in self.keywords)
753
def string_from_client(self, client, key):
754
return self.valuetostring(client[key], key)
757
def valuetostring(cls, value, keyword):
758
if isinstance(value, bool):
759
return "Yes" if value else "No"
760
if keyword in ("Timeout", "Interval", "ApprovalDelay",
761
"ApprovalDuration", "ExtendedTimeout"):
762
return cls.milliseconds_to_string(value)
765
def header_line(self, format_string):
766
return format_string.format(**self.tableheaders)
768
def client_line(self, client, format_string):
769
return format_string.format(
770
**{key: self.string_from_client(client, key)
771
for key in self.keywords})
774
def milliseconds_to_string(ms):
775
td = datetime.timedelta(0, 0, 0, ms)
776
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
777
.format(days="{}T".format(td.days)
779
hours=td.seconds // 3600,
780
minutes=(td.seconds % 3600) // 60,
781
seconds=td.seconds % 60))
784
class PropertySetter(Base):
785
"Abstract class for Actions for setting one client property"
787
def run_on_one_client(self, client, properties=None):
788
"""Set the Client's D-Bus property"""
789
self.bus.set_client_property(client, self.propname,
794
raise NotImplementedError()
797
class Enable(PropertySetter):
802
class Disable(PropertySetter):
807
class BumpTimeout(PropertySetter):
808
propname = "LastCheckedOK"
812
class StartChecker(PropertySetter):
813
propname = "CheckerRunning"
817
class StopChecker(PropertySetter):
818
propname = "CheckerRunning"
822
class ApproveByDefault(PropertySetter):
823
propname = "ApprovedByDefault"
827
class DenyByDefault(PropertySetter):
828
propname = "ApprovedByDefault"
832
class PropertySetterValue(PropertySetter):
833
"""Abstract class for PropertySetter recieving a value as
834
constructor argument instead of a class attribute."""
835
def __init__(self, value):
836
self.value_to_set = value
839
class SetChecker(PropertySetterValue):
843
class SetHost(PropertySetterValue):
847
class SetSecret(PropertySetterValue):
851
def value_to_set(self):
855
def value_to_set(self, value):
856
"""When setting, read data from supplied file object"""
857
self._vts = value.read()
861
class PropertySetterValueMilliseconds(PropertySetterValue):
862
"""Abstract class for PropertySetterValue taking a value
863
argument as a datetime.timedelta() but should store it as
867
def value_to_set(self):
871
def value_to_set(self, value):
872
"When setting, convert value from a datetime.timedelta"
873
self._vts = int(round(value.total_seconds() * 1000))
876
class SetTimeout(PropertySetterValueMilliseconds):
880
class SetExtendedTimeout(PropertySetterValueMilliseconds):
881
propname = "ExtendedTimeout"
884
class SetInterval(PropertySetterValueMilliseconds):
885
propname = "Interval"
888
class SetApprovalDelay(PropertySetterValueMilliseconds):
889
propname = "ApprovalDelay"
892
class SetApprovalDuration(PropertySetterValueMilliseconds):
893
propname = "ApprovalDuration"
1041
1126
self.check_option_syntax(options)
1044
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1045
def test_calls_and_returns_get_object_on_bus(self):
1046
class MockBus(object):
1048
def get_object(mockbus_self, busname, dbus_path):
1049
# Note that "self" is still the testcase instance,
1050
# this MockBus instance is in "mockbus_self".
1051
self.assertEqual(busname, dbus_busname)
1052
self.assertEqual(dbus_path, server_dbus_path)
1053
mockbus_self.called = True
1056
mockbus = get_mandos_dbus_object(bus=MockBus())
1057
self.assertIsInstance(mockbus, MockBus)
1058
self.assertTrue(mockbus.called)
1060
def test_logs_and_exits_on_dbus_error(self):
1061
class MockBusFailing(object):
1062
def get_object(self, busname, dbus_path):
1063
raise dbus.exceptions.DBusException("Test")
1065
with self.assertLogs(log, logging.CRITICAL):
1066
with self.assertRaises(SystemExit) as e:
1067
bus = get_mandos_dbus_object(bus=MockBusFailing())
1069
if isinstance(e.exception.code, int):
1070
self.assertNotEqual(e.exception.code, 0)
1072
self.assertIsNotNone(e.exception.code)
1075
class Test_get_managed_objects(TestCaseWithAssertLogs):
1076
def test_calls_and_returns_GetManagedObjects(self):
1077
managed_objects = {"/clients/foo": { "Name": "foo"}}
1078
class MockObjectManager(object):
1079
def GetManagedObjects(self):
1080
return managed_objects
1081
retval = get_managed_objects(MockObjectManager())
1082
self.assertDictEqual(managed_objects, retval)
1084
def test_logs_and_exits_on_dbus_error(self):
1129
class Test_dbus_exceptions(unittest.TestCase):
1131
def test_dbus_ConnectFailed_is_Error(self):
1132
with self.assertRaises(dbus.Error):
1133
raise dbus.ConnectFailed()
1136
class Test_dbus_MandosBus(unittest.TestCase):
1138
class MockMandosBus(dbus.MandosBus):
1140
self._name = "se.recompile.Mandos"
1141
self._server_path = "/"
1142
self._server_interface = "se.recompile.Mandos"
1143
self._client_interface = "se.recompile.Mandos.Client"
1145
self.call_method_return = Unique()
1147
def call_method(self, methodname, busname, objectpath,
1149
self.calls.append((methodname, busname, objectpath,
1151
return self.call_method_return
1154
self.bus = self.MockMandosBus()
1156
def test_set_client_property(self):
1157
self.bus.set_client_property("objectpath", "key", "value")
1158
expected_call = ("Set", self.bus._name, "objectpath",
1159
"org.freedesktop.DBus.Properties",
1160
(self.bus._client_interface, "key", "value"))
1161
self.assertIn(expected_call, self.bus.calls)
1163
def test_call_client_method(self):
1164
ret = self.bus.call_client_method("objectpath", "methodname")
1165
self.assertIs(self.bus.call_method_return, ret)
1166
expected_call = ("methodname", self.bus._name, "objectpath",
1167
self.bus._client_interface, ())
1168
self.assertIn(expected_call, self.bus.calls)
1170
def test_call_client_method_with_args(self):
1171
args = (Unique(), Unique())
1172
ret = self.bus.call_client_method("objectpath", "methodname",
1174
self.assertIs(self.bus.call_method_return, ret)
1175
expected_call = ("methodname", self.bus._name, "objectpath",
1176
self.bus._client_interface,
1178
self.assertIn(expected_call, self.bus.calls)
1180
def test_get_clients_and_properties(self):
1183
self.bus._client_interface: {
1187
"irrelevant_interface": {
1188
"key": "othervalue",
1192
"other_objectpath": {
1193
"other_irrelevant_interface": {
1199
expected_clients_and_properties = {
1205
self.bus.call_method_return = managed_objects
1206
ret = self.bus.get_clients_and_properties()
1207
self.assertDictEqual(expected_clients_and_properties, ret)
1208
expected_call = ("GetManagedObjects", self.bus._name,
1209
self.bus._server_path,
1210
"org.freedesktop.DBus.ObjectManager", ())
1211
self.assertIn(expected_call, self.bus.calls)
1213
def test_call_server_method(self):
1214
ret = self.bus.call_server_method("methodname")
1215
self.assertIs(self.bus.call_method_return, ret)
1216
expected_call = ("methodname", self.bus._name,
1217
self.bus._server_path,
1218
self.bus._server_interface, ())
1219
self.assertIn(expected_call, self.bus.calls)
1221
def test_call_server_method_with_args(self):
1222
args = (Unique(), Unique())
1223
ret = self.bus.call_server_method("methodname", *args)
1224
self.assertIs(self.bus.call_method_return, ret)
1225
expected_call = ("methodname", self.bus._name,
1226
self.bus._server_path,
1227
self.bus._server_interface,
1229
self.assertIn(expected_call, self.bus.calls)
1232
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1234
def MockDBusPython_func(self, func):
1235
class mock_dbus_python(object):
1236
"""mock dbus-python module"""
1237
class exceptions(object):
1238
"""Pseudo-namespace"""
1239
class DBusException(Exception):
1241
class SystemBus(object):
1243
def get_object(busname, objectpath):
1244
DBusObject = collections.namedtuple(
1245
"DBusObject", ("methodname",))
1246
def method(*args, **kwargs):
1247
self.assertEqual({"dbus_interface":
1251
return DBusObject(methodname=method)
1252
class Boolean(object):
1253
def __init__(self, value):
1254
self.value = bool(value)
1257
if sys.version_info.major == 2:
1258
__nonzero__ = __bool__
1259
class ObjectPath(str):
1261
class Dictionary(dict):
1263
return mock_dbus_python
1265
def call_method(self, bus, methodname, busname, objectpath,
1267
with self.assertLogs(log, logging.DEBUG):
1268
return bus.call_method(methodname, busname, objectpath,
1271
def test_call_method_returns(self):
1272
expected_method_return = Unique()
1273
method_args = (Unique(), Unique())
1275
self.assertEqual(len(method_args), len(args))
1276
for marg, arg in zip(method_args, args):
1277
self.assertIs(marg, arg)
1278
return expected_method_return
1279
mock_dbus_python = self.MockDBusPython_func(func)
1280
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1281
ret = self.call_method(bus, "methodname", "busname",
1282
"objectpath", "interface",
1284
self.assertIs(ret, expected_method_return)
1286
def test_call_method_filters_bool_true(self):
1288
return method_return
1289
mock_dbus_python = self.MockDBusPython_func(func)
1290
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1291
method_return = mock_dbus_python.Boolean(True)
1292
ret = self.call_method(bus, "methodname", "busname",
1293
"objectpath", "interface")
1294
self.assertTrue(ret)
1295
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1297
def test_call_method_filters_bool_false(self):
1299
return method_return
1300
mock_dbus_python = self.MockDBusPython_func(func)
1301
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1302
method_return = mock_dbus_python.Boolean(False)
1303
ret = self.call_method(bus, "methodname", "busname",
1304
"objectpath", "interface")
1305
self.assertFalse(ret)
1306
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1308
def test_call_method_filters_objectpath(self):
1310
return method_return
1311
mock_dbus_python = self.MockDBusPython_func(func)
1312
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1313
method_return = mock_dbus_python.ObjectPath("objectpath")
1314
ret = self.call_method(bus, "methodname", "busname",
1315
"objectpath", "interface")
1316
self.assertEqual("objectpath", ret)
1317
self.assertIsNot("objectpath", ret)
1318
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1320
def test_call_method_filters_booleans_in_dict(self):
1322
return method_return
1323
mock_dbus_python = self.MockDBusPython_func(func)
1324
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1325
method_return = mock_dbus_python.Dictionary(
1326
{mock_dbus_python.Boolean(True):
1327
mock_dbus_python.Boolean(False),
1328
mock_dbus_python.Boolean(False):
1329
mock_dbus_python.Boolean(True)})
1330
ret = self.call_method(bus, "methodname", "busname",
1331
"objectpath", "interface")
1332
expected_method_return = {True: False,
1334
self.assertEqual(expected_method_return, ret)
1335
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1337
def test_call_method_filters_objectpaths_in_dict(self):
1339
return method_return
1340
mock_dbus_python = self.MockDBusPython_func(func)
1341
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1342
method_return = mock_dbus_python.Dictionary(
1343
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1344
mock_dbus_python.ObjectPath("objectpath_value_1"),
1345
mock_dbus_python.ObjectPath("objectpath_key_2"):
1346
mock_dbus_python.ObjectPath("objectpath_value_2")})
1347
ret = self.call_method(bus, "methodname", "busname",
1348
"objectpath", "interface")
1349
expected_method_return = {str(key): str(value)
1351
method_return.items()}
1352
self.assertEqual(expected_method_return, ret)
1353
self.assertIsInstance(ret, dict)
1354
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1356
def test_call_method_filters_dict_in_dict(self):
1358
return method_return
1359
mock_dbus_python = self.MockDBusPython_func(func)
1360
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1361
method_return = mock_dbus_python.Dictionary(
1362
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1363
"key12": "value12"}),
1364
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1365
"key22": "value22"})})
1366
ret = self.call_method(bus, "methodname", "busname",
1367
"objectpath", "interface")
1368
expected_method_return = {
1369
"key1": {"key11": "value11",
1370
"key12": "value12"},
1371
"key2": {"key21": "value21",
1372
"key22": "value22"},
1374
self.assertEqual(expected_method_return, ret)
1375
self.assertIsInstance(ret, dict)
1376
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1377
for key, value in ret.items():
1378
self.assertIsInstance(value, dict)
1379
self.assertEqual(expected_method_return[key], value)
1380
self.assertNotIsInstance(value,
1381
mock_dbus_python.Dictionary)
1383
def test_call_method_filters_dict_three_deep(self):
1385
return method_return
1386
mock_dbus_python = self.MockDBusPython_func(func)
1387
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1388
method_return = mock_dbus_python.Dictionary(
1390
mock_dbus_python.Dictionary(
1392
mock_dbus_python.Dictionary(
1394
mock_dbus_python.Boolean(True),
1398
ret = self.call_method(bus, "methodname", "busname",
1399
"objectpath", "interface")
1400
expected_method_return = {"key1": {"key2": {"key3": True}}}
1401
self.assertEqual(expected_method_return, ret)
1402
self.assertIsInstance(ret, dict)
1403
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1404
self.assertIsInstance(ret["key1"], dict)
1405
self.assertNotIsInstance(ret["key1"],
1406
mock_dbus_python.Dictionary)
1407
self.assertIsInstance(ret["key1"]["key2"], dict)
1408
self.assertNotIsInstance(ret["key1"]["key2"],
1409
mock_dbus_python.Dictionary)
1410
self.assertTrue(ret["key1"]["key2"]["key3"])
1411
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1412
mock_dbus_python.Boolean)
1414
def test_call_method_handles_exception(self):
1085
1415
dbus_logger = logging.getLogger("dbus.proxies")
1087
class MockObjectManagerFailing(object):
1088
def GetManagedObjects(self):
1089
dbus_logger.error("Test")
1090
raise dbus.exceptions.DBusException("Test")
1418
dbus_logger.error("Test")
1419
raise mock_dbus_python.exceptions.DBusException()
1421
mock_dbus_python = self.MockDBusPython_func(func)
1422
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1092
1424
class CountingHandler(logging.Handler):
1099
1431
dbus_logger.addHandler(counting_handler)
1102
with self.assertLogs(log, logging.CRITICAL) as watcher:
1103
with self.assertRaises(SystemExit) as e:
1104
get_managed_objects(MockObjectManagerFailing())
1434
with self.assertRaises(dbus.Error) as e:
1435
self.call_method(bus, "methodname", "busname",
1436
"objectpath", "interface")
1106
1438
dbus_logger.removeFilter(counting_handler)
1440
self.assertNotIsInstance(e, dbus.ConnectFailed)
1108
1442
# Make sure the dbus logger was suppressed
1109
self.assertEqual(counting_handler.count, 0)
1111
# Test that the dbus_logger still works
1112
with self.assertLogs(dbus_logger, logging.ERROR):
1113
dbus_logger.error("Test")
1115
if isinstance(e.exception.code, int):
1116
self.assertNotEqual(e.exception.code, 0)
1118
self.assertIsNotNone(e.exception.code)
1443
self.assertEqual(0, counting_handler.count)
1445
def test_get_object_converts_to_correct_exception(self):
1446
bus = dbus_python_adapter.SystemBus(
1447
self.fake_dbus_python_raises_exception_on_connect)
1448
with self.assertRaises(dbus.ConnectFailed):
1449
self.call_method(bus, "methodname", "busname",
1450
"objectpath", "interface")
1452
class fake_dbus_python_raises_exception_on_connect(object):
1453
"""fake dbus-python module"""
1454
class exceptions(object):
1455
"""Pseudo-namespace"""
1456
class DBusException(Exception):
1461
def get_object(busname, objectpath):
1462
raise cls.exceptions.DBusException()
1463
Bus = collections.namedtuple("Bus", ["get_object"])
1464
return Bus(get_object=get_object)
1467
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1468
class mock_dbus_python(object):
1469
"""mock dbus-python modules"""
1470
class SystemBus(object):
1472
def get_object(busname, objectpath):
1476
self.bus = dbus_python_adapter.CachingBus(
1477
self.mock_dbus_python)
1479
def test_returns_distinct_objectpaths(self):
1480
obj1 = self.bus.get_object("busname", "objectpath1")
1481
self.assertIsInstance(obj1, Unique)
1482
obj2 = self.bus.get_object("busname", "objectpath2")
1483
self.assertIsInstance(obj2, Unique)
1484
self.assertIsNot(obj1, obj2)
1486
def test_returns_distinct_busnames(self):
1487
obj1 = self.bus.get_object("busname1", "objectpath")
1488
self.assertIsInstance(obj1, Unique)
1489
obj2 = self.bus.get_object("busname2", "objectpath")
1490
self.assertIsInstance(obj2, Unique)
1491
self.assertIsNot(obj1, obj2)
1493
def test_returns_distinct_both(self):
1494
obj1 = self.bus.get_object("busname1", "objectpath")
1495
self.assertIsInstance(obj1, Unique)
1496
obj2 = self.bus.get_object("busname2", "objectpath")
1497
self.assertIsInstance(obj2, Unique)
1498
self.assertIsNot(obj1, obj2)
1500
def test_returns_same(self):
1501
obj1 = self.bus.get_object("busname", "objectpath")
1502
self.assertIsInstance(obj1, Unique)
1503
obj2 = self.bus.get_object("busname", "objectpath")
1504
self.assertIsInstance(obj2, Unique)
1505
self.assertIs(obj1, obj2)
1507
def test_returns_same_old(self):
1508
obj1 = self.bus.get_object("busname1", "objectpath1")
1509
self.assertIsInstance(obj1, Unique)
1510
obj2 = self.bus.get_object("busname2", "objectpath2")
1511
self.assertIsInstance(obj2, Unique)
1512
obj1b = self.bus.get_object("busname1", "objectpath1")
1513
self.assertIsInstance(obj1b, Unique)
1514
self.assertIsNot(obj1, obj2)
1515
self.assertIsNot(obj2, obj1b)
1516
self.assertIs(obj1, obj1b)
1121
1519
class Test_commands_from_options(unittest.TestCase):
1122
1521
def setUp(self):
1123
1522
self.parser = argparse.ArgumentParser()
1124
1523
add_command_line_options(self.parser)
1126
1525
def test_is_enabled(self):
1127
self.assert_command_from_args(["--is-enabled", "foo"],
1526
self.assert_command_from_args(["--is-enabled", "client"],
1130
1529
def assert_command_from_args(self, args, command_cls,
1134
1533
options = self.parser.parse_args(args)
1135
1534
check_option_syntax(self.parser, options)
1136
1535
commands = commands_from_options(options)
1137
self.assertEqual(len(commands), 1)
1536
self.assertEqual(1, len(commands))
1138
1537
command = commands[0]
1139
1538
self.assertIsInstance(command, command_cls)
1140
1539
for key, value in cmd_attrs.items():
1141
self.assertEqual(getattr(command, key), value)
1540
self.assertEqual(value, getattr(command, key))
1143
1542
def test_is_enabled_short(self):
1144
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1543
self.assert_command_from_args(["-V", "client"],
1146
1546
def test_approve(self):
1147
self.assert_command_from_args(["--approve", "foo"],
1547
self.assert_command_from_args(["--approve", "client"],
1150
1550
def test_approve_short(self):
1151
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1551
self.assert_command_from_args(["-A", "client"],
1153
1554
def test_deny(self):
1154
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1555
self.assert_command_from_args(["--deny", "client"],
1156
1558
def test_deny_short(self):
1157
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1559
self.assert_command_from_args(["-D", "client"], command.Deny)
1159
1561
def test_remove(self):
1160
self.assert_command_from_args(["--remove", "foo"],
1562
self.assert_command_from_args(["--remove", "client"],
1163
1565
def test_deny_before_remove(self):
1164
1566
options = self.parser.parse_args(["--deny", "--remove",
1166
1568
check_option_syntax(self.parser, options)
1167
1569
commands = commands_from_options(options)
1168
self.assertEqual(len(commands), 2)
1169
self.assertIsInstance(commands[0], DenyCmd)
1170
self.assertIsInstance(commands[1], RemoveCmd)
1570
self.assertEqual(2, len(commands))
1571
self.assertIsInstance(commands[0], command.Deny)
1572
self.assertIsInstance(commands[1], command.Remove)
1172
1574
def test_deny_before_remove_reversed(self):
1173
1575
options = self.parser.parse_args(["--remove", "--deny",
1175
1577
check_option_syntax(self.parser, options)
1176
1578
commands = commands_from_options(options)
1177
self.assertEqual(len(commands), 2)
1178
self.assertIsInstance(commands[0], DenyCmd)
1179
self.assertIsInstance(commands[1], RemoveCmd)
1579
self.assertEqual(2, len(commands))
1580
self.assertIsInstance(commands[0], command.Deny)
1581
self.assertIsInstance(commands[1], command.Remove)
1181
1583
def test_remove_short(self):
1182
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1584
self.assert_command_from_args(["-r", "client"],
1184
1587
def test_dump_json(self):
1185
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1588
self.assert_command_from_args(["--dump-json"],
1187
1591
def test_enable(self):
1188
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1592
self.assert_command_from_args(["--enable", "client"],
1190
1595
def test_enable_short(self):
1191
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1596
self.assert_command_from_args(["-e", "client"],
1193
1599
def test_disable(self):
1194
self.assert_command_from_args(["--disable", "foo"],
1600
self.assert_command_from_args(["--disable", "client"],
1197
1603
def test_disable_short(self):
1198
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1604
self.assert_command_from_args(["-d", "client"],
1200
1607
def test_bump_timeout(self):
1201
self.assert_command_from_args(["--bump-timeout", "foo"],
1608
self.assert_command_from_args(["--bump-timeout", "client"],
1609
command.BumpTimeout)
1204
1611
def test_bump_timeout_short(self):
1205
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1612
self.assert_command_from_args(["-b", "client"],
1613
command.BumpTimeout)
1207
1615
def test_start_checker(self):
1208
self.assert_command_from_args(["--start-checker", "foo"],
1616
self.assert_command_from_args(["--start-checker", "client"],
1617
command.StartChecker)
1211
1619
def test_stop_checker(self):
1212
self.assert_command_from_args(["--stop-checker", "foo"],
1620
self.assert_command_from_args(["--stop-checker", "client"],
1621
command.StopChecker)
1215
1623
def test_approve_by_default(self):
1216
self.assert_command_from_args(["--approve-by-default", "foo"],
1217
ApproveByDefaultCmd)
1624
self.assert_command_from_args(["--approve-by-default",
1626
command.ApproveByDefault)
1219
1628
def test_deny_by_default(self):
1220
self.assert_command_from_args(["--deny-by-default", "foo"],
1629
self.assert_command_from_args(["--deny-by-default", "client"],
1630
command.DenyByDefault)
1223
1632
def test_checker(self):
1224
self.assert_command_from_args(["--checker", ":", "foo"],
1225
SetCheckerCmd, value_to_set=":")
1633
self.assert_command_from_args(["--checker", ":", "client"],
1227
1637
def test_checker_empty(self):
1228
self.assert_command_from_args(["--checker", "", "foo"],
1229
SetCheckerCmd, value_to_set="")
1638
self.assert_command_from_args(["--checker", "", "client"],
1231
1642
def test_checker_short(self):
1232
self.assert_command_from_args(["-c", ":", "foo"],
1233
SetCheckerCmd, value_to_set=":")
1643
self.assert_command_from_args(["-c", ":", "client"],
1235
1647
def test_host(self):
1236
self.assert_command_from_args(["--host", "foo.example.org",
1238
value_to_set="foo.example.org")
1648
self.assert_command_from_args(
1649
["--host", "client.example.org", "client"],
1650
command.SetHost, value_to_set="client.example.org")
1240
1652
def test_host_short(self):
1241
self.assert_command_from_args(["-H", "foo.example.org",
1243
value_to_set="foo.example.org")
1653
self.assert_command_from_args(
1654
["-H", "client.example.org", "client"], command.SetHost,
1655
value_to_set="client.example.org")
1245
1657
def test_secret_devnull(self):
1246
1658
self.assert_command_from_args(["--secret", os.path.devnull,
1247
"foo"], SetSecretCmd,
1659
"client"], command.SetSecret,
1248
1660
value_to_set=b"")
1250
1662
def test_secret_tempfile(self):
1255
1667
self.assert_command_from_args(["--secret", f.name,
1256
"foo"], SetSecretCmd,
1257
1670
value_to_set=value)
1259
1672
def test_secret_devnull_short(self):
1260
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1261
SetSecretCmd, value_to_set=b"")
1673
self.assert_command_from_args(["-s", os.path.devnull,
1674
"client"], command.SetSecret,
1263
1677
def test_secret_tempfile_short(self):
1264
1678
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1265
1679
value = b"secret\0xyzzy\nbar"
1268
self.assert_command_from_args(["-s", f.name, "foo"],
1682
self.assert_command_from_args(["-s", f.name, "client"],
1270
1684
value_to_set=value)
1272
1686
def test_timeout(self):
1273
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1687
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1275
1689
value_to_set=300000)
1277
1691
def test_timeout_short(self):
1278
self.assert_command_from_args(["-t", "PT5M", "foo"],
1692
self.assert_command_from_args(["-t", "PT5M", "client"],
1280
1694
value_to_set=300000)
1282
1696
def test_extended_timeout(self):
1283
1697
self.assert_command_from_args(["--extended-timeout", "PT15M",
1285
SetExtendedTimeoutCmd,
1699
command.SetExtendedTimeout,
1286
1700
value_to_set=900000)
1288
1702
def test_interval(self):
1289
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1703
self.assert_command_from_args(["--interval", "PT2M",
1704
"client"], command.SetInterval,
1291
1705
value_to_set=120000)
1293
1707
def test_interval_short(self):
1294
self.assert_command_from_args(["-i", "PT2M", "foo"],
1708
self.assert_command_from_args(["-i", "PT2M", "client"],
1709
command.SetInterval,
1296
1710
value_to_set=120000)
1298
1712
def test_approval_delay(self):
1299
1713
self.assert_command_from_args(["--approval-delay", "PT30S",
1300
"foo"], SetApprovalDelayCmd,
1715
command.SetApprovalDelay,
1301
1716
value_to_set=30000)
1303
1718
def test_approval_duration(self):
1304
1719
self.assert_command_from_args(["--approval-duration", "PT1S",
1305
"foo"], SetApprovalDurationCmd,
1721
command.SetApprovalDuration,
1306
1722
value_to_set=1000)
1308
1724
def test_print_table(self):
1309
self.assert_command_from_args([], PrintTableCmd,
1725
self.assert_command_from_args([], command.PrintTable,
1312
1728
def test_print_table_verbose(self):
1313
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1729
self.assert_command_from_args(["--verbose"],
1316
1733
def test_print_table_verbose_short(self):
1317
self.assert_command_from_args(["-v"], PrintTableCmd,
1734
self.assert_command_from_args(["-v"], command.PrintTable,
1321
class TestCmd(unittest.TestCase):
1738
class TestCommand(unittest.TestCase):
1322
1739
"""Abstract class for tests of command classes"""
1326
class MockClient(object):
1327
def __init__(self, name, **attributes):
1328
self.__dbus_object_path__ = "/clients/{}".format(name)
1329
self.attributes = attributes
1330
self.attributes["Name"] = name
1332
def Set(self, interface, propname, value, dbus_interface):
1333
testcase.assertEqual(interface, client_dbus_interface)
1334
testcase.assertEqual(dbus_interface,
1335
dbus.PROPERTIES_IFACE)
1336
self.attributes[propname] = value
1337
def Get(self, interface, propname, dbus_interface):
1338
testcase.assertEqual(interface, client_dbus_interface)
1339
testcase.assertEqual(dbus_interface,
1340
dbus.PROPERTIES_IFACE)
1341
return self.attributes[propname]
1342
def Approve(self, approve, dbus_interface):
1343
testcase.assertEqual(dbus_interface,
1344
client_dbus_interface)
1345
self.calls.append(("Approve", (approve,
1347
self.client = MockClient(
1349
KeyID=("92ed150794387c03ce684574b1139a65"
1350
"94a34f895daaaf09fd8ea90a27cddb12"),
1352
Host="foo.example.org",
1353
Enabled=dbus.Boolean(True),
1355
LastCheckedOK="2019-02-03T00:00:00",
1356
Created="2019-01-02T00:00:00",
1358
Fingerprint=("778827225BA7DE539C5A"
1359
"7CFA59CFF7CDBD9A5920"),
1360
CheckerRunning=dbus.Boolean(False),
1361
LastEnabled="2019-01-03T00:00:00",
1362
ApprovalPending=dbus.Boolean(False),
1363
ApprovedByDefault=dbus.Boolean(True),
1364
LastApprovalRequest="",
1366
ApprovalDuration=1000,
1367
Checker="fping -q -- %(host)s",
1368
ExtendedTimeout=900000,
1369
Expires="2019-02-04T00:00:00",
1370
LastCheckerStatus=0)
1371
self.other_client = MockClient(
1373
KeyID=("0558568eedd67d622f5c83b35a115f79"
1374
"6ab612cff5ad227247e46c2b020f441c"),
1375
Secret=b"secretbar",
1377
Enabled=dbus.Boolean(True),
1379
LastCheckedOK="2019-02-04T00:00:00",
1380
Created="2019-01-03T00:00:00",
1382
Fingerprint=("3E393AEAEFB84C7E89E2"
1383
"F547B3A107558FCA3A27"),
1384
CheckerRunning=dbus.Boolean(True),
1385
LastEnabled="2019-01-04T00:00:00",
1386
ApprovalPending=dbus.Boolean(False),
1387
ApprovedByDefault=dbus.Boolean(False),
1388
LastApprovalRequest="2019-01-03T00:00:00",
1389
ApprovalDelay=30000,
1390
ApprovalDuration=93785000,
1392
ExtendedTimeout=900000,
1393
Expires="2019-02-05T00:00:00",
1394
LastCheckerStatus=-2)
1395
self.clients = collections.OrderedDict(
1397
("/clients/foo", self.client.attributes),
1398
("/clients/barbar", self.other_client.attributes),
1400
self.one_client = {"/clients/foo": self.client.attributes}
1406
def get_object(client_bus_name, path):
1407
self.assertEqual(client_bus_name, dbus_busname)
1409
# Note: "self" here is the TestCmd instance, not
1410
# the Bus instance, since this is a static method!
1411
"/clients/foo": self.client,
1412
"/clients/barbar": self.other_client,
1417
class TestIsEnabledCmd(TestCmd):
1418
def test_is_enabled(self):
1419
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1421
for client, properties
1422
in self.clients.items()))
1424
def test_is_enabled_run_exits_successfully(self):
1425
with self.assertRaises(SystemExit) as e:
1426
IsEnabledCmd().run(self.one_client)
1427
if e.exception.code is not None:
1428
self.assertEqual(e.exception.code, 0)
1430
self.assertIsNone(e.exception.code)
1432
def test_is_enabled_run_exits_with_failure(self):
1433
self.client.attributes["Enabled"] = dbus.Boolean(False)
1434
with self.assertRaises(SystemExit) as e:
1435
IsEnabledCmd().run(self.one_client)
1436
if isinstance(e.exception.code, int):
1437
self.assertNotEqual(e.exception.code, 0)
1439
self.assertIsNotNone(e.exception.code)
1442
class TestApproveCmd(TestCmd):
1443
def test_approve(self):
1444
ApproveCmd().run(self.clients, self.bus)
1445
for clientpath in self.clients:
1446
client = self.bus.get_object(dbus_busname, clientpath)
1447
self.assertIn(("Approve", (True, client_dbus_interface)),
1451
class TestDenyCmd(TestCmd):
1452
def test_deny(self):
1453
DenyCmd().run(self.clients, self.bus)
1454
for clientpath in self.clients:
1455
client = self.bus.get_object(dbus_busname, clientpath)
1456
self.assertIn(("Approve", (False, client_dbus_interface)),
1460
class TestRemoveCmd(TestCmd):
1461
def test_remove(self):
1462
class MockMandos(object):
1465
def RemoveClient(self, dbus_path):
1466
self.calls.append(("RemoveClient", (dbus_path,)))
1467
mandos = MockMandos()
1468
super(TestRemoveCmd, self).setUp()
1469
RemoveCmd().run(self.clients, self.bus, mandos)
1470
self.assertEqual(len(mandos.calls), 2)
1471
for clientpath in self.clients:
1472
self.assertIn(("RemoveClient", (clientpath,)),
1476
class TestDumpJSONCmd(TestCmd):
1478
self.expected_json = {
1741
class FakeMandosBus(dbus.MandosBus):
1742
def __init__(self, testcase):
1743
self.client_properties = {
1481
1745
"KeyID": ("92ed150794387c03ce684574b1139a65"
1482
1746
"94a34f895daaaf09fd8ea90a27cddb12"),
1747
"Secret": b"secret",
1483
1748
"Host": "foo.example.org",
1484
1749
"Enabled": True,
1485
1750
"Timeout": 300000,
1523
1789
"ExtendedTimeout": 900000,
1524
1790
"Expires": "2019-02-05T00:00:00",
1525
1791
"LastCheckerStatus": -2,
1528
return super(TestDumpJSONCmd, self).setUp()
1530
def test_normal(self):
1531
output = DumpJSONCmd().output(self.clients.values())
1532
json_data = json.loads(output)
1533
self.assertDictEqual(json_data, self.expected_json)
1535
def test_one_client(self):
1536
output = DumpJSONCmd().output(self.one_client.values())
1537
json_data = json.loads(output)
1793
self.clients = collections.OrderedDict(
1795
("client_objectpath", self.client_properties),
1796
("other_client_objectpath",
1797
self.other_client_properties),
1799
self.one_client = {"client_objectpath":
1800
self.client_properties}
1801
self.testcase = testcase
1804
def call_method(self, methodname, busname, objectpath,
1806
self.testcase.assertEqual("se.recompile.Mandos", busname)
1807
self.calls.append((methodname, busname, objectpath,
1809
if interface == "org.freedesktop.DBus.Properties":
1810
if methodname == "Set":
1811
self.testcase.assertEqual(3, len(args))
1812
interface, key, value = args
1813
self.testcase.assertEqual(
1814
"se.recompile.Mandos.Client", interface)
1815
self.clients[objectpath][key] = value
1817
elif interface == "se.recompile.Mandos":
1818
self.testcase.assertEqual("RemoveClient", methodname)
1819
self.testcase.assertEqual(1, len(args))
1820
clientpath = args[0]
1821
del self.clients[clientpath]
1823
elif interface == "se.recompile.Mandos.Client":
1824
if methodname == "Approve":
1825
self.testcase.assertEqual(1, len(args))
1830
self.bus = self.FakeMandosBus(self)
1833
class TestBaseCommands(TestCommand):
1835
def test_IsEnabled_exits_successfully(self):
1836
with self.assertRaises(SystemExit) as e:
1837
command.IsEnabled().run(self.bus.one_client)
1838
if e.exception.code is not None:
1839
self.assertEqual(0, e.exception.code)
1841
self.assertIsNone(e.exception.code)
1843
def test_IsEnabled_exits_with_failure(self):
1844
self.bus.client_properties["Enabled"] = False
1845
with self.assertRaises(SystemExit) as e:
1846
command.IsEnabled().run(self.bus.one_client)
1847
if isinstance(e.exception.code, int):
1848
self.assertNotEqual(0, e.exception.code)
1850
self.assertIsNotNone(e.exception.code)
1852
def test_Approve(self):
1853
busname = "se.recompile.Mandos"
1854
client_interface = "se.recompile.Mandos.Client"
1855
command.Approve().run(self.bus.clients, self.bus)
1856
for clientpath in self.bus.clients:
1857
self.assertIn(("Approve", busname, clientpath,
1858
client_interface, (True,)), self.bus.calls)
1860
def test_Deny(self):
1861
busname = "se.recompile.Mandos"
1862
client_interface = "se.recompile.Mandos.Client"
1863
command.Deny().run(self.bus.clients, self.bus)
1864
for clientpath in self.bus.clients:
1865
self.assertIn(("Approve", busname, clientpath,
1866
client_interface, (False,)),
1869
def test_Remove(self):
1870
command.Remove().run(self.bus.clients, self.bus)
1871
for clientpath in self.bus.clients:
1872
self.assertIn(("RemoveClient", dbus_busname,
1873
dbus_server_path, dbus_server_interface,
1874
(clientpath,)), self.bus.calls)
1879
"KeyID": ("92ed150794387c03ce684574b1139a65"
1880
"94a34f895daaaf09fd8ea90a27cddb12"),
1881
"Host": "foo.example.org",
1884
"LastCheckedOK": "2019-02-03T00:00:00",
1885
"Created": "2019-01-02T00:00:00",
1887
"Fingerprint": ("778827225BA7DE539C5A"
1888
"7CFA59CFF7CDBD9A5920"),
1889
"CheckerRunning": False,
1890
"LastEnabled": "2019-01-03T00:00:00",
1891
"ApprovalPending": False,
1892
"ApprovedByDefault": True,
1893
"LastApprovalRequest": "",
1895
"ApprovalDuration": 1000,
1896
"Checker": "fping -q -- %(host)s",
1897
"ExtendedTimeout": 900000,
1898
"Expires": "2019-02-04T00:00:00",
1899
"LastCheckerStatus": 0,
1903
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1904
"6ab612cff5ad227247e46c2b020f441c"),
1905
"Host": "192.0.2.3",
1908
"LastCheckedOK": "2019-02-04T00:00:00",
1909
"Created": "2019-01-03T00:00:00",
1911
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1912
"F547B3A107558FCA3A27"),
1913
"CheckerRunning": True,
1914
"LastEnabled": "2019-01-04T00:00:00",
1915
"ApprovalPending": False,
1916
"ApprovedByDefault": False,
1917
"LastApprovalRequest": "2019-01-03T00:00:00",
1918
"ApprovalDelay": 30000,
1919
"ApprovalDuration": 93785000,
1921
"ExtendedTimeout": 900000,
1922
"Expires": "2019-02-05T00:00:00",
1923
"LastCheckerStatus": -2,
1927
def test_DumpJSON_normal(self):
1928
with self.capture_stdout_to_buffer() as buffer:
1929
command.DumpJSON().run(self.bus.clients)
1930
json_data = json.loads(buffer.getvalue())
1931
self.assertDictEqual(self.expected_json, json_data)
1934
@contextlib.contextmanager
1935
def capture_stdout_to_buffer():
1936
capture_buffer = io.StringIO()
1937
old_stdout = sys.stdout
1938
sys.stdout = capture_buffer
1940
yield capture_buffer
1942
sys.stdout = old_stdout
1944
def test_DumpJSON_one_client(self):
1945
with self.capture_stdout_to_buffer() as buffer:
1946
command.DumpJSON().run(self.bus.one_client)
1947
json_data = json.loads(buffer.getvalue())
1538
1948
expected_json = {"foo": self.expected_json["foo"]}
1539
self.assertDictEqual(json_data, expected_json)
1542
class TestPrintTableCmd(TestCmd):
1543
def test_normal(self):
1544
output = PrintTableCmd().output(self.clients.values())
1949
self.assertDictEqual(expected_json, json_data)
1951
def test_PrintTable_normal(self):
1952
with self.capture_stdout_to_buffer() as buffer:
1953
command.PrintTable().run(self.bus.clients)
1545
1954
expected_output = "\n".join((
1546
1955
"Name Enabled Timeout Last Successful Check",
1547
1956
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1548
1957
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1550
self.assertEqual(output, expected_output)
1959
self.assertEqual(expected_output, buffer.getvalue())
1552
def test_verbose(self):
1553
output = PrintTableCmd(verbose=True).output(
1554
self.clients.values())
1961
def test_PrintTable_verbose(self):
1962
with self.capture_stdout_to_buffer() as buffer:
1963
command.PrintTable(verbose=True).run(self.bus.clients)
1641
2050
num_lines = max(len(rows) for rows in columns)
1642
expected_output = "\n".join("".join(rows[line]
1643
for rows in columns)
1644
for line in range(num_lines))
1645
self.assertEqual(output, expected_output)
2051
expected_output = ("\n".join("".join(rows[line]
2052
for rows in columns)
2053
for line in range(num_lines))
2055
self.assertEqual(expected_output, buffer.getvalue())
1647
def test_one_client(self):
1648
output = PrintTableCmd().output(self.one_client.values())
2057
def test_PrintTable_one_client(self):
2058
with self.capture_stdout_to_buffer() as buffer:
2059
command.PrintTable().run(self.bus.one_client)
1649
2060
expected_output = "\n".join((
1650
2061
"Name Enabled Timeout Last Successful Check",
1651
2062
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1653
self.assertEqual(output, expected_output)
1656
class TestPropertyCmd(TestCmd):
1657
"""Abstract class for tests of PropertyCmd classes"""
2064
self.assertEqual(expected_output, buffer.getvalue())
2067
class TestPropertySetterCmd(TestCommand):
2068
"""Abstract class for tests of command.PropertySetter classes"""
1658
2070
def runTest(self):
1659
2071
if not hasattr(self, "command"):
2072
return # Abstract TestCase class
1661
2073
values_to_get = getattr(self, "values_to_get",
1662
2074
self.values_to_set)
1663
2075
for value_to_set, value_to_get in zip(self.values_to_set,
1664
2076
values_to_get):
1665
for clientpath in self.clients:
1666
client = self.bus.get_object(dbus_busname, clientpath)
1667
old_value = client.attributes[self.propname]
1668
self.assertNotIsInstance(old_value, self.Unique)
1669
client.attributes[self.propname] = self.Unique()
1670
self.run_command(value_to_set, self.clients)
1671
for clientpath in self.clients:
1672
client = self.bus.get_object(dbus_busname, clientpath)
1673
value = client.attributes[self.propname]
1674
self.assertNotIsInstance(value, self.Unique)
1675
self.assertEqual(value, value_to_get)
1677
class Unique(object):
1678
"""Class for objects which exist only to be unique objects,
1679
since unittest.mock.sentinel only exists in Python 3.3"""
2077
for clientpath in self.bus.clients:
2078
self.bus.clients[clientpath][self.propname] = Unique()
2079
self.run_command(value_to_set, self.bus.clients)
2080
for clientpath in self.bus.clients:
2081
value = self.bus.clients[clientpath][self.propname]
2082
self.assertNotIsInstance(value, Unique)
2083
self.assertEqual(value_to_get, value)
1681
2085
def run_command(self, value, clients):
1682
2086
self.command().run(clients, self.bus)
1685
class TestEnableCmd(TestPropertyCmd):
1687
propname = "Enabled"
1688
values_to_set = [dbus.Boolean(True)]
1691
class TestDisableCmd(TestPropertyCmd):
1692
command = DisableCmd
1693
propname = "Enabled"
1694
values_to_set = [dbus.Boolean(False)]
1697
class TestBumpTimeoutCmd(TestPropertyCmd):
1698
command = BumpTimeoutCmd
2089
class TestEnableCmd(TestPropertySetterCmd):
2090
command = command.Enable
2091
propname = "Enabled"
2092
values_to_set = [True]
2095
class TestDisableCmd(TestPropertySetterCmd):
2096
command = command.Disable
2097
propname = "Enabled"
2098
values_to_set = [False]
2101
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2102
command = command.BumpTimeout
1699
2103
propname = "LastCheckedOK"
1700
2104
values_to_set = [""]
1703
class TestStartCheckerCmd(TestPropertyCmd):
1704
command = StartCheckerCmd
1705
propname = "CheckerRunning"
1706
values_to_set = [dbus.Boolean(True)]
1709
class TestStopCheckerCmd(TestPropertyCmd):
1710
command = StopCheckerCmd
1711
propname = "CheckerRunning"
1712
values_to_set = [dbus.Boolean(False)]
1715
class TestApproveByDefaultCmd(TestPropertyCmd):
1716
command = ApproveByDefaultCmd
1717
propname = "ApprovedByDefault"
1718
values_to_set = [dbus.Boolean(True)]
1721
class TestDenyByDefaultCmd(TestPropertyCmd):
1722
command = DenyByDefaultCmd
1723
propname = "ApprovedByDefault"
1724
values_to_set = [dbus.Boolean(False)]
1727
class TestPropertyValueCmd(TestPropertyCmd):
1728
"""Abstract class for tests of PropertyValueCmd classes"""
1731
if type(self) is TestPropertyValueCmd:
1733
return super(TestPropertyValueCmd, self).runTest()
2107
class TestStartCheckerCmd(TestPropertySetterCmd):
2108
command = command.StartChecker
2109
propname = "CheckerRunning"
2110
values_to_set = [True]
2113
class TestStopCheckerCmd(TestPropertySetterCmd):
2114
command = command.StopChecker
2115
propname = "CheckerRunning"
2116
values_to_set = [False]
2119
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2120
command = command.ApproveByDefault
2121
propname = "ApprovedByDefault"
2122
values_to_set = [True]
2125
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2126
command = command.DenyByDefault
2127
propname = "ApprovedByDefault"
2128
values_to_set = [False]
2131
class TestPropertySetterValueCmd(TestPropertySetterCmd):
2132
"""Abstract class for tests of PropertySetterValueCmd classes"""
1735
2134
def run_command(self, value, clients):
1736
2135
self.command(value).run(clients, self.bus)
1739
class TestSetCheckerCmd(TestPropertyValueCmd):
1740
command = SetCheckerCmd
2138
class TestSetCheckerCmd(TestPropertySetterValueCmd):
2139
command = command.SetChecker
1741
2140
propname = "Checker"
1742
2141
values_to_set = ["", ":", "fping -q -- %s"]
1745
class TestSetHostCmd(TestPropertyValueCmd):
1746
command = SetHostCmd
2144
class TestSetHostCmd(TestPropertySetterValueCmd):
2145
command = command.SetHost
1747
2146
propname = "Host"
1748
values_to_set = ["192.0.2.3", "foo.example.org"]
1751
class TestSetSecretCmd(TestPropertyValueCmd):
1752
command = SetSecretCmd
2147
values_to_set = ["192.0.2.3", "client.example.org"]
2150
class TestSetSecretCmd(TestPropertySetterValueCmd):
2151
command = command.SetSecret
1753
2152
propname = "Secret"
1754
2153
values_to_set = [io.BytesIO(b""),
1755
2154
io.BytesIO(b"secret\0xyzzy\nbar")]
1756
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1759
class TestSetTimeoutCmd(TestPropertyValueCmd):
1760
command = SetTimeoutCmd
2155
values_to_get = [f.getvalue() for f in values_to_set]
2158
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
2159
command = command.SetTimeout
1761
2160
propname = "Timeout"
1762
2161
values_to_set = [datetime.timedelta(),
1763
2162
datetime.timedelta(minutes=5),
1764
2163
datetime.timedelta(seconds=1),
1765
2164
datetime.timedelta(weeks=1),
1766
2165
datetime.timedelta(weeks=52)]
1767
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1770
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1771
command = SetExtendedTimeoutCmd
2166
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2169
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
2170
command = command.SetExtendedTimeout
1772
2171
propname = "ExtendedTimeout"
1773
2172
values_to_set = [datetime.timedelta(),
1774
2173
datetime.timedelta(minutes=5),
1775
2174
datetime.timedelta(seconds=1),
1776
2175
datetime.timedelta(weeks=1),
1777
2176
datetime.timedelta(weeks=52)]
1778
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1781
class TestSetIntervalCmd(TestPropertyValueCmd):
1782
command = SetIntervalCmd
2177
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2180
class TestSetIntervalCmd(TestPropertySetterValueCmd):
2181
command = command.SetInterval
1783
2182
propname = "Interval"
1784
2183
values_to_set = [datetime.timedelta(),
1785
2184
datetime.timedelta(minutes=5),
1786
2185
datetime.timedelta(seconds=1),
1787
2186
datetime.timedelta(weeks=1),
1788
2187
datetime.timedelta(weeks=52)]
1789
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1792
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1793
command = SetApprovalDelayCmd
2188
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2191
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
2192
command = command.SetApprovalDelay
1794
2193
propname = "ApprovalDelay"
1795
2194
values_to_set = [datetime.timedelta(),
1796
2195
datetime.timedelta(minutes=5),
1797
2196
datetime.timedelta(seconds=1),
1798
2197
datetime.timedelta(weeks=1),
1799
2198
datetime.timedelta(weeks=52)]
1800
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1803
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1804
command = SetApprovalDurationCmd
2199
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2202
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
2203
command = command.SetApprovalDuration
1805
2204
propname = "ApprovalDuration"
1806
2205
values_to_set = [datetime.timedelta(),
1807
2206
datetime.timedelta(minutes=5),
1808
2207
datetime.timedelta(seconds=1),
1809
2208
datetime.timedelta(weeks=1),
1810
2209
datetime.timedelta(weeks=52)]
1811
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2210
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]