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