2
# -*- mode: python; coding: utf-8 -*-
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
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2008-2015 Teddy Hogeborn
7
# Copyright © 2008-2015 Björn Påhlsson
9
# This program is free software: you can redistribute it and/or modify
10
# it under the terms of the GNU General Public License as published by
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
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
19
# GNU General Public License for more details.
19
21
# You should have received a copy of the GNU General Public License
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
23
24
# Contact the authors at <mandos@recompile.se>.
26
27
from __future__ import (division, absolute_import, print_function,
64
72
"ApprovalDelay": "Approval Delay",
65
73
"ApprovalDuration": "Approval Duration",
66
74
"Checker": "Checker",
67
"ExtendedTimeout": "Extended Timeout"
75
"ExtendedTimeout": "Extended Timeout",
77
"LastCheckerStatus": "Last Checker Status",
69
79
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
80
domain = "se.recompile"
73
83
server_interface = domain + ".Mandos"
74
84
client_interface = domain + ".Mandos.Client"
89
dbus.OBJECT_MANAGER_IFACE
90
except AttributeError:
91
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
78
94
def milliseconds_to_string(ms):
79
95
td = datetime.timedelta(0, 0, 0, ms)
80
return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
81
days = "{}T".format(td.days) if td.days else "",
82
hours = td.seconds // 3600,
83
minutes = (td.seconds % 3600) // 60,
84
seconds = td.seconds % 60))
96
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
97
.format(days="{}T".format(td.days) if td.days else "",
98
hours=td.seconds // 3600,
99
minutes=(td.seconds % 3600) // 60,
100
seconds=td.seconds % 60))
87
103
def rfc3339_duration_to_delta(duration):
88
104
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
90
106
>>> rfc3339_duration_to_delta("P7D")
91
107
datetime.timedelta(7)
92
108
>>> rfc3339_duration_to_delta("PT60S")
102
118
>>> rfc3339_duration_to_delta("P1DT3M20S")
103
119
datetime.timedelta(1, 200)
106
122
# Parsing an RFC 3339 duration with regular expressions is not
107
123
# possible - there would have to be multiple places for the same
108
124
# values, like seconds. The current code, while more esoteric, is
109
125
# cleaner without depending on a parsing library. If Python had a
110
126
# built-in library for parsing we would use it, but we'd like to
111
127
# avoid excessive use of external libraries.
113
129
# New type for defining tokens, syntax, and semantics all-in-one
114
130
Token = collections.namedtuple("Token", (
115
131
"regexp", # To match token; if "value" is not None, must have
148
164
frozenset((token_year, token_month,
149
165
token_day, token_time,
151
# Define starting values
152
value = datetime.timedelta() # Value so far
167
# Define starting values:
169
value = datetime.timedelta()
153
170
found_token = None
154
followers = frozenset((token_duration, )) # Following valid tokens
155
s = duration # String left to parse
171
# Following valid tokens
172
followers = frozenset((token_duration, ))
173
# String left to parse
156
175
# Loop until end token is found
157
176
while found_token is not token_end:
158
177
# Search for any currently valid tokens
196
215
>>> string_to_delta('5m 30s')
197
216
datetime.timedelta(0, 330)
201
220
return rfc3339_duration_to_delta(interval)
202
221
except ValueError:
205
224
value = datetime.timedelta(0)
206
225
regexp = re.compile(r"(\d+)([dsmhw]?)")
208
227
for num, suffix in regexp.findall(interval):
209
228
if suffix == "d":
210
229
value += datetime.timedelta(int(num))
229
248
"ApprovalDuration", "ExtendedTimeout"):
230
249
return milliseconds_to_string(value)
231
250
return str(value)
233
252
# Create format string to print table rows
234
253
format_string = " ".join("{{{key}:{width}}}".format(
235
width = max(len(tablewords[key]),
236
max(len(valuetostring(client[key], key))
237
for client in clients)),
254
width=max(len(tablewords[key]),
255
max(len(valuetostring(client[key], key))
256
for client in clients)),
239
258
for key in keywords)
240
259
# Print header line
241
260
print(format_string.format(**tablewords))
242
261
for client in clients:
243
print(format_string.format(**{
244
key: valuetostring(client[key], key)
245
for key in keywords }))
263
.format(**{key: valuetostring(client[key], key)
264
for key in keywords}))
248
267
def has_actions(options):
270
289
parser = argparse.ArgumentParser()
271
290
parser.add_argument("--version", action="version",
272
version = "%(prog)s {}".format(version),
291
version="%(prog)s {}".format(version),
273
292
help="show version number and exit")
274
293
parser.add_argument("-a", "--all", action="store_true",
275
294
help="Select all clients")
276
295
parser.add_argument("-v", "--verbose", action="store_true",
277
296
help="Print all fields")
297
parser.add_argument("-j", "--dump-json", action="store_true",
298
help="Dump client data in JSON format")
278
299
parser.add_argument("-e", "--enable", action="store_true",
279
300
help="Enable client")
280
301
parser.add_argument("-d", "--disable", action="store_true",
319
340
help="Run self-test")
320
341
parser.add_argument("client", nargs="*", help="Client name")
321
342
options = parser.parse_args()
323
344
if has_actions(options) and not (options.client or options.all):
324
345
parser.error("Options require clients names or --all.")
325
346
if options.verbose and has_actions(options):
326
parser.error("--verbose can only be used alone or with"
347
parser.error("--verbose can only be used alone.")
348
if options.dump_json and (options.verbose
349
or has_actions(options)):
350
parser.error("--dump-json can only be used alone.")
328
351
if options.all and not has_actions(options):
329
352
parser.error("--all requires an action.")
332
fail_count, test_count = doctest.testmod()
333
sys.exit(os.EX_OK if fail_count == 0 else 1)
336
355
bus = dbus.SystemBus()
337
356
mandos_dbus_objc = bus.get_object(busname, server_path)
338
357
except dbus.exceptions.DBusException:
339
print("Could not connect to Mandos server", file=sys.stderr)
358
log.critical("Could not connect to Mandos server")
342
361
mandos_serv = dbus.Interface(mandos_dbus_objc,
343
dbus_interface = server_interface)
345
#block stderr since dbus library prints to stderr
362
dbus_interface=server_interface)
363
mandos_serv_object_manager = dbus.Interface(
364
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
366
# block stderr since dbus library prints to stderr
346
367
null = os.open(os.path.devnull, os.O_RDWR)
347
368
stderrcopy = os.dup(sys.stderr.fileno())
348
369
os.dup2(null, sys.stderr.fileno())
352
mandos_clients = mandos_serv.GetAllClientsWithProperties()
373
mandos_clients = {path: ifs_and_props[client_interface]
374
for path, ifs_and_props in
375
mandos_serv_object_manager
376
.GetManagedObjects().items()
377
if client_interface in ifs_and_props}
355
380
os.dup2(stderrcopy, sys.stderr.fileno())
356
381
os.close(stderrcopy)
357
except dbus.exceptions.DBusException:
358
print("Access denied: Accessing mandos server through dbus.",
382
except dbus.exceptions.DBusException as e:
383
log.critical("Failed to access Mandos server through D-Bus:"
362
387
# Compile dict of (clients: properties) to process
365
390
if options.all or not options.client:
366
clients = { bus.get_object(busname, path): properties
367
for path, properties in mandos_clients.items() }
391
clients = {bus.get_object(busname, path): properties
392
for path, properties in mandos_clients.items()}
369
394
for name in options.client:
370
395
for path, client in mandos_clients.items():
373
398
clients[client_objc] = client
376
print("Client not found on server: {!r}"
377
.format(name), file=sys.stderr)
401
log.critical("Client not found on server: %r", name)
380
404
if not has_actions(options) and clients:
405
if options.verbose or options.dump_json:
382
406
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
383
"Created", "Interval", "Host", "Fingerprint",
384
"CheckerRunning", "LastEnabled",
385
"ApprovalPending", "ApprovedByDefault",
386
"LastApprovalRequest", "ApprovalDelay",
387
"ApprovalDuration", "Checker",
407
"Created", "Interval", "Host", "KeyID",
408
"Fingerprint", "CheckerRunning",
409
"LastEnabled", "ApprovalPending",
410
"ApprovedByDefault", "LastApprovalRequest",
411
"ApprovalDelay", "ApprovalDuration",
412
"Checker", "ExtendedTimeout", "Expires",
390
415
keywords = defaultkeywords
392
print_clients(clients.values(), keywords)
417
if options.dump_json:
418
json.dump({client["Name"]: {key:
420
if isinstance(client[key],
424
for client in clients.values()},
425
fp=sys.stdout, indent=4,
426
separators=(',', ': '))
429
print_clients(clients.values(), keywords)
394
431
# Process each client in the list by all selected options
395
432
for client in clients:
397
434
def set_client_prop(prop, value):
398
435
"""Set a Client D-Bus property"""
399
436
client.Set(client_interface, prop, value,
400
437
dbus_interface=dbus.PROPERTIES_IFACE)
402
439
def set_client_prop_ms(prop, value):
403
440
"""Set a Client D-Bus property, converted
404
441
from a string to milliseconds."""
405
442
set_client_prop(prop,
406
443
string_to_delta(value).total_seconds()
409
446
if options.remove:
410
447
mandos_serv.RemoveClient(client.__dbus_object_path__)
411
448
if options.enable:
419
456
if options.stop_checker:
420
457
set_client_prop("CheckerRunning", dbus.Boolean(False))
421
458
if options.is_enabled:
422
sys.exit(0 if client.Get(client_interface,
425
dbus.PROPERTIES_IFACE)
459
if client.Get(client_interface, "Enabled",
460
dbus_interface=dbus.PROPERTIES_IFACE):
427
464
if options.checker is not None:
428
465
set_client_prop("Checker", options.checker)
429
466
if options.host is not None:
455
492
client.Approve(dbus.Boolean(False),
456
493
dbus_interface=client_interface)
496
class Test_milliseconds_to_string(unittest.TestCase):
498
self.assertEqual(milliseconds_to_string(93785000),
500
def test_no_days(self):
501
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
502
def test_all_zero(self):
503
self.assertEqual(milliseconds_to_string(0), "00:00:00")
504
def test_no_fractional_seconds(self):
505
self.assertEqual(milliseconds_to_string(400), "00:00:00")
506
self.assertEqual(milliseconds_to_string(900), "00:00:00")
507
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
510
def should_only_run_tests():
511
parser = argparse.ArgumentParser(add_help=False)
512
parser.add_argument("--check", action='store_true')
513
args, unknown_args = parser.parse_known_args()
514
run_tests = args.check
516
# Remove --check argument from sys.argv
517
sys.argv[1:] = unknown_args
520
# Add all tests from doctest strings
521
def load_tests(loader, tests, none):
523
tests.addTests(doctest.DocTestSuite())
459
526
if __name__ == "__main__":
527
if should_only_run_tests():
528
# Call using ./tdd-python-script --check [--verbose]