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)
464
class NullFilter(logging.Filter):
465
def filter(self, record):
468
nullfilter = NullFilter()
470
def __exit__(self, exc_type, exc_val, exc_tb):
471
self.logger.removeFilter(self.nullfilter)
449
474
def commands_from_options(options):
453
478
if options.is_enabled:
454
commands.append(IsEnabledCmd())
479
commands.append(command.IsEnabled())
456
481
if options.approve:
457
commands.append(ApproveCmd())
482
commands.append(command.Approve())
460
commands.append(DenyCmd())
485
commands.append(command.Deny())
462
487
if options.remove:
463
commands.append(RemoveCmd())
488
commands.append(command.Remove())
465
490
if options.dump_json:
466
commands.append(DumpJSONCmd())
491
commands.append(command.DumpJSON())
468
493
if options.enable:
469
commands.append(EnableCmd())
494
commands.append(command.Enable())
471
496
if options.disable:
472
commands.append(DisableCmd())
497
commands.append(command.Disable())
474
499
if options.bump_timeout:
475
commands.append(BumpTimeoutCmd())
500
commands.append(command.BumpTimeout())
477
502
if options.start_checker:
478
commands.append(StartCheckerCmd())
503
commands.append(command.StartChecker())
480
505
if options.stop_checker:
481
commands.append(StopCheckerCmd())
506
commands.append(command.StopChecker())
483
508
if options.approved_by_default is not None:
484
509
if options.approved_by_default:
485
commands.append(ApproveByDefaultCmd())
510
commands.append(command.ApproveByDefault())
487
commands.append(DenyByDefaultCmd())
512
commands.append(command.DenyByDefault())
489
514
if options.checker is not None:
490
commands.append(SetCheckerCmd(options.checker))
515
commands.append(command.SetChecker(options.checker))
492
517
if options.host is not None:
493
commands.append(SetHostCmd(options.host))
518
commands.append(command.SetHost(options.host))
495
520
if options.secret is not None:
496
commands.append(SetSecretCmd(options.secret))
521
commands.append(command.SetSecret(options.secret))
498
523
if options.timeout is not None:
499
commands.append(SetTimeoutCmd(options.timeout))
524
commands.append(command.SetTimeout(options.timeout))
501
526
if options.extended_timeout:
503
SetExtendedTimeoutCmd(options.extended_timeout))
528
command.SetExtendedTimeout(options.extended_timeout))
505
530
if options.interval is not None:
506
commands.append(SetIntervalCmd(options.interval))
531
commands.append(command.SetInterval(options.interval))
508
533
if options.approval_delay is not None:
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
535
command.SetApprovalDelay(options.approval_delay))
511
537
if options.approval_duration is not None:
513
SetApprovalDurationCmd(options.approval_duration))
539
command.SetApprovalDuration(options.approval_duration))
515
541
# If no command option has been given, show table of clients,
516
542
# optionally verbosely
518
commands.append(PrintTableCmd(verbose=options.verbose))
544
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 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")
581
def run(self, clients, bus=None, mandos=None):
582
print(self.output(clients.values()))
584
def output(self, clients):
585
raise NotImplementedError()
588
class DumpJSONCmd(OutputCmd):
589
def output(self, clients):
590
data = {client["Name"]:
591
{key: self.dbus_boolean_to_bool(client[key])
592
for key in self.all_keywords}
593
for client in clients}
594
return json.dumps(data, indent=4, separators=(',', ': '))
597
def dbus_boolean_to_bool(value):
598
if isinstance(value, dbus.Boolean):
603
class PrintTableCmd(OutputCmd):
604
def __init__(self, verbose=False):
605
self.verbose = verbose
607
def output(self, clients):
608
default_keywords = ("Name", "Enabled", "Timeout",
610
keywords = default_keywords
612
keywords = self.all_keywords
613
return str(self.TableOfClients(clients, keywords))
615
class TableOfClients(object):
618
"Enabled": "Enabled",
619
"Timeout": "Timeout",
620
"LastCheckedOK": "Last Successful Check",
621
"LastApprovalRequest": "Last Approval Request",
622
"Created": "Created",
623
"Interval": "Interval",
625
"Fingerprint": "Fingerprint",
627
"CheckerRunning": "Check Is Running",
628
"LastEnabled": "Last Enabled",
629
"ApprovalPending": "Approval Is Pending",
630
"ApprovedByDefault": "Approved By Default",
631
"ApprovalDelay": "Approval Delay",
632
"ApprovalDuration": "Approval Duration",
633
"Checker": "Checker",
634
"ExtendedTimeout": "Extended Timeout",
635
"Expires": "Expires",
636
"LastCheckerStatus": "Last Checker Status",
639
def __init__(self, clients, keywords, tableheaders=None):
640
self.clients = clients
641
self.keywords = keywords
642
if tableheaders is not None:
643
self.tableheaders = tableheaders
646
return "\n".join(self.rows())
648
if sys.version_info.major == 2:
649
__unicode__ = __str__
549
class command(object):
550
"""A namespace for command classes"""
553
"""Abstract base class for commands"""
554
def run(self, clients, bus=None, mandos=None):
555
"""Normal commands should implement run_on_one_client(),
556
but commands which want to operate on all clients at the same time can
557
override this run() method instead.
559
for clientpath, properties in clients.items():
560
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
561
dbus_busname, str(clientpath))
562
client = bus.get_object(dbus_busname, clientpath)
563
self.run_on_one_client(client, properties)
566
class IsEnabled(Base):
567
def run(self, clients, bus=None, mandos=None):
568
client, properties = next(iter(clients.items()))
569
if self.is_enabled(client, properties):
572
def is_enabled(self, client, properties):
573
return properties["Enabled"]
577
def run_on_one_client(self, client, properties):
578
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
579
client.__dbus_object_path__,
580
client_dbus_interface)
581
client.Approve(dbus.Boolean(True),
582
dbus_interface=client_dbus_interface)
586
def run_on_one_client(self, client, properties):
587
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
588
client.__dbus_object_path__,
589
client_dbus_interface)
590
client.Approve(dbus.Boolean(False),
591
dbus_interface=client_dbus_interface)
595
def run(self, clients, bus, mandos):
596
for clientpath in clients.keys():
597
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
598
dbus_busname, server_dbus_path,
599
server_dbus_interface, clientpath)
600
mandos.RemoveClient(clientpath)
604
"""Abstract class for commands outputting client details"""
605
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
606
"Created", "Interval", "Host", "KeyID",
607
"Fingerprint", "CheckerRunning",
608
"LastEnabled", "ApprovalPending",
609
"ApprovedByDefault", "LastApprovalRequest",
610
"ApprovalDelay", "ApprovalDuration",
611
"Checker", "ExtendedTimeout", "Expires",
615
class DumpJSON(Output):
616
def run(self, clients, bus=None, mandos=None):
617
data = {client["Name"]:
618
{key: self.dbus_boolean_to_bool(client[key])
619
for key in self.all_keywords}
620
for client in clients.values()}
621
print(json.dumps(data, indent=4, separators=(',', ': ')))
624
def dbus_boolean_to_bool(value):
625
if isinstance(value, dbus.Boolean):
630
class PrintTable(Output):
631
def __init__(self, verbose=False):
632
self.verbose = verbose
634
def run(self, clients, bus=None, mandos=None):
635
default_keywords = ("Name", "Enabled", "Timeout",
637
keywords = default_keywords
639
keywords = self.all_keywords
640
print(self.TableOfClients(clients.values(), keywords))
642
class TableOfClients(object):
645
"Enabled": "Enabled",
646
"Timeout": "Timeout",
647
"LastCheckedOK": "Last Successful Check",
648
"LastApprovalRequest": "Last Approval Request",
649
"Created": "Created",
650
"Interval": "Interval",
652
"Fingerprint": "Fingerprint",
654
"CheckerRunning": "Check Is Running",
655
"LastEnabled": "Last Enabled",
656
"ApprovalPending": "Approval Is Pending",
657
"ApprovedByDefault": "Approved By Default",
658
"ApprovalDelay": "Approval Delay",
659
"ApprovalDuration": "Approval Duration",
660
"Checker": "Checker",
661
"ExtendedTimeout": "Extended Timeout",
662
"Expires": "Expires",
663
"LastCheckerStatus": "Last Checker Status",
666
def __init__(self, clients, keywords):
667
self.clients = clients
668
self.keywords = keywords
650
670
def __str__(self):
651
return str(self).encode(locale.getpreferredencoding())
654
format_string = self.row_formatting_string()
655
rows = [self.header_line(format_string)]
656
rows.extend(self.client_line(client, format_string)
657
for client in self.clients)
660
def row_formatting_string(self):
661
"Format string used to format table rows"
662
return " ".join("{{{key}:{width}}}".format(
663
width=max(len(self.tableheaders[key]),
664
*(len(self.string_from_client(client, key))
665
for client in self.clients)),
667
for key in self.keywords)
669
def string_from_client(self, client, key):
670
return self.valuetostring(client[key], key)
673
def valuetostring(cls, value, keyword):
674
if isinstance(value, dbus.Boolean):
675
return "Yes" if value else "No"
676
if keyword in ("Timeout", "Interval", "ApprovalDelay",
677
"ApprovalDuration", "ExtendedTimeout"):
678
return cls.milliseconds_to_string(value)
681
def header_line(self, format_string):
682
return format_string.format(**self.tableheaders)
684
def client_line(self, client, format_string):
685
return format_string.format(
686
**{key: self.string_from_client(client, key)
687
for key in self.keywords})
690
def milliseconds_to_string(ms):
691
td = datetime.timedelta(0, 0, 0, ms)
692
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
693
.format(days="{}T".format(td.days)
695
hours=td.seconds // 3600,
696
minutes=(td.seconds % 3600) // 60,
697
seconds=td.seconds % 60))
700
class PropertyCmd(Command):
701
"""Abstract class for Actions for setting one client property"""
703
def run_on_one_client(self, client, properties):
704
"""Set the Client's D-Bus property"""
705
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
706
client.__dbus_object_path__,
707
dbus.PROPERTIES_IFACE, client_dbus_interface,
708
self.propname, self.value_to_set
709
if not isinstance(self.value_to_set, dbus.Boolean)
710
else bool(self.value_to_set))
711
client.Set(client_dbus_interface, self.propname,
713
dbus_interface=dbus.PROPERTIES_IFACE)
717
raise NotImplementedError()
720
class EnableCmd(PropertyCmd):
722
value_to_set = dbus.Boolean(True)
725
class DisableCmd(PropertyCmd):
727
value_to_set = dbus.Boolean(False)
730
class BumpTimeoutCmd(PropertyCmd):
731
propname = "LastCheckedOK"
735
class StartCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
737
value_to_set = dbus.Boolean(True)
740
class StopCheckerCmd(PropertyCmd):
741
propname = "CheckerRunning"
742
value_to_set = dbus.Boolean(False)
745
class ApproveByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
747
value_to_set = dbus.Boolean(True)
750
class DenyByDefaultCmd(PropertyCmd):
751
propname = "ApprovedByDefault"
752
value_to_set = dbus.Boolean(False)
755
class PropertyValueCmd(PropertyCmd):
756
"""Abstract class for PropertyCmd recieving a value as argument"""
757
def __init__(self, value):
758
self.value_to_set = value
761
class SetCheckerCmd(PropertyValueCmd):
765
class SetHostCmd(PropertyValueCmd):
769
class SetSecretCmd(PropertyValueCmd):
773
def value_to_set(self):
777
def value_to_set(self, value):
778
"""When setting, read data from supplied file object"""
779
self._vts = value.read()
783
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
784
"""Abstract class for PropertyValueCmd taking a value argument as
785
a datetime.timedelta() but should store it as milliseconds."""
788
def value_to_set(self):
792
def value_to_set(self, value):
793
"""When setting, convert value from a datetime.timedelta"""
794
self._vts = int(round(value.total_seconds() * 1000))
797
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
801
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
802
propname = "ExtendedTimeout"
805
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
806
propname = "Interval"
809
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
810
propname = "ApprovalDelay"
813
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
814
propname = "ApprovalDuration"
671
return "\n".join(self.rows())
673
if sys.version_info.major == 2:
674
__unicode__ = __str__
676
return str(self).encode(
677
locale.getpreferredencoding())
680
format_string = self.row_formatting_string()
681
rows = [self.header_line(format_string)]
682
rows.extend(self.client_line(client, format_string)
683
for client in self.clients)
686
def row_formatting_string(self):
687
"Format string used to format table rows"
688
return " ".join("{{{key}:{width}}}".format(
689
width=max(len(self.tableheaders[key]),
690
*(len(self.string_from_client(client,
692
for client in self.clients)),
694
for key in self.keywords)
696
def string_from_client(self, client, key):
697
return self.valuetostring(client[key], key)
700
def valuetostring(cls, value, keyword):
701
if isinstance(value, dbus.Boolean):
702
return "Yes" if value else "No"
703
if keyword in ("Timeout", "Interval", "ApprovalDelay",
704
"ApprovalDuration", "ExtendedTimeout"):
705
return cls.milliseconds_to_string(value)
708
def header_line(self, format_string):
709
return format_string.format(**self.tableheaders)
711
def client_line(self, client, format_string):
712
return format_string.format(
713
**{key: self.string_from_client(client, key)
714
for key in self.keywords})
717
def milliseconds_to_string(ms):
718
td = datetime.timedelta(0, 0, 0, ms)
719
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
720
.format(days="{}T".format(td.days)
722
hours=td.seconds // 3600,
723
minutes=(td.seconds % 3600) // 60,
724
seconds=td.seconds % 60))
727
class PropertySetter(Base):
728
"Abstract class for Actions for setting one client property"
730
def run_on_one_client(self, client, properties):
731
"""Set the Client's D-Bus property"""
732
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
733
client.__dbus_object_path__,
734
dbus.PROPERTIES_IFACE, client_dbus_interface,
735
self.propname, self.value_to_set
736
if not isinstance(self.value_to_set,
738
else bool(self.value_to_set))
739
client.Set(client_dbus_interface, self.propname,
741
dbus_interface=dbus.PROPERTIES_IFACE)
745
raise NotImplementedError()
748
class Enable(PropertySetter):
750
value_to_set = dbus.Boolean(True)
753
class Disable(PropertySetter):
755
value_to_set = dbus.Boolean(False)
758
class BumpTimeout(PropertySetter):
759
propname = "LastCheckedOK"
763
class StartChecker(PropertySetter):
764
propname = "CheckerRunning"
765
value_to_set = dbus.Boolean(True)
768
class StopChecker(PropertySetter):
769
propname = "CheckerRunning"
770
value_to_set = dbus.Boolean(False)
773
class ApproveByDefault(PropertySetter):
774
propname = "ApprovedByDefault"
775
value_to_set = dbus.Boolean(True)
778
class DenyByDefault(PropertySetter):
779
propname = "ApprovedByDefault"
780
value_to_set = dbus.Boolean(False)
783
class PropertySetterValue(PropertySetter):
784
"""Abstract class for PropertySetter recieving a value as
785
constructor argument instead of a class attribute."""
786
def __init__(self, value):
787
self.value_to_set = value
790
class SetChecker(PropertySetterValue):
794
class SetHost(PropertySetterValue):
798
class SetSecret(PropertySetterValue):
802
def value_to_set(self):
806
def value_to_set(self, value):
807
"""When setting, read data from supplied file object"""
808
self._vts = value.read()
812
class PropertySetterValueMilliseconds(PropertySetterValue):
813
"""Abstract class for PropertySetterValue taking a value
814
argument as a datetime.timedelta() but should store it as
818
def value_to_set(self):
822
def value_to_set(self, value):
823
"When setting, convert value from a datetime.timedelta"
824
self._vts = int(round(value.total_seconds() * 1000))
827
class SetTimeout(PropertySetterValueMilliseconds):
831
class SetExtendedTimeout(PropertySetterValueMilliseconds):
832
propname = "ExtendedTimeout"
835
class SetInterval(PropertySetterValueMilliseconds):
836
propname = "Interval"
839
class SetApprovalDelay(PropertySetterValueMilliseconds):
840
propname = "ApprovalDelay"
843
class SetApprovalDuration(PropertySetterValueMilliseconds):
844
propname = "ApprovalDuration"
818
class Test_string_to_delta(unittest.TestCase):
819
def test_handles_basic_rfc3339(self):
820
self.assertEqual(string_to_delta("PT0S"),
821
datetime.timedelta())
822
self.assertEqual(string_to_delta("P0D"),
823
datetime.timedelta())
824
self.assertEqual(string_to_delta("PT1S"),
825
datetime.timedelta(0, 1))
826
self.assertEqual(string_to_delta("PT2H"),
827
datetime.timedelta(0, 7200))
848
class TestCaseWithAssertLogs(unittest.TestCase):
849
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
851
if not hasattr(unittest.TestCase, "assertLogs"):
852
@contextlib.contextmanager
853
def assertLogs(self, logger, level=logging.INFO):
854
capturing_handler = self.CapturingLevelHandler(level)
855
old_level = logger.level
856
old_propagate = logger.propagate
857
logger.addHandler(capturing_handler)
858
logger.setLevel(level)
859
logger.propagate = False
861
yield capturing_handler.watcher
863
logger.propagate = old_propagate
864
logger.removeHandler(capturing_handler)
865
logger.setLevel(old_level)
866
self.assertGreater(len(capturing_handler.watcher.records),
869
class CapturingLevelHandler(logging.Handler):
870
def __init__(self, level, *args, **kwargs):
871
logging.Handler.__init__(self, *args, **kwargs)
872
self.watcher = self.LoggingWatcher([], [])
873
def emit(self, record):
874
self.watcher.records.append(record)
875
self.watcher.output.append(self.format(record))
877
LoggingWatcher = collections.namedtuple("LoggingWatcher",
882
class Test_string_to_delta(TestCaseWithAssertLogs):
883
# Just test basic RFC 3339 functionality here, the doc string for
884
# rfc3339_duration_to_delta() already has more comprehensive
885
# tests, which is run by doctest.
887
def test_rfc3339_zero_seconds(self):
888
self.assertEqual(datetime.timedelta(),
889
string_to_delta("PT0S"))
891
def test_rfc3339_zero_days(self):
892
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
894
def test_rfc3339_one_second(self):
895
self.assertEqual(datetime.timedelta(0, 1),
896
string_to_delta("PT1S"))
898
def test_rfc3339_two_hours(self):
899
self.assertEqual(datetime.timedelta(0, 7200),
900
string_to_delta("PT2H"))
829
902
def test_falls_back_to_pre_1_6_1_with_warning(self):
830
# assertLogs only exists in Python 3.4
831
if hasattr(self, "assertLogs"):
832
with self.assertLogs(log, logging.WARNING):
833
value = string_to_delta("2h")
835
class WarningFilter(logging.Filter):
836
"""Don't show, but record the presence of, warnings"""
837
def filter(self, record):
838
is_warning = record.levelno >= logging.WARNING
839
self.found = is_warning or getattr(self, "found",
841
return not is_warning
842
warning_filter = WarningFilter()
843
log.addFilter(warning_filter)
845
value = string_to_delta("2h")
847
log.removeFilter(warning_filter)
848
self.assertTrue(getattr(warning_filter, "found", False))
849
self.assertEqual(value, datetime.timedelta(0, 7200))
903
with self.assertLogs(log, logging.WARNING):
904
value = string_to_delta("2h")
905
self.assertEqual(datetime.timedelta(0, 7200), value)
852
908
class Test_check_option_syntax(unittest.TestCase):
997
1165
options = self.parser.parse_args(args)
998
1166
check_option_syntax(self.parser, options)
999
1167
commands = commands_from_options(options)
1000
self.assertEqual(len(commands), 1)
1168
self.assertEqual(1, len(commands))
1001
1169
command = commands[0]
1002
1170
self.assertIsInstance(command, command_cls)
1003
1171
for key, value in cmd_attrs.items():
1004
self.assertEqual(getattr(command, key), value)
1172
self.assertEqual(value, getattr(command, key))
1006
1174
def test_is_enabled_short(self):
1007
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1175
self.assert_command_from_args(["-V", "client"],
1009
1178
def test_approve(self):
1010
self.assert_command_from_args(["--approve", "foo"],
1179
self.assert_command_from_args(["--approve", "client"],
1013
1182
def test_approve_short(self):
1014
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1183
self.assert_command_from_args(["-A", "client"],
1016
1186
def test_deny(self):
1017
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1187
self.assert_command_from_args(["--deny", "client"],
1019
1190
def test_deny_short(self):
1020
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1191
self.assert_command_from_args(["-D", "client"], command.Deny)
1022
1193
def test_remove(self):
1023
self.assert_command_from_args(["--remove", "foo"],
1194
self.assert_command_from_args(["--remove", "client"],
1026
1197
def test_deny_before_remove(self):
1027
1198
options = self.parser.parse_args(["--deny", "--remove",
1029
1200
check_option_syntax(self.parser, options)
1030
1201
commands = commands_from_options(options)
1031
self.assertEqual(len(commands), 2)
1032
self.assertIsInstance(commands[0], DenyCmd)
1033
self.assertIsInstance(commands[1], RemoveCmd)
1202
self.assertEqual(2, len(commands))
1203
self.assertIsInstance(commands[0], command.Deny)
1204
self.assertIsInstance(commands[1], command.Remove)
1035
1206
def test_deny_before_remove_reversed(self):
1036
1207
options = self.parser.parse_args(["--remove", "--deny",
1038
1209
check_option_syntax(self.parser, options)
1039
1210
commands = commands_from_options(options)
1040
self.assertEqual(len(commands), 2)
1041
self.assertIsInstance(commands[0], DenyCmd)
1042
self.assertIsInstance(commands[1], RemoveCmd)
1211
self.assertEqual(2, len(commands))
1212
self.assertIsInstance(commands[0], command.Deny)
1213
self.assertIsInstance(commands[1], command.Remove)
1044
1215
def test_remove_short(self):
1045
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1216
self.assert_command_from_args(["-r", "client"],
1047
1219
def test_dump_json(self):
1048
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1220
self.assert_command_from_args(["--dump-json"],
1050
1223
def test_enable(self):
1051
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1224
self.assert_command_from_args(["--enable", "client"],
1053
1227
def test_enable_short(self):
1054
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1228
self.assert_command_from_args(["-e", "client"],
1056
1231
def test_disable(self):
1057
self.assert_command_from_args(["--disable", "foo"],
1232
self.assert_command_from_args(["--disable", "client"],
1060
1235
def test_disable_short(self):
1061
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1236
self.assert_command_from_args(["-d", "client"],
1063
1239
def test_bump_timeout(self):
1064
self.assert_command_from_args(["--bump-timeout", "foo"],
1240
self.assert_command_from_args(["--bump-timeout", "client"],
1241
command.BumpTimeout)
1067
1243
def test_bump_timeout_short(self):
1068
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1244
self.assert_command_from_args(["-b", "client"],
1245
command.BumpTimeout)
1070
1247
def test_start_checker(self):
1071
self.assert_command_from_args(["--start-checker", "foo"],
1248
self.assert_command_from_args(["--start-checker", "client"],
1249
command.StartChecker)
1074
1251
def test_stop_checker(self):
1075
self.assert_command_from_args(["--stop-checker", "foo"],
1252
self.assert_command_from_args(["--stop-checker", "client"],
1253
command.StopChecker)
1078
1255
def test_approve_by_default(self):
1079
self.assert_command_from_args(["--approve-by-default", "foo"],
1080
ApproveByDefaultCmd)
1256
self.assert_command_from_args(["--approve-by-default",
1258
command.ApproveByDefault)
1082
1260
def test_deny_by_default(self):
1083
self.assert_command_from_args(["--deny-by-default", "foo"],
1261
self.assert_command_from_args(["--deny-by-default", "client"],
1262
command.DenyByDefault)
1086
1264
def test_checker(self):
1087
self.assert_command_from_args(["--checker", ":", "foo"],
1088
SetCheckerCmd, value_to_set=":")
1265
self.assert_command_from_args(["--checker", ":", "client"],
1090
1269
def test_checker_empty(self):
1091
self.assert_command_from_args(["--checker", "", "foo"],
1092
SetCheckerCmd, value_to_set="")
1270
self.assert_command_from_args(["--checker", "", "client"],
1094
1274
def test_checker_short(self):
1095
self.assert_command_from_args(["-c", ":", "foo"],
1096
SetCheckerCmd, value_to_set=":")
1275
self.assert_command_from_args(["-c", ":", "client"],
1098
1279
def test_host(self):
1099
self.assert_command_from_args(["--host", "foo.example.org",
1101
value_to_set="foo.example.org")
1280
self.assert_command_from_args(
1281
["--host", "client.example.org", "client"],
1282
command.SetHost, value_to_set="client.example.org")
1103
1284
def test_host_short(self):
1104
self.assert_command_from_args(["-H", "foo.example.org",
1106
value_to_set="foo.example.org")
1285
self.assert_command_from_args(
1286
["-H", "client.example.org", "client"], command.SetHost,
1287
value_to_set="client.example.org")
1108
1289
def test_secret_devnull(self):
1109
1290
self.assert_command_from_args(["--secret", os.path.devnull,
1110
"foo"], SetSecretCmd,
1291
"client"], command.SetSecret,
1111
1292
value_to_set=b"")
1113
1294
def test_secret_tempfile(self):
1257
1438
LastCheckerStatus=-2)
1258
1439
self.clients = collections.OrderedDict(
1260
("/clients/foo", self.client.attributes),
1261
("/clients/barbar", self.other_client.attributes),
1441
(self.client.__dbus_object_path__,
1442
self.client.attributes),
1443
(self.other_client.__dbus_object_path__,
1444
self.other_client.attributes),
1263
self.one_client = {"/clients/foo": self.client.attributes}
1446
self.one_client = {self.client.__dbus_object_path__:
1447
self.client.attributes}
1451
class MockBus(object):
1269
1453
def get_object(client_bus_name, path):
1270
self.assertEqual(client_bus_name, dbus_busname)
1272
# Note: "self" here is the TestCmd instance, not
1273
# the Bus instance, since this is a static method!
1274
"/clients/foo": self.client,
1275
"/clients/barbar": self.other_client,
1280
class TestIsEnabledCmd(TestCmd):
1281
def test_is_enabled(self):
1282
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1284
for client, properties
1285
in self.clients.items()))
1287
def test_is_enabled_run_exits_successfully(self):
1454
self.assertEqual(dbus_busname, client_bus_name)
1455
# Note: "self" here is the TestCmd instance, not the
1456
# MockBus instance, since this is a static method!
1457
if path == self.client.__dbus_object_path__:
1459
elif path == self.other_client.__dbus_object_path__:
1460
return self.other_client
1464
class TestBaseCommands(TestCommand):
1466
def test_IsEnabled_exits_successfully(self):
1288
1467
with self.assertRaises(SystemExit) as e:
1289
IsEnabledCmd().run(self.one_client)
1468
command.IsEnabled().run(self.one_client)
1290
1469
if e.exception.code is not None:
1291
self.assertEqual(e.exception.code, 0)
1470
self.assertEqual(0, e.exception.code)
1293
1472
self.assertIsNone(e.exception.code)
1295
def test_is_enabled_run_exits_with_failure(self):
1474
def test_IsEnabled_exits_with_failure(self):
1296
1475
self.client.attributes["Enabled"] = dbus.Boolean(False)
1297
1476
with self.assertRaises(SystemExit) as e:
1298
IsEnabledCmd().run(self.one_client)
1477
command.IsEnabled().run(self.one_client)
1299
1478
if isinstance(e.exception.code, int):
1300
self.assertNotEqual(e.exception.code, 0)
1479
self.assertNotEqual(0, e.exception.code)
1302
1481
self.assertIsNotNone(e.exception.code)
1305
class TestApproveCmd(TestCmd):
1306
def test_approve(self):
1307
ApproveCmd().run(self.clients, self.bus)
1483
def test_Approve(self):
1484
command.Approve().run(self.clients, self.bus)
1308
1485
for clientpath in self.clients:
1309
1486
client = self.bus.get_object(dbus_busname, clientpath)
1310
1487
self.assertIn(("Approve", (True, client_dbus_interface)),
1314
class TestDenyCmd(TestCmd):
1315
def test_deny(self):
1316
DenyCmd().run(self.clients, self.bus)
1490
def test_Deny(self):
1491
command.Deny().run(self.clients, self.bus)
1317
1492
for clientpath in self.clients:
1318
1493
client = self.bus.get_object(dbus_busname, clientpath)
1319
1494
self.assertIn(("Approve", (False, client_dbus_interface)),
1323
class TestRemoveCmd(TestCmd):
1324
def test_remove(self):
1325
class MockMandos(object):
1497
def test_Remove(self):
1498
class MandosSpy(object):
1326
1499
def __init__(self):
1327
1500
self.calls = []
1328
1501
def RemoveClient(self, dbus_path):
1329
1502
self.calls.append(("RemoveClient", (dbus_path,)))
1330
mandos = MockMandos()
1331
super(TestRemoveCmd, self).setUp()
1332
RemoveCmd().run(self.clients, self.bus, mandos)
1333
self.assertEqual(len(mandos.calls), 2)
1503
mandos = MandosSpy()
1504
command.Remove().run(self.clients, self.bus, mandos)
1334
1505
for clientpath in self.clients:
1335
1506
self.assertIn(("RemoveClient", (clientpath,)),
1339
class TestDumpJSONCmd(TestCmd):
1341
self.expected_json = {
1344
"KeyID": ("92ed150794387c03ce684574b1139a65"
1345
"94a34f895daaaf09fd8ea90a27cddb12"),
1346
"Host": "foo.example.org",
1349
"LastCheckedOK": "2019-02-03T00:00:00",
1350
"Created": "2019-01-02T00:00:00",
1352
"Fingerprint": ("778827225BA7DE539C5A"
1353
"7CFA59CFF7CDBD9A5920"),
1354
"CheckerRunning": False,
1355
"LastEnabled": "2019-01-03T00:00:00",
1356
"ApprovalPending": False,
1357
"ApprovedByDefault": True,
1358
"LastApprovalRequest": "",
1360
"ApprovalDuration": 1000,
1361
"Checker": "fping -q -- %(host)s",
1362
"ExtendedTimeout": 900000,
1363
"Expires": "2019-02-04T00:00:00",
1364
"LastCheckerStatus": 0,
1368
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1369
"6ab612cff5ad227247e46c2b020f441c"),
1370
"Host": "192.0.2.3",
1373
"LastCheckedOK": "2019-02-04T00:00:00",
1374
"Created": "2019-01-03T00:00:00",
1376
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1377
"F547B3A107558FCA3A27"),
1378
"CheckerRunning": True,
1379
"LastEnabled": "2019-01-04T00:00:00",
1380
"ApprovalPending": False,
1381
"ApprovedByDefault": False,
1382
"LastApprovalRequest": "2019-01-03T00:00:00",
1383
"ApprovalDelay": 30000,
1384
"ApprovalDuration": 93785000,
1386
"ExtendedTimeout": 900000,
1387
"Expires": "2019-02-05T00:00:00",
1388
"LastCheckerStatus": -2,
1391
return super(TestDumpJSONCmd, self).setUp()
1393
def test_normal(self):
1394
output = DumpJSONCmd().output(self.clients.values())
1395
json_data = json.loads(output)
1396
self.assertDictEqual(json_data, self.expected_json)
1398
def test_one_client(self):
1399
output = DumpJSONCmd().output(self.one_client.values())
1400
json_data = json.loads(output)
1512
"KeyID": ("92ed150794387c03ce684574b1139a65"
1513
"94a34f895daaaf09fd8ea90a27cddb12"),
1514
"Host": "foo.example.org",
1517
"LastCheckedOK": "2019-02-03T00:00:00",
1518
"Created": "2019-01-02T00:00:00",
1520
"Fingerprint": ("778827225BA7DE539C5A"
1521
"7CFA59CFF7CDBD9A5920"),
1522
"CheckerRunning": False,
1523
"LastEnabled": "2019-01-03T00:00:00",
1524
"ApprovalPending": False,
1525
"ApprovedByDefault": True,
1526
"LastApprovalRequest": "",
1528
"ApprovalDuration": 1000,
1529
"Checker": "fping -q -- %(host)s",
1530
"ExtendedTimeout": 900000,
1531
"Expires": "2019-02-04T00:00:00",
1532
"LastCheckerStatus": 0,
1536
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1537
"6ab612cff5ad227247e46c2b020f441c"),
1538
"Host": "192.0.2.3",
1541
"LastCheckedOK": "2019-02-04T00:00:00",
1542
"Created": "2019-01-03T00:00:00",
1544
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1545
"F547B3A107558FCA3A27"),
1546
"CheckerRunning": True,
1547
"LastEnabled": "2019-01-04T00:00:00",
1548
"ApprovalPending": False,
1549
"ApprovedByDefault": False,
1550
"LastApprovalRequest": "2019-01-03T00:00:00",
1551
"ApprovalDelay": 30000,
1552
"ApprovalDuration": 93785000,
1554
"ExtendedTimeout": 900000,
1555
"Expires": "2019-02-05T00:00:00",
1556
"LastCheckerStatus": -2,
1560
def test_DumpJSON_normal(self):
1561
with self.capture_stdout_to_buffer() as buffer:
1562
command.DumpJSON().run(self.clients)
1563
json_data = json.loads(buffer.getvalue())
1564
self.assertDictEqual(self.expected_json, json_data)
1567
@contextlib.contextmanager
1568
def capture_stdout_to_buffer():
1569
capture_buffer = io.StringIO()
1570
old_stdout = sys.stdout
1571
sys.stdout = capture_buffer
1573
yield capture_buffer
1575
sys.stdout = old_stdout
1577
def test_DumpJSON_one_client(self):
1578
with self.capture_stdout_to_buffer() as buffer:
1579
command.DumpJSON().run(self.one_client)
1580
json_data = json.loads(buffer.getvalue())
1401
1581
expected_json = {"foo": self.expected_json["foo"]}
1402
self.assertDictEqual(json_data, expected_json)
1405
class TestPrintTableCmd(TestCmd):
1406
def test_normal(self):
1407
output = PrintTableCmd().output(self.clients.values())
1582
self.assertDictEqual(expected_json, json_data)
1584
def test_PrintTable_normal(self):
1585
with self.capture_stdout_to_buffer() as buffer:
1586
command.PrintTable().run(self.clients)
1408
1587
expected_output = "\n".join((
1409
1588
"Name Enabled Timeout Last Successful Check",
1410
1589
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1411
1590
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1413
self.assertEqual(output, expected_output)
1592
self.assertEqual(expected_output, buffer.getvalue())
1415
def test_verbose(self):
1416
output = PrintTableCmd(verbose=True).output(
1417
self.clients.values())
1594
def test_PrintTable_verbose(self):
1595
with self.capture_stdout_to_buffer() as buffer:
1596
command.PrintTable(verbose=True).run(self.clients)
1545
1725
self.command().run(clients, self.bus)
1548
class TestEnableCmd(TestPropertyCmd):
1728
class TestEnableCmd(TestPropertySetterCmd):
1729
command = command.Enable
1550
1730
propname = "Enabled"
1551
1731
values_to_set = [dbus.Boolean(True)]
1554
class TestDisableCmd(TestPropertyCmd):
1555
command = DisableCmd
1734
class TestDisableCmd(TestPropertySetterCmd):
1735
command = command.Disable
1556
1736
propname = "Enabled"
1557
1737
values_to_set = [dbus.Boolean(False)]
1560
class TestBumpTimeoutCmd(TestPropertyCmd):
1561
command = BumpTimeoutCmd
1740
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1741
command = command.BumpTimeout
1562
1742
propname = "LastCheckedOK"
1563
1743
values_to_set = [""]
1566
class TestStartCheckerCmd(TestPropertyCmd):
1567
command = StartCheckerCmd
1568
propname = "CheckerRunning"
1569
values_to_set = [dbus.Boolean(True)]
1572
class TestStopCheckerCmd(TestPropertyCmd):
1573
command = StopCheckerCmd
1574
propname = "CheckerRunning"
1575
values_to_set = [dbus.Boolean(False)]
1578
class TestApproveByDefaultCmd(TestPropertyCmd):
1579
command = ApproveByDefaultCmd
1580
propname = "ApprovedByDefault"
1581
values_to_set = [dbus.Boolean(True)]
1584
class TestDenyByDefaultCmd(TestPropertyCmd):
1585
command = DenyByDefaultCmd
1586
propname = "ApprovedByDefault"
1587
values_to_set = [dbus.Boolean(False)]
1590
class TestPropertyValueCmd(TestPropertyCmd):
1591
"""Abstract class for tests of PropertyValueCmd classes"""
1746
class TestStartCheckerCmd(TestPropertySetterCmd):
1747
command = command.StartChecker
1748
propname = "CheckerRunning"
1749
values_to_set = [dbus.Boolean(True)]
1752
class TestStopCheckerCmd(TestPropertySetterCmd):
1753
command = command.StopChecker
1754
propname = "CheckerRunning"
1755
values_to_set = [dbus.Boolean(False)]
1758
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1759
command = command.ApproveByDefault
1760
propname = "ApprovedByDefault"
1761
values_to_set = [dbus.Boolean(True)]
1764
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1765
command = command.DenyByDefault
1766
propname = "ApprovedByDefault"
1767
values_to_set = [dbus.Boolean(False)]
1770
class TestPropertySetterValueCmd(TestPropertySetterCmd):
1771
"""Abstract class for tests of PropertySetterValueCmd classes"""
1593
1773
def runTest(self):
1594
if type(self) is TestPropertyValueCmd:
1774
if type(self) is TestPropertySetterValueCmd:
1596
return super(TestPropertyValueCmd, self).runTest()
1776
return super(TestPropertySetterValueCmd, self).runTest()
1598
1778
def run_command(self, value, clients):
1599
1779
self.command(value).run(clients, self.bus)
1602
class TestSetCheckerCmd(TestPropertyValueCmd):
1603
command = SetCheckerCmd
1782
class TestSetCheckerCmd(TestPropertySetterValueCmd):
1783
command = command.SetChecker
1604
1784
propname = "Checker"
1605
1785
values_to_set = ["", ":", "fping -q -- %s"]
1608
class TestSetHostCmd(TestPropertyValueCmd):
1609
command = SetHostCmd
1788
class TestSetHostCmd(TestPropertySetterValueCmd):
1789
command = command.SetHost
1610
1790
propname = "Host"
1611
values_to_set = ["192.0.2.3", "foo.example.org"]
1614
class TestSetSecretCmd(TestPropertyValueCmd):
1615
command = SetSecretCmd
1791
values_to_set = ["192.0.2.3", "client.example.org"]
1794
class TestSetSecretCmd(TestPropertySetterValueCmd):
1795
command = command.SetSecret
1616
1796
propname = "Secret"
1617
1797
values_to_set = [io.BytesIO(b""),
1618
1798
io.BytesIO(b"secret\0xyzzy\nbar")]
1619
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1622
class TestSetTimeoutCmd(TestPropertyValueCmd):
1623
command = SetTimeoutCmd
1799
values_to_get = [f.getvalue() for f in values_to_set]
1802
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
1803
command = command.SetTimeout
1624
1804
propname = "Timeout"
1625
1805
values_to_set = [datetime.timedelta(),
1626
1806
datetime.timedelta(minutes=5),
1627
1807
datetime.timedelta(seconds=1),
1628
1808
datetime.timedelta(weeks=1),
1629
1809
datetime.timedelta(weeks=52)]
1630
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1633
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1634
command = SetExtendedTimeoutCmd
1810
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1813
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
1814
command = command.SetExtendedTimeout
1635
1815
propname = "ExtendedTimeout"
1636
1816
values_to_set = [datetime.timedelta(),
1637
1817
datetime.timedelta(minutes=5),
1638
1818
datetime.timedelta(seconds=1),
1639
1819
datetime.timedelta(weeks=1),
1640
1820
datetime.timedelta(weeks=52)]
1641
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1644
class TestSetIntervalCmd(TestPropertyValueCmd):
1645
command = SetIntervalCmd
1821
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1824
class TestSetIntervalCmd(TestPropertySetterValueCmd):
1825
command = command.SetInterval
1646
1826
propname = "Interval"
1647
1827
values_to_set = [datetime.timedelta(),
1648
1828
datetime.timedelta(minutes=5),
1649
1829
datetime.timedelta(seconds=1),
1650
1830
datetime.timedelta(weeks=1),
1651
1831
datetime.timedelta(weeks=52)]
1652
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1655
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1656
command = SetApprovalDelayCmd
1832
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1835
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
1836
command = command.SetApprovalDelay
1657
1837
propname = "ApprovalDelay"
1658
1838
values_to_set = [datetime.timedelta(),
1659
1839
datetime.timedelta(minutes=5),
1660
1840
datetime.timedelta(seconds=1),
1661
1841
datetime.timedelta(weeks=1),
1662
1842
datetime.timedelta(weeks=52)]
1663
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1666
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1667
command = SetApprovalDurationCmd
1843
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1846
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
1847
command = command.SetApprovalDuration
1668
1848
propname = "ApprovalDuration"
1669
1849
values_to_set = [datetime.timedelta(),
1670
1850
datetime.timedelta(minutes=5),
1671
1851
datetime.timedelta(seconds=1),
1672
1852
datetime.timedelta(weeks=1),
1673
1853
datetime.timedelta(weeks=52)]
1674
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1854
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]