446
424
options.remove = True
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
434
return mandos_dbus_object
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
462
self.logger.addFilter(self.nullfilter)
465
class NullFilter(logging.Filter):
466
def filter(self, record):
469
nullfilter = NullFilter()
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
449
475
def commands_from_options(options):
453
479
if options.is_enabled:
454
commands.append(IsEnabledCmd())
480
commands.append(command.IsEnabled())
456
482
if options.approve:
457
commands.append(ApproveCmd())
483
commands.append(command.Approve())
460
commands.append(DenyCmd())
486
commands.append(command.Deny())
462
488
if options.remove:
463
commands.append(RemoveCmd())
489
commands.append(command.Remove())
465
491
if options.dump_json:
466
commands.append(DumpJSONCmd())
492
commands.append(command.DumpJSON())
468
494
if options.enable:
469
commands.append(EnableCmd())
495
commands.append(command.Enable())
471
497
if options.disable:
472
commands.append(DisableCmd())
498
commands.append(command.Disable())
474
500
if options.bump_timeout:
475
commands.append(BumpTimeoutCmd())
501
commands.append(command.BumpTimeout())
477
503
if options.start_checker:
478
commands.append(StartCheckerCmd())
504
commands.append(command.StartChecker())
480
506
if options.stop_checker:
481
commands.append(StopCheckerCmd())
507
commands.append(command.StopChecker())
483
509
if options.approved_by_default is not None:
484
510
if options.approved_by_default:
485
commands.append(ApproveByDefaultCmd())
511
commands.append(command.ApproveByDefault())
487
commands.append(DenyByDefaultCmd())
513
commands.append(command.DenyByDefault())
489
515
if options.checker is not None:
490
commands.append(SetCheckerCmd(options.checker))
516
commands.append(command.SetChecker(options.checker))
492
518
if options.host is not None:
493
commands.append(SetHostCmd(options.host))
519
commands.append(command.SetHost(options.host))
495
521
if options.secret is not None:
496
commands.append(SetSecretCmd(options.secret))
522
commands.append(command.SetSecret(options.secret))
498
524
if options.timeout is not None:
499
commands.append(SetTimeoutCmd(options.timeout))
525
commands.append(command.SetTimeout(options.timeout))
501
527
if options.extended_timeout:
503
SetExtendedTimeoutCmd(options.extended_timeout))
529
command.SetExtendedTimeout(options.extended_timeout))
505
531
if options.interval is not None:
506
commands.append(SetIntervalCmd(options.interval))
532
commands.append(command.SetInterval(options.interval))
508
534
if options.approval_delay is not None:
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
536
command.SetApprovalDelay(options.approval_delay))
511
538
if options.approval_duration is not None:
513
SetApprovalDurationCmd(options.approval_duration))
540
command.SetApprovalDuration(options.approval_duration))
515
542
# If no command option has been given, show table of clients,
516
543
# optionally verbosely
518
commands.append(PrintTableCmd(verbose=options.verbose))
545
commands.append(command.PrintTable(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):
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 PrintCmd(Command):
572
"""Abstract class for commands printing 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(PrintCmd):
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(PrintCmd):
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__
550
class command(object):
551
"""A namespace for command classes"""
554
"""Abstract base class for commands"""
555
def run(self, clients, bus=None, mandos=None):
556
"""Normal commands should implement run_on_one_client(),
557
but commands which want to operate on all clients at the same time can
558
override this run() method instead.
561
for clientpath, properties in clients.items():
562
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
563
dbus_busname, str(clientpath))
564
client = bus.get_object(dbus_busname, clientpath)
565
self.run_on_one_client(client, properties)
568
class IsEnabled(Base):
569
def run(self, clients, bus=None, mandos=None):
570
client, properties = next(iter(clients.items()))
571
if self.is_enabled(client, properties):
574
def is_enabled(self, client, properties):
575
return properties["Enabled"]
579
def run_on_one_client(self, client, properties):
580
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
581
client.__dbus_object_path__,
582
client_dbus_interface)
583
client.Approve(dbus.Boolean(True),
584
dbus_interface=client_dbus_interface)
588
def run_on_one_client(self, client, properties):
589
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
590
client.__dbus_object_path__,
591
client_dbus_interface)
592
client.Approve(dbus.Boolean(False),
593
dbus_interface=client_dbus_interface)
597
def run_on_one_client(self, client, properties):
598
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
599
dbus_busname, server_dbus_path,
600
server_dbus_interface,
601
str(client.__dbus_object_path__))
602
self.mandos.RemoveClient(client.__dbus_object_path__)
606
"""Abstract class for commands outputting client details"""
607
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
608
"Created", "Interval", "Host", "KeyID",
609
"Fingerprint", "CheckerRunning",
610
"LastEnabled", "ApprovalPending",
611
"ApprovedByDefault", "LastApprovalRequest",
612
"ApprovalDelay", "ApprovalDuration",
613
"Checker", "ExtendedTimeout", "Expires",
616
def run(self, clients, bus=None, mandos=None):
617
print(self.output(clients.values()))
619
def output(self, clients):
620
raise NotImplementedError()
623
class DumpJSON(Output):
624
def output(self, clients):
625
data = {client["Name"]:
626
{key: self.dbus_boolean_to_bool(client[key])
627
for key in self.all_keywords}
628
for client in clients}
629
return json.dumps(data, indent=4, separators=(',', ': '))
632
def dbus_boolean_to_bool(value):
633
if isinstance(value, dbus.Boolean):
638
class PrintTable(Output):
639
def __init__(self, verbose=False):
640
self.verbose = verbose
642
def output(self, clients):
643
default_keywords = ("Name", "Enabled", "Timeout",
645
keywords = default_keywords
647
keywords = self.all_keywords
648
return str(self.TableOfClients(clients, keywords))
650
class TableOfClients(object):
653
"Enabled": "Enabled",
654
"Timeout": "Timeout",
655
"LastCheckedOK": "Last Successful Check",
656
"LastApprovalRequest": "Last Approval Request",
657
"Created": "Created",
658
"Interval": "Interval",
660
"Fingerprint": "Fingerprint",
662
"CheckerRunning": "Check Is Running",
663
"LastEnabled": "Last Enabled",
664
"ApprovalPending": "Approval Is Pending",
665
"ApprovedByDefault": "Approved By Default",
666
"ApprovalDelay": "Approval Delay",
667
"ApprovalDuration": "Approval Duration",
668
"Checker": "Checker",
669
"ExtendedTimeout": "Extended Timeout",
670
"Expires": "Expires",
671
"LastCheckerStatus": "Last Checker Status",
674
def __init__(self, clients, keywords):
675
self.clients = clients
676
self.keywords = keywords
647
678
def __str__(self):
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
679
return "\n".join(self.rows())
681
if sys.version_info.major == 2:
682
__unicode__ = __str__
684
return str(self).encode(
685
locale.getpreferredencoding())
688
format_string = self.row_formatting_string()
689
rows = [self.header_line(format_string)]
690
rows.extend(self.client_line(client, format_string)
691
for client in self.clients)
694
def row_formatting_string(self):
695
"Format string used to format table rows"
696
return " ".join("{{{key}:{width}}}".format(
697
width=max(len(self.tableheaders[key]),
698
*(len(self.string_from_client(client,
700
for client in self.clients)),
702
for key in self.keywords)
704
def string_from_client(self, client, key):
705
return self.valuetostring(client[key], key)
708
def valuetostring(cls, value, keyword):
709
if isinstance(value, dbus.Boolean):
710
return "Yes" if value else "No"
711
if keyword in ("Timeout", "Interval", "ApprovalDelay",
712
"ApprovalDuration", "ExtendedTimeout"):
713
return cls.milliseconds_to_string(value)
716
def header_line(self, format_string):
717
return format_string.format(**self.tableheaders)
719
def client_line(self, client, format_string):
720
return format_string.format(
721
**{key: self.string_from_client(client, key)
722
for key in self.keywords})
725
def milliseconds_to_string(ms):
726
td = datetime.timedelta(0, 0, 0, ms)
727
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
728
.format(days="{}T".format(td.days)
730
hours=td.seconds // 3600,
731
minutes=(td.seconds % 3600) // 60,
732
seconds=td.seconds % 60))
735
class Property(Base):
736
"Abstract class for Actions for setting one client property"
738
def run_on_one_client(self, client, properties):
739
"""Set the Client's D-Bus property"""
740
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
741
client.__dbus_object_path__,
742
dbus.PROPERTIES_IFACE, client_dbus_interface,
743
self.propname, self.value_to_set
744
if not isinstance(self.value_to_set,
746
else bool(self.value_to_set))
747
client.Set(client_dbus_interface, self.propname,
749
dbus_interface=dbus.PROPERTIES_IFACE)
753
raise NotImplementedError()
756
class Enable(Property):
758
value_to_set = dbus.Boolean(True)
761
class Disable(Property):
763
value_to_set = dbus.Boolean(False)
766
class BumpTimeout(Property):
767
propname = "LastCheckedOK"
771
class StartChecker(Property):
772
propname = "CheckerRunning"
773
value_to_set = dbus.Boolean(True)
776
class StopChecker(Property):
777
propname = "CheckerRunning"
778
value_to_set = dbus.Boolean(False)
781
class ApproveByDefault(Property):
782
propname = "ApprovedByDefault"
783
value_to_set = dbus.Boolean(True)
786
class DenyByDefault(Property):
787
propname = "ApprovedByDefault"
788
value_to_set = dbus.Boolean(False)
791
class PropertyValue(Property):
792
"Abstract class for Property recieving a value as argument"
793
def __init__(self, value):
794
self.value_to_set = value
797
class SetChecker(PropertyValue):
801
class SetHost(PropertyValue):
805
class SetSecret(PropertyValue):
809
def value_to_set(self):
813
def value_to_set(self, value):
814
"""When setting, read data from supplied file object"""
815
self._vts = value.read()
819
class MillisecondsPropertyValueArgument(PropertyValue):
820
"""Abstract class for PropertyValue taking a value argument as
778
821
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"
824
def value_to_set(self):
828
def value_to_set(self, value):
829
"When setting, convert value from a datetime.timedelta"
830
self._vts = int(round(value.total_seconds() * 1000))
833
class SetTimeout(MillisecondsPropertyValueArgument):
837
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
838
propname = "ExtendedTimeout"
841
class SetInterval(MillisecondsPropertyValueArgument):
842
propname = "Interval"
845
class SetApprovalDelay(MillisecondsPropertyValueArgument):
846
propname = "ApprovalDelay"
849
class SetApprovalDuration(MillisecondsPropertyValueArgument):
850
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))
854
class TestCaseWithAssertLogs(unittest.TestCase):
855
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
857
if not hasattr(unittest.TestCase, "assertLogs"):
858
@contextlib.contextmanager
859
def assertLogs(self, logger, level=logging.INFO):
860
capturing_handler = self.CapturingLevelHandler(level)
861
old_level = logger.level
862
old_propagate = logger.propagate
863
logger.addHandler(capturing_handler)
864
logger.setLevel(level)
865
logger.propagate = False
867
yield capturing_handler.watcher
869
logger.propagate = old_propagate
870
logger.removeHandler(capturing_handler)
871
logger.setLevel(old_level)
872
self.assertGreater(len(capturing_handler.watcher.records),
875
class CapturingLevelHandler(logging.Handler):
876
def __init__(self, level, *args, **kwargs):
877
logging.Handler.__init__(self, *args, **kwargs)
878
self.watcher = self.LoggingWatcher([], [])
879
def emit(self, record):
880
self.watcher.records.append(record)
881
self.watcher.output.append(self.format(record))
883
LoggingWatcher = collections.namedtuple("LoggingWatcher",
888
class Test_string_to_delta(TestCaseWithAssertLogs):
889
# Just test basic RFC 3339 functionality here, the doc string for
890
# rfc3339_duration_to_delta() already has more comprehensive
891
# tests, which is run by doctest.
893
def test_rfc3339_zero_seconds(self):
894
self.assertEqual(datetime.timedelta(),
895
string_to_delta("PT0S"))
897
def test_rfc3339_zero_days(self):
898
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
900
def test_rfc3339_one_second(self):
901
self.assertEqual(datetime.timedelta(0, 1),
902
string_to_delta("PT1S"))
904
def test_rfc3339_two_hours(self):
905
self.assertEqual(datetime.timedelta(0, 7200),
906
string_to_delta("PT2H"))
819
908
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))
909
with self.assertLogs(log, logging.WARNING):
910
value = string_to_delta("2h")
911
self.assertEqual(datetime.timedelta(0, 7200), value)
842
914
class Test_check_option_syntax(unittest.TestCase):
916
self.parser = argparse.ArgumentParser()
917
add_command_line_options(self.parser)
919
def test_actions_requires_client_or_all(self):
920
for action, value in self.actions.items():
921
options = self.parser.parse_args()
922
setattr(options, action, value)
923
with self.assertParseError():
924
self.check_option_syntax(options)
843
926
# This mostly corresponds to the definition from has_actions() in
844
927
# check_option_syntax()
982
1171
options = self.parser.parse_args(args)
983
1172
check_option_syntax(self.parser, options)
984
1173
commands = commands_from_options(options)
985
self.assertEqual(len(commands), 1)
1174
self.assertEqual(1, len(commands))
986
1175
command = commands[0]
987
1176
self.assertIsInstance(command, command_cls)
988
1177
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,
1178
self.assertEqual(value, getattr(command, key))
1180
def test_is_enabled_short(self):
1181
self.assert_command_from_args(["-V", "foo"],
1184
def test_approve(self):
1185
self.assert_command_from_args(["--approve", "foo"],
1188
def test_approve_short(self):
1189
self.assert_command_from_args(["-A", "foo"], command.Approve)
1191
def test_deny(self):
1192
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1194
def test_deny_short(self):
1195
self.assert_command_from_args(["-D", "foo"], command.Deny)
1197
def test_remove(self):
1198
self.assert_command_from_args(["--remove", "foo"],
1201
def test_deny_before_remove(self):
1202
options = self.parser.parse_args(["--deny", "--remove",
1204
check_option_syntax(self.parser, options)
1205
commands = commands_from_options(options)
1206
self.assertEqual(2, len(commands))
1207
self.assertIsInstance(commands[0], command.Deny)
1208
self.assertIsInstance(commands[1], command.Remove)
1210
def test_deny_before_remove_reversed(self):
1211
options = self.parser.parse_args(["--remove", "--deny",
1213
check_option_syntax(self.parser, options)
1214
commands = commands_from_options(options)
1215
self.assertEqual(2, len(commands))
1216
self.assertIsInstance(commands[0], command.Deny)
1217
self.assertIsInstance(commands[1], command.Remove)
1219
def test_remove_short(self):
1220
self.assert_command_from_args(["-r", "foo"], command.Remove)
1222
def test_dump_json(self):
1223
self.assert_command_from_args(["--dump-json"],
1002
1226
def test_enable(self):
1003
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1227
self.assert_command_from_args(["--enable", "foo"],
1005
1230
def test_enable_short(self):
1006
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1231
self.assert_command_from_args(["-e", "foo"], command.Enable)
1008
1233
def test_disable(self):
1009
1234
self.assert_command_from_args(["--disable", "foo"],
1012
1237
def test_disable_short(self):
1013
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1238
self.assert_command_from_args(["-d", "foo"], command.Disable)
1015
1240
def test_bump_timeout(self):
1016
1241
self.assert_command_from_args(["--bump-timeout", "foo"],
1242
command.BumpTimeout)
1019
1244
def test_bump_timeout_short(self):
1020
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1245
self.assert_command_from_args(["-b", "foo"],
1246
command.BumpTimeout)
1022
1248
def test_start_checker(self):
1023
1249
self.assert_command_from_args(["--start-checker", "foo"],
1250
command.StartChecker)
1026
1252
def test_stop_checker(self):
1027
1253
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)
1254
command.StopChecker)
1256
def test_approve_by_default(self):
1257
self.assert_command_from_args(["--approve-by-default", "foo"],
1258
command.ApproveByDefault)
1260
def test_deny_by_default(self):
1261
self.assert_command_from_args(["--deny-by-default", "foo"],
1262
command.DenyByDefault)
1037
1264
def test_checker(self):
1038
1265
self.assert_command_from_args(["--checker", ":", "foo"],
1039
SetCheckerCmd, value_to_set=":")
1041
1269
def test_checker_empty(self):
1042
1270
self.assert_command_from_args(["--checker", "", "foo"],
1043
SetCheckerCmd, value_to_set="")
1045
1274
def test_checker_short(self):
1046
1275
self.assert_command_from_args(["-c", ":", "foo"],
1047
SetCheckerCmd, value_to_set=":")
1279
def test_host(self):
1280
self.assert_command_from_args(["--host", "foo.example.org",
1281
"foo"], command.SetHost,
1282
value_to_set="foo.example.org")
1284
def test_host_short(self):
1285
self.assert_command_from_args(["-H", "foo.example.org",
1286
"foo"], command.SetHost,
1287
value_to_set="foo.example.org")
1289
def test_secret_devnull(self):
1290
self.assert_command_from_args(["--secret", os.path.devnull,
1291
"foo"], command.SetSecret,
1294
def test_secret_tempfile(self):
1295
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1296
value = b"secret\0xyzzy\nbar"
1299
self.assert_command_from_args(["--secret", f.name,
1300
"foo"], command.SetSecret,
1303
def test_secret_devnull_short(self):
1304
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1308
def test_secret_tempfile_short(self):
1309
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1310
value = b"secret\0xyzzy\nbar"
1313
self.assert_command_from_args(["-s", f.name, "foo"],
1049
1317
def test_timeout(self):
1050
1318
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1052
1320
value_to_set=300000)
1054
1322
def test_timeout_short(self):
1055
1323
self.assert_command_from_args(["-t", "PT5M", "foo"],
1057
1325
value_to_set=300000)
1059
1327
def test_extended_timeout(self):
1060
1328
self.assert_command_from_args(["--extended-timeout", "PT15M",
1062
SetExtendedTimeoutCmd,
1330
command.SetExtendedTimeout,
1063
1331
value_to_set=900000)
1065
1333
def test_interval(self):
1066
1334
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1335
command.SetInterval,
1068
1336
value_to_set=120000)
1070
1338
def test_interval_short(self):
1071
1339
self.assert_command_from_args(["-i", "PT2M", "foo"],
1340
command.SetInterval,
1073
1341
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
1343
def test_approval_delay(self):
1084
1344
self.assert_command_from_args(["--approval-delay", "PT30S",
1085
"foo"], SetApprovalDelayCmd,
1346
command.SetApprovalDelay,
1086
1347
value_to_set=30000)
1088
1349
def test_approval_duration(self):
1089
1350
self.assert_command_from_args(["--approval-duration", "PT1S",
1090
"foo"], SetApprovalDurationCmd,
1352
command.SetApprovalDuration,
1091
1353
value_to_set=1000)
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):
1355
def test_print_table(self):
1356
self.assert_command_from_args([], command.PrintTable,
1359
def test_print_table_verbose(self):
1360
self.assert_command_from_args(["--verbose"],
1364
def test_print_table_verbose_short(self):
1365
self.assert_command_from_args(["-v"], command.PrintTable,
1369
class TestCommand(unittest.TestCase):
1173
1370
"""Abstract class for tests of command classes"""
1174
1372
def setUp(self):
1175
1373
testcase = self
1176
1374
class MockClient(object):
1248
1441
("/clients/barbar", self.other_client.attributes),
1250
1443
self.one_client = {"/clients/foo": self.client.attributes}
1253
1447
class Bus(object):
1255
1449
def get_object(client_bus_name, path):
1256
self.assertEqual(client_bus_name, dbus_busname)
1450
self.assertEqual(dbus_busname, client_bus_name)
1452
# Note: "self" here is the TestCmd instance, not
1453
# the Bus instance, since this is a static method!
1258
1454
"/clients/foo": self.client,
1259
1455
"/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):
1460
class TestBaseCommands(TestCommand):
1462
def test_IsEnabled_exits_successfully(self):
1271
1463
with self.assertRaises(SystemExit) as e:
1272
IsEnabledCmd().run(self.one_client)
1464
command.IsEnabled().run(self.one_client)
1273
1465
if e.exception.code is not None:
1274
self.assertEqual(e.exception.code, 0)
1466
self.assertEqual(0, e.exception.code)
1276
1468
self.assertIsNone(e.exception.code)
1277
def test_is_enabled_run_exits_with_failure(self):
1470
def test_IsEnabled_exits_with_failure(self):
1278
1471
self.client.attributes["Enabled"] = dbus.Boolean(False)
1279
1472
with self.assertRaises(SystemExit) as e:
1280
IsEnabledCmd().run(self.one_client)
1473
command.IsEnabled().run(self.one_client)
1281
1474
if isinstance(e.exception.code, int):
1282
self.assertNotEqual(e.exception.code, 0)
1475
self.assertNotEqual(0, e.exception.code)
1284
1477
self.assertIsNotNone(e.exception.code)
1287
class TestApproveCmd(TestCmd):
1288
def test_approve(self):
1289
ApproveCmd().run(self.clients, self.bus)
1479
def test_Approve(self):
1480
command.Approve().run(self.clients, self.bus)
1290
1481
for clientpath in self.clients:
1291
1482
client = self.bus.get_object(dbus_busname, clientpath)
1292
1483
self.assertIn(("Approve", (True, client_dbus_interface)),
1296
class TestDenyCmd(TestCmd):
1297
def test_deny(self):
1298
DenyCmd().run(self.clients, self.bus)
1486
def test_Deny(self):
1487
command.Deny().run(self.clients, self.bus)
1299
1488
for clientpath in self.clients:
1300
1489
client = self.bus.get_object(dbus_busname, clientpath)
1301
1490
self.assertIn(("Approve", (False, client_dbus_interface)),
1304
class TestRemoveCmd(TestCmd):
1305
def test_remove(self):
1493
def test_Remove(self):
1306
1494
class MockMandos(object):
1307
1495
def __init__(self):
1308
1496
self.calls = []
1309
1497
def RemoveClient(self, dbus_path):
1310
1498
self.calls.append(("RemoveClient", (dbus_path,)))
1311
1499
mandos = MockMandos()
1312
super(TestRemoveCmd, self).setUp()
1313
RemoveCmd().run(self.clients, self.bus, mandos)
1314
self.assertEqual(len(mandos.calls), 2)
1500
command.Remove().run(self.clients, self.bus, mandos)
1315
1501
for clientpath in self.clients:
1316
1502
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))
1508
"KeyID": ("92ed150794387c03ce684574b1139a65"
1509
"94a34f895daaaf09fd8ea90a27cddb12"),
1510
"Host": "foo.example.org",
1513
"LastCheckedOK": "2019-02-03T00:00:00",
1514
"Created": "2019-01-02T00:00:00",
1516
"Fingerprint": ("778827225BA7DE539C5A"
1517
"7CFA59CFF7CDBD9A5920"),
1518
"CheckerRunning": False,
1519
"LastEnabled": "2019-01-03T00:00:00",
1520
"ApprovalPending": False,
1521
"ApprovedByDefault": True,
1522
"LastApprovalRequest": "",
1524
"ApprovalDuration": 1000,
1525
"Checker": "fping -q -- %(host)s",
1526
"ExtendedTimeout": 900000,
1527
"Expires": "2019-02-04T00:00:00",
1528
"LastCheckerStatus": 0,
1532
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1533
"6ab612cff5ad227247e46c2b020f441c"),
1534
"Host": "192.0.2.3",
1537
"LastCheckedOK": "2019-02-04T00:00:00",
1538
"Created": "2019-01-03T00:00:00",
1540
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1541
"F547B3A107558FCA3A27"),
1542
"CheckerRunning": True,
1543
"LastEnabled": "2019-01-04T00:00:00",
1544
"ApprovalPending": False,
1545
"ApprovedByDefault": False,
1546
"LastApprovalRequest": "2019-01-03T00:00:00",
1547
"ApprovalDelay": 30000,
1548
"ApprovalDuration": 93785000,
1550
"ExtendedTimeout": 900000,
1551
"Expires": "2019-02-05T00:00:00",
1552
"LastCheckerStatus": -2,
1556
def test_DumpJSON_normal(self):
1557
with self.capture_stdout_to_buffer() as buffer:
1558
command.DumpJSON().run(self.clients)
1559
json_data = json.loads(buffer.getvalue())
1560
self.assertDictEqual(self.expected_json, json_data)
1563
@contextlib.contextmanager
1564
def capture_stdout_to_buffer():
1565
capture_buffer = io.StringIO()
1566
old_stdout = sys.stdout
1567
sys.stdout = capture_buffer
1569
yield capture_buffer
1571
sys.stdout = old_stdout
1573
def test_DumpJSON_one_client(self):
1574
with self.capture_stdout_to_buffer() as buffer:
1575
command.DumpJSON().run(self.one_client)
1576
json_data = json.loads(buffer.getvalue())
1379
1577
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())
1578
self.assertDictEqual(expected_json, json_data)
1580
def test_PrintTable_normal(self):
1581
with self.capture_stdout_to_buffer() as buffer:
1582
command.PrintTable().run(self.clients)
1386
1583
expected_output = "\n".join((
1387
1584
"Name Enabled Timeout Last Successful Check",
1388
1585
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1389
1586
"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())
1588
self.assertEqual(expected_output, buffer.getvalue())
1590
def test_PrintTable_verbose(self):
1591
with self.capture_stdout_to_buffer() as buffer:
1592
command.PrintTable(verbose=True).run(self.clients)