To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1048
- compare with another revision
- download diff
- download tarball
- view history from revision 1048
- Committer: Teddy Hogeborn
- Date: 2019-03-09 18:53:46 UTC
- Revision ID: teddy@recompile.se-20190309185346-9a1sjer0ao7p0qj2
mandos-ctl: Add abstract method and attribute
* mandos-ctl (PrintCmd.output): New abstract method.
(PropertyCmd.propname): Add abstract property
* mandos-ctl (PrintCmd.output): New abstract method.
(PropertyCmd.propname): Add abstract property
- 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.11"
93
94
95
def main():
96
parser = argparse.ArgumentParser()
97
add_command_line_options(parser)
98
99
options = parser.parse_args()
100
check_option_syntax(parser, options)
101
102
clientnames = options.client
103
104
if options.debug:
105
log.setLevel(logging.DEBUG)
106
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)
123
124
# Compile dict of (clientpath: properties) to process
125
if not clientnames:
126
clients = all_clients
127
else:
128
clients = {}
129
for name in clientnames:
130
for objpath, properties in all_clients.items():
131
if properties["Name"] == name:
132
clients[objpath] = properties
133
break
134
else:
135
log.critical("Client not found on server: %r", name)
136
sys.exit(1)
137
138
commands = commands_from_options(options)
139
140
for command in commands:
141
command.run(clients, bus)
142
143
144
def add_command_line_options(parser):
145
parser.add_argument("--version", action="version",
146
version="%(prog)s {}".format(version),
147
help="show version number and exit")
148
parser.add_argument("-a", "--all", action="store_true",
149
help="Select all clients")
150
parser.add_argument("-v", "--verbose", action="store_true",
151
help="Print all fields")
152
parser.add_argument("-j", "--dump-json", dest="commands",
153
action="append_const", default=[],
154
const=command.DumpJSON(),
155
help="Dump client data in JSON format")
156
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(),
160
help="Enable client")
161
enable_disable.add_argument("-d", "--disable", dest="commands",
162
action="append_const", default=[],
163
const=command.Disable(),
164
help="disable client")
165
parser.add_argument("-b", "--bump-timeout", dest="commands",
166
action="append_const", default=[],
167
const=command.BumpTimeout(),
168
help="Bump timeout for client")
169
start_stop_checker = parser.add_mutually_exclusive_group()
170
start_stop_checker.add_argument("--start-checker",
171
dest="commands",
172
action="append_const", default=[],
173
const=command.StartChecker(),
174
help="Start checker for client")
175
start_stop_checker.add_argument("--stop-checker", dest="commands",
176
action="append_const", default=[],
177
const=command.StopChecker(),
178
help="Stop checker for client")
179
parser.add_argument("-V", "--is-enabled", dest="commands",
180
action="append_const", default=[],
181
const=command.IsEnabled(),
182
help="Check if client is enabled")
183
parser.add_argument("-r", "--remove", dest="commands",
184
action="append_const", default=[],
185
const=command.Remove(),
186
help="Remove client")
187
parser.add_argument("-c", "--checker", dest="commands",
188
action="append", default=[],
189
metavar="COMMAND", type=command.SetChecker,
190
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")
206
approve_deny_default = parser.add_mutually_exclusive_group()
207
approve_deny_default.add_argument(
208
"--approve-by-default", dest="commands",
209
action="append_const", default=[],
210
const=command.ApproveByDefault(),
211
help="Set client to be approved by default")
212
approve_deny_default.add_argument(
213
"--deny-by-default", dest="commands",
214
action="append_const", default=[],
215
const=command.DenyByDefault(),
216
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")
236
approve_deny = parser.add_mutually_exclusive_group()
237
approve_deny.add_argument(
238
"-A", "--approve", dest="commands", action="append_const",
239
default=[], const=command.Approve(),
240
help="Approve any current client request")
241
approve_deny.add_argument("-D", "--deny", dest="commands",
242
action="append_const", default=[],
243
const=command.Deny(),
244
help="Deny any current client request")
245
parser.add_argument("--debug", action="store_true",
246
help="Debug mode (show D-Bus commands)")
247
parser.add_argument("--check", action="store_true",
248
help="Run self-test")
249
parser.add_argument("client", nargs="*", help="Client name")
250
251
252
def string_to_delta(interval):
253
"""Parse a string and return a datetime.timedelta"""
254
255
try:
256
return rfc3339_duration_to_delta(interval)
257
except ValueError as e:
258
log.warning("%s - Parsing as pre-1.6.1 interval instead",
259
' '.join(e.args))
260
return parse_pre_1_6_1_interval(interval)
67
domain = "se.recompile"
68
busname = domain + ".Mandos"
69
server_path = "/"
70
server_interface = domain + ".Mandos"
71
client_interface = domain + ".Mandos.Client"
72
version = "1.8.3"
73
74
75
try:
76
dbus.OBJECT_MANAGER_IFACE
77
except AttributeError:
78
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
79
80
81
def milliseconds_to_string(ms):
82
td = datetime.timedelta(0, 0, 0, ms)
83
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
84
.format(days="{}T".format(td.days) if td.days else "",
85
hours=td.seconds // 3600,
86
minutes=(td.seconds % 3600) // 60,
87
seconds=td.seconds % 60))
261
88
262
89
263
90
def rfc3339_duration_to_delta(duration):
264
91
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
265
92
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
93
>>> rfc3339_duration_to_delta("P7D")
94
datetime.timedelta(7)
95
>>> rfc3339_duration_to_delta("PT60S")
96
datetime.timedelta(0, 60)
97
>>> rfc3339_duration_to_delta("PT60M")
98
datetime.timedelta(0, 3600)
99
>>> rfc3339_duration_to_delta("P60M")
100
datetime.timedelta(1680)
101
>>> rfc3339_duration_to_delta("PT24H")
102
datetime.timedelta(1)
103
>>> rfc3339_duration_to_delta("P1W")
104
datetime.timedelta(7)
105
>>> rfc3339_duration_to_delta("PT5M30S")
106
datetime.timedelta(0, 330)
107
>>> rfc3339_duration_to_delta("P1DT3M20S")
108
datetime.timedelta(1, 200)
283
109
>>> # Can not be empty:
284
110
>>> rfc3339_duration_to_delta("")
285
111
Traceback (most recent call last):
286
112
...
287
ValueError: Invalid RFC 3339 duration: ""
113
ValueError: Invalid RFC 3339 duration: u''
288
114
>>> # Must start with "P":
289
115
>>> rfc3339_duration_to_delta("1D")
290
116
Traceback (most recent call last):
291
117
...
292
ValueError: Invalid RFC 3339 duration: "1D"
118
ValueError: Invalid RFC 3339 duration: u'1D'
293
119
>>> # Must use correct order
294
120
>>> rfc3339_duration_to_delta("PT1S2M")
295
121
Traceback (most recent call last):
296
122
...
297
ValueError: Invalid RFC 3339 duration: "PT1S2M"
123
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
298
124
>>> # Time needs time marker
299
125
>>> rfc3339_duration_to_delta("P1H2S")
300
126
Traceback (most recent call last):
301
127
...
302
ValueError: Invalid RFC 3339 duration: "P1H2S"
128
ValueError: Invalid RFC 3339 duration: u'P1H2S'
303
129
>>> # Weeks can not be combined with anything else
304
130
>>> rfc3339_duration_to_delta("P1D2W")
305
131
Traceback (most recent call last):
306
132
...
307
ValueError: Invalid RFC 3339 duration: "P1D2W"
133
ValueError: Invalid RFC 3339 duration: u'P1D2W'
308
134
>>> rfc3339_duration_to_delta("P2W2H")
309
135
Traceback (most recent call last):
310
136
...
311
ValueError: Invalid RFC 3339 duration: "P2W2H"
137
ValueError: Invalid RFC 3339 duration: u'P2W2H'
312
138
"""
313
139
314
140
# Parsing an RFC 3339 duration with regular expressions is not
385
211
break
386
212
else:
387
213
# No currently valid tokens were found
388
raise ValueError("Invalid RFC 3339 duration: \"{}\""
214
raise ValueError("Invalid RFC 3339 duration: {!r}"
389
215
.format(duration))
390
216
# End token found
391
217
return value
392
218
393
219
220
def string_to_delta(interval):
221
"""Parse a string and return a datetime.timedelta"""
222
223
try:
224
return rfc3339_duration_to_delta(interval)
225
except ValueError as e:
226
log.warning("%s - Parsing as pre-1.6.1 interval instead",
227
' '.join(e.args))
228
return parse_pre_1_6_1_interval(interval)
229
230
394
231
def parse_pre_1_6_1_interval(interval):
395
232
"""Parse an interval string as documented by Mandos before 1.6.1,
396
233
and return a datetime.timedelta
397
234
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
235
>>> parse_pre_1_6_1_interval('7d')
236
datetime.timedelta(7)
237
>>> parse_pre_1_6_1_interval('60s')
238
datetime.timedelta(0, 60)
239
>>> parse_pre_1_6_1_interval('60m')
240
datetime.timedelta(0, 3600)
241
>>> parse_pre_1_6_1_interval('24h')
242
datetime.timedelta(1)
243
>>> parse_pre_1_6_1_interval('1w')
244
datetime.timedelta(7)
245
>>> parse_pre_1_6_1_interval('5m 30s')
246
datetime.timedelta(0, 330)
247
>>> parse_pre_1_6_1_interval('')
248
datetime.timedelta(0)
412
249
>>> # Ignore unknown characters, allow any order and repetitions
413
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m') == datetime.timedelta(2, 480, 18000)
414
True
250
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
251
datetime.timedelta(2, 480, 18000)
415
252
416
253
"""
417
254
434
271
return value
435
272
436
273
274
## Classes for commands.
275
276
# Abstract classes first
277
class Command(object):
278
"""Abstract class for commands"""
279
def run(self, mandos, clients):
280
"""Normal commands should implement run_on_one_client(), but
281
commands which want to operate on all clients at the same time
282
can override this run() method instead."""
283
self.mandos = mandos
284
for client, properties in clients.items():
285
self.run_on_one_client(client, properties)
286
287
class PrintCmd(Command):
288
"""Abstract class for commands printing client details"""
289
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
290
"Created", "Interval", "Host", "KeyID",
291
"Fingerprint", "CheckerRunning", "LastEnabled",
292
"ApprovalPending", "ApprovedByDefault",
293
"LastApprovalRequest", "ApprovalDelay",
294
"ApprovalDuration", "Checker", "ExtendedTimeout",
295
"Expires", "LastCheckerStatus")
296
def run(self, mandos, clients):
297
print(self.output(clients.values()))
298
def output(self, clients):
299
raise NotImplementedError()
300
301
class PropertyCmd(Command):
302
"""Abstract class for Actions for setting one client property"""
303
def run_on_one_client(self, client, properties):
304
"""Set the Client's D-Bus property"""
305
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
306
client.__dbus_object_path__,
307
dbus.PROPERTIES_IFACE, client_interface,
308
self.propname, self.value_to_set
309
if not isinstance(self.value_to_set, dbus.Boolean)
310
else bool(self.value_to_set))
311
client.Set(client_interface, self.propname, self.value_to_set,
312
dbus_interface=dbus.PROPERTIES_IFACE)
313
@property
314
def propname(self):
315
raise NotImplementedError()
316
317
class ValueArgumentMixIn(object):
318
"""Mixin class for commands taking a value as argument"""
319
def __init__(self, value):
320
self.value_to_set = value
321
322
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
323
"""Mixin class for commands taking a value argument as
324
milliseconds."""
325
@property
326
def value_to_set(self):
327
return self._vts
328
@value_to_set.setter
329
def value_to_set(self, value):
330
"""When setting, convert value to a datetime.timedelta"""
331
self._vts = int(round(value.total_seconds() * 1000))
332
333
# Actual (non-abstract) command classes
334
335
class PrintTableCmd(PrintCmd):
336
def __init__(self, verbose=False):
337
self.verbose = verbose
338
339
def output(self, clients):
340
default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
341
keywords = default_keywords
342
if self.verbose:
343
keywords = self.all_keywords
344
return str(self.TableOfClients(clients, keywords))
345
346
class TableOfClients(object):
347
tableheaders = {
348
"Name": "Name",
349
"Enabled": "Enabled",
350
"Timeout": "Timeout",
351
"LastCheckedOK": "Last Successful Check",
352
"LastApprovalRequest": "Last Approval Request",
353
"Created": "Created",
354
"Interval": "Interval",
355
"Host": "Host",
356
"Fingerprint": "Fingerprint",
357
"KeyID": "Key ID",
358
"CheckerRunning": "Check Is Running",
359
"LastEnabled": "Last Enabled",
360
"ApprovalPending": "Approval Is Pending",
361
"ApprovedByDefault": "Approved By Default",
362
"ApprovalDelay": "Approval Delay",
363
"ApprovalDuration": "Approval Duration",
364
"Checker": "Checker",
365
"ExtendedTimeout": "Extended Timeout",
366
"Expires": "Expires",
367
"LastCheckerStatus": "Last Checker Status",
368
}
369
370
def __init__(self, clients, keywords, tableheaders=None):
371
self.clients = clients
372
self.keywords = keywords
373
if tableheaders is not None:
374
self.tableheaders = tableheaders
375
376
def __str__(self):
377
return "\n".join(self.rows())
378
379
if sys.version_info.major == 2:
380
__unicode__ = __str__
381
def __str__(self):
382
return str(self).encode(locale.getpreferredencoding())
383
384
def rows(self):
385
format_string = self.row_formatting_string()
386
rows = [self.header_line(format_string)]
387
rows.extend(self.client_line(client, format_string)
388
for client in self.clients)
389
return rows
390
391
def row_formatting_string(self):
392
"Format string used to format table rows"
393
return " ".join("{{{key}:{width}}}".format(
394
width=max(len(self.tableheaders[key]),
395
*(len(self.string_from_client(client, key))
396
for client in self.clients)),
397
key=key)
398
for key in self.keywords)
399
400
def string_from_client(self, client, key):
401
return self.valuetostring(client[key], key)
402
403
@staticmethod
404
def valuetostring(value, keyword):
405
if isinstance(value, dbus.Boolean):
406
return "Yes" if value else "No"
407
if keyword in ("Timeout", "Interval", "ApprovalDelay",
408
"ApprovalDuration", "ExtendedTimeout"):
409
return milliseconds_to_string(value)
410
return str(value)
411
412
def header_line(self, format_string):
413
return format_string.format(**self.tableheaders)
414
415
def client_line(self, client, format_string):
416
return format_string.format(
417
**{key: self.string_from_client(client, key)
418
for key in self.keywords})
419
420
421
422
class DumpJSONCmd(PrintCmd):
423
def output(self, clients):
424
data = {client["Name"]:
425
{key: self.dbus_boolean_to_bool(client[key])
426
for key in self.all_keywords}
427
for client in clients.values()}
428
return json.dumps(data, indent=4, separators=(',', ': '))
429
@staticmethod
430
def dbus_boolean_to_bool(value):
431
if isinstance(value, dbus.Boolean):
432
value = bool(value)
433
return value
434
435
class IsEnabledCmd(Command):
436
def run_on_one_client(self, client, properties):
437
if self.is_enabled(client, properties):
438
sys.exit(0)
439
sys.exit(1)
440
def is_enabled(self, client, properties):
441
log.debug("D-Bus: %s:%s:%s.Get(%r, %r)", busname,
442
client.__dbus_object_path__,
443
dbus.PROPERTIES_IFACE, client_interface,
444
"Enabled")
445
return bool(client.Get(client_interface, "Enabled",
446
dbus_interface=dbus.PROPERTIES_IFACE))
447
448
class RemoveCmd(Command):
449
def run_on_one_client(self, client, properties):
450
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", busname,
451
server_path, server_interface,
452
str(client.__dbus_object_path__))
453
self.mandos.RemoveClient(client.__dbus_object_path__)
454
455
class ApproveCmd(Command):
456
def run_on_one_client(self, client, properties):
457
log.debug("D-Bus: %s:%s.Approve(True)",
458
client.__dbus_object_path__, client_interface)
459
client.Approve(dbus.Boolean(True),
460
dbus_interface=client_interface)
461
462
class DenyCmd(Command):
463
def run_on_one_client(self, client, properties):
464
log.debug("D-Bus: %s:%s.Approve(False)",
465
client.__dbus_object_path__, client_interface)
466
client.Approve(dbus.Boolean(False),
467
dbus_interface=client_interface)
468
469
class EnableCmd(PropertyCmd):
470
propname = "Enabled"
471
value_to_set = dbus.Boolean(True)
472
473
class DisableCmd(PropertyCmd):
474
propname = "Enabled"
475
value_to_set = dbus.Boolean(False)
476
477
class BumpTimeoutCmd(PropertyCmd):
478
propname = "LastCheckedOK"
479
value_to_set = ""
480
481
class StartCheckerCmd(PropertyCmd):
482
propname = "CheckerRunning"
483
value_to_set = dbus.Boolean(True)
484
485
class StopCheckerCmd(PropertyCmd):
486
propname = "CheckerRunning"
487
value_to_set = dbus.Boolean(False)
488
489
class ApproveByDefaultCmd(PropertyCmd):
490
propname = "ApprovedByDefault"
491
value_to_set = dbus.Boolean(True)
492
493
class DenyByDefaultCmd(PropertyCmd):
494
propname = "ApprovedByDefault"
495
value_to_set = dbus.Boolean(False)
496
497
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
498
propname = "Checker"
499
500
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
501
propname = "Host"
502
503
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
504
propname = "Secret"
505
@property
506
def value_to_set(self):
507
return self._vts
508
@value_to_set.setter
509
def value_to_set(self, value):
510
"""When setting, read data from supplied file object"""
511
self._vts = value.read()
512
value.close()
513
514
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
515
propname = "Timeout"
516
517
class SetExtendedTimeoutCmd(PropertyCmd,
518
MillisecondsValueArgumentMixIn):
519
propname = "ExtendedTimeout"
520
521
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
522
propname = "Interval"
523
524
class SetApprovalDelayCmd(PropertyCmd,
525
MillisecondsValueArgumentMixIn):
526
propname = "ApprovalDelay"
527
528
class SetApprovalDurationCmd(PropertyCmd,
529
MillisecondsValueArgumentMixIn):
530
propname = "ApprovalDuration"
531
532
def add_command_line_options(parser):
533
parser.add_argument("--version", action="version",
534
version="%(prog)s {}".format(version),
535
help="show version number and exit")
536
parser.add_argument("-a", "--all", action="store_true",
537
help="Select all clients")
538
parser.add_argument("-v", "--verbose", action="store_true",
539
help="Print all fields")
540
parser.add_argument("-j", "--dump-json", action="store_true",
541
help="Dump client data in JSON format")
542
enable_disable = parser.add_mutually_exclusive_group()
543
enable_disable.add_argument("-e", "--enable", action="store_true",
544
help="Enable client")
545
enable_disable.add_argument("-d", "--disable",
546
action="store_true",
547
help="disable client")
548
parser.add_argument("-b", "--bump-timeout", action="store_true",
549
help="Bump timeout for client")
550
start_stop_checker = parser.add_mutually_exclusive_group()
551
start_stop_checker.add_argument("--start-checker",
552
action="store_true",
553
help="Start checker for client")
554
start_stop_checker.add_argument("--stop-checker",
555
action="store_true",
556
help="Stop checker for client")
557
parser.add_argument("-V", "--is-enabled", action="store_true",
558
help="Check if client is enabled")
559
parser.add_argument("-r", "--remove", action="store_true",
560
help="Remove client")
561
parser.add_argument("-c", "--checker",
562
help="Set checker command for client")
563
parser.add_argument("-t", "--timeout", type=string_to_delta,
564
help="Set timeout for client")
565
parser.add_argument("--extended-timeout", type=string_to_delta,
566
help="Set extended timeout for client")
567
parser.add_argument("-i", "--interval", type=string_to_delta,
568
help="Set checker interval for client")
569
approve_deny_default = parser.add_mutually_exclusive_group()
570
approve_deny_default.add_argument(
571
"--approve-by-default", action="store_true",
572
default=None, dest="approved_by_default",
573
help="Set client to be approved by default")
574
approve_deny_default.add_argument(
575
"--deny-by-default", action="store_false",
576
dest="approved_by_default",
577
help="Set client to be denied by default")
578
parser.add_argument("--approval-delay", type=string_to_delta,
579
help="Set delay before client approve/deny")
580
parser.add_argument("--approval-duration", type=string_to_delta,
581
help="Set duration of one client approval")
582
parser.add_argument("-H", "--host", help="Set host for client")
583
parser.add_argument("-s", "--secret",
584
type=argparse.FileType(mode="rb"),
585
help="Set password blob (file) for client")
586
approve_deny = parser.add_mutually_exclusive_group()
587
approve_deny.add_argument(
588
"-A", "--approve", action="store_true",
589
help="Approve any current client request")
590
approve_deny.add_argument("-D", "--deny", action="store_true",
591
help="Deny any current client request")
592
parser.add_argument("--debug", action="store_true",
593
help="Debug mode (show D-Bus commands)")
594
parser.add_argument("--check", action="store_true",
595
help="Run self-test")
596
parser.add_argument("client", nargs="*", help="Client name")
597
598
599
def commands_from_options(options):
600
601
commands = []
602
603
if options.dump_json:
604
commands.append(DumpJSONCmd())
605
606
if options.enable:
607
commands.append(EnableCmd())
608
609
if options.disable:
610
commands.append(DisableCmd())
611
612
if options.bump_timeout:
613
commands.append(BumpTimeoutCmd())
614
615
if options.start_checker:
616
commands.append(StartCheckerCmd())
617
618
if options.stop_checker:
619
commands.append(StopCheckerCmd())
620
621
if options.is_enabled:
622
commands.append(IsEnabledCmd())
623
624
if options.checker is not None:
625
commands.append(SetCheckerCmd(options.checker))
626
627
if options.timeout is not None:
628
commands.append(SetTimeoutCmd(options.timeout))
629
630
if options.extended_timeout:
631
commands.append(
632
SetExtendedTimeoutCmd(options.extended_timeout))
633
634
if options.interval is not None:
635
commands.append(SetIntervalCmd(options.interval))
636
637
if options.approved_by_default is not None:
638
if options.approved_by_default:
639
commands.append(ApproveByDefaultCmd())
640
else:
641
commands.append(DenyByDefaultCmd())
642
643
if options.approval_delay is not None:
644
commands.append(SetApprovalDelayCmd(options.approval_delay))
645
646
if options.approval_duration is not None:
647
commands.append(
648
SetApprovalDurationCmd(options.approval_duration))
649
650
if options.host is not None:
651
commands.append(SetHostCmd(options.host))
652
653
if options.secret is not None:
654
commands.append(SetSecretCmd(options.secret))
655
656
if options.approve:
657
commands.append(ApproveCmd())
658
659
if options.deny:
660
commands.append(DenyCmd())
661
662
if options.remove:
663
commands.append(RemoveCmd())
664
665
# If no command option has been given, show table of clients,
666
# optionally verbosely
667
if not commands:
668
commands.append(PrintTableCmd(verbose=options.verbose))
669
670
return commands
671
672
437
673
def check_option_syntax(parser, options):
438
674
"""Apply additional restrictions on options, not expressible in
439
675
argparse"""
440
676
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)
677
def has_actions(options):
678
return any((options.enable,
679
options.disable,
680
options.bump_timeout,
681
options.start_checker,
682
options.stop_checker,
683
options.is_enabled,
684
options.remove,
685
options.checker is not None,
686
options.timeout is not None,
687
options.extended_timeout is not None,
688
options.interval is not None,
689
options.approved_by_default is not None,
690
options.approval_delay is not None,
691
options.approval_duration is not None,
692
options.host is not None,
693
options.secret is not None,
694
options.approve,
695
options.deny))
464
696
465
if has_commands(options) and not (options.client or options.all):
697
if has_actions(options) and not (options.client or options.all):
466
698
parser.error("Options require clients names or --all.")
467
if options.verbose and has_commands(options):
699
if options.verbose and has_actions(options):
468
700
parser.error("--verbose can only be used alone.")
469
if (has_commands(options, (command.DumpJSON,))
470
and (options.verbose or len(options.commands) > 1)):
701
if options.dump_json and (options.verbose
702
or has_actions(options)):
471
703
parser.error("--dump-json can only be used alone.")
472
if options.all and not has_commands(options):
704
if options.all and not has_actions(options):
473
705
parser.error("--all requires an action.")
474
if (has_commands(options, (command.IsEnabled,))
475
and len(options.client) > 1):
706
if options.is_enabled and len(options.client) > 1:
476
707
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
787
788
789
def commands_from_options(options):
790
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)
809
else:
810
cleaned_after.append(cmd)
811
if cleaned_after != after_remove:
812
commands = before_remove + cleaned_after
813
814
# If no command option has been given, show table of clients,
815
# optionally verbosely
816
if not commands:
817
commands.append(command.PrintTable(verbose=options.verbose))
818
819
return commands
820
821
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
922
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
1032
1033
@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"
1094
708
if options.remove:
709
options.remove = False
710
if has_actions(options) and not options.deny:
711
parser.error("--remove can only be combined with --deny")
712
options.remove = True
713
714
715
def main():
716
parser = argparse.ArgumentParser()
717
718
add_command_line_options(parser)
719
720
options = parser.parse_args()
721
722
check_option_syntax(parser, options)
723
724
clientnames = options.client
725
726
if options.debug:
727
log.setLevel(logging.DEBUG)
728
729
try:
730
bus = dbus.SystemBus()
731
log.debug("D-Bus: Connect to: (name=%r, path=%r)", busname,
732
server_path)
733
mandos_dbus_objc = bus.get_object(busname, server_path)
734
except dbus.exceptions.DBusException:
735
log.critical("Could not connect to Mandos server")
736
sys.exit(1)
737
738
mandos_serv = dbus.Interface(mandos_dbus_objc,
739
dbus_interface=server_interface)
740
mandos_serv_object_manager = dbus.Interface(
741
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
742
743
# Filter out log message from dbus module
744
dbus_logger = logging.getLogger("dbus.proxies")
745
class NullFilter(logging.Filter):
746
def filter(self, record):
747
return False
748
dbus_filter = NullFilter()
749
try:
750
dbus_logger.addFilter(dbus_filter)
751
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", busname,
752
server_path, dbus.OBJECT_MANAGER_IFACE)
753
mandos_clients = {path: ifs_and_props[client_interface]
754
for path, ifs_and_props in
755
mandos_serv_object_manager
756
.GetManagedObjects().items()
757
if client_interface in ifs_and_props}
758
except dbus.exceptions.DBusException as e:
759
log.critical("Failed to access Mandos server through D-Bus:"
760
"\n%s", e)
761
sys.exit(1)
762
finally:
763
# restore dbus logger
764
dbus_logger.removeFilter(dbus_filter)
765
766
# Compile dict of (clients: properties) to process
767
clients = {}
768
769
if not clientnames:
770
clients = {(log.debug("D-Bus: Connect to: (name=%r, path=%r)",
771
busname, str(path)) and False) or
772
bus.get_object(busname, path): properties
773
for path, properties in mandos_clients.items()}
774
else:
775
for name in clientnames:
776
for path, client in mandos_clients.items():
777
if client["Name"] == name:
778
log.debug("D-Bus: Connect to: (name=%r, path=%r)",
779
busname, str(path))
780
client_objc = bus.get_object(busname, path)
781
clients[client_objc] = client
782
break
783
else:
784
log.critical("Client not found on server: %r", name)
785
sys.exit(1)
786
787
# Run all commands on clients
788
commands = commands_from_options(options)
789
for command in commands:
790
command.run(mandos_serv, clients)
1095
791
1096
792
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"))
1155
793
class Test_milliseconds_to_string(unittest.TestCase):
794
def test_all(self):
795
self.assertEqual(milliseconds_to_string(93785000),
796
"1T02:03:05")
797
def test_no_days(self):
798
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
799
def test_all_zero(self):
800
self.assertEqual(milliseconds_to_string(0), "00:00:00")
801
def test_no_fractional_seconds(self):
802
self.assertEqual(milliseconds_to_string(400), "00:00:00")
803
self.assertEqual(milliseconds_to_string(900), "00:00:00")
804
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
805
806
class Test_string_to_delta(unittest.TestCase):
807
def test_handles_basic_rfc3339(self):
808
self.assertEqual(string_to_delta("PT0S"),
809
datetime.timedelta())
810
self.assertEqual(string_to_delta("P0D"),
811
datetime.timedelta())
812
self.assertEqual(string_to_delta("PT1S"),
813
datetime.timedelta(0, 1))
814
self.assertEqual(string_to_delta("PT2H"),
815
datetime.timedelta(0, 7200))
1156
816
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)
1160
1161
1162
class Test_check_option_syntax(unittest.TestCase):
1163
def setUp(self):
1164
self.parser = argparse.ArgumentParser()
1165
add_command_line_options(self.parser)
1166
1167
def test_actions_requires_client_or_all(self):
1168
for action, value in self.actions.items():
1169
args = self.actionargs(action, value)
1170
with self.assertParseError():
1171
self.parse_args(args)
1172
1173
# This mostly corresponds to the definition from has_commands() in
1174
# check_option_syntax()
1175
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,
1195
}
1196
1197
@staticmethod
1198
def actionargs(action, value, *args):
1199
if value is not None:
1200
return [action, value] + list(args)
817
# assertLogs only exists in Python 3.4
818
if hasattr(self, "assertLogs"):
819
with self.assertLogs(log, logging.WARNING):
820
value = string_to_delta("2h")
1201
821
else:
1202
return [action] + list(args)
1203
1204
@contextlib.contextmanager
1205
def assertParseError(self):
1206
with self.assertRaises(SystemExit) as e:
1207
with self.redirect_stderr_to_devnull():
1208
yield
1209
# Exit code from argparse is guaranteed to be "2". Reference:
1210
# https://docs.python.org/3/library
1211
# /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)
1217
1218
@staticmethod
1219
@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
822
class WarningFilter(logging.Filter):
823
"""Don't show, but record the presence of, warnings"""
824
def filter(self, record):
825
is_warning = record.levelno >= logging.WARNING
826
self.found = is_warning or getattr(self, "found",
827
False)
828
return not is_warning
829
warning_filter = WarningFilter()
830
log.addFilter(warning_filter)
1224
831
try:
1225
yield
832
value = string_to_delta("2h")
1226
833
finally:
1227
sys.stderr = old_stderr
1228
1229
def check_option_syntax(self, options):
1230
check_option_syntax(self.parser, options)
1231
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)
1245
1246
def test_dump_json_conflicts_with_verbose(self):
1247
args = ["--dump-json", "--verbose"]
1248
with self.assertParseError():
1249
self.parse_args(args)
1250
1251
def test_dump_json_conflicts_with_action(self):
1252
for action, value in self.actions.items():
1253
args = self.actionargs(action, value, "--dump-json")
1254
with self.assertParseError():
1255
self.parse_args(args)
1256
1257
def test_all_can_not_be_alone(self):
1258
args = ["--all"]
1259
with self.assertParseError():
1260
self.parse_args(args)
1261
1262
def test_all_is_ok_with_any_action(self):
1263
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)
1294
1295
def test_is_enabled_fails_without_client(self):
1296
args = ["--is-enabled"]
1297
with self.assertParseError():
1298
self.parse_args(args)
1299
1300
def test_is_enabled_fails_with_two_clients(self):
1301
args = ["--is-enabled", "client1", "client2"]
1302
with self.assertParseError():
1303
self.parse_args(args)
1304
1305
def test_remove_can_only_be_combined_with_action_deny(self):
1306
for action, value in self.actions.items():
1307
if action in {"--remove", "--deny"}:
1308
continue
1309
args = self.actionargs(action, value, "--all",
1310
"--remove")
1311
with self.assertParseError():
1312
self.parse_args(args)
1313
1314
1315
class Test_dbus_exceptions(unittest.TestCase):
1316
1317
def test_dbus_ConnectFailed_is_Error(self):
1318
with self.assertRaises(dbus.Error):
1319
raise dbus.ConnectFailed()
1320
1321
1322
class Test_dbus_MandosBus(unittest.TestCase):
1323
1324
class MockMandosBus(dbus.MandosBus):
1325
def __init__(self):
1326
self._name = "se.recompile.Mandos"
1327
self._server_path = "/"
1328
self._server_interface = "se.recompile.Mandos"
1329
self._client_interface = "se.recompile.Mandos.Client"
1330
self.calls = []
1331
self.call_method_return = Unique()
1332
1333
def call_method(self, methodname, busname, objectpath,
1334
interface, *args):
1335
self.calls.append((methodname, busname, objectpath,
1336
interface, args))
1337
return self.call_method_return
1338
1339
def setUp(self):
1340
self.bus = self.MockMandosBus()
1341
1342
def test_set_client_property(self):
1343
self.bus.set_client_property("objectpath", "key", "value")
1344
expected_call = ("Set", self.bus._name, "objectpath",
1345
"org.freedesktop.DBus.Properties",
1346
(self.bus._client_interface, "key", "value"))
1347
self.assertIn(expected_call, self.bus.calls)
1348
1349
def test_call_client_method(self):
1350
ret = self.bus.call_client_method("objectpath", "methodname")
1351
self.assertIs(self.bus.call_method_return, ret)
1352
expected_call = ("methodname", self.bus._name, "objectpath",
1353
self.bus._client_interface, ())
1354
self.assertIn(expected_call, self.bus.calls)
1355
1356
def test_call_client_method_with_args(self):
1357
args = (Unique(), Unique())
1358
ret = self.bus.call_client_method("objectpath", "methodname",
1359
*args)
1360
self.assertIs(self.bus.call_method_return, ret)
1361
expected_call = ("methodname", self.bus._name, "objectpath",
1362
self.bus._client_interface,
1363
(args[0], args[1]))
1364
self.assertIn(expected_call, self.bus.calls)
1365
1366
def test_get_clients_and_properties(self):
1367
managed_objects = {
1368
"objectpath": {
1369
self.bus._client_interface: {
1370
"key": "value",
1371
"bool": True,
1372
},
1373
"irrelevant_interface": {
1374
"key": "othervalue",
1375
"bool": False,
1376
},
1377
},
1378
"other_objectpath": {
1379
"other_irrelevant_interface": {
1380
"key": "value 3",
1381
"bool": None,
1382
},
1383
},
1384
}
1385
expected_clients_and_properties = {
1386
"objectpath": {
1387
"key": "value",
1388
"bool": True,
1389
}
1390
}
1391
self.bus.call_method_return = managed_objects
1392
ret = self.bus.get_clients_and_properties()
1393
self.assertDictEqual(expected_clients_and_properties, ret)
1394
expected_call = ("GetManagedObjects", self.bus._name,
1395
self.bus._server_path,
1396
"org.freedesktop.DBus.ObjectManager", ())
1397
self.assertIn(expected_call, self.bus.calls)
1398
1399
def test_call_server_method(self):
1400
ret = self.bus.call_server_method("methodname")
1401
self.assertIs(self.bus.call_method_return, ret)
1402
expected_call = ("methodname", self.bus._name,
1403
self.bus._server_path,
1404
self.bus._server_interface, ())
1405
self.assertIn(expected_call, self.bus.calls)
1406
1407
def test_call_server_method_with_args(self):
1408
args = (Unique(), Unique())
1409
ret = self.bus.call_server_method("methodname", *args)
1410
self.assertIs(self.bus.call_method_return, ret)
1411
expected_call = ("methodname", self.bus._name,
1412
self.bus._server_path,
1413
self.bus._server_interface,
1414
(args[0], args[1]))
1415
self.assertIn(expected_call, self.bus.calls)
1416
1417
1418
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1419
1420
def MockDBusPython_func(self, func):
1421
class mock_dbus_python:
1422
"""mock dbus-python module"""
1423
class exceptions:
1424
"""Pseudo-namespace"""
1425
class DBusException(Exception):
1426
pass
1427
class SystemBus:
1428
@staticmethod
1429
def get_object(busname, objectpath):
1430
DBusObject = collections.namedtuple(
1431
"DBusObject", ("methodname", "Set"))
1432
def method(*args, **kwargs):
1433
self.assertEqual({"dbus_interface":
1434
"interface"},
1435
kwargs)
1436
return func(*args)
1437
def set_property(interface, key, value,
1438
dbus_interface=None):
1439
self.assertEqual(
1440
"org.freedesktop.DBus.Properties",
1441
dbus_interface)
1442
self.assertEqual("Secret", key)
1443
return func(interface, key, value,
1444
dbus_interface=dbus_interface)
1445
return DBusObject(methodname=method,
1446
Set=set_property)
1447
class Boolean:
1448
def __init__(self, value):
1449
self.value = bool(value)
1450
def __bool__(self):
1451
return self.value
1452
if sys.version_info.major == 2:
1453
__nonzero__ = __bool__
1454
class ObjectPath(str):
1455
pass
1456
class Dictionary(dict):
1457
pass
1458
class ByteArray(bytes):
1459
pass
1460
return mock_dbus_python
1461
1462
def call_method(self, bus, methodname, busname, objectpath,
1463
interface, *args):
1464
with self.assertLogs(log, logging.DEBUG):
1465
return bus.call_method(methodname, busname, objectpath,
1466
interface, *args)
1467
1468
def test_call_method_returns(self):
1469
expected_method_return = Unique()
1470
method_args = (Unique(), Unique())
1471
def func(*args):
1472
self.assertEqual(len(method_args), len(args))
1473
for marg, arg in zip(method_args, args):
1474
self.assertIs(marg, arg)
1475
return expected_method_return
1476
mock_dbus_python = self.MockDBusPython_func(func)
1477
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1478
ret = self.call_method(bus, "methodname", "busname",
1479
"objectpath", "interface",
1480
*method_args)
1481
self.assertIs(ret, expected_method_return)
1482
1483
def test_call_method_filters_bool_true(self):
1484
def func():
1485
return method_return
1486
mock_dbus_python = self.MockDBusPython_func(func)
1487
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1488
method_return = mock_dbus_python.Boolean(True)
1489
ret = self.call_method(bus, "methodname", "busname",
1490
"objectpath", "interface")
1491
self.assertTrue(ret)
1492
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1493
1494
def test_call_method_filters_bool_false(self):
1495
def func():
1496
return method_return
1497
mock_dbus_python = self.MockDBusPython_func(func)
1498
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1499
method_return = mock_dbus_python.Boolean(False)
1500
ret = self.call_method(bus, "methodname", "busname",
1501
"objectpath", "interface")
1502
self.assertFalse(ret)
1503
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1504
1505
def test_call_method_filters_objectpath(self):
1506
def func():
1507
return method_return
1508
mock_dbus_python = self.MockDBusPython_func(func)
1509
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1510
method_return = mock_dbus_python.ObjectPath("objectpath")
1511
ret = self.call_method(bus, "methodname", "busname",
1512
"objectpath", "interface")
1513
self.assertEqual("objectpath", ret)
1514
self.assertIsNot("objectpath", ret)
1515
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1516
1517
def test_call_method_filters_booleans_in_dict(self):
1518
def func():
1519
return method_return
1520
mock_dbus_python = self.MockDBusPython_func(func)
1521
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1522
method_return = mock_dbus_python.Dictionary(
1523
{mock_dbus_python.Boolean(True):
1524
mock_dbus_python.Boolean(False),
1525
mock_dbus_python.Boolean(False):
1526
mock_dbus_python.Boolean(True)})
1527
ret = self.call_method(bus, "methodname", "busname",
1528
"objectpath", "interface")
1529
expected_method_return = {True: False,
1530
False: True}
1531
self.assertEqual(expected_method_return, ret)
1532
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1533
1534
def test_call_method_filters_objectpaths_in_dict(self):
1535
def func():
1536
return method_return
1537
mock_dbus_python = self.MockDBusPython_func(func)
1538
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1539
method_return = mock_dbus_python.Dictionary(
1540
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1541
mock_dbus_python.ObjectPath("objectpath_value_1"),
1542
mock_dbus_python.ObjectPath("objectpath_key_2"):
1543
mock_dbus_python.ObjectPath("objectpath_value_2")})
1544
ret = self.call_method(bus, "methodname", "busname",
1545
"objectpath", "interface")
1546
expected_method_return = {str(key): str(value)
1547
for key, value in
1548
method_return.items()}
1549
self.assertEqual(expected_method_return, ret)
1550
self.assertIsInstance(ret, dict)
1551
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1552
1553
def test_call_method_filters_dict_in_dict(self):
1554
def func():
1555
return method_return
1556
mock_dbus_python = self.MockDBusPython_func(func)
1557
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1558
method_return = mock_dbus_python.Dictionary(
1559
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1560
"key12": "value12"}),
1561
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1562
"key22": "value22"})})
1563
ret = self.call_method(bus, "methodname", "busname",
1564
"objectpath", "interface")
1565
expected_method_return = {
1566
"key1": {"key11": "value11",
1567
"key12": "value12"},
1568
"key2": {"key21": "value21",
1569
"key22": "value22"},
1570
}
1571
self.assertEqual(expected_method_return, ret)
1572
self.assertIsInstance(ret, dict)
1573
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1574
for key, value in ret.items():
1575
self.assertIsInstance(value, dict)
1576
self.assertEqual(expected_method_return[key], value)
1577
self.assertNotIsInstance(value,
1578
mock_dbus_python.Dictionary)
1579
1580
def test_call_method_filters_dict_three_deep(self):
1581
def func():
1582
return method_return
1583
mock_dbus_python = self.MockDBusPython_func(func)
1584
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1585
method_return = mock_dbus_python.Dictionary(
1586
{"key1":
1587
mock_dbus_python.Dictionary(
1588
{"key2":
1589
mock_dbus_python.Dictionary(
1590
{"key3":
1591
mock_dbus_python.Boolean(True),
1592
}),
1593
}),
1594
})
1595
ret = self.call_method(bus, "methodname", "busname",
1596
"objectpath", "interface")
1597
expected_method_return = {"key1": {"key2": {"key3": True}}}
1598
self.assertEqual(expected_method_return, ret)
1599
self.assertIsInstance(ret, dict)
1600
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1601
self.assertIsInstance(ret["key1"], dict)
1602
self.assertNotIsInstance(ret["key1"],
1603
mock_dbus_python.Dictionary)
1604
self.assertIsInstance(ret["key1"]["key2"], dict)
1605
self.assertNotIsInstance(ret["key1"]["key2"],
1606
mock_dbus_python.Dictionary)
1607
self.assertTrue(ret["key1"]["key2"]["key3"])
1608
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1609
mock_dbus_python.Boolean)
1610
1611
def test_call_method_handles_exception(self):
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
1630
try:
1631
with self.assertRaises(dbus.Error) as e:
1632
self.call_method(bus, "methodname", "busname",
1633
"objectpath", "interface")
1634
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")
2061
2062
2063
class Test_commands_from_options(unittest.TestCase):
2064
2065
def setUp(self):
2066
self.parser = argparse.ArgumentParser()
2067
add_command_line_options(self.parser)
2068
2069
def test_is_enabled(self):
2070
self.assert_command_from_args(["--is-enabled", "client"],
2071
command.IsEnabled)
2072
2073
def assert_command_from_args(self, args, command_cls, length=1,
2074
clients=None, **cmd_attrs):
2075
"""Assert that parsing ARGS should result in an instance of
2076
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
2077
options = self.parser.parse_args(args)
2078
check_option_syntax(self.parser, options)
2079
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)
2088
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)
2096
2097
def test_is_enabled_short(self):
2098
self.assert_command_from_args(["-V", "client"],
2099
command.IsEnabled)
2100
2101
def test_approve(self):
2102
self.assert_command_from_args(["--approve", "client"],
2103
command.Approve)
2104
2105
def test_approve_short(self):
2106
self.assert_command_from_args(["-A", "client"],
2107
command.Approve)
2108
2109
def test_deny(self):
2110
self.assert_command_from_args(["--deny", "client"],
2111
command.Deny)
2112
2113
def test_deny_short(self):
2114
self.assert_command_from_args(["-D", "client"], command.Deny)
2115
2116
def test_remove(self):
2117
self.assert_command_from_args(["--remove", "client"],
2118
command.Remove)
2119
2120
def test_deny_before_remove(self):
2121
options = self.parser.parse_args(["--deny", "--remove",
2122
"client"])
2123
check_option_syntax(self.parser, options)
2124
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)
2128
2129
def test_deny_before_remove_reversed(self):
2130
options = self.parser.parse_args(["--remove", "--deny",
2131
"--all"])
2132
check_option_syntax(self.parser, options)
2133
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)
2137
2138
def test_remove_short(self):
2139
self.assert_command_from_args(["-r", "client"],
2140
command.Remove)
2141
2142
def test_dump_json(self):
2143
self.assert_command_from_args(["--dump-json"],
2144
command.DumpJSON)
2145
2146
def test_enable(self):
2147
self.assert_command_from_args(["--enable", "client"],
2148
command.Enable)
2149
2150
def test_enable_short(self):
2151
self.assert_command_from_args(["-e", "client"],
2152
command.Enable)
2153
2154
def test_disable(self):
2155
self.assert_command_from_args(["--disable", "client"],
2156
command.Disable)
2157
2158
def test_disable_short(self):
2159
self.assert_command_from_args(["-d", "client"],
2160
command.Disable)
2161
2162
def test_bump_timeout(self):
2163
self.assert_command_from_args(["--bump-timeout", "client"],
2164
command.BumpTimeout)
2165
2166
def test_bump_timeout_short(self):
2167
self.assert_command_from_args(["-b", "client"],
2168
command.BumpTimeout)
2169
2170
def test_start_checker(self):
2171
self.assert_command_from_args(["--start-checker", "client"],
2172
command.StartChecker)
2173
2174
def test_stop_checker(self):
2175
self.assert_command_from_args(["--stop-checker", "client"],
2176
command.StopChecker)
2177
2178
def test_approve_by_default(self):
2179
self.assert_command_from_args(["--approve-by-default",
2180
"client"],
2181
command.ApproveByDefault)
2182
2183
def test_deny_by_default(self):
2184
self.assert_command_from_args(["--deny-by-default", "client"],
2185
command.DenyByDefault)
2186
2187
def test_checker(self):
2188
self.assert_command_from_args(["--checker", ":", "client"],
2189
command.SetChecker,
2190
value_to_set=":")
2191
2192
def test_checker_empty(self):
2193
self.assert_command_from_args(["--checker", "", "client"],
2194
command.SetChecker,
2195
value_to_set="")
2196
2197
def test_checker_short(self):
2198
self.assert_command_from_args(["-c", ":", "client"],
2199
command.SetChecker,
2200
value_to_set=":")
2201
2202
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")
2206
2207
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")
2211
2212
def test_secret_devnull(self):
2213
self.assert_command_from_args(["--secret", os.path.devnull,
2214
"client"], command.SetSecret,
2215
value_to_set=b"")
2216
2217
def test_secret_tempfile(self):
2218
with tempfile.NamedTemporaryFile(mode="r+b") as f:
2219
value = b"secret\0xyzzy\nbar"
2220
f.write(value)
2221
f.seek(0)
2222
self.assert_command_from_args(["--secret", f.name,
2223
"client"],
2224
command.SetSecret,
2225
value_to_set=value)
2226
2227
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"")
2231
2232
def test_secret_tempfile_short(self):
2233
with tempfile.NamedTemporaryFile(mode="r+b") as f:
2234
value = b"secret\0xyzzy\nbar"
2235
f.write(value)
2236
f.seek(0)
2237
self.assert_command_from_args(["-s", f.name, "client"],
2238
command.SetSecret,
2239
value_to_set=value)
2240
2241
def test_timeout(self):
2242
self.assert_command_from_args(["--timeout", "PT5M", "client"],
2243
command.SetTimeout,
2244
value_to_set=300000)
2245
2246
def test_timeout_short(self):
2247
self.assert_command_from_args(["-t", "PT5M", "client"],
2248
command.SetTimeout,
2249
value_to_set=300000)
2250
2251
def test_extended_timeout(self):
2252
self.assert_command_from_args(["--extended-timeout", "PT15M",
2253
"client"],
2254
command.SetExtendedTimeout,
2255
value_to_set=900000)
2256
2257
def test_interval(self):
2258
self.assert_command_from_args(["--interval", "PT2M",
2259
"client"], command.SetInterval,
2260
value_to_set=120000)
2261
2262
def test_interval_short(self):
2263
self.assert_command_from_args(["-i", "PT2M", "client"],
2264
command.SetInterval,
2265
value_to_set=120000)
2266
2267
def test_approval_delay(self):
2268
self.assert_command_from_args(["--approval-delay", "PT30S",
2269
"client"],
2270
command.SetApprovalDelay,
2271
value_to_set=30000)
2272
2273
def test_approval_duration(self):
2274
self.assert_command_from_args(["--approval-duration", "PT1S",
2275
"client"],
2276
command.SetApprovalDuration,
2277
value_to_set=1000)
2278
2279
def test_print_table(self):
2280
self.assert_command_from_args([], command.PrintTable,
2281
verbose=False)
2282
2283
def test_print_table_verbose(self):
2284
self.assert_command_from_args(["--verbose"],
2285
command.PrintTable,
2286
verbose=True)
2287
2288
def test_print_table_verbose_short(self):
2289
self.assert_command_from_args(["-v"], command.PrintTable,
2290
verbose=True)
2291
2292
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):
834
log.removeFilter(warning_filter)
835
self.assertTrue(getattr(warning_filter, "found", False))
836
self.assertEqual(value, datetime.timedelta(0, 7200))
837
838
839
class TestCmd(unittest.TestCase):
2325
840
"""Abstract class for tests of command classes"""
2326
2327
class FakeMandosBus(dbus.MandosBus):
2328
def __init__(self, testcase):
2329
self.client_properties = {
841
def setUp(self):
842
testcase = self
843
class MockClient(object):
844
def __init__(self, name, **attributes):
845
self.__dbus_object_path__ = "objpath_{}".format(name)
846
self.attributes = attributes
847
self.attributes["Name"] = name
848
self.calls = []
849
def Set(self, interface, propname, value, dbus_interface):
850
testcase.assertEqual(interface, client_interface)
851
testcase.assertEqual(dbus_interface,
852
dbus.PROPERTIES_IFACE)
853
self.attributes[propname] = value
854
def Get(self, interface, propname, dbus_interface):
855
testcase.assertEqual(interface, client_interface)
856
testcase.assertEqual(dbus_interface,
857
dbus.PROPERTIES_IFACE)
858
return self.attributes[propname]
859
def Approve(self, approve, dbus_interface):
860
testcase.assertEqual(dbus_interface, client_interface)
861
self.calls.append(("Approve", (approve,
862
dbus_interface)))
863
self.client = MockClient(
864
"foo",
865
KeyID=("92ed150794387c03ce684574b1139a65"
866
"94a34f895daaaf09fd8ea90a27cddb12"),
867
Secret=b"secret",
868
Host="foo.example.org",
869
Enabled=dbus.Boolean(True),
870
Timeout=300000,
871
LastCheckedOK="2019-02-03T00:00:00",
872
Created="2019-01-02T00:00:00",
873
Interval=120000,
874
Fingerprint=("778827225BA7DE539C5A"
875
"7CFA59CFF7CDBD9A5920"),
876
CheckerRunning=dbus.Boolean(False),
877
LastEnabled="2019-01-03T00:00:00",
878
ApprovalPending=dbus.Boolean(False),
879
ApprovedByDefault=dbus.Boolean(True),
880
LastApprovalRequest="",
881
ApprovalDelay=0,
882
ApprovalDuration=1000,
883
Checker="fping -q -- %(host)s",
884
ExtendedTimeout=900000,
885
Expires="2019-02-04T00:00:00",
886
LastCheckerStatus=0)
887
self.other_client = MockClient(
888
"barbar",
889
KeyID=("0558568eedd67d622f5c83b35a115f79"
890
"6ab612cff5ad227247e46c2b020f441c"),
891
Secret=b"secretbar",
892
Host="192.0.2.3",
893
Enabled=dbus.Boolean(True),
894
Timeout=300000,
895
LastCheckedOK="2019-02-04T00:00:00",
896
Created="2019-01-03T00:00:00",
897
Interval=120000,
898
Fingerprint=("3E393AEAEFB84C7E89E2"
899
"F547B3A107558FCA3A27"),
900
CheckerRunning=dbus.Boolean(True),
901
LastEnabled="2019-01-04T00:00:00",
902
ApprovalPending=dbus.Boolean(False),
903
ApprovedByDefault=dbus.Boolean(False),
904
LastApprovalRequest="2019-01-03T00:00:00",
905
ApprovalDelay=30000,
906
ApprovalDuration=1000,
907
Checker=":",
908
ExtendedTimeout=900000,
909
Expires="2019-02-05T00:00:00",
910
LastCheckerStatus=-2)
911
self.clients = collections.OrderedDict(
912
[
913
(self.client, self.client.attributes),
914
(self.other_client, self.other_client.attributes),
915
])
916
self.one_client = {self.client: self.client.attributes}
917
918
class TestPrintTableCmd(TestCmd):
919
def test_normal(self):
920
output = PrintTableCmd().output(self.clients.values())
921
expected_output = """
922
Name Enabled Timeout Last Successful Check
923
foo Yes 00:05:00 2019-02-03T00:00:00
924
barbar Yes 00:05:00 2019-02-04T00:00:00
925
"""[1:-1]
926
self.assertEqual(output, expected_output)
927
def test_verbose(self):
928
output = PrintTableCmd(verbose=True).output(
929
self.clients.values())
930
expected_output = """
931
Name Enabled Timeout Last Successful Check Created Interval Host Key ID Fingerprint Check Is Running Last Enabled Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker Extended Timeout Expires Last Checker Status
932
foo Yes 00:05:00 2019-02-03T00:00:00 2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No 2019-01-03T00:00:00 No Yes 00:00:00 00:00:01 fping -q -- %(host)s 00:15:00 2019-02-04T00:00:00 0
933
barbar Yes 00:05:00 2019-02-04T00:00:00 2019-01-03T00:00:00 00:02:00 192.0.2.3 0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes 2019-01-04T00:00:00 No No 2019-01-03T00:00:00 00:00:30 00:00:01 : 00:15:00 2019-02-05T00:00:00 -2
934
"""[1:-1]
935
self.assertEqual(output, expected_output)
936
def test_one_client(self):
937
output = PrintTableCmd().output(self.one_client.values())
938
expected_output = """
939
Name Enabled Timeout Last Successful Check
940
foo Yes 00:05:00 2019-02-03T00:00:00
941
"""[1:-1]
942
self.assertEqual(output, expected_output)
943
944
class TestDumpJSONCmd(TestCmd):
945
def setUp(self):
946
self.expected_json = {
947
"foo": {
2330
948
"Name": "foo",
2331
949
"KeyID": ("92ed150794387c03ce684574b1139a65"
2332
950
"94a34f895daaaf09fd8ea90a27cddb12"),
2333
"Secret": b"secret",
2334
951
"Host": "foo.example.org",
2335
952
"Enabled": True,
2336
953
"Timeout": 300000,
2350
967
"ExtendedTimeout": 900000,
2351
968
"Expires": "2019-02-04T00:00:00",
2352
969
"LastCheckerStatus": 0,
2353
}
2354
self.other_client_properties = {
970
},
971
"barbar": {
2355
972
"Name": "barbar",
2356
973
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2357
974
"6ab612cff5ad227247e46c2b020f441c"),
2358
"Secret": b"secretbar",
2359
975
"Host": "192.0.2.3",
2360
976
"Enabled": True,
2361
977
"Timeout": 300000,
2370
986
"ApprovedByDefault": False,
2371
987
"LastApprovalRequest": "2019-01-03T00:00:00",
2372
988
"ApprovalDelay": 30000,
2373
"ApprovalDuration": 93785000,
989
"ApprovalDuration": 1000,
2374
990
"Checker": ":",
2375
991
"ExtendedTimeout": 900000,
2376
992
"Expires": "2019-02-05T00:00:00",
2377
993
"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):
994
},
995
}
996
return super(TestDumpJSONCmd, self).setUp()
997
def test_normal(self):
998
json_data = json.loads(DumpJSONCmd().output(self.clients))
999
self.assertDictEqual(json_data, self.expected_json)
1000
def test_one_client(self):
1001
clients = self.one_client
1002
json_data = json.loads(DumpJSONCmd().output(clients))
1003
expected_json = {"foo": self.expected_json["foo"]}
1004
self.assertDictEqual(json_data, expected_json)
1005
1006
class TestIsEnabledCmd(TestCmd):
1007
def test_is_enabled(self):
1008
self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
1009
for client, properties in self.clients.items()))
1010
def test_is_enabled_run_exits_successfully(self):
2422
1011
with self.assertRaises(SystemExit) as e:
2423
command.IsEnabled().run(self.bus.one_client)
1012
IsEnabledCmd().run(None, self.one_client)
2424
1013
if e.exception.code is not None:
2425
self.assertEqual(0, e.exception.code)
1014
self.assertEqual(e.exception.code, 0)
2426
1015
else:
2427
1016
self.assertIsNone(e.exception.code)
2428
2429
def test_IsEnabled_exits_with_failure(self):
2430
self.bus.client_properties["Enabled"] = False
1017
def test_is_enabled_run_exits_with_failure(self):
1018
self.client.attributes["Enabled"] = dbus.Boolean(False)
2431
1019
with self.assertRaises(SystemExit) as e:
2432
command.IsEnabled().run(self.bus.one_client)
1020
IsEnabledCmd().run(None, self.one_client)
2433
1021
if isinstance(e.exception.code, int):
2434
self.assertNotEqual(0, e.exception.code)
1022
self.assertNotEqual(e.exception.code, 0)
2435
1023
else:
2436
1024
self.assertIsNotNone(e.exception.code)
2437
1025
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())
2534
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)
2540
expected_output = "\n".join((
2541
"Name Enabled Timeout Last Successful Check",
2542
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2543
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
2544
)) + "\n"
2545
self.assertEqual(expected_output, buffer.getvalue())
2546
2547
def test_PrintTable_verbose(self):
2548
with self.capture_stdout_to_buffer() as buffer:
2549
command.PrintTable(verbose=True).run(self.bus.clients)
2550
columns = (
2551
(
2552
"Name ",
2553
"foo ",
2554
"barbar ",
2555
),(
2556
"Enabled ",
2557
"Yes ",
2558
"Yes ",
2559
),(
2560
"Timeout ",
2561
"00:05:00 ",
2562
"00:05:00 ",
2563
),(
2564
"Last Successful Check ",
2565
"2019-02-03T00:00:00 ",
2566
"2019-02-04T00:00:00 ",
2567
),(
2568
"Created ",
2569
"2019-01-02T00:00:00 ",
2570
"2019-01-03T00:00:00 ",
2571
),(
2572
"Interval ",
2573
"00:02:00 ",
2574
"00:02:00 ",
2575
),(
2576
"Host ",
2577
"foo.example.org ",
2578
"192.0.2.3 ",
2579
),(
2580
("Key ID "
2581
" "),
2582
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
2583
"ea90a27cddb12 "),
2584
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
2585
"46c2b020f441c "),
2586
),(
2587
"Fingerprint ",
2588
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
2589
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
2590
),(
2591
"Check Is Running ",
2592
"No ",
2593
"Yes ",
2594
),(
2595
"Last Enabled ",
2596
"2019-01-03T00:00:00 ",
2597
"2019-01-04T00:00:00 ",
2598
),(
2599
"Approval Is Pending ",
2600
"No ",
2601
"No ",
2602
),(
2603
"Approved By Default ",
2604
"Yes ",
2605
"No ",
2606
),(
2607
"Last Approval Request ",
2608
" ",
2609
"2019-01-03T00:00:00 ",
2610
),(
2611
"Approval Delay ",
2612
"00:00:00 ",
2613
"00:00:30 ",
2614
),(
2615
"Approval Duration ",
2616
"00:00:01 ",
2617
"1T02:03:05 ",
2618
),(
2619
"Checker ",
2620
"fping -q -- %(host)s ",
2621
": ",
2622
),(
2623
"Extended Timeout ",
2624
"00:15:00 ",
2625
"00:15:00 ",
2626
),(
2627
"Expires ",
2628
"2019-02-04T00:00:00 ",
2629
"2019-02-05T00:00:00 ",
2630
),(
2631
"Last Checker Status",
2632
"0 ",
2633
"-2 ",
2634
)
2635
)
2636
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())
2642
2643
def test_PrintTable_one_client(self):
2644
with self.capture_stdout_to_buffer() as buffer:
2645
command.PrintTable().run(self.bus.one_client)
2646
expected_output = "\n".join((
2647
"Name Enabled Timeout Last Successful Check",
2648
"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
1026
class TestRemoveCmd(TestCmd):
1027
def test_remove(self):
1028
class MockMandos(object):
1029
def __init__(self):
1030
self.calls = []
1031
def RemoveClient(self, dbus_path):
1032
self.calls.append(("RemoveClient", (dbus_path,)))
1033
mandos = MockMandos()
1034
super(TestRemoveCmd, self).setUp()
1035
RemoveCmd().run(mandos, self.clients)
1036
self.assertEqual(len(mandos.calls), 2)
1037
for client in self.clients:
1038
self.assertIn(("RemoveClient",
1039
(client.__dbus_object_path__,)),
1040
mandos.calls)
1041
1042
class TestApproveCmd(TestCmd):
1043
def test_approve(self):
1044
ApproveCmd().run(None, self.clients)
1045
for client in self.clients:
1046
self.assertIn(("Approve", (True, client_interface)),
1047
client.calls)
1048
1049
class TestDenyCmd(TestCmd):
1050
def test_deny(self):
1051
DenyCmd().run(None, self.clients)
1052
for client in self.clients:
1053
self.assertIn(("Approve", (False, client_interface)),
1054
client.calls)
1055
1056
class TestEnableCmd(TestCmd):
1057
def test_enable(self):
1058
for client in self.clients:
1059
client.attributes["Enabled"] = False
1060
1061
EnableCmd().run(None, self.clients)
1062
1063
for client in self.clients:
1064
self.assertTrue(client.attributes["Enabled"])
1065
1066
class TestDisableCmd(TestCmd):
1067
def test_disable(self):
1068
DisableCmd().run(None, self.clients)
1069
1070
for client in self.clients:
1071
self.assertFalse(client.attributes["Enabled"])
1072
1073
class Unique(object):
1074
"""Class for objects which exist only to be unique objects, since
1075
unittest.mock.sentinel only exists in Python 3.3"""
1076
1077
class TestPropertyCmd(TestCmd):
1078
"""Abstract class for tests of PropertyCmd classes"""
2656
1079
def runTest(self):
2657
1080
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])
1081
return
1082
values_to_get = getattr(self, "values_to_get",
1083
self.values_to_set)
1084
for value_to_set, value_to_get in zip(self.values_to_set,
1085
values_to_get):
1086
for client in self.clients:
1087
old_value = client.attributes[self.propname]
1088
self.assertNotIsInstance(old_value, Unique)
1089
client.attributes[self.propname] = Unique()
1090
self.run_command(value_to_set, self.clients)
1091
for client in self.clients:
1092
value = client.attributes[self.propname]
2675
1093
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
1094
self.assertEqual(value, value_to_get)
1095
def run_command(self, value, clients):
1096
self.command().run(None, clients)
1097
1098
class TestBumpTimeoutCmd(TestPropertyCmd):
1099
command = BumpTimeoutCmd
2693
1100
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
1101
values_to_set = [""]
1102
1103
class TestStartCheckerCmd(TestPropertyCmd):
1104
command = StartCheckerCmd
1105
propname = "CheckerRunning"
1106
values_to_set = [dbus.Boolean(True)]
1107
1108
class TestStopCheckerCmd(TestPropertyCmd):
1109
command = StopCheckerCmd
1110
propname = "CheckerRunning"
1111
values_to_set = [dbus.Boolean(False)]
1112
1113
class TestApproveByDefaultCmd(TestPropertyCmd):
1114
command = ApproveByDefaultCmd
1115
propname = "ApprovedByDefault"
1116
values_to_set = [dbus.Boolean(True)]
1117
1118
class TestDenyByDefaultCmd(TestPropertyCmd):
1119
command = DenyByDefaultCmd
1120
propname = "ApprovedByDefault"
1121
values_to_set = [dbus.Boolean(False)]
1122
1123
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1124
"""Abstract class for tests of PropertyCmd classes using the
1125
ValueArgumentMixIn"""
1126
def runTest(self):
1127
if type(self) is TestValueArgumentPropertyCmd:
1128
return
1129
return super(TestValueArgumentPropertyCmd, self).runTest()
1130
def run_command(self, value, clients):
1131
self.command(value).run(None, clients)
1132
1133
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1134
command = SetCheckerCmd
2723
1135
propname = "Checker"
2724
1136
values_to_set = ["", ":", "fping -q -- %s"]
2725
1137
2726
2727
class TestSetHostCmd(TestPropertySetterCmd):
2728
command = command.SetHost
1138
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1139
command = SetHostCmd
2729
1140
propname = "Host"
2730
values_to_set = ["192.0.2.3", "client.example.org"]
2731
2732
2733
class TestSetSecretCmd(TestPropertySetterCmd):
2734
command = command.SetSecret
1141
values_to_set = ["192.0.2.3", "foo.example.org"]
1142
1143
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1144
command = SetSecretCmd
2735
1145
propname = "Secret"
2736
1146
values_to_set = [io.BytesIO(b""),
2737
1147
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
1148
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1149
1150
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1151
command = SetTimeoutCmd
2743
1152
propname = "Timeout"
2744
1153
values_to_set = [datetime.timedelta(),
2745
1154
datetime.timedelta(minutes=5),
2746
1155
datetime.timedelta(seconds=1),
2747
1156
datetime.timedelta(weeks=1),
2748
1157
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
1158
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1159
1160
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1161
command = SetExtendedTimeoutCmd
2754
1162
propname = "ExtendedTimeout"
2755
1163
values_to_set = [datetime.timedelta(),
2756
1164
datetime.timedelta(minutes=5),
2757
1165
datetime.timedelta(seconds=1),
2758
1166
datetime.timedelta(weeks=1),
2759
1167
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
1168
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1169
1170
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1171
command = SetIntervalCmd
2765
1172
propname = "Interval"
2766
1173
values_to_set = [datetime.timedelta(),
2767
1174
datetime.timedelta(minutes=5),
2768
1175
datetime.timedelta(seconds=1),
2769
1176
datetime.timedelta(weeks=1),
2770
1177
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
1178
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1179
1180
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1181
command = SetApprovalDelayCmd
2776
1182
propname = "ApprovalDelay"
2777
1183
values_to_set = [datetime.timedelta(),
2778
1184
datetime.timedelta(minutes=5),
2779
1185
datetime.timedelta(seconds=1),
2780
1186
datetime.timedelta(weeks=1),
2781
1187
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
1188
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1189
1190
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1191
command = SetApprovalDurationCmd
2787
1192
propname = "ApprovalDuration"
2788
1193
values_to_set = [datetime.timedelta(),
2789
1194
datetime.timedelta(minutes=5),
2790
1195
datetime.timedelta(seconds=1),
2791
1196
datetime.timedelta(weeks=1),
2792
1197
datetime.timedelta(weeks=52)]
2793
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1198
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1199
1200
class Test_command_from_options(unittest.TestCase):
1201
def setUp(self):
1202
self.parser = argparse.ArgumentParser()
1203
add_command_line_options(self.parser)
1204
def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1205
"""Assert that parsing ARGS should result in an instance of
1206
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1207
options = self.parser.parse_args(args)
1208
check_option_syntax(self.parser, options)
1209
commands = commands_from_options(options)
1210
self.assertEqual(len(commands), 1)
1211
command = commands[0]
1212
self.assertIsInstance(command, command_cls)
1213
for key, value in cmd_attrs.items():
1214
self.assertEqual(getattr(command, key), value)
1215
def test_print_table(self):
1216
self.assert_command_from_args([], PrintTableCmd,
1217
verbose=False)
1218
1219
def test_print_table_verbose(self):
1220
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1221
verbose=True)
1222
1223
def test_print_table_verbose_short(self):
1224
self.assert_command_from_args(["-v"], PrintTableCmd,
1225
verbose=True)
1226
1227
def test_enable(self):
1228
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1229
1230
def test_enable_short(self):
1231
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1232
1233
def test_disable(self):
1234
self.assert_command_from_args(["--disable", "foo"],
1235
DisableCmd)
1236
1237
def test_disable_short(self):
1238
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1239
1240
def test_bump_timeout(self):
1241
self.assert_command_from_args(["--bump-timeout", "foo"],
1242
BumpTimeoutCmd)
1243
1244
def test_bump_timeout_short(self):
1245
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1246
1247
def test_start_checker(self):
1248
self.assert_command_from_args(["--start-checker", "foo"],
1249
StartCheckerCmd)
1250
1251
def test_stop_checker(self):
1252
self.assert_command_from_args(["--stop-checker", "foo"],
1253
StopCheckerCmd)
1254
1255
def test_remove(self):
1256
self.assert_command_from_args(["--remove", "foo"],
1257
RemoveCmd)
1258
1259
def test_remove_short(self):
1260
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1261
1262
def test_checker(self):
1263
self.assert_command_from_args(["--checker", ":", "foo"],
1264
SetCheckerCmd, value_to_set=":")
1265
1266
def test_checker_empty(self):
1267
self.assert_command_from_args(["--checker", "", "foo"],
1268
SetCheckerCmd, value_to_set="")
1269
1270
def test_checker_short(self):
1271
self.assert_command_from_args(["-c", ":", "foo"],
1272
SetCheckerCmd, value_to_set=":")
1273
1274
def test_timeout(self):
1275
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1276
SetTimeoutCmd,
1277
value_to_set=300000)
1278
1279
def test_timeout_short(self):
1280
self.assert_command_from_args(["-t", "PT5M", "foo"],
1281
SetTimeoutCmd,
1282
value_to_set=300000)
1283
1284
def test_extended_timeout(self):
1285
self.assert_command_from_args(["--extended-timeout", "PT15M",
1286
"foo"],
1287
SetExtendedTimeoutCmd,
1288
value_to_set=900000)
1289
1290
def test_interval(self):
1291
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1292
SetIntervalCmd,
1293
value_to_set=120000)
1294
1295
def test_interval_short(self):
1296
self.assert_command_from_args(["-i", "PT2M", "foo"],
1297
SetIntervalCmd,
1298
value_to_set=120000)
1299
1300
def test_approve_by_default(self):
1301
self.assert_command_from_args(["--approve-by-default", "foo"],
1302
ApproveByDefaultCmd)
1303
1304
def test_deny_by_default(self):
1305
self.assert_command_from_args(["--deny-by-default", "foo"],
1306
DenyByDefaultCmd)
1307
1308
def test_approval_delay(self):
1309
self.assert_command_from_args(["--approval-delay", "PT30S",
1310
"foo"], SetApprovalDelayCmd,
1311
value_to_set=30000)
1312
1313
def test_approval_duration(self):
1314
self.assert_command_from_args(["--approval-duration", "PT1S",
1315
"foo"], SetApprovalDurationCmd,
1316
value_to_set=1000)
1317
1318
def test_host(self):
1319
self.assert_command_from_args(["--host", "foo.example.org",
1320
"foo"], SetHostCmd,
1321
value_to_set="foo.example.org")
1322
1323
def test_host_short(self):
1324
self.assert_command_from_args(["-H", "foo.example.org",
1325
"foo"], SetHostCmd,
1326
value_to_set="foo.example.org")
1327
1328
def test_secret_devnull(self):
1329
self.assert_command_from_args(["--secret", os.path.devnull,
1330
"foo"], SetSecretCmd,
1331
value_to_set=b"")
1332
1333
def test_secret_tempfile(self):
1334
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1335
value = b"secret\0xyzzy\nbar"
1336
f.write(value)
1337
f.seek(0)
1338
self.assert_command_from_args(["--secret", f.name,
1339
"foo"], SetSecretCmd,
1340
value_to_set=value)
1341
1342
def test_secret_devnull_short(self):
1343
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1344
SetSecretCmd, value_to_set=b"")
1345
1346
def test_secret_tempfile_short(self):
1347
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1348
value = b"secret\0xyzzy\nbar"
1349
f.write(value)
1350
f.seek(0)
1351
self.assert_command_from_args(["-s", f.name, "foo"],
1352
SetSecretCmd,
1353
value_to_set=value)
1354
1355
def test_approve(self):
1356
self.assert_command_from_args(["--approve", "foo"],
1357
ApproveCmd)
1358
1359
def test_approve_short(self):
1360
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1361
1362
def test_deny(self):
1363
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1364
1365
def test_deny_short(self):
1366
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1367
1368
def test_dump_json(self):
1369
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1370
1371
def test_is_enabled(self):
1372
self.assert_command_from_args(["--is-enabled", "foo"],
1373
IsEnabledCmd)
1374
1375
def test_is_enabled_short(self):
1376
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1377
1378
def test_deny_before_remove(self):
1379
options = self.parser.parse_args(["--deny", "--remove", "foo"])
1380
check_option_syntax(self.parser, options)
1381
commands = commands_from_options(options)
1382
self.assertEqual(len(commands), 2)
1383
self.assertIsInstance(commands[0], DenyCmd)
1384
self.assertIsInstance(commands[1], RemoveCmd)
1385
1386
def test_deny_before_remove_reversed(self):
1387
options = self.parser.parse_args(["--remove", "--deny", "--all"])
1388
check_option_syntax(self.parser, options)
1389
commands = commands_from_options(options)
1390
self.assertEqual(len(commands), 2)
1391
self.assertIsInstance(commands[0], DenyCmd)
1392
self.assertIsInstance(commands[1], RemoveCmd)
1393
1394
1395
class Test_check_option_syntax(unittest.TestCase):
1396
# This mostly corresponds to the definition from has_actions() in
1397
# check_option_syntax()
1398
actions = {
1399
# The actual values set here are not that important, but we do
1400
# at least stick to the correct types, even though they are
1401
# never used
1402
"enable": True,
1403
"disable": True,
1404
"bump_timeout": True,
1405
"start_checker": True,
1406
"stop_checker": True,
1407
"is_enabled": True,
1408
"remove": True,
1409
"checker": "x",
1410
"timeout": datetime.timedelta(),
1411
"extended_timeout": datetime.timedelta(),
1412
"interval": datetime.timedelta(),
1413
"approved_by_default": True,
1414
"approval_delay": datetime.timedelta(),
1415
"approval_duration": datetime.timedelta(),
1416
"host": "x",
1417
"secret": io.BytesIO(b"x"),
1418
"approve": True,
1419
"deny": True,
1420
}
1421
1422
def setUp(self):
1423
self.parser = argparse.ArgumentParser()
1424
add_command_line_options(self.parser)
1425
1426
@contextlib.contextmanager
1427
def assertParseError(self):
1428
with self.assertRaises(SystemExit) as e:
1429
with self.temporarily_suppress_stderr():
1430
yield
1431
# Exit code from argparse is guaranteed to be "2". Reference:
1432
# https://docs.python.org/3/library/argparse.html#exiting-methods
1433
self.assertEqual(e.exception.code, 2)
1434
1435
@staticmethod
1436
@contextlib.contextmanager
1437
def temporarily_suppress_stderr():
1438
null = os.open(os.path.devnull, os.O_RDWR)
1439
stderrcopy = os.dup(sys.stderr.fileno())
1440
os.dup2(null, sys.stderr.fileno())
1441
os.close(null)
1442
try:
1443
yield
1444
finally:
1445
# restore stderr
1446
os.dup2(stderrcopy, sys.stderr.fileno())
1447
os.close(stderrcopy)
1448
1449
def check_option_syntax(self, options):
1450
check_option_syntax(self.parser, options)
1451
1452
def test_actions_requires_client_or_all(self):
1453
for action, value in self.actions.items():
1454
options = self.parser.parse_args()
1455
setattr(options, action, value)
1456
with self.assertParseError():
1457
self.check_option_syntax(options)
1458
1459
def test_actions_conflicts_with_verbose(self):
1460
for action, value in self.actions.items():
1461
options = self.parser.parse_args()
1462
setattr(options, action, value)
1463
options.verbose = True
1464
with self.assertParseError():
1465
self.check_option_syntax(options)
1466
1467
def test_dump_json_conflicts_with_verbose(self):
1468
options = self.parser.parse_args()
1469
options.dump_json = True
1470
options.verbose = True
1471
with self.assertParseError():
1472
self.check_option_syntax(options)
1473
1474
def test_dump_json_conflicts_with_action(self):
1475
for action, value in self.actions.items():
1476
options = self.parser.parse_args()
1477
setattr(options, action, value)
1478
options.dump_json = True
1479
with self.assertParseError():
1480
self.check_option_syntax(options)
1481
1482
def test_all_can_not_be_alone(self):
1483
options = self.parser.parse_args()
1484
options.all = True
1485
with self.assertParseError():
1486
self.check_option_syntax(options)
1487
1488
def test_all_is_ok_with_any_action(self):
1489
for action, value in self.actions.items():
1490
options = self.parser.parse_args()
1491
setattr(options, action, value)
1492
options.all = True
1493
self.check_option_syntax(options)
1494
1495
def test_is_enabled_fails_without_client(self):
1496
options = self.parser.parse_args()
1497
options.is_enabled = True
1498
with self.assertParseError():
1499
self.check_option_syntax(options)
1500
1501
def test_is_enabled_works_with_one_client(self):
1502
options = self.parser.parse_args()
1503
options.is_enabled = True
1504
options.client = ["foo"]
1505
self.check_option_syntax(options)
1506
1507
def test_is_enabled_fails_with_two_clients(self):
1508
options = self.parser.parse_args()
1509
options.is_enabled = True
1510
options.client = ["foo", "barbar"]
1511
with self.assertParseError():
1512
self.check_option_syntax(options)
1513
1514
def test_remove_can_only_be_combined_with_action_deny(self):
1515
for action, value in self.actions.items():
1516
if action in {"remove", "deny"}:
1517
continue
1518
options = self.parser.parse_args()
1519
setattr(options, action, value)
1520
options.all = True
1521
options.remove = True
1522
with self.assertParseError():
1523
self.check_option_syntax(options)
2794
1524
2795
1525
2796
1526
2811
1541
return tests
2812
1542
2813
1543
if __name__ == "__main__":
2814
try:
2815
if should_only_run_tests():
2816
# Call using ./tdd-python-script --check [--verbose]
2817
unittest.main()
2818
else:
2819
main()
2820
finally:
2821
logging.shutdown()
1544
if should_only_run_tests():
1545
# Call using ./tdd-python-script --check [--verbose]
1546
unittest.main()
1547
else:
1548
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0