To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1128
- compare with another revision
- download diff
- download tarball
- view history from revision 1128
- Committer: Teddy Hogeborn
- Date: 2019-07-27 19:28:14 UTC
- Revision ID: teddy@recompile.se-20190727192814-wzkmawaw88pn47s1
Add debconf translation support
* debian/mandos-client.templates: Reformatted by
debconf-gettextize(1).
* debian/mandos.templates: - '' -
* debian/po/POTFILES.in: New.
* debian/po/templates.pot: - '' -
* debian/mandos-client.templates: Reformatted by
debconf-gettextize(1).
* debian/mandos.templates: - '' -
* debian/po/POTFILES.in: New.
* debian/po/templates.pot: - '' -
- files added:
- debian/po/POTFILES.in
- debian/tests
- dracut-module
- files modified:
- .bzrignore
added
removed
mandos-ctl
1
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
2
# -*- after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --test" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
46
46
import tempfile
47
47
import contextlib
48
48
49
import dbus
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
50
62
51
63
# Show warnings by default
52
64
if not sys.warnoptions:
61
73
62
74
if sys.version_info.major == 2:
63
75
str = unicode
76
import StringIO
77
io.StringIO = StringIO.StringIO
64
78
65
79
locale.setlocale(locale.LC_ALL, "")
66
80
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"
81
version = "1.8.4"
80
82
81
83
82
84
def main():
83
85
parser = argparse.ArgumentParser()
84
85
86
add_command_line_options(parser)
86
87
87
88
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
try:
97
bus = dbus.SystemBus()
98
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
99
dbus_busname, server_dbus_path)
100
mandos_dbus_objc = bus.get_object(dbus_busname,
101
server_dbus_path)
102
except dbus.exceptions.DBusException:
103
log.critical("Could not connect to Mandos server")
104
sys.exit(1)
105
106
mandos_serv = dbus.Interface(mandos_dbus_objc,
107
dbus_interface=server_dbus_interface)
108
mandos_serv_object_manager = dbus.Interface(
109
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
110
111
try:
112
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
113
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
114
with SilenceLogger("dbus.proxies"):
115
all_clients = {path: ifs_and_props[client_dbus_interface]
116
for path, ifs_and_props in
117
mandos_serv_object_manager
118
.GetManagedObjects().items()
119
if client_dbus_interface in ifs_and_props}
120
except dbus.exceptions.DBusException as e:
121
log.critical("Failed to access Mandos server through D-Bus:"
122
"\n%s", e)
123
sys.exit(1)
124
125
# Compile dict of (clients: properties) to process
126
clients = {}
127
96
if pydbus is not None:
97
bus = pydbus_adapter.CachingBus(pydbus)
98
else:
99
bus = dbus_python_adapter.CachingBus(dbus_python)
100
101
try:
102
all_clients = bus.get_clients_and_properties()
103
except dbus.ConnectFailed as e:
104
log.critical("Could not connect to Mandos server: %s", e)
105
sys.exit(1)
106
except dbus.Error as e:
107
log.critical(
108
"Failed to access Mandos server through D-Bus:\n%s", e)
109
sys.exit(1)
110
111
# Compile dict of (clientpath: properties) to process
128
112
if not clientnames:
129
113
clients = all_clients
130
114
else:
115
clients = {}
131
116
for name in clientnames:
132
117
for objpath, properties in all_clients.items():
133
118
if properties["Name"] == name:
137
122
log.critical("Client not found on server: %r", name)
138
123
sys.exit(1)
139
124
140
# Run all commands on clients
141
125
commands = commands_from_options(options)
126
142
127
for command in commands:
143
command.run(clients, bus, mandos_serv)
128
command.run(clients, bus)
144
129
145
130
146
131
def add_command_line_options(parser):
151
136
help="Select all clients")
152
137
parser.add_argument("-v", "--verbose", action="store_true",
153
138
help="Print all fields")
154
parser.add_argument("-j", "--dump-json", action="store_true",
139
parser.add_argument("-j", "--dump-json", dest="commands",
140
action="append_const", default=[],
141
const=command.DumpJSON(),
155
142
help="Dump client data in JSON format")
156
143
enable_disable = parser.add_mutually_exclusive_group()
157
enable_disable.add_argument("-e", "--enable", action="store_true",
144
enable_disable.add_argument("-e", "--enable", dest="commands",
145
action="append_const", default=[],
146
const=command.Enable(),
158
147
help="Enable client")
159
enable_disable.add_argument("-d", "--disable",
160
action="store_true",
148
enable_disable.add_argument("-d", "--disable", dest="commands",
149
action="append_const", default=[],
150
const=command.Disable(),
161
151
help="disable client")
162
parser.add_argument("-b", "--bump-timeout", action="store_true",
152
parser.add_argument("-b", "--bump-timeout", dest="commands",
153
action="append_const", default=[],
154
const=command.BumpTimeout(),
163
155
help="Bump timeout for client")
164
156
start_stop_checker = parser.add_mutually_exclusive_group()
165
157
start_stop_checker.add_argument("--start-checker",
166
action="store_true",
158
dest="commands",
159
action="append_const", default=[],
160
const=command.StartChecker(),
167
161
help="Start checker for client")
168
start_stop_checker.add_argument("--stop-checker",
169
action="store_true",
162
start_stop_checker.add_argument("--stop-checker", dest="commands",
163
action="append_const", default=[],
164
const=command.StopChecker(),
170
165
help="Stop checker for client")
171
parser.add_argument("-V", "--is-enabled", action="store_true",
166
parser.add_argument("-V", "--is-enabled", dest="commands",
167
action="append_const", default=[],
168
const=command.IsEnabled(),
172
169
help="Check if client is enabled")
173
parser.add_argument("-r", "--remove", action="store_true",
170
parser.add_argument("-r", "--remove", dest="commands",
171
action="append_const", default=[],
172
const=command.Remove(),
174
173
help="Remove client")
175
parser.add_argument("-c", "--checker",
174
parser.add_argument("-c", "--checker", dest="commands",
175
action="append", default=[],
176
metavar="COMMAND", type=command.SetChecker,
176
177
help="Set checker command for client")
177
parser.add_argument("-t", "--timeout", type=string_to_delta,
178
help="Set timeout for client")
179
parser.add_argument("--extended-timeout", type=string_to_delta,
180
help="Set extended timeout for client")
181
parser.add_argument("-i", "--interval", type=string_to_delta,
182
help="Set checker interval 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")
183
193
approve_deny_default = parser.add_mutually_exclusive_group()
184
194
approve_deny_default.add_argument(
185
"--approve-by-default", action="store_true",
186
default=None, dest="approved_by_default",
195
"--approve-by-default", dest="commands",
196
action="append_const", default=[],
197
const=command.ApproveByDefault(),
187
198
help="Set client to be approved by default")
188
199
approve_deny_default.add_argument(
189
"--deny-by-default", action="store_false",
190
dest="approved_by_default",
200
"--deny-by-default", dest="commands",
201
action="append_const", default=[],
202
const=command.DenyByDefault(),
191
203
help="Set client to be denied by default")
192
parser.add_argument("--approval-delay", type=string_to_delta,
193
help="Set delay before client approve/deny")
194
parser.add_argument("--approval-duration", type=string_to_delta,
195
help="Set duration of one client approval")
196
parser.add_argument("-H", "--host", help="Set host for client")
197
parser.add_argument("-s", "--secret",
198
type=argparse.FileType(mode="rb"),
199
help="Set password blob (file) for client")
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")
200
223
approve_deny = parser.add_mutually_exclusive_group()
201
224
approve_deny.add_argument(
202
"-A", "--approve", action="store_true",
225
"-A", "--approve", dest="commands", action="append_const",
226
default=[], const=command.Approve(),
203
227
help="Approve any current client request")
204
approve_deny.add_argument("-D", "--deny", action="store_true",
228
approve_deny.add_argument("-D", "--deny", dest="commands",
229
action="append_const", default=[],
230
const=command.Deny(),
205
231
help="Deny any current client request")
206
232
parser.add_argument("--debug", action="store_true",
207
233
help="Debug mode (show D-Bus commands)")
244
270
>>> rfc3339_duration_to_delta("")
245
271
Traceback (most recent call last):
246
272
...
247
ValueError: Invalid RFC 3339 duration: u''
273
ValueError: Invalid RFC 3339 duration: ""
248
274
>>> # Must start with "P":
249
275
>>> rfc3339_duration_to_delta("1D")
250
276
Traceback (most recent call last):
251
277
...
252
ValueError: Invalid RFC 3339 duration: u'1D'
278
ValueError: Invalid RFC 3339 duration: "1D"
253
279
>>> # Must use correct order
254
280
>>> rfc3339_duration_to_delta("PT1S2M")
255
281
Traceback (most recent call last):
256
282
...
257
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
283
ValueError: Invalid RFC 3339 duration: "PT1S2M"
258
284
>>> # Time needs time marker
259
285
>>> rfc3339_duration_to_delta("P1H2S")
260
286
Traceback (most recent call last):
261
287
...
262
ValueError: Invalid RFC 3339 duration: u'P1H2S'
288
ValueError: Invalid RFC 3339 duration: "P1H2S"
263
289
>>> # Weeks can not be combined with anything else
264
290
>>> rfc3339_duration_to_delta("P1D2W")
265
291
Traceback (most recent call last):
266
292
...
267
ValueError: Invalid RFC 3339 duration: u'P1D2W'
293
ValueError: Invalid RFC 3339 duration: "P1D2W"
268
294
>>> rfc3339_duration_to_delta("P2W2H")
269
295
Traceback (most recent call last):
270
296
...
271
ValueError: Invalid RFC 3339 duration: u'P2W2H'
297
ValueError: Invalid RFC 3339 duration: "P2W2H"
272
298
"""
273
299
274
300
# Parsing an RFC 3339 duration with regular expressions is not
345
371
break
346
372
else:
347
373
# No currently valid tokens were found
348
raise ValueError("Invalid RFC 3339 duration: {!r}"
374
raise ValueError("Invalid RFC 3339 duration: \"{}\""
349
375
.format(duration))
350
376
# End token found
351
377
return value
398
424
"""Apply additional restrictions on options, not expressible in
399
425
argparse"""
400
426
401
def has_actions(options):
402
return any((options.enable,
403
options.disable,
404
options.bump_timeout,
405
options.start_checker,
406
options.stop_checker,
407
options.is_enabled,
408
options.remove,
409
options.checker is not None,
410
options.timeout is not None,
411
options.extended_timeout is not None,
412
options.interval is not None,
413
options.approved_by_default is not None,
414
options.approval_delay is not None,
415
options.approval_duration is not None,
416
options.host is not None,
417
options.secret is not None,
418
options.approve,
419
options.deny))
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)
420
450
421
if has_actions(options) and not (options.client or options.all):
451
if has_commands(options) and not (options.client or options.all):
422
452
parser.error("Options require clients names or --all.")
423
if options.verbose and has_actions(options):
453
if options.verbose and has_commands(options):
424
454
parser.error("--verbose can only be used alone.")
425
if options.dump_json and (options.verbose
426
or has_actions(options)):
455
if (has_commands(options, (command.DumpJSON,))
456
and (options.verbose or len(options.commands) > 1)):
427
457
parser.error("--dump-json can only be used alone.")
428
if options.all and not has_actions(options):
458
if options.all and not has_commands(options):
429
459
parser.error("--all requires an action.")
430
if options.is_enabled and len(options.client) > 1:
460
if (has_commands(options, (command.IsEnabled,))
461
and len(options.client) > 1):
431
462
parser.error("--is-enabled requires exactly one client")
432
if options.remove:
433
options.remove = False
434
if has_actions(options) and not options.deny:
435
parser.error("--remove can only be combined with --deny")
436
options.remove = True
437
438
439
class SilenceLogger(object):
440
"Simple context manager to silence a particular logger"
441
def __init__(self, loggername):
442
self.logger = logging.getLogger(loggername)
443
444
def __enter__(self):
445
self.logger.addFilter(self.nullfilter)
446
return self
447
448
class NullFilter(logging.Filter):
449
def filter(self, record):
450
return False
451
452
nullfilter = NullFilter()
453
454
def __exit__(self, exc_type, exc_val, exc_tb):
455
self.logger.removeFilter(self.nullfilter)
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
456
679
457
680
458
681
def commands_from_options(options):
459
682
460
commands = []
461
462
if options.is_enabled:
463
commands.append(IsEnabledCmd())
464
465
if options.approve:
466
commands.append(ApproveCmd())
467
468
if options.deny:
469
commands.append(DenyCmd())
470
471
if options.remove:
472
commands.append(RemoveCmd())
473
474
if options.dump_json:
475
commands.append(DumpJSONCmd())
476
477
if options.enable:
478
commands.append(EnableCmd())
479
480
if options.disable:
481
commands.append(DisableCmd())
482
483
if options.bump_timeout:
484
commands.append(BumpTimeoutCmd())
485
486
if options.start_checker:
487
commands.append(StartCheckerCmd())
488
489
if options.stop_checker:
490
commands.append(StopCheckerCmd())
491
492
if options.approved_by_default is not None:
493
if options.approved_by_default:
494
commands.append(ApproveByDefaultCmd())
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)
495
701
else:
496
commands.append(DenyByDefaultCmd())
497
498
if options.checker is not None:
499
commands.append(SetCheckerCmd(options.checker))
500
501
if options.host is not None:
502
commands.append(SetHostCmd(options.host))
503
504
if options.secret is not None:
505
commands.append(SetSecretCmd(options.secret))
506
507
if options.timeout is not None:
508
commands.append(SetTimeoutCmd(options.timeout))
509
510
if options.extended_timeout:
511
commands.append(
512
SetExtendedTimeoutCmd(options.extended_timeout))
513
514
if options.interval is not None:
515
commands.append(SetIntervalCmd(options.interval))
516
517
if options.approval_delay is not None:
518
commands.append(SetApprovalDelayCmd(options.approval_delay))
519
520
if options.approval_duration is not None:
521
commands.append(
522
SetApprovalDurationCmd(options.approval_duration))
702
cleaned_after.append(cmd)
703
if cleaned_after != after_remove:
704
commands = before_remove + cleaned_after
523
705
524
706
# If no command option has been given, show table of clients,
525
707
# optionally verbosely
526
708
if not commands:
527
commands.append(PrintTableCmd(verbose=options.verbose))
709
commands.append(command.PrintTable(verbose=options.verbose))
528
710
529
711
return commands
530
712
531
713
532
class Command(object):
533
"""Abstract class for commands"""
534
def run(self, clients, bus=None, mandos=None):
535
"""Normal commands should implement run_on_one_client(), but
536
commands which want to operate on all clients at the same time
537
can override this run() method instead."""
538
self.mandos = mandos
539
for clientpath, properties in clients.items():
540
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
541
dbus_busname, str(clientpath))
542
client = bus.get_object(dbus_busname, clientpath)
543
self.run_on_one_client(client, properties)
544
545
546
class IsEnabledCmd(Command):
547
def run(self, clients, bus=None, mandos=None):
548
client, properties = next(iter(clients.items()))
549
if self.is_enabled(client, properties):
550
sys.exit(0)
551
sys.exit(1)
552
def is_enabled(self, client, properties):
553
return properties["Enabled"]
554
555
556
class ApproveCmd(Command):
557
def run_on_one_client(self, client, properties):
558
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
559
client.__dbus_object_path__, client_dbus_interface)
560
client.Approve(dbus.Boolean(True),
561
dbus_interface=client_dbus_interface)
562
563
564
class DenyCmd(Command):
565
def run_on_one_client(self, client, properties):
566
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
567
client.__dbus_object_path__, client_dbus_interface)
568
client.Approve(dbus.Boolean(False),
569
dbus_interface=client_dbus_interface)
570
571
572
class RemoveCmd(Command):
573
def run_on_one_client(self, client, properties):
574
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
575
server_dbus_path, server_dbus_interface,
576
str(client.__dbus_object_path__))
577
self.mandos.RemoveClient(client.__dbus_object_path__)
578
579
580
class OutputCmd(Command):
581
"""Abstract class for commands outputting client details"""
582
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
583
"Created", "Interval", "Host", "KeyID",
584
"Fingerprint", "CheckerRunning", "LastEnabled",
585
"ApprovalPending", "ApprovedByDefault",
586
"LastApprovalRequest", "ApprovalDelay",
587
"ApprovalDuration", "Checker", "ExtendedTimeout",
588
"Expires", "LastCheckerStatus")
589
590
def run(self, clients, bus=None, mandos=None):
591
print(self.output(clients.values()))
592
593
def output(self, clients):
594
raise NotImplementedError()
595
596
597
class DumpJSONCmd(OutputCmd):
598
def output(self, clients):
599
data = {client["Name"]:
600
{key: self.dbus_boolean_to_bool(client[key])
601
for key in self.all_keywords}
602
for client in clients}
603
return json.dumps(data, indent=4, separators=(',', ': '))
604
605
@staticmethod
606
def dbus_boolean_to_bool(value):
607
if isinstance(value, dbus.Boolean):
608
value = bool(value)
609
return value
610
611
612
class PrintTableCmd(OutputCmd):
613
def __init__(self, verbose=False):
614
self.verbose = verbose
615
616
def output(self, clients):
617
default_keywords = ("Name", "Enabled", "Timeout",
618
"LastCheckedOK")
619
keywords = default_keywords
620
if self.verbose:
621
keywords = self.all_keywords
622
return str(self.TableOfClients(clients, keywords))
623
624
class TableOfClients(object):
625
tableheaders = {
626
"Name": "Name",
627
"Enabled": "Enabled",
628
"Timeout": "Timeout",
629
"LastCheckedOK": "Last Successful Check",
630
"LastApprovalRequest": "Last Approval Request",
631
"Created": "Created",
632
"Interval": "Interval",
633
"Host": "Host",
634
"Fingerprint": "Fingerprint",
635
"KeyID": "Key ID",
636
"CheckerRunning": "Check Is Running",
637
"LastEnabled": "Last Enabled",
638
"ApprovalPending": "Approval Is Pending",
639
"ApprovedByDefault": "Approved By Default",
640
"ApprovalDelay": "Approval Delay",
641
"ApprovalDuration": "Approval Duration",
642
"Checker": "Checker",
643
"ExtendedTimeout": "Extended Timeout",
644
"Expires": "Expires",
645
"LastCheckerStatus": "Last Checker Status",
646
}
647
648
def __init__(self, clients, keywords):
649
self.clients = clients
650
self.keywords = keywords
651
652
def __str__(self):
653
return "\n".join(self.rows())
654
655
if sys.version_info.major == 2:
656
__unicode__ = __str__
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
657
814
def __str__(self):
658
return str(self).encode(locale.getpreferredencoding())
659
660
def rows(self):
661
format_string = self.row_formatting_string()
662
rows = [self.header_line(format_string)]
663
rows.extend(self.client_line(client, format_string)
664
for client in self.clients)
665
return rows
666
667
def row_formatting_string(self):
668
"Format string used to format table rows"
669
return " ".join("{{{key}:{width}}}".format(
670
width=max(len(self.tableheaders[key]),
671
*(len(self.string_from_client(client, key))
672
for client in self.clients)),
673
key=key)
674
for key in self.keywords)
675
676
def string_from_client(self, client, key):
677
return self.valuetostring(client[key], key)
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
678
924
679
925
@classmethod
680
def valuetostring(cls, value, keyword):
681
if isinstance(value, dbus.Boolean):
682
return "Yes" if value else "No"
683
if keyword in ("Timeout", "Interval", "ApprovalDelay",
684
"ApprovalDuration", "ExtendedTimeout"):
685
return cls.milliseconds_to_string(value)
686
return str(value)
687
688
def header_line(self, format_string):
689
return format_string.format(**self.tableheaders)
690
691
def client_line(self, client, format_string):
692
return format_string.format(
693
**{key: self.string_from_client(client, key)
694
for key in self.keywords})
695
696
@staticmethod
697
def milliseconds_to_string(ms):
698
td = datetime.timedelta(0, 0, 0, ms)
699
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
700
.format(days="{}T".format(td.days)
701
if td.days else "",
702
hours=td.seconds // 3600,
703
minutes=(td.seconds % 3600) // 60,
704
seconds=td.seconds % 60))
705
706
707
class PropertyCmd(Command):
708
"""Abstract class for Actions for setting one client property"""
709
710
def run_on_one_client(self, client, properties):
711
"""Set the Client's D-Bus property"""
712
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
713
client.__dbus_object_path__,
714
dbus.PROPERTIES_IFACE, client_dbus_interface,
715
self.propname, self.value_to_set
716
if not isinstance(self.value_to_set, dbus.Boolean)
717
else bool(self.value_to_set))
718
client.Set(client_dbus_interface, self.propname,
719
self.value_to_set,
720
dbus_interface=dbus.PROPERTIES_IFACE)
721
722
@property
723
def propname(self):
724
raise NotImplementedError()
725
726
727
class EnableCmd(PropertyCmd):
728
propname = "Enabled"
729
value_to_set = dbus.Boolean(True)
730
731
732
class DisableCmd(PropertyCmd):
733
propname = "Enabled"
734
value_to_set = dbus.Boolean(False)
735
736
737
class BumpTimeoutCmd(PropertyCmd):
738
propname = "LastCheckedOK"
739
value_to_set = ""
740
741
742
class StartCheckerCmd(PropertyCmd):
743
propname = "CheckerRunning"
744
value_to_set = dbus.Boolean(True)
745
746
747
class StopCheckerCmd(PropertyCmd):
748
propname = "CheckerRunning"
749
value_to_set = dbus.Boolean(False)
750
751
752
class ApproveByDefaultCmd(PropertyCmd):
753
propname = "ApprovedByDefault"
754
value_to_set = dbus.Boolean(True)
755
756
757
class DenyByDefaultCmd(PropertyCmd):
758
propname = "ApprovedByDefault"
759
value_to_set = dbus.Boolean(False)
760
761
762
class PropertyValueCmd(PropertyCmd):
763
"""Abstract class for PropertyCmd recieving a value as argument"""
764
def __init__(self, value):
765
self.value_to_set = value
766
767
768
class SetCheckerCmd(PropertyValueCmd):
769
propname = "Checker"
770
771
772
class SetHostCmd(PropertyValueCmd):
773
propname = "Host"
774
775
776
class SetSecretCmd(PropertyValueCmd):
777
propname = "Secret"
778
779
@property
780
def value_to_set(self):
781
return self._vts
782
783
@value_to_set.setter
784
def value_to_set(self, value):
785
"""When setting, read data from supplied file object"""
786
self._vts = value.read()
787
value.close()
788
789
790
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
791
"""Abstract class for PropertyValueCmd taking a value argument as
792
a datetime.timedelta() but should store it as milliseconds."""
793
794
@property
795
def value_to_set(self):
796
return self._vts
797
798
@value_to_set.setter
799
def value_to_set(self, value):
800
"""When setting, convert value from a datetime.timedelta"""
801
self._vts = int(round(value.total_seconds() * 1000))
802
803
804
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
805
propname = "Timeout"
806
807
808
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
809
propname = "ExtendedTimeout"
810
811
812
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
813
propname = "Interval"
814
815
816
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
817
propname = "ApprovalDelay"
818
819
820
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
821
propname = "ApprovalDuration"
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"
822
986
823
987
824
988
825
class Test_string_to_delta(unittest.TestCase):
826
def test_handles_basic_rfc3339(self):
827
self.assertEqual(string_to_delta("PT0S"),
828
datetime.timedelta())
829
self.assertEqual(string_to_delta("P0D"),
830
datetime.timedelta())
831
self.assertEqual(string_to_delta("PT1S"),
832
datetime.timedelta(0, 1))
833
self.assertEqual(string_to_delta("PT2H"),
834
datetime.timedelta(0, 7200))
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"))
835
1047
836
1048
def test_falls_back_to_pre_1_6_1_with_warning(self):
837
# assertLogs only exists in Python 3.4
838
if hasattr(self, "assertLogs"):
839
with self.assertLogs(log, logging.WARNING):
840
value = string_to_delta("2h")
841
else:
842
class WarningFilter(logging.Filter):
843
"""Don't show, but record the presence of, warnings"""
844
def filter(self, record):
845
is_warning = record.levelno >= logging.WARNING
846
self.found = is_warning or getattr(self, "found",
847
False)
848
return not is_warning
849
warning_filter = WarningFilter()
850
log.addFilter(warning_filter)
851
try:
852
value = string_to_delta("2h")
853
finally:
854
log.removeFilter(warning_filter)
855
self.assertTrue(getattr(warning_filter, "found", False))
856
self.assertEqual(value, datetime.timedelta(0, 7200))
1049
with self.assertLogs(log, logging.WARNING):
1050
value = string_to_delta("2h")
1051
self.assertEqual(datetime.timedelta(0, 7200), value)
857
1052
858
1053
859
1054
class Test_check_option_syntax(unittest.TestCase):
863
1058
864
1059
def test_actions_requires_client_or_all(self):
865
1060
for action, value in self.actions.items():
866
options = self.parser.parse_args()
867
setattr(options, action, value)
1061
args = self.actionargs(action, value)
868
1062
with self.assertParseError():
869
self.check_option_syntax(options)
1063
self.parse_args(args)
870
1064
871
# This mostly corresponds to the definition from has_actions() in
1065
# This mostly corresponds to the definition from has_commands() in
872
1066
# check_option_syntax()
873
1067
actions = {
874
# The actual values set here are not that important, but we do
875
# at least stick to the correct types, even though they are
876
# never used
877
"enable": True,
878
"disable": True,
879
"bump_timeout": True,
880
"start_checker": True,
881
"stop_checker": True,
882
"is_enabled": True,
883
"remove": True,
884
"checker": "x",
885
"timeout": datetime.timedelta(),
886
"extended_timeout": datetime.timedelta(),
887
"interval": datetime.timedelta(),
888
"approved_by_default": True,
889
"approval_delay": datetime.timedelta(),
890
"approval_duration": datetime.timedelta(),
891
"host": "x",
892
"secret": io.BytesIO(b"x"),
893
"approve": True,
894
"deny": True,
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,
895
1087
}
896
1088
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
897
1096
@contextlib.contextmanager
898
1097
def assertParseError(self):
899
1098
with self.assertRaises(SystemExit) as e:
900
with self.temporarily_suppress_stderr():
1099
with self.redirect_stderr_to_devnull():
901
1100
yield
902
1101
# Exit code from argparse is guaranteed to be "2". Reference:
903
1102
# https://docs.python.org/3/library
904
1103
# /argparse.html#exiting-methods
905
self.assertEqual(e.exception.code, 2)
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)
906
1109
907
1110
@staticmethod
908
1111
@contextlib.contextmanager
909
def temporarily_suppress_stderr():
910
null = os.open(os.path.devnull, os.O_RDWR)
911
stderrcopy = os.dup(sys.stderr.fileno())
912
os.dup2(null, sys.stderr.fileno())
913
os.close(null)
914
try:
915
yield
916
finally:
917
# restore stderr
918
os.dup2(stderrcopy, sys.stderr.fileno())
919
os.close(stderrcopy)
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
920
1120
921
1121
def check_option_syntax(self, options):
922
1122
check_option_syntax(self.parser, options)
923
1123
924
def test_actions_conflicts_with_verbose(self):
925
for action, value in self.actions.items():
926
options = self.parser.parse_args()
927
setattr(options, action, value)
928
options.verbose = True
929
with self.assertParseError():
930
self.check_option_syntax(options)
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
1137
932
1138
def test_dump_json_conflicts_with_verbose(self):
933
options = self.parser.parse_args()
934
options.dump_json = True
935
options.verbose = True
1139
args = ["--dump-json", "--verbose"]
936
1140
with self.assertParseError():
937
self.check_option_syntax(options)
1141
self.parse_args(args)
938
1142
939
1143
def test_dump_json_conflicts_with_action(self):
940
1144
for action, value in self.actions.items():
941
options = self.parser.parse_args()
942
setattr(options, action, value)
943
options.dump_json = True
1145
args = self.actionargs(action, value, "--dump-json")
944
1146
with self.assertParseError():
945
self.check_option_syntax(options)
1147
self.parse_args(args)
946
1148
947
1149
def test_all_can_not_be_alone(self):
948
options = self.parser.parse_args()
949
options.all = True
1150
args = ["--all"]
950
1151
with self.assertParseError():
951
self.check_option_syntax(options)
1152
self.parse_args(args)
952
1153
953
1154
def test_all_is_ok_with_any_action(self):
954
1155
for action, value in self.actions.items():
955
options = self.parser.parse_args()
956
setattr(options, action, value)
957
options.all = True
958
self.check_option_syntax(options)
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)
959
1186
960
1187
def test_is_enabled_fails_without_client(self):
961
options = self.parser.parse_args()
962
options.is_enabled = True
1188
args = ["--is-enabled"]
963
1189
with self.assertParseError():
964
self.check_option_syntax(options)
965
966
def test_is_enabled_works_with_one_client(self):
967
options = self.parser.parse_args()
968
options.is_enabled = True
969
options.client = ["foo"]
970
self.check_option_syntax(options)
1190
self.parse_args(args)
971
1191
972
1192
def test_is_enabled_fails_with_two_clients(self):
973
options = self.parser.parse_args()
974
options.is_enabled = True
975
options.client = ["foo", "barbar"]
1193
args = ["--is-enabled", "client1", "client2"]
976
1194
with self.assertParseError():
977
self.check_option_syntax(options)
1195
self.parse_args(args)
978
1196
979
1197
def test_remove_can_only_be_combined_with_action_deny(self):
980
1198
for action, value in self.actions.items():
981
if action in {"remove", "deny"}:
1199
if action in {"--remove", "--deny"}:
982
1200
continue
983
options = self.parser.parse_args()
984
setattr(options, action, value)
985
options.all = True
986
options.remove = True
1201
args = self.actionargs(action, value, "--all",
1202
"--remove")
987
1203
with self.assertParseError():
988
self.check_option_syntax(options)
989
990
991
class Test_SilenceLogger(unittest.TestCase):
992
loggername = "mandos-ctl.Test_SilenceLogger"
993
log = logging.getLogger(loggername)
994
log.propagate = False
995
log.addHandler(logging.NullHandler())
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
996
1230
997
1231
def setUp(self):
998
self.counting_filter = self.CountingFilter()
999
1000
class CountingFilter(logging.Filter):
1001
"Count number of records"
1002
count = 0
1003
def filter(self, record):
1004
self.count += 1
1005
return True
1006
1007
def test_should_filter_records_only_when_active(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
1008
1522
try:
1009
with SilenceLogger(self.loggername):
1010
self.log.addFilter(self.counting_filter)
1011
self.log.info("Filtered log message 1")
1012
self.log.info("Non-filtered message 2")
1013
self.log.info("Non-filtered message 3")
1523
with self.assertRaises(dbus.Error) as e:
1524
self.call_method(bus, "methodname", "busname",
1525
"objectpath", "interface")
1014
1526
finally:
1015
self.log.removeFilter(self.counting_filter)
1016
self.assertEqual(self.counting_filter.count, 2)
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)
1017
1771
1018
1772
1019
1773
class Test_commands_from_options(unittest.TestCase):
1774
1020
1775
def setUp(self):
1021
1776
self.parser = argparse.ArgumentParser()
1022
1777
add_command_line_options(self.parser)
1023
1778
1024
1779
def test_is_enabled(self):
1025
self.assert_command_from_args(["--is-enabled", "foo"],
1026
IsEnabledCmd)
1780
self.assert_command_from_args(["--is-enabled", "client"],
1781
command.IsEnabled)
1027
1782
1028
def assert_command_from_args(self, args, command_cls,
1029
**cmd_attrs):
1783
def assert_command_from_args(self, args, command_cls, length=1,
1784
clients=None, **cmd_attrs):
1030
1785
"""Assert that parsing ARGS should result in an instance of
1031
1786
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1032
1787
options = self.parser.parse_args(args)
1033
1788
check_option_syntax(self.parser, options)
1034
1789
commands = commands_from_options(options)
1035
self.assertEqual(len(commands), 1)
1036
command = commands[0]
1037
self.assertIsInstance(command, command_cls)
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)
1038
1798
for key, value in cmd_attrs.items():
1039
self.assertEqual(getattr(command, key), value)
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)
1040
1806
1041
1807
def test_is_enabled_short(self):
1042
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1808
self.assert_command_from_args(["-V", "client"],
1809
command.IsEnabled)
1043
1810
1044
1811
def test_approve(self):
1045
self.assert_command_from_args(["--approve", "foo"],
1046
ApproveCmd)
1812
self.assert_command_from_args(["--approve", "client"],
1813
command.Approve)
1047
1814
1048
1815
def test_approve_short(self):
1049
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1816
self.assert_command_from_args(["-A", "client"],
1817
command.Approve)
1050
1818
1051
1819
def test_deny(self):
1052
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1820
self.assert_command_from_args(["--deny", "client"],
1821
command.Deny)
1053
1822
1054
1823
def test_deny_short(self):
1055
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1824
self.assert_command_from_args(["-D", "client"], command.Deny)
1056
1825
1057
1826
def test_remove(self):
1058
self.assert_command_from_args(["--remove", "foo"],
1059
RemoveCmd)
1827
self.assert_command_from_args(["--remove", "client"],
1828
command.Remove)
1060
1829
1061
1830
def test_deny_before_remove(self):
1062
1831
options = self.parser.parse_args(["--deny", "--remove",
1063
"foo"])
1832
"client"])
1064
1833
check_option_syntax(self.parser, options)
1065
1834
commands = commands_from_options(options)
1066
self.assertEqual(len(commands), 2)
1067
self.assertIsInstance(commands[0], DenyCmd)
1068
self.assertIsInstance(commands[1], RemoveCmd)
1835
self.assertEqual(2, len(commands))
1836
self.assertIsInstance(commands[0], command.Deny)
1837
self.assertIsInstance(commands[1], command.Remove)
1069
1838
1070
1839
def test_deny_before_remove_reversed(self):
1071
1840
options = self.parser.parse_args(["--remove", "--deny",
1072
1841
"--all"])
1073
1842
check_option_syntax(self.parser, options)
1074
1843
commands = commands_from_options(options)
1075
self.assertEqual(len(commands), 2)
1076
self.assertIsInstance(commands[0], DenyCmd)
1077
self.assertIsInstance(commands[1], RemoveCmd)
1844
self.assertEqual(2, len(commands))
1845
self.assertIsInstance(commands[0], command.Deny)
1846
self.assertIsInstance(commands[1], command.Remove)
1078
1847
1079
1848
def test_remove_short(self):
1080
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1849
self.assert_command_from_args(["-r", "client"],
1850
command.Remove)
1081
1851
1082
1852
def test_dump_json(self):
1083
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1853
self.assert_command_from_args(["--dump-json"],
1854
command.DumpJSON)
1084
1855
1085
1856
def test_enable(self):
1086
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1857
self.assert_command_from_args(["--enable", "client"],
1858
command.Enable)
1087
1859
1088
1860
def test_enable_short(self):
1089
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1861
self.assert_command_from_args(["-e", "client"],
1862
command.Enable)
1090
1863
1091
1864
def test_disable(self):
1092
self.assert_command_from_args(["--disable", "foo"],
1093
DisableCmd)
1865
self.assert_command_from_args(["--disable", "client"],
1866
command.Disable)
1094
1867
1095
1868
def test_disable_short(self):
1096
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1869
self.assert_command_from_args(["-d", "client"],
1870
command.Disable)
1097
1871
1098
1872
def test_bump_timeout(self):
1099
self.assert_command_from_args(["--bump-timeout", "foo"],
1100
BumpTimeoutCmd)
1873
self.assert_command_from_args(["--bump-timeout", "client"],
1874
command.BumpTimeout)
1101
1875
1102
1876
def test_bump_timeout_short(self):
1103
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1877
self.assert_command_from_args(["-b", "client"],
1878
command.BumpTimeout)
1104
1879
1105
1880
def test_start_checker(self):
1106
self.assert_command_from_args(["--start-checker", "foo"],
1107
StartCheckerCmd)
1881
self.assert_command_from_args(["--start-checker", "client"],
1882
command.StartChecker)
1108
1883
1109
1884
def test_stop_checker(self):
1110
self.assert_command_from_args(["--stop-checker", "foo"],
1111
StopCheckerCmd)
1885
self.assert_command_from_args(["--stop-checker", "client"],
1886
command.StopChecker)
1112
1887
1113
1888
def test_approve_by_default(self):
1114
self.assert_command_from_args(["--approve-by-default", "foo"],
1115
ApproveByDefaultCmd)
1889
self.assert_command_from_args(["--approve-by-default",
1890
"client"],
1891
command.ApproveByDefault)
1116
1892
1117
1893
def test_deny_by_default(self):
1118
self.assert_command_from_args(["--deny-by-default", "foo"],
1119
DenyByDefaultCmd)
1894
self.assert_command_from_args(["--deny-by-default", "client"],
1895
command.DenyByDefault)
1120
1896
1121
1897
def test_checker(self):
1122
self.assert_command_from_args(["--checker", ":", "foo"],
1123
SetCheckerCmd, value_to_set=":")
1898
self.assert_command_from_args(["--checker", ":", "client"],
1899
command.SetChecker,
1900
value_to_set=":")
1124
1901
1125
1902
def test_checker_empty(self):
1126
self.assert_command_from_args(["--checker", "", "foo"],
1127
SetCheckerCmd, value_to_set="")
1903
self.assert_command_from_args(["--checker", "", "client"],
1904
command.SetChecker,
1905
value_to_set="")
1128
1906
1129
1907
def test_checker_short(self):
1130
self.assert_command_from_args(["-c", ":", "foo"],
1131
SetCheckerCmd, value_to_set=":")
1908
self.assert_command_from_args(["-c", ":", "client"],
1909
command.SetChecker,
1910
value_to_set=":")
1132
1911
1133
1912
def test_host(self):
1134
self.assert_command_from_args(["--host", "foo.example.org",
1135
"foo"], SetHostCmd,
1136
value_to_set="foo.example.org")
1913
self.assert_command_from_args(
1914
["--host", "client.example.org", "client"],
1915
command.SetHost, value_to_set="client.example.org")
1137
1916
1138
1917
def test_host_short(self):
1139
self.assert_command_from_args(["-H", "foo.example.org",
1140
"foo"], SetHostCmd,
1141
value_to_set="foo.example.org")
1918
self.assert_command_from_args(
1919
["-H", "client.example.org", "client"], command.SetHost,
1920
value_to_set="client.example.org")
1142
1921
1143
1922
def test_secret_devnull(self):
1144
1923
self.assert_command_from_args(["--secret", os.path.devnull,
1145
"foo"], SetSecretCmd,
1924
"client"], command.SetSecret,
1146
1925
value_to_set=b"")
1147
1926
1148
1927
def test_secret_tempfile(self):
1151
1930
f.write(value)
1152
1931
f.seek(0)
1153
1932
self.assert_command_from_args(["--secret", f.name,
1154
"foo"], SetSecretCmd,
1933
"client"],
1934
command.SetSecret,
1155
1935
value_to_set=value)
1156
1936
1157
1937
def test_secret_devnull_short(self):
1158
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1159
SetSecretCmd, value_to_set=b"")
1938
self.assert_command_from_args(["-s", os.path.devnull,
1939
"client"], command.SetSecret,
1940
value_to_set=b"")
1160
1941
1161
1942
def test_secret_tempfile_short(self):
1162
1943
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1163
1944
value = b"secret\0xyzzy\nbar"
1164
1945
f.write(value)
1165
1946
f.seek(0)
1166
self.assert_command_from_args(["-s", f.name, "foo"],
1167
SetSecretCmd,
1947
self.assert_command_from_args(["-s", f.name, "client"],
1948
command.SetSecret,
1168
1949
value_to_set=value)
1169
1950
1170
1951
def test_timeout(self):
1171
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1172
SetTimeoutCmd,
1952
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1953
command.SetTimeout,
1173
1954
value_to_set=300000)
1174
1955
1175
1956
def test_timeout_short(self):
1176
self.assert_command_from_args(["-t", "PT5M", "foo"],
1177
SetTimeoutCmd,
1957
self.assert_command_from_args(["-t", "PT5M", "client"],
1958
command.SetTimeout,
1178
1959
value_to_set=300000)
1179
1960
1180
1961
def test_extended_timeout(self):
1181
1962
self.assert_command_from_args(["--extended-timeout", "PT15M",
1182
"foo"],
1183
SetExtendedTimeoutCmd,
1963
"client"],
1964
command.SetExtendedTimeout,
1184
1965
value_to_set=900000)
1185
1966
1186
1967
def test_interval(self):
1187
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1188
SetIntervalCmd,
1968
self.assert_command_from_args(["--interval", "PT2M",
1969
"client"], command.SetInterval,
1189
1970
value_to_set=120000)
1190
1971
1191
1972
def test_interval_short(self):
1192
self.assert_command_from_args(["-i", "PT2M", "foo"],
1193
SetIntervalCmd,
1973
self.assert_command_from_args(["-i", "PT2M", "client"],
1974
command.SetInterval,
1194
1975
value_to_set=120000)
1195
1976
1196
1977
def test_approval_delay(self):
1197
1978
self.assert_command_from_args(["--approval-delay", "PT30S",
1198
"foo"], SetApprovalDelayCmd,
1979
"client"],
1980
command.SetApprovalDelay,
1199
1981
value_to_set=30000)
1200
1982
1201
1983
def test_approval_duration(self):
1202
1984
self.assert_command_from_args(["--approval-duration", "PT1S",
1203
"foo"], SetApprovalDurationCmd,
1985
"client"],
1986
command.SetApprovalDuration,
1204
1987
value_to_set=1000)
1205
1988
1206
1989
def test_print_table(self):
1207
self.assert_command_from_args([], PrintTableCmd,
1990
self.assert_command_from_args([], command.PrintTable,
1208
1991
verbose=False)
1209
1992
1210
1993
def test_print_table_verbose(self):
1211
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1994
self.assert_command_from_args(["--verbose"],
1995
command.PrintTable,
1212
1996
verbose=True)
1213
1997
1214
1998
def test_print_table_verbose_short(self):
1215
self.assert_command_from_args(["-v"], PrintTableCmd,
1216
verbose=True)
1217
1218
1219
class TestCmd(unittest.TestCase):
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):
1220
2035
"""Abstract class for tests of command classes"""
1221
2036
1222
def setUp(self):
1223
testcase = self
1224
class MockClient(object):
1225
def __init__(self, name, **attributes):
1226
self.__dbus_object_path__ = "/clients/{}".format(name)
1227
self.attributes = attributes
1228
self.attributes["Name"] = name
1229
self.calls = []
1230
def Set(self, interface, propname, value, dbus_interface):
1231
testcase.assertEqual(interface, client_dbus_interface)
1232
testcase.assertEqual(dbus_interface,
1233
dbus.PROPERTIES_IFACE)
1234
self.attributes[propname] = value
1235
def Get(self, interface, propname, dbus_interface):
1236
testcase.assertEqual(interface, client_dbus_interface)
1237
testcase.assertEqual(dbus_interface,
1238
dbus.PROPERTIES_IFACE)
1239
return self.attributes[propname]
1240
def Approve(self, approve, dbus_interface):
1241
testcase.assertEqual(dbus_interface,
1242
client_dbus_interface)
1243
self.calls.append(("Approve", (approve,
1244
dbus_interface)))
1245
self.client = MockClient(
1246
"foo",
1247
KeyID=("92ed150794387c03ce684574b1139a65"
1248
"94a34f895daaaf09fd8ea90a27cddb12"),
1249
Secret=b"secret",
1250
Host="foo.example.org",
1251
Enabled=dbus.Boolean(True),
1252
Timeout=300000,
1253
LastCheckedOK="2019-02-03T00:00:00",
1254
Created="2019-01-02T00:00:00",
1255
Interval=120000,
1256
Fingerprint=("778827225BA7DE539C5A"
1257
"7CFA59CFF7CDBD9A5920"),
1258
CheckerRunning=dbus.Boolean(False),
1259
LastEnabled="2019-01-03T00:00:00",
1260
ApprovalPending=dbus.Boolean(False),
1261
ApprovedByDefault=dbus.Boolean(True),
1262
LastApprovalRequest="",
1263
ApprovalDelay=0,
1264
ApprovalDuration=1000,
1265
Checker="fping -q -- %(host)s",
1266
ExtendedTimeout=900000,
1267
Expires="2019-02-04T00:00:00",
1268
LastCheckerStatus=0)
1269
self.other_client = MockClient(
1270
"barbar",
1271
KeyID=("0558568eedd67d622f5c83b35a115f79"
1272
"6ab612cff5ad227247e46c2b020f441c"),
1273
Secret=b"secretbar",
1274
Host="192.0.2.3",
1275
Enabled=dbus.Boolean(True),
1276
Timeout=300000,
1277
LastCheckedOK="2019-02-04T00:00:00",
1278
Created="2019-01-03T00:00:00",
1279
Interval=120000,
1280
Fingerprint=("3E393AEAEFB84C7E89E2"
1281
"F547B3A107558FCA3A27"),
1282
CheckerRunning=dbus.Boolean(True),
1283
LastEnabled="2019-01-04T00:00:00",
1284
ApprovalPending=dbus.Boolean(False),
1285
ApprovedByDefault=dbus.Boolean(False),
1286
LastApprovalRequest="2019-01-03T00:00:00",
1287
ApprovalDelay=30000,
1288
ApprovalDuration=93785000,
1289
Checker=":",
1290
ExtendedTimeout=900000,
1291
Expires="2019-02-05T00:00:00",
1292
LastCheckerStatus=-2)
1293
self.clients = collections.OrderedDict(
1294
[
1295
("/clients/foo", self.client.attributes),
1296
("/clients/barbar", self.other_client.attributes),
1297
])
1298
self.one_client = {"/clients/foo": self.client.attributes}
1299
1300
@property
1301
def bus(self):
1302
class Bus(object):
1303
@staticmethod
1304
def get_object(client_bus_name, path):
1305
self.assertEqual(client_bus_name, dbus_busname)
1306
return {
1307
# Note: "self" here is the TestCmd instance, not
1308
# the Bus instance, since this is a static method!
1309
"/clients/foo": self.client,
1310
"/clients/barbar": self.other_client,
1311
}[path]
1312
return Bus()
1313
1314
1315
class TestIsEnabledCmd(TestCmd):
1316
def test_is_enabled(self):
1317
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1318
properties)
1319
for client, properties
1320
in self.clients.items()))
1321
1322
def test_is_enabled_run_exits_successfully(self):
1323
with self.assertRaises(SystemExit) as e:
1324
IsEnabledCmd().run(self.one_client)
1325
if e.exception.code is not None:
1326
self.assertEqual(e.exception.code, 0)
1327
else:
1328
self.assertIsNone(e.exception.code)
1329
1330
def test_is_enabled_run_exits_with_failure(self):
1331
self.client.attributes["Enabled"] = dbus.Boolean(False)
1332
with self.assertRaises(SystemExit) as e:
1333
IsEnabledCmd().run(self.one_client)
1334
if isinstance(e.exception.code, int):
1335
self.assertNotEqual(e.exception.code, 0)
1336
else:
1337
self.assertIsNotNone(e.exception.code)
1338
1339
1340
class TestApproveCmd(TestCmd):
1341
def test_approve(self):
1342
ApproveCmd().run(self.clients, self.bus)
1343
for clientpath in self.clients:
1344
client = self.bus.get_object(dbus_busname, clientpath)
1345
self.assertIn(("Approve", (True, client_dbus_interface)),
1346
client.calls)
1347
1348
1349
class TestDenyCmd(TestCmd):
1350
def test_deny(self):
1351
DenyCmd().run(self.clients, self.bus)
1352
for clientpath in self.clients:
1353
client = self.bus.get_object(dbus_busname, clientpath)
1354
self.assertIn(("Approve", (False, client_dbus_interface)),
1355
client.calls)
1356
1357
1358
class TestRemoveCmd(TestCmd):
1359
def test_remove(self):
1360
class MockMandos(object):
1361
def __init__(self):
1362
self.calls = []
1363
def RemoveClient(self, dbus_path):
1364
self.calls.append(("RemoveClient", (dbus_path,)))
1365
mandos = MockMandos()
1366
super(TestRemoveCmd, self).setUp()
1367
RemoveCmd().run(self.clients, self.bus, mandos)
1368
self.assertEqual(len(mandos.calls), 2)
1369
for clientpath in self.clients:
1370
self.assertIn(("RemoveClient", (clientpath,)),
1371
mandos.calls)
1372
1373
1374
class TestDumpJSONCmd(TestCmd):
1375
def setUp(self):
1376
self.expected_json = {
1377
"foo": {
2037
class FakeMandosBus(dbus.MandosBus):
2038
def __init__(self, testcase):
2039
self.client_properties = {
1378
2040
"Name": "foo",
1379
2041
"KeyID": ("92ed150794387c03ce684574b1139a65"
1380
2042
"94a34f895daaaf09fd8ea90a27cddb12"),
2043
"Secret": b"secret",
1381
2044
"Host": "foo.example.org",
1382
2045
"Enabled": True,
1383
2046
"Timeout": 300000,
1397
2060
"ExtendedTimeout": 900000,
1398
2061
"Expires": "2019-02-04T00:00:00",
1399
2062
"LastCheckerStatus": 0,
1400
},
1401
"barbar": {
2063
}
2064
self.other_client_properties = {
1402
2065
"Name": "barbar",
1403
2066
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1404
2067
"6ab612cff5ad227247e46c2b020f441c"),
2068
"Secret": b"secretbar",
1405
2069
"Host": "192.0.2.3",
1406
2070
"Enabled": True,
1407
2071
"Timeout": 300000,
1421
2085
"ExtendedTimeout": 900000,
1422
2086
"Expires": "2019-02-05T00:00:00",
1423
2087
"LastCheckerStatus": -2,
1424
},
1425
}
1426
return super(TestDumpJSONCmd, self).setUp()
1427
1428
def test_normal(self):
1429
output = DumpJSONCmd().output(self.clients.values())
1430
json_data = json.loads(output)
1431
self.assertDictEqual(json_data, self.expected_json)
1432
1433
def test_one_client(self):
1434
output = DumpJSONCmd().output(self.one_client.values())
1435
json_data = json.loads(output)
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())
1436
2244
expected_json = {"foo": self.expected_json["foo"]}
1437
self.assertDictEqual(json_data, expected_json)
1438
1439
1440
class TestPrintTableCmd(TestCmd):
1441
def test_normal(self):
1442
output = PrintTableCmd().output(self.clients.values())
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)
1443
2250
expected_output = "\n".join((
1444
2251
"Name Enabled Timeout Last Successful Check",
1445
2252
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1446
2253
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1447
))
1448
self.assertEqual(output, expected_output)
2254
)) + "\n"
2255
self.assertEqual(expected_output, buffer.getvalue())
1449
2256
1450
def test_verbose(self):
1451
output = PrintTableCmd(verbose=True).output(
1452
self.clients.values())
2257
def test_PrintTable_verbose(self):
2258
with self.capture_stdout_to_buffer() as buffer:
2259
command.PrintTable(verbose=True).run(self.bus.clients)
1453
2260
columns = (
1454
2261
(
1455
2262
"Name ",
1537
2344
)
1538
2345
)
1539
2346
num_lines = max(len(rows) for rows in columns)
1540
expected_output = "\n".join("".join(rows[line]
1541
for rows in columns)
1542
for line in range(num_lines))
1543
self.assertEqual(output, expected_output)
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())
1544
2352
1545
def test_one_client(self):
1546
output = PrintTableCmd().output(self.one_client.values())
2353
def test_PrintTable_one_client(self):
2354
with self.capture_stdout_to_buffer() as buffer:
2355
command.PrintTable().run(self.bus.one_client)
1547
2356
expected_output = "\n".join((
1548
2357
"Name Enabled Timeout Last Successful Check",
1549
2358
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1550
))
1551
self.assertEqual(output, expected_output)
1552
1553
1554
class TestPropertyCmd(TestCmd):
1555
"""Abstract class for tests of PropertyCmd classes"""
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
1556
2366
def runTest(self):
1557
2367
if not hasattr(self, "command"):
1558
return
1559
values_to_get = getattr(self, "values_to_get",
1560
self.values_to_set)
1561
for value_to_set, value_to_get in zip(self.values_to_set,
1562
values_to_get):
1563
for clientpath in self.clients:
1564
client = self.bus.get_object(dbus_busname, clientpath)
1565
old_value = client.attributes[self.propname]
1566
self.assertNotIsInstance(old_value, self.Unique)
1567
client.attributes[self.propname] = self.Unique()
1568
self.run_command(value_to_set, self.clients)
1569
for clientpath in self.clients:
1570
client = self.bus.get_object(dbus_busname, clientpath)
1571
value = client.attributes[self.propname]
1572
self.assertNotIsInstance(value, self.Unique)
1573
self.assertEqual(value, value_to_get)
1574
1575
class Unique(object):
1576
"""Class for objects which exist only to be unique objects,
1577
since unittest.mock.sentinel only exists in Python 3.3"""
1578
1579
def run_command(self, value, clients):
1580
self.command().run(clients, self.bus)
1581
1582
1583
class TestEnableCmd(TestPropertyCmd):
1584
command = EnableCmd
1585
propname = "Enabled"
1586
values_to_set = [dbus.Boolean(True)]
1587
1588
1589
class TestDisableCmd(TestPropertyCmd):
1590
command = DisableCmd
1591
propname = "Enabled"
1592
values_to_set = [dbus.Boolean(False)]
1593
1594
1595
class TestBumpTimeoutCmd(TestPropertyCmd):
1596
command = BumpTimeoutCmd
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
1597
2403
propname = "LastCheckedOK"
1598
values_to_set = [""]
1599
1600
1601
class TestStartCheckerCmd(TestPropertyCmd):
1602
command = StartCheckerCmd
1603
propname = "CheckerRunning"
1604
values_to_set = [dbus.Boolean(True)]
1605
1606
1607
class TestStopCheckerCmd(TestPropertyCmd):
1608
command = StopCheckerCmd
1609
propname = "CheckerRunning"
1610
values_to_set = [dbus.Boolean(False)]
1611
1612
1613
class TestApproveByDefaultCmd(TestPropertyCmd):
1614
command = ApproveByDefaultCmd
1615
propname = "ApprovedByDefault"
1616
values_to_set = [dbus.Boolean(True)]
1617
1618
1619
class TestDenyByDefaultCmd(TestPropertyCmd):
1620
command = DenyByDefaultCmd
1621
propname = "ApprovedByDefault"
1622
values_to_set = [dbus.Boolean(False)]
1623
1624
1625
class TestPropertyValueCmd(TestPropertyCmd):
1626
"""Abstract class for tests of PropertyValueCmd classes"""
1627
1628
def runTest(self):
1629
if type(self) is TestPropertyValueCmd:
1630
return
1631
return super(TestPropertyValueCmd, self).runTest()
1632
1633
def run_command(self, value, clients):
1634
self.command(value).run(clients, self.bus)
1635
1636
1637
class TestSetCheckerCmd(TestPropertyValueCmd):
1638
command = SetCheckerCmd
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
1639
2433
propname = "Checker"
1640
2434
values_to_set = ["", ":", "fping -q -- %s"]
1641
2435
1642
2436
1643
class TestSetHostCmd(TestPropertyValueCmd):
1644
command = SetHostCmd
2437
class TestSetHostCmd(TestPropertySetterCmd):
2438
command = command.SetHost
1645
2439
propname = "Host"
1646
values_to_set = ["192.0.2.3", "foo.example.org"]
1647
1648
1649
class TestSetSecretCmd(TestPropertyValueCmd):
1650
command = SetSecretCmd
2440
values_to_set = ["192.0.2.3", "client.example.org"]
2441
2442
2443
class TestSetSecretCmd(TestPropertySetterCmd):
2444
command = command.SetSecret
1651
2445
propname = "Secret"
1652
2446
values_to_set = [io.BytesIO(b""),
1653
2447
io.BytesIO(b"secret\0xyzzy\nbar")]
1654
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1655
1656
1657
class TestSetTimeoutCmd(TestPropertyValueCmd):
1658
command = SetTimeoutCmd
2448
values_to_get = [f.getvalue() for f in values_to_set]
2449
2450
2451
class TestSetTimeoutCmd(TestPropertySetterCmd):
2452
command = command.SetTimeout
1659
2453
propname = "Timeout"
1660
2454
values_to_set = [datetime.timedelta(),
1661
2455
datetime.timedelta(minutes=5),
1662
2456
datetime.timedelta(seconds=1),
1663
2457
datetime.timedelta(weeks=1),
1664
2458
datetime.timedelta(weeks=52)]
1665
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1666
1667
1668
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1669
command = SetExtendedTimeoutCmd
2459
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2460
2461
2462
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2463
command = command.SetExtendedTimeout
1670
2464
propname = "ExtendedTimeout"
1671
2465
values_to_set = [datetime.timedelta(),
1672
2466
datetime.timedelta(minutes=5),
1673
2467
datetime.timedelta(seconds=1),
1674
2468
datetime.timedelta(weeks=1),
1675
2469
datetime.timedelta(weeks=52)]
1676
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1677
1678
1679
class TestSetIntervalCmd(TestPropertyValueCmd):
1680
command = SetIntervalCmd
2470
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2471
2472
2473
class TestSetIntervalCmd(TestPropertySetterCmd):
2474
command = command.SetInterval
1681
2475
propname = "Interval"
1682
2476
values_to_set = [datetime.timedelta(),
1683
2477
datetime.timedelta(minutes=5),
1684
2478
datetime.timedelta(seconds=1),
1685
2479
datetime.timedelta(weeks=1),
1686
2480
datetime.timedelta(weeks=52)]
1687
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1688
1689
1690
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1691
command = SetApprovalDelayCmd
2481
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2482
2483
2484
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2485
command = command.SetApprovalDelay
1692
2486
propname = "ApprovalDelay"
1693
2487
values_to_set = [datetime.timedelta(),
1694
2488
datetime.timedelta(minutes=5),
1695
2489
datetime.timedelta(seconds=1),
1696
2490
datetime.timedelta(weeks=1),
1697
2491
datetime.timedelta(weeks=52)]
1698
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1699
1700
1701
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1702
command = SetApprovalDurationCmd
2492
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2493
2494
2495
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2496
command = command.SetApprovalDuration
1703
2497
propname = "ApprovalDuration"
1704
2498
values_to_set = [datetime.timedelta(),
1705
2499
datetime.timedelta(minutes=5),
1706
2500
datetime.timedelta(seconds=1),
1707
2501
datetime.timedelta(weeks=1),
1708
2502
datetime.timedelta(weeks=52)]
1709
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2503
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1710
2504
1711
2505
1712
2506
1727
2521
return tests
1728
2522
1729
2523
if __name__ == "__main__":
1730
if should_only_run_tests():
1731
# Call using ./tdd-python-script --check [--verbose]
1732
unittest.main()
1733
else:
1734
main()
2524
try:
2525
if should_only_run_tests():
2526
# Call using ./tdd-python-script --check [--verbose]
2527
unittest.main()
2528
else:
2529
main()
2530
finally:
2531
logging.shutdown()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0