345
437
parser.error("--dump-json can only be used alone.")
346
438
if options.all and not has_actions(options):
347
439
parser.error("--all requires an action.")
350
bus = dbus.SystemBus()
351
mandos_dbus_objc = bus.get_object(busname, server_path)
352
except dbus.exceptions.DBusException:
353
print("Could not connect to Mandos server", file=sys.stderr)
440
if options.is_enabled and len(options.client) > 1:
441
parser.error("--is-enabled requires exactly one client")
443
options.remove = False
444
if has_actions(options) and not options.deny:
445
parser.error("--remove can only be combined with --deny")
446
options.remove = True
449
def commands_from_options(options):
453
if options.is_enabled:
454
commands.append(IsEnabledCmd())
457
commands.append(ApproveCmd())
460
commands.append(DenyCmd())
463
commands.append(RemoveCmd())
465
if options.dump_json:
466
commands.append(DumpJSONCmd())
469
commands.append(EnableCmd())
472
commands.append(DisableCmd())
474
if options.bump_timeout:
475
commands.append(BumpTimeoutCmd())
477
if options.start_checker:
478
commands.append(StartCheckerCmd())
480
if options.stop_checker:
481
commands.append(StopCheckerCmd())
483
if options.approved_by_default is not None:
484
if options.approved_by_default:
485
commands.append(ApproveByDefaultCmd())
487
commands.append(DenyByDefaultCmd())
489
if options.checker is not None:
490
commands.append(SetCheckerCmd(options.checker))
492
if options.host is not None:
493
commands.append(SetHostCmd(options.host))
495
if options.secret is not None:
496
commands.append(SetSecretCmd(options.secret))
498
if options.timeout is not None:
499
commands.append(SetTimeoutCmd(options.timeout))
501
if options.extended_timeout:
503
SetExtendedTimeoutCmd(options.extended_timeout))
505
if options.interval is not None:
506
commands.append(SetIntervalCmd(options.interval))
508
if options.approval_delay is not None:
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
511
if options.approval_duration is not None:
513
SetApprovalDurationCmd(options.approval_duration))
515
# If no command option has been given, show table of clients,
516
# optionally verbosely
518
commands.append(PrintTableCmd(verbose=options.verbose))
523
class Command(object):
524
"""Abstract class for commands"""
525
def run(self, clients, bus=None, mandos=None):
526
"""Normal commands should implement run_on_one_client(), but
527
commands which want to operate on all clients at the same time
528
can override this run() method instead."""
530
for clientpath, properties in clients.items():
531
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
532
dbus_busname, str(clientpath))
533
client = bus.get_object(dbus_busname, clientpath)
534
self.run_on_one_client(client, properties)
537
class IsEnabledCmd(Command):
538
def run(self, clients, bus=None, mandos=None):
539
client, properties = next(iter(clients.items()))
540
if self.is_enabled(client, properties):
356
mandos_serv = dbus.Interface(mandos_dbus_objc,
357
dbus_interface=server_interface)
358
mandos_serv_object_manager = dbus.Interface(
359
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
361
# block stderr since dbus library prints to stderr
362
null = os.open(os.path.devnull, os.O_RDWR)
363
stderrcopy = os.dup(sys.stderr.fileno())
364
os.dup2(null, sys.stderr.fileno())
543
def is_enabled(self, client, properties):
544
return properties["Enabled"]
547
class ApproveCmd(Command):
548
def run_on_one_client(self, client, properties):
549
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
550
client.__dbus_object_path__, client_dbus_interface)
551
client.Approve(dbus.Boolean(True),
552
dbus_interface=client_dbus_interface)
555
class DenyCmd(Command):
556
def run_on_one_client(self, client, properties):
557
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
558
client.__dbus_object_path__, client_dbus_interface)
559
client.Approve(dbus.Boolean(False),
560
dbus_interface=client_dbus_interface)
563
class RemoveCmd(Command):
564
def run_on_one_client(self, client, properties):
565
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
566
server_dbus_path, server_dbus_interface,
567
str(client.__dbus_object_path__))
568
self.mandos.RemoveClient(client.__dbus_object_path__)
571
class OutputCmd(Command):
572
"""Abstract class for commands outputting client details"""
573
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
574
"Created", "Interval", "Host", "KeyID",
575
"Fingerprint", "CheckerRunning", "LastEnabled",
576
"ApprovalPending", "ApprovedByDefault",
577
"LastApprovalRequest", "ApprovalDelay",
578
"ApprovalDuration", "Checker", "ExtendedTimeout",
579
"Expires", "LastCheckerStatus")
580
def run(self, clients, bus=None, mandos=None):
581
print(self.output(clients.values()))
582
def output(self, clients):
583
raise NotImplementedError()
586
class DumpJSONCmd(OutputCmd):
587
def output(self, clients):
588
data = {client["Name"]:
589
{key: self.dbus_boolean_to_bool(client[key])
590
for key in self.all_keywords}
591
for client in clients.values()}
592
return json.dumps(data, indent=4, separators=(',', ': '))
594
def dbus_boolean_to_bool(value):
595
if isinstance(value, dbus.Boolean):
600
class PrintTableCmd(OutputCmd):
601
def __init__(self, verbose=False):
602
self.verbose = verbose
604
def output(self, clients):
605
default_keywords = ("Name", "Enabled", "Timeout",
607
keywords = default_keywords
609
keywords = self.all_keywords
610
return str(self.TableOfClients(clients, keywords))
612
class TableOfClients(object):
615
"Enabled": "Enabled",
616
"Timeout": "Timeout",
617
"LastCheckedOK": "Last Successful Check",
618
"LastApprovalRequest": "Last Approval Request",
619
"Created": "Created",
620
"Interval": "Interval",
622
"Fingerprint": "Fingerprint",
624
"CheckerRunning": "Check Is Running",
625
"LastEnabled": "Last Enabled",
626
"ApprovalPending": "Approval Is Pending",
627
"ApprovedByDefault": "Approved By Default",
628
"ApprovalDelay": "Approval Delay",
629
"ApprovalDuration": "Approval Duration",
630
"Checker": "Checker",
631
"ExtendedTimeout": "Extended Timeout",
632
"Expires": "Expires",
633
"LastCheckerStatus": "Last Checker Status",
636
def __init__(self, clients, keywords, tableheaders=None):
637
self.clients = clients
638
self.keywords = keywords
639
if tableheaders is not None:
640
self.tableheaders = tableheaders
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"""
699
def run_on_one_client(self, client, properties):
700
"""Set the Client's D-Bus property"""
701
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
702
client.__dbus_object_path__,
703
dbus.PROPERTIES_IFACE, client_dbus_interface,
704
self.propname, self.value_to_set
705
if not isinstance(self.value_to_set, dbus.Boolean)
706
else bool(self.value_to_set))
707
client.Set(client_dbus_interface, self.propname,
709
dbus_interface=dbus.PROPERTIES_IFACE)
712
raise NotImplementedError()
715
class EnableCmd(PropertyCmd):
717
value_to_set = dbus.Boolean(True)
720
class DisableCmd(PropertyCmd):
722
value_to_set = dbus.Boolean(False)
725
class BumpTimeoutCmd(PropertyCmd):
726
propname = "LastCheckedOK"
730
class StartCheckerCmd(PropertyCmd):
731
propname = "CheckerRunning"
732
value_to_set = dbus.Boolean(True)
735
class StopCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
737
value_to_set = dbus.Boolean(False)
740
class ApproveByDefaultCmd(PropertyCmd):
741
propname = "ApprovedByDefault"
742
value_to_set = dbus.Boolean(True)
745
class DenyByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
747
value_to_set = dbus.Boolean(False)
750
class PropertyValueCmd(PropertyCmd):
751
"""Abstract class for PropertyCmd recieving a value as argument"""
752
def __init__(self, value):
753
self.value_to_set = value
756
class SetCheckerCmd(PropertyValueCmd):
760
class SetHostCmd(PropertyValueCmd):
764
class SetSecretCmd(PropertyValueCmd):
767
def value_to_set(self):
770
def value_to_set(self, value):
771
"""When setting, read data from supplied file object"""
772
self._vts = value.read()
776
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
777
"""Abstract class for PropertyValueCmd taking a value argument as
778
a datetime.timedelta() but should store it as milliseconds."""
780
def value_to_set(self):
783
def value_to_set(self, value):
784
"""When setting, convert value from a datetime.timedelta"""
785
self._vts = int(round(value.total_seconds() * 1000))
788
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
792
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
793
propname = "ExtendedTimeout"
796
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
797
propname = "Interval"
800
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
801
propname = "ApprovalDelay"
804
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
805
propname = "ApprovalDuration"
809
class Test_string_to_delta(unittest.TestCase):
810
def test_handles_basic_rfc3339(self):
811
self.assertEqual(string_to_delta("PT0S"),
812
datetime.timedelta())
813
self.assertEqual(string_to_delta("P0D"),
814
datetime.timedelta())
815
self.assertEqual(string_to_delta("PT1S"),
816
datetime.timedelta(0, 1))
817
self.assertEqual(string_to_delta("PT2H"),
818
datetime.timedelta(0, 7200))
819
def test_falls_back_to_pre_1_6_1_with_warning(self):
820
# assertLogs only exists in Python 3.4
821
if hasattr(self, "assertLogs"):
822
with self.assertLogs(log, logging.WARNING):
823
value = string_to_delta("2h")
825
class WarningFilter(logging.Filter):
826
"""Don't show, but record the presence of, warnings"""
827
def filter(self, record):
828
is_warning = record.levelno >= logging.WARNING
829
self.found = is_warning or getattr(self, "found",
831
return not is_warning
832
warning_filter = WarningFilter()
833
log.addFilter(warning_filter)
835
value = string_to_delta("2h")
837
log.removeFilter(warning_filter)
838
self.assertTrue(getattr(warning_filter, "found", False))
839
self.assertEqual(value, datetime.timedelta(0, 7200))
842
class Test_check_option_syntax(unittest.TestCase):
843
# This mostly corresponds to the definition from has_actions() in
844
# check_option_syntax()
846
# The actual values set here are not that important, but we do
847
# at least stick to the correct types, even though they are
851
"bump_timeout": True,
852
"start_checker": True,
853
"stop_checker": True,
857
"timeout": datetime.timedelta(),
858
"extended_timeout": datetime.timedelta(),
859
"interval": datetime.timedelta(),
860
"approved_by_default": True,
861
"approval_delay": datetime.timedelta(),
862
"approval_duration": datetime.timedelta(),
864
"secret": io.BytesIO(b"x"),
870
self.parser = argparse.ArgumentParser()
871
add_command_line_options(self.parser)
873
@contextlib.contextmanager
874
def assertParseError(self):
875
with self.assertRaises(SystemExit) as e:
876
with self.temporarily_suppress_stderr():
878
# Exit code from argparse is guaranteed to be "2". Reference:
879
# https://docs.python.org/3/library
880
# /argparse.html#exiting-methods
881
self.assertEqual(e.exception.code, 2)
884
@contextlib.contextmanager
885
def temporarily_suppress_stderr():
886
null = os.open(os.path.devnull, os.O_RDWR)
887
stderrcopy = os.dup(sys.stderr.fileno())
888
os.dup2(null, sys.stderr.fileno())
368
mandos_clients = {path: ifs_and_props[client_interface]
369
for path, ifs_and_props in
370
mandos_serv_object_manager
371
.GetManagedObjects().items()
372
if client_interface in ifs_and_props}
375
894
os.dup2(stderrcopy, sys.stderr.fileno())
376
895
os.close(stderrcopy)
377
except dbus.exceptions.DBusException as e:
378
print("Access denied: "
379
"Accessing mandos server through D-Bus: {}".format(e),
383
# Compile dict of (clients: properties) to process
386
if options.all or not options.client:
387
clients = {bus.get_object(busname, path): properties
388
for path, properties in mandos_clients.items()}
390
for name in options.client:
391
for path, client in mandos_clients.items():
392
if client["Name"] == name:
393
client_objc = bus.get_object(busname, path)
394
clients[client_objc] = client
397
print("Client not found on server: {!r}"
398
.format(name), file=sys.stderr)
401
if not has_actions(options) and clients:
402
if options.verbose or options.dump_json:
403
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
404
"Created", "Interval", "Host", "KeyID",
405
"Fingerprint", "CheckerRunning",
406
"LastEnabled", "ApprovalPending",
407
"ApprovedByDefault", "LastApprovalRequest",
408
"ApprovalDelay", "ApprovalDuration",
409
"Checker", "ExtendedTimeout", "Expires",
412
keywords = defaultkeywords
414
if options.dump_json:
415
json.dump({client["Name"]: {key:
417
if isinstance(client[key],
421
for client in clients.values()},
422
fp=sys.stdout, indent=4,
423
separators=(',', ': '))
426
print_clients(clients.values(), keywords)
428
# Process each client in the list by all selected options
429
for client in clients:
431
def set_client_prop(prop, value):
432
"""Set a Client D-Bus property"""
433
client.Set(client_interface, prop, value,
434
dbus_interface=dbus.PROPERTIES_IFACE)
436
def set_client_prop_ms(prop, value):
437
"""Set a Client D-Bus property, converted
438
from a string to milliseconds."""
439
set_client_prop(prop,
440
string_to_delta(value).total_seconds()
444
mandos_serv.RemoveClient(client.__dbus_object_path__)
446
set_client_prop("Enabled", dbus.Boolean(True))
448
set_client_prop("Enabled", dbus.Boolean(False))
449
if options.bump_timeout:
450
set_client_prop("LastCheckedOK", "")
451
if options.start_checker:
452
set_client_prop("CheckerRunning", dbus.Boolean(True))
453
if options.stop_checker:
454
set_client_prop("CheckerRunning", dbus.Boolean(False))
455
if options.is_enabled:
456
if client.Get(client_interface, "Enabled",
457
dbus_interface=dbus.PROPERTIES_IFACE):
461
if options.checker is not None:
462
set_client_prop("Checker", options.checker)
463
if options.host is not None:
464
set_client_prop("Host", options.host)
465
if options.interval is not None:
466
set_client_prop_ms("Interval", options.interval)
467
if options.approval_delay is not None:
468
set_client_prop_ms("ApprovalDelay",
469
options.approval_delay)
470
if options.approval_duration is not None:
471
set_client_prop_ms("ApprovalDuration",
472
options.approval_duration)
473
if options.timeout is not None:
474
set_client_prop_ms("Timeout", options.timeout)
475
if options.extended_timeout is not None:
476
set_client_prop_ms("ExtendedTimeout",
477
options.extended_timeout)
478
if options.secret is not None:
479
set_client_prop("Secret",
480
dbus.ByteArray(options.secret.read()))
481
if options.approved_by_default is not None:
482
set_client_prop("ApprovedByDefault",
484
.approved_by_default))
486
client.Approve(dbus.Boolean(True),
487
dbus_interface=client_interface)
489
client.Approve(dbus.Boolean(False),
490
dbus_interface=client_interface)
493
class Test_milliseconds_to_string(unittest.TestCase):
495
self.assertEqual(milliseconds_to_string(93785000),
497
def test_no_days(self):
498
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
499
def test_all_zero(self):
500
self.assertEqual(milliseconds_to_string(0), "00:00:00")
501
def test_no_fractional_seconds(self):
502
self.assertEqual(milliseconds_to_string(400), "00:00:00")
503
self.assertEqual(milliseconds_to_string(900), "00:00:00")
504
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
897
def check_option_syntax(self, options):
898
check_option_syntax(self.parser, options)
900
def test_actions_requires_client_or_all(self):
901
for action, value in self.actions.items():
902
options = self.parser.parse_args()
903
setattr(options, action, value)
904
with self.assertParseError():
905
self.check_option_syntax(options)
907
def test_actions_conflicts_with_verbose(self):
908
for action, value in self.actions.items():
909
options = self.parser.parse_args()
910
setattr(options, action, value)
911
options.verbose = True
912
with self.assertParseError():
913
self.check_option_syntax(options)
915
def test_dump_json_conflicts_with_verbose(self):
916
options = self.parser.parse_args()
917
options.dump_json = True
918
options.verbose = True
919
with self.assertParseError():
920
self.check_option_syntax(options)
922
def test_dump_json_conflicts_with_action(self):
923
for action, value in self.actions.items():
924
options = self.parser.parse_args()
925
setattr(options, action, value)
926
options.dump_json = True
927
with self.assertParseError():
928
self.check_option_syntax(options)
930
def test_all_can_not_be_alone(self):
931
options = self.parser.parse_args()
933
with self.assertParseError():
934
self.check_option_syntax(options)
936
def test_all_is_ok_with_any_action(self):
937
for action, value in self.actions.items():
938
options = self.parser.parse_args()
939
setattr(options, action, value)
941
self.check_option_syntax(options)
943
def test_is_enabled_fails_without_client(self):
944
options = self.parser.parse_args()
945
options.is_enabled = True
946
with self.assertParseError():
947
self.check_option_syntax(options)
949
def test_is_enabled_works_with_one_client(self):
950
options = self.parser.parse_args()
951
options.is_enabled = True
952
options.client = ["foo"]
953
self.check_option_syntax(options)
955
def test_is_enabled_fails_with_two_clients(self):
956
options = self.parser.parse_args()
957
options.is_enabled = True
958
options.client = ["foo", "barbar"]
959
with self.assertParseError():
960
self.check_option_syntax(options)
962
def test_remove_can_only_be_combined_with_action_deny(self):
963
for action, value in self.actions.items():
964
if action in {"remove", "deny"}:
966
options = self.parser.parse_args()
967
setattr(options, action, value)
969
options.remove = True
970
with self.assertParseError():
971
self.check_option_syntax(options)
974
class Test_command_from_options(unittest.TestCase):
976
self.parser = argparse.ArgumentParser()
977
add_command_line_options(self.parser)
978
def assert_command_from_args(self, args, command_cls,
980
"""Assert that parsing ARGS should result in an instance of
981
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
982
options = self.parser.parse_args(args)
983
check_option_syntax(self.parser, options)
984
commands = commands_from_options(options)
985
self.assertEqual(len(commands), 1)
986
command = commands[0]
987
self.assertIsInstance(command, command_cls)
988
for key, value in cmd_attrs.items():
989
self.assertEqual(getattr(command, key), value)
990
def test_print_table(self):
991
self.assert_command_from_args([], PrintTableCmd,
994
def test_print_table_verbose(self):
995
self.assert_command_from_args(["--verbose"], PrintTableCmd,
998
def test_print_table_verbose_short(self):
999
self.assert_command_from_args(["-v"], PrintTableCmd,
1002
def test_enable(self):
1003
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1005
def test_enable_short(self):
1006
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1008
def test_disable(self):
1009
self.assert_command_from_args(["--disable", "foo"],
1012
def test_disable_short(self):
1013
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1015
def test_bump_timeout(self):
1016
self.assert_command_from_args(["--bump-timeout", "foo"],
1019
def test_bump_timeout_short(self):
1020
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1022
def test_start_checker(self):
1023
self.assert_command_from_args(["--start-checker", "foo"],
1026
def test_stop_checker(self):
1027
self.assert_command_from_args(["--stop-checker", "foo"],
1030
def test_remove(self):
1031
self.assert_command_from_args(["--remove", "foo"],
1034
def test_remove_short(self):
1035
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1037
def test_checker(self):
1038
self.assert_command_from_args(["--checker", ":", "foo"],
1039
SetCheckerCmd, value_to_set=":")
1041
def test_checker_empty(self):
1042
self.assert_command_from_args(["--checker", "", "foo"],
1043
SetCheckerCmd, value_to_set="")
1045
def test_checker_short(self):
1046
self.assert_command_from_args(["-c", ":", "foo"],
1047
SetCheckerCmd, value_to_set=":")
1049
def test_timeout(self):
1050
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1052
value_to_set=300000)
1054
def test_timeout_short(self):
1055
self.assert_command_from_args(["-t", "PT5M", "foo"],
1057
value_to_set=300000)
1059
def test_extended_timeout(self):
1060
self.assert_command_from_args(["--extended-timeout", "PT15M",
1062
SetExtendedTimeoutCmd,
1063
value_to_set=900000)
1065
def test_interval(self):
1066
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1068
value_to_set=120000)
1070
def test_interval_short(self):
1071
self.assert_command_from_args(["-i", "PT2M", "foo"],
1073
value_to_set=120000)
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_approval_delay(self):
1084
self.assert_command_from_args(["--approval-delay", "PT30S",
1085
"foo"], SetApprovalDelayCmd,
1088
def test_approval_duration(self):
1089
self.assert_command_from_args(["--approval-duration", "PT1S",
1090
"foo"], SetApprovalDurationCmd,
1093
def test_host(self):
1094
self.assert_command_from_args(["--host", "foo.example.org",
1096
value_to_set="foo.example.org")
1098
def test_host_short(self):
1099
self.assert_command_from_args(["-H", "foo.example.org",
1101
value_to_set="foo.example.org")
1103
def test_secret_devnull(self):
1104
self.assert_command_from_args(["--secret", os.path.devnull,
1105
"foo"], SetSecretCmd,
1108
def test_secret_tempfile(self):
1109
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1110
value = b"secret\0xyzzy\nbar"
1113
self.assert_command_from_args(["--secret", f.name,
1114
"foo"], SetSecretCmd,
1117
def test_secret_devnull_short(self):
1118
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1119
SetSecretCmd, value_to_set=b"")
1121
def test_secret_tempfile_short(self):
1122
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1123
value = b"secret\0xyzzy\nbar"
1126
self.assert_command_from_args(["-s", f.name, "foo"],
1130
def test_approve(self):
1131
self.assert_command_from_args(["--approve", "foo"],
1134
def test_approve_short(self):
1135
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1137
def test_deny(self):
1138
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1140
def test_deny_short(self):
1141
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1143
def test_dump_json(self):
1144
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1146
def test_is_enabled(self):
1147
self.assert_command_from_args(["--is-enabled", "foo"],
1150
def test_is_enabled_short(self):
1151
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1153
def test_deny_before_remove(self):
1154
options = self.parser.parse_args(["--deny", "--remove",
1156
check_option_syntax(self.parser, options)
1157
commands = commands_from_options(options)
1158
self.assertEqual(len(commands), 2)
1159
self.assertIsInstance(commands[0], DenyCmd)
1160
self.assertIsInstance(commands[1], RemoveCmd)
1162
def test_deny_before_remove_reversed(self):
1163
options = self.parser.parse_args(["--remove", "--deny",
1165
check_option_syntax(self.parser, options)
1166
commands = commands_from_options(options)
1167
self.assertEqual(len(commands), 2)
1168
self.assertIsInstance(commands[0], DenyCmd)
1169
self.assertIsInstance(commands[1], RemoveCmd)
1172
class TestCmd(unittest.TestCase):
1173
"""Abstract class for tests of command classes"""
1176
class MockClient(object):
1177
def __init__(self, name, **attributes):
1178
self.__dbus_object_path__ = "/clients/{}".format(name)
1179
self.attributes = attributes
1180
self.attributes["Name"] = name
1182
def Set(self, interface, propname, value, dbus_interface):
1183
testcase.assertEqual(interface, client_dbus_interface)
1184
testcase.assertEqual(dbus_interface,
1185
dbus.PROPERTIES_IFACE)
1186
self.attributes[propname] = value
1187
def Get(self, interface, propname, dbus_interface):
1188
testcase.assertEqual(interface, client_dbus_interface)
1189
testcase.assertEqual(dbus_interface,
1190
dbus.PROPERTIES_IFACE)
1191
return self.attributes[propname]
1192
def Approve(self, approve, dbus_interface):
1193
testcase.assertEqual(dbus_interface,
1194
client_dbus_interface)
1195
self.calls.append(("Approve", (approve,
1197
self.client = MockClient(
1199
KeyID=("92ed150794387c03ce684574b1139a65"
1200
"94a34f895daaaf09fd8ea90a27cddb12"),
1202
Host="foo.example.org",
1203
Enabled=dbus.Boolean(True),
1205
LastCheckedOK="2019-02-03T00:00:00",
1206
Created="2019-01-02T00:00:00",
1208
Fingerprint=("778827225BA7DE539C5A"
1209
"7CFA59CFF7CDBD9A5920"),
1210
CheckerRunning=dbus.Boolean(False),
1211
LastEnabled="2019-01-03T00:00:00",
1212
ApprovalPending=dbus.Boolean(False),
1213
ApprovedByDefault=dbus.Boolean(True),
1214
LastApprovalRequest="",
1216
ApprovalDuration=1000,
1217
Checker="fping -q -- %(host)s",
1218
ExtendedTimeout=900000,
1219
Expires="2019-02-04T00:00:00",
1220
LastCheckerStatus=0)
1221
self.other_client = MockClient(
1223
KeyID=("0558568eedd67d622f5c83b35a115f79"
1224
"6ab612cff5ad227247e46c2b020f441c"),
1225
Secret=b"secretbar",
1227
Enabled=dbus.Boolean(True),
1229
LastCheckedOK="2019-02-04T00:00:00",
1230
Created="2019-01-03T00:00:00",
1232
Fingerprint=("3E393AEAEFB84C7E89E2"
1233
"F547B3A107558FCA3A27"),
1234
CheckerRunning=dbus.Boolean(True),
1235
LastEnabled="2019-01-04T00:00:00",
1236
ApprovalPending=dbus.Boolean(False),
1237
ApprovedByDefault=dbus.Boolean(False),
1238
LastApprovalRequest="2019-01-03T00:00:00",
1239
ApprovalDelay=30000,
1240
ApprovalDuration=93785000,
1242
ExtendedTimeout=900000,
1243
Expires="2019-02-05T00:00:00",
1244
LastCheckerStatus=-2)
1245
self.clients = collections.OrderedDict(
1247
("/clients/foo", self.client.attributes),
1248
("/clients/barbar", self.other_client.attributes),
1250
self.one_client = {"/clients/foo": self.client.attributes}
1255
def get_object(client_bus_name, path):
1256
self.assertEqual(client_bus_name, dbus_busname)
1258
"/clients/foo": self.client,
1259
"/clients/barbar": self.other_client,
1264
class TestIsEnabledCmd(TestCmd):
1265
def test_is_enabled(self):
1266
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1268
for client, properties
1269
in self.clients.items()))
1270
def test_is_enabled_run_exits_successfully(self):
1271
with self.assertRaises(SystemExit) as e:
1272
IsEnabledCmd().run(self.one_client)
1273
if e.exception.code is not None:
1274
self.assertEqual(e.exception.code, 0)
1276
self.assertIsNone(e.exception.code)
1277
def test_is_enabled_run_exits_with_failure(self):
1278
self.client.attributes["Enabled"] = dbus.Boolean(False)
1279
with self.assertRaises(SystemExit) as e:
1280
IsEnabledCmd().run(self.one_client)
1281
if isinstance(e.exception.code, int):
1282
self.assertNotEqual(e.exception.code, 0)
1284
self.assertIsNotNone(e.exception.code)
1287
class TestApproveCmd(TestCmd):
1288
def test_approve(self):
1289
ApproveCmd().run(self.clients, self.bus)
1290
for clientpath in self.clients:
1291
client = self.bus.get_object(dbus_busname, clientpath)
1292
self.assertIn(("Approve", (True, client_dbus_interface)),
1296
class TestDenyCmd(TestCmd):
1297
def test_deny(self):
1298
DenyCmd().run(self.clients, self.bus)
1299
for clientpath in self.clients:
1300
client = self.bus.get_object(dbus_busname, clientpath)
1301
self.assertIn(("Approve", (False, client_dbus_interface)),
1304
class TestRemoveCmd(TestCmd):
1305
def test_remove(self):
1306
class MockMandos(object):
1309
def RemoveClient(self, dbus_path):
1310
self.calls.append(("RemoveClient", (dbus_path,)))
1311
mandos = MockMandos()
1312
super(TestRemoveCmd, self).setUp()
1313
RemoveCmd().run(self.clients, self.bus, mandos)
1314
self.assertEqual(len(mandos.calls), 2)
1315
for clientpath in self.clients:
1316
self.assertIn(("RemoveClient", (clientpath,)),
1320
class TestDumpJSONCmd(TestCmd):
1322
self.expected_json = {
1325
"KeyID": ("92ed150794387c03ce684574b1139a65"
1326
"94a34f895daaaf09fd8ea90a27cddb12"),
1327
"Host": "foo.example.org",
1330
"LastCheckedOK": "2019-02-03T00:00:00",
1331
"Created": "2019-01-02T00:00:00",
1333
"Fingerprint": ("778827225BA7DE539C5A"
1334
"7CFA59CFF7CDBD9A5920"),
1335
"CheckerRunning": False,
1336
"LastEnabled": "2019-01-03T00:00:00",
1337
"ApprovalPending": False,
1338
"ApprovedByDefault": True,
1339
"LastApprovalRequest": "",
1341
"ApprovalDuration": 1000,
1342
"Checker": "fping -q -- %(host)s",
1343
"ExtendedTimeout": 900000,
1344
"Expires": "2019-02-04T00:00:00",
1345
"LastCheckerStatus": 0,
1349
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1350
"6ab612cff5ad227247e46c2b020f441c"),
1351
"Host": "192.0.2.3",
1354
"LastCheckedOK": "2019-02-04T00:00:00",
1355
"Created": "2019-01-03T00:00:00",
1357
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1358
"F547B3A107558FCA3A27"),
1359
"CheckerRunning": True,
1360
"LastEnabled": "2019-01-04T00:00:00",
1361
"ApprovalPending": False,
1362
"ApprovedByDefault": False,
1363
"LastApprovalRequest": "2019-01-03T00:00:00",
1364
"ApprovalDelay": 30000,
1365
"ApprovalDuration": 93785000,
1367
"ExtendedTimeout": 900000,
1368
"Expires": "2019-02-05T00:00:00",
1369
"LastCheckerStatus": -2,
1372
return super(TestDumpJSONCmd, self).setUp()
1373
def test_normal(self):
1374
json_data = json.loads(DumpJSONCmd().output(self.clients))
1375
self.assertDictEqual(json_data, self.expected_json)
1376
def test_one_client(self):
1377
clients = self.one_client
1378
json_data = json.loads(DumpJSONCmd().output(clients))
1379
expected_json = {"foo": self.expected_json["foo"]}
1380
self.assertDictEqual(json_data, expected_json)
1383
class TestPrintTableCmd(TestCmd):
1384
def test_normal(self):
1385
output = PrintTableCmd().output(self.clients.values())
1386
expected_output = "\n".join((
1387
"Name Enabled Timeout Last Successful Check",
1388
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1389
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1391
self.assertEqual(output, expected_output)
1392
def test_verbose(self):
1393
output = PrintTableCmd(verbose=True).output(
1394
self.clients.values())
1409
"Last Successful Check ",
1410
"2019-02-03T00:00:00 ",
1411
"2019-02-04T00:00:00 ",
1414
"2019-01-02T00:00:00 ",
1415
"2019-01-03T00:00:00 ",
1427
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1429
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1433
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1434
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1436
"Check Is Running ",
1441
"2019-01-03T00:00:00 ",
1442
"2019-01-04T00:00:00 ",
1444
"Approval Is Pending ",
1448
"Approved By Default ",
1452
"Last Approval Request ",
1454
"2019-01-03T00:00:00 ",
1460
"Approval Duration ",
1465
"fping -q -- %(host)s ",
1468
"Extended Timeout ",
1473
"2019-02-04T00:00:00 ",
1474
"2019-02-05T00:00:00 ",
1476
"Last Checker Status",
1481
num_lines = max(len(rows) for rows in columns)
1482
expected_output = "\n".join("".join(rows[line]
1483
for rows in columns)
1484
for line in range(num_lines))
1485
self.assertEqual(output, expected_output)
1486
def test_one_client(self):
1487
output = PrintTableCmd().output(self.one_client.values())
1488
expected_output = "\n".join((
1489
"Name Enabled Timeout Last Successful Check",
1490
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1492
self.assertEqual(output, expected_output)
1495
class Unique(object):
1496
"""Class for objects which exist only to be unique objects, since
1497
unittest.mock.sentinel only exists in Python 3.3"""
1500
class TestPropertyCmd(TestCmd):
1501
"""Abstract class for tests of PropertyCmd classes"""
1503
if not hasattr(self, "command"):
1505
values_to_get = getattr(self, "values_to_get",
1507
for value_to_set, value_to_get in zip(self.values_to_set,
1509
for clientpath in self.clients:
1510
client = self.bus.get_object(dbus_busname, clientpath)
1511
old_value = client.attributes[self.propname]
1512
self.assertNotIsInstance(old_value, Unique)
1513
client.attributes[self.propname] = Unique()
1514
self.run_command(value_to_set, self.clients)
1515
for clientpath in self.clients:
1516
client = self.bus.get_object(dbus_busname, clientpath)
1517
value = client.attributes[self.propname]
1518
self.assertNotIsInstance(value, Unique)
1519
self.assertEqual(value, value_to_get)
1520
def run_command(self, value, clients):
1521
self.command().run(clients, self.bus)
1524
class TestEnableCmd(TestPropertyCmd):
1526
propname = "Enabled"
1527
values_to_set = [dbus.Boolean(True)]
1530
class TestDisableCmd(TestPropertyCmd):
1531
command = DisableCmd
1532
propname = "Enabled"
1533
values_to_set = [dbus.Boolean(False)]
1536
class TestBumpTimeoutCmd(TestPropertyCmd):
1537
command = BumpTimeoutCmd
1538
propname = "LastCheckedOK"
1539
values_to_set = [""]
1542
class TestStartCheckerCmd(TestPropertyCmd):
1543
command = StartCheckerCmd
1544
propname = "CheckerRunning"
1545
values_to_set = [dbus.Boolean(True)]
1548
class TestStopCheckerCmd(TestPropertyCmd):
1549
command = StopCheckerCmd
1550
propname = "CheckerRunning"
1551
values_to_set = [dbus.Boolean(False)]
1554
class TestApproveByDefaultCmd(TestPropertyCmd):
1555
command = ApproveByDefaultCmd
1556
propname = "ApprovedByDefault"
1557
values_to_set = [dbus.Boolean(True)]
1560
class TestDenyByDefaultCmd(TestPropertyCmd):
1561
command = DenyByDefaultCmd
1562
propname = "ApprovedByDefault"
1563
values_to_set = [dbus.Boolean(False)]
1566
class TestPropertyValueCmd(TestPropertyCmd):
1567
"""Abstract class for tests of PropertyValueCmd classes"""
1569
if type(self) is TestPropertyValueCmd:
1571
return super(TestPropertyValueCmd, self).runTest()
1572
def run_command(self, value, clients):
1573
self.command(value).run(clients, self.bus)
1576
class TestSetCheckerCmd(TestPropertyValueCmd):
1577
command = SetCheckerCmd
1578
propname = "Checker"
1579
values_to_set = ["", ":", "fping -q -- %s"]
1582
class TestSetHostCmd(TestPropertyValueCmd):
1583
command = SetHostCmd
1585
values_to_set = ["192.0.2.3", "foo.example.org"]
1588
class TestSetSecretCmd(TestPropertyValueCmd):
1589
command = SetSecretCmd
1591
values_to_set = [io.BytesIO(b""),
1592
io.BytesIO(b"secret\0xyzzy\nbar")]
1593
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1596
class TestSetTimeoutCmd(TestPropertyValueCmd):
1597
command = SetTimeoutCmd
1598
propname = "Timeout"
1599
values_to_set = [datetime.timedelta(),
1600
datetime.timedelta(minutes=5),
1601
datetime.timedelta(seconds=1),
1602
datetime.timedelta(weeks=1),
1603
datetime.timedelta(weeks=52)]
1604
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1607
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1608
command = SetExtendedTimeoutCmd
1609
propname = "ExtendedTimeout"
1610
values_to_set = [datetime.timedelta(),
1611
datetime.timedelta(minutes=5),
1612
datetime.timedelta(seconds=1),
1613
datetime.timedelta(weeks=1),
1614
datetime.timedelta(weeks=52)]
1615
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1618
class TestSetIntervalCmd(TestPropertyValueCmd):
1619
command = SetIntervalCmd
1620
propname = "Interval"
1621
values_to_set = [datetime.timedelta(),
1622
datetime.timedelta(minutes=5),
1623
datetime.timedelta(seconds=1),
1624
datetime.timedelta(weeks=1),
1625
datetime.timedelta(weeks=52)]
1626
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1629
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1630
command = SetApprovalDelayCmd
1631
propname = "ApprovalDelay"
1632
values_to_set = [datetime.timedelta(),
1633
datetime.timedelta(minutes=5),
1634
datetime.timedelta(seconds=1),
1635
datetime.timedelta(weeks=1),
1636
datetime.timedelta(weeks=52)]
1637
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1640
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1641
command = SetApprovalDurationCmd
1642
propname = "ApprovalDuration"
1643
values_to_set = [datetime.timedelta(),
1644
datetime.timedelta(minutes=5),
1645
datetime.timedelta(seconds=1),
1646
datetime.timedelta(weeks=1),
1647
datetime.timedelta(weeks=52)]
1648
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
507
1652
def should_only_run_tests():