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.616
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.616
- Committer: Teddy Hogeborn
- Date: 2019-03-15 21:59:44 UTC
- mto: This revision was merged to the branch mainline in revision 382.
- Revision ID: teddy@recompile.se-20190315215944-lomtn36y7o3jphp8
mandos-ctl: Refactor
* mandos-ctl (main): Call get_mandos_dbus_object() to get
"mandos_dbus_objc", and rename it to
"mandos_dbus_object".
(get_mandos_dbus_object): New.
(Test_get_mandos_dbus_object): - '' -
* mandos-ctl (main): Call get_mandos_dbus_object() to get
"mandos_dbus_objc", and rename it to
"mandos_dbus_object".
(get_mandos_dbus_object): New.
(Test_get_mandos_dbus_object): - '' -
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
81
version = "1.8.4"
67
dbus_busname_domain = "se.recompile"
68
dbus_busname = dbus_busname_domain + ".Mandos"
69
server_dbus_path = "/"
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
72
del dbus_busname_domain
73
version = "1.8.3"
74
75
76
try:
77
dbus.OBJECT_MANAGER_IFACE
78
except AttributeError:
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
82
80
83
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)
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)
100
104
101
105
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)
110
111
# Compile dict of (clientpath: properties) to process
106
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
107
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
108
with SilenceLogger("dbus.proxies"):
109
all_clients = {path: ifs_and_props[client_dbus_interface]
110
for path, ifs_and_props in
111
mandos_serv_object_manager
112
.GetManagedObjects().items()
113
if client_dbus_interface in ifs_and_props}
114
except dbus.exceptions.DBusException as e:
115
log.critical("Failed to access Mandos server through D-Bus:"
116
"\n%s", e)
117
sys.exit(1)
118
119
# Compile dict of (clients: properties) to process
120
clients = {}
121
112
122
if not clientnames:
113
123
clients = all_clients
114
124
else:
115
clients = {}
116
125
for name in clientnames:
117
126
for objpath, properties in all_clients.items():
118
127
if properties["Name"] == name:
122
131
log.critical("Client not found on server: %r", name)
123
132
sys.exit(1)
124
133
134
# Run all commands on clients
125
135
commands = commands_from_options(options)
126
127
136
for command in commands:
128
command.run(clients, bus)
137
command.run(clients, bus, mandos_serv)
129
138
130
139
131
140
def add_command_line_options(parser):
136
145
help="Select all clients")
137
146
parser.add_argument("-v", "--verbose", action="store_true",
138
147
help="Print all fields")
139
parser.add_argument("-j", "--dump-json", dest="commands",
140
action="append_const", default=[],
141
const=command.DumpJSON(),
148
parser.add_argument("-j", "--dump-json", action="store_true",
142
149
help="Dump client data in JSON format")
143
150
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(),
151
enable_disable.add_argument("-e", "--enable", action="store_true",
147
152
help="Enable client")
148
enable_disable.add_argument("-d", "--disable", dest="commands",
149
action="append_const", default=[],
150
const=command.Disable(),
153
enable_disable.add_argument("-d", "--disable",
154
action="store_true",
151
155
help="disable client")
152
parser.add_argument("-b", "--bump-timeout", dest="commands",
153
action="append_const", default=[],
154
const=command.BumpTimeout(),
156
parser.add_argument("-b", "--bump-timeout", action="store_true",
155
157
help="Bump timeout for client")
156
158
start_stop_checker = parser.add_mutually_exclusive_group()
157
159
start_stop_checker.add_argument("--start-checker",
158
dest="commands",
159
action="append_const", default=[],
160
const=command.StartChecker(),
160
action="store_true",
161
161
help="Start checker for client")
162
start_stop_checker.add_argument("--stop-checker", dest="commands",
163
action="append_const", default=[],
164
const=command.StopChecker(),
162
start_stop_checker.add_argument("--stop-checker",
163
action="store_true",
165
164
help="Stop checker for client")
166
parser.add_argument("-V", "--is-enabled", dest="commands",
167
action="append_const", default=[],
168
const=command.IsEnabled(),
165
parser.add_argument("-V", "--is-enabled", action="store_true",
169
166
help="Check if client is enabled")
170
parser.add_argument("-r", "--remove", dest="commands",
171
action="append_const", default=[],
172
const=command.Remove(),
167
parser.add_argument("-r", "--remove", action="store_true",
173
168
help="Remove client")
174
parser.add_argument("-c", "--checker", dest="commands",
175
action="append", default=[],
176
metavar="COMMAND", type=command.SetChecker,
169
parser.add_argument("-c", "--checker",
177
170
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")
171
parser.add_argument("-t", "--timeout", type=string_to_delta,
172
help="Set timeout for client")
173
parser.add_argument("--extended-timeout", type=string_to_delta,
174
help="Set extended timeout for client")
175
parser.add_argument("-i", "--interval", type=string_to_delta,
176
help="Set checker interval for client")
193
177
approve_deny_default = parser.add_mutually_exclusive_group()
194
178
approve_deny_default.add_argument(
195
"--approve-by-default", dest="commands",
196
action="append_const", default=[],
197
const=command.ApproveByDefault(),
179
"--approve-by-default", action="store_true",
180
default=None, dest="approved_by_default",
198
181
help="Set client to be approved by default")
199
182
approve_deny_default.add_argument(
200
"--deny-by-default", dest="commands",
201
action="append_const", default=[],
202
const=command.DenyByDefault(),
183
"--deny-by-default", action="store_false",
184
dest="approved_by_default",
203
185
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")
186
parser.add_argument("--approval-delay", type=string_to_delta,
187
help="Set delay before client approve/deny")
188
parser.add_argument("--approval-duration", type=string_to_delta,
189
help="Set duration of one client approval")
190
parser.add_argument("-H", "--host", help="Set host for client")
191
parser.add_argument("-s", "--secret",
192
type=argparse.FileType(mode="rb"),
193
help="Set password blob (file) for client")
223
194
approve_deny = parser.add_mutually_exclusive_group()
224
195
approve_deny.add_argument(
225
"-A", "--approve", dest="commands", action="append_const",
226
default=[], const=command.Approve(),
196
"-A", "--approve", action="store_true",
227
197
help="Approve any current client request")
228
approve_deny.add_argument("-D", "--deny", dest="commands",
229
action="append_const", default=[],
230
const=command.Deny(),
198
approve_deny.add_argument("-D", "--deny", action="store_true",
231
199
help="Deny any current client request")
232
200
parser.add_argument("--debug", action="store_true",
233
201
help="Debug mode (show D-Bus commands)")
270
238
>>> rfc3339_duration_to_delta("")
271
239
Traceback (most recent call last):
272
240
...
273
ValueError: Invalid RFC 3339 duration: ""
241
ValueError: Invalid RFC 3339 duration: u''
274
242
>>> # Must start with "P":
275
243
>>> rfc3339_duration_to_delta("1D")
276
244
Traceback (most recent call last):
277
245
...
278
ValueError: Invalid RFC 3339 duration: "1D"
246
ValueError: Invalid RFC 3339 duration: u'1D'
279
247
>>> # Must use correct order
280
248
>>> rfc3339_duration_to_delta("PT1S2M")
281
249
Traceback (most recent call last):
282
250
...
283
ValueError: Invalid RFC 3339 duration: "PT1S2M"
251
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
284
252
>>> # Time needs time marker
285
253
>>> rfc3339_duration_to_delta("P1H2S")
286
254
Traceback (most recent call last):
287
255
...
288
ValueError: Invalid RFC 3339 duration: "P1H2S"
256
ValueError: Invalid RFC 3339 duration: u'P1H2S'
289
257
>>> # Weeks can not be combined with anything else
290
258
>>> rfc3339_duration_to_delta("P1D2W")
291
259
Traceback (most recent call last):
292
260
...
293
ValueError: Invalid RFC 3339 duration: "P1D2W"
261
ValueError: Invalid RFC 3339 duration: u'P1D2W'
294
262
>>> rfc3339_duration_to_delta("P2W2H")
295
263
Traceback (most recent call last):
296
264
...
297
ValueError: Invalid RFC 3339 duration: "P2W2H"
265
ValueError: Invalid RFC 3339 duration: u'P2W2H'
298
266
"""
299
267
300
268
# Parsing an RFC 3339 duration with regular expressions is not
371
339
break
372
340
else:
373
341
# No currently valid tokens were found
374
raise ValueError("Invalid RFC 3339 duration: \"{}\""
342
raise ValueError("Invalid RFC 3339 duration: {!r}"
375
343
.format(duration))
376
344
# End token found
377
345
return value
424
392
"""Apply additional restrictions on options, not expressible in
425
393
argparse"""
426
394
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)
395
def has_actions(options):
396
return any((options.enable,
397
options.disable,
398
options.bump_timeout,
399
options.start_checker,
400
options.stop_checker,
401
options.is_enabled,
402
options.remove,
403
options.checker is not None,
404
options.timeout is not None,
405
options.extended_timeout is not None,
406
options.interval is not None,
407
options.approved_by_default is not None,
408
options.approval_delay is not None,
409
options.approval_duration is not None,
410
options.host is not None,
411
options.secret is not None,
412
options.approve,
413
options.deny))
450
414
451
if has_commands(options) and not (options.client or options.all):
415
if has_actions(options) and not (options.client or options.all):
452
416
parser.error("Options require clients names or --all.")
453
if options.verbose and has_commands(options):
417
if options.verbose and has_actions(options):
454
418
parser.error("--verbose can only be used alone.")
455
if (has_commands(options, (command.DumpJSON,))
456
and (options.verbose or len(options.commands) > 1)):
419
if options.dump_json and (options.verbose
420
or has_actions(options)):
457
421
parser.error("--dump-json can only be used alone.")
458
if options.all and not has_commands(options):
422
if options.all and not has_actions(options):
459
423
parser.error("--all requires an action.")
460
if (has_commands(options, (command.IsEnabled,))
461
and len(options.client) > 1):
424
if options.is_enabled and len(options.client) > 1:
462
425
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
426
if options.remove:
427
options.remove = False
428
if has_actions(options) and not options.deny:
429
parser.error("--remove can only be combined with --deny")
430
options.remove = True
431
432
433
def get_mandos_dbus_object(bus):
434
try:
435
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
436
dbus_busname, server_dbus_path)
437
mandos_dbus_object = bus.get_object(dbus_busname,
438
server_dbus_path)
439
except dbus.exceptions.DBusException:
440
log.critical("Could not connect to Mandos server")
441
sys.exit(1)
442
443
return mandos_dbus_object
444
445
446
class SilenceLogger(object):
447
"Simple context manager to silence a particular logger"
448
def __init__(self, loggername):
449
self.logger = logging.getLogger(loggername)
450
451
def __enter__(self):
452
self.logger.addFilter(self.nullfilter)
453
return self
454
455
class NullFilter(logging.Filter):
456
def filter(self, record):
457
return False
458
459
nullfilter = NullFilter()
460
461
def __exit__(self, exc_type, exc_val, exc_tb):
462
self.logger.removeFilter(self.nullfilter)
679
463
680
464
681
465
def commands_from_options(options):
682
466
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)
467
commands = []
468
469
if options.is_enabled:
470
commands.append(IsEnabledCmd())
471
472
if options.approve:
473
commands.append(ApproveCmd())
474
475
if options.deny:
476
commands.append(DenyCmd())
477
478
if options.remove:
479
commands.append(RemoveCmd())
480
481
if options.dump_json:
482
commands.append(DumpJSONCmd())
483
484
if options.enable:
485
commands.append(EnableCmd())
486
487
if options.disable:
488
commands.append(DisableCmd())
489
490
if options.bump_timeout:
491
commands.append(BumpTimeoutCmd())
492
493
if options.start_checker:
494
commands.append(StartCheckerCmd())
495
496
if options.stop_checker:
497
commands.append(StopCheckerCmd())
498
499
if options.approved_by_default is not None:
500
if options.approved_by_default:
501
commands.append(ApproveByDefaultCmd())
701
502
else:
702
cleaned_after.append(cmd)
703
if cleaned_after != after_remove:
704
commands = before_remove + cleaned_after
503
commands.append(DenyByDefaultCmd())
504
505
if options.checker is not None:
506
commands.append(SetCheckerCmd(options.checker))
507
508
if options.host is not None:
509
commands.append(SetHostCmd(options.host))
510
511
if options.secret is not None:
512
commands.append(SetSecretCmd(options.secret))
513
514
if options.timeout is not None:
515
commands.append(SetTimeoutCmd(options.timeout))
516
517
if options.extended_timeout:
518
commands.append(
519
SetExtendedTimeoutCmd(options.extended_timeout))
520
521
if options.interval is not None:
522
commands.append(SetIntervalCmd(options.interval))
523
524
if options.approval_delay is not None:
525
commands.append(SetApprovalDelayCmd(options.approval_delay))
526
527
if options.approval_duration is not None:
528
commands.append(
529
SetApprovalDurationCmd(options.approval_duration))
705
530
706
531
# If no command option has been given, show table of clients,
707
532
# optionally verbosely
708
533
if not commands:
709
commands.append(command.PrintTable(verbose=options.verbose))
534
commands.append(PrintTableCmd(verbose=options.verbose))
710
535
711
536
return commands
712
537
713
538
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
539
class Command(object):
540
"""Abstract class for commands"""
541
def run(self, clients, bus=None, mandos=None):
542
"""Normal commands should implement run_on_one_client(), but
543
commands which want to operate on all clients at the same time
544
can override this run() method instead."""
545
self.mandos = mandos
546
for clientpath, properties in clients.items():
547
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
548
dbus_busname, str(clientpath))
549
client = bus.get_object(dbus_busname, clientpath)
550
self.run_on_one_client(client, properties)
551
552
553
class IsEnabledCmd(Command):
554
def run(self, clients, bus=None, mandos=None):
555
client, properties = next(iter(clients.items()))
556
if self.is_enabled(client, properties):
557
sys.exit(0)
558
sys.exit(1)
559
def is_enabled(self, client, properties):
560
return properties["Enabled"]
561
562
563
class ApproveCmd(Command):
564
def run_on_one_client(self, client, properties):
565
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
566
client.__dbus_object_path__, client_dbus_interface)
567
client.Approve(dbus.Boolean(True),
568
dbus_interface=client_dbus_interface)
569
570
571
class DenyCmd(Command):
572
def run_on_one_client(self, client, properties):
573
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
574
client.__dbus_object_path__, client_dbus_interface)
575
client.Approve(dbus.Boolean(False),
576
dbus_interface=client_dbus_interface)
577
578
579
class RemoveCmd(Command):
580
def run_on_one_client(self, client, properties):
581
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
582
server_dbus_path, server_dbus_interface,
583
str(client.__dbus_object_path__))
584
self.mandos.RemoveClient(client.__dbus_object_path__)
585
586
587
class OutputCmd(Command):
588
"""Abstract class for commands outputting client details"""
589
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
590
"Created", "Interval", "Host", "KeyID",
591
"Fingerprint", "CheckerRunning", "LastEnabled",
592
"ApprovalPending", "ApprovedByDefault",
593
"LastApprovalRequest", "ApprovalDelay",
594
"ApprovalDuration", "Checker", "ExtendedTimeout",
595
"Expires", "LastCheckerStatus")
596
597
def run(self, clients, bus=None, mandos=None):
598
print(self.output(clients.values()))
599
600
def output(self, clients):
601
raise NotImplementedError()
602
603
604
class DumpJSONCmd(OutputCmd):
605
def output(self, clients):
606
data = {client["Name"]:
607
{key: self.dbus_boolean_to_bool(client[key])
608
for key in self.all_keywords}
609
for client in clients}
610
return json.dumps(data, indent=4, separators=(',', ': '))
611
612
@staticmethod
613
def dbus_boolean_to_bool(value):
614
if isinstance(value, dbus.Boolean):
615
value = bool(value)
616
return value
617
618
619
class PrintTableCmd(OutputCmd):
620
def __init__(self, verbose=False):
621
self.verbose = verbose
622
623
def output(self, clients):
624
default_keywords = ("Name", "Enabled", "Timeout",
625
"LastCheckedOK")
626
keywords = default_keywords
627
if self.verbose:
628
keywords = self.all_keywords
629
return str(self.TableOfClients(clients, keywords))
630
631
class TableOfClients(object):
632
tableheaders = {
633
"Name": "Name",
634
"Enabled": "Enabled",
635
"Timeout": "Timeout",
636
"LastCheckedOK": "Last Successful Check",
637
"LastApprovalRequest": "Last Approval Request",
638
"Created": "Created",
639
"Interval": "Interval",
640
"Host": "Host",
641
"Fingerprint": "Fingerprint",
642
"KeyID": "Key ID",
643
"CheckerRunning": "Check Is Running",
644
"LastEnabled": "Last Enabled",
645
"ApprovalPending": "Approval Is Pending",
646
"ApprovedByDefault": "Approved By Default",
647
"ApprovalDelay": "Approval Delay",
648
"ApprovalDuration": "Approval Duration",
649
"Checker": "Checker",
650
"ExtendedTimeout": "Extended Timeout",
651
"Expires": "Expires",
652
"LastCheckerStatus": "Last Checker Status",
653
}
654
655
def __init__(self, clients, keywords):
656
self.clients = clients
657
self.keywords = keywords
658
659
def __str__(self):
660
return "\n".join(self.rows())
661
662
if sys.version_info.major == 2:
663
__unicode__ = __str__
814
664
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
665
return str(self).encode(locale.getpreferredencoding())
666
667
def rows(self):
668
format_string = self.row_formatting_string()
669
rows = [self.header_line(format_string)]
670
rows.extend(self.client_line(client, format_string)
671
for client in self.clients)
672
return rows
673
674
def row_formatting_string(self):
675
"Format string used to format table rows"
676
return " ".join("{{{key}:{width}}}".format(
677
width=max(len(self.tableheaders[key]),
678
*(len(self.string_from_client(client, key))
679
for client in self.clients)),
680
key=key)
681
for key in self.keywords)
682
683
def string_from_client(self, client, key):
684
return self.valuetostring(client[key], key)
924
685
925
686
@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"
687
def valuetostring(cls, value, keyword):
688
if isinstance(value, dbus.Boolean):
689
return "Yes" if value else "No"
690
if keyword in ("Timeout", "Interval", "ApprovalDelay",
691
"ApprovalDuration", "ExtendedTimeout"):
692
return cls.milliseconds_to_string(value)
693
return str(value)
694
695
def header_line(self, format_string):
696
return format_string.format(**self.tableheaders)
697
698
def client_line(self, client, format_string):
699
return format_string.format(
700
**{key: self.string_from_client(client, key)
701
for key in self.keywords})
702
703
@staticmethod
704
def milliseconds_to_string(ms):
705
td = datetime.timedelta(0, 0, 0, ms)
706
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
707
.format(days="{}T".format(td.days)
708
if td.days else "",
709
hours=td.seconds // 3600,
710
minutes=(td.seconds % 3600) // 60,
711
seconds=td.seconds % 60))
712
713
714
class PropertyCmd(Command):
715
"""Abstract class for Actions for setting one client property"""
716
717
def run_on_one_client(self, client, properties):
718
"""Set the Client's D-Bus property"""
719
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
720
client.__dbus_object_path__,
721
dbus.PROPERTIES_IFACE, client_dbus_interface,
722
self.propname, self.value_to_set
723
if not isinstance(self.value_to_set, dbus.Boolean)
724
else bool(self.value_to_set))
725
client.Set(client_dbus_interface, self.propname,
726
self.value_to_set,
727
dbus_interface=dbus.PROPERTIES_IFACE)
728
729
@property
730
def propname(self):
731
raise NotImplementedError()
732
733
734
class EnableCmd(PropertyCmd):
735
propname = "Enabled"
736
value_to_set = dbus.Boolean(True)
737
738
739
class DisableCmd(PropertyCmd):
740
propname = "Enabled"
741
value_to_set = dbus.Boolean(False)
742
743
744
class BumpTimeoutCmd(PropertyCmd):
745
propname = "LastCheckedOK"
746
value_to_set = ""
747
748
749
class StartCheckerCmd(PropertyCmd):
750
propname = "CheckerRunning"
751
value_to_set = dbus.Boolean(True)
752
753
754
class StopCheckerCmd(PropertyCmd):
755
propname = "CheckerRunning"
756
value_to_set = dbus.Boolean(False)
757
758
759
class ApproveByDefaultCmd(PropertyCmd):
760
propname = "ApprovedByDefault"
761
value_to_set = dbus.Boolean(True)
762
763
764
class DenyByDefaultCmd(PropertyCmd):
765
propname = "ApprovedByDefault"
766
value_to_set = dbus.Boolean(False)
767
768
769
class PropertyValueCmd(PropertyCmd):
770
"""Abstract class for PropertyCmd recieving a value as argument"""
771
def __init__(self, value):
772
self.value_to_set = value
773
774
775
class SetCheckerCmd(PropertyValueCmd):
776
propname = "Checker"
777
778
779
class SetHostCmd(PropertyValueCmd):
780
propname = "Host"
781
782
783
class SetSecretCmd(PropertyValueCmd):
784
propname = "Secret"
785
786
@property
787
def value_to_set(self):
788
return self._vts
789
790
@value_to_set.setter
791
def value_to_set(self, value):
792
"""When setting, read data from supplied file object"""
793
self._vts = value.read()
794
value.close()
795
796
797
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
798
"""Abstract class for PropertyValueCmd taking a value argument as
799
a datetime.timedelta() but should store it as milliseconds."""
800
801
@property
802
def value_to_set(self):
803
return self._vts
804
805
@value_to_set.setter
806
def value_to_set(self, value):
807
"""When setting, convert value from a datetime.timedelta"""
808
self._vts = int(round(value.total_seconds() * 1000))
809
810
811
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
812
propname = "Timeout"
813
814
815
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
816
propname = "ExtendedTimeout"
817
818
819
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
820
propname = "Interval"
821
822
823
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
824
propname = "ApprovalDelay"
825
826
827
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
828
propname = "ApprovalDuration"
986
829
987
830
988
831
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"))
832
class Test_string_to_delta(unittest.TestCase):
833
def test_handles_basic_rfc3339(self):
834
self.assertEqual(string_to_delta("PT0S"),
835
datetime.timedelta())
836
self.assertEqual(string_to_delta("P0D"),
837
datetime.timedelta())
838
self.assertEqual(string_to_delta("PT1S"),
839
datetime.timedelta(0, 1))
840
self.assertEqual(string_to_delta("PT2H"),
841
datetime.timedelta(0, 7200))
1047
842
1048
843
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)
844
# assertLogs only exists in Python 3.4
845
if hasattr(self, "assertLogs"):
846
with self.assertLogs(log, logging.WARNING):
847
value = string_to_delta("2h")
848
else:
849
class WarningFilter(logging.Filter):
850
"""Don't show, but record the presence of, warnings"""
851
def filter(self, record):
852
is_warning = record.levelno >= logging.WARNING
853
self.found = is_warning or getattr(self, "found",
854
False)
855
return not is_warning
856
warning_filter = WarningFilter()
857
log.addFilter(warning_filter)
858
try:
859
value = string_to_delta("2h")
860
finally:
861
log.removeFilter(warning_filter)
862
self.assertTrue(getattr(warning_filter, "found", False))
863
self.assertEqual(value, datetime.timedelta(0, 7200))
1052
864
1053
865
1054
866
class Test_check_option_syntax(unittest.TestCase):
1058
870
1059
871
def test_actions_requires_client_or_all(self):
1060
872
for action, value in self.actions.items():
1061
args = self.actionargs(action, value)
873
options = self.parser.parse_args()
874
setattr(options, action, value)
1062
875
with self.assertParseError():
1063
self.parse_args(args)
876
self.check_option_syntax(options)
1064
877
1065
# This mostly corresponds to the definition from has_commands() in
878
# This mostly corresponds to the definition from has_actions() in
1066
879
# check_option_syntax()
1067
880
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,
881
# The actual values set here are not that important, but we do
882
# at least stick to the correct types, even though they are
883
# never used
884
"enable": True,
885
"disable": True,
886
"bump_timeout": True,
887
"start_checker": True,
888
"stop_checker": True,
889
"is_enabled": True,
890
"remove": True,
891
"checker": "x",
892
"timeout": datetime.timedelta(),
893
"extended_timeout": datetime.timedelta(),
894
"interval": datetime.timedelta(),
895
"approved_by_default": True,
896
"approval_delay": datetime.timedelta(),
897
"approval_duration": datetime.timedelta(),
898
"host": "x",
899
"secret": io.BytesIO(b"x"),
900
"approve": True,
901
"deny": True,
1087
902
}
1088
903
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
904
@contextlib.contextmanager
1097
905
def assertParseError(self):
1098
906
with self.assertRaises(SystemExit) as e:
1099
with self.redirect_stderr_to_devnull():
907
with self.temporarily_suppress_stderr():
1100
908
yield
1101
909
# Exit code from argparse is guaranteed to be "2". Reference:
1102
910
# https://docs.python.org/3/library
1103
911
# /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)
912
self.assertEqual(e.exception.code, 2)
1109
913
1110
914
@staticmethod
1111
915
@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
916
def temporarily_suppress_stderr():
917
null = os.open(os.path.devnull, os.O_RDWR)
918
stderrcopy = os.dup(sys.stderr.fileno())
919
os.dup2(null, sys.stderr.fileno())
920
os.close(null)
921
try:
922
yield
923
finally:
924
# restore stderr
925
os.dup2(stderrcopy, sys.stderr.fileno())
926
os.close(stderrcopy)
1120
927
1121
928
def check_option_syntax(self, options):
1122
929
check_option_syntax(self.parser, options)
1123
930
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)
931
def test_actions_conflicts_with_verbose(self):
932
for action, value in self.actions.items():
933
options = self.parser.parse_args()
934
setattr(options, action, value)
935
options.verbose = True
936
with self.assertParseError():
937
self.check_option_syntax(options)
1137
938
1138
939
def test_dump_json_conflicts_with_verbose(self):
1139
args = ["--dump-json", "--verbose"]
940
options = self.parser.parse_args()
941
options.dump_json = True
942
options.verbose = True
1140
943
with self.assertParseError():
1141
self.parse_args(args)
944
self.check_option_syntax(options)
1142
945
1143
946
def test_dump_json_conflicts_with_action(self):
1144
947
for action, value in self.actions.items():
1145
args = self.actionargs(action, value, "--dump-json")
948
options = self.parser.parse_args()
949
setattr(options, action, value)
950
options.dump_json = True
1146
951
with self.assertParseError():
1147
self.parse_args(args)
952
self.check_option_syntax(options)
1148
953
1149
954
def test_all_can_not_be_alone(self):
1150
args = ["--all"]
955
options = self.parser.parse_args()
956
options.all = True
1151
957
with self.assertParseError():
1152
self.parse_args(args)
958
self.check_option_syntax(options)
1153
959
1154
960
def test_all_is_ok_with_any_action(self):
1155
961
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)
962
options = self.parser.parse_args()
963
setattr(options, action, value)
964
options.all = True
965
self.check_option_syntax(options)
1186
966
1187
967
def test_is_enabled_fails_without_client(self):
1188
args = ["--is-enabled"]
968
options = self.parser.parse_args()
969
options.is_enabled = True
1189
970
with self.assertParseError():
1190
self.parse_args(args)
971
self.check_option_syntax(options)
972
973
def test_is_enabled_works_with_one_client(self):
974
options = self.parser.parse_args()
975
options.is_enabled = True
976
options.client = ["foo"]
977
self.check_option_syntax(options)
1191
978
1192
979
def test_is_enabled_fails_with_two_clients(self):
1193
args = ["--is-enabled", "client1", "client2"]
980
options = self.parser.parse_args()
981
options.is_enabled = True
982
options.client = ["foo", "barbar"]
1194
983
with self.assertParseError():
1195
self.parse_args(args)
984
self.check_option_syntax(options)
1196
985
1197
986
def test_remove_can_only_be_combined_with_action_deny(self):
1198
987
for action, value in self.actions.items():
1199
if action in {"--remove", "--deny"}:
988
if action in {"remove", "deny"}:
1200
989
continue
1201
args = self.actionargs(action, value, "--all",
1202
"--remove")
990
options = self.parser.parse_args()
991
setattr(options, action, value)
992
options.all = True
993
options.remove = True
1203
994
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
995
self.check_option_syntax(options)
996
997
998
class Test_get_mandos_dbus_object(unittest.TestCase):
999
def test_calls_and_returns_get_object_on_bus(self):
1000
class MockBus(object):
1001
called = False
1002
def get_object(mockbus_self, busname, dbus_path):
1003
# Note that "self" is still the testcase instance,
1004
# this MockBus instance is in "mockbus_self".
1005
self.assertEqual(busname, dbus_busname)
1006
self.assertEqual(dbus_path, server_dbus_path)
1007
mockbus_self.called = True
1008
return mockbus_self
1009
1010
mockbus = get_mandos_dbus_object(bus=MockBus())
1011
self.assertIsInstance(mockbus, MockBus)
1012
self.assertTrue(mockbus.called)
1013
1014
def test_logs_and_exits_on_dbus_error(self):
1015
class MockBusFailing(object):
1016
def get_object(self, busname, dbus_path):
1017
raise dbus.exceptions.DBusException("Test")
1018
1019
# assertLogs only exists in Python 3.4
1020
if hasattr(self, "assertLogs"):
1021
with self.assertLogs(log, logging.CRITICAL):
1022
with self.assertRaises(SystemExit) as e:
1023
bus = get_mandos_dbus_object(bus=MockBus())
1024
else:
1025
critical_filter = self.CriticalFilter()
1026
log.addFilter(critical_filter)
1027
try:
1028
with self.assertRaises(SystemExit) as e:
1029
get_mandos_dbus_object(bus=MockBusFailing())
1030
finally:
1031
log.removeFilter(critical_filter)
1032
self.assertTrue(critical_filter.found)
1033
if isinstance(e.exception.code, int):
1034
self.assertNotEqual(e.exception.code, 0)
1035
else:
1036
self.assertIsNotNone(e.exception.code)
1037
1038
class CriticalFilter(logging.Filter):
1039
"""Don't show, but register, critical messages"""
1040
found = False
1041
def filter(self, record):
1042
is_critical = record.levelno >= logging.CRITICAL
1043
self.found = is_critical or self.found
1044
return not is_critical
1045
1046
1047
class Test_SilenceLogger(unittest.TestCase):
1048
loggername = "mandos-ctl.Test_SilenceLogger"
1049
log = logging.getLogger(loggername)
1050
log.propagate = False
1051
log.addHandler(logging.NullHandler())
1230
1052
1231
1053
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
1054
self.counting_filter = self.CountingFilter()
1055
1056
class CountingFilter(logging.Filter):
1057
"Count number of records"
1058
count = 0
1059
def filter(self, record):
1060
self.count += 1
1061
return True
1062
1063
def test_should_filter_records_only_when_active(self):
1522
1064
try:
1523
with self.assertRaises(dbus.Error) as e:
1524
self.call_method(bus, "methodname", "busname",
1525
"objectpath", "interface")
1065
with SilenceLogger(self.loggername):
1066
self.log.addFilter(self.counting_filter)
1067
self.log.info("Filtered log message 1")
1068
self.log.info("Non-filtered message 2")
1069
self.log.info("Non-filtered message 3")
1526
1070
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)
1071
self.log.removeFilter(self.counting_filter)
1072
self.assertEqual(self.counting_filter.count, 2)
1771
1073
1772
1074
1773
1075
class Test_commands_from_options(unittest.TestCase):
1774
1775
1076
def setUp(self):
1776
1077
self.parser = argparse.ArgumentParser()
1777
1078
add_command_line_options(self.parser)
1778
1079
1779
1080
def test_is_enabled(self):
1780
self.assert_command_from_args(["--is-enabled", "client"],
1781
command.IsEnabled)
1081
self.assert_command_from_args(["--is-enabled", "foo"],
1082
IsEnabledCmd)
1782
1083
1783
def assert_command_from_args(self, args, command_cls, length=1,
1784
clients=None, **cmd_attrs):
1084
def assert_command_from_args(self, args, command_cls,
1085
**cmd_attrs):
1785
1086
"""Assert that parsing ARGS should result in an instance of
1786
1087
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1787
1088
options = self.parser.parse_args(args)
1788
1089
check_option_syntax(self.parser, options)
1789
1090
commands = commands_from_options(options)
1790
self.assertEqual(length, len(commands))
1791
for command in commands:
1792
if isinstance(command, command_cls):
1793
break
1794
else:
1795
self.assertIsInstance(command, command_cls)
1796
if clients is not None:
1797
self.assertEqual(clients, options.client)
1091
self.assertEqual(len(commands), 1)
1092
command = commands[0]
1093
self.assertIsInstance(command, command_cls)
1798
1094
for key, value in cmd_attrs.items():
1799
self.assertEqual(value, getattr(command, key))
1800
1801
def assert_commands_from_args(self, args, commands, clients=None):
1802
for cmd in commands:
1803
self.assert_command_from_args(args, cmd,
1804
length=len(commands),
1805
clients=clients)
1095
self.assertEqual(getattr(command, key), value)
1806
1096
1807
1097
def test_is_enabled_short(self):
1808
self.assert_command_from_args(["-V", "client"],
1809
command.IsEnabled)
1098
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1810
1099
1811
1100
def test_approve(self):
1812
self.assert_command_from_args(["--approve", "client"],
1813
command.Approve)
1101
self.assert_command_from_args(["--approve", "foo"],
1102
ApproveCmd)
1814
1103
1815
1104
def test_approve_short(self):
1816
self.assert_command_from_args(["-A", "client"],
1817
command.Approve)
1105
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1818
1106
1819
1107
def test_deny(self):
1820
self.assert_command_from_args(["--deny", "client"],
1821
command.Deny)
1108
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1822
1109
1823
1110
def test_deny_short(self):
1824
self.assert_command_from_args(["-D", "client"], command.Deny)
1111
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1825
1112
1826
1113
def test_remove(self):
1827
self.assert_command_from_args(["--remove", "client"],
1828
command.Remove)
1114
self.assert_command_from_args(["--remove", "foo"],
1115
RemoveCmd)
1829
1116
1830
1117
def test_deny_before_remove(self):
1831
1118
options = self.parser.parse_args(["--deny", "--remove",
1832
"client"])
1119
"foo"])
1833
1120
check_option_syntax(self.parser, options)
1834
1121
commands = commands_from_options(options)
1835
self.assertEqual(2, len(commands))
1836
self.assertIsInstance(commands[0], command.Deny)
1837
self.assertIsInstance(commands[1], command.Remove)
1122
self.assertEqual(len(commands), 2)
1123
self.assertIsInstance(commands[0], DenyCmd)
1124
self.assertIsInstance(commands[1], RemoveCmd)
1838
1125
1839
1126
def test_deny_before_remove_reversed(self):
1840
1127
options = self.parser.parse_args(["--remove", "--deny",
1841
1128
"--all"])
1842
1129
check_option_syntax(self.parser, options)
1843
1130
commands = commands_from_options(options)
1844
self.assertEqual(2, len(commands))
1845
self.assertIsInstance(commands[0], command.Deny)
1846
self.assertIsInstance(commands[1], command.Remove)
1131
self.assertEqual(len(commands), 2)
1132
self.assertIsInstance(commands[0], DenyCmd)
1133
self.assertIsInstance(commands[1], RemoveCmd)
1847
1134
1848
1135
def test_remove_short(self):
1849
self.assert_command_from_args(["-r", "client"],
1850
command.Remove)
1136
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1851
1137
1852
1138
def test_dump_json(self):
1853
self.assert_command_from_args(["--dump-json"],
1854
command.DumpJSON)
1139
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1855
1140
1856
1141
def test_enable(self):
1857
self.assert_command_from_args(["--enable", "client"],
1858
command.Enable)
1142
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1859
1143
1860
1144
def test_enable_short(self):
1861
self.assert_command_from_args(["-e", "client"],
1862
command.Enable)
1145
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1863
1146
1864
1147
def test_disable(self):
1865
self.assert_command_from_args(["--disable", "client"],
1866
command.Disable)
1148
self.assert_command_from_args(["--disable", "foo"],
1149
DisableCmd)
1867
1150
1868
1151
def test_disable_short(self):
1869
self.assert_command_from_args(["-d", "client"],
1870
command.Disable)
1152
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1871
1153
1872
1154
def test_bump_timeout(self):
1873
self.assert_command_from_args(["--bump-timeout", "client"],
1874
command.BumpTimeout)
1155
self.assert_command_from_args(["--bump-timeout", "foo"],
1156
BumpTimeoutCmd)
1875
1157
1876
1158
def test_bump_timeout_short(self):
1877
self.assert_command_from_args(["-b", "client"],
1878
command.BumpTimeout)
1159
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1879
1160
1880
1161
def test_start_checker(self):
1881
self.assert_command_from_args(["--start-checker", "client"],
1882
command.StartChecker)
1162
self.assert_command_from_args(["--start-checker", "foo"],
1163
StartCheckerCmd)
1883
1164
1884
1165
def test_stop_checker(self):
1885
self.assert_command_from_args(["--stop-checker", "client"],
1886
command.StopChecker)
1166
self.assert_command_from_args(["--stop-checker", "foo"],
1167
StopCheckerCmd)
1887
1168
1888
1169
def test_approve_by_default(self):
1889
self.assert_command_from_args(["--approve-by-default",
1890
"client"],
1891
command.ApproveByDefault)
1170
self.assert_command_from_args(["--approve-by-default", "foo"],
1171
ApproveByDefaultCmd)
1892
1172
1893
1173
def test_deny_by_default(self):
1894
self.assert_command_from_args(["--deny-by-default", "client"],
1895
command.DenyByDefault)
1174
self.assert_command_from_args(["--deny-by-default", "foo"],
1175
DenyByDefaultCmd)
1896
1176
1897
1177
def test_checker(self):
1898
self.assert_command_from_args(["--checker", ":", "client"],
1899
command.SetChecker,
1900
value_to_set=":")
1178
self.assert_command_from_args(["--checker", ":", "foo"],
1179
SetCheckerCmd, value_to_set=":")
1901
1180
1902
1181
def test_checker_empty(self):
1903
self.assert_command_from_args(["--checker", "", "client"],
1904
command.SetChecker,
1905
value_to_set="")
1182
self.assert_command_from_args(["--checker", "", "foo"],
1183
SetCheckerCmd, value_to_set="")
1906
1184
1907
1185
def test_checker_short(self):
1908
self.assert_command_from_args(["-c", ":", "client"],
1909
command.SetChecker,
1910
value_to_set=":")
1186
self.assert_command_from_args(["-c", ":", "foo"],
1187
SetCheckerCmd, value_to_set=":")
1911
1188
1912
1189
def test_host(self):
1913
self.assert_command_from_args(
1914
["--host", "client.example.org", "client"],
1915
command.SetHost, value_to_set="client.example.org")
1190
self.assert_command_from_args(["--host", "foo.example.org",
1191
"foo"], SetHostCmd,
1192
value_to_set="foo.example.org")
1916
1193
1917
1194
def test_host_short(self):
1918
self.assert_command_from_args(
1919
["-H", "client.example.org", "client"], command.SetHost,
1920
value_to_set="client.example.org")
1195
self.assert_command_from_args(["-H", "foo.example.org",
1196
"foo"], SetHostCmd,
1197
value_to_set="foo.example.org")
1921
1198
1922
1199
def test_secret_devnull(self):
1923
1200
self.assert_command_from_args(["--secret", os.path.devnull,
1924
"client"], command.SetSecret,
1201
"foo"], SetSecretCmd,
1925
1202
value_to_set=b"")
1926
1203
1927
1204
def test_secret_tempfile(self):
1930
1207
f.write(value)
1931
1208
f.seek(0)
1932
1209
self.assert_command_from_args(["--secret", f.name,
1933
"client"],
1934
command.SetSecret,
1210
"foo"], SetSecretCmd,
1935
1211
value_to_set=value)
1936
1212
1937
1213
def test_secret_devnull_short(self):
1938
self.assert_command_from_args(["-s", os.path.devnull,
1939
"client"], command.SetSecret,
1940
value_to_set=b"")
1214
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1215
SetSecretCmd, value_to_set=b"")
1941
1216
1942
1217
def test_secret_tempfile_short(self):
1943
1218
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1944
1219
value = b"secret\0xyzzy\nbar"
1945
1220
f.write(value)
1946
1221
f.seek(0)
1947
self.assert_command_from_args(["-s", f.name, "client"],
1948
command.SetSecret,
1222
self.assert_command_from_args(["-s", f.name, "foo"],
1223
SetSecretCmd,
1949
1224
value_to_set=value)
1950
1225
1951
1226
def test_timeout(self):
1952
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1953
command.SetTimeout,
1227
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1228
SetTimeoutCmd,
1954
1229
value_to_set=300000)
1955
1230
1956
1231
def test_timeout_short(self):
1957
self.assert_command_from_args(["-t", "PT5M", "client"],
1958
command.SetTimeout,
1232
self.assert_command_from_args(["-t", "PT5M", "foo"],
1233
SetTimeoutCmd,
1959
1234
value_to_set=300000)
1960
1235
1961
1236
def test_extended_timeout(self):
1962
1237
self.assert_command_from_args(["--extended-timeout", "PT15M",
1963
"client"],
1964
command.SetExtendedTimeout,
1238
"foo"],
1239
SetExtendedTimeoutCmd,
1965
1240
value_to_set=900000)
1966
1241
1967
1242
def test_interval(self):
1968
self.assert_command_from_args(["--interval", "PT2M",
1969
"client"], command.SetInterval,
1243
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1244
SetIntervalCmd,
1970
1245
value_to_set=120000)
1971
1246
1972
1247
def test_interval_short(self):
1973
self.assert_command_from_args(["-i", "PT2M", "client"],
1974
command.SetInterval,
1248
self.assert_command_from_args(["-i", "PT2M", "foo"],
1249
SetIntervalCmd,
1975
1250
value_to_set=120000)
1976
1251
1977
1252
def test_approval_delay(self):
1978
1253
self.assert_command_from_args(["--approval-delay", "PT30S",
1979
"client"],
1980
command.SetApprovalDelay,
1254
"foo"], SetApprovalDelayCmd,
1981
1255
value_to_set=30000)
1982
1256
1983
1257
def test_approval_duration(self):
1984
1258
self.assert_command_from_args(["--approval-duration", "PT1S",
1985
"client"],
1986
command.SetApprovalDuration,
1259
"foo"], SetApprovalDurationCmd,
1987
1260
value_to_set=1000)
1988
1261
1989
1262
def test_print_table(self):
1990
self.assert_command_from_args([], command.PrintTable,
1263
self.assert_command_from_args([], PrintTableCmd,
1991
1264
verbose=False)
1992
1265
1993
1266
def test_print_table_verbose(self):
1994
self.assert_command_from_args(["--verbose"],
1995
command.PrintTable,
1267
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1996
1268
verbose=True)
1997
1269
1998
1270
def test_print_table_verbose_short(self):
1999
self.assert_command_from_args(["-v"], command.PrintTable,
2000
verbose=True)
2001
2002
2003
def test_manual_page_example_1(self):
2004
self.assert_command_from_args("--verbose".split(),
2005
command.PrintTable,
2006
clients=[],
2007
verbose=True)
2008
2009
def test_manual_page_example_2(self):
2010
self.assert_command_from_args(
2011
"--verbose foo1.example.org foo2.example.org".split(),
2012
command.PrintTable, clients=["foo1.example.org",
2013
"foo2.example.org"],
2014
verbose=True)
2015
2016
def test_manual_page_example_3(self):
2017
self.assert_command_from_args("--enable --all".split(),
2018
command.Enable,
2019
clients=[])
2020
2021
def test_manual_page_example_4(self):
2022
self.assert_commands_from_args(
2023
("--timeout=PT5M --interval=PT1M foo1.example.org"
2024
" foo2.example.org").split(),
2025
[command.SetTimeout, command.SetInterval],
2026
clients=["foo1.example.org", "foo2.example.org"])
2027
2028
def test_manual_page_example_5(self):
2029
self.assert_command_from_args("--approve --all".split(),
2030
command.Approve,
2031
clients=[])
2032
2033
2034
class TestCommand(unittest.TestCase):
1271
self.assert_command_from_args(["-v"], PrintTableCmd,
1272
verbose=True)
1273
1274
1275
class TestCmd(unittest.TestCase):
2035
1276
"""Abstract class for tests of command classes"""
2036
1277
2037
class FakeMandosBus(dbus.MandosBus):
2038
def __init__(self, testcase):
2039
self.client_properties = {
1278
def setUp(self):
1279
testcase = self
1280
class MockClient(object):
1281
def __init__(self, name, **attributes):
1282
self.__dbus_object_path__ = "/clients/{}".format(name)
1283
self.attributes = attributes
1284
self.attributes["Name"] = name
1285
self.calls = []
1286
def Set(self, interface, propname, value, dbus_interface):
1287
testcase.assertEqual(interface, client_dbus_interface)
1288
testcase.assertEqual(dbus_interface,
1289
dbus.PROPERTIES_IFACE)
1290
self.attributes[propname] = value
1291
def Get(self, interface, propname, dbus_interface):
1292
testcase.assertEqual(interface, client_dbus_interface)
1293
testcase.assertEqual(dbus_interface,
1294
dbus.PROPERTIES_IFACE)
1295
return self.attributes[propname]
1296
def Approve(self, approve, dbus_interface):
1297
testcase.assertEqual(dbus_interface,
1298
client_dbus_interface)
1299
self.calls.append(("Approve", (approve,
1300
dbus_interface)))
1301
self.client = MockClient(
1302
"foo",
1303
KeyID=("92ed150794387c03ce684574b1139a65"
1304
"94a34f895daaaf09fd8ea90a27cddb12"),
1305
Secret=b"secret",
1306
Host="foo.example.org",
1307
Enabled=dbus.Boolean(True),
1308
Timeout=300000,
1309
LastCheckedOK="2019-02-03T00:00:00",
1310
Created="2019-01-02T00:00:00",
1311
Interval=120000,
1312
Fingerprint=("778827225BA7DE539C5A"
1313
"7CFA59CFF7CDBD9A5920"),
1314
CheckerRunning=dbus.Boolean(False),
1315
LastEnabled="2019-01-03T00:00:00",
1316
ApprovalPending=dbus.Boolean(False),
1317
ApprovedByDefault=dbus.Boolean(True),
1318
LastApprovalRequest="",
1319
ApprovalDelay=0,
1320
ApprovalDuration=1000,
1321
Checker="fping -q -- %(host)s",
1322
ExtendedTimeout=900000,
1323
Expires="2019-02-04T00:00:00",
1324
LastCheckerStatus=0)
1325
self.other_client = MockClient(
1326
"barbar",
1327
KeyID=("0558568eedd67d622f5c83b35a115f79"
1328
"6ab612cff5ad227247e46c2b020f441c"),
1329
Secret=b"secretbar",
1330
Host="192.0.2.3",
1331
Enabled=dbus.Boolean(True),
1332
Timeout=300000,
1333
LastCheckedOK="2019-02-04T00:00:00",
1334
Created="2019-01-03T00:00:00",
1335
Interval=120000,
1336
Fingerprint=("3E393AEAEFB84C7E89E2"
1337
"F547B3A107558FCA3A27"),
1338
CheckerRunning=dbus.Boolean(True),
1339
LastEnabled="2019-01-04T00:00:00",
1340
ApprovalPending=dbus.Boolean(False),
1341
ApprovedByDefault=dbus.Boolean(False),
1342
LastApprovalRequest="2019-01-03T00:00:00",
1343
ApprovalDelay=30000,
1344
ApprovalDuration=93785000,
1345
Checker=":",
1346
ExtendedTimeout=900000,
1347
Expires="2019-02-05T00:00:00",
1348
LastCheckerStatus=-2)
1349
self.clients = collections.OrderedDict(
1350
[
1351
("/clients/foo", self.client.attributes),
1352
("/clients/barbar", self.other_client.attributes),
1353
])
1354
self.one_client = {"/clients/foo": self.client.attributes}
1355
1356
@property
1357
def bus(self):
1358
class Bus(object):
1359
@staticmethod
1360
def get_object(client_bus_name, path):
1361
self.assertEqual(client_bus_name, dbus_busname)
1362
return {
1363
# Note: "self" here is the TestCmd instance, not
1364
# the Bus instance, since this is a static method!
1365
"/clients/foo": self.client,
1366
"/clients/barbar": self.other_client,
1367
}[path]
1368
return Bus()
1369
1370
1371
class TestIsEnabledCmd(TestCmd):
1372
def test_is_enabled(self):
1373
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1374
properties)
1375
for client, properties
1376
in self.clients.items()))
1377
1378
def test_is_enabled_run_exits_successfully(self):
1379
with self.assertRaises(SystemExit) as e:
1380
IsEnabledCmd().run(self.one_client)
1381
if e.exception.code is not None:
1382
self.assertEqual(e.exception.code, 0)
1383
else:
1384
self.assertIsNone(e.exception.code)
1385
1386
def test_is_enabled_run_exits_with_failure(self):
1387
self.client.attributes["Enabled"] = dbus.Boolean(False)
1388
with self.assertRaises(SystemExit) as e:
1389
IsEnabledCmd().run(self.one_client)
1390
if isinstance(e.exception.code, int):
1391
self.assertNotEqual(e.exception.code, 0)
1392
else:
1393
self.assertIsNotNone(e.exception.code)
1394
1395
1396
class TestApproveCmd(TestCmd):
1397
def test_approve(self):
1398
ApproveCmd().run(self.clients, self.bus)
1399
for clientpath in self.clients:
1400
client = self.bus.get_object(dbus_busname, clientpath)
1401
self.assertIn(("Approve", (True, client_dbus_interface)),
1402
client.calls)
1403
1404
1405
class TestDenyCmd(TestCmd):
1406
def test_deny(self):
1407
DenyCmd().run(self.clients, self.bus)
1408
for clientpath in self.clients:
1409
client = self.bus.get_object(dbus_busname, clientpath)
1410
self.assertIn(("Approve", (False, client_dbus_interface)),
1411
client.calls)
1412
1413
1414
class TestRemoveCmd(TestCmd):
1415
def test_remove(self):
1416
class MockMandos(object):
1417
def __init__(self):
1418
self.calls = []
1419
def RemoveClient(self, dbus_path):
1420
self.calls.append(("RemoveClient", (dbus_path,)))
1421
mandos = MockMandos()
1422
super(TestRemoveCmd, self).setUp()
1423
RemoveCmd().run(self.clients, self.bus, mandos)
1424
self.assertEqual(len(mandos.calls), 2)
1425
for clientpath in self.clients:
1426
self.assertIn(("RemoveClient", (clientpath,)),
1427
mandos.calls)
1428
1429
1430
class TestDumpJSONCmd(TestCmd):
1431
def setUp(self):
1432
self.expected_json = {
1433
"foo": {
2040
1434
"Name": "foo",
2041
1435
"KeyID": ("92ed150794387c03ce684574b1139a65"
2042
1436
"94a34f895daaaf09fd8ea90a27cddb12"),
2043
"Secret": b"secret",
2044
1437
"Host": "foo.example.org",
2045
1438
"Enabled": True,
2046
1439
"Timeout": 300000,
2060
1453
"ExtendedTimeout": 900000,
2061
1454
"Expires": "2019-02-04T00:00:00",
2062
1455
"LastCheckerStatus": 0,
2063
}
2064
self.other_client_properties = {
1456
},
1457
"barbar": {
2065
1458
"Name": "barbar",
2066
1459
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2067
1460
"6ab612cff5ad227247e46c2b020f441c"),
2068
"Secret": b"secretbar",
2069
1461
"Host": "192.0.2.3",
2070
1462
"Enabled": True,
2071
1463
"Timeout": 300000,
2085
1477
"ExtendedTimeout": 900000,
2086
1478
"Expires": "2019-02-05T00:00:00",
2087
1479
"LastCheckerStatus": -2,
2088
}
2089
self.clients = collections.OrderedDict(
2090
[
2091
("client_objectpath", self.client_properties),
2092
("other_client_objectpath",
2093
self.other_client_properties),
2094
])
2095
self.one_client = {"client_objectpath":
2096
self.client_properties}
2097
self.testcase = testcase
2098
self.calls = []
2099
2100
def call_method(self, methodname, busname, objectpath,
2101
interface, *args):
2102
self.testcase.assertEqual("se.recompile.Mandos", busname)
2103
self.calls.append((methodname, busname, objectpath,
2104
interface, args))
2105
if interface == "org.freedesktop.DBus.Properties":
2106
if methodname == "Set":
2107
self.testcase.assertEqual(3, len(args))
2108
interface, key, value = args
2109
self.testcase.assertEqual(
2110
"se.recompile.Mandos.Client", interface)
2111
self.clients[objectpath][key] = value
2112
return
2113
elif interface == "se.recompile.Mandos":
2114
self.testcase.assertEqual("RemoveClient", methodname)
2115
self.testcase.assertEqual(1, len(args))
2116
clientpath = args[0]
2117
del self.clients[clientpath]
2118
return
2119
elif interface == "se.recompile.Mandos.Client":
2120
if methodname == "Approve":
2121
self.testcase.assertEqual(1, len(args))
2122
return
2123
raise ValueError()
2124
2125
def setUp(self):
2126
self.bus = self.FakeMandosBus(self)
2127
2128
2129
class TestBaseCommands(TestCommand):
2130
2131
def test_IsEnabled_exits_successfully(self):
2132
with self.assertRaises(SystemExit) as e:
2133
command.IsEnabled().run(self.bus.one_client)
2134
if e.exception.code is not None:
2135
self.assertEqual(0, e.exception.code)
2136
else:
2137
self.assertIsNone(e.exception.code)
2138
2139
def test_IsEnabled_exits_with_failure(self):
2140
self.bus.client_properties["Enabled"] = False
2141
with self.assertRaises(SystemExit) as e:
2142
command.IsEnabled().run(self.bus.one_client)
2143
if isinstance(e.exception.code, int):
2144
self.assertNotEqual(0, e.exception.code)
2145
else:
2146
self.assertIsNotNone(e.exception.code)
2147
2148
def test_Approve(self):
2149
busname = "se.recompile.Mandos"
2150
client_interface = "se.recompile.Mandos.Client"
2151
command.Approve().run(self.bus.clients, self.bus)
2152
for clientpath in self.bus.clients:
2153
self.assertIn(("Approve", busname, clientpath,
2154
client_interface, (True,)), self.bus.calls)
2155
2156
def test_Deny(self):
2157
busname = "se.recompile.Mandos"
2158
client_interface = "se.recompile.Mandos.Client"
2159
command.Deny().run(self.bus.clients, self.bus)
2160
for clientpath in self.bus.clients:
2161
self.assertIn(("Approve", busname, clientpath,
2162
client_interface, (False,)),
2163
self.bus.calls)
2164
2165
def test_Remove(self):
2166
command.Remove().run(self.bus.clients, self.bus)
2167
for clientpath in self.bus.clients:
2168
self.assertIn(("RemoveClient", dbus_busname,
2169
dbus_server_path, dbus_server_interface,
2170
(clientpath,)), self.bus.calls)
2171
2172
expected_json = {
2173
"foo": {
2174
"Name": "foo",
2175
"KeyID": ("92ed150794387c03ce684574b1139a65"
2176
"94a34f895daaaf09fd8ea90a27cddb12"),
2177
"Host": "foo.example.org",
2178
"Enabled": True,
2179
"Timeout": 300000,
2180
"LastCheckedOK": "2019-02-03T00:00:00",
2181
"Created": "2019-01-02T00:00:00",
2182
"Interval": 120000,
2183
"Fingerprint": ("778827225BA7DE539C5A"
2184
"7CFA59CFF7CDBD9A5920"),
2185
"CheckerRunning": False,
2186
"LastEnabled": "2019-01-03T00:00:00",
2187
"ApprovalPending": False,
2188
"ApprovedByDefault": True,
2189
"LastApprovalRequest": "",
2190
"ApprovalDelay": 0,
2191
"ApprovalDuration": 1000,
2192
"Checker": "fping -q -- %(host)s",
2193
"ExtendedTimeout": 900000,
2194
"Expires": "2019-02-04T00:00:00",
2195
"LastCheckerStatus": 0,
2196
},
2197
"barbar": {
2198
"Name": "barbar",
2199
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2200
"6ab612cff5ad227247e46c2b020f441c"),
2201
"Host": "192.0.2.3",
2202
"Enabled": True,
2203
"Timeout": 300000,
2204
"LastCheckedOK": "2019-02-04T00:00:00",
2205
"Created": "2019-01-03T00:00:00",
2206
"Interval": 120000,
2207
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2208
"F547B3A107558FCA3A27"),
2209
"CheckerRunning": True,
2210
"LastEnabled": "2019-01-04T00:00:00",
2211
"ApprovalPending": False,
2212
"ApprovedByDefault": False,
2213
"LastApprovalRequest": "2019-01-03T00:00:00",
2214
"ApprovalDelay": 30000,
2215
"ApprovalDuration": 93785000,
2216
"Checker": ":",
2217
"ExtendedTimeout": 900000,
2218
"Expires": "2019-02-05T00:00:00",
2219
"LastCheckerStatus": -2,
2220
},
2221
}
2222
2223
def test_DumpJSON_normal(self):
2224
with self.capture_stdout_to_buffer() as buffer:
2225
command.DumpJSON().run(self.bus.clients)
2226
json_data = json.loads(buffer.getvalue())
2227
self.assertDictEqual(self.expected_json, json_data)
2228
2229
@staticmethod
2230
@contextlib.contextmanager
2231
def capture_stdout_to_buffer():
2232
capture_buffer = io.StringIO()
2233
old_stdout = sys.stdout
2234
sys.stdout = capture_buffer
2235
try:
2236
yield capture_buffer
2237
finally:
2238
sys.stdout = old_stdout
2239
2240
def test_DumpJSON_one_client(self):
2241
with self.capture_stdout_to_buffer() as buffer:
2242
command.DumpJSON().run(self.bus.one_client)
2243
json_data = json.loads(buffer.getvalue())
1480
},
1481
}
1482
return super(TestDumpJSONCmd, self).setUp()
1483
1484
def test_normal(self):
1485
output = DumpJSONCmd().output(self.clients.values())
1486
json_data = json.loads(output)
1487
self.assertDictEqual(json_data, self.expected_json)
1488
1489
def test_one_client(self):
1490
output = DumpJSONCmd().output(self.one_client.values())
1491
json_data = json.loads(output)
2244
1492
expected_json = {"foo": self.expected_json["foo"]}
2245
self.assertDictEqual(expected_json, json_data)
2246
2247
def test_PrintTable_normal(self):
2248
with self.capture_stdout_to_buffer() as buffer:
2249
command.PrintTable().run(self.bus.clients)
1493
self.assertDictEqual(json_data, expected_json)
1494
1495
1496
class TestPrintTableCmd(TestCmd):
1497
def test_normal(self):
1498
output = PrintTableCmd().output(self.clients.values())
2250
1499
expected_output = "\n".join((
2251
1500
"Name Enabled Timeout Last Successful Check",
2252
1501
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2253
1502
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
2254
)) + "\n"
2255
self.assertEqual(expected_output, buffer.getvalue())
1503
))
1504
self.assertEqual(output, expected_output)
2256
1505
2257
def test_PrintTable_verbose(self):
2258
with self.capture_stdout_to_buffer() as buffer:
2259
command.PrintTable(verbose=True).run(self.bus.clients)
1506
def test_verbose(self):
1507
output = PrintTableCmd(verbose=True).output(
1508
self.clients.values())
2260
1509
columns = (
2261
1510
(
2262
1511
"Name ",
2344
1593
)
2345
1594
)
2346
1595
num_lines = max(len(rows) for rows in columns)
2347
expected_output = ("\n".join("".join(rows[line]
2348
for rows in columns)
2349
for line in range(num_lines))
2350
+ "\n")
2351
self.assertEqual(expected_output, buffer.getvalue())
1596
expected_output = "\n".join("".join(rows[line]
1597
for rows in columns)
1598
for line in range(num_lines))
1599
self.assertEqual(output, expected_output)
2352
1600
2353
def test_PrintTable_one_client(self):
2354
with self.capture_stdout_to_buffer() as buffer:
2355
command.PrintTable().run(self.bus.one_client)
1601
def test_one_client(self):
1602
output = PrintTableCmd().output(self.one_client.values())
2356
1603
expected_output = "\n".join((
2357
1604
"Name Enabled Timeout Last Successful Check",
2358
1605
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2359
)) + "\n"
2360
self.assertEqual(expected_output, buffer.getvalue())
2361
2362
2363
class TestPropertySetterCmd(TestCommand):
2364
"""Abstract class for tests of command.PropertySetter classes"""
2365
1606
))
1607
self.assertEqual(output, expected_output)
1608
1609
1610
class TestPropertyCmd(TestCmd):
1611
"""Abstract class for tests of PropertyCmd classes"""
2366
1612
def runTest(self):
2367
1613
if not hasattr(self, "command"):
2368
return # Abstract TestCase class
2369
2370
if hasattr(self, "values_to_set"):
2371
cmd_args = [(value,) for value in self.values_to_set]
2372
values_to_get = getattr(self, "values_to_get",
2373
self.values_to_set)
2374
else:
2375
cmd_args = [() for x in range(len(self.values_to_get))]
2376
values_to_get = self.values_to_get
2377
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2378
for clientpath in self.bus.clients:
2379
self.bus.clients[clientpath][self.propname] = (
2380
Unique())
2381
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2382
for clientpath in self.bus.clients:
2383
value = (self.bus.clients[clientpath]
2384
[self.propname])
2385
self.assertNotIsInstance(value, Unique)
2386
self.assertEqual(value_to_get, value)
2387
2388
2389
class TestEnableCmd(TestPropertySetterCmd):
2390
command = command.Enable
2391
propname = "Enabled"
2392
values_to_get = [True]
2393
2394
2395
class TestDisableCmd(TestPropertySetterCmd):
2396
command = command.Disable
2397
propname = "Enabled"
2398
values_to_get = [False]
2399
2400
2401
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2402
command = command.BumpTimeout
1614
return
1615
values_to_get = getattr(self, "values_to_get",
1616
self.values_to_set)
1617
for value_to_set, value_to_get in zip(self.values_to_set,
1618
values_to_get):
1619
for clientpath in self.clients:
1620
client = self.bus.get_object(dbus_busname, clientpath)
1621
old_value = client.attributes[self.propname]
1622
self.assertNotIsInstance(old_value, self.Unique)
1623
client.attributes[self.propname] = self.Unique()
1624
self.run_command(value_to_set, self.clients)
1625
for clientpath in self.clients:
1626
client = self.bus.get_object(dbus_busname, clientpath)
1627
value = client.attributes[self.propname]
1628
self.assertNotIsInstance(value, self.Unique)
1629
self.assertEqual(value, value_to_get)
1630
1631
class Unique(object):
1632
"""Class for objects which exist only to be unique objects,
1633
since unittest.mock.sentinel only exists in Python 3.3"""
1634
1635
def run_command(self, value, clients):
1636
self.command().run(clients, self.bus)
1637
1638
1639
class TestEnableCmd(TestPropertyCmd):
1640
command = EnableCmd
1641
propname = "Enabled"
1642
values_to_set = [dbus.Boolean(True)]
1643
1644
1645
class TestDisableCmd(TestPropertyCmd):
1646
command = DisableCmd
1647
propname = "Enabled"
1648
values_to_set = [dbus.Boolean(False)]
1649
1650
1651
class TestBumpTimeoutCmd(TestPropertyCmd):
1652
command = BumpTimeoutCmd
2403
1653
propname = "LastCheckedOK"
2404
values_to_get = [""]
2405
2406
2407
class TestStartCheckerCmd(TestPropertySetterCmd):
2408
command = command.StartChecker
2409
propname = "CheckerRunning"
2410
values_to_get = [True]
2411
2412
2413
class TestStopCheckerCmd(TestPropertySetterCmd):
2414
command = command.StopChecker
2415
propname = "CheckerRunning"
2416
values_to_get = [False]
2417
2418
2419
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2420
command = command.ApproveByDefault
2421
propname = "ApprovedByDefault"
2422
values_to_get = [True]
2423
2424
2425
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2426
command = command.DenyByDefault
2427
propname = "ApprovedByDefault"
2428
values_to_get = [False]
2429
2430
2431
class TestSetCheckerCmd(TestPropertySetterCmd):
2432
command = command.SetChecker
1654
values_to_set = [""]
1655
1656
1657
class TestStartCheckerCmd(TestPropertyCmd):
1658
command = StartCheckerCmd
1659
propname = "CheckerRunning"
1660
values_to_set = [dbus.Boolean(True)]
1661
1662
1663
class TestStopCheckerCmd(TestPropertyCmd):
1664
command = StopCheckerCmd
1665
propname = "CheckerRunning"
1666
values_to_set = [dbus.Boolean(False)]
1667
1668
1669
class TestApproveByDefaultCmd(TestPropertyCmd):
1670
command = ApproveByDefaultCmd
1671
propname = "ApprovedByDefault"
1672
values_to_set = [dbus.Boolean(True)]
1673
1674
1675
class TestDenyByDefaultCmd(TestPropertyCmd):
1676
command = DenyByDefaultCmd
1677
propname = "ApprovedByDefault"
1678
values_to_set = [dbus.Boolean(False)]
1679
1680
1681
class TestPropertyValueCmd(TestPropertyCmd):
1682
"""Abstract class for tests of PropertyValueCmd classes"""
1683
1684
def runTest(self):
1685
if type(self) is TestPropertyValueCmd:
1686
return
1687
return super(TestPropertyValueCmd, self).runTest()
1688
1689
def run_command(self, value, clients):
1690
self.command(value).run(clients, self.bus)
1691
1692
1693
class TestSetCheckerCmd(TestPropertyValueCmd):
1694
command = SetCheckerCmd
2433
1695
propname = "Checker"
2434
1696
values_to_set = ["", ":", "fping -q -- %s"]
2435
1697
2436
1698
2437
class TestSetHostCmd(TestPropertySetterCmd):
2438
command = command.SetHost
1699
class TestSetHostCmd(TestPropertyValueCmd):
1700
command = SetHostCmd
2439
1701
propname = "Host"
2440
values_to_set = ["192.0.2.3", "client.example.org"]
2441
2442
2443
class TestSetSecretCmd(TestPropertySetterCmd):
2444
command = command.SetSecret
1702
values_to_set = ["192.0.2.3", "foo.example.org"]
1703
1704
1705
class TestSetSecretCmd(TestPropertyValueCmd):
1706
command = SetSecretCmd
2445
1707
propname = "Secret"
2446
1708
values_to_set = [io.BytesIO(b""),
2447
1709
io.BytesIO(b"secret\0xyzzy\nbar")]
2448
values_to_get = [f.getvalue() for f in values_to_set]
2449
2450
2451
class TestSetTimeoutCmd(TestPropertySetterCmd):
2452
command = command.SetTimeout
1710
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1711
1712
1713
class TestSetTimeoutCmd(TestPropertyValueCmd):
1714
command = SetTimeoutCmd
2453
1715
propname = "Timeout"
2454
1716
values_to_set = [datetime.timedelta(),
2455
1717
datetime.timedelta(minutes=5),
2456
1718
datetime.timedelta(seconds=1),
2457
1719
datetime.timedelta(weeks=1),
2458
1720
datetime.timedelta(weeks=52)]
2459
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2460
2461
2462
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2463
command = command.SetExtendedTimeout
1721
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1722
1723
1724
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1725
command = SetExtendedTimeoutCmd
2464
1726
propname = "ExtendedTimeout"
2465
1727
values_to_set = [datetime.timedelta(),
2466
1728
datetime.timedelta(minutes=5),
2467
1729
datetime.timedelta(seconds=1),
2468
1730
datetime.timedelta(weeks=1),
2469
1731
datetime.timedelta(weeks=52)]
2470
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2471
2472
2473
class TestSetIntervalCmd(TestPropertySetterCmd):
2474
command = command.SetInterval
1732
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1733
1734
1735
class TestSetIntervalCmd(TestPropertyValueCmd):
1736
command = SetIntervalCmd
2475
1737
propname = "Interval"
2476
1738
values_to_set = [datetime.timedelta(),
2477
1739
datetime.timedelta(minutes=5),
2478
1740
datetime.timedelta(seconds=1),
2479
1741
datetime.timedelta(weeks=1),
2480
1742
datetime.timedelta(weeks=52)]
2481
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2482
2483
2484
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2485
command = command.SetApprovalDelay
1743
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1744
1745
1746
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1747
command = SetApprovalDelayCmd
2486
1748
propname = "ApprovalDelay"
2487
1749
values_to_set = [datetime.timedelta(),
2488
1750
datetime.timedelta(minutes=5),
2489
1751
datetime.timedelta(seconds=1),
2490
1752
datetime.timedelta(weeks=1),
2491
1753
datetime.timedelta(weeks=52)]
2492
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2493
2494
2495
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2496
command = command.SetApprovalDuration
1754
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1755
1756
1757
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1758
command = SetApprovalDurationCmd
2497
1759
propname = "ApprovalDuration"
2498
1760
values_to_set = [datetime.timedelta(),
2499
1761
datetime.timedelta(minutes=5),
2500
1762
datetime.timedelta(seconds=1),
2501
1763
datetime.timedelta(weeks=1),
2502
1764
datetime.timedelta(weeks=52)]
2503
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1765
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2504
1766
2505
1767
2506
1768
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0