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