139
136
help="Select all clients")
140
137
parser.add_argument("-v", "--verbose", action="store_true",
141
138
help="Print all fields")
142
parser.add_argument("-j", "--dump-json", action="store_true",
139
parser.add_argument("-j", "--dump-json", dest="commands",
140
action="append_const", default=[],
141
const=command.DumpJSON(),
143
142
help="Dump client data in JSON format")
144
143
enable_disable = parser.add_mutually_exclusive_group()
145
enable_disable.add_argument("-e", "--enable", action="store_true",
144
enable_disable.add_argument("-e", "--enable", dest="commands",
145
action="append_const", default=[],
146
const=command.Enable(),
146
147
help="Enable client")
147
enable_disable.add_argument("-d", "--disable",
148
enable_disable.add_argument("-d", "--disable", dest="commands",
149
action="append_const", default=[],
150
const=command.Disable(),
149
151
help="disable client")
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
152
parser.add_argument("-b", "--bump-timeout", dest="commands",
153
action="append_const", default=[],
154
const=command.BumpTimeout(),
151
155
help="Bump timeout for client")
152
156
start_stop_checker = parser.add_mutually_exclusive_group()
153
157
start_stop_checker.add_argument("--start-checker",
159
action="append_const", default=[],
160
const=command.StartChecker(),
155
161
help="Start checker for client")
156
start_stop_checker.add_argument("--stop-checker",
162
start_stop_checker.add_argument("--stop-checker", dest="commands",
163
action="append_const", default=[],
164
const=command.StopChecker(),
158
165
help="Stop checker for client")
159
parser.add_argument("-V", "--is-enabled", action="store_true",
166
parser.add_argument("-V", "--is-enabled", dest="commands",
167
action="append_const", default=[],
168
const=command.IsEnabled(),
160
169
help="Check if client is enabled")
161
parser.add_argument("-r", "--remove", action="store_true",
170
parser.add_argument("-r", "--remove", dest="commands",
171
action="append_const", default=[],
172
const=command.Remove(),
162
173
help="Remove client")
163
parser.add_argument("-c", "--checker",
174
parser.add_argument("-c", "--checker", dest="commands",
175
action="append", default=[],
176
metavar="COMMAND", type=command.SetChecker,
164
177
help="Set checker command 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")
179
"-t", "--timeout", dest="commands", action="append",
180
default=[], metavar="TIME",
181
type=command.SetTimeout.argparse(string_to_delta),
182
help="Set timeout for client")
184
"--extended-timeout", dest="commands", action="append",
185
default=[], metavar="TIME",
186
type=command.SetExtendedTimeout.argparse(string_to_delta),
187
help="Set extended timeout for client")
189
"-i", "--interval", dest="commands", action="append",
190
default=[], metavar="TIME",
191
type=command.SetInterval.argparse(string_to_delta),
192
help="Set checker interval for client")
171
193
approve_deny_default = parser.add_mutually_exclusive_group()
172
194
approve_deny_default.add_argument(
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
195
"--approve-by-default", dest="commands",
196
action="append_const", default=[],
197
const=command.ApproveByDefault(),
175
198
help="Set client to be approved by default")
176
199
approve_deny_default.add_argument(
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
200
"--deny-by-default", dest="commands",
201
action="append_const", default=[],
202
const=command.DenyByDefault(),
179
203
help="Set client to be denied by default")
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")
205
"--approval-delay", dest="commands", action="append",
206
default=[], metavar="TIME",
207
type=command.SetApprovalDelay.argparse(string_to_delta),
208
help="Set delay before client approve/deny")
210
"--approval-duration", dest="commands", action="append",
211
default=[], metavar="TIME",
212
type=command.SetApprovalDuration.argparse(string_to_delta),
213
help="Set duration of one client approval")
214
parser.add_argument("-H", "--host", dest="commands",
215
action="append", default=[], metavar="STRING",
216
type=command.SetHost,
217
help="Set host for client")
219
"-s", "--secret", dest="commands", action="append",
220
default=[], metavar="FILENAME",
221
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
222
help="Set password blob (file) for client")
188
223
approve_deny = parser.add_mutually_exclusive_group()
189
224
approve_deny.add_argument(
190
"-A", "--approve", action="store_true",
225
"-A", "--approve", dest="commands", action="append_const",
226
default=[], const=command.Approve(),
191
227
help="Approve any current client request")
192
approve_deny.add_argument("-D", "--deny", action="store_true",
228
approve_deny.add_argument("-D", "--deny", dest="commands",
229
action="append_const", default=[],
230
const=command.Deny(),
193
231
help="Deny any current client request")
194
232
parser.add_argument("--debug", action="store_true",
195
233
help="Debug mode (show D-Bus commands)")
386
425
"""Apply additional restrictions on options, not expressible in
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,
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)
409
if has_actions(options) and not (options.client or options.all):
452
if has_commands(options) and not (options.client or options.all):
410
453
parser.error("Options require clients names or --all.")
411
if options.verbose and has_actions(options):
454
if options.verbose and has_commands(options):
412
455
parser.error("--verbose can only be used alone.")
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
456
if (has_commands(options, (command.DumpJSON,))
457
and (options.verbose or len(options.commands) > 1)):
415
458
parser.error("--dump-json can only be used alone.")
416
if options.all and not has_actions(options):
459
if options.all and not has_commands(options):
417
460
parser.error("--all requires an action.")
418
if options.is_enabled and len(options.client) > 1:
461
if (has_commands(options, (command.IsEnabled,))
462
and len(options.client) > 1):
419
463
parser.error("--is-enabled requires exactly one client")
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)
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
475
682
def commands_from_options(options):
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())
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)
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))
703
cleaned_after.append(cmd)
704
if cleaned_after != after_remove:
705
commands = before_remove + cleaned_after
541
707
# If no command option has been given, show table of clients,
542
708
# optionally verbosely
544
commands.append(PrintTableCmd(verbose=options.verbose))
710
commands.append(command.PrintTable(verbose=options.verbose))
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__
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
674
815
def __str__(self):
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)
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
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"
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"
897
1060
def test_actions_requires_client_or_all(self):
898
1061
for action, value in self.actions.items():
899
options = self.parser.parse_args()
900
setattr(options, action, value)
1062
args = self.actionargs(action, value)
901
1063
with self.assertParseError():
902
self.check_option_syntax(options)
1064
self.parse_args(args)
904
# This mostly corresponds to the definition from has_actions() in
1066
# This mostly corresponds to the definition from has_commands() in
905
1067
# check_option_syntax()
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"),
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)
1095
return [action] + list(args)
930
1097
@contextlib.contextmanager
931
1098
def assertParseError(self):
932
1099
with self.assertRaises(SystemExit) as e:
933
with self.temporarily_suppress_stderr():
1100
with self.redirect_stderr_to_devnull():
935
1102
# Exit code from argparse is guaranteed to be "2". Reference:
936
1103
# https://docs.python.org/3/library
937
1104
# /argparse.html#exiting-methods
938
self.assertEqual(e.exception.code, 2)
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)
941
1112
@contextlib.contextmanager
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())
1113
def redirect_stderr_to_devnull():
1114
old_stderr = sys.stderr
1115
with contextlib.closing(open(os.devnull, "w")) as null:
1120
sys.stderr = old_stderr
954
1122
def check_option_syntax(self, options):
955
1123
check_option_syntax(self.parser, options)
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)
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)
965
1139
def test_dump_json_conflicts_with_verbose(self):
966
options = self.parser.parse_args()
967
options.dump_json = True
968
options.verbose = True
1140
args = ["--dump-json", "--verbose"]
969
1141
with self.assertParseError():
970
self.check_option_syntax(options)
1142
self.parse_args(args)
972
1144
def test_dump_json_conflicts_with_action(self):
973
1145
for action, value in self.actions.items():
974
options = self.parser.parse_args()
975
setattr(options, action, value)
976
options.dump_json = True
1146
args = self.actionargs(action, value, "--dump-json")
977
1147
with self.assertParseError():
978
self.check_option_syntax(options)
1148
self.parse_args(args)
980
1150
def test_all_can_not_be_alone(self):
981
options = self.parser.parse_args()
983
1152
with self.assertParseError():
984
self.check_option_syntax(options)
1153
self.parse_args(args)
986
1155
def test_all_is_ok_with_any_action(self):
987
1156
for action, value in self.actions.items():
988
options = self.parser.parse_args()
989
setattr(options, action, value)
991
self.check_option_syntax(options)
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)
993
1188
def test_is_enabled_fails_without_client(self):
994
options = self.parser.parse_args()
995
options.is_enabled = True
1189
args = ["--is-enabled"]
996
1190
with self.assertParseError():
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)
1191
self.parse_args(args)
1005
1193
def test_is_enabled_fails_with_two_clients(self):
1006
options = self.parser.parse_args()
1007
options.is_enabled = True
1008
options.client = ["foo", "barbar"]
1194
args = ["--is-enabled", "client1", "client2"]
1009
1195
with self.assertParseError():
1010
self.check_option_syntax(options)
1196
self.parse_args(args)
1012
1198
def test_remove_can_only_be_combined_with_action_deny(self):
1013
1199
for action, value in self.actions.items():
1014
if action in {"remove", "deny"}:
1200
if action in {"--remove", "--deny"}:
1016
options = self.parser.parse_args()
1017
setattr(options, action, value)
1019
options.remove = True
1202
args = self.actionargs(action, value, "--all",
1020
1204
with self.assertParseError():
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):
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):
1065
1505
dbus_logger = logging.getLogger("dbus.proxies")
1067
class MockObjectManagerFailing(object):
1068
def GetManagedObjects(self):
1069
dbus_logger.error("Test")
1070
raise dbus.exceptions.DBusException("Test")
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)
1072
1514
class CountingHandler(logging.Handler):
1079
1521
dbus_logger.addHandler(counting_handler)
1082
with self.assertLogs(log, logging.CRITICAL) as watcher:
1083
with self.assertRaises(SystemExit) as e:
1084
get_managed_objects(MockObjectManagerFailing())
1524
with self.assertRaises(dbus.Error) as e:
1525
self.call_method(bus, "methodname", "busname",
1526
"objectpath", "interface")
1086
1528
dbus_logger.removeFilter(counting_handler)
1530
self.assertNotIsInstance(e, dbus.ConnectFailed)
1088
1532
# Make sure the dbus logger was suppressed
1089
self.assertEqual(counting_handler.count, 0)
1091
# Test that the dbus_logger still works
1092
with self.assertLogs(dbus_logger, logging.ERROR):
1093
dbus_logger.error("Test")
1095
if isinstance(e.exception.code, int):
1096
self.assertNotEqual(e.exception.code, 0)
1098
self.assertIsNotNone(e.exception.code)
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)
1101
1774
class Test_commands_from_options(unittest.TestCase):
1102
1776
def setUp(self):
1103
1777
self.parser = argparse.ArgumentParser()
1104
1778
add_command_line_options(self.parser)
1106
1780
def test_is_enabled(self):
1107
self.assert_command_from_args(["--is-enabled", "foo"],
1781
self.assert_command_from_args(["--is-enabled", "client"],
1110
def assert_command_from_args(self, args, command_cls,
1784
def assert_command_from_args(self, args, command_cls, length=1,
1785
clients=None, **cmd_attrs):
1112
1786
"""Assert that parsing ARGS should result in an instance of
1113
1787
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1114
1788
options = self.parser.parse_args(args)
1115
1789
check_option_syntax(self.parser, options)
1116
1790
commands = commands_from_options(options)
1117
self.assertEqual(len(commands), 1)
1118
command = commands[0]
1119
self.assertIsInstance(command, command_cls)
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)
1120
1799
for key, value in cmd_attrs.items():
1121
self.assertEqual(getattr(command, key), value)
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),
1123
1808
def test_is_enabled_short(self):
1124
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1809
self.assert_command_from_args(["-V", "client"],
1126
1812
def test_approve(self):
1127
self.assert_command_from_args(["--approve", "foo"],
1813
self.assert_command_from_args(["--approve", "client"],
1130
1816
def test_approve_short(self):
1131
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1817
self.assert_command_from_args(["-A", "client"],
1133
1820
def test_deny(self):
1134
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1821
self.assert_command_from_args(["--deny", "client"],
1136
1824
def test_deny_short(self):
1137
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1825
self.assert_command_from_args(["-D", "client"], command.Deny)
1139
1827
def test_remove(self):
1140
self.assert_command_from_args(["--remove", "foo"],
1828
self.assert_command_from_args(["--remove", "client"],
1143
1831
def test_deny_before_remove(self):
1144
1832
options = self.parser.parse_args(["--deny", "--remove",
1146
1834
check_option_syntax(self.parser, options)
1147
1835
commands = commands_from_options(options)
1148
self.assertEqual(len(commands), 2)
1149
self.assertIsInstance(commands[0], DenyCmd)
1150
self.assertIsInstance(commands[1], RemoveCmd)
1836
self.assertEqual(2, len(commands))
1837
self.assertIsInstance(commands[0], command.Deny)
1838
self.assertIsInstance(commands[1], command.Remove)
1152
1840
def test_deny_before_remove_reversed(self):
1153
1841
options = self.parser.parse_args(["--remove", "--deny",
1155
1843
check_option_syntax(self.parser, options)
1156
1844
commands = commands_from_options(options)
1157
self.assertEqual(len(commands), 2)
1158
self.assertIsInstance(commands[0], DenyCmd)
1159
self.assertIsInstance(commands[1], RemoveCmd)
1845
self.assertEqual(2, len(commands))
1846
self.assertIsInstance(commands[0], command.Deny)
1847
self.assertIsInstance(commands[1], command.Remove)
1161
1849
def test_remove_short(self):
1162
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1850
self.assert_command_from_args(["-r", "client"],
1164
1853
def test_dump_json(self):
1165
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1854
self.assert_command_from_args(["--dump-json"],
1167
1857
def test_enable(self):
1168
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1858
self.assert_command_from_args(["--enable", "client"],
1170
1861
def test_enable_short(self):
1171
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1862
self.assert_command_from_args(["-e", "client"],
1173
1865
def test_disable(self):
1174
self.assert_command_from_args(["--disable", "foo"],
1866
self.assert_command_from_args(["--disable", "client"],
1177
1869
def test_disable_short(self):
1178
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1870
self.assert_command_from_args(["-d", "client"],
1180
1873
def test_bump_timeout(self):
1181
self.assert_command_from_args(["--bump-timeout", "foo"],
1874
self.assert_command_from_args(["--bump-timeout", "client"],
1875
command.BumpTimeout)
1184
1877
def test_bump_timeout_short(self):
1185
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1878
self.assert_command_from_args(["-b", "client"],
1879
command.BumpTimeout)
1187
1881
def test_start_checker(self):
1188
self.assert_command_from_args(["--start-checker", "foo"],
1882
self.assert_command_from_args(["--start-checker", "client"],
1883
command.StartChecker)
1191
1885
def test_stop_checker(self):
1192
self.assert_command_from_args(["--stop-checker", "foo"],
1886
self.assert_command_from_args(["--stop-checker", "client"],
1887
command.StopChecker)
1195
1889
def test_approve_by_default(self):
1196
self.assert_command_from_args(["--approve-by-default", "foo"],
1197
ApproveByDefaultCmd)
1890
self.assert_command_from_args(["--approve-by-default",
1892
command.ApproveByDefault)
1199
1894
def test_deny_by_default(self):
1200
self.assert_command_from_args(["--deny-by-default", "foo"],
1895
self.assert_command_from_args(["--deny-by-default", "client"],
1896
command.DenyByDefault)
1203
1898
def test_checker(self):
1204
self.assert_command_from_args(["--checker", ":", "foo"],
1205
SetCheckerCmd, value_to_set=":")
1899
self.assert_command_from_args(["--checker", ":", "client"],
1207
1903
def test_checker_empty(self):
1208
self.assert_command_from_args(["--checker", "", "foo"],
1209
SetCheckerCmd, value_to_set="")
1904
self.assert_command_from_args(["--checker", "", "client"],
1211
1908
def test_checker_short(self):
1212
self.assert_command_from_args(["-c", ":", "foo"],
1213
SetCheckerCmd, value_to_set=":")
1909
self.assert_command_from_args(["-c", ":", "client"],
1215
1913
def test_host(self):
1216
self.assert_command_from_args(["--host", "foo.example.org",
1218
value_to_set="foo.example.org")
1914
self.assert_command_from_args(
1915
["--host", "client.example.org", "client"],
1916
command.SetHost, value_to_set="client.example.org")
1220
1918
def test_host_short(self):
1221
self.assert_command_from_args(["-H", "foo.example.org",
1223
value_to_set="foo.example.org")
1919
self.assert_command_from_args(
1920
["-H", "client.example.org", "client"], command.SetHost,
1921
value_to_set="client.example.org")
1225
1923
def test_secret_devnull(self):
1226
1924
self.assert_command_from_args(["--secret", os.path.devnull,
1227
"foo"], SetSecretCmd,
1925
"client"], command.SetSecret,
1228
1926
value_to_set=b"")
1230
1928
def test_secret_tempfile(self):
1235
1933
self.assert_command_from_args(["--secret", f.name,
1236
"foo"], SetSecretCmd,
1237
1936
value_to_set=value)
1239
1938
def test_secret_devnull_short(self):
1240
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1241
SetSecretCmd, value_to_set=b"")
1939
self.assert_command_from_args(["-s", os.path.devnull,
1940
"client"], command.SetSecret,
1243
1943
def test_secret_tempfile_short(self):
1244
1944
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1245
1945
value = b"secret\0xyzzy\nbar"
1248
self.assert_command_from_args(["-s", f.name, "foo"],
1948
self.assert_command_from_args(["-s", f.name, "client"],
1250
1950
value_to_set=value)
1252
1952
def test_timeout(self):
1253
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1953
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1255
1955
value_to_set=300000)
1257
1957
def test_timeout_short(self):
1258
self.assert_command_from_args(["-t", "PT5M", "foo"],
1958
self.assert_command_from_args(["-t", "PT5M", "client"],
1260
1960
value_to_set=300000)
1262
1962
def test_extended_timeout(self):
1263
1963
self.assert_command_from_args(["--extended-timeout", "PT15M",
1265
SetExtendedTimeoutCmd,
1965
command.SetExtendedTimeout,
1266
1966
value_to_set=900000)
1268
1968
def test_interval(self):
1269
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1969
self.assert_command_from_args(["--interval", "PT2M",
1970
"client"], command.SetInterval,
1271
1971
value_to_set=120000)
1273
1973
def test_interval_short(self):
1274
self.assert_command_from_args(["-i", "PT2M", "foo"],
1974
self.assert_command_from_args(["-i", "PT2M", "client"],
1975
command.SetInterval,
1276
1976
value_to_set=120000)
1278
1978
def test_approval_delay(self):
1279
1979
self.assert_command_from_args(["--approval-delay", "PT30S",
1280
"foo"], SetApprovalDelayCmd,
1981
command.SetApprovalDelay,
1281
1982
value_to_set=30000)
1283
1984
def test_approval_duration(self):
1284
1985
self.assert_command_from_args(["--approval-duration", "PT1S",
1285
"foo"], SetApprovalDurationCmd,
1987
command.SetApprovalDuration,
1286
1988
value_to_set=1000)
1288
1990
def test_print_table(self):
1289
self.assert_command_from_args([], PrintTableCmd,
1991
self.assert_command_from_args([], command.PrintTable,
1292
1994
def test_print_table_verbose(self):
1293
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1995
self.assert_command_from_args(["--verbose"],
1296
1999
def test_print_table_verbose_short(self):
1297
self.assert_command_from_args(["-v"], PrintTableCmd,
2000
self.assert_command_from_args(["-v"], command.PrintTable,
1301
class TestCmd(unittest.TestCase):
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):
1302
2036
"""Abstract class for tests of command classes"""
1306
class MockClient(object):
1307
def __init__(self, name, **attributes):
1308
self.__dbus_object_path__ = "/clients/{}".format(name)
1309
self.attributes = attributes
1310
self.attributes["Name"] = name
1312
def Set(self, interface, propname, value, dbus_interface):
1313
testcase.assertEqual(interface, client_dbus_interface)
1314
testcase.assertEqual(dbus_interface,
1315
dbus.PROPERTIES_IFACE)
1316
self.attributes[propname] = value
1317
def Get(self, interface, propname, dbus_interface):
1318
testcase.assertEqual(interface, client_dbus_interface)
1319
testcase.assertEqual(dbus_interface,
1320
dbus.PROPERTIES_IFACE)
1321
return self.attributes[propname]
1322
def Approve(self, approve, dbus_interface):
1323
testcase.assertEqual(dbus_interface,
1324
client_dbus_interface)
1325
self.calls.append(("Approve", (approve,
1327
self.client = MockClient(
1329
KeyID=("92ed150794387c03ce684574b1139a65"
1330
"94a34f895daaaf09fd8ea90a27cddb12"),
1332
Host="foo.example.org",
1333
Enabled=dbus.Boolean(True),
1335
LastCheckedOK="2019-02-03T00:00:00",
1336
Created="2019-01-02T00:00:00",
1338
Fingerprint=("778827225BA7DE539C5A"
1339
"7CFA59CFF7CDBD9A5920"),
1340
CheckerRunning=dbus.Boolean(False),
1341
LastEnabled="2019-01-03T00:00:00",
1342
ApprovalPending=dbus.Boolean(False),
1343
ApprovedByDefault=dbus.Boolean(True),
1344
LastApprovalRequest="",
1346
ApprovalDuration=1000,
1347
Checker="fping -q -- %(host)s",
1348
ExtendedTimeout=900000,
1349
Expires="2019-02-04T00:00:00",
1350
LastCheckerStatus=0)
1351
self.other_client = MockClient(
1353
KeyID=("0558568eedd67d622f5c83b35a115f79"
1354
"6ab612cff5ad227247e46c2b020f441c"),
1355
Secret=b"secretbar",
1357
Enabled=dbus.Boolean(True),
1359
LastCheckedOK="2019-02-04T00:00:00",
1360
Created="2019-01-03T00:00:00",
1362
Fingerprint=("3E393AEAEFB84C7E89E2"
1363
"F547B3A107558FCA3A27"),
1364
CheckerRunning=dbus.Boolean(True),
1365
LastEnabled="2019-01-04T00:00:00",
1366
ApprovalPending=dbus.Boolean(False),
1367
ApprovedByDefault=dbus.Boolean(False),
1368
LastApprovalRequest="2019-01-03T00:00:00",
1369
ApprovalDelay=30000,
1370
ApprovalDuration=93785000,
1372
ExtendedTimeout=900000,
1373
Expires="2019-02-05T00:00:00",
1374
LastCheckerStatus=-2)
1375
self.clients = collections.OrderedDict(
1377
("/clients/foo", self.client.attributes),
1378
("/clients/barbar", self.other_client.attributes),
1380
self.one_client = {"/clients/foo": self.client.attributes}
1386
def get_object(client_bus_name, path):
1387
self.assertEqual(client_bus_name, dbus_busname)
1389
# Note: "self" here is the TestCmd instance, not
1390
# the Bus instance, since this is a static method!
1391
"/clients/foo": self.client,
1392
"/clients/barbar": self.other_client,
1397
class TestIsEnabledCmd(TestCmd):
1398
def test_is_enabled(self):
1399
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1401
for client, properties
1402
in self.clients.items()))
1404
def test_is_enabled_run_exits_successfully(self):
1405
with self.assertRaises(SystemExit) as e:
1406
IsEnabledCmd().run(self.one_client)
1407
if e.exception.code is not None:
1408
self.assertEqual(e.exception.code, 0)
1410
self.assertIsNone(e.exception.code)
1412
def test_is_enabled_run_exits_with_failure(self):
1413
self.client.attributes["Enabled"] = dbus.Boolean(False)
1414
with self.assertRaises(SystemExit) as e:
1415
IsEnabledCmd().run(self.one_client)
1416
if isinstance(e.exception.code, int):
1417
self.assertNotEqual(e.exception.code, 0)
1419
self.assertIsNotNone(e.exception.code)
1422
class TestApproveCmd(TestCmd):
1423
def test_approve(self):
1424
ApproveCmd().run(self.clients, self.bus)
1425
for clientpath in self.clients:
1426
client = self.bus.get_object(dbus_busname, clientpath)
1427
self.assertIn(("Approve", (True, client_dbus_interface)),
1431
class TestDenyCmd(TestCmd):
1432
def test_deny(self):
1433
DenyCmd().run(self.clients, self.bus)
1434
for clientpath in self.clients:
1435
client = self.bus.get_object(dbus_busname, clientpath)
1436
self.assertIn(("Approve", (False, client_dbus_interface)),
1440
class TestRemoveCmd(TestCmd):
1441
def test_remove(self):
1442
class MockMandos(object):
1445
def RemoveClient(self, dbus_path):
1446
self.calls.append(("RemoveClient", (dbus_path,)))
1447
mandos = MockMandos()
1448
super(TestRemoveCmd, self).setUp()
1449
RemoveCmd().run(self.clients, self.bus, mandos)
1450
self.assertEqual(len(mandos.calls), 2)
1451
for clientpath in self.clients:
1452
self.assertIn(("RemoveClient", (clientpath,)),
1456
class TestDumpJSONCmd(TestCmd):
1458
self.expected_json = {
2038
class FakeMandosBus(dbus.MandosBus):
2039
def __init__(self, testcase):
2040
self.client_properties = {
1461
2042
"KeyID": ("92ed150794387c03ce684574b1139a65"
1462
2043
"94a34f895daaaf09fd8ea90a27cddb12"),
2044
"Secret": b"secret",
1463
2045
"Host": "foo.example.org",
1464
2046
"Enabled": True,
1465
2047
"Timeout": 300000,
1503
2086
"ExtendedTimeout": 900000,
1504
2087
"Expires": "2019-02-05T00:00:00",
1505
2088
"LastCheckerStatus": -2,
1508
return super(TestDumpJSONCmd, self).setUp()
1510
def test_normal(self):
1511
output = DumpJSONCmd().output(self.clients.values())
1512
json_data = json.loads(output)
1513
self.assertDictEqual(json_data, self.expected_json)
1515
def test_one_client(self):
1516
output = DumpJSONCmd().output(self.one_client.values())
1517
json_data = json.loads(output)
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):
2133
with self.assertRaises(SystemExit) as e:
2134
command.IsEnabled().run(self.bus.one_client)
2135
if e.exception.code is not None:
2136
self.assertEqual(0, e.exception.code)
2138
self.assertIsNone(e.exception.code)
2140
def test_IsEnabled_exits_with_failure(self):
2141
self.bus.client_properties["Enabled"] = False
2142
with self.assertRaises(SystemExit) as e:
2143
command.IsEnabled().run(self.bus.one_client)
2144
if isinstance(e.exception.code, int):
2145
self.assertNotEqual(0, e.exception.code)
2147
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())
1518
2245
expected_json = {"foo": self.expected_json["foo"]}
1519
self.assertDictEqual(json_data, expected_json)
1522
class TestPrintTableCmd(TestCmd):
1523
def test_normal(self):
1524
output = PrintTableCmd().output(self.clients.values())
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)
1525
2251
expected_output = "\n".join((
1526
2252
"Name Enabled Timeout Last Successful Check",
1527
2253
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1528
2254
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1530
self.assertEqual(output, expected_output)
2256
self.assertEqual(expected_output, buffer.getvalue())
1532
def test_verbose(self):
1533
output = PrintTableCmd(verbose=True).output(
1534
self.clients.values())
2258
def test_PrintTable_verbose(self):
2259
with self.capture_stdout_to_buffer() as buffer:
2260
command.PrintTable(verbose=True).run(self.bus.clients)
1621
2347
num_lines = max(len(rows) for rows in columns)
1622
expected_output = "\n".join("".join(rows[line]
1623
for rows in columns)
1624
for line in range(num_lines))
1625
self.assertEqual(output, expected_output)
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())
1627
def test_one_client(self):
1628
output = PrintTableCmd().output(self.one_client.values())
2354
def test_PrintTable_one_client(self):
2355
with self.capture_stdout_to_buffer() as buffer:
2356
command.PrintTable().run(self.bus.one_client)
1629
2357
expected_output = "\n".join((
1630
2358
"Name Enabled Timeout Last Successful Check",
1631
2359
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1633
self.assertEqual(output, expected_output)
1636
class TestPropertyCmd(TestCmd):
1637
"""Abstract class for tests of PropertyCmd classes"""
2361
self.assertEqual(expected_output, buffer.getvalue())
2364
class TestPropertySetterCmd(TestCommand):
2365
"""Abstract class for tests of command.PropertySetter classes"""
1638
2367
def runTest(self):
1639
2368
if not hasattr(self, "command"):
1641
values_to_get = getattr(self, "values_to_get",
1643
for value_to_set, value_to_get in zip(self.values_to_set,
1645
for clientpath in self.clients:
1646
client = self.bus.get_object(dbus_busname, clientpath)
1647
old_value = client.attributes[self.propname]
1648
self.assertNotIsInstance(old_value, self.Unique)
1649
client.attributes[self.propname] = self.Unique()
1650
self.run_command(value_to_set, self.clients)
1651
for clientpath in self.clients:
1652
client = self.bus.get_object(dbus_busname, clientpath)
1653
value = client.attributes[self.propname]
1654
self.assertNotIsInstance(value, self.Unique)
1655
self.assertEqual(value, value_to_get)
1657
class Unique(object):
1658
"""Class for objects which exist only to be unique objects,
1659
since unittest.mock.sentinel only exists in Python 3.3"""
1661
def run_command(self, value, clients):
1662
self.command().run(clients, self.bus)
1665
class TestEnableCmd(TestPropertyCmd):
1667
propname = "Enabled"
1668
values_to_set = [dbus.Boolean(True)]
1671
class TestDisableCmd(TestPropertyCmd):
1672
command = DisableCmd
1673
propname = "Enabled"
1674
values_to_set = [dbus.Boolean(False)]
1677
class TestBumpTimeoutCmd(TestPropertyCmd):
1678
command = BumpTimeoutCmd
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]
2386
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
1679
2404
propname = "LastCheckedOK"
1680
values_to_set = [""]
1683
class TestStartCheckerCmd(TestPropertyCmd):
1684
command = StartCheckerCmd
1685
propname = "CheckerRunning"
1686
values_to_set = [dbus.Boolean(True)]
1689
class TestStopCheckerCmd(TestPropertyCmd):
1690
command = StopCheckerCmd
1691
propname = "CheckerRunning"
1692
values_to_set = [dbus.Boolean(False)]
1695
class TestApproveByDefaultCmd(TestPropertyCmd):
1696
command = ApproveByDefaultCmd
1697
propname = "ApprovedByDefault"
1698
values_to_set = [dbus.Boolean(True)]
1701
class TestDenyByDefaultCmd(TestPropertyCmd):
1702
command = DenyByDefaultCmd
1703
propname = "ApprovedByDefault"
1704
values_to_set = [dbus.Boolean(False)]
1707
class TestPropertyValueCmd(TestPropertyCmd):
1708
"""Abstract class for tests of PropertyValueCmd classes"""
1711
if type(self) is TestPropertyValueCmd:
1713
return super(TestPropertyValueCmd, self).runTest()
1715
def run_command(self, value, clients):
1716
self.command(value).run(clients, self.bus)
1719
class TestSetCheckerCmd(TestPropertyValueCmd):
1720
command = SetCheckerCmd
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
1721
2434
propname = "Checker"
1722
2435
values_to_set = ["", ":", "fping -q -- %s"]
1725
class TestSetHostCmd(TestPropertyValueCmd):
1726
command = SetHostCmd
2438
class TestSetHostCmd(TestPropertySetterCmd):
2439
command = command.SetHost
1727
2440
propname = "Host"
1728
values_to_set = ["192.0.2.3", "foo.example.org"]
1731
class TestSetSecretCmd(TestPropertyValueCmd):
1732
command = SetSecretCmd
2441
values_to_set = ["192.0.2.3", "client.example.org"]
2444
class TestSetSecretCmd(TestPropertySetterCmd):
2445
command = command.SetSecret
1733
2446
propname = "Secret"
1734
2447
values_to_set = [io.BytesIO(b""),
1735
2448
io.BytesIO(b"secret\0xyzzy\nbar")]
1736
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1739
class TestSetTimeoutCmd(TestPropertyValueCmd):
1740
command = SetTimeoutCmd
2449
values_to_get = [f.getvalue() for f in values_to_set]
2452
class TestSetTimeoutCmd(TestPropertySetterCmd):
2453
command = command.SetTimeout
1741
2454
propname = "Timeout"
1742
2455
values_to_set = [datetime.timedelta(),
1743
2456
datetime.timedelta(minutes=5),
1744
2457
datetime.timedelta(seconds=1),
1745
2458
datetime.timedelta(weeks=1),
1746
2459
datetime.timedelta(weeks=52)]
1747
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1750
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1751
command = SetExtendedTimeoutCmd
2460
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2463
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2464
command = command.SetExtendedTimeout
1752
2465
propname = "ExtendedTimeout"
1753
2466
values_to_set = [datetime.timedelta(),
1754
2467
datetime.timedelta(minutes=5),
1755
2468
datetime.timedelta(seconds=1),
1756
2469
datetime.timedelta(weeks=1),
1757
2470
datetime.timedelta(weeks=52)]
1758
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1761
class TestSetIntervalCmd(TestPropertyValueCmd):
1762
command = SetIntervalCmd
2471
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2474
class TestSetIntervalCmd(TestPropertySetterCmd):
2475
command = command.SetInterval
1763
2476
propname = "Interval"
1764
2477
values_to_set = [datetime.timedelta(),
1765
2478
datetime.timedelta(minutes=5),
1766
2479
datetime.timedelta(seconds=1),
1767
2480
datetime.timedelta(weeks=1),
1768
2481
datetime.timedelta(weeks=52)]
1769
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1772
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1773
command = SetApprovalDelayCmd
2482
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2485
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2486
command = command.SetApprovalDelay
1774
2487
propname = "ApprovalDelay"
1775
2488
values_to_set = [datetime.timedelta(),
1776
2489
datetime.timedelta(minutes=5),
1777
2490
datetime.timedelta(seconds=1),
1778
2491
datetime.timedelta(weeks=1),
1779
2492
datetime.timedelta(weeks=52)]
1780
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1783
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1784
command = SetApprovalDurationCmd
2493
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2496
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2497
command = command.SetApprovalDuration
1785
2498
propname = "ApprovalDuration"
1786
2499
values_to_set = [datetime.timedelta(),
1787
2500
datetime.timedelta(minutes=5),
1788
2501
datetime.timedelta(seconds=1),
1789
2502
datetime.timedelta(weeks=1),
1790
2503
datetime.timedelta(weeks=52)]
1791
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2504
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]