139
139
help="Select all clients")
140
140
parser.add_argument("-v", "--verbose", action="store_true",
141
141
help="Print all fields")
142
parser.add_argument("-j", "--dump-json", dest="commands",
143
action="append_const", default=[],
144
const=command.DumpJSON(),
142
parser.add_argument("-j", "--dump-json", action="store_true",
145
143
help="Dump client data in JSON format")
146
144
enable_disable = parser.add_mutually_exclusive_group()
147
enable_disable.add_argument("-e", "--enable", dest="commands",
148
action="append_const", default=[],
149
const=command.Enable(),
145
enable_disable.add_argument("-e", "--enable", action="store_true",
150
146
help="Enable client")
151
enable_disable.add_argument("-d", "--disable", dest="commands",
152
action="append_const", default=[],
153
const=command.Disable(),
147
enable_disable.add_argument("-d", "--disable",
154
149
help="disable client")
155
parser.add_argument("-b", "--bump-timeout", dest="commands",
156
action="append_const", default=[],
157
const=command.BumpTimeout(),
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
158
151
help="Bump timeout for client")
159
152
start_stop_checker = parser.add_mutually_exclusive_group()
160
153
start_stop_checker.add_argument("--start-checker",
162
action="append_const", default=[],
163
const=command.StartChecker(),
164
155
help="Start checker for client")
165
start_stop_checker.add_argument("--stop-checker", dest="commands",
166
action="append_const", default=[],
167
const=command.StopChecker(),
156
start_stop_checker.add_argument("--stop-checker",
168
158
help="Stop checker for client")
169
parser.add_argument("-V", "--is-enabled", dest="commands",
170
action="append_const", default=[],
171
const=command.IsEnabled(),
159
parser.add_argument("-V", "--is-enabled", action="store_true",
172
160
help="Check if client is enabled")
173
parser.add_argument("-r", "--remove", dest="commands",
174
action="append_const", default=[],
175
const=command.Remove(),
161
parser.add_argument("-r", "--remove", action="store_true",
176
162
help="Remove client")
177
parser.add_argument("-c", "--checker", dest="commands",
178
action="append", default=[],
179
metavar="COMMAND", type=command.SetChecker,
163
parser.add_argument("-c", "--checker",
180
164
help="Set checker command for client")
182
"-t", "--timeout", dest="commands", action="append",
183
default=[], metavar="TIME",
184
type=command.SetTimeout.argparse(string_to_delta),
185
help="Set timeout for client")
187
"--extended-timeout", dest="commands", action="append",
188
default=[], metavar="TIME",
189
type=command.SetExtendedTimeout.argparse(string_to_delta),
190
help="Set extended timeout for client")
192
"-i", "--interval", dest="commands", action="append",
193
default=[], metavar="TIME",
194
type=command.SetInterval.argparse(string_to_delta),
195
help="Set checker interval for client")
165
parser.add_argument("-t", "--timeout", type=string_to_delta,
166
help="Set timeout for client")
167
parser.add_argument("--extended-timeout", type=string_to_delta,
168
help="Set extended timeout for client")
169
parser.add_argument("-i", "--interval", type=string_to_delta,
170
help="Set checker interval for client")
196
171
approve_deny_default = parser.add_mutually_exclusive_group()
197
172
approve_deny_default.add_argument(
198
"--approve-by-default", dest="commands",
199
action="append_const", default=[],
200
const=command.ApproveByDefault(),
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
201
175
help="Set client to be approved by default")
202
176
approve_deny_default.add_argument(
203
"--deny-by-default", dest="commands",
204
action="append_const", default=[],
205
const=command.DenyByDefault(),
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
206
179
help="Set client to be denied by default")
208
"--approval-delay", dest="commands", action="append",
209
default=[], metavar="TIME",
210
type=command.SetApprovalDelay.argparse(string_to_delta),
211
help="Set delay before client approve/deny")
213
"--approval-duration", dest="commands", action="append",
214
default=[], metavar="TIME",
215
type=command.SetApprovalDuration.argparse(string_to_delta),
216
help="Set duration of one client approval")
217
parser.add_argument("-H", "--host", dest="commands",
218
action="append", default=[], metavar="STRING",
219
type=command.SetHost,
220
help="Set host for client")
222
"-s", "--secret", dest="commands", action="append",
223
default=[], metavar="FILENAME",
224
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
225
help="Set password blob (file) for client")
180
parser.add_argument("--approval-delay", type=string_to_delta,
181
help="Set delay before client approve/deny")
182
parser.add_argument("--approval-duration", type=string_to_delta,
183
help="Set duration of one client approval")
184
parser.add_argument("-H", "--host", help="Set host for client")
185
parser.add_argument("-s", "--secret",
186
type=argparse.FileType(mode="rb"),
187
help="Set password blob (file) for client")
226
188
approve_deny = parser.add_mutually_exclusive_group()
227
189
approve_deny.add_argument(
228
"-A", "--approve", dest="commands", action="append_const",
229
default=[], const=command.Approve(),
190
"-A", "--approve", action="store_true",
230
191
help="Approve any current client request")
231
approve_deny.add_argument("-D", "--deny", dest="commands",
232
action="append_const", default=[],
233
const=command.Deny(),
192
approve_deny.add_argument("-D", "--deny", action="store_true",
234
193
help="Deny any current client request")
235
194
parser.add_argument("--debug", action="store_true",
236
195
help="Debug mode (show D-Bus commands)")
428
386
"""Apply additional restrictions on options, not expressible in
431
def has_commands(options, commands=None):
433
commands = (command.Enable,
436
command.StartChecker,
442
command.SetExtendedTimeout,
444
command.ApproveByDefault,
445
command.DenyByDefault,
446
command.SetApprovalDelay,
447
command.SetApprovalDuration,
452
return any(isinstance(cmd, commands)
453
for cmd in options.commands)
389
def has_actions(options):
390
return any((options.enable,
392
options.bump_timeout,
393
options.start_checker,
394
options.stop_checker,
397
options.checker is not None,
398
options.timeout is not None,
399
options.extended_timeout is not None,
400
options.interval is not None,
401
options.approved_by_default is not None,
402
options.approval_delay is not None,
403
options.approval_duration is not None,
404
options.host is not None,
405
options.secret is not None,
455
if has_commands(options) and not (options.client or options.all):
409
if has_actions(options) and not (options.client or options.all):
456
410
parser.error("Options require clients names or --all.")
457
if options.verbose and has_commands(options):
411
if options.verbose and has_actions(options):
458
412
parser.error("--verbose can only be used alone.")
459
if (has_commands(options, (command.DumpJSON,))
460
and (options.verbose or len(options.commands) > 1)):
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
461
415
parser.error("--dump-json can only be used alone.")
462
if options.all and not has_commands(options):
416
if options.all and not has_actions(options):
463
417
parser.error("--all requires an action.")
464
if (has_commands(options, (command.IsEnabled,))
465
and len(options.client) > 1):
418
if options.is_enabled and len(options.client) > 1:
466
419
parser.error("--is-enabled requires exactly one client")
467
if (len(options.commands) > 1
468
and has_commands(options, (command.Remove,))
469
and not has_commands(options, (command.Deny,))):
470
parser.error("--remove can only be combined with --deny")
477
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
478
def get_managed_objects(self, busname, objectpath):
479
return self.call_method("GetManagedObjects", busname,
481
self.object_manager_iface)
483
properties_iface = "org.freedesktop.DBus.Properties"
484
def set_property(self, busname, objectpath, interface, key,
486
self.call_method("Set", busname, objectpath,
487
self.properties_iface, interface, key,
491
class MandosBus(SystemBus):
492
busname_domain = "se.recompile"
493
busname = busname_domain + ".Mandos"
495
server_interface = busname_domain + ".Mandos"
496
client_interface = busname_domain + ".Mandos.Client"
499
def get_clients_and_properties(self):
500
managed_objects = self.get_managed_objects(
501
self.busname, self.server_path)
502
return {objpath: properties[self.client_interface]
503
for objpath, properties in managed_objects.items()
504
if self.client_interface in properties}
506
def set_client_property(self, objectpath, key, value):
507
return self.set_property(self.busname, objectpath,
508
self.client_interface, key,
511
def call_client_method(self, objectpath, method, *args):
512
return self.call_method(method, self.busname, objectpath,
513
self.client_interface, *args)
515
def call_server_method(self, method, *args):
516
return self.call_method(method, self.busname,
518
self.server_interface, *args)
520
class Error(Exception):
523
class ConnectFailed(Error):
527
class dbus_python_adapter:
529
class SystemBus(dbus.MandosBus):
530
"""Use dbus-python"""
532
def __init__(self, module=dbus_python):
533
self.dbus_python = module
534
self.bus = self.dbus_python.SystemBus()
536
@contextlib.contextmanager
537
def convert_exception(self, exception_class=dbus.Error):
540
except self.dbus_python.exceptions.DBusException as e:
541
# This does what "raise from" would do
542
exc = exception_class(*e.args)
546
def call_method(self, methodname, busname, objectpath,
548
proxy_object = self.get_object(busname, objectpath)
549
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
550
interface, methodname,
551
", ".join(repr(a) for a in args))
552
method = getattr(proxy_object, methodname)
553
with self.convert_exception():
554
with dbus_python_adapter.SilenceLogger(
556
value = method(*args, dbus_interface=interface)
557
return self.type_filter(value)
559
def get_object(self, busname, objectpath):
560
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
562
with self.convert_exception(dbus.ConnectFailed):
563
return self.bus.get_object(busname, objectpath)
565
def type_filter(self, value):
566
"""Convert the most bothersome types to Python types"""
567
if isinstance(value, self.dbus_python.Boolean):
569
if isinstance(value, self.dbus_python.ObjectPath):
571
# Also recurse into dictionaries
572
if isinstance(value, self.dbus_python.Dictionary):
573
return {self.type_filter(key):
574
self.type_filter(subval)
575
for key, subval in value.items()}
578
def set_client_property(self, objectpath, key, value):
580
if not isinstance(value, bytes):
581
value = value.encode("utf-8")
582
value = self.dbus_python.ByteArray(value)
583
return self.set_property(self.busname, objectpath,
584
self.client_interface, key,
588
"Simple context manager to silence a particular logger"
589
def __init__(self, loggername):
590
self.logger = logging.getLogger(loggername)
593
self.logger.addFilter(self.nullfilter)
595
class NullFilter(logging.Filter):
596
def filter(self, record):
599
nullfilter = NullFilter()
601
def __exit__(self, exc_type, exc_val, exc_tb):
602
self.logger.removeFilter(self.nullfilter)
605
class CachingBus(SystemBus):
606
"""A caching layer for dbus_python_adapter.SystemBus"""
607
def __init__(self, *args, **kwargs):
608
self.object_cache = {}
609
super(dbus_python_adapter.CachingBus,
610
self).__init__(*args, **kwargs)
611
def get_object(self, busname, objectpath):
613
return self.object_cache[(busname, objectpath)]
616
dbus_python_adapter.CachingBus,
617
self).get_object(busname, objectpath)
618
self.object_cache[(busname, objectpath)] = new_object
622
class pydbus_adapter:
623
class SystemBus(dbus.MandosBus):
624
def __init__(self, module=pydbus):
626
self.bus = self.pydbus.SystemBus()
628
@contextlib.contextmanager
629
def convert_exception(self, exception_class=dbus.Error):
632
except gi.repository.GLib.Error as e:
633
# This does what "raise from" would do
634
exc = exception_class(*e.args)
638
def call_method(self, methodname, busname, objectpath,
640
proxy_object = self.get(busname, objectpath)
641
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
642
interface, methodname,
643
", ".join(repr(a) for a in args))
644
method = getattr(proxy_object[interface], methodname)
645
with self.convert_exception():
648
def get(self, busname, objectpath):
649
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
651
with self.convert_exception(dbus.ConnectFailed):
652
if sys.version_info.major <= 2:
653
with warnings.catch_warnings():
654
warnings.filterwarnings(
655
"ignore", "", DeprecationWarning,
656
r"^xml\.etree\.ElementTree$")
657
return self.bus.get(busname, objectpath)
659
return self.bus.get(busname, objectpath)
661
def set_property(self, busname, objectpath, interface, key,
663
proxy_object = self.get(busname, objectpath)
664
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
665
objectpath, self.properties_iface, interface,
667
setattr(proxy_object[interface], key, value)
669
class CachingBus(SystemBus):
670
"""A caching layer for pydbus_adapter.SystemBus"""
671
def __init__(self, *args, **kwargs):
672
self.object_cache = {}
673
super(pydbus_adapter.CachingBus,
674
self).__init__(*args, **kwargs)
675
def get(self, busname, objectpath):
677
return self.object_cache[(busname, objectpath)]
679
new_object = (super(pydbus_adapter.CachingBus, self)
680
.get(busname, objectpath))
681
self.object_cache[(busname, objectpath)] = new_object
421
options.remove = False
422
if has_actions(options) and not options.deny:
423
parser.error("--remove can only be combined with --deny")
424
options.remove = True
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
434
return mandos_dbus_object
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
462
self.logger.addFilter(self.nullfilter)
465
class NullFilter(logging.Filter):
466
def filter(self, record):
469
nullfilter = NullFilter()
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
685
475
def commands_from_options(options):
687
commands = list(options.commands)
689
def find_cmd(cmd, commands):
691
for i, c in enumerate(commands):
692
if isinstance(c, cmd):
696
# If command.Remove is present, move any instances of command.Deny
697
# to occur ahead of command.Remove.
698
index_of_remove = find_cmd(command.Remove, commands)
699
before_remove = commands[:index_of_remove]
700
after_remove = commands[index_of_remove:]
702
for cmd in after_remove:
703
if isinstance(cmd, command.Deny):
704
before_remove.append(cmd)
479
if options.is_enabled:
480
commands.append(IsEnabledCmd())
483
commands.append(ApproveCmd())
486
commands.append(DenyCmd())
489
commands.append(RemoveCmd())
491
if options.dump_json:
492
commands.append(DumpJSONCmd())
495
commands.append(EnableCmd())
498
commands.append(DisableCmd())
500
if options.bump_timeout:
501
commands.append(BumpTimeoutCmd())
503
if options.start_checker:
504
commands.append(StartCheckerCmd())
506
if options.stop_checker:
507
commands.append(StopCheckerCmd())
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(ApproveByDefaultCmd())
706
cleaned_after.append(cmd)
707
if cleaned_after != after_remove:
708
commands = before_remove + cleaned_after
513
commands.append(DenyByDefaultCmd())
515
if options.checker is not None:
516
commands.append(SetCheckerCmd(options.checker))
518
if options.host is not None:
519
commands.append(SetHostCmd(options.host))
521
if options.secret is not None:
522
commands.append(SetSecretCmd(options.secret))
524
if options.timeout is not None:
525
commands.append(SetTimeoutCmd(options.timeout))
527
if options.extended_timeout:
529
SetExtendedTimeoutCmd(options.extended_timeout))
531
if options.interval is not None:
532
commands.append(SetIntervalCmd(options.interval))
534
if options.approval_delay is not None:
535
commands.append(SetApprovalDelayCmd(options.approval_delay))
537
if options.approval_duration is not None:
539
SetApprovalDurationCmd(options.approval_duration))
710
541
# If no command option has been given, show table of clients,
711
542
# optionally verbosely
713
commands.append(command.PrintTable(verbose=options.verbose))
544
commands.append(PrintTableCmd(verbose=options.verbose))
719
"""A namespace for command classes"""
722
"""Abstract base class for commands"""
723
def run(self, clients, bus=None):
724
"""Normal commands should implement run_on_one_client(),
725
but commands which want to operate on all clients at the same time can
726
override this run() method instead.
729
for client, properties in clients.items():
730
self.run_on_one_client(client, properties)
733
class IsEnabled(Base):
734
def run(self, clients, bus=None):
735
properties = next(iter(clients.values()))
736
if properties["Enabled"]:
742
def run_on_one_client(self, client, properties):
743
self.bus.call_client_method(client, "Approve", True)
747
def run_on_one_client(self, client, properties):
748
self.bus.call_client_method(client, "Approve", False)
752
def run(self, clients, bus):
753
for clientpath in frozenset(clients.keys()):
754
bus.call_server_method("RemoveClient", clientpath)
758
"""Abstract class for commands outputting client details"""
759
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
760
"Created", "Interval", "Host", "KeyID",
761
"Fingerprint", "CheckerRunning",
762
"LastEnabled", "ApprovalPending",
763
"ApprovedByDefault", "LastApprovalRequest",
764
"ApprovalDelay", "ApprovalDuration",
765
"Checker", "ExtendedTimeout", "Expires",
769
class DumpJSON(Output):
770
def run(self, clients, bus=None):
771
data = {properties["Name"]:
772
{key: properties[key]
773
for key in self.all_keywords}
774
for properties in clients.values()}
775
print(json.dumps(data, indent=4, separators=(',', ': ')))
778
class PrintTable(Output):
779
def __init__(self, verbose=False):
780
self.verbose = verbose
782
def run(self, clients, bus=None):
783
default_keywords = ("Name", "Enabled", "Timeout",
785
keywords = default_keywords
787
keywords = self.all_keywords
788
print(self.TableOfClients(clients.values(), keywords))
790
class TableOfClients:
793
"Enabled": "Enabled",
794
"Timeout": "Timeout",
795
"LastCheckedOK": "Last Successful Check",
796
"LastApprovalRequest": "Last Approval Request",
797
"Created": "Created",
798
"Interval": "Interval",
800
"Fingerprint": "Fingerprint",
802
"CheckerRunning": "Check Is Running",
803
"LastEnabled": "Last Enabled",
804
"ApprovalPending": "Approval Is Pending",
805
"ApprovedByDefault": "Approved By Default",
806
"ApprovalDelay": "Approval Delay",
807
"ApprovalDuration": "Approval Duration",
808
"Checker": "Checker",
809
"ExtendedTimeout": "Extended Timeout",
810
"Expires": "Expires",
811
"LastCheckerStatus": "Last Checker Status",
814
def __init__(self, clients, keywords):
815
self.clients = clients
816
self.keywords = keywords
549
class Command(object):
550
"""Abstract class for commands"""
551
def run(self, clients, bus=None, mandos=None):
552
"""Normal commands should implement run_on_one_client(), but
553
commands which want to operate on all clients at the same time
554
can override this run() method instead."""
556
for clientpath, properties in clients.items():
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
dbus_busname, str(clientpath))
559
client = bus.get_object(dbus_busname, clientpath)
560
self.run_on_one_client(client, properties)
563
class IsEnabledCmd(Command):
564
def run(self, clients, bus=None, mandos=None):
565
client, properties = next(iter(clients.items()))
566
if self.is_enabled(client, properties):
569
def is_enabled(self, client, properties):
570
return properties["Enabled"]
573
class ApproveCmd(Command):
574
def run_on_one_client(self, client, properties):
575
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
576
client.__dbus_object_path__, client_dbus_interface)
577
client.Approve(dbus.Boolean(True),
578
dbus_interface=client_dbus_interface)
581
class DenyCmd(Command):
582
def run_on_one_client(self, client, properties):
583
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
584
client.__dbus_object_path__, client_dbus_interface)
585
client.Approve(dbus.Boolean(False),
586
dbus_interface=client_dbus_interface)
589
class RemoveCmd(Command):
590
def run_on_one_client(self, client, properties):
591
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
592
server_dbus_path, server_dbus_interface,
593
str(client.__dbus_object_path__))
594
self.mandos.RemoveClient(client.__dbus_object_path__)
597
class OutputCmd(Command):
598
"""Abstract class for commands outputting client details"""
599
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
600
"Created", "Interval", "Host", "KeyID",
601
"Fingerprint", "CheckerRunning", "LastEnabled",
602
"ApprovalPending", "ApprovedByDefault",
603
"LastApprovalRequest", "ApprovalDelay",
604
"ApprovalDuration", "Checker", "ExtendedTimeout",
605
"Expires", "LastCheckerStatus")
607
def run(self, clients, bus=None, mandos=None):
608
print(self.output(clients.values()))
610
def output(self, clients):
611
raise NotImplementedError()
614
class DumpJSONCmd(OutputCmd):
615
def output(self, clients):
616
data = {client["Name"]:
617
{key: self.dbus_boolean_to_bool(client[key])
618
for key in self.all_keywords}
619
for client in clients}
620
return json.dumps(data, indent=4, separators=(',', ': '))
623
def dbus_boolean_to_bool(value):
624
if isinstance(value, dbus.Boolean):
629
class PrintTableCmd(OutputCmd):
630
def __init__(self, verbose=False):
631
self.verbose = verbose
633
def output(self, clients):
634
default_keywords = ("Name", "Enabled", "Timeout",
636
keywords = default_keywords
638
keywords = self.all_keywords
639
return str(self.TableOfClients(clients, keywords))
641
class TableOfClients(object):
644
"Enabled": "Enabled",
645
"Timeout": "Timeout",
646
"LastCheckedOK": "Last Successful Check",
647
"LastApprovalRequest": "Last Approval Request",
648
"Created": "Created",
649
"Interval": "Interval",
651
"Fingerprint": "Fingerprint",
653
"CheckerRunning": "Check Is Running",
654
"LastEnabled": "Last Enabled",
655
"ApprovalPending": "Approval Is Pending",
656
"ApprovedByDefault": "Approved By Default",
657
"ApprovalDelay": "Approval Delay",
658
"ApprovalDuration": "Approval Duration",
659
"Checker": "Checker",
660
"ExtendedTimeout": "Extended Timeout",
661
"Expires": "Expires",
662
"LastCheckerStatus": "Last Checker Status",
665
def __init__(self, clients, keywords):
666
self.clients = clients
667
self.keywords = keywords
670
return "\n".join(self.rows())
672
if sys.version_info.major == 2:
673
__unicode__ = __str__
818
674
def __str__(self):
819
return "\n".join(self.rows())
821
if sys.version_info.major == 2:
822
__unicode__ = __str__
824
return str(self).encode(
825
locale.getpreferredencoding())
828
format_string = self.row_formatting_string()
829
rows = [self.header_line(format_string)]
830
rows.extend(self.client_line(client, format_string)
831
for client in self.clients)
834
def row_formatting_string(self):
835
"Format string used to format table rows"
836
return " ".join("{{{key}:{width}}}".format(
837
width=max(len(self.tableheaders[key]),
838
*(len(self.string_from_client(client,
840
for client in self.clients)),
842
for key in self.keywords)
844
def string_from_client(self, client, key):
845
return self.valuetostring(client[key], key)
848
def valuetostring(cls, value, keyword):
849
if isinstance(value, bool):
850
return "Yes" if value else "No"
851
if keyword in ("Timeout", "Interval", "ApprovalDelay",
852
"ApprovalDuration", "ExtendedTimeout"):
853
return cls.milliseconds_to_string(value)
856
def header_line(self, format_string):
857
return format_string.format(**self.tableheaders)
859
def client_line(self, client, format_string):
860
return format_string.format(
861
**{key: self.string_from_client(client, key)
862
for key in self.keywords})
865
def milliseconds_to_string(ms):
866
td = datetime.timedelta(0, 0, 0, ms)
867
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
868
.format(days="{}T".format(td.days)
870
hours=td.seconds // 3600,
871
minutes=(td.seconds % 3600) // 60,
872
seconds=td.seconds % 60))
875
class PropertySetter(Base):
876
"Abstract class for Actions for setting one client property"
878
def run_on_one_client(self, client, properties=None):
879
"""Set the Client's D-Bus property"""
880
self.bus.set_client_property(client, self.propname,
885
raise NotImplementedError()
888
class Enable(PropertySetter):
893
class Disable(PropertySetter):
898
class BumpTimeout(PropertySetter):
899
propname = "LastCheckedOK"
903
class StartChecker(PropertySetter):
904
propname = "CheckerRunning"
908
class StopChecker(PropertySetter):
909
propname = "CheckerRunning"
913
class ApproveByDefault(PropertySetter):
914
propname = "ApprovedByDefault"
918
class DenyByDefault(PropertySetter):
919
propname = "ApprovedByDefault"
923
class PropertySetterValue(PropertySetter):
924
"""Abstract class for PropertySetter recieving a value as
925
constructor argument instead of a class attribute."""
926
def __init__(self, value):
927
self.value_to_set = value
675
return str(self).encode(locale.getpreferredencoding())
678
format_string = self.row_formatting_string()
679
rows = [self.header_line(format_string)]
680
rows.extend(self.client_line(client, format_string)
681
for client in self.clients)
684
def row_formatting_string(self):
685
"Format string used to format table rows"
686
return " ".join("{{{key}:{width}}}".format(
687
width=max(len(self.tableheaders[key]),
688
*(len(self.string_from_client(client, key))
689
for client in self.clients)),
691
for key in self.keywords)
693
def string_from_client(self, client, key):
694
return self.valuetostring(client[key], key)
930
def argparse(cls, argtype):
932
return cls(argtype(arg))
935
class SetChecker(PropertySetterValue):
939
class SetHost(PropertySetterValue):
943
class SetSecret(PropertySetterValue):
947
def value_to_set(self):
951
def value_to_set(self, value):
952
"""When setting, read data from supplied file object"""
953
self._vts = value.read()
957
class PropertySetterValueMilliseconds(PropertySetterValue):
958
"""Abstract class for PropertySetterValue taking a value
959
argument as a datetime.timedelta() but should store it as
963
def value_to_set(self):
967
def value_to_set(self, value):
968
"When setting, convert value from a datetime.timedelta"
969
self._vts = int(round(value.total_seconds() * 1000))
972
class SetTimeout(PropertySetterValueMilliseconds):
976
class SetExtendedTimeout(PropertySetterValueMilliseconds):
977
propname = "ExtendedTimeout"
980
class SetInterval(PropertySetterValueMilliseconds):
981
propname = "Interval"
984
class SetApprovalDelay(PropertySetterValueMilliseconds):
985
propname = "ApprovalDelay"
988
class SetApprovalDuration(PropertySetterValueMilliseconds):
989
propname = "ApprovalDuration"
697
def valuetostring(cls, value, keyword):
698
if isinstance(value, dbus.Boolean):
699
return "Yes" if value else "No"
700
if keyword in ("Timeout", "Interval", "ApprovalDelay",
701
"ApprovalDuration", "ExtendedTimeout"):
702
return cls.milliseconds_to_string(value)
705
def header_line(self, format_string):
706
return format_string.format(**self.tableheaders)
708
def client_line(self, client, format_string):
709
return format_string.format(
710
**{key: self.string_from_client(client, key)
711
for key in self.keywords})
714
def milliseconds_to_string(ms):
715
td = datetime.timedelta(0, 0, 0, ms)
716
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
717
.format(days="{}T".format(td.days)
719
hours=td.seconds // 3600,
720
minutes=(td.seconds % 3600) // 60,
721
seconds=td.seconds % 60))
724
class PropertyCmd(Command):
725
"""Abstract class for Actions for setting one client property"""
727
def run_on_one_client(self, client, properties):
728
"""Set the Client's D-Bus property"""
729
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
730
client.__dbus_object_path__,
731
dbus.PROPERTIES_IFACE, client_dbus_interface,
732
self.propname, self.value_to_set
733
if not isinstance(self.value_to_set, dbus.Boolean)
734
else bool(self.value_to_set))
735
client.Set(client_dbus_interface, self.propname,
737
dbus_interface=dbus.PROPERTIES_IFACE)
741
raise NotImplementedError()
744
class EnableCmd(PropertyCmd):
746
value_to_set = dbus.Boolean(True)
749
class DisableCmd(PropertyCmd):
751
value_to_set = dbus.Boolean(False)
754
class BumpTimeoutCmd(PropertyCmd):
755
propname = "LastCheckedOK"
759
class StartCheckerCmd(PropertyCmd):
760
propname = "CheckerRunning"
761
value_to_set = dbus.Boolean(True)
764
class StopCheckerCmd(PropertyCmd):
765
propname = "CheckerRunning"
766
value_to_set = dbus.Boolean(False)
769
class ApproveByDefaultCmd(PropertyCmd):
770
propname = "ApprovedByDefault"
771
value_to_set = dbus.Boolean(True)
774
class DenyByDefaultCmd(PropertyCmd):
775
propname = "ApprovedByDefault"
776
value_to_set = dbus.Boolean(False)
779
class PropertyValueCmd(PropertyCmd):
780
"""Abstract class for PropertyCmd recieving a value as argument"""
781
def __init__(self, value):
782
self.value_to_set = value
785
class SetCheckerCmd(PropertyValueCmd):
789
class SetHostCmd(PropertyValueCmd):
793
class SetSecretCmd(PropertyValueCmd):
797
def value_to_set(self):
801
def value_to_set(self, value):
802
"""When setting, read data from supplied file object"""
803
self._vts = value.read()
807
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
808
"""Abstract class for PropertyValueCmd taking a value argument as
809
a datetime.timedelta() but should store it as milliseconds."""
812
def value_to_set(self):
816
def value_to_set(self, value):
817
"""When setting, convert value from a datetime.timedelta"""
818
self._vts = int(round(value.total_seconds() * 1000))
821
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
825
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
826
propname = "ExtendedTimeout"
829
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
830
propname = "Interval"
833
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
834
propname = "ApprovalDelay"
837
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
838
propname = "ApprovalDuration"
1063
897
def test_actions_requires_client_or_all(self):
1064
898
for action, value in self.actions.items():
1065
args = self.actionargs(action, value)
899
options = self.parser.parse_args()
900
setattr(options, action, value)
1066
901
with self.assertParseError():
1067
self.parse_args(args)
902
self.check_option_syntax(options)
1069
# This mostly corresponds to the definition from has_commands() in
904
# This mostly corresponds to the definition from has_actions() in
1070
905
# check_option_syntax()
1074
"--bump-timeout": None,
1075
"--start-checker": None,
1076
"--stop-checker": None,
1077
"--is-enabled": None,
1080
"--timeout": "PT0S",
1081
"--extended-timeout": "PT0S",
1082
"--interval": "PT0S",
1083
"--approve-by-default": None,
1084
"--deny-by-default": None,
1085
"--approval-delay": "PT0S",
1086
"--approval-duration": "PT0S",
1087
"--host": "hostname",
1088
"--secret": "/dev/null",
907
# The actual values set here are not that important, but we do
908
# at least stick to the correct types, even though they are
912
"bump_timeout": True,
913
"start_checker": True,
914
"stop_checker": True,
918
"timeout": datetime.timedelta(),
919
"extended_timeout": datetime.timedelta(),
920
"interval": datetime.timedelta(),
921
"approved_by_default": True,
922
"approval_delay": datetime.timedelta(),
923
"approval_duration": datetime.timedelta(),
925
"secret": io.BytesIO(b"x"),
1094
def actionargs(action, value, *args):
1095
if value is not None:
1096
return [action, value] + list(args)
1098
return [action] + list(args)
1100
930
@contextlib.contextmanager
1101
931
def assertParseError(self):
1102
932
with self.assertRaises(SystemExit) as e:
1103
with self.redirect_stderr_to_devnull():
933
with self.temporarily_suppress_stderr():
1105
935
# Exit code from argparse is guaranteed to be "2". Reference:
1106
936
# https://docs.python.org/3/library
1107
937
# /argparse.html#exiting-methods
1108
self.assertEqual(2, e.exception.code)
1110
def parse_args(self, args):
1111
options = self.parser.parse_args(args)
1112
check_option_syntax(self.parser, options)
938
self.assertEqual(e.exception.code, 2)
1115
941
@contextlib.contextmanager
1116
def redirect_stderr_to_devnull():
1117
old_stderr = sys.stderr
1118
with contextlib.closing(open(os.devnull, "w")) as null:
1123
sys.stderr = old_stderr
942
def temporarily_suppress_stderr():
943
null = os.open(os.path.devnull, os.O_RDWR)
944
stderrcopy = os.dup(sys.stderr.fileno())
945
os.dup2(null, sys.stderr.fileno())
951
os.dup2(stderrcopy, sys.stderr.fileno())
1125
954
def check_option_syntax(self, options):
1126
955
check_option_syntax(self.parser, options)
1128
def test_actions_all_conflicts_with_verbose(self):
1129
for action, value in self.actions.items():
1130
args = self.actionargs(action, value, "--all",
1132
with self.assertParseError():
1133
self.parse_args(args)
1135
def test_actions_with_client_conflicts_with_verbose(self):
1136
for action, value in self.actions.items():
1137
args = self.actionargs(action, value, "--verbose",
1139
with self.assertParseError():
1140
self.parse_args(args)
957
def test_actions_conflicts_with_verbose(self):
958
for action, value in self.actions.items():
959
options = self.parser.parse_args()
960
setattr(options, action, value)
961
options.verbose = True
962
with self.assertParseError():
963
self.check_option_syntax(options)
1142
965
def test_dump_json_conflicts_with_verbose(self):
1143
args = ["--dump-json", "--verbose"]
966
options = self.parser.parse_args()
967
options.dump_json = True
968
options.verbose = True
1144
969
with self.assertParseError():
1145
self.parse_args(args)
970
self.check_option_syntax(options)
1147
972
def test_dump_json_conflicts_with_action(self):
1148
973
for action, value in self.actions.items():
1149
args = self.actionargs(action, value, "--dump-json")
974
options = self.parser.parse_args()
975
setattr(options, action, value)
976
options.dump_json = True
1150
977
with self.assertParseError():
1151
self.parse_args(args)
978
self.check_option_syntax(options)
1153
980
def test_all_can_not_be_alone(self):
981
options = self.parser.parse_args()
1155
983
with self.assertParseError():
1156
self.parse_args(args)
984
self.check_option_syntax(options)
1158
986
def test_all_is_ok_with_any_action(self):
1159
987
for action, value in self.actions.items():
1160
args = self.actionargs(action, value, "--all")
1161
self.parse_args(args)
1163
def test_any_action_is_ok_with_one_client(self):
1164
for action, value in self.actions.items():
1165
args = self.actionargs(action, value, "client")
1166
self.parse_args(args)
1168
def test_one_client_with_all_actions_except_is_enabled(self):
1169
for action, value in self.actions.items():
1170
if action == "--is-enabled":
1172
args = self.actionargs(action, value, "client")
1173
self.parse_args(args)
1175
def test_two_clients_with_all_actions_except_is_enabled(self):
1176
for action, value in self.actions.items():
1177
if action == "--is-enabled":
1179
args = self.actionargs(action, value, "client1",
1181
self.parse_args(args)
1183
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1184
for action, value in self.actions.items():
1185
if action == "--is-enabled":
1187
args = self.actionargs(action, value, "client1",
1189
self.parse_args(args)
988
options = self.parser.parse_args()
989
setattr(options, action, value)
991
self.check_option_syntax(options)
1191
993
def test_is_enabled_fails_without_client(self):
1192
args = ["--is-enabled"]
994
options = self.parser.parse_args()
995
options.is_enabled = True
1193
996
with self.assertParseError():
1194
self.parse_args(args)
997
self.check_option_syntax(options)
999
def test_is_enabled_works_with_one_client(self):
1000
options = self.parser.parse_args()
1001
options.is_enabled = True
1002
options.client = ["foo"]
1003
self.check_option_syntax(options)
1196
1005
def test_is_enabled_fails_with_two_clients(self):
1197
args = ["--is-enabled", "client1", "client2"]
1006
options = self.parser.parse_args()
1007
options.is_enabled = True
1008
options.client = ["foo", "barbar"]
1198
1009
with self.assertParseError():
1199
self.parse_args(args)
1010
self.check_option_syntax(options)
1201
1012
def test_remove_can_only_be_combined_with_action_deny(self):
1202
1013
for action, value in self.actions.items():
1203
if action in {"--remove", "--deny"}:
1014
if action in {"remove", "deny"}:
1205
args = self.actionargs(action, value, "--all",
1016
options = self.parser.parse_args()
1017
setattr(options, action, value)
1019
options.remove = True
1207
1020
with self.assertParseError():
1208
self.parse_args(args)
1211
class Test_dbus_exceptions(unittest.TestCase):
1213
def test_dbus_ConnectFailed_is_Error(self):
1214
with self.assertRaises(dbus.Error):
1215
raise dbus.ConnectFailed()
1218
class Test_dbus_MandosBus(unittest.TestCase):
1220
class MockMandosBus(dbus.MandosBus):
1222
self._name = "se.recompile.Mandos"
1223
self._server_path = "/"
1224
self._server_interface = "se.recompile.Mandos"
1225
self._client_interface = "se.recompile.Mandos.Client"
1227
self.call_method_return = Unique()
1229
def call_method(self, methodname, busname, objectpath,
1231
self.calls.append((methodname, busname, objectpath,
1233
return self.call_method_return
1236
self.bus = self.MockMandosBus()
1238
def test_set_client_property(self):
1239
self.bus.set_client_property("objectpath", "key", "value")
1240
expected_call = ("Set", self.bus._name, "objectpath",
1241
"org.freedesktop.DBus.Properties",
1242
(self.bus._client_interface, "key", "value"))
1243
self.assertIn(expected_call, self.bus.calls)
1245
def test_call_client_method(self):
1246
ret = self.bus.call_client_method("objectpath", "methodname")
1247
self.assertIs(self.bus.call_method_return, ret)
1248
expected_call = ("methodname", self.bus._name, "objectpath",
1249
self.bus._client_interface, ())
1250
self.assertIn(expected_call, self.bus.calls)
1252
def test_call_client_method_with_args(self):
1253
args = (Unique(), Unique())
1254
ret = self.bus.call_client_method("objectpath", "methodname",
1256
self.assertIs(self.bus.call_method_return, ret)
1257
expected_call = ("methodname", self.bus._name, "objectpath",
1258
self.bus._client_interface,
1260
self.assertIn(expected_call, self.bus.calls)
1262
def test_get_clients_and_properties(self):
1265
self.bus._client_interface: {
1269
"irrelevant_interface": {
1270
"key": "othervalue",
1274
"other_objectpath": {
1275
"other_irrelevant_interface": {
1281
expected_clients_and_properties = {
1287
self.bus.call_method_return = managed_objects
1288
ret = self.bus.get_clients_and_properties()
1289
self.assertDictEqual(expected_clients_and_properties, ret)
1290
expected_call = ("GetManagedObjects", self.bus._name,
1291
self.bus._server_path,
1292
"org.freedesktop.DBus.ObjectManager", ())
1293
self.assertIn(expected_call, self.bus.calls)
1295
def test_call_server_method(self):
1296
ret = self.bus.call_server_method("methodname")
1297
self.assertIs(self.bus.call_method_return, ret)
1298
expected_call = ("methodname", self.bus._name,
1299
self.bus._server_path,
1300
self.bus._server_interface, ())
1301
self.assertIn(expected_call, self.bus.calls)
1303
def test_call_server_method_with_args(self):
1304
args = (Unique(), Unique())
1305
ret = self.bus.call_server_method("methodname", *args)
1306
self.assertIs(self.bus.call_method_return, ret)
1307
expected_call = ("methodname", self.bus._name,
1308
self.bus._server_path,
1309
self.bus._server_interface,
1311
self.assertIn(expected_call, self.bus.calls)
1314
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1316
def MockDBusPython_func(self, func):
1317
class mock_dbus_python:
1318
"""mock dbus-python module"""
1320
"""Pseudo-namespace"""
1321
class DBusException(Exception):
1325
def get_object(busname, objectpath):
1326
DBusObject = collections.namedtuple(
1327
"DBusObject", ("methodname", "Set"))
1328
def method(*args, **kwargs):
1329
self.assertEqual({"dbus_interface":
1333
def set_property(interface, key, value,
1334
dbus_interface=None):
1336
"org.freedesktop.DBus.Properties",
1338
self.assertEqual("Secret", key)
1339
return func(interface, key, value,
1340
dbus_interface=dbus_interface)
1341
return DBusObject(methodname=method,
1344
def __init__(self, value):
1345
self.value = bool(value)
1348
if sys.version_info.major == 2:
1349
__nonzero__ = __bool__
1350
class ObjectPath(str):
1352
class Dictionary(dict):
1354
class ByteArray(bytes):
1356
return mock_dbus_python
1358
def call_method(self, bus, methodname, busname, objectpath,
1360
with self.assertLogs(log, logging.DEBUG):
1361
return bus.call_method(methodname, busname, objectpath,
1364
def test_call_method_returns(self):
1365
expected_method_return = Unique()
1366
method_args = (Unique(), Unique())
1368
self.assertEqual(len(method_args), len(args))
1369
for marg, arg in zip(method_args, args):
1370
self.assertIs(marg, arg)
1371
return expected_method_return
1372
mock_dbus_python = self.MockDBusPython_func(func)
1373
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1374
ret = self.call_method(bus, "methodname", "busname",
1375
"objectpath", "interface",
1377
self.assertIs(ret, expected_method_return)
1379
def test_call_method_filters_bool_true(self):
1381
return method_return
1382
mock_dbus_python = self.MockDBusPython_func(func)
1383
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1384
method_return = mock_dbus_python.Boolean(True)
1385
ret = self.call_method(bus, "methodname", "busname",
1386
"objectpath", "interface")
1387
self.assertTrue(ret)
1388
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1390
def test_call_method_filters_bool_false(self):
1392
return method_return
1393
mock_dbus_python = self.MockDBusPython_func(func)
1394
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1395
method_return = mock_dbus_python.Boolean(False)
1396
ret = self.call_method(bus, "methodname", "busname",
1397
"objectpath", "interface")
1398
self.assertFalse(ret)
1399
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1401
def test_call_method_filters_objectpath(self):
1403
return method_return
1404
mock_dbus_python = self.MockDBusPython_func(func)
1405
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1406
method_return = mock_dbus_python.ObjectPath("objectpath")
1407
ret = self.call_method(bus, "methodname", "busname",
1408
"objectpath", "interface")
1409
self.assertEqual("objectpath", ret)
1410
self.assertIsNot("objectpath", ret)
1411
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1413
def test_call_method_filters_booleans_in_dict(self):
1415
return method_return
1416
mock_dbus_python = self.MockDBusPython_func(func)
1417
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1418
method_return = mock_dbus_python.Dictionary(
1419
{mock_dbus_python.Boolean(True):
1420
mock_dbus_python.Boolean(False),
1421
mock_dbus_python.Boolean(False):
1422
mock_dbus_python.Boolean(True)})
1423
ret = self.call_method(bus, "methodname", "busname",
1424
"objectpath", "interface")
1425
expected_method_return = {True: False,
1427
self.assertEqual(expected_method_return, ret)
1428
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1430
def test_call_method_filters_objectpaths_in_dict(self):
1432
return method_return
1433
mock_dbus_python = self.MockDBusPython_func(func)
1434
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1435
method_return = mock_dbus_python.Dictionary(
1436
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1437
mock_dbus_python.ObjectPath("objectpath_value_1"),
1438
mock_dbus_python.ObjectPath("objectpath_key_2"):
1439
mock_dbus_python.ObjectPath("objectpath_value_2")})
1440
ret = self.call_method(bus, "methodname", "busname",
1441
"objectpath", "interface")
1442
expected_method_return = {str(key): str(value)
1444
method_return.items()}
1445
self.assertEqual(expected_method_return, ret)
1446
self.assertIsInstance(ret, dict)
1447
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1449
def test_call_method_filters_dict_in_dict(self):
1451
return method_return
1452
mock_dbus_python = self.MockDBusPython_func(func)
1453
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1454
method_return = mock_dbus_python.Dictionary(
1455
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1456
"key12": "value12"}),
1457
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1458
"key22": "value22"})})
1459
ret = self.call_method(bus, "methodname", "busname",
1460
"objectpath", "interface")
1461
expected_method_return = {
1462
"key1": {"key11": "value11",
1463
"key12": "value12"},
1464
"key2": {"key21": "value21",
1465
"key22": "value22"},
1467
self.assertEqual(expected_method_return, ret)
1468
self.assertIsInstance(ret, dict)
1469
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1470
for key, value in ret.items():
1471
self.assertIsInstance(value, dict)
1472
self.assertEqual(expected_method_return[key], value)
1473
self.assertNotIsInstance(value,
1474
mock_dbus_python.Dictionary)
1476
def test_call_method_filters_dict_three_deep(self):
1478
return method_return
1479
mock_dbus_python = self.MockDBusPython_func(func)
1480
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1481
method_return = mock_dbus_python.Dictionary(
1483
mock_dbus_python.Dictionary(
1485
mock_dbus_python.Dictionary(
1487
mock_dbus_python.Boolean(True),
1491
ret = self.call_method(bus, "methodname", "busname",
1492
"objectpath", "interface")
1493
expected_method_return = {"key1": {"key2": {"key3": True}}}
1494
self.assertEqual(expected_method_return, ret)
1495
self.assertIsInstance(ret, dict)
1496
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1497
self.assertIsInstance(ret["key1"], dict)
1498
self.assertNotIsInstance(ret["key1"],
1499
mock_dbus_python.Dictionary)
1500
self.assertIsInstance(ret["key1"]["key2"], dict)
1501
self.assertNotIsInstance(ret["key1"]["key2"],
1502
mock_dbus_python.Dictionary)
1503
self.assertTrue(ret["key1"]["key2"]["key3"])
1504
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1505
mock_dbus_python.Boolean)
1507
def test_call_method_handles_exception(self):
1021
self.check_option_syntax(options)
1024
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1025
def test_calls_and_returns_get_object_on_bus(self):
1026
class MockBus(object):
1028
def get_object(mockbus_self, busname, dbus_path):
1029
# Note that "self" is still the testcase instance,
1030
# this MockBus instance is in "mockbus_self".
1031
self.assertEqual(busname, dbus_busname)
1032
self.assertEqual(dbus_path, server_dbus_path)
1033
mockbus_self.called = True
1036
mockbus = get_mandos_dbus_object(bus=MockBus())
1037
self.assertIsInstance(mockbus, MockBus)
1038
self.assertTrue(mockbus.called)
1040
def test_logs_and_exits_on_dbus_error(self):
1041
class MockBusFailing(object):
1042
def get_object(self, busname, dbus_path):
1043
raise dbus.exceptions.DBusException("Test")
1045
with self.assertLogs(log, logging.CRITICAL):
1046
with self.assertRaises(SystemExit) as e:
1047
bus = get_mandos_dbus_object(bus=MockBusFailing())
1049
if isinstance(e.exception.code, int):
1050
self.assertNotEqual(e.exception.code, 0)
1052
self.assertIsNotNone(e.exception.code)
1055
class Test_get_managed_objects(TestCaseWithAssertLogs):
1056
def test_calls_and_returns_GetManagedObjects(self):
1057
managed_objects = {"/clients/foo": { "Name": "foo"}}
1058
class MockObjectManager(object):
1059
def GetManagedObjects(self):
1060
return managed_objects
1061
retval = get_managed_objects(MockObjectManager())
1062
self.assertDictEqual(managed_objects, retval)
1064
def test_logs_and_exits_on_dbus_error(self):
1508
1065
dbus_logger = logging.getLogger("dbus.proxies")
1511
dbus_logger.error("Test")
1512
raise mock_dbus_python.exceptions.DBusException()
1514
mock_dbus_python = self.MockDBusPython_func(func)
1515
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1067
class MockObjectManagerFailing(object):
1068
def GetManagedObjects(self):
1069
dbus_logger.error("Test")
1070
raise dbus.exceptions.DBusException("Test")
1517
1072
class CountingHandler(logging.Handler):
1524
1079
dbus_logger.addHandler(counting_handler)
1527
with self.assertRaises(dbus.Error) as e:
1528
self.call_method(bus, "methodname", "busname",
1529
"objectpath", "interface")
1082
with self.assertLogs(log, logging.CRITICAL) as watcher:
1083
with self.assertRaises(SystemExit) as e:
1084
get_managed_objects(MockObjectManagerFailing())
1531
1086
dbus_logger.removeFilter(counting_handler)
1533
self.assertNotIsInstance(e, dbus.ConnectFailed)
1535
# Make sure the dbus logger was suppressed
1536
self.assertEqual(0, counting_handler.count)
1538
def test_Set_Secret_sends_bytearray(self):
1540
def func(*args, **kwargs):
1541
ret[0] = (args, kwargs)
1542
mock_dbus_python = self.MockDBusPython_func(func)
1543
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1544
bus.set_client_property("objectpath", "Secret", "value")
1545
expected_call = (("se.recompile.Mandos.Client", "Secret",
1546
mock_dbus_python.ByteArray(b"value")),
1548
"org.freedesktop.DBus.Properties"})
1549
self.assertEqual(expected_call, ret[0])
1550
if sys.version_info.major == 2:
1551
self.assertIsInstance(ret[0][0][-1],
1552
mock_dbus_python.ByteArray)
1554
def test_get_object_converts_to_correct_exception(self):
1555
bus = dbus_python_adapter.SystemBus(
1556
self.fake_dbus_python_raises_exception_on_connect)
1557
with self.assertRaises(dbus.ConnectFailed):
1558
self.call_method(bus, "methodname", "busname",
1559
"objectpath", "interface")
1561
class fake_dbus_python_raises_exception_on_connect:
1562
"""fake dbus-python module"""
1564
"""Pseudo-namespace"""
1565
class DBusException(Exception):
1570
def get_object(busname, objectpath):
1571
raise cls.exceptions.DBusException()
1572
Bus = collections.namedtuple("Bus", ["get_object"])
1573
return Bus(get_object=get_object)
1576
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1577
class mock_dbus_python:
1578
"""mock dbus-python modules"""
1581
def get_object(busname, objectpath):
1585
self.bus = dbus_python_adapter.CachingBus(
1586
self.mock_dbus_python)
1588
def test_returns_distinct_objectpaths(self):
1589
obj1 = self.bus.get_object("busname", "objectpath1")
1590
self.assertIsInstance(obj1, Unique)
1591
obj2 = self.bus.get_object("busname", "objectpath2")
1592
self.assertIsInstance(obj2, Unique)
1593
self.assertIsNot(obj1, obj2)
1595
def test_returns_distinct_busnames(self):
1596
obj1 = self.bus.get_object("busname1", "objectpath")
1597
self.assertIsInstance(obj1, Unique)
1598
obj2 = self.bus.get_object("busname2", "objectpath")
1599
self.assertIsInstance(obj2, Unique)
1600
self.assertIsNot(obj1, obj2)
1602
def test_returns_distinct_both(self):
1603
obj1 = self.bus.get_object("busname1", "objectpath")
1604
self.assertIsInstance(obj1, Unique)
1605
obj2 = self.bus.get_object("busname2", "objectpath")
1606
self.assertIsInstance(obj2, Unique)
1607
self.assertIsNot(obj1, obj2)
1609
def test_returns_same(self):
1610
obj1 = self.bus.get_object("busname", "objectpath")
1611
self.assertIsInstance(obj1, Unique)
1612
obj2 = self.bus.get_object("busname", "objectpath")
1613
self.assertIsInstance(obj2, Unique)
1614
self.assertIs(obj1, obj2)
1616
def test_returns_same_old(self):
1617
obj1 = self.bus.get_object("busname1", "objectpath1")
1618
self.assertIsInstance(obj1, Unique)
1619
obj2 = self.bus.get_object("busname2", "objectpath2")
1620
self.assertIsInstance(obj2, Unique)
1621
obj1b = self.bus.get_object("busname1", "objectpath1")
1622
self.assertIsInstance(obj1b, Unique)
1623
self.assertIsNot(obj1, obj2)
1624
self.assertIsNot(obj2, obj1b)
1625
self.assertIs(obj1, obj1b)
1628
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1630
def Stub_pydbus_func(self, func):
1632
"""stub pydbus module"""
1635
def get(busname, objectpath):
1636
DBusObject = collections.namedtuple(
1637
"DBusObject", ("methodname",))
1638
return {"interface":
1639
DBusObject(methodname=func)}
1642
def call_method(self, bus, methodname, busname, objectpath,
1644
with self.assertLogs(log, logging.DEBUG):
1645
return bus.call_method(methodname, busname, objectpath,
1648
def test_call_method_returns(self):
1649
expected_method_return = Unique()
1650
method_args = (Unique(), Unique())
1652
self.assertEqual(len(method_args), len(args))
1653
for marg, arg in zip(method_args, args):
1654
self.assertIs(marg, arg)
1655
return expected_method_return
1656
stub_pydbus = self.Stub_pydbus_func(func)
1657
bus = pydbus_adapter.SystemBus(stub_pydbus)
1658
ret = self.call_method(bus, "methodname", "busname",
1659
"objectpath", "interface",
1661
self.assertIs(ret, expected_method_return)
1663
def test_call_method_handles_exception(self):
1664
dbus_logger = logging.getLogger("dbus.proxies")
1667
raise gi.repository.GLib.Error()
1669
stub_pydbus = self.Stub_pydbus_func(func)
1670
bus = pydbus_adapter.SystemBus(stub_pydbus)
1672
with self.assertRaises(dbus.Error) as e:
1673
self.call_method(bus, "methodname", "busname",
1674
"objectpath", "interface")
1676
self.assertNotIsInstance(e, dbus.ConnectFailed)
1678
def test_get_converts_to_correct_exception(self):
1679
bus = pydbus_adapter.SystemBus(
1680
self.fake_pydbus_raises_exception_on_connect)
1681
with self.assertRaises(dbus.ConnectFailed):
1682
self.call_method(bus, "methodname", "busname",
1683
"objectpath", "interface")
1685
class fake_pydbus_raises_exception_on_connect:
1686
"""fake dbus-python module"""
1689
def get(busname, objectpath):
1690
raise gi.repository.GLib.Error()
1691
Bus = collections.namedtuple("Bus", ["get"])
1694
def test_set_property_uses_setattr(self):
1701
def get(busname, objectpath):
1702
return {"interface": obj}
1703
bus = pydbus_adapter.SystemBus(pydbus_spy)
1705
bus.set_property("busname", "objectpath", "interface", "key",
1707
self.assertIs(value, obj.key)
1709
def test_get_suppresses_xml_deprecation_warning(self):
1710
if sys.version_info.major >= 3:
1712
class stub_pydbus_get:
1715
def get(busname, objectpath):
1716
warnings.warn_explicit(
1717
"deprecated", DeprecationWarning,
1718
"xml.etree.ElementTree", 0)
1719
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1720
with warnings.catch_warnings(record=True) as w:
1721
warnings.simplefilter("always")
1722
bus.get("busname", "objectpath")
1723
self.assertEqual(0, len(w))
1726
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1728
"""stub pydbus module"""
1731
def get(busname, objectpath):
1735
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1737
def test_returns_distinct_objectpaths(self):
1738
obj1 = self.bus.get("busname", "objectpath1")
1739
self.assertIsInstance(obj1, Unique)
1740
obj2 = self.bus.get("busname", "objectpath2")
1741
self.assertIsInstance(obj2, Unique)
1742
self.assertIsNot(obj1, obj2)
1744
def test_returns_distinct_busnames(self):
1745
obj1 = self.bus.get("busname1", "objectpath")
1746
self.assertIsInstance(obj1, Unique)
1747
obj2 = self.bus.get("busname2", "objectpath")
1748
self.assertIsInstance(obj2, Unique)
1749
self.assertIsNot(obj1, obj2)
1751
def test_returns_distinct_both(self):
1752
obj1 = self.bus.get("busname1", "objectpath")
1753
self.assertIsInstance(obj1, Unique)
1754
obj2 = self.bus.get("busname2", "objectpath")
1755
self.assertIsInstance(obj2, Unique)
1756
self.assertIsNot(obj1, obj2)
1758
def test_returns_same(self):
1759
obj1 = self.bus.get("busname", "objectpath")
1760
self.assertIsInstance(obj1, Unique)
1761
obj2 = self.bus.get("busname", "objectpath")
1762
self.assertIsInstance(obj2, Unique)
1763
self.assertIs(obj1, obj2)
1765
def test_returns_same_old(self):
1766
obj1 = self.bus.get("busname1", "objectpath1")
1767
self.assertIsInstance(obj1, Unique)
1768
obj2 = self.bus.get("busname2", "objectpath2")
1769
self.assertIsInstance(obj2, Unique)
1770
obj1b = self.bus.get("busname1", "objectpath1")
1771
self.assertIsInstance(obj1b, Unique)
1772
self.assertIsNot(obj1, obj2)
1773
self.assertIsNot(obj2, obj1b)
1774
self.assertIs(obj1, obj1b)
1087
self.assertEqual(counting_handler.count, 0)
1089
# Test that the dbus_logger still works
1090
with self.assertLogs(dbus_logger, logging.ERROR):
1091
dbus_logger.error("Test")
1093
if isinstance(e.exception.code, int):
1094
self.assertNotEqual(e.exception.code, 0)
1096
self.assertIsNotNone(e.exception.code)
1777
1099
class Test_commands_from_options(unittest.TestCase):
1779
1100
def setUp(self):
1780
1101
self.parser = argparse.ArgumentParser()
1781
1102
add_command_line_options(self.parser)
1783
1104
def test_is_enabled(self):
1784
self.assert_command_from_args(["--is-enabled", "client"],
1105
self.assert_command_from_args(["--is-enabled", "foo"],
1787
def assert_command_from_args(self, args, command_cls, length=1,
1788
clients=None, **cmd_attrs):
1108
def assert_command_from_args(self, args, command_cls,
1789
1110
"""Assert that parsing ARGS should result in an instance of
1790
1111
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1791
1112
options = self.parser.parse_args(args)
1792
1113
check_option_syntax(self.parser, options)
1793
1114
commands = commands_from_options(options)
1794
self.assertEqual(length, len(commands))
1795
for command in commands:
1796
if isinstance(command, command_cls):
1799
self.assertIsInstance(command, command_cls)
1800
if clients is not None:
1801
self.assertEqual(clients, options.client)
1115
self.assertEqual(len(commands), 1)
1116
command = commands[0]
1117
self.assertIsInstance(command, command_cls)
1802
1118
for key, value in cmd_attrs.items():
1803
self.assertEqual(value, getattr(command, key))
1805
def assert_commands_from_args(self, args, commands, clients=None):
1806
for cmd in commands:
1807
self.assert_command_from_args(args, cmd,
1808
length=len(commands),
1119
self.assertEqual(getattr(command, key), value)
1811
1121
def test_is_enabled_short(self):
1812
self.assert_command_from_args(["-V", "client"],
1122
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1815
1124
def test_approve(self):
1816
self.assert_command_from_args(["--approve", "client"],
1125
self.assert_command_from_args(["--approve", "foo"],
1819
1128
def test_approve_short(self):
1820
self.assert_command_from_args(["-A", "client"],
1129
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1823
1131
def test_deny(self):
1824
self.assert_command_from_args(["--deny", "client"],
1132
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1827
1134
def test_deny_short(self):
1828
self.assert_command_from_args(["-D", "client"], command.Deny)
1135
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1830
1137
def test_remove(self):
1831
self.assert_command_from_args(["--remove", "client"],
1138
self.assert_command_from_args(["--remove", "foo"],
1834
1141
def test_deny_before_remove(self):
1835
1142
options = self.parser.parse_args(["--deny", "--remove",
1837
1144
check_option_syntax(self.parser, options)
1838
1145
commands = commands_from_options(options)
1839
self.assertEqual(2, len(commands))
1840
self.assertIsInstance(commands[0], command.Deny)
1841
self.assertIsInstance(commands[1], command.Remove)
1146
self.assertEqual(len(commands), 2)
1147
self.assertIsInstance(commands[0], DenyCmd)
1148
self.assertIsInstance(commands[1], RemoveCmd)
1843
1150
def test_deny_before_remove_reversed(self):
1844
1151
options = self.parser.parse_args(["--remove", "--deny",
1846
1153
check_option_syntax(self.parser, options)
1847
1154
commands = commands_from_options(options)
1848
self.assertEqual(2, len(commands))
1849
self.assertIsInstance(commands[0], command.Deny)
1850
self.assertIsInstance(commands[1], command.Remove)
1155
self.assertEqual(len(commands), 2)
1156
self.assertIsInstance(commands[0], DenyCmd)
1157
self.assertIsInstance(commands[1], RemoveCmd)
1852
1159
def test_remove_short(self):
1853
self.assert_command_from_args(["-r", "client"],
1160
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1856
1162
def test_dump_json(self):
1857
self.assert_command_from_args(["--dump-json"],
1163
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1860
1165
def test_enable(self):
1861
self.assert_command_from_args(["--enable", "client"],
1166
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1864
1168
def test_enable_short(self):
1865
self.assert_command_from_args(["-e", "client"],
1169
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1868
1171
def test_disable(self):
1869
self.assert_command_from_args(["--disable", "client"],
1172
self.assert_command_from_args(["--disable", "foo"],
1872
1175
def test_disable_short(self):
1873
self.assert_command_from_args(["-d", "client"],
1176
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1876
1178
def test_bump_timeout(self):
1877
self.assert_command_from_args(["--bump-timeout", "client"],
1878
command.BumpTimeout)
1179
self.assert_command_from_args(["--bump-timeout", "foo"],
1880
1182
def test_bump_timeout_short(self):
1881
self.assert_command_from_args(["-b", "client"],
1882
command.BumpTimeout)
1183
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1884
1185
def test_start_checker(self):
1885
self.assert_command_from_args(["--start-checker", "client"],
1886
command.StartChecker)
1186
self.assert_command_from_args(["--start-checker", "foo"],
1888
1189
def test_stop_checker(self):
1889
self.assert_command_from_args(["--stop-checker", "client"],
1890
command.StopChecker)
1190
self.assert_command_from_args(["--stop-checker", "foo"],
1892
1193
def test_approve_by_default(self):
1893
self.assert_command_from_args(["--approve-by-default",
1895
command.ApproveByDefault)
1194
self.assert_command_from_args(["--approve-by-default", "foo"],
1195
ApproveByDefaultCmd)
1897
1197
def test_deny_by_default(self):
1898
self.assert_command_from_args(["--deny-by-default", "client"],
1899
command.DenyByDefault)
1198
self.assert_command_from_args(["--deny-by-default", "foo"],
1901
1201
def test_checker(self):
1902
self.assert_command_from_args(["--checker", ":", "client"],
1202
self.assert_command_from_args(["--checker", ":", "foo"],
1203
SetCheckerCmd, value_to_set=":")
1906
1205
def test_checker_empty(self):
1907
self.assert_command_from_args(["--checker", "", "client"],
1206
self.assert_command_from_args(["--checker", "", "foo"],
1207
SetCheckerCmd, value_to_set="")
1911
1209
def test_checker_short(self):
1912
self.assert_command_from_args(["-c", ":", "client"],
1210
self.assert_command_from_args(["-c", ":", "foo"],
1211
SetCheckerCmd, value_to_set=":")
1916
1213
def test_host(self):
1917
self.assert_command_from_args(
1918
["--host", "client.example.org", "client"],
1919
command.SetHost, value_to_set="client.example.org")
1214
self.assert_command_from_args(["--host", "foo.example.org",
1216
value_to_set="foo.example.org")
1921
1218
def test_host_short(self):
1922
self.assert_command_from_args(
1923
["-H", "client.example.org", "client"], command.SetHost,
1924
value_to_set="client.example.org")
1219
self.assert_command_from_args(["-H", "foo.example.org",
1221
value_to_set="foo.example.org")
1926
1223
def test_secret_devnull(self):
1927
1224
self.assert_command_from_args(["--secret", os.path.devnull,
1928
"client"], command.SetSecret,
1225
"foo"], SetSecretCmd,
1929
1226
value_to_set=b"")
1931
1228
def test_secret_tempfile(self):
1936
1233
self.assert_command_from_args(["--secret", f.name,
1234
"foo"], SetSecretCmd,
1939
1235
value_to_set=value)
1941
1237
def test_secret_devnull_short(self):
1942
self.assert_command_from_args(["-s", os.path.devnull,
1943
"client"], command.SetSecret,
1238
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1239
SetSecretCmd, value_to_set=b"")
1946
1241
def test_secret_tempfile_short(self):
1947
1242
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1948
1243
value = b"secret\0xyzzy\nbar"
1951
self.assert_command_from_args(["-s", f.name, "client"],
1246
self.assert_command_from_args(["-s", f.name, "foo"],
1953
1248
value_to_set=value)
1955
1250
def test_timeout(self):
1956
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1251
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1958
1253
value_to_set=300000)
1960
1255
def test_timeout_short(self):
1961
self.assert_command_from_args(["-t", "PT5M", "client"],
1256
self.assert_command_from_args(["-t", "PT5M", "foo"],
1963
1258
value_to_set=300000)
1965
1260
def test_extended_timeout(self):
1966
1261
self.assert_command_from_args(["--extended-timeout", "PT15M",
1968
command.SetExtendedTimeout,
1263
SetExtendedTimeoutCmd,
1969
1264
value_to_set=900000)
1971
1266
def test_interval(self):
1972
self.assert_command_from_args(["--interval", "PT2M",
1973
"client"], command.SetInterval,
1267
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1974
1269
value_to_set=120000)
1976
1271
def test_interval_short(self):
1977
self.assert_command_from_args(["-i", "PT2M", "client"],
1978
command.SetInterval,
1272
self.assert_command_from_args(["-i", "PT2M", "foo"],
1979
1274
value_to_set=120000)
1981
1276
def test_approval_delay(self):
1982
1277
self.assert_command_from_args(["--approval-delay", "PT30S",
1984
command.SetApprovalDelay,
1278
"foo"], SetApprovalDelayCmd,
1985
1279
value_to_set=30000)
1987
1281
def test_approval_duration(self):
1988
1282
self.assert_command_from_args(["--approval-duration", "PT1S",
1990
command.SetApprovalDuration,
1283
"foo"], SetApprovalDurationCmd,
1991
1284
value_to_set=1000)
1993
1286
def test_print_table(self):
1994
self.assert_command_from_args([], command.PrintTable,
1287
self.assert_command_from_args([], PrintTableCmd,
1997
1290
def test_print_table_verbose(self):
1998
self.assert_command_from_args(["--verbose"],
1291
self.assert_command_from_args(["--verbose"], PrintTableCmd,
2002
1294
def test_print_table_verbose_short(self):
2003
self.assert_command_from_args(["-v"], command.PrintTable,
1295
self.assert_command_from_args(["-v"], PrintTableCmd,
2007
def test_manual_page_example_1(self):
2008
self.assert_command_from_args("",
2013
def test_manual_page_example_2(self):
2014
self.assert_command_from_args(
2015
"--verbose foo1.example.org foo2.example.org".split(),
2016
command.PrintTable, clients=["foo1.example.org",
2017
"foo2.example.org"],
2020
def test_manual_page_example_3(self):
2021
self.assert_command_from_args("--enable --all".split(),
2025
def test_manual_page_example_4(self):
2026
self.assert_commands_from_args(
2027
("--timeout=PT5M --interval=PT1M foo1.example.org"
2028
" foo2.example.org").split(),
2029
[command.SetTimeout, command.SetInterval],
2030
clients=["foo1.example.org", "foo2.example.org"])
2032
def test_manual_page_example_5(self):
2033
self.assert_command_from_args("--approve --all".split(),
2038
class TestCommand(unittest.TestCase):
1299
class TestCmd(unittest.TestCase):
2039
1300
"""Abstract class for tests of command classes"""
2041
class FakeMandosBus(dbus.MandosBus):
2042
def __init__(self, testcase):
2043
self.client_properties = {
1304
class MockClient(object):
1305
def __init__(self, name, **attributes):
1306
self.__dbus_object_path__ = "/clients/{}".format(name)
1307
self.attributes = attributes
1308
self.attributes["Name"] = name
1310
def Set(self, interface, propname, value, dbus_interface):
1311
testcase.assertEqual(interface, client_dbus_interface)
1312
testcase.assertEqual(dbus_interface,
1313
dbus.PROPERTIES_IFACE)
1314
self.attributes[propname] = value
1315
def Get(self, interface, propname, dbus_interface):
1316
testcase.assertEqual(interface, client_dbus_interface)
1317
testcase.assertEqual(dbus_interface,
1318
dbus.PROPERTIES_IFACE)
1319
return self.attributes[propname]
1320
def Approve(self, approve, dbus_interface):
1321
testcase.assertEqual(dbus_interface,
1322
client_dbus_interface)
1323
self.calls.append(("Approve", (approve,
1325
self.client = MockClient(
1327
KeyID=("92ed150794387c03ce684574b1139a65"
1328
"94a34f895daaaf09fd8ea90a27cddb12"),
1330
Host="foo.example.org",
1331
Enabled=dbus.Boolean(True),
1333
LastCheckedOK="2019-02-03T00:00:00",
1334
Created="2019-01-02T00:00:00",
1336
Fingerprint=("778827225BA7DE539C5A"
1337
"7CFA59CFF7CDBD9A5920"),
1338
CheckerRunning=dbus.Boolean(False),
1339
LastEnabled="2019-01-03T00:00:00",
1340
ApprovalPending=dbus.Boolean(False),
1341
ApprovedByDefault=dbus.Boolean(True),
1342
LastApprovalRequest="",
1344
ApprovalDuration=1000,
1345
Checker="fping -q -- %(host)s",
1346
ExtendedTimeout=900000,
1347
Expires="2019-02-04T00:00:00",
1348
LastCheckerStatus=0)
1349
self.other_client = MockClient(
1351
KeyID=("0558568eedd67d622f5c83b35a115f79"
1352
"6ab612cff5ad227247e46c2b020f441c"),
1353
Secret=b"secretbar",
1355
Enabled=dbus.Boolean(True),
1357
LastCheckedOK="2019-02-04T00:00:00",
1358
Created="2019-01-03T00:00:00",
1360
Fingerprint=("3E393AEAEFB84C7E89E2"
1361
"F547B3A107558FCA3A27"),
1362
CheckerRunning=dbus.Boolean(True),
1363
LastEnabled="2019-01-04T00:00:00",
1364
ApprovalPending=dbus.Boolean(False),
1365
ApprovedByDefault=dbus.Boolean(False),
1366
LastApprovalRequest="2019-01-03T00:00:00",
1367
ApprovalDelay=30000,
1368
ApprovalDuration=93785000,
1370
ExtendedTimeout=900000,
1371
Expires="2019-02-05T00:00:00",
1372
LastCheckerStatus=-2)
1373
self.clients = collections.OrderedDict(
1375
("/clients/foo", self.client.attributes),
1376
("/clients/barbar", self.other_client.attributes),
1378
self.one_client = {"/clients/foo": self.client.attributes}
1384
def get_object(client_bus_name, path):
1385
self.assertEqual(client_bus_name, dbus_busname)
1387
# Note: "self" here is the TestCmd instance, not
1388
# the Bus instance, since this is a static method!
1389
"/clients/foo": self.client,
1390
"/clients/barbar": self.other_client,
1395
class TestIsEnabledCmd(TestCmd):
1396
def test_is_enabled(self):
1397
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1399
for client, properties
1400
in self.clients.items()))
1402
def test_is_enabled_run_exits_successfully(self):
1403
with self.assertRaises(SystemExit) as e:
1404
IsEnabledCmd().run(self.one_client)
1405
if e.exception.code is not None:
1406
self.assertEqual(e.exception.code, 0)
1408
self.assertIsNone(e.exception.code)
1410
def test_is_enabled_run_exits_with_failure(self):
1411
self.client.attributes["Enabled"] = dbus.Boolean(False)
1412
with self.assertRaises(SystemExit) as e:
1413
IsEnabledCmd().run(self.one_client)
1414
if isinstance(e.exception.code, int):
1415
self.assertNotEqual(e.exception.code, 0)
1417
self.assertIsNotNone(e.exception.code)
1420
class TestApproveCmd(TestCmd):
1421
def test_approve(self):
1422
ApproveCmd().run(self.clients, self.bus)
1423
for clientpath in self.clients:
1424
client = self.bus.get_object(dbus_busname, clientpath)
1425
self.assertIn(("Approve", (True, client_dbus_interface)),
1429
class TestDenyCmd(TestCmd):
1430
def test_deny(self):
1431
DenyCmd().run(self.clients, self.bus)
1432
for clientpath in self.clients:
1433
client = self.bus.get_object(dbus_busname, clientpath)
1434
self.assertIn(("Approve", (False, client_dbus_interface)),
1438
class TestRemoveCmd(TestCmd):
1439
def test_remove(self):
1440
class MockMandos(object):
1443
def RemoveClient(self, dbus_path):
1444
self.calls.append(("RemoveClient", (dbus_path,)))
1445
mandos = MockMandos()
1446
super(TestRemoveCmd, self).setUp()
1447
RemoveCmd().run(self.clients, self.bus, mandos)
1448
self.assertEqual(len(mandos.calls), 2)
1449
for clientpath in self.clients:
1450
self.assertIn(("RemoveClient", (clientpath,)),
1454
class TestDumpJSONCmd(TestCmd):
1456
self.expected_json = {
2045
1459
"KeyID": ("92ed150794387c03ce684574b1139a65"
2046
1460
"94a34f895daaaf09fd8ea90a27cddb12"),
2047
"Secret": b"secret",
2048
1461
"Host": "foo.example.org",
2049
1462
"Enabled": True,
2050
1463
"Timeout": 300000,
2089
1501
"ExtendedTimeout": 900000,
2090
1502
"Expires": "2019-02-05T00:00:00",
2091
1503
"LastCheckerStatus": -2,
2093
self.clients = collections.OrderedDict(
2095
("client_objectpath", self.client_properties),
2096
("other_client_objectpath",
2097
self.other_client_properties),
2099
self.one_client = {"client_objectpath":
2100
self.client_properties}
2101
self.testcase = testcase
2104
def call_method(self, methodname, busname, objectpath,
2106
self.testcase.assertEqual("se.recompile.Mandos", busname)
2107
self.calls.append((methodname, busname, objectpath,
2109
if interface == "org.freedesktop.DBus.Properties":
2110
if methodname == "Set":
2111
self.testcase.assertEqual(3, len(args))
2112
interface, key, value = args
2113
self.testcase.assertEqual(
2114
"se.recompile.Mandos.Client", interface)
2115
self.clients[objectpath][key] = value
2117
elif interface == "se.recompile.Mandos":
2118
self.testcase.assertEqual("RemoveClient", methodname)
2119
self.testcase.assertEqual(1, len(args))
2120
clientpath = args[0]
2121
del self.clients[clientpath]
2123
elif interface == "se.recompile.Mandos.Client":
2124
if methodname == "Approve":
2125
self.testcase.assertEqual(1, len(args))
2130
self.bus = self.FakeMandosBus(self)
2133
class TestBaseCommands(TestCommand):
2135
def test_IsEnabled_exits_successfully(self):
2136
with self.assertRaises(SystemExit) as e:
2137
command.IsEnabled().run(self.bus.one_client)
2138
if e.exception.code is not None:
2139
self.assertEqual(0, e.exception.code)
2141
self.assertIsNone(e.exception.code)
2143
def test_IsEnabled_exits_with_failure(self):
2144
self.bus.client_properties["Enabled"] = False
2145
with self.assertRaises(SystemExit) as e:
2146
command.IsEnabled().run(self.bus.one_client)
2147
if isinstance(e.exception.code, int):
2148
self.assertNotEqual(0, e.exception.code)
2150
self.assertIsNotNone(e.exception.code)
2152
def test_Approve(self):
2153
busname = "se.recompile.Mandos"
2154
client_interface = "se.recompile.Mandos.Client"
2155
command.Approve().run(self.bus.clients, self.bus)
2156
for clientpath in self.bus.clients:
2157
self.assertIn(("Approve", busname, clientpath,
2158
client_interface, (True,)), self.bus.calls)
2160
def test_Deny(self):
2161
busname = "se.recompile.Mandos"
2162
client_interface = "se.recompile.Mandos.Client"
2163
command.Deny().run(self.bus.clients, self.bus)
2164
for clientpath in self.bus.clients:
2165
self.assertIn(("Approve", busname, clientpath,
2166
client_interface, (False,)),
2169
def test_Remove(self):
2170
command.Remove().run(self.bus.clients, self.bus)
2171
for clientpath in self.bus.clients:
2172
self.assertIn(("RemoveClient", dbus_busname,
2173
dbus_server_path, dbus_server_interface,
2174
(clientpath,)), self.bus.calls)
2179
"KeyID": ("92ed150794387c03ce684574b1139a65"
2180
"94a34f895daaaf09fd8ea90a27cddb12"),
2181
"Host": "foo.example.org",
2184
"LastCheckedOK": "2019-02-03T00:00:00",
2185
"Created": "2019-01-02T00:00:00",
2187
"Fingerprint": ("778827225BA7DE539C5A"
2188
"7CFA59CFF7CDBD9A5920"),
2189
"CheckerRunning": False,
2190
"LastEnabled": "2019-01-03T00:00:00",
2191
"ApprovalPending": False,
2192
"ApprovedByDefault": True,
2193
"LastApprovalRequest": "",
2195
"ApprovalDuration": 1000,
2196
"Checker": "fping -q -- %(host)s",
2197
"ExtendedTimeout": 900000,
2198
"Expires": "2019-02-04T00:00:00",
2199
"LastCheckerStatus": 0,
2203
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2204
"6ab612cff5ad227247e46c2b020f441c"),
2205
"Host": "192.0.2.3",
2208
"LastCheckedOK": "2019-02-04T00:00:00",
2209
"Created": "2019-01-03T00:00:00",
2211
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2212
"F547B3A107558FCA3A27"),
2213
"CheckerRunning": True,
2214
"LastEnabled": "2019-01-04T00:00:00",
2215
"ApprovalPending": False,
2216
"ApprovedByDefault": False,
2217
"LastApprovalRequest": "2019-01-03T00:00:00",
2218
"ApprovalDelay": 30000,
2219
"ApprovalDuration": 93785000,
2221
"ExtendedTimeout": 900000,
2222
"Expires": "2019-02-05T00:00:00",
2223
"LastCheckerStatus": -2,
2227
def test_DumpJSON_normal(self):
2228
with self.capture_stdout_to_buffer() as buffer:
2229
command.DumpJSON().run(self.bus.clients)
2230
json_data = json.loads(buffer.getvalue())
2231
self.assertDictEqual(self.expected_json, json_data)
2234
@contextlib.contextmanager
2235
def capture_stdout_to_buffer():
2236
capture_buffer = io.StringIO()
2237
old_stdout = sys.stdout
2238
sys.stdout = capture_buffer
2240
yield capture_buffer
2242
sys.stdout = old_stdout
2244
def test_DumpJSON_one_client(self):
2245
with self.capture_stdout_to_buffer() as buffer:
2246
command.DumpJSON().run(self.bus.one_client)
2247
json_data = json.loads(buffer.getvalue())
1506
return super(TestDumpJSONCmd, self).setUp()
1508
def test_normal(self):
1509
output = DumpJSONCmd().output(self.clients.values())
1510
json_data = json.loads(output)
1511
self.assertDictEqual(json_data, self.expected_json)
1513
def test_one_client(self):
1514
output = DumpJSONCmd().output(self.one_client.values())
1515
json_data = json.loads(output)
2248
1516
expected_json = {"foo": self.expected_json["foo"]}
2249
self.assertDictEqual(expected_json, json_data)
2251
def test_PrintTable_normal(self):
2252
with self.capture_stdout_to_buffer() as buffer:
2253
command.PrintTable().run(self.bus.clients)
1517
self.assertDictEqual(json_data, expected_json)
1520
class TestPrintTableCmd(TestCmd):
1521
def test_normal(self):
1522
output = PrintTableCmd().output(self.clients.values())
2254
1523
expected_output = "\n".join((
2255
1524
"Name Enabled Timeout Last Successful Check",
2256
1525
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2257
1526
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
2259
self.assertEqual(expected_output, buffer.getvalue())
1528
self.assertEqual(output, expected_output)
2261
def test_PrintTable_verbose(self):
2262
with self.capture_stdout_to_buffer() as buffer:
2263
command.PrintTable(verbose=True).run(self.bus.clients)
1530
def test_verbose(self):
1531
output = PrintTableCmd(verbose=True).output(
1532
self.clients.values())
2350
1619
num_lines = max(len(rows) for rows in columns)
2351
expected_output = ("\n".join("".join(rows[line]
2352
for rows in columns)
2353
for line in range(num_lines))
2355
self.assertEqual(expected_output, buffer.getvalue())
1620
expected_output = "\n".join("".join(rows[line]
1621
for rows in columns)
1622
for line in range(num_lines))
1623
self.assertEqual(output, expected_output)
2357
def test_PrintTable_one_client(self):
2358
with self.capture_stdout_to_buffer() as buffer:
2359
command.PrintTable().run(self.bus.one_client)
1625
def test_one_client(self):
1626
output = PrintTableCmd().output(self.one_client.values())
2360
1627
expected_output = "\n".join((
2361
1628
"Name Enabled Timeout Last Successful Check",
2362
1629
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2364
self.assertEqual(expected_output, buffer.getvalue())
2367
class TestPropertySetterCmd(TestCommand):
2368
"""Abstract class for tests of command.PropertySetter classes"""
1631
self.assertEqual(output, expected_output)
1634
class TestPropertyCmd(TestCmd):
1635
"""Abstract class for tests of PropertyCmd classes"""
2370
1636
def runTest(self):
2371
1637
if not hasattr(self, "command"):
2372
return # Abstract TestCase class
2374
if hasattr(self, "values_to_set"):
2375
cmd_args = [(value,) for value in self.values_to_set]
2376
values_to_get = getattr(self, "values_to_get",
2379
cmd_args = [() for x in range(len(self.values_to_get))]
2380
values_to_get = self.values_to_get
2381
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2382
for clientpath in self.bus.clients:
2383
self.bus.clients[clientpath][self.propname] = (
2385
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2386
for clientpath in self.bus.clients:
2387
value = (self.bus.clients[clientpath]
2389
self.assertNotIsInstance(value, Unique)
2390
self.assertEqual(value_to_get, value)
2393
class TestEnableCmd(TestPropertySetterCmd):
2394
command = command.Enable
2395
propname = "Enabled"
2396
values_to_get = [True]
2399
class TestDisableCmd(TestPropertySetterCmd):
2400
command = command.Disable
2401
propname = "Enabled"
2402
values_to_get = [False]
2405
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2406
command = command.BumpTimeout
1639
values_to_get = getattr(self, "values_to_get",
1641
for value_to_set, value_to_get in zip(self.values_to_set,
1643
for clientpath in self.clients:
1644
client = self.bus.get_object(dbus_busname, clientpath)
1645
old_value = client.attributes[self.propname]
1646
self.assertNotIsInstance(old_value, self.Unique)
1647
client.attributes[self.propname] = self.Unique()
1648
self.run_command(value_to_set, self.clients)
1649
for clientpath in self.clients:
1650
client = self.bus.get_object(dbus_busname, clientpath)
1651
value = client.attributes[self.propname]
1652
self.assertNotIsInstance(value, self.Unique)
1653
self.assertEqual(value, value_to_get)
1655
class Unique(object):
1656
"""Class for objects which exist only to be unique objects,
1657
since unittest.mock.sentinel only exists in Python 3.3"""
1659
def run_command(self, value, clients):
1660
self.command().run(clients, self.bus)
1663
class TestEnableCmd(TestPropertyCmd):
1665
propname = "Enabled"
1666
values_to_set = [dbus.Boolean(True)]
1669
class TestDisableCmd(TestPropertyCmd):
1670
command = DisableCmd
1671
propname = "Enabled"
1672
values_to_set = [dbus.Boolean(False)]
1675
class TestBumpTimeoutCmd(TestPropertyCmd):
1676
command = BumpTimeoutCmd
2407
1677
propname = "LastCheckedOK"
2408
values_to_get = [""]
2411
class TestStartCheckerCmd(TestPropertySetterCmd):
2412
command = command.StartChecker
2413
propname = "CheckerRunning"
2414
values_to_get = [True]
2417
class TestStopCheckerCmd(TestPropertySetterCmd):
2418
command = command.StopChecker
2419
propname = "CheckerRunning"
2420
values_to_get = [False]
2423
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2424
command = command.ApproveByDefault
2425
propname = "ApprovedByDefault"
2426
values_to_get = [True]
2429
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2430
command = command.DenyByDefault
2431
propname = "ApprovedByDefault"
2432
values_to_get = [False]
2435
class TestSetCheckerCmd(TestPropertySetterCmd):
2436
command = command.SetChecker
1678
values_to_set = [""]
1681
class TestStartCheckerCmd(TestPropertyCmd):
1682
command = StartCheckerCmd
1683
propname = "CheckerRunning"
1684
values_to_set = [dbus.Boolean(True)]
1687
class TestStopCheckerCmd(TestPropertyCmd):
1688
command = StopCheckerCmd
1689
propname = "CheckerRunning"
1690
values_to_set = [dbus.Boolean(False)]
1693
class TestApproveByDefaultCmd(TestPropertyCmd):
1694
command = ApproveByDefaultCmd
1695
propname = "ApprovedByDefault"
1696
values_to_set = [dbus.Boolean(True)]
1699
class TestDenyByDefaultCmd(TestPropertyCmd):
1700
command = DenyByDefaultCmd
1701
propname = "ApprovedByDefault"
1702
values_to_set = [dbus.Boolean(False)]
1705
class TestPropertyValueCmd(TestPropertyCmd):
1706
"""Abstract class for tests of PropertyValueCmd classes"""
1709
if type(self) is TestPropertyValueCmd:
1711
return super(TestPropertyValueCmd, self).runTest()
1713
def run_command(self, value, clients):
1714
self.command(value).run(clients, self.bus)
1717
class TestSetCheckerCmd(TestPropertyValueCmd):
1718
command = SetCheckerCmd
2437
1719
propname = "Checker"
2438
1720
values_to_set = ["", ":", "fping -q -- %s"]
2441
class TestSetHostCmd(TestPropertySetterCmd):
2442
command = command.SetHost
1723
class TestSetHostCmd(TestPropertyValueCmd):
1724
command = SetHostCmd
2443
1725
propname = "Host"
2444
values_to_set = ["192.0.2.3", "client.example.org"]
2447
class TestSetSecretCmd(TestPropertySetterCmd):
2448
command = command.SetSecret
1726
values_to_set = ["192.0.2.3", "foo.example.org"]
1729
class TestSetSecretCmd(TestPropertyValueCmd):
1730
command = SetSecretCmd
2449
1731
propname = "Secret"
2450
1732
values_to_set = [io.BytesIO(b""),
2451
1733
io.BytesIO(b"secret\0xyzzy\nbar")]
2452
values_to_get = [f.getvalue() for f in values_to_set]
2455
class TestSetTimeoutCmd(TestPropertySetterCmd):
2456
command = command.SetTimeout
1734
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1737
class TestSetTimeoutCmd(TestPropertyValueCmd):
1738
command = SetTimeoutCmd
2457
1739
propname = "Timeout"
2458
1740
values_to_set = [datetime.timedelta(),
2459
1741
datetime.timedelta(minutes=5),
2460
1742
datetime.timedelta(seconds=1),
2461
1743
datetime.timedelta(weeks=1),
2462
1744
datetime.timedelta(weeks=52)]
2463
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2466
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2467
command = command.SetExtendedTimeout
1745
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1748
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1749
command = SetExtendedTimeoutCmd
2468
1750
propname = "ExtendedTimeout"
2469
1751
values_to_set = [datetime.timedelta(),
2470
1752
datetime.timedelta(minutes=5),
2471
1753
datetime.timedelta(seconds=1),
2472
1754
datetime.timedelta(weeks=1),
2473
1755
datetime.timedelta(weeks=52)]
2474
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2477
class TestSetIntervalCmd(TestPropertySetterCmd):
2478
command = command.SetInterval
1756
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1759
class TestSetIntervalCmd(TestPropertyValueCmd):
1760
command = SetIntervalCmd
2479
1761
propname = "Interval"
2480
1762
values_to_set = [datetime.timedelta(),
2481
1763
datetime.timedelta(minutes=5),
2482
1764
datetime.timedelta(seconds=1),
2483
1765
datetime.timedelta(weeks=1),
2484
1766
datetime.timedelta(weeks=52)]
2485
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2488
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2489
command = command.SetApprovalDelay
1767
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1770
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1771
command = SetApprovalDelayCmd
2490
1772
propname = "ApprovalDelay"
2491
1773
values_to_set = [datetime.timedelta(),
2492
1774
datetime.timedelta(minutes=5),
2493
1775
datetime.timedelta(seconds=1),
2494
1776
datetime.timedelta(weeks=1),
2495
1777
datetime.timedelta(weeks=52)]
2496
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2499
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2500
command = command.SetApprovalDuration
1778
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1781
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1782
command = SetApprovalDurationCmd
2501
1783
propname = "ApprovalDuration"
2502
1784
values_to_set = [datetime.timedelta(),
2503
1785
datetime.timedelta(minutes=5),
2504
1786
datetime.timedelta(seconds=1),
2505
1787
datetime.timedelta(weeks=1),
2506
1788
datetime.timedelta(weeks=52)]
2507
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1789
values_to_get = [0, 300000, 1000, 604800000, 31449600000]