436
342
parser.error("--dump-json can only be used alone.")
437
343
if options.all and not has_actions(options):
438
344
parser.error("--all requires an action.")
439
if options.is_enabled and len(options.client) > 1:
440
parser.error("--is-enabled requires exactly one client")
442
options.remove = False
443
if has_actions(options) and not options.deny:
444
parser.error("--remove can only be combined with --deny")
445
options.remove = True
448
def commands_from_options(options):
452
if options.is_enabled:
453
commands.append(IsEnabledCmd())
456
commands.append(ApproveCmd())
459
commands.append(DenyCmd())
462
commands.append(RemoveCmd())
464
if options.dump_json:
465
commands.append(DumpJSONCmd())
468
commands.append(EnableCmd())
471
commands.append(DisableCmd())
473
if options.bump_timeout:
474
commands.append(BumpTimeoutCmd())
476
if options.start_checker:
477
commands.append(StartCheckerCmd())
479
if options.stop_checker:
480
commands.append(StopCheckerCmd())
482
if options.approved_by_default is not None:
483
if options.approved_by_default:
484
commands.append(ApproveByDefaultCmd())
486
commands.append(DenyByDefaultCmd())
488
if options.checker is not None:
489
commands.append(SetCheckerCmd(options.checker))
491
if options.host is not None:
492
commands.append(SetHostCmd(options.host))
494
if options.secret is not None:
495
commands.append(SetSecretCmd(options.secret))
497
if options.timeout is not None:
498
commands.append(SetTimeoutCmd(options.timeout))
500
if options.extended_timeout:
502
SetExtendedTimeoutCmd(options.extended_timeout))
504
if options.interval is not None:
505
commands.append(SetIntervalCmd(options.interval))
507
if options.approval_delay is not None:
508
commands.append(SetApprovalDelayCmd(options.approval_delay))
510
if options.approval_duration is not None:
512
SetApprovalDurationCmd(options.approval_duration))
514
# If no command option has been given, show table of clients,
515
# optionally verbosely
517
commands.append(PrintTableCmd(verbose=options.verbose))
522
class Command(object):
523
"""Abstract class for commands"""
524
def run(self, clients, bus=None, mandos=None):
525
"""Normal commands should implement run_on_one_client(), but
526
commands which want to operate on all clients at the same time
527
can override this run() method instead."""
529
for clientpath, properties in clients.items():
530
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
531
dbus_busname, str(clientpath))
532
client = bus.get_object(dbus_busname, clientpath)
533
self.run_on_one_client(client, properties)
536
class IsEnabledCmd(Command):
537
def run(self, clients, bus=None, mandos=None):
538
client, properties = next(iter(clients.items()))
539
if self.is_enabled(client, properties):
348
fail_count, test_count = doctest.testmod()
349
sys.exit(os.EX_OK if fail_count == 0 else 1)
352
bus = dbus.SystemBus()
353
mandos_dbus_objc = bus.get_object(busname, server_path)
354
except dbus.exceptions.DBusException:
355
print("Could not connect to Mandos server", file=sys.stderr)
542
def is_enabled(self, client, properties):
543
return properties["Enabled"]
546
class ApproveCmd(Command):
547
def run_on_one_client(self, client, properties):
548
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
549
client.__dbus_object_path__, client_dbus_interface)
550
client.Approve(dbus.Boolean(True),
551
dbus_interface=client_dbus_interface)
554
class DenyCmd(Command):
555
def run_on_one_client(self, client, properties):
556
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
557
client.__dbus_object_path__, client_dbus_interface)
558
client.Approve(dbus.Boolean(False),
559
dbus_interface=client_dbus_interface)
562
class RemoveCmd(Command):
563
def run_on_one_client(self, client, properties):
564
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
565
server_dbus_path, server_dbus_interface,
566
str(client.__dbus_object_path__))
567
self.mandos.RemoveClient(client.__dbus_object_path__)
570
class OutputCmd(Command):
571
"""Abstract class for commands outputting client details"""
572
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
573
"Created", "Interval", "Host", "KeyID",
574
"Fingerprint", "CheckerRunning", "LastEnabled",
575
"ApprovalPending", "ApprovedByDefault",
576
"LastApprovalRequest", "ApprovalDelay",
577
"ApprovalDuration", "Checker", "ExtendedTimeout",
578
"Expires", "LastCheckerStatus")
580
def run(self, clients, bus=None, mandos=None):
581
print(self.output(clients.values()))
583
def output(self, clients):
584
raise NotImplementedError()
587
class DumpJSONCmd(OutputCmd):
588
def output(self, clients):
589
data = {client["Name"]:
590
{key: self.dbus_boolean_to_bool(client[key])
591
for key in self.all_keywords}
592
for client in clients}
593
return json.dumps(data, indent=4, separators=(',', ': '))
596
def dbus_boolean_to_bool(value):
597
if isinstance(value, dbus.Boolean):
602
class PrintTableCmd(OutputCmd):
603
def __init__(self, verbose=False):
604
self.verbose = verbose
606
def output(self, clients):
607
default_keywords = ("Name", "Enabled", "Timeout",
609
keywords = default_keywords
611
keywords = self.all_keywords
612
return str(self.TableOfClients(clients, keywords))
614
class TableOfClients(object):
617
"Enabled": "Enabled",
618
"Timeout": "Timeout",
619
"LastCheckedOK": "Last Successful Check",
620
"LastApprovalRequest": "Last Approval Request",
621
"Created": "Created",
622
"Interval": "Interval",
624
"Fingerprint": "Fingerprint",
626
"CheckerRunning": "Check Is Running",
627
"LastEnabled": "Last Enabled",
628
"ApprovalPending": "Approval Is Pending",
629
"ApprovedByDefault": "Approved By Default",
630
"ApprovalDelay": "Approval Delay",
631
"ApprovalDuration": "Approval Duration",
632
"Checker": "Checker",
633
"ExtendedTimeout": "Extended Timeout",
634
"Expires": "Expires",
635
"LastCheckerStatus": "Last Checker Status",
638
def __init__(self, clients, keywords):
639
self.clients = clients
640
self.keywords = keywords
643
return "\n".join(self.rows())
645
if sys.version_info.major == 2:
646
__unicode__ = __str__
648
return str(self).encode(locale.getpreferredencoding())
651
format_string = self.row_formatting_string()
652
rows = [self.header_line(format_string)]
653
rows.extend(self.client_line(client, format_string)
654
for client in self.clients)
657
def row_formatting_string(self):
658
"Format string used to format table rows"
659
return " ".join("{{{key}:{width}}}".format(
660
width=max(len(self.tableheaders[key]),
661
*(len(self.string_from_client(client, key))
662
for client in self.clients)),
664
for key in self.keywords)
666
def string_from_client(self, client, key):
667
return self.valuetostring(client[key], key)
670
def valuetostring(cls, value, keyword):
671
if isinstance(value, dbus.Boolean):
672
return "Yes" if value else "No"
673
if keyword in ("Timeout", "Interval", "ApprovalDelay",
674
"ApprovalDuration", "ExtendedTimeout"):
675
return cls.milliseconds_to_string(value)
678
def header_line(self, format_string):
679
return format_string.format(**self.tableheaders)
681
def client_line(self, client, format_string):
682
return format_string.format(
683
**{key: self.string_from_client(client, key)
684
for key in self.keywords})
687
def milliseconds_to_string(ms):
688
td = datetime.timedelta(0, 0, 0, ms)
689
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
690
.format(days="{}T".format(td.days)
692
hours=td.seconds // 3600,
693
minutes=(td.seconds % 3600) // 60,
694
seconds=td.seconds % 60))
697
class PropertyCmd(Command):
698
"""Abstract class for Actions for setting one client property"""
700
def run_on_one_client(self, client, properties):
701
"""Set the Client's D-Bus property"""
702
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
703
client.__dbus_object_path__,
704
dbus.PROPERTIES_IFACE, client_dbus_interface,
705
self.propname, self.value_to_set
706
if not isinstance(self.value_to_set, dbus.Boolean)
707
else bool(self.value_to_set))
708
client.Set(client_dbus_interface, self.propname,
710
dbus_interface=dbus.PROPERTIES_IFACE)
714
raise NotImplementedError()
717
class EnableCmd(PropertyCmd):
719
value_to_set = dbus.Boolean(True)
722
class DisableCmd(PropertyCmd):
724
value_to_set = dbus.Boolean(False)
727
class BumpTimeoutCmd(PropertyCmd):
728
propname = "LastCheckedOK"
732
class StartCheckerCmd(PropertyCmd):
733
propname = "CheckerRunning"
734
value_to_set = dbus.Boolean(True)
737
class StopCheckerCmd(PropertyCmd):
738
propname = "CheckerRunning"
739
value_to_set = dbus.Boolean(False)
742
class ApproveByDefaultCmd(PropertyCmd):
743
propname = "ApprovedByDefault"
744
value_to_set = dbus.Boolean(True)
747
class DenyByDefaultCmd(PropertyCmd):
748
propname = "ApprovedByDefault"
749
value_to_set = dbus.Boolean(False)
752
class PropertyValueCmd(PropertyCmd):
753
"""Abstract class for PropertyCmd recieving a value as argument"""
754
def __init__(self, value):
755
self.value_to_set = value
758
class SetCheckerCmd(PropertyValueCmd):
762
class SetHostCmd(PropertyValueCmd):
766
class SetSecretCmd(PropertyValueCmd):
770
def value_to_set(self):
774
def value_to_set(self, value):
775
"""When setting, read data from supplied file object"""
776
self._vts = value.read()
780
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
781
"""Abstract class for PropertyValueCmd taking a value argument as
782
a datetime.timedelta() but should store it as milliseconds."""
785
def value_to_set(self):
789
def value_to_set(self, value):
790
"""When setting, convert value from a datetime.timedelta"""
791
self._vts = int(round(value.total_seconds() * 1000))
794
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
798
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
799
propname = "ExtendedTimeout"
802
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
803
propname = "Interval"
806
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
807
propname = "ApprovalDelay"
810
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
811
propname = "ApprovalDuration"
815
class Test_string_to_delta(unittest.TestCase):
816
def test_handles_basic_rfc3339(self):
817
self.assertEqual(string_to_delta("PT0S"),
818
datetime.timedelta())
819
self.assertEqual(string_to_delta("P0D"),
820
datetime.timedelta())
821
self.assertEqual(string_to_delta("PT1S"),
822
datetime.timedelta(0, 1))
823
self.assertEqual(string_to_delta("PT2H"),
824
datetime.timedelta(0, 7200))
826
def test_falls_back_to_pre_1_6_1_with_warning(self):
827
# assertLogs only exists in Python 3.4
828
if hasattr(self, "assertLogs"):
829
with self.assertLogs(log, logging.WARNING):
830
value = string_to_delta("2h")
832
class WarningFilter(logging.Filter):
833
"""Don't show, but record the presence of, warnings"""
834
def filter(self, record):
835
is_warning = record.levelno >= logging.WARNING
836
self.found = is_warning or getattr(self, "found",
838
return not is_warning
839
warning_filter = WarningFilter()
840
log.addFilter(warning_filter)
842
value = string_to_delta("2h")
844
log.removeFilter(warning_filter)
845
self.assertTrue(getattr(warning_filter, "found", False))
846
self.assertEqual(value, datetime.timedelta(0, 7200))
849
class Test_check_option_syntax(unittest.TestCase):
851
self.parser = argparse.ArgumentParser()
852
add_command_line_options(self.parser)
854
def test_actions_requires_client_or_all(self):
855
for action, value in self.actions.items():
856
options = self.parser.parse_args()
857
setattr(options, action, value)
858
with self.assertParseError():
859
self.check_option_syntax(options)
861
# This mostly corresponds to the definition from has_actions() in
862
# check_option_syntax()
864
# The actual values set here are not that important, but we do
865
# at least stick to the correct types, even though they are
869
"bump_timeout": True,
870
"start_checker": True,
871
"stop_checker": True,
875
"timeout": datetime.timedelta(),
876
"extended_timeout": datetime.timedelta(),
877
"interval": datetime.timedelta(),
878
"approved_by_default": True,
879
"approval_delay": datetime.timedelta(),
880
"approval_duration": datetime.timedelta(),
882
"secret": io.BytesIO(b"x"),
887
@contextlib.contextmanager
888
def assertParseError(self):
889
with self.assertRaises(SystemExit) as e:
890
with self.temporarily_suppress_stderr():
892
# Exit code from argparse is guaranteed to be "2". Reference:
893
# https://docs.python.org/3/library
894
# /argparse.html#exiting-methods
895
self.assertEqual(e.exception.code, 2)
898
@contextlib.contextmanager
899
def temporarily_suppress_stderr():
900
null = os.open(os.path.devnull, os.O_RDWR)
901
stderrcopy = os.dup(sys.stderr.fileno())
902
os.dup2(null, sys.stderr.fileno())
358
mandos_serv = dbus.Interface(mandos_dbus_objc,
359
dbus_interface=server_interface)
360
mandos_serv_object_manager = dbus.Interface(
361
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
363
# block stderr since dbus library prints to stderr
364
null = os.open(os.path.devnull, os.O_RDWR)
365
stderrcopy = os.dup(sys.stderr.fileno())
366
os.dup2(null, sys.stderr.fileno())
370
mandos_clients = {path: ifs_and_props[client_interface]
371
for path, ifs_and_props in
372
mandos_serv_object_manager
373
.GetManagedObjects().items()
374
if client_interface in ifs_and_props}
908
377
os.dup2(stderrcopy, sys.stderr.fileno())
909
378
os.close(stderrcopy)
911
def check_option_syntax(self, options):
912
check_option_syntax(self.parser, options)
914
def test_actions_conflicts_with_verbose(self):
915
for action, value in self.actions.items():
916
options = self.parser.parse_args()
917
setattr(options, action, value)
918
options.verbose = True
919
with self.assertParseError():
920
self.check_option_syntax(options)
922
def test_dump_json_conflicts_with_verbose(self):
923
options = self.parser.parse_args()
924
options.dump_json = True
925
options.verbose = True
926
with self.assertParseError():
927
self.check_option_syntax(options)
929
def test_dump_json_conflicts_with_action(self):
930
for action, value in self.actions.items():
931
options = self.parser.parse_args()
932
setattr(options, action, value)
933
options.dump_json = True
934
with self.assertParseError():
935
self.check_option_syntax(options)
937
def test_all_can_not_be_alone(self):
938
options = self.parser.parse_args()
940
with self.assertParseError():
941
self.check_option_syntax(options)
943
def test_all_is_ok_with_any_action(self):
944
for action, value in self.actions.items():
945
options = self.parser.parse_args()
946
setattr(options, action, value)
948
self.check_option_syntax(options)
950
def test_is_enabled_fails_without_client(self):
951
options = self.parser.parse_args()
952
options.is_enabled = True
953
with self.assertParseError():
954
self.check_option_syntax(options)
956
def test_is_enabled_works_with_one_client(self):
957
options = self.parser.parse_args()
958
options.is_enabled = True
959
options.client = ["foo"]
960
self.check_option_syntax(options)
962
def test_is_enabled_fails_with_two_clients(self):
963
options = self.parser.parse_args()
964
options.is_enabled = True
965
options.client = ["foo", "barbar"]
966
with self.assertParseError():
967
self.check_option_syntax(options)
969
def test_remove_can_only_be_combined_with_action_deny(self):
970
for action, value in self.actions.items():
971
if action in {"remove", "deny"}:
973
options = self.parser.parse_args()
974
setattr(options, action, value)
976
options.remove = True
977
with self.assertParseError():
978
self.check_option_syntax(options)
981
class Test_commands_from_options(unittest.TestCase):
983
self.parser = argparse.ArgumentParser()
984
add_command_line_options(self.parser)
986
def test_is_enabled(self):
987
self.assert_command_from_args(["--is-enabled", "foo"],
990
def assert_command_from_args(self, args, command_cls,
992
"""Assert that parsing ARGS should result in an instance of
993
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
994
options = self.parser.parse_args(args)
995
check_option_syntax(self.parser, options)
996
commands = commands_from_options(options)
997
self.assertEqual(len(commands), 1)
998
command = commands[0]
999
self.assertIsInstance(command, command_cls)
1000
for key, value in cmd_attrs.items():
1001
self.assertEqual(getattr(command, key), value)
1003
def test_is_enabled_short(self):
1004
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1006
def test_approve(self):
1007
self.assert_command_from_args(["--approve", "foo"],
1010
def test_approve_short(self):
1011
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1013
def test_deny(self):
1014
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1016
def test_deny_short(self):
1017
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1019
def test_remove(self):
1020
self.assert_command_from_args(["--remove", "foo"],
1023
def test_deny_before_remove(self):
1024
options = self.parser.parse_args(["--deny", "--remove",
1026
check_option_syntax(self.parser, options)
1027
commands = commands_from_options(options)
1028
self.assertEqual(len(commands), 2)
1029
self.assertIsInstance(commands[0], DenyCmd)
1030
self.assertIsInstance(commands[1], RemoveCmd)
1032
def test_deny_before_remove_reversed(self):
1033
options = self.parser.parse_args(["--remove", "--deny",
1035
check_option_syntax(self.parser, options)
1036
commands = commands_from_options(options)
1037
self.assertEqual(len(commands), 2)
1038
self.assertIsInstance(commands[0], DenyCmd)
1039
self.assertIsInstance(commands[1], RemoveCmd)
1041
def test_remove_short(self):
1042
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1044
def test_dump_json(self):
1045
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1047
def test_enable(self):
1048
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1050
def test_enable_short(self):
1051
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1053
def test_disable(self):
1054
self.assert_command_from_args(["--disable", "foo"],
1057
def test_disable_short(self):
1058
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1060
def test_bump_timeout(self):
1061
self.assert_command_from_args(["--bump-timeout", "foo"],
1064
def test_bump_timeout_short(self):
1065
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1067
def test_start_checker(self):
1068
self.assert_command_from_args(["--start-checker", "foo"],
1071
def test_stop_checker(self):
1072
self.assert_command_from_args(["--stop-checker", "foo"],
1075
def test_approve_by_default(self):
1076
self.assert_command_from_args(["--approve-by-default", "foo"],
1077
ApproveByDefaultCmd)
1079
def test_deny_by_default(self):
1080
self.assert_command_from_args(["--deny-by-default", "foo"],
1083
def test_checker(self):
1084
self.assert_command_from_args(["--checker", ":", "foo"],
1085
SetCheckerCmd, value_to_set=":")
1087
def test_checker_empty(self):
1088
self.assert_command_from_args(["--checker", "", "foo"],
1089
SetCheckerCmd, value_to_set="")
1091
def test_checker_short(self):
1092
self.assert_command_from_args(["-c", ":", "foo"],
1093
SetCheckerCmd, value_to_set=":")
1095
def test_host(self):
1096
self.assert_command_from_args(["--host", "foo.example.org",
1098
value_to_set="foo.example.org")
1100
def test_host_short(self):
1101
self.assert_command_from_args(["-H", "foo.example.org",
1103
value_to_set="foo.example.org")
1105
def test_secret_devnull(self):
1106
self.assert_command_from_args(["--secret", os.path.devnull,
1107
"foo"], SetSecretCmd,
1110
def test_secret_tempfile(self):
1111
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1112
value = b"secret\0xyzzy\nbar"
1115
self.assert_command_from_args(["--secret", f.name,
1116
"foo"], SetSecretCmd,
1119
def test_secret_devnull_short(self):
1120
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1121
SetSecretCmd, value_to_set=b"")
1123
def test_secret_tempfile_short(self):
1124
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1125
value = b"secret\0xyzzy\nbar"
1128
self.assert_command_from_args(["-s", f.name, "foo"],
1132
def test_timeout(self):
1133
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1135
value_to_set=300000)
1137
def test_timeout_short(self):
1138
self.assert_command_from_args(["-t", "PT5M", "foo"],
1140
value_to_set=300000)
1142
def test_extended_timeout(self):
1143
self.assert_command_from_args(["--extended-timeout", "PT15M",
1145
SetExtendedTimeoutCmd,
1146
value_to_set=900000)
1148
def test_interval(self):
1149
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1151
value_to_set=120000)
1153
def test_interval_short(self):
1154
self.assert_command_from_args(["-i", "PT2M", "foo"],
1156
value_to_set=120000)
1158
def test_approval_delay(self):
1159
self.assert_command_from_args(["--approval-delay", "PT30S",
1160
"foo"], SetApprovalDelayCmd,
1163
def test_approval_duration(self):
1164
self.assert_command_from_args(["--approval-duration", "PT1S",
1165
"foo"], SetApprovalDurationCmd,
1168
def test_print_table(self):
1169
self.assert_command_from_args([], PrintTableCmd,
1172
def test_print_table_verbose(self):
1173
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1176
def test_print_table_verbose_short(self):
1177
self.assert_command_from_args(["-v"], PrintTableCmd,
1181
class TestCmd(unittest.TestCase):
1182
"""Abstract class for tests of command classes"""
1186
class MockClient(object):
1187
def __init__(self, name, **attributes):
1188
self.__dbus_object_path__ = "/clients/{}".format(name)
1189
self.attributes = attributes
1190
self.attributes["Name"] = name
1192
def Set(self, interface, propname, value, dbus_interface):
1193
testcase.assertEqual(interface, client_dbus_interface)
1194
testcase.assertEqual(dbus_interface,
1195
dbus.PROPERTIES_IFACE)
1196
self.attributes[propname] = value
1197
def Get(self, interface, propname, dbus_interface):
1198
testcase.assertEqual(interface, client_dbus_interface)
1199
testcase.assertEqual(dbus_interface,
1200
dbus.PROPERTIES_IFACE)
1201
return self.attributes[propname]
1202
def Approve(self, approve, dbus_interface):
1203
testcase.assertEqual(dbus_interface,
1204
client_dbus_interface)
1205
self.calls.append(("Approve", (approve,
1207
self.client = MockClient(
1209
KeyID=("92ed150794387c03ce684574b1139a65"
1210
"94a34f895daaaf09fd8ea90a27cddb12"),
1212
Host="foo.example.org",
1213
Enabled=dbus.Boolean(True),
1215
LastCheckedOK="2019-02-03T00:00:00",
1216
Created="2019-01-02T00:00:00",
1218
Fingerprint=("778827225BA7DE539C5A"
1219
"7CFA59CFF7CDBD9A5920"),
1220
CheckerRunning=dbus.Boolean(False),
1221
LastEnabled="2019-01-03T00:00:00",
1222
ApprovalPending=dbus.Boolean(False),
1223
ApprovedByDefault=dbus.Boolean(True),
1224
LastApprovalRequest="",
1226
ApprovalDuration=1000,
1227
Checker="fping -q -- %(host)s",
1228
ExtendedTimeout=900000,
1229
Expires="2019-02-04T00:00:00",
1230
LastCheckerStatus=0)
1231
self.other_client = MockClient(
1233
KeyID=("0558568eedd67d622f5c83b35a115f79"
1234
"6ab612cff5ad227247e46c2b020f441c"),
1235
Secret=b"secretbar",
1237
Enabled=dbus.Boolean(True),
1239
LastCheckedOK="2019-02-04T00:00:00",
1240
Created="2019-01-03T00:00:00",
1242
Fingerprint=("3E393AEAEFB84C7E89E2"
1243
"F547B3A107558FCA3A27"),
1244
CheckerRunning=dbus.Boolean(True),
1245
LastEnabled="2019-01-04T00:00:00",
1246
ApprovalPending=dbus.Boolean(False),
1247
ApprovedByDefault=dbus.Boolean(False),
1248
LastApprovalRequest="2019-01-03T00:00:00",
1249
ApprovalDelay=30000,
1250
ApprovalDuration=93785000,
1252
ExtendedTimeout=900000,
1253
Expires="2019-02-05T00:00:00",
1254
LastCheckerStatus=-2)
1255
self.clients = collections.OrderedDict(
1257
("/clients/foo", self.client.attributes),
1258
("/clients/barbar", self.other_client.attributes),
1260
self.one_client = {"/clients/foo": self.client.attributes}
1266
def get_object(client_bus_name, path):
1267
self.assertEqual(client_bus_name, dbus_busname)
1269
# Note: "self" here is the TestCmd instance, not
1270
# the Bus instance, since this is a static method!
1271
"/clients/foo": self.client,
1272
"/clients/barbar": self.other_client,
1277
class TestIsEnabledCmd(TestCmd):
1278
def test_is_enabled(self):
1279
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1281
for client, properties
1282
in self.clients.items()))
1284
def test_is_enabled_run_exits_successfully(self):
1285
with self.assertRaises(SystemExit) as e:
1286
IsEnabledCmd().run(self.one_client)
1287
if e.exception.code is not None:
1288
self.assertEqual(e.exception.code, 0)
1290
self.assertIsNone(e.exception.code)
1292
def test_is_enabled_run_exits_with_failure(self):
1293
self.client.attributes["Enabled"] = dbus.Boolean(False)
1294
with self.assertRaises(SystemExit) as e:
1295
IsEnabledCmd().run(self.one_client)
1296
if isinstance(e.exception.code, int):
1297
self.assertNotEqual(e.exception.code, 0)
1299
self.assertIsNotNone(e.exception.code)
1302
class TestApproveCmd(TestCmd):
1303
def test_approve(self):
1304
ApproveCmd().run(self.clients, self.bus)
1305
for clientpath in self.clients:
1306
client = self.bus.get_object(dbus_busname, clientpath)
1307
self.assertIn(("Approve", (True, client_dbus_interface)),
1311
class TestDenyCmd(TestCmd):
1312
def test_deny(self):
1313
DenyCmd().run(self.clients, self.bus)
1314
for clientpath in self.clients:
1315
client = self.bus.get_object(dbus_busname, clientpath)
1316
self.assertIn(("Approve", (False, client_dbus_interface)),
1320
class TestRemoveCmd(TestCmd):
1321
def test_remove(self):
1322
class MockMandos(object):
1325
def RemoveClient(self, dbus_path):
1326
self.calls.append(("RemoveClient", (dbus_path,)))
1327
mandos = MockMandos()
1328
super(TestRemoveCmd, self).setUp()
1329
RemoveCmd().run(self.clients, self.bus, mandos)
1330
self.assertEqual(len(mandos.calls), 2)
1331
for clientpath in self.clients:
1332
self.assertIn(("RemoveClient", (clientpath,)),
1336
class TestDumpJSONCmd(TestCmd):
1338
self.expected_json = {
1341
"KeyID": ("92ed150794387c03ce684574b1139a65"
1342
"94a34f895daaaf09fd8ea90a27cddb12"),
1343
"Host": "foo.example.org",
1346
"LastCheckedOK": "2019-02-03T00:00:00",
1347
"Created": "2019-01-02T00:00:00",
1349
"Fingerprint": ("778827225BA7DE539C5A"
1350
"7CFA59CFF7CDBD9A5920"),
1351
"CheckerRunning": False,
1352
"LastEnabled": "2019-01-03T00:00:00",
1353
"ApprovalPending": False,
1354
"ApprovedByDefault": True,
1355
"LastApprovalRequest": "",
1357
"ApprovalDuration": 1000,
1358
"Checker": "fping -q -- %(host)s",
1359
"ExtendedTimeout": 900000,
1360
"Expires": "2019-02-04T00:00:00",
1361
"LastCheckerStatus": 0,
1365
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1366
"6ab612cff5ad227247e46c2b020f441c"),
1367
"Host": "192.0.2.3",
1370
"LastCheckedOK": "2019-02-04T00:00:00",
1371
"Created": "2019-01-03T00:00:00",
1373
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1374
"F547B3A107558FCA3A27"),
1375
"CheckerRunning": True,
1376
"LastEnabled": "2019-01-04T00:00:00",
1377
"ApprovalPending": False,
1378
"ApprovedByDefault": False,
1379
"LastApprovalRequest": "2019-01-03T00:00:00",
1380
"ApprovalDelay": 30000,
1381
"ApprovalDuration": 93785000,
1383
"ExtendedTimeout": 900000,
1384
"Expires": "2019-02-05T00:00:00",
1385
"LastCheckerStatus": -2,
1388
return super(TestDumpJSONCmd, self).setUp()
1390
def test_normal(self):
1391
output = DumpJSONCmd().output(self.clients.values())
1392
json_data = json.loads(output)
1393
self.assertDictEqual(json_data, self.expected_json)
1395
def test_one_client(self):
1396
output = DumpJSONCmd().output(self.one_client.values())
1397
json_data = json.loads(output)
1398
expected_json = {"foo": self.expected_json["foo"]}
1399
self.assertDictEqual(json_data, expected_json)
1402
class TestPrintTableCmd(TestCmd):
1403
def test_normal(self):
1404
output = PrintTableCmd().output(self.clients.values())
1405
expected_output = "\n".join((
1406
"Name Enabled Timeout Last Successful Check",
1407
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1408
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1410
self.assertEqual(output, expected_output)
1412
def test_verbose(self):
1413
output = PrintTableCmd(verbose=True).output(
1414
self.clients.values())
1429
"Last Successful Check ",
1430
"2019-02-03T00:00:00 ",
1431
"2019-02-04T00:00:00 ",
1434
"2019-01-02T00:00:00 ",
1435
"2019-01-03T00:00:00 ",
1447
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1449
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1453
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1454
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1456
"Check Is Running ",
1461
"2019-01-03T00:00:00 ",
1462
"2019-01-04T00:00:00 ",
1464
"Approval Is Pending ",
1468
"Approved By Default ",
1472
"Last Approval Request ",
1474
"2019-01-03T00:00:00 ",
1480
"Approval Duration ",
1485
"fping -q -- %(host)s ",
1488
"Extended Timeout ",
1493
"2019-02-04T00:00:00 ",
1494
"2019-02-05T00:00:00 ",
1496
"Last Checker Status",
1501
num_lines = max(len(rows) for rows in columns)
1502
expected_output = "\n".join("".join(rows[line]
1503
for rows in columns)
1504
for line in range(num_lines))
1505
self.assertEqual(output, expected_output)
1507
def test_one_client(self):
1508
output = PrintTableCmd().output(self.one_client.values())
1509
expected_output = "\n".join((
1510
"Name Enabled Timeout Last Successful Check",
1511
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1513
self.assertEqual(output, expected_output)
1516
class TestPropertyCmd(TestCmd):
1517
"""Abstract class for tests of PropertyCmd classes"""
1519
if not hasattr(self, "command"):
1521
values_to_get = getattr(self, "values_to_get",
1523
for value_to_set, value_to_get in zip(self.values_to_set,
1525
for clientpath in self.clients:
1526
client = self.bus.get_object(dbus_busname, clientpath)
1527
old_value = client.attributes[self.propname]
1528
self.assertNotIsInstance(old_value, self.Unique)
1529
client.attributes[self.propname] = self.Unique()
1530
self.run_command(value_to_set, self.clients)
1531
for clientpath in self.clients:
1532
client = self.bus.get_object(dbus_busname, clientpath)
1533
value = client.attributes[self.propname]
1534
self.assertNotIsInstance(value, self.Unique)
1535
self.assertEqual(value, value_to_get)
1537
class Unique(object):
1538
"""Class for objects which exist only to be unique objects,
1539
since unittest.mock.sentinel only exists in Python 3.3"""
1541
def run_command(self, value, clients):
1542
self.command().run(clients, self.bus)
1545
class TestEnableCmd(TestPropertyCmd):
1547
propname = "Enabled"
1548
values_to_set = [dbus.Boolean(True)]
1551
class TestDisableCmd(TestPropertyCmd):
1552
command = DisableCmd
1553
propname = "Enabled"
1554
values_to_set = [dbus.Boolean(False)]
1557
class TestBumpTimeoutCmd(TestPropertyCmd):
1558
command = BumpTimeoutCmd
1559
propname = "LastCheckedOK"
1560
values_to_set = [""]
1563
class TestStartCheckerCmd(TestPropertyCmd):
1564
command = StartCheckerCmd
1565
propname = "CheckerRunning"
1566
values_to_set = [dbus.Boolean(True)]
1569
class TestStopCheckerCmd(TestPropertyCmd):
1570
command = StopCheckerCmd
1571
propname = "CheckerRunning"
1572
values_to_set = [dbus.Boolean(False)]
1575
class TestApproveByDefaultCmd(TestPropertyCmd):
1576
command = ApproveByDefaultCmd
1577
propname = "ApprovedByDefault"
1578
values_to_set = [dbus.Boolean(True)]
1581
class TestDenyByDefaultCmd(TestPropertyCmd):
1582
command = DenyByDefaultCmd
1583
propname = "ApprovedByDefault"
1584
values_to_set = [dbus.Boolean(False)]
1587
class TestPropertyValueCmd(TestPropertyCmd):
1588
"""Abstract class for tests of PropertyValueCmd classes"""
1591
if type(self) is TestPropertyValueCmd:
1593
return super(TestPropertyValueCmd, self).runTest()
1595
def run_command(self, value, clients):
1596
self.command(value).run(clients, self.bus)
1599
class TestSetCheckerCmd(TestPropertyValueCmd):
1600
command = SetCheckerCmd
1601
propname = "Checker"
1602
values_to_set = ["", ":", "fping -q -- %s"]
1605
class TestSetHostCmd(TestPropertyValueCmd):
1606
command = SetHostCmd
1608
values_to_set = ["192.0.2.3", "foo.example.org"]
1611
class TestSetSecretCmd(TestPropertyValueCmd):
1612
command = SetSecretCmd
1614
values_to_set = [io.BytesIO(b""),
1615
io.BytesIO(b"secret\0xyzzy\nbar")]
1616
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1619
class TestSetTimeoutCmd(TestPropertyValueCmd):
1620
command = SetTimeoutCmd
1621
propname = "Timeout"
1622
values_to_set = [datetime.timedelta(),
1623
datetime.timedelta(minutes=5),
1624
datetime.timedelta(seconds=1),
1625
datetime.timedelta(weeks=1),
1626
datetime.timedelta(weeks=52)]
1627
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1630
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1631
command = SetExtendedTimeoutCmd
1632
propname = "ExtendedTimeout"
1633
values_to_set = [datetime.timedelta(),
1634
datetime.timedelta(minutes=5),
1635
datetime.timedelta(seconds=1),
1636
datetime.timedelta(weeks=1),
1637
datetime.timedelta(weeks=52)]
1638
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1641
class TestSetIntervalCmd(TestPropertyValueCmd):
1642
command = SetIntervalCmd
1643
propname = "Interval"
1644
values_to_set = [datetime.timedelta(),
1645
datetime.timedelta(minutes=5),
1646
datetime.timedelta(seconds=1),
1647
datetime.timedelta(weeks=1),
1648
datetime.timedelta(weeks=52)]
1649
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1652
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1653
command = SetApprovalDelayCmd
1654
propname = "ApprovalDelay"
1655
values_to_set = [datetime.timedelta(),
1656
datetime.timedelta(minutes=5),
1657
datetime.timedelta(seconds=1),
1658
datetime.timedelta(weeks=1),
1659
datetime.timedelta(weeks=52)]
1660
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1663
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1664
command = SetApprovalDurationCmd
1665
propname = "ApprovalDuration"
1666
values_to_set = [datetime.timedelta(),
1667
datetime.timedelta(minutes=5),
1668
datetime.timedelta(seconds=1),
1669
datetime.timedelta(weeks=1),
1670
datetime.timedelta(weeks=52)]
1671
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1675
def should_only_run_tests():
1676
parser = argparse.ArgumentParser(add_help=False)
1677
parser.add_argument("--check", action='store_true')
1678
args, unknown_args = parser.parse_known_args()
1679
run_tests = args.check
1681
# Remove --check argument from sys.argv
1682
sys.argv[1:] = unknown_args
1685
# Add all tests from doctest strings
1686
def load_tests(loader, tests, none):
1688
tests.addTests(doctest.DocTestSuite())
379
except dbus.exceptions.DBusException as e:
380
print("Access denied: "
381
"Accessing mandos server through D-Bus: {}".format(e),
385
# Compile dict of (clients: properties) to process
388
if options.all or not options.client:
389
clients = {bus.get_object(busname, path): properties
390
for path, properties in mandos_clients.items()}
392
for name in options.client:
393
for path, client in mandos_clients.items():
394
if client["Name"] == name:
395
client_objc = bus.get_object(busname, path)
396
clients[client_objc] = client
399
print("Client not found on server: {!r}"
400
.format(name), file=sys.stderr)
403
if not has_actions(options) and clients:
404
if options.verbose or options.dump_json:
405
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
406
"Created", "Interval", "Host", "Fingerprint",
407
"CheckerRunning", "LastEnabled",
408
"ApprovalPending", "ApprovedByDefault",
409
"LastApprovalRequest", "ApprovalDelay",
410
"ApprovalDuration", "Checker",
411
"ExtendedTimeout", "Expires",
414
keywords = defaultkeywords
416
if options.dump_json:
417
json.dump({client["Name"]: {key:
419
if isinstance(client[key],
423
for client in clients.values()},
424
fp=sys.stdout, indent=4,
425
separators=(',', ': '))
428
print_clients(clients.values(), keywords)
430
# Process each client in the list by all selected options
431
for client in clients:
433
def set_client_prop(prop, value):
434
"""Set a Client D-Bus property"""
435
client.Set(client_interface, prop, value,
436
dbus_interface=dbus.PROPERTIES_IFACE)
438
def set_client_prop_ms(prop, value):
439
"""Set a Client D-Bus property, converted
440
from a string to milliseconds."""
441
set_client_prop(prop,
442
string_to_delta(value).total_seconds()
446
mandos_serv.RemoveClient(client.__dbus_object_path__)
448
set_client_prop("Enabled", dbus.Boolean(True))
450
set_client_prop("Enabled", dbus.Boolean(False))
451
if options.bump_timeout:
452
set_client_prop("LastCheckedOK", "")
453
if options.start_checker:
454
set_client_prop("CheckerRunning", dbus.Boolean(True))
455
if options.stop_checker:
456
set_client_prop("CheckerRunning", dbus.Boolean(False))
457
if options.is_enabled:
458
if client.Get(client_interface, "Enabled",
459
dbus_interface=dbus.PROPERTIES_IFACE):
463
if options.checker is not None:
464
set_client_prop("Checker", options.checker)
465
if options.host is not None:
466
set_client_prop("Host", options.host)
467
if options.interval is not None:
468
set_client_prop_ms("Interval", options.interval)
469
if options.approval_delay is not None:
470
set_client_prop_ms("ApprovalDelay",
471
options.approval_delay)
472
if options.approval_duration is not None:
473
set_client_prop_ms("ApprovalDuration",
474
options.approval_duration)
475
if options.timeout is not None:
476
set_client_prop_ms("Timeout", options.timeout)
477
if options.extended_timeout is not None:
478
set_client_prop_ms("ExtendedTimeout",
479
options.extended_timeout)
480
if options.secret is not None:
481
set_client_prop("Secret",
482
dbus.ByteArray(options.secret.read()))
483
if options.approved_by_default is not None:
484
set_client_prop("ApprovedByDefault",
486
.approved_by_default))
488
client.Approve(dbus.Boolean(True),
489
dbus_interface=client_interface)
491
client.Approve(dbus.Boolean(False),
492
dbus_interface=client_interface)
1691
495
if __name__ == "__main__":
1692
if should_only_run_tests():
1693
# Call using ./tdd-python-script --check [--verbose]