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*")))); -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2008-2019 Teddy Hogeborn
7
# Copyright © 2008-2019 Björn Påhlsson
9
# This file is part of Mandos.
11
# Mandos is free software: you can redistribute it and/or modify it
12
# under the terms of the GNU General Public License as published by
13
# the Free Software Foundation, either version 3 of the License, or
14
# (at your option) any later version.
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
# GNU General Public License for more details.
21
# You should have received a copy of the GNU General Public License
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
24
# Contact the authors at <mandos@recompile.se>.
27
from __future__ import (division, absolute_import, print_function,
31
from future_builtins import *
2
# -*- mode: python; coding: utf-8 -*-
4
from __future__ import division
7
from optparse import OptionParser
51
# Show warnings by default
52
if not sys.warnoptions:
54
warnings.simplefilter("default")
56
log = logging.getLogger(sys.argv[0])
57
logging.basicConfig(level="INFO", # Show info level messages
58
format="%(message)s") # Show basic log messages
60
logging.captureWarnings(True) # Show warnings via the logging system
62
if sys.version_info.major == 2:
65
io.StringIO = StringIO.StringIO
67
locale.setlocale(locale.LC_ALL, "")
69
dbus_busname_domain = "se.recompile"
70
dbus_busname = dbus_busname_domain + ".Mandos"
71
server_dbus_path = "/"
72
server_dbus_interface = dbus_busname_domain + ".Mandos"
73
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
74
del dbus_busname_domain
79
dbus.OBJECT_MANAGER_IFACE
80
except AttributeError:
81
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
13
locale.setlocale(locale.LC_ALL, u'')
17
'Enabled': u'Enabled',
18
'Timeout': u'Timeout',
19
'LastCheckedOK': u'Last Successful Check',
20
'LastApprovalRequest': u'Last Approval Request',
21
'Created': u'Created',
22
'Interval': u'Interval',
24
'Fingerprint': u'Fingerprint',
25
'CheckerRunning': u'Check Is Running',
26
'LastEnabled': u'Last Enabled',
27
'ApprovalPending': u'Approval Is Pending',
28
'ApprovedByDefault': u'Approved By Default',
29
'ApprovalDelay': u"Approval Delay",
30
'ApprovalDuration': u"Approval Duration",
31
'Checker': u'Checker',
33
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
34
domain = 'se.bsnet.fukt'
35
busname = domain + '.Mandos'
37
server_interface = domain + '.Mandos'
38
client_interface = domain + '.Mandos.Client'
41
def timedelta_to_milliseconds(td):
42
"Convert a datetime.timedelta object to milliseconds"
43
return ((td.days * 24 * 60 * 60 * 1000)
45
+ (td.microseconds // 1000))
47
def milliseconds_to_string(ms):
48
td = datetime.timedelta(0, 0, 0, ms)
49
return (u"%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
50
% { "days": "%dT" % td.days if td.days else "",
51
"hours": td.seconds // 3600,
52
"minutes": (td.seconds % 3600) // 60,
53
"seconds": td.seconds % 60,
57
def string_to_delta(interval):
58
"""Parse a string and return a datetime.timedelta
60
>>> string_to_delta('7d')
62
>>> string_to_delta('60s')
63
datetime.timedelta(0, 60)
64
>>> string_to_delta('60m')
65
datetime.timedelta(0, 3600)
66
>>> string_to_delta('24h')
68
>>> string_to_delta(u'1w')
70
>>> string_to_delta('5m 30s')
71
datetime.timedelta(0, 330)
73
timevalue = datetime.timedelta(0)
74
regexp = re.compile("\d+[dsmhw]")
76
for s in regexp.findall(interval):
78
suffix = unicode(s[-1])
81
delta = datetime.timedelta(value)
83
delta = datetime.timedelta(0, value)
85
delta = datetime.timedelta(0, 0, 0, 0, value)
87
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
89
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
92
except (ValueError, IndexError):
97
def print_clients(clients, keywords):
98
def valuetostring(value, keyword):
99
if type(value) is dbus.Boolean:
100
return u"Yes" if value else u"No"
101
if keyword in (u"Timeout", u"Interval", u"ApprovalDelay",
102
u"ApprovalDuration"):
103
return milliseconds_to_string(value)
104
return unicode(value)
106
# Create format string to print table rows
107
format_string = u' '.join(u'%%-%ds' %
108
max(len(tablewords[key]),
109
max(len(valuetostring(client[key],
115
print format_string % tuple(tablewords[key] for key in keywords)
116
for client in clients:
117
print format_string % tuple(valuetostring(client[key], key)
120
def has_actions(options):
121
return any((options.enable,
123
options.bump_timeout,
124
options.start_checker,
125
options.stop_checker,
128
options.checker is not None,
129
options.timeout is not None,
130
options.interval is not None,
131
options.approved_by_default is not None,
132
options.approval_delay is not None,
133
options.approval_duration is not None,
134
options.host is not None,
135
options.secret is not None,
85
parser = argparse.ArgumentParser()
86
add_command_line_options(parser)
88
options = parser.parse_args()
89
check_option_syntax(parser, options)
91
clientnames = options.client
94
log.setLevel(logging.DEBUG)
96
bus = dbus.SystemBus()
98
mandos_dbus_object = get_mandos_dbus_object(bus)
100
mandos_serv = dbus.Interface(
101
mandos_dbus_object, dbus_interface=server_dbus_interface)
102
mandos_serv_object_manager = dbus.Interface(
103
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
108
for path, ifs_and_props in managed_objects.items():
110
all_clients[path] = ifs_and_props[client_dbus_interface]
114
# Compile dict of (clientpath: properties) to process
116
clients = all_clients
119
for name in clientnames:
120
for objpath, properties in all_clients.items():
121
if properties["Name"] == name:
122
clients[objpath] = properties
140
parser = OptionParser(version = "%%prog %s" % version)
141
parser.add_option("-a", "--all", action="store_true",
142
help="Select all clients")
143
parser.add_option("-v", "--verbose", action="store_true",
144
help="Print all fields")
145
parser.add_option("-e", "--enable", action="store_true",
146
help="Enable client")
147
parser.add_option("-d", "--disable", action="store_true",
148
help="disable client")
149
parser.add_option("-b", "--bump-timeout", action="store_true",
150
help="Bump timeout for client")
151
parser.add_option("--start-checker", action="store_true",
152
help="Start checker for client")
153
parser.add_option("--stop-checker", action="store_true",
154
help="Stop checker for client")
155
parser.add_option("-V", "--is-enabled", action="store_true",
156
help="Check if client is enabled")
157
parser.add_option("-r", "--remove", action="store_true",
158
help="Remove client")
159
parser.add_option("-c", "--checker", type="string",
160
help="Set checker command for client")
161
parser.add_option("-t", "--timeout", type="string",
162
help="Set timeout for client")
163
parser.add_option("-i", "--interval", type="string",
164
help="Set checker interval for client")
165
parser.add_option("--approve-by-default", action="store_true",
166
dest=u"approved_by_default",
167
help="Set client to be approved by default")
168
parser.add_option("--deny-by-default", action="store_false",
169
dest=u"approved_by_default",
170
help="Set client to be denied by default")
171
parser.add_option("--approval-delay", type="string",
172
help="Set delay before client approve/deny")
173
parser.add_option("--approval-duration", type="string",
174
help="Set duration of one client approval")
175
parser.add_option("-H", "--host", type="string",
176
help="Set host for client")
177
parser.add_option("-s", "--secret", type="string",
178
help="Set password blob (file) for client")
179
parser.add_option("-A", "--approve", action="store_true",
180
help="Approve any current client request")
181
parser.add_option("-D", "--deny", action="store_true",
182
help="Deny any current client request")
183
options, client_names = parser.parse_args()
185
if has_actions(options) and not client_names and not options.all:
186
parser.error('Options require clients names or --all.')
187
if options.verbose and has_actions(options):
188
parser.error('--verbose can only be used alone or with'
190
if options.all and not has_actions(options):
191
parser.error('--all requires an action.')
194
bus = dbus.SystemBus()
195
mandos_dbus_objc = bus.get_object(busname, server_path)
196
except dbus.exceptions.DBusException:
197
print >> sys.stderr, "Could not connect to Mandos server"
200
mandos_serv = dbus.Interface(mandos_dbus_objc,
201
dbus_interface = server_interface)
203
#block stderr since dbus library prints to stderr
204
null = os.open(os.path.devnull, os.O_RDWR)
205
stderrcopy = os.dup(sys.stderr.fileno())
206
os.dup2(null, sys.stderr.fileno())
210
mandos_clients = mandos_serv.GetAllClientsWithProperties()
213
os.dup2(stderrcopy, sys.stderr.fileno())
215
except dbus.exceptions.DBusException, e:
216
print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
219
# Compile dict of (clients: properties) to process
222
if options.all or not client_names:
223
clients = dict((bus.get_object(busname, path), properties)
224
for path, properties in
225
mandos_clients.iteritems())
227
for name in client_names:
228
for path, client in mandos_clients.iteritems():
229
if client['Name'] == name:
230
client_objc = bus.get_object(busname, path)
231
clients[client_objc] = client
234
print >> sys.stderr, "Client not found on server: %r" % name
237
if not has_actions(options) and clients:
239
keywords = ('Name', 'Enabled', 'Timeout',
240
'LastCheckedOK', 'Created', 'Interval',
241
'Host', 'Fingerprint', 'CheckerRunning',
242
'LastEnabled', 'ApprovalPending',
244
'LastApprovalRequest', 'ApprovalDelay',
245
'ApprovalDuration', 'Checker')
125
log.critical("Client not found on server: %r", name)
128
commands = commands_from_options(options)
130
for command in commands:
131
command.run(clients, bus, mandos_serv)
134
def add_command_line_options(parser):
135
parser.add_argument("--version", action="version",
136
version="%(prog)s {}".format(version),
137
help="show version number and exit")
138
parser.add_argument("-a", "--all", action="store_true",
139
help="Select all clients")
140
parser.add_argument("-v", "--verbose", action="store_true",
141
help="Print all fields")
142
parser.add_argument("-j", "--dump-json", action="store_true",
143
help="Dump client data in JSON format")
144
enable_disable = parser.add_mutually_exclusive_group()
145
enable_disable.add_argument("-e", "--enable", action="store_true",
146
help="Enable client")
147
enable_disable.add_argument("-d", "--disable",
149
help="disable client")
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
151
help="Bump timeout for client")
152
start_stop_checker = parser.add_mutually_exclusive_group()
153
start_stop_checker.add_argument("--start-checker",
155
help="Start checker for client")
156
start_stop_checker.add_argument("--stop-checker",
158
help="Stop checker for client")
159
parser.add_argument("-V", "--is-enabled", action="store_true",
160
help="Check if client is enabled")
161
parser.add_argument("-r", "--remove", action="store_true",
162
help="Remove client")
163
parser.add_argument("-c", "--checker",
164
help="Set checker command for client")
165
parser.add_argument("-t", "--timeout", type=string_to_delta,
166
help="Set timeout for client")
167
parser.add_argument("--extended-timeout", type=string_to_delta,
168
help="Set extended timeout for client")
169
parser.add_argument("-i", "--interval", type=string_to_delta,
170
help="Set checker interval for client")
171
approve_deny_default = parser.add_mutually_exclusive_group()
172
approve_deny_default.add_argument(
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
175
help="Set client to be approved by default")
176
approve_deny_default.add_argument(
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
179
help="Set client to be denied by default")
180
parser.add_argument("--approval-delay", type=string_to_delta,
181
help="Set delay before client approve/deny")
182
parser.add_argument("--approval-duration", type=string_to_delta,
183
help="Set duration of one client approval")
184
parser.add_argument("-H", "--host", help="Set host for client")
185
parser.add_argument("-s", "--secret",
186
type=argparse.FileType(mode="rb"),
187
help="Set password blob (file) for client")
188
approve_deny = parser.add_mutually_exclusive_group()
189
approve_deny.add_argument(
190
"-A", "--approve", action="store_true",
191
help="Approve any current client request")
192
approve_deny.add_argument("-D", "--deny", action="store_true",
193
help="Deny any current client request")
194
parser.add_argument("--debug", action="store_true",
195
help="Debug mode (show D-Bus commands)")
196
parser.add_argument("--check", action="store_true",
197
help="Run self-test")
198
parser.add_argument("client", nargs="*", help="Client name")
201
def string_to_delta(interval):
202
"""Parse a string and return a datetime.timedelta"""
205
return rfc3339_duration_to_delta(interval)
206
except ValueError as e:
207
log.warning("%s - Parsing as pre-1.6.1 interval instead",
209
return parse_pre_1_6_1_interval(interval)
212
def rfc3339_duration_to_delta(duration):
213
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
215
>>> rfc3339_duration_to_delta("P7D")
216
datetime.timedelta(7)
217
>>> rfc3339_duration_to_delta("PT60S")
218
datetime.timedelta(0, 60)
219
>>> rfc3339_duration_to_delta("PT60M")
220
datetime.timedelta(0, 3600)
221
>>> rfc3339_duration_to_delta("P60M")
222
datetime.timedelta(1680)
223
>>> rfc3339_duration_to_delta("PT24H")
224
datetime.timedelta(1)
225
>>> rfc3339_duration_to_delta("P1W")
226
datetime.timedelta(7)
227
>>> rfc3339_duration_to_delta("PT5M30S")
228
datetime.timedelta(0, 330)
229
>>> rfc3339_duration_to_delta("P1DT3M20S")
230
datetime.timedelta(1, 200)
231
>>> # Can not be empty:
232
>>> rfc3339_duration_to_delta("")
233
Traceback (most recent call last):
235
ValueError: Invalid RFC 3339 duration: ""
236
>>> # Must start with "P":
237
>>> rfc3339_duration_to_delta("1D")
238
Traceback (most recent call last):
240
ValueError: Invalid RFC 3339 duration: "1D"
241
>>> # Must use correct order
242
>>> rfc3339_duration_to_delta("PT1S2M")
243
Traceback (most recent call last):
245
ValueError: Invalid RFC 3339 duration: "PT1S2M"
246
>>> # Time needs time marker
247
>>> rfc3339_duration_to_delta("P1H2S")
248
Traceback (most recent call last):
250
ValueError: Invalid RFC 3339 duration: "P1H2S"
251
>>> # Weeks can not be combined with anything else
252
>>> rfc3339_duration_to_delta("P1D2W")
253
Traceback (most recent call last):
255
ValueError: Invalid RFC 3339 duration: "P1D2W"
256
>>> rfc3339_duration_to_delta("P2W2H")
257
Traceback (most recent call last):
259
ValueError: Invalid RFC 3339 duration: "P2W2H"
262
# Parsing an RFC 3339 duration with regular expressions is not
263
# possible - there would have to be multiple places for the same
264
# values, like seconds. The current code, while more esoteric, is
265
# cleaner without depending on a parsing library. If Python had a
266
# built-in library for parsing we would use it, but we'd like to
267
# avoid excessive use of external libraries.
269
# New type for defining tokens, syntax, and semantics all-in-one
270
Token = collections.namedtuple("Token", (
271
"regexp", # To match token; if "value" is not None, must have
272
# a "group" containing digits
273
"value", # datetime.timedelta or None
274
"followers")) # Tokens valid after this token
275
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
276
# the "duration" ABNF definition in RFC 3339, Appendix A.
277
token_end = Token(re.compile(r"$"), None, frozenset())
278
token_second = Token(re.compile(r"(\d+)S"),
279
datetime.timedelta(seconds=1),
280
frozenset((token_end, )))
281
token_minute = Token(re.compile(r"(\d+)M"),
282
datetime.timedelta(minutes=1),
283
frozenset((token_second, token_end)))
284
token_hour = Token(re.compile(r"(\d+)H"),
285
datetime.timedelta(hours=1),
286
frozenset((token_minute, token_end)))
287
token_time = Token(re.compile(r"T"),
289
frozenset((token_hour, token_minute,
291
token_day = Token(re.compile(r"(\d+)D"),
292
datetime.timedelta(days=1),
293
frozenset((token_time, token_end)))
294
token_month = Token(re.compile(r"(\d+)M"),
295
datetime.timedelta(weeks=4),
296
frozenset((token_day, token_end)))
297
token_year = Token(re.compile(r"(\d+)Y"),
298
datetime.timedelta(weeks=52),
299
frozenset((token_month, token_end)))
300
token_week = Token(re.compile(r"(\d+)W"),
301
datetime.timedelta(weeks=1),
302
frozenset((token_end, )))
303
token_duration = Token(re.compile(r"P"), None,
304
frozenset((token_year, token_month,
305
token_day, token_time,
307
# Define starting values:
309
value = datetime.timedelta()
311
# Following valid tokens
312
followers = frozenset((token_duration, ))
313
# String left to parse
315
# Loop until end token is found
316
while found_token is not token_end:
317
# Search for any currently valid tokens
318
for token in followers:
319
match = token.regexp.match(s)
320
if match is not None:
322
if token.value is not None:
323
# Value found, parse digits
324
factor = int(match.group(1), 10)
325
# Add to value so far
326
value += factor * token.value
327
# Strip token from string
328
s = token.regexp.sub("", s, 1)
331
# Set valid next tokens
332
followers = found_token.followers
335
# No currently valid tokens were found
336
raise ValueError("Invalid RFC 3339 duration: \"{}\""
342
def parse_pre_1_6_1_interval(interval):
343
"""Parse an interval string as documented by Mandos before 1.6.1,
344
and return a datetime.timedelta
346
>>> parse_pre_1_6_1_interval('7d')
347
datetime.timedelta(7)
348
>>> parse_pre_1_6_1_interval('60s')
349
datetime.timedelta(0, 60)
350
>>> parse_pre_1_6_1_interval('60m')
351
datetime.timedelta(0, 3600)
352
>>> parse_pre_1_6_1_interval('24h')
353
datetime.timedelta(1)
354
>>> parse_pre_1_6_1_interval('1w')
355
datetime.timedelta(7)
356
>>> parse_pre_1_6_1_interval('5m 30s')
357
datetime.timedelta(0, 330)
358
>>> parse_pre_1_6_1_interval('')
359
datetime.timedelta(0)
360
>>> # Ignore unknown characters, allow any order and repetitions
361
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
362
datetime.timedelta(2, 480, 18000)
366
value = datetime.timedelta(0)
367
regexp = re.compile(r"(\d+)([dsmhw]?)")
369
for num, suffix in regexp.findall(interval):
371
value += datetime.timedelta(int(num))
373
value += datetime.timedelta(0, int(num))
375
value += datetime.timedelta(0, 0, 0, 0, int(num))
377
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
379
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
381
value += datetime.timedelta(0, 0, 0, int(num))
385
def check_option_syntax(parser, options):
386
"""Apply additional restrictions on options, not expressible in
389
def has_actions(options):
390
return any((options.enable,
392
options.bump_timeout,
393
options.start_checker,
394
options.stop_checker,
397
options.checker is not None,
398
options.timeout is not None,
399
options.extended_timeout is not None,
400
options.interval is not None,
401
options.approved_by_default is not None,
402
options.approval_delay is not None,
403
options.approval_duration is not None,
404
options.host is not None,
405
options.secret is not None,
409
if has_actions(options) and not (options.client or options.all):
410
parser.error("Options require clients names or --all.")
411
if options.verbose and has_actions(options):
412
parser.error("--verbose can only be used alone.")
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
415
parser.error("--dump-json can only be used alone.")
416
if options.all and not has_actions(options):
417
parser.error("--all requires an action.")
418
if options.is_enabled and len(options.client) > 1:
419
parser.error("--is-enabled requires exactly one client")
421
options.remove = False
422
if has_actions(options) and not options.deny:
423
parser.error("--remove can only be combined with --deny")
424
options.remove = True
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
434
return mandos_dbus_object
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
462
self.logger.addFilter(self.nullfilter)
464
class NullFilter(logging.Filter):
465
def filter(self, record):
468
nullfilter = NullFilter()
470
def __exit__(self, exc_type, exc_val, exc_tb):
471
self.logger.removeFilter(self.nullfilter)
474
def commands_from_options(options):
478
if options.is_enabled:
479
commands.append(command.IsEnabled())
482
commands.append(command.Approve())
485
commands.append(command.Deny())
488
commands.append(command.Remove())
490
if options.dump_json:
491
commands.append(command.DumpJSON())
494
commands.append(command.Enable())
497
commands.append(command.Disable())
499
if options.bump_timeout:
500
commands.append(command.BumpTimeout())
502
if options.start_checker:
503
commands.append(command.StartChecker())
505
if options.stop_checker:
506
commands.append(command.StopChecker())
508
if options.approved_by_default is not None:
509
if options.approved_by_default:
510
commands.append(command.ApproveByDefault())
512
commands.append(command.DenyByDefault())
514
if options.checker is not None:
515
commands.append(command.SetChecker(options.checker))
517
if options.host is not None:
518
commands.append(command.SetHost(options.host))
520
if options.secret is not None:
521
commands.append(command.SetSecret(options.secret))
523
if options.timeout is not None:
524
commands.append(command.SetTimeout(options.timeout))
526
if options.extended_timeout:
528
command.SetExtendedTimeout(options.extended_timeout))
530
if options.interval is not None:
531
commands.append(command.SetInterval(options.interval))
533
if options.approval_delay is not None:
535
command.SetApprovalDelay(options.approval_delay))
537
if options.approval_duration is not None:
539
command.SetApprovalDuration(options.approval_duration))
541
# If no command option has been given, show table of clients,
542
# optionally verbosely
544
commands.append(command.PrintTable(verbose=options.verbose))
549
class command(object):
550
"""A namespace for command classes"""
553
"""Abstract base class for commands"""
554
def run(self, clients, bus=None, mandos=None):
555
"""Normal commands should implement run_on_one_client(),
556
but commands which want to operate on all clients at the same time can
557
override this run() method instead.
560
for clientpath, properties in clients.items():
561
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
562
dbus_busname, str(clientpath))
563
client = bus.get_object(dbus_busname, clientpath)
564
self.run_on_one_client(client, properties)
567
class IsEnabled(Base):
568
def run(self, clients, bus=None, mandos=None):
569
client, properties = next(iter(clients.items()))
570
if self.is_enabled(client, properties):
573
def is_enabled(self, client, properties):
574
return properties["Enabled"]
578
def run_on_one_client(self, client, properties):
579
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
580
client.__dbus_object_path__,
581
client_dbus_interface)
582
client.Approve(dbus.Boolean(True),
583
dbus_interface=client_dbus_interface)
587
def run_on_one_client(self, client, properties):
588
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
589
client.__dbus_object_path__,
590
client_dbus_interface)
591
client.Approve(dbus.Boolean(False),
592
dbus_interface=client_dbus_interface)
596
def run_on_one_client(self, client, properties):
597
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
598
dbus_busname, server_dbus_path,
599
server_dbus_interface,
600
str(client.__dbus_object_path__))
601
self.mandos.RemoveClient(client.__dbus_object_path__)
605
"""Abstract class for commands outputting client details"""
606
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
607
"Created", "Interval", "Host", "KeyID",
608
"Fingerprint", "CheckerRunning",
609
"LastEnabled", "ApprovalPending",
610
"ApprovedByDefault", "LastApprovalRequest",
611
"ApprovalDelay", "ApprovalDuration",
612
"Checker", "ExtendedTimeout", "Expires",
616
class DumpJSON(Output):
617
def run(self, clients, bus=None, mandos=None):
618
data = {client["Name"]:
619
{key: self.dbus_boolean_to_bool(client[key])
620
for key in self.all_keywords}
621
for client in clients.values()}
622
print(json.dumps(data, indent=4, separators=(',', ': ')))
625
def dbus_boolean_to_bool(value):
626
if isinstance(value, dbus.Boolean):
631
class PrintTable(Output):
632
def __init__(self, verbose=False):
633
self.verbose = verbose
635
def run(self, clients, bus=None, mandos=None):
636
default_keywords = ("Name", "Enabled", "Timeout",
638
keywords = default_keywords
640
keywords = self.all_keywords
641
print(self.TableOfClients(clients.values(), keywords))
643
class TableOfClients(object):
646
"Enabled": "Enabled",
647
"Timeout": "Timeout",
648
"LastCheckedOK": "Last Successful Check",
649
"LastApprovalRequest": "Last Approval Request",
650
"Created": "Created",
651
"Interval": "Interval",
653
"Fingerprint": "Fingerprint",
655
"CheckerRunning": "Check Is Running",
656
"LastEnabled": "Last Enabled",
657
"ApprovalPending": "Approval Is Pending",
658
"ApprovedByDefault": "Approved By Default",
659
"ApprovalDelay": "Approval Delay",
660
"ApprovalDuration": "Approval Duration",
661
"Checker": "Checker",
662
"ExtendedTimeout": "Extended Timeout",
663
"Expires": "Expires",
664
"LastCheckerStatus": "Last Checker Status",
667
def __init__(self, clients, keywords):
668
self.clients = clients
669
self.keywords = keywords
672
return "\n".join(self.rows())
674
if sys.version_info.major == 2:
675
__unicode__ = __str__
677
return str(self).encode(
678
locale.getpreferredencoding())
681
format_string = self.row_formatting_string()
682
rows = [self.header_line(format_string)]
683
rows.extend(self.client_line(client, format_string)
684
for client in self.clients)
687
def row_formatting_string(self):
688
"Format string used to format table rows"
689
return " ".join("{{{key}:{width}}}".format(
690
width=max(len(self.tableheaders[key]),
691
*(len(self.string_from_client(client,
693
for client in self.clients)),
695
for key in self.keywords)
697
def string_from_client(self, client, key):
698
return self.valuetostring(client[key], key)
701
def valuetostring(cls, value, keyword):
702
if isinstance(value, dbus.Boolean):
703
return "Yes" if value else "No"
704
if keyword in ("Timeout", "Interval", "ApprovalDelay",
705
"ApprovalDuration", "ExtendedTimeout"):
706
return cls.milliseconds_to_string(value)
709
def header_line(self, format_string):
710
return format_string.format(**self.tableheaders)
712
def client_line(self, client, format_string):
713
return format_string.format(
714
**{key: self.string_from_client(client, key)
715
for key in self.keywords})
718
def milliseconds_to_string(ms):
719
td = datetime.timedelta(0, 0, 0, ms)
720
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
721
.format(days="{}T".format(td.days)
723
hours=td.seconds // 3600,
724
minutes=(td.seconds % 3600) // 60,
725
seconds=td.seconds % 60))
728
class PropertySetter(Base):
729
"Abstract class for Actions for setting one client property"
731
def run_on_one_client(self, client, properties):
732
"""Set the Client's D-Bus property"""
733
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
734
client.__dbus_object_path__,
735
dbus.PROPERTIES_IFACE, client_dbus_interface,
736
self.propname, self.value_to_set
737
if not isinstance(self.value_to_set,
739
else bool(self.value_to_set))
740
client.Set(client_dbus_interface, self.propname,
742
dbus_interface=dbus.PROPERTIES_IFACE)
746
raise NotImplementedError()
749
class Enable(PropertySetter):
751
value_to_set = dbus.Boolean(True)
754
class Disable(PropertySetter):
756
value_to_set = dbus.Boolean(False)
759
class BumpTimeout(PropertySetter):
760
propname = "LastCheckedOK"
764
class StartChecker(PropertySetter):
765
propname = "CheckerRunning"
766
value_to_set = dbus.Boolean(True)
769
class StopChecker(PropertySetter):
770
propname = "CheckerRunning"
771
value_to_set = dbus.Boolean(False)
774
class ApproveByDefault(PropertySetter):
775
propname = "ApprovedByDefault"
776
value_to_set = dbus.Boolean(True)
779
class DenyByDefault(PropertySetter):
780
propname = "ApprovedByDefault"
781
value_to_set = dbus.Boolean(False)
784
class PropertySetterValue(PropertySetter):
785
"""Abstract class for PropertySetter recieving a value as
786
constructor argument instead of a class attribute."""
787
def __init__(self, value):
788
self.value_to_set = value
791
class SetChecker(PropertySetterValue):
795
class SetHost(PropertySetterValue):
799
class SetSecret(PropertySetterValue):
803
def value_to_set(self):
807
def value_to_set(self, value):
808
"""When setting, read data from supplied file object"""
809
self._vts = value.read()
813
class PropertySetterValueMilliseconds(PropertySetterValue):
814
"""Abstract class for PropertySetterValue taking a value
815
argument as a datetime.timedelta() but should store it as
819
def value_to_set(self):
823
def value_to_set(self, value):
824
"When setting, convert value from a datetime.timedelta"
825
self._vts = int(round(value.total_seconds() * 1000))
828
class SetTimeout(PropertySetterValueMilliseconds):
832
class SetExtendedTimeout(PropertySetterValueMilliseconds):
833
propname = "ExtendedTimeout"
836
class SetInterval(PropertySetterValueMilliseconds):
837
propname = "Interval"
840
class SetApprovalDelay(PropertySetterValueMilliseconds):
841
propname = "ApprovalDelay"
844
class SetApprovalDuration(PropertySetterValueMilliseconds):
845
propname = "ApprovalDuration"
849
class TestCaseWithAssertLogs(unittest.TestCase):
850
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
852
if not hasattr(unittest.TestCase, "assertLogs"):
853
@contextlib.contextmanager
854
def assertLogs(self, logger, level=logging.INFO):
855
capturing_handler = self.CapturingLevelHandler(level)
856
old_level = logger.level
857
old_propagate = logger.propagate
858
logger.addHandler(capturing_handler)
859
logger.setLevel(level)
860
logger.propagate = False
862
yield capturing_handler.watcher
864
logger.propagate = old_propagate
865
logger.removeHandler(capturing_handler)
866
logger.setLevel(old_level)
867
self.assertGreater(len(capturing_handler.watcher.records),
870
class CapturingLevelHandler(logging.Handler):
871
def __init__(self, level, *args, **kwargs):
872
logging.Handler.__init__(self, *args, **kwargs)
873
self.watcher = self.LoggingWatcher([], [])
874
def emit(self, record):
875
self.watcher.records.append(record)
876
self.watcher.output.append(self.format(record))
878
LoggingWatcher = collections.namedtuple("LoggingWatcher",
883
class Test_string_to_delta(TestCaseWithAssertLogs):
884
# Just test basic RFC 3339 functionality here, the doc string for
885
# rfc3339_duration_to_delta() already has more comprehensive
886
# tests, which is run by doctest.
888
def test_rfc3339_zero_seconds(self):
889
self.assertEqual(datetime.timedelta(),
890
string_to_delta("PT0S"))
892
def test_rfc3339_zero_days(self):
893
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
895
def test_rfc3339_one_second(self):
896
self.assertEqual(datetime.timedelta(0, 1),
897
string_to_delta("PT1S"))
899
def test_rfc3339_two_hours(self):
900
self.assertEqual(datetime.timedelta(0, 7200),
901
string_to_delta("PT2H"))
903
def test_falls_back_to_pre_1_6_1_with_warning(self):
904
with self.assertLogs(log, logging.WARNING):
905
value = string_to_delta("2h")
906
self.assertEqual(datetime.timedelta(0, 7200), value)
909
class Test_check_option_syntax(unittest.TestCase):
911
self.parser = argparse.ArgumentParser()
912
add_command_line_options(self.parser)
914
def test_actions_requires_client_or_all(self):
915
for action, value in self.actions.items():
916
options = self.parser.parse_args()
917
setattr(options, action, value)
918
with self.assertParseError():
919
self.check_option_syntax(options)
921
# This mostly corresponds to the definition from has_actions() in
922
# check_option_syntax()
924
# The actual values set here are not that important, but we do
925
# at least stick to the correct types, even though they are
929
"bump_timeout": True,
930
"start_checker": True,
931
"stop_checker": True,
935
"timeout": datetime.timedelta(),
936
"extended_timeout": datetime.timedelta(),
937
"interval": datetime.timedelta(),
938
"approved_by_default": True,
939
"approval_delay": datetime.timedelta(),
940
"approval_duration": datetime.timedelta(),
942
"secret": io.BytesIO(b"x"),
947
@contextlib.contextmanager
948
def assertParseError(self):
949
with self.assertRaises(SystemExit) as e:
950
with self.redirect_stderr_to_devnull():
952
# Exit code from argparse is guaranteed to be "2". Reference:
953
# https://docs.python.org/3/library
954
# /argparse.html#exiting-methods
955
self.assertEqual(2, e.exception.code)
958
@contextlib.contextmanager
959
def redirect_stderr_to_devnull():
960
old_stderr = sys.stderr
961
with contextlib.closing(open(os.devnull, "w")) as null:
966
sys.stderr = old_stderr
968
def check_option_syntax(self, options):
969
check_option_syntax(self.parser, options)
971
def test_actions_all_conflicts_with_verbose(self):
972
for action, value in self.actions.items():
973
options = self.parser.parse_args()
974
setattr(options, action, value)
976
options.verbose = True
977
with self.assertParseError():
978
self.check_option_syntax(options)
980
def test_actions_with_client_conflicts_with_verbose(self):
981
for action, value in self.actions.items():
982
options = self.parser.parse_args()
983
setattr(options, action, value)
984
options.verbose = True
985
options.client = ["client"]
986
with self.assertParseError():
987
self.check_option_syntax(options)
989
def test_dump_json_conflicts_with_verbose(self):
990
options = self.parser.parse_args()
991
options.dump_json = True
992
options.verbose = True
993
with self.assertParseError():
994
self.check_option_syntax(options)
996
def test_dump_json_conflicts_with_action(self):
997
for action, value in self.actions.items():
998
options = self.parser.parse_args()
999
setattr(options, action, value)
1000
options.dump_json = True
1001
with self.assertParseError():
1002
self.check_option_syntax(options)
1004
def test_all_can_not_be_alone(self):
1005
options = self.parser.parse_args()
1007
with self.assertParseError():
1008
self.check_option_syntax(options)
1010
def test_all_is_ok_with_any_action(self):
1011
for action, value in self.actions.items():
1012
options = self.parser.parse_args()
1013
setattr(options, action, value)
1015
self.check_option_syntax(options)
1017
def test_any_action_is_ok_with_one_client(self):
1018
for action, value in self.actions.items():
1019
options = self.parser.parse_args()
1020
setattr(options, action, value)
1021
options.client = ["client"]
1022
self.check_option_syntax(options)
1024
def test_one_client_with_all_actions_except_is_enabled(self):
1025
options = self.parser.parse_args()
1026
for action, value in self.actions.items():
1027
if action == "is_enabled":
1029
setattr(options, action, value)
1030
options.client = ["client"]
1031
self.check_option_syntax(options)
1033
def test_two_clients_with_all_actions_except_is_enabled(self):
1034
options = self.parser.parse_args()
1035
for action, value in self.actions.items():
1036
if action == "is_enabled":
1038
setattr(options, action, value)
1039
options.client = ["client1", "client2"]
1040
self.check_option_syntax(options)
1042
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1043
for action, value in self.actions.items():
1044
if action == "is_enabled":
1046
options = self.parser.parse_args()
1047
setattr(options, action, value)
1048
options.client = ["client1", "client2"]
1049
self.check_option_syntax(options)
1051
def test_is_enabled_fails_without_client(self):
1052
options = self.parser.parse_args()
1053
options.is_enabled = True
1054
with self.assertParseError():
1055
self.check_option_syntax(options)
1057
def test_is_enabled_fails_with_two_clients(self):
1058
options = self.parser.parse_args()
1059
options.is_enabled = True
1060
options.client = ["client1", "client2"]
1061
with self.assertParseError():
1062
self.check_option_syntax(options)
1064
def test_remove_can_only_be_combined_with_action_deny(self):
1065
for action, value in self.actions.items():
1066
if action in {"remove", "deny"}:
1068
options = self.parser.parse_args()
1069
setattr(options, action, value)
1071
options.remove = True
1072
with self.assertParseError():
1073
self.check_option_syntax(options)
1076
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1077
def test_calls_and_returns_get_object_on_bus(self):
1078
class MockBus(object):
1080
def get_object(mockbus_self, busname, dbus_path):
1081
# Note that "self" is still the testcase instance,
1082
# this MockBus instance is in "mockbus_self".
1083
self.assertEqual(dbus_busname, busname)
1084
self.assertEqual(server_dbus_path, dbus_path)
1085
mockbus_self.called = True
1088
mockbus = get_mandos_dbus_object(bus=MockBus())
1089
self.assertIsInstance(mockbus, MockBus)
1090
self.assertTrue(mockbus.called)
1092
def test_logs_and_exits_on_dbus_error(self):
1093
class FailingBusStub(object):
1094
def get_object(self, busname, dbus_path):
1095
raise dbus.exceptions.DBusException("Test")
1097
with self.assertLogs(log, logging.CRITICAL):
1098
with self.assertRaises(SystemExit) as e:
1099
bus = get_mandos_dbus_object(bus=FailingBusStub())
1101
if isinstance(e.exception.code, int):
1102
self.assertNotEqual(0, e.exception.code)
1104
self.assertIsNotNone(e.exception.code)
1107
class Test_get_managed_objects(TestCaseWithAssertLogs):
1108
def test_calls_and_returns_GetManagedObjects(self):
1109
managed_objects = {"/clients/client": { "Name": "client"}}
1110
class ObjectManagerStub(object):
1111
def GetManagedObjects(self):
1112
return managed_objects
1113
retval = get_managed_objects(ObjectManagerStub())
1114
self.assertDictEqual(managed_objects, retval)
1116
def test_logs_and_exits_on_dbus_error(self):
1117
dbus_logger = logging.getLogger("dbus.proxies")
1119
class ObjectManagerFailingStub(object):
1120
def GetManagedObjects(self):
1121
dbus_logger.error("Test")
1122
raise dbus.exceptions.DBusException("Test")
1124
class CountingHandler(logging.Handler):
1126
def emit(self, record):
1129
counting_handler = CountingHandler()
1131
dbus_logger.addHandler(counting_handler)
1134
with self.assertLogs(log, logging.CRITICAL) as watcher:
1135
with self.assertRaises(SystemExit) as e:
1136
get_managed_objects(ObjectManagerFailingStub())
1138
dbus_logger.removeFilter(counting_handler)
1140
# Make sure the dbus logger was suppressed
1141
self.assertEqual(0, counting_handler.count)
1143
# Test that the dbus_logger still works
1144
with self.assertLogs(dbus_logger, logging.ERROR):
1145
dbus_logger.error("Test")
1147
if isinstance(e.exception.code, int):
1148
self.assertNotEqual(0, e.exception.code)
1150
self.assertIsNotNone(e.exception.code)
1153
class Test_commands_from_options(unittest.TestCase):
1155
self.parser = argparse.ArgumentParser()
1156
add_command_line_options(self.parser)
1158
def test_is_enabled(self):
1159
self.assert_command_from_args(["--is-enabled", "client"],
1162
def assert_command_from_args(self, args, command_cls,
1164
"""Assert that parsing ARGS should result in an instance of
1165
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1166
options = self.parser.parse_args(args)
1167
check_option_syntax(self.parser, options)
1168
commands = commands_from_options(options)
1169
self.assertEqual(1, len(commands))
1170
command = commands[0]
1171
self.assertIsInstance(command, command_cls)
1172
for key, value in cmd_attrs.items():
1173
self.assertEqual(value, getattr(command, key))
1175
def test_is_enabled_short(self):
1176
self.assert_command_from_args(["-V", "client"],
1179
def test_approve(self):
1180
self.assert_command_from_args(["--approve", "client"],
1183
def test_approve_short(self):
1184
self.assert_command_from_args(["-A", "client"],
1187
def test_deny(self):
1188
self.assert_command_from_args(["--deny", "client"],
1191
def test_deny_short(self):
1192
self.assert_command_from_args(["-D", "client"], command.Deny)
1194
def test_remove(self):
1195
self.assert_command_from_args(["--remove", "client"],
1198
def test_deny_before_remove(self):
1199
options = self.parser.parse_args(["--deny", "--remove",
1201
check_option_syntax(self.parser, options)
1202
commands = commands_from_options(options)
1203
self.assertEqual(2, len(commands))
1204
self.assertIsInstance(commands[0], command.Deny)
1205
self.assertIsInstance(commands[1], command.Remove)
1207
def test_deny_before_remove_reversed(self):
1208
options = self.parser.parse_args(["--remove", "--deny",
1210
check_option_syntax(self.parser, options)
1211
commands = commands_from_options(options)
1212
self.assertEqual(2, len(commands))
1213
self.assertIsInstance(commands[0], command.Deny)
1214
self.assertIsInstance(commands[1], command.Remove)
1216
def test_remove_short(self):
1217
self.assert_command_from_args(["-r", "client"],
1220
def test_dump_json(self):
1221
self.assert_command_from_args(["--dump-json"],
1224
def test_enable(self):
1225
self.assert_command_from_args(["--enable", "client"],
1228
def test_enable_short(self):
1229
self.assert_command_from_args(["-e", "client"],
1232
def test_disable(self):
1233
self.assert_command_from_args(["--disable", "client"],
1236
def test_disable_short(self):
1237
self.assert_command_from_args(["-d", "client"],
1240
def test_bump_timeout(self):
1241
self.assert_command_from_args(["--bump-timeout", "client"],
1242
command.BumpTimeout)
1244
def test_bump_timeout_short(self):
1245
self.assert_command_from_args(["-b", "client"],
1246
command.BumpTimeout)
1248
def test_start_checker(self):
1249
self.assert_command_from_args(["--start-checker", "client"],
1250
command.StartChecker)
1252
def test_stop_checker(self):
1253
self.assert_command_from_args(["--stop-checker", "client"],
1254
command.StopChecker)
1256
def test_approve_by_default(self):
1257
self.assert_command_from_args(["--approve-by-default",
1259
command.ApproveByDefault)
1261
def test_deny_by_default(self):
1262
self.assert_command_from_args(["--deny-by-default", "client"],
1263
command.DenyByDefault)
1265
def test_checker(self):
1266
self.assert_command_from_args(["--checker", ":", "client"],
1270
def test_checker_empty(self):
1271
self.assert_command_from_args(["--checker", "", "client"],
1275
def test_checker_short(self):
1276
self.assert_command_from_args(["-c", ":", "client"],
1280
def test_host(self):
1281
self.assert_command_from_args(
1282
["--host", "client.example.org", "client"],
1283
command.SetHost, value_to_set="client.example.org")
1285
def test_host_short(self):
1286
self.assert_command_from_args(
1287
["-H", "client.example.org", "client"], command.SetHost,
1288
value_to_set="client.example.org")
1290
def test_secret_devnull(self):
1291
self.assert_command_from_args(["--secret", os.path.devnull,
1292
"client"], command.SetSecret,
1295
def test_secret_tempfile(self):
1296
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1297
value = b"secret\0xyzzy\nbar"
1300
self.assert_command_from_args(["--secret", f.name,
1305
def test_secret_devnull_short(self):
1306
self.assert_command_from_args(["-s", os.path.devnull,
1307
"client"], command.SetSecret,
1310
def test_secret_tempfile_short(self):
1311
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1312
value = b"secret\0xyzzy\nbar"
1315
self.assert_command_from_args(["-s", f.name, "client"],
1319
def test_timeout(self):
1320
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1322
value_to_set=300000)
1324
def test_timeout_short(self):
1325
self.assert_command_from_args(["-t", "PT5M", "client"],
1327
value_to_set=300000)
1329
def test_extended_timeout(self):
1330
self.assert_command_from_args(["--extended-timeout", "PT15M",
1332
command.SetExtendedTimeout,
1333
value_to_set=900000)
1335
def test_interval(self):
1336
self.assert_command_from_args(["--interval", "PT2M",
1337
"client"], command.SetInterval,
1338
value_to_set=120000)
1340
def test_interval_short(self):
1341
self.assert_command_from_args(["-i", "PT2M", "client"],
1342
command.SetInterval,
1343
value_to_set=120000)
1345
def test_approval_delay(self):
1346
self.assert_command_from_args(["--approval-delay", "PT30S",
1348
command.SetApprovalDelay,
1351
def test_approval_duration(self):
1352
self.assert_command_from_args(["--approval-duration", "PT1S",
1354
command.SetApprovalDuration,
1357
def test_print_table(self):
1358
self.assert_command_from_args([], command.PrintTable,
1361
def test_print_table_verbose(self):
1362
self.assert_command_from_args(["--verbose"],
1366
def test_print_table_verbose_short(self):
1367
self.assert_command_from_args(["-v"], command.PrintTable,
1371
class TestCommand(unittest.TestCase):
1372
"""Abstract class for tests of command classes"""
1376
class MockClient(object):
1377
def __init__(self, name, **attributes):
1378
self.__dbus_object_path__ = "/clients/{}".format(name)
1379
self.attributes = attributes
1380
self.attributes["Name"] = name
1382
def Set(self, interface, propname, value, dbus_interface):
1383
testcase.assertEqual(client_dbus_interface, interface)
1384
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1386
self.attributes[propname] = value
1387
def Approve(self, approve, dbus_interface):
1388
testcase.assertEqual(client_dbus_interface,
1390
self.calls.append(("Approve", (approve,
1392
self.client = MockClient(
1394
KeyID=("92ed150794387c03ce684574b1139a65"
1395
"94a34f895daaaf09fd8ea90a27cddb12"),
1397
Host="foo.example.org",
1398
Enabled=dbus.Boolean(True),
1400
LastCheckedOK="2019-02-03T00:00:00",
1401
Created="2019-01-02T00:00:00",
1403
Fingerprint=("778827225BA7DE539C5A"
1404
"7CFA59CFF7CDBD9A5920"),
1405
CheckerRunning=dbus.Boolean(False),
1406
LastEnabled="2019-01-03T00:00:00",
1407
ApprovalPending=dbus.Boolean(False),
1408
ApprovedByDefault=dbus.Boolean(True),
1409
LastApprovalRequest="",
1411
ApprovalDuration=1000,
1412
Checker="fping -q -- %(host)s",
1413
ExtendedTimeout=900000,
1414
Expires="2019-02-04T00:00:00",
1415
LastCheckerStatus=0)
1416
self.other_client = MockClient(
1418
KeyID=("0558568eedd67d622f5c83b35a115f79"
1419
"6ab612cff5ad227247e46c2b020f441c"),
1420
Secret=b"secretbar",
1422
Enabled=dbus.Boolean(True),
1424
LastCheckedOK="2019-02-04T00:00:00",
1425
Created="2019-01-03T00:00:00",
1427
Fingerprint=("3E393AEAEFB84C7E89E2"
1428
"F547B3A107558FCA3A27"),
1429
CheckerRunning=dbus.Boolean(True),
1430
LastEnabled="2019-01-04T00:00:00",
1431
ApprovalPending=dbus.Boolean(False),
1432
ApprovedByDefault=dbus.Boolean(False),
1433
LastApprovalRequest="2019-01-03T00:00:00",
1434
ApprovalDelay=30000,
1435
ApprovalDuration=93785000,
1437
ExtendedTimeout=900000,
1438
Expires="2019-02-05T00:00:00",
1439
LastCheckerStatus=-2)
1440
self.clients = collections.OrderedDict(
1442
(self.client.__dbus_object_path__,
1443
self.client.attributes),
1444
(self.other_client.__dbus_object_path__,
1445
self.other_client.attributes),
1447
self.one_client = {self.client.__dbus_object_path__:
1448
self.client.attributes}
1452
class MockBus(object):
1454
def get_object(client_bus_name, path):
1455
self.assertEqual(dbus_busname, client_bus_name)
1456
# Note: "self" here is the TestCmd instance, not the
1457
# MockBus instance, since this is a static method!
1458
if path == self.client.__dbus_object_path__:
1460
elif path == self.other_client.__dbus_object_path__:
1461
return self.other_client
1465
class TestBaseCommands(TestCommand):
1467
def test_IsEnabled_exits_successfully(self):
1468
with self.assertRaises(SystemExit) as e:
1469
command.IsEnabled().run(self.one_client)
1470
if e.exception.code is not None:
1471
self.assertEqual(0, e.exception.code)
1473
self.assertIsNone(e.exception.code)
1475
def test_IsEnabled_exits_with_failure(self):
1476
self.client.attributes["Enabled"] = dbus.Boolean(False)
1477
with self.assertRaises(SystemExit) as e:
1478
command.IsEnabled().run(self.one_client)
1479
if isinstance(e.exception.code, int):
1480
self.assertNotEqual(0, e.exception.code)
1482
self.assertIsNotNone(e.exception.code)
1484
def test_Approve(self):
1485
command.Approve().run(self.clients, self.bus)
1486
for clientpath in self.clients:
1487
client = self.bus.get_object(dbus_busname, clientpath)
1488
self.assertIn(("Approve", (True, client_dbus_interface)),
1491
def test_Deny(self):
1492
command.Deny().run(self.clients, self.bus)
1493
for clientpath in self.clients:
1494
client = self.bus.get_object(dbus_busname, clientpath)
1495
self.assertIn(("Approve", (False, client_dbus_interface)),
1498
def test_Remove(self):
1499
class MandosSpy(object):
1502
def RemoveClient(self, dbus_path):
1503
self.calls.append(("RemoveClient", (dbus_path,)))
1504
mandos = MandosSpy()
1505
command.Remove().run(self.clients, self.bus, mandos)
1506
for clientpath in self.clients:
1507
self.assertIn(("RemoveClient", (clientpath,)),
1513
"KeyID": ("92ed150794387c03ce684574b1139a65"
1514
"94a34f895daaaf09fd8ea90a27cddb12"),
1515
"Host": "foo.example.org",
1518
"LastCheckedOK": "2019-02-03T00:00:00",
1519
"Created": "2019-01-02T00:00:00",
1521
"Fingerprint": ("778827225BA7DE539C5A"
1522
"7CFA59CFF7CDBD9A5920"),
1523
"CheckerRunning": False,
1524
"LastEnabled": "2019-01-03T00:00:00",
1525
"ApprovalPending": False,
1526
"ApprovedByDefault": True,
1527
"LastApprovalRequest": "",
1529
"ApprovalDuration": 1000,
1530
"Checker": "fping -q -- %(host)s",
1531
"ExtendedTimeout": 900000,
1532
"Expires": "2019-02-04T00:00:00",
1533
"LastCheckerStatus": 0,
1537
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1538
"6ab612cff5ad227247e46c2b020f441c"),
1539
"Host": "192.0.2.3",
1542
"LastCheckedOK": "2019-02-04T00:00:00",
1543
"Created": "2019-01-03T00:00:00",
1545
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1546
"F547B3A107558FCA3A27"),
1547
"CheckerRunning": True,
1548
"LastEnabled": "2019-01-04T00:00:00",
1549
"ApprovalPending": False,
1550
"ApprovedByDefault": False,
1551
"LastApprovalRequest": "2019-01-03T00:00:00",
1552
"ApprovalDelay": 30000,
1553
"ApprovalDuration": 93785000,
1555
"ExtendedTimeout": 900000,
1556
"Expires": "2019-02-05T00:00:00",
1557
"LastCheckerStatus": -2,
1561
def test_DumpJSON_normal(self):
1562
with self.capture_stdout_to_buffer() as buffer:
1563
command.DumpJSON().run(self.clients)
1564
json_data = json.loads(buffer.getvalue())
1565
self.assertDictEqual(self.expected_json, json_data)
1568
@contextlib.contextmanager
1569
def capture_stdout_to_buffer():
1570
capture_buffer = io.StringIO()
1571
old_stdout = sys.stdout
1572
sys.stdout = capture_buffer
1574
yield capture_buffer
1576
sys.stdout = old_stdout
1578
def test_DumpJSON_one_client(self):
1579
with self.capture_stdout_to_buffer() as buffer:
1580
command.DumpJSON().run(self.one_client)
1581
json_data = json.loads(buffer.getvalue())
1582
expected_json = {"foo": self.expected_json["foo"]}
1583
self.assertDictEqual(expected_json, json_data)
1585
def test_PrintTable_normal(self):
1586
with self.capture_stdout_to_buffer() as buffer:
1587
command.PrintTable().run(self.clients)
1588
expected_output = "\n".join((
1589
"Name Enabled Timeout Last Successful Check",
1590
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1591
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1593
self.assertEqual(expected_output, buffer.getvalue())
1595
def test_PrintTable_verbose(self):
1596
with self.capture_stdout_to_buffer() as buffer:
1597
command.PrintTable(verbose=True).run(self.clients)
1612
"Last Successful Check ",
1613
"2019-02-03T00:00:00 ",
1614
"2019-02-04T00:00:00 ",
1617
"2019-01-02T00:00:00 ",
1618
"2019-01-03T00:00:00 ",
1630
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1632
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1636
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1637
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1639
"Check Is Running ",
1644
"2019-01-03T00:00:00 ",
1645
"2019-01-04T00:00:00 ",
1647
"Approval Is Pending ",
1651
"Approved By Default ",
1655
"Last Approval Request ",
1657
"2019-01-03T00:00:00 ",
1663
"Approval Duration ",
1668
"fping -q -- %(host)s ",
1671
"Extended Timeout ",
1676
"2019-02-04T00:00:00 ",
1677
"2019-02-05T00:00:00 ",
1679
"Last Checker Status",
1684
num_lines = max(len(rows) for rows in columns)
1685
expected_output = ("\n".join("".join(rows[line]
1686
for rows in columns)
1687
for line in range(num_lines))
1689
self.assertEqual(expected_output, buffer.getvalue())
1691
def test_PrintTable_one_client(self):
1692
with self.capture_stdout_to_buffer() as buffer:
1693
command.PrintTable().run(self.one_client)
1694
expected_output = "\n".join((
1695
"Name Enabled Timeout Last Successful Check",
1696
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1698
self.assertEqual(expected_output, buffer.getvalue())
1701
class TestPropertySetterCmd(TestCommand):
1702
"""Abstract class for tests of command.PropertySetter classes"""
1704
if not hasattr(self, "command"):
1706
values_to_get = getattr(self, "values_to_get",
1708
for value_to_set, value_to_get in zip(self.values_to_set,
1710
for clientpath in self.clients:
1711
client = self.bus.get_object(dbus_busname, clientpath)
1712
old_value = client.attributes[self.propname]
1713
client.attributes[self.propname] = self.Unique()
1714
self.run_command(value_to_set, self.clients)
1715
for clientpath in self.clients:
1716
client = self.bus.get_object(dbus_busname, clientpath)
1717
value = client.attributes[self.propname]
1718
self.assertNotIsInstance(value, self.Unique)
1719
self.assertEqual(value_to_get, value)
1721
class Unique(object):
1722
"""Class for objects which exist only to be unique objects,
1723
since unittest.mock.sentinel only exists in Python 3.3"""
1725
def run_command(self, value, clients):
1726
self.command().run(clients, self.bus)
1729
class TestEnableCmd(TestPropertySetterCmd):
1730
command = command.Enable
1731
propname = "Enabled"
1732
values_to_set = [dbus.Boolean(True)]
1735
class TestDisableCmd(TestPropertySetterCmd):
1736
command = command.Disable
1737
propname = "Enabled"
1738
values_to_set = [dbus.Boolean(False)]
1741
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1742
command = command.BumpTimeout
1743
propname = "LastCheckedOK"
1744
values_to_set = [""]
1747
class TestStartCheckerCmd(TestPropertySetterCmd):
1748
command = command.StartChecker
1749
propname = "CheckerRunning"
1750
values_to_set = [dbus.Boolean(True)]
1753
class TestStopCheckerCmd(TestPropertySetterCmd):
1754
command = command.StopChecker
1755
propname = "CheckerRunning"
1756
values_to_set = [dbus.Boolean(False)]
1759
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1760
command = command.ApproveByDefault
1761
propname = "ApprovedByDefault"
1762
values_to_set = [dbus.Boolean(True)]
1765
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1766
command = command.DenyByDefault
1767
propname = "ApprovedByDefault"
1768
values_to_set = [dbus.Boolean(False)]
1771
class TestPropertySetterValueCmd(TestPropertySetterCmd):
1772
"""Abstract class for tests of PropertySetterValueCmd classes"""
1775
if type(self) is TestPropertySetterValueCmd:
1777
return super(TestPropertySetterValueCmd, self).runTest()
1779
def run_command(self, value, clients):
1780
self.command(value).run(clients, self.bus)
1783
class TestSetCheckerCmd(TestPropertySetterValueCmd):
1784
command = command.SetChecker
1785
propname = "Checker"
1786
values_to_set = ["", ":", "fping -q -- %s"]
1789
class TestSetHostCmd(TestPropertySetterValueCmd):
1790
command = command.SetHost
1792
values_to_set = ["192.0.2.3", "client.example.org"]
1795
class TestSetSecretCmd(TestPropertySetterValueCmd):
1796
command = command.SetSecret
1798
values_to_set = [io.BytesIO(b""),
1799
io.BytesIO(b"secret\0xyzzy\nbar")]
1800
values_to_get = [f.getvalue() for f in values_to_set]
1803
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
1804
command = command.SetTimeout
1805
propname = "Timeout"
1806
values_to_set = [datetime.timedelta(),
1807
datetime.timedelta(minutes=5),
1808
datetime.timedelta(seconds=1),
1809
datetime.timedelta(weeks=1),
1810
datetime.timedelta(weeks=52)]
1811
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1814
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
1815
command = command.SetExtendedTimeout
1816
propname = "ExtendedTimeout"
1817
values_to_set = [datetime.timedelta(),
1818
datetime.timedelta(minutes=5),
1819
datetime.timedelta(seconds=1),
1820
datetime.timedelta(weeks=1),
1821
datetime.timedelta(weeks=52)]
1822
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1825
class TestSetIntervalCmd(TestPropertySetterValueCmd):
1826
command = command.SetInterval
1827
propname = "Interval"
1828
values_to_set = [datetime.timedelta(),
1829
datetime.timedelta(minutes=5),
1830
datetime.timedelta(seconds=1),
1831
datetime.timedelta(weeks=1),
1832
datetime.timedelta(weeks=52)]
1833
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1836
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
1837
command = command.SetApprovalDelay
1838
propname = "ApprovalDelay"
1839
values_to_set = [datetime.timedelta(),
1840
datetime.timedelta(minutes=5),
1841
datetime.timedelta(seconds=1),
1842
datetime.timedelta(weeks=1),
1843
datetime.timedelta(weeks=52)]
1844
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1847
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
1848
command = command.SetApprovalDuration
1849
propname = "ApprovalDuration"
1850
values_to_set = [datetime.timedelta(),
1851
datetime.timedelta(minutes=5),
1852
datetime.timedelta(seconds=1),
1853
datetime.timedelta(weeks=1),
1854
datetime.timedelta(weeks=52)]
1855
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1859
def should_only_run_tests():
1860
parser = argparse.ArgumentParser(add_help=False)
1861
parser.add_argument("--check", action='store_true')
1862
args, unknown_args = parser.parse_known_args()
1863
run_tests = args.check
1865
# Remove --check argument from sys.argv
1866
sys.argv[1:] = unknown_args
1869
# Add all tests from doctest strings
1870
def load_tests(loader, tests, none):
1872
tests.addTests(doctest.DocTestSuite())
1875
if __name__ == "__main__":
1877
if should_only_run_tests():
1878
# Call using ./tdd-python-script --check [--verbose]
247
keywords = defaultkeywords
249
print_clients(clients.values(), keywords)
251
# Process each client in the list by all selected options
252
for client in clients:
254
mandos_serv.RemoveClient(client.__dbus_object_path__)
256
client.Enable(dbus_interface=client_interface)
258
client.Disable(dbus_interface=client_interface)
259
if options.bump_timeout:
260
client.CheckedOK(dbus_interface=client_interface)
261
if options.start_checker:
262
client.StartChecker(dbus_interface=client_interface)
263
if options.stop_checker:
264
client.StopChecker(dbus_interface=client_interface)
265
if options.is_enabled:
266
sys.exit(0 if client.Get(client_interface,
268
dbus_interface=dbus.PROPERTIES_IFACE)
271
client.Set(client_interface, u"Checker", options.checker,
272
dbus_interface=dbus.PROPERTIES_IFACE)
274
client.Set(client_interface, u"Host", options.host,
275
dbus_interface=dbus.PROPERTIES_IFACE)
277
client.Set(client_interface, u"Interval",
278
timedelta_to_milliseconds
279
(string_to_delta(options.interval)),
280
dbus_interface=dbus.PROPERTIES_IFACE)
281
if options.approval_delay:
282
client.Set(client_interface, u"ApprovalDelay",
283
timedelta_to_milliseconds
284
(string_to_delta(options.
286
dbus_interface=dbus.PROPERTIES_IFACE)
287
if options.approval_duration:
288
client.Set(client_interface, u"ApprovalDuration",
289
timedelta_to_milliseconds
290
(string_to_delta(options.
292
dbus_interface=dbus.PROPERTIES_IFACE)
294
client.Set(client_interface, u"Timeout",
295
timedelta_to_milliseconds
296
(string_to_delta(options.timeout)),
297
dbus_interface=dbus.PROPERTIES_IFACE)
299
client.Set(client_interface, u"Secret",
300
dbus.ByteArray(open(options.secret,
302
dbus_interface=dbus.PROPERTIES_IFACE)
303
if options.approved_by_default is not None:
304
client.Set(client_interface, u"ApprovedByDefault",
306
.approved_by_default),
307
dbus_interface=dbus.PROPERTIES_IFACE)
309
client.Approve(dbus.Boolean(True),
310
dbus_interface=client_interface)
312
client.Approve(dbus.Boolean(False),
313
dbus_interface=client_interface)
315
if __name__ == '__main__':