2
# -*- mode: python; coding: utf-8 -*-
4
from __future__ import division
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 *
7
from optparse import OptionParser
12
locale.setlocale(locale.LC_ALL, u'')
16
'enabled': u'Enabled',
17
'timeout': u'Timeout',
18
'last_checked_ok': u'Last Successful Check',
19
'created': u'Created',
20
'interval': u'Interval',
22
'fingerprint': u'Fingerprint',
23
'checker_running': u'Check Is Running',
24
'last_enabled': u'Last Enabled',
25
'checker': u'Checker',
27
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok')
28
domain = 'se.bsnet.fukt'
29
busname = domain + '.Mandos'
31
server_interface = domain + '.Mandos'
32
client_interface = domain + '.Mandos.Client'
34
bus = dbus.SystemBus()
35
mandos_dbus_objc = bus.get_object(busname, server_path)
36
mandos_serv = dbus.Interface(mandos_dbus_objc,
37
dbus_interface = server_interface)
38
mandos_clients = mandos_serv.GetAllClientsWithProperties()
40
def timedelta_to_milliseconds(td):
41
"Convert a datetime.timedelta object to milliseconds"
42
return ((td.days * 24 * 60 * 60 * 1000)
44
+ (td.microseconds // 1000))
46
def milliseconds_to_string(ms):
47
td = datetime.timedelta(0, 0, 0, ms)
48
return (u"%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
49
% { "days": "%dT" % td.days if td.days else "",
50
"hours": td.seconds // 3600,
51
"minutes": (td.seconds % 3600) // 60,
52
"seconds": td.seconds % 60,
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
locale.setlocale(locale.LC_ALL, "")
67
dbus_busname_domain = "se.recompile"
68
dbus_busname = dbus_busname_domain + ".Mandos"
69
server_dbus_path = "/"
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
72
del dbus_busname_domain
77
dbus.OBJECT_MANAGER_IFACE
78
except AttributeError:
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
83
parser = argparse.ArgumentParser()
85
add_command_line_options(parser)
87
options = parser.parse_args()
89
check_option_syntax(parser, options)
91
clientnames = options.client
94
log.setLevel(logging.DEBUG)
97
bus = dbus.SystemBus()
98
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
99
dbus_busname, server_dbus_path)
100
mandos_dbus_objc = bus.get_object(dbus_busname,
102
except dbus.exceptions.DBusException:
103
log.critical("Could not connect to Mandos server")
106
mandos_serv = dbus.Interface(mandos_dbus_objc,
107
dbus_interface=server_dbus_interface)
108
mandos_serv_object_manager = dbus.Interface(
109
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
111
# Filter out log message from dbus module
112
dbus_logger = logging.getLogger("dbus.proxies")
113
class NullFilter(logging.Filter):
114
def filter(self, record):
116
dbus_filter = NullFilter()
118
dbus_logger.addFilter(dbus_filter)
119
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
120
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
121
mandos_clients = {path: ifs_and_props[client_dbus_interface]
122
for path, ifs_and_props in
123
mandos_serv_object_manager
124
.GetManagedObjects().items()
125
if client_dbus_interface in ifs_and_props}
126
except dbus.exceptions.DBusException as e:
127
log.critical("Failed to access Mandos server through D-Bus:"
131
# restore dbus logger
132
dbus_logger.removeFilter(dbus_filter)
134
# Compile dict of (clients: properties) to process
138
clients = {objpath: properties
139
for objpath, properties in mandos_clients.items()}
141
for name in clientnames:
142
for objpath, properties in mandos_clients.items():
143
if properties["Name"] == name:
144
clients[objpath] = properties
147
log.critical("Client not found on server: %r", name)
150
# Run all commands on clients
151
commands = commands_from_options(options)
152
for command in commands:
153
command.run(clients, bus, mandos_serv)
156
def add_command_line_options(parser):
157
parser.add_argument("--version", action="version",
158
version="%(prog)s {}".format(version),
159
help="show version number and exit")
160
parser.add_argument("-a", "--all", action="store_true",
161
help="Select all clients")
162
parser.add_argument("-v", "--verbose", action="store_true",
163
help="Print all fields")
164
parser.add_argument("-j", "--dump-json", action="store_true",
165
help="Dump client data in JSON format")
166
enable_disable = parser.add_mutually_exclusive_group()
167
enable_disable.add_argument("-e", "--enable", action="store_true",
168
help="Enable client")
169
enable_disable.add_argument("-d", "--disable",
171
help="disable client")
172
parser.add_argument("-b", "--bump-timeout", action="store_true",
173
help="Bump timeout for client")
174
start_stop_checker = parser.add_mutually_exclusive_group()
175
start_stop_checker.add_argument("--start-checker",
177
help="Start checker for client")
178
start_stop_checker.add_argument("--stop-checker",
180
help="Stop checker for client")
181
parser.add_argument("-V", "--is-enabled", action="store_true",
182
help="Check if client is enabled")
183
parser.add_argument("-r", "--remove", action="store_true",
184
help="Remove client")
185
parser.add_argument("-c", "--checker",
186
help="Set checker command for client")
187
parser.add_argument("-t", "--timeout", type=string_to_delta,
188
help="Set timeout for client")
189
parser.add_argument("--extended-timeout", type=string_to_delta,
190
help="Set extended timeout for client")
191
parser.add_argument("-i", "--interval", type=string_to_delta,
192
help="Set checker interval for client")
193
approve_deny_default = parser.add_mutually_exclusive_group()
194
approve_deny_default.add_argument(
195
"--approve-by-default", action="store_true",
196
default=None, dest="approved_by_default",
197
help="Set client to be approved by default")
198
approve_deny_default.add_argument(
199
"--deny-by-default", action="store_false",
200
dest="approved_by_default",
201
help="Set client to be denied by default")
202
parser.add_argument("--approval-delay", type=string_to_delta,
203
help="Set delay before client approve/deny")
204
parser.add_argument("--approval-duration", type=string_to_delta,
205
help="Set duration of one client approval")
206
parser.add_argument("-H", "--host", help="Set host for client")
207
parser.add_argument("-s", "--secret",
208
type=argparse.FileType(mode="rb"),
209
help="Set password blob (file) for client")
210
approve_deny = parser.add_mutually_exclusive_group()
211
approve_deny.add_argument(
212
"-A", "--approve", action="store_true",
213
help="Approve any current client request")
214
approve_deny.add_argument("-D", "--deny", action="store_true",
215
help="Deny any current client request")
216
parser.add_argument("--debug", action="store_true",
217
help="Debug mode (show D-Bus commands)")
218
parser.add_argument("--check", action="store_true",
219
help="Run self-test")
220
parser.add_argument("client", nargs="*", help="Client name")
56
223
def string_to_delta(interval):
57
"""Parse a string and return a datetime.timedelta
59
>>> string_to_delta('7d')
61
>>> string_to_delta('60s')
62
datetime.timedelta(0, 60)
63
>>> string_to_delta('60m')
64
datetime.timedelta(0, 3600)
65
>>> string_to_delta('24h')
67
>>> string_to_delta(u'1w')
69
>>> string_to_delta('5m 30s')
70
datetime.timedelta(0, 330)
72
timevalue = datetime.timedelta(0)
73
regexp = re.compile("\d+[dsmhw]")
75
for s in regexp.findall(interval):
77
suffix = unicode(s[-1])
80
delta = datetime.timedelta(value)
82
delta = datetime.timedelta(0, value)
84
delta = datetime.timedelta(0, 0, 0, 0, value)
86
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
88
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
91
except (ValueError, IndexError):
96
def print_clients(clients):
97
def valuetostring(value, keyword):
98
if type(value) is dbus.Boolean:
99
return u"Yes" if value else u"No"
100
if keyword in (u"timeout", u"interval"):
101
return milliseconds_to_string(value)
102
return unicode(value)
104
# Create format string to print table rows
105
format_string = u' '.join(u'%%-%ds' %
106
max(len(tablewords[key]),
107
max(len(valuetostring(client[key], key))
112
print format_string % tuple(tablewords[key] for key in keywords)
113
for client in clients:
114
print format_string % tuple(valuetostring(client[key], key)
117
parser = OptionParser(version = "%%prog %s" % version)
118
parser.add_option("-a", "--all", action="store_true",
119
help="Print all fields")
120
parser.add_option("-e", "--enable", action="store_true",
121
help="Enable client")
122
parser.add_option("-d", "--disable", action="store_true",
123
help="disable client")
124
parser.add_option("-b", "--bump-timeout", action="store_true",
125
help="Bump timeout for client")
126
parser.add_option("--start-checker", action="store_true",
127
help="Start checker for client")
128
parser.add_option("--stop-checker", action="store_true",
129
help="Stop checker for client")
130
parser.add_option("-V", "--is-enabled", action="store_true",
131
help="Check if client is enabled")
132
parser.add_option("-r", "--remove", action="store_true",
133
help="Remove client")
134
parser.add_option("-c", "--checker", type="string",
135
help="Set checker command for client")
136
parser.add_option("-t", "--timeout", type="string",
137
help="Set timeout for client")
138
parser.add_option("-i", "--interval", type="string",
139
help="Set checker interval for client")
140
parser.add_option("-H", "--host", type="string",
141
help="Set host for client")
142
parser.add_option("-s", "--secret", type="string",
143
help="Set password blob (file) for client")
144
options, client_names = parser.parse_args()
146
# Compile list of clients to process
148
for name in client_names:
149
for path, client in mandos_clients.iteritems():
150
if client['name'] == name:
151
client_objc = bus.get_object(busname, path)
152
clients.append(client_objc)
155
print >> sys.stderr, "Client not found on server: %r" % name
158
if not clients and mandos_clients.values():
159
keywords = defaultkeywords
161
keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
162
'created', 'interval', 'host', 'fingerprint',
163
'checker_running', 'last_enabled', 'checker')
164
print_clients(mandos_clients.values())
166
# Process each client in the list by all selected options
167
for client in clients:
169
mandos_serv.RemoveClient(client.__dbus_object_path__)
224
"""Parse a string and return a datetime.timedelta"""
227
return rfc3339_duration_to_delta(interval)
228
except ValueError as e:
229
log.warning("%s - Parsing as pre-1.6.1 interval instead",
231
return parse_pre_1_6_1_interval(interval)
234
def rfc3339_duration_to_delta(duration):
235
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
237
>>> rfc3339_duration_to_delta("P7D")
238
datetime.timedelta(7)
239
>>> rfc3339_duration_to_delta("PT60S")
240
datetime.timedelta(0, 60)
241
>>> rfc3339_duration_to_delta("PT60M")
242
datetime.timedelta(0, 3600)
243
>>> rfc3339_duration_to_delta("P60M")
244
datetime.timedelta(1680)
245
>>> rfc3339_duration_to_delta("PT24H")
246
datetime.timedelta(1)
247
>>> rfc3339_duration_to_delta("P1W")
248
datetime.timedelta(7)
249
>>> rfc3339_duration_to_delta("PT5M30S")
250
datetime.timedelta(0, 330)
251
>>> rfc3339_duration_to_delta("P1DT3M20S")
252
datetime.timedelta(1, 200)
253
>>> # Can not be empty:
254
>>> rfc3339_duration_to_delta("")
255
Traceback (most recent call last):
257
ValueError: Invalid RFC 3339 duration: u''
258
>>> # Must start with "P":
259
>>> rfc3339_duration_to_delta("1D")
260
Traceback (most recent call last):
262
ValueError: Invalid RFC 3339 duration: u'1D'
263
>>> # Must use correct order
264
>>> rfc3339_duration_to_delta("PT1S2M")
265
Traceback (most recent call last):
267
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
268
>>> # Time needs time marker
269
>>> rfc3339_duration_to_delta("P1H2S")
270
Traceback (most recent call last):
272
ValueError: Invalid RFC 3339 duration: u'P1H2S'
273
>>> # Weeks can not be combined with anything else
274
>>> rfc3339_duration_to_delta("P1D2W")
275
Traceback (most recent call last):
277
ValueError: Invalid RFC 3339 duration: u'P1D2W'
278
>>> rfc3339_duration_to_delta("P2W2H")
279
Traceback (most recent call last):
281
ValueError: Invalid RFC 3339 duration: u'P2W2H'
284
# Parsing an RFC 3339 duration with regular expressions is not
285
# possible - there would have to be multiple places for the same
286
# values, like seconds. The current code, while more esoteric, is
287
# cleaner without depending on a parsing library. If Python had a
288
# built-in library for parsing we would use it, but we'd like to
289
# avoid excessive use of external libraries.
291
# New type for defining tokens, syntax, and semantics all-in-one
292
Token = collections.namedtuple("Token", (
293
"regexp", # To match token; if "value" is not None, must have
294
# a "group" containing digits
295
"value", # datetime.timedelta or None
296
"followers")) # Tokens valid after this token
297
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
298
# the "duration" ABNF definition in RFC 3339, Appendix A.
299
token_end = Token(re.compile(r"$"), None, frozenset())
300
token_second = Token(re.compile(r"(\d+)S"),
301
datetime.timedelta(seconds=1),
302
frozenset((token_end, )))
303
token_minute = Token(re.compile(r"(\d+)M"),
304
datetime.timedelta(minutes=1),
305
frozenset((token_second, token_end)))
306
token_hour = Token(re.compile(r"(\d+)H"),
307
datetime.timedelta(hours=1),
308
frozenset((token_minute, token_end)))
309
token_time = Token(re.compile(r"T"),
311
frozenset((token_hour, token_minute,
313
token_day = Token(re.compile(r"(\d+)D"),
314
datetime.timedelta(days=1),
315
frozenset((token_time, token_end)))
316
token_month = Token(re.compile(r"(\d+)M"),
317
datetime.timedelta(weeks=4),
318
frozenset((token_day, token_end)))
319
token_year = Token(re.compile(r"(\d+)Y"),
320
datetime.timedelta(weeks=52),
321
frozenset((token_month, token_end)))
322
token_week = Token(re.compile(r"(\d+)W"),
323
datetime.timedelta(weeks=1),
324
frozenset((token_end, )))
325
token_duration = Token(re.compile(r"P"), None,
326
frozenset((token_year, token_month,
327
token_day, token_time,
329
# Define starting values:
331
value = datetime.timedelta()
333
# Following valid tokens
334
followers = frozenset((token_duration, ))
335
# String left to parse
337
# Loop until end token is found
338
while found_token is not token_end:
339
# Search for any currently valid tokens
340
for token in followers:
341
match = token.regexp.match(s)
342
if match is not None:
344
if token.value is not None:
345
# Value found, parse digits
346
factor = int(match.group(1), 10)
347
# Add to value so far
348
value += factor * token.value
349
# Strip token from string
350
s = token.regexp.sub("", s, 1)
353
# Set valid next tokens
354
followers = found_token.followers
357
# No currently valid tokens were found
358
raise ValueError("Invalid RFC 3339 duration: {!r}"
364
def parse_pre_1_6_1_interval(interval):
365
"""Parse an interval string as documented by Mandos before 1.6.1,
366
and return a datetime.timedelta
368
>>> parse_pre_1_6_1_interval('7d')
369
datetime.timedelta(7)
370
>>> parse_pre_1_6_1_interval('60s')
371
datetime.timedelta(0, 60)
372
>>> parse_pre_1_6_1_interval('60m')
373
datetime.timedelta(0, 3600)
374
>>> parse_pre_1_6_1_interval('24h')
375
datetime.timedelta(1)
376
>>> parse_pre_1_6_1_interval('1w')
377
datetime.timedelta(7)
378
>>> parse_pre_1_6_1_interval('5m 30s')
379
datetime.timedelta(0, 330)
380
>>> parse_pre_1_6_1_interval('')
381
datetime.timedelta(0)
382
>>> # Ignore unknown characters, allow any order and repetitions
383
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
384
datetime.timedelta(2, 480, 18000)
388
value = datetime.timedelta(0)
389
regexp = re.compile(r"(\d+)([dsmhw]?)")
391
for num, suffix in regexp.findall(interval):
393
value += datetime.timedelta(int(num))
395
value += datetime.timedelta(0, int(num))
397
value += datetime.timedelta(0, 0, 0, 0, int(num))
399
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
401
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
403
value += datetime.timedelta(0, 0, 0, int(num))
407
def check_option_syntax(parser, options):
408
"""Apply additional restrictions on options, not expressible in
411
def has_actions(options):
412
return any((options.enable,
414
options.bump_timeout,
415
options.start_checker,
416
options.stop_checker,
419
options.checker is not None,
420
options.timeout is not None,
421
options.extended_timeout is not None,
422
options.interval is not None,
423
options.approved_by_default is not None,
424
options.approval_delay is not None,
425
options.approval_duration is not None,
426
options.host is not None,
427
options.secret is not None,
431
if has_actions(options) and not (options.client or options.all):
432
parser.error("Options require clients names or --all.")
433
if options.verbose and has_actions(options):
434
parser.error("--verbose can only be used alone.")
435
if options.dump_json and (options.verbose
436
or has_actions(options)):
437
parser.error("--dump-json can only be used alone.")
438
if options.all and not has_actions(options):
439
parser.error("--all requires an action.")
440
if options.is_enabled and len(options.client) > 1:
441
parser.error("--is-enabled requires exactly one client")
443
options.remove = False
444
if has_actions(options) and not options.deny:
445
parser.error("--remove can only be combined with --deny")
446
options.remove = True
449
def commands_from_options(options):
453
if options.is_enabled:
454
commands.append(IsEnabledCmd())
457
commands.append(ApproveCmd())
460
commands.append(DenyCmd())
463
commands.append(RemoveCmd())
465
if options.dump_json:
466
commands.append(DumpJSONCmd())
170
468
if options.enable:
171
client.Enable(dbus_interface=client_interface)
469
commands.append(EnableCmd())
172
471
if options.disable:
173
client.Disable(dbus_interface=client_interface)
472
commands.append(DisableCmd())
174
474
if options.bump_timeout:
175
client.CheckedOK(dbus_interface=client_interface)
475
commands.append(BumpTimeoutCmd())
176
477
if options.start_checker:
177
client.StartChecker(dbus_interface=client_interface)
478
commands.append(StartCheckerCmd())
178
480
if options.stop_checker:
179
client.StopChecker(dbus_interface=client_interface)
180
if options.is_enabled:
181
sys.exit(0 if client.Get(client_interface,
183
dbus_interface=dbus.PROPERTIES_IFACE)
186
client.Set(client_interface, u"checker", options.checker,
187
dbus_interface=dbus.PROPERTIES_IFACE)
189
client.Set(client_interface, u"host", options.host,
190
dbus_interface=dbus.PROPERTIES_IFACE)
192
client.Set(client_interface, u"interval",
193
timedelta_to_milliseconds
194
(string_to_delta(options.interval)),
195
dbus_interface=dbus.PROPERTIES_IFACE)
197
client.Set(client_interface, u"timeout",
198
timedelta_to_milliseconds(string_to_delta
200
dbus_interface=dbus.PROPERTIES_IFACE)
202
client.Set(client_interface, u"secret",
203
dbus.ByteArray(open(options.secret, u'rb').read()),
204
dbus_interface=dbus.PROPERTIES_IFACE)
481
commands.append(StopCheckerCmd())
483
if options.approved_by_default is not None:
484
if options.approved_by_default:
485
commands.append(ApproveByDefaultCmd())
487
commands.append(DenyByDefaultCmd())
489
if options.checker is not None:
490
commands.append(SetCheckerCmd(options.checker))
492
if options.host is not None:
493
commands.append(SetHostCmd(options.host))
495
if options.secret is not None:
496
commands.append(SetSecretCmd(options.secret))
498
if options.timeout is not None:
499
commands.append(SetTimeoutCmd(options.timeout))
501
if options.extended_timeout:
503
SetExtendedTimeoutCmd(options.extended_timeout))
505
if options.interval is not None:
506
commands.append(SetIntervalCmd(options.interval))
508
if options.approval_delay is not None:
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
511
if options.approval_duration is not None:
513
SetApprovalDurationCmd(options.approval_duration))
515
# If no command option has been given, show table of clients,
516
# optionally verbosely
518
commands.append(PrintTableCmd(verbose=options.verbose))
523
class Command(object):
524
"""Abstract class for commands"""
525
def run(self, clients, bus=None, mandos=None):
526
"""Normal commands should implement run_on_one_client(), but
527
commands which want to operate on all clients at the same time
528
can override this run() method instead."""
530
for clientpath, properties in clients.items():
531
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
532
dbus_busname, str(clientpath))
533
client = bus.get_object(dbus_busname, clientpath)
534
self.run_on_one_client(client, properties)
537
class IsEnabledCmd(Command):
538
def run(self, clients, bus=None, mandos=None):
539
client, properties = next(iter(clients.items()))
540
if self.is_enabled(client, properties):
543
def is_enabled(self, client, properties):
544
return properties["Enabled"]
547
class ApproveCmd(Command):
548
def run_on_one_client(self, client, properties):
549
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
550
client.__dbus_object_path__, client_dbus_interface)
551
client.Approve(dbus.Boolean(True),
552
dbus_interface=client_dbus_interface)
555
class DenyCmd(Command):
556
def run_on_one_client(self, client, properties):
557
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
558
client.__dbus_object_path__, client_dbus_interface)
559
client.Approve(dbus.Boolean(False),
560
dbus_interface=client_dbus_interface)
563
class RemoveCmd(Command):
564
def run_on_one_client(self, client, properties):
565
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
566
server_dbus_path, server_dbus_interface,
567
str(client.__dbus_object_path__))
568
self.mandos.RemoveClient(client.__dbus_object_path__)
571
class OutputCmd(Command):
572
"""Abstract class for commands outputting client details"""
573
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
574
"Created", "Interval", "Host", "KeyID",
575
"Fingerprint", "CheckerRunning", "LastEnabled",
576
"ApprovalPending", "ApprovedByDefault",
577
"LastApprovalRequest", "ApprovalDelay",
578
"ApprovalDuration", "Checker", "ExtendedTimeout",
579
"Expires", "LastCheckerStatus")
580
def run(self, clients, bus=None, mandos=None):
581
print(self.output(clients.values()))
582
def output(self, clients):
583
raise NotImplementedError()
586
class DumpJSONCmd(OutputCmd):
587
def output(self, clients):
588
data = {client["Name"]:
589
{key: self.dbus_boolean_to_bool(client[key])
590
for key in self.all_keywords}
591
for client in clients.values()}
592
return json.dumps(data, indent=4, separators=(',', ': '))
594
def dbus_boolean_to_bool(value):
595
if isinstance(value, dbus.Boolean):
600
class PrintTableCmd(OutputCmd):
601
def __init__(self, verbose=False):
602
self.verbose = verbose
604
def output(self, clients):
605
default_keywords = ("Name", "Enabled", "Timeout",
607
keywords = default_keywords
609
keywords = self.all_keywords
610
return str(self.TableOfClients(clients, keywords))
612
class TableOfClients(object):
615
"Enabled": "Enabled",
616
"Timeout": "Timeout",
617
"LastCheckedOK": "Last Successful Check",
618
"LastApprovalRequest": "Last Approval Request",
619
"Created": "Created",
620
"Interval": "Interval",
622
"Fingerprint": "Fingerprint",
624
"CheckerRunning": "Check Is Running",
625
"LastEnabled": "Last Enabled",
626
"ApprovalPending": "Approval Is Pending",
627
"ApprovedByDefault": "Approved By Default",
628
"ApprovalDelay": "Approval Delay",
629
"ApprovalDuration": "Approval Duration",
630
"Checker": "Checker",
631
"ExtendedTimeout": "Extended Timeout",
632
"Expires": "Expires",
633
"LastCheckerStatus": "Last Checker Status",
636
def __init__(self, clients, keywords, tableheaders=None):
637
self.clients = clients
638
self.keywords = keywords
639
if tableheaders is not None:
640
self.tableheaders = tableheaders
643
return "\n".join(self.rows())
645
if sys.version_info.major == 2:
646
__unicode__ = __str__
648
return str(self).encode(locale.getpreferredencoding())
651
format_string = self.row_formatting_string()
652
rows = [self.header_line(format_string)]
653
rows.extend(self.client_line(client, format_string)
654
for client in self.clients)
657
def row_formatting_string(self):
658
"Format string used to format table rows"
659
return " ".join("{{{key}:{width}}}".format(
660
width=max(len(self.tableheaders[key]),
661
*(len(self.string_from_client(client, key))
662
for client in self.clients)),
664
for key in self.keywords)
666
def string_from_client(self, client, key):
667
return self.valuetostring(client[key], key)
670
def valuetostring(cls, value, keyword):
671
if isinstance(value, dbus.Boolean):
672
return "Yes" if value else "No"
673
if keyword in ("Timeout", "Interval", "ApprovalDelay",
674
"ApprovalDuration", "ExtendedTimeout"):
675
return cls.milliseconds_to_string(value)
678
def header_line(self, format_string):
679
return format_string.format(**self.tableheaders)
681
def client_line(self, client, format_string):
682
return format_string.format(
683
**{key: self.string_from_client(client, key)
684
for key in self.keywords})
687
def milliseconds_to_string(ms):
688
td = datetime.timedelta(0, 0, 0, ms)
689
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
690
.format(days="{}T".format(td.days)
692
hours=td.seconds // 3600,
693
minutes=(td.seconds % 3600) // 60,
694
seconds=td.seconds % 60))
697
class PropertyCmd(Command):
698
"""Abstract class for Actions for setting one client property"""
699
def run_on_one_client(self, client, properties):
700
"""Set the Client's D-Bus property"""
701
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
702
client.__dbus_object_path__,
703
dbus.PROPERTIES_IFACE, client_dbus_interface,
704
self.propname, self.value_to_set
705
if not isinstance(self.value_to_set, dbus.Boolean)
706
else bool(self.value_to_set))
707
client.Set(client_dbus_interface, self.propname,
709
dbus_interface=dbus.PROPERTIES_IFACE)
712
raise NotImplementedError()
715
class EnableCmd(PropertyCmd):
717
value_to_set = dbus.Boolean(True)
720
class DisableCmd(PropertyCmd):
722
value_to_set = dbus.Boolean(False)
725
class BumpTimeoutCmd(PropertyCmd):
726
propname = "LastCheckedOK"
730
class StartCheckerCmd(PropertyCmd):
731
propname = "CheckerRunning"
732
value_to_set = dbus.Boolean(True)
735
class StopCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
737
value_to_set = dbus.Boolean(False)
740
class ApproveByDefaultCmd(PropertyCmd):
741
propname = "ApprovedByDefault"
742
value_to_set = dbus.Boolean(True)
745
class DenyByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
747
value_to_set = dbus.Boolean(False)
750
class PropertyValueCmd(PropertyCmd):
751
"""Abstract class for PropertyCmd recieving a value as argument"""
752
def __init__(self, value):
753
self.value_to_set = value
756
class SetCheckerCmd(PropertyValueCmd):
760
class SetHostCmd(PropertyValueCmd):
764
class SetSecretCmd(PropertyValueCmd):
767
def value_to_set(self):
770
def value_to_set(self, value):
771
"""When setting, read data from supplied file object"""
772
self._vts = value.read()
776
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
777
"""Abstract class for PropertyValueCmd taking a value argument as
778
a datetime.timedelta() but should store it as milliseconds."""
780
def value_to_set(self):
783
def value_to_set(self, value):
784
"""When setting, convert value from a datetime.timedelta"""
785
self._vts = int(round(value.total_seconds() * 1000))
788
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
792
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
793
propname = "ExtendedTimeout"
796
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
797
propname = "Interval"
800
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
801
propname = "ApprovalDelay"
804
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
805
propname = "ApprovalDuration"
809
class Test_string_to_delta(unittest.TestCase):
810
def test_handles_basic_rfc3339(self):
811
self.assertEqual(string_to_delta("PT0S"),
812
datetime.timedelta())
813
self.assertEqual(string_to_delta("P0D"),
814
datetime.timedelta())
815
self.assertEqual(string_to_delta("PT1S"),
816
datetime.timedelta(0, 1))
817
self.assertEqual(string_to_delta("PT2H"),
818
datetime.timedelta(0, 7200))
819
def test_falls_back_to_pre_1_6_1_with_warning(self):
820
# assertLogs only exists in Python 3.4
821
if hasattr(self, "assertLogs"):
822
with self.assertLogs(log, logging.WARNING):
823
value = string_to_delta("2h")
825
class WarningFilter(logging.Filter):
826
"""Don't show, but record the presence of, warnings"""
827
def filter(self, record):
828
is_warning = record.levelno >= logging.WARNING
829
self.found = is_warning or getattr(self, "found",
831
return not is_warning
832
warning_filter = WarningFilter()
833
log.addFilter(warning_filter)
835
value = string_to_delta("2h")
837
log.removeFilter(warning_filter)
838
self.assertTrue(getattr(warning_filter, "found", False))
839
self.assertEqual(value, datetime.timedelta(0, 7200))
842
class Test_check_option_syntax(unittest.TestCase):
844
self.parser = argparse.ArgumentParser()
845
add_command_line_options(self.parser)
847
def test_actions_requires_client_or_all(self):
848
for action, value in self.actions.items():
849
options = self.parser.parse_args()
850
setattr(options, action, value)
851
with self.assertParseError():
852
self.check_option_syntax(options)
854
# This mostly corresponds to the definition from has_actions() in
855
# check_option_syntax()
857
# The actual values set here are not that important, but we do
858
# at least stick to the correct types, even though they are
862
"bump_timeout": True,
863
"start_checker": True,
864
"stop_checker": True,
868
"timeout": datetime.timedelta(),
869
"extended_timeout": datetime.timedelta(),
870
"interval": datetime.timedelta(),
871
"approved_by_default": True,
872
"approval_delay": datetime.timedelta(),
873
"approval_duration": datetime.timedelta(),
875
"secret": io.BytesIO(b"x"),
880
@contextlib.contextmanager
881
def assertParseError(self):
882
with self.assertRaises(SystemExit) as e:
883
with self.temporarily_suppress_stderr():
885
# Exit code from argparse is guaranteed to be "2". Reference:
886
# https://docs.python.org/3/library
887
# /argparse.html#exiting-methods
888
self.assertEqual(e.exception.code, 2)
891
@contextlib.contextmanager
892
def temporarily_suppress_stderr():
893
null = os.open(os.path.devnull, os.O_RDWR)
894
stderrcopy = os.dup(sys.stderr.fileno())
895
os.dup2(null, sys.stderr.fileno())
901
os.dup2(stderrcopy, sys.stderr.fileno())
904
def check_option_syntax(self, options):
905
check_option_syntax(self.parser, options)
907
def test_actions_conflicts_with_verbose(self):
908
for action, value in self.actions.items():
909
options = self.parser.parse_args()
910
setattr(options, action, value)
911
options.verbose = True
912
with self.assertParseError():
913
self.check_option_syntax(options)
915
def test_dump_json_conflicts_with_verbose(self):
916
options = self.parser.parse_args()
917
options.dump_json = True
918
options.verbose = True
919
with self.assertParseError():
920
self.check_option_syntax(options)
922
def test_dump_json_conflicts_with_action(self):
923
for action, value in self.actions.items():
924
options = self.parser.parse_args()
925
setattr(options, action, value)
926
options.dump_json = True
927
with self.assertParseError():
928
self.check_option_syntax(options)
930
def test_all_can_not_be_alone(self):
931
options = self.parser.parse_args()
933
with self.assertParseError():
934
self.check_option_syntax(options)
936
def test_all_is_ok_with_any_action(self):
937
for action, value in self.actions.items():
938
options = self.parser.parse_args()
939
setattr(options, action, value)
941
self.check_option_syntax(options)
943
def test_is_enabled_fails_without_client(self):
944
options = self.parser.parse_args()
945
options.is_enabled = True
946
with self.assertParseError():
947
self.check_option_syntax(options)
949
def test_is_enabled_works_with_one_client(self):
950
options = self.parser.parse_args()
951
options.is_enabled = True
952
options.client = ["foo"]
953
self.check_option_syntax(options)
955
def test_is_enabled_fails_with_two_clients(self):
956
options = self.parser.parse_args()
957
options.is_enabled = True
958
options.client = ["foo", "barbar"]
959
with self.assertParseError():
960
self.check_option_syntax(options)
962
def test_remove_can_only_be_combined_with_action_deny(self):
963
for action, value in self.actions.items():
964
if action in {"remove", "deny"}:
966
options = self.parser.parse_args()
967
setattr(options, action, value)
969
options.remove = True
970
with self.assertParseError():
971
self.check_option_syntax(options)
974
class Test_commands_from_options(unittest.TestCase):
976
self.parser = argparse.ArgumentParser()
977
add_command_line_options(self.parser)
979
def test_is_enabled(self):
980
self.assert_command_from_args(["--is-enabled", "foo"],
983
def assert_command_from_args(self, args, command_cls,
985
"""Assert that parsing ARGS should result in an instance of
986
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
987
options = self.parser.parse_args(args)
988
check_option_syntax(self.parser, options)
989
commands = commands_from_options(options)
990
self.assertEqual(len(commands), 1)
991
command = commands[0]
992
self.assertIsInstance(command, command_cls)
993
for key, value in cmd_attrs.items():
994
self.assertEqual(getattr(command, key), value)
996
def test_is_enabled_short(self):
997
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
999
def test_approve(self):
1000
self.assert_command_from_args(["--approve", "foo"],
1003
def test_approve_short(self):
1004
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1006
def test_deny(self):
1007
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1009
def test_deny_short(self):
1010
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1012
def test_remove(self):
1013
self.assert_command_from_args(["--remove", "foo"],
1016
def test_deny_before_remove(self):
1017
options = self.parser.parse_args(["--deny", "--remove",
1019
check_option_syntax(self.parser, options)
1020
commands = commands_from_options(options)
1021
self.assertEqual(len(commands), 2)
1022
self.assertIsInstance(commands[0], DenyCmd)
1023
self.assertIsInstance(commands[1], RemoveCmd)
1025
def test_deny_before_remove_reversed(self):
1026
options = self.parser.parse_args(["--remove", "--deny",
1028
check_option_syntax(self.parser, options)
1029
commands = commands_from_options(options)
1030
self.assertEqual(len(commands), 2)
1031
self.assertIsInstance(commands[0], DenyCmd)
1032
self.assertIsInstance(commands[1], RemoveCmd)
1034
def test_remove_short(self):
1035
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1037
def test_dump_json(self):
1038
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1040
def test_enable(self):
1041
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1043
def test_enable_short(self):
1044
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1046
def test_disable(self):
1047
self.assert_command_from_args(["--disable", "foo"],
1050
def test_disable_short(self):
1051
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1053
def test_bump_timeout(self):
1054
self.assert_command_from_args(["--bump-timeout", "foo"],
1057
def test_bump_timeout_short(self):
1058
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1060
def test_start_checker(self):
1061
self.assert_command_from_args(["--start-checker", "foo"],
1064
def test_stop_checker(self):
1065
self.assert_command_from_args(["--stop-checker", "foo"],
1068
def test_approve_by_default(self):
1069
self.assert_command_from_args(["--approve-by-default", "foo"],
1070
ApproveByDefaultCmd)
1072
def test_deny_by_default(self):
1073
self.assert_command_from_args(["--deny-by-default", "foo"],
1076
def test_checker(self):
1077
self.assert_command_from_args(["--checker", ":", "foo"],
1078
SetCheckerCmd, value_to_set=":")
1080
def test_checker_empty(self):
1081
self.assert_command_from_args(["--checker", "", "foo"],
1082
SetCheckerCmd, value_to_set="")
1084
def test_checker_short(self):
1085
self.assert_command_from_args(["-c", ":", "foo"],
1086
SetCheckerCmd, value_to_set=":")
1088
def test_host(self):
1089
self.assert_command_from_args(["--host", "foo.example.org",
1091
value_to_set="foo.example.org")
1093
def test_host_short(self):
1094
self.assert_command_from_args(["-H", "foo.example.org",
1096
value_to_set="foo.example.org")
1098
def test_secret_devnull(self):
1099
self.assert_command_from_args(["--secret", os.path.devnull,
1100
"foo"], SetSecretCmd,
1103
def test_secret_tempfile(self):
1104
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1105
value = b"secret\0xyzzy\nbar"
1108
self.assert_command_from_args(["--secret", f.name,
1109
"foo"], SetSecretCmd,
1112
def test_secret_devnull_short(self):
1113
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1114
SetSecretCmd, value_to_set=b"")
1116
def test_secret_tempfile_short(self):
1117
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1118
value = b"secret\0xyzzy\nbar"
1121
self.assert_command_from_args(["-s", f.name, "foo"],
1125
def test_timeout(self):
1126
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1128
value_to_set=300000)
1130
def test_timeout_short(self):
1131
self.assert_command_from_args(["-t", "PT5M", "foo"],
1133
value_to_set=300000)
1135
def test_extended_timeout(self):
1136
self.assert_command_from_args(["--extended-timeout", "PT15M",
1138
SetExtendedTimeoutCmd,
1139
value_to_set=900000)
1141
def test_interval(self):
1142
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1144
value_to_set=120000)
1146
def test_interval_short(self):
1147
self.assert_command_from_args(["-i", "PT2M", "foo"],
1149
value_to_set=120000)
1151
def test_approval_delay(self):
1152
self.assert_command_from_args(["--approval-delay", "PT30S",
1153
"foo"], SetApprovalDelayCmd,
1156
def test_approval_duration(self):
1157
self.assert_command_from_args(["--approval-duration", "PT1S",
1158
"foo"], SetApprovalDurationCmd,
1161
def test_print_table(self):
1162
self.assert_command_from_args([], PrintTableCmd,
1165
def test_print_table_verbose(self):
1166
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1169
def test_print_table_verbose_short(self):
1170
self.assert_command_from_args(["-v"], PrintTableCmd,
1174
class TestCmd(unittest.TestCase):
1175
"""Abstract class for tests of command classes"""
1178
class MockClient(object):
1179
def __init__(self, name, **attributes):
1180
self.__dbus_object_path__ = "/clients/{}".format(name)
1181
self.attributes = attributes
1182
self.attributes["Name"] = name
1184
def Set(self, interface, propname, value, dbus_interface):
1185
testcase.assertEqual(interface, client_dbus_interface)
1186
testcase.assertEqual(dbus_interface,
1187
dbus.PROPERTIES_IFACE)
1188
self.attributes[propname] = value
1189
def Get(self, interface, propname, dbus_interface):
1190
testcase.assertEqual(interface, client_dbus_interface)
1191
testcase.assertEqual(dbus_interface,
1192
dbus.PROPERTIES_IFACE)
1193
return self.attributes[propname]
1194
def Approve(self, approve, dbus_interface):
1195
testcase.assertEqual(dbus_interface,
1196
client_dbus_interface)
1197
self.calls.append(("Approve", (approve,
1199
self.client = MockClient(
1201
KeyID=("92ed150794387c03ce684574b1139a65"
1202
"94a34f895daaaf09fd8ea90a27cddb12"),
1204
Host="foo.example.org",
1205
Enabled=dbus.Boolean(True),
1207
LastCheckedOK="2019-02-03T00:00:00",
1208
Created="2019-01-02T00:00:00",
1210
Fingerprint=("778827225BA7DE539C5A"
1211
"7CFA59CFF7CDBD9A5920"),
1212
CheckerRunning=dbus.Boolean(False),
1213
LastEnabled="2019-01-03T00:00:00",
1214
ApprovalPending=dbus.Boolean(False),
1215
ApprovedByDefault=dbus.Boolean(True),
1216
LastApprovalRequest="",
1218
ApprovalDuration=1000,
1219
Checker="fping -q -- %(host)s",
1220
ExtendedTimeout=900000,
1221
Expires="2019-02-04T00:00:00",
1222
LastCheckerStatus=0)
1223
self.other_client = MockClient(
1225
KeyID=("0558568eedd67d622f5c83b35a115f79"
1226
"6ab612cff5ad227247e46c2b020f441c"),
1227
Secret=b"secretbar",
1229
Enabled=dbus.Boolean(True),
1231
LastCheckedOK="2019-02-04T00:00:00",
1232
Created="2019-01-03T00:00:00",
1234
Fingerprint=("3E393AEAEFB84C7E89E2"
1235
"F547B3A107558FCA3A27"),
1236
CheckerRunning=dbus.Boolean(True),
1237
LastEnabled="2019-01-04T00:00:00",
1238
ApprovalPending=dbus.Boolean(False),
1239
ApprovedByDefault=dbus.Boolean(False),
1240
LastApprovalRequest="2019-01-03T00:00:00",
1241
ApprovalDelay=30000,
1242
ApprovalDuration=93785000,
1244
ExtendedTimeout=900000,
1245
Expires="2019-02-05T00:00:00",
1246
LastCheckerStatus=-2)
1247
self.clients = collections.OrderedDict(
1249
("/clients/foo", self.client.attributes),
1250
("/clients/barbar", self.other_client.attributes),
1252
self.one_client = {"/clients/foo": self.client.attributes}
1257
def get_object(client_bus_name, path):
1258
self.assertEqual(client_bus_name, dbus_busname)
1260
"/clients/foo": self.client,
1261
"/clients/barbar": self.other_client,
1266
class TestIsEnabledCmd(TestCmd):
1267
def test_is_enabled(self):
1268
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1270
for client, properties
1271
in self.clients.items()))
1272
def test_is_enabled_run_exits_successfully(self):
1273
with self.assertRaises(SystemExit) as e:
1274
IsEnabledCmd().run(self.one_client)
1275
if e.exception.code is not None:
1276
self.assertEqual(e.exception.code, 0)
1278
self.assertIsNone(e.exception.code)
1279
def test_is_enabled_run_exits_with_failure(self):
1280
self.client.attributes["Enabled"] = dbus.Boolean(False)
1281
with self.assertRaises(SystemExit) as e:
1282
IsEnabledCmd().run(self.one_client)
1283
if isinstance(e.exception.code, int):
1284
self.assertNotEqual(e.exception.code, 0)
1286
self.assertIsNotNone(e.exception.code)
1289
class TestApproveCmd(TestCmd):
1290
def test_approve(self):
1291
ApproveCmd().run(self.clients, self.bus)
1292
for clientpath in self.clients:
1293
client = self.bus.get_object(dbus_busname, clientpath)
1294
self.assertIn(("Approve", (True, client_dbus_interface)),
1298
class TestDenyCmd(TestCmd):
1299
def test_deny(self):
1300
DenyCmd().run(self.clients, self.bus)
1301
for clientpath in self.clients:
1302
client = self.bus.get_object(dbus_busname, clientpath)
1303
self.assertIn(("Approve", (False, client_dbus_interface)),
1306
class TestRemoveCmd(TestCmd):
1307
def test_remove(self):
1308
class MockMandos(object):
1311
def RemoveClient(self, dbus_path):
1312
self.calls.append(("RemoveClient", (dbus_path,)))
1313
mandos = MockMandos()
1314
super(TestRemoveCmd, self).setUp()
1315
RemoveCmd().run(self.clients, self.bus, mandos)
1316
self.assertEqual(len(mandos.calls), 2)
1317
for clientpath in self.clients:
1318
self.assertIn(("RemoveClient", (clientpath,)),
1322
class TestDumpJSONCmd(TestCmd):
1324
self.expected_json = {
1327
"KeyID": ("92ed150794387c03ce684574b1139a65"
1328
"94a34f895daaaf09fd8ea90a27cddb12"),
1329
"Host": "foo.example.org",
1332
"LastCheckedOK": "2019-02-03T00:00:00",
1333
"Created": "2019-01-02T00:00:00",
1335
"Fingerprint": ("778827225BA7DE539C5A"
1336
"7CFA59CFF7CDBD9A5920"),
1337
"CheckerRunning": False,
1338
"LastEnabled": "2019-01-03T00:00:00",
1339
"ApprovalPending": False,
1340
"ApprovedByDefault": True,
1341
"LastApprovalRequest": "",
1343
"ApprovalDuration": 1000,
1344
"Checker": "fping -q -- %(host)s",
1345
"ExtendedTimeout": 900000,
1346
"Expires": "2019-02-04T00:00:00",
1347
"LastCheckerStatus": 0,
1351
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1352
"6ab612cff5ad227247e46c2b020f441c"),
1353
"Host": "192.0.2.3",
1356
"LastCheckedOK": "2019-02-04T00:00:00",
1357
"Created": "2019-01-03T00:00:00",
1359
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1360
"F547B3A107558FCA3A27"),
1361
"CheckerRunning": True,
1362
"LastEnabled": "2019-01-04T00:00:00",
1363
"ApprovalPending": False,
1364
"ApprovedByDefault": False,
1365
"LastApprovalRequest": "2019-01-03T00:00:00",
1366
"ApprovalDelay": 30000,
1367
"ApprovalDuration": 93785000,
1369
"ExtendedTimeout": 900000,
1370
"Expires": "2019-02-05T00:00:00",
1371
"LastCheckerStatus": -2,
1374
return super(TestDumpJSONCmd, self).setUp()
1375
def test_normal(self):
1376
json_data = json.loads(DumpJSONCmd().output(self.clients))
1377
self.assertDictEqual(json_data, self.expected_json)
1378
def test_one_client(self):
1379
clients = self.one_client
1380
json_data = json.loads(DumpJSONCmd().output(clients))
1381
expected_json = {"foo": self.expected_json["foo"]}
1382
self.assertDictEqual(json_data, expected_json)
1385
class TestPrintTableCmd(TestCmd):
1386
def test_normal(self):
1387
output = PrintTableCmd().output(self.clients.values())
1388
expected_output = "\n".join((
1389
"Name Enabled Timeout Last Successful Check",
1390
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1391
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1393
self.assertEqual(output, expected_output)
1394
def test_verbose(self):
1395
output = PrintTableCmd(verbose=True).output(
1396
self.clients.values())
1411
"Last Successful Check ",
1412
"2019-02-03T00:00:00 ",
1413
"2019-02-04T00:00:00 ",
1416
"2019-01-02T00:00:00 ",
1417
"2019-01-03T00:00:00 ",
1429
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1431
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1435
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1436
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1438
"Check Is Running ",
1443
"2019-01-03T00:00:00 ",
1444
"2019-01-04T00:00:00 ",
1446
"Approval Is Pending ",
1450
"Approved By Default ",
1454
"Last Approval Request ",
1456
"2019-01-03T00:00:00 ",
1462
"Approval Duration ",
1467
"fping -q -- %(host)s ",
1470
"Extended Timeout ",
1475
"2019-02-04T00:00:00 ",
1476
"2019-02-05T00:00:00 ",
1478
"Last Checker Status",
1483
num_lines = max(len(rows) for rows in columns)
1484
expected_output = "\n".join("".join(rows[line]
1485
for rows in columns)
1486
for line in range(num_lines))
1487
self.assertEqual(output, expected_output)
1488
def test_one_client(self):
1489
output = PrintTableCmd().output(self.one_client.values())
1490
expected_output = "\n".join((
1491
"Name Enabled Timeout Last Successful Check",
1492
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1494
self.assertEqual(output, expected_output)
1497
class Unique(object):
1498
"""Class for objects which exist only to be unique objects, since
1499
unittest.mock.sentinel only exists in Python 3.3"""
1502
class TestPropertyCmd(TestCmd):
1503
"""Abstract class for tests of PropertyCmd classes"""
1505
if not hasattr(self, "command"):
1507
values_to_get = getattr(self, "values_to_get",
1509
for value_to_set, value_to_get in zip(self.values_to_set,
1511
for clientpath in self.clients:
1512
client = self.bus.get_object(dbus_busname, clientpath)
1513
old_value = client.attributes[self.propname]
1514
self.assertNotIsInstance(old_value, Unique)
1515
client.attributes[self.propname] = Unique()
1516
self.run_command(value_to_set, self.clients)
1517
for clientpath in self.clients:
1518
client = self.bus.get_object(dbus_busname, clientpath)
1519
value = client.attributes[self.propname]
1520
self.assertNotIsInstance(value, Unique)
1521
self.assertEqual(value, value_to_get)
1522
def run_command(self, value, clients):
1523
self.command().run(clients, self.bus)
1526
class TestEnableCmd(TestPropertyCmd):
1528
propname = "Enabled"
1529
values_to_set = [dbus.Boolean(True)]
1532
class TestDisableCmd(TestPropertyCmd):
1533
command = DisableCmd
1534
propname = "Enabled"
1535
values_to_set = [dbus.Boolean(False)]
1538
class TestBumpTimeoutCmd(TestPropertyCmd):
1539
command = BumpTimeoutCmd
1540
propname = "LastCheckedOK"
1541
values_to_set = [""]
1544
class TestStartCheckerCmd(TestPropertyCmd):
1545
command = StartCheckerCmd
1546
propname = "CheckerRunning"
1547
values_to_set = [dbus.Boolean(True)]
1550
class TestStopCheckerCmd(TestPropertyCmd):
1551
command = StopCheckerCmd
1552
propname = "CheckerRunning"
1553
values_to_set = [dbus.Boolean(False)]
1556
class TestApproveByDefaultCmd(TestPropertyCmd):
1557
command = ApproveByDefaultCmd
1558
propname = "ApprovedByDefault"
1559
values_to_set = [dbus.Boolean(True)]
1562
class TestDenyByDefaultCmd(TestPropertyCmd):
1563
command = DenyByDefaultCmd
1564
propname = "ApprovedByDefault"
1565
values_to_set = [dbus.Boolean(False)]
1568
class TestPropertyValueCmd(TestPropertyCmd):
1569
"""Abstract class for tests of PropertyValueCmd classes"""
1571
if type(self) is TestPropertyValueCmd:
1573
return super(TestPropertyValueCmd, self).runTest()
1574
def run_command(self, value, clients):
1575
self.command(value).run(clients, self.bus)
1578
class TestSetCheckerCmd(TestPropertyValueCmd):
1579
command = SetCheckerCmd
1580
propname = "Checker"
1581
values_to_set = ["", ":", "fping -q -- %s"]
1584
class TestSetHostCmd(TestPropertyValueCmd):
1585
command = SetHostCmd
1587
values_to_set = ["192.0.2.3", "foo.example.org"]
1590
class TestSetSecretCmd(TestPropertyValueCmd):
1591
command = SetSecretCmd
1593
values_to_set = [io.BytesIO(b""),
1594
io.BytesIO(b"secret\0xyzzy\nbar")]
1595
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1598
class TestSetTimeoutCmd(TestPropertyValueCmd):
1599
command = SetTimeoutCmd
1600
propname = "Timeout"
1601
values_to_set = [datetime.timedelta(),
1602
datetime.timedelta(minutes=5),
1603
datetime.timedelta(seconds=1),
1604
datetime.timedelta(weeks=1),
1605
datetime.timedelta(weeks=52)]
1606
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1609
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1610
command = SetExtendedTimeoutCmd
1611
propname = "ExtendedTimeout"
1612
values_to_set = [datetime.timedelta(),
1613
datetime.timedelta(minutes=5),
1614
datetime.timedelta(seconds=1),
1615
datetime.timedelta(weeks=1),
1616
datetime.timedelta(weeks=52)]
1617
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1620
class TestSetIntervalCmd(TestPropertyValueCmd):
1621
command = SetIntervalCmd
1622
propname = "Interval"
1623
values_to_set = [datetime.timedelta(),
1624
datetime.timedelta(minutes=5),
1625
datetime.timedelta(seconds=1),
1626
datetime.timedelta(weeks=1),
1627
datetime.timedelta(weeks=52)]
1628
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1631
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1632
command = SetApprovalDelayCmd
1633
propname = "ApprovalDelay"
1634
values_to_set = [datetime.timedelta(),
1635
datetime.timedelta(minutes=5),
1636
datetime.timedelta(seconds=1),
1637
datetime.timedelta(weeks=1),
1638
datetime.timedelta(weeks=52)]
1639
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1642
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1643
command = SetApprovalDurationCmd
1644
propname = "ApprovalDuration"
1645
values_to_set = [datetime.timedelta(),
1646
datetime.timedelta(minutes=5),
1647
datetime.timedelta(seconds=1),
1648
datetime.timedelta(weeks=1),
1649
datetime.timedelta(weeks=52)]
1650
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1654
def should_only_run_tests():
1655
parser = argparse.ArgumentParser(add_help=False)
1656
parser.add_argument("--check", action='store_true')
1657
args, unknown_args = parser.parse_known_args()
1658
run_tests = args.check
1660
# Remove --check argument from sys.argv
1661
sys.argv[1:] = unknown_args
1664
# Add all tests from doctest strings
1665
def load_tests(loader, tests, none):
1667
tests.addTests(doctest.DocTestSuite())
1670
if __name__ == "__main__":
1671
if should_only_run_tests():
1672
# Call using ./tdd-python-script --check [--verbose]