415
344
parser.error("--dump-json can only be used alone.")
416
345
if options.all and not has_actions(options):
417
346
parser.error("--all requires an action.")
418
if options.is_enabled and len(options.client) > 1:
419
parser.error("--is-enabled requires exactly one client")
421
options.remove = False
422
if has_actions(options) and not options.deny:
423
parser.error("--remove can only be combined with --deny")
424
options.remove = True
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
434
return mandos_dbus_object
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
462
self.logger.addFilter(self.nullfilter)
465
class NullFilter(logging.Filter):
466
def filter(self, record):
469
nullfilter = NullFilter()
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
475
def commands_from_options(options):
479
if options.is_enabled:
480
commands.append(IsEnabledCmd())
483
commands.append(ApproveCmd())
486
commands.append(DenyCmd())
489
commands.append(RemoveCmd())
491
if options.dump_json:
492
commands.append(DumpJSONCmd())
495
commands.append(EnableCmd())
498
commands.append(DisableCmd())
500
if options.bump_timeout:
501
commands.append(BumpTimeoutCmd())
503
if options.start_checker:
504
commands.append(StartCheckerCmd())
506
if options.stop_checker:
507
commands.append(StopCheckerCmd())
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(ApproveByDefaultCmd())
513
commands.append(DenyByDefaultCmd())
515
if options.checker is not None:
516
commands.append(SetCheckerCmd(options.checker))
518
if options.host is not None:
519
commands.append(SetHostCmd(options.host))
521
if options.secret is not None:
522
commands.append(SetSecretCmd(options.secret))
524
if options.timeout is not None:
525
commands.append(SetTimeoutCmd(options.timeout))
527
if options.extended_timeout:
529
SetExtendedTimeoutCmd(options.extended_timeout))
531
if options.interval is not None:
532
commands.append(SetIntervalCmd(options.interval))
534
if options.approval_delay is not None:
535
commands.append(SetApprovalDelayCmd(options.approval_delay))
537
if options.approval_duration is not None:
539
SetApprovalDurationCmd(options.approval_duration))
541
# If no command option has been given, show table of clients,
542
# optionally verbosely
544
commands.append(PrintTableCmd(verbose=options.verbose))
549
class Command(object):
550
"""Abstract class for commands"""
551
def run(self, clients, bus=None, mandos=None):
552
"""Normal commands should implement run_on_one_client(), but
553
commands which want to operate on all clients at the same time
554
can override this run() method instead."""
556
for clientpath, properties in clients.items():
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
dbus_busname, str(clientpath))
559
client = bus.get_object(dbus_busname, clientpath)
560
self.run_on_one_client(client, properties)
563
class IsEnabledCmd(Command):
564
def run(self, clients, bus=None, mandos=None):
565
client, properties = next(iter(clients.items()))
566
if self.is_enabled(client, properties):
569
def is_enabled(self, client, properties):
570
return properties["Enabled"]
573
class ApproveCmd(Command):
574
def run_on_one_client(self, client, properties):
575
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
576
client.__dbus_object_path__, client_dbus_interface)
577
client.Approve(dbus.Boolean(True),
578
dbus_interface=client_dbus_interface)
581
class DenyCmd(Command):
582
def run_on_one_client(self, client, properties):
583
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
584
client.__dbus_object_path__, client_dbus_interface)
585
client.Approve(dbus.Boolean(False),
586
dbus_interface=client_dbus_interface)
589
class RemoveCmd(Command):
590
def run_on_one_client(self, client, properties):
591
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
592
server_dbus_path, server_dbus_interface,
593
str(client.__dbus_object_path__))
594
self.mandos.RemoveClient(client.__dbus_object_path__)
597
class OutputCmd(Command):
598
"""Abstract class for commands outputting client details"""
599
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
600
"Created", "Interval", "Host", "KeyID",
601
"Fingerprint", "CheckerRunning", "LastEnabled",
602
"ApprovalPending", "ApprovedByDefault",
603
"LastApprovalRequest", "ApprovalDelay",
604
"ApprovalDuration", "Checker", "ExtendedTimeout",
605
"Expires", "LastCheckerStatus")
607
def run(self, clients, bus=None, mandos=None):
608
print(self.output(clients.values()))
610
def output(self, clients):
611
raise NotImplementedError()
614
class DumpJSONCmd(OutputCmd):
615
def output(self, clients):
616
data = {client["Name"]:
617
{key: self.dbus_boolean_to_bool(client[key])
618
for key in self.all_keywords}
619
for client in clients}
620
return json.dumps(data, indent=4, separators=(',', ': '))
623
def dbus_boolean_to_bool(value):
624
if isinstance(value, dbus.Boolean):
629
class PrintTableCmd(OutputCmd):
630
def __init__(self, verbose=False):
631
self.verbose = verbose
633
def output(self, clients):
634
default_keywords = ("Name", "Enabled", "Timeout",
636
keywords = default_keywords
638
keywords = self.all_keywords
639
return str(self.TableOfClients(clients, keywords))
641
class TableOfClients(object):
644
"Enabled": "Enabled",
645
"Timeout": "Timeout",
646
"LastCheckedOK": "Last Successful Check",
647
"LastApprovalRequest": "Last Approval Request",
648
"Created": "Created",
649
"Interval": "Interval",
651
"Fingerprint": "Fingerprint",
653
"CheckerRunning": "Check Is Running",
654
"LastEnabled": "Last Enabled",
655
"ApprovalPending": "Approval Is Pending",
656
"ApprovedByDefault": "Approved By Default",
657
"ApprovalDelay": "Approval Delay",
658
"ApprovalDuration": "Approval Duration",
659
"Checker": "Checker",
660
"ExtendedTimeout": "Extended Timeout",
661
"Expires": "Expires",
662
"LastCheckerStatus": "Last Checker Status",
665
def __init__(self, clients, keywords):
666
self.clients = clients
667
self.keywords = keywords
670
return "\n".join(self.rows())
672
if sys.version_info.major == 2:
673
__unicode__ = __str__
675
return str(self).encode(locale.getpreferredencoding())
678
format_string = self.row_formatting_string()
679
rows = [self.header_line(format_string)]
680
rows.extend(self.client_line(client, format_string)
681
for client in self.clients)
684
def row_formatting_string(self):
685
"Format string used to format table rows"
686
return " ".join("{{{key}:{width}}}".format(
687
width=max(len(self.tableheaders[key]),
688
*(len(self.string_from_client(client, key))
689
for client in self.clients)),
691
for key in self.keywords)
693
def string_from_client(self, client, key):
694
return self.valuetostring(client[key], key)
697
def valuetostring(cls, value, keyword):
698
if isinstance(value, dbus.Boolean):
699
return "Yes" if value else "No"
700
if keyword in ("Timeout", "Interval", "ApprovalDelay",
701
"ApprovalDuration", "ExtendedTimeout"):
702
return cls.milliseconds_to_string(value)
705
def header_line(self, format_string):
706
return format_string.format(**self.tableheaders)
708
def client_line(self, client, format_string):
709
return format_string.format(
710
**{key: self.string_from_client(client, key)
711
for key in self.keywords})
714
def milliseconds_to_string(ms):
715
td = datetime.timedelta(0, 0, 0, ms)
716
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
717
.format(days="{}T".format(td.days)
719
hours=td.seconds // 3600,
720
minutes=(td.seconds % 3600) // 60,
721
seconds=td.seconds % 60))
724
class PropertyCmd(Command):
725
"""Abstract class for Actions for setting one client property"""
727
def run_on_one_client(self, client, properties):
728
"""Set the Client's D-Bus property"""
729
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
730
client.__dbus_object_path__,
731
dbus.PROPERTIES_IFACE, client_dbus_interface,
732
self.propname, self.value_to_set
733
if not isinstance(self.value_to_set, dbus.Boolean)
734
else bool(self.value_to_set))
735
client.Set(client_dbus_interface, self.propname,
737
dbus_interface=dbus.PROPERTIES_IFACE)
741
raise NotImplementedError()
744
class EnableCmd(PropertyCmd):
746
value_to_set = dbus.Boolean(True)
749
class DisableCmd(PropertyCmd):
751
value_to_set = dbus.Boolean(False)
754
class BumpTimeoutCmd(PropertyCmd):
755
propname = "LastCheckedOK"
759
class StartCheckerCmd(PropertyCmd):
760
propname = "CheckerRunning"
761
value_to_set = dbus.Boolean(True)
764
class StopCheckerCmd(PropertyCmd):
765
propname = "CheckerRunning"
766
value_to_set = dbus.Boolean(False)
769
class ApproveByDefaultCmd(PropertyCmd):
770
propname = "ApprovedByDefault"
771
value_to_set = dbus.Boolean(True)
774
class DenyByDefaultCmd(PropertyCmd):
775
propname = "ApprovedByDefault"
776
value_to_set = dbus.Boolean(False)
779
class PropertyValueCmd(PropertyCmd):
780
"""Abstract class for PropertyCmd recieving a value as argument"""
781
def __init__(self, value):
782
self.value_to_set = value
785
class SetCheckerCmd(PropertyValueCmd):
789
class SetHostCmd(PropertyValueCmd):
793
class SetSecretCmd(PropertyValueCmd):
797
def value_to_set(self):
801
def value_to_set(self, value):
802
"""When setting, read data from supplied file object"""
803
self._vts = value.read()
807
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
808
"""Abstract class for PropertyValueCmd taking a value argument as
809
a datetime.timedelta() but should store it as milliseconds."""
812
def value_to_set(self):
816
def value_to_set(self, value):
817
"""When setting, convert value from a datetime.timedelta"""
818
self._vts = int(round(value.total_seconds() * 1000))
821
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
825
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
826
propname = "ExtendedTimeout"
829
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
830
propname = "Interval"
833
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
834
propname = "ApprovalDelay"
837
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
838
propname = "ApprovalDuration"
842
class TestCaseWithAssertLogs(unittest.TestCase):
843
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
845
if not hasattr(unittest.TestCase, "assertLogs"):
846
@contextlib.contextmanager
847
def assertLogs(self, logger, level=logging.INFO):
848
capturing_handler = self.CapturingLevelHandler(level)
849
old_level = logger.level
850
old_propagate = logger.propagate
851
logger.addHandler(capturing_handler)
852
logger.setLevel(level)
853
logger.propagate = False
855
yield capturing_handler.watcher
857
logger.propagate = old_propagate
858
logger.removeHandler(capturing_handler)
859
logger.setLevel(old_level)
860
self.assertGreater(len(capturing_handler.watcher.records),
863
class CapturingLevelHandler(logging.Handler):
864
def __init__(self, level, *args, **kwargs):
865
logging.Handler.__init__(self, *args, **kwargs)
866
self.watcher = self.LoggingWatcher([], [])
867
def emit(self, record):
868
self.watcher.records.append(record)
869
self.watcher.output.append(self.format(record))
871
LoggingWatcher = collections.namedtuple("LoggingWatcher",
875
class Test_string_to_delta(TestCaseWithAssertLogs):
876
def test_handles_basic_rfc3339(self):
877
self.assertEqual(string_to_delta("PT0S"),
878
datetime.timedelta())
879
self.assertEqual(string_to_delta("P0D"),
880
datetime.timedelta())
881
self.assertEqual(string_to_delta("PT1S"),
882
datetime.timedelta(0, 1))
883
self.assertEqual(string_to_delta("PT2H"),
884
datetime.timedelta(0, 7200))
886
def test_falls_back_to_pre_1_6_1_with_warning(self):
887
with self.assertLogs(log, logging.WARNING):
888
value = string_to_delta("2h")
889
self.assertEqual(value, datetime.timedelta(0, 7200))
892
class Test_check_option_syntax(unittest.TestCase):
894
self.parser = argparse.ArgumentParser()
895
add_command_line_options(self.parser)
897
def test_actions_requires_client_or_all(self):
898
for action, value in self.actions.items():
899
options = self.parser.parse_args()
900
setattr(options, action, value)
901
with self.assertParseError():
902
self.check_option_syntax(options)
904
# This mostly corresponds to the definition from has_actions() in
905
# check_option_syntax()
907
# The actual values set here are not that important, but we do
908
# at least stick to the correct types, even though they are
912
"bump_timeout": True,
913
"start_checker": True,
914
"stop_checker": True,
918
"timeout": datetime.timedelta(),
919
"extended_timeout": datetime.timedelta(),
920
"interval": datetime.timedelta(),
921
"approved_by_default": True,
922
"approval_delay": datetime.timedelta(),
923
"approval_duration": datetime.timedelta(),
925
"secret": io.BytesIO(b"x"),
930
@contextlib.contextmanager
931
def assertParseError(self):
932
with self.assertRaises(SystemExit) as e:
933
with self.temporarily_suppress_stderr():
935
# Exit code from argparse is guaranteed to be "2". Reference:
936
# https://docs.python.org/3/library
937
# /argparse.html#exiting-methods
938
self.assertEqual(e.exception.code, 2)
941
@contextlib.contextmanager
942
def temporarily_suppress_stderr():
943
null = os.open(os.path.devnull, os.O_RDWR)
944
stderrcopy = os.dup(sys.stderr.fileno())
945
os.dup2(null, sys.stderr.fileno())
350
fail_count, test_count = doctest.testmod()
351
sys.exit(os.EX_OK if fail_count == 0 else 1)
354
bus = dbus.SystemBus()
355
mandos_dbus_objc = bus.get_object(busname, server_path)
356
except dbus.exceptions.DBusException:
357
print("Could not connect to Mandos server", file=sys.stderr)
360
mandos_serv = dbus.Interface(mandos_dbus_objc,
361
dbus_interface=server_interface)
362
mandos_serv_object_manager = dbus.Interface(
363
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
365
# block stderr since dbus library prints to stderr
366
null = os.open(os.path.devnull, os.O_RDWR)
367
stderrcopy = os.dup(sys.stderr.fileno())
368
os.dup2(null, sys.stderr.fileno())
372
mandos_clients = {path: ifs_and_props[client_interface]
373
for path, ifs_and_props in
374
mandos_serv_object_manager
375
.GetManagedObjects().items()
376
if client_interface in ifs_and_props}
951
379
os.dup2(stderrcopy, sys.stderr.fileno())
952
380
os.close(stderrcopy)
954
def check_option_syntax(self, options):
955
check_option_syntax(self.parser, options)
957
def test_actions_conflicts_with_verbose(self):
958
for action, value in self.actions.items():
959
options = self.parser.parse_args()
960
setattr(options, action, value)
961
options.verbose = True
962
with self.assertParseError():
963
self.check_option_syntax(options)
965
def test_dump_json_conflicts_with_verbose(self):
966
options = self.parser.parse_args()
967
options.dump_json = True
968
options.verbose = True
969
with self.assertParseError():
970
self.check_option_syntax(options)
972
def test_dump_json_conflicts_with_action(self):
973
for action, value in self.actions.items():
974
options = self.parser.parse_args()
975
setattr(options, action, value)
976
options.dump_json = True
977
with self.assertParseError():
978
self.check_option_syntax(options)
980
def test_all_can_not_be_alone(self):
981
options = self.parser.parse_args()
983
with self.assertParseError():
984
self.check_option_syntax(options)
986
def test_all_is_ok_with_any_action(self):
987
for action, value in self.actions.items():
988
options = self.parser.parse_args()
989
setattr(options, action, value)
991
self.check_option_syntax(options)
993
def test_is_enabled_fails_without_client(self):
994
options = self.parser.parse_args()
995
options.is_enabled = True
996
with self.assertParseError():
997
self.check_option_syntax(options)
999
def test_is_enabled_works_with_one_client(self):
1000
options = self.parser.parse_args()
1001
options.is_enabled = True
1002
options.client = ["foo"]
1003
self.check_option_syntax(options)
1005
def test_is_enabled_fails_with_two_clients(self):
1006
options = self.parser.parse_args()
1007
options.is_enabled = True
1008
options.client = ["foo", "barbar"]
1009
with self.assertParseError():
1010
self.check_option_syntax(options)
1012
def test_remove_can_only_be_combined_with_action_deny(self):
1013
for action, value in self.actions.items():
1014
if action in {"remove", "deny"}:
1016
options = self.parser.parse_args()
1017
setattr(options, action, value)
1019
options.remove = True
1020
with self.assertParseError():
1021
self.check_option_syntax(options)
1024
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1025
def test_calls_and_returns_get_object_on_bus(self):
1026
class MockBus(object):
1028
def get_object(mockbus_self, busname, dbus_path):
1029
# Note that "self" is still the testcase instance,
1030
# this MockBus instance is in "mockbus_self".
1031
self.assertEqual(busname, dbus_busname)
1032
self.assertEqual(dbus_path, server_dbus_path)
1033
mockbus_self.called = True
1036
mockbus = get_mandos_dbus_object(bus=MockBus())
1037
self.assertIsInstance(mockbus, MockBus)
1038
self.assertTrue(mockbus.called)
1040
def test_logs_and_exits_on_dbus_error(self):
1041
class MockBusFailing(object):
1042
def get_object(self, busname, dbus_path):
1043
raise dbus.exceptions.DBusException("Test")
1045
with self.assertLogs(log, logging.CRITICAL):
1046
with self.assertRaises(SystemExit) as e:
1047
bus = get_mandos_dbus_object(bus=MockBusFailing())
1049
if isinstance(e.exception.code, int):
1050
self.assertNotEqual(e.exception.code, 0)
1052
self.assertIsNotNone(e.exception.code)
1055
class Test_get_managed_objects(TestCaseWithAssertLogs):
1056
def test_calls_and_returns_GetManagedObjects(self):
1057
managed_objects = {"/clients/foo": { "Name": "foo"}}
1058
class MockObjectManager(object):
1059
def GetManagedObjects(self):
1060
return managed_objects
1061
retval = get_managed_objects(MockObjectManager())
1062
self.assertDictEqual(managed_objects, retval)
1064
def test_logs_and_exits_on_dbus_error(self):
1065
dbus_logger = logging.getLogger("dbus.proxies")
1067
class MockObjectManagerFailing(object):
1068
def GetManagedObjects(self):
1069
dbus_logger.error("Test")
1070
raise dbus.exceptions.DBusException("Test")
1072
class CountingHandler(logging.Handler):
1074
def emit(self, record):
1077
counting_handler = CountingHandler()
1079
dbus_logger.addHandler(counting_handler)
1082
with self.assertLogs(log, logging.CRITICAL) as watcher:
1083
with self.assertRaises(SystemExit) as e:
1084
get_managed_objects(MockObjectManagerFailing())
1086
dbus_logger.removeFilter(counting_handler)
1087
self.assertEqual(counting_handler.count, 0)
1089
# Test that the dbus_logger still works
1090
with self.assertLogs(dbus_logger, logging.ERROR):
1091
dbus_logger.error("Test")
1093
if isinstance(e.exception.code, int):
1094
self.assertNotEqual(e.exception.code, 0)
1096
self.assertIsNotNone(e.exception.code)
1099
class Test_commands_from_options(unittest.TestCase):
1101
self.parser = argparse.ArgumentParser()
1102
add_command_line_options(self.parser)
1104
def test_is_enabled(self):
1105
self.assert_command_from_args(["--is-enabled", "foo"],
1108
def assert_command_from_args(self, args, command_cls,
1110
"""Assert that parsing ARGS should result in an instance of
1111
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1112
options = self.parser.parse_args(args)
1113
check_option_syntax(self.parser, options)
1114
commands = commands_from_options(options)
1115
self.assertEqual(len(commands), 1)
1116
command = commands[0]
1117
self.assertIsInstance(command, command_cls)
1118
for key, value in cmd_attrs.items():
1119
self.assertEqual(getattr(command, key), value)
1121
def test_is_enabled_short(self):
1122
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1124
def test_approve(self):
1125
self.assert_command_from_args(["--approve", "foo"],
1128
def test_approve_short(self):
1129
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1131
def test_deny(self):
1132
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1134
def test_deny_short(self):
1135
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1137
def test_remove(self):
1138
self.assert_command_from_args(["--remove", "foo"],
1141
def test_deny_before_remove(self):
1142
options = self.parser.parse_args(["--deny", "--remove",
1144
check_option_syntax(self.parser, options)
1145
commands = commands_from_options(options)
1146
self.assertEqual(len(commands), 2)
1147
self.assertIsInstance(commands[0], DenyCmd)
1148
self.assertIsInstance(commands[1], RemoveCmd)
1150
def test_deny_before_remove_reversed(self):
1151
options = self.parser.parse_args(["--remove", "--deny",
1153
check_option_syntax(self.parser, options)
1154
commands = commands_from_options(options)
1155
self.assertEqual(len(commands), 2)
1156
self.assertIsInstance(commands[0], DenyCmd)
1157
self.assertIsInstance(commands[1], RemoveCmd)
1159
def test_remove_short(self):
1160
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1162
def test_dump_json(self):
1163
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1165
def test_enable(self):
1166
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1168
def test_enable_short(self):
1169
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1171
def test_disable(self):
1172
self.assert_command_from_args(["--disable", "foo"],
1175
def test_disable_short(self):
1176
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1178
def test_bump_timeout(self):
1179
self.assert_command_from_args(["--bump-timeout", "foo"],
1182
def test_bump_timeout_short(self):
1183
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1185
def test_start_checker(self):
1186
self.assert_command_from_args(["--start-checker", "foo"],
1189
def test_stop_checker(self):
1190
self.assert_command_from_args(["--stop-checker", "foo"],
1193
def test_approve_by_default(self):
1194
self.assert_command_from_args(["--approve-by-default", "foo"],
1195
ApproveByDefaultCmd)
1197
def test_deny_by_default(self):
1198
self.assert_command_from_args(["--deny-by-default", "foo"],
1201
def test_checker(self):
1202
self.assert_command_from_args(["--checker", ":", "foo"],
1203
SetCheckerCmd, value_to_set=":")
1205
def test_checker_empty(self):
1206
self.assert_command_from_args(["--checker", "", "foo"],
1207
SetCheckerCmd, value_to_set="")
1209
def test_checker_short(self):
1210
self.assert_command_from_args(["-c", ":", "foo"],
1211
SetCheckerCmd, value_to_set=":")
1213
def test_host(self):
1214
self.assert_command_from_args(["--host", "foo.example.org",
1216
value_to_set="foo.example.org")
1218
def test_host_short(self):
1219
self.assert_command_from_args(["-H", "foo.example.org",
1221
value_to_set="foo.example.org")
1223
def test_secret_devnull(self):
1224
self.assert_command_from_args(["--secret", os.path.devnull,
1225
"foo"], SetSecretCmd,
1228
def test_secret_tempfile(self):
1229
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1230
value = b"secret\0xyzzy\nbar"
1233
self.assert_command_from_args(["--secret", f.name,
1234
"foo"], SetSecretCmd,
1237
def test_secret_devnull_short(self):
1238
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1239
SetSecretCmd, value_to_set=b"")
1241
def test_secret_tempfile_short(self):
1242
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1243
value = b"secret\0xyzzy\nbar"
1246
self.assert_command_from_args(["-s", f.name, "foo"],
1250
def test_timeout(self):
1251
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1253
value_to_set=300000)
1255
def test_timeout_short(self):
1256
self.assert_command_from_args(["-t", "PT5M", "foo"],
1258
value_to_set=300000)
1260
def test_extended_timeout(self):
1261
self.assert_command_from_args(["--extended-timeout", "PT15M",
1263
SetExtendedTimeoutCmd,
1264
value_to_set=900000)
1266
def test_interval(self):
1267
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1269
value_to_set=120000)
1271
def test_interval_short(self):
1272
self.assert_command_from_args(["-i", "PT2M", "foo"],
1274
value_to_set=120000)
1276
def test_approval_delay(self):
1277
self.assert_command_from_args(["--approval-delay", "PT30S",
1278
"foo"], SetApprovalDelayCmd,
1281
def test_approval_duration(self):
1282
self.assert_command_from_args(["--approval-duration", "PT1S",
1283
"foo"], SetApprovalDurationCmd,
1286
def test_print_table(self):
1287
self.assert_command_from_args([], PrintTableCmd,
1290
def test_print_table_verbose(self):
1291
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1294
def test_print_table_verbose_short(self):
1295
self.assert_command_from_args(["-v"], PrintTableCmd,
1299
class TestCmd(unittest.TestCase):
1300
"""Abstract class for tests of command classes"""
1304
class MockClient(object):
1305
def __init__(self, name, **attributes):
1306
self.__dbus_object_path__ = "/clients/{}".format(name)
1307
self.attributes = attributes
1308
self.attributes["Name"] = name
1310
def Set(self, interface, propname, value, dbus_interface):
1311
testcase.assertEqual(interface, client_dbus_interface)
1312
testcase.assertEqual(dbus_interface,
1313
dbus.PROPERTIES_IFACE)
1314
self.attributes[propname] = value
1315
def Get(self, interface, propname, dbus_interface):
1316
testcase.assertEqual(interface, client_dbus_interface)
1317
testcase.assertEqual(dbus_interface,
1318
dbus.PROPERTIES_IFACE)
1319
return self.attributes[propname]
1320
def Approve(self, approve, dbus_interface):
1321
testcase.assertEqual(dbus_interface,
1322
client_dbus_interface)
1323
self.calls.append(("Approve", (approve,
1325
self.client = MockClient(
1327
KeyID=("92ed150794387c03ce684574b1139a65"
1328
"94a34f895daaaf09fd8ea90a27cddb12"),
1330
Host="foo.example.org",
1331
Enabled=dbus.Boolean(True),
1333
LastCheckedOK="2019-02-03T00:00:00",
1334
Created="2019-01-02T00:00:00",
1336
Fingerprint=("778827225BA7DE539C5A"
1337
"7CFA59CFF7CDBD9A5920"),
1338
CheckerRunning=dbus.Boolean(False),
1339
LastEnabled="2019-01-03T00:00:00",
1340
ApprovalPending=dbus.Boolean(False),
1341
ApprovedByDefault=dbus.Boolean(True),
1342
LastApprovalRequest="",
1344
ApprovalDuration=1000,
1345
Checker="fping -q -- %(host)s",
1346
ExtendedTimeout=900000,
1347
Expires="2019-02-04T00:00:00",
1348
LastCheckerStatus=0)
1349
self.other_client = MockClient(
1351
KeyID=("0558568eedd67d622f5c83b35a115f79"
1352
"6ab612cff5ad227247e46c2b020f441c"),
1353
Secret=b"secretbar",
1355
Enabled=dbus.Boolean(True),
1357
LastCheckedOK="2019-02-04T00:00:00",
1358
Created="2019-01-03T00:00:00",
1360
Fingerprint=("3E393AEAEFB84C7E89E2"
1361
"F547B3A107558FCA3A27"),
1362
CheckerRunning=dbus.Boolean(True),
1363
LastEnabled="2019-01-04T00:00:00",
1364
ApprovalPending=dbus.Boolean(False),
1365
ApprovedByDefault=dbus.Boolean(False),
1366
LastApprovalRequest="2019-01-03T00:00:00",
1367
ApprovalDelay=30000,
1368
ApprovalDuration=93785000,
1370
ExtendedTimeout=900000,
1371
Expires="2019-02-05T00:00:00",
1372
LastCheckerStatus=-2)
1373
self.clients = collections.OrderedDict(
1375
("/clients/foo", self.client.attributes),
1376
("/clients/barbar", self.other_client.attributes),
1378
self.one_client = {"/clients/foo": self.client.attributes}
1384
def get_object(client_bus_name, path):
1385
self.assertEqual(client_bus_name, dbus_busname)
1387
# Note: "self" here is the TestCmd instance, not
1388
# the Bus instance, since this is a static method!
1389
"/clients/foo": self.client,
1390
"/clients/barbar": self.other_client,
1395
class TestIsEnabledCmd(TestCmd):
1396
def test_is_enabled(self):
1397
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1399
for client, properties
1400
in self.clients.items()))
1402
def test_is_enabled_run_exits_successfully(self):
1403
with self.assertRaises(SystemExit) as e:
1404
IsEnabledCmd().run(self.one_client)
1405
if e.exception.code is not None:
1406
self.assertEqual(e.exception.code, 0)
1408
self.assertIsNone(e.exception.code)
1410
def test_is_enabled_run_exits_with_failure(self):
1411
self.client.attributes["Enabled"] = dbus.Boolean(False)
1412
with self.assertRaises(SystemExit) as e:
1413
IsEnabledCmd().run(self.one_client)
1414
if isinstance(e.exception.code, int):
1415
self.assertNotEqual(e.exception.code, 0)
1417
self.assertIsNotNone(e.exception.code)
1420
class TestApproveCmd(TestCmd):
1421
def test_approve(self):
1422
ApproveCmd().run(self.clients, self.bus)
1423
for clientpath in self.clients:
1424
client = self.bus.get_object(dbus_busname, clientpath)
1425
self.assertIn(("Approve", (True, client_dbus_interface)),
1429
class TestDenyCmd(TestCmd):
1430
def test_deny(self):
1431
DenyCmd().run(self.clients, self.bus)
1432
for clientpath in self.clients:
1433
client = self.bus.get_object(dbus_busname, clientpath)
1434
self.assertIn(("Approve", (False, client_dbus_interface)),
1438
class TestRemoveCmd(TestCmd):
1439
def test_remove(self):
1440
class MockMandos(object):
1443
def RemoveClient(self, dbus_path):
1444
self.calls.append(("RemoveClient", (dbus_path,)))
1445
mandos = MockMandos()
1446
super(TestRemoveCmd, self).setUp()
1447
RemoveCmd().run(self.clients, self.bus, mandos)
1448
self.assertEqual(len(mandos.calls), 2)
1449
for clientpath in self.clients:
1450
self.assertIn(("RemoveClient", (clientpath,)),
1454
class TestDumpJSONCmd(TestCmd):
1456
self.expected_json = {
1459
"KeyID": ("92ed150794387c03ce684574b1139a65"
1460
"94a34f895daaaf09fd8ea90a27cddb12"),
1461
"Host": "foo.example.org",
1464
"LastCheckedOK": "2019-02-03T00:00:00",
1465
"Created": "2019-01-02T00:00:00",
1467
"Fingerprint": ("778827225BA7DE539C5A"
1468
"7CFA59CFF7CDBD9A5920"),
1469
"CheckerRunning": False,
1470
"LastEnabled": "2019-01-03T00:00:00",
1471
"ApprovalPending": False,
1472
"ApprovedByDefault": True,
1473
"LastApprovalRequest": "",
1475
"ApprovalDuration": 1000,
1476
"Checker": "fping -q -- %(host)s",
1477
"ExtendedTimeout": 900000,
1478
"Expires": "2019-02-04T00:00:00",
1479
"LastCheckerStatus": 0,
1483
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1484
"6ab612cff5ad227247e46c2b020f441c"),
1485
"Host": "192.0.2.3",
1488
"LastCheckedOK": "2019-02-04T00:00:00",
1489
"Created": "2019-01-03T00:00:00",
1491
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1492
"F547B3A107558FCA3A27"),
1493
"CheckerRunning": True,
1494
"LastEnabled": "2019-01-04T00:00:00",
1495
"ApprovalPending": False,
1496
"ApprovedByDefault": False,
1497
"LastApprovalRequest": "2019-01-03T00:00:00",
1498
"ApprovalDelay": 30000,
1499
"ApprovalDuration": 93785000,
1501
"ExtendedTimeout": 900000,
1502
"Expires": "2019-02-05T00:00:00",
1503
"LastCheckerStatus": -2,
1506
return super(TestDumpJSONCmd, self).setUp()
1508
def test_normal(self):
1509
output = DumpJSONCmd().output(self.clients.values())
1510
json_data = json.loads(output)
1511
self.assertDictEqual(json_data, self.expected_json)
1513
def test_one_client(self):
1514
output = DumpJSONCmd().output(self.one_client.values())
1515
json_data = json.loads(output)
1516
expected_json = {"foo": self.expected_json["foo"]}
1517
self.assertDictEqual(json_data, expected_json)
1520
class TestPrintTableCmd(TestCmd):
1521
def test_normal(self):
1522
output = PrintTableCmd().output(self.clients.values())
1523
expected_output = "\n".join((
1524
"Name Enabled Timeout Last Successful Check",
1525
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1526
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1528
self.assertEqual(output, expected_output)
1530
def test_verbose(self):
1531
output = PrintTableCmd(verbose=True).output(
1532
self.clients.values())
1547
"Last Successful Check ",
1548
"2019-02-03T00:00:00 ",
1549
"2019-02-04T00:00:00 ",
1552
"2019-01-02T00:00:00 ",
1553
"2019-01-03T00:00:00 ",
1565
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1567
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1571
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1572
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1574
"Check Is Running ",
1579
"2019-01-03T00:00:00 ",
1580
"2019-01-04T00:00:00 ",
1582
"Approval Is Pending ",
1586
"Approved By Default ",
1590
"Last Approval Request ",
1592
"2019-01-03T00:00:00 ",
1598
"Approval Duration ",
1603
"fping -q -- %(host)s ",
1606
"Extended Timeout ",
1611
"2019-02-04T00:00:00 ",
1612
"2019-02-05T00:00:00 ",
1614
"Last Checker Status",
1619
num_lines = max(len(rows) for rows in columns)
1620
expected_output = "\n".join("".join(rows[line]
1621
for rows in columns)
1622
for line in range(num_lines))
1623
self.assertEqual(output, expected_output)
1625
def test_one_client(self):
1626
output = PrintTableCmd().output(self.one_client.values())
1627
expected_output = "\n".join((
1628
"Name Enabled Timeout Last Successful Check",
1629
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1631
self.assertEqual(output, expected_output)
1634
class TestPropertyCmd(TestCmd):
1635
"""Abstract class for tests of PropertyCmd classes"""
1637
if not hasattr(self, "command"):
1639
values_to_get = getattr(self, "values_to_get",
1641
for value_to_set, value_to_get in zip(self.values_to_set,
1643
for clientpath in self.clients:
1644
client = self.bus.get_object(dbus_busname, clientpath)
1645
old_value = client.attributes[self.propname]
1646
self.assertNotIsInstance(old_value, self.Unique)
1647
client.attributes[self.propname] = self.Unique()
1648
self.run_command(value_to_set, self.clients)
1649
for clientpath in self.clients:
1650
client = self.bus.get_object(dbus_busname, clientpath)
1651
value = client.attributes[self.propname]
1652
self.assertNotIsInstance(value, self.Unique)
1653
self.assertEqual(value, value_to_get)
1655
class Unique(object):
1656
"""Class for objects which exist only to be unique objects,
1657
since unittest.mock.sentinel only exists in Python 3.3"""
1659
def run_command(self, value, clients):
1660
self.command().run(clients, self.bus)
1663
class TestEnableCmd(TestPropertyCmd):
1665
propname = "Enabled"
1666
values_to_set = [dbus.Boolean(True)]
1669
class TestDisableCmd(TestPropertyCmd):
1670
command = DisableCmd
1671
propname = "Enabled"
1672
values_to_set = [dbus.Boolean(False)]
1675
class TestBumpTimeoutCmd(TestPropertyCmd):
1676
command = BumpTimeoutCmd
1677
propname = "LastCheckedOK"
1678
values_to_set = [""]
1681
class TestStartCheckerCmd(TestPropertyCmd):
1682
command = StartCheckerCmd
1683
propname = "CheckerRunning"
1684
values_to_set = [dbus.Boolean(True)]
1687
class TestStopCheckerCmd(TestPropertyCmd):
1688
command = StopCheckerCmd
1689
propname = "CheckerRunning"
1690
values_to_set = [dbus.Boolean(False)]
1693
class TestApproveByDefaultCmd(TestPropertyCmd):
1694
command = ApproveByDefaultCmd
1695
propname = "ApprovedByDefault"
1696
values_to_set = [dbus.Boolean(True)]
1699
class TestDenyByDefaultCmd(TestPropertyCmd):
1700
command = DenyByDefaultCmd
1701
propname = "ApprovedByDefault"
1702
values_to_set = [dbus.Boolean(False)]
1705
class TestPropertyValueCmd(TestPropertyCmd):
1706
"""Abstract class for tests of PropertyValueCmd classes"""
1709
if type(self) is TestPropertyValueCmd:
1711
return super(TestPropertyValueCmd, self).runTest()
1713
def run_command(self, value, clients):
1714
self.command(value).run(clients, self.bus)
1717
class TestSetCheckerCmd(TestPropertyValueCmd):
1718
command = SetCheckerCmd
1719
propname = "Checker"
1720
values_to_set = ["", ":", "fping -q -- %s"]
1723
class TestSetHostCmd(TestPropertyValueCmd):
1724
command = SetHostCmd
1726
values_to_set = ["192.0.2.3", "foo.example.org"]
1729
class TestSetSecretCmd(TestPropertyValueCmd):
1730
command = SetSecretCmd
1732
values_to_set = [io.BytesIO(b""),
1733
io.BytesIO(b"secret\0xyzzy\nbar")]
1734
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1737
class TestSetTimeoutCmd(TestPropertyValueCmd):
1738
command = SetTimeoutCmd
1739
propname = "Timeout"
1740
values_to_set = [datetime.timedelta(),
1741
datetime.timedelta(minutes=5),
1742
datetime.timedelta(seconds=1),
1743
datetime.timedelta(weeks=1),
1744
datetime.timedelta(weeks=52)]
1745
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1748
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1749
command = SetExtendedTimeoutCmd
1750
propname = "ExtendedTimeout"
1751
values_to_set = [datetime.timedelta(),
1752
datetime.timedelta(minutes=5),
1753
datetime.timedelta(seconds=1),
1754
datetime.timedelta(weeks=1),
1755
datetime.timedelta(weeks=52)]
1756
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1759
class TestSetIntervalCmd(TestPropertyValueCmd):
1760
command = SetIntervalCmd
1761
propname = "Interval"
1762
values_to_set = [datetime.timedelta(),
1763
datetime.timedelta(minutes=5),
1764
datetime.timedelta(seconds=1),
1765
datetime.timedelta(weeks=1),
1766
datetime.timedelta(weeks=52)]
1767
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1770
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1771
command = SetApprovalDelayCmd
1772
propname = "ApprovalDelay"
1773
values_to_set = [datetime.timedelta(),
1774
datetime.timedelta(minutes=5),
1775
datetime.timedelta(seconds=1),
1776
datetime.timedelta(weeks=1),
1777
datetime.timedelta(weeks=52)]
1778
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1781
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1782
command = SetApprovalDurationCmd
1783
propname = "ApprovalDuration"
1784
values_to_set = [datetime.timedelta(),
1785
datetime.timedelta(minutes=5),
1786
datetime.timedelta(seconds=1),
1787
datetime.timedelta(weeks=1),
1788
datetime.timedelta(weeks=52)]
1789
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1793
def should_only_run_tests():
1794
parser = argparse.ArgumentParser(add_help=False)
1795
parser.add_argument("--check", action='store_true')
1796
args, unknown_args = parser.parse_known_args()
1797
run_tests = args.check
1799
# Remove --check argument from sys.argv
1800
sys.argv[1:] = unknown_args
1803
# Add all tests from doctest strings
1804
def load_tests(loader, tests, none):
1806
tests.addTests(doctest.DocTestSuite())
381
except dbus.exceptions.DBusException as e:
382
print("Access denied: "
383
"Accessing mandos server through D-Bus: {}".format(e),
387
# Compile dict of (clients: properties) to process
390
if options.all or not options.client:
391
clients = {bus.get_object(busname, path): properties
392
for path, properties in mandos_clients.items()}
394
for name in options.client:
395
for path, client in mandos_clients.items():
396
if client["Name"] == name:
397
client_objc = bus.get_object(busname, path)
398
clients[client_objc] = client
401
print("Client not found on server: {!r}"
402
.format(name), file=sys.stderr)
405
if not has_actions(options) and clients:
406
if options.verbose or options.dump_json:
407
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
408
"Created", "Interval", "Host", "KeyID",
409
"Fingerprint", "CheckerRunning",
410
"LastEnabled", "ApprovalPending",
411
"ApprovedByDefault", "LastApprovalRequest",
412
"ApprovalDelay", "ApprovalDuration",
413
"Checker", "ExtendedTimeout", "Expires",
416
keywords = defaultkeywords
418
if options.dump_json:
419
json.dump({client["Name"]: {key:
421
if isinstance(client[key],
425
for client in clients.values()},
426
fp=sys.stdout, indent=4,
427
separators=(',', ': '))
430
print_clients(clients.values(), keywords)
432
# Process each client in the list by all selected options
433
for client in clients:
435
def set_client_prop(prop, value):
436
"""Set a Client D-Bus property"""
437
client.Set(client_interface, prop, value,
438
dbus_interface=dbus.PROPERTIES_IFACE)
440
def set_client_prop_ms(prop, value):
441
"""Set a Client D-Bus property, converted
442
from a string to milliseconds."""
443
set_client_prop(prop,
444
string_to_delta(value).total_seconds()
448
mandos_serv.RemoveClient(client.__dbus_object_path__)
450
set_client_prop("Enabled", dbus.Boolean(True))
452
set_client_prop("Enabled", dbus.Boolean(False))
453
if options.bump_timeout:
454
set_client_prop("LastCheckedOK", "")
455
if options.start_checker:
456
set_client_prop("CheckerRunning", dbus.Boolean(True))
457
if options.stop_checker:
458
set_client_prop("CheckerRunning", dbus.Boolean(False))
459
if options.is_enabled:
460
if client.Get(client_interface, "Enabled",
461
dbus_interface=dbus.PROPERTIES_IFACE):
465
if options.checker is not None:
466
set_client_prop("Checker", options.checker)
467
if options.host is not None:
468
set_client_prop("Host", options.host)
469
if options.interval is not None:
470
set_client_prop_ms("Interval", options.interval)
471
if options.approval_delay is not None:
472
set_client_prop_ms("ApprovalDelay",
473
options.approval_delay)
474
if options.approval_duration is not None:
475
set_client_prop_ms("ApprovalDuration",
476
options.approval_duration)
477
if options.timeout is not None:
478
set_client_prop_ms("Timeout", options.timeout)
479
if options.extended_timeout is not None:
480
set_client_prop_ms("ExtendedTimeout",
481
options.extended_timeout)
482
if options.secret is not None:
483
set_client_prop("Secret",
484
dbus.ByteArray(options.secret.read()))
485
if options.approved_by_default is not None:
486
set_client_prop("ApprovedByDefault",
488
.approved_by_default))
490
client.Approve(dbus.Boolean(True),
491
dbus_interface=client_interface)
493
client.Approve(dbus.Boolean(False),
494
dbus_interface=client_interface)
1809
497
if __name__ == "__main__":
1811
if should_only_run_tests():
1812
# Call using ./tdd-python-script --check [--verbose]