424
def check_option_syntax(parser, options):
425
"""Apply additional restrictions on options, not expressible in
428
def has_commands(options, commands=None):
430
commands = (command.Enable,
433
command.StartChecker,
439
command.SetExtendedTimeout,
441
command.ApproveByDefault,
442
command.DenyByDefault,
443
command.SetApprovalDelay,
444
command.SetApprovalDuration,
449
return any(isinstance(cmd, commands)
450
for cmd in options.commands)
452
if has_commands(options) and not (options.client or options.all):
273
## Classes for commands.
275
# Abstract classes first
276
class Command(object):
277
"""Abstract class for commands"""
278
def run(self, mandos, clients):
279
"""Normal commands should implement run_on_one_client(), but
280
commands which want to operate on all clients at the same time
281
can override this run() method instead."""
283
for client, properties in clients.items():
284
self.run_on_one_client(client, properties)
286
class PrintCmd(Command):
287
"""Abstract class for commands printing client details"""
288
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
289
"Created", "Interval", "Host", "KeyID",
290
"Fingerprint", "CheckerRunning", "LastEnabled",
291
"ApprovalPending", "ApprovedByDefault",
292
"LastApprovalRequest", "ApprovalDelay",
293
"ApprovalDuration", "Checker", "ExtendedTimeout",
294
"Expires", "LastCheckerStatus")
295
def run(self, mandos, clients):
296
print(self.output(clients))
298
class PropertyCmd(Command):
299
"""Abstract class for Actions for setting one client property"""
300
def run_on_one_client(self, client, properties):
301
"""Set the Client's D-Bus property"""
302
client.Set(client_interface, self.property, self.value_to_set,
303
dbus_interface=dbus.PROPERTIES_IFACE)
305
class ValueArgumentMixIn(object):
306
"""Mixin class for commands taking a value as argument"""
307
def __init__(self, value):
308
self.value_to_set = value
310
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
311
"""Mixin class for commands taking a value argument as
314
def value_to_set(self):
317
def value_to_set(self, value):
318
"""When setting, convert value to a datetime.timedelta"""
319
self._vts = int(round(value.total_seconds() * 1000))
321
# Actual (non-abstract) command classes
323
class PrintTableCmd(PrintCmd):
324
def __init__(self, verbose=False):
325
self.verbose = verbose
327
def output(self, clients):
328
default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
329
keywords = default_keywords
331
keywords = self.all_keywords
332
return str(self.TableOfClients(clients.values(), keywords))
334
class TableOfClients(object):
337
"Enabled": "Enabled",
338
"Timeout": "Timeout",
339
"LastCheckedOK": "Last Successful Check",
340
"LastApprovalRequest": "Last Approval Request",
341
"Created": "Created",
342
"Interval": "Interval",
344
"Fingerprint": "Fingerprint",
346
"CheckerRunning": "Check Is Running",
347
"LastEnabled": "Last Enabled",
348
"ApprovalPending": "Approval Is Pending",
349
"ApprovedByDefault": "Approved By Default",
350
"ApprovalDelay": "Approval Delay",
351
"ApprovalDuration": "Approval Duration",
352
"Checker": "Checker",
353
"ExtendedTimeout": "Extended Timeout",
354
"Expires": "Expires",
355
"LastCheckerStatus": "Last Checker Status",
358
def __init__(self, clients, keywords, tableheaders=None):
359
self.clients = clients
360
self.keywords = keywords
361
if tableheaders is not None:
362
self.tableheaders = tableheaders
365
return "\n".join(self.rows())
367
if sys.version_info.major == 2:
368
__unicode__ = __str__
370
return str(self).encode(locale.getpreferredencoding())
373
format_string = self.row_formatting_string()
374
rows = [self.header_line(format_string)]
375
rows.extend(self.client_line(client, format_string)
376
for client in self.clients)
379
def row_formatting_string(self):
380
"Format string used to format table rows"
381
return " ".join("{{{key}:{width}}}".format(
382
width=max(len(self.tableheaders[key]),
383
*(len(self.string_from_client(client, key))
384
for client in self.clients)),
386
for key in self.keywords)
388
def string_from_client(self, client, key):
389
return self.valuetostring(client[key], key)
392
def valuetostring(value, keyword):
393
if isinstance(value, dbus.Boolean):
394
return "Yes" if value else "No"
395
if keyword in ("Timeout", "Interval", "ApprovalDelay",
396
"ApprovalDuration", "ExtendedTimeout"):
397
return milliseconds_to_string(value)
400
def header_line(self, format_string):
401
return format_string.format(**self.tableheaders)
403
def client_line(self, client, format_string):
404
return format_string.format(
405
**{key: self.string_from_client(client, key)
406
for key in self.keywords})
410
class DumpJSONCmd(PrintCmd):
411
def output(self, clients):
412
data = {client["Name"]:
413
{key: self.dbus_boolean_to_bool(client[key])
414
for key in self.all_keywords}
415
for client in clients.values()}
416
return json.dumps(data, indent=4, separators=(',', ': '))
418
def dbus_boolean_to_bool(value):
419
if isinstance(value, dbus.Boolean):
423
class IsEnabledCmd(Command):
424
def run_on_one_client(self, client, properties):
425
if self.is_enabled(client, properties):
428
def is_enabled(self, client, properties):
429
return bool(properties["Enabled"])
431
class RemoveCmd(Command):
432
def run_on_one_client(self, client, properties):
433
self.mandos.RemoveClient(client.__dbus_object_path__)
435
class ApproveCmd(Command):
436
def run_on_one_client(self, client, properties):
437
client.Approve(dbus.Boolean(True),
438
dbus_interface=client_interface)
440
class DenyCmd(Command):
441
def run_on_one_client(self, client, properties):
442
client.Approve(dbus.Boolean(False),
443
dbus_interface=client_interface)
445
class EnableCmd(PropertyCmd):
447
value_to_set = dbus.Boolean(True)
449
class DisableCmd(PropertyCmd):
451
value_to_set = dbus.Boolean(False)
453
class BumpTimeoutCmd(PropertyCmd):
454
property = "LastCheckedOK"
457
class StartCheckerCmd(PropertyCmd):
458
property = "CheckerRunning"
459
value_to_set = dbus.Boolean(True)
461
class StopCheckerCmd(PropertyCmd):
462
property = "CheckerRunning"
463
value_to_set = dbus.Boolean(False)
465
class ApproveByDefaultCmd(PropertyCmd):
466
property = "ApprovedByDefault"
467
value_to_set = dbus.Boolean(True)
469
class DenyByDefaultCmd(PropertyCmd):
470
property = "ApprovedByDefault"
471
value_to_set = dbus.Boolean(False)
473
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
476
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
479
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
481
def value_to_set(self):
484
def value_to_set(self, value):
485
"""When setting, read data from supplied file object"""
486
self._vts = value.read()
490
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
493
class SetExtendedTimeoutCmd(PropertyCmd,
494
MillisecondsValueArgumentMixIn):
495
property = "ExtendedTimeout"
497
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
498
property = "Interval"
500
class SetApprovalDelayCmd(PropertyCmd,
501
MillisecondsValueArgumentMixIn):
502
property = "ApprovalDelay"
504
class SetApprovalDurationCmd(PropertyCmd,
505
MillisecondsValueArgumentMixIn):
506
property = "ApprovalDuration"
508
def add_command_line_options(parser):
509
parser.add_argument("--version", action="version",
510
version="%(prog)s {}".format(version),
511
help="show version number and exit")
512
parser.add_argument("-a", "--all", action="store_true",
513
help="Select all clients")
514
parser.add_argument("-v", "--verbose", action="store_true",
515
help="Print all fields")
516
parser.add_argument("-j", "--dump-json", action="store_true",
517
help="Dump client data in JSON format")
518
enable_disable = parser.add_mutually_exclusive_group()
519
enable_disable.add_argument("-e", "--enable", action="store_true",
520
help="Enable client")
521
enable_disable.add_argument("-d", "--disable",
523
help="disable client")
524
parser.add_argument("-b", "--bump-timeout", action="store_true",
525
help="Bump timeout for client")
526
start_stop_checker = parser.add_mutually_exclusive_group()
527
start_stop_checker.add_argument("--start-checker",
529
help="Start checker for client")
530
start_stop_checker.add_argument("--stop-checker",
532
help="Stop checker for client")
533
parser.add_argument("-V", "--is-enabled", action="store_true",
534
help="Check if client is enabled")
535
parser.add_argument("-r", "--remove", action="store_true",
536
help="Remove client")
537
parser.add_argument("-c", "--checker",
538
help="Set checker command for client")
539
parser.add_argument("-t", "--timeout", type=string_to_delta,
540
help="Set timeout for client")
541
parser.add_argument("--extended-timeout", type=string_to_delta,
542
help="Set extended timeout for client")
543
parser.add_argument("-i", "--interval", type=string_to_delta,
544
help="Set checker interval for client")
545
approve_deny_default = parser.add_mutually_exclusive_group()
546
approve_deny_default.add_argument(
547
"--approve-by-default", action="store_true",
548
default=None, dest="approved_by_default",
549
help="Set client to be approved by default")
550
approve_deny_default.add_argument(
551
"--deny-by-default", action="store_false",
552
dest="approved_by_default",
553
help="Set client to be denied by default")
554
parser.add_argument("--approval-delay", type=string_to_delta,
555
help="Set delay before client approve/deny")
556
parser.add_argument("--approval-duration", type=string_to_delta,
557
help="Set duration of one client approval")
558
parser.add_argument("-H", "--host", help="Set host for client")
559
parser.add_argument("-s", "--secret",
560
type=argparse.FileType(mode="rb"),
561
help="Set password blob (file) for client")
562
approve_deny = parser.add_mutually_exclusive_group()
563
approve_deny.add_argument(
564
"-A", "--approve", action="store_true",
565
help="Approve any current client request")
566
approve_deny.add_argument("-D", "--deny", action="store_true",
567
help="Deny any current client request")
568
parser.add_argument("--check", action="store_true",
569
help="Run self-test")
570
parser.add_argument("client", nargs="*", help="Client name")
573
def commands_from_options(options):
577
if options.dump_json:
578
commands.append(DumpJSONCmd())
581
commands.append(EnableCmd())
584
commands.append(DisableCmd())
586
if options.bump_timeout:
587
commands.append(BumpTimeoutCmd())
589
if options.start_checker:
590
commands.append(StartCheckerCmd())
592
if options.stop_checker:
593
commands.append(StopCheckerCmd())
595
if options.is_enabled:
596
commands.append(IsEnabledCmd())
599
commands.append(RemoveCmd())
601
if options.checker is not None:
602
commands.append(SetCheckerCmd(options.checker))
604
if options.timeout is not None:
605
commands.append(SetTimeoutCmd(options.timeout))
607
if options.extended_timeout:
609
SetExtendedTimeoutCmd(options.extended_timeout))
611
if options.interval is not None:
612
commands.append(SetIntervalCmd(options.interval))
614
if options.approved_by_default is not None:
615
if options.approved_by_default:
616
commands.append(ApproveByDefaultCmd())
618
commands.append(DenyByDefaultCmd())
620
if options.approval_delay is not None:
621
commands.append(SetApprovalDelayCmd(options.approval_delay))
623
if options.approval_duration is not None:
625
SetApprovalDurationCmd(options.approval_duration))
627
if options.host is not None:
628
commands.append(SetHostCmd(options.host))
630
if options.secret is not None:
631
commands.append(SetSecretCmd(options.secret))
634
commands.append(ApproveCmd())
637
commands.append(DenyCmd())
639
# If no command option has been given, show table of clients,
640
# optionally verbosely
642
commands.append(PrintTableCmd(verbose=options.verbose))
648
parser = argparse.ArgumentParser()
650
add_command_line_options(parser)
652
options = parser.parse_args()
654
def has_actions(options):
655
return any((options.enable,
657
options.bump_timeout,
658
options.start_checker,
659
options.stop_checker,
662
options.checker is not None,
663
options.timeout is not None,
664
options.extended_timeout is not None,
665
options.interval is not None,
666
options.approved_by_default is not None,
667
options.approval_delay is not None,
668
options.approval_duration is not None,
669
options.host is not None,
670
options.secret is not None,
674
if has_actions(options) and not (options.client or options.all):
453
675
parser.error("Options require clients names or --all.")
454
if options.verbose and has_commands(options):
676
if options.verbose and has_actions(options):
455
677
parser.error("--verbose can only be used alone.")
456
if (has_commands(options, (command.DumpJSON,))
457
and (options.verbose or len(options.commands) > 1)):
678
if options.dump_json and (options.verbose
679
or has_actions(options)):
458
680
parser.error("--dump-json can only be used alone.")
459
if options.all and not has_commands(options):
681
if options.all and not has_actions(options):
460
682
parser.error("--all requires an action.")
461
if (has_commands(options, (command.IsEnabled,))
462
and len(options.client) > 1):
683
if options.is_enabled and len(options.client) > 1:
463
684
parser.error("--is-enabled requires exactly one client")
464
if (len(options.commands) > 1
465
and has_commands(options, (command.Remove,))
466
and not has_commands(options, (command.Deny,))):
467
parser.error("--remove can only be combined with --deny")
472
class SystemBus(object):
474
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
475
def get_managed_objects(self, busname, objectpath):
476
return self.call_method("GetManagedObjects", busname,
478
self.object_manager_iface)
480
properties_iface = "org.freedesktop.DBus.Properties"
481
def set_property(self, busname, objectpath, interface, key,
483
self.call_method("Set", busname, objectpath,
484
self.properties_iface, interface, key,
488
class MandosBus(SystemBus):
489
busname_domain = "se.recompile"
490
busname = busname_domain + ".Mandos"
492
server_interface = busname_domain + ".Mandos"
493
client_interface = busname_domain + ".Mandos.Client"
496
def get_clients_and_properties(self):
497
managed_objects = self.get_managed_objects(
498
self.busname, self.server_path)
499
return {objpath: properties[self.client_interface]
500
for objpath, properties in managed_objects.items()
501
if self.client_interface in properties}
503
def set_client_property(self, objectpath, key, value):
504
return self.set_property(self.busname, objectpath,
505
self.client_interface, key,
508
def call_client_method(self, objectpath, method, *args):
509
return self.call_method(method, self.busname, objectpath,
510
self.client_interface, *args)
512
def call_server_method(self, method, *args):
513
return self.call_method(method, self.busname,
515
self.server_interface, *args)
517
class Error(Exception):
520
class ConnectFailed(Error):
524
class dbus_python_adapter(object):
526
class SystemBus(dbus.MandosBus):
527
"""Use dbus-python"""
529
def __init__(self, module=dbus_python):
530
self.dbus_python = module
531
self.bus = self.dbus_python.SystemBus()
533
@contextlib.contextmanager
534
def convert_exception(self, exception_class=dbus.Error):
537
except self.dbus_python.exceptions.DBusException as e:
538
# This does what "raise from" would do
539
exc = exception_class(*e.args)
543
def call_method(self, methodname, busname, objectpath,
545
proxy_object = self.get_object(busname, objectpath)
546
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
547
interface, methodname,
548
", ".join(repr(a) for a in args))
549
method = getattr(proxy_object, methodname)
550
with self.convert_exception():
551
with dbus_python_adapter.SilenceLogger(
553
value = method(*args, dbus_interface=interface)
554
return self.type_filter(value)
556
def get_object(self, busname, objectpath):
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
559
with self.convert_exception(dbus.ConnectFailed):
560
return self.bus.get_object(busname, objectpath)
562
def type_filter(self, value):
563
"""Convert the most bothersome types to Python types"""
564
if isinstance(value, self.dbus_python.Boolean):
566
if isinstance(value, self.dbus_python.ObjectPath):
568
# Also recurse into dictionaries
569
if isinstance(value, self.dbus_python.Dictionary):
570
return {self.type_filter(key):
571
self.type_filter(subval)
572
for key, subval in value.items()}
575
def set_client_property(self, objectpath, key, value):
577
if not isinstance(value, bytes):
578
value = value.encode("utf-8")
579
value = self.dbus_python.ByteArray(value)
580
return self.set_property(self.busname, objectpath,
581
self.client_interface, key,
584
class SilenceLogger(object):
585
"Simple context manager to silence a particular logger"
586
def __init__(self, loggername):
587
self.logger = logging.getLogger(loggername)
590
self.logger.addFilter(self.nullfilter)
592
class NullFilter(logging.Filter):
593
def filter(self, record):
596
nullfilter = NullFilter()
598
def __exit__(self, exc_type, exc_val, exc_tb):
599
self.logger.removeFilter(self.nullfilter)
602
class CachingBus(SystemBus):
603
"""A caching layer for dbus_python_adapter.SystemBus"""
604
def __init__(self, *args, **kwargs):
605
self.object_cache = {}
606
super(dbus_python_adapter.CachingBus,
607
self).__init__(*args, **kwargs)
608
def get_object(self, busname, objectpath):
610
return self.object_cache[(busname, objectpath)]
613
dbus_python_adapter.CachingBus,
614
self).get_object(busname, objectpath)
615
self.object_cache[(busname, objectpath)] = new_object
619
class pydbus_adapter(object):
620
class SystemBus(dbus.MandosBus):
621
def __init__(self, module=pydbus):
623
self.bus = self.pydbus.SystemBus()
625
@contextlib.contextmanager
626
def convert_exception(self, exception_class=dbus.Error):
629
except gi.repository.GLib.Error as e:
630
# This does what "raise from" would do
631
exc = exception_class(*e.args)
635
def call_method(self, methodname, busname, objectpath,
637
proxy_object = self.get(busname, objectpath)
638
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
639
interface, methodname,
640
", ".join(repr(a) for a in args))
641
method = getattr(proxy_object[interface], methodname)
642
with self.convert_exception():
645
def get(self, busname, objectpath):
646
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
648
with self.convert_exception(dbus.ConnectFailed):
649
if sys.version_info.major <= 2:
650
with warnings.catch_warnings():
651
warnings.filterwarnings(
652
"ignore", "", DeprecationWarning,
653
r"^xml\.etree\.ElementTree$")
654
return self.bus.get(busname, objectpath)
656
return self.bus.get(busname, objectpath)
658
def set_property(self, busname, objectpath, interface, key,
660
proxy_object = self.get(busname, objectpath)
661
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
662
objectpath, self.properties_iface, interface,
664
setattr(proxy_object[interface], key, value)
666
class CachingBus(SystemBus):
667
"""A caching layer for pydbus_adapter.SystemBus"""
668
def __init__(self, *args, **kwargs):
669
self.object_cache = {}
670
super(pydbus_adapter.CachingBus,
671
self).__init__(*args, **kwargs)
672
def get(self, busname, objectpath):
674
return self.object_cache[(busname, objectpath)]
676
new_object = (super(pydbus_adapter.CachingBus, self)
677
.get(busname, objectpath))
678
self.object_cache[(busname, objectpath)] = new_object
682
def commands_from_options(options):
684
commands = list(options.commands)
686
def find_cmd(cmd, commands):
688
for i, c in enumerate(commands):
689
if isinstance(c, cmd):
693
# If command.Remove is present, move any instances of command.Deny
694
# to occur ahead of command.Remove.
695
index_of_remove = find_cmd(command.Remove, commands)
696
before_remove = commands[:index_of_remove]
697
after_remove = commands[index_of_remove:]
699
for cmd in after_remove:
700
if isinstance(cmd, command.Deny):
701
before_remove.append(cmd)
703
cleaned_after.append(cmd)
704
if cleaned_after != after_remove:
705
commands = before_remove + cleaned_after
707
# If no command option has been given, show table of clients,
708
# optionally verbosely
710
commands.append(command.PrintTable(verbose=options.verbose))
715
class command(object):
716
"""A namespace for command classes"""
719
"""Abstract base class for commands"""
720
def run(self, clients, bus=None):
721
"""Normal commands should implement run_on_one_client(),
722
but commands which want to operate on all clients at the same time can
723
override this run() method instead.
726
for client, properties in clients.items():
727
self.run_on_one_client(client, properties)
730
class IsEnabled(Base):
731
def run(self, clients, bus=None):
732
properties = next(iter(clients.values()))
733
if properties["Enabled"]:
739
def run_on_one_client(self, client, properties):
740
self.bus.call_client_method(client, "Approve", True)
744
def run_on_one_client(self, client, properties):
745
self.bus.call_client_method(client, "Approve", False)
749
def run(self, clients, bus):
750
for clientpath in frozenset(clients.keys()):
751
bus.call_server_method("RemoveClient", clientpath)
755
"""Abstract class for commands outputting client details"""
756
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
757
"Created", "Interval", "Host", "KeyID",
758
"Fingerprint", "CheckerRunning",
759
"LastEnabled", "ApprovalPending",
760
"ApprovedByDefault", "LastApprovalRequest",
761
"ApprovalDelay", "ApprovalDuration",
762
"Checker", "ExtendedTimeout", "Expires",
766
class DumpJSON(Output):
767
def run(self, clients, bus=None):
768
data = {properties["Name"]:
769
{key: properties[key]
770
for key in self.all_keywords}
771
for properties in clients.values()}
772
print(json.dumps(data, indent=4, separators=(',', ': ')))
775
class PrintTable(Output):
776
def __init__(self, verbose=False):
777
self.verbose = verbose
779
def run(self, clients, bus=None):
780
default_keywords = ("Name", "Enabled", "Timeout",
782
keywords = default_keywords
784
keywords = self.all_keywords
785
print(self.TableOfClients(clients.values(), keywords))
787
class TableOfClients(object):
790
"Enabled": "Enabled",
791
"Timeout": "Timeout",
792
"LastCheckedOK": "Last Successful Check",
793
"LastApprovalRequest": "Last Approval Request",
794
"Created": "Created",
795
"Interval": "Interval",
797
"Fingerprint": "Fingerprint",
799
"CheckerRunning": "Check Is Running",
800
"LastEnabled": "Last Enabled",
801
"ApprovalPending": "Approval Is Pending",
802
"ApprovedByDefault": "Approved By Default",
803
"ApprovalDelay": "Approval Delay",
804
"ApprovalDuration": "Approval Duration",
805
"Checker": "Checker",
806
"ExtendedTimeout": "Extended Timeout",
807
"Expires": "Expires",
808
"LastCheckerStatus": "Last Checker Status",
811
def __init__(self, clients, keywords):
812
self.clients = clients
813
self.keywords = keywords
816
return "\n".join(self.rows())
818
if sys.version_info.major == 2:
819
__unicode__ = __str__
821
return str(self).encode(
822
locale.getpreferredencoding())
825
format_string = self.row_formatting_string()
826
rows = [self.header_line(format_string)]
827
rows.extend(self.client_line(client, format_string)
828
for client in self.clients)
831
def row_formatting_string(self):
832
"Format string used to format table rows"
833
return " ".join("{{{key}:{width}}}".format(
834
width=max(len(self.tableheaders[key]),
835
*(len(self.string_from_client(client,
837
for client in self.clients)),
839
for key in self.keywords)
841
def string_from_client(self, client, key):
842
return self.valuetostring(client[key], key)
845
def valuetostring(cls, value, keyword):
846
if isinstance(value, bool):
847
return "Yes" if value else "No"
848
if keyword in ("Timeout", "Interval", "ApprovalDelay",
849
"ApprovalDuration", "ExtendedTimeout"):
850
return cls.milliseconds_to_string(value)
853
def header_line(self, format_string):
854
return format_string.format(**self.tableheaders)
856
def client_line(self, client, format_string):
857
return format_string.format(
858
**{key: self.string_from_client(client, key)
859
for key in self.keywords})
862
def milliseconds_to_string(ms):
863
td = datetime.timedelta(0, 0, 0, ms)
864
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
865
.format(days="{}T".format(td.days)
867
hours=td.seconds // 3600,
868
minutes=(td.seconds % 3600) // 60,
869
seconds=td.seconds % 60))
872
class PropertySetter(Base):
873
"Abstract class for Actions for setting one client property"
875
def run_on_one_client(self, client, properties=None):
876
"""Set the Client's D-Bus property"""
877
self.bus.set_client_property(client, self.propname,
882
raise NotImplementedError()
885
class Enable(PropertySetter):
890
class Disable(PropertySetter):
895
class BumpTimeout(PropertySetter):
896
propname = "LastCheckedOK"
900
class StartChecker(PropertySetter):
901
propname = "CheckerRunning"
905
class StopChecker(PropertySetter):
906
propname = "CheckerRunning"
910
class ApproveByDefault(PropertySetter):
911
propname = "ApprovedByDefault"
915
class DenyByDefault(PropertySetter):
916
propname = "ApprovedByDefault"
920
class PropertySetterValue(PropertySetter):
921
"""Abstract class for PropertySetter recieving a value as
922
constructor argument instead of a class attribute."""
923
def __init__(self, value):
924
self.value_to_set = value
927
def argparse(cls, argtype):
929
return cls(argtype(arg))
932
class SetChecker(PropertySetterValue):
936
class SetHost(PropertySetterValue):
940
class SetSecret(PropertySetterValue):
944
def value_to_set(self):
948
def value_to_set(self, value):
949
"""When setting, read data from supplied file object"""
950
self._vts = value.read()
954
class PropertySetterValueMilliseconds(PropertySetterValue):
955
"""Abstract class for PropertySetterValue taking a value
956
argument as a datetime.timedelta() but should store it as
960
def value_to_set(self):
964
def value_to_set(self, value):
965
"When setting, convert value from a datetime.timedelta"
966
self._vts = int(round(value.total_seconds() * 1000))
969
class SetTimeout(PropertySetterValueMilliseconds):
973
class SetExtendedTimeout(PropertySetterValueMilliseconds):
974
propname = "ExtendedTimeout"
977
class SetInterval(PropertySetterValueMilliseconds):
978
propname = "Interval"
981
class SetApprovalDelay(PropertySetterValueMilliseconds):
982
propname = "ApprovalDelay"
985
class SetApprovalDuration(PropertySetterValueMilliseconds):
986
propname = "ApprovalDuration"
686
clientnames = options.client
689
bus = dbus.SystemBus()
690
mandos_dbus_objc = bus.get_object(busname, server_path)
691
except dbus.exceptions.DBusException:
692
log.critical("Could not connect to Mandos server")
695
mandos_serv = dbus.Interface(mandos_dbus_objc,
696
dbus_interface=server_interface)
697
mandos_serv_object_manager = dbus.Interface(
698
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
700
# Filter out log message from dbus module
701
dbus_logger = logging.getLogger("dbus.proxies")
702
class NullFilter(logging.Filter):
703
def filter(self, record):
705
dbus_filter = NullFilter()
707
dbus_logger.addFilter(dbus_filter)
708
mandos_clients = {path: ifs_and_props[client_interface]
709
for path, ifs_and_props in
710
mandos_serv_object_manager
711
.GetManagedObjects().items()
712
if client_interface in ifs_and_props}
713
except dbus.exceptions.DBusException as e:
714
log.critical("Failed to access Mandos server through D-Bus:"
718
# restore dbus logger
719
dbus_logger.removeFilter(dbus_filter)
721
# Compile dict of (clients: properties) to process
725
clients = {bus.get_object(busname, path): properties
726
for path, properties in mandos_clients.items()}
728
for name in clientnames:
729
for path, client in mandos_clients.items():
730
if client["Name"] == name:
731
client_objc = bus.get_object(busname, path)
732
clients[client_objc] = client
735
log.critical("Client not found on server: %r", name)
738
# Run all commands on clients
739
commands = commands_from_options(options)
740
for command in commands:
741
command.run(mandos_serv, clients)
990
class TestCaseWithAssertLogs(unittest.TestCase):
991
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
993
if not hasattr(unittest.TestCase, "assertLogs"):
994
@contextlib.contextmanager
995
def assertLogs(self, logger, level=logging.INFO):
996
capturing_handler = self.CapturingLevelHandler(level)
997
old_level = logger.level
998
old_propagate = logger.propagate
999
logger.addHandler(capturing_handler)
1000
logger.setLevel(level)
1001
logger.propagate = False
1003
yield capturing_handler.watcher
1005
logger.propagate = old_propagate
1006
logger.removeHandler(capturing_handler)
1007
logger.setLevel(old_level)
1008
self.assertGreater(len(capturing_handler.watcher.records),
1011
class CapturingLevelHandler(logging.Handler):
1012
def __init__(self, level, *args, **kwargs):
1013
logging.Handler.__init__(self, *args, **kwargs)
1014
self.watcher = self.LoggingWatcher([], [])
1015
def emit(self, record):
1016
self.watcher.records.append(record)
1017
self.watcher.output.append(self.format(record))
1019
LoggingWatcher = collections.namedtuple("LoggingWatcher",
1024
class Unique(object):
1025
"""Class for objects which exist only to be unique objects, since
1026
unittest.mock.sentinel only exists in Python 3.3"""
1029
class Test_string_to_delta(TestCaseWithAssertLogs):
1030
# Just test basic RFC 3339 functionality here, the doc string for
1031
# rfc3339_duration_to_delta() already has more comprehensive
1032
# tests, which are run by doctest.
1034
def test_rfc3339_zero_seconds(self):
1035
self.assertEqual(datetime.timedelta(),
1036
string_to_delta("PT0S"))
1038
def test_rfc3339_zero_days(self):
1039
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1041
def test_rfc3339_one_second(self):
1042
self.assertEqual(datetime.timedelta(0, 1),
1043
string_to_delta("PT1S"))
1045
def test_rfc3339_two_hours(self):
1046
self.assertEqual(datetime.timedelta(0, 7200),
1047
string_to_delta("PT2H"))
744
class Test_milliseconds_to_string(unittest.TestCase):
746
self.assertEqual(milliseconds_to_string(93785000),
748
def test_no_days(self):
749
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
750
def test_all_zero(self):
751
self.assertEqual(milliseconds_to_string(0), "00:00:00")
752
def test_no_fractional_seconds(self):
753
self.assertEqual(milliseconds_to_string(400), "00:00:00")
754
self.assertEqual(milliseconds_to_string(900), "00:00:00")
755
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
757
class Test_string_to_delta(unittest.TestCase):
758
def test_handles_basic_rfc3339(self):
759
self.assertEqual(string_to_delta("PT0S"),
760
datetime.timedelta())
761
self.assertEqual(string_to_delta("P0D"),
762
datetime.timedelta())
763
self.assertEqual(string_to_delta("PT1S"),
764
datetime.timedelta(0, 1))
765
self.assertEqual(string_to_delta("PT2H"),
766
datetime.timedelta(0, 7200))
1049
767
def test_falls_back_to_pre_1_6_1_with_warning(self):
1050
with self.assertLogs(log, logging.WARNING):
1051
value = string_to_delta("2h")
1052
self.assertEqual(datetime.timedelta(0, 7200), value)
1055
class Test_check_option_syntax(unittest.TestCase):
1057
self.parser = argparse.ArgumentParser()
1058
add_command_line_options(self.parser)
1060
def test_actions_requires_client_or_all(self):
1061
for action, value in self.actions.items():
1062
args = self.actionargs(action, value)
1063
with self.assertParseError():
1064
self.parse_args(args)
1066
# This mostly corresponds to the definition from has_commands() in
1067
# check_option_syntax()
1071
"--bump-timeout": None,
1072
"--start-checker": None,
1073
"--stop-checker": None,
1074
"--is-enabled": None,
1077
"--timeout": "PT0S",
1078
"--extended-timeout": "PT0S",
1079
"--interval": "PT0S",
1080
"--approve-by-default": None,
1081
"--deny-by-default": None,
1082
"--approval-delay": "PT0S",
1083
"--approval-duration": "PT0S",
1084
"--host": "hostname",
1085
"--secret": "/dev/null",
1091
def actionargs(action, value, *args):
1092
if value is not None:
1093
return [action, value] + list(args)
768
# assertLogs only exists in Python 3.4
769
if hasattr(self, "assertLogs"):
770
with self.assertLogs(log, logging.WARNING):
771
value = string_to_delta("2h")
1095
return [action] + list(args)
1097
@contextlib.contextmanager
1098
def assertParseError(self):
1099
with self.assertRaises(SystemExit) as e:
1100
with self.redirect_stderr_to_devnull():
1102
# Exit code from argparse is guaranteed to be "2". Reference:
1103
# https://docs.python.org/3/library
1104
# /argparse.html#exiting-methods
1105
self.assertEqual(2, e.exception.code)
1107
def parse_args(self, args):
1108
options = self.parser.parse_args(args)
1109
check_option_syntax(self.parser, options)
1112
@contextlib.contextmanager
1113
def redirect_stderr_to_devnull():
1114
old_stderr = sys.stderr
1115
with contextlib.closing(open(os.devnull, "w")) as null:
773
class WarningFilter(logging.Filter):
774
"""Don't show, but record the presence of, warnings"""
775
def filter(self, record):
776
is_warning = record.levelno >= logging.WARNING
777
self.found = is_warning or getattr(self, "found",
779
return not is_warning
780
warning_filter = WarningFilter()
781
log.addFilter(warning_filter)
783
value = string_to_delta("2h")
1120
sys.stderr = old_stderr
1122
def check_option_syntax(self, options):
1123
check_option_syntax(self.parser, options)
1125
def test_actions_all_conflicts_with_verbose(self):
1126
for action, value in self.actions.items():
1127
args = self.actionargs(action, value, "--all",
1129
with self.assertParseError():
1130
self.parse_args(args)
1132
def test_actions_with_client_conflicts_with_verbose(self):
1133
for action, value in self.actions.items():
1134
args = self.actionargs(action, value, "--verbose",
1136
with self.assertParseError():
1137
self.parse_args(args)
1139
def test_dump_json_conflicts_with_verbose(self):
1140
args = ["--dump-json", "--verbose"]
1141
with self.assertParseError():
1142
self.parse_args(args)
1144
def test_dump_json_conflicts_with_action(self):
1145
for action, value in self.actions.items():
1146
args = self.actionargs(action, value, "--dump-json")
1147
with self.assertParseError():
1148
self.parse_args(args)
1150
def test_all_can_not_be_alone(self):
1152
with self.assertParseError():
1153
self.parse_args(args)
1155
def test_all_is_ok_with_any_action(self):
1156
for action, value in self.actions.items():
1157
args = self.actionargs(action, value, "--all")
1158
self.parse_args(args)
1160
def test_any_action_is_ok_with_one_client(self):
1161
for action, value in self.actions.items():
1162
args = self.actionargs(action, value, "client")
1163
self.parse_args(args)
1165
def test_one_client_with_all_actions_except_is_enabled(self):
1166
for action, value in self.actions.items():
1167
if action == "--is-enabled":
1169
args = self.actionargs(action, value, "client")
1170
self.parse_args(args)
1172
def test_two_clients_with_all_actions_except_is_enabled(self):
1173
for action, value in self.actions.items():
1174
if action == "--is-enabled":
1176
args = self.actionargs(action, value, "client1",
1178
self.parse_args(args)
1180
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1181
for action, value in self.actions.items():
1182
if action == "--is-enabled":
1184
args = self.actionargs(action, value, "client1",
1186
self.parse_args(args)
1188
def test_is_enabled_fails_without_client(self):
1189
args = ["--is-enabled"]
1190
with self.assertParseError():
1191
self.parse_args(args)
1193
def test_is_enabled_fails_with_two_clients(self):
1194
args = ["--is-enabled", "client1", "client2"]
1195
with self.assertParseError():
1196
self.parse_args(args)
1198
def test_remove_can_only_be_combined_with_action_deny(self):
1199
for action, value in self.actions.items():
1200
if action in {"--remove", "--deny"}:
1202
args = self.actionargs(action, value, "--all",
1204
with self.assertParseError():
1205
self.parse_args(args)
1208
class Test_dbus_exceptions(unittest.TestCase):
1210
def test_dbus_ConnectFailed_is_Error(self):
1211
with self.assertRaises(dbus.Error):
1212
raise dbus.ConnectFailed()
1215
class Test_dbus_MandosBus(unittest.TestCase):
1217
class MockMandosBus(dbus.MandosBus):
1219
self._name = "se.recompile.Mandos"
1220
self._server_path = "/"
1221
self._server_interface = "se.recompile.Mandos"
1222
self._client_interface = "se.recompile.Mandos.Client"
1224
self.call_method_return = Unique()
1226
def call_method(self, methodname, busname, objectpath,
1228
self.calls.append((methodname, busname, objectpath,
1230
return self.call_method_return
1233
self.bus = self.MockMandosBus()
1235
def test_set_client_property(self):
1236
self.bus.set_client_property("objectpath", "key", "value")
1237
expected_call = ("Set", self.bus._name, "objectpath",
1238
"org.freedesktop.DBus.Properties",
1239
(self.bus._client_interface, "key", "value"))
1240
self.assertIn(expected_call, self.bus.calls)
1242
def test_call_client_method(self):
1243
ret = self.bus.call_client_method("objectpath", "methodname")
1244
self.assertIs(self.bus.call_method_return, ret)
1245
expected_call = ("methodname", self.bus._name, "objectpath",
1246
self.bus._client_interface, ())
1247
self.assertIn(expected_call, self.bus.calls)
1249
def test_call_client_method_with_args(self):
1250
args = (Unique(), Unique())
1251
ret = self.bus.call_client_method("objectpath", "methodname",
1253
self.assertIs(self.bus.call_method_return, ret)
1254
expected_call = ("methodname", self.bus._name, "objectpath",
1255
self.bus._client_interface,
1257
self.assertIn(expected_call, self.bus.calls)
1259
def test_get_clients_and_properties(self):
1262
self.bus._client_interface: {
1266
"irrelevant_interface": {
1267
"key": "othervalue",
1271
"other_objectpath": {
1272
"other_irrelevant_interface": {
1278
expected_clients_and_properties = {
1284
self.bus.call_method_return = managed_objects
1285
ret = self.bus.get_clients_and_properties()
1286
self.assertDictEqual(expected_clients_and_properties, ret)
1287
expected_call = ("GetManagedObjects", self.bus._name,
1288
self.bus._server_path,
1289
"org.freedesktop.DBus.ObjectManager", ())
1290
self.assertIn(expected_call, self.bus.calls)
1292
def test_call_server_method(self):
1293
ret = self.bus.call_server_method("methodname")
1294
self.assertIs(self.bus.call_method_return, ret)
1295
expected_call = ("methodname", self.bus._name,
1296
self.bus._server_path,
1297
self.bus._server_interface, ())
1298
self.assertIn(expected_call, self.bus.calls)
1300
def test_call_server_method_with_args(self):
1301
args = (Unique(), Unique())
1302
ret = self.bus.call_server_method("methodname", *args)
1303
self.assertIs(self.bus.call_method_return, ret)
1304
expected_call = ("methodname", self.bus._name,
1305
self.bus._server_path,
1306
self.bus._server_interface,
1308
self.assertIn(expected_call, self.bus.calls)
1311
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1313
def MockDBusPython_func(self, func):
1314
class mock_dbus_python(object):
1315
"""mock dbus-python module"""
1316
class exceptions(object):
1317
"""Pseudo-namespace"""
1318
class DBusException(Exception):
1320
class SystemBus(object):
1322
def get_object(busname, objectpath):
1323
DBusObject = collections.namedtuple(
1324
"DBusObject", ("methodname", "Set"))
1325
def method(*args, **kwargs):
1326
self.assertEqual({"dbus_interface":
1330
def set_property(interface, key, value,
1331
dbus_interface=None):
1333
"org.freedesktop.DBus.Properties",
1335
self.assertEqual("Secret", key)
1336
return func(interface, key, value,
1337
dbus_interface=dbus_interface)
1338
return DBusObject(methodname=method,
1340
class Boolean(object):
1341
def __init__(self, value):
1342
self.value = bool(value)
1345
if sys.version_info.major == 2:
1346
__nonzero__ = __bool__
1347
class ObjectPath(str):
1349
class Dictionary(dict):
1351
class ByteArray(bytes):
1353
return mock_dbus_python
1355
def call_method(self, bus, methodname, busname, objectpath,
1357
with self.assertLogs(log, logging.DEBUG):
1358
return bus.call_method(methodname, busname, objectpath,
1361
def test_call_method_returns(self):
1362
expected_method_return = Unique()
1363
method_args = (Unique(), Unique())
1365
self.assertEqual(len(method_args), len(args))
1366
for marg, arg in zip(method_args, args):
1367
self.assertIs(marg, arg)
1368
return expected_method_return
1369
mock_dbus_python = self.MockDBusPython_func(func)
1370
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1371
ret = self.call_method(bus, "methodname", "busname",
1372
"objectpath", "interface",
1374
self.assertIs(ret, expected_method_return)
1376
def test_call_method_filters_bool_true(self):
1378
return method_return
1379
mock_dbus_python = self.MockDBusPython_func(func)
1380
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1381
method_return = mock_dbus_python.Boolean(True)
1382
ret = self.call_method(bus, "methodname", "busname",
1383
"objectpath", "interface")
1384
self.assertTrue(ret)
1385
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1387
def test_call_method_filters_bool_false(self):
1389
return method_return
1390
mock_dbus_python = self.MockDBusPython_func(func)
1391
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1392
method_return = mock_dbus_python.Boolean(False)
1393
ret = self.call_method(bus, "methodname", "busname",
1394
"objectpath", "interface")
1395
self.assertFalse(ret)
1396
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1398
def test_call_method_filters_objectpath(self):
1400
return method_return
1401
mock_dbus_python = self.MockDBusPython_func(func)
1402
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1403
method_return = mock_dbus_python.ObjectPath("objectpath")
1404
ret = self.call_method(bus, "methodname", "busname",
1405
"objectpath", "interface")
1406
self.assertEqual("objectpath", ret)
1407
self.assertIsNot("objectpath", ret)
1408
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1410
def test_call_method_filters_booleans_in_dict(self):
1412
return method_return
1413
mock_dbus_python = self.MockDBusPython_func(func)
1414
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1415
method_return = mock_dbus_python.Dictionary(
1416
{mock_dbus_python.Boolean(True):
1417
mock_dbus_python.Boolean(False),
1418
mock_dbus_python.Boolean(False):
1419
mock_dbus_python.Boolean(True)})
1420
ret = self.call_method(bus, "methodname", "busname",
1421
"objectpath", "interface")
1422
expected_method_return = {True: False,
1424
self.assertEqual(expected_method_return, ret)
1425
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1427
def test_call_method_filters_objectpaths_in_dict(self):
1429
return method_return
1430
mock_dbus_python = self.MockDBusPython_func(func)
1431
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1432
method_return = mock_dbus_python.Dictionary(
1433
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1434
mock_dbus_python.ObjectPath("objectpath_value_1"),
1435
mock_dbus_python.ObjectPath("objectpath_key_2"):
1436
mock_dbus_python.ObjectPath("objectpath_value_2")})
1437
ret = self.call_method(bus, "methodname", "busname",
1438
"objectpath", "interface")
1439
expected_method_return = {str(key): str(value)
1441
method_return.items()}
1442
self.assertEqual(expected_method_return, ret)
1443
self.assertIsInstance(ret, dict)
1444
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1446
def test_call_method_filters_dict_in_dict(self):
1448
return method_return
1449
mock_dbus_python = self.MockDBusPython_func(func)
1450
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1451
method_return = mock_dbus_python.Dictionary(
1452
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1453
"key12": "value12"}),
1454
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1455
"key22": "value22"})})
1456
ret = self.call_method(bus, "methodname", "busname",
1457
"objectpath", "interface")
1458
expected_method_return = {
1459
"key1": {"key11": "value11",
1460
"key12": "value12"},
1461
"key2": {"key21": "value21",
1462
"key22": "value22"},
1464
self.assertEqual(expected_method_return, ret)
1465
self.assertIsInstance(ret, dict)
1466
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1467
for key, value in ret.items():
1468
self.assertIsInstance(value, dict)
1469
self.assertEqual(expected_method_return[key], value)
1470
self.assertNotIsInstance(value,
1471
mock_dbus_python.Dictionary)
1473
def test_call_method_filters_dict_three_deep(self):
1475
return method_return
1476
mock_dbus_python = self.MockDBusPython_func(func)
1477
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1478
method_return = mock_dbus_python.Dictionary(
1480
mock_dbus_python.Dictionary(
1482
mock_dbus_python.Dictionary(
1484
mock_dbus_python.Boolean(True),
1488
ret = self.call_method(bus, "methodname", "busname",
1489
"objectpath", "interface")
1490
expected_method_return = {"key1": {"key2": {"key3": True}}}
1491
self.assertEqual(expected_method_return, ret)
1492
self.assertIsInstance(ret, dict)
1493
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1494
self.assertIsInstance(ret["key1"], dict)
1495
self.assertNotIsInstance(ret["key1"],
1496
mock_dbus_python.Dictionary)
1497
self.assertIsInstance(ret["key1"]["key2"], dict)
1498
self.assertNotIsInstance(ret["key1"]["key2"],
1499
mock_dbus_python.Dictionary)
1500
self.assertTrue(ret["key1"]["key2"]["key3"])
1501
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1502
mock_dbus_python.Boolean)
1504
def test_call_method_handles_exception(self):
1505
dbus_logger = logging.getLogger("dbus.proxies")
1508
dbus_logger.error("Test")
1509
raise mock_dbus_python.exceptions.DBusException()
1511
mock_dbus_python = self.MockDBusPython_func(func)
1512
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1514
class CountingHandler(logging.Handler):
1516
def emit(self, record):
1519
counting_handler = CountingHandler()
1521
dbus_logger.addHandler(counting_handler)
1524
with self.assertRaises(dbus.Error) as e:
1525
self.call_method(bus, "methodname", "busname",
1526
"objectpath", "interface")
1528
dbus_logger.removeFilter(counting_handler)
1530
self.assertNotIsInstance(e, dbus.ConnectFailed)
1532
# Make sure the dbus logger was suppressed
1533
self.assertEqual(0, counting_handler.count)
1535
def test_Set_Secret_sends_bytearray(self):
1537
def func(*args, **kwargs):
1538
ret[0] = (args, kwargs)
1539
mock_dbus_python = self.MockDBusPython_func(func)
1540
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1541
bus.set_client_property("objectpath", "Secret", "value")
1542
expected_call = (("se.recompile.Mandos.Client", "Secret",
1543
mock_dbus_python.ByteArray(b"value")),
1545
"org.freedesktop.DBus.Properties"})
1546
self.assertEqual(expected_call, ret[0])
1547
if sys.version_info.major == 2:
1548
self.assertIsInstance(ret[0][0][-1],
1549
mock_dbus_python.ByteArray)
1551
def test_get_object_converts_to_correct_exception(self):
1552
bus = dbus_python_adapter.SystemBus(
1553
self.fake_dbus_python_raises_exception_on_connect)
1554
with self.assertRaises(dbus.ConnectFailed):
1555
self.call_method(bus, "methodname", "busname",
1556
"objectpath", "interface")
1558
class fake_dbus_python_raises_exception_on_connect(object):
1559
"""fake dbus-python module"""
1560
class exceptions(object):
1561
"""Pseudo-namespace"""
1562
class DBusException(Exception):
1567
def get_object(busname, objectpath):
1568
raise cls.exceptions.DBusException()
1569
Bus = collections.namedtuple("Bus", ["get_object"])
1570
return Bus(get_object=get_object)
1573
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1574
class mock_dbus_python(object):
1575
"""mock dbus-python modules"""
1576
class SystemBus(object):
1578
def get_object(busname, objectpath):
1582
self.bus = dbus_python_adapter.CachingBus(
1583
self.mock_dbus_python)
1585
def test_returns_distinct_objectpaths(self):
1586
obj1 = self.bus.get_object("busname", "objectpath1")
1587
self.assertIsInstance(obj1, Unique)
1588
obj2 = self.bus.get_object("busname", "objectpath2")
1589
self.assertIsInstance(obj2, Unique)
1590
self.assertIsNot(obj1, obj2)
1592
def test_returns_distinct_busnames(self):
1593
obj1 = self.bus.get_object("busname1", "objectpath")
1594
self.assertIsInstance(obj1, Unique)
1595
obj2 = self.bus.get_object("busname2", "objectpath")
1596
self.assertIsInstance(obj2, Unique)
1597
self.assertIsNot(obj1, obj2)
1599
def test_returns_distinct_both(self):
1600
obj1 = self.bus.get_object("busname1", "objectpath")
1601
self.assertIsInstance(obj1, Unique)
1602
obj2 = self.bus.get_object("busname2", "objectpath")
1603
self.assertIsInstance(obj2, Unique)
1604
self.assertIsNot(obj1, obj2)
1606
def test_returns_same(self):
1607
obj1 = self.bus.get_object("busname", "objectpath")
1608
self.assertIsInstance(obj1, Unique)
1609
obj2 = self.bus.get_object("busname", "objectpath")
1610
self.assertIsInstance(obj2, Unique)
1611
self.assertIs(obj1, obj2)
1613
def test_returns_same_old(self):
1614
obj1 = self.bus.get_object("busname1", "objectpath1")
1615
self.assertIsInstance(obj1, Unique)
1616
obj2 = self.bus.get_object("busname2", "objectpath2")
1617
self.assertIsInstance(obj2, Unique)
1618
obj1b = self.bus.get_object("busname1", "objectpath1")
1619
self.assertIsInstance(obj1b, Unique)
1620
self.assertIsNot(obj1, obj2)
1621
self.assertIsNot(obj2, obj1b)
1622
self.assertIs(obj1, obj1b)
1625
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1627
def Stub_pydbus_func(self, func):
1628
class stub_pydbus(object):
1629
"""stub pydbus module"""
1630
class SystemBus(object):
1632
def get(busname, objectpath):
1633
DBusObject = collections.namedtuple(
1634
"DBusObject", ("methodname",))
1635
return {"interface":
1636
DBusObject(methodname=func)}
1639
def call_method(self, bus, methodname, busname, objectpath,
1641
with self.assertLogs(log, logging.DEBUG):
1642
return bus.call_method(methodname, busname, objectpath,
1645
def test_call_method_returns(self):
1646
expected_method_return = Unique()
1647
method_args = (Unique(), Unique())
1649
self.assertEqual(len(method_args), len(args))
1650
for marg, arg in zip(method_args, args):
1651
self.assertIs(marg, arg)
1652
return expected_method_return
1653
stub_pydbus = self.Stub_pydbus_func(func)
1654
bus = pydbus_adapter.SystemBus(stub_pydbus)
1655
ret = self.call_method(bus, "methodname", "busname",
1656
"objectpath", "interface",
1658
self.assertIs(ret, expected_method_return)
1660
def test_call_method_handles_exception(self):
1661
dbus_logger = logging.getLogger("dbus.proxies")
1664
raise gi.repository.GLib.Error()
1666
stub_pydbus = self.Stub_pydbus_func(func)
1667
bus = pydbus_adapter.SystemBus(stub_pydbus)
1669
with self.assertRaises(dbus.Error) as e:
1670
self.call_method(bus, "methodname", "busname",
1671
"objectpath", "interface")
1673
self.assertNotIsInstance(e, dbus.ConnectFailed)
1675
def test_get_converts_to_correct_exception(self):
1676
bus = pydbus_adapter.SystemBus(
1677
self.fake_pydbus_raises_exception_on_connect)
1678
with self.assertRaises(dbus.ConnectFailed):
1679
self.call_method(bus, "methodname", "busname",
1680
"objectpath", "interface")
1682
class fake_pydbus_raises_exception_on_connect(object):
1683
"""fake dbus-python module"""
1686
def get(busname, objectpath):
1687
raise gi.repository.GLib.Error()
1688
Bus = collections.namedtuple("Bus", ["get"])
1691
def test_set_property_uses_setattr(self):
1692
class Object(object):
1695
class pydbus_spy(object):
1696
class SystemBus(object):
1698
def get(busname, objectpath):
1699
return {"interface": obj}
1700
bus = pydbus_adapter.SystemBus(pydbus_spy)
1702
bus.set_property("busname", "objectpath", "interface", "key",
1704
self.assertIs(value, obj.key)
1706
def test_get_suppresses_xml_deprecation_warning(self):
1707
if sys.version_info.major >= 3:
1709
class stub_pydbus_get(object):
1710
class SystemBus(object):
1712
def get(busname, objectpath):
1713
warnings.warn_explicit(
1714
"deprecated", DeprecationWarning,
1715
"xml.etree.ElementTree", 0)
1716
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1717
with warnings.catch_warnings(record=True) as w:
1718
warnings.simplefilter("always")
1719
bus.get("busname", "objectpath")
1720
self.assertEqual(0, len(w))
1723
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1724
class stub_pydbus(object):
1725
"""stub pydbus module"""
1726
class SystemBus(object):
1728
def get(busname, objectpath):
1732
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1734
def test_returns_distinct_objectpaths(self):
1735
obj1 = self.bus.get("busname", "objectpath1")
1736
self.assertIsInstance(obj1, Unique)
1737
obj2 = self.bus.get("busname", "objectpath2")
1738
self.assertIsInstance(obj2, Unique)
1739
self.assertIsNot(obj1, obj2)
1741
def test_returns_distinct_busnames(self):
1742
obj1 = self.bus.get("busname1", "objectpath")
1743
self.assertIsInstance(obj1, Unique)
1744
obj2 = self.bus.get("busname2", "objectpath")
1745
self.assertIsInstance(obj2, Unique)
1746
self.assertIsNot(obj1, obj2)
1748
def test_returns_distinct_both(self):
1749
obj1 = self.bus.get("busname1", "objectpath")
1750
self.assertIsInstance(obj1, Unique)
1751
obj2 = self.bus.get("busname2", "objectpath")
1752
self.assertIsInstance(obj2, Unique)
1753
self.assertIsNot(obj1, obj2)
1755
def test_returns_same(self):
1756
obj1 = self.bus.get("busname", "objectpath")
1757
self.assertIsInstance(obj1, Unique)
1758
obj2 = self.bus.get("busname", "objectpath")
1759
self.assertIsInstance(obj2, Unique)
1760
self.assertIs(obj1, obj2)
1762
def test_returns_same_old(self):
1763
obj1 = self.bus.get("busname1", "objectpath1")
1764
self.assertIsInstance(obj1, Unique)
1765
obj2 = self.bus.get("busname2", "objectpath2")
1766
self.assertIsInstance(obj2, Unique)
1767
obj1b = self.bus.get("busname1", "objectpath1")
1768
self.assertIsInstance(obj1b, Unique)
1769
self.assertIsNot(obj1, obj2)
1770
self.assertIsNot(obj2, obj1b)
1771
self.assertIs(obj1, obj1b)
1774
class Test_commands_from_options(unittest.TestCase):
1777
self.parser = argparse.ArgumentParser()
1778
add_command_line_options(self.parser)
1780
def test_is_enabled(self):
1781
self.assert_command_from_args(["--is-enabled", "client"],
1784
def assert_command_from_args(self, args, command_cls, length=1,
1785
clients=None, **cmd_attrs):
1786
"""Assert that parsing ARGS should result in an instance of
1787
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1788
options = self.parser.parse_args(args)
1789
check_option_syntax(self.parser, options)
1790
commands = commands_from_options(options)
1791
self.assertEqual(length, len(commands))
1792
for command in commands:
1793
if isinstance(command, command_cls):
1796
self.assertIsInstance(command, command_cls)
1797
if clients is not None:
1798
self.assertEqual(clients, options.client)
1799
for key, value in cmd_attrs.items():
1800
self.assertEqual(value, getattr(command, key))
1802
def assert_commands_from_args(self, args, commands, clients=None):
1803
for cmd in commands:
1804
self.assert_command_from_args(args, cmd,
1805
length=len(commands),
1808
def test_is_enabled_short(self):
1809
self.assert_command_from_args(["-V", "client"],
1812
def test_approve(self):
1813
self.assert_command_from_args(["--approve", "client"],
1816
def test_approve_short(self):
1817
self.assert_command_from_args(["-A", "client"],
1820
def test_deny(self):
1821
self.assert_command_from_args(["--deny", "client"],
1824
def test_deny_short(self):
1825
self.assert_command_from_args(["-D", "client"], command.Deny)
1827
def test_remove(self):
1828
self.assert_command_from_args(["--remove", "client"],
1831
def test_deny_before_remove(self):
1832
options = self.parser.parse_args(["--deny", "--remove",
1834
check_option_syntax(self.parser, options)
1835
commands = commands_from_options(options)
1836
self.assertEqual(2, len(commands))
1837
self.assertIsInstance(commands[0], command.Deny)
1838
self.assertIsInstance(commands[1], command.Remove)
1840
def test_deny_before_remove_reversed(self):
1841
options = self.parser.parse_args(["--remove", "--deny",
1843
check_option_syntax(self.parser, options)
1844
commands = commands_from_options(options)
1845
self.assertEqual(2, len(commands))
1846
self.assertIsInstance(commands[0], command.Deny)
1847
self.assertIsInstance(commands[1], command.Remove)
1849
def test_remove_short(self):
1850
self.assert_command_from_args(["-r", "client"],
1853
def test_dump_json(self):
1854
self.assert_command_from_args(["--dump-json"],
1857
def test_enable(self):
1858
self.assert_command_from_args(["--enable", "client"],
1861
def test_enable_short(self):
1862
self.assert_command_from_args(["-e", "client"],
1865
def test_disable(self):
1866
self.assert_command_from_args(["--disable", "client"],
1869
def test_disable_short(self):
1870
self.assert_command_from_args(["-d", "client"],
1873
def test_bump_timeout(self):
1874
self.assert_command_from_args(["--bump-timeout", "client"],
1875
command.BumpTimeout)
1877
def test_bump_timeout_short(self):
1878
self.assert_command_from_args(["-b", "client"],
1879
command.BumpTimeout)
1881
def test_start_checker(self):
1882
self.assert_command_from_args(["--start-checker", "client"],
1883
command.StartChecker)
1885
def test_stop_checker(self):
1886
self.assert_command_from_args(["--stop-checker", "client"],
1887
command.StopChecker)
1889
def test_approve_by_default(self):
1890
self.assert_command_from_args(["--approve-by-default",
1892
command.ApproveByDefault)
1894
def test_deny_by_default(self):
1895
self.assert_command_from_args(["--deny-by-default", "client"],
1896
command.DenyByDefault)
1898
def test_checker(self):
1899
self.assert_command_from_args(["--checker", ":", "client"],
1903
def test_checker_empty(self):
1904
self.assert_command_from_args(["--checker", "", "client"],
1908
def test_checker_short(self):
1909
self.assert_command_from_args(["-c", ":", "client"],
1913
def test_host(self):
1914
self.assert_command_from_args(
1915
["--host", "client.example.org", "client"],
1916
command.SetHost, value_to_set="client.example.org")
1918
def test_host_short(self):
1919
self.assert_command_from_args(
1920
["-H", "client.example.org", "client"], command.SetHost,
1921
value_to_set="client.example.org")
1923
def test_secret_devnull(self):
1924
self.assert_command_from_args(["--secret", os.path.devnull,
1925
"client"], command.SetSecret,
1928
def test_secret_tempfile(self):
1929
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1930
value = b"secret\0xyzzy\nbar"
1933
self.assert_command_from_args(["--secret", f.name,
1938
def test_secret_devnull_short(self):
1939
self.assert_command_from_args(["-s", os.path.devnull,
1940
"client"], command.SetSecret,
1943
def test_secret_tempfile_short(self):
1944
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1945
value = b"secret\0xyzzy\nbar"
1948
self.assert_command_from_args(["-s", f.name, "client"],
1952
def test_timeout(self):
1953
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1955
value_to_set=300000)
1957
def test_timeout_short(self):
1958
self.assert_command_from_args(["-t", "PT5M", "client"],
1960
value_to_set=300000)
1962
def test_extended_timeout(self):
1963
self.assert_command_from_args(["--extended-timeout", "PT15M",
1965
command.SetExtendedTimeout,
1966
value_to_set=900000)
1968
def test_interval(self):
1969
self.assert_command_from_args(["--interval", "PT2M",
1970
"client"], command.SetInterval,
1971
value_to_set=120000)
1973
def test_interval_short(self):
1974
self.assert_command_from_args(["-i", "PT2M", "client"],
1975
command.SetInterval,
1976
value_to_set=120000)
1978
def test_approval_delay(self):
1979
self.assert_command_from_args(["--approval-delay", "PT30S",
1981
command.SetApprovalDelay,
1984
def test_approval_duration(self):
1985
self.assert_command_from_args(["--approval-duration", "PT1S",
1987
command.SetApprovalDuration,
1990
def test_print_table(self):
1991
self.assert_command_from_args([], command.PrintTable,
1994
def test_print_table_verbose(self):
1995
self.assert_command_from_args(["--verbose"],
1999
def test_print_table_verbose_short(self):
2000
self.assert_command_from_args(["-v"], command.PrintTable,
2004
def test_manual_page_example_1(self):
2005
self.assert_command_from_args("",
2010
def test_manual_page_example_2(self):
2011
self.assert_command_from_args(
2012
"--verbose foo1.example.org foo2.example.org".split(),
2013
command.PrintTable, clients=["foo1.example.org",
2014
"foo2.example.org"],
2017
def test_manual_page_example_3(self):
2018
self.assert_command_from_args("--enable --all".split(),
2022
def test_manual_page_example_4(self):
2023
self.assert_commands_from_args(
2024
("--timeout=PT5M --interval=PT1M foo1.example.org"
2025
" foo2.example.org").split(),
2026
[command.SetTimeout, command.SetInterval],
2027
clients=["foo1.example.org", "foo2.example.org"])
2029
def test_manual_page_example_5(self):
2030
self.assert_command_from_args("--approve --all".split(),
2035
class TestCommand(unittest.TestCase):
785
log.removeFilter(warning_filter)
786
self.assertTrue(getattr(warning_filter, "found", False))
787
self.assertEqual(value, datetime.timedelta(0, 7200))
790
class TestCmd(unittest.TestCase):
2036
791
"""Abstract class for tests of command classes"""
2038
class FakeMandosBus(dbus.MandosBus):
2039
def __init__(self, testcase):
2040
self.client_properties = {
794
class MockClient(object):
795
def __init__(self, name, **attributes):
796
self.__dbus_object_path__ = "objpath_{}".format(name)
797
self.attributes = attributes
798
self.attributes["Name"] = name
800
def Set(self, interface, property, value, dbus_interface):
801
testcase.assertEqual(interface, client_interface)
802
testcase.assertEqual(dbus_interface,
803
dbus.PROPERTIES_IFACE)
804
self.attributes[property] = value
805
def Get(self, interface, property, dbus_interface):
806
testcase.assertEqual(interface, client_interface)
807
testcase.assertEqual(dbus_interface,
808
dbus.PROPERTIES_IFACE)
809
return self.attributes[property]
810
def Approve(self, approve, dbus_interface):
811
testcase.assertEqual(dbus_interface, client_interface)
812
self.calls.append(("Approve", (approve,
814
self.client = MockClient(
816
KeyID=("92ed150794387c03ce684574b1139a65"
817
"94a34f895daaaf09fd8ea90a27cddb12"),
819
Host="foo.example.org",
820
Enabled=dbus.Boolean(True),
822
LastCheckedOK="2019-02-03T00:00:00",
823
Created="2019-01-02T00:00:00",
825
Fingerprint=("778827225BA7DE539C5A"
826
"7CFA59CFF7CDBD9A5920"),
827
CheckerRunning=dbus.Boolean(False),
828
LastEnabled="2019-01-03T00:00:00",
829
ApprovalPending=dbus.Boolean(False),
830
ApprovedByDefault=dbus.Boolean(True),
831
LastApprovalRequest="",
833
ApprovalDuration=1000,
834
Checker="fping -q -- %(host)s",
835
ExtendedTimeout=900000,
836
Expires="2019-02-04T00:00:00",
838
self.other_client = MockClient(
840
KeyID=("0558568eedd67d622f5c83b35a115f79"
841
"6ab612cff5ad227247e46c2b020f441c"),
844
Enabled=dbus.Boolean(True),
846
LastCheckedOK="2019-02-04T00:00:00",
847
Created="2019-01-03T00:00:00",
849
Fingerprint=("3E393AEAEFB84C7E89E2"
850
"F547B3A107558FCA3A27"),
851
CheckerRunning=dbus.Boolean(True),
852
LastEnabled="2019-01-04T00:00:00",
853
ApprovalPending=dbus.Boolean(False),
854
ApprovedByDefault=dbus.Boolean(False),
855
LastApprovalRequest="2019-01-03T00:00:00",
857
ApprovalDuration=1000,
859
ExtendedTimeout=900000,
860
Expires="2019-02-05T00:00:00",
861
LastCheckerStatus=-2)
862
self.clients = collections.OrderedDict(
864
(self.client, self.client.attributes),
865
(self.other_client, self.other_client.attributes),
867
self.one_client = {self.client: self.client.attributes}
869
class TestPrintTableCmd(TestCmd):
870
def test_normal(self):
871
output = PrintTableCmd().output(self.clients)
872
expected_output = """
873
Name Enabled Timeout Last Successful Check
874
foo Yes 00:05:00 2019-02-03T00:00:00
875
barbar Yes 00:05:00 2019-02-04T00:00:00
877
self.assertEqual(output, expected_output)
878
def test_verbose(self):
879
output = PrintTableCmd(verbose=True).output(self.clients)
880
expected_output = """
881
Name Enabled Timeout Last Successful Check Created Interval Host Key ID Fingerprint Check Is Running Last Enabled Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker Extended Timeout Expires Last Checker Status
882
foo Yes 00:05:00 2019-02-03T00:00:00 2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No 2019-01-03T00:00:00 No Yes 00:00:00 00:00:01 fping -q -- %(host)s 00:15:00 2019-02-04T00:00:00 0
883
barbar Yes 00:05:00 2019-02-04T00:00:00 2019-01-03T00:00:00 00:02:00 192.0.2.3 0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes 2019-01-04T00:00:00 No No 2019-01-03T00:00:00 00:00:30 00:00:01 : 00:15:00 2019-02-05T00:00:00 -2
885
self.assertEqual(output, expected_output)
886
def test_one_client(self):
887
output = PrintTableCmd().output(self.one_client)
888
expected_output = """
889
Name Enabled Timeout Last Successful Check
890
foo Yes 00:05:00 2019-02-03T00:00:00
892
self.assertEqual(output, expected_output)
894
class TestDumpJSONCmd(TestCmd):
896
self.expected_json = {
2042
899
"KeyID": ("92ed150794387c03ce684574b1139a65"
2043
900
"94a34f895daaaf09fd8ea90a27cddb12"),
2044
"Secret": b"secret",
2045
901
"Host": "foo.example.org",
2046
902
"Enabled": True,
2047
903
"Timeout": 300000,
2081
936
"ApprovedByDefault": False,
2082
937
"LastApprovalRequest": "2019-01-03T00:00:00",
2083
938
"ApprovalDelay": 30000,
2084
"ApprovalDuration": 93785000,
939
"ApprovalDuration": 1000,
2086
941
"ExtendedTimeout": 900000,
2087
942
"Expires": "2019-02-05T00:00:00",
2088
943
"LastCheckerStatus": -2,
2090
self.clients = collections.OrderedDict(
2092
("client_objectpath", self.client_properties),
2093
("other_client_objectpath",
2094
self.other_client_properties),
2096
self.one_client = {"client_objectpath":
2097
self.client_properties}
2098
self.testcase = testcase
2101
def call_method(self, methodname, busname, objectpath,
2103
self.testcase.assertEqual("se.recompile.Mandos", busname)
2104
self.calls.append((methodname, busname, objectpath,
2106
if interface == "org.freedesktop.DBus.Properties":
2107
if methodname == "Set":
2108
self.testcase.assertEqual(3, len(args))
2109
interface, key, value = args
2110
self.testcase.assertEqual(
2111
"se.recompile.Mandos.Client", interface)
2112
self.clients[objectpath][key] = value
2114
elif interface == "se.recompile.Mandos":
2115
self.testcase.assertEqual("RemoveClient", methodname)
2116
self.testcase.assertEqual(1, len(args))
2117
clientpath = args[0]
2118
del self.clients[clientpath]
2120
elif interface == "se.recompile.Mandos.Client":
2121
if methodname == "Approve":
2122
self.testcase.assertEqual(1, len(args))
2127
self.bus = self.FakeMandosBus(self)
2130
class TestBaseCommands(TestCommand):
2132
def test_IsEnabled_exits_successfully(self):
946
return super(TestDumpJSONCmd, self).setUp()
947
def test_normal(self):
948
json_data = json.loads(DumpJSONCmd().output(self.clients))
949
self.assertDictEqual(json_data, self.expected_json)
950
def test_one_client(self):
951
clients = self.one_client
952
json_data = json.loads(DumpJSONCmd().output(clients))
953
expected_json = {"foo": self.expected_json["foo"]}
954
self.assertDictEqual(json_data, expected_json)
956
class TestIsEnabledCmd(TestCmd):
957
def test_is_enabled(self):
958
self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
959
for client, properties in self.clients.items()))
960
def test_is_enabled_run_exits_successfully(self):
2133
961
with self.assertRaises(SystemExit) as e:
2134
command.IsEnabled().run(self.bus.one_client)
962
IsEnabledCmd().run(None, self.one_client)
2135
963
if e.exception.code is not None:
2136
self.assertEqual(0, e.exception.code)
964
self.assertEqual(e.exception.code, 0)
2138
966
self.assertIsNone(e.exception.code)
2140
def test_IsEnabled_exits_with_failure(self):
2141
self.bus.client_properties["Enabled"] = False
967
def test_is_enabled_run_exits_with_failure(self):
968
self.client.attributes["Enabled"] = dbus.Boolean(False)
2142
969
with self.assertRaises(SystemExit) as e:
2143
command.IsEnabled().run(self.bus.one_client)
970
IsEnabledCmd().run(None, self.one_client)
2144
971
if isinstance(e.exception.code, int):
2145
self.assertNotEqual(0, e.exception.code)
972
self.assertNotEqual(e.exception.code, 0)
2147
974
self.assertIsNotNone(e.exception.code)
2149
def test_Approve(self):
2150
busname = "se.recompile.Mandos"
2151
client_interface = "se.recompile.Mandos.Client"
2152
command.Approve().run(self.bus.clients, self.bus)
2153
for clientpath in self.bus.clients:
2154
self.assertIn(("Approve", busname, clientpath,
2155
client_interface, (True,)), self.bus.calls)
2157
def test_Deny(self):
2158
busname = "se.recompile.Mandos"
2159
client_interface = "se.recompile.Mandos.Client"
2160
command.Deny().run(self.bus.clients, self.bus)
2161
for clientpath in self.bus.clients:
2162
self.assertIn(("Approve", busname, clientpath,
2163
client_interface, (False,)),
2166
def test_Remove(self):
2167
command.Remove().run(self.bus.clients, self.bus)
2168
for clientpath in self.bus.clients:
2169
self.assertIn(("RemoveClient", dbus_busname,
2170
dbus_server_path, dbus_server_interface,
2171
(clientpath,)), self.bus.calls)
2176
"KeyID": ("92ed150794387c03ce684574b1139a65"
2177
"94a34f895daaaf09fd8ea90a27cddb12"),
2178
"Host": "foo.example.org",
2181
"LastCheckedOK": "2019-02-03T00:00:00",
2182
"Created": "2019-01-02T00:00:00",
2184
"Fingerprint": ("778827225BA7DE539C5A"
2185
"7CFA59CFF7CDBD9A5920"),
2186
"CheckerRunning": False,
2187
"LastEnabled": "2019-01-03T00:00:00",
2188
"ApprovalPending": False,
2189
"ApprovedByDefault": True,
2190
"LastApprovalRequest": "",
2192
"ApprovalDuration": 1000,
2193
"Checker": "fping -q -- %(host)s",
2194
"ExtendedTimeout": 900000,
2195
"Expires": "2019-02-04T00:00:00",
2196
"LastCheckerStatus": 0,
2200
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2201
"6ab612cff5ad227247e46c2b020f441c"),
2202
"Host": "192.0.2.3",
2205
"LastCheckedOK": "2019-02-04T00:00:00",
2206
"Created": "2019-01-03T00:00:00",
2208
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2209
"F547B3A107558FCA3A27"),
2210
"CheckerRunning": True,
2211
"LastEnabled": "2019-01-04T00:00:00",
2212
"ApprovalPending": False,
2213
"ApprovedByDefault": False,
2214
"LastApprovalRequest": "2019-01-03T00:00:00",
2215
"ApprovalDelay": 30000,
2216
"ApprovalDuration": 93785000,
2218
"ExtendedTimeout": 900000,
2219
"Expires": "2019-02-05T00:00:00",
2220
"LastCheckerStatus": -2,
2224
def test_DumpJSON_normal(self):
2225
with self.capture_stdout_to_buffer() as buffer:
2226
command.DumpJSON().run(self.bus.clients)
2227
json_data = json.loads(buffer.getvalue())
2228
self.assertDictEqual(self.expected_json, json_data)
2231
@contextlib.contextmanager
2232
def capture_stdout_to_buffer():
2233
capture_buffer = io.StringIO()
2234
old_stdout = sys.stdout
2235
sys.stdout = capture_buffer
2237
yield capture_buffer
2239
sys.stdout = old_stdout
2241
def test_DumpJSON_one_client(self):
2242
with self.capture_stdout_to_buffer() as buffer:
2243
command.DumpJSON().run(self.bus.one_client)
2244
json_data = json.loads(buffer.getvalue())
2245
expected_json = {"foo": self.expected_json["foo"]}
2246
self.assertDictEqual(expected_json, json_data)
2248
def test_PrintTable_normal(self):
2249
with self.capture_stdout_to_buffer() as buffer:
2250
command.PrintTable().run(self.bus.clients)
2251
expected_output = "\n".join((
2252
"Name Enabled Timeout Last Successful Check",
2253
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2254
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
2256
self.assertEqual(expected_output, buffer.getvalue())
2258
def test_PrintTable_verbose(self):
2259
with self.capture_stdout_to_buffer() as buffer:
2260
command.PrintTable(verbose=True).run(self.bus.clients)
2275
"Last Successful Check ",
2276
"2019-02-03T00:00:00 ",
2277
"2019-02-04T00:00:00 ",
2280
"2019-01-02T00:00:00 ",
2281
"2019-01-03T00:00:00 ",
2293
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
2295
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
2299
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
2300
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
2302
"Check Is Running ",
2307
"2019-01-03T00:00:00 ",
2308
"2019-01-04T00:00:00 ",
2310
"Approval Is Pending ",
2314
"Approved By Default ",
2318
"Last Approval Request ",
2320
"2019-01-03T00:00:00 ",
2326
"Approval Duration ",
2331
"fping -q -- %(host)s ",
2334
"Extended Timeout ",
2339
"2019-02-04T00:00:00 ",
2340
"2019-02-05T00:00:00 ",
2342
"Last Checker Status",
2347
num_lines = max(len(rows) for rows in columns)
2348
expected_output = ("\n".join("".join(rows[line]
2349
for rows in columns)
2350
for line in range(num_lines))
2352
self.assertEqual(expected_output, buffer.getvalue())
2354
def test_PrintTable_one_client(self):
2355
with self.capture_stdout_to_buffer() as buffer:
2356
command.PrintTable().run(self.bus.one_client)
2357
expected_output = "\n".join((
2358
"Name Enabled Timeout Last Successful Check",
2359
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2361
self.assertEqual(expected_output, buffer.getvalue())
2364
class TestPropertySetterCmd(TestCommand):
2365
"""Abstract class for tests of command.PropertySetter classes"""
976
class TestRemoveCmd(TestCmd):
977
def test_remove(self):
978
class MockMandos(object):
981
def RemoveClient(self, dbus_path):
982
self.calls.append(("RemoveClient", (dbus_path,)))
983
mandos = MockMandos()
984
super(TestRemoveCmd, self).setUp()
985
RemoveCmd().run(mandos, self.clients)
986
self.assertEqual(len(mandos.calls), 2)
987
for client in self.clients:
988
self.assertIn(("RemoveClient",
989
(client.__dbus_object_path__,)),
992
class TestApproveCmd(TestCmd):
993
def test_approve(self):
994
ApproveCmd().run(None, self.clients)
995
for client in self.clients:
996
self.assertIn(("Approve", (True, client_interface)),
999
class TestDenyCmd(TestCmd):
1000
def test_deny(self):
1001
DenyCmd().run(None, self.clients)
1002
for client in self.clients:
1003
self.assertIn(("Approve", (False, client_interface)),
1006
class TestEnableCmd(TestCmd):
1007
def test_enable(self):
1008
for client in self.clients:
1009
client.attributes["Enabled"] = False
1011
EnableCmd().run(None, self.clients)
1013
for client in self.clients:
1014
self.assertTrue(client.attributes["Enabled"])
1016
class TestDisableCmd(TestCmd):
1017
def test_disable(self):
1018
DisableCmd().run(None, self.clients)
1020
for client in self.clients:
1021
self.assertFalse(client.attributes["Enabled"])
1023
class Unique(object):
1024
"""Class for objects which exist only to be unique objects, since
1025
unittest.mock.sentinel only exists in Python 3.3"""
1027
class TestPropertyCmd(TestCmd):
1028
"""Abstract class for tests of PropertyCmd classes"""
2367
1029
def runTest(self):
2368
1030
if not hasattr(self, "command"):
2369
return # Abstract TestCase class
2371
if hasattr(self, "values_to_set"):
2372
cmd_args = [(value,) for value in self.values_to_set]
2373
values_to_get = getattr(self, "values_to_get",
2376
cmd_args = [() for x in range(len(self.values_to_get))]
2377
values_to_get = self.values_to_get
2378
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2379
for clientpath in self.bus.clients:
2380
self.bus.clients[clientpath][self.propname] = (
2382
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2383
for clientpath in self.bus.clients:
2384
value = (self.bus.clients[clientpath]
1032
values_to_get = getattr(self, "values_to_get",
1034
for value_to_set, value_to_get in zip(self.values_to_set,
1036
for client in self.clients:
1037
old_value = client.attributes[self.property]
1038
self.assertNotIsInstance(old_value, Unique)
1039
client.attributes[self.property] = Unique()
1040
self.run_command(value_to_set, self.clients)
1041
for client in self.clients:
1042
value = client.attributes[self.property]
2386
1043
self.assertNotIsInstance(value, Unique)
2387
self.assertEqual(value_to_get, value)
2390
class TestEnableCmd(TestPropertySetterCmd):
2391
command = command.Enable
2392
propname = "Enabled"
2393
values_to_get = [True]
2396
class TestDisableCmd(TestPropertySetterCmd):
2397
command = command.Disable
2398
propname = "Enabled"
2399
values_to_get = [False]
2402
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2403
command = command.BumpTimeout
2404
propname = "LastCheckedOK"
2405
values_to_get = [""]
2408
class TestStartCheckerCmd(TestPropertySetterCmd):
2409
command = command.StartChecker
2410
propname = "CheckerRunning"
2411
values_to_get = [True]
2414
class TestStopCheckerCmd(TestPropertySetterCmd):
2415
command = command.StopChecker
2416
propname = "CheckerRunning"
2417
values_to_get = [False]
2420
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2421
command = command.ApproveByDefault
2422
propname = "ApprovedByDefault"
2423
values_to_get = [True]
2426
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2427
command = command.DenyByDefault
2428
propname = "ApprovedByDefault"
2429
values_to_get = [False]
2432
class TestSetCheckerCmd(TestPropertySetterCmd):
2433
command = command.SetChecker
2434
propname = "Checker"
1044
self.assertEqual(value, value_to_get)
1045
def run_command(self, value, clients):
1046
self.command().run(None, clients)
1048
class TestBumpTimeoutCmd(TestPropertyCmd):
1049
command = BumpTimeoutCmd
1050
property = "LastCheckedOK"
1051
values_to_set = [""]
1053
class TestStartCheckerCmd(TestPropertyCmd):
1054
command = StartCheckerCmd
1055
property = "CheckerRunning"
1056
values_to_set = [dbus.Boolean(True)]
1058
class TestStopCheckerCmd(TestPropertyCmd):
1059
command = StopCheckerCmd
1060
property = "CheckerRunning"
1061
values_to_set = [dbus.Boolean(False)]
1063
class TestApproveByDefaultCmd(TestPropertyCmd):
1064
command = ApproveByDefaultCmd
1065
property = "ApprovedByDefault"
1066
values_to_set = [dbus.Boolean(True)]
1068
class TestDenyByDefaultCmd(TestPropertyCmd):
1069
command = DenyByDefaultCmd
1070
property = "ApprovedByDefault"
1071
values_to_set = [dbus.Boolean(False)]
1073
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1074
"""Abstract class for tests of PropertyCmd classes using the
1075
ValueArgumentMixIn"""
1077
if type(self) is TestValueArgumentPropertyCmd:
1079
return super(TestValueArgumentPropertyCmd, self).runTest()
1080
def run_command(self, value, clients):
1081
self.command(value).run(None, clients)
1083
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1084
command = SetCheckerCmd
1085
property = "Checker"
2435
1086
values_to_set = ["", ":", "fping -q -- %s"]
2438
class TestSetHostCmd(TestPropertySetterCmd):
2439
command = command.SetHost
2441
values_to_set = ["192.0.2.3", "client.example.org"]
2444
class TestSetSecretCmd(TestPropertySetterCmd):
2445
command = command.SetSecret
2447
values_to_set = [io.BytesIO(b""),
1088
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1089
command = SetHostCmd
1091
values_to_set = ["192.0.2.3", "foo.example.org"]
1093
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1094
command = SetSecretCmd
1096
values_to_set = [open("/dev/null", "rb"),
2448
1097
io.BytesIO(b"secret\0xyzzy\nbar")]
2449
values_to_get = [f.getvalue() for f in values_to_set]
2452
class TestSetTimeoutCmd(TestPropertySetterCmd):
2453
command = command.SetTimeout
2454
propname = "Timeout"
2455
values_to_set = [datetime.timedelta(),
2456
datetime.timedelta(minutes=5),
2457
datetime.timedelta(seconds=1),
2458
datetime.timedelta(weeks=1),
2459
datetime.timedelta(weeks=52)]
2460
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2463
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2464
command = command.SetExtendedTimeout
2465
propname = "ExtendedTimeout"
2466
values_to_set = [datetime.timedelta(),
2467
datetime.timedelta(minutes=5),
2468
datetime.timedelta(seconds=1),
2469
datetime.timedelta(weeks=1),
2470
datetime.timedelta(weeks=52)]
2471
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2474
class TestSetIntervalCmd(TestPropertySetterCmd):
2475
command = command.SetInterval
2476
propname = "Interval"
2477
values_to_set = [datetime.timedelta(),
2478
datetime.timedelta(minutes=5),
2479
datetime.timedelta(seconds=1),
2480
datetime.timedelta(weeks=1),
2481
datetime.timedelta(weeks=52)]
2482
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2485
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2486
command = command.SetApprovalDelay
2487
propname = "ApprovalDelay"
2488
values_to_set = [datetime.timedelta(),
2489
datetime.timedelta(minutes=5),
2490
datetime.timedelta(seconds=1),
2491
datetime.timedelta(weeks=1),
2492
datetime.timedelta(weeks=52)]
2493
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2496
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2497
command = command.SetApprovalDuration
2498
propname = "ApprovalDuration"
2499
values_to_set = [datetime.timedelta(),
2500
datetime.timedelta(minutes=5),
2501
datetime.timedelta(seconds=1),
2502
datetime.timedelta(weeks=1),
2503
datetime.timedelta(weeks=52)]
2504
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1098
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1100
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1101
command = SetTimeoutCmd
1102
property = "Timeout"
1103
values_to_set = [datetime.timedelta(),
1104
datetime.timedelta(minutes=5),
1105
datetime.timedelta(seconds=1),
1106
datetime.timedelta(weeks=1),
1107
datetime.timedelta(weeks=52)]
1108
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1110
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1111
command = SetExtendedTimeoutCmd
1112
property = "ExtendedTimeout"
1113
values_to_set = [datetime.timedelta(),
1114
datetime.timedelta(minutes=5),
1115
datetime.timedelta(seconds=1),
1116
datetime.timedelta(weeks=1),
1117
datetime.timedelta(weeks=52)]
1118
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1120
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1121
command = SetIntervalCmd
1122
property = "Interval"
1123
values_to_set = [datetime.timedelta(),
1124
datetime.timedelta(minutes=5),
1125
datetime.timedelta(seconds=1),
1126
datetime.timedelta(weeks=1),
1127
datetime.timedelta(weeks=52)]
1128
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1130
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1131
command = SetApprovalDelayCmd
1132
property = "ApprovalDelay"
1133
values_to_set = [datetime.timedelta(),
1134
datetime.timedelta(minutes=5),
1135
datetime.timedelta(seconds=1),
1136
datetime.timedelta(weeks=1),
1137
datetime.timedelta(weeks=52)]
1138
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1140
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1141
command = SetApprovalDurationCmd
1142
property = "ApprovalDuration"
1143
values_to_set = [datetime.timedelta(),
1144
datetime.timedelta(minutes=5),
1145
datetime.timedelta(seconds=1),
1146
datetime.timedelta(weeks=1),
1147
datetime.timedelta(weeks=52)]
1148
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1150
class Test_command_from_options(unittest.TestCase):
1152
self.parser = argparse.ArgumentParser()
1153
add_command_line_options(self.parser)
1154
def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1155
"""Assert that parsing ARGS should result in an instance of
1156
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1157
options = self.parser.parse_args(args)
1158
commands = commands_from_options(options)
1159
self.assertEqual(len(commands), 1)
1160
command = commands[0]
1161
self.assertIsInstance(command, command_cls)
1162
for key, value in cmd_attrs.items():
1163
self.assertEqual(getattr(command, key), value)
1164
def test_print_table(self):
1165
self.assert_command_from_args([], PrintTableCmd,
1168
def test_print_table_verbose(self):
1169
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1172
def test_print_table_verbose_short(self):
1173
self.assert_command_from_args(["-v"], PrintTableCmd,
1176
def test_enable(self):
1177
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1179
def test_enable_short(self):
1180
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1182
def test_disable(self):
1183
self.assert_command_from_args(["--disable", "foo"],
1186
def test_disable_short(self):
1187
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1189
def test_bump_timeout(self):
1190
self.assert_command_from_args(["--bump-timeout", "foo"],
1193
def test_bump_timeout_short(self):
1194
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1196
def test_start_checker(self):
1197
self.assert_command_from_args(["--start-checker", "foo"],
1200
def test_stop_checker(self):
1201
self.assert_command_from_args(["--stop-checker", "foo"],
1204
def test_remove(self):
1205
self.assert_command_from_args(["--remove", "foo"],
1208
def test_remove_short(self):
1209
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1211
def test_checker(self):
1212
self.assert_command_from_args(["--checker", ":", "foo"],
1213
SetCheckerCmd, value_to_set=":")
1215
def test_checker_empty(self):
1216
self.assert_command_from_args(["--checker", "", "foo"],
1217
SetCheckerCmd, value_to_set="")
1219
def test_checker_short(self):
1220
self.assert_command_from_args(["-c", ":", "foo"],
1221
SetCheckerCmd, value_to_set=":")
1223
def test_timeout(self):
1224
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1226
value_to_set=300000)
1228
def test_timeout_short(self):
1229
self.assert_command_from_args(["-t", "PT5M", "foo"],
1231
value_to_set=300000)
1233
def test_extended_timeout(self):
1234
self.assert_command_from_args(["--extended-timeout", "PT15M",
1236
SetExtendedTimeoutCmd,
1237
value_to_set=900000)
1239
def test_interval(self):
1240
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1242
value_to_set=120000)
1244
def test_interval_short(self):
1245
self.assert_command_from_args(["-i", "PT2M", "foo"],
1247
value_to_set=120000)
1249
def test_approve_by_default(self):
1250
self.assert_command_from_args(["--approve-by-default", "foo"],
1251
ApproveByDefaultCmd)
1253
def test_deny_by_default(self):
1254
self.assert_command_from_args(["--deny-by-default", "foo"],
1257
def test_approval_delay(self):
1258
self.assert_command_from_args(["--approval-delay", "PT30S",
1259
"foo"], SetApprovalDelayCmd,
1262
def test_approval_duration(self):
1263
self.assert_command_from_args(["--approval-duration", "PT1S",
1264
"foo"], SetApprovalDurationCmd,
1267
def test_host(self):
1268
self.assert_command_from_args(["--host", "foo.example.org",
1270
value_to_set="foo.example.org")
1272
def test_host_short(self):
1273
self.assert_command_from_args(["-H", "foo.example.org",
1275
value_to_set="foo.example.org")
1277
def test_secret_devnull(self):
1278
self.assert_command_from_args(["--secret", os.path.devnull,
1279
"foo"], SetSecretCmd,
1282
def test_secret_tempfile(self):
1283
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1284
value = b"secret\0xyzzy\nbar"
1287
self.assert_command_from_args(["--secret", f.name,
1288
"foo"], SetSecretCmd,
1291
def test_secret_devnull_short(self):
1292
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1293
SetSecretCmd, value_to_set=b"")
1295
def test_secret_tempfile_short(self):
1296
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1297
value = b"secret\0xyzzy\nbar"
1300
self.assert_command_from_args(["-s", f.name, "foo"],
1304
def test_approve(self):
1305
self.assert_command_from_args(["--approve", "foo"],
1308
def test_approve_short(self):
1309
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1311
def test_deny(self):
1312
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1314
def test_deny_short(self):
1315
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1317
def test_dump_json(self):
1318
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1320
def test_is_enabled(self):
1321
self.assert_command_from_args(["--is-enabled", "foo"],
1324
def test_is_enabled_short(self):
1325
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)