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):
553
630
class Base(object):
554
631
"""Abstract base class for commands"""
555
def run(self, clients, bus=None, mandos=None):
632
def run(self, clients, bus=None):
556
633
"""Normal commands should implement run_on_one_client(),
557
634
but commands which want to operate on all clients at the same time can
558
635
override this run() method instead.
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)
638
for client, properties in clients.items():
565
639
self.run_on_one_client(client, properties)
568
642
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):
643
def run(self, clients, bus=None):
644
properties = next(iter(clients.values()))
645
if properties["Enabled"]:
574
def is_enabled(self, client, properties):
575
return properties["Enabled"]
578
650
class Approve(Base):
579
651
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)
652
self.bus.call_client_method(client, "Approve", True)
587
655
class Deny(Base):
588
656
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)
657
self.bus.call_client_method(client, "Approve", False)
596
660
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__)
661
def run(self, clients, bus):
662
for clientpath in frozenset(clients.keys()):
663
bus.call_server_method("RemoveClient", clientpath)
605
666
class Output(Base):
732
781
seconds=td.seconds % 60))
735
class Property(Base):
784
class PropertySetter(Base):
736
785
"Abstract class for Actions for setting one client property"
738
def run_on_one_client(self, client, properties):
787
def run_on_one_client(self, client, properties=None):
739
788
"""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,
746
else bool(self.value_to_set))
747
client.Set(client_dbus_interface, self.propname,
749
dbus_interface=dbus.PROPERTIES_IFACE)
789
self.bus.set_client_property(client, self.propname,
752
793
def propname(self):
753
794
raise NotImplementedError()
756
class Enable(Property):
758
value_to_set = dbus.Boolean(True)
761
class Disable(Property):
763
value_to_set = dbus.Boolean(False)
766
class BumpTimeout(Property):
797
class Enable(PropertySetter):
802
class Disable(PropertySetter):
807
class BumpTimeout(PropertySetter):
767
808
propname = "LastCheckedOK"
768
809
value_to_set = ""
771
class StartChecker(Property):
772
propname = "CheckerRunning"
773
value_to_set = dbus.Boolean(True)
776
class StopChecker(Property):
777
propname = "CheckerRunning"
778
value_to_set = dbus.Boolean(False)
781
class ApproveByDefault(Property):
782
propname = "ApprovedByDefault"
783
value_to_set = dbus.Boolean(True)
786
class DenyByDefault(Property):
787
propname = "ApprovedByDefault"
788
value_to_set = dbus.Boolean(False)
791
class PropertyValue(Property):
792
"Abstract class for Property recieving a value as argument"
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."""
793
835
def __init__(self, value):
794
836
self.value_to_set = value
797
class SetChecker(PropertyValue):
839
class SetChecker(PropertySetterValue):
798
840
propname = "Checker"
801
class SetHost(PropertyValue):
843
class SetHost(PropertySetterValue):
802
844
propname = "Host"
805
class SetSecret(PropertyValue):
847
class SetSecret(PropertySetterValue):
806
848
propname = "Secret"
1082
1126
self.check_option_syntax(options)
1085
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1086
def test_calls_and_returns_get_object_on_bus(self):
1087
class MockBus(object):
1089
def get_object(mockbus_self, busname, dbus_path):
1090
# Note that "self" is still the testcase instance,
1091
# this MockBus instance is in "mockbus_self".
1092
self.assertEqual(busname, dbus_busname)
1093
self.assertEqual(dbus_path, server_dbus_path)
1094
mockbus_self.called = True
1097
mockbus = get_mandos_dbus_object(bus=MockBus())
1098
self.assertIsInstance(mockbus, MockBus)
1099
self.assertTrue(mockbus.called)
1101
def test_logs_and_exits_on_dbus_error(self):
1102
class MockBusFailing(object):
1103
def get_object(self, busname, dbus_path):
1104
raise dbus.exceptions.DBusException("Test")
1106
with self.assertLogs(log, logging.CRITICAL):
1107
with self.assertRaises(SystemExit) as e:
1108
bus = get_mandos_dbus_object(bus=MockBusFailing())
1110
if isinstance(e.exception.code, int):
1111
self.assertNotEqual(e.exception.code, 0)
1113
self.assertIsNotNone(e.exception.code)
1116
class Test_get_managed_objects(TestCaseWithAssertLogs):
1117
def test_calls_and_returns_GetManagedObjects(self):
1118
managed_objects = {"/clients/foo": { "Name": "foo"}}
1119
class MockObjectManager(object):
1120
def GetManagedObjects(self):
1121
return managed_objects
1122
retval = get_managed_objects(MockObjectManager())
1123
self.assertDictEqual(managed_objects, retval)
1125
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):
1126
1415
dbus_logger = logging.getLogger("dbus.proxies")
1128
class MockObjectManagerFailing(object):
1129
def GetManagedObjects(self):
1130
dbus_logger.error("Test")
1131
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)
1133
1424
class CountingHandler(logging.Handler):
1140
1431
dbus_logger.addHandler(counting_handler)
1143
with self.assertLogs(log, logging.CRITICAL) as watcher:
1144
with self.assertRaises(SystemExit) as e:
1145
get_managed_objects(MockObjectManagerFailing())
1434
with self.assertRaises(dbus.Error) as e:
1435
self.call_method(bus, "methodname", "busname",
1436
"objectpath", "interface")
1147
1438
dbus_logger.removeFilter(counting_handler)
1440
self.assertNotIsInstance(e, dbus.ConnectFailed)
1149
1442
# Make sure the dbus logger was suppressed
1150
self.assertEqual(counting_handler.count, 0)
1152
# Test that the dbus_logger still works
1153
with self.assertLogs(dbus_logger, logging.ERROR):
1154
dbus_logger.error("Test")
1156
if isinstance(e.exception.code, int):
1157
self.assertNotEqual(e.exception.code, 0)
1159
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)
1162
1519
class Test_commands_from_options(unittest.TestCase):
1163
1521
def setUp(self):
1164
1522
self.parser = argparse.ArgumentParser()
1165
1523
add_command_line_options(self.parser)
1167
1525
def test_is_enabled(self):
1168
self.assert_command_from_args(["--is-enabled", "foo"],
1526
self.assert_command_from_args(["--is-enabled", "client"],
1169
1527
command.IsEnabled)
1171
1529
def assert_command_from_args(self, args, command_cls,
1217
1577
check_option_syntax(self.parser, options)
1218
1578
commands = commands_from_options(options)
1219
self.assertEqual(len(commands), 2)
1579
self.assertEqual(2, len(commands))
1220
1580
self.assertIsInstance(commands[0], command.Deny)
1221
1581
self.assertIsInstance(commands[1], command.Remove)
1223
1583
def test_remove_short(self):
1224
self.assert_command_from_args(["-r", "foo"], command.Remove)
1584
self.assert_command_from_args(["-r", "client"],
1226
1587
def test_dump_json(self):
1227
1588
self.assert_command_from_args(["--dump-json"],
1228
1589
command.DumpJSON)
1230
1591
def test_enable(self):
1231
self.assert_command_from_args(["--enable", "foo"],
1592
self.assert_command_from_args(["--enable", "client"],
1232
1593
command.Enable)
1234
1595
def test_enable_short(self):
1235
self.assert_command_from_args(["-e", "foo"], command.Enable)
1596
self.assert_command_from_args(["-e", "client"],
1237
1599
def test_disable(self):
1238
self.assert_command_from_args(["--disable", "foo"],
1600
self.assert_command_from_args(["--disable", "client"],
1239
1601
command.Disable)
1241
1603
def test_disable_short(self):
1242
self.assert_command_from_args(["-d", "foo"], command.Disable)
1604
self.assert_command_from_args(["-d", "client"],
1244
1607
def test_bump_timeout(self):
1245
self.assert_command_from_args(["--bump-timeout", "foo"],
1608
self.assert_command_from_args(["--bump-timeout", "client"],
1246
1609
command.BumpTimeout)
1248
1611
def test_bump_timeout_short(self):
1249
self.assert_command_from_args(["-b", "foo"],
1612
self.assert_command_from_args(["-b", "client"],
1250
1613
command.BumpTimeout)
1252
1615
def test_start_checker(self):
1253
self.assert_command_from_args(["--start-checker", "foo"],
1616
self.assert_command_from_args(["--start-checker", "client"],
1254
1617
command.StartChecker)
1256
1619
def test_stop_checker(self):
1257
self.assert_command_from_args(["--stop-checker", "foo"],
1620
self.assert_command_from_args(["--stop-checker", "client"],
1258
1621
command.StopChecker)
1260
1623
def test_approve_by_default(self):
1261
self.assert_command_from_args(["--approve-by-default", "foo"],
1624
self.assert_command_from_args(["--approve-by-default",
1262
1626
command.ApproveByDefault)
1264
1628
def test_deny_by_default(self):
1265
self.assert_command_from_args(["--deny-by-default", "foo"],
1629
self.assert_command_from_args(["--deny-by-default", "client"],
1266
1630
command.DenyByDefault)
1268
1632
def test_checker(self):
1269
self.assert_command_from_args(["--checker", ":", "foo"],
1633
self.assert_command_from_args(["--checker", ":", "client"],
1270
1634
command.SetChecker,
1271
1635
value_to_set=":")
1273
1637
def test_checker_empty(self):
1274
self.assert_command_from_args(["--checker", "", "foo"],
1638
self.assert_command_from_args(["--checker", "", "client"],
1275
1639
command.SetChecker,
1276
1640
value_to_set="")
1278
1642
def test_checker_short(self):
1279
self.assert_command_from_args(["-c", ":", "foo"],
1643
self.assert_command_from_args(["-c", ":", "client"],
1280
1644
command.SetChecker,
1281
1645
value_to_set=":")
1283
1647
def test_host(self):
1284
self.assert_command_from_args(["--host", "foo.example.org",
1285
"foo"], command.SetHost,
1286
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")
1288
1652
def test_host_short(self):
1289
self.assert_command_from_args(["-H", "foo.example.org",
1290
"foo"], command.SetHost,
1291
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")
1293
1657
def test_secret_devnull(self):
1294
1658
self.assert_command_from_args(["--secret", os.path.devnull,
1295
"foo"], command.SetSecret,
1659
"client"], command.SetSecret,
1296
1660
value_to_set=b"")
1298
1662
def test_secret_tempfile(self):
1373
1738
class TestCommand(unittest.TestCase):
1374
1739
"""Abstract class for tests of command classes"""
1741
class FakeMandosBus(dbus.MandosBus):
1742
def __init__(self, testcase):
1743
self.client_properties = {
1745
"KeyID": ("92ed150794387c03ce684574b1139a65"
1746
"94a34f895daaaf09fd8ea90a27cddb12"),
1747
"Secret": b"secret",
1748
"Host": "foo.example.org",
1751
"LastCheckedOK": "2019-02-03T00:00:00",
1752
"Created": "2019-01-02T00:00:00",
1754
"Fingerprint": ("778827225BA7DE539C5A"
1755
"7CFA59CFF7CDBD9A5920"),
1756
"CheckerRunning": False,
1757
"LastEnabled": "2019-01-03T00:00:00",
1758
"ApprovalPending": False,
1759
"ApprovedByDefault": True,
1760
"LastApprovalRequest": "",
1762
"ApprovalDuration": 1000,
1763
"Checker": "fping -q -- %(host)s",
1764
"ExtendedTimeout": 900000,
1765
"Expires": "2019-02-04T00:00:00",
1766
"LastCheckerStatus": 0,
1768
self.other_client_properties = {
1770
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1771
"6ab612cff5ad227247e46c2b020f441c"),
1772
"Secret": b"secretbar",
1773
"Host": "192.0.2.3",
1776
"LastCheckedOK": "2019-02-04T00:00:00",
1777
"Created": "2019-01-03T00:00:00",
1779
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1780
"F547B3A107558FCA3A27"),
1781
"CheckerRunning": True,
1782
"LastEnabled": "2019-01-04T00:00:00",
1783
"ApprovalPending": False,
1784
"ApprovedByDefault": False,
1785
"LastApprovalRequest": "2019-01-03T00:00:00",
1786
"ApprovalDelay": 30000,
1787
"ApprovalDuration": 93785000,
1789
"ExtendedTimeout": 900000,
1790
"Expires": "2019-02-05T00:00:00",
1791
"LastCheckerStatus": -2,
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))
1376
1829
def setUp(self):
1378
class MockClient(object):
1379
def __init__(self, name, **attributes):
1380
self.__dbus_object_path__ = "/clients/{}".format(name)
1381
self.attributes = attributes
1382
self.attributes["Name"] = name
1384
def Set(self, interface, propname, value, dbus_interface):
1385
testcase.assertEqual(interface, client_dbus_interface)
1386
testcase.assertEqual(dbus_interface,
1387
dbus.PROPERTIES_IFACE)
1388
self.attributes[propname] = value
1389
def Approve(self, approve, dbus_interface):
1390
testcase.assertEqual(dbus_interface,
1391
client_dbus_interface)
1392
self.calls.append(("Approve", (approve,
1394
self.client = MockClient(
1396
KeyID=("92ed150794387c03ce684574b1139a65"
1397
"94a34f895daaaf09fd8ea90a27cddb12"),
1399
Host="foo.example.org",
1400
Enabled=dbus.Boolean(True),
1402
LastCheckedOK="2019-02-03T00:00:00",
1403
Created="2019-01-02T00:00:00",
1405
Fingerprint=("778827225BA7DE539C5A"
1406
"7CFA59CFF7CDBD9A5920"),
1407
CheckerRunning=dbus.Boolean(False),
1408
LastEnabled="2019-01-03T00:00:00",
1409
ApprovalPending=dbus.Boolean(False),
1410
ApprovedByDefault=dbus.Boolean(True),
1411
LastApprovalRequest="",
1413
ApprovalDuration=1000,
1414
Checker="fping -q -- %(host)s",
1415
ExtendedTimeout=900000,
1416
Expires="2019-02-04T00:00:00",
1417
LastCheckerStatus=0)
1418
self.other_client = MockClient(
1420
KeyID=("0558568eedd67d622f5c83b35a115f79"
1421
"6ab612cff5ad227247e46c2b020f441c"),
1422
Secret=b"secretbar",
1424
Enabled=dbus.Boolean(True),
1426
LastCheckedOK="2019-02-04T00:00:00",
1427
Created="2019-01-03T00:00:00",
1429
Fingerprint=("3E393AEAEFB84C7E89E2"
1430
"F547B3A107558FCA3A27"),
1431
CheckerRunning=dbus.Boolean(True),
1432
LastEnabled="2019-01-04T00:00:00",
1433
ApprovalPending=dbus.Boolean(False),
1434
ApprovedByDefault=dbus.Boolean(False),
1435
LastApprovalRequest="2019-01-03T00:00:00",
1436
ApprovalDelay=30000,
1437
ApprovalDuration=93785000,
1439
ExtendedTimeout=900000,
1440
Expires="2019-02-05T00:00:00",
1441
LastCheckerStatus=-2)
1442
self.clients = collections.OrderedDict(
1444
("/clients/foo", self.client.attributes),
1445
("/clients/barbar", self.other_client.attributes),
1447
self.one_client = {"/clients/foo": self.client.attributes}
1453
def get_object(client_bus_name, path):
1454
self.assertEqual(client_bus_name, dbus_busname)
1456
# Note: "self" here is the TestCmd instance, not
1457
# the Bus instance, since this is a static method!
1458
"/clients/foo": self.client,
1459
"/clients/barbar": self.other_client,
1830
self.bus = self.FakeMandosBus(self)
1464
1833
class TestBaseCommands(TestCommand):
1466
def test_IsEnabled(self):
1467
self.assertTrue(all(command.IsEnabled().is_enabled(client,
1469
for client, properties
1470
in self.clients.items()))
1472
def test_IsEnabled_run_exits_successfully(self):
1835
def test_IsEnabled_exits_successfully(self):
1473
1836
with self.assertRaises(SystemExit) as e:
1474
command.IsEnabled().run(self.one_client)
1837
command.IsEnabled().run(self.bus.one_client)
1475
1838
if e.exception.code is not None:
1476
self.assertEqual(e.exception.code, 0)
1839
self.assertEqual(0, e.exception.code)
1478
1841
self.assertIsNone(e.exception.code)
1480
def test_IsEnabled_run_exits_with_failure(self):
1481
self.client.attributes["Enabled"] = dbus.Boolean(False)
1843
def test_IsEnabled_exits_with_failure(self):
1844
self.bus.client_properties["Enabled"] = False
1482
1845
with self.assertRaises(SystemExit) as e:
1483
command.IsEnabled().run(self.one_client)
1846
command.IsEnabled().run(self.bus.one_client)
1484
1847
if isinstance(e.exception.code, int):
1485
self.assertNotEqual(e.exception.code, 0)
1848
self.assertNotEqual(0, e.exception.code)
1487
1850
self.assertIsNotNone(e.exception.code)
1489
1852
def test_Approve(self):
1490
command.Approve().run(self.clients, self.bus)
1491
for clientpath in self.clients:
1492
client = self.bus.get_object(dbus_busname, clientpath)
1493
self.assertIn(("Approve", (True, client_dbus_interface)),
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)
1496
1860
def test_Deny(self):
1497
command.Deny().run(self.clients, self.bus)
1498
for clientpath in self.clients:
1499
client = self.bus.get_object(dbus_busname, clientpath)
1500
self.assertIn(("Approve", (False, client_dbus_interface)),
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,)),
1503
1869
def test_Remove(self):
1504
class MockMandos(object):
1507
def RemoveClient(self, dbus_path):
1508
self.calls.append(("RemoveClient", (dbus_path,)))
1509
mandos = MockMandos()
1510
command.Remove().run(self.clients, self.bus, mandos)
1511
for clientpath in self.clients:
1512
self.assertIn(("RemoveClient", (clientpath,)),
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)
1515
1876
expected_json = {
1675
2050
num_lines = max(len(rows) for rows in columns)
1676
expected_output = "\n".join("".join(rows[line]
1677
for rows in columns)
1678
for line in range(num_lines))
1679
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())
1681
2057
def test_PrintTable_one_client(self):
1682
output = command.PrintTable().output(self.one_client.values())
2058
with self.capture_stdout_to_buffer() as buffer:
2059
command.PrintTable().run(self.bus.one_client)
1683
2060
expected_output = "\n".join((
1684
2061
"Name Enabled Timeout Last Successful Check",
1685
2062
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1687
self.assertEqual(output, expected_output)
1690
class TestPropertyCmd(TestCommand):
1691
"""Abstract class for tests of command.Property classes"""
2064
self.assertEqual(expected_output, buffer.getvalue())
2067
class TestPropertySetterCmd(TestCommand):
2068
"""Abstract class for tests of command.PropertySetter classes"""
1692
2070
def runTest(self):
1693
2071
if not hasattr(self, "command"):
2072
return # Abstract TestCase class
1695
2073
values_to_get = getattr(self, "values_to_get",
1696
2074
self.values_to_set)
1697
2075
for value_to_set, value_to_get in zip(self.values_to_set,
1698
2076
values_to_get):
1699
for clientpath in self.clients:
1700
client = self.bus.get_object(dbus_busname, clientpath)
1701
old_value = client.attributes[self.propname]
1702
client.attributes[self.propname] = self.Unique()
1703
self.run_command(value_to_set, self.clients)
1704
for clientpath in self.clients:
1705
client = self.bus.get_object(dbus_busname, clientpath)
1706
value = client.attributes[self.propname]
1707
self.assertNotIsInstance(value, self.Unique)
1708
self.assertEqual(value, value_to_get)
1710
class Unique(object):
1711
"""Class for objects which exist only to be unique objects,
1712
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)
1714
2085
def run_command(self, value, clients):
1715
2086
self.command().run(clients, self.bus)
1718
class TestEnableCmd(TestPropertyCmd):
2089
class TestEnableCmd(TestPropertySetterCmd):
1719
2090
command = command.Enable
1720
2091
propname = "Enabled"
1721
values_to_set = [dbus.Boolean(True)]
1724
class TestDisableCmd(TestPropertyCmd):
2092
values_to_set = [True]
2095
class TestDisableCmd(TestPropertySetterCmd):
1725
2096
command = command.Disable
1726
2097
propname = "Enabled"
1727
values_to_set = [dbus.Boolean(False)]
1730
class TestBumpTimeoutCmd(TestPropertyCmd):
2098
values_to_set = [False]
2101
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1731
2102
command = command.BumpTimeout
1732
2103
propname = "LastCheckedOK"
1733
2104
values_to_set = [""]
1736
class TestStartCheckerCmd(TestPropertyCmd):
2107
class TestStartCheckerCmd(TestPropertySetterCmd):
1737
2108
command = command.StartChecker
1738
2109
propname = "CheckerRunning"
1739
values_to_set = [dbus.Boolean(True)]
1742
class TestStopCheckerCmd(TestPropertyCmd):
2110
values_to_set = [True]
2113
class TestStopCheckerCmd(TestPropertySetterCmd):
1743
2114
command = command.StopChecker
1744
2115
propname = "CheckerRunning"
1745
values_to_set = [dbus.Boolean(False)]
1748
class TestApproveByDefaultCmd(TestPropertyCmd):
2116
values_to_set = [False]
2119
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1749
2120
command = command.ApproveByDefault
1750
2121
propname = "ApprovedByDefault"
1751
values_to_set = [dbus.Boolean(True)]
1754
class TestDenyByDefaultCmd(TestPropertyCmd):
2122
values_to_set = [True]
2125
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1755
2126
command = command.DenyByDefault
1756
2127
propname = "ApprovedByDefault"
1757
values_to_set = [dbus.Boolean(False)]
1760
class TestPropertyValueCmd(TestPropertyCmd):
1761
"""Abstract class for tests of PropertyValueCmd classes"""
1764
if type(self) is TestPropertyValueCmd:
1766
return super(TestPropertyValueCmd, self).runTest()
2128
values_to_set = [False]
2131
class TestPropertySetterValueCmd(TestPropertySetterCmd):
2132
"""Abstract class for tests of PropertySetterValueCmd classes"""
1768
2134
def run_command(self, value, clients):
1769
2135
self.command(value).run(clients, self.bus)
1772
class TestSetCheckerCmd(TestPropertyValueCmd):
2138
class TestSetCheckerCmd(TestPropertySetterValueCmd):
1773
2139
command = command.SetChecker
1774
2140
propname = "Checker"
1775
2141
values_to_set = ["", ":", "fping -q -- %s"]
1778
class TestSetHostCmd(TestPropertyValueCmd):
2144
class TestSetHostCmd(TestPropertySetterValueCmd):
1779
2145
command = command.SetHost
1780
2146
propname = "Host"
1781
values_to_set = ["192.0.2.3", "foo.example.org"]
1784
class TestSetSecretCmd(TestPropertyValueCmd):
2147
values_to_set = ["192.0.2.3", "client.example.org"]
2150
class TestSetSecretCmd(TestPropertySetterValueCmd):
1785
2151
command = command.SetSecret
1786
2152
propname = "Secret"
1787
2153
values_to_set = [io.BytesIO(b""),
1788
2154
io.BytesIO(b"secret\0xyzzy\nbar")]
1789
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1792
class TestSetTimeoutCmd(TestPropertyValueCmd):
2155
values_to_get = [f.getvalue() for f in values_to_set]
2158
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
1793
2159
command = command.SetTimeout
1794
2160
propname = "Timeout"
1795
2161
values_to_set = [datetime.timedelta(),