223
403
value += datetime.timedelta(0, 0, 0, int(num))
226
def print_clients(clients, keywords):
227
def valuetostring(value, keyword):
228
if type(value) is dbus.Boolean:
229
return "Yes" if value else "No"
230
if keyword in ("Timeout", "Interval", "ApprovalDelay",
231
"ApprovalDuration", "ExtendedTimeout"):
232
return milliseconds_to_string(value)
233
return unicode(value)
235
# Create format string to print table rows
236
format_string = " ".join("{{{key}:{width}}}".format(
237
width = max(len(tablewords[key]),
238
max(len(valuetostring(client[key],
242
key = key) for key in keywords)
244
print(format_string.format(**tablewords))
245
for client in clients:
246
print(format_string.format(**dict((key,
247
valuetostring(client[key],
249
for key in keywords)))
251
def has_actions(options):
252
return any((options.enable,
254
options.bump_timeout,
255
options.start_checker,
256
options.stop_checker,
259
options.checker is not None,
260
options.timeout is not None,
261
options.extended_timeout is not None,
262
options.interval is not None,
263
options.approved_by_default is not None,
264
options.approval_delay is not None,
265
options.approval_duration is not None,
266
options.host is not None,
267
options.secret is not None,
272
parser = argparse.ArgumentParser()
273
parser.add_argument("--version", action="version",
274
version = "%(prog)s {0}".format(version),
275
help="show version number and exit")
276
parser.add_argument("-a", "--all", action="store_true",
277
help="Select all clients")
278
parser.add_argument("-v", "--verbose", action="store_true",
279
help="Print all fields")
280
parser.add_argument("-e", "--enable", action="store_true",
281
help="Enable client")
282
parser.add_argument("-d", "--disable", action="store_true",
283
help="disable client")
284
parser.add_argument("-b", "--bump-timeout", action="store_true",
285
help="Bump timeout for client")
286
parser.add_argument("--start-checker", action="store_true",
287
help="Start checker for client")
288
parser.add_argument("--stop-checker", action="store_true",
289
help="Stop checker for client")
290
parser.add_argument("-V", "--is-enabled", action="store_true",
291
help="Check if client is enabled")
292
parser.add_argument("-r", "--remove", action="store_true",
293
help="Remove client")
294
parser.add_argument("-c", "--checker",
295
help="Set checker command for client")
296
parser.add_argument("-t", "--timeout",
297
help="Set timeout for client")
298
parser.add_argument("--extended-timeout",
299
help="Set extended timeout for client")
300
parser.add_argument("-i", "--interval",
301
help="Set checker interval for client")
302
parser.add_argument("--approve-by-default", action="store_true",
303
default=None, dest="approved_by_default",
304
help="Set client to be approved by default")
305
parser.add_argument("--deny-by-default", action="store_false",
306
dest="approved_by_default",
307
help="Set client to be denied by default")
308
parser.add_argument("--approval-delay",
309
help="Set delay before client approve/deny")
310
parser.add_argument("--approval-duration",
311
help="Set duration of one client approval")
312
parser.add_argument("-H", "--host", help="Set host for client")
313
parser.add_argument("-s", "--secret", type=file,
314
help="Set password blob (file) for client")
315
parser.add_argument("-A", "--approve", action="store_true",
316
help="Approve any current client request")
317
parser.add_argument("-D", "--deny", action="store_true",
318
help="Deny any current client request")
319
parser.add_argument("--check", action="store_true",
320
help="Run self-test")
321
parser.add_argument("client", nargs="*", help="Client name")
322
options = parser.parse_args()
407
def check_option_syntax(parser, options):
408
"""Apply additional restrictions on options, not expressible in
411
def has_actions(options):
412
return any((options.enable,
414
options.bump_timeout,
415
options.start_checker,
416
options.stop_checker,
419
options.checker is not None,
420
options.timeout is not None,
421
options.extended_timeout is not None,
422
options.interval is not None,
423
options.approved_by_default is not None,
424
options.approval_delay is not None,
425
options.approval_duration is not None,
426
options.host is not None,
427
options.secret is not None,
324
431
if has_actions(options) and not (options.client or options.all):
325
432
parser.error("Options require clients names or --all.")
326
433
if options.verbose and has_actions(options):
327
parser.error("--verbose can only be used alone or with"
434
parser.error("--verbose can only be used alone.")
435
if options.dump_json and (options.verbose
436
or has_actions(options)):
437
parser.error("--dump-json can only be used alone.")
329
438
if options.all and not has_actions(options):
330
439
parser.error("--all requires an action.")
333
fail_count, test_count = doctest.testmod()
334
sys.exit(0 if fail_count == 0 else 1)
337
bus = dbus.SystemBus()
338
mandos_dbus_objc = bus.get_object(busname, server_path)
339
except dbus.exceptions.DBusException:
340
print("Could not connect to Mandos server",
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):
344
mandos_serv = dbus.Interface(mandos_dbus_objc,
345
dbus_interface = server_interface)
347
#block stderr since dbus library prints to stderr
348
null = os.open(os.path.devnull, os.O_RDWR)
349
stderrcopy = os.dup(sys.stderr.fileno())
350
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")
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):
640
self.clients = clients
641
self.keywords = keywords
644
return "\n".join(self.rows())
646
if sys.version_info.major == 2:
647
__unicode__ = __str__
649
return str(self).encode(locale.getpreferredencoding())
652
format_string = self.row_formatting_string()
653
rows = [self.header_line(format_string)]
654
rows.extend(self.client_line(client, format_string)
655
for client in self.clients)
658
def row_formatting_string(self):
659
"Format string used to format table rows"
660
return " ".join("{{{key}:{width}}}".format(
661
width=max(len(self.tableheaders[key]),
662
*(len(self.string_from_client(client, key))
663
for client in self.clients)),
665
for key in self.keywords)
667
def string_from_client(self, client, key):
668
return self.valuetostring(client[key], key)
671
def valuetostring(cls, value, keyword):
672
if isinstance(value, dbus.Boolean):
673
return "Yes" if value else "No"
674
if keyword in ("Timeout", "Interval", "ApprovalDelay",
675
"ApprovalDuration", "ExtendedTimeout"):
676
return cls.milliseconds_to_string(value)
679
def header_line(self, format_string):
680
return format_string.format(**self.tableheaders)
682
def client_line(self, client, format_string):
683
return format_string.format(
684
**{key: self.string_from_client(client, key)
685
for key in self.keywords})
688
def milliseconds_to_string(ms):
689
td = datetime.timedelta(0, 0, 0, ms)
690
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
691
.format(days="{}T".format(td.days)
693
hours=td.seconds // 3600,
694
minutes=(td.seconds % 3600) // 60,
695
seconds=td.seconds % 60))
698
class PropertyCmd(Command):
699
"""Abstract class for Actions for setting one client property"""
701
def run_on_one_client(self, client, properties):
702
"""Set the Client's D-Bus property"""
703
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
704
client.__dbus_object_path__,
705
dbus.PROPERTIES_IFACE, client_dbus_interface,
706
self.propname, self.value_to_set
707
if not isinstance(self.value_to_set, dbus.Boolean)
708
else bool(self.value_to_set))
709
client.Set(client_dbus_interface, self.propname,
711
dbus_interface=dbus.PROPERTIES_IFACE)
715
raise NotImplementedError()
718
class EnableCmd(PropertyCmd):
720
value_to_set = dbus.Boolean(True)
723
class DisableCmd(PropertyCmd):
725
value_to_set = dbus.Boolean(False)
728
class BumpTimeoutCmd(PropertyCmd):
729
propname = "LastCheckedOK"
733
class StartCheckerCmd(PropertyCmd):
734
propname = "CheckerRunning"
735
value_to_set = dbus.Boolean(True)
738
class StopCheckerCmd(PropertyCmd):
739
propname = "CheckerRunning"
740
value_to_set = dbus.Boolean(False)
743
class ApproveByDefaultCmd(PropertyCmd):
744
propname = "ApprovedByDefault"
745
value_to_set = dbus.Boolean(True)
748
class DenyByDefaultCmd(PropertyCmd):
749
propname = "ApprovedByDefault"
750
value_to_set = dbus.Boolean(False)
753
class PropertyValueCmd(PropertyCmd):
754
"""Abstract class for PropertyCmd recieving a value as argument"""
755
def __init__(self, value):
756
self.value_to_set = value
759
class SetCheckerCmd(PropertyValueCmd):
763
class SetHostCmd(PropertyValueCmd):
767
class SetSecretCmd(PropertyValueCmd):
771
def value_to_set(self):
775
def value_to_set(self, value):
776
"""When setting, read data from supplied file object"""
777
self._vts = value.read()
781
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
782
"""Abstract class for PropertyValueCmd taking a value argument as
783
a datetime.timedelta() but should store it as milliseconds."""
786
def value_to_set(self):
790
def value_to_set(self, value):
791
"""When setting, convert value from a datetime.timedelta"""
792
self._vts = int(round(value.total_seconds() * 1000))
795
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
799
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
800
propname = "ExtendedTimeout"
803
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
804
propname = "Interval"
807
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
808
propname = "ApprovalDelay"
811
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
812
propname = "ApprovalDuration"
816
class Test_string_to_delta(unittest.TestCase):
817
def test_handles_basic_rfc3339(self):
818
self.assertEqual(string_to_delta("PT0S"),
819
datetime.timedelta())
820
self.assertEqual(string_to_delta("P0D"),
821
datetime.timedelta())
822
self.assertEqual(string_to_delta("PT1S"),
823
datetime.timedelta(0, 1))
824
self.assertEqual(string_to_delta("PT2H"),
825
datetime.timedelta(0, 7200))
827
def test_falls_back_to_pre_1_6_1_with_warning(self):
828
# assertLogs only exists in Python 3.4
829
if hasattr(self, "assertLogs"):
830
with self.assertLogs(log, logging.WARNING):
831
value = string_to_delta("2h")
833
class WarningFilter(logging.Filter):
834
"""Don't show, but record the presence of, warnings"""
835
def filter(self, record):
836
is_warning = record.levelno >= logging.WARNING
837
self.found = is_warning or getattr(self, "found",
839
return not is_warning
840
warning_filter = WarningFilter()
841
log.addFilter(warning_filter)
843
value = string_to_delta("2h")
845
log.removeFilter(warning_filter)
846
self.assertTrue(getattr(warning_filter, "found", False))
847
self.assertEqual(value, datetime.timedelta(0, 7200))
850
class Test_check_option_syntax(unittest.TestCase):
852
self.parser = argparse.ArgumentParser()
853
add_command_line_options(self.parser)
855
def test_actions_requires_client_or_all(self):
856
for action, value in self.actions.items():
857
options = self.parser.parse_args()
858
setattr(options, action, value)
859
with self.assertParseError():
860
self.check_option_syntax(options)
862
# This mostly corresponds to the definition from has_actions() in
863
# check_option_syntax()
865
# The actual values set here are not that important, but we do
866
# at least stick to the correct types, even though they are
870
"bump_timeout": True,
871
"start_checker": True,
872
"stop_checker": True,
876
"timeout": datetime.timedelta(),
877
"extended_timeout": datetime.timedelta(),
878
"interval": datetime.timedelta(),
879
"approved_by_default": True,
880
"approval_delay": datetime.timedelta(),
881
"approval_duration": datetime.timedelta(),
883
"secret": io.BytesIO(b"x"),
888
@contextlib.contextmanager
889
def assertParseError(self):
890
with self.assertRaises(SystemExit) as e:
891
with self.temporarily_suppress_stderr():
893
# Exit code from argparse is guaranteed to be "2". Reference:
894
# https://docs.python.org/3/library
895
# /argparse.html#exiting-methods
896
self.assertEqual(e.exception.code, 2)
899
@contextlib.contextmanager
900
def temporarily_suppress_stderr():
901
null = os.open(os.path.devnull, os.O_RDWR)
902
stderrcopy = os.dup(sys.stderr.fileno())
903
os.dup2(null, sys.stderr.fileno())
354
mandos_clients = mandos_serv.GetAllClientsWithProperties()
357
909
os.dup2(stderrcopy, sys.stderr.fileno())
358
910
os.close(stderrcopy)
359
except dbus.exceptions.DBusException:
360
print("Access denied: Accessing mandos server through dbus.",
364
# Compile dict of (clients: properties) to process
367
if options.all or not options.client:
368
clients = dict((bus.get_object(busname, path), properties)
369
for path, properties in
370
mandos_clients.iteritems())
372
for name in options.client:
373
for path, client in mandos_clients.iteritems():
374
if client["Name"] == name:
375
client_objc = bus.get_object(busname, path)
376
clients[client_objc] = client
379
print("Client not found on server: {0!r}"
380
.format(name), file=sys.stderr)
383
if not has_actions(options) and clients:
385
keywords = ("Name", "Enabled", "Timeout",
386
"LastCheckedOK", "Created", "Interval",
387
"Host", "Fingerprint", "CheckerRunning",
388
"LastEnabled", "ApprovalPending",
390
"LastApprovalRequest", "ApprovalDelay",
391
"ApprovalDuration", "Checker",
394
keywords = defaultkeywords
396
print_clients(clients.values(), keywords)
398
# Process each client in the list by all selected options
399
for client in clients:
400
def set_client_prop(prop, value):
401
"""Set a Client D-Bus property"""
402
client.Set(client_interface, prop, value,
403
dbus_interface=dbus.PROPERTIES_IFACE)
404
def set_client_prop_ms(prop, value):
405
"""Set a Client D-Bus property, converted
406
from a string to milliseconds."""
407
set_client_prop(prop,
408
timedelta_to_milliseconds
409
(string_to_delta(value)))
411
mandos_serv.RemoveClient(client.__dbus_object_path__)
413
set_client_prop("Enabled", dbus.Boolean(True))
415
set_client_prop("Enabled", dbus.Boolean(False))
416
if options.bump_timeout:
417
set_client_prop("LastCheckedOK", "")
418
if options.start_checker:
419
set_client_prop("CheckerRunning", dbus.Boolean(True))
420
if options.stop_checker:
421
set_client_prop("CheckerRunning", dbus.Boolean(False))
422
if options.is_enabled:
423
sys.exit(0 if client.Get(client_interface,
426
dbus.PROPERTIES_IFACE)
428
if options.checker is not None:
429
set_client_prop("Checker", options.checker)
430
if options.host is not None:
431
set_client_prop("Host", options.host)
432
if options.interval is not None:
433
set_client_prop_ms("Interval", options.interval)
434
if options.approval_delay is not None:
435
set_client_prop_ms("ApprovalDelay",
436
options.approval_delay)
437
if options.approval_duration is not None:
438
set_client_prop_ms("ApprovalDuration",
439
options.approval_duration)
440
if options.timeout is not None:
441
set_client_prop_ms("Timeout", options.timeout)
442
if options.extended_timeout is not None:
443
set_client_prop_ms("ExtendedTimeout",
444
options.extended_timeout)
445
if options.secret is not None:
446
set_client_prop("Secret",
447
dbus.ByteArray(options.secret.read()))
448
if options.approved_by_default is not None:
449
set_client_prop("ApprovedByDefault",
451
.approved_by_default))
453
client.Approve(dbus.Boolean(True),
454
dbus_interface=client_interface)
456
client.Approve(dbus.Boolean(False),
457
dbus_interface=client_interface)
912
def check_option_syntax(self, options):
913
check_option_syntax(self.parser, options)
915
def test_actions_conflicts_with_verbose(self):
916
for action, value in self.actions.items():
917
options = self.parser.parse_args()
918
setattr(options, action, value)
919
options.verbose = True
920
with self.assertParseError():
921
self.check_option_syntax(options)
923
def test_dump_json_conflicts_with_verbose(self):
924
options = self.parser.parse_args()
925
options.dump_json = True
926
options.verbose = True
927
with self.assertParseError():
928
self.check_option_syntax(options)
930
def test_dump_json_conflicts_with_action(self):
931
for action, value in self.actions.items():
932
options = self.parser.parse_args()
933
setattr(options, action, value)
934
options.dump_json = True
935
with self.assertParseError():
936
self.check_option_syntax(options)
938
def test_all_can_not_be_alone(self):
939
options = self.parser.parse_args()
941
with self.assertParseError():
942
self.check_option_syntax(options)
944
def test_all_is_ok_with_any_action(self):
945
for action, value in self.actions.items():
946
options = self.parser.parse_args()
947
setattr(options, action, value)
949
self.check_option_syntax(options)
951
def test_is_enabled_fails_without_client(self):
952
options = self.parser.parse_args()
953
options.is_enabled = True
954
with self.assertParseError():
955
self.check_option_syntax(options)
957
def test_is_enabled_works_with_one_client(self):
958
options = self.parser.parse_args()
959
options.is_enabled = True
960
options.client = ["foo"]
961
self.check_option_syntax(options)
963
def test_is_enabled_fails_with_two_clients(self):
964
options = self.parser.parse_args()
965
options.is_enabled = True
966
options.client = ["foo", "barbar"]
967
with self.assertParseError():
968
self.check_option_syntax(options)
970
def test_remove_can_only_be_combined_with_action_deny(self):
971
for action, value in self.actions.items():
972
if action in {"remove", "deny"}:
974
options = self.parser.parse_args()
975
setattr(options, action, value)
977
options.remove = True
978
with self.assertParseError():
979
self.check_option_syntax(options)
982
class Test_commands_from_options(unittest.TestCase):
984
self.parser = argparse.ArgumentParser()
985
add_command_line_options(self.parser)
987
def test_is_enabled(self):
988
self.assert_command_from_args(["--is-enabled", "foo"],
991
def assert_command_from_args(self, args, command_cls,
993
"""Assert that parsing ARGS should result in an instance of
994
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
995
options = self.parser.parse_args(args)
996
check_option_syntax(self.parser, options)
997
commands = commands_from_options(options)
998
self.assertEqual(len(commands), 1)
999
command = commands[0]
1000
self.assertIsInstance(command, command_cls)
1001
for key, value in cmd_attrs.items():
1002
self.assertEqual(getattr(command, key), value)
1004
def test_is_enabled_short(self):
1005
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1007
def test_approve(self):
1008
self.assert_command_from_args(["--approve", "foo"],
1011
def test_approve_short(self):
1012
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1014
def test_deny(self):
1015
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1017
def test_deny_short(self):
1018
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1020
def test_remove(self):
1021
self.assert_command_from_args(["--remove", "foo"],
1024
def test_deny_before_remove(self):
1025
options = self.parser.parse_args(["--deny", "--remove",
1027
check_option_syntax(self.parser, options)
1028
commands = commands_from_options(options)
1029
self.assertEqual(len(commands), 2)
1030
self.assertIsInstance(commands[0], DenyCmd)
1031
self.assertIsInstance(commands[1], RemoveCmd)
1033
def test_deny_before_remove_reversed(self):
1034
options = self.parser.parse_args(["--remove", "--deny",
1036
check_option_syntax(self.parser, options)
1037
commands = commands_from_options(options)
1038
self.assertEqual(len(commands), 2)
1039
self.assertIsInstance(commands[0], DenyCmd)
1040
self.assertIsInstance(commands[1], RemoveCmd)
1042
def test_remove_short(self):
1043
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1045
def test_dump_json(self):
1046
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1048
def test_enable(self):
1049
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1051
def test_enable_short(self):
1052
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1054
def test_disable(self):
1055
self.assert_command_from_args(["--disable", "foo"],
1058
def test_disable_short(self):
1059
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1061
def test_bump_timeout(self):
1062
self.assert_command_from_args(["--bump-timeout", "foo"],
1065
def test_bump_timeout_short(self):
1066
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1068
def test_start_checker(self):
1069
self.assert_command_from_args(["--start-checker", "foo"],
1072
def test_stop_checker(self):
1073
self.assert_command_from_args(["--stop-checker", "foo"],
1076
def test_approve_by_default(self):
1077
self.assert_command_from_args(["--approve-by-default", "foo"],
1078
ApproveByDefaultCmd)
1080
def test_deny_by_default(self):
1081
self.assert_command_from_args(["--deny-by-default", "foo"],
1084
def test_checker(self):
1085
self.assert_command_from_args(["--checker", ":", "foo"],
1086
SetCheckerCmd, value_to_set=":")
1088
def test_checker_empty(self):
1089
self.assert_command_from_args(["--checker", "", "foo"],
1090
SetCheckerCmd, value_to_set="")
1092
def test_checker_short(self):
1093
self.assert_command_from_args(["-c", ":", "foo"],
1094
SetCheckerCmd, value_to_set=":")
1096
def test_host(self):
1097
self.assert_command_from_args(["--host", "foo.example.org",
1099
value_to_set="foo.example.org")
1101
def test_host_short(self):
1102
self.assert_command_from_args(["-H", "foo.example.org",
1104
value_to_set="foo.example.org")
1106
def test_secret_devnull(self):
1107
self.assert_command_from_args(["--secret", os.path.devnull,
1108
"foo"], SetSecretCmd,
1111
def test_secret_tempfile(self):
1112
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1113
value = b"secret\0xyzzy\nbar"
1116
self.assert_command_from_args(["--secret", f.name,
1117
"foo"], SetSecretCmd,
1120
def test_secret_devnull_short(self):
1121
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1122
SetSecretCmd, value_to_set=b"")
1124
def test_secret_tempfile_short(self):
1125
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1126
value = b"secret\0xyzzy\nbar"
1129
self.assert_command_from_args(["-s", f.name, "foo"],
1133
def test_timeout(self):
1134
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1136
value_to_set=300000)
1138
def test_timeout_short(self):
1139
self.assert_command_from_args(["-t", "PT5M", "foo"],
1141
value_to_set=300000)
1143
def test_extended_timeout(self):
1144
self.assert_command_from_args(["--extended-timeout", "PT15M",
1146
SetExtendedTimeoutCmd,
1147
value_to_set=900000)
1149
def test_interval(self):
1150
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1152
value_to_set=120000)
1154
def test_interval_short(self):
1155
self.assert_command_from_args(["-i", "PT2M", "foo"],
1157
value_to_set=120000)
1159
def test_approval_delay(self):
1160
self.assert_command_from_args(["--approval-delay", "PT30S",
1161
"foo"], SetApprovalDelayCmd,
1164
def test_approval_duration(self):
1165
self.assert_command_from_args(["--approval-duration", "PT1S",
1166
"foo"], SetApprovalDurationCmd,
1169
def test_print_table(self):
1170
self.assert_command_from_args([], PrintTableCmd,
1173
def test_print_table_verbose(self):
1174
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1177
def test_print_table_verbose_short(self):
1178
self.assert_command_from_args(["-v"], PrintTableCmd,
1182
class TestCmd(unittest.TestCase):
1183
"""Abstract class for tests of command classes"""
1187
class MockClient(object):
1188
def __init__(self, name, **attributes):
1189
self.__dbus_object_path__ = "/clients/{}".format(name)
1190
self.attributes = attributes
1191
self.attributes["Name"] = name
1193
def Set(self, interface, propname, value, dbus_interface):
1194
testcase.assertEqual(interface, client_dbus_interface)
1195
testcase.assertEqual(dbus_interface,
1196
dbus.PROPERTIES_IFACE)
1197
self.attributes[propname] = value
1198
def Get(self, interface, propname, dbus_interface):
1199
testcase.assertEqual(interface, client_dbus_interface)
1200
testcase.assertEqual(dbus_interface,
1201
dbus.PROPERTIES_IFACE)
1202
return self.attributes[propname]
1203
def Approve(self, approve, dbus_interface):
1204
testcase.assertEqual(dbus_interface,
1205
client_dbus_interface)
1206
self.calls.append(("Approve", (approve,
1208
self.client = MockClient(
1210
KeyID=("92ed150794387c03ce684574b1139a65"
1211
"94a34f895daaaf09fd8ea90a27cddb12"),
1213
Host="foo.example.org",
1214
Enabled=dbus.Boolean(True),
1216
LastCheckedOK="2019-02-03T00:00:00",
1217
Created="2019-01-02T00:00:00",
1219
Fingerprint=("778827225BA7DE539C5A"
1220
"7CFA59CFF7CDBD9A5920"),
1221
CheckerRunning=dbus.Boolean(False),
1222
LastEnabled="2019-01-03T00:00:00",
1223
ApprovalPending=dbus.Boolean(False),
1224
ApprovedByDefault=dbus.Boolean(True),
1225
LastApprovalRequest="",
1227
ApprovalDuration=1000,
1228
Checker="fping -q -- %(host)s",
1229
ExtendedTimeout=900000,
1230
Expires="2019-02-04T00:00:00",
1231
LastCheckerStatus=0)
1232
self.other_client = MockClient(
1234
KeyID=("0558568eedd67d622f5c83b35a115f79"
1235
"6ab612cff5ad227247e46c2b020f441c"),
1236
Secret=b"secretbar",
1238
Enabled=dbus.Boolean(True),
1240
LastCheckedOK="2019-02-04T00:00:00",
1241
Created="2019-01-03T00:00:00",
1243
Fingerprint=("3E393AEAEFB84C7E89E2"
1244
"F547B3A107558FCA3A27"),
1245
CheckerRunning=dbus.Boolean(True),
1246
LastEnabled="2019-01-04T00:00:00",
1247
ApprovalPending=dbus.Boolean(False),
1248
ApprovedByDefault=dbus.Boolean(False),
1249
LastApprovalRequest="2019-01-03T00:00:00",
1250
ApprovalDelay=30000,
1251
ApprovalDuration=93785000,
1253
ExtendedTimeout=900000,
1254
Expires="2019-02-05T00:00:00",
1255
LastCheckerStatus=-2)
1256
self.clients = collections.OrderedDict(
1258
("/clients/foo", self.client.attributes),
1259
("/clients/barbar", self.other_client.attributes),
1261
self.one_client = {"/clients/foo": self.client.attributes}
1267
def get_object(client_bus_name, path):
1268
self.assertEqual(client_bus_name, dbus_busname)
1270
# Note: "self" here is the TestCmd instance, not
1271
# the Bus instance, since this is a static method!
1272
"/clients/foo": self.client,
1273
"/clients/barbar": self.other_client,
1278
class TestIsEnabledCmd(TestCmd):
1279
def test_is_enabled(self):
1280
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1282
for client, properties
1283
in self.clients.items()))
1285
def test_is_enabled_run_exits_successfully(self):
1286
with self.assertRaises(SystemExit) as e:
1287
IsEnabledCmd().run(self.one_client)
1288
if e.exception.code is not None:
1289
self.assertEqual(e.exception.code, 0)
1291
self.assertIsNone(e.exception.code)
1293
def test_is_enabled_run_exits_with_failure(self):
1294
self.client.attributes["Enabled"] = dbus.Boolean(False)
1295
with self.assertRaises(SystemExit) as e:
1296
IsEnabledCmd().run(self.one_client)
1297
if isinstance(e.exception.code, int):
1298
self.assertNotEqual(e.exception.code, 0)
1300
self.assertIsNotNone(e.exception.code)
1303
class TestApproveCmd(TestCmd):
1304
def test_approve(self):
1305
ApproveCmd().run(self.clients, self.bus)
1306
for clientpath in self.clients:
1307
client = self.bus.get_object(dbus_busname, clientpath)
1308
self.assertIn(("Approve", (True, client_dbus_interface)),
1312
class TestDenyCmd(TestCmd):
1313
def test_deny(self):
1314
DenyCmd().run(self.clients, self.bus)
1315
for clientpath in self.clients:
1316
client = self.bus.get_object(dbus_busname, clientpath)
1317
self.assertIn(("Approve", (False, client_dbus_interface)),
1321
class TestRemoveCmd(TestCmd):
1322
def test_remove(self):
1323
class MockMandos(object):
1326
def RemoveClient(self, dbus_path):
1327
self.calls.append(("RemoveClient", (dbus_path,)))
1328
mandos = MockMandos()
1329
super(TestRemoveCmd, self).setUp()
1330
RemoveCmd().run(self.clients, self.bus, mandos)
1331
self.assertEqual(len(mandos.calls), 2)
1332
for clientpath in self.clients:
1333
self.assertIn(("RemoveClient", (clientpath,)),
1337
class TestDumpJSONCmd(TestCmd):
1339
self.expected_json = {
1342
"KeyID": ("92ed150794387c03ce684574b1139a65"
1343
"94a34f895daaaf09fd8ea90a27cddb12"),
1344
"Host": "foo.example.org",
1347
"LastCheckedOK": "2019-02-03T00:00:00",
1348
"Created": "2019-01-02T00:00:00",
1350
"Fingerprint": ("778827225BA7DE539C5A"
1351
"7CFA59CFF7CDBD9A5920"),
1352
"CheckerRunning": False,
1353
"LastEnabled": "2019-01-03T00:00:00",
1354
"ApprovalPending": False,
1355
"ApprovedByDefault": True,
1356
"LastApprovalRequest": "",
1358
"ApprovalDuration": 1000,
1359
"Checker": "fping -q -- %(host)s",
1360
"ExtendedTimeout": 900000,
1361
"Expires": "2019-02-04T00:00:00",
1362
"LastCheckerStatus": 0,
1366
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1367
"6ab612cff5ad227247e46c2b020f441c"),
1368
"Host": "192.0.2.3",
1371
"LastCheckedOK": "2019-02-04T00:00:00",
1372
"Created": "2019-01-03T00:00:00",
1374
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1375
"F547B3A107558FCA3A27"),
1376
"CheckerRunning": True,
1377
"LastEnabled": "2019-01-04T00:00:00",
1378
"ApprovalPending": False,
1379
"ApprovedByDefault": False,
1380
"LastApprovalRequest": "2019-01-03T00:00:00",
1381
"ApprovalDelay": 30000,
1382
"ApprovalDuration": 93785000,
1384
"ExtendedTimeout": 900000,
1385
"Expires": "2019-02-05T00:00:00",
1386
"LastCheckerStatus": -2,
1389
return super(TestDumpJSONCmd, self).setUp()
1391
def test_normal(self):
1392
output = DumpJSONCmd().output(self.clients.values())
1393
json_data = json.loads(output)
1394
self.assertDictEqual(json_data, self.expected_json)
1396
def test_one_client(self):
1397
output = DumpJSONCmd().output(self.one_client.values())
1398
json_data = json.loads(output)
1399
expected_json = {"foo": self.expected_json["foo"]}
1400
self.assertDictEqual(json_data, expected_json)
1403
class TestPrintTableCmd(TestCmd):
1404
def test_normal(self):
1405
output = PrintTableCmd().output(self.clients.values())
1406
expected_output = "\n".join((
1407
"Name Enabled Timeout Last Successful Check",
1408
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1409
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1411
self.assertEqual(output, expected_output)
1413
def test_verbose(self):
1414
output = PrintTableCmd(verbose=True).output(
1415
self.clients.values())
1430
"Last Successful Check ",
1431
"2019-02-03T00:00:00 ",
1432
"2019-02-04T00:00:00 ",
1435
"2019-01-02T00:00:00 ",
1436
"2019-01-03T00:00:00 ",
1448
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1450
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1454
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1455
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1457
"Check Is Running ",
1462
"2019-01-03T00:00:00 ",
1463
"2019-01-04T00:00:00 ",
1465
"Approval Is Pending ",
1469
"Approved By Default ",
1473
"Last Approval Request ",
1475
"2019-01-03T00:00:00 ",
1481
"Approval Duration ",
1486
"fping -q -- %(host)s ",
1489
"Extended Timeout ",
1494
"2019-02-04T00:00:00 ",
1495
"2019-02-05T00:00:00 ",
1497
"Last Checker Status",
1502
num_lines = max(len(rows) for rows in columns)
1503
expected_output = "\n".join("".join(rows[line]
1504
for rows in columns)
1505
for line in range(num_lines))
1506
self.assertEqual(output, expected_output)
1508
def test_one_client(self):
1509
output = PrintTableCmd().output(self.one_client.values())
1510
expected_output = "\n".join((
1511
"Name Enabled Timeout Last Successful Check",
1512
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1514
self.assertEqual(output, expected_output)
1517
class TestPropertyCmd(TestCmd):
1518
"""Abstract class for tests of PropertyCmd classes"""
1520
if not hasattr(self, "command"):
1522
values_to_get = getattr(self, "values_to_get",
1524
for value_to_set, value_to_get in zip(self.values_to_set,
1526
for clientpath in self.clients:
1527
client = self.bus.get_object(dbus_busname, clientpath)
1528
old_value = client.attributes[self.propname]
1529
self.assertNotIsInstance(old_value, self.Unique)
1530
client.attributes[self.propname] = self.Unique()
1531
self.run_command(value_to_set, self.clients)
1532
for clientpath in self.clients:
1533
client = self.bus.get_object(dbus_busname, clientpath)
1534
value = client.attributes[self.propname]
1535
self.assertNotIsInstance(value, self.Unique)
1536
self.assertEqual(value, value_to_get)
1538
class Unique(object):
1539
"""Class for objects which exist only to be unique objects,
1540
since unittest.mock.sentinel only exists in Python 3.3"""
1542
def run_command(self, value, clients):
1543
self.command().run(clients, self.bus)
1546
class TestEnableCmd(TestPropertyCmd):
1548
propname = "Enabled"
1549
values_to_set = [dbus.Boolean(True)]
1552
class TestDisableCmd(TestPropertyCmd):
1553
command = DisableCmd
1554
propname = "Enabled"
1555
values_to_set = [dbus.Boolean(False)]
1558
class TestBumpTimeoutCmd(TestPropertyCmd):
1559
command = BumpTimeoutCmd
1560
propname = "LastCheckedOK"
1561
values_to_set = [""]
1564
class TestStartCheckerCmd(TestPropertyCmd):
1565
command = StartCheckerCmd
1566
propname = "CheckerRunning"
1567
values_to_set = [dbus.Boolean(True)]
1570
class TestStopCheckerCmd(TestPropertyCmd):
1571
command = StopCheckerCmd
1572
propname = "CheckerRunning"
1573
values_to_set = [dbus.Boolean(False)]
1576
class TestApproveByDefaultCmd(TestPropertyCmd):
1577
command = ApproveByDefaultCmd
1578
propname = "ApprovedByDefault"
1579
values_to_set = [dbus.Boolean(True)]
1582
class TestDenyByDefaultCmd(TestPropertyCmd):
1583
command = DenyByDefaultCmd
1584
propname = "ApprovedByDefault"
1585
values_to_set = [dbus.Boolean(False)]
1588
class TestPropertyValueCmd(TestPropertyCmd):
1589
"""Abstract class for tests of PropertyValueCmd classes"""
1592
if type(self) is TestPropertyValueCmd:
1594
return super(TestPropertyValueCmd, self).runTest()
1596
def run_command(self, value, clients):
1597
self.command(value).run(clients, self.bus)
1600
class TestSetCheckerCmd(TestPropertyValueCmd):
1601
command = SetCheckerCmd
1602
propname = "Checker"
1603
values_to_set = ["", ":", "fping -q -- %s"]
1606
class TestSetHostCmd(TestPropertyValueCmd):
1607
command = SetHostCmd
1609
values_to_set = ["192.0.2.3", "foo.example.org"]
1612
class TestSetSecretCmd(TestPropertyValueCmd):
1613
command = SetSecretCmd
1615
values_to_set = [io.BytesIO(b""),
1616
io.BytesIO(b"secret\0xyzzy\nbar")]
1617
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1620
class TestSetTimeoutCmd(TestPropertyValueCmd):
1621
command = SetTimeoutCmd
1622
propname = "Timeout"
1623
values_to_set = [datetime.timedelta(),
1624
datetime.timedelta(minutes=5),
1625
datetime.timedelta(seconds=1),
1626
datetime.timedelta(weeks=1),
1627
datetime.timedelta(weeks=52)]
1628
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1631
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1632
command = SetExtendedTimeoutCmd
1633
propname = "ExtendedTimeout"
1634
values_to_set = [datetime.timedelta(),
1635
datetime.timedelta(minutes=5),
1636
datetime.timedelta(seconds=1),
1637
datetime.timedelta(weeks=1),
1638
datetime.timedelta(weeks=52)]
1639
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1642
class TestSetIntervalCmd(TestPropertyValueCmd):
1643
command = SetIntervalCmd
1644
propname = "Interval"
1645
values_to_set = [datetime.timedelta(),
1646
datetime.timedelta(minutes=5),
1647
datetime.timedelta(seconds=1),
1648
datetime.timedelta(weeks=1),
1649
datetime.timedelta(weeks=52)]
1650
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1653
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1654
command = SetApprovalDelayCmd
1655
propname = "ApprovalDelay"
1656
values_to_set = [datetime.timedelta(),
1657
datetime.timedelta(minutes=5),
1658
datetime.timedelta(seconds=1),
1659
datetime.timedelta(weeks=1),
1660
datetime.timedelta(weeks=52)]
1661
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1664
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1665
command = SetApprovalDurationCmd
1666
propname = "ApprovalDuration"
1667
values_to_set = [datetime.timedelta(),
1668
datetime.timedelta(minutes=5),
1669
datetime.timedelta(seconds=1),
1670
datetime.timedelta(weeks=1),
1671
datetime.timedelta(weeks=52)]
1672
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1676
def should_only_run_tests():
1677
parser = argparse.ArgumentParser(add_help=False)
1678
parser.add_argument("--check", action='store_true')
1679
args, unknown_args = parser.parse_known_args()
1680
run_tests = args.check
1682
# Remove --check argument from sys.argv
1683
sys.argv[1:] = unknown_args
1686
# Add all tests from doctest strings
1687
def load_tests(loader, tests, none):
1689
tests.addTests(doctest.DocTestSuite())
459
1692
if __name__ == "__main__":
1693
if should_only_run_tests():
1694
# Call using ./tdd-python-script --check [--verbose]