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