To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1085
- compare with another revision
- download diff
- download tarball
- view history from revision 1085
- Committer: Teddy Hogeborn
- Date: 2019-03-17 21:29:32 UTC
- Revision ID: teddy@recompile.se-20190317212932-r3libgz33mkb85rw
mandos-ctl: Refactor
* mandos-ctl: For Python 2, use StringIO.StringIO as a replacement for
io.StringIO, since Python 2's io.StringIO won't work
with print redirection.
(Output.run, Output.output): Remove.
(DumpJSON.output): Rename to "run" and change signature to match.
Also change code to print instead of returning
string.
(PrintTable.output): - '' -
* mandos-ctl: For Python 2, use StringIO.StringIO as a replacement for
io.StringIO, since Python 2's io.StringIO won't work
with print redirection.
(Output.run, Output.output): Remove.
(DumpJSON.output): Rename to "run" and change signature to match.
Also change code to print instead of returning
string.
(PrintTable.output): - '' -
- files removed:
- initramfs-tools-conf-hook
- files modified:
- Makefile
added
removed
mandos-ctl
46
46
import tempfile
47
47
import contextlib
48
48
49
try:
50
import pydbus
51
import gi
52
dbus_python = None
53
except ImportError:
54
import dbus as dbus_python
55
pydbus = None
56
class gi(object):
57
"""Dummy gi module, for the tests"""
58
class repository(object):
59
class GLib(object):
60
class Error(Exception):
61
pass
49
import dbus
62
50
63
51
# Show warnings by default
64
52
if not sys.warnoptions:
78
66
79
67
locale.setlocale(locale.LC_ALL, "")
80
68
69
dbus_busname_domain = "se.recompile"
70
dbus_busname = dbus_busname_domain + ".Mandos"
71
server_dbus_path = "/"
72
server_dbus_interface = dbus_busname_domain + ".Mandos"
73
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
74
del dbus_busname_domain
81
75
version = "1.8.3"
82
76
83
77
78
try:
79
dbus.OBJECT_MANAGER_IFACE
80
except AttributeError:
81
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
82
83
84
84
def main():
85
85
parser = argparse.ArgumentParser()
86
86
87
add_command_line_options(parser)
87
88
88
89
options = parser.parse_args()
90
89
91
check_option_syntax(parser, options)
90
92
91
93
clientnames = options.client
93
95
if options.debug:
94
96
log.setLevel(logging.DEBUG)
95
97
96
if pydbus is not None:
97
bus = pydbus_adapter.CachingBus(pydbus)
98
else:
99
bus = dbus_python_adapter.CachingBus(dbus_python)
100
101
try:
102
all_clients = bus.get_clients_and_properties()
103
except dbus.ConnectFailed as e:
104
log.critical("Could not connect to Mandos server: %s", e)
105
sys.exit(1)
106
except dbus.Error as e:
107
log.critical(
108
"Failed to access Mandos server through D-Bus:\n%s", e)
109
sys.exit(1)
98
bus = dbus.SystemBus()
99
100
mandos_dbus_object = get_mandos_dbus_object(bus)
101
102
mandos_serv = dbus.Interface(
103
mandos_dbus_object, dbus_interface=server_dbus_interface)
104
mandos_serv_object_manager = dbus.Interface(
105
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
106
107
managed_objects = get_managed_objects(mandos_serv_object_manager)
108
109
all_clients = {}
110
for path, ifs_and_props in managed_objects.items():
111
try:
112
all_clients[path] = ifs_and_props[client_dbus_interface]
113
except KeyError:
114
pass
110
115
111
116
# Compile dict of (clientpath: properties) to process
112
117
if not clientnames:
125
130
commands = commands_from_options(options)
126
131
127
132
for command in commands:
128
command.run(clients, bus)
133
command.run(clients, bus, mandos_serv)
129
134
130
135
131
136
def add_command_line_options(parser):
136
141
help="Select all clients")
137
142
parser.add_argument("-v", "--verbose", action="store_true",
138
143
help="Print all fields")
139
parser.add_argument("-j", "--dump-json", dest="commands",
140
action="append_const", default=[],
141
const=command.DumpJSON(),
144
parser.add_argument("-j", "--dump-json", action="store_true",
142
145
help="Dump client data in JSON format")
143
146
enable_disable = parser.add_mutually_exclusive_group()
144
enable_disable.add_argument("-e", "--enable", dest="commands",
145
action="append_const", default=[],
146
const=command.Enable(),
147
enable_disable.add_argument("-e", "--enable", action="store_true",
147
148
help="Enable client")
148
enable_disable.add_argument("-d", "--disable", dest="commands",
149
action="append_const", default=[],
150
const=command.Disable(),
149
enable_disable.add_argument("-d", "--disable",
150
action="store_true",
151
151
help="disable client")
152
parser.add_argument("-b", "--bump-timeout", dest="commands",
153
action="append_const", default=[],
154
const=command.BumpTimeout(),
152
parser.add_argument("-b", "--bump-timeout", action="store_true",
155
153
help="Bump timeout for client")
156
154
start_stop_checker = parser.add_mutually_exclusive_group()
157
155
start_stop_checker.add_argument("--start-checker",
158
dest="commands",
159
action="append_const", default=[],
160
const=command.StartChecker(),
156
action="store_true",
161
157
help="Start checker for client")
162
start_stop_checker.add_argument("--stop-checker", dest="commands",
163
action="append_const", default=[],
164
const=command.StopChecker(),
158
start_stop_checker.add_argument("--stop-checker",
159
action="store_true",
165
160
help="Stop checker for client")
166
parser.add_argument("-V", "--is-enabled", dest="commands",
167
action="append_const", default=[],
168
const=command.IsEnabled(),
161
parser.add_argument("-V", "--is-enabled", action="store_true",
169
162
help="Check if client is enabled")
170
parser.add_argument("-r", "--remove", dest="commands",
171
action="append_const", default=[],
172
const=command.Remove(),
163
parser.add_argument("-r", "--remove", action="store_true",
173
164
help="Remove client")
174
parser.add_argument("-c", "--checker", dest="commands",
175
action="append", default=[],
176
metavar="COMMAND", type=command.SetChecker,
165
parser.add_argument("-c", "--checker",
177
166
help="Set checker command for client")
178
parser.add_argument(
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")
183
parser.add_argument(
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")
188
parser.add_argument(
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")
167
parser.add_argument("-t", "--timeout", type=string_to_delta,
168
help="Set timeout for client")
169
parser.add_argument("--extended-timeout", type=string_to_delta,
170
help="Set extended timeout for client")
171
parser.add_argument("-i", "--interval", type=string_to_delta,
172
help="Set checker interval for client")
193
173
approve_deny_default = parser.add_mutually_exclusive_group()
194
174
approve_deny_default.add_argument(
195
"--approve-by-default", dest="commands",
196
action="append_const", default=[],
197
const=command.ApproveByDefault(),
175
"--approve-by-default", action="store_true",
176
default=None, dest="approved_by_default",
198
177
help="Set client to be approved by default")
199
178
approve_deny_default.add_argument(
200
"--deny-by-default", dest="commands",
201
action="append_const", default=[],
202
const=command.DenyByDefault(),
179
"--deny-by-default", action="store_false",
180
dest="approved_by_default",
203
181
help="Set client to be denied by default")
204
parser.add_argument(
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")
209
parser.add_argument(
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")
218
parser.add_argument(
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")
182
parser.add_argument("--approval-delay", type=string_to_delta,
183
help="Set delay before client approve/deny")
184
parser.add_argument("--approval-duration", type=string_to_delta,
185
help="Set duration of one client approval")
186
parser.add_argument("-H", "--host", help="Set host for client")
187
parser.add_argument("-s", "--secret",
188
type=argparse.FileType(mode="rb"),
189
help="Set password blob (file) for client")
223
190
approve_deny = parser.add_mutually_exclusive_group()
224
191
approve_deny.add_argument(
225
"-A", "--approve", dest="commands", action="append_const",
226
default=[], const=command.Approve(),
192
"-A", "--approve", action="store_true",
227
193
help="Approve any current client request")
228
approve_deny.add_argument("-D", "--deny", dest="commands",
229
action="append_const", default=[],
230
const=command.Deny(),
194
approve_deny.add_argument("-D", "--deny", action="store_true",
231
195
help="Deny any current client request")
232
196
parser.add_argument("--debug", action="store_true",
233
197
help="Debug mode (show D-Bus commands)")
424
388
"""Apply additional restrictions on options, not expressible in
425
389
argparse"""
426
390
427
def has_commands(options, commands=None):
428
if commands is None:
429
commands = (command.Enable,
430
command.Disable,
431
command.BumpTimeout,
432
command.StartChecker,
433
command.StopChecker,
434
command.IsEnabled,
435
command.Remove,
436
command.SetChecker,
437
command.SetTimeout,
438
command.SetExtendedTimeout,
439
command.SetInterval,
440
command.ApproveByDefault,
441
command.DenyByDefault,
442
command.SetApprovalDelay,
443
command.SetApprovalDuration,
444
command.SetHost,
445
command.SetSecret,
446
command.Approve,
447
command.Deny)
448
return any(isinstance(cmd, commands)
449
for cmd in options.commands)
391
def has_actions(options):
392
return any((options.enable,
393
options.disable,
394
options.bump_timeout,
395
options.start_checker,
396
options.stop_checker,
397
options.is_enabled,
398
options.remove,
399
options.checker is not None,
400
options.timeout is not None,
401
options.extended_timeout is not None,
402
options.interval is not None,
403
options.approved_by_default is not None,
404
options.approval_delay is not None,
405
options.approval_duration is not None,
406
options.host is not None,
407
options.secret is not None,
408
options.approve,
409
options.deny))
450
410
451
if has_commands(options) and not (options.client or options.all):
411
if has_actions(options) and not (options.client or options.all):
452
412
parser.error("Options require clients names or --all.")
453
if options.verbose and has_commands(options):
413
if options.verbose and has_actions(options):
454
414
parser.error("--verbose can only be used alone.")
455
if (has_commands(options, (command.DumpJSON,))
456
and (options.verbose or len(options.commands) > 1)):
415
if options.dump_json and (options.verbose
416
or has_actions(options)):
457
417
parser.error("--dump-json can only be used alone.")
458
if options.all and not has_commands(options):
418
if options.all and not has_actions(options):
459
419
parser.error("--all requires an action.")
460
if (has_commands(options, (command.IsEnabled,))
461
and len(options.client) > 1):
420
if options.is_enabled and len(options.client) > 1:
462
421
parser.error("--is-enabled requires exactly one client")
463
if (len(options.commands) > 1
464
and has_commands(options, (command.Remove,))
465
and not has_commands(options, (command.Deny,))):
466
parser.error("--remove can only be combined with --deny")
467
468
469
class dbus(object):
470
471
class SystemBus(object):
472
473
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
474
def get_managed_objects(self, busname, objectpath):
475
return self.call_method("GetManagedObjects", busname,
476
objectpath,
477
self.object_manager_iface)
478
479
properties_iface = "org.freedesktop.DBus.Properties"
480
def set_property(self, busname, objectpath, interface, key,
481
value):
482
self.call_method("Set", busname, objectpath,
483
self.properties_iface, interface, key,
484
value)
485
486
487
class MandosBus(SystemBus):
488
busname_domain = "se.recompile"
489
busname = busname_domain + ".Mandos"
490
server_path = "/"
491
server_interface = busname_domain + ".Mandos"
492
client_interface = busname_domain + ".Mandos.Client"
493
del busname_domain
494
495
def get_clients_and_properties(self):
496
managed_objects = self.get_managed_objects(
497
self.busname, self.server_path)
498
return {objpath: properties[self.client_interface]
499
for objpath, properties in managed_objects.items()
500
if self.client_interface in properties}
501
502
def set_client_property(self, objectpath, key, value):
503
return self.set_property(self.busname, objectpath,
504
self.client_interface, key,
505
value)
506
507
def call_client_method(self, objectpath, method, *args):
508
return self.call_method(method, self.busname, objectpath,
509
self.client_interface, *args)
510
511
def call_server_method(self, method, *args):
512
return self.call_method(method, self.busname,
513
self.server_path,
514
self.server_interface, *args)
515
516
class Error(Exception):
517
pass
518
519
class ConnectFailed(Error):
520
pass
521
522
523
class dbus_python_adapter(object):
524
525
class SystemBus(dbus.MandosBus):
526
"""Use dbus-python"""
527
528
def __init__(self, module=dbus_python):
529
self.dbus_python = module
530
self.bus = self.dbus_python.SystemBus()
531
532
@contextlib.contextmanager
533
def convert_exception(self, exception_class=dbus.Error):
534
try:
535
yield
536
except self.dbus_python.exceptions.DBusException as e:
537
# This does what "raise from" would do
538
exc = exception_class(*e.args)
539
exc.__cause__ = e
540
raise exc
541
542
def call_method(self, methodname, busname, objectpath,
543
interface, *args):
544
proxy_object = self.get_object(busname, objectpath)
545
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
546
interface, methodname,
547
", ".join(repr(a) for a in args))
548
method = getattr(proxy_object, methodname)
549
with self.convert_exception():
550
with dbus_python_adapter.SilenceLogger(
551
"dbus.proxies"):
552
value = method(*args, dbus_interface=interface)
553
return self.type_filter(value)
554
555
def get_object(self, busname, objectpath):
556
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
557
busname, objectpath)
558
with self.convert_exception(dbus.ConnectFailed):
559
return self.bus.get_object(busname, objectpath)
560
561
def type_filter(self, value):
562
"""Convert the most bothersome types to Python types"""
563
if isinstance(value, self.dbus_python.Boolean):
564
return bool(value)
565
if isinstance(value, self.dbus_python.ObjectPath):
566
return str(value)
567
# Also recurse into dictionaries
568
if isinstance(value, self.dbus_python.Dictionary):
569
return {self.type_filter(key):
570
self.type_filter(subval)
571
for key, subval in value.items()}
572
return value
573
574
def set_client_property(self, objectpath, key, value):
575
if key == "Secret":
576
if not isinstance(value, bytes):
577
value = value.encode("utf-8")
578
value = self.dbus_python.ByteArray(value)
579
return self.set_property(self.busname, objectpath,
580
self.client_interface, key,
581
value)
582
583
class SilenceLogger(object):
584
"Simple context manager to silence a particular logger"
585
def __init__(self, loggername):
586
self.logger = logging.getLogger(loggername)
587
588
def __enter__(self):
589
self.logger.addFilter(self.nullfilter)
590
591
class NullFilter(logging.Filter):
592
def filter(self, record):
593
return False
594
595
nullfilter = NullFilter()
596
597
def __exit__(self, exc_type, exc_val, exc_tb):
598
self.logger.removeFilter(self.nullfilter)
599
600
601
class CachingBus(SystemBus):
602
"""A caching layer for dbus_python_adapter.SystemBus"""
603
def __init__(self, *args, **kwargs):
604
self.object_cache = {}
605
super(dbus_python_adapter.CachingBus,
606
self).__init__(*args, **kwargs)
607
def get_object(self, busname, objectpath):
608
try:
609
return self.object_cache[(busname, objectpath)]
610
except KeyError:
611
new_object = super(
612
dbus_python_adapter.CachingBus,
613
self).get_object(busname, objectpath)
614
self.object_cache[(busname, objectpath)] = new_object
615
return new_object
616
617
618
class pydbus_adapter(object):
619
class SystemBus(dbus.MandosBus):
620
def __init__(self, module=pydbus):
621
self.pydbus = module
622
self.bus = self.pydbus.SystemBus()
623
624
@contextlib.contextmanager
625
def convert_exception(self, exception_class=dbus.Error):
626
try:
627
yield
628
except gi.repository.GLib.Error as e:
629
# This does what "raise from" would do
630
exc = exception_class(*e.args)
631
exc.__cause__ = e
632
raise exc
633
634
def call_method(self, methodname, busname, objectpath,
635
interface, *args):
636
proxy_object = self.get(busname, objectpath)
637
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
638
interface, methodname,
639
", ".join(repr(a) for a in args))
640
method = getattr(proxy_object[interface], methodname)
641
with self.convert_exception():
642
return method(*args)
643
644
def get(self, busname, objectpath):
645
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
646
busname, objectpath)
647
with self.convert_exception(dbus.ConnectFailed):
648
if sys.version_info.major <= 2:
649
with warnings.catch_warnings():
650
warnings.filterwarnings(
651
"ignore", "", DeprecationWarning,
652
r"^xml\.etree\.ElementTree$")
653
return self.bus.get(busname, objectpath)
654
else:
655
return self.bus.get(busname, objectpath)
656
657
def set_property(self, busname, objectpath, interface, key,
658
value):
659
proxy_object = self.get(busname, objectpath)
660
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
661
objectpath, self.properties_iface, interface,
662
key, value)
663
setattr(proxy_object[interface], key, value)
664
665
class CachingBus(SystemBus):
666
"""A caching layer for pydbus_adapter.SystemBus"""
667
def __init__(self, *args, **kwargs):
668
self.object_cache = {}
669
super(pydbus_adapter.CachingBus,
670
self).__init__(*args, **kwargs)
671
def get(self, busname, objectpath):
672
try:
673
return self.object_cache[(busname, objectpath)]
674
except KeyError:
675
new_object = (super(pydbus_adapter.CachingBus, self)
676
.get(busname, objectpath))
677
self.object_cache[(busname, objectpath)] = new_object
678
return new_object
422
if options.remove:
423
options.remove = False
424
if has_actions(options) and not options.deny:
425
parser.error("--remove can only be combined with --deny")
426
options.remove = True
427
428
429
def get_mandos_dbus_object(bus):
430
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
431
dbus_busname, server_dbus_path)
432
with if_dbus_exception_log_with_exception_and_exit(
433
"Could not connect to Mandos server: %s"):
434
mandos_dbus_object = bus.get_object(dbus_busname,
435
server_dbus_path)
436
return mandos_dbus_object
437
438
439
@contextlib.contextmanager
440
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
try:
442
yield
443
except dbus.exceptions.DBusException as e:
444
log.critical(*(args + (e,)), **kwargs)
445
sys.exit(1)
446
447
448
def get_managed_objects(object_manager):
449
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
450
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
451
with if_dbus_exception_log_with_exception_and_exit(
452
"Failed to access Mandos server through D-Bus:\n%s"):
453
with SilenceLogger("dbus.proxies"):
454
managed_objects = object_manager.GetManagedObjects()
455
return managed_objects
456
457
458
class SilenceLogger(object):
459
"Simple context manager to silence a particular logger"
460
def __init__(self, loggername):
461
self.logger = logging.getLogger(loggername)
462
463
def __enter__(self):
464
self.logger.addFilter(self.nullfilter)
465
return self
466
467
class NullFilter(logging.Filter):
468
def filter(self, record):
469
return False
470
471
nullfilter = NullFilter()
472
473
def __exit__(self, exc_type, exc_val, exc_tb):
474
self.logger.removeFilter(self.nullfilter)
679
475
680
476
681
477
def commands_from_options(options):
682
478
683
commands = list(options.commands)
684
685
def find_cmd(cmd, commands):
686
i = 0
687
for i, c in enumerate(commands):
688
if isinstance(c, cmd):
689
return i
690
return i+1
691
692
# If command.Remove is present, move any instances of command.Deny
693
# to occur ahead of command.Remove.
694
index_of_remove = find_cmd(command.Remove, commands)
695
before_remove = commands[:index_of_remove]
696
after_remove = commands[index_of_remove:]
697
cleaned_after = []
698
for cmd in after_remove:
699
if isinstance(cmd, command.Deny):
700
before_remove.append(cmd)
479
commands = []
480
481
if options.is_enabled:
482
commands.append(command.IsEnabled())
483
484
if options.approve:
485
commands.append(command.Approve())
486
487
if options.deny:
488
commands.append(command.Deny())
489
490
if options.remove:
491
commands.append(command.Remove())
492
493
if options.dump_json:
494
commands.append(command.DumpJSON())
495
496
if options.enable:
497
commands.append(command.Enable())
498
499
if options.disable:
500
commands.append(command.Disable())
501
502
if options.bump_timeout:
503
commands.append(command.BumpTimeout())
504
505
if options.start_checker:
506
commands.append(command.StartChecker())
507
508
if options.stop_checker:
509
commands.append(command.StopChecker())
510
511
if options.approved_by_default is not None:
512
if options.approved_by_default:
513
commands.append(command.ApproveByDefault())
701
514
else:
702
cleaned_after.append(cmd)
703
if cleaned_after != after_remove:
704
commands = before_remove + cleaned_after
515
commands.append(command.DenyByDefault())
516
517
if options.checker is not None:
518
commands.append(command.SetChecker(options.checker))
519
520
if options.host is not None:
521
commands.append(command.SetHost(options.host))
522
523
if options.secret is not None:
524
commands.append(command.SetSecret(options.secret))
525
526
if options.timeout is not None:
527
commands.append(command.SetTimeout(options.timeout))
528
529
if options.extended_timeout:
530
commands.append(
531
command.SetExtendedTimeout(options.extended_timeout))
532
533
if options.interval is not None:
534
commands.append(command.SetInterval(options.interval))
535
536
if options.approval_delay is not None:
537
commands.append(
538
command.SetApprovalDelay(options.approval_delay))
539
540
if options.approval_duration is not None:
541
commands.append(
542
command.SetApprovalDuration(options.approval_duration))
705
543
706
544
# If no command option has been given, show table of clients,
707
545
# optionally verbosely
716
554
717
555
class Base(object):
718
556
"""Abstract base class for commands"""
719
def run(self, clients, bus=None):
557
def run(self, clients, bus=None, mandos=None):
720
558
"""Normal commands should implement run_on_one_client(),
721
559
but commands which want to operate on all clients at the same time can
722
560
override this run() method instead.
723
561
"""
724
self.bus = bus
725
for client, properties in clients.items():
562
self.mandos = mandos
563
for clientpath, properties in clients.items():
564
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
565
dbus_busname, str(clientpath))
566
client = bus.get_object(dbus_busname, clientpath)
726
567
self.run_on_one_client(client, properties)
727
568
728
569
729
570
class IsEnabled(Base):
730
def run(self, clients, bus=None):
731
properties = next(iter(clients.values()))
732
if properties["Enabled"]:
571
def run(self, clients, bus=None, mandos=None):
572
client, properties = next(iter(clients.items()))
573
if self.is_enabled(client, properties):
733
574
sys.exit(0)
734
575
sys.exit(1)
576
def is_enabled(self, client, properties):
577
return properties["Enabled"]
735
578
736
579
737
580
class Approve(Base):
738
581
def run_on_one_client(self, client, properties):
739
self.bus.call_client_method(client, "Approve", True)
582
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
583
client.__dbus_object_path__,
584
client_dbus_interface)
585
client.Approve(dbus.Boolean(True),
586
dbus_interface=client_dbus_interface)
740
587
741
588
742
589
class Deny(Base):
743
590
def run_on_one_client(self, client, properties):
744
self.bus.call_client_method(client, "Approve", False)
591
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
592
client.__dbus_object_path__,
593
client_dbus_interface)
594
client.Approve(dbus.Boolean(False),
595
dbus_interface=client_dbus_interface)
745
596
746
597
747
598
class Remove(Base):
748
def run(self, clients, bus):
749
for clientpath in frozenset(clients.keys()):
750
bus.call_server_method("RemoveClient", clientpath)
599
def run_on_one_client(self, client, properties):
600
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
601
dbus_busname, server_dbus_path,
602
server_dbus_interface,
603
str(client.__dbus_object_path__))
604
self.mandos.RemoveClient(client.__dbus_object_path__)
751
605
752
606
753
607
class Output(Base):
763
617
764
618
765
619
class DumpJSON(Output):
766
def run(self, clients, bus=None):
767
data = {properties["Name"]:
768
{key: properties[key]
620
def run(self, clients, bus=None, mandos=None):
621
data = {client["Name"]:
622
{key: self.dbus_boolean_to_bool(client[key])
769
623
for key in self.all_keywords}
770
for properties in clients.values()}
624
for client in clients.values()}
771
625
print(json.dumps(data, indent=4, separators=(',', ': ')))
772
626
627
@staticmethod
628
def dbus_boolean_to_bool(value):
629
if isinstance(value, dbus.Boolean):
630
value = bool(value)
631
return value
632
773
633
774
634
class PrintTable(Output):
775
635
def __init__(self, verbose=False):
776
636
self.verbose = verbose
777
637
778
def run(self, clients, bus=None):
638
def run(self, clients, bus=None, mandos=None):
779
639
default_keywords = ("Name", "Enabled", "Timeout",
780
640
"LastCheckedOK")
781
641
keywords = default_keywords
842
702
843
703
@classmethod
844
704
def valuetostring(cls, value, keyword):
845
if isinstance(value, bool):
705
if isinstance(value, dbus.Boolean):
846
706
return "Yes" if value else "No"
847
707
if keyword in ("Timeout", "Interval", "ApprovalDelay",
848
708
"ApprovalDuration", "ExtendedTimeout"):
868
728
seconds=td.seconds % 60))
869
729
870
730
871
class PropertySetter(Base):
731
class Property(Base):
872
732
"Abstract class for Actions for setting one client property"
873
733
874
def run_on_one_client(self, client, properties=None):
734
def run_on_one_client(self, client, properties):
875
735
"""Set the Client's D-Bus property"""
876
self.bus.set_client_property(client, self.propname,
877
self.value_to_set)
736
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
737
client.__dbus_object_path__,
738
dbus.PROPERTIES_IFACE, client_dbus_interface,
739
self.propname, self.value_to_set
740
if not isinstance(self.value_to_set,
741
dbus.Boolean)
742
else bool(self.value_to_set))
743
client.Set(client_dbus_interface, self.propname,
744
self.value_to_set,
745
dbus_interface=dbus.PROPERTIES_IFACE)
878
746
879
747
@property
880
748
def propname(self):
881
749
raise NotImplementedError()
882
750
883
751
884
class Enable(PropertySetter):
885
propname = "Enabled"
886
value_to_set = True
887
888
889
class Disable(PropertySetter):
890
propname = "Enabled"
891
value_to_set = False
892
893
894
class BumpTimeout(PropertySetter):
752
class Enable(Property):
753
propname = "Enabled"
754
value_to_set = dbus.Boolean(True)
755
756
757
class Disable(Property):
758
propname = "Enabled"
759
value_to_set = dbus.Boolean(False)
760
761
762
class BumpTimeout(Property):
895
763
propname = "LastCheckedOK"
896
764
value_to_set = ""
897
765
898
766
899
class StartChecker(PropertySetter):
900
propname = "CheckerRunning"
901
value_to_set = True
902
903
904
class StopChecker(PropertySetter):
905
propname = "CheckerRunning"
906
value_to_set = False
907
908
909
class ApproveByDefault(PropertySetter):
910
propname = "ApprovedByDefault"
911
value_to_set = True
912
913
914
class DenyByDefault(PropertySetter):
915
propname = "ApprovedByDefault"
916
value_to_set = False
917
918
919
class PropertySetterValue(PropertySetter):
920
"""Abstract class for PropertySetter recieving a value as
921
constructor argument instead of a class attribute."""
767
class StartChecker(Property):
768
propname = "CheckerRunning"
769
value_to_set = dbus.Boolean(True)
770
771
772
class StopChecker(Property):
773
propname = "CheckerRunning"
774
value_to_set = dbus.Boolean(False)
775
776
777
class ApproveByDefault(Property):
778
propname = "ApprovedByDefault"
779
value_to_set = dbus.Boolean(True)
780
781
782
class DenyByDefault(Property):
783
propname = "ApprovedByDefault"
784
value_to_set = dbus.Boolean(False)
785
786
787
class PropertyValue(Property):
788
"Abstract class for Property recieving a value as argument"
922
789
def __init__(self, value):
923
790
self.value_to_set = value
924
791
925
@classmethod
926
def argparse(cls, argtype):
927
def cmdtype(arg):
928
return cls(argtype(arg))
929
return cmdtype
930
792
931
class SetChecker(PropertySetterValue):
793
class SetChecker(PropertyValue):
932
794
propname = "Checker"
933
795
934
796
935
class SetHost(PropertySetterValue):
797
class SetHost(PropertyValue):
936
798
propname = "Host"
937
799
938
800
939
class SetSecret(PropertySetterValue):
801
class SetSecret(PropertyValue):
940
802
propname = "Secret"
941
803
942
804
@property
950
812
value.close()
951
813
952
814
953
class PropertySetterValueMilliseconds(PropertySetterValue):
954
"""Abstract class for PropertySetterValue taking a value
955
argument as a datetime.timedelta() but should store it as
956
milliseconds."""
815
class MillisecondsPropertyValueArgument(PropertyValue):
816
"""Abstract class for PropertyValue taking a value argument as
817
a datetime.timedelta() but should store it as milliseconds."""
957
818
958
819
@property
959
820
def value_to_set(self):
965
826
self._vts = int(round(value.total_seconds() * 1000))
966
827
967
828
968
class SetTimeout(PropertySetterValueMilliseconds):
829
class SetTimeout(MillisecondsPropertyValueArgument):
969
830
propname = "Timeout"
970
831
971
832
972
class SetExtendedTimeout(PropertySetterValueMilliseconds):
833
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
973
834
propname = "ExtendedTimeout"
974
835
975
836
976
class SetInterval(PropertySetterValueMilliseconds):
837
class SetInterval(MillisecondsPropertyValueArgument):
977
838
propname = "Interval"
978
839
979
840
980
class SetApprovalDelay(PropertySetterValueMilliseconds):
841
class SetApprovalDelay(MillisecondsPropertyValueArgument):
981
842
propname = "ApprovalDelay"
982
843
983
844
984
class SetApprovalDuration(PropertySetterValueMilliseconds):
845
class SetApprovalDuration(MillisecondsPropertyValueArgument):
985
846
propname = "ApprovalDuration"
986
847
987
848
1020
881
"output"))
1021
882
1022
883
1023
class Unique(object):
1024
"""Class for objects which exist only to be unique objects, since
1025
unittest.mock.sentinel only exists in Python 3.3"""
1026
1027
1028
884
class Test_string_to_delta(TestCaseWithAssertLogs):
1029
885
# Just test basic RFC 3339 functionality here, the doc string for
1030
886
# rfc3339_duration_to_delta() already has more comprehensive
1031
# tests, which are run by doctest.
887
# tests, which is run by doctest.
1032
888
1033
889
def test_rfc3339_zero_seconds(self):
1034
890
self.assertEqual(datetime.timedelta(),
1058
914
1059
915
def test_actions_requires_client_or_all(self):
1060
916
for action, value in self.actions.items():
1061
args = self.actionargs(action, value)
917
options = self.parser.parse_args()
918
setattr(options, action, value)
1062
919
with self.assertParseError():
1063
self.parse_args(args)
920
self.check_option_syntax(options)
1064
921
1065
# This mostly corresponds to the definition from has_commands() in
922
# This mostly corresponds to the definition from has_actions() in
1066
923
# check_option_syntax()
1067
924
actions = {
1068
"--enable": None,
1069
"--disable": None,
1070
"--bump-timeout": None,
1071
"--start-checker": None,
1072
"--stop-checker": None,
1073
"--is-enabled": None,
1074
"--remove": None,
1075
"--checker": "x",
1076
"--timeout": "PT0S",
1077
"--extended-timeout": "PT0S",
1078
"--interval": "PT0S",
1079
"--approve-by-default": None,
1080
"--deny-by-default": None,
1081
"--approval-delay": "PT0S",
1082
"--approval-duration": "PT0S",
1083
"--host": "hostname",
1084
"--secret": "/dev/null",
1085
"--approve": None,
1086
"--deny": None,
925
# The actual values set here are not that important, but we do
926
# at least stick to the correct types, even though they are
927
# never used
928
"enable": True,
929
"disable": True,
930
"bump_timeout": True,
931
"start_checker": True,
932
"stop_checker": True,
933
"is_enabled": True,
934
"remove": True,
935
"checker": "x",
936
"timeout": datetime.timedelta(),
937
"extended_timeout": datetime.timedelta(),
938
"interval": datetime.timedelta(),
939
"approved_by_default": True,
940
"approval_delay": datetime.timedelta(),
941
"approval_duration": datetime.timedelta(),
942
"host": "x",
943
"secret": io.BytesIO(b"x"),
944
"approve": True,
945
"deny": True,
1087
946
}
1088
947
1089
@staticmethod
1090
def actionargs(action, value, *args):
1091
if value is not None:
1092
return [action, value] + list(args)
1093
else:
1094
return [action] + list(args)
1095
1096
948
@contextlib.contextmanager
1097
949
def assertParseError(self):
1098
950
with self.assertRaises(SystemExit) as e:
1103
955
# /argparse.html#exiting-methods
1104
956
self.assertEqual(2, e.exception.code)
1105
957
1106
def parse_args(self, args):
1107
options = self.parser.parse_args(args)
1108
check_option_syntax(self.parser, options)
1109
1110
958
@staticmethod
1111
959
@contextlib.contextmanager
1112
960
def redirect_stderr_to_devnull():
1123
971
1124
972
def test_actions_all_conflicts_with_verbose(self):
1125
973
for action, value in self.actions.items():
1126
args = self.actionargs(action, value, "--all",
1127
"--verbose")
974
options = self.parser.parse_args()
975
setattr(options, action, value)
976
options.all = True
977
options.verbose = True
1128
978
with self.assertParseError():
1129
self.parse_args(args)
979
self.check_option_syntax(options)
1130
980
1131
981
def test_actions_with_client_conflicts_with_verbose(self):
1132
982
for action, value in self.actions.items():
1133
args = self.actionargs(action, value, "--verbose",
1134
"client")
983
options = self.parser.parse_args()
984
setattr(options, action, value)
985
options.verbose = True
986
options.client = ["foo"]
1135
987
with self.assertParseError():
1136
self.parse_args(args)
988
self.check_option_syntax(options)
1137
989
1138
990
def test_dump_json_conflicts_with_verbose(self):
1139
args = ["--dump-json", "--verbose"]
991
options = self.parser.parse_args()
992
options.dump_json = True
993
options.verbose = True
1140
994
with self.assertParseError():
1141
self.parse_args(args)
995
self.check_option_syntax(options)
1142
996
1143
997
def test_dump_json_conflicts_with_action(self):
1144
998
for action, value in self.actions.items():
1145
args = self.actionargs(action, value, "--dump-json")
999
options = self.parser.parse_args()
1000
setattr(options, action, value)
1001
options.dump_json = True
1146
1002
with self.assertParseError():
1147
self.parse_args(args)
1003
self.check_option_syntax(options)
1148
1004
1149
1005
def test_all_can_not_be_alone(self):
1150
args = ["--all"]
1006
options = self.parser.parse_args()
1007
options.all = True
1151
1008
with self.assertParseError():
1152
self.parse_args(args)
1009
self.check_option_syntax(options)
1153
1010
1154
1011
def test_all_is_ok_with_any_action(self):
1155
1012
for action, value in self.actions.items():
1156
args = self.actionargs(action, value, "--all")
1157
self.parse_args(args)
1013
options = self.parser.parse_args()
1014
setattr(options, action, value)
1015
options.all = True
1016
self.check_option_syntax(options)
1158
1017
1159
1018
def test_any_action_is_ok_with_one_client(self):
1160
1019
for action, value in self.actions.items():
1161
args = self.actionargs(action, value, "client")
1162
self.parse_args(args)
1020
options = self.parser.parse_args()
1021
setattr(options, action, value)
1022
options.client = ["foo"]
1023
self.check_option_syntax(options)
1163
1024
1164
1025
def test_one_client_with_all_actions_except_is_enabled(self):
1026
options = self.parser.parse_args()
1165
1027
for action, value in self.actions.items():
1166
if action == "--is-enabled":
1028
if action == "is_enabled":
1167
1029
continue
1168
args = self.actionargs(action, value, "client")
1169
self.parse_args(args)
1030
setattr(options, action, value)
1031
options.client = ["foo"]
1032
self.check_option_syntax(options)
1170
1033
1171
1034
def test_two_clients_with_all_actions_except_is_enabled(self):
1035
options = self.parser.parse_args()
1172
1036
for action, value in self.actions.items():
1173
if action == "--is-enabled":
1037
if action == "is_enabled":
1174
1038
continue
1175
args = self.actionargs(action, value, "client1",
1176
"client2")
1177
self.parse_args(args)
1039
setattr(options, action, value)
1040
options.client = ["foo", "barbar"]
1041
self.check_option_syntax(options)
1178
1042
1179
1043
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1180
1044
for action, value in self.actions.items():
1181
if action == "--is-enabled":
1045
if action == "is_enabled":
1182
1046
continue
1183
args = self.actionargs(action, value, "client1",
1184
"client2")
1185
self.parse_args(args)
1047
options = self.parser.parse_args()
1048
setattr(options, action, value)
1049
options.client = ["foo", "barbar"]
1050
self.check_option_syntax(options)
1186
1051
1187
1052
def test_is_enabled_fails_without_client(self):
1188
args = ["--is-enabled"]
1053
options = self.parser.parse_args()
1054
options.is_enabled = True
1189
1055
with self.assertParseError():
1190
self.parse_args(args)
1056
self.check_option_syntax(options)
1191
1057
1192
1058
def test_is_enabled_fails_with_two_clients(self):
1193
args = ["--is-enabled", "client1", "client2"]
1059
options = self.parser.parse_args()
1060
options.is_enabled = True
1061
options.client = ["foo", "barbar"]
1194
1062
with self.assertParseError():
1195
self.parse_args(args)
1063
self.check_option_syntax(options)
1196
1064
1197
1065
def test_remove_can_only_be_combined_with_action_deny(self):
1198
1066
for action, value in self.actions.items():
1199
if action in {"--remove", "--deny"}:
1067
if action in {"remove", "deny"}:
1200
1068
continue
1201
args = self.actionargs(action, value, "--all",
1202
"--remove")
1069
options = self.parser.parse_args()
1070
setattr(options, action, value)
1071
options.all = True
1072
options.remove = True
1203
1073
with self.assertParseError():
1204
self.parse_args(args)
1205
1206
1207
class Test_dbus_exceptions(unittest.TestCase):
1208
1209
def test_dbus_ConnectFailed_is_Error(self):
1210
with self.assertRaises(dbus.Error):
1211
raise dbus.ConnectFailed()
1212
1213
1214
class Test_dbus_MandosBus(unittest.TestCase):
1215
1216
class MockMandosBus(dbus.MandosBus):
1217
def __init__(self):
1218
self._name = "se.recompile.Mandos"
1219
self._server_path = "/"
1220
self._server_interface = "se.recompile.Mandos"
1221
self._client_interface = "se.recompile.Mandos.Client"
1222
self.calls = []
1223
self.call_method_return = Unique()
1224
1225
def call_method(self, methodname, busname, objectpath,
1226
interface, *args):
1227
self.calls.append((methodname, busname, objectpath,
1228
interface, args))
1229
return self.call_method_return
1230
1231
def setUp(self):
1232
self.bus = self.MockMandosBus()
1233
1234
def test_set_client_property(self):
1235
self.bus.set_client_property("objectpath", "key", "value")
1236
expected_call = ("Set", self.bus._name, "objectpath",
1237
"org.freedesktop.DBus.Properties",
1238
(self.bus._client_interface, "key", "value"))
1239
self.assertIn(expected_call, self.bus.calls)
1240
1241
def test_call_client_method(self):
1242
ret = self.bus.call_client_method("objectpath", "methodname")
1243
self.assertIs(self.bus.call_method_return, ret)
1244
expected_call = ("methodname", self.bus._name, "objectpath",
1245
self.bus._client_interface, ())
1246
self.assertIn(expected_call, self.bus.calls)
1247
1248
def test_call_client_method_with_args(self):
1249
args = (Unique(), Unique())
1250
ret = self.bus.call_client_method("objectpath", "methodname",
1251
*args)
1252
self.assertIs(self.bus.call_method_return, ret)
1253
expected_call = ("methodname", self.bus._name, "objectpath",
1254
self.bus._client_interface,
1255
(args[0], args[1]))
1256
self.assertIn(expected_call, self.bus.calls)
1257
1258
def test_get_clients_and_properties(self):
1259
managed_objects = {
1260
"objectpath": {
1261
self.bus._client_interface: {
1262
"key": "value",
1263
"bool": True,
1264
},
1265
"irrelevant_interface": {
1266
"key": "othervalue",
1267
"bool": False,
1268
},
1269
},
1270
"other_objectpath": {
1271
"other_irrelevant_interface": {
1272
"key": "value 3",
1273
"bool": None,
1274
},
1275
},
1276
}
1277
expected_clients_and_properties = {
1278
"objectpath": {
1279
"key": "value",
1280
"bool": True,
1281
}
1282
}
1283
self.bus.call_method_return = managed_objects
1284
ret = self.bus.get_clients_and_properties()
1285
self.assertDictEqual(expected_clients_and_properties, ret)
1286
expected_call = ("GetManagedObjects", self.bus._name,
1287
self.bus._server_path,
1288
"org.freedesktop.DBus.ObjectManager", ())
1289
self.assertIn(expected_call, self.bus.calls)
1290
1291
def test_call_server_method(self):
1292
ret = self.bus.call_server_method("methodname")
1293
self.assertIs(self.bus.call_method_return, ret)
1294
expected_call = ("methodname", self.bus._name,
1295
self.bus._server_path,
1296
self.bus._server_interface, ())
1297
self.assertIn(expected_call, self.bus.calls)
1298
1299
def test_call_server_method_with_args(self):
1300
args = (Unique(), Unique())
1301
ret = self.bus.call_server_method("methodname", *args)
1302
self.assertIs(self.bus.call_method_return, ret)
1303
expected_call = ("methodname", self.bus._name,
1304
self.bus._server_path,
1305
self.bus._server_interface,
1306
(args[0], args[1]))
1307
self.assertIn(expected_call, self.bus.calls)
1308
1309
1310
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1311
1312
def MockDBusPython_func(self, func):
1313
class mock_dbus_python(object):
1314
"""mock dbus-python module"""
1315
class exceptions(object):
1316
"""Pseudo-namespace"""
1317
class DBusException(Exception):
1318
pass
1319
class SystemBus(object):
1320
@staticmethod
1321
def get_object(busname, objectpath):
1322
DBusObject = collections.namedtuple(
1323
"DBusObject", ("methodname", "Set"))
1324
def method(*args, **kwargs):
1325
self.assertEqual({"dbus_interface":
1326
"interface"},
1327
kwargs)
1328
return func(*args)
1329
def set_property(interface, key, value,
1330
dbus_interface=None):
1331
self.assertEqual(
1332
"org.freedesktop.DBus.Properties",
1333
dbus_interface)
1334
self.assertEqual("Secret", key)
1335
return func(interface, key, value,
1336
dbus_interface=dbus_interface)
1337
return DBusObject(methodname=method,
1338
Set=set_property)
1339
class Boolean(object):
1340
def __init__(self, value):
1341
self.value = bool(value)
1342
def __bool__(self):
1343
return self.value
1344
if sys.version_info.major == 2:
1345
__nonzero__ = __bool__
1346
class ObjectPath(str):
1347
pass
1348
class Dictionary(dict):
1349
pass
1350
class ByteArray(bytes):
1351
pass
1352
return mock_dbus_python
1353
1354
def call_method(self, bus, methodname, busname, objectpath,
1355
interface, *args):
1356
with self.assertLogs(log, logging.DEBUG):
1357
return bus.call_method(methodname, busname, objectpath,
1358
interface, *args)
1359
1360
def test_call_method_returns(self):
1361
expected_method_return = Unique()
1362
method_args = (Unique(), Unique())
1363
def func(*args):
1364
self.assertEqual(len(method_args), len(args))
1365
for marg, arg in zip(method_args, args):
1366
self.assertIs(marg, arg)
1367
return expected_method_return
1368
mock_dbus_python = self.MockDBusPython_func(func)
1369
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1370
ret = self.call_method(bus, "methodname", "busname",
1371
"objectpath", "interface",
1372
*method_args)
1373
self.assertIs(ret, expected_method_return)
1374
1375
def test_call_method_filters_bool_true(self):
1376
def func():
1377
return method_return
1378
mock_dbus_python = self.MockDBusPython_func(func)
1379
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1380
method_return = mock_dbus_python.Boolean(True)
1381
ret = self.call_method(bus, "methodname", "busname",
1382
"objectpath", "interface")
1383
self.assertTrue(ret)
1384
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1385
1386
def test_call_method_filters_bool_false(self):
1387
def func():
1388
return method_return
1389
mock_dbus_python = self.MockDBusPython_func(func)
1390
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1391
method_return = mock_dbus_python.Boolean(False)
1392
ret = self.call_method(bus, "methodname", "busname",
1393
"objectpath", "interface")
1394
self.assertFalse(ret)
1395
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1396
1397
def test_call_method_filters_objectpath(self):
1398
def func():
1399
return method_return
1400
mock_dbus_python = self.MockDBusPython_func(func)
1401
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1402
method_return = mock_dbus_python.ObjectPath("objectpath")
1403
ret = self.call_method(bus, "methodname", "busname",
1404
"objectpath", "interface")
1405
self.assertEqual("objectpath", ret)
1406
self.assertIsNot("objectpath", ret)
1407
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1408
1409
def test_call_method_filters_booleans_in_dict(self):
1410
def func():
1411
return method_return
1412
mock_dbus_python = self.MockDBusPython_func(func)
1413
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1414
method_return = mock_dbus_python.Dictionary(
1415
{mock_dbus_python.Boolean(True):
1416
mock_dbus_python.Boolean(False),
1417
mock_dbus_python.Boolean(False):
1418
mock_dbus_python.Boolean(True)})
1419
ret = self.call_method(bus, "methodname", "busname",
1420
"objectpath", "interface")
1421
expected_method_return = {True: False,
1422
False: True}
1423
self.assertEqual(expected_method_return, ret)
1424
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1425
1426
def test_call_method_filters_objectpaths_in_dict(self):
1427
def func():
1428
return method_return
1429
mock_dbus_python = self.MockDBusPython_func(func)
1430
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1431
method_return = mock_dbus_python.Dictionary(
1432
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1433
mock_dbus_python.ObjectPath("objectpath_value_1"),
1434
mock_dbus_python.ObjectPath("objectpath_key_2"):
1435
mock_dbus_python.ObjectPath("objectpath_value_2")})
1436
ret = self.call_method(bus, "methodname", "busname",
1437
"objectpath", "interface")
1438
expected_method_return = {str(key): str(value)
1439
for key, value in
1440
method_return.items()}
1441
self.assertEqual(expected_method_return, ret)
1442
self.assertIsInstance(ret, dict)
1443
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1444
1445
def test_call_method_filters_dict_in_dict(self):
1446
def func():
1447
return method_return
1448
mock_dbus_python = self.MockDBusPython_func(func)
1449
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1450
method_return = mock_dbus_python.Dictionary(
1451
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1452
"key12": "value12"}),
1453
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1454
"key22": "value22"})})
1455
ret = self.call_method(bus, "methodname", "busname",
1456
"objectpath", "interface")
1457
expected_method_return = {
1458
"key1": {"key11": "value11",
1459
"key12": "value12"},
1460
"key2": {"key21": "value21",
1461
"key22": "value22"},
1462
}
1463
self.assertEqual(expected_method_return, ret)
1464
self.assertIsInstance(ret, dict)
1465
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1466
for key, value in ret.items():
1467
self.assertIsInstance(value, dict)
1468
self.assertEqual(expected_method_return[key], value)
1469
self.assertNotIsInstance(value,
1470
mock_dbus_python.Dictionary)
1471
1472
def test_call_method_filters_dict_three_deep(self):
1473
def func():
1474
return method_return
1475
mock_dbus_python = self.MockDBusPython_func(func)
1476
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1477
method_return = mock_dbus_python.Dictionary(
1478
{"key1":
1479
mock_dbus_python.Dictionary(
1480
{"key2":
1481
mock_dbus_python.Dictionary(
1482
{"key3":
1483
mock_dbus_python.Boolean(True),
1484
}),
1485
}),
1486
})
1487
ret = self.call_method(bus, "methodname", "busname",
1488
"objectpath", "interface")
1489
expected_method_return = {"key1": {"key2": {"key3": True}}}
1490
self.assertEqual(expected_method_return, ret)
1491
self.assertIsInstance(ret, dict)
1492
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1493
self.assertIsInstance(ret["key1"], dict)
1494
self.assertNotIsInstance(ret["key1"],
1495
mock_dbus_python.Dictionary)
1496
self.assertIsInstance(ret["key1"]["key2"], dict)
1497
self.assertNotIsInstance(ret["key1"]["key2"],
1498
mock_dbus_python.Dictionary)
1499
self.assertTrue(ret["key1"]["key2"]["key3"])
1500
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1501
mock_dbus_python.Boolean)
1502
1503
def test_call_method_handles_exception(self):
1074
self.check_option_syntax(options)
1075
1076
1077
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1078
def test_calls_and_returns_get_object_on_bus(self):
1079
class MockBus(object):
1080
called = False
1081
def get_object(mockbus_self, busname, dbus_path):
1082
# Note that "self" is still the testcase instance,
1083
# this MockBus instance is in "mockbus_self".
1084
self.assertEqual(dbus_busname, busname)
1085
self.assertEqual(server_dbus_path, dbus_path)
1086
mockbus_self.called = True
1087
return mockbus_self
1088
1089
mockbus = get_mandos_dbus_object(bus=MockBus())
1090
self.assertIsInstance(mockbus, MockBus)
1091
self.assertTrue(mockbus.called)
1092
1093
def test_logs_and_exits_on_dbus_error(self):
1094
class MockBusFailing(object):
1095
def get_object(self, busname, dbus_path):
1096
raise dbus.exceptions.DBusException("Test")
1097
1098
with self.assertLogs(log, logging.CRITICAL):
1099
with self.assertRaises(SystemExit) as e:
1100
bus = get_mandos_dbus_object(bus=MockBusFailing())
1101
1102
if isinstance(e.exception.code, int):
1103
self.assertNotEqual(0, e.exception.code)
1104
else:
1105
self.assertIsNotNone(e.exception.code)
1106
1107
1108
class Test_get_managed_objects(TestCaseWithAssertLogs):
1109
def test_calls_and_returns_GetManagedObjects(self):
1110
managed_objects = {"/clients/foo": { "Name": "foo"}}
1111
class MockObjectManager(object):
1112
def GetManagedObjects(self):
1113
return managed_objects
1114
retval = get_managed_objects(MockObjectManager())
1115
self.assertDictEqual(managed_objects, retval)
1116
1117
def test_logs_and_exits_on_dbus_error(self):
1504
1118
dbus_logger = logging.getLogger("dbus.proxies")
1505
1119
1506
def func():
1507
dbus_logger.error("Test")
1508
raise mock_dbus_python.exceptions.DBusException()
1509
1510
mock_dbus_python = self.MockDBusPython_func(func)
1511
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1120
class MockObjectManagerFailing(object):
1121
def GetManagedObjects(self):
1122
dbus_logger.error("Test")
1123
raise dbus.exceptions.DBusException("Test")
1512
1124
1513
1125
class CountingHandler(logging.Handler):
1514
1126
count = 0
1520
1132
dbus_logger.addHandler(counting_handler)
1521
1133
1522
1134
try:
1523
with self.assertRaises(dbus.Error) as e:
1524
self.call_method(bus, "methodname", "busname",
1525
"objectpath", "interface")
1135
with self.assertLogs(log, logging.CRITICAL) as watcher:
1136
with self.assertRaises(SystemExit) as e:
1137
get_managed_objects(MockObjectManagerFailing())
1526
1138
finally:
1527
1139
dbus_logger.removeFilter(counting_handler)
1528
1140
1529
self.assertNotIsInstance(e, dbus.ConnectFailed)
1530
1531
1141
# Make sure the dbus logger was suppressed
1532
1142
self.assertEqual(0, counting_handler.count)
1533
1143
1534
def test_Set_Secret_sends_bytearray(self):
1535
ret = [None]
1536
def func(*args, **kwargs):
1537
ret[0] = (args, kwargs)
1538
mock_dbus_python = self.MockDBusPython_func(func)
1539
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1540
bus.set_client_property("objectpath", "Secret", "value")
1541
expected_call = (("se.recompile.Mandos.Client", "Secret",
1542
mock_dbus_python.ByteArray(b"value")),
1543
{"dbus_interface":
1544
"org.freedesktop.DBus.Properties"})
1545
self.assertEqual(expected_call, ret[0])
1546
if sys.version_info.major == 2:
1547
self.assertIsInstance(ret[0][0][-1],
1548
mock_dbus_python.ByteArray)
1549
1550
def test_get_object_converts_to_correct_exception(self):
1551
bus = dbus_python_adapter.SystemBus(
1552
self.fake_dbus_python_raises_exception_on_connect)
1553
with self.assertRaises(dbus.ConnectFailed):
1554
self.call_method(bus, "methodname", "busname",
1555
"objectpath", "interface")
1556
1557
class fake_dbus_python_raises_exception_on_connect(object):
1558
"""fake dbus-python module"""
1559
class exceptions(object):
1560
"""Pseudo-namespace"""
1561
class DBusException(Exception):
1562
pass
1563
1564
@classmethod
1565
def SystemBus(cls):
1566
def get_object(busname, objectpath):
1567
raise cls.exceptions.DBusException()
1568
Bus = collections.namedtuple("Bus", ["get_object"])
1569
return Bus(get_object=get_object)
1570
1571
1572
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1573
class mock_dbus_python(object):
1574
"""mock dbus-python modules"""
1575
class SystemBus(object):
1576
@staticmethod
1577
def get_object(busname, objectpath):
1578
return Unique()
1579
1580
def setUp(self):
1581
self.bus = dbus_python_adapter.CachingBus(
1582
self.mock_dbus_python)
1583
1584
def test_returns_distinct_objectpaths(self):
1585
obj1 = self.bus.get_object("busname", "objectpath1")
1586
self.assertIsInstance(obj1, Unique)
1587
obj2 = self.bus.get_object("busname", "objectpath2")
1588
self.assertIsInstance(obj2, Unique)
1589
self.assertIsNot(obj1, obj2)
1590
1591
def test_returns_distinct_busnames(self):
1592
obj1 = self.bus.get_object("busname1", "objectpath")
1593
self.assertIsInstance(obj1, Unique)
1594
obj2 = self.bus.get_object("busname2", "objectpath")
1595
self.assertIsInstance(obj2, Unique)
1596
self.assertIsNot(obj1, obj2)
1597
1598
def test_returns_distinct_both(self):
1599
obj1 = self.bus.get_object("busname1", "objectpath")
1600
self.assertIsInstance(obj1, Unique)
1601
obj2 = self.bus.get_object("busname2", "objectpath")
1602
self.assertIsInstance(obj2, Unique)
1603
self.assertIsNot(obj1, obj2)
1604
1605
def test_returns_same(self):
1606
obj1 = self.bus.get_object("busname", "objectpath")
1607
self.assertIsInstance(obj1, Unique)
1608
obj2 = self.bus.get_object("busname", "objectpath")
1609
self.assertIsInstance(obj2, Unique)
1610
self.assertIs(obj1, obj2)
1611
1612
def test_returns_same_old(self):
1613
obj1 = self.bus.get_object("busname1", "objectpath1")
1614
self.assertIsInstance(obj1, Unique)
1615
obj2 = self.bus.get_object("busname2", "objectpath2")
1616
self.assertIsInstance(obj2, Unique)
1617
obj1b = self.bus.get_object("busname1", "objectpath1")
1618
self.assertIsInstance(obj1b, Unique)
1619
self.assertIsNot(obj1, obj2)
1620
self.assertIsNot(obj2, obj1b)
1621
self.assertIs(obj1, obj1b)
1622
1623
1624
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1625
1626
def Stub_pydbus_func(self, func):
1627
class stub_pydbus(object):
1628
"""stub pydbus module"""
1629
class SystemBus(object):
1630
@staticmethod
1631
def get(busname, objectpath):
1632
DBusObject = collections.namedtuple(
1633
"DBusObject", ("methodname",))
1634
return {"interface":
1635
DBusObject(methodname=func)}
1636
return stub_pydbus
1637
1638
def call_method(self, bus, methodname, busname, objectpath,
1639
interface, *args):
1640
with self.assertLogs(log, logging.DEBUG):
1641
return bus.call_method(methodname, busname, objectpath,
1642
interface, *args)
1643
1644
def test_call_method_returns(self):
1645
expected_method_return = Unique()
1646
method_args = (Unique(), Unique())
1647
def func(*args):
1648
self.assertEqual(len(method_args), len(args))
1649
for marg, arg in zip(method_args, args):
1650
self.assertIs(marg, arg)
1651
return expected_method_return
1652
stub_pydbus = self.Stub_pydbus_func(func)
1653
bus = pydbus_adapter.SystemBus(stub_pydbus)
1654
ret = self.call_method(bus, "methodname", "busname",
1655
"objectpath", "interface",
1656
*method_args)
1657
self.assertIs(ret, expected_method_return)
1658
1659
def test_call_method_handles_exception(self):
1660
dbus_logger = logging.getLogger("dbus.proxies")
1661
1662
def func():
1663
raise gi.repository.GLib.Error()
1664
1665
stub_pydbus = self.Stub_pydbus_func(func)
1666
bus = pydbus_adapter.SystemBus(stub_pydbus)
1667
1668
with self.assertRaises(dbus.Error) as e:
1669
self.call_method(bus, "methodname", "busname",
1670
"objectpath", "interface")
1671
1672
self.assertNotIsInstance(e, dbus.ConnectFailed)
1673
1674
def test_get_converts_to_correct_exception(self):
1675
bus = pydbus_adapter.SystemBus(
1676
self.fake_pydbus_raises_exception_on_connect)
1677
with self.assertRaises(dbus.ConnectFailed):
1678
self.call_method(bus, "methodname", "busname",
1679
"objectpath", "interface")
1680
1681
class fake_pydbus_raises_exception_on_connect(object):
1682
"""fake dbus-python module"""
1683
@classmethod
1684
def SystemBus(cls):
1685
def get(busname, objectpath):
1686
raise gi.repository.GLib.Error()
1687
Bus = collections.namedtuple("Bus", ["get"])
1688
return Bus(get=get)
1689
1690
def test_set_property_uses_setattr(self):
1691
class Object(object):
1692
pass
1693
obj = Object()
1694
class pydbus_spy(object):
1695
class SystemBus(object):
1696
@staticmethod
1697
def get(busname, objectpath):
1698
return {"interface": obj}
1699
bus = pydbus_adapter.SystemBus(pydbus_spy)
1700
value = Unique()
1701
bus.set_property("busname", "objectpath", "interface", "key",
1702
value)
1703
self.assertIs(value, obj.key)
1704
1705
def test_get_suppresses_xml_deprecation_warning(self):
1706
if sys.version_info.major >= 3:
1707
return
1708
class stub_pydbus_get(object):
1709
class SystemBus(object):
1710
@staticmethod
1711
def get(busname, objectpath):
1712
warnings.warn_explicit(
1713
"deprecated", DeprecationWarning,
1714
"xml.etree.ElementTree", 0)
1715
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1716
with warnings.catch_warnings(record=True) as w:
1717
warnings.simplefilter("always")
1718
bus.get("busname", "objectpath")
1719
self.assertEqual(0, len(w))
1720
1721
1722
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1723
class stub_pydbus(object):
1724
"""stub pydbus module"""
1725
class SystemBus(object):
1726
@staticmethod
1727
def get(busname, objectpath):
1728
return Unique()
1729
1730
def setUp(self):
1731
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1732
1733
def test_returns_distinct_objectpaths(self):
1734
obj1 = self.bus.get("busname", "objectpath1")
1735
self.assertIsInstance(obj1, Unique)
1736
obj2 = self.bus.get("busname", "objectpath2")
1737
self.assertIsInstance(obj2, Unique)
1738
self.assertIsNot(obj1, obj2)
1739
1740
def test_returns_distinct_busnames(self):
1741
obj1 = self.bus.get("busname1", "objectpath")
1742
self.assertIsInstance(obj1, Unique)
1743
obj2 = self.bus.get("busname2", "objectpath")
1744
self.assertIsInstance(obj2, Unique)
1745
self.assertIsNot(obj1, obj2)
1746
1747
def test_returns_distinct_both(self):
1748
obj1 = self.bus.get("busname1", "objectpath")
1749
self.assertIsInstance(obj1, Unique)
1750
obj2 = self.bus.get("busname2", "objectpath")
1751
self.assertIsInstance(obj2, Unique)
1752
self.assertIsNot(obj1, obj2)
1753
1754
def test_returns_same(self):
1755
obj1 = self.bus.get("busname", "objectpath")
1756
self.assertIsInstance(obj1, Unique)
1757
obj2 = self.bus.get("busname", "objectpath")
1758
self.assertIsInstance(obj2, Unique)
1759
self.assertIs(obj1, obj2)
1760
1761
def test_returns_same_old(self):
1762
obj1 = self.bus.get("busname1", "objectpath1")
1763
self.assertIsInstance(obj1, Unique)
1764
obj2 = self.bus.get("busname2", "objectpath2")
1765
self.assertIsInstance(obj2, Unique)
1766
obj1b = self.bus.get("busname1", "objectpath1")
1767
self.assertIsInstance(obj1b, Unique)
1768
self.assertIsNot(obj1, obj2)
1769
self.assertIsNot(obj2, obj1b)
1770
self.assertIs(obj1, obj1b)
1144
# Test that the dbus_logger still works
1145
with self.assertLogs(dbus_logger, logging.ERROR):
1146
dbus_logger.error("Test")
1147
1148
if isinstance(e.exception.code, int):
1149
self.assertNotEqual(0, e.exception.code)
1150
else:
1151
self.assertIsNotNone(e.exception.code)
1771
1152
1772
1153
1773
1154
class Test_commands_from_options(unittest.TestCase):
1774
1775
1155
def setUp(self):
1776
1156
self.parser = argparse.ArgumentParser()
1777
1157
add_command_line_options(self.parser)
1778
1158
1779
1159
def test_is_enabled(self):
1780
self.assert_command_from_args(["--is-enabled", "client"],
1160
self.assert_command_from_args(["--is-enabled", "foo"],
1781
1161
command.IsEnabled)
1782
1162
1783
1163
def assert_command_from_args(self, args, command_cls,
1794
1174
self.assertEqual(value, getattr(command, key))
1795
1175
1796
1176
def test_is_enabled_short(self):
1797
self.assert_command_from_args(["-V", "client"],
1177
self.assert_command_from_args(["-V", "foo"],
1798
1178
command.IsEnabled)
1799
1179
1800
1180
def test_approve(self):
1801
self.assert_command_from_args(["--approve", "client"],
1181
self.assert_command_from_args(["--approve", "foo"],
1802
1182
command.Approve)
1803
1183
1804
1184
def test_approve_short(self):
1805
self.assert_command_from_args(["-A", "client"],
1806
command.Approve)
1185
self.assert_command_from_args(["-A", "foo"], command.Approve)
1807
1186
1808
1187
def test_deny(self):
1809
self.assert_command_from_args(["--deny", "client"],
1810
command.Deny)
1188
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1811
1189
1812
1190
def test_deny_short(self):
1813
self.assert_command_from_args(["-D", "client"], command.Deny)
1191
self.assert_command_from_args(["-D", "foo"], command.Deny)
1814
1192
1815
1193
def test_remove(self):
1816
self.assert_command_from_args(["--remove", "client"],
1194
self.assert_command_from_args(["--remove", "foo"],
1817
1195
command.Remove)
1818
1196
1819
1197
def test_deny_before_remove(self):
1820
1198
options = self.parser.parse_args(["--deny", "--remove",
1821
"client"])
1199
"foo"])
1822
1200
check_option_syntax(self.parser, options)
1823
1201
commands = commands_from_options(options)
1824
1202
self.assertEqual(2, len(commands))
1835
1213
self.assertIsInstance(commands[1], command.Remove)
1836
1214
1837
1215
def test_remove_short(self):
1838
self.assert_command_from_args(["-r", "client"],
1839
command.Remove)
1216
self.assert_command_from_args(["-r", "foo"], command.Remove)
1840
1217
1841
1218
def test_dump_json(self):
1842
1219
self.assert_command_from_args(["--dump-json"],
1843
1220
command.DumpJSON)
1844
1221
1845
1222
def test_enable(self):
1846
self.assert_command_from_args(["--enable", "client"],
1223
self.assert_command_from_args(["--enable", "foo"],
1847
1224
command.Enable)
1848
1225
1849
1226
def test_enable_short(self):
1850
self.assert_command_from_args(["-e", "client"],
1851
command.Enable)
1227
self.assert_command_from_args(["-e", "foo"], command.Enable)
1852
1228
1853
1229
def test_disable(self):
1854
self.assert_command_from_args(["--disable", "client"],
1230
self.assert_command_from_args(["--disable", "foo"],
1855
1231
command.Disable)
1856
1232
1857
1233
def test_disable_short(self):
1858
self.assert_command_from_args(["-d", "client"],
1859
command.Disable)
1234
self.assert_command_from_args(["-d", "foo"], command.Disable)
1860
1235
1861
1236
def test_bump_timeout(self):
1862
self.assert_command_from_args(["--bump-timeout", "client"],
1237
self.assert_command_from_args(["--bump-timeout", "foo"],
1863
1238
command.BumpTimeout)
1864
1239
1865
1240
def test_bump_timeout_short(self):
1866
self.assert_command_from_args(["-b", "client"],
1241
self.assert_command_from_args(["-b", "foo"],
1867
1242
command.BumpTimeout)
1868
1243
1869
1244
def test_start_checker(self):
1870
self.assert_command_from_args(["--start-checker", "client"],
1245
self.assert_command_from_args(["--start-checker", "foo"],
1871
1246
command.StartChecker)
1872
1247
1873
1248
def test_stop_checker(self):
1874
self.assert_command_from_args(["--stop-checker", "client"],
1249
self.assert_command_from_args(["--stop-checker", "foo"],
1875
1250
command.StopChecker)
1876
1251
1877
1252
def test_approve_by_default(self):
1878
self.assert_command_from_args(["--approve-by-default",
1879
"client"],
1253
self.assert_command_from_args(["--approve-by-default", "foo"],
1880
1254
command.ApproveByDefault)
1881
1255
1882
1256
def test_deny_by_default(self):
1883
self.assert_command_from_args(["--deny-by-default", "client"],
1257
self.assert_command_from_args(["--deny-by-default", "foo"],
1884
1258
command.DenyByDefault)
1885
1259
1886
1260
def test_checker(self):
1887
self.assert_command_from_args(["--checker", ":", "client"],
1261
self.assert_command_from_args(["--checker", ":", "foo"],
1888
1262
command.SetChecker,
1889
1263
value_to_set=":")
1890
1264
1891
1265
def test_checker_empty(self):
1892
self.assert_command_from_args(["--checker", "", "client"],
1266
self.assert_command_from_args(["--checker", "", "foo"],
1893
1267
command.SetChecker,
1894
1268
value_to_set="")
1895
1269
1896
1270
def test_checker_short(self):
1897
self.assert_command_from_args(["-c", ":", "client"],
1271
self.assert_command_from_args(["-c", ":", "foo"],
1898
1272
command.SetChecker,
1899
1273
value_to_set=":")
1900
1274
1901
1275
def test_host(self):
1902
self.assert_command_from_args(
1903
["--host", "client.example.org", "client"],
1904
command.SetHost, value_to_set="client.example.org")
1276
self.assert_command_from_args(["--host", "foo.example.org",
1277
"foo"], command.SetHost,
1278
value_to_set="foo.example.org")
1905
1279
1906
1280
def test_host_short(self):
1907
self.assert_command_from_args(
1908
["-H", "client.example.org", "client"], command.SetHost,
1909
value_to_set="client.example.org")
1281
self.assert_command_from_args(["-H", "foo.example.org",
1282
"foo"], command.SetHost,
1283
value_to_set="foo.example.org")
1910
1284
1911
1285
def test_secret_devnull(self):
1912
1286
self.assert_command_from_args(["--secret", os.path.devnull,
1913
"client"], command.SetSecret,
1287
"foo"], command.SetSecret,
1914
1288
value_to_set=b"")
1915
1289
1916
1290
def test_secret_tempfile(self):
1919
1293
f.write(value)
1920
1294
f.seek(0)
1921
1295
self.assert_command_from_args(["--secret", f.name,
1922
"client"],
1923
command.SetSecret,
1296
"foo"], command.SetSecret,
1924
1297
value_to_set=value)
1925
1298
1926
1299
def test_secret_devnull_short(self):
1927
self.assert_command_from_args(["-s", os.path.devnull,
1928
"client"], command.SetSecret,
1300
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1301
command.SetSecret,
1929
1302
value_to_set=b"")
1930
1303
1931
1304
def test_secret_tempfile_short(self):
1933
1306
value = b"secret\0xyzzy\nbar"
1934
1307
f.write(value)
1935
1308
f.seek(0)
1936
self.assert_command_from_args(["-s", f.name, "client"],
1309
self.assert_command_from_args(["-s", f.name, "foo"],
1937
1310
command.SetSecret,
1938
1311
value_to_set=value)
1939
1312
1940
1313
def test_timeout(self):
1941
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1314
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1942
1315
command.SetTimeout,
1943
1316
value_to_set=300000)
1944
1317
1945
1318
def test_timeout_short(self):
1946
self.assert_command_from_args(["-t", "PT5M", "client"],
1319
self.assert_command_from_args(["-t", "PT5M", "foo"],
1947
1320
command.SetTimeout,
1948
1321
value_to_set=300000)
1949
1322
1950
1323
def test_extended_timeout(self):
1951
1324
self.assert_command_from_args(["--extended-timeout", "PT15M",
1952
"client"],
1325
"foo"],
1953
1326
command.SetExtendedTimeout,
1954
1327
value_to_set=900000)
1955
1328
1956
1329
def test_interval(self):
1957
self.assert_command_from_args(["--interval", "PT2M",
1958
"client"], command.SetInterval,
1330
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1331
command.SetInterval,
1959
1332
value_to_set=120000)
1960
1333
1961
1334
def test_interval_short(self):
1962
self.assert_command_from_args(["-i", "PT2M", "client"],
1335
self.assert_command_from_args(["-i", "PT2M", "foo"],
1963
1336
command.SetInterval,
1964
1337
value_to_set=120000)
1965
1338
1966
1339
def test_approval_delay(self):
1967
1340
self.assert_command_from_args(["--approval-delay", "PT30S",
1968
"client"],
1341
"foo"],
1969
1342
command.SetApprovalDelay,
1970
1343
value_to_set=30000)
1971
1344
1972
1345
def test_approval_duration(self):
1973
1346
self.assert_command_from_args(["--approval-duration", "PT1S",
1974
"client"],
1347
"foo"],
1975
1348
command.SetApprovalDuration,
1976
1349
value_to_set=1000)
1977
1350
1992
1365
class TestCommand(unittest.TestCase):
1993
1366
"""Abstract class for tests of command classes"""
1994
1367
1995
class FakeMandosBus(dbus.MandosBus):
1996
def __init__(self, testcase):
1997
self.client_properties = {
1998
"Name": "foo",
1999
"KeyID": ("92ed150794387c03ce684574b1139a65"
2000
"94a34f895daaaf09fd8ea90a27cddb12"),
2001
"Secret": b"secret",
2002
"Host": "foo.example.org",
2003
"Enabled": True,
2004
"Timeout": 300000,
2005
"LastCheckedOK": "2019-02-03T00:00:00",
2006
"Created": "2019-01-02T00:00:00",
2007
"Interval": 120000,
2008
"Fingerprint": ("778827225BA7DE539C5A"
2009
"7CFA59CFF7CDBD9A5920"),
2010
"CheckerRunning": False,
2011
"LastEnabled": "2019-01-03T00:00:00",
2012
"ApprovalPending": False,
2013
"ApprovedByDefault": True,
2014
"LastApprovalRequest": "",
2015
"ApprovalDelay": 0,
2016
"ApprovalDuration": 1000,
2017
"Checker": "fping -q -- %(host)s",
2018
"ExtendedTimeout": 900000,
2019
"Expires": "2019-02-04T00:00:00",
2020
"LastCheckerStatus": 0,
2021
}
2022
self.other_client_properties = {
2023
"Name": "barbar",
2024
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2025
"6ab612cff5ad227247e46c2b020f441c"),
2026
"Secret": b"secretbar",
2027
"Host": "192.0.2.3",
2028
"Enabled": True,
2029
"Timeout": 300000,
2030
"LastCheckedOK": "2019-02-04T00:00:00",
2031
"Created": "2019-01-03T00:00:00",
2032
"Interval": 120000,
2033
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2034
"F547B3A107558FCA3A27"),
2035
"CheckerRunning": True,
2036
"LastEnabled": "2019-01-04T00:00:00",
2037
"ApprovalPending": False,
2038
"ApprovedByDefault": False,
2039
"LastApprovalRequest": "2019-01-03T00:00:00",
2040
"ApprovalDelay": 30000,
2041
"ApprovalDuration": 93785000,
2042
"Checker": ":",
2043
"ExtendedTimeout": 900000,
2044
"Expires": "2019-02-05T00:00:00",
2045
"LastCheckerStatus": -2,
2046
}
2047
self.clients = collections.OrderedDict(
2048
[
2049
("client_objectpath", self.client_properties),
2050
("other_client_objectpath",
2051
self.other_client_properties),
2052
])
2053
self.one_client = {"client_objectpath":
2054
self.client_properties}
2055
self.testcase = testcase
2056
self.calls = []
2057
2058
def call_method(self, methodname, busname, objectpath,
2059
interface, *args):
2060
self.testcase.assertEqual("se.recompile.Mandos", busname)
2061
self.calls.append((methodname, busname, objectpath,
2062
interface, args))
2063
if interface == "org.freedesktop.DBus.Properties":
2064
if methodname == "Set":
2065
self.testcase.assertEqual(3, len(args))
2066
interface, key, value = args
2067
self.testcase.assertEqual(
2068
"se.recompile.Mandos.Client", interface)
2069
self.clients[objectpath][key] = value
2070
return
2071
elif interface == "se.recompile.Mandos":
2072
self.testcase.assertEqual("RemoveClient", methodname)
2073
self.testcase.assertEqual(1, len(args))
2074
clientpath = args[0]
2075
del self.clients[clientpath]
2076
return
2077
elif interface == "se.recompile.Mandos.Client":
2078
if methodname == "Approve":
2079
self.testcase.assertEqual(1, len(args))
2080
return
2081
raise ValueError()
2082
2083
1368
def setUp(self):
2084
self.bus = self.FakeMandosBus(self)
1369
testcase = self
1370
class MockClient(object):
1371
def __init__(self, name, **attributes):
1372
self.__dbus_object_path__ = "/clients/{}".format(name)
1373
self.attributes = attributes
1374
self.attributes["Name"] = name
1375
self.calls = []
1376
def Set(self, interface, propname, value, dbus_interface):
1377
testcase.assertEqual(client_dbus_interface, interface)
1378
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1379
dbus_interface)
1380
self.attributes[propname] = value
1381
def Approve(self, approve, dbus_interface):
1382
testcase.assertEqual(client_dbus_interface,
1383
dbus_interface)
1384
self.calls.append(("Approve", (approve,
1385
dbus_interface)))
1386
self.client = MockClient(
1387
"foo",
1388
KeyID=("92ed150794387c03ce684574b1139a65"
1389
"94a34f895daaaf09fd8ea90a27cddb12"),
1390
Secret=b"secret",
1391
Host="foo.example.org",
1392
Enabled=dbus.Boolean(True),
1393
Timeout=300000,
1394
LastCheckedOK="2019-02-03T00:00:00",
1395
Created="2019-01-02T00:00:00",
1396
Interval=120000,
1397
Fingerprint=("778827225BA7DE539C5A"
1398
"7CFA59CFF7CDBD9A5920"),
1399
CheckerRunning=dbus.Boolean(False),
1400
LastEnabled="2019-01-03T00:00:00",
1401
ApprovalPending=dbus.Boolean(False),
1402
ApprovedByDefault=dbus.Boolean(True),
1403
LastApprovalRequest="",
1404
ApprovalDelay=0,
1405
ApprovalDuration=1000,
1406
Checker="fping -q -- %(host)s",
1407
ExtendedTimeout=900000,
1408
Expires="2019-02-04T00:00:00",
1409
LastCheckerStatus=0)
1410
self.other_client = MockClient(
1411
"barbar",
1412
KeyID=("0558568eedd67d622f5c83b35a115f79"
1413
"6ab612cff5ad227247e46c2b020f441c"),
1414
Secret=b"secretbar",
1415
Host="192.0.2.3",
1416
Enabled=dbus.Boolean(True),
1417
Timeout=300000,
1418
LastCheckedOK="2019-02-04T00:00:00",
1419
Created="2019-01-03T00:00:00",
1420
Interval=120000,
1421
Fingerprint=("3E393AEAEFB84C7E89E2"
1422
"F547B3A107558FCA3A27"),
1423
CheckerRunning=dbus.Boolean(True),
1424
LastEnabled="2019-01-04T00:00:00",
1425
ApprovalPending=dbus.Boolean(False),
1426
ApprovedByDefault=dbus.Boolean(False),
1427
LastApprovalRequest="2019-01-03T00:00:00",
1428
ApprovalDelay=30000,
1429
ApprovalDuration=93785000,
1430
Checker=":",
1431
ExtendedTimeout=900000,
1432
Expires="2019-02-05T00:00:00",
1433
LastCheckerStatus=-2)
1434
self.clients = collections.OrderedDict(
1435
[
1436
("/clients/foo", self.client.attributes),
1437
("/clients/barbar", self.other_client.attributes),
1438
])
1439
self.one_client = {"/clients/foo": self.client.attributes}
1440
1441
@property
1442
def bus(self):
1443
class Bus(object):
1444
@staticmethod
1445
def get_object(client_bus_name, path):
1446
self.assertEqual(dbus_busname, client_bus_name)
1447
return {
1448
# Note: "self" here is the TestCmd instance, not
1449
# the Bus instance, since this is a static method!
1450
"/clients/foo": self.client,
1451
"/clients/barbar": self.other_client,
1452
}[path]
1453
return Bus()
2085
1454
2086
1455
2087
1456
class TestBaseCommands(TestCommand):
2088
1457
2089
1458
def test_IsEnabled_exits_successfully(self):
2090
1459
with self.assertRaises(SystemExit) as e:
2091
command.IsEnabled().run(self.bus.one_client)
1460
command.IsEnabled().run(self.one_client)
2092
1461
if e.exception.code is not None:
2093
1462
self.assertEqual(0, e.exception.code)
2094
1463
else:
2095
1464
self.assertIsNone(e.exception.code)
2096
1465
2097
1466
def test_IsEnabled_exits_with_failure(self):
2098
self.bus.client_properties["Enabled"] = False
1467
self.client.attributes["Enabled"] = dbus.Boolean(False)
2099
1468
with self.assertRaises(SystemExit) as e:
2100
command.IsEnabled().run(self.bus.one_client)
1469
command.IsEnabled().run(self.one_client)
2101
1470
if isinstance(e.exception.code, int):
2102
1471
self.assertNotEqual(0, e.exception.code)
2103
1472
else:
2104
1473
self.assertIsNotNone(e.exception.code)
2105
1474
2106
1475
def test_Approve(self):
2107
busname = "se.recompile.Mandos"
2108
client_interface = "se.recompile.Mandos.Client"
2109
command.Approve().run(self.bus.clients, self.bus)
2110
for clientpath in self.bus.clients:
2111
self.assertIn(("Approve", busname, clientpath,
2112
client_interface, (True,)), self.bus.calls)
1476
command.Approve().run(self.clients, self.bus)
1477
for clientpath in self.clients:
1478
client = self.bus.get_object(dbus_busname, clientpath)
1479
self.assertIn(("Approve", (True, client_dbus_interface)),
1480
client.calls)
2113
1481
2114
1482
def test_Deny(self):
2115
busname = "se.recompile.Mandos"
2116
client_interface = "se.recompile.Mandos.Client"
2117
command.Deny().run(self.bus.clients, self.bus)
2118
for clientpath in self.bus.clients:
2119
self.assertIn(("Approve", busname, clientpath,
2120
client_interface, (False,)),
2121
self.bus.calls)
1483
command.Deny().run(self.clients, self.bus)
1484
for clientpath in self.clients:
1485
client = self.bus.get_object(dbus_busname, clientpath)
1486
self.assertIn(("Approve", (False, client_dbus_interface)),
1487
client.calls)
2122
1488
2123
1489
def test_Remove(self):
2124
command.Remove().run(self.bus.clients, self.bus)
2125
for clientpath in self.bus.clients:
2126
self.assertIn(("RemoveClient", dbus_busname,
2127
dbus_server_path, dbus_server_interface,
2128
(clientpath,)), self.bus.calls)
1490
class MockMandos(object):
1491
def __init__(self):
1492
self.calls = []
1493
def RemoveClient(self, dbus_path):
1494
self.calls.append(("RemoveClient", (dbus_path,)))
1495
mandos = MockMandos()
1496
command.Remove().run(self.clients, self.bus, mandos)
1497
for clientpath in self.clients:
1498
self.assertIn(("RemoveClient", (clientpath,)),
1499
mandos.calls)
2129
1500
2130
1501
expected_json = {
2131
1502
"foo": {
2180
1551
2181
1552
def test_DumpJSON_normal(self):
2182
1553
with self.capture_stdout_to_buffer() as buffer:
2183
command.DumpJSON().run(self.bus.clients)
1554
command.DumpJSON().run(self.clients)
2184
1555
json_data = json.loads(buffer.getvalue())
2185
1556
self.assertDictEqual(self.expected_json, json_data)
2186
1557
2197
1568
2198
1569
def test_DumpJSON_one_client(self):
2199
1570
with self.capture_stdout_to_buffer() as buffer:
2200
command.DumpJSON().run(self.bus.one_client)
1571
command.DumpJSON().run(self.one_client)
2201
1572
json_data = json.loads(buffer.getvalue())
2202
1573
expected_json = {"foo": self.expected_json["foo"]}
2203
1574
self.assertDictEqual(expected_json, json_data)
2204
1575
2205
1576
def test_PrintTable_normal(self):
2206
1577
with self.capture_stdout_to_buffer() as buffer:
2207
command.PrintTable().run(self.bus.clients)
1578
command.PrintTable().run(self.clients)
2208
1579
expected_output = "\n".join((
2209
1580
"Name Enabled Timeout Last Successful Check",
2210
1581
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2214
1585
2215
1586
def test_PrintTable_verbose(self):
2216
1587
with self.capture_stdout_to_buffer() as buffer:
2217
command.PrintTable(verbose=True).run(self.bus.clients)
1588
command.PrintTable(verbose=True).run(self.clients)
2218
1589
columns = (
2219
1590
(
2220
1591
"Name ",
2310
1681
2311
1682
def test_PrintTable_one_client(self):
2312
1683
with self.capture_stdout_to_buffer() as buffer:
2313
command.PrintTable().run(self.bus.one_client)
1684
command.PrintTable().run(self.one_client)
2314
1685
expected_output = "\n".join((
2315
1686
"Name Enabled Timeout Last Successful Check",
2316
1687
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2318
1689
self.assertEqual(expected_output, buffer.getvalue())
2319
1690
2320
1691
2321
class TestPropertySetterCmd(TestCommand):
2322
"""Abstract class for tests of command.PropertySetter classes"""
2323
1692
class TestPropertyCmd(TestCommand):
1693
"""Abstract class for tests of command.Property classes"""
2324
1694
def runTest(self):
2325
1695
if not hasattr(self, "command"):
2326
return # Abstract TestCase class
2327
2328
if hasattr(self, "values_to_set"):
2329
cmd_args = [(value,) for value in self.values_to_set]
2330
values_to_get = getattr(self, "values_to_get",
2331
self.values_to_set)
2332
else:
2333
cmd_args = [() for x in range(len(self.values_to_get))]
2334
values_to_get = self.values_to_get
2335
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2336
for clientpath in self.bus.clients:
2337
self.bus.clients[clientpath][self.propname] = (
2338
Unique())
2339
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2340
for clientpath in self.bus.clients:
2341
value = (self.bus.clients[clientpath]
2342
[self.propname])
2343
self.assertNotIsInstance(value, Unique)
1696
return
1697
values_to_get = getattr(self, "values_to_get",
1698
self.values_to_set)
1699
for value_to_set, value_to_get in zip(self.values_to_set,
1700
values_to_get):
1701
for clientpath in self.clients:
1702
client = self.bus.get_object(dbus_busname, clientpath)
1703
old_value = client.attributes[self.propname]
1704
client.attributes[self.propname] = self.Unique()
1705
self.run_command(value_to_set, self.clients)
1706
for clientpath in self.clients:
1707
client = self.bus.get_object(dbus_busname, clientpath)
1708
value = client.attributes[self.propname]
1709
self.assertNotIsInstance(value, self.Unique)
2344
1710
self.assertEqual(value_to_get, value)
2345
1711
2346
2347
class TestEnableCmd(TestPropertySetterCmd):
1712
class Unique(object):
1713
"""Class for objects which exist only to be unique objects,
1714
since unittest.mock.sentinel only exists in Python 3.3"""
1715
1716
def run_command(self, value, clients):
1717
self.command().run(clients, self.bus)
1718
1719
1720
class TestEnableCmd(TestPropertyCmd):
2348
1721
command = command.Enable
2349
1722
propname = "Enabled"
2350
values_to_get = [True]
2351
2352
2353
class TestDisableCmd(TestPropertySetterCmd):
1723
values_to_set = [dbus.Boolean(True)]
1724
1725
1726
class TestDisableCmd(TestPropertyCmd):
2354
1727
command = command.Disable
2355
1728
propname = "Enabled"
2356
values_to_get = [False]
2357
2358
2359
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1729
values_to_set = [dbus.Boolean(False)]
1730
1731
1732
class TestBumpTimeoutCmd(TestPropertyCmd):
2360
1733
command = command.BumpTimeout
2361
1734
propname = "LastCheckedOK"
2362
values_to_get = [""]
2363
2364
2365
class TestStartCheckerCmd(TestPropertySetterCmd):
1735
values_to_set = [""]
1736
1737
1738
class TestStartCheckerCmd(TestPropertyCmd):
2366
1739
command = command.StartChecker
2367
1740
propname = "CheckerRunning"
2368
values_to_get = [True]
2369
2370
2371
class TestStopCheckerCmd(TestPropertySetterCmd):
1741
values_to_set = [dbus.Boolean(True)]
1742
1743
1744
class TestStopCheckerCmd(TestPropertyCmd):
2372
1745
command = command.StopChecker
2373
1746
propname = "CheckerRunning"
2374
values_to_get = [False]
2375
2376
2377
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1747
values_to_set = [dbus.Boolean(False)]
1748
1749
1750
class TestApproveByDefaultCmd(TestPropertyCmd):
2378
1751
command = command.ApproveByDefault
2379
1752
propname = "ApprovedByDefault"
2380
values_to_get = [True]
2381
2382
2383
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1753
values_to_set = [dbus.Boolean(True)]
1754
1755
1756
class TestDenyByDefaultCmd(TestPropertyCmd):
2384
1757
command = command.DenyByDefault
2385
1758
propname = "ApprovedByDefault"
2386
values_to_get = [False]
2387
2388
2389
class TestSetCheckerCmd(TestPropertySetterCmd):
1759
values_to_set = [dbus.Boolean(False)]
1760
1761
1762
class TestPropertyValueCmd(TestPropertyCmd):
1763
"""Abstract class for tests of PropertyValueCmd classes"""
1764
1765
def runTest(self):
1766
if type(self) is TestPropertyValueCmd:
1767
return
1768
return super(TestPropertyValueCmd, self).runTest()
1769
1770
def run_command(self, value, clients):
1771
self.command(value).run(clients, self.bus)
1772
1773
1774
class TestSetCheckerCmd(TestPropertyValueCmd):
2390
1775
command = command.SetChecker
2391
1776
propname = "Checker"
2392
1777
values_to_set = ["", ":", "fping -q -- %s"]
2393
1778
2394
1779
2395
class TestSetHostCmd(TestPropertySetterCmd):
1780
class TestSetHostCmd(TestPropertyValueCmd):
2396
1781
command = command.SetHost
2397
1782
propname = "Host"
2398
values_to_set = ["192.0.2.3", "client.example.org"]
2399
2400
2401
class TestSetSecretCmd(TestPropertySetterCmd):
1783
values_to_set = ["192.0.2.3", "foo.example.org"]
1784
1785
1786
class TestSetSecretCmd(TestPropertyValueCmd):
2402
1787
command = command.SetSecret
2403
1788
propname = "Secret"
2404
1789
values_to_set = [io.BytesIO(b""),
2405
1790
io.BytesIO(b"secret\0xyzzy\nbar")]
2406
values_to_get = [f.getvalue() for f in values_to_set]
2407
2408
2409
class TestSetTimeoutCmd(TestPropertySetterCmd):
1791
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1792
1793
1794
class TestSetTimeoutCmd(TestPropertyValueCmd):
2410
1795
command = command.SetTimeout
2411
1796
propname = "Timeout"
2412
1797
values_to_set = [datetime.timedelta(),
2414
1799
datetime.timedelta(seconds=1),
2415
1800
datetime.timedelta(weeks=1),
2416
1801
datetime.timedelta(weeks=52)]
2417
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2418
2419
2420
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1802
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1803
1804
1805
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2421
1806
command = command.SetExtendedTimeout
2422
1807
propname = "ExtendedTimeout"
2423
1808
values_to_set = [datetime.timedelta(),
2425
1810
datetime.timedelta(seconds=1),
2426
1811
datetime.timedelta(weeks=1),
2427
1812
datetime.timedelta(weeks=52)]
2428
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2429
2430
2431
class TestSetIntervalCmd(TestPropertySetterCmd):
1813
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1814
1815
1816
class TestSetIntervalCmd(TestPropertyValueCmd):
2432
1817
command = command.SetInterval
2433
1818
propname = "Interval"
2434
1819
values_to_set = [datetime.timedelta(),
2436
1821
datetime.timedelta(seconds=1),
2437
1822
datetime.timedelta(weeks=1),
2438
1823
datetime.timedelta(weeks=52)]
2439
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2440
2441
2442
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1824
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1825
1826
1827
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2443
1828
command = command.SetApprovalDelay
2444
1829
propname = "ApprovalDelay"
2445
1830
values_to_set = [datetime.timedelta(),
2447
1832
datetime.timedelta(seconds=1),
2448
1833
datetime.timedelta(weeks=1),
2449
1834
datetime.timedelta(weeks=52)]
2450
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2451
2452
2453
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1835
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1836
1837
1838
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2454
1839
command = command.SetApprovalDuration
2455
1840
propname = "ApprovalDuration"
2456
1841
values_to_set = [datetime.timedelta(),
2458
1843
datetime.timedelta(seconds=1),
2459
1844
datetime.timedelta(weeks=1),
2460
1845
datetime.timedelta(weeks=52)]
2461
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1846
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2462
1847
2463
1848
2464
1849
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0