141
149
help="Select all clients")
142
150
parser.add_argument("-v", "--verbose", action="store_true",
143
151
help="Print all fields")
144
parser.add_argument("-j", "--dump-json", action="store_true",
152
parser.add_argument("-j", "--dump-json", dest="commands",
153
action="append_const", default=[],
154
const=command.DumpJSON(),
145
155
help="Dump client data in JSON format")
146
156
enable_disable = parser.add_mutually_exclusive_group()
147
enable_disable.add_argument("-e", "--enable", action="store_true",
157
enable_disable.add_argument("-e", "--enable", dest="commands",
158
action="append_const", default=[],
159
const=command.Enable(),
148
160
help="Enable client")
149
enable_disable.add_argument("-d", "--disable",
161
enable_disable.add_argument("-d", "--disable", dest="commands",
162
action="append_const", default=[],
163
const=command.Disable(),
151
164
help="disable client")
152
parser.add_argument("-b", "--bump-timeout", action="store_true",
165
parser.add_argument("-b", "--bump-timeout", dest="commands",
166
action="append_const", default=[],
167
const=command.BumpTimeout(),
153
168
help="Bump timeout for client")
154
169
start_stop_checker = parser.add_mutually_exclusive_group()
155
170
start_stop_checker.add_argument("--start-checker",
172
action="append_const", default=[],
173
const=command.StartChecker(),
157
174
help="Start checker for client")
158
start_stop_checker.add_argument("--stop-checker",
175
start_stop_checker.add_argument("--stop-checker", dest="commands",
176
action="append_const", default=[],
177
const=command.StopChecker(),
160
178
help="Stop checker for client")
161
parser.add_argument("-V", "--is-enabled", action="store_true",
179
parser.add_argument("-V", "--is-enabled", dest="commands",
180
action="append_const", default=[],
181
const=command.IsEnabled(),
162
182
help="Check if client is enabled")
163
parser.add_argument("-r", "--remove", action="store_true",
183
parser.add_argument("-r", "--remove", dest="commands",
184
action="append_const", default=[],
185
const=command.Remove(),
164
186
help="Remove client")
165
parser.add_argument("-c", "--checker",
187
parser.add_argument("-c", "--checker", dest="commands",
188
action="append", default=[],
189
metavar="COMMAND", type=command.SetChecker,
166
190
help="Set checker command for client")
167
parser.add_argument("-t", "--timeout", type=string_to_delta,
168
help="Set timeout for client")
169
parser.add_argument("--extended-timeout", type=string_to_delta,
170
help="Set extended timeout for client")
171
parser.add_argument("-i", "--interval", type=string_to_delta,
172
help="Set checker interval for client")
192
"-t", "--timeout", dest="commands", action="append",
193
default=[], metavar="TIME",
194
type=command.SetTimeout.argparse(string_to_delta),
195
help="Set timeout for client")
197
"--extended-timeout", dest="commands", action="append",
198
default=[], metavar="TIME",
199
type=command.SetExtendedTimeout.argparse(string_to_delta),
200
help="Set extended timeout for client")
202
"-i", "--interval", dest="commands", action="append",
203
default=[], metavar="TIME",
204
type=command.SetInterval.argparse(string_to_delta),
205
help="Set checker interval for client")
173
206
approve_deny_default = parser.add_mutually_exclusive_group()
174
207
approve_deny_default.add_argument(
175
"--approve-by-default", action="store_true",
176
default=None, dest="approved_by_default",
208
"--approve-by-default", dest="commands",
209
action="append_const", default=[],
210
const=command.ApproveByDefault(),
177
211
help="Set client to be approved by default")
178
212
approve_deny_default.add_argument(
179
"--deny-by-default", action="store_false",
180
dest="approved_by_default",
213
"--deny-by-default", dest="commands",
214
action="append_const", default=[],
215
const=command.DenyByDefault(),
181
216
help="Set client to be denied by default")
182
parser.add_argument("--approval-delay", type=string_to_delta,
183
help="Set delay before client approve/deny")
184
parser.add_argument("--approval-duration", type=string_to_delta,
185
help="Set duration of one client approval")
186
parser.add_argument("-H", "--host", help="Set host for client")
187
parser.add_argument("-s", "--secret",
188
type=argparse.FileType(mode="rb"),
189
help="Set password blob (file) for client")
218
"--approval-delay", dest="commands", action="append",
219
default=[], metavar="TIME",
220
type=command.SetApprovalDelay.argparse(string_to_delta),
221
help="Set delay before client approve/deny")
223
"--approval-duration", dest="commands", action="append",
224
default=[], metavar="TIME",
225
type=command.SetApprovalDuration.argparse(string_to_delta),
226
help="Set duration of one client approval")
227
parser.add_argument("-H", "--host", dest="commands",
228
action="append", default=[], metavar="STRING",
229
type=command.SetHost,
230
help="Set host for client")
232
"-s", "--secret", dest="commands", action="append",
233
default=[], metavar="FILENAME",
234
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
235
help="Set password blob (file) for client")
190
236
approve_deny = parser.add_mutually_exclusive_group()
191
237
approve_deny.add_argument(
192
"-A", "--approve", action="store_true",
238
"-A", "--approve", dest="commands", action="append_const",
239
default=[], const=command.Approve(),
193
240
help="Approve any current client request")
194
approve_deny.add_argument("-D", "--deny", action="store_true",
241
approve_deny.add_argument("-D", "--deny", dest="commands",
242
action="append_const", default=[],
243
const=command.Deny(),
195
244
help="Deny any current client request")
196
245
parser.add_argument("--debug", action="store_true",
197
246
help="Debug mode (show D-Bus commands)")
388
438
"""Apply additional restrictions on options, not expressible in
391
def has_actions(options):
392
return any((options.enable,
394
options.bump_timeout,
395
options.start_checker,
396
options.stop_checker,
399
options.checker is not None,
400
options.timeout is not None,
401
options.extended_timeout is not None,
402
options.interval is not None,
403
options.approved_by_default is not None,
404
options.approval_delay is not None,
405
options.approval_duration is not None,
406
options.host is not None,
407
options.secret is not None,
441
def has_commands(options, commands=None):
443
commands = (command.Enable,
446
command.StartChecker,
452
command.SetExtendedTimeout,
454
command.ApproveByDefault,
455
command.DenyByDefault,
456
command.SetApprovalDelay,
457
command.SetApprovalDuration,
462
return any(isinstance(cmd, commands)
463
for cmd in options.commands)
411
if has_actions(options) and not (options.client or options.all):
465
if has_commands(options) and not (options.client or options.all):
412
466
parser.error("Options require clients names or --all.")
413
if options.verbose and has_actions(options):
467
if options.verbose and has_commands(options):
414
468
parser.error("--verbose can only be used alone.")
415
if options.dump_json and (options.verbose
416
or has_actions(options)):
469
if (has_commands(options, (command.DumpJSON,))
470
and (options.verbose or len(options.commands) > 1)):
417
471
parser.error("--dump-json can only be used alone.")
418
if options.all and not has_actions(options):
472
if options.all and not has_commands(options):
419
473
parser.error("--all requires an action.")
420
if options.is_enabled and len(options.client) > 1:
474
if (has_commands(options, (command.IsEnabled,))
475
and len(options.client) > 1):
421
476
parser.error("--is-enabled requires exactly one client")
423
options.remove = False
424
if has_actions(options) and not options.deny:
425
parser.error("--remove can only be combined with --deny")
426
options.remove = True
429
def get_mandos_dbus_object(bus):
430
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
431
dbus_busname, server_dbus_path)
432
with if_dbus_exception_log_with_exception_and_exit(
433
"Could not connect to Mandos server: %s"):
434
mandos_dbus_object = bus.get_object(dbus_busname,
436
return mandos_dbus_object
439
@contextlib.contextmanager
440
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
443
except dbus.exceptions.DBusException as e:
444
log.critical(*(args + (e,)), **kwargs)
448
def get_managed_objects(object_manager):
449
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
450
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
451
with if_dbus_exception_log_with_exception_and_exit(
452
"Failed to access Mandos server through D-Bus:\n%s"):
453
with SilenceLogger("dbus.proxies"):
454
managed_objects = object_manager.GetManagedObjects()
455
return managed_objects
458
class SilenceLogger(object):
459
"Simple context manager to silence a particular logger"
460
def __init__(self, loggername):
461
self.logger = logging.getLogger(loggername)
464
self.logger.addFilter(self.nullfilter)
467
class NullFilter(logging.Filter):
468
def filter(self, record):
471
nullfilter = NullFilter()
473
def __exit__(self, exc_type, exc_val, exc_tb):
474
self.logger.removeFilter(self.nullfilter)
477
if (len(options.commands) > 1
478
and has_commands(options, (command.Remove,))
479
and not has_commands(options, (command.Deny,))):
480
parser.error("--remove can only be combined with --deny")
487
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
488
def get_managed_objects(self, busname, objectpath):
489
return self.call_method("GetManagedObjects", busname,
491
self.object_manager_iface)
493
properties_iface = "org.freedesktop.DBus.Properties"
494
def set_property(self, busname, objectpath, interface, key,
496
self.call_method("Set", busname, objectpath,
497
self.properties_iface, interface, key,
500
def call_method(self, methodname, busname, objectpath,
502
raise NotImplementedError()
505
class MandosBus(SystemBus):
506
busname_domain = "se.recompile"
507
busname = busname_domain + ".Mandos"
509
server_interface = busname_domain + ".Mandos"
510
client_interface = busname_domain + ".Mandos.Client"
513
def get_clients_and_properties(self):
514
managed_objects = self.get_managed_objects(
515
self.busname, self.server_path)
516
return {objpath: properties[self.client_interface]
517
for objpath, properties in managed_objects.items()
518
if self.client_interface in properties}
520
def set_client_property(self, objectpath, key, value):
521
return self.set_property(self.busname, objectpath,
522
self.client_interface, key,
525
def call_client_method(self, objectpath, method, *args):
526
return self.call_method(method, self.busname, objectpath,
527
self.client_interface, *args)
529
def call_server_method(self, method, *args):
530
return self.call_method(method, self.busname,
532
self.server_interface, *args)
534
class Error(Exception):
537
class ConnectFailed(Error):
541
class dbus_python_adapter:
543
class SystemBus(dbus.MandosBus):
544
"""Use dbus-python"""
546
def __init__(self, module=dbus_python):
547
self.dbus_python = module
548
self.bus = self.dbus_python.SystemBus()
550
@contextlib.contextmanager
551
def convert_exception(self, exception_class=dbus.Error):
554
except self.dbus_python.exceptions.DBusException as e:
555
# This does what "raise from" would do
556
exc = exception_class(*e.args)
560
def call_method(self, methodname, busname, objectpath,
562
proxy_object = self.get_object(busname, objectpath)
563
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
564
interface, methodname,
565
", ".join(repr(a) for a in args))
566
method = getattr(proxy_object, methodname)
567
with self.convert_exception():
568
with dbus_python_adapter.SilenceLogger(
570
value = method(*args, dbus_interface=interface)
571
return self.type_filter(value)
573
def get_object(self, busname, objectpath):
574
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
576
with self.convert_exception(dbus.ConnectFailed):
577
return self.bus.get_object(busname, objectpath)
579
def type_filter(self, value):
580
"""Convert the most bothersome types to Python types"""
581
if isinstance(value, self.dbus_python.Boolean):
583
if isinstance(value, self.dbus_python.ObjectPath):
585
# Also recurse into dictionaries
586
if isinstance(value, self.dbus_python.Dictionary):
587
return {self.type_filter(key):
588
self.type_filter(subval)
589
for key, subval in value.items()}
592
def set_client_property(self, objectpath, key, value):
594
if not isinstance(value, bytes):
595
value = value.encode("utf-8")
596
value = self.dbus_python.ByteArray(value)
597
return self.set_property(self.busname, objectpath,
598
self.client_interface, key,
602
"Simple context manager to silence a particular logger"
603
def __init__(self, loggername):
604
self.logger = logging.getLogger(loggername)
607
self.logger.addFilter(self.nullfilter)
609
class NullFilter(logging.Filter):
610
def filter(self, record):
613
nullfilter = NullFilter()
615
def __exit__(self, exc_type, exc_val, exc_tb):
616
self.logger.removeFilter(self.nullfilter)
619
class CachingBus(SystemBus):
620
"""A caching layer for dbus_python_adapter.SystemBus"""
621
def __init__(self, *args, **kwargs):
622
self.object_cache = {}
623
super(dbus_python_adapter.CachingBus,
624
self).__init__(*args, **kwargs)
625
def get_object(self, busname, objectpath):
627
return self.object_cache[(busname, objectpath)]
630
dbus_python_adapter.CachingBus,
631
self).get_object(busname, objectpath)
632
self.object_cache[(busname, objectpath)] = new_object
636
class pydbus_adapter:
637
class SystemBus(dbus.MandosBus):
638
def __init__(self, module=pydbus):
640
self.bus = self.pydbus.SystemBus()
642
@contextlib.contextmanager
643
def convert_exception(self, exception_class=dbus.Error):
646
except gi.repository.GLib.Error as e:
647
# This does what "raise from" would do
648
exc = exception_class(*e.args)
652
def call_method(self, methodname, busname, objectpath,
654
proxy_object = self.get(busname, objectpath)
655
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
656
interface, methodname,
657
", ".join(repr(a) for a in args))
658
method = getattr(proxy_object[interface], methodname)
659
with self.convert_exception():
662
def get(self, busname, objectpath):
663
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
665
with self.convert_exception(dbus.ConnectFailed):
666
if sys.version_info.major <= 2:
667
with warnings.catch_warnings():
668
warnings.filterwarnings(
669
"ignore", "", DeprecationWarning,
670
r"^xml\.etree\.ElementTree$")
671
return self.bus.get(busname, objectpath)
673
return self.bus.get(busname, objectpath)
675
def set_property(self, busname, objectpath, interface, key,
677
proxy_object = self.get(busname, objectpath)
678
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
679
objectpath, self.properties_iface, interface,
681
setattr(proxy_object[interface], key, value)
683
class CachingBus(SystemBus):
684
"""A caching layer for pydbus_adapter.SystemBus"""
685
def __init__(self, *args, **kwargs):
686
self.object_cache = {}
687
super(pydbus_adapter.CachingBus,
688
self).__init__(*args, **kwargs)
689
def get(self, busname, objectpath):
691
return self.object_cache[(busname, objectpath)]
693
new_object = (super(pydbus_adapter.CachingBus, self)
694
.get(busname, objectpath))
695
self.object_cache[(busname, objectpath)] = new_object
699
class dbussy_adapter:
700
class SystemBus(dbus.SystemBus):
703
def __init__(self, dbussy, ravel):
706
self.bus = ravel.system_bus()
708
@contextlib.contextmanager
709
def convert_exception(self, exception_class=dbus.Error):
712
except self.dbussy.DBusError as e:
713
# This does what "raise from" would do
714
exc = exception_class(*e.args)
718
def call_method(self, methodname, busname, objectpath,
720
proxy_object = self.get_object(busname, objectpath)
721
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
722
interface, methodname,
723
", ".join(repr(a) for a in args))
724
iface = proxy_object.get_interface(interface)
725
method = getattr(iface, methodname)
726
with self.convert_exception(dbus.Error):
727
value = method(*args)
728
# DBussy returns values either as an empty list or as a
729
# tuple: (signature, value)
731
return self.type_filter(value[0])
733
def get_object(self, busname, objectpath):
734
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
736
with self.convert_exception(dbus.ConnectFailed):
737
return self.bus[busname][objectpath]
739
def type_filter(self, value):
740
"""Convert the most bothersome types to Python types"""
741
if isinstance(value, tuple):
743
and isinstance(value[0],
744
self.dbussy.DBUS.Signature)):
745
return self.type_filter(value[1])
746
elif isinstance(value, self.dbussy.DBUS.ObjectPath):
748
# Also recurse into dictionaries
749
elif isinstance(value, dict):
750
return {self.type_filter(key):
751
self.type_filter(subval)
752
for key, subval in value.items()}
755
def set_property(self, busname, objectpath, interface, key,
757
proxy_object = self.get_object(busname, objectpath)
758
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
759
objectpath, self.properties_iface, interface,
762
# DBussy wants a Byte Array to be a sequence of
763
# values, not a byte string
765
setattr(proxy_object.get_interface(interface), key, value)
767
class MandosBus(SystemBus, dbus.MandosBus):
770
class CachingBus(MandosBus):
771
"""A caching layer for dbussy_adapter.MandosBus"""
772
def __init__(self, *args, **kwargs):
773
self.object_cache = {}
774
super(dbussy_adapter.CachingBus, self).__init__(*args,
776
def get_object(self, busname, objectpath):
778
return self.object_cache[(busname, objectpath)]
781
dbussy_adapter.CachingBus,
782
self).get_object(busname, objectpath)
783
self.object_cache[(busname, objectpath)] = new_object
477
787
def commands_from_options(options):
481
if options.is_enabled:
482
commands.append(command.IsEnabled())
485
commands.append(command.Approve())
488
commands.append(command.Deny())
491
commands.append(command.Remove())
493
if options.dump_json:
494
commands.append(command.DumpJSON())
497
commands.append(command.Enable())
500
commands.append(command.Disable())
502
if options.bump_timeout:
503
commands.append(command.BumpTimeout())
505
if options.start_checker:
506
commands.append(command.StartChecker())
508
if options.stop_checker:
509
commands.append(command.StopChecker())
511
if options.approved_by_default is not None:
512
if options.approved_by_default:
513
commands.append(command.ApproveByDefault())
789
commands = list(options.commands)
791
def find_cmd(cmd, commands):
793
for i, c in enumerate(commands):
794
if isinstance(c, cmd):
798
# If command.Remove is present, move any instances of command.Deny
799
# to occur ahead of command.Remove.
800
index_of_remove = find_cmd(command.Remove, commands)
801
before_remove = commands[:index_of_remove]
802
after_remove = commands[index_of_remove:]
804
for cmd in after_remove:
805
if isinstance(cmd, command.Deny):
806
before_remove.append(cmd)
515
commands.append(command.DenyByDefault())
517
if options.checker is not None:
518
commands.append(command.SetChecker(options.checker))
520
if options.host is not None:
521
commands.append(command.SetHost(options.host))
523
if options.secret is not None:
524
commands.append(command.SetSecret(options.secret))
526
if options.timeout is not None:
527
commands.append(command.SetTimeout(options.timeout))
529
if options.extended_timeout:
531
command.SetExtendedTimeout(options.extended_timeout))
533
if options.interval is not None:
534
commands.append(command.SetInterval(options.interval))
536
if options.approval_delay is not None:
538
command.SetApprovalDelay(options.approval_delay))
540
if options.approval_duration is not None:
542
command.SetApprovalDuration(options.approval_duration))
808
cleaned_after.append(cmd)
809
if cleaned_after != after_remove:
810
commands = before_remove + cleaned_after
544
812
# If no command option has been given, show table of clients,
545
813
# optionally verbosely
972
1230
def test_actions_all_conflicts_with_verbose(self):
973
1231
for action, value in self.actions.items():
974
options = self.parser.parse_args()
975
setattr(options, action, value)
977
options.verbose = True
1232
args = self.actionargs(action, value, "--all",
978
1234
with self.assertParseError():
979
self.check_option_syntax(options)
1235
self.parse_args(args)
981
1237
def test_actions_with_client_conflicts_with_verbose(self):
982
1238
for action, value in self.actions.items():
983
options = self.parser.parse_args()
984
setattr(options, action, value)
985
options.verbose = True
986
options.client = ["client"]
1239
args = self.actionargs(action, value, "--verbose",
987
1241
with self.assertParseError():
988
self.check_option_syntax(options)
1242
self.parse_args(args)
990
1244
def test_dump_json_conflicts_with_verbose(self):
991
options = self.parser.parse_args()
992
options.dump_json = True
993
options.verbose = True
1245
args = ["--dump-json", "--verbose"]
994
1246
with self.assertParseError():
995
self.check_option_syntax(options)
1247
self.parse_args(args)
997
1249
def test_dump_json_conflicts_with_action(self):
998
1250
for action, value in self.actions.items():
999
options = self.parser.parse_args()
1000
setattr(options, action, value)
1001
options.dump_json = True
1251
args = self.actionargs(action, value, "--dump-json")
1002
1252
with self.assertParseError():
1003
self.check_option_syntax(options)
1253
self.parse_args(args)
1005
1255
def test_all_can_not_be_alone(self):
1006
options = self.parser.parse_args()
1008
1257
with self.assertParseError():
1009
self.check_option_syntax(options)
1258
self.parse_args(args)
1011
1260
def test_all_is_ok_with_any_action(self):
1012
1261
for action, value in self.actions.items():
1013
options = self.parser.parse_args()
1014
setattr(options, action, value)
1016
self.check_option_syntax(options)
1262
args = self.actionargs(action, value, "--all")
1263
self.parse_args(args)
1018
1265
def test_any_action_is_ok_with_one_client(self):
1019
1266
for action, value in self.actions.items():
1020
options = self.parser.parse_args()
1021
setattr(options, action, value)
1022
options.client = ["client"]
1023
self.check_option_syntax(options)
1267
args = self.actionargs(action, value, "client")
1268
self.parse_args(args)
1025
1270
def test_one_client_with_all_actions_except_is_enabled(self):
1026
options = self.parser.parse_args()
1027
1271
for action, value in self.actions.items():
1028
if action == "is_enabled":
1272
if action == "--is-enabled":
1030
setattr(options, action, value)
1031
options.client = ["client"]
1032
self.check_option_syntax(options)
1274
args = self.actionargs(action, value, "client")
1275
self.parse_args(args)
1034
1277
def test_two_clients_with_all_actions_except_is_enabled(self):
1035
options = self.parser.parse_args()
1036
1278
for action, value in self.actions.items():
1037
if action == "is_enabled":
1279
if action == "--is-enabled":
1039
setattr(options, action, value)
1040
options.client = ["client1", "client2"]
1041
self.check_option_syntax(options)
1281
args = self.actionargs(action, value, "client1",
1283
self.parse_args(args)
1043
1285
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1044
1286
for action, value in self.actions.items():
1045
if action == "is_enabled":
1287
if action == "--is-enabled":
1047
options = self.parser.parse_args()
1048
setattr(options, action, value)
1049
options.client = ["client1", "client2"]
1050
self.check_option_syntax(options)
1289
args = self.actionargs(action, value, "client1",
1291
self.parse_args(args)
1052
1293
def test_is_enabled_fails_without_client(self):
1053
options = self.parser.parse_args()
1054
options.is_enabled = True
1294
args = ["--is-enabled"]
1055
1295
with self.assertParseError():
1056
self.check_option_syntax(options)
1296
self.parse_args(args)
1058
1298
def test_is_enabled_fails_with_two_clients(self):
1059
options = self.parser.parse_args()
1060
options.is_enabled = True
1061
options.client = ["client1", "client2"]
1299
args = ["--is-enabled", "client1", "client2"]
1062
1300
with self.assertParseError():
1063
self.check_option_syntax(options)
1301
self.parse_args(args)
1065
1303
def test_remove_can_only_be_combined_with_action_deny(self):
1066
1304
for action, value in self.actions.items():
1067
if action in {"remove", "deny"}:
1305
if action in {"--remove", "--deny"}:
1069
options = self.parser.parse_args()
1070
setattr(options, action, value)
1072
options.remove = True
1307
args = self.actionargs(action, value, "--all",
1073
1309
with self.assertParseError():
1074
self.check_option_syntax(options)
1077
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1078
def test_calls_and_returns_get_object_on_bus(self):
1079
class MockBus(object):
1081
def get_object(mockbus_self, busname, dbus_path):
1082
# Note that "self" is still the testcase instance,
1083
# this MockBus instance is in "mockbus_self".
1084
self.assertEqual(dbus_busname, busname)
1085
self.assertEqual(server_dbus_path, dbus_path)
1086
mockbus_self.called = True
1089
mockbus = get_mandos_dbus_object(bus=MockBus())
1090
self.assertIsInstance(mockbus, MockBus)
1091
self.assertTrue(mockbus.called)
1093
def test_logs_and_exits_on_dbus_error(self):
1094
class FailingBusStub(object):
1095
def get_object(self, busname, dbus_path):
1096
raise dbus.exceptions.DBusException("Test")
1098
with self.assertLogs(log, logging.CRITICAL):
1099
with self.assertRaises(SystemExit) as e:
1100
bus = get_mandos_dbus_object(bus=FailingBusStub())
1102
if isinstance(e.exception.code, int):
1103
self.assertNotEqual(0, e.exception.code)
1105
self.assertIsNotNone(e.exception.code)
1108
class Test_get_managed_objects(TestCaseWithAssertLogs):
1109
def test_calls_and_returns_GetManagedObjects(self):
1110
managed_objects = {"/clients/client": { "Name": "client"}}
1111
class ObjectManagerStub(object):
1112
def GetManagedObjects(self):
1113
return managed_objects
1114
retval = get_managed_objects(ObjectManagerStub())
1115
self.assertDictEqual(managed_objects, retval)
1117
def test_logs_and_exits_on_dbus_error(self):
1310
self.parse_args(args)
1313
class Test_dbus_exceptions(unittest.TestCase):
1315
def test_dbus_ConnectFailed_is_Error(self):
1316
with self.assertRaises(dbus.Error):
1317
raise dbus.ConnectFailed()
1320
class Test_dbus_MandosBus(unittest.TestCase):
1322
class MockMandosBus(dbus.MandosBus):
1324
self._name = "se.recompile.Mandos"
1325
self._server_path = "/"
1326
self._server_interface = "se.recompile.Mandos"
1327
self._client_interface = "se.recompile.Mandos.Client"
1329
self.call_method_return = Unique()
1331
def call_method(self, methodname, busname, objectpath,
1333
self.calls.append((methodname, busname, objectpath,
1335
return self.call_method_return
1338
self.bus = self.MockMandosBus()
1340
def test_set_client_property(self):
1341
self.bus.set_client_property("objectpath", "key", "value")
1342
expected_call = ("Set", self.bus._name, "objectpath",
1343
"org.freedesktop.DBus.Properties",
1344
(self.bus._client_interface, "key", "value"))
1345
self.assertIn(expected_call, self.bus.calls)
1347
def test_call_client_method(self):
1348
ret = self.bus.call_client_method("objectpath", "methodname")
1349
self.assertIs(self.bus.call_method_return, ret)
1350
expected_call = ("methodname", self.bus._name, "objectpath",
1351
self.bus._client_interface, ())
1352
self.assertIn(expected_call, self.bus.calls)
1354
def test_call_client_method_with_args(self):
1355
args = (Unique(), Unique())
1356
ret = self.bus.call_client_method("objectpath", "methodname",
1358
self.assertIs(self.bus.call_method_return, ret)
1359
expected_call = ("methodname", self.bus._name, "objectpath",
1360
self.bus._client_interface,
1362
self.assertIn(expected_call, self.bus.calls)
1364
def test_get_clients_and_properties(self):
1367
self.bus._client_interface: {
1371
"irrelevant_interface": {
1372
"key": "othervalue",
1376
"other_objectpath": {
1377
"other_irrelevant_interface": {
1383
expected_clients_and_properties = {
1389
self.bus.call_method_return = managed_objects
1390
ret = self.bus.get_clients_and_properties()
1391
self.assertDictEqual(expected_clients_and_properties, ret)
1392
expected_call = ("GetManagedObjects", self.bus._name,
1393
self.bus._server_path,
1394
"org.freedesktop.DBus.ObjectManager", ())
1395
self.assertIn(expected_call, self.bus.calls)
1397
def test_call_server_method(self):
1398
ret = self.bus.call_server_method("methodname")
1399
self.assertIs(self.bus.call_method_return, ret)
1400
expected_call = ("methodname", self.bus._name,
1401
self.bus._server_path,
1402
self.bus._server_interface, ())
1403
self.assertIn(expected_call, self.bus.calls)
1405
def test_call_server_method_with_args(self):
1406
args = (Unique(), Unique())
1407
ret = self.bus.call_server_method("methodname", *args)
1408
self.assertIs(self.bus.call_method_return, ret)
1409
expected_call = ("methodname", self.bus._name,
1410
self.bus._server_path,
1411
self.bus._server_interface,
1413
self.assertIn(expected_call, self.bus.calls)
1416
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1418
def MockDBusPython_func(self, func):
1419
class mock_dbus_python:
1420
"""mock dbus-python module"""
1422
"""Pseudo-namespace"""
1423
class DBusException(Exception):
1427
def get_object(busname, objectpath):
1428
DBusObject = collections.namedtuple(
1429
"DBusObject", ("methodname", "Set"))
1430
def method(*args, **kwargs):
1431
self.assertEqual({"dbus_interface":
1435
def set_property(interface, key, value,
1436
dbus_interface=None):
1438
"org.freedesktop.DBus.Properties",
1440
self.assertEqual("Secret", key)
1441
return func(interface, key, value,
1442
dbus_interface=dbus_interface)
1443
return DBusObject(methodname=method,
1446
def __init__(self, value):
1447
self.value = bool(value)
1450
if sys.version_info.major == 2:
1451
__nonzero__ = __bool__
1452
class ObjectPath(str):
1454
class Dictionary(dict):
1456
class ByteArray(bytes):
1458
return mock_dbus_python
1460
def call_method(self, bus, methodname, busname, objectpath,
1462
with self.assertLogs(log, logging.DEBUG):
1463
return bus.call_method(methodname, busname, objectpath,
1466
def test_call_method_returns(self):
1467
expected_method_return = Unique()
1468
method_args = (Unique(), Unique())
1470
self.assertEqual(len(method_args), len(args))
1471
for marg, arg in zip(method_args, args):
1472
self.assertIs(marg, arg)
1473
return expected_method_return
1474
mock_dbus_python = self.MockDBusPython_func(func)
1475
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1476
ret = self.call_method(bus, "methodname", "busname",
1477
"objectpath", "interface",
1479
self.assertIs(ret, expected_method_return)
1481
def test_call_method_filters_bool_true(self):
1483
return method_return
1484
mock_dbus_python = self.MockDBusPython_func(func)
1485
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1486
method_return = mock_dbus_python.Boolean(True)
1487
ret = self.call_method(bus, "methodname", "busname",
1488
"objectpath", "interface")
1489
self.assertTrue(ret)
1490
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1492
def test_call_method_filters_bool_false(self):
1494
return method_return
1495
mock_dbus_python = self.MockDBusPython_func(func)
1496
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1497
method_return = mock_dbus_python.Boolean(False)
1498
ret = self.call_method(bus, "methodname", "busname",
1499
"objectpath", "interface")
1500
self.assertFalse(ret)
1501
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1503
def test_call_method_filters_objectpath(self):
1505
return method_return
1506
mock_dbus_python = self.MockDBusPython_func(func)
1507
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1508
method_return = mock_dbus_python.ObjectPath("objectpath")
1509
ret = self.call_method(bus, "methodname", "busname",
1510
"objectpath", "interface")
1511
self.assertEqual("objectpath", ret)
1512
self.assertIsNot("objectpath", ret)
1513
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1515
def test_call_method_filters_booleans_in_dict(self):
1517
return method_return
1518
mock_dbus_python = self.MockDBusPython_func(func)
1519
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1520
method_return = mock_dbus_python.Dictionary(
1521
{mock_dbus_python.Boolean(True):
1522
mock_dbus_python.Boolean(False),
1523
mock_dbus_python.Boolean(False):
1524
mock_dbus_python.Boolean(True)})
1525
ret = self.call_method(bus, "methodname", "busname",
1526
"objectpath", "interface")
1527
expected_method_return = {True: False,
1529
self.assertEqual(expected_method_return, ret)
1530
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1532
def test_call_method_filters_objectpaths_in_dict(self):
1534
return method_return
1535
mock_dbus_python = self.MockDBusPython_func(func)
1536
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1537
method_return = mock_dbus_python.Dictionary(
1538
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1539
mock_dbus_python.ObjectPath("objectpath_value_1"),
1540
mock_dbus_python.ObjectPath("objectpath_key_2"):
1541
mock_dbus_python.ObjectPath("objectpath_value_2")})
1542
ret = self.call_method(bus, "methodname", "busname",
1543
"objectpath", "interface")
1544
expected_method_return = {str(key): str(value)
1546
method_return.items()}
1547
self.assertEqual(expected_method_return, ret)
1548
self.assertIsInstance(ret, dict)
1549
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1551
def test_call_method_filters_dict_in_dict(self):
1553
return method_return
1554
mock_dbus_python = self.MockDBusPython_func(func)
1555
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1556
method_return = mock_dbus_python.Dictionary(
1557
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1558
"key12": "value12"}),
1559
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1560
"key22": "value22"})})
1561
ret = self.call_method(bus, "methodname", "busname",
1562
"objectpath", "interface")
1563
expected_method_return = {
1564
"key1": {"key11": "value11",
1565
"key12": "value12"},
1566
"key2": {"key21": "value21",
1567
"key22": "value22"},
1569
self.assertEqual(expected_method_return, ret)
1570
self.assertIsInstance(ret, dict)
1571
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1572
for key, value in ret.items():
1573
self.assertIsInstance(value, dict)
1574
self.assertEqual(expected_method_return[key], value)
1575
self.assertNotIsInstance(value,
1576
mock_dbus_python.Dictionary)
1578
def test_call_method_filters_dict_three_deep(self):
1580
return method_return
1581
mock_dbus_python = self.MockDBusPython_func(func)
1582
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1583
method_return = mock_dbus_python.Dictionary(
1585
mock_dbus_python.Dictionary(
1587
mock_dbus_python.Dictionary(
1589
mock_dbus_python.Boolean(True),
1593
ret = self.call_method(bus, "methodname", "busname",
1594
"objectpath", "interface")
1595
expected_method_return = {"key1": {"key2": {"key3": True}}}
1596
self.assertEqual(expected_method_return, ret)
1597
self.assertIsInstance(ret, dict)
1598
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1599
self.assertIsInstance(ret["key1"], dict)
1600
self.assertNotIsInstance(ret["key1"],
1601
mock_dbus_python.Dictionary)
1602
self.assertIsInstance(ret["key1"]["key2"], dict)
1603
self.assertNotIsInstance(ret["key1"]["key2"],
1604
mock_dbus_python.Dictionary)
1605
self.assertTrue(ret["key1"]["key2"]["key3"])
1606
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1607
mock_dbus_python.Boolean)
1609
def test_call_method_handles_exception(self):
1118
1610
dbus_logger = logging.getLogger("dbus.proxies")
1120
class ObjectManagerFailingStub(object):
1121
def GetManagedObjects(self):
1122
dbus_logger.error("Test")
1123
raise dbus.exceptions.DBusException("Test")
1613
dbus_logger.error("Test")
1614
raise mock_dbus_python.exceptions.DBusException()
1616
mock_dbus_python = self.MockDBusPython_func(func)
1617
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1125
1619
class CountingHandler(logging.Handler):
1132
1626
dbus_logger.addHandler(counting_handler)
1135
with self.assertLogs(log, logging.CRITICAL) as watcher:
1136
with self.assertRaises(SystemExit) as e:
1137
get_managed_objects(ObjectManagerFailingStub())
1629
with self.assertRaises(dbus.Error) as e:
1630
self.call_method(bus, "methodname", "busname",
1631
"objectpath", "interface")
1139
1633
dbus_logger.removeFilter(counting_handler)
1635
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1141
1637
# Make sure the dbus logger was suppressed
1142
1638
self.assertEqual(0, counting_handler.count)
1144
# Test that the dbus_logger still works
1145
with self.assertLogs(dbus_logger, logging.ERROR):
1146
dbus_logger.error("Test")
1148
if isinstance(e.exception.code, int):
1149
self.assertNotEqual(0, e.exception.code)
1151
self.assertIsNotNone(e.exception.code)
1640
def test_Set_Secret_sends_bytearray(self):
1642
def func(*args, **kwargs):
1643
ret[0] = (args, kwargs)
1644
mock_dbus_python = self.MockDBusPython_func(func)
1645
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1646
bus.set_client_property("objectpath", "Secret", "value")
1647
expected_call = (("se.recompile.Mandos.Client", "Secret",
1648
mock_dbus_python.ByteArray(b"value")),
1650
"org.freedesktop.DBus.Properties"})
1651
self.assertEqual(expected_call, ret[0])
1652
if sys.version_info.major == 2:
1653
self.assertIsInstance(ret[0][0][-1],
1654
mock_dbus_python.ByteArray)
1656
def test_get_object_converts_to_correct_exception(self):
1657
bus = dbus_python_adapter.SystemBus(
1658
self.fake_dbus_python_raises_exception_on_connect)
1659
with self.assertRaises(dbus.ConnectFailed):
1660
self.call_method(bus, "methodname", "busname",
1661
"objectpath", "interface")
1663
class fake_dbus_python_raises_exception_on_connect:
1664
"""fake dbus-python module"""
1666
"""Pseudo-namespace"""
1667
class DBusException(Exception):
1672
def get_object(busname, objectpath):
1673
raise cls.exceptions.DBusException()
1674
Bus = collections.namedtuple("Bus", ["get_object"])
1675
return Bus(get_object=get_object)
1678
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1679
class mock_dbus_python:
1680
"""mock dbus-python modules"""
1683
def get_object(busname, objectpath):
1687
self.bus = dbus_python_adapter.CachingBus(
1688
self.mock_dbus_python)
1690
def test_returns_distinct_objectpaths(self):
1691
obj1 = self.bus.get_object("busname", "objectpath1")
1692
self.assertIsInstance(obj1, Unique)
1693
obj2 = self.bus.get_object("busname", "objectpath2")
1694
self.assertIsInstance(obj2, Unique)
1695
self.assertIsNot(obj1, obj2)
1697
def test_returns_distinct_busnames(self):
1698
obj1 = self.bus.get_object("busname1", "objectpath")
1699
self.assertIsInstance(obj1, Unique)
1700
obj2 = self.bus.get_object("busname2", "objectpath")
1701
self.assertIsInstance(obj2, Unique)
1702
self.assertIsNot(obj1, obj2)
1704
def test_returns_distinct_both(self):
1705
obj1 = self.bus.get_object("busname1", "objectpath")
1706
self.assertIsInstance(obj1, Unique)
1707
obj2 = self.bus.get_object("busname2", "objectpath")
1708
self.assertIsInstance(obj2, Unique)
1709
self.assertIsNot(obj1, obj2)
1711
def test_returns_same(self):
1712
obj1 = self.bus.get_object("busname", "objectpath")
1713
self.assertIsInstance(obj1, Unique)
1714
obj2 = self.bus.get_object("busname", "objectpath")
1715
self.assertIsInstance(obj2, Unique)
1716
self.assertIs(obj1, obj2)
1718
def test_returns_same_old(self):
1719
obj1 = self.bus.get_object("busname1", "objectpath1")
1720
self.assertIsInstance(obj1, Unique)
1721
obj2 = self.bus.get_object("busname2", "objectpath2")
1722
self.assertIsInstance(obj2, Unique)
1723
obj1b = self.bus.get_object("busname1", "objectpath1")
1724
self.assertIsInstance(obj1b, Unique)
1725
self.assertIsNot(obj1, obj2)
1726
self.assertIsNot(obj2, obj1b)
1727
self.assertIs(obj1, obj1b)
1730
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1732
def Stub_pydbus_func(self, func):
1734
"""stub pydbus module"""
1737
def get(busname, objectpath):
1738
DBusObject = collections.namedtuple(
1739
"DBusObject", ("methodname",))
1740
return {"interface":
1741
DBusObject(methodname=func)}
1744
def call_method(self, bus, methodname, busname, objectpath,
1746
with self.assertLogs(log, logging.DEBUG):
1747
return bus.call_method(methodname, busname, objectpath,
1750
def test_call_method_returns(self):
1751
expected_method_return = Unique()
1752
method_args = (Unique(), Unique())
1754
self.assertEqual(len(method_args), len(args))
1755
for marg, arg in zip(method_args, args):
1756
self.assertIs(marg, arg)
1757
return expected_method_return
1758
stub_pydbus = self.Stub_pydbus_func(func)
1759
bus = pydbus_adapter.SystemBus(stub_pydbus)
1760
ret = self.call_method(bus, "methodname", "busname",
1761
"objectpath", "interface",
1763
self.assertIs(ret, expected_method_return)
1765
def test_call_method_handles_exception(self):
1766
dbus_logger = logging.getLogger("dbus.proxies")
1769
raise gi.repository.GLib.Error()
1771
stub_pydbus = self.Stub_pydbus_func(func)
1772
bus = pydbus_adapter.SystemBus(stub_pydbus)
1774
with self.assertRaises(dbus.Error) as e:
1775
self.call_method(bus, "methodname", "busname",
1776
"objectpath", "interface")
1778
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1780
def test_get_converts_to_correct_exception(self):
1781
bus = pydbus_adapter.SystemBus(
1782
self.fake_pydbus_raises_exception_on_connect)
1783
with self.assertRaises(dbus.ConnectFailed):
1784
self.call_method(bus, "methodname", "busname",
1785
"objectpath", "interface")
1787
class fake_pydbus_raises_exception_on_connect:
1788
"""fake dbus-python module"""
1791
def get(busname, objectpath):
1792
raise gi.repository.GLib.Error()
1793
Bus = collections.namedtuple("Bus", ["get"])
1796
def test_set_property_uses_setattr(self):
1803
def get(busname, objectpath):
1804
return {"interface": obj}
1805
bus = pydbus_adapter.SystemBus(pydbus_spy)
1807
bus.set_property("busname", "objectpath", "interface", "key",
1809
self.assertIs(value, obj.key)
1811
def test_get_suppresses_xml_deprecation_warning(self):
1812
if sys.version_info.major >= 3:
1814
class stub_pydbus_get:
1817
def get(busname, objectpath):
1818
warnings.warn_explicit(
1819
"deprecated", DeprecationWarning,
1820
"xml.etree.ElementTree", 0)
1821
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1822
with warnings.catch_warnings(record=True) as w:
1823
warnings.simplefilter("always")
1824
bus.get("busname", "objectpath")
1825
self.assertEqual(0, len(w))
1828
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1830
"""stub pydbus module"""
1833
def get(busname, objectpath):
1837
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1839
def test_returns_distinct_objectpaths(self):
1840
obj1 = self.bus.get("busname", "objectpath1")
1841
self.assertIsInstance(obj1, Unique)
1842
obj2 = self.bus.get("busname", "objectpath2")
1843
self.assertIsInstance(obj2, Unique)
1844
self.assertIsNot(obj1, obj2)
1846
def test_returns_distinct_busnames(self):
1847
obj1 = self.bus.get("busname1", "objectpath")
1848
self.assertIsInstance(obj1, Unique)
1849
obj2 = self.bus.get("busname2", "objectpath")
1850
self.assertIsInstance(obj2, Unique)
1851
self.assertIsNot(obj1, obj2)
1853
def test_returns_distinct_both(self):
1854
obj1 = self.bus.get("busname1", "objectpath")
1855
self.assertIsInstance(obj1, Unique)
1856
obj2 = self.bus.get("busname2", "objectpath")
1857
self.assertIsInstance(obj2, Unique)
1858
self.assertIsNot(obj1, obj2)
1860
def test_returns_same(self):
1861
obj1 = self.bus.get("busname", "objectpath")
1862
self.assertIsInstance(obj1, Unique)
1863
obj2 = self.bus.get("busname", "objectpath")
1864
self.assertIsInstance(obj2, Unique)
1865
self.assertIs(obj1, obj2)
1867
def test_returns_same_old(self):
1868
obj1 = self.bus.get("busname1", "objectpath1")
1869
self.assertIsInstance(obj1, Unique)
1870
obj2 = self.bus.get("busname2", "objectpath2")
1871
self.assertIsInstance(obj2, Unique)
1872
obj1b = self.bus.get("busname1", "objectpath1")
1873
self.assertIsInstance(obj1b, Unique)
1874
self.assertIsNot(obj1, obj2)
1875
self.assertIsNot(obj2, obj1b)
1876
self.assertIs(obj1, obj1b)
1879
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
1883
class ObjectPath(str):
1885
class DBusError(Exception):
1888
def fake_ravel_func(self, func):
1892
class DBusInterfaceProxy:
1894
def methodname(*args):
1895
return [func(*args)]
1898
def get_interface(interface):
1899
if interface == "interface":
1900
return DBusInterfaceProxy()
1901
return {"busname": {"objectpath": DBusObject()}}
1904
def call_method(self, bus, methodname, busname, objectpath,
1906
with self.assertLogs(log, logging.DEBUG):
1907
return bus.call_method(methodname, busname, objectpath,
1910
def test_call_method_returns(self):
1911
expected_method_return = Unique()
1912
method_args = (Unique(), Unique())
1914
self.assertEqual(len(method_args), len(args))
1915
for marg, arg in zip(method_args, args):
1916
self.assertIs(marg, arg)
1917
return expected_method_return
1918
fake_ravel = self.fake_ravel_func(func)
1919
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1920
ret = self.call_method(bus, "methodname", "busname",
1921
"objectpath", "interface",
1923
self.assertIs(ret, expected_method_return)
1925
def test_call_method_filters_objectpath(self):
1927
return method_return
1928
fake_ravel = self.fake_ravel_func(func)
1929
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1930
method_return = (self.dummy_dbussy.DBUS
1931
.ObjectPath("objectpath"))
1932
ret = self.call_method(bus, "methodname", "busname",
1933
"objectpath", "interface")
1934
self.assertEqual("objectpath", ret)
1935
self.assertNotIsInstance(ret,
1936
self.dummy_dbussy.DBUS.ObjectPath)
1938
def test_call_method_filters_objectpaths_in_dict(self):
1939
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1941
return method_return
1942
fake_ravel = self.fake_ravel_func(func)
1943
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1945
ObjectPath("objectpath_key_1"):
1946
ObjectPath("objectpath_value_1"),
1947
ObjectPath("objectpath_key_2"):
1948
ObjectPath("objectpath_value_2"),
1950
ret = self.call_method(bus, "methodname", "busname",
1951
"objectpath", "interface")
1952
expected_method_return = {str(key): str(value)
1954
method_return.items()}
1955
for key, value in ret.items():
1956
self.assertNotIsInstance(key, ObjectPath)
1957
self.assertNotIsInstance(value, ObjectPath)
1958
self.assertEqual(expected_method_return, ret)
1959
self.assertIsInstance(ret, dict)
1961
def test_call_method_filters_objectpaths_in_dict_in_dict(self):
1962
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1964
return method_return
1965
fake_ravel = self.fake_ravel_func(func)
1966
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1968
ObjectPath("key1"): {
1969
ObjectPath("key11"): ObjectPath("value11"),
1970
ObjectPath("key12"): ObjectPath("value12"),
1972
ObjectPath("key2"): {
1973
ObjectPath("key21"): ObjectPath("value21"),
1974
ObjectPath("key22"): ObjectPath("value22"),
1977
ret = self.call_method(bus, "methodname", "busname",
1978
"objectpath", "interface")
1979
expected_method_return = {
1980
"key1": {"key11": "value11",
1981
"key12": "value12"},
1982
"key2": {"key21": "value21",
1983
"key22": "value22"},
1985
self.assertEqual(expected_method_return, ret)
1986
for key, value in ret.items():
1987
self.assertIsInstance(value, dict)
1988
self.assertEqual(expected_method_return[key], value)
1989
self.assertNotIsInstance(key, ObjectPath)
1990
for inner_key, inner_value in value.items():
1991
self.assertIsInstance(value, dict)
1993
expected_method_return[key][inner_key],
1995
self.assertNotIsInstance(key, ObjectPath)
1997
def test_call_method_filters_objectpaths_in_dict_three_deep(self):
1998
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
2000
return method_return
2001
fake_ravel = self.fake_ravel_func(func)
2002
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2004
ObjectPath("key1"): {
2005
ObjectPath("key2"): {
2006
ObjectPath("key3"): ObjectPath("value"),
2010
ret = self.call_method(bus, "methodname", "busname",
2011
"objectpath", "interface")
2012
expected_method_return = {"key1": {"key2": {"key3": "value"}}}
2013
self.assertEqual(expected_method_return, ret)
2014
self.assertIsInstance(ret, dict)
2015
self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
2016
self.assertIsInstance(ret["key1"], dict)
2017
self.assertNotIsInstance(next(iter(ret["key1"].keys())),
2019
self.assertIsInstance(ret["key1"]["key2"], dict)
2020
self.assertNotIsInstance(
2021
next(iter(ret["key1"]["key2"].keys())),
2023
self.assertEqual("value", ret["key1"]["key2"]["key3"])
2024
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
2025
self.dummy_dbussy.DBUS.ObjectPath)
2027
def test_call_method_handles_exception(self):
2029
raise self.dummy_dbussy.DBusError()
2031
fake_ravel = self.fake_ravel_func(func)
2032
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2034
with self.assertRaises(dbus.Error) as e:
2035
self.call_method(bus, "methodname", "busname",
2036
"objectpath", "interface")
2038
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
2040
def test_get_object_converts_to_correct_exception(self):
2041
class fake_ravel_raises_exception_on_connect:
2046
def __getitem__(key):
2047
if key == "objectpath":
2048
raise self.dummy_dbussy.DBusError()
2049
raise Exception(key)
2050
return {"busname": Bus()}
2052
raise self.dummy_dbussy.DBusError()
2053
bus = dbussy_adapter.SystemBus(
2055
fake_ravel_raises_exception_on_connect)
2056
with self.assertRaises(dbus.ConnectFailed):
2057
self.call_method(bus, "methodname", "busname",
2058
"objectpath", "interface")
1154
2061
class Test_commands_from_options(unittest.TestCase):
1155
2063
def setUp(self):
1156
2064
self.parser = argparse.ArgumentParser()
1157
2065
add_command_line_options(self.parser)
2291
def test_manual_page_example_1(self):
2292
self.assert_command_from_args("",
2297
def test_manual_page_example_2(self):
2298
self.assert_command_from_args(
2299
"--verbose foo1.example.org foo2.example.org".split(),
2300
command.PrintTable, clients=["foo1.example.org",
2301
"foo2.example.org"],
2304
def test_manual_page_example_3(self):
2305
self.assert_command_from_args("--enable --all".split(),
2309
def test_manual_page_example_4(self):
2310
self.assert_commands_from_args(
2311
("--timeout=PT5M --interval=PT1M foo1.example.org"
2312
" foo2.example.org").split(),
2313
[command.SetTimeout, command.SetInterval],
2314
clients=["foo1.example.org", "foo2.example.org"])
2316
def test_manual_page_example_5(self):
2317
self.assert_command_from_args("--approve --all".split(),
1372
2322
class TestCommand(unittest.TestCase):
1373
2323
"""Abstract class for tests of command classes"""
2325
class FakeMandosBus(dbus.MandosBus):
2326
def __init__(self, testcase):
2327
self.client_properties = {
2329
"KeyID": ("92ed150794387c03ce684574b1139a65"
2330
"94a34f895daaaf09fd8ea90a27cddb12"),
2331
"Secret": b"secret",
2332
"Host": "foo.example.org",
2335
"LastCheckedOK": "2019-02-03T00:00:00",
2336
"Created": "2019-01-02T00:00:00",
2338
"Fingerprint": ("778827225BA7DE539C5A"
2339
"7CFA59CFF7CDBD9A5920"),
2340
"CheckerRunning": False,
2341
"LastEnabled": "2019-01-03T00:00:00",
2342
"ApprovalPending": False,
2343
"ApprovedByDefault": True,
2344
"LastApprovalRequest": "",
2346
"ApprovalDuration": 1000,
2347
"Checker": "fping -q -- %(host)s",
2348
"ExtendedTimeout": 900000,
2349
"Expires": "2019-02-04T00:00:00",
2350
"LastCheckerStatus": 0,
2352
self.other_client_properties = {
2354
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2355
"6ab612cff5ad227247e46c2b020f441c"),
2356
"Secret": b"secretbar",
2357
"Host": "192.0.2.3",
2360
"LastCheckedOK": "2019-02-04T00:00:00",
2361
"Created": "2019-01-03T00:00:00",
2363
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2364
"F547B3A107558FCA3A27"),
2365
"CheckerRunning": True,
2366
"LastEnabled": "2019-01-04T00:00:00",
2367
"ApprovalPending": False,
2368
"ApprovedByDefault": False,
2369
"LastApprovalRequest": "2019-01-03T00:00:00",
2370
"ApprovalDelay": 30000,
2371
"ApprovalDuration": 93785000,
2373
"ExtendedTimeout": 900000,
2374
"Expires": "2019-02-05T00:00:00",
2375
"LastCheckerStatus": -2,
2377
self.clients = collections.OrderedDict(
2379
("client_objectpath", self.client_properties),
2380
("other_client_objectpath",
2381
self.other_client_properties),
2383
self.one_client = {"client_objectpath":
2384
self.client_properties}
2385
self.testcase = testcase
2388
def call_method(self, methodname, busname, objectpath,
2390
self.testcase.assertEqual("se.recompile.Mandos", busname)
2391
self.calls.append((methodname, busname, objectpath,
2393
if interface == "org.freedesktop.DBus.Properties":
2394
if methodname == "Set":
2395
self.testcase.assertEqual(3, len(args))
2396
interface, key, value = args
2397
self.testcase.assertEqual(
2398
"se.recompile.Mandos.Client", interface)
2399
self.clients[objectpath][key] = value
2401
elif interface == "se.recompile.Mandos":
2402
self.testcase.assertEqual("RemoveClient", methodname)
2403
self.testcase.assertEqual(1, len(args))
2404
clientpath = args[0]
2405
del self.clients[clientpath]
2407
elif interface == "se.recompile.Mandos.Client":
2408
if methodname == "Approve":
2409
self.testcase.assertEqual(1, len(args))
1375
2413
def setUp(self):
1377
class MockClient(object):
1378
def __init__(self, name, **attributes):
1379
self.__dbus_object_path__ = "/clients/{}".format(name)
1380
self.attributes = attributes
1381
self.attributes["Name"] = name
1383
def Set(self, interface, propname, value, dbus_interface):
1384
testcase.assertEqual(client_dbus_interface, interface)
1385
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1387
self.attributes[propname] = value
1388
def Approve(self, approve, dbus_interface):
1389
testcase.assertEqual(client_dbus_interface,
1391
self.calls.append(("Approve", (approve,
1393
self.client = MockClient(
1395
KeyID=("92ed150794387c03ce684574b1139a65"
1396
"94a34f895daaaf09fd8ea90a27cddb12"),
1398
Host="foo.example.org",
1399
Enabled=dbus.Boolean(True),
1401
LastCheckedOK="2019-02-03T00:00:00",
1402
Created="2019-01-02T00:00:00",
1404
Fingerprint=("778827225BA7DE539C5A"
1405
"7CFA59CFF7CDBD9A5920"),
1406
CheckerRunning=dbus.Boolean(False),
1407
LastEnabled="2019-01-03T00:00:00",
1408
ApprovalPending=dbus.Boolean(False),
1409
ApprovedByDefault=dbus.Boolean(True),
1410
LastApprovalRequest="",
1412
ApprovalDuration=1000,
1413
Checker="fping -q -- %(host)s",
1414
ExtendedTimeout=900000,
1415
Expires="2019-02-04T00:00:00",
1416
LastCheckerStatus=0)
1417
self.other_client = MockClient(
1419
KeyID=("0558568eedd67d622f5c83b35a115f79"
1420
"6ab612cff5ad227247e46c2b020f441c"),
1421
Secret=b"secretbar",
1423
Enabled=dbus.Boolean(True),
1425
LastCheckedOK="2019-02-04T00:00:00",
1426
Created="2019-01-03T00:00:00",
1428
Fingerprint=("3E393AEAEFB84C7E89E2"
1429
"F547B3A107558FCA3A27"),
1430
CheckerRunning=dbus.Boolean(True),
1431
LastEnabled="2019-01-04T00:00:00",
1432
ApprovalPending=dbus.Boolean(False),
1433
ApprovedByDefault=dbus.Boolean(False),
1434
LastApprovalRequest="2019-01-03T00:00:00",
1435
ApprovalDelay=30000,
1436
ApprovalDuration=93785000,
1438
ExtendedTimeout=900000,
1439
Expires="2019-02-05T00:00:00",
1440
LastCheckerStatus=-2)
1441
self.clients = collections.OrderedDict(
1443
(self.client.__dbus_object_path__,
1444
self.client.attributes),
1445
(self.other_client.__dbus_object_path__,
1446
self.other_client.attributes),
1448
self.one_client = {self.client.__dbus_object_path__:
1449
self.client.attributes}
1453
class MockBus(object):
1455
def get_object(client_bus_name, path):
1456
self.assertEqual(dbus_busname, client_bus_name)
1457
# Note: "self" here is the TestCmd instance, not the
1458
# MockBus instance, since this is a static method!
1459
if path == self.client.__dbus_object_path__:
1461
elif path == self.other_client.__dbus_object_path__:
1462
return self.other_client
2414
self.bus = self.FakeMandosBus(self)
1466
2417
class TestBaseCommands(TestCommand):
1468
2419
def test_IsEnabled_exits_successfully(self):
1469
2420
with self.assertRaises(SystemExit) as e:
1470
command.IsEnabled().run(self.one_client)
2421
command.IsEnabled().run(self.bus.one_client)
1471
2422
if e.exception.code is not None:
1472
2423
self.assertEqual(0, e.exception.code)
1474
2425
self.assertIsNone(e.exception.code)
1476
2427
def test_IsEnabled_exits_with_failure(self):
1477
self.client.attributes["Enabled"] = dbus.Boolean(False)
2428
self.bus.client_properties["Enabled"] = False
1478
2429
with self.assertRaises(SystemExit) as e:
1479
command.IsEnabled().run(self.one_client)
2430
command.IsEnabled().run(self.bus.one_client)
1480
2431
if isinstance(e.exception.code, int):
1481
2432
self.assertNotEqual(0, e.exception.code)
1483
2434
self.assertIsNotNone(e.exception.code)
1485
2436
def test_Approve(self):
1486
command.Approve().run(self.clients, self.bus)
1487
for clientpath in self.clients:
1488
client = self.bus.get_object(dbus_busname, clientpath)
1489
self.assertIn(("Approve", (True, client_dbus_interface)),
2437
busname = "se.recompile.Mandos"
2438
client_interface = "se.recompile.Mandos.Client"
2439
command.Approve().run(self.bus.clients, self.bus)
2440
for clientpath in self.bus.clients:
2441
self.assertIn(("Approve", busname, clientpath,
2442
client_interface, (True,)), self.bus.calls)
1492
2444
def test_Deny(self):
1493
command.Deny().run(self.clients, self.bus)
1494
for clientpath in self.clients:
1495
client = self.bus.get_object(dbus_busname, clientpath)
1496
self.assertIn(("Approve", (False, client_dbus_interface)),
2445
busname = "se.recompile.Mandos"
2446
client_interface = "se.recompile.Mandos.Client"
2447
command.Deny().run(self.bus.clients, self.bus)
2448
for clientpath in self.bus.clients:
2449
self.assertIn(("Approve", busname, clientpath,
2450
client_interface, (False,)),
1499
2453
def test_Remove(self):
1500
class MandosSpy(object):
1503
def RemoveClient(self, dbus_path):
1504
self.calls.append(("RemoveClient", (dbus_path,)))
1505
mandos = MandosSpy()
1506
command.Remove().run(self.clients, self.bus, mandos)
1507
for clientpath in self.clients:
1508
self.assertIn(("RemoveClient", (clientpath,)),
2454
command.Remove().run(self.bus.clients, self.bus)
2455
for clientpath in self.bus.clients:
2456
self.assertIn(("RemoveClient", dbus_busname,
2457
dbus_server_path, dbus_server_interface,
2458
(clientpath,)), self.bus.calls)
1511
2460
expected_json = {
1699
2648
self.assertEqual(expected_output, buffer.getvalue())
1702
class TestPropertyCmd(TestCommand):
1703
"""Abstract class for tests of command.Property classes"""
2651
class TestPropertySetterCmd(TestCommand):
2652
"""Abstract class for tests of command.PropertySetter classes"""
1704
2654
def runTest(self):
1705
2655
if not hasattr(self, "command"):
1707
values_to_get = getattr(self, "values_to_get",
1709
for value_to_set, value_to_get in zip(self.values_to_set,
1711
for clientpath in self.clients:
1712
client = self.bus.get_object(dbus_busname, clientpath)
1713
old_value = client.attributes[self.propname]
1714
client.attributes[self.propname] = self.Unique()
1715
self.run_command(value_to_set, self.clients)
1716
for clientpath in self.clients:
1717
client = self.bus.get_object(dbus_busname, clientpath)
1718
value = client.attributes[self.propname]
1719
self.assertNotIsInstance(value, self.Unique)
2656
return # Abstract TestCase class
2658
if hasattr(self, "values_to_set"):
2659
cmd_args = [(value,) for value in self.values_to_set]
2660
values_to_get = getattr(self, "values_to_get",
2663
cmd_args = [() for x in range(len(self.values_to_get))]
2664
values_to_get = self.values_to_get
2665
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2666
for clientpath in self.bus.clients:
2667
self.bus.clients[clientpath][self.propname] = (
2669
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2670
for clientpath in self.bus.clients:
2671
value = (self.bus.clients[clientpath]
2673
self.assertNotIsInstance(value, Unique)
1720
2674
self.assertEqual(value_to_get, value)
1722
class Unique(object):
1723
"""Class for objects which exist only to be unique objects,
1724
since unittest.mock.sentinel only exists in Python 3.3"""
1726
def run_command(self, value, clients):
1727
self.command().run(clients, self.bus)
1730
class TestEnableCmd(TestPropertyCmd):
2677
class TestEnableCmd(TestPropertySetterCmd):
1731
2678
command = command.Enable
1732
2679
propname = "Enabled"
1733
values_to_set = [dbus.Boolean(True)]
1736
class TestDisableCmd(TestPropertyCmd):
2680
values_to_get = [True]
2683
class TestDisableCmd(TestPropertySetterCmd):
1737
2684
command = command.Disable
1738
2685
propname = "Enabled"
1739
values_to_set = [dbus.Boolean(False)]
1742
class TestBumpTimeoutCmd(TestPropertyCmd):
2686
values_to_get = [False]
2689
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1743
2690
command = command.BumpTimeout
1744
2691
propname = "LastCheckedOK"
1745
values_to_set = [""]
1748
class TestStartCheckerCmd(TestPropertyCmd):
2692
values_to_get = [""]
2695
class TestStartCheckerCmd(TestPropertySetterCmd):
1749
2696
command = command.StartChecker
1750
2697
propname = "CheckerRunning"
1751
values_to_set = [dbus.Boolean(True)]
1754
class TestStopCheckerCmd(TestPropertyCmd):
2698
values_to_get = [True]
2701
class TestStopCheckerCmd(TestPropertySetterCmd):
1755
2702
command = command.StopChecker
1756
2703
propname = "CheckerRunning"
1757
values_to_set = [dbus.Boolean(False)]
1760
class TestApproveByDefaultCmd(TestPropertyCmd):
2704
values_to_get = [False]
2707
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1761
2708
command = command.ApproveByDefault
1762
2709
propname = "ApprovedByDefault"
1763
values_to_set = [dbus.Boolean(True)]
1766
class TestDenyByDefaultCmd(TestPropertyCmd):
2710
values_to_get = [True]
2713
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1767
2714
command = command.DenyByDefault
1768
2715
propname = "ApprovedByDefault"
1769
values_to_set = [dbus.Boolean(False)]
1772
class TestPropertyValueCmd(TestPropertyCmd):
1773
"""Abstract class for tests of PropertyValueCmd classes"""
1776
if type(self) is TestPropertyValueCmd:
1778
return super(TestPropertyValueCmd, self).runTest()
1780
def run_command(self, value, clients):
1781
self.command(value).run(clients, self.bus)
1784
class TestSetCheckerCmd(TestPropertyValueCmd):
2716
values_to_get = [False]
2719
class TestSetCheckerCmd(TestPropertySetterCmd):
1785
2720
command = command.SetChecker
1786
2721
propname = "Checker"
1787
2722
values_to_set = ["", ":", "fping -q -- %s"]
1790
class TestSetHostCmd(TestPropertyValueCmd):
2725
class TestSetHostCmd(TestPropertySetterCmd):
1791
2726
command = command.SetHost
1792
2727
propname = "Host"
1793
2728
values_to_set = ["192.0.2.3", "client.example.org"]
1796
class TestSetSecretCmd(TestPropertyValueCmd):
2731
class TestSetSecretCmd(TestPropertySetterCmd):
1797
2732
command = command.SetSecret
1798
2733
propname = "Secret"
1799
2734
values_to_set = [io.BytesIO(b""),