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