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 1084
- compare with another revision
- download diff
- download tarball
- view history from revision 1084
- Committer: Teddy Hogeborn
- Date: 2019-03-17 18:44:44 UTC
- Revision ID: teddy@recompile.se-20190317184444-5o7vougp7c3p87ri
mandos-ctl: Refactor tests
* mandos-ctl (TestBaseCommands.test_DumpJSON_normal): Don't run the
.output method on command; instead, use capture_stdout_to_buffer().
(TestBaseCommands.test_DumpJSON_one_client): - '' -
(TestBaseCommands.test_PrintTable_normal): - '' -
(TestBaseCommands.test_PrintTable_verbose): - '' -
(TestBaseCommands.test_PrintTable_one_client): - '' -
(TestBaseCommands.capture_stdout_to_buffer): New.
* mandos-ctl (TestBaseCommands.test_DumpJSON_normal): Don't run the
.output method on command; instead, use capture_stdout_to_buffer().
(TestBaseCommands.test_DumpJSON_one_client): - '' -
(TestBaseCommands.test_PrintTable_normal): - '' -
(TestBaseCommands.test_PrintTable_verbose): - '' -
(TestBaseCommands.test_PrintTable_one_client): - '' -
(TestBaseCommands.capture_stdout_to_buffer): New.
- 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 -*-
3
#
4
# Mandos Control - Control or query the Mandos server
5
#
6
# Copyright © 2008-2020 Teddy Hogeborn
7
# Copyright © 2008-2020 Björn Påhlsson
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
#
4
# Mandos Monitor - Control and monitor the Mandos server
5
#
6
# Copyright © 2008-2019 Teddy Hogeborn
7
# Copyright © 2008-2019 Björn Påhlsson
8
8
#
9
9
# This file is part of Mandos.
10
10
#
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.14"
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
# list of one element with the return 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
# A D-Bus Variant value is represented as the Python type
742
# Tuple[dbussy.DBUS.Signature, Any]
743
if isinstance(value, tuple):
744
if (len(value) == 2
745
and isinstance(value[0],
746
self.dbussy.DBUS.Signature)):
747
return self.type_filter(value[1])
748
elif isinstance(value, self.dbussy.DBUS.ObjectPath):
749
return str(value)
750
# Also recurse into dictionaries
751
elif isinstance(value, dict):
752
return {self.type_filter(key):
753
self.type_filter(subval)
754
for key, subval in value.items()}
755
return value
756
757
def set_property(self, busname, objectpath, interface, key,
758
value):
759
proxy_object = self.get_object(busname, objectpath)
760
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
761
objectpath, self.properties_iface, interface,
762
key, value)
763
if key == "Secret":
764
# DBussy wants a Byte Array to be a sequence of
765
# values, not a byte string
766
value = tuple(value)
767
setattr(proxy_object.get_interface(interface), key, value)
768
769
class MandosBus(SystemBus, dbus.MandosBus):
770
pass
771
772
class CachingBus(MandosBus):
773
"""A caching layer for dbussy_adapter.MandosBus"""
774
def __init__(self, *args, **kwargs):
775
self.object_cache = {}
776
super(dbussy_adapter.CachingBus, self).__init__(*args,
777
**kwargs)
778
def get_object(self, busname, objectpath):
779
try:
780
return self.object_cache[(busname, objectpath)]
781
except KeyError:
782
new_object = super(
783
dbussy_adapter.CachingBus,
784
self).get_object(busname, objectpath)
785
self.object_cache[(busname, objectpath)] = new_object
786
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)
787
473
788
474
789
475
def commands_from_options(options):
790
476
791
commands = list(options.commands)
792
793
def find_cmd(cmd, commands):
794
i = 0
795
for i, c in enumerate(commands):
796
if isinstance(c, cmd):
797
return i
798
return i+1
799
800
# If command.Remove is present, move any instances of command.Deny
801
# to occur ahead of command.Remove.
802
index_of_remove = find_cmd(command.Remove, commands)
803
before_remove = commands[:index_of_remove]
804
after_remove = commands[index_of_remove:]
805
cleaned_after = []
806
for cmd in after_remove:
807
if isinstance(cmd, command.Deny):
808
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())
809
512
else:
810
cleaned_after.append(cmd)
811
if cleaned_after != after_remove:
812
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))
813
541
814
542
# If no command option has been given, show table of clients,
815
543
# optionally verbosely
819
547
return commands
820
548
821
549
822
class command:
550
class command(object):
823
551
"""A namespace for command classes"""
824
552
825
class Base:
553
class Base(object):
826
554
"""Abstract base class for commands"""
827
def run(self, clients, bus=None):
555
def run(self, clients, bus=None, mandos=None):
828
556
"""Normal commands should implement run_on_one_client(),
829
557
but commands which want to operate on all clients at the same time can
830
558
override this run() method instead.
831
559
"""
832
self.bus = bus
833
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)
834
565
self.run_on_one_client(client, properties)
835
566
836
567
837
568
class IsEnabled(Base):
838
def run(self, clients, bus=None):
839
properties = next(iter(clients.values()))
840
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):
841
572
sys.exit(0)
842
573
sys.exit(1)
574
def is_enabled(self, client, properties):
575
return properties["Enabled"]
843
576
844
577
845
578
class Approve(Base):
846
579
def run_on_one_client(self, client, properties):
847
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)
848
585
849
586
850
587
class Deny(Base):
851
588
def run_on_one_client(self, client, properties):
852
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)
853
594
854
595
855
596
class Remove(Base):
856
def run(self, clients, bus):
857
for clientpath in frozenset(clients.keys()):
858
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__)
859
603
860
604
861
605
class Output(Base):
869
613
"Checker", "ExtendedTimeout", "Expires",
870
614
"LastCheckerStatus")
871
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
872
622
873
623
class DumpJSON(Output):
874
def run(self, clients, bus=None):
875
data = {properties["Name"]:
876
{key: properties[key]
624
def output(self, clients):
625
data = {client["Name"]:
626
{key: self.dbus_boolean_to_bool(client[key])
877
627
for key in self.all_keywords}
878
for properties in clients.values()}
879
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
880
636
881
637
882
638
class PrintTable(Output):
883
639
def __init__(self, verbose=False):
884
640
self.verbose = verbose
885
641
886
def run(self, clients, bus=None):
642
def output(self, clients):
887
643
default_keywords = ("Name", "Enabled", "Timeout",
888
644
"LastCheckedOK")
889
645
keywords = default_keywords
890
646
if self.verbose:
891
647
keywords = self.all_keywords
892
print(self.TableOfClients(clients.values(), keywords))
648
return str(self.TableOfClients(clients, keywords))
893
649
894
class TableOfClients:
650
class TableOfClients(object):
895
651
tableheaders = {
896
652
"Name": "Name",
897
653
"Enabled": "Enabled",
950
706
951
707
@classmethod
952
708
def valuetostring(cls, value, keyword):
953
if isinstance(value, bool):
709
if isinstance(value, dbus.Boolean):
954
710
return "Yes" if value else "No"
955
711
if keyword in ("Timeout", "Interval", "ApprovalDelay",
956
712
"ApprovalDuration", "ExtendedTimeout"):
976
732
seconds=td.seconds % 60))
977
733
978
734
979
class PropertySetter(Base):
735
class Property(Base):
980
736
"Abstract class for Actions for setting one client property"
981
737
982
def run_on_one_client(self, client, properties=None):
738
def run_on_one_client(self, client, properties):
983
739
"""Set the Client's D-Bus property"""
984
self.bus.set_client_property(client, self.propname,
985
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)
986
750
987
751
@property
988
752
def propname(self):
989
753
raise NotImplementedError()
990
754
991
755
992
class Enable(PropertySetter):
993
propname = "Enabled"
994
value_to_set = True
995
996
997
class Disable(PropertySetter):
998
propname = "Enabled"
999
value_to_set = False
1000
1001
1002
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):
1003
767
propname = "LastCheckedOK"
1004
768
value_to_set = ""
1005
769
1006
770
1007
class StartChecker(PropertySetter):
1008
propname = "CheckerRunning"
1009
value_to_set = True
1010
1011
1012
class StopChecker(PropertySetter):
1013
propname = "CheckerRunning"
1014
value_to_set = False
1015
1016
1017
class ApproveByDefault(PropertySetter):
1018
propname = "ApprovedByDefault"
1019
value_to_set = True
1020
1021
1022
class DenyByDefault(PropertySetter):
1023
propname = "ApprovedByDefault"
1024
value_to_set = False
1025
1026
1027
class PropertySetterValue(PropertySetter):
1028
"""Abstract class for PropertySetter recieving a value as
1029
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"
1030
793
def __init__(self, value):
1031
794
self.value_to_set = value
1032
795
1033
@classmethod
1034
def argparse(cls, argtype):
1035
def cmdtype(arg):
1036
return cls(argtype(arg))
1037
return cmdtype
1038
796
1039
class SetChecker(PropertySetterValue):
797
class SetChecker(PropertyValue):
1040
798
propname = "Checker"
1041
799
1042
800
1043
class SetHost(PropertySetterValue):
801
class SetHost(PropertyValue):
1044
802
propname = "Host"
1045
803
1046
804
1047
class SetSecret(PropertySetterValue):
805
class SetSecret(PropertyValue):
1048
806
propname = "Secret"
1049
807
1050
808
@property
1058
816
value.close()
1059
817
1060
818
1061
class PropertySetterValueMilliseconds(PropertySetterValue):
1062
"""Abstract class for PropertySetterValue taking a value
1063
argument as a datetime.timedelta() but should store it as
1064
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."""
1065
822
1066
823
@property
1067
824
def value_to_set(self):
1073
830
self._vts = int(round(value.total_seconds() * 1000))
1074
831
1075
832
1076
class SetTimeout(PropertySetterValueMilliseconds):
833
class SetTimeout(MillisecondsPropertyValueArgument):
1077
834
propname = "Timeout"
1078
835
1079
836
1080
class SetExtendedTimeout(PropertySetterValueMilliseconds):
837
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
1081
838
propname = "ExtendedTimeout"
1082
839
1083
840
1084
class SetInterval(PropertySetterValueMilliseconds):
841
class SetInterval(MillisecondsPropertyValueArgument):
1085
842
propname = "Interval"
1086
843
1087
844
1088
class SetApprovalDelay(PropertySetterValueMilliseconds):
845
class SetApprovalDelay(MillisecondsPropertyValueArgument):
1089
846
propname = "ApprovalDelay"
1090
847
1091
848
1092
class SetApprovalDuration(PropertySetterValueMilliseconds):
849
class SetApprovalDuration(MillisecondsPropertyValueArgument):
1093
850
propname = "ApprovalDuration"
1094
851
1095
852
1128
885
"output"))
1129
886
1130
887
1131
class Unique:
1132
"""Class for objects which exist only to be unique objects, since
1133
unittest.mock.sentinel only exists in Python 3.3"""
1134
1135
1136
888
class Test_string_to_delta(TestCaseWithAssertLogs):
1137
889
# Just test basic RFC 3339 functionality here, the doc string for
1138
890
# rfc3339_duration_to_delta() already has more comprehensive
1139
# tests, which are run by doctest.
891
# tests, which is run by doctest.
1140
892
1141
893
def test_rfc3339_zero_seconds(self):
1142
894
self.assertEqual(datetime.timedelta(),
1166
918
1167
919
def test_actions_requires_client_or_all(self):
1168
920
for action, value in self.actions.items():
1169
args = self.actionargs(action, value)
921
options = self.parser.parse_args()
922
setattr(options, action, value)
1170
923
with self.assertParseError():
1171
self.parse_args(args)
924
self.check_option_syntax(options)
1172
925
1173
# This mostly corresponds to the definition from has_commands() in
926
# This mostly corresponds to the definition from has_actions() in
1174
927
# check_option_syntax()
1175
928
actions = {
1176
"--enable": None,
1177
"--disable": None,
1178
"--bump-timeout": None,
1179
"--start-checker": None,
1180
"--stop-checker": None,
1181
"--is-enabled": None,
1182
"--remove": None,
1183
"--checker": "x",
1184
"--timeout": "PT0S",
1185
"--extended-timeout": "PT0S",
1186
"--interval": "PT0S",
1187
"--approve-by-default": None,
1188
"--deny-by-default": None,
1189
"--approval-delay": "PT0S",
1190
"--approval-duration": "PT0S",
1191
"--host": "hostname",
1192
"--secret": "/dev/null",
1193
"--approve": None,
1194
"--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,
1195
950
}
1196
951
1197
@staticmethod
1198
def actionargs(action, value, *args):
1199
if value is not None:
1200
return [action, value] + list(args)
1201
else:
1202
return [action] + list(args)
1203
1204
952
@contextlib.contextmanager
1205
953
def assertParseError(self):
1206
954
with self.assertRaises(SystemExit) as e:
1211
959
# /argparse.html#exiting-methods
1212
960
self.assertEqual(2, e.exception.code)
1213
961
1214
def parse_args(self, args):
1215
options = self.parser.parse_args(args)
1216
check_option_syntax(self.parser, options)
1217
1218
962
@staticmethod
1219
963
@contextlib.contextmanager
1220
964
def redirect_stderr_to_devnull():
1231
975
1232
976
def test_actions_all_conflicts_with_verbose(self):
1233
977
for action, value in self.actions.items():
1234
args = self.actionargs(action, value, "--all",
1235
"--verbose")
978
options = self.parser.parse_args()
979
setattr(options, action, value)
980
options.all = True
981
options.verbose = True
1236
982
with self.assertParseError():
1237
self.parse_args(args)
983
self.check_option_syntax(options)
1238
984
1239
985
def test_actions_with_client_conflicts_with_verbose(self):
1240
986
for action, value in self.actions.items():
1241
args = self.actionargs(action, value, "--verbose",
1242
"client")
987
options = self.parser.parse_args()
988
setattr(options, action, value)
989
options.verbose = True
990
options.client = ["foo"]
1243
991
with self.assertParseError():
1244
self.parse_args(args)
992
self.check_option_syntax(options)
1245
993
1246
994
def test_dump_json_conflicts_with_verbose(self):
1247
args = ["--dump-json", "--verbose"]
995
options = self.parser.parse_args()
996
options.dump_json = True
997
options.verbose = True
1248
998
with self.assertParseError():
1249
self.parse_args(args)
999
self.check_option_syntax(options)
1250
1000
1251
1001
def test_dump_json_conflicts_with_action(self):
1252
1002
for action, value in self.actions.items():
1253
args = self.actionargs(action, value, "--dump-json")
1003
options = self.parser.parse_args()
1004
setattr(options, action, value)
1005
options.dump_json = True
1254
1006
with self.assertParseError():
1255
self.parse_args(args)
1007
self.check_option_syntax(options)
1256
1008
1257
1009
def test_all_can_not_be_alone(self):
1258
args = ["--all"]
1010
options = self.parser.parse_args()
1011
options.all = True
1259
1012
with self.assertParseError():
1260
self.parse_args(args)
1013
self.check_option_syntax(options)
1261
1014
1262
1015
def test_all_is_ok_with_any_action(self):
1263
1016
for action, value in self.actions.items():
1264
args = self.actionargs(action, value, "--all")
1265
self.parse_args(args)
1017
options = self.parser.parse_args()
1018
setattr(options, action, value)
1019
options.all = True
1020
self.check_option_syntax(options)
1266
1021
1267
1022
def test_any_action_is_ok_with_one_client(self):
1268
1023
for action, value in self.actions.items():
1269
args = self.actionargs(action, value, "client")
1270
self.parse_args(args)
1024
options = self.parser.parse_args()
1025
setattr(options, action, value)
1026
options.client = ["foo"]
1027
self.check_option_syntax(options)
1271
1028
1272
1029
def test_one_client_with_all_actions_except_is_enabled(self):
1030
options = self.parser.parse_args()
1273
1031
for action, value in self.actions.items():
1274
if action == "--is-enabled":
1032
if action == "is_enabled":
1275
1033
continue
1276
args = self.actionargs(action, value, "client")
1277
self.parse_args(args)
1034
setattr(options, action, value)
1035
options.client = ["foo"]
1036
self.check_option_syntax(options)
1278
1037
1279
1038
def test_two_clients_with_all_actions_except_is_enabled(self):
1039
options = self.parser.parse_args()
1280
1040
for action, value in self.actions.items():
1281
if action == "--is-enabled":
1041
if action == "is_enabled":
1282
1042
continue
1283
args = self.actionargs(action, value, "client1",
1284
"client2")
1285
self.parse_args(args)
1043
setattr(options, action, value)
1044
options.client = ["foo", "barbar"]
1045
self.check_option_syntax(options)
1286
1046
1287
1047
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1288
1048
for action, value in self.actions.items():
1289
if action == "--is-enabled":
1049
if action == "is_enabled":
1290
1050
continue
1291
args = self.actionargs(action, value, "client1",
1292
"client2")
1293
self.parse_args(args)
1051
options = self.parser.parse_args()
1052
setattr(options, action, value)
1053
options.client = ["foo", "barbar"]
1054
self.check_option_syntax(options)
1294
1055
1295
1056
def test_is_enabled_fails_without_client(self):
1296
args = ["--is-enabled"]
1057
options = self.parser.parse_args()
1058
options.is_enabled = True
1297
1059
with self.assertParseError():
1298
self.parse_args(args)
1060
self.check_option_syntax(options)
1299
1061
1300
1062
def test_is_enabled_fails_with_two_clients(self):
1301
args = ["--is-enabled", "client1", "client2"]
1063
options = self.parser.parse_args()
1064
options.is_enabled = True
1065
options.client = ["foo", "barbar"]
1302
1066
with self.assertParseError():
1303
self.parse_args(args)
1067
self.check_option_syntax(options)
1304
1068
1305
1069
def test_remove_can_only_be_combined_with_action_deny(self):
1306
1070
for action, value in self.actions.items():
1307
if action in {"--remove", "--deny"}:
1071
if action in {"remove", "deny"}:
1308
1072
continue
1309
args = self.actionargs(action, value, "--all",
1310
"--remove")
1073
options = self.parser.parse_args()
1074
setattr(options, action, value)
1075
options.all = True
1076
options.remove = True
1311
1077
with self.assertParseError():
1312
self.parse_args(args)
1313
1314
1315
class Test_dbus_exceptions(unittest.TestCase):
1316
1317
def test_dbus_ConnectFailed_is_Error(self):
1318
with self.assertRaises(dbus.Error):
1319
raise dbus.ConnectFailed()
1320
1321
1322
class Test_dbus_MandosBus(unittest.TestCase):
1323
1324
class MockMandosBus(dbus.MandosBus):
1325
def __init__(self):
1326
self._name = "se.recompile.Mandos"
1327
self._server_path = "/"
1328
self._server_interface = "se.recompile.Mandos"
1329
self._client_interface = "se.recompile.Mandos.Client"
1330
self.calls = []
1331
self.call_method_return = Unique()
1332
1333
def call_method(self, methodname, busname, objectpath,
1334
interface, *args):
1335
self.calls.append((methodname, busname, objectpath,
1336
interface, args))
1337
return self.call_method_return
1338
1339
def setUp(self):
1340
self.bus = self.MockMandosBus()
1341
1342
def test_set_client_property(self):
1343
self.bus.set_client_property("objectpath", "key", "value")
1344
expected_call = ("Set", self.bus._name, "objectpath",
1345
"org.freedesktop.DBus.Properties",
1346
(self.bus._client_interface, "key", "value"))
1347
self.assertIn(expected_call, self.bus.calls)
1348
1349
def test_call_client_method(self):
1350
ret = self.bus.call_client_method("objectpath", "methodname")
1351
self.assertIs(self.bus.call_method_return, ret)
1352
expected_call = ("methodname", self.bus._name, "objectpath",
1353
self.bus._client_interface, ())
1354
self.assertIn(expected_call, self.bus.calls)
1355
1356
def test_call_client_method_with_args(self):
1357
args = (Unique(), Unique())
1358
ret = self.bus.call_client_method("objectpath", "methodname",
1359
*args)
1360
self.assertIs(self.bus.call_method_return, ret)
1361
expected_call = ("methodname", self.bus._name, "objectpath",
1362
self.bus._client_interface,
1363
(args[0], args[1]))
1364
self.assertIn(expected_call, self.bus.calls)
1365
1366
def test_get_clients_and_properties(self):
1367
managed_objects = {
1368
"objectpath": {
1369
self.bus._client_interface: {
1370
"key": "value",
1371
"bool": True,
1372
},
1373
"irrelevant_interface": {
1374
"key": "othervalue",
1375
"bool": False,
1376
},
1377
},
1378
"other_objectpath": {
1379
"other_irrelevant_interface": {
1380
"key": "value 3",
1381
"bool": None,
1382
},
1383
},
1384
}
1385
expected_clients_and_properties = {
1386
"objectpath": {
1387
"key": "value",
1388
"bool": True,
1389
}
1390
}
1391
self.bus.call_method_return = managed_objects
1392
ret = self.bus.get_clients_and_properties()
1393
self.assertDictEqual(expected_clients_and_properties, ret)
1394
expected_call = ("GetManagedObjects", self.bus._name,
1395
self.bus._server_path,
1396
"org.freedesktop.DBus.ObjectManager", ())
1397
self.assertIn(expected_call, self.bus.calls)
1398
1399
def test_call_server_method(self):
1400
ret = self.bus.call_server_method("methodname")
1401
self.assertIs(self.bus.call_method_return, ret)
1402
expected_call = ("methodname", self.bus._name,
1403
self.bus._server_path,
1404
self.bus._server_interface, ())
1405
self.assertIn(expected_call, self.bus.calls)
1406
1407
def test_call_server_method_with_args(self):
1408
args = (Unique(), Unique())
1409
ret = self.bus.call_server_method("methodname", *args)
1410
self.assertIs(self.bus.call_method_return, ret)
1411
expected_call = ("methodname", self.bus._name,
1412
self.bus._server_path,
1413
self.bus._server_interface,
1414
(args[0], args[1]))
1415
self.assertIn(expected_call, self.bus.calls)
1416
1417
1418
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1419
1420
def MockDBusPython_func(self, func):
1421
class mock_dbus_python:
1422
"""mock dbus-python module"""
1423
class exceptions:
1424
"""Pseudo-namespace"""
1425
class DBusException(Exception):
1426
pass
1427
class SystemBus:
1428
@staticmethod
1429
def get_object(busname, objectpath):
1430
DBusObject = collections.namedtuple(
1431
"DBusObject", ("methodname", "Set"))
1432
def method(*args, **kwargs):
1433
self.assertEqual({"dbus_interface":
1434
"interface"},
1435
kwargs)
1436
return func(*args)
1437
def set_property(interface, key, value,
1438
dbus_interface=None):
1439
self.assertEqual(
1440
"org.freedesktop.DBus.Properties",
1441
dbus_interface)
1442
self.assertEqual("Secret", key)
1443
return func(interface, key, value,
1444
dbus_interface=dbus_interface)
1445
return DBusObject(methodname=method,
1446
Set=set_property)
1447
class Boolean:
1448
def __init__(self, value):
1449
self.value = bool(value)
1450
def __bool__(self):
1451
return self.value
1452
if sys.version_info.major == 2:
1453
__nonzero__ = __bool__
1454
class ObjectPath(str):
1455
pass
1456
class Dictionary(dict):
1457
pass
1458
class ByteArray(bytes):
1459
pass
1460
return mock_dbus_python
1461
1462
def call_method(self, bus, methodname, busname, objectpath,
1463
interface, *args):
1464
with self.assertLogs(log, logging.DEBUG):
1465
return bus.call_method(methodname, busname, objectpath,
1466
interface, *args)
1467
1468
def test_call_method_returns(self):
1469
expected_method_return = Unique()
1470
method_args = (Unique(), Unique())
1471
def func(*args):
1472
self.assertEqual(len(method_args), len(args))
1473
for marg, arg in zip(method_args, args):
1474
self.assertIs(marg, arg)
1475
return expected_method_return
1476
mock_dbus_python = self.MockDBusPython_func(func)
1477
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1478
ret = self.call_method(bus, "methodname", "busname",
1479
"objectpath", "interface",
1480
*method_args)
1481
self.assertIs(ret, expected_method_return)
1482
1483
def test_call_method_filters_bool_true(self):
1484
def func():
1485
return method_return
1486
mock_dbus_python = self.MockDBusPython_func(func)
1487
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1488
method_return = mock_dbus_python.Boolean(True)
1489
ret = self.call_method(bus, "methodname", "busname",
1490
"objectpath", "interface")
1491
self.assertTrue(ret)
1492
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1493
1494
def test_call_method_filters_bool_false(self):
1495
def func():
1496
return method_return
1497
mock_dbus_python = self.MockDBusPython_func(func)
1498
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1499
method_return = mock_dbus_python.Boolean(False)
1500
ret = self.call_method(bus, "methodname", "busname",
1501
"objectpath", "interface")
1502
self.assertFalse(ret)
1503
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1504
1505
def test_call_method_filters_objectpath(self):
1506
def func():
1507
return method_return
1508
mock_dbus_python = self.MockDBusPython_func(func)
1509
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1510
method_return = mock_dbus_python.ObjectPath("objectpath")
1511
ret = self.call_method(bus, "methodname", "busname",
1512
"objectpath", "interface")
1513
self.assertEqual("objectpath", ret)
1514
self.assertIsNot("objectpath", ret)
1515
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1516
1517
def test_call_method_filters_booleans_in_dict(self):
1518
def func():
1519
return method_return
1520
mock_dbus_python = self.MockDBusPython_func(func)
1521
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1522
method_return = mock_dbus_python.Dictionary(
1523
{mock_dbus_python.Boolean(True):
1524
mock_dbus_python.Boolean(False),
1525
mock_dbus_python.Boolean(False):
1526
mock_dbus_python.Boolean(True)})
1527
ret = self.call_method(bus, "methodname", "busname",
1528
"objectpath", "interface")
1529
expected_method_return = {True: False,
1530
False: True}
1531
self.assertEqual(expected_method_return, ret)
1532
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1533
1534
def test_call_method_filters_objectpaths_in_dict(self):
1535
def func():
1536
return method_return
1537
mock_dbus_python = self.MockDBusPython_func(func)
1538
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1539
method_return = mock_dbus_python.Dictionary(
1540
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1541
mock_dbus_python.ObjectPath("objectpath_value_1"),
1542
mock_dbus_python.ObjectPath("objectpath_key_2"):
1543
mock_dbus_python.ObjectPath("objectpath_value_2")})
1544
ret = self.call_method(bus, "methodname", "busname",
1545
"objectpath", "interface")
1546
expected_method_return = {str(key): str(value)
1547
for key, value in
1548
method_return.items()}
1549
self.assertEqual(expected_method_return, ret)
1550
self.assertIsInstance(ret, dict)
1551
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1552
1553
def test_call_method_filters_dict_in_dict(self):
1554
def func():
1555
return method_return
1556
mock_dbus_python = self.MockDBusPython_func(func)
1557
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1558
method_return = mock_dbus_python.Dictionary(
1559
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1560
"key12": "value12"}),
1561
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1562
"key22": "value22"})})
1563
ret = self.call_method(bus, "methodname", "busname",
1564
"objectpath", "interface")
1565
expected_method_return = {
1566
"key1": {"key11": "value11",
1567
"key12": "value12"},
1568
"key2": {"key21": "value21",
1569
"key22": "value22"},
1570
}
1571
self.assertEqual(expected_method_return, ret)
1572
self.assertIsInstance(ret, dict)
1573
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1574
for key, value in ret.items():
1575
self.assertIsInstance(value, dict)
1576
self.assertEqual(expected_method_return[key], value)
1577
self.assertNotIsInstance(value,
1578
mock_dbus_python.Dictionary)
1579
1580
def test_call_method_filters_dict_three_deep(self):
1581
def func():
1582
return method_return
1583
mock_dbus_python = self.MockDBusPython_func(func)
1584
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1585
method_return = mock_dbus_python.Dictionary(
1586
{"key1":
1587
mock_dbus_python.Dictionary(
1588
{"key2":
1589
mock_dbus_python.Dictionary(
1590
{"key3":
1591
mock_dbus_python.Boolean(True),
1592
}),
1593
}),
1594
})
1595
ret = self.call_method(bus, "methodname", "busname",
1596
"objectpath", "interface")
1597
expected_method_return = {"key1": {"key2": {"key3": True}}}
1598
self.assertEqual(expected_method_return, ret)
1599
self.assertIsInstance(ret, dict)
1600
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1601
self.assertIsInstance(ret["key1"], dict)
1602
self.assertNotIsInstance(ret["key1"],
1603
mock_dbus_python.Dictionary)
1604
self.assertIsInstance(ret["key1"]["key2"], dict)
1605
self.assertNotIsInstance(ret["key1"]["key2"],
1606
mock_dbus_python.Dictionary)
1607
self.assertTrue(ret["key1"]["key2"]["key3"])
1608
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1609
mock_dbus_python.Boolean)
1610
1611
def test_call_method_handles_exception(self):
1078
self.check_option_syntax(options)
1079
1080
1081
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1082
def test_calls_and_returns_get_object_on_bus(self):
1083
class MockBus(object):
1084
called = False
1085
def get_object(mockbus_self, busname, dbus_path):
1086
# Note that "self" is still the testcase instance,
1087
# this MockBus instance is in "mockbus_self".
1088
self.assertEqual(dbus_busname, busname)
1089
self.assertEqual(server_dbus_path, dbus_path)
1090
mockbus_self.called = True
1091
return mockbus_self
1092
1093
mockbus = get_mandos_dbus_object(bus=MockBus())
1094
self.assertIsInstance(mockbus, MockBus)
1095
self.assertTrue(mockbus.called)
1096
1097
def test_logs_and_exits_on_dbus_error(self):
1098
class MockBusFailing(object):
1099
def get_object(self, busname, dbus_path):
1100
raise dbus.exceptions.DBusException("Test")
1101
1102
with self.assertLogs(log, logging.CRITICAL):
1103
with self.assertRaises(SystemExit) as e:
1104
bus = get_mandos_dbus_object(bus=MockBusFailing())
1105
1106
if isinstance(e.exception.code, int):
1107
self.assertNotEqual(0, e.exception.code)
1108
else:
1109
self.assertIsNotNone(e.exception.code)
1110
1111
1112
class Test_get_managed_objects(TestCaseWithAssertLogs):
1113
def test_calls_and_returns_GetManagedObjects(self):
1114
managed_objects = {"/clients/foo": { "Name": "foo"}}
1115
class MockObjectManager(object):
1116
def GetManagedObjects(self):
1117
return managed_objects
1118
retval = get_managed_objects(MockObjectManager())
1119
self.assertDictEqual(managed_objects, retval)
1120
1121
def test_logs_and_exits_on_dbus_error(self):
1612
1122
dbus_logger = logging.getLogger("dbus.proxies")
1613
1123
1614
def func():
1615
dbus_logger.error("Test")
1616
raise mock_dbus_python.exceptions.DBusException()
1617
1618
mock_dbus_python = self.MockDBusPython_func(func)
1619
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1124
class MockObjectManagerFailing(object):
1125
def GetManagedObjects(self):
1126
dbus_logger.error("Test")
1127
raise dbus.exceptions.DBusException("Test")
1620
1128
1621
1129
class CountingHandler(logging.Handler):
1622
1130
count = 0
1628
1136
dbus_logger.addHandler(counting_handler)
1629
1137
1630
1138
try:
1631
with self.assertRaises(dbus.Error) as e:
1632
self.call_method(bus, "methodname", "busname",
1633
"objectpath", "interface")
1139
with self.assertLogs(log, logging.CRITICAL) as watcher:
1140
with self.assertRaises(SystemExit) as e:
1141
get_managed_objects(MockObjectManagerFailing())
1634
1142
finally:
1635
1143
dbus_logger.removeFilter(counting_handler)
1636
1144
1637
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1638
1639
1145
# Make sure the dbus logger was suppressed
1640
1146
self.assertEqual(0, counting_handler.count)
1641
1147
1642
def test_Set_Secret_sends_bytearray(self):
1643
ret = [None]
1644
def func(*args, **kwargs):
1645
ret[0] = (args, kwargs)
1646
mock_dbus_python = self.MockDBusPython_func(func)
1647
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1648
bus.set_client_property("objectpath", "Secret", "value")
1649
expected_call = (("se.recompile.Mandos.Client", "Secret",
1650
mock_dbus_python.ByteArray(b"value")),
1651
{"dbus_interface":
1652
"org.freedesktop.DBus.Properties"})
1653
self.assertEqual(expected_call, ret[0])
1654
if sys.version_info.major == 2:
1655
self.assertIsInstance(ret[0][0][-1],
1656
mock_dbus_python.ByteArray)
1657
1658
def test_get_object_converts_to_correct_exception(self):
1659
bus = dbus_python_adapter.SystemBus(
1660
self.fake_dbus_python_raises_exception_on_connect)
1661
with self.assertRaises(dbus.ConnectFailed):
1662
self.call_method(bus, "methodname", "busname",
1663
"objectpath", "interface")
1664
1665
class fake_dbus_python_raises_exception_on_connect:
1666
"""fake dbus-python module"""
1667
class exceptions:
1668
"""Pseudo-namespace"""
1669
class DBusException(Exception):
1670
pass
1671
1672
@classmethod
1673
def SystemBus(cls):
1674
def get_object(busname, objectpath):
1675
raise cls.exceptions.DBusException()
1676
Bus = collections.namedtuple("Bus", ["get_object"])
1677
return Bus(get_object=get_object)
1678
1679
1680
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1681
class mock_dbus_python:
1682
"""mock dbus-python modules"""
1683
class SystemBus:
1684
@staticmethod
1685
def get_object(busname, objectpath):
1686
return Unique()
1687
1688
def setUp(self):
1689
self.bus = dbus_python_adapter.CachingBus(
1690
self.mock_dbus_python)
1691
1692
def test_returns_distinct_objectpaths(self):
1693
obj1 = self.bus.get_object("busname", "objectpath1")
1694
self.assertIsInstance(obj1, Unique)
1695
obj2 = self.bus.get_object("busname", "objectpath2")
1696
self.assertIsInstance(obj2, Unique)
1697
self.assertIsNot(obj1, obj2)
1698
1699
def test_returns_distinct_busnames(self):
1700
obj1 = self.bus.get_object("busname1", "objectpath")
1701
self.assertIsInstance(obj1, Unique)
1702
obj2 = self.bus.get_object("busname2", "objectpath")
1703
self.assertIsInstance(obj2, Unique)
1704
self.assertIsNot(obj1, obj2)
1705
1706
def test_returns_distinct_both(self):
1707
obj1 = self.bus.get_object("busname1", "objectpath")
1708
self.assertIsInstance(obj1, Unique)
1709
obj2 = self.bus.get_object("busname2", "objectpath")
1710
self.assertIsInstance(obj2, Unique)
1711
self.assertIsNot(obj1, obj2)
1712
1713
def test_returns_same(self):
1714
obj1 = self.bus.get_object("busname", "objectpath")
1715
self.assertIsInstance(obj1, Unique)
1716
obj2 = self.bus.get_object("busname", "objectpath")
1717
self.assertIsInstance(obj2, Unique)
1718
self.assertIs(obj1, obj2)
1719
1720
def test_returns_same_old(self):
1721
obj1 = self.bus.get_object("busname1", "objectpath1")
1722
self.assertIsInstance(obj1, Unique)
1723
obj2 = self.bus.get_object("busname2", "objectpath2")
1724
self.assertIsInstance(obj2, Unique)
1725
obj1b = self.bus.get_object("busname1", "objectpath1")
1726
self.assertIsInstance(obj1b, Unique)
1727
self.assertIsNot(obj1, obj2)
1728
self.assertIsNot(obj2, obj1b)
1729
self.assertIs(obj1, obj1b)
1730
1731
1732
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1733
1734
def Stub_pydbus_func(self, func):
1735
class stub_pydbus:
1736
"""stub pydbus module"""
1737
class SystemBus:
1738
@staticmethod
1739
def get(busname, objectpath):
1740
DBusObject = collections.namedtuple(
1741
"DBusObject", ("methodname",))
1742
return {"interface":
1743
DBusObject(methodname=func)}
1744
return stub_pydbus
1745
1746
def call_method(self, bus, methodname, busname, objectpath,
1747
interface, *args):
1748
with self.assertLogs(log, logging.DEBUG):
1749
return bus.call_method(methodname, busname, objectpath,
1750
interface, *args)
1751
1752
def test_call_method_returns(self):
1753
expected_method_return = Unique()
1754
method_args = (Unique(), Unique())
1755
def func(*args):
1756
self.assertEqual(len(method_args), len(args))
1757
for marg, arg in zip(method_args, args):
1758
self.assertIs(marg, arg)
1759
return expected_method_return
1760
stub_pydbus = self.Stub_pydbus_func(func)
1761
bus = pydbus_adapter.SystemBus(stub_pydbus)
1762
ret = self.call_method(bus, "methodname", "busname",
1763
"objectpath", "interface",
1764
*method_args)
1765
self.assertIs(ret, expected_method_return)
1766
1767
def test_call_method_handles_exception(self):
1768
dbus_logger = logging.getLogger("dbus.proxies")
1769
1770
def func():
1771
raise gi.repository.GLib.Error()
1772
1773
stub_pydbus = self.Stub_pydbus_func(func)
1774
bus = pydbus_adapter.SystemBus(stub_pydbus)
1775
1776
with self.assertRaises(dbus.Error) as e:
1777
self.call_method(bus, "methodname", "busname",
1778
"objectpath", "interface")
1779
1780
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1781
1782
def test_get_converts_to_correct_exception(self):
1783
bus = pydbus_adapter.SystemBus(
1784
self.fake_pydbus_raises_exception_on_connect)
1785
with self.assertRaises(dbus.ConnectFailed):
1786
self.call_method(bus, "methodname", "busname",
1787
"objectpath", "interface")
1788
1789
class fake_pydbus_raises_exception_on_connect:
1790
"""fake dbus-python module"""
1791
@classmethod
1792
def SystemBus(cls):
1793
def get(busname, objectpath):
1794
raise gi.repository.GLib.Error()
1795
Bus = collections.namedtuple("Bus", ["get"])
1796
return Bus(get=get)
1797
1798
def test_set_property_uses_setattr(self):
1799
class Object:
1800
pass
1801
obj = Object()
1802
class pydbus_spy:
1803
class SystemBus:
1804
@staticmethod
1805
def get(busname, objectpath):
1806
return {"interface": obj}
1807
bus = pydbus_adapter.SystemBus(pydbus_spy)
1808
value = Unique()
1809
bus.set_property("busname", "objectpath", "interface", "key",
1810
value)
1811
self.assertIs(value, obj.key)
1812
1813
def test_get_suppresses_xml_deprecation_warning(self):
1814
if sys.version_info.major >= 3:
1815
return
1816
class stub_pydbus_get:
1817
class SystemBus:
1818
@staticmethod
1819
def get(busname, objectpath):
1820
warnings.warn_explicit(
1821
"deprecated", DeprecationWarning,
1822
"xml.etree.ElementTree", 0)
1823
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1824
with warnings.catch_warnings(record=True) as w:
1825
warnings.simplefilter("always")
1826
bus.get("busname", "objectpath")
1827
self.assertEqual(0, len(w))
1828
1829
1830
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1831
class stub_pydbus:
1832
"""stub pydbus module"""
1833
class SystemBus:
1834
@staticmethod
1835
def get(busname, objectpath):
1836
return Unique()
1837
1838
def setUp(self):
1839
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1840
1841
def test_returns_distinct_objectpaths(self):
1842
obj1 = self.bus.get("busname", "objectpath1")
1843
self.assertIsInstance(obj1, Unique)
1844
obj2 = self.bus.get("busname", "objectpath2")
1845
self.assertIsInstance(obj2, Unique)
1846
self.assertIsNot(obj1, obj2)
1847
1848
def test_returns_distinct_busnames(self):
1849
obj1 = self.bus.get("busname1", "objectpath")
1850
self.assertIsInstance(obj1, Unique)
1851
obj2 = self.bus.get("busname2", "objectpath")
1852
self.assertIsInstance(obj2, Unique)
1853
self.assertIsNot(obj1, obj2)
1854
1855
def test_returns_distinct_both(self):
1856
obj1 = self.bus.get("busname1", "objectpath")
1857
self.assertIsInstance(obj1, Unique)
1858
obj2 = self.bus.get("busname2", "objectpath")
1859
self.assertIsInstance(obj2, Unique)
1860
self.assertIsNot(obj1, obj2)
1861
1862
def test_returns_same(self):
1863
obj1 = self.bus.get("busname", "objectpath")
1864
self.assertIsInstance(obj1, Unique)
1865
obj2 = self.bus.get("busname", "objectpath")
1866
self.assertIsInstance(obj2, Unique)
1867
self.assertIs(obj1, obj2)
1868
1869
def test_returns_same_old(self):
1870
obj1 = self.bus.get("busname1", "objectpath1")
1871
self.assertIsInstance(obj1, Unique)
1872
obj2 = self.bus.get("busname2", "objectpath2")
1873
self.assertIsInstance(obj2, Unique)
1874
obj1b = self.bus.get("busname1", "objectpath1")
1875
self.assertIsInstance(obj1b, Unique)
1876
self.assertIsNot(obj1, obj2)
1877
self.assertIsNot(obj2, obj1b)
1878
self.assertIs(obj1, obj1b)
1879
1880
1881
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
1882
1883
class dummy_dbussy:
1884
class DBUS:
1885
class ObjectPath(str):
1886
pass
1887
class DBusError(Exception):
1888
pass
1889
1890
def fake_ravel_func(self, func):
1891
class fake_ravel:
1892
@staticmethod
1893
def system_bus():
1894
class DBusInterfaceProxy:
1895
@staticmethod
1896
def methodname(*args):
1897
return [func(*args)]
1898
class DBusObject:
1899
@staticmethod
1900
def get_interface(interface):
1901
if interface == "interface":
1902
return DBusInterfaceProxy()
1903
return {"busname": {"objectpath": DBusObject()}}
1904
return fake_ravel
1905
1906
def call_method(self, bus, methodname, busname, objectpath,
1907
interface, *args):
1908
with self.assertLogs(log, logging.DEBUG):
1909
return bus.call_method(methodname, busname, objectpath,
1910
interface, *args)
1911
1912
def test_call_method_returns(self):
1913
expected_method_return = Unique()
1914
method_args = (Unique(), Unique())
1915
def func(*args):
1916
self.assertEqual(len(method_args), len(args))
1917
for marg, arg in zip(method_args, args):
1918
self.assertIs(marg, arg)
1919
return expected_method_return
1920
fake_ravel = self.fake_ravel_func(func)
1921
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1922
ret = self.call_method(bus, "methodname", "busname",
1923
"objectpath", "interface",
1924
*method_args)
1925
self.assertIs(ret, expected_method_return)
1926
1927
def test_call_method_filters_objectpath(self):
1928
def func():
1929
return method_return
1930
fake_ravel = self.fake_ravel_func(func)
1931
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1932
method_return = (self.dummy_dbussy.DBUS
1933
.ObjectPath("objectpath"))
1934
ret = self.call_method(bus, "methodname", "busname",
1935
"objectpath", "interface")
1936
self.assertEqual("objectpath", ret)
1937
self.assertNotIsInstance(ret,
1938
self.dummy_dbussy.DBUS.ObjectPath)
1939
1940
def test_call_method_filters_objectpaths_in_dict(self):
1941
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1942
def func():
1943
return method_return
1944
fake_ravel = self.fake_ravel_func(func)
1945
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1946
method_return = {
1947
ObjectPath("objectpath_key_1"):
1948
ObjectPath("objectpath_value_1"),
1949
ObjectPath("objectpath_key_2"):
1950
ObjectPath("objectpath_value_2"),
1951
}
1952
ret = self.call_method(bus, "methodname", "busname",
1953
"objectpath", "interface")
1954
expected_method_return = {str(key): str(value)
1955
for key, value in
1956
method_return.items()}
1957
for key, value in ret.items():
1958
self.assertNotIsInstance(key, ObjectPath)
1959
self.assertNotIsInstance(value, ObjectPath)
1960
self.assertEqual(expected_method_return, ret)
1961
self.assertIsInstance(ret, dict)
1962
1963
def test_call_method_filters_objectpaths_in_dict_in_dict(self):
1964
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1965
def func():
1966
return method_return
1967
fake_ravel = self.fake_ravel_func(func)
1968
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1969
method_return = {
1970
ObjectPath("key1"): {
1971
ObjectPath("key11"): ObjectPath("value11"),
1972
ObjectPath("key12"): ObjectPath("value12"),
1973
},
1974
ObjectPath("key2"): {
1975
ObjectPath("key21"): ObjectPath("value21"),
1976
ObjectPath("key22"): ObjectPath("value22"),
1977
},
1978
}
1979
ret = self.call_method(bus, "methodname", "busname",
1980
"objectpath", "interface")
1981
expected_method_return = {
1982
"key1": {"key11": "value11",
1983
"key12": "value12"},
1984
"key2": {"key21": "value21",
1985
"key22": "value22"},
1986
}
1987
self.assertEqual(expected_method_return, ret)
1988
for key, value in ret.items():
1989
self.assertIsInstance(value, dict)
1990
self.assertEqual(expected_method_return[key], value)
1991
self.assertNotIsInstance(key, ObjectPath)
1992
for inner_key, inner_value in value.items():
1993
self.assertIsInstance(value, dict)
1994
self.assertEqual(
1995
expected_method_return[key][inner_key],
1996
inner_value)
1997
self.assertNotIsInstance(key, ObjectPath)
1998
1999
def test_call_method_filters_objectpaths_in_dict_three_deep(self):
2000
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
2001
def func():
2002
return method_return
2003
fake_ravel = self.fake_ravel_func(func)
2004
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2005
method_return = {
2006
ObjectPath("key1"): {
2007
ObjectPath("key2"): {
2008
ObjectPath("key3"): ObjectPath("value"),
2009
},
2010
},
2011
}
2012
ret = self.call_method(bus, "methodname", "busname",
2013
"objectpath", "interface")
2014
expected_method_return = {"key1": {"key2": {"key3": "value"}}}
2015
self.assertEqual(expected_method_return, ret)
2016
self.assertIsInstance(ret, dict)
2017
self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
2018
self.assertIsInstance(ret["key1"], dict)
2019
self.assertNotIsInstance(next(iter(ret["key1"].keys())),
2020
ObjectPath)
2021
self.assertIsInstance(ret["key1"]["key2"], dict)
2022
self.assertNotIsInstance(
2023
next(iter(ret["key1"]["key2"].keys())),
2024
ObjectPath)
2025
self.assertEqual("value", ret["key1"]["key2"]["key3"])
2026
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
2027
self.dummy_dbussy.DBUS.ObjectPath)
2028
2029
def test_call_method_handles_exception(self):
2030
def func():
2031
raise self.dummy_dbussy.DBusError()
2032
2033
fake_ravel = self.fake_ravel_func(func)
2034
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2035
2036
with self.assertRaises(dbus.Error) as e:
2037
self.call_method(bus, "methodname", "busname",
2038
"objectpath", "interface")
2039
2040
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
2041
2042
def test_get_object_converts_to_correct_exception(self):
2043
class fake_ravel_raises_exception_on_connect:
2044
@staticmethod
2045
def system_bus():
2046
class Bus:
2047
@staticmethod
2048
def __getitem__(key):
2049
if key == "objectpath":
2050
raise self.dummy_dbussy.DBusError()
2051
raise Exception(key)
2052
return {"busname": Bus()}
2053
def func():
2054
raise self.dummy_dbussy.DBusError()
2055
bus = dbussy_adapter.SystemBus(
2056
self.dummy_dbussy,
2057
fake_ravel_raises_exception_on_connect)
2058
with self.assertRaises(dbus.ConnectFailed):
2059
self.call_method(bus, "methodname", "busname",
2060
"objectpath", "interface")
1148
# Test that the dbus_logger still works
1149
with self.assertLogs(dbus_logger, logging.ERROR):
1150
dbus_logger.error("Test")
1151
1152
if isinstance(e.exception.code, int):
1153
self.assertNotEqual(0, e.exception.code)
1154
else:
1155
self.assertIsNotNone(e.exception.code)
2061
1156
2062
1157
2063
1158
class Test_commands_from_options(unittest.TestCase):
2064
2065
1159
def setUp(self):
2066
1160
self.parser = argparse.ArgumentParser()
2067
1161
add_command_line_options(self.parser)
2068
1162
2069
1163
def test_is_enabled(self):
2070
self.assert_command_from_args(["--is-enabled", "client"],
1164
self.assert_command_from_args(["--is-enabled", "foo"],
2071
1165
command.IsEnabled)
2072
1166
2073
def assert_command_from_args(self, args, command_cls, length=1,
2074
clients=None, **cmd_attrs):
1167
def assert_command_from_args(self, args, command_cls,
1168
**cmd_attrs):
2075
1169
"""Assert that parsing ARGS should result in an instance of
2076
1170
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
2077
1171
options = self.parser.parse_args(args)
2078
1172
check_option_syntax(self.parser, options)
2079
1173
commands = commands_from_options(options)
2080
self.assertEqual(length, len(commands))
2081
for command in commands:
2082
if isinstance(command, command_cls):
2083
break
2084
else:
2085
self.assertIsInstance(command, command_cls)
2086
if clients is not None:
2087
self.assertEqual(clients, options.client)
1174
self.assertEqual(1, len(commands))
1175
command = commands[0]
1176
self.assertIsInstance(command, command_cls)
2088
1177
for key, value in cmd_attrs.items():
2089
1178
self.assertEqual(value, getattr(command, key))
2090
1179
2091
def assert_commands_from_args(self, args, commands, clients=None):
2092
for cmd in commands:
2093
self.assert_command_from_args(args, cmd,
2094
length=len(commands),
2095
clients=clients)
2096
2097
1180
def test_is_enabled_short(self):
2098
self.assert_command_from_args(["-V", "client"],
1181
self.assert_command_from_args(["-V", "foo"],
2099
1182
command.IsEnabled)
2100
1183
2101
1184
def test_approve(self):
2102
self.assert_command_from_args(["--approve", "client"],
1185
self.assert_command_from_args(["--approve", "foo"],
2103
1186
command.Approve)
2104
1187
2105
1188
def test_approve_short(self):
2106
self.assert_command_from_args(["-A", "client"],
2107
command.Approve)
1189
self.assert_command_from_args(["-A", "foo"], command.Approve)
2108
1190
2109
1191
def test_deny(self):
2110
self.assert_command_from_args(["--deny", "client"],
2111
command.Deny)
1192
self.assert_command_from_args(["--deny", "foo"], command.Deny)
2112
1193
2113
1194
def test_deny_short(self):
2114
self.assert_command_from_args(["-D", "client"], command.Deny)
1195
self.assert_command_from_args(["-D", "foo"], command.Deny)
2115
1196
2116
1197
def test_remove(self):
2117
self.assert_command_from_args(["--remove", "client"],
1198
self.assert_command_from_args(["--remove", "foo"],
2118
1199
command.Remove)
2119
1200
2120
1201
def test_deny_before_remove(self):
2121
1202
options = self.parser.parse_args(["--deny", "--remove",
2122
"client"])
1203
"foo"])
2123
1204
check_option_syntax(self.parser, options)
2124
1205
commands = commands_from_options(options)
2125
1206
self.assertEqual(2, len(commands))
2136
1217
self.assertIsInstance(commands[1], command.Remove)
2137
1218
2138
1219
def test_remove_short(self):
2139
self.assert_command_from_args(["-r", "client"],
2140
command.Remove)
1220
self.assert_command_from_args(["-r", "foo"], command.Remove)
2141
1221
2142
1222
def test_dump_json(self):
2143
1223
self.assert_command_from_args(["--dump-json"],
2144
1224
command.DumpJSON)
2145
1225
2146
1226
def test_enable(self):
2147
self.assert_command_from_args(["--enable", "client"],
1227
self.assert_command_from_args(["--enable", "foo"],
2148
1228
command.Enable)
2149
1229
2150
1230
def test_enable_short(self):
2151
self.assert_command_from_args(["-e", "client"],
2152
command.Enable)
1231
self.assert_command_from_args(["-e", "foo"], command.Enable)
2153
1232
2154
1233
def test_disable(self):
2155
self.assert_command_from_args(["--disable", "client"],
1234
self.assert_command_from_args(["--disable", "foo"],
2156
1235
command.Disable)
2157
1236
2158
1237
def test_disable_short(self):
2159
self.assert_command_from_args(["-d", "client"],
2160
command.Disable)
1238
self.assert_command_from_args(["-d", "foo"], command.Disable)
2161
1239
2162
1240
def test_bump_timeout(self):
2163
self.assert_command_from_args(["--bump-timeout", "client"],
1241
self.assert_command_from_args(["--bump-timeout", "foo"],
2164
1242
command.BumpTimeout)
2165
1243
2166
1244
def test_bump_timeout_short(self):
2167
self.assert_command_from_args(["-b", "client"],
1245
self.assert_command_from_args(["-b", "foo"],
2168
1246
command.BumpTimeout)
2169
1247
2170
1248
def test_start_checker(self):
2171
self.assert_command_from_args(["--start-checker", "client"],
1249
self.assert_command_from_args(["--start-checker", "foo"],
2172
1250
command.StartChecker)
2173
1251
2174
1252
def test_stop_checker(self):
2175
self.assert_command_from_args(["--stop-checker", "client"],
1253
self.assert_command_from_args(["--stop-checker", "foo"],
2176
1254
command.StopChecker)
2177
1255
2178
1256
def test_approve_by_default(self):
2179
self.assert_command_from_args(["--approve-by-default",
2180
"client"],
1257
self.assert_command_from_args(["--approve-by-default", "foo"],
2181
1258
command.ApproveByDefault)
2182
1259
2183
1260
def test_deny_by_default(self):
2184
self.assert_command_from_args(["--deny-by-default", "client"],
1261
self.assert_command_from_args(["--deny-by-default", "foo"],
2185
1262
command.DenyByDefault)
2186
1263
2187
1264
def test_checker(self):
2188
self.assert_command_from_args(["--checker", ":", "client"],
1265
self.assert_command_from_args(["--checker", ":", "foo"],
2189
1266
command.SetChecker,
2190
1267
value_to_set=":")
2191
1268
2192
1269
def test_checker_empty(self):
2193
self.assert_command_from_args(["--checker", "", "client"],
1270
self.assert_command_from_args(["--checker", "", "foo"],
2194
1271
command.SetChecker,
2195
1272
value_to_set="")
2196
1273
2197
1274
def test_checker_short(self):
2198
self.assert_command_from_args(["-c", ":", "client"],
1275
self.assert_command_from_args(["-c", ":", "foo"],
2199
1276
command.SetChecker,
2200
1277
value_to_set=":")
2201
1278
2202
1279
def test_host(self):
2203
self.assert_command_from_args(
2204
["--host", "client.example.org", "client"],
2205
command.SetHost, value_to_set="client.example.org")
1280
self.assert_command_from_args(["--host", "foo.example.org",
1281
"foo"], command.SetHost,
1282
value_to_set="foo.example.org")
2206
1283
2207
1284
def test_host_short(self):
2208
self.assert_command_from_args(
2209
["-H", "client.example.org", "client"], command.SetHost,
2210
value_to_set="client.example.org")
1285
self.assert_command_from_args(["-H", "foo.example.org",
1286
"foo"], command.SetHost,
1287
value_to_set="foo.example.org")
2211
1288
2212
1289
def test_secret_devnull(self):
2213
1290
self.assert_command_from_args(["--secret", os.path.devnull,
2214
"client"], command.SetSecret,
1291
"foo"], command.SetSecret,
2215
1292
value_to_set=b"")
2216
1293
2217
1294
def test_secret_tempfile(self):
2220
1297
f.write(value)
2221
1298
f.seek(0)
2222
1299
self.assert_command_from_args(["--secret", f.name,
2223
"client"],
2224
command.SetSecret,
1300
"foo"], command.SetSecret,
2225
1301
value_to_set=value)
2226
1302
2227
1303
def test_secret_devnull_short(self):
2228
self.assert_command_from_args(["-s", os.path.devnull,
2229
"client"], command.SetSecret,
1304
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1305
command.SetSecret,
2230
1306
value_to_set=b"")
2231
1307
2232
1308
def test_secret_tempfile_short(self):
2234
1310
value = b"secret\0xyzzy\nbar"
2235
1311
f.write(value)
2236
1312
f.seek(0)
2237
self.assert_command_from_args(["-s", f.name, "client"],
1313
self.assert_command_from_args(["-s", f.name, "foo"],
2238
1314
command.SetSecret,
2239
1315
value_to_set=value)
2240
1316
2241
1317
def test_timeout(self):
2242
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1318
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
2243
1319
command.SetTimeout,
2244
1320
value_to_set=300000)
2245
1321
2246
1322
def test_timeout_short(self):
2247
self.assert_command_from_args(["-t", "PT5M", "client"],
1323
self.assert_command_from_args(["-t", "PT5M", "foo"],
2248
1324
command.SetTimeout,
2249
1325
value_to_set=300000)
2250
1326
2251
1327
def test_extended_timeout(self):
2252
1328
self.assert_command_from_args(["--extended-timeout", "PT15M",
2253
"client"],
1329
"foo"],
2254
1330
command.SetExtendedTimeout,
2255
1331
value_to_set=900000)
2256
1332
2257
1333
def test_interval(self):
2258
self.assert_command_from_args(["--interval", "PT2M",
2259
"client"], command.SetInterval,
1334
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1335
command.SetInterval,
2260
1336
value_to_set=120000)
2261
1337
2262
1338
def test_interval_short(self):
2263
self.assert_command_from_args(["-i", "PT2M", "client"],
1339
self.assert_command_from_args(["-i", "PT2M", "foo"],
2264
1340
command.SetInterval,
2265
1341
value_to_set=120000)
2266
1342
2267
1343
def test_approval_delay(self):
2268
1344
self.assert_command_from_args(["--approval-delay", "PT30S",
2269
"client"],
1345
"foo"],
2270
1346
command.SetApprovalDelay,
2271
1347
value_to_set=30000)
2272
1348
2273
1349
def test_approval_duration(self):
2274
1350
self.assert_command_from_args(["--approval-duration", "PT1S",
2275
"client"],
1351
"foo"],
2276
1352
command.SetApprovalDuration,
2277
1353
value_to_set=1000)
2278
1354
2290
1366
verbose=True)
2291
1367
2292
1368
2293
def test_manual_page_example_1(self):
2294
self.assert_command_from_args("",
2295
command.PrintTable,
2296
clients=[],
2297
verbose=False)
2298
2299
def test_manual_page_example_2(self):
2300
self.assert_command_from_args(
2301
"--verbose foo1.example.org foo2.example.org".split(),
2302
command.PrintTable, clients=["foo1.example.org",
2303
"foo2.example.org"],
2304
verbose=True)
2305
2306
def test_manual_page_example_3(self):
2307
self.assert_command_from_args("--enable --all".split(),
2308
command.Enable,
2309
clients=[])
2310
2311
def test_manual_page_example_4(self):
2312
self.assert_commands_from_args(
2313
("--timeout=PT5M --interval=PT1M foo1.example.org"
2314
" foo2.example.org").split(),
2315
[command.SetTimeout, command.SetInterval],
2316
clients=["foo1.example.org", "foo2.example.org"])
2317
2318
def test_manual_page_example_5(self):
2319
self.assert_command_from_args("--approve --all".split(),
2320
command.Approve,
2321
clients=[])
2322
2323
2324
1369
class TestCommand(unittest.TestCase):
2325
1370
"""Abstract class for tests of command classes"""
2326
1371
2327
class FakeMandosBus(dbus.MandosBus):
2328
def __init__(self, testcase):
2329
self.client_properties = {
2330
"Name": "foo",
2331
"KeyID": ("92ed150794387c03ce684574b1139a65"
2332
"94a34f895daaaf09fd8ea90a27cddb12"),
2333
"Secret": b"secret",
2334
"Host": "foo.example.org",
2335
"Enabled": True,
2336
"Timeout": 300000,
2337
"LastCheckedOK": "2019-02-03T00:00:00",
2338
"Created": "2019-01-02T00:00:00",
2339
"Interval": 120000,
2340
"Fingerprint": ("778827225BA7DE539C5A"
2341
"7CFA59CFF7CDBD9A5920"),
2342
"CheckerRunning": False,
2343
"LastEnabled": "2019-01-03T00:00:00",
2344
"ApprovalPending": False,
2345
"ApprovedByDefault": True,
2346
"LastApprovalRequest": "",
2347
"ApprovalDelay": 0,
2348
"ApprovalDuration": 1000,
2349
"Checker": "fping -q -- %(host)s",
2350
"ExtendedTimeout": 900000,
2351
"Expires": "2019-02-04T00:00:00",
2352
"LastCheckerStatus": 0,
2353
}
2354
self.other_client_properties = {
2355
"Name": "barbar",
2356
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2357
"6ab612cff5ad227247e46c2b020f441c"),
2358
"Secret": b"secretbar",
2359
"Host": "192.0.2.3",
2360
"Enabled": True,
2361
"Timeout": 300000,
2362
"LastCheckedOK": "2019-02-04T00:00:00",
2363
"Created": "2019-01-03T00:00:00",
2364
"Interval": 120000,
2365
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2366
"F547B3A107558FCA3A27"),
2367
"CheckerRunning": True,
2368
"LastEnabled": "2019-01-04T00:00:00",
2369
"ApprovalPending": False,
2370
"ApprovedByDefault": False,
2371
"LastApprovalRequest": "2019-01-03T00:00:00",
2372
"ApprovalDelay": 30000,
2373
"ApprovalDuration": 93785000,
2374
"Checker": ":",
2375
"ExtendedTimeout": 900000,
2376
"Expires": "2019-02-05T00:00:00",
2377
"LastCheckerStatus": -2,
2378
}
2379
self.clients = collections.OrderedDict(
2380
[
2381
("client_objectpath", self.client_properties),
2382
("other_client_objectpath",
2383
self.other_client_properties),
2384
])
2385
self.one_client = {"client_objectpath":
2386
self.client_properties}
2387
self.testcase = testcase
2388
self.calls = []
2389
2390
def call_method(self, methodname, busname, objectpath,
2391
interface, *args):
2392
self.testcase.assertEqual("se.recompile.Mandos", busname)
2393
self.calls.append((methodname, busname, objectpath,
2394
interface, args))
2395
if interface == "org.freedesktop.DBus.Properties":
2396
if methodname == "Set":
2397
self.testcase.assertEqual(3, len(args))
2398
interface, key, value = args
2399
self.testcase.assertEqual(
2400
"se.recompile.Mandos.Client", interface)
2401
self.clients[objectpath][key] = value
2402
return
2403
elif interface == "se.recompile.Mandos":
2404
self.testcase.assertEqual("RemoveClient", methodname)
2405
self.testcase.assertEqual(1, len(args))
2406
clientpath = args[0]
2407
del self.clients[clientpath]
2408
return
2409
elif interface == "se.recompile.Mandos.Client":
2410
if methodname == "Approve":
2411
self.testcase.assertEqual(1, len(args))
2412
return
2413
raise ValueError()
2414
2415
1372
def setUp(self):
2416
self.bus = self.FakeMandosBus(self)
1373
testcase = self
1374
class MockClient(object):
1375
def __init__(self, name, **attributes):
1376
self.__dbus_object_path__ = "/clients/{}".format(name)
1377
self.attributes = attributes
1378
self.attributes["Name"] = name
1379
self.calls = []
1380
def Set(self, interface, propname, value, dbus_interface):
1381
testcase.assertEqual(client_dbus_interface, interface)
1382
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1383
dbus_interface)
1384
self.attributes[propname] = value
1385
def Approve(self, approve, dbus_interface):
1386
testcase.assertEqual(client_dbus_interface,
1387
dbus_interface)
1388
self.calls.append(("Approve", (approve,
1389
dbus_interface)))
1390
self.client = MockClient(
1391
"foo",
1392
KeyID=("92ed150794387c03ce684574b1139a65"
1393
"94a34f895daaaf09fd8ea90a27cddb12"),
1394
Secret=b"secret",
1395
Host="foo.example.org",
1396
Enabled=dbus.Boolean(True),
1397
Timeout=300000,
1398
LastCheckedOK="2019-02-03T00:00:00",
1399
Created="2019-01-02T00:00:00",
1400
Interval=120000,
1401
Fingerprint=("778827225BA7DE539C5A"
1402
"7CFA59CFF7CDBD9A5920"),
1403
CheckerRunning=dbus.Boolean(False),
1404
LastEnabled="2019-01-03T00:00:00",
1405
ApprovalPending=dbus.Boolean(False),
1406
ApprovedByDefault=dbus.Boolean(True),
1407
LastApprovalRequest="",
1408
ApprovalDelay=0,
1409
ApprovalDuration=1000,
1410
Checker="fping -q -- %(host)s",
1411
ExtendedTimeout=900000,
1412
Expires="2019-02-04T00:00:00",
1413
LastCheckerStatus=0)
1414
self.other_client = MockClient(
1415
"barbar",
1416
KeyID=("0558568eedd67d622f5c83b35a115f79"
1417
"6ab612cff5ad227247e46c2b020f441c"),
1418
Secret=b"secretbar",
1419
Host="192.0.2.3",
1420
Enabled=dbus.Boolean(True),
1421
Timeout=300000,
1422
LastCheckedOK="2019-02-04T00:00:00",
1423
Created="2019-01-03T00:00:00",
1424
Interval=120000,
1425
Fingerprint=("3E393AEAEFB84C7E89E2"
1426
"F547B3A107558FCA3A27"),
1427
CheckerRunning=dbus.Boolean(True),
1428
LastEnabled="2019-01-04T00:00:00",
1429
ApprovalPending=dbus.Boolean(False),
1430
ApprovedByDefault=dbus.Boolean(False),
1431
LastApprovalRequest="2019-01-03T00:00:00",
1432
ApprovalDelay=30000,
1433
ApprovalDuration=93785000,
1434
Checker=":",
1435
ExtendedTimeout=900000,
1436
Expires="2019-02-05T00:00:00",
1437
LastCheckerStatus=-2)
1438
self.clients = collections.OrderedDict(
1439
[
1440
("/clients/foo", self.client.attributes),
1441
("/clients/barbar", self.other_client.attributes),
1442
])
1443
self.one_client = {"/clients/foo": self.client.attributes}
1444
1445
@property
1446
def bus(self):
1447
class Bus(object):
1448
@staticmethod
1449
def get_object(client_bus_name, path):
1450
self.assertEqual(dbus_busname, client_bus_name)
1451
return {
1452
# Note: "self" here is the TestCmd instance, not
1453
# the Bus instance, since this is a static method!
1454
"/clients/foo": self.client,
1455
"/clients/barbar": self.other_client,
1456
}[path]
1457
return Bus()
2417
1458
2418
1459
2419
1460
class TestBaseCommands(TestCommand):
2420
1461
2421
1462
def test_IsEnabled_exits_successfully(self):
2422
1463
with self.assertRaises(SystemExit) as e:
2423
command.IsEnabled().run(self.bus.one_client)
1464
command.IsEnabled().run(self.one_client)
2424
1465
if e.exception.code is not None:
2425
1466
self.assertEqual(0, e.exception.code)
2426
1467
else:
2427
1468
self.assertIsNone(e.exception.code)
2428
1469
2429
1470
def test_IsEnabled_exits_with_failure(self):
2430
self.bus.client_properties["Enabled"] = False
1471
self.client.attributes["Enabled"] = dbus.Boolean(False)
2431
1472
with self.assertRaises(SystemExit) as e:
2432
command.IsEnabled().run(self.bus.one_client)
1473
command.IsEnabled().run(self.one_client)
2433
1474
if isinstance(e.exception.code, int):
2434
1475
self.assertNotEqual(0, e.exception.code)
2435
1476
else:
2436
1477
self.assertIsNotNone(e.exception.code)
2437
1478
2438
1479
def test_Approve(self):
2439
busname = "se.recompile.Mandos"
2440
client_interface = "se.recompile.Mandos.Client"
2441
command.Approve().run(self.bus.clients, self.bus)
2442
self.assertTrue(self.bus.clients)
2443
for clientpath in self.bus.clients:
2444
self.assertIn(("Approve", busname, clientpath,
2445
client_interface, (True,)), self.bus.calls)
1480
command.Approve().run(self.clients, self.bus)
1481
for clientpath in self.clients:
1482
client = self.bus.get_object(dbus_busname, clientpath)
1483
self.assertIn(("Approve", (True, client_dbus_interface)),
1484
client.calls)
2446
1485
2447
1486
def test_Deny(self):
2448
busname = "se.recompile.Mandos"
2449
client_interface = "se.recompile.Mandos.Client"
2450
command.Deny().run(self.bus.clients, self.bus)
2451
self.assertTrue(self.bus.clients)
2452
for clientpath in self.bus.clients:
2453
self.assertIn(("Approve", busname, clientpath,
2454
client_interface, (False,)),
2455
self.bus.calls)
1487
command.Deny().run(self.clients, self.bus)
1488
for clientpath in self.clients:
1489
client = self.bus.get_object(dbus_busname, clientpath)
1490
self.assertIn(("Approve", (False, client_dbus_interface)),
1491
client.calls)
2456
1492
2457
1493
def test_Remove(self):
2458
busname = "se.recompile.Mandos"
2459
server_path = "/"
2460
server_interface = "se.recompile.Mandos"
2461
orig_clients = self.bus.clients.copy()
2462
command.Remove().run(self.bus.clients, self.bus)
2463
self.assertFalse(self.bus.clients)
2464
for clientpath in orig_clients:
2465
self.assertIn(("RemoveClient", busname,
2466
server_path, server_interface,
2467
(clientpath,)), self.bus.calls)
1494
class MockMandos(object):
1495
def __init__(self):
1496
self.calls = []
1497
def RemoveClient(self, dbus_path):
1498
self.calls.append(("RemoveClient", (dbus_path,)))
1499
mandos = MockMandos()
1500
command.Remove().run(self.clients, self.bus, mandos)
1501
for clientpath in self.clients:
1502
self.assertIn(("RemoveClient", (clientpath,)),
1503
mandos.calls)
2468
1504
2469
1505
expected_json = {
2470
1506
"foo": {
2519
1555
2520
1556
def test_DumpJSON_normal(self):
2521
1557
with self.capture_stdout_to_buffer() as buffer:
2522
command.DumpJSON().run(self.bus.clients)
1558
command.DumpJSON().run(self.clients)
2523
1559
json_data = json.loads(buffer.getvalue())
2524
1560
self.assertDictEqual(self.expected_json, json_data)
2525
1561
2536
1572
2537
1573
def test_DumpJSON_one_client(self):
2538
1574
with self.capture_stdout_to_buffer() as buffer:
2539
command.DumpJSON().run(self.bus.one_client)
1575
command.DumpJSON().run(self.one_client)
2540
1576
json_data = json.loads(buffer.getvalue())
2541
1577
expected_json = {"foo": self.expected_json["foo"]}
2542
1578
self.assertDictEqual(expected_json, json_data)
2543
1579
2544
1580
def test_PrintTable_normal(self):
2545
1581
with self.capture_stdout_to_buffer() as buffer:
2546
command.PrintTable().run(self.bus.clients)
1582
command.PrintTable().run(self.clients)
2547
1583
expected_output = "\n".join((
2548
1584
"Name Enabled Timeout Last Successful Check",
2549
1585
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2553
1589
2554
1590
def test_PrintTable_verbose(self):
2555
1591
with self.capture_stdout_to_buffer() as buffer:
2556
command.PrintTable(verbose=True).run(self.bus.clients)
1592
command.PrintTable(verbose=True).run(self.clients)
2557
1593
columns = (
2558
1594
(
2559
1595
"Name ",
2649
1685
2650
1686
def test_PrintTable_one_client(self):
2651
1687
with self.capture_stdout_to_buffer() as buffer:
2652
command.PrintTable().run(self.bus.one_client)
1688
command.PrintTable().run(self.one_client)
2653
1689
expected_output = "\n".join((
2654
1690
"Name Enabled Timeout Last Successful Check",
2655
1691
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2657
1693
self.assertEqual(expected_output, buffer.getvalue())
2658
1694
2659
1695
2660
class TestPropertySetterCmd(TestCommand):
2661
"""Abstract class for tests of command.PropertySetter classes"""
2662
1696
class TestPropertyCmd(TestCommand):
1697
"""Abstract class for tests of command.Property classes"""
2663
1698
def runTest(self):
2664
1699
if not hasattr(self, "command"):
2665
return # Abstract TestCase class
2666
2667
if hasattr(self, "values_to_set"):
2668
cmd_args = [(value,) for value in self.values_to_set]
2669
values_to_get = getattr(self, "values_to_get",
2670
self.values_to_set)
2671
else:
2672
cmd_args = [() for x in range(len(self.values_to_get))]
2673
values_to_get = self.values_to_get
2674
self.assertTrue(values_to_get)
2675
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2676
for clientpath in self.bus.clients:
2677
self.bus.clients[clientpath][self.propname] = (
2678
Unique())
2679
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2680
self.assertTrue(self.bus.clients)
2681
for clientpath in self.bus.clients:
2682
value = (self.bus.clients[clientpath]
2683
[self.propname])
2684
self.assertNotIsInstance(value, Unique)
1700
return
1701
values_to_get = getattr(self, "values_to_get",
1702
self.values_to_set)
1703
for value_to_set, value_to_get in zip(self.values_to_set,
1704
values_to_get):
1705
for clientpath in self.clients:
1706
client = self.bus.get_object(dbus_busname, clientpath)
1707
old_value = client.attributes[self.propname]
1708
client.attributes[self.propname] = self.Unique()
1709
self.run_command(value_to_set, self.clients)
1710
for clientpath in self.clients:
1711
client = self.bus.get_object(dbus_busname, clientpath)
1712
value = client.attributes[self.propname]
1713
self.assertNotIsInstance(value, self.Unique)
2685
1714
self.assertEqual(value_to_get, value)
2686
1715
2687
2688
class TestEnableCmd(TestPropertySetterCmd):
1716
class Unique(object):
1717
"""Class for objects which exist only to be unique objects,
1718
since unittest.mock.sentinel only exists in Python 3.3"""
1719
1720
def run_command(self, value, clients):
1721
self.command().run(clients, self.bus)
1722
1723
1724
class TestEnableCmd(TestPropertyCmd):
2689
1725
command = command.Enable
2690
1726
propname = "Enabled"
2691
values_to_get = [True]
2692
2693
2694
class TestDisableCmd(TestPropertySetterCmd):
1727
values_to_set = [dbus.Boolean(True)]
1728
1729
1730
class TestDisableCmd(TestPropertyCmd):
2695
1731
command = command.Disable
2696
1732
propname = "Enabled"
2697
values_to_get = [False]
2698
2699
2700
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1733
values_to_set = [dbus.Boolean(False)]
1734
1735
1736
class TestBumpTimeoutCmd(TestPropertyCmd):
2701
1737
command = command.BumpTimeout
2702
1738
propname = "LastCheckedOK"
2703
values_to_get = [""]
2704
2705
2706
class TestStartCheckerCmd(TestPropertySetterCmd):
1739
values_to_set = [""]
1740
1741
1742
class TestStartCheckerCmd(TestPropertyCmd):
2707
1743
command = command.StartChecker
2708
1744
propname = "CheckerRunning"
2709
values_to_get = [True]
2710
2711
2712
class TestStopCheckerCmd(TestPropertySetterCmd):
1745
values_to_set = [dbus.Boolean(True)]
1746
1747
1748
class TestStopCheckerCmd(TestPropertyCmd):
2713
1749
command = command.StopChecker
2714
1750
propname = "CheckerRunning"
2715
values_to_get = [False]
2716
2717
2718
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1751
values_to_set = [dbus.Boolean(False)]
1752
1753
1754
class TestApproveByDefaultCmd(TestPropertyCmd):
2719
1755
command = command.ApproveByDefault
2720
1756
propname = "ApprovedByDefault"
2721
values_to_get = [True]
2722
2723
2724
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1757
values_to_set = [dbus.Boolean(True)]
1758
1759
1760
class TestDenyByDefaultCmd(TestPropertyCmd):
2725
1761
command = command.DenyByDefault
2726
1762
propname = "ApprovedByDefault"
2727
values_to_get = [False]
2728
2729
2730
class TestSetCheckerCmd(TestPropertySetterCmd):
1763
values_to_set = [dbus.Boolean(False)]
1764
1765
1766
class TestPropertyValueCmd(TestPropertyCmd):
1767
"""Abstract class for tests of PropertyValueCmd classes"""
1768
1769
def runTest(self):
1770
if type(self) is TestPropertyValueCmd:
1771
return
1772
return super(TestPropertyValueCmd, self).runTest()
1773
1774
def run_command(self, value, clients):
1775
self.command(value).run(clients, self.bus)
1776
1777
1778
class TestSetCheckerCmd(TestPropertyValueCmd):
2731
1779
command = command.SetChecker
2732
1780
propname = "Checker"
2733
1781
values_to_set = ["", ":", "fping -q -- %s"]
2734
1782
2735
1783
2736
class TestSetHostCmd(TestPropertySetterCmd):
1784
class TestSetHostCmd(TestPropertyValueCmd):
2737
1785
command = command.SetHost
2738
1786
propname = "Host"
2739
values_to_set = ["192.0.2.3", "client.example.org"]
2740
2741
2742
class TestSetSecretCmd(TestPropertySetterCmd):
1787
values_to_set = ["192.0.2.3", "foo.example.org"]
1788
1789
1790
class TestSetSecretCmd(TestPropertyValueCmd):
2743
1791
command = command.SetSecret
2744
1792
propname = "Secret"
2745
1793
values_to_set = [io.BytesIO(b""),
2746
1794
io.BytesIO(b"secret\0xyzzy\nbar")]
2747
values_to_get = [f.getvalue() for f in values_to_set]
2748
2749
2750
class TestSetTimeoutCmd(TestPropertySetterCmd):
1795
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1796
1797
1798
class TestSetTimeoutCmd(TestPropertyValueCmd):
2751
1799
command = command.SetTimeout
2752
1800
propname = "Timeout"
2753
1801
values_to_set = [datetime.timedelta(),
2755
1803
datetime.timedelta(seconds=1),
2756
1804
datetime.timedelta(weeks=1),
2757
1805
datetime.timedelta(weeks=52)]
2758
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2759
2760
2761
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1806
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1807
1808
1809
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2762
1810
command = command.SetExtendedTimeout
2763
1811
propname = "ExtendedTimeout"
2764
1812
values_to_set = [datetime.timedelta(),
2766
1814
datetime.timedelta(seconds=1),
2767
1815
datetime.timedelta(weeks=1),
2768
1816
datetime.timedelta(weeks=52)]
2769
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2770
2771
2772
class TestSetIntervalCmd(TestPropertySetterCmd):
1817
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1818
1819
1820
class TestSetIntervalCmd(TestPropertyValueCmd):
2773
1821
command = command.SetInterval
2774
1822
propname = "Interval"
2775
1823
values_to_set = [datetime.timedelta(),
2777
1825
datetime.timedelta(seconds=1),
2778
1826
datetime.timedelta(weeks=1),
2779
1827
datetime.timedelta(weeks=52)]
2780
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2781
2782
2783
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1828
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1829
1830
1831
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2784
1832
command = command.SetApprovalDelay
2785
1833
propname = "ApprovalDelay"
2786
1834
values_to_set = [datetime.timedelta(),
2788
1836
datetime.timedelta(seconds=1),
2789
1837
datetime.timedelta(weeks=1),
2790
1838
datetime.timedelta(weeks=52)]
2791
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2792
2793
2794
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1839
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1840
1841
1842
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2795
1843
command = command.SetApprovalDuration
2796
1844
propname = "ApprovalDuration"
2797
1845
values_to_set = [datetime.timedelta(),
2799
1847
datetime.timedelta(seconds=1),
2800
1848
datetime.timedelta(weeks=1),
2801
1849
datetime.timedelta(weeks=52)]
2802
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1850
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2803
1851
2804
1852
2805
1853
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0