421
357
parser.error("--dump-json can only be used alone.")
422
358
if options.all and not has_actions(options):
423
359
parser.error("--all requires an action.")
424
if options.is_enabled and len(options.client) > 1:
425
parser.error("--is-enabled requires exactly one client")
427
options.remove = False
428
if has_actions(options) and not options.deny:
429
parser.error("--remove can only be combined with --deny")
430
options.remove = True
433
def get_mandos_dbus_object(bus):
435
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
436
dbus_busname, server_dbus_path)
437
mandos_dbus_object = bus.get_object(dbus_busname,
362
bus = dbus.SystemBus()
363
mandos_dbus_objc = bus.get_object(busname, server_path)
439
364
except dbus.exceptions.DBusException:
440
365
log.critical("Could not connect to Mandos server")
443
return mandos_dbus_object
446
class SilenceLogger(object):
447
"Simple context manager to silence a particular logger"
448
def __init__(self, loggername):
449
self.logger = logging.getLogger(loggername)
452
self.logger.addFilter(self.nullfilter)
455
class NullFilter(logging.Filter):
456
def filter(self, record):
459
nullfilter = NullFilter()
461
def __exit__(self, exc_type, exc_val, exc_tb):
462
self.logger.removeFilter(self.nullfilter)
465
def commands_from_options(options):
469
if options.is_enabled:
470
commands.append(IsEnabledCmd())
473
commands.append(ApproveCmd())
476
commands.append(DenyCmd())
479
commands.append(RemoveCmd())
481
if options.dump_json:
482
commands.append(DumpJSONCmd())
485
commands.append(EnableCmd())
488
commands.append(DisableCmd())
490
if options.bump_timeout:
491
commands.append(BumpTimeoutCmd())
493
if options.start_checker:
494
commands.append(StartCheckerCmd())
496
if options.stop_checker:
497
commands.append(StopCheckerCmd())
499
if options.approved_by_default is not None:
500
if options.approved_by_default:
501
commands.append(ApproveByDefaultCmd())
503
commands.append(DenyByDefaultCmd())
505
if options.checker is not None:
506
commands.append(SetCheckerCmd(options.checker))
508
if options.host is not None:
509
commands.append(SetHostCmd(options.host))
511
if options.secret is not None:
512
commands.append(SetSecretCmd(options.secret))
514
if options.timeout is not None:
515
commands.append(SetTimeoutCmd(options.timeout))
517
if options.extended_timeout:
519
SetExtendedTimeoutCmd(options.extended_timeout))
521
if options.interval is not None:
522
commands.append(SetIntervalCmd(options.interval))
524
if options.approval_delay is not None:
525
commands.append(SetApprovalDelayCmd(options.approval_delay))
527
if options.approval_duration is not None:
529
SetApprovalDurationCmd(options.approval_duration))
531
# If no command option has been given, show table of clients,
532
# optionally verbosely
534
commands.append(PrintTableCmd(verbose=options.verbose))
539
class Command(object):
540
"""Abstract class for commands"""
541
def run(self, clients, bus=None, mandos=None):
542
"""Normal commands should implement run_on_one_client(), but
543
commands which want to operate on all clients at the same time
544
can override this run() method instead."""
546
for clientpath, properties in clients.items():
547
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
548
dbus_busname, str(clientpath))
549
client = bus.get_object(dbus_busname, clientpath)
550
self.run_on_one_client(client, properties)
553
class IsEnabledCmd(Command):
554
def run(self, clients, bus=None, mandos=None):
555
client, properties = next(iter(clients.items()))
556
if self.is_enabled(client, properties):
559
def is_enabled(self, client, properties):
560
return properties["Enabled"]
563
class ApproveCmd(Command):
564
def run_on_one_client(self, client, properties):
565
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
566
client.__dbus_object_path__, client_dbus_interface)
567
client.Approve(dbus.Boolean(True),
568
dbus_interface=client_dbus_interface)
571
class DenyCmd(Command):
572
def run_on_one_client(self, client, properties):
573
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
574
client.__dbus_object_path__, client_dbus_interface)
575
client.Approve(dbus.Boolean(False),
576
dbus_interface=client_dbus_interface)
579
class RemoveCmd(Command):
580
def run_on_one_client(self, client, properties):
581
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
582
server_dbus_path, server_dbus_interface,
583
str(client.__dbus_object_path__))
584
self.mandos.RemoveClient(client.__dbus_object_path__)
587
class OutputCmd(Command):
588
"""Abstract class for commands outputting client details"""
589
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
590
"Created", "Interval", "Host", "KeyID",
591
"Fingerprint", "CheckerRunning", "LastEnabled",
592
"ApprovalPending", "ApprovedByDefault",
593
"LastApprovalRequest", "ApprovalDelay",
594
"ApprovalDuration", "Checker", "ExtendedTimeout",
595
"Expires", "LastCheckerStatus")
597
def run(self, clients, bus=None, mandos=None):
598
print(self.output(clients.values()))
600
def output(self, clients):
601
raise NotImplementedError()
604
class DumpJSONCmd(OutputCmd):
605
def output(self, clients):
606
data = {client["Name"]:
607
{key: self.dbus_boolean_to_bool(client[key])
608
for key in self.all_keywords}
609
for client in clients}
610
return json.dumps(data, indent=4, separators=(',', ': '))
613
def dbus_boolean_to_bool(value):
614
if isinstance(value, dbus.Boolean):
619
class PrintTableCmd(OutputCmd):
620
def __init__(self, verbose=False):
621
self.verbose = verbose
623
def output(self, clients):
624
default_keywords = ("Name", "Enabled", "Timeout",
626
keywords = default_keywords
628
keywords = self.all_keywords
629
return str(self.TableOfClients(clients, keywords))
631
class TableOfClients(object):
634
"Enabled": "Enabled",
635
"Timeout": "Timeout",
636
"LastCheckedOK": "Last Successful Check",
637
"LastApprovalRequest": "Last Approval Request",
638
"Created": "Created",
639
"Interval": "Interval",
641
"Fingerprint": "Fingerprint",
643
"CheckerRunning": "Check Is Running",
644
"LastEnabled": "Last Enabled",
645
"ApprovalPending": "Approval Is Pending",
646
"ApprovedByDefault": "Approved By Default",
647
"ApprovalDelay": "Approval Delay",
648
"ApprovalDuration": "Approval Duration",
649
"Checker": "Checker",
650
"ExtendedTimeout": "Extended Timeout",
651
"Expires": "Expires",
652
"LastCheckerStatus": "Last Checker Status",
655
def __init__(self, clients, keywords):
656
self.clients = clients
657
self.keywords = keywords
660
return "\n".join(self.rows())
662
if sys.version_info.major == 2:
663
__unicode__ = __str__
665
return str(self).encode(locale.getpreferredencoding())
668
format_string = self.row_formatting_string()
669
rows = [self.header_line(format_string)]
670
rows.extend(self.client_line(client, format_string)
671
for client in self.clients)
674
def row_formatting_string(self):
675
"Format string used to format table rows"
676
return " ".join("{{{key}:{width}}}".format(
677
width=max(len(self.tableheaders[key]),
678
*(len(self.string_from_client(client, key))
679
for client in self.clients)),
681
for key in self.keywords)
683
def string_from_client(self, client, key):
684
return self.valuetostring(client[key], key)
687
def valuetostring(cls, value, keyword):
688
if isinstance(value, dbus.Boolean):
689
return "Yes" if value else "No"
690
if keyword in ("Timeout", "Interval", "ApprovalDelay",
691
"ApprovalDuration", "ExtendedTimeout"):
692
return cls.milliseconds_to_string(value)
695
def header_line(self, format_string):
696
return format_string.format(**self.tableheaders)
698
def client_line(self, client, format_string):
699
return format_string.format(
700
**{key: self.string_from_client(client, key)
701
for key in self.keywords})
704
def milliseconds_to_string(ms):
705
td = datetime.timedelta(0, 0, 0, ms)
706
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
707
.format(days="{}T".format(td.days)
709
hours=td.seconds // 3600,
710
minutes=(td.seconds % 3600) // 60,
711
seconds=td.seconds % 60))
714
class PropertyCmd(Command):
715
"""Abstract class for Actions for setting one client property"""
717
def run_on_one_client(self, client, properties):
718
"""Set the Client's D-Bus property"""
719
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
720
client.__dbus_object_path__,
721
dbus.PROPERTIES_IFACE, client_dbus_interface,
722
self.propname, self.value_to_set
723
if not isinstance(self.value_to_set, dbus.Boolean)
724
else bool(self.value_to_set))
725
client.Set(client_dbus_interface, self.propname,
727
dbus_interface=dbus.PROPERTIES_IFACE)
731
raise NotImplementedError()
734
class EnableCmd(PropertyCmd):
736
value_to_set = dbus.Boolean(True)
739
class DisableCmd(PropertyCmd):
741
value_to_set = dbus.Boolean(False)
744
class BumpTimeoutCmd(PropertyCmd):
745
propname = "LastCheckedOK"
749
class StartCheckerCmd(PropertyCmd):
750
propname = "CheckerRunning"
751
value_to_set = dbus.Boolean(True)
754
class StopCheckerCmd(PropertyCmd):
755
propname = "CheckerRunning"
756
value_to_set = dbus.Boolean(False)
759
class ApproveByDefaultCmd(PropertyCmd):
760
propname = "ApprovedByDefault"
761
value_to_set = dbus.Boolean(True)
764
class DenyByDefaultCmd(PropertyCmd):
765
propname = "ApprovedByDefault"
766
value_to_set = dbus.Boolean(False)
769
class PropertyValueCmd(PropertyCmd):
770
"""Abstract class for PropertyCmd recieving a value as argument"""
771
def __init__(self, value):
772
self.value_to_set = value
775
class SetCheckerCmd(PropertyValueCmd):
779
class SetHostCmd(PropertyValueCmd):
783
class SetSecretCmd(PropertyValueCmd):
787
def value_to_set(self):
791
def value_to_set(self, value):
792
"""When setting, read data from supplied file object"""
793
self._vts = value.read()
797
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
798
"""Abstract class for PropertyValueCmd taking a value argument as
799
a datetime.timedelta() but should store it as milliseconds."""
802
def value_to_set(self):
806
def value_to_set(self, value):
807
"""When setting, convert value from a datetime.timedelta"""
808
self._vts = int(round(value.total_seconds() * 1000))
811
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
815
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
816
propname = "ExtendedTimeout"
819
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
820
propname = "Interval"
823
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
824
propname = "ApprovalDelay"
827
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
828
propname = "ApprovalDuration"
832
class Test_string_to_delta(unittest.TestCase):
833
def test_handles_basic_rfc3339(self):
834
self.assertEqual(string_to_delta("PT0S"),
835
datetime.timedelta())
836
self.assertEqual(string_to_delta("P0D"),
837
datetime.timedelta())
838
self.assertEqual(string_to_delta("PT1S"),
839
datetime.timedelta(0, 1))
840
self.assertEqual(string_to_delta("PT2H"),
841
datetime.timedelta(0, 7200))
843
def test_falls_back_to_pre_1_6_1_with_warning(self):
844
# assertLogs only exists in Python 3.4
845
if hasattr(self, "assertLogs"):
846
with self.assertLogs(log, logging.WARNING):
847
value = string_to_delta("2h")
849
class WarningFilter(logging.Filter):
850
"""Don't show, but record the presence of, warnings"""
851
def filter(self, record):
852
is_warning = record.levelno >= logging.WARNING
853
self.found = is_warning or getattr(self, "found",
855
return not is_warning
856
warning_filter = WarningFilter()
857
log.addFilter(warning_filter)
859
value = string_to_delta("2h")
861
log.removeFilter(warning_filter)
862
self.assertTrue(getattr(warning_filter, "found", False))
863
self.assertEqual(value, datetime.timedelta(0, 7200))
866
class Test_check_option_syntax(unittest.TestCase):
868
self.parser = argparse.ArgumentParser()
869
add_command_line_options(self.parser)
871
def test_actions_requires_client_or_all(self):
872
for action, value in self.actions.items():
873
options = self.parser.parse_args()
874
setattr(options, action, value)
875
with self.assertParseError():
876
self.check_option_syntax(options)
878
# This mostly corresponds to the definition from has_actions() in
879
# check_option_syntax()
881
# The actual values set here are not that important, but we do
882
# at least stick to the correct types, even though they are
886
"bump_timeout": True,
887
"start_checker": True,
888
"stop_checker": True,
892
"timeout": datetime.timedelta(),
893
"extended_timeout": datetime.timedelta(),
894
"interval": datetime.timedelta(),
895
"approved_by_default": True,
896
"approval_delay": datetime.timedelta(),
897
"approval_duration": datetime.timedelta(),
899
"secret": io.BytesIO(b"x"),
904
@contextlib.contextmanager
905
def assertParseError(self):
906
with self.assertRaises(SystemExit) as e:
907
with self.temporarily_suppress_stderr():
909
# Exit code from argparse is guaranteed to be "2". Reference:
910
# https://docs.python.org/3/library
911
# /argparse.html#exiting-methods
912
self.assertEqual(e.exception.code, 2)
915
@contextlib.contextmanager
916
def temporarily_suppress_stderr():
917
null = os.open(os.path.devnull, os.O_RDWR)
918
stderrcopy = os.dup(sys.stderr.fileno())
919
os.dup2(null, sys.stderr.fileno())
368
mandos_serv = dbus.Interface(mandos_dbus_objc,
369
dbus_interface=server_interface)
370
mandos_serv_object_manager = dbus.Interface(
371
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
373
# block stderr since dbus library prints to stderr
374
null = os.open(os.path.devnull, os.O_RDWR)
375
stderrcopy = os.dup(sys.stderr.fileno())
376
os.dup2(null, sys.stderr.fileno())
380
mandos_clients = {path: ifs_and_props[client_interface]
381
for path, ifs_and_props in
382
mandos_serv_object_manager
383
.GetManagedObjects().items()
384
if client_interface in ifs_and_props}
925
387
os.dup2(stderrcopy, sys.stderr.fileno())
926
388
os.close(stderrcopy)
928
def check_option_syntax(self, options):
929
check_option_syntax(self.parser, options)
931
def test_actions_conflicts_with_verbose(self):
932
for action, value in self.actions.items():
933
options = self.parser.parse_args()
934
setattr(options, action, value)
935
options.verbose = True
936
with self.assertParseError():
937
self.check_option_syntax(options)
939
def test_dump_json_conflicts_with_verbose(self):
940
options = self.parser.parse_args()
941
options.dump_json = True
942
options.verbose = True
943
with self.assertParseError():
944
self.check_option_syntax(options)
946
def test_dump_json_conflicts_with_action(self):
947
for action, value in self.actions.items():
948
options = self.parser.parse_args()
949
setattr(options, action, value)
950
options.dump_json = True
951
with self.assertParseError():
952
self.check_option_syntax(options)
954
def test_all_can_not_be_alone(self):
955
options = self.parser.parse_args()
957
with self.assertParseError():
958
self.check_option_syntax(options)
960
def test_all_is_ok_with_any_action(self):
961
for action, value in self.actions.items():
962
options = self.parser.parse_args()
963
setattr(options, action, value)
965
self.check_option_syntax(options)
967
def test_is_enabled_fails_without_client(self):
968
options = self.parser.parse_args()
969
options.is_enabled = True
970
with self.assertParseError():
971
self.check_option_syntax(options)
973
def test_is_enabled_works_with_one_client(self):
974
options = self.parser.parse_args()
975
options.is_enabled = True
976
options.client = ["foo"]
977
self.check_option_syntax(options)
979
def test_is_enabled_fails_with_two_clients(self):
980
options = self.parser.parse_args()
981
options.is_enabled = True
982
options.client = ["foo", "barbar"]
983
with self.assertParseError():
984
self.check_option_syntax(options)
986
def test_remove_can_only_be_combined_with_action_deny(self):
987
for action, value in self.actions.items():
988
if action in {"remove", "deny"}:
990
options = self.parser.parse_args()
991
setattr(options, action, value)
993
options.remove = True
994
with self.assertParseError():
995
self.check_option_syntax(options)
998
class Test_get_mandos_dbus_object(unittest.TestCase):
999
def test_calls_and_returns_get_object_on_bus(self):
1000
class MockBus(object):
1002
def get_object(mockbus_self, busname, dbus_path):
1003
# Note that "self" is still the testcase instance,
1004
# this MockBus instance is in "mockbus_self".
1005
self.assertEqual(busname, dbus_busname)
1006
self.assertEqual(dbus_path, server_dbus_path)
1007
mockbus_self.called = True
1010
mockbus = get_mandos_dbus_object(bus=MockBus())
1011
self.assertIsInstance(mockbus, MockBus)
1012
self.assertTrue(mockbus.called)
1014
def test_logs_and_exits_on_dbus_error(self):
1015
class MockBusFailing(object):
1016
def get_object(self, busname, dbus_path):
1017
raise dbus.exceptions.DBusException("Test")
1019
# assertLogs only exists in Python 3.4
1020
if hasattr(self, "assertLogs"):
1021
with self.assertLogs(log, logging.CRITICAL):
1022
with self.assertRaises(SystemExit) as e:
1023
bus = get_mandos_dbus_object(bus=MockBus())
1025
critical_filter = self.CriticalFilter()
1026
log.addFilter(critical_filter)
1028
with self.assertRaises(SystemExit) as e:
1029
get_mandos_dbus_object(bus=MockBusFailing())
1031
log.removeFilter(critical_filter)
1032
self.assertTrue(critical_filter.found)
1033
if isinstance(e.exception.code, int):
1034
self.assertNotEqual(e.exception.code, 0)
1036
self.assertIsNotNone(e.exception.code)
1038
class CriticalFilter(logging.Filter):
1039
"""Don't show, but register, critical messages"""
1041
def filter(self, record):
1042
is_critical = record.levelno >= logging.CRITICAL
1043
self.found = is_critical or self.found
1044
return not is_critical
1047
class Test_SilenceLogger(unittest.TestCase):
1048
loggername = "mandos-ctl.Test_SilenceLogger"
1049
log = logging.getLogger(loggername)
1050
log.propagate = False
1051
log.addHandler(logging.NullHandler())
1054
self.counting_filter = self.CountingFilter()
1056
class CountingFilter(logging.Filter):
1057
"Count number of records"
1059
def filter(self, record):
1063
def test_should_filter_records_only_when_active(self):
1065
with SilenceLogger(self.loggername):
1066
self.log.addFilter(self.counting_filter)
1067
self.log.info("Filtered log message 1")
1068
self.log.info("Non-filtered message 2")
1069
self.log.info("Non-filtered message 3")
1071
self.log.removeFilter(self.counting_filter)
1072
self.assertEqual(self.counting_filter.count, 2)
1075
class Test_commands_from_options(unittest.TestCase):
1077
self.parser = argparse.ArgumentParser()
1078
add_command_line_options(self.parser)
1080
def test_is_enabled(self):
1081
self.assert_command_from_args(["--is-enabled", "foo"],
1084
def assert_command_from_args(self, args, command_cls,
1086
"""Assert that parsing ARGS should result in an instance of
1087
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1088
options = self.parser.parse_args(args)
1089
check_option_syntax(self.parser, options)
1090
commands = commands_from_options(options)
1091
self.assertEqual(len(commands), 1)
1092
command = commands[0]
1093
self.assertIsInstance(command, command_cls)
1094
for key, value in cmd_attrs.items():
1095
self.assertEqual(getattr(command, key), value)
1097
def test_is_enabled_short(self):
1098
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1100
def test_approve(self):
1101
self.assert_command_from_args(["--approve", "foo"],
1104
def test_approve_short(self):
1105
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1107
def test_deny(self):
1108
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1110
def test_deny_short(self):
1111
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1113
def test_remove(self):
1114
self.assert_command_from_args(["--remove", "foo"],
1117
def test_deny_before_remove(self):
1118
options = self.parser.parse_args(["--deny", "--remove",
1120
check_option_syntax(self.parser, options)
1121
commands = commands_from_options(options)
1122
self.assertEqual(len(commands), 2)
1123
self.assertIsInstance(commands[0], DenyCmd)
1124
self.assertIsInstance(commands[1], RemoveCmd)
1126
def test_deny_before_remove_reversed(self):
1127
options = self.parser.parse_args(["--remove", "--deny",
1129
check_option_syntax(self.parser, options)
1130
commands = commands_from_options(options)
1131
self.assertEqual(len(commands), 2)
1132
self.assertIsInstance(commands[0], DenyCmd)
1133
self.assertIsInstance(commands[1], RemoveCmd)
1135
def test_remove_short(self):
1136
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1138
def test_dump_json(self):
1139
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1141
def test_enable(self):
1142
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1144
def test_enable_short(self):
1145
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1147
def test_disable(self):
1148
self.assert_command_from_args(["--disable", "foo"],
1151
def test_disable_short(self):
1152
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1154
def test_bump_timeout(self):
1155
self.assert_command_from_args(["--bump-timeout", "foo"],
1158
def test_bump_timeout_short(self):
1159
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1161
def test_start_checker(self):
1162
self.assert_command_from_args(["--start-checker", "foo"],
1165
def test_stop_checker(self):
1166
self.assert_command_from_args(["--stop-checker", "foo"],
1169
def test_approve_by_default(self):
1170
self.assert_command_from_args(["--approve-by-default", "foo"],
1171
ApproveByDefaultCmd)
1173
def test_deny_by_default(self):
1174
self.assert_command_from_args(["--deny-by-default", "foo"],
1177
def test_checker(self):
1178
self.assert_command_from_args(["--checker", ":", "foo"],
1179
SetCheckerCmd, value_to_set=":")
1181
def test_checker_empty(self):
1182
self.assert_command_from_args(["--checker", "", "foo"],
1183
SetCheckerCmd, value_to_set="")
1185
def test_checker_short(self):
1186
self.assert_command_from_args(["-c", ":", "foo"],
1187
SetCheckerCmd, value_to_set=":")
1189
def test_host(self):
1190
self.assert_command_from_args(["--host", "foo.example.org",
1192
value_to_set="foo.example.org")
1194
def test_host_short(self):
1195
self.assert_command_from_args(["-H", "foo.example.org",
1197
value_to_set="foo.example.org")
1199
def test_secret_devnull(self):
1200
self.assert_command_from_args(["--secret", os.path.devnull,
1201
"foo"], SetSecretCmd,
1204
def test_secret_tempfile(self):
1205
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1206
value = b"secret\0xyzzy\nbar"
1209
self.assert_command_from_args(["--secret", f.name,
1210
"foo"], SetSecretCmd,
1213
def test_secret_devnull_short(self):
1214
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1215
SetSecretCmd, value_to_set=b"")
1217
def test_secret_tempfile_short(self):
1218
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1219
value = b"secret\0xyzzy\nbar"
1222
self.assert_command_from_args(["-s", f.name, "foo"],
1226
def test_timeout(self):
1227
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1229
value_to_set=300000)
1231
def test_timeout_short(self):
1232
self.assert_command_from_args(["-t", "PT5M", "foo"],
1234
value_to_set=300000)
1236
def test_extended_timeout(self):
1237
self.assert_command_from_args(["--extended-timeout", "PT15M",
1239
SetExtendedTimeoutCmd,
1240
value_to_set=900000)
1242
def test_interval(self):
1243
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1245
value_to_set=120000)
1247
def test_interval_short(self):
1248
self.assert_command_from_args(["-i", "PT2M", "foo"],
1250
value_to_set=120000)
1252
def test_approval_delay(self):
1253
self.assert_command_from_args(["--approval-delay", "PT30S",
1254
"foo"], SetApprovalDelayCmd,
1257
def test_approval_duration(self):
1258
self.assert_command_from_args(["--approval-duration", "PT1S",
1259
"foo"], SetApprovalDurationCmd,
1262
def test_print_table(self):
1263
self.assert_command_from_args([], PrintTableCmd,
1266
def test_print_table_verbose(self):
1267
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1270
def test_print_table_verbose_short(self):
1271
self.assert_command_from_args(["-v"], PrintTableCmd,
1275
class TestCmd(unittest.TestCase):
1276
"""Abstract class for tests of command classes"""
1280
class MockClient(object):
1281
def __init__(self, name, **attributes):
1282
self.__dbus_object_path__ = "/clients/{}".format(name)
1283
self.attributes = attributes
1284
self.attributes["Name"] = name
1286
def Set(self, interface, propname, value, dbus_interface):
1287
testcase.assertEqual(interface, client_dbus_interface)
1288
testcase.assertEqual(dbus_interface,
1289
dbus.PROPERTIES_IFACE)
1290
self.attributes[propname] = value
1291
def Get(self, interface, propname, dbus_interface):
1292
testcase.assertEqual(interface, client_dbus_interface)
1293
testcase.assertEqual(dbus_interface,
1294
dbus.PROPERTIES_IFACE)
1295
return self.attributes[propname]
1296
def Approve(self, approve, dbus_interface):
1297
testcase.assertEqual(dbus_interface,
1298
client_dbus_interface)
1299
self.calls.append(("Approve", (approve,
1301
self.client = MockClient(
1303
KeyID=("92ed150794387c03ce684574b1139a65"
1304
"94a34f895daaaf09fd8ea90a27cddb12"),
1306
Host="foo.example.org",
1307
Enabled=dbus.Boolean(True),
1309
LastCheckedOK="2019-02-03T00:00:00",
1310
Created="2019-01-02T00:00:00",
1312
Fingerprint=("778827225BA7DE539C5A"
1313
"7CFA59CFF7CDBD9A5920"),
1314
CheckerRunning=dbus.Boolean(False),
1315
LastEnabled="2019-01-03T00:00:00",
1316
ApprovalPending=dbus.Boolean(False),
1317
ApprovedByDefault=dbus.Boolean(True),
1318
LastApprovalRequest="",
1320
ApprovalDuration=1000,
1321
Checker="fping -q -- %(host)s",
1322
ExtendedTimeout=900000,
1323
Expires="2019-02-04T00:00:00",
1324
LastCheckerStatus=0)
1325
self.other_client = MockClient(
1327
KeyID=("0558568eedd67d622f5c83b35a115f79"
1328
"6ab612cff5ad227247e46c2b020f441c"),
1329
Secret=b"secretbar",
1331
Enabled=dbus.Boolean(True),
1333
LastCheckedOK="2019-02-04T00:00:00",
1334
Created="2019-01-03T00:00:00",
1336
Fingerprint=("3E393AEAEFB84C7E89E2"
1337
"F547B3A107558FCA3A27"),
1338
CheckerRunning=dbus.Boolean(True),
1339
LastEnabled="2019-01-04T00:00:00",
1340
ApprovalPending=dbus.Boolean(False),
1341
ApprovedByDefault=dbus.Boolean(False),
1342
LastApprovalRequest="2019-01-03T00:00:00",
1343
ApprovalDelay=30000,
1344
ApprovalDuration=93785000,
1346
ExtendedTimeout=900000,
1347
Expires="2019-02-05T00:00:00",
1348
LastCheckerStatus=-2)
1349
self.clients = collections.OrderedDict(
1351
("/clients/foo", self.client.attributes),
1352
("/clients/barbar", self.other_client.attributes),
1354
self.one_client = {"/clients/foo": self.client.attributes}
1360
def get_object(client_bus_name, path):
1361
self.assertEqual(client_bus_name, dbus_busname)
1363
# Note: "self" here is the TestCmd instance, not
1364
# the Bus instance, since this is a static method!
1365
"/clients/foo": self.client,
1366
"/clients/barbar": self.other_client,
1371
class TestIsEnabledCmd(TestCmd):
1372
def test_is_enabled(self):
1373
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1375
for client, properties
1376
in self.clients.items()))
1378
def test_is_enabled_run_exits_successfully(self):
1379
with self.assertRaises(SystemExit) as e:
1380
IsEnabledCmd().run(self.one_client)
1381
if e.exception.code is not None:
1382
self.assertEqual(e.exception.code, 0)
1384
self.assertIsNone(e.exception.code)
1386
def test_is_enabled_run_exits_with_failure(self):
1387
self.client.attributes["Enabled"] = dbus.Boolean(False)
1388
with self.assertRaises(SystemExit) as e:
1389
IsEnabledCmd().run(self.one_client)
1390
if isinstance(e.exception.code, int):
1391
self.assertNotEqual(e.exception.code, 0)
1393
self.assertIsNotNone(e.exception.code)
1396
class TestApproveCmd(TestCmd):
1397
def test_approve(self):
1398
ApproveCmd().run(self.clients, self.bus)
1399
for clientpath in self.clients:
1400
client = self.bus.get_object(dbus_busname, clientpath)
1401
self.assertIn(("Approve", (True, client_dbus_interface)),
1405
class TestDenyCmd(TestCmd):
1406
def test_deny(self):
1407
DenyCmd().run(self.clients, self.bus)
1408
for clientpath in self.clients:
1409
client = self.bus.get_object(dbus_busname, clientpath)
1410
self.assertIn(("Approve", (False, client_dbus_interface)),
1414
class TestRemoveCmd(TestCmd):
1415
def test_remove(self):
1416
class MockMandos(object):
1419
def RemoveClient(self, dbus_path):
1420
self.calls.append(("RemoveClient", (dbus_path,)))
1421
mandos = MockMandos()
1422
super(TestRemoveCmd, self).setUp()
1423
RemoveCmd().run(self.clients, self.bus, mandos)
1424
self.assertEqual(len(mandos.calls), 2)
1425
for clientpath in self.clients:
1426
self.assertIn(("RemoveClient", (clientpath,)),
1430
class TestDumpJSONCmd(TestCmd):
1432
self.expected_json = {
1435
"KeyID": ("92ed150794387c03ce684574b1139a65"
1436
"94a34f895daaaf09fd8ea90a27cddb12"),
1437
"Host": "foo.example.org",
1440
"LastCheckedOK": "2019-02-03T00:00:00",
1441
"Created": "2019-01-02T00:00:00",
1443
"Fingerprint": ("778827225BA7DE539C5A"
1444
"7CFA59CFF7CDBD9A5920"),
1445
"CheckerRunning": False,
1446
"LastEnabled": "2019-01-03T00:00:00",
1447
"ApprovalPending": False,
1448
"ApprovedByDefault": True,
1449
"LastApprovalRequest": "",
1451
"ApprovalDuration": 1000,
1452
"Checker": "fping -q -- %(host)s",
1453
"ExtendedTimeout": 900000,
1454
"Expires": "2019-02-04T00:00:00",
1455
"LastCheckerStatus": 0,
1459
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1460
"6ab612cff5ad227247e46c2b020f441c"),
1461
"Host": "192.0.2.3",
1464
"LastCheckedOK": "2019-02-04T00:00:00",
1465
"Created": "2019-01-03T00:00:00",
1467
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1468
"F547B3A107558FCA3A27"),
1469
"CheckerRunning": True,
1470
"LastEnabled": "2019-01-04T00:00:00",
1471
"ApprovalPending": False,
1472
"ApprovedByDefault": False,
1473
"LastApprovalRequest": "2019-01-03T00:00:00",
1474
"ApprovalDelay": 30000,
1475
"ApprovalDuration": 93785000,
1477
"ExtendedTimeout": 900000,
1478
"Expires": "2019-02-05T00:00:00",
1479
"LastCheckerStatus": -2,
1482
return super(TestDumpJSONCmd, self).setUp()
1484
def test_normal(self):
1485
output = DumpJSONCmd().output(self.clients.values())
1486
json_data = json.loads(output)
1487
self.assertDictEqual(json_data, self.expected_json)
1489
def test_one_client(self):
1490
output = DumpJSONCmd().output(self.one_client.values())
1491
json_data = json.loads(output)
1492
expected_json = {"foo": self.expected_json["foo"]}
1493
self.assertDictEqual(json_data, expected_json)
1496
class TestPrintTableCmd(TestCmd):
1497
def test_normal(self):
1498
output = PrintTableCmd().output(self.clients.values())
1499
expected_output = "\n".join((
1500
"Name Enabled Timeout Last Successful Check",
1501
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1502
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1504
self.assertEqual(output, expected_output)
1506
def test_verbose(self):
1507
output = PrintTableCmd(verbose=True).output(
1508
self.clients.values())
1523
"Last Successful Check ",
1524
"2019-02-03T00:00:00 ",
1525
"2019-02-04T00:00:00 ",
1528
"2019-01-02T00:00:00 ",
1529
"2019-01-03T00:00:00 ",
1541
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1543
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1547
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1548
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1550
"Check Is Running ",
1555
"2019-01-03T00:00:00 ",
1556
"2019-01-04T00:00:00 ",
1558
"Approval Is Pending ",
1562
"Approved By Default ",
1566
"Last Approval Request ",
1568
"2019-01-03T00:00:00 ",
1574
"Approval Duration ",
1579
"fping -q -- %(host)s ",
1582
"Extended Timeout ",
1587
"2019-02-04T00:00:00 ",
1588
"2019-02-05T00:00:00 ",
1590
"Last Checker Status",
1595
num_lines = max(len(rows) for rows in columns)
1596
expected_output = "\n".join("".join(rows[line]
1597
for rows in columns)
1598
for line in range(num_lines))
1599
self.assertEqual(output, expected_output)
1601
def test_one_client(self):
1602
output = PrintTableCmd().output(self.one_client.values())
1603
expected_output = "\n".join((
1604
"Name Enabled Timeout Last Successful Check",
1605
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1607
self.assertEqual(output, expected_output)
1610
class TestPropertyCmd(TestCmd):
1611
"""Abstract class for tests of PropertyCmd classes"""
1613
if not hasattr(self, "command"):
1615
values_to_get = getattr(self, "values_to_get",
1617
for value_to_set, value_to_get in zip(self.values_to_set,
1619
for clientpath in self.clients:
1620
client = self.bus.get_object(dbus_busname, clientpath)
1621
old_value = client.attributes[self.propname]
1622
self.assertNotIsInstance(old_value, self.Unique)
1623
client.attributes[self.propname] = self.Unique()
1624
self.run_command(value_to_set, self.clients)
1625
for clientpath in self.clients:
1626
client = self.bus.get_object(dbus_busname, clientpath)
1627
value = client.attributes[self.propname]
1628
self.assertNotIsInstance(value, self.Unique)
1629
self.assertEqual(value, value_to_get)
1631
class Unique(object):
1632
"""Class for objects which exist only to be unique objects,
1633
since unittest.mock.sentinel only exists in Python 3.3"""
1635
def run_command(self, value, clients):
1636
self.command().run(clients, self.bus)
1639
class TestEnableCmd(TestPropertyCmd):
1641
propname = "Enabled"
1642
values_to_set = [dbus.Boolean(True)]
1645
class TestDisableCmd(TestPropertyCmd):
1646
command = DisableCmd
1647
propname = "Enabled"
1648
values_to_set = [dbus.Boolean(False)]
1651
class TestBumpTimeoutCmd(TestPropertyCmd):
1652
command = BumpTimeoutCmd
1653
propname = "LastCheckedOK"
1654
values_to_set = [""]
1657
class TestStartCheckerCmd(TestPropertyCmd):
1658
command = StartCheckerCmd
1659
propname = "CheckerRunning"
1660
values_to_set = [dbus.Boolean(True)]
1663
class TestStopCheckerCmd(TestPropertyCmd):
1664
command = StopCheckerCmd
1665
propname = "CheckerRunning"
1666
values_to_set = [dbus.Boolean(False)]
1669
class TestApproveByDefaultCmd(TestPropertyCmd):
1670
command = ApproveByDefaultCmd
1671
propname = "ApprovedByDefault"
1672
values_to_set = [dbus.Boolean(True)]
1675
class TestDenyByDefaultCmd(TestPropertyCmd):
1676
command = DenyByDefaultCmd
1677
propname = "ApprovedByDefault"
1678
values_to_set = [dbus.Boolean(False)]
1681
class TestPropertyValueCmd(TestPropertyCmd):
1682
"""Abstract class for tests of PropertyValueCmd classes"""
1685
if type(self) is TestPropertyValueCmd:
1687
return super(TestPropertyValueCmd, self).runTest()
1689
def run_command(self, value, clients):
1690
self.command(value).run(clients, self.bus)
1693
class TestSetCheckerCmd(TestPropertyValueCmd):
1694
command = SetCheckerCmd
1695
propname = "Checker"
1696
values_to_set = ["", ":", "fping -q -- %s"]
1699
class TestSetHostCmd(TestPropertyValueCmd):
1700
command = SetHostCmd
1702
values_to_set = ["192.0.2.3", "foo.example.org"]
1705
class TestSetSecretCmd(TestPropertyValueCmd):
1706
command = SetSecretCmd
1708
values_to_set = [io.BytesIO(b""),
1709
io.BytesIO(b"secret\0xyzzy\nbar")]
1710
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1713
class TestSetTimeoutCmd(TestPropertyValueCmd):
1714
command = SetTimeoutCmd
1715
propname = "Timeout"
1716
values_to_set = [datetime.timedelta(),
1717
datetime.timedelta(minutes=5),
1718
datetime.timedelta(seconds=1),
1719
datetime.timedelta(weeks=1),
1720
datetime.timedelta(weeks=52)]
1721
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1724
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1725
command = SetExtendedTimeoutCmd
1726
propname = "ExtendedTimeout"
1727
values_to_set = [datetime.timedelta(),
1728
datetime.timedelta(minutes=5),
1729
datetime.timedelta(seconds=1),
1730
datetime.timedelta(weeks=1),
1731
datetime.timedelta(weeks=52)]
1732
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1735
class TestSetIntervalCmd(TestPropertyValueCmd):
1736
command = SetIntervalCmd
1737
propname = "Interval"
1738
values_to_set = [datetime.timedelta(),
1739
datetime.timedelta(minutes=5),
1740
datetime.timedelta(seconds=1),
1741
datetime.timedelta(weeks=1),
1742
datetime.timedelta(weeks=52)]
1743
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1746
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1747
command = SetApprovalDelayCmd
1748
propname = "ApprovalDelay"
1749
values_to_set = [datetime.timedelta(),
1750
datetime.timedelta(minutes=5),
1751
datetime.timedelta(seconds=1),
1752
datetime.timedelta(weeks=1),
1753
datetime.timedelta(weeks=52)]
1754
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1757
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1758
command = SetApprovalDurationCmd
1759
propname = "ApprovalDuration"
1760
values_to_set = [datetime.timedelta(),
1761
datetime.timedelta(minutes=5),
1762
datetime.timedelta(seconds=1),
1763
datetime.timedelta(weeks=1),
1764
datetime.timedelta(weeks=52)]
1765
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
389
except dbus.exceptions.DBusException as e:
390
log.critical("Failed to access Mandos server through D-Bus:"
394
# Compile dict of (clients: properties) to process
397
if options.all or not options.client:
398
clients = {bus.get_object(busname, path): properties
399
for path, properties in mandos_clients.items()}
401
for name in options.client:
402
for path, client in mandos_clients.items():
403
if client["Name"] == name:
404
client_objc = bus.get_object(busname, path)
405
clients[client_objc] = client
408
log.critical("Client not found on server: %r", name)
411
if not has_actions(options) and clients:
412
if options.verbose or options.dump_json:
413
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
414
"Created", "Interval", "Host", "KeyID",
415
"Fingerprint", "CheckerRunning",
416
"LastEnabled", "ApprovalPending",
417
"ApprovedByDefault", "LastApprovalRequest",
418
"ApprovalDelay", "ApprovalDuration",
419
"Checker", "ExtendedTimeout", "Expires",
422
keywords = defaultkeywords
424
if options.dump_json:
425
json.dump({client["Name"]: {key:
427
if isinstance(client[key],
431
for client in clients.values()},
432
fp=sys.stdout, indent=4,
433
separators=(',', ': '))
436
print_clients(clients.values(), keywords)
438
# Process each client in the list by all selected options
439
for client in clients:
441
def set_client_prop(prop, value):
442
"""Set a Client D-Bus property"""
443
client.Set(client_interface, prop, value,
444
dbus_interface=dbus.PROPERTIES_IFACE)
446
def set_client_prop_ms(prop, value):
447
"""Set a Client D-Bus property, converted
448
from a string to milliseconds."""
449
set_client_prop(prop,
450
string_to_delta(value).total_seconds()
454
mandos_serv.RemoveClient(client.__dbus_object_path__)
456
set_client_prop("Enabled", dbus.Boolean(True))
458
set_client_prop("Enabled", dbus.Boolean(False))
459
if options.bump_timeout:
460
set_client_prop("LastCheckedOK", "")
461
if options.start_checker:
462
set_client_prop("CheckerRunning", dbus.Boolean(True))
463
if options.stop_checker:
464
set_client_prop("CheckerRunning", dbus.Boolean(False))
465
if options.is_enabled:
466
if client.Get(client_interface, "Enabled",
467
dbus_interface=dbus.PROPERTIES_IFACE):
471
if options.checker is not None:
472
set_client_prop("Checker", options.checker)
473
if options.host is not None:
474
set_client_prop("Host", options.host)
475
if options.interval is not None:
476
set_client_prop_ms("Interval", options.interval)
477
if options.approval_delay is not None:
478
set_client_prop_ms("ApprovalDelay",
479
options.approval_delay)
480
if options.approval_duration is not None:
481
set_client_prop_ms("ApprovalDuration",
482
options.approval_duration)
483
if options.timeout is not None:
484
set_client_prop_ms("Timeout", options.timeout)
485
if options.extended_timeout is not None:
486
set_client_prop_ms("ExtendedTimeout",
487
options.extended_timeout)
488
if options.secret is not None:
489
set_client_prop("Secret",
490
dbus.ByteArray(options.secret.read()))
491
if options.approved_by_default is not None:
492
set_client_prop("ApprovedByDefault",
494
.approved_by_default))
496
client.Approve(dbus.Boolean(True),
497
dbus_interface=client_interface)
499
client.Approve(dbus.Boolean(False),
500
dbus_interface=client_interface)
503
class Test_milliseconds_to_string(unittest.TestCase):
505
self.assertEqual(milliseconds_to_string(93785000),
507
def test_no_days(self):
508
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
509
def test_all_zero(self):
510
self.assertEqual(milliseconds_to_string(0), "00:00:00")
511
def test_no_fractional_seconds(self):
512
self.assertEqual(milliseconds_to_string(400), "00:00:00")
513
self.assertEqual(milliseconds_to_string(900), "00:00:00")
514
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
1769
517
def should_only_run_tests():