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 1082
- compare with another revision
- download diff
- download tarball
- view history from revision 1082
- Committer: Teddy Hogeborn
- Date: 2019-03-17 17:34:07 UTC
- Revision ID: teddy@recompile.se-20190317173407-itlj1a7mzfwb3yz3
mandos-ctl: Refactor tests
* mandos-ctl: Change all calls to assertEqual (and related functions
assertNotEqual and assertDictEqual) to always pass
arguments in (expected, actual) order, for consistency.
* mandos-ctl: Change all calls to assertEqual (and related functions
assertNotEqual and assertDictEqual) to always pass
arguments in (expected, actual) order, for consistency.
- files removed:
- debian/po/POTFILES.in
- debian/tests
- dracut-module
- files modified:
- .bzrignore
added
removed
mandos-ctl
1
#!/usr/bin/python3 -bbI
2
# -*- after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
46
46
import tempfile
47
47
import contextlib
48
48
49
if sys.version_info.major == 2:
50
__metaclass__ = type
51
str = unicode
52
53
class gi:
54
"""Dummy gi module, for the tests"""
55
class repository:
56
class GLib:
57
class Error(Exception):
58
pass
59
dbussy = None
60
ravel = None
61
dbus_python = None
62
pydbus = None
63
64
try:
65
import dbussy
66
import ravel
67
except ImportError:
68
try:
69
import pydbus
70
import gi
71
except ImportError:
72
import dbus as dbus_python
73
49
import dbus
74
50
75
51
# Show warnings by default
76
52
if not sys.warnoptions:
84
60
logging.captureWarnings(True) # Show warnings via the logging system
85
61
86
62
if sys.version_info.major == 2:
87
import StringIO
88
io.StringIO = StringIO.StringIO
63
str = unicode
89
64
90
65
locale.setlocale(locale.LC_ALL, "")
91
66
92
version = "1.8.9"
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
version = "1.8.3"
74
75
76
try:
77
dbus.OBJECT_MANAGER_IFACE
78
except AttributeError:
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
93
80
94
81
95
82
def main():
96
83
parser = argparse.ArgumentParser()
84
97
85
add_command_line_options(parser)
98
86
99
87
options = parser.parse_args()
88
100
89
check_option_syntax(parser, options)
101
90
102
91
clientnames = options.client
104
93
if options.debug:
105
94
log.setLevel(logging.DEBUG)
106
95
107
if dbussy is not None and ravel is not None:
108
bus = dbussy_adapter.CachingBus(dbussy, ravel)
109
elif pydbus is not None:
110
bus = pydbus_adapter.CachingBus(pydbus)
111
else:
112
bus = dbus_python_adapter.CachingBus(dbus_python)
113
114
try:
115
all_clients = bus.get_clients_and_properties()
116
except dbus.ConnectFailed as e:
117
log.critical("Could not connect to Mandos server: %s", e)
118
sys.exit(1)
119
except dbus.Error as e:
120
log.critical(
121
"Failed to access Mandos server through D-Bus:\n%s", e)
122
sys.exit(1)
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
123
113
124
114
# Compile dict of (clientpath: properties) to process
125
115
if not clientnames:
138
128
commands = commands_from_options(options)
139
129
140
130
for command in commands:
141
command.run(clients, bus)
131
command.run(clients, bus, mandos_serv)
142
132
143
133
144
134
def add_command_line_options(parser):
149
139
help="Select all clients")
150
140
parser.add_argument("-v", "--verbose", action="store_true",
151
141
help="Print all fields")
152
parser.add_argument("-j", "--dump-json", dest="commands",
153
action="append_const", default=[],
154
const=command.DumpJSON(),
142
parser.add_argument("-j", "--dump-json", action="store_true",
155
143
help="Dump client data in JSON format")
156
144
enable_disable = parser.add_mutually_exclusive_group()
157
enable_disable.add_argument("-e", "--enable", dest="commands",
158
action="append_const", default=[],
159
const=command.Enable(),
145
enable_disable.add_argument("-e", "--enable", action="store_true",
160
146
help="Enable client")
161
enable_disable.add_argument("-d", "--disable", dest="commands",
162
action="append_const", default=[],
163
const=command.Disable(),
147
enable_disable.add_argument("-d", "--disable",
148
action="store_true",
164
149
help="disable client")
165
parser.add_argument("-b", "--bump-timeout", dest="commands",
166
action="append_const", default=[],
167
const=command.BumpTimeout(),
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
168
151
help="Bump timeout for client")
169
152
start_stop_checker = parser.add_mutually_exclusive_group()
170
153
start_stop_checker.add_argument("--start-checker",
171
dest="commands",
172
action="append_const", default=[],
173
const=command.StartChecker(),
154
action="store_true",
174
155
help="Start checker for client")
175
start_stop_checker.add_argument("--stop-checker", dest="commands",
176
action="append_const", default=[],
177
const=command.StopChecker(),
156
start_stop_checker.add_argument("--stop-checker",
157
action="store_true",
178
158
help="Stop checker for client")
179
parser.add_argument("-V", "--is-enabled", dest="commands",
180
action="append_const", default=[],
181
const=command.IsEnabled(),
159
parser.add_argument("-V", "--is-enabled", action="store_true",
182
160
help="Check if client is enabled")
183
parser.add_argument("-r", "--remove", dest="commands",
184
action="append_const", default=[],
185
const=command.Remove(),
161
parser.add_argument("-r", "--remove", action="store_true",
186
162
help="Remove client")
187
parser.add_argument("-c", "--checker", dest="commands",
188
action="append", default=[],
189
metavar="COMMAND", type=command.SetChecker,
163
parser.add_argument("-c", "--checker",
190
164
help="Set checker command for client")
191
parser.add_argument(
192
"-t", "--timeout", dest="commands", action="append",
193
default=[], metavar="TIME",
194
type=command.SetTimeout.argparse(string_to_delta),
195
help="Set timeout for client")
196
parser.add_argument(
197
"--extended-timeout", dest="commands", action="append",
198
default=[], metavar="TIME",
199
type=command.SetExtendedTimeout.argparse(string_to_delta),
200
help="Set extended timeout for client")
201
parser.add_argument(
202
"-i", "--interval", dest="commands", action="append",
203
default=[], metavar="TIME",
204
type=command.SetInterval.argparse(string_to_delta),
205
help="Set checker interval for client")
165
parser.add_argument("-t", "--timeout", type=string_to_delta,
166
help="Set timeout for client")
167
parser.add_argument("--extended-timeout", type=string_to_delta,
168
help="Set extended timeout for client")
169
parser.add_argument("-i", "--interval", type=string_to_delta,
170
help="Set checker interval for client")
206
171
approve_deny_default = parser.add_mutually_exclusive_group()
207
172
approve_deny_default.add_argument(
208
"--approve-by-default", dest="commands",
209
action="append_const", default=[],
210
const=command.ApproveByDefault(),
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
211
175
help="Set client to be approved by default")
212
176
approve_deny_default.add_argument(
213
"--deny-by-default", dest="commands",
214
action="append_const", default=[],
215
const=command.DenyByDefault(),
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
216
179
help="Set client to be denied by default")
217
parser.add_argument(
218
"--approval-delay", dest="commands", action="append",
219
default=[], metavar="TIME",
220
type=command.SetApprovalDelay.argparse(string_to_delta),
221
help="Set delay before client approve/deny")
222
parser.add_argument(
223
"--approval-duration", dest="commands", action="append",
224
default=[], metavar="TIME",
225
type=command.SetApprovalDuration.argparse(string_to_delta),
226
help="Set duration of one client approval")
227
parser.add_argument("-H", "--host", dest="commands",
228
action="append", default=[], metavar="STRING",
229
type=command.SetHost,
230
help="Set host for client")
231
parser.add_argument(
232
"-s", "--secret", dest="commands", action="append",
233
default=[], metavar="FILENAME",
234
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
235
help="Set password blob (file) for client")
180
parser.add_argument("--approval-delay", type=string_to_delta,
181
help="Set delay before client approve/deny")
182
parser.add_argument("--approval-duration", type=string_to_delta,
183
help="Set duration of one client approval")
184
parser.add_argument("-H", "--host", help="Set host for client")
185
parser.add_argument("-s", "--secret",
186
type=argparse.FileType(mode="rb"),
187
help="Set password blob (file) for client")
236
188
approve_deny = parser.add_mutually_exclusive_group()
237
189
approve_deny.add_argument(
238
"-A", "--approve", dest="commands", action="append_const",
239
default=[], const=command.Approve(),
190
"-A", "--approve", action="store_true",
240
191
help="Approve any current client request")
241
approve_deny.add_argument("-D", "--deny", dest="commands",
242
action="append_const", default=[],
243
const=command.Deny(),
192
approve_deny.add_argument("-D", "--deny", action="store_true",
244
193
help="Deny any current client request")
245
194
parser.add_argument("--debug", action="store_true",
246
195
help="Debug mode (show D-Bus commands)")
263
212
def rfc3339_duration_to_delta(duration):
264
213
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
265
214
266
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
267
True
268
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
269
True
270
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
271
True
272
>>> # 60 months
273
>>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
274
True
275
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
276
True
277
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
278
True
279
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
280
True
281
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
282
True
215
>>> rfc3339_duration_to_delta("P7D")
216
datetime.timedelta(7)
217
>>> rfc3339_duration_to_delta("PT60S")
218
datetime.timedelta(0, 60)
219
>>> rfc3339_duration_to_delta("PT60M")
220
datetime.timedelta(0, 3600)
221
>>> rfc3339_duration_to_delta("P60M")
222
datetime.timedelta(1680)
223
>>> rfc3339_duration_to_delta("PT24H")
224
datetime.timedelta(1)
225
>>> rfc3339_duration_to_delta("P1W")
226
datetime.timedelta(7)
227
>>> rfc3339_duration_to_delta("PT5M30S")
228
datetime.timedelta(0, 330)
229
>>> rfc3339_duration_to_delta("P1DT3M20S")
230
datetime.timedelta(1, 200)
283
231
>>> # Can not be empty:
284
232
>>> rfc3339_duration_to_delta("")
285
233
Traceback (most recent call last):
395
343
"""Parse an interval string as documented by Mandos before 1.6.1,
396
344
and return a datetime.timedelta
397
345
398
>>> parse_pre_1_6_1_interval('7d') == datetime.timedelta(days=7)
399
True
400
>>> parse_pre_1_6_1_interval('60s') == datetime.timedelta(0, 60)
401
True
402
>>> parse_pre_1_6_1_interval('60m') == datetime.timedelta(hours=1)
403
True
404
>>> parse_pre_1_6_1_interval('24h') == datetime.timedelta(days=1)
405
True
406
>>> parse_pre_1_6_1_interval('1w') == datetime.timedelta(days=7)
407
True
408
>>> parse_pre_1_6_1_interval('5m 30s') == datetime.timedelta(0, 330)
409
True
410
>>> parse_pre_1_6_1_interval('') == datetime.timedelta(0)
411
True
346
>>> parse_pre_1_6_1_interval('7d')
347
datetime.timedelta(7)
348
>>> parse_pre_1_6_1_interval('60s')
349
datetime.timedelta(0, 60)
350
>>> parse_pre_1_6_1_interval('60m')
351
datetime.timedelta(0, 3600)
352
>>> parse_pre_1_6_1_interval('24h')
353
datetime.timedelta(1)
354
>>> parse_pre_1_6_1_interval('1w')
355
datetime.timedelta(7)
356
>>> parse_pre_1_6_1_interval('5m 30s')
357
datetime.timedelta(0, 330)
358
>>> parse_pre_1_6_1_interval('')
359
datetime.timedelta(0)
412
360
>>> # Ignore unknown characters, allow any order and repetitions
413
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m') == datetime.timedelta(2, 480, 18000)
414
True
361
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
362
datetime.timedelta(2, 480, 18000)
415
363
416
364
"""
417
365
438
386
"""Apply additional restrictions on options, not expressible in
439
387
argparse"""
440
388
441
def has_commands(options, commands=None):
442
if commands is None:
443
commands = (command.Enable,
444
command.Disable,
445
command.BumpTimeout,
446
command.StartChecker,
447
command.StopChecker,
448
command.IsEnabled,
449
command.Remove,
450
command.SetChecker,
451
command.SetTimeout,
452
command.SetExtendedTimeout,
453
command.SetInterval,
454
command.ApproveByDefault,
455
command.DenyByDefault,
456
command.SetApprovalDelay,
457
command.SetApprovalDuration,
458
command.SetHost,
459
command.SetSecret,
460
command.Approve,
461
command.Deny)
462
return any(isinstance(cmd, commands)
463
for cmd in options.commands)
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))
464
408
465
if has_commands(options) and not (options.client or options.all):
409
if has_actions(options) and not (options.client or options.all):
466
410
parser.error("Options require clients names or --all.")
467
if options.verbose and has_commands(options):
411
if options.verbose and has_actions(options):
468
412
parser.error("--verbose can only be used alone.")
469
if (has_commands(options, (command.DumpJSON,))
470
and (options.verbose or len(options.commands) > 1)):
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
471
415
parser.error("--dump-json can only be used alone.")
472
if options.all and not has_commands(options):
416
if options.all and not has_actions(options):
473
417
parser.error("--all requires an action.")
474
if (has_commands(options, (command.IsEnabled,))
475
and len(options.client) > 1):
418
if options.is_enabled and len(options.client) > 1:
476
419
parser.error("--is-enabled requires exactly one client")
477
if (len(options.commands) > 1
478
and has_commands(options, (command.Remove,))
479
and not has_commands(options, (command.Deny,))):
480
parser.error("--remove can only be combined with --deny")
481
482
483
class dbus:
484
485
class SystemBus:
486
487
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
488
def get_managed_objects(self, busname, objectpath):
489
return self.call_method("GetManagedObjects", busname,
490
objectpath,
491
self.object_manager_iface)
492
493
properties_iface = "org.freedesktop.DBus.Properties"
494
def set_property(self, busname, objectpath, interface, key,
495
value):
496
self.call_method("Set", busname, objectpath,
497
self.properties_iface, interface, key,
498
value)
499
500
def call_method(self, methodname, busname, objectpath,
501
interface, *args):
502
raise NotImplementedError()
503
504
505
class MandosBus(SystemBus):
506
busname_domain = "se.recompile"
507
busname = busname_domain + ".Mandos"
508
server_path = "/"
509
server_interface = busname_domain + ".Mandos"
510
client_interface = busname_domain + ".Mandos.Client"
511
del busname_domain
512
513
def get_clients_and_properties(self):
514
managed_objects = self.get_managed_objects(
515
self.busname, self.server_path)
516
return {objpath: properties[self.client_interface]
517
for objpath, properties in managed_objects.items()
518
if self.client_interface in properties}
519
520
def set_client_property(self, objectpath, key, value):
521
return self.set_property(self.busname, objectpath,
522
self.client_interface, key,
523
value)
524
525
def call_client_method(self, objectpath, method, *args):
526
return self.call_method(method, self.busname, objectpath,
527
self.client_interface, *args)
528
529
def call_server_method(self, method, *args):
530
return self.call_method(method, self.busname,
531
self.server_path,
532
self.server_interface, *args)
533
534
class Error(Exception):
535
pass
536
537
class ConnectFailed(Error):
538
pass
539
540
541
class dbus_python_adapter:
542
543
class SystemBus(dbus.MandosBus):
544
"""Use dbus-python"""
545
546
def __init__(self, module=dbus_python):
547
self.dbus_python = module
548
self.bus = self.dbus_python.SystemBus()
549
550
@contextlib.contextmanager
551
def convert_exception(self, exception_class=dbus.Error):
552
try:
553
yield
554
except self.dbus_python.exceptions.DBusException as e:
555
# This does what "raise from" would do
556
exc = exception_class(*e.args)
557
exc.__cause__ = e
558
raise exc
559
560
def call_method(self, methodname, busname, objectpath,
561
interface, *args):
562
proxy_object = self.get_object(busname, objectpath)
563
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
564
interface, methodname,
565
", ".join(repr(a) for a in args))
566
method = getattr(proxy_object, methodname)
567
with self.convert_exception():
568
with dbus_python_adapter.SilenceLogger(
569
"dbus.proxies"):
570
value = method(*args, dbus_interface=interface)
571
return self.type_filter(value)
572
573
def get_object(self, busname, objectpath):
574
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
575
busname, objectpath)
576
with self.convert_exception(dbus.ConnectFailed):
577
return self.bus.get_object(busname, objectpath)
578
579
def type_filter(self, value):
580
"""Convert the most bothersome types to Python types"""
581
if isinstance(value, self.dbus_python.Boolean):
582
return bool(value)
583
if isinstance(value, self.dbus_python.ObjectPath):
584
return str(value)
585
# Also recurse into dictionaries
586
if isinstance(value, self.dbus_python.Dictionary):
587
return {self.type_filter(key):
588
self.type_filter(subval)
589
for key, subval in value.items()}
590
return value
591
592
def set_client_property(self, objectpath, key, value):
593
if key == "Secret":
594
if not isinstance(value, bytes):
595
value = value.encode("utf-8")
596
value = self.dbus_python.ByteArray(value)
597
return self.set_property(self.busname, objectpath,
598
self.client_interface, key,
599
value)
600
601
class SilenceLogger:
602
"Simple context manager to silence a particular logger"
603
def __init__(self, loggername):
604
self.logger = logging.getLogger(loggername)
605
606
def __enter__(self):
607
self.logger.addFilter(self.nullfilter)
608
609
class NullFilter(logging.Filter):
610
def filter(self, record):
611
return False
612
613
nullfilter = NullFilter()
614
615
def __exit__(self, exc_type, exc_val, exc_tb):
616
self.logger.removeFilter(self.nullfilter)
617
618
619
class CachingBus(SystemBus):
620
"""A caching layer for dbus_python_adapter.SystemBus"""
621
def __init__(self, *args, **kwargs):
622
self.object_cache = {}
623
super(dbus_python_adapter.CachingBus,
624
self).__init__(*args, **kwargs)
625
def get_object(self, busname, objectpath):
626
try:
627
return self.object_cache[(busname, objectpath)]
628
except KeyError:
629
new_object = super(
630
dbus_python_adapter.CachingBus,
631
self).get_object(busname, objectpath)
632
self.object_cache[(busname, objectpath)] = new_object
633
return new_object
634
635
636
class pydbus_adapter:
637
class SystemBus(dbus.MandosBus):
638
def __init__(self, module=pydbus):
639
self.pydbus = module
640
self.bus = self.pydbus.SystemBus()
641
642
@contextlib.contextmanager
643
def convert_exception(self, exception_class=dbus.Error):
644
try:
645
yield
646
except gi.repository.GLib.Error as e:
647
# This does what "raise from" would do
648
exc = exception_class(*e.args)
649
exc.__cause__ = e
650
raise exc
651
652
def call_method(self, methodname, busname, objectpath,
653
interface, *args):
654
proxy_object = self.get(busname, objectpath)
655
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
656
interface, methodname,
657
", ".join(repr(a) for a in args))
658
method = getattr(proxy_object[interface], methodname)
659
with self.convert_exception():
660
return method(*args)
661
662
def get(self, busname, objectpath):
663
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
664
busname, objectpath)
665
with self.convert_exception(dbus.ConnectFailed):
666
if sys.version_info.major <= 2:
667
with warnings.catch_warnings():
668
warnings.filterwarnings(
669
"ignore", "", DeprecationWarning,
670
r"^xml\.etree\.ElementTree$")
671
return self.bus.get(busname, objectpath)
672
else:
673
return self.bus.get(busname, objectpath)
674
675
def set_property(self, busname, objectpath, interface, key,
676
value):
677
proxy_object = self.get(busname, objectpath)
678
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
679
objectpath, self.properties_iface, interface,
680
key, value)
681
setattr(proxy_object[interface], key, value)
682
683
class CachingBus(SystemBus):
684
"""A caching layer for pydbus_adapter.SystemBus"""
685
def __init__(self, *args, **kwargs):
686
self.object_cache = {}
687
super(pydbus_adapter.CachingBus,
688
self).__init__(*args, **kwargs)
689
def get(self, busname, objectpath):
690
try:
691
return self.object_cache[(busname, objectpath)]
692
except KeyError:
693
new_object = (super(pydbus_adapter.CachingBus, self)
694
.get(busname, objectpath))
695
self.object_cache[(busname, objectpath)] = new_object
696
return new_object
697
698
699
class dbussy_adapter:
700
class SystemBus(dbus.SystemBus):
701
"""Use DBussy"""
702
703
def __init__(self, dbussy, ravel):
704
self.dbussy = dbussy
705
self.ravel = ravel
706
self.bus = ravel.system_bus()
707
708
@contextlib.contextmanager
709
def convert_exception(self, exception_class=dbus.Error):
710
try:
711
yield
712
except self.dbussy.DBusError as e:
713
# This does what "raise from" would do
714
exc = exception_class(*e.args)
715
exc.__cause__ = e
716
raise exc
717
718
def call_method(self, methodname, busname, objectpath,
719
interface, *args):
720
proxy_object = self.get_object(busname, objectpath)
721
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
722
interface, methodname,
723
", ".join(repr(a) for a in args))
724
iface = proxy_object.get_interface(interface)
725
method = getattr(iface, methodname)
726
with self.convert_exception(dbus.Error):
727
value = method(*args)
728
# DBussy returns values either as an empty list or as a
729
# tuple: (signature, value)
730
if value:
731
return self.type_filter(value[0])
732
733
def get_object(self, busname, objectpath):
734
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
735
busname, objectpath)
736
with self.convert_exception(dbus.ConnectFailed):
737
return self.bus[busname][objectpath]
738
739
def type_filter(self, value):
740
"""Convert the most bothersome types to Python types"""
741
if isinstance(value, tuple):
742
if (len(value) == 2
743
and isinstance(value[0],
744
self.dbussy.DBUS.Signature)):
745
return self.type_filter(value[1])
746
elif isinstance(value, self.dbussy.DBUS.ObjectPath):
747
return str(value)
748
# Also recurse into dictionaries
749
elif isinstance(value, dict):
750
return {self.type_filter(key):
751
self.type_filter(subval)
752
for key, subval in value.items()}
753
return value
754
755
def set_property(self, busname, objectpath, interface, key,
756
value):
757
proxy_object = self.get_object(busname, objectpath)
758
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
759
objectpath, self.properties_iface, interface,
760
key, value)
761
if key == "Secret":
762
# DBussy wants a Byte Array to be a sequence of
763
# values, not a byte string
764
value = tuple(value)
765
setattr(proxy_object.get_interface(interface), key, value)
766
767
class MandosBus(SystemBus, dbus.MandosBus):
768
pass
769
770
class CachingBus(MandosBus):
771
"""A caching layer for dbussy_adapter.MandosBus"""
772
def __init__(self, *args, **kwargs):
773
self.object_cache = {}
774
super(dbussy_adapter.CachingBus, self).__init__(*args,
775
**kwargs)
776
def get_object(self, busname, objectpath):
777
try:
778
return self.object_cache[(busname, objectpath)]
779
except KeyError:
780
new_object = super(
781
dbussy_adapter.CachingBus,
782
self).get_object(busname, objectpath)
783
self.object_cache[(busname, objectpath)] = new_object
784
return new_object
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)
785
473
786
474
787
475
def commands_from_options(options):
788
476
789
commands = list(options.commands)
790
791
def find_cmd(cmd, commands):
792
i = 0
793
for i, c in enumerate(commands):
794
if isinstance(c, cmd):
795
return i
796
return i+1
797
798
# If command.Remove is present, move any instances of command.Deny
799
# to occur ahead of command.Remove.
800
index_of_remove = find_cmd(command.Remove, commands)
801
before_remove = commands[:index_of_remove]
802
after_remove = commands[index_of_remove:]
803
cleaned_after = []
804
for cmd in after_remove:
805
if isinstance(cmd, command.Deny):
806
before_remove.append(cmd)
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())
807
512
else:
808
cleaned_after.append(cmd)
809
if cleaned_after != after_remove:
810
commands = before_remove + cleaned_after
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))
811
541
812
542
# If no command option has been given, show table of clients,
813
543
# optionally verbosely
817
547
return commands
818
548
819
549
820
class command:
550
class command(object):
821
551
"""A namespace for command classes"""
822
552
823
class Base:
553
class Base(object):
824
554
"""Abstract base class for commands"""
825
def run(self, clients, bus=None):
555
def run(self, clients, bus=None, mandos=None):
826
556
"""Normal commands should implement run_on_one_client(),
827
557
but commands which want to operate on all clients at the same time can
828
558
override this run() method instead.
829
559
"""
830
self.bus = bus
831
for client, properties in clients.items():
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)
832
565
self.run_on_one_client(client, properties)
833
566
834
567
835
568
class IsEnabled(Base):
836
def run(self, clients, bus=None):
837
properties = next(iter(clients.values()))
838
if properties["Enabled"]:
569
def run(self, clients, bus=None, mandos=None):
570
client, properties = next(iter(clients.items()))
571
if self.is_enabled(client, properties):
839
572
sys.exit(0)
840
573
sys.exit(1)
574
def is_enabled(self, client, properties):
575
return properties["Enabled"]
841
576
842
577
843
578
class Approve(Base):
844
579
def run_on_one_client(self, client, properties):
845
self.bus.call_client_method(client, "Approve", True)
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)
846
585
847
586
848
587
class Deny(Base):
849
588
def run_on_one_client(self, client, properties):
850
self.bus.call_client_method(client, "Approve", False)
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)
851
594
852
595
853
596
class Remove(Base):
854
def run(self, clients, bus):
855
for clientpath in frozenset(clients.keys()):
856
bus.call_server_method("RemoveClient", clientpath)
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__)
857
603
858
604
859
605
class Output(Base):
867
613
"Checker", "ExtendedTimeout", "Expires",
868
614
"LastCheckerStatus")
869
615
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
870
622
871
623
class DumpJSON(Output):
872
def run(self, clients, bus=None):
873
data = {properties["Name"]:
874
{key: properties[key]
624
def output(self, clients):
625
data = {client["Name"]:
626
{key: self.dbus_boolean_to_bool(client[key])
875
627
for key in self.all_keywords}
876
for properties in clients.values()}
877
print(json.dumps(data, indent=4, separators=(',', ': ')))
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
878
636
879
637
880
638
class PrintTable(Output):
881
639
def __init__(self, verbose=False):
882
640
self.verbose = verbose
883
641
884
def run(self, clients, bus=None):
642
def output(self, clients):
885
643
default_keywords = ("Name", "Enabled", "Timeout",
886
644
"LastCheckedOK")
887
645
keywords = default_keywords
888
646
if self.verbose:
889
647
keywords = self.all_keywords
890
print(self.TableOfClients(clients.values(), keywords))
648
return str(self.TableOfClients(clients, keywords))
891
649
892
class TableOfClients:
650
class TableOfClients(object):
893
651
tableheaders = {
894
652
"Name": "Name",
895
653
"Enabled": "Enabled",
948
706
949
707
@classmethod
950
708
def valuetostring(cls, value, keyword):
951
if isinstance(value, bool):
709
if isinstance(value, dbus.Boolean):
952
710
return "Yes" if value else "No"
953
711
if keyword in ("Timeout", "Interval", "ApprovalDelay",
954
712
"ApprovalDuration", "ExtendedTimeout"):
974
732
seconds=td.seconds % 60))
975
733
976
734
977
class PropertySetter(Base):
735
class Property(Base):
978
736
"Abstract class for Actions for setting one client property"
979
737
980
def run_on_one_client(self, client, properties=None):
738
def run_on_one_client(self, client, properties):
981
739
"""Set the Client's D-Bus property"""
982
self.bus.set_client_property(client, self.propname,
983
self.value_to_set)
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)
984
750
985
751
@property
986
752
def propname(self):
987
753
raise NotImplementedError()
988
754
989
755
990
class Enable(PropertySetter):
991
propname = "Enabled"
992
value_to_set = True
993
994
995
class Disable(PropertySetter):
996
propname = "Enabled"
997
value_to_set = False
998
999
1000
class BumpTimeout(PropertySetter):
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):
1001
767
propname = "LastCheckedOK"
1002
768
value_to_set = ""
1003
769
1004
770
1005
class StartChecker(PropertySetter):
1006
propname = "CheckerRunning"
1007
value_to_set = True
1008
1009
1010
class StopChecker(PropertySetter):
1011
propname = "CheckerRunning"
1012
value_to_set = False
1013
1014
1015
class ApproveByDefault(PropertySetter):
1016
propname = "ApprovedByDefault"
1017
value_to_set = True
1018
1019
1020
class DenyByDefault(PropertySetter):
1021
propname = "ApprovedByDefault"
1022
value_to_set = False
1023
1024
1025
class PropertySetterValue(PropertySetter):
1026
"""Abstract class for PropertySetter recieving a value as
1027
constructor argument instead of a class attribute."""
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"
1028
793
def __init__(self, value):
1029
794
self.value_to_set = value
1030
795
1031
@classmethod
1032
def argparse(cls, argtype):
1033
def cmdtype(arg):
1034
return cls(argtype(arg))
1035
return cmdtype
1036
796
1037
class SetChecker(PropertySetterValue):
797
class SetChecker(PropertyValue):
1038
798
propname = "Checker"
1039
799
1040
800
1041
class SetHost(PropertySetterValue):
801
class SetHost(PropertyValue):
1042
802
propname = "Host"
1043
803
1044
804
1045
class SetSecret(PropertySetterValue):
805
class SetSecret(PropertyValue):
1046
806
propname = "Secret"
1047
807
1048
808
@property
1056
816
value.close()
1057
817
1058
818
1059
class PropertySetterValueMilliseconds(PropertySetterValue):
1060
"""Abstract class for PropertySetterValue taking a value
1061
argument as a datetime.timedelta() but should store it as
1062
milliseconds."""
819
class MillisecondsPropertyValueArgument(PropertyValue):
820
"""Abstract class for PropertyValue taking a value argument as
821
a datetime.timedelta() but should store it as milliseconds."""
1063
822
1064
823
@property
1065
824
def value_to_set(self):
1071
830
self._vts = int(round(value.total_seconds() * 1000))
1072
831
1073
832
1074
class SetTimeout(PropertySetterValueMilliseconds):
833
class SetTimeout(MillisecondsPropertyValueArgument):
1075
834
propname = "Timeout"
1076
835
1077
836
1078
class SetExtendedTimeout(PropertySetterValueMilliseconds):
837
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
1079
838
propname = "ExtendedTimeout"
1080
839
1081
840
1082
class SetInterval(PropertySetterValueMilliseconds):
841
class SetInterval(MillisecondsPropertyValueArgument):
1083
842
propname = "Interval"
1084
843
1085
844
1086
class SetApprovalDelay(PropertySetterValueMilliseconds):
845
class SetApprovalDelay(MillisecondsPropertyValueArgument):
1087
846
propname = "ApprovalDelay"
1088
847
1089
848
1090
class SetApprovalDuration(PropertySetterValueMilliseconds):
849
class SetApprovalDuration(MillisecondsPropertyValueArgument):
1091
850
propname = "ApprovalDuration"
1092
851
1093
852
1126
885
"output"))
1127
886
1128
887
1129
class Unique:
1130
"""Class for objects which exist only to be unique objects, since
1131
unittest.mock.sentinel only exists in Python 3.3"""
1132
1133
1134
888
class Test_string_to_delta(TestCaseWithAssertLogs):
1135
889
# Just test basic RFC 3339 functionality here, the doc string for
1136
890
# rfc3339_duration_to_delta() already has more comprehensive
1137
# tests, which are run by doctest.
891
# tests, which is run by doctest.
1138
892
1139
893
def test_rfc3339_zero_seconds(self):
1140
894
self.assertEqual(datetime.timedelta(),
1164
918
1165
919
def test_actions_requires_client_or_all(self):
1166
920
for action, value in self.actions.items():
1167
args = self.actionargs(action, value)
921
options = self.parser.parse_args()
922
setattr(options, action, value)
1168
923
with self.assertParseError():
1169
self.parse_args(args)
924
self.check_option_syntax(options)
1170
925
1171
# This mostly corresponds to the definition from has_commands() in
926
# This mostly corresponds to the definition from has_actions() in
1172
927
# check_option_syntax()
1173
928
actions = {
1174
"--enable": None,
1175
"--disable": None,
1176
"--bump-timeout": None,
1177
"--start-checker": None,
1178
"--stop-checker": None,
1179
"--is-enabled": None,
1180
"--remove": None,
1181
"--checker": "x",
1182
"--timeout": "PT0S",
1183
"--extended-timeout": "PT0S",
1184
"--interval": "PT0S",
1185
"--approve-by-default": None,
1186
"--deny-by-default": None,
1187
"--approval-delay": "PT0S",
1188
"--approval-duration": "PT0S",
1189
"--host": "hostname",
1190
"--secret": "/dev/null",
1191
"--approve": None,
1192
"--deny": None,
929
# The actual values set here are not that important, but we do
930
# at least stick to the correct types, even though they are
931
# never used
932
"enable": True,
933
"disable": True,
934
"bump_timeout": True,
935
"start_checker": True,
936
"stop_checker": True,
937
"is_enabled": True,
938
"remove": True,
939
"checker": "x",
940
"timeout": datetime.timedelta(),
941
"extended_timeout": datetime.timedelta(),
942
"interval": datetime.timedelta(),
943
"approved_by_default": True,
944
"approval_delay": datetime.timedelta(),
945
"approval_duration": datetime.timedelta(),
946
"host": "x",
947
"secret": io.BytesIO(b"x"),
948
"approve": True,
949
"deny": True,
1193
950
}
1194
951
1195
@staticmethod
1196
def actionargs(action, value, *args):
1197
if value is not None:
1198
return [action, value] + list(args)
1199
else:
1200
return [action] + list(args)
1201
1202
952
@contextlib.contextmanager
1203
953
def assertParseError(self):
1204
954
with self.assertRaises(SystemExit) as e:
1209
959
# /argparse.html#exiting-methods
1210
960
self.assertEqual(2, e.exception.code)
1211
961
1212
def parse_args(self, args):
1213
options = self.parser.parse_args(args)
1214
check_option_syntax(self.parser, options)
1215
1216
962
@staticmethod
1217
963
@contextlib.contextmanager
1218
964
def redirect_stderr_to_devnull():
1219
old_stderr = sys.stderr
1220
with contextlib.closing(open(os.devnull, "w")) as null:
1221
sys.stderr = null
1222
try:
1223
yield
1224
finally:
1225
sys.stderr = old_stderr
965
null = os.open(os.path.devnull, os.O_RDWR)
966
stderrcopy = os.dup(sys.stderr.fileno())
967
os.dup2(null, sys.stderr.fileno())
968
os.close(null)
969
try:
970
yield
971
finally:
972
# restore stderr
973
os.dup2(stderrcopy, sys.stderr.fileno())
974
os.close(stderrcopy)
1226
975
1227
976
def check_option_syntax(self, options):
1228
977
check_option_syntax(self.parser, options)
1229
978
1230
979
def test_actions_all_conflicts_with_verbose(self):
1231
980
for action, value in self.actions.items():
1232
args = self.actionargs(action, value, "--all",
1233
"--verbose")
981
options = self.parser.parse_args()
982
setattr(options, action, value)
983
options.all = True
984
options.verbose = True
1234
985
with self.assertParseError():
1235
self.parse_args(args)
986
self.check_option_syntax(options)
1236
987
1237
988
def test_actions_with_client_conflicts_with_verbose(self):
1238
989
for action, value in self.actions.items():
1239
args = self.actionargs(action, value, "--verbose",
1240
"client")
990
options = self.parser.parse_args()
991
setattr(options, action, value)
992
options.verbose = True
993
options.client = ["foo"]
1241
994
with self.assertParseError():
1242
self.parse_args(args)
995
self.check_option_syntax(options)
1243
996
1244
997
def test_dump_json_conflicts_with_verbose(self):
1245
args = ["--dump-json", "--verbose"]
998
options = self.parser.parse_args()
999
options.dump_json = True
1000
options.verbose = True
1246
1001
with self.assertParseError():
1247
self.parse_args(args)
1002
self.check_option_syntax(options)
1248
1003
1249
1004
def test_dump_json_conflicts_with_action(self):
1250
1005
for action, value in self.actions.items():
1251
args = self.actionargs(action, value, "--dump-json")
1006
options = self.parser.parse_args()
1007
setattr(options, action, value)
1008
options.dump_json = True
1252
1009
with self.assertParseError():
1253
self.parse_args(args)
1010
self.check_option_syntax(options)
1254
1011
1255
1012
def test_all_can_not_be_alone(self):
1256
args = ["--all"]
1013
options = self.parser.parse_args()
1014
options.all = True
1257
1015
with self.assertParseError():
1258
self.parse_args(args)
1016
self.check_option_syntax(options)
1259
1017
1260
1018
def test_all_is_ok_with_any_action(self):
1261
1019
for action, value in self.actions.items():
1262
args = self.actionargs(action, value, "--all")
1263
self.parse_args(args)
1020
options = self.parser.parse_args()
1021
setattr(options, action, value)
1022
options.all = True
1023
self.check_option_syntax(options)
1264
1024
1265
1025
def test_any_action_is_ok_with_one_client(self):
1266
1026
for action, value in self.actions.items():
1267
args = self.actionargs(action, value, "client")
1268
self.parse_args(args)
1027
options = self.parser.parse_args()
1028
setattr(options, action, value)
1029
options.client = ["foo"]
1030
self.check_option_syntax(options)
1269
1031
1270
1032
def test_one_client_with_all_actions_except_is_enabled(self):
1033
options = self.parser.parse_args()
1271
1034
for action, value in self.actions.items():
1272
if action == "--is-enabled":
1035
if action == "is_enabled":
1273
1036
continue
1274
args = self.actionargs(action, value, "client")
1275
self.parse_args(args)
1037
setattr(options, action, value)
1038
options.client = ["foo"]
1039
self.check_option_syntax(options)
1276
1040
1277
1041
def test_two_clients_with_all_actions_except_is_enabled(self):
1042
options = self.parser.parse_args()
1278
1043
for action, value in self.actions.items():
1279
if action == "--is-enabled":
1044
if action == "is_enabled":
1280
1045
continue
1281
args = self.actionargs(action, value, "client1",
1282
"client2")
1283
self.parse_args(args)
1046
setattr(options, action, value)
1047
options.client = ["foo", "barbar"]
1048
self.check_option_syntax(options)
1284
1049
1285
1050
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1286
1051
for action, value in self.actions.items():
1287
if action == "--is-enabled":
1052
if action == "is_enabled":
1288
1053
continue
1289
args = self.actionargs(action, value, "client1",
1290
"client2")
1291
self.parse_args(args)
1054
options = self.parser.parse_args()
1055
setattr(options, action, value)
1056
options.client = ["foo", "barbar"]
1057
self.check_option_syntax(options)
1292
1058
1293
1059
def test_is_enabled_fails_without_client(self):
1294
args = ["--is-enabled"]
1060
options = self.parser.parse_args()
1061
options.is_enabled = True
1295
1062
with self.assertParseError():
1296
self.parse_args(args)
1063
self.check_option_syntax(options)
1297
1064
1298
1065
def test_is_enabled_fails_with_two_clients(self):
1299
args = ["--is-enabled", "client1", "client2"]
1066
options = self.parser.parse_args()
1067
options.is_enabled = True
1068
options.client = ["foo", "barbar"]
1300
1069
with self.assertParseError():
1301
self.parse_args(args)
1070
self.check_option_syntax(options)
1302
1071
1303
1072
def test_remove_can_only_be_combined_with_action_deny(self):
1304
1073
for action, value in self.actions.items():
1305
if action in {"--remove", "--deny"}:
1074
if action in {"remove", "deny"}:
1306
1075
continue
1307
args = self.actionargs(action, value, "--all",
1308
"--remove")
1076
options = self.parser.parse_args()
1077
setattr(options, action, value)
1078
options.all = True
1079
options.remove = True
1309
1080
with self.assertParseError():
1310
self.parse_args(args)
1311
1312
1313
class Test_dbus_exceptions(unittest.TestCase):
1314
1315
def test_dbus_ConnectFailed_is_Error(self):
1316
with self.assertRaises(dbus.Error):
1317
raise dbus.ConnectFailed()
1318
1319
1320
class Test_dbus_MandosBus(unittest.TestCase):
1321
1322
class MockMandosBus(dbus.MandosBus):
1323
def __init__(self):
1324
self._name = "se.recompile.Mandos"
1325
self._server_path = "/"
1326
self._server_interface = "se.recompile.Mandos"
1327
self._client_interface = "se.recompile.Mandos.Client"
1328
self.calls = []
1329
self.call_method_return = Unique()
1330
1331
def call_method(self, methodname, busname, objectpath,
1332
interface, *args):
1333
self.calls.append((methodname, busname, objectpath,
1334
interface, args))
1335
return self.call_method_return
1336
1337
def setUp(self):
1338
self.bus = self.MockMandosBus()
1339
1340
def test_set_client_property(self):
1341
self.bus.set_client_property("objectpath", "key", "value")
1342
expected_call = ("Set", self.bus._name, "objectpath",
1343
"org.freedesktop.DBus.Properties",
1344
(self.bus._client_interface, "key", "value"))
1345
self.assertIn(expected_call, self.bus.calls)
1346
1347
def test_call_client_method(self):
1348
ret = self.bus.call_client_method("objectpath", "methodname")
1349
self.assertIs(self.bus.call_method_return, ret)
1350
expected_call = ("methodname", self.bus._name, "objectpath",
1351
self.bus._client_interface, ())
1352
self.assertIn(expected_call, self.bus.calls)
1353
1354
def test_call_client_method_with_args(self):
1355
args = (Unique(), Unique())
1356
ret = self.bus.call_client_method("objectpath", "methodname",
1357
*args)
1358
self.assertIs(self.bus.call_method_return, ret)
1359
expected_call = ("methodname", self.bus._name, "objectpath",
1360
self.bus._client_interface,
1361
(args[0], args[1]))
1362
self.assertIn(expected_call, self.bus.calls)
1363
1364
def test_get_clients_and_properties(self):
1365
managed_objects = {
1366
"objectpath": {
1367
self.bus._client_interface: {
1368
"key": "value",
1369
"bool": True,
1370
},
1371
"irrelevant_interface": {
1372
"key": "othervalue",
1373
"bool": False,
1374
},
1375
},
1376
"other_objectpath": {
1377
"other_irrelevant_interface": {
1378
"key": "value 3",
1379
"bool": None,
1380
},
1381
},
1382
}
1383
expected_clients_and_properties = {
1384
"objectpath": {
1385
"key": "value",
1386
"bool": True,
1387
}
1388
}
1389
self.bus.call_method_return = managed_objects
1390
ret = self.bus.get_clients_and_properties()
1391
self.assertDictEqual(expected_clients_and_properties, ret)
1392
expected_call = ("GetManagedObjects", self.bus._name,
1393
self.bus._server_path,
1394
"org.freedesktop.DBus.ObjectManager", ())
1395
self.assertIn(expected_call, self.bus.calls)
1396
1397
def test_call_server_method(self):
1398
ret = self.bus.call_server_method("methodname")
1399
self.assertIs(self.bus.call_method_return, ret)
1400
expected_call = ("methodname", self.bus._name,
1401
self.bus._server_path,
1402
self.bus._server_interface, ())
1403
self.assertIn(expected_call, self.bus.calls)
1404
1405
def test_call_server_method_with_args(self):
1406
args = (Unique(), Unique())
1407
ret = self.bus.call_server_method("methodname", *args)
1408
self.assertIs(self.bus.call_method_return, ret)
1409
expected_call = ("methodname", self.bus._name,
1410
self.bus._server_path,
1411
self.bus._server_interface,
1412
(args[0], args[1]))
1413
self.assertIn(expected_call, self.bus.calls)
1414
1415
1416
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1417
1418
def MockDBusPython_func(self, func):
1419
class mock_dbus_python:
1420
"""mock dbus-python module"""
1421
class exceptions:
1422
"""Pseudo-namespace"""
1423
class DBusException(Exception):
1424
pass
1425
class SystemBus:
1426
@staticmethod
1427
def get_object(busname, objectpath):
1428
DBusObject = collections.namedtuple(
1429
"DBusObject", ("methodname", "Set"))
1430
def method(*args, **kwargs):
1431
self.assertEqual({"dbus_interface":
1432
"interface"},
1433
kwargs)
1434
return func(*args)
1435
def set_property(interface, key, value,
1436
dbus_interface=None):
1437
self.assertEqual(
1438
"org.freedesktop.DBus.Properties",
1439
dbus_interface)
1440
self.assertEqual("Secret", key)
1441
return func(interface, key, value,
1442
dbus_interface=dbus_interface)
1443
return DBusObject(methodname=method,
1444
Set=set_property)
1445
class Boolean:
1446
def __init__(self, value):
1447
self.value = bool(value)
1448
def __bool__(self):
1449
return self.value
1450
if sys.version_info.major == 2:
1451
__nonzero__ = __bool__
1452
class ObjectPath(str):
1453
pass
1454
class Dictionary(dict):
1455
pass
1456
class ByteArray(bytes):
1457
pass
1458
return mock_dbus_python
1459
1460
def call_method(self, bus, methodname, busname, objectpath,
1461
interface, *args):
1462
with self.assertLogs(log, logging.DEBUG):
1463
return bus.call_method(methodname, busname, objectpath,
1464
interface, *args)
1465
1466
def test_call_method_returns(self):
1467
expected_method_return = Unique()
1468
method_args = (Unique(), Unique())
1469
def func(*args):
1470
self.assertEqual(len(method_args), len(args))
1471
for marg, arg in zip(method_args, args):
1472
self.assertIs(marg, arg)
1473
return expected_method_return
1474
mock_dbus_python = self.MockDBusPython_func(func)
1475
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1476
ret = self.call_method(bus, "methodname", "busname",
1477
"objectpath", "interface",
1478
*method_args)
1479
self.assertIs(ret, expected_method_return)
1480
1481
def test_call_method_filters_bool_true(self):
1482
def func():
1483
return method_return
1484
mock_dbus_python = self.MockDBusPython_func(func)
1485
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1486
method_return = mock_dbus_python.Boolean(True)
1487
ret = self.call_method(bus, "methodname", "busname",
1488
"objectpath", "interface")
1489
self.assertTrue(ret)
1490
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1491
1492
def test_call_method_filters_bool_false(self):
1493
def func():
1494
return method_return
1495
mock_dbus_python = self.MockDBusPython_func(func)
1496
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1497
method_return = mock_dbus_python.Boolean(False)
1498
ret = self.call_method(bus, "methodname", "busname",
1499
"objectpath", "interface")
1500
self.assertFalse(ret)
1501
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1502
1503
def test_call_method_filters_objectpath(self):
1504
def func():
1505
return method_return
1506
mock_dbus_python = self.MockDBusPython_func(func)
1507
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1508
method_return = mock_dbus_python.ObjectPath("objectpath")
1509
ret = self.call_method(bus, "methodname", "busname",
1510
"objectpath", "interface")
1511
self.assertEqual("objectpath", ret)
1512
self.assertIsNot("objectpath", ret)
1513
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1514
1515
def test_call_method_filters_booleans_in_dict(self):
1516
def func():
1517
return method_return
1518
mock_dbus_python = self.MockDBusPython_func(func)
1519
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1520
method_return = mock_dbus_python.Dictionary(
1521
{mock_dbus_python.Boolean(True):
1522
mock_dbus_python.Boolean(False),
1523
mock_dbus_python.Boolean(False):
1524
mock_dbus_python.Boolean(True)})
1525
ret = self.call_method(bus, "methodname", "busname",
1526
"objectpath", "interface")
1527
expected_method_return = {True: False,
1528
False: True}
1529
self.assertEqual(expected_method_return, ret)
1530
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1531
1532
def test_call_method_filters_objectpaths_in_dict(self):
1533
def func():
1534
return method_return
1535
mock_dbus_python = self.MockDBusPython_func(func)
1536
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1537
method_return = mock_dbus_python.Dictionary(
1538
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1539
mock_dbus_python.ObjectPath("objectpath_value_1"),
1540
mock_dbus_python.ObjectPath("objectpath_key_2"):
1541
mock_dbus_python.ObjectPath("objectpath_value_2")})
1542
ret = self.call_method(bus, "methodname", "busname",
1543
"objectpath", "interface")
1544
expected_method_return = {str(key): str(value)
1545
for key, value in
1546
method_return.items()}
1547
self.assertEqual(expected_method_return, ret)
1548
self.assertIsInstance(ret, dict)
1549
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1550
1551
def test_call_method_filters_dict_in_dict(self):
1552
def func():
1553
return method_return
1554
mock_dbus_python = self.MockDBusPython_func(func)
1555
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1556
method_return = mock_dbus_python.Dictionary(
1557
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1558
"key12": "value12"}),
1559
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1560
"key22": "value22"})})
1561
ret = self.call_method(bus, "methodname", "busname",
1562
"objectpath", "interface")
1563
expected_method_return = {
1564
"key1": {"key11": "value11",
1565
"key12": "value12"},
1566
"key2": {"key21": "value21",
1567
"key22": "value22"},
1568
}
1569
self.assertEqual(expected_method_return, ret)
1570
self.assertIsInstance(ret, dict)
1571
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1572
for key, value in ret.items():
1573
self.assertIsInstance(value, dict)
1574
self.assertEqual(expected_method_return[key], value)
1575
self.assertNotIsInstance(value,
1576
mock_dbus_python.Dictionary)
1577
1578
def test_call_method_filters_dict_three_deep(self):
1579
def func():
1580
return method_return
1581
mock_dbus_python = self.MockDBusPython_func(func)
1582
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1583
method_return = mock_dbus_python.Dictionary(
1584
{"key1":
1585
mock_dbus_python.Dictionary(
1586
{"key2":
1587
mock_dbus_python.Dictionary(
1588
{"key3":
1589
mock_dbus_python.Boolean(True),
1590
}),
1591
}),
1592
})
1593
ret = self.call_method(bus, "methodname", "busname",
1594
"objectpath", "interface")
1595
expected_method_return = {"key1": {"key2": {"key3": True}}}
1596
self.assertEqual(expected_method_return, ret)
1597
self.assertIsInstance(ret, dict)
1598
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1599
self.assertIsInstance(ret["key1"], dict)
1600
self.assertNotIsInstance(ret["key1"],
1601
mock_dbus_python.Dictionary)
1602
self.assertIsInstance(ret["key1"]["key2"], dict)
1603
self.assertNotIsInstance(ret["key1"]["key2"],
1604
mock_dbus_python.Dictionary)
1605
self.assertTrue(ret["key1"]["key2"]["key3"])
1606
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1607
mock_dbus_python.Boolean)
1608
1609
def test_call_method_handles_exception(self):
1081
self.check_option_syntax(options)
1082
1083
1084
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1085
def test_calls_and_returns_get_object_on_bus(self):
1086
class MockBus(object):
1087
called = False
1088
def get_object(mockbus_self, busname, dbus_path):
1089
# Note that "self" is still the testcase instance,
1090
# this MockBus instance is in "mockbus_self".
1091
self.assertEqual(dbus_busname, busname)
1092
self.assertEqual(server_dbus_path, dbus_path)
1093
mockbus_self.called = True
1094
return mockbus_self
1095
1096
mockbus = get_mandos_dbus_object(bus=MockBus())
1097
self.assertIsInstance(mockbus, MockBus)
1098
self.assertTrue(mockbus.called)
1099
1100
def test_logs_and_exits_on_dbus_error(self):
1101
class MockBusFailing(object):
1102
def get_object(self, busname, dbus_path):
1103
raise dbus.exceptions.DBusException("Test")
1104
1105
with self.assertLogs(log, logging.CRITICAL):
1106
with self.assertRaises(SystemExit) as e:
1107
bus = get_mandos_dbus_object(bus=MockBusFailing())
1108
1109
if isinstance(e.exception.code, int):
1110
self.assertNotEqual(0, e.exception.code)
1111
else:
1112
self.assertIsNotNone(e.exception.code)
1113
1114
1115
class Test_get_managed_objects(TestCaseWithAssertLogs):
1116
def test_calls_and_returns_GetManagedObjects(self):
1117
managed_objects = {"/clients/foo": { "Name": "foo"}}
1118
class MockObjectManager(object):
1119
def GetManagedObjects(self):
1120
return managed_objects
1121
retval = get_managed_objects(MockObjectManager())
1122
self.assertDictEqual(managed_objects, retval)
1123
1124
def test_logs_and_exits_on_dbus_error(self):
1610
1125
dbus_logger = logging.getLogger("dbus.proxies")
1611
1126
1612
def func():
1613
dbus_logger.error("Test")
1614
raise mock_dbus_python.exceptions.DBusException()
1615
1616
mock_dbus_python = self.MockDBusPython_func(func)
1617
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1127
class MockObjectManagerFailing(object):
1128
def GetManagedObjects(self):
1129
dbus_logger.error("Test")
1130
raise dbus.exceptions.DBusException("Test")
1618
1131
1619
1132
class CountingHandler(logging.Handler):
1620
1133
count = 0
1626
1139
dbus_logger.addHandler(counting_handler)
1627
1140
1628
1141
try:
1629
with self.assertRaises(dbus.Error) as e:
1630
self.call_method(bus, "methodname", "busname",
1631
"objectpath", "interface")
1142
with self.assertLogs(log, logging.CRITICAL) as watcher:
1143
with self.assertRaises(SystemExit) as e:
1144
get_managed_objects(MockObjectManagerFailing())
1632
1145
finally:
1633
1146
dbus_logger.removeFilter(counting_handler)
1634
1147
1635
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1636
1637
1148
# Make sure the dbus logger was suppressed
1638
1149
self.assertEqual(0, counting_handler.count)
1639
1150
1640
def test_Set_Secret_sends_bytearray(self):
1641
ret = [None]
1642
def func(*args, **kwargs):
1643
ret[0] = (args, kwargs)
1644
mock_dbus_python = self.MockDBusPython_func(func)
1645
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1646
bus.set_client_property("objectpath", "Secret", "value")
1647
expected_call = (("se.recompile.Mandos.Client", "Secret",
1648
mock_dbus_python.ByteArray(b"value")),
1649
{"dbus_interface":
1650
"org.freedesktop.DBus.Properties"})
1651
self.assertEqual(expected_call, ret[0])
1652
if sys.version_info.major == 2:
1653
self.assertIsInstance(ret[0][0][-1],
1654
mock_dbus_python.ByteArray)
1655
1656
def test_get_object_converts_to_correct_exception(self):
1657
bus = dbus_python_adapter.SystemBus(
1658
self.fake_dbus_python_raises_exception_on_connect)
1659
with self.assertRaises(dbus.ConnectFailed):
1660
self.call_method(bus, "methodname", "busname",
1661
"objectpath", "interface")
1662
1663
class fake_dbus_python_raises_exception_on_connect:
1664
"""fake dbus-python module"""
1665
class exceptions:
1666
"""Pseudo-namespace"""
1667
class DBusException(Exception):
1668
pass
1669
1670
@classmethod
1671
def SystemBus(cls):
1672
def get_object(busname, objectpath):
1673
raise cls.exceptions.DBusException()
1674
Bus = collections.namedtuple("Bus", ["get_object"])
1675
return Bus(get_object=get_object)
1676
1677
1678
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1679
class mock_dbus_python:
1680
"""mock dbus-python modules"""
1681
class SystemBus:
1682
@staticmethod
1683
def get_object(busname, objectpath):
1684
return Unique()
1685
1686
def setUp(self):
1687
self.bus = dbus_python_adapter.CachingBus(
1688
self.mock_dbus_python)
1689
1690
def test_returns_distinct_objectpaths(self):
1691
obj1 = self.bus.get_object("busname", "objectpath1")
1692
self.assertIsInstance(obj1, Unique)
1693
obj2 = self.bus.get_object("busname", "objectpath2")
1694
self.assertIsInstance(obj2, Unique)
1695
self.assertIsNot(obj1, obj2)
1696
1697
def test_returns_distinct_busnames(self):
1698
obj1 = self.bus.get_object("busname1", "objectpath")
1699
self.assertIsInstance(obj1, Unique)
1700
obj2 = self.bus.get_object("busname2", "objectpath")
1701
self.assertIsInstance(obj2, Unique)
1702
self.assertIsNot(obj1, obj2)
1703
1704
def test_returns_distinct_both(self):
1705
obj1 = self.bus.get_object("busname1", "objectpath")
1706
self.assertIsInstance(obj1, Unique)
1707
obj2 = self.bus.get_object("busname2", "objectpath")
1708
self.assertIsInstance(obj2, Unique)
1709
self.assertIsNot(obj1, obj2)
1710
1711
def test_returns_same(self):
1712
obj1 = self.bus.get_object("busname", "objectpath")
1713
self.assertIsInstance(obj1, Unique)
1714
obj2 = self.bus.get_object("busname", "objectpath")
1715
self.assertIsInstance(obj2, Unique)
1716
self.assertIs(obj1, obj2)
1717
1718
def test_returns_same_old(self):
1719
obj1 = self.bus.get_object("busname1", "objectpath1")
1720
self.assertIsInstance(obj1, Unique)
1721
obj2 = self.bus.get_object("busname2", "objectpath2")
1722
self.assertIsInstance(obj2, Unique)
1723
obj1b = self.bus.get_object("busname1", "objectpath1")
1724
self.assertIsInstance(obj1b, Unique)
1725
self.assertIsNot(obj1, obj2)
1726
self.assertIsNot(obj2, obj1b)
1727
self.assertIs(obj1, obj1b)
1728
1729
1730
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1731
1732
def Stub_pydbus_func(self, func):
1733
class stub_pydbus:
1734
"""stub pydbus module"""
1735
class SystemBus:
1736
@staticmethod
1737
def get(busname, objectpath):
1738
DBusObject = collections.namedtuple(
1739
"DBusObject", ("methodname",))
1740
return {"interface":
1741
DBusObject(methodname=func)}
1742
return stub_pydbus
1743
1744
def call_method(self, bus, methodname, busname, objectpath,
1745
interface, *args):
1746
with self.assertLogs(log, logging.DEBUG):
1747
return bus.call_method(methodname, busname, objectpath,
1748
interface, *args)
1749
1750
def test_call_method_returns(self):
1751
expected_method_return = Unique()
1752
method_args = (Unique(), Unique())
1753
def func(*args):
1754
self.assertEqual(len(method_args), len(args))
1755
for marg, arg in zip(method_args, args):
1756
self.assertIs(marg, arg)
1757
return expected_method_return
1758
stub_pydbus = self.Stub_pydbus_func(func)
1759
bus = pydbus_adapter.SystemBus(stub_pydbus)
1760
ret = self.call_method(bus, "methodname", "busname",
1761
"objectpath", "interface",
1762
*method_args)
1763
self.assertIs(ret, expected_method_return)
1764
1765
def test_call_method_handles_exception(self):
1766
dbus_logger = logging.getLogger("dbus.proxies")
1767
1768
def func():
1769
raise gi.repository.GLib.Error()
1770
1771
stub_pydbus = self.Stub_pydbus_func(func)
1772
bus = pydbus_adapter.SystemBus(stub_pydbus)
1773
1774
with self.assertRaises(dbus.Error) as e:
1775
self.call_method(bus, "methodname", "busname",
1776
"objectpath", "interface")
1777
1778
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1779
1780
def test_get_converts_to_correct_exception(self):
1781
bus = pydbus_adapter.SystemBus(
1782
self.fake_pydbus_raises_exception_on_connect)
1783
with self.assertRaises(dbus.ConnectFailed):
1784
self.call_method(bus, "methodname", "busname",
1785
"objectpath", "interface")
1786
1787
class fake_pydbus_raises_exception_on_connect:
1788
"""fake dbus-python module"""
1789
@classmethod
1790
def SystemBus(cls):
1791
def get(busname, objectpath):
1792
raise gi.repository.GLib.Error()
1793
Bus = collections.namedtuple("Bus", ["get"])
1794
return Bus(get=get)
1795
1796
def test_set_property_uses_setattr(self):
1797
class Object:
1798
pass
1799
obj = Object()
1800
class pydbus_spy:
1801
class SystemBus:
1802
@staticmethod
1803
def get(busname, objectpath):
1804
return {"interface": obj}
1805
bus = pydbus_adapter.SystemBus(pydbus_spy)
1806
value = Unique()
1807
bus.set_property("busname", "objectpath", "interface", "key",
1808
value)
1809
self.assertIs(value, obj.key)
1810
1811
def test_get_suppresses_xml_deprecation_warning(self):
1812
if sys.version_info.major >= 3:
1813
return
1814
class stub_pydbus_get:
1815
class SystemBus:
1816
@staticmethod
1817
def get(busname, objectpath):
1818
warnings.warn_explicit(
1819
"deprecated", DeprecationWarning,
1820
"xml.etree.ElementTree", 0)
1821
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1822
with warnings.catch_warnings(record=True) as w:
1823
warnings.simplefilter("always")
1824
bus.get("busname", "objectpath")
1825
self.assertEqual(0, len(w))
1826
1827
1828
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1829
class stub_pydbus:
1830
"""stub pydbus module"""
1831
class SystemBus:
1832
@staticmethod
1833
def get(busname, objectpath):
1834
return Unique()
1835
1836
def setUp(self):
1837
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1838
1839
def test_returns_distinct_objectpaths(self):
1840
obj1 = self.bus.get("busname", "objectpath1")
1841
self.assertIsInstance(obj1, Unique)
1842
obj2 = self.bus.get("busname", "objectpath2")
1843
self.assertIsInstance(obj2, Unique)
1844
self.assertIsNot(obj1, obj2)
1845
1846
def test_returns_distinct_busnames(self):
1847
obj1 = self.bus.get("busname1", "objectpath")
1848
self.assertIsInstance(obj1, Unique)
1849
obj2 = self.bus.get("busname2", "objectpath")
1850
self.assertIsInstance(obj2, Unique)
1851
self.assertIsNot(obj1, obj2)
1852
1853
def test_returns_distinct_both(self):
1854
obj1 = self.bus.get("busname1", "objectpath")
1855
self.assertIsInstance(obj1, Unique)
1856
obj2 = self.bus.get("busname2", "objectpath")
1857
self.assertIsInstance(obj2, Unique)
1858
self.assertIsNot(obj1, obj2)
1859
1860
def test_returns_same(self):
1861
obj1 = self.bus.get("busname", "objectpath")
1862
self.assertIsInstance(obj1, Unique)
1863
obj2 = self.bus.get("busname", "objectpath")
1864
self.assertIsInstance(obj2, Unique)
1865
self.assertIs(obj1, obj2)
1866
1867
def test_returns_same_old(self):
1868
obj1 = self.bus.get("busname1", "objectpath1")
1869
self.assertIsInstance(obj1, Unique)
1870
obj2 = self.bus.get("busname2", "objectpath2")
1871
self.assertIsInstance(obj2, Unique)
1872
obj1b = self.bus.get("busname1", "objectpath1")
1873
self.assertIsInstance(obj1b, Unique)
1874
self.assertIsNot(obj1, obj2)
1875
self.assertIsNot(obj2, obj1b)
1876
self.assertIs(obj1, obj1b)
1877
1878
1879
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
1880
1881
class dummy_dbussy:
1882
class DBUS:
1883
class ObjectPath(str):
1884
pass
1885
class DBusError(Exception):
1886
pass
1887
1888
def fake_ravel_func(self, func):
1889
class fake_ravel:
1890
@staticmethod
1891
def system_bus():
1892
class DBusInterfaceProxy:
1893
@staticmethod
1894
def methodname(*args):
1895
return [func(*args)]
1896
class DBusObject:
1897
@staticmethod
1898
def get_interface(interface):
1899
if interface == "interface":
1900
return DBusInterfaceProxy()
1901
return {"busname": {"objectpath": DBusObject()}}
1902
return fake_ravel
1903
1904
def call_method(self, bus, methodname, busname, objectpath,
1905
interface, *args):
1906
with self.assertLogs(log, logging.DEBUG):
1907
return bus.call_method(methodname, busname, objectpath,
1908
interface, *args)
1909
1910
def test_call_method_returns(self):
1911
expected_method_return = Unique()
1912
method_args = (Unique(), Unique())
1913
def func(*args):
1914
self.assertEqual(len(method_args), len(args))
1915
for marg, arg in zip(method_args, args):
1916
self.assertIs(marg, arg)
1917
return expected_method_return
1918
fake_ravel = self.fake_ravel_func(func)
1919
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1920
ret = self.call_method(bus, "methodname", "busname",
1921
"objectpath", "interface",
1922
*method_args)
1923
self.assertIs(ret, expected_method_return)
1924
1925
def test_call_method_filters_objectpath(self):
1926
def func():
1927
return method_return
1928
fake_ravel = self.fake_ravel_func(func)
1929
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1930
method_return = (self.dummy_dbussy.DBUS
1931
.ObjectPath("objectpath"))
1932
ret = self.call_method(bus, "methodname", "busname",
1933
"objectpath", "interface")
1934
self.assertEqual("objectpath", ret)
1935
self.assertNotIsInstance(ret,
1936
self.dummy_dbussy.DBUS.ObjectPath)
1937
1938
def test_call_method_filters_objectpaths_in_dict(self):
1939
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1940
def func():
1941
return method_return
1942
fake_ravel = self.fake_ravel_func(func)
1943
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1944
method_return = {
1945
ObjectPath("objectpath_key_1"):
1946
ObjectPath("objectpath_value_1"),
1947
ObjectPath("objectpath_key_2"):
1948
ObjectPath("objectpath_value_2"),
1949
}
1950
ret = self.call_method(bus, "methodname", "busname",
1951
"objectpath", "interface")
1952
expected_method_return = {str(key): str(value)
1953
for key, value in
1954
method_return.items()}
1955
for key, value in ret.items():
1956
self.assertNotIsInstance(key, ObjectPath)
1957
self.assertNotIsInstance(value, ObjectPath)
1958
self.assertEqual(expected_method_return, ret)
1959
self.assertIsInstance(ret, dict)
1960
1961
def test_call_method_filters_objectpaths_in_dict_in_dict(self):
1962
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1963
def func():
1964
return method_return
1965
fake_ravel = self.fake_ravel_func(func)
1966
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1967
method_return = {
1968
ObjectPath("key1"): {
1969
ObjectPath("key11"): ObjectPath("value11"),
1970
ObjectPath("key12"): ObjectPath("value12"),
1971
},
1972
ObjectPath("key2"): {
1973
ObjectPath("key21"): ObjectPath("value21"),
1974
ObjectPath("key22"): ObjectPath("value22"),
1975
},
1976
}
1977
ret = self.call_method(bus, "methodname", "busname",
1978
"objectpath", "interface")
1979
expected_method_return = {
1980
"key1": {"key11": "value11",
1981
"key12": "value12"},
1982
"key2": {"key21": "value21",
1983
"key22": "value22"},
1984
}
1985
self.assertEqual(expected_method_return, ret)
1986
for key, value in ret.items():
1987
self.assertIsInstance(value, dict)
1988
self.assertEqual(expected_method_return[key], value)
1989
self.assertNotIsInstance(key, ObjectPath)
1990
for inner_key, inner_value in value.items():
1991
self.assertIsInstance(value, dict)
1992
self.assertEqual(
1993
expected_method_return[key][inner_key],
1994
inner_value)
1995
self.assertNotIsInstance(key, ObjectPath)
1996
1997
def test_call_method_filters_objectpaths_in_dict_three_deep(self):
1998
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1999
def func():
2000
return method_return
2001
fake_ravel = self.fake_ravel_func(func)
2002
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2003
method_return = {
2004
ObjectPath("key1"): {
2005
ObjectPath("key2"): {
2006
ObjectPath("key3"): ObjectPath("value"),
2007
},
2008
},
2009
}
2010
ret = self.call_method(bus, "methodname", "busname",
2011
"objectpath", "interface")
2012
expected_method_return = {"key1": {"key2": {"key3": "value"}}}
2013
self.assertEqual(expected_method_return, ret)
2014
self.assertIsInstance(ret, dict)
2015
self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
2016
self.assertIsInstance(ret["key1"], dict)
2017
self.assertNotIsInstance(next(iter(ret["key1"].keys())),
2018
ObjectPath)
2019
self.assertIsInstance(ret["key1"]["key2"], dict)
2020
self.assertNotIsInstance(
2021
next(iter(ret["key1"]["key2"].keys())),
2022
ObjectPath)
2023
self.assertEqual("value", ret["key1"]["key2"]["key3"])
2024
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
2025
self.dummy_dbussy.DBUS.ObjectPath)
2026
2027
def test_call_method_handles_exception(self):
2028
def func():
2029
raise self.dummy_dbussy.DBusError()
2030
2031
fake_ravel = self.fake_ravel_func(func)
2032
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2033
2034
with self.assertRaises(dbus.Error) as e:
2035
self.call_method(bus, "methodname", "busname",
2036
"objectpath", "interface")
2037
2038
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
2039
2040
def test_get_object_converts_to_correct_exception(self):
2041
class fake_ravel_raises_exception_on_connect:
2042
@staticmethod
2043
def system_bus():
2044
class Bus:
2045
@staticmethod
2046
def __getitem__(key):
2047
if key == "objectpath":
2048
raise self.dummy_dbussy.DBusError()
2049
raise Exception(key)
2050
return {"busname": Bus()}
2051
def func():
2052
raise self.dummy_dbussy.DBusError()
2053
bus = dbussy_adapter.SystemBus(
2054
self.dummy_dbussy,
2055
fake_ravel_raises_exception_on_connect)
2056
with self.assertRaises(dbus.ConnectFailed):
2057
self.call_method(bus, "methodname", "busname",
2058
"objectpath", "interface")
1151
# Test that the dbus_logger still works
1152
with self.assertLogs(dbus_logger, logging.ERROR):
1153
dbus_logger.error("Test")
1154
1155
if isinstance(e.exception.code, int):
1156
self.assertNotEqual(0, e.exception.code)
1157
else:
1158
self.assertIsNotNone(e.exception.code)
2059
1159
2060
1160
2061
1161
class Test_commands_from_options(unittest.TestCase):
2062
2063
1162
def setUp(self):
2064
1163
self.parser = argparse.ArgumentParser()
2065
1164
add_command_line_options(self.parser)
2066
1165
2067
1166
def test_is_enabled(self):
2068
self.assert_command_from_args(["--is-enabled", "client"],
1167
self.assert_command_from_args(["--is-enabled", "foo"],
2069
1168
command.IsEnabled)
2070
1169
2071
def assert_command_from_args(self, args, command_cls, length=1,
2072
clients=None, **cmd_attrs):
1170
def assert_command_from_args(self, args, command_cls,
1171
**cmd_attrs):
2073
1172
"""Assert that parsing ARGS should result in an instance of
2074
1173
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
2075
1174
options = self.parser.parse_args(args)
2076
1175
check_option_syntax(self.parser, options)
2077
1176
commands = commands_from_options(options)
2078
self.assertEqual(length, len(commands))
2079
for command in commands:
2080
if isinstance(command, command_cls):
2081
break
2082
else:
2083
self.assertIsInstance(command, command_cls)
2084
if clients is not None:
2085
self.assertEqual(clients, options.client)
1177
self.assertEqual(1, len(commands))
1178
command = commands[0]
1179
self.assertIsInstance(command, command_cls)
2086
1180
for key, value in cmd_attrs.items():
2087
1181
self.assertEqual(value, getattr(command, key))
2088
1182
2089
def assert_commands_from_args(self, args, commands, clients=None):
2090
for cmd in commands:
2091
self.assert_command_from_args(args, cmd,
2092
length=len(commands),
2093
clients=clients)
2094
2095
1183
def test_is_enabled_short(self):
2096
self.assert_command_from_args(["-V", "client"],
1184
self.assert_command_from_args(["-V", "foo"],
2097
1185
command.IsEnabled)
2098
1186
2099
1187
def test_approve(self):
2100
self.assert_command_from_args(["--approve", "client"],
1188
self.assert_command_from_args(["--approve", "foo"],
2101
1189
command.Approve)
2102
1190
2103
1191
def test_approve_short(self):
2104
self.assert_command_from_args(["-A", "client"],
2105
command.Approve)
1192
self.assert_command_from_args(["-A", "foo"], command.Approve)
2106
1193
2107
1194
def test_deny(self):
2108
self.assert_command_from_args(["--deny", "client"],
2109
command.Deny)
1195
self.assert_command_from_args(["--deny", "foo"], command.Deny)
2110
1196
2111
1197
def test_deny_short(self):
2112
self.assert_command_from_args(["-D", "client"], command.Deny)
1198
self.assert_command_from_args(["-D", "foo"], command.Deny)
2113
1199
2114
1200
def test_remove(self):
2115
self.assert_command_from_args(["--remove", "client"],
1201
self.assert_command_from_args(["--remove", "foo"],
2116
1202
command.Remove)
2117
1203
2118
1204
def test_deny_before_remove(self):
2119
1205
options = self.parser.parse_args(["--deny", "--remove",
2120
"client"])
1206
"foo"])
2121
1207
check_option_syntax(self.parser, options)
2122
1208
commands = commands_from_options(options)
2123
1209
self.assertEqual(2, len(commands))
2134
1220
self.assertIsInstance(commands[1], command.Remove)
2135
1221
2136
1222
def test_remove_short(self):
2137
self.assert_command_from_args(["-r", "client"],
2138
command.Remove)
1223
self.assert_command_from_args(["-r", "foo"], command.Remove)
2139
1224
2140
1225
def test_dump_json(self):
2141
1226
self.assert_command_from_args(["--dump-json"],
2142
1227
command.DumpJSON)
2143
1228
2144
1229
def test_enable(self):
2145
self.assert_command_from_args(["--enable", "client"],
1230
self.assert_command_from_args(["--enable", "foo"],
2146
1231
command.Enable)
2147
1232
2148
1233
def test_enable_short(self):
2149
self.assert_command_from_args(["-e", "client"],
2150
command.Enable)
1234
self.assert_command_from_args(["-e", "foo"], command.Enable)
2151
1235
2152
1236
def test_disable(self):
2153
self.assert_command_from_args(["--disable", "client"],
1237
self.assert_command_from_args(["--disable", "foo"],
2154
1238
command.Disable)
2155
1239
2156
1240
def test_disable_short(self):
2157
self.assert_command_from_args(["-d", "client"],
2158
command.Disable)
1241
self.assert_command_from_args(["-d", "foo"], command.Disable)
2159
1242
2160
1243
def test_bump_timeout(self):
2161
self.assert_command_from_args(["--bump-timeout", "client"],
1244
self.assert_command_from_args(["--bump-timeout", "foo"],
2162
1245
command.BumpTimeout)
2163
1246
2164
1247
def test_bump_timeout_short(self):
2165
self.assert_command_from_args(["-b", "client"],
1248
self.assert_command_from_args(["-b", "foo"],
2166
1249
command.BumpTimeout)
2167
1250
2168
1251
def test_start_checker(self):
2169
self.assert_command_from_args(["--start-checker", "client"],
1252
self.assert_command_from_args(["--start-checker", "foo"],
2170
1253
command.StartChecker)
2171
1254
2172
1255
def test_stop_checker(self):
2173
self.assert_command_from_args(["--stop-checker", "client"],
1256
self.assert_command_from_args(["--stop-checker", "foo"],
2174
1257
command.StopChecker)
2175
1258
2176
1259
def test_approve_by_default(self):
2177
self.assert_command_from_args(["--approve-by-default",
2178
"client"],
1260
self.assert_command_from_args(["--approve-by-default", "foo"],
2179
1261
command.ApproveByDefault)
2180
1262
2181
1263
def test_deny_by_default(self):
2182
self.assert_command_from_args(["--deny-by-default", "client"],
1264
self.assert_command_from_args(["--deny-by-default", "foo"],
2183
1265
command.DenyByDefault)
2184
1266
2185
1267
def test_checker(self):
2186
self.assert_command_from_args(["--checker", ":", "client"],
1268
self.assert_command_from_args(["--checker", ":", "foo"],
2187
1269
command.SetChecker,
2188
1270
value_to_set=":")
2189
1271
2190
1272
def test_checker_empty(self):
2191
self.assert_command_from_args(["--checker", "", "client"],
1273
self.assert_command_from_args(["--checker", "", "foo"],
2192
1274
command.SetChecker,
2193
1275
value_to_set="")
2194
1276
2195
1277
def test_checker_short(self):
2196
self.assert_command_from_args(["-c", ":", "client"],
1278
self.assert_command_from_args(["-c", ":", "foo"],
2197
1279
command.SetChecker,
2198
1280
value_to_set=":")
2199
1281
2200
1282
def test_host(self):
2201
self.assert_command_from_args(
2202
["--host", "client.example.org", "client"],
2203
command.SetHost, value_to_set="client.example.org")
1283
self.assert_command_from_args(["--host", "foo.example.org",
1284
"foo"], command.SetHost,
1285
value_to_set="foo.example.org")
2204
1286
2205
1287
def test_host_short(self):
2206
self.assert_command_from_args(
2207
["-H", "client.example.org", "client"], command.SetHost,
2208
value_to_set="client.example.org")
1288
self.assert_command_from_args(["-H", "foo.example.org",
1289
"foo"], command.SetHost,
1290
value_to_set="foo.example.org")
2209
1291
2210
1292
def test_secret_devnull(self):
2211
1293
self.assert_command_from_args(["--secret", os.path.devnull,
2212
"client"], command.SetSecret,
1294
"foo"], command.SetSecret,
2213
1295
value_to_set=b"")
2214
1296
2215
1297
def test_secret_tempfile(self):
2218
1300
f.write(value)
2219
1301
f.seek(0)
2220
1302
self.assert_command_from_args(["--secret", f.name,
2221
"client"],
2222
command.SetSecret,
1303
"foo"], command.SetSecret,
2223
1304
value_to_set=value)
2224
1305
2225
1306
def test_secret_devnull_short(self):
2226
self.assert_command_from_args(["-s", os.path.devnull,
2227
"client"], command.SetSecret,
1307
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1308
command.SetSecret,
2228
1309
value_to_set=b"")
2229
1310
2230
1311
def test_secret_tempfile_short(self):
2232
1313
value = b"secret\0xyzzy\nbar"
2233
1314
f.write(value)
2234
1315
f.seek(0)
2235
self.assert_command_from_args(["-s", f.name, "client"],
1316
self.assert_command_from_args(["-s", f.name, "foo"],
2236
1317
command.SetSecret,
2237
1318
value_to_set=value)
2238
1319
2239
1320
def test_timeout(self):
2240
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1321
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
2241
1322
command.SetTimeout,
2242
1323
value_to_set=300000)
2243
1324
2244
1325
def test_timeout_short(self):
2245
self.assert_command_from_args(["-t", "PT5M", "client"],
1326
self.assert_command_from_args(["-t", "PT5M", "foo"],
2246
1327
command.SetTimeout,
2247
1328
value_to_set=300000)
2248
1329
2249
1330
def test_extended_timeout(self):
2250
1331
self.assert_command_from_args(["--extended-timeout", "PT15M",
2251
"client"],
1332
"foo"],
2252
1333
command.SetExtendedTimeout,
2253
1334
value_to_set=900000)
2254
1335
2255
1336
def test_interval(self):
2256
self.assert_command_from_args(["--interval", "PT2M",
2257
"client"], command.SetInterval,
1337
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1338
command.SetInterval,
2258
1339
value_to_set=120000)
2259
1340
2260
1341
def test_interval_short(self):
2261
self.assert_command_from_args(["-i", "PT2M", "client"],
1342
self.assert_command_from_args(["-i", "PT2M", "foo"],
2262
1343
command.SetInterval,
2263
1344
value_to_set=120000)
2264
1345
2265
1346
def test_approval_delay(self):
2266
1347
self.assert_command_from_args(["--approval-delay", "PT30S",
2267
"client"],
1348
"foo"],
2268
1349
command.SetApprovalDelay,
2269
1350
value_to_set=30000)
2270
1351
2271
1352
def test_approval_duration(self):
2272
1353
self.assert_command_from_args(["--approval-duration", "PT1S",
2273
"client"],
1354
"foo"],
2274
1355
command.SetApprovalDuration,
2275
1356
value_to_set=1000)
2276
1357
2288
1369
verbose=True)
2289
1370
2290
1371
2291
def test_manual_page_example_1(self):
2292
self.assert_command_from_args("",
2293
command.PrintTable,
2294
clients=[],
2295
verbose=False)
2296
2297
def test_manual_page_example_2(self):
2298
self.assert_command_from_args(
2299
"--verbose foo1.example.org foo2.example.org".split(),
2300
command.PrintTable, clients=["foo1.example.org",
2301
"foo2.example.org"],
2302
verbose=True)
2303
2304
def test_manual_page_example_3(self):
2305
self.assert_command_from_args("--enable --all".split(),
2306
command.Enable,
2307
clients=[])
2308
2309
def test_manual_page_example_4(self):
2310
self.assert_commands_from_args(
2311
("--timeout=PT5M --interval=PT1M foo1.example.org"
2312
" foo2.example.org").split(),
2313
[command.SetTimeout, command.SetInterval],
2314
clients=["foo1.example.org", "foo2.example.org"])
2315
2316
def test_manual_page_example_5(self):
2317
self.assert_command_from_args("--approve --all".split(),
2318
command.Approve,
2319
clients=[])
2320
2321
2322
1372
class TestCommand(unittest.TestCase):
2323
1373
"""Abstract class for tests of command classes"""
2324
1374
2325
class FakeMandosBus(dbus.MandosBus):
2326
def __init__(self, testcase):
2327
self.client_properties = {
2328
"Name": "foo",
2329
"KeyID": ("92ed150794387c03ce684574b1139a65"
2330
"94a34f895daaaf09fd8ea90a27cddb12"),
2331
"Secret": b"secret",
2332
"Host": "foo.example.org",
2333
"Enabled": True,
2334
"Timeout": 300000,
2335
"LastCheckedOK": "2019-02-03T00:00:00",
2336
"Created": "2019-01-02T00:00:00",
2337
"Interval": 120000,
2338
"Fingerprint": ("778827225BA7DE539C5A"
2339
"7CFA59CFF7CDBD9A5920"),
2340
"CheckerRunning": False,
2341
"LastEnabled": "2019-01-03T00:00:00",
2342
"ApprovalPending": False,
2343
"ApprovedByDefault": True,
2344
"LastApprovalRequest": "",
2345
"ApprovalDelay": 0,
2346
"ApprovalDuration": 1000,
2347
"Checker": "fping -q -- %(host)s",
2348
"ExtendedTimeout": 900000,
2349
"Expires": "2019-02-04T00:00:00",
2350
"LastCheckerStatus": 0,
2351
}
2352
self.other_client_properties = {
2353
"Name": "barbar",
2354
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2355
"6ab612cff5ad227247e46c2b020f441c"),
2356
"Secret": b"secretbar",
2357
"Host": "192.0.2.3",
2358
"Enabled": True,
2359
"Timeout": 300000,
2360
"LastCheckedOK": "2019-02-04T00:00:00",
2361
"Created": "2019-01-03T00:00:00",
2362
"Interval": 120000,
2363
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2364
"F547B3A107558FCA3A27"),
2365
"CheckerRunning": True,
2366
"LastEnabled": "2019-01-04T00:00:00",
2367
"ApprovalPending": False,
2368
"ApprovedByDefault": False,
2369
"LastApprovalRequest": "2019-01-03T00:00:00",
2370
"ApprovalDelay": 30000,
2371
"ApprovalDuration": 93785000,
2372
"Checker": ":",
2373
"ExtendedTimeout": 900000,
2374
"Expires": "2019-02-05T00:00:00",
2375
"LastCheckerStatus": -2,
2376
}
2377
self.clients = collections.OrderedDict(
2378
[
2379
("client_objectpath", self.client_properties),
2380
("other_client_objectpath",
2381
self.other_client_properties),
2382
])
2383
self.one_client = {"client_objectpath":
2384
self.client_properties}
2385
self.testcase = testcase
2386
self.calls = []
2387
2388
def call_method(self, methodname, busname, objectpath,
2389
interface, *args):
2390
self.testcase.assertEqual("se.recompile.Mandos", busname)
2391
self.calls.append((methodname, busname, objectpath,
2392
interface, args))
2393
if interface == "org.freedesktop.DBus.Properties":
2394
if methodname == "Set":
2395
self.testcase.assertEqual(3, len(args))
2396
interface, key, value = args
2397
self.testcase.assertEqual(
2398
"se.recompile.Mandos.Client", interface)
2399
self.clients[objectpath][key] = value
2400
return
2401
elif interface == "se.recompile.Mandos":
2402
self.testcase.assertEqual("RemoveClient", methodname)
2403
self.testcase.assertEqual(1, len(args))
2404
clientpath = args[0]
2405
del self.clients[clientpath]
2406
return
2407
elif interface == "se.recompile.Mandos.Client":
2408
if methodname == "Approve":
2409
self.testcase.assertEqual(1, len(args))
2410
return
2411
raise ValueError()
2412
2413
1375
def setUp(self):
2414
self.bus = self.FakeMandosBus(self)
1376
testcase = self
1377
class MockClient(object):
1378
def __init__(self, name, **attributes):
1379
self.__dbus_object_path__ = "/clients/{}".format(name)
1380
self.attributes = attributes
1381
self.attributes["Name"] = name
1382
self.calls = []
1383
def Set(self, interface, propname, value, dbus_interface):
1384
testcase.assertEqual(client_dbus_interface, interface)
1385
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1386
dbus_interface)
1387
self.attributes[propname] = value
1388
def Approve(self, approve, dbus_interface):
1389
testcase.assertEqual(client_dbus_interface,
1390
dbus_interface)
1391
self.calls.append(("Approve", (approve,
1392
dbus_interface)))
1393
self.client = MockClient(
1394
"foo",
1395
KeyID=("92ed150794387c03ce684574b1139a65"
1396
"94a34f895daaaf09fd8ea90a27cddb12"),
1397
Secret=b"secret",
1398
Host="foo.example.org",
1399
Enabled=dbus.Boolean(True),
1400
Timeout=300000,
1401
LastCheckedOK="2019-02-03T00:00:00",
1402
Created="2019-01-02T00:00:00",
1403
Interval=120000,
1404
Fingerprint=("778827225BA7DE539C5A"
1405
"7CFA59CFF7CDBD9A5920"),
1406
CheckerRunning=dbus.Boolean(False),
1407
LastEnabled="2019-01-03T00:00:00",
1408
ApprovalPending=dbus.Boolean(False),
1409
ApprovedByDefault=dbus.Boolean(True),
1410
LastApprovalRequest="",
1411
ApprovalDelay=0,
1412
ApprovalDuration=1000,
1413
Checker="fping -q -- %(host)s",
1414
ExtendedTimeout=900000,
1415
Expires="2019-02-04T00:00:00",
1416
LastCheckerStatus=0)
1417
self.other_client = MockClient(
1418
"barbar",
1419
KeyID=("0558568eedd67d622f5c83b35a115f79"
1420
"6ab612cff5ad227247e46c2b020f441c"),
1421
Secret=b"secretbar",
1422
Host="192.0.2.3",
1423
Enabled=dbus.Boolean(True),
1424
Timeout=300000,
1425
LastCheckedOK="2019-02-04T00:00:00",
1426
Created="2019-01-03T00:00:00",
1427
Interval=120000,
1428
Fingerprint=("3E393AEAEFB84C7E89E2"
1429
"F547B3A107558FCA3A27"),
1430
CheckerRunning=dbus.Boolean(True),
1431
LastEnabled="2019-01-04T00:00:00",
1432
ApprovalPending=dbus.Boolean(False),
1433
ApprovedByDefault=dbus.Boolean(False),
1434
LastApprovalRequest="2019-01-03T00:00:00",
1435
ApprovalDelay=30000,
1436
ApprovalDuration=93785000,
1437
Checker=":",
1438
ExtendedTimeout=900000,
1439
Expires="2019-02-05T00:00:00",
1440
LastCheckerStatus=-2)
1441
self.clients = collections.OrderedDict(
1442
[
1443
("/clients/foo", self.client.attributes),
1444
("/clients/barbar", self.other_client.attributes),
1445
])
1446
self.one_client = {"/clients/foo": self.client.attributes}
1447
1448
@property
1449
def bus(self):
1450
class Bus(object):
1451
@staticmethod
1452
def get_object(client_bus_name, path):
1453
self.assertEqual(dbus_busname, client_bus_name)
1454
return {
1455
# Note: "self" here is the TestCmd instance, not
1456
# the Bus instance, since this is a static method!
1457
"/clients/foo": self.client,
1458
"/clients/barbar": self.other_client,
1459
}[path]
1460
return Bus()
2415
1461
2416
1462
2417
1463
class TestBaseCommands(TestCommand):
2418
1464
2419
1465
def test_IsEnabled_exits_successfully(self):
2420
1466
with self.assertRaises(SystemExit) as e:
2421
command.IsEnabled().run(self.bus.one_client)
1467
command.IsEnabled().run(self.one_client)
2422
1468
if e.exception.code is not None:
2423
1469
self.assertEqual(0, e.exception.code)
2424
1470
else:
2425
1471
self.assertIsNone(e.exception.code)
2426
1472
2427
1473
def test_IsEnabled_exits_with_failure(self):
2428
self.bus.client_properties["Enabled"] = False
1474
self.client.attributes["Enabled"] = dbus.Boolean(False)
2429
1475
with self.assertRaises(SystemExit) as e:
2430
command.IsEnabled().run(self.bus.one_client)
1476
command.IsEnabled().run(self.one_client)
2431
1477
if isinstance(e.exception.code, int):
2432
1478
self.assertNotEqual(0, e.exception.code)
2433
1479
else:
2434
1480
self.assertIsNotNone(e.exception.code)
2435
1481
2436
1482
def test_Approve(self):
2437
busname = "se.recompile.Mandos"
2438
client_interface = "se.recompile.Mandos.Client"
2439
command.Approve().run(self.bus.clients, self.bus)
2440
for clientpath in self.bus.clients:
2441
self.assertIn(("Approve", busname, clientpath,
2442
client_interface, (True,)), self.bus.calls)
1483
command.Approve().run(self.clients, self.bus)
1484
for clientpath in self.clients:
1485
client = self.bus.get_object(dbus_busname, clientpath)
1486
self.assertIn(("Approve", (True, client_dbus_interface)),
1487
client.calls)
2443
1488
2444
1489
def test_Deny(self):
2445
busname = "se.recompile.Mandos"
2446
client_interface = "se.recompile.Mandos.Client"
2447
command.Deny().run(self.bus.clients, self.bus)
2448
for clientpath in self.bus.clients:
2449
self.assertIn(("Approve", busname, clientpath,
2450
client_interface, (False,)),
2451
self.bus.calls)
1490
command.Deny().run(self.clients, self.bus)
1491
for clientpath in self.clients:
1492
client = self.bus.get_object(dbus_busname, clientpath)
1493
self.assertIn(("Approve", (False, client_dbus_interface)),
1494
client.calls)
2452
1495
2453
1496
def test_Remove(self):
2454
command.Remove().run(self.bus.clients, self.bus)
2455
for clientpath in self.bus.clients:
2456
self.assertIn(("RemoveClient", dbus_busname,
2457
dbus_server_path, dbus_server_interface,
2458
(clientpath,)), self.bus.calls)
1497
class MockMandos(object):
1498
def __init__(self):
1499
self.calls = []
1500
def RemoveClient(self, dbus_path):
1501
self.calls.append(("RemoveClient", (dbus_path,)))
1502
mandos = MockMandos()
1503
command.Remove().run(self.clients, self.bus, mandos)
1504
for clientpath in self.clients:
1505
self.assertIn(("RemoveClient", (clientpath,)),
1506
mandos.calls)
2459
1507
2460
1508
expected_json = {
2461
1509
"foo": {
2509
1557
}
2510
1558
2511
1559
def test_DumpJSON_normal(self):
2512
with self.capture_stdout_to_buffer() as buffer:
2513
command.DumpJSON().run(self.bus.clients)
2514
json_data = json.loads(buffer.getvalue())
1560
output = command.DumpJSON().output(self.clients.values())
1561
json_data = json.loads(output)
2515
1562
self.assertDictEqual(self.expected_json, json_data)
2516
1563
2517
@staticmethod
2518
@contextlib.contextmanager
2519
def capture_stdout_to_buffer():
2520
capture_buffer = io.StringIO()
2521
old_stdout = sys.stdout
2522
sys.stdout = capture_buffer
2523
try:
2524
yield capture_buffer
2525
finally:
2526
sys.stdout = old_stdout
2527
2528
1564
def test_DumpJSON_one_client(self):
2529
with self.capture_stdout_to_buffer() as buffer:
2530
command.DumpJSON().run(self.bus.one_client)
2531
json_data = json.loads(buffer.getvalue())
1565
output = command.DumpJSON().output(self.one_client.values())
1566
json_data = json.loads(output)
2532
1567
expected_json = {"foo": self.expected_json["foo"]}
2533
1568
self.assertDictEqual(expected_json, json_data)
2534
1569
2535
1570
def test_PrintTable_normal(self):
2536
with self.capture_stdout_to_buffer() as buffer:
2537
command.PrintTable().run(self.bus.clients)
1571
output = command.PrintTable().output(self.clients.values())
2538
1572
expected_output = "\n".join((
2539
1573
"Name Enabled Timeout Last Successful Check",
2540
1574
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2541
1575
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
2542
)) + "\n"
2543
self.assertEqual(expected_output, buffer.getvalue())
1576
))
1577
self.assertEqual(expected_output, output)
2544
1578
2545
1579
def test_PrintTable_verbose(self):
2546
with self.capture_stdout_to_buffer() as buffer:
2547
command.PrintTable(verbose=True).run(self.bus.clients)
1580
output = command.PrintTable(verbose=True).output(
1581
self.clients.values())
2548
1582
columns = (
2549
1583
(
2550
1584
"Name ",
2632
1666
)
2633
1667
)
2634
1668
num_lines = max(len(rows) for rows in columns)
2635
expected_output = ("\n".join("".join(rows[line]
2636
for rows in columns)
2637
for line in range(num_lines))
2638
+ "\n")
2639
self.assertEqual(expected_output, buffer.getvalue())
1669
expected_output = "\n".join("".join(rows[line]
1670
for rows in columns)
1671
for line in range(num_lines))
1672
self.assertEqual(expected_output, output)
2640
1673
2641
1674
def test_PrintTable_one_client(self):
2642
with self.capture_stdout_to_buffer() as buffer:
2643
command.PrintTable().run(self.bus.one_client)
1675
output = command.PrintTable().output(self.one_client.values())
2644
1676
expected_output = "\n".join((
2645
1677
"Name Enabled Timeout Last Successful Check",
2646
1678
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2647
)) + "\n"
2648
self.assertEqual(expected_output, buffer.getvalue())
2649
2650
2651
class TestPropertySetterCmd(TestCommand):
2652
"""Abstract class for tests of command.PropertySetter classes"""
2653
1679
))
1680
self.assertEqual(expected_output, output)
1681
1682
1683
class TestPropertyCmd(TestCommand):
1684
"""Abstract class for tests of command.Property classes"""
2654
1685
def runTest(self):
2655
1686
if not hasattr(self, "command"):
2656
return # Abstract TestCase class
2657
2658
if hasattr(self, "values_to_set"):
2659
cmd_args = [(value,) for value in self.values_to_set]
2660
values_to_get = getattr(self, "values_to_get",
2661
self.values_to_set)
2662
else:
2663
cmd_args = [() for x in range(len(self.values_to_get))]
2664
values_to_get = self.values_to_get
2665
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2666
for clientpath in self.bus.clients:
2667
self.bus.clients[clientpath][self.propname] = (
2668
Unique())
2669
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2670
for clientpath in self.bus.clients:
2671
value = (self.bus.clients[clientpath]
2672
[self.propname])
2673
self.assertNotIsInstance(value, Unique)
1687
return
1688
values_to_get = getattr(self, "values_to_get",
1689
self.values_to_set)
1690
for value_to_set, value_to_get in zip(self.values_to_set,
1691
values_to_get):
1692
for clientpath in self.clients:
1693
client = self.bus.get_object(dbus_busname, clientpath)
1694
old_value = client.attributes[self.propname]
1695
client.attributes[self.propname] = self.Unique()
1696
self.run_command(value_to_set, self.clients)
1697
for clientpath in self.clients:
1698
client = self.bus.get_object(dbus_busname, clientpath)
1699
value = client.attributes[self.propname]
1700
self.assertNotIsInstance(value, self.Unique)
2674
1701
self.assertEqual(value_to_get, value)
2675
1702
2676
2677
class TestEnableCmd(TestPropertySetterCmd):
1703
class Unique(object):
1704
"""Class for objects which exist only to be unique objects,
1705
since unittest.mock.sentinel only exists in Python 3.3"""
1706
1707
def run_command(self, value, clients):
1708
self.command().run(clients, self.bus)
1709
1710
1711
class TestEnableCmd(TestPropertyCmd):
2678
1712
command = command.Enable
2679
1713
propname = "Enabled"
2680
values_to_get = [True]
2681
2682
2683
class TestDisableCmd(TestPropertySetterCmd):
1714
values_to_set = [dbus.Boolean(True)]
1715
1716
1717
class TestDisableCmd(TestPropertyCmd):
2684
1718
command = command.Disable
2685
1719
propname = "Enabled"
2686
values_to_get = [False]
2687
2688
2689
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1720
values_to_set = [dbus.Boolean(False)]
1721
1722
1723
class TestBumpTimeoutCmd(TestPropertyCmd):
2690
1724
command = command.BumpTimeout
2691
1725
propname = "LastCheckedOK"
2692
values_to_get = [""]
2693
2694
2695
class TestStartCheckerCmd(TestPropertySetterCmd):
1726
values_to_set = [""]
1727
1728
1729
class TestStartCheckerCmd(TestPropertyCmd):
2696
1730
command = command.StartChecker
2697
1731
propname = "CheckerRunning"
2698
values_to_get = [True]
2699
2700
2701
class TestStopCheckerCmd(TestPropertySetterCmd):
1732
values_to_set = [dbus.Boolean(True)]
1733
1734
1735
class TestStopCheckerCmd(TestPropertyCmd):
2702
1736
command = command.StopChecker
2703
1737
propname = "CheckerRunning"
2704
values_to_get = [False]
2705
2706
2707
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1738
values_to_set = [dbus.Boolean(False)]
1739
1740
1741
class TestApproveByDefaultCmd(TestPropertyCmd):
2708
1742
command = command.ApproveByDefault
2709
1743
propname = "ApprovedByDefault"
2710
values_to_get = [True]
2711
2712
2713
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1744
values_to_set = [dbus.Boolean(True)]
1745
1746
1747
class TestDenyByDefaultCmd(TestPropertyCmd):
2714
1748
command = command.DenyByDefault
2715
1749
propname = "ApprovedByDefault"
2716
values_to_get = [False]
2717
2718
2719
class TestSetCheckerCmd(TestPropertySetterCmd):
1750
values_to_set = [dbus.Boolean(False)]
1751
1752
1753
class TestPropertyValueCmd(TestPropertyCmd):
1754
"""Abstract class for tests of PropertyValueCmd classes"""
1755
1756
def runTest(self):
1757
if type(self) is TestPropertyValueCmd:
1758
return
1759
return super(TestPropertyValueCmd, self).runTest()
1760
1761
def run_command(self, value, clients):
1762
self.command(value).run(clients, self.bus)
1763
1764
1765
class TestSetCheckerCmd(TestPropertyValueCmd):
2720
1766
command = command.SetChecker
2721
1767
propname = "Checker"
2722
1768
values_to_set = ["", ":", "fping -q -- %s"]
2723
1769
2724
1770
2725
class TestSetHostCmd(TestPropertySetterCmd):
1771
class TestSetHostCmd(TestPropertyValueCmd):
2726
1772
command = command.SetHost
2727
1773
propname = "Host"
2728
values_to_set = ["192.0.2.3", "client.example.org"]
2729
2730
2731
class TestSetSecretCmd(TestPropertySetterCmd):
1774
values_to_set = ["192.0.2.3", "foo.example.org"]
1775
1776
1777
class TestSetSecretCmd(TestPropertyValueCmd):
2732
1778
command = command.SetSecret
2733
1779
propname = "Secret"
2734
1780
values_to_set = [io.BytesIO(b""),
2735
1781
io.BytesIO(b"secret\0xyzzy\nbar")]
2736
values_to_get = [f.getvalue() for f in values_to_set]
2737
2738
2739
class TestSetTimeoutCmd(TestPropertySetterCmd):
1782
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1783
1784
1785
class TestSetTimeoutCmd(TestPropertyValueCmd):
2740
1786
command = command.SetTimeout
2741
1787
propname = "Timeout"
2742
1788
values_to_set = [datetime.timedelta(),
2744
1790
datetime.timedelta(seconds=1),
2745
1791
datetime.timedelta(weeks=1),
2746
1792
datetime.timedelta(weeks=52)]
2747
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2748
2749
2750
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1793
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1794
1795
1796
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2751
1797
command = command.SetExtendedTimeout
2752
1798
propname = "ExtendedTimeout"
2753
1799
values_to_set = [datetime.timedelta(),
2755
1801
datetime.timedelta(seconds=1),
2756
1802
datetime.timedelta(weeks=1),
2757
1803
datetime.timedelta(weeks=52)]
2758
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2759
2760
2761
class TestSetIntervalCmd(TestPropertySetterCmd):
1804
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1805
1806
1807
class TestSetIntervalCmd(TestPropertyValueCmd):
2762
1808
command = command.SetInterval
2763
1809
propname = "Interval"
2764
1810
values_to_set = [datetime.timedelta(),
2766
1812
datetime.timedelta(seconds=1),
2767
1813
datetime.timedelta(weeks=1),
2768
1814
datetime.timedelta(weeks=52)]
2769
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2770
2771
2772
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1815
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1816
1817
1818
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2773
1819
command = command.SetApprovalDelay
2774
1820
propname = "ApprovalDelay"
2775
1821
values_to_set = [datetime.timedelta(),
2777
1823
datetime.timedelta(seconds=1),
2778
1824
datetime.timedelta(weeks=1),
2779
1825
datetime.timedelta(weeks=52)]
2780
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2781
2782
2783
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1826
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1827
1828
1829
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2784
1830
command = command.SetApprovalDuration
2785
1831
propname = "ApprovalDuration"
2786
1832
values_to_set = [datetime.timedelta(),
2788
1834
datetime.timedelta(seconds=1),
2789
1835
datetime.timedelta(weeks=1),
2790
1836
datetime.timedelta(weeks=52)]
2791
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1837
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2792
1838
2793
1839
2794
1840
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0