437
def check_option_syntax(parser, options):
438
"""Apply additional restrictions on options, not expressible in
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)
465
if has_commands(options) and not (options.client or options.all):
271
class TableOfClients(object):
274
"Enabled": "Enabled",
275
"Timeout": "Timeout",
276
"LastCheckedOK": "Last Successful Check",
277
"LastApprovalRequest": "Last Approval Request",
278
"Created": "Created",
279
"Interval": "Interval",
281
"Fingerprint": "Fingerprint",
283
"CheckerRunning": "Check Is Running",
284
"LastEnabled": "Last Enabled",
285
"ApprovalPending": "Approval Is Pending",
286
"ApprovedByDefault": "Approved By Default",
287
"ApprovalDelay": "Approval Delay",
288
"ApprovalDuration": "Approval Duration",
289
"Checker": "Checker",
290
"ExtendedTimeout": "Extended Timeout",
291
"Expires": "Expires",
292
"LastCheckerStatus": "Last Checker Status",
295
def __init__(self, clients, keywords, tableheaders=None):
296
self.clients = clients
297
self.keywords = keywords
298
if tableheaders is not None:
299
self.tableheaders = tableheaders
302
return "\n".join(self.rows())
304
if sys.version_info.major == 2:
305
__unicode__ = __str__
307
return str(self).encode(locale.getpreferredencoding())
310
format_string = self.row_formatting_string()
311
rows = [self.header_line(format_string)]
312
rows.extend(self.client_line(client, format_string)
313
for client in self.clients)
316
def row_formatting_string(self):
317
"Format string used to format table rows"
318
return " ".join("{{{key}:{width}}}".format(
319
width=max(len(self.tableheaders[key]),
320
*(len(self.string_from_client(client, key))
321
for client in self.clients)),
323
for key in self.keywords)
325
def string_from_client(self, client, key):
326
return self.valuetostring(client[key], key)
329
def valuetostring(value, keyword):
330
if isinstance(value, dbus.Boolean):
331
return "Yes" if value else "No"
332
if keyword in ("Timeout", "Interval", "ApprovalDelay",
333
"ApprovalDuration", "ExtendedTimeout"):
334
return milliseconds_to_string(value)
337
def header_line(self, format_string):
338
return format_string.format(**self.tableheaders)
340
def client_line(self, client, format_string):
341
return format_string.format(
342
**{key: self.string_from_client(client, key)
343
for key in self.keywords})
346
## Classes for commands.
348
# Abstract classes first
349
class Command(object):
350
"""Abstract class for commands"""
351
def run(self, mandos, clients):
352
"""Normal commands should implement run_on_one_client(), but
353
commands which want to operate on all clients at the same time
354
can override this run() method instead."""
356
for client in clients:
357
self.run_on_one_client(client)
359
class PrintCmd(Command):
360
"""Abstract class for commands printing client details"""
361
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
362
"Created", "Interval", "Host", "KeyID",
363
"Fingerprint", "CheckerRunning", "LastEnabled",
364
"ApprovalPending", "ApprovedByDefault",
365
"LastApprovalRequest", "ApprovalDelay",
366
"ApprovalDuration", "Checker", "ExtendedTimeout",
367
"Expires", "LastCheckerStatus")
368
def run(self, mandos, clients):
369
print(self.output(clients))
371
class PropertyCmd(Command):
372
"""Abstract class for Actions for setting one client property"""
373
def run_on_one_client(self, client):
374
"""Set the Client's D-Bus property"""
375
client.Set(client_interface, self.property, self.value_to_set,
376
dbus_interface=dbus.PROPERTIES_IFACE)
378
class ValueArgumentMixIn(object):
379
"""Mixin class for commands taking a value as argument"""
380
def __init__(self, value):
381
self.value_to_set = value
383
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
384
"""Mixin class for commands taking a value argument as
387
def value_to_set(self):
390
def value_to_set(self, value):
391
"""When setting, convert value to a datetime.timedelta"""
392
self._vts = string_to_delta(value).total_seconds() * 1000
394
# Actual (non-abstract) command classes
396
class PrintTableCmd(PrintCmd):
397
def __init__(self, verbose=False):
398
self.verbose = verbose
399
def output(self, clients):
401
keywords = self.all_keywords
403
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
404
return str(TableOfClients(clients.values(), keywords))
406
class DumpJSONCmd(PrintCmd):
407
def output(self, clients):
408
data = {client["Name"]:
409
{key: self.dbus_boolean_to_bool(client[key])
410
for key in self.all_keywords}
411
for client in clients.values()}
412
return json.dumps(data, indent=4, separators=(',', ': '))
414
def dbus_boolean_to_bool(value):
415
if isinstance(value, dbus.Boolean):
419
class IsEnabledCmd(Command):
420
def run_on_one_client(self, client):
421
if self.is_enabled(client):
424
def is_enabled(self, client):
425
return client.Get(client_interface, "Enabled",
426
dbus_interface=dbus.PROPERTIES_IFACE)
428
class RemoveCmd(Command):
429
def run_on_one_client(self, client):
430
self.mandos.RemoveClient(client.__dbus_object_path__)
432
class ApproveCmd(Command):
433
def run_on_one_client(self, client):
434
client.Approve(dbus.Boolean(True),
435
dbus_interface=client_interface)
437
class DenyCmd(Command):
438
def run_on_one_client(self, client):
439
client.Approve(dbus.Boolean(False),
440
dbus_interface=client_interface)
442
class EnableCmd(PropertyCmd):
444
value_to_set = dbus.Boolean(True)
446
class DisableCmd(PropertyCmd):
448
value_to_set = dbus.Boolean(False)
450
class BumpTimeoutCmd(PropertyCmd):
451
property = "LastCheckedOK"
454
class StartCheckerCmd(PropertyCmd):
455
property = "CheckerRunning"
456
value_to_set = dbus.Boolean(True)
458
class StopCheckerCmd(PropertyCmd):
459
property = "CheckerRunning"
460
value_to_set = dbus.Boolean(False)
462
class ApproveByDefaultCmd(PropertyCmd):
463
property = "ApprovedByDefault"
464
value_to_set = dbus.Boolean(True)
466
class DenyByDefaultCmd(PropertyCmd):
467
property = "ApprovedByDefault"
468
value_to_set = dbus.Boolean(False)
470
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
473
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
476
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
479
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
482
class SetExtendedTimeoutCmd(PropertyCmd,
483
MillisecondsValueArgumentMixIn):
484
property = "ExtendedTimeout"
486
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
487
property = "Interval"
489
class SetApprovalDelayCmd(PropertyCmd,
490
MillisecondsValueArgumentMixIn):
491
property = "ApprovalDelay"
493
class SetApprovalDurationCmd(PropertyCmd,
494
MillisecondsValueArgumentMixIn):
495
property = "ApprovalDuration"
497
def has_actions(options):
498
return any((options.enable,
500
options.bump_timeout,
501
options.start_checker,
502
options.stop_checker,
505
options.checker is not None,
506
options.timeout is not None,
507
options.extended_timeout is not None,
508
options.interval is not None,
509
options.approved_by_default is not None,
510
options.approval_delay is not None,
511
options.approval_duration is not None,
512
options.host is not None,
513
options.secret is not None,
518
def commands_and_clients_from_options(args=None):
521
parser = argparse.ArgumentParser()
522
parser.add_argument("--version", action="version",
523
version="%(prog)s {}".format(version),
524
help="show version number and exit")
525
parser.add_argument("-a", "--all", action="store_true",
526
help="Select all clients")
527
parser.add_argument("-v", "--verbose", action="store_true",
528
help="Print all fields")
529
parser.add_argument("-j", "--dump-json", action="store_true",
530
help="Dump client data in JSON format")
531
enable_disable = parser.add_mutually_exclusive_group()
532
enable_disable.add_argument("-e", "--enable", action="store_true",
533
help="Enable client")
534
enable_disable.add_argument("-d", "--disable",
536
help="disable client")
537
parser.add_argument("-b", "--bump-timeout", action="store_true",
538
help="Bump timeout for client")
539
start_stop_checker = parser.add_mutually_exclusive_group()
540
start_stop_checker.add_argument("--start-checker",
542
help="Start checker for client")
543
start_stop_checker.add_argument("--stop-checker",
545
help="Stop checker for client")
546
parser.add_argument("-V", "--is-enabled", action="store_true",
547
help="Check if client is enabled")
548
parser.add_argument("-r", "--remove", action="store_true",
549
help="Remove client")
550
parser.add_argument("-c", "--checker",
551
help="Set checker command for client")
552
parser.add_argument("-t", "--timeout",
553
help="Set timeout for client")
554
parser.add_argument("--extended-timeout",
555
help="Set extended timeout for client")
556
parser.add_argument("-i", "--interval",
557
help="Set checker interval for client")
558
approve_deny_default = parser.add_mutually_exclusive_group()
559
approve_deny_default.add_argument(
560
"--approve-by-default", action="store_true",
561
default=None, dest="approved_by_default",
562
help="Set client to be approved by default")
563
approve_deny_default.add_argument(
564
"--deny-by-default", action="store_false",
565
dest="approved_by_default",
566
help="Set client to be denied by default")
567
parser.add_argument("--approval-delay",
568
help="Set delay before client approve/deny")
569
parser.add_argument("--approval-duration",
570
help="Set duration of one client approval")
571
parser.add_argument("-H", "--host", help="Set host for client")
572
parser.add_argument("-s", "--secret",
573
type=argparse.FileType(mode="rb"),
574
help="Set password blob (file) for client")
575
approve_deny = parser.add_mutually_exclusive_group()
576
approve_deny.add_argument(
577
"-A", "--approve", action="store_true",
578
help="Approve any current client request")
579
approve_deny.add_argument("-D", "--deny", action="store_true",
580
help="Deny any current client request")
581
parser.add_argument("--check", action="store_true",
582
help="Run self-test")
583
parser.add_argument("client", nargs="*", help="Client name")
584
options = parser.parse_args(args=args)
586
if has_actions(options) and not (options.client or options.all):
466
587
parser.error("Options require clients names or --all.")
467
if options.verbose and has_commands(options):
588
if options.verbose and has_actions(options):
468
589
parser.error("--verbose can only be used alone.")
469
if (has_commands(options, (command.DumpJSON,))
470
and (options.verbose or len(options.commands) > 1)):
590
if options.dump_json and (options.verbose
591
or has_actions(options)):
471
592
parser.error("--dump-json can only be used alone.")
472
if options.all and not has_commands(options):
593
if options.all and not has_actions(options):
473
594
parser.error("--all requires an action.")
474
if (has_commands(options, (command.IsEnabled,))
475
and len(options.client) > 1):
476
parser.error("--is-enabled requires exactly one client")
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
787
def commands_from_options(options):
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)
595
if options.is_enabled and len(options.client) > 1:
596
parser.error("--is-enabled requires exactly one client")
600
if options.dump_json:
601
commands.append(DumpJSONCmd())
604
commands.append(EnableCmd())
607
commands.append(DisableCmd())
609
if options.bump_timeout:
610
commands.append(BumpTimeoutCmd(options.bump_timeout))
612
if options.start_checker:
613
commands.append(StartCheckerCmd())
615
if options.stop_checker:
616
commands.append(StopCheckerCmd())
618
if options.is_enabled:
619
commands.append(IsEnabledCmd())
622
commands.append(RemoveCmd())
624
if options.checker is not None:
625
commands.append(SetCheckerCmd())
627
if options.timeout is not None:
628
commands.append(SetTimeoutCmd(options.timeout))
630
if options.extended_timeout:
632
SetExtendedTimeoutCmd(options.extended_timeout))
634
if options.interval is not None:
635
command.append(SetIntervalCmd(options.interval))
637
if options.approved_by_default is not None:
638
if options.approved_by_default:
639
command.append(ApproveByDefaultCmd())
808
cleaned_after.append(cmd)
809
if cleaned_after != after_remove:
810
commands = before_remove + cleaned_after
641
command.append(DenyByDefaultCmd())
643
if options.approval_delay is not None:
644
command.append(SetApprovalDelayCmd(options.approval_delay))
646
if options.approval_duration is not None:
648
SetApprovalDurationCmd(options.approval_duration))
650
if options.host is not None:
651
command.append(SetHostCmd(options.host))
653
if options.secret is not None:
654
command.append(SetSecretCmd(options.secret))
657
commands.append(ApproveCmd())
660
commands.append(DenyCmd())
812
662
# If no command option has been given, show table of clients,
813
663
# optionally verbosely
815
commands.append(command.PrintTable(verbose=options.verbose))
821
"""A namespace for command classes"""
824
"""Abstract base class for commands"""
825
def run(self, clients, bus=None):
826
"""Normal commands should implement run_on_one_client(),
827
but commands which want to operate on all clients at the same time can
828
override this run() method instead.
831
for client, properties in clients.items():
832
self.run_on_one_client(client, properties)
835
class IsEnabled(Base):
836
def run(self, clients, bus=None):
837
properties = next(iter(clients.values()))
838
if properties["Enabled"]:
844
def run_on_one_client(self, client, properties):
845
self.bus.call_client_method(client, "Approve", True)
849
def run_on_one_client(self, client, properties):
850
self.bus.call_client_method(client, "Approve", False)
854
def run(self, clients, bus):
855
for clientpath in frozenset(clients.keys()):
856
bus.call_server_method("RemoveClient", clientpath)
860
"""Abstract class for commands outputting client details"""
861
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
862
"Created", "Interval", "Host", "KeyID",
863
"Fingerprint", "CheckerRunning",
864
"LastEnabled", "ApprovalPending",
865
"ApprovedByDefault", "LastApprovalRequest",
866
"ApprovalDelay", "ApprovalDuration",
867
"Checker", "ExtendedTimeout", "Expires",
871
class DumpJSON(Output):
872
def run(self, clients, bus=None):
873
data = {properties["Name"]:
874
{key: properties[key]
875
for key in self.all_keywords}
876
for properties in clients.values()}
877
print(json.dumps(data, indent=4, separators=(',', ': ')))
880
class PrintTable(Output):
881
def __init__(self, verbose=False):
882
self.verbose = verbose
884
def run(self, clients, bus=None):
885
default_keywords = ("Name", "Enabled", "Timeout",
887
keywords = default_keywords
889
keywords = self.all_keywords
890
print(self.TableOfClients(clients.values(), keywords))
892
class TableOfClients:
895
"Enabled": "Enabled",
896
"Timeout": "Timeout",
897
"LastCheckedOK": "Last Successful Check",
898
"LastApprovalRequest": "Last Approval Request",
899
"Created": "Created",
900
"Interval": "Interval",
902
"Fingerprint": "Fingerprint",
904
"CheckerRunning": "Check Is Running",
905
"LastEnabled": "Last Enabled",
906
"ApprovalPending": "Approval Is Pending",
907
"ApprovedByDefault": "Approved By Default",
908
"ApprovalDelay": "Approval Delay",
909
"ApprovalDuration": "Approval Duration",
910
"Checker": "Checker",
911
"ExtendedTimeout": "Extended Timeout",
912
"Expires": "Expires",
913
"LastCheckerStatus": "Last Checker Status",
916
def __init__(self, clients, keywords):
917
self.clients = clients
918
self.keywords = keywords
921
return "\n".join(self.rows())
923
if sys.version_info.major == 2:
924
__unicode__ = __str__
926
return str(self).encode(
927
locale.getpreferredencoding())
930
format_string = self.row_formatting_string()
931
rows = [self.header_line(format_string)]
932
rows.extend(self.client_line(client, format_string)
933
for client in self.clients)
936
def row_formatting_string(self):
937
"Format string used to format table rows"
938
return " ".join("{{{key}:{width}}}".format(
939
width=max(len(self.tableheaders[key]),
940
*(len(self.string_from_client(client,
942
for client in self.clients)),
944
for key in self.keywords)
946
def string_from_client(self, client, key):
947
return self.valuetostring(client[key], key)
950
def valuetostring(cls, value, keyword):
951
if isinstance(value, bool):
952
return "Yes" if value else "No"
953
if keyword in ("Timeout", "Interval", "ApprovalDelay",
954
"ApprovalDuration", "ExtendedTimeout"):
955
return cls.milliseconds_to_string(value)
958
def header_line(self, format_string):
959
return format_string.format(**self.tableheaders)
961
def client_line(self, client, format_string):
962
return format_string.format(
963
**{key: self.string_from_client(client, key)
964
for key in self.keywords})
967
def milliseconds_to_string(ms):
968
td = datetime.timedelta(0, 0, 0, ms)
969
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
970
.format(days="{}T".format(td.days)
972
hours=td.seconds // 3600,
973
minutes=(td.seconds % 3600) // 60,
974
seconds=td.seconds % 60))
977
class PropertySetter(Base):
978
"Abstract class for Actions for setting one client property"
980
def run_on_one_client(self, client, properties=None):
981
"""Set the Client's D-Bus property"""
982
self.bus.set_client_property(client, self.propname,
987
raise NotImplementedError()
990
class Enable(PropertySetter):
995
class Disable(PropertySetter):
1000
class BumpTimeout(PropertySetter):
1001
propname = "LastCheckedOK"
1005
class StartChecker(PropertySetter):
1006
propname = "CheckerRunning"
1010
class StopChecker(PropertySetter):
1011
propname = "CheckerRunning"
1012
value_to_set = False
1015
class ApproveByDefault(PropertySetter):
1016
propname = "ApprovedByDefault"
1020
class DenyByDefault(PropertySetter):
1021
propname = "ApprovedByDefault"
1022
value_to_set = False
1025
class PropertySetterValue(PropertySetter):
1026
"""Abstract class for PropertySetter recieving a value as
1027
constructor argument instead of a class attribute."""
1028
def __init__(self, value):
1029
self.value_to_set = value
1032
def argparse(cls, argtype):
1034
return cls(argtype(arg))
1037
class SetChecker(PropertySetterValue):
1038
propname = "Checker"
1041
class SetHost(PropertySetterValue):
1045
class SetSecret(PropertySetterValue):
1049
def value_to_set(self):
1052
@value_to_set.setter
1053
def value_to_set(self, value):
1054
"""When setting, read data from supplied file object"""
1055
self._vts = value.read()
1059
class PropertySetterValueMilliseconds(PropertySetterValue):
1060
"""Abstract class for PropertySetterValue taking a value
1061
argument as a datetime.timedelta() but should store it as
1065
def value_to_set(self):
1068
@value_to_set.setter
1069
def value_to_set(self, value):
1070
"When setting, convert value from a datetime.timedelta"
1071
self._vts = int(round(value.total_seconds() * 1000))
1074
class SetTimeout(PropertySetterValueMilliseconds):
1075
propname = "Timeout"
1078
class SetExtendedTimeout(PropertySetterValueMilliseconds):
1079
propname = "ExtendedTimeout"
1082
class SetInterval(PropertySetterValueMilliseconds):
1083
propname = "Interval"
1086
class SetApprovalDelay(PropertySetterValueMilliseconds):
1087
propname = "ApprovalDelay"
1090
class SetApprovalDuration(PropertySetterValueMilliseconds):
1091
propname = "ApprovalDuration"
665
commands.append(PrintTableCmd(verbose=options.verbose))
667
return commands, options.client
671
commands, clientnames = commands_and_clients_from_options()
674
bus = dbus.SystemBus()
675
mandos_dbus_objc = bus.get_object(busname, server_path)
676
except dbus.exceptions.DBusException:
677
log.critical("Could not connect to Mandos server")
680
mandos_serv = dbus.Interface(mandos_dbus_objc,
681
dbus_interface=server_interface)
682
mandos_serv_object_manager = dbus.Interface(
683
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
685
# Filter out log message from dbus module
686
dbus_logger = logging.getLogger("dbus.proxies")
687
class NullFilter(logging.Filter):
688
def filter(self, record):
690
dbus_filter = NullFilter()
691
dbus_logger.addFilter(dbus_filter)
694
mandos_clients = {path: ifs_and_props[client_interface]
695
for path, ifs_and_props in
696
mandos_serv_object_manager
697
.GetManagedObjects().items()
698
if client_interface in ifs_and_props}
700
# restore dbus logger
701
dbus_logger.removeFilter(dbus_filter)
702
except dbus.exceptions.DBusException as e:
703
log.critical("Failed to access Mandos server through D-Bus:"
707
# Compile dict of (clients: properties) to process
711
clients = {bus.get_object(busname, path): properties
712
for path, properties in mandos_clients.items()}
714
for name in clientnames:
715
for path, client in mandos_clients.items():
716
if client["Name"] == name:
717
client_objc = bus.get_object(busname, path)
718
clients[client_objc] = client
721
log.critical("Client not found on server: %r", name)
724
# Run all commands on clients
725
for command in commands:
726
command.run(mandos_serv, clients)
1095
class TestCaseWithAssertLogs(unittest.TestCase):
1096
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
1098
if not hasattr(unittest.TestCase, "assertLogs"):
1099
@contextlib.contextmanager
1100
def assertLogs(self, logger, level=logging.INFO):
1101
capturing_handler = self.CapturingLevelHandler(level)
1102
old_level = logger.level
1103
old_propagate = logger.propagate
1104
logger.addHandler(capturing_handler)
1105
logger.setLevel(level)
1106
logger.propagate = False
1108
yield capturing_handler.watcher
1110
logger.propagate = old_propagate
1111
logger.removeHandler(capturing_handler)
1112
logger.setLevel(old_level)
1113
self.assertGreater(len(capturing_handler.watcher.records),
1116
class CapturingLevelHandler(logging.Handler):
1117
def __init__(self, level, *args, **kwargs):
1118
logging.Handler.__init__(self, *args, **kwargs)
1119
self.watcher = self.LoggingWatcher([], [])
1120
def emit(self, record):
1121
self.watcher.records.append(record)
1122
self.watcher.output.append(self.format(record))
1124
LoggingWatcher = collections.namedtuple("LoggingWatcher",
1130
"""Class for objects which exist only to be unique objects, since
1131
unittest.mock.sentinel only exists in Python 3.3"""
1134
class Test_string_to_delta(TestCaseWithAssertLogs):
1135
# Just test basic RFC 3339 functionality here, the doc string for
1136
# rfc3339_duration_to_delta() already has more comprehensive
1137
# tests, which are run by doctest.
1139
def test_rfc3339_zero_seconds(self):
1140
self.assertEqual(datetime.timedelta(),
1141
string_to_delta("PT0S"))
1143
def test_rfc3339_zero_days(self):
1144
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1146
def test_rfc3339_one_second(self):
1147
self.assertEqual(datetime.timedelta(0, 1),
1148
string_to_delta("PT1S"))
1150
def test_rfc3339_two_hours(self):
1151
self.assertEqual(datetime.timedelta(0, 7200),
1152
string_to_delta("PT2H"))
729
class Test_milliseconds_to_string(unittest.TestCase):
731
self.assertEqual(milliseconds_to_string(93785000),
733
def test_no_days(self):
734
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
735
def test_all_zero(self):
736
self.assertEqual(milliseconds_to_string(0), "00:00:00")
737
def test_no_fractional_seconds(self):
738
self.assertEqual(milliseconds_to_string(400), "00:00:00")
739
self.assertEqual(milliseconds_to_string(900), "00:00:00")
740
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
742
class Test_string_to_delta(unittest.TestCase):
743
def test_handles_basic_rfc3339(self):
744
self.assertEqual(string_to_delta("PT2H"),
745
datetime.timedelta(0, 7200))
1154
746
def test_falls_back_to_pre_1_6_1_with_warning(self):
1155
with self.assertLogs(log, logging.WARNING):
1156
value = string_to_delta("2h")
1157
self.assertEqual(datetime.timedelta(0, 7200), value)
1160
class Test_check_option_syntax(unittest.TestCase):
1162
self.parser = argparse.ArgumentParser()
1163
add_command_line_options(self.parser)
1165
def test_actions_requires_client_or_all(self):
1166
for action, value in self.actions.items():
1167
args = self.actionargs(action, value)
1168
with self.assertParseError():
1169
self.parse_args(args)
1171
# This mostly corresponds to the definition from has_commands() in
1172
# check_option_syntax()
1176
"--bump-timeout": None,
1177
"--start-checker": None,
1178
"--stop-checker": None,
1179
"--is-enabled": None,
1182
"--timeout": "PT0S",
1183
"--extended-timeout": "PT0S",
1184
"--interval": "PT0S",
1185
"--approve-by-default": None,
1186
"--deny-by-default": None,
1187
"--approval-delay": "PT0S",
1188
"--approval-duration": "PT0S",
1189
"--host": "hostname",
1190
"--secret": "/dev/null",
1196
def actionargs(action, value, *args):
1197
if value is not None:
1198
return [action, value] + list(args)
747
# assertLogs only exists in Python 3.4
748
if hasattr(self, "assertLogs"):
749
with self.assertLogs(log, logging.WARNING):
750
value = string_to_delta("2h")
1200
return [action] + list(args)
1202
@contextlib.contextmanager
1203
def assertParseError(self):
1204
with self.assertRaises(SystemExit) as e:
1205
with self.redirect_stderr_to_devnull():
1207
# Exit code from argparse is guaranteed to be "2". Reference:
1208
# https://docs.python.org/3/library
1209
# /argparse.html#exiting-methods
1210
self.assertEqual(2, e.exception.code)
1212
def parse_args(self, args):
1213
options = self.parser.parse_args(args)
1214
check_option_syntax(self.parser, options)
1217
@contextlib.contextmanager
1218
def redirect_stderr_to_devnull():
1219
old_stderr = sys.stderr
1220
with contextlib.closing(open(os.devnull, "w")) as null:
752
class WarningFilter(logging.Filter):
753
"""Don't show, but record the presence of, warnings"""
754
def filter(self, record):
755
is_warning = record.levelno >= logging.WARNING
756
self.found = is_warning or getattr(self, "found",
758
return not is_warning
759
warning_filter = WarningFilter()
760
log.addFilter(warning_filter)
762
value = string_to_delta("2h")
1225
sys.stderr = old_stderr
1227
def check_option_syntax(self, options):
1228
check_option_syntax(self.parser, options)
1230
def test_actions_all_conflicts_with_verbose(self):
1231
for action, value in self.actions.items():
1232
args = self.actionargs(action, value, "--all",
1234
with self.assertParseError():
1235
self.parse_args(args)
1237
def test_actions_with_client_conflicts_with_verbose(self):
1238
for action, value in self.actions.items():
1239
args = self.actionargs(action, value, "--verbose",
1241
with self.assertParseError():
1242
self.parse_args(args)
1244
def test_dump_json_conflicts_with_verbose(self):
1245
args = ["--dump-json", "--verbose"]
1246
with self.assertParseError():
1247
self.parse_args(args)
1249
def test_dump_json_conflicts_with_action(self):
1250
for action, value in self.actions.items():
1251
args = self.actionargs(action, value, "--dump-json")
1252
with self.assertParseError():
1253
self.parse_args(args)
1255
def test_all_can_not_be_alone(self):
1257
with self.assertParseError():
1258
self.parse_args(args)
1260
def test_all_is_ok_with_any_action(self):
1261
for action, value in self.actions.items():
1262
args = self.actionargs(action, value, "--all")
1263
self.parse_args(args)
1265
def test_any_action_is_ok_with_one_client(self):
1266
for action, value in self.actions.items():
1267
args = self.actionargs(action, value, "client")
1268
self.parse_args(args)
1270
def test_one_client_with_all_actions_except_is_enabled(self):
1271
for action, value in self.actions.items():
1272
if action == "--is-enabled":
1274
args = self.actionargs(action, value, "client")
1275
self.parse_args(args)
1277
def test_two_clients_with_all_actions_except_is_enabled(self):
1278
for action, value in self.actions.items():
1279
if action == "--is-enabled":
1281
args = self.actionargs(action, value, "client1",
1283
self.parse_args(args)
1285
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1286
for action, value in self.actions.items():
1287
if action == "--is-enabled":
1289
args = self.actionargs(action, value, "client1",
1291
self.parse_args(args)
1293
def test_is_enabled_fails_without_client(self):
1294
args = ["--is-enabled"]
1295
with self.assertParseError():
1296
self.parse_args(args)
1298
def test_is_enabled_fails_with_two_clients(self):
1299
args = ["--is-enabled", "client1", "client2"]
1300
with self.assertParseError():
1301
self.parse_args(args)
1303
def test_remove_can_only_be_combined_with_action_deny(self):
1304
for action, value in self.actions.items():
1305
if action in {"--remove", "--deny"}:
1307
args = self.actionargs(action, value, "--all",
1309
with self.assertParseError():
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):
1610
dbus_logger = logging.getLogger("dbus.proxies")
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)
1619
class CountingHandler(logging.Handler):
1621
def emit(self, record):
1624
counting_handler = CountingHandler()
1626
dbus_logger.addHandler(counting_handler)
1629
with self.assertRaises(dbus.Error) as e:
1630
self.call_method(bus, "methodname", "busname",
1631
"objectpath", "interface")
1633
dbus_logger.removeFilter(counting_handler)
1635
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1637
# Make sure the dbus logger was suppressed
1638
self.assertEqual(0, counting_handler.count)
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")
2061
class Test_commands_from_options(unittest.TestCase):
2064
self.parser = argparse.ArgumentParser()
2065
add_command_line_options(self.parser)
2067
def test_is_enabled(self):
2068
self.assert_command_from_args(["--is-enabled", "client"],
2071
def assert_command_from_args(self, args, command_cls, length=1,
2072
clients=None, **cmd_attrs):
2073
"""Assert that parsing ARGS should result in an instance of
2074
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
2075
options = self.parser.parse_args(args)
2076
check_option_syntax(self.parser, options)
2077
commands = commands_from_options(options)
2078
self.assertEqual(length, len(commands))
2079
for command in commands:
2080
if isinstance(command, command_cls):
2083
self.assertIsInstance(command, command_cls)
2084
if clients is not None:
2085
self.assertEqual(clients, options.client)
2086
for key, value in cmd_attrs.items():
2087
self.assertEqual(value, getattr(command, key))
2089
def assert_commands_from_args(self, args, commands, clients=None):
2090
for cmd in commands:
2091
self.assert_command_from_args(args, cmd,
2092
length=len(commands),
2095
def test_is_enabled_short(self):
2096
self.assert_command_from_args(["-V", "client"],
2099
def test_approve(self):
2100
self.assert_command_from_args(["--approve", "client"],
2103
def test_approve_short(self):
2104
self.assert_command_from_args(["-A", "client"],
2107
def test_deny(self):
2108
self.assert_command_from_args(["--deny", "client"],
2111
def test_deny_short(self):
2112
self.assert_command_from_args(["-D", "client"], command.Deny)
2114
def test_remove(self):
2115
self.assert_command_from_args(["--remove", "client"],
2118
def test_deny_before_remove(self):
2119
options = self.parser.parse_args(["--deny", "--remove",
2121
check_option_syntax(self.parser, options)
2122
commands = commands_from_options(options)
2123
self.assertEqual(2, len(commands))
2124
self.assertIsInstance(commands[0], command.Deny)
2125
self.assertIsInstance(commands[1], command.Remove)
2127
def test_deny_before_remove_reversed(self):
2128
options = self.parser.parse_args(["--remove", "--deny",
2130
check_option_syntax(self.parser, options)
2131
commands = commands_from_options(options)
2132
self.assertEqual(2, len(commands))
2133
self.assertIsInstance(commands[0], command.Deny)
2134
self.assertIsInstance(commands[1], command.Remove)
2136
def test_remove_short(self):
2137
self.assert_command_from_args(["-r", "client"],
2140
def test_dump_json(self):
2141
self.assert_command_from_args(["--dump-json"],
2144
def test_enable(self):
2145
self.assert_command_from_args(["--enable", "client"],
2148
def test_enable_short(self):
2149
self.assert_command_from_args(["-e", "client"],
2152
def test_disable(self):
2153
self.assert_command_from_args(["--disable", "client"],
2156
def test_disable_short(self):
2157
self.assert_command_from_args(["-d", "client"],
2160
def test_bump_timeout(self):
2161
self.assert_command_from_args(["--bump-timeout", "client"],
2162
command.BumpTimeout)
2164
def test_bump_timeout_short(self):
2165
self.assert_command_from_args(["-b", "client"],
2166
command.BumpTimeout)
2168
def test_start_checker(self):
2169
self.assert_command_from_args(["--start-checker", "client"],
2170
command.StartChecker)
2172
def test_stop_checker(self):
2173
self.assert_command_from_args(["--stop-checker", "client"],
2174
command.StopChecker)
2176
def test_approve_by_default(self):
2177
self.assert_command_from_args(["--approve-by-default",
2179
command.ApproveByDefault)
2181
def test_deny_by_default(self):
2182
self.assert_command_from_args(["--deny-by-default", "client"],
2183
command.DenyByDefault)
2185
def test_checker(self):
2186
self.assert_command_from_args(["--checker", ":", "client"],
2190
def test_checker_empty(self):
2191
self.assert_command_from_args(["--checker", "", "client"],
2195
def test_checker_short(self):
2196
self.assert_command_from_args(["-c", ":", "client"],
2200
def test_host(self):
2201
self.assert_command_from_args(
2202
["--host", "client.example.org", "client"],
2203
command.SetHost, value_to_set="client.example.org")
2205
def test_host_short(self):
2206
self.assert_command_from_args(
2207
["-H", "client.example.org", "client"], command.SetHost,
2208
value_to_set="client.example.org")
2210
def test_secret_devnull(self):
2211
self.assert_command_from_args(["--secret", os.path.devnull,
2212
"client"], command.SetSecret,
2215
def test_secret_tempfile(self):
2216
with tempfile.NamedTemporaryFile(mode="r+b") as f:
2217
value = b"secret\0xyzzy\nbar"
2220
self.assert_command_from_args(["--secret", f.name,
2225
def test_secret_devnull_short(self):
2226
self.assert_command_from_args(["-s", os.path.devnull,
2227
"client"], command.SetSecret,
2230
def test_secret_tempfile_short(self):
2231
with tempfile.NamedTemporaryFile(mode="r+b") as f:
2232
value = b"secret\0xyzzy\nbar"
2235
self.assert_command_from_args(["-s", f.name, "client"],
2239
def test_timeout(self):
2240
self.assert_command_from_args(["--timeout", "PT5M", "client"],
2242
value_to_set=300000)
2244
def test_timeout_short(self):
2245
self.assert_command_from_args(["-t", "PT5M", "client"],
2247
value_to_set=300000)
2249
def test_extended_timeout(self):
2250
self.assert_command_from_args(["--extended-timeout", "PT15M",
2252
command.SetExtendedTimeout,
2253
value_to_set=900000)
2255
def test_interval(self):
2256
self.assert_command_from_args(["--interval", "PT2M",
2257
"client"], command.SetInterval,
2258
value_to_set=120000)
2260
def test_interval_short(self):
2261
self.assert_command_from_args(["-i", "PT2M", "client"],
2262
command.SetInterval,
2263
value_to_set=120000)
2265
def test_approval_delay(self):
2266
self.assert_command_from_args(["--approval-delay", "PT30S",
2268
command.SetApprovalDelay,
2271
def test_approval_duration(self):
2272
self.assert_command_from_args(["--approval-duration", "PT1S",
2274
command.SetApprovalDuration,
2277
def test_print_table(self):
2278
self.assert_command_from_args([], command.PrintTable,
2281
def test_print_table_verbose(self):
2282
self.assert_command_from_args(["--verbose"],
2286
def test_print_table_verbose_short(self):
2287
self.assert_command_from_args(["-v"], command.PrintTable,
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(),
2322
class TestCommand(unittest.TestCase):
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))
2414
self.bus = self.FakeMandosBus(self)
2417
class TestBaseCommands(TestCommand):
2419
def test_IsEnabled_exits_successfully(self):
2420
with self.assertRaises(SystemExit) as e:
2421
command.IsEnabled().run(self.bus.one_client)
2422
if e.exception.code is not None:
2423
self.assertEqual(0, e.exception.code)
2425
self.assertIsNone(e.exception.code)
2427
def test_IsEnabled_exits_with_failure(self):
2428
self.bus.client_properties["Enabled"] = False
2429
with self.assertRaises(SystemExit) as e:
2430
command.IsEnabled().run(self.bus.one_client)
2431
if isinstance(e.exception.code, int):
2432
self.assertNotEqual(0, e.exception.code)
2434
self.assertIsNotNone(e.exception.code)
2436
def test_Approve(self):
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)
2444
def test_Deny(self):
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,)),
2453
def test_Remove(self):
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)
2463
"KeyID": ("92ed150794387c03ce684574b1139a65"
2464
"94a34f895daaaf09fd8ea90a27cddb12"),
2465
"Host": "foo.example.org",
2468
"LastCheckedOK": "2019-02-03T00:00:00",
2469
"Created": "2019-01-02T00:00:00",
2471
"Fingerprint": ("778827225BA7DE539C5A"
2472
"7CFA59CFF7CDBD9A5920"),
2473
"CheckerRunning": False,
2474
"LastEnabled": "2019-01-03T00:00:00",
2475
"ApprovalPending": False,
2476
"ApprovedByDefault": True,
2477
"LastApprovalRequest": "",
2479
"ApprovalDuration": 1000,
2480
"Checker": "fping -q -- %(host)s",
2481
"ExtendedTimeout": 900000,
2482
"Expires": "2019-02-04T00:00:00",
2483
"LastCheckerStatus": 0,
2487
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2488
"6ab612cff5ad227247e46c2b020f441c"),
2489
"Host": "192.0.2.3",
2492
"LastCheckedOK": "2019-02-04T00:00:00",
2493
"Created": "2019-01-03T00:00:00",
2495
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2496
"F547B3A107558FCA3A27"),
2497
"CheckerRunning": True,
2498
"LastEnabled": "2019-01-04T00:00:00",
2499
"ApprovalPending": False,
2500
"ApprovedByDefault": False,
2501
"LastApprovalRequest": "2019-01-03T00:00:00",
2502
"ApprovalDelay": 30000,
2503
"ApprovalDuration": 93785000,
2505
"ExtendedTimeout": 900000,
2506
"Expires": "2019-02-05T00:00:00",
2507
"LastCheckerStatus": -2,
2511
def test_DumpJSON_normal(self):
2512
with self.capture_stdout_to_buffer() as buffer:
2513
command.DumpJSON().run(self.bus.clients)
2514
json_data = json.loads(buffer.getvalue())
2515
self.assertDictEqual(self.expected_json, json_data)
2518
@contextlib.contextmanager
2519
def capture_stdout_to_buffer():
2520
capture_buffer = io.StringIO()
2521
old_stdout = sys.stdout
2522
sys.stdout = capture_buffer
2524
yield capture_buffer
2526
sys.stdout = old_stdout
2528
def test_DumpJSON_one_client(self):
2529
with self.capture_stdout_to_buffer() as buffer:
2530
command.DumpJSON().run(self.bus.one_client)
2531
json_data = json.loads(buffer.getvalue())
2532
expected_json = {"foo": self.expected_json["foo"]}
2533
self.assertDictEqual(expected_json, json_data)
2535
def test_PrintTable_normal(self):
2536
with self.capture_stdout_to_buffer() as buffer:
2537
command.PrintTable().run(self.bus.clients)
2538
expected_output = "\n".join((
2539
"Name Enabled Timeout Last Successful Check",
2540
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2541
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
2543
self.assertEqual(expected_output, buffer.getvalue())
2545
def test_PrintTable_verbose(self):
2546
with self.capture_stdout_to_buffer() as buffer:
2547
command.PrintTable(verbose=True).run(self.bus.clients)
2562
"Last Successful Check ",
2563
"2019-02-03T00:00:00 ",
2564
"2019-02-04T00:00:00 ",
2567
"2019-01-02T00:00:00 ",
2568
"2019-01-03T00:00:00 ",
2580
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
2582
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
2586
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
2587
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
2589
"Check Is Running ",
2594
"2019-01-03T00:00:00 ",
2595
"2019-01-04T00:00:00 ",
2597
"Approval Is Pending ",
2601
"Approved By Default ",
2605
"Last Approval Request ",
2607
"2019-01-03T00:00:00 ",
2613
"Approval Duration ",
2618
"fping -q -- %(host)s ",
2621
"Extended Timeout ",
2626
"2019-02-04T00:00:00 ",
2627
"2019-02-05T00:00:00 ",
2629
"Last Checker Status",
2634
num_lines = max(len(rows) for rows in columns)
2635
expected_output = ("\n".join("".join(rows[line]
2636
for rows in columns)
2637
for line in range(num_lines))
2639
self.assertEqual(expected_output, buffer.getvalue())
2641
def test_PrintTable_one_client(self):
2642
with self.capture_stdout_to_buffer() as buffer:
2643
command.PrintTable().run(self.bus.one_client)
2644
expected_output = "\n".join((
2645
"Name Enabled Timeout Last Successful Check",
2646
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2648
self.assertEqual(expected_output, buffer.getvalue())
2651
class TestPropertySetterCmd(TestCommand):
2652
"""Abstract class for tests of command.PropertySetter classes"""
2655
if not hasattr(self, "command"):
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)
2674
self.assertEqual(value_to_get, value)
2677
class TestEnableCmd(TestPropertySetterCmd):
2678
command = command.Enable
2679
propname = "Enabled"
2680
values_to_get = [True]
2683
class TestDisableCmd(TestPropertySetterCmd):
2684
command = command.Disable
2685
propname = "Enabled"
2686
values_to_get = [False]
2689
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2690
command = command.BumpTimeout
2691
propname = "LastCheckedOK"
2692
values_to_get = [""]
2695
class TestStartCheckerCmd(TestPropertySetterCmd):
2696
command = command.StartChecker
2697
propname = "CheckerRunning"
2698
values_to_get = [True]
2701
class TestStopCheckerCmd(TestPropertySetterCmd):
2702
command = command.StopChecker
2703
propname = "CheckerRunning"
2704
values_to_get = [False]
2707
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2708
command = command.ApproveByDefault
2709
propname = "ApprovedByDefault"
2710
values_to_get = [True]
2713
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2714
command = command.DenyByDefault
2715
propname = "ApprovedByDefault"
2716
values_to_get = [False]
2719
class TestSetCheckerCmd(TestPropertySetterCmd):
2720
command = command.SetChecker
2721
propname = "Checker"
2722
values_to_set = ["", ":", "fping -q -- %s"]
2725
class TestSetHostCmd(TestPropertySetterCmd):
2726
command = command.SetHost
2728
values_to_set = ["192.0.2.3", "client.example.org"]
2731
class TestSetSecretCmd(TestPropertySetterCmd):
2732
command = command.SetSecret
2734
values_to_set = [io.BytesIO(b""),
2735
io.BytesIO(b"secret\0xyzzy\nbar")]
2736
values_to_get = [f.getvalue() for f in values_to_set]
2739
class TestSetTimeoutCmd(TestPropertySetterCmd):
2740
command = command.SetTimeout
2741
propname = "Timeout"
2742
values_to_set = [datetime.timedelta(),
2743
datetime.timedelta(minutes=5),
2744
datetime.timedelta(seconds=1),
2745
datetime.timedelta(weeks=1),
2746
datetime.timedelta(weeks=52)]
2747
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2750
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2751
command = command.SetExtendedTimeout
2752
propname = "ExtendedTimeout"
2753
values_to_set = [datetime.timedelta(),
2754
datetime.timedelta(minutes=5),
2755
datetime.timedelta(seconds=1),
2756
datetime.timedelta(weeks=1),
2757
datetime.timedelta(weeks=52)]
2758
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2761
class TestSetIntervalCmd(TestPropertySetterCmd):
2762
command = command.SetInterval
2763
propname = "Interval"
2764
values_to_set = [datetime.timedelta(),
2765
datetime.timedelta(minutes=5),
2766
datetime.timedelta(seconds=1),
2767
datetime.timedelta(weeks=1),
2768
datetime.timedelta(weeks=52)]
2769
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2772
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2773
command = command.SetApprovalDelay
2774
propname = "ApprovalDelay"
2775
values_to_set = [datetime.timedelta(),
2776
datetime.timedelta(minutes=5),
2777
datetime.timedelta(seconds=1),
2778
datetime.timedelta(weeks=1),
2779
datetime.timedelta(weeks=52)]
2780
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2783
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2784
command = command.SetApprovalDuration
2785
propname = "ApprovalDuration"
2786
values_to_set = [datetime.timedelta(),
2787
datetime.timedelta(minutes=5),
2788
datetime.timedelta(seconds=1),
2789
datetime.timedelta(weeks=1),
2790
datetime.timedelta(weeks=52)]
2791
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
764
log.removeFilter(warning_filter)
765
self.assertTrue(getattr(warning_filter, "found", False))
766
self.assertEqual(value, datetime.timedelta(0, 7200))
768
class Test_TableOfClients(unittest.TestCase):
770
self.tableheaders = {
774
"Bool": "A D-BUS Boolean",
775
"NonDbusBoolean": "A Non-D-BUS Boolean",
776
"Integer": "An Integer",
777
"Timeout": "Timedelta 1",
778
"Interval": "Timedelta 2",
779
"ApprovalDelay": "Timedelta 3",
780
"ApprovalDuration": "Timedelta 4",
781
"ExtendedTimeout": "Timedelta 5",
782
"String": "A String",
784
self.keywords = ["Attr1", "AttrTwo"]
790
"Bool": dbus.Boolean(False),
791
"NonDbusBoolean": False,
795
"ApprovalDelay": 2000,
796
"ApprovalDuration": 3000,
797
"ExtendedTimeout": 4000,
804
"Bool": dbus.Boolean(True),
805
"NonDbusBoolean": True,
808
"Interval": 93786000,
809
"ApprovalDelay": 93787000,
810
"ApprovalDuration": 93788000,
811
"ExtendedTimeout": 93789000,
812
"String": "A huge string which will not fit," * 10,
815
def test_short_header(self):
816
text = str(TableOfClients(self.clients, self.keywords,
823
self.assertEqual(text, expected_text)
824
def test_booleans(self):
825
keywords = ["Bool", "NonDbusBoolean"]
826
text = str(TableOfClients(self.clients, keywords,
829
A D-BUS Boolean A Non-D-BUS Boolean
833
self.assertEqual(text, expected_text)
834
def test_milliseconds_detection(self):
835
keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
836
"ApprovalDuration", "ExtendedTimeout"]
837
text = str(TableOfClients(self.clients, keywords,
840
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
841
0 00:00:00 00:00:01 00:00:02 00:00:03 00:00:04
842
1 1T02:03:05 1T02:03:06 1T02:03:07 1T02:03:08 1T02:03:09
844
self.assertEqual(text, expected_text)
845
def test_empty_and_long_string_values(self):
846
keywords = ["String"]
847
text = str(TableOfClients(self.clients, keywords,
852
A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,
854
self.assertEqual(text, expected_text)