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-2016 Teddy Hogeborn
7
# Copyright © 2008-2016 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,
65
79
"ApprovalDelay": "Approval Delay",
66
80
"ApprovalDuration": "Approval Duration",
67
81
"Checker": "Checker",
68
"ExtendedTimeout": "Extended Timeout"
82
"ExtendedTimeout": "Extended Timeout",
84
"LastCheckerStatus": "Last Checker Status",
70
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
71
87
domain = "se.recompile"
81
97
except AttributeError:
82
98
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
84
101
def milliseconds_to_string(ms):
85
102
td = datetime.timedelta(0, 0, 0, ms)
86
return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
87
days = "{}T".format(td.days) if td.days else "",
88
hours = td.seconds // 3600,
89
minutes = (td.seconds % 3600) // 60,
90
seconds = td.seconds % 60))
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))
93
110
def rfc3339_duration_to_delta(duration):
94
111
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
96
113
>>> rfc3339_duration_to_delta("P7D")
97
114
datetime.timedelta(7)
98
115
>>> rfc3339_duration_to_delta("PT60S")
99
116
datetime.timedelta(0, 60)
100
117
>>> rfc3339_duration_to_delta("PT60M")
101
118
datetime.timedelta(0, 3600)
119
>>> rfc3339_duration_to_delta("P60M")
120
datetime.timedelta(1680)
102
121
>>> rfc3339_duration_to_delta("PT24H")
103
122
datetime.timedelta(1)
104
123
>>> rfc3339_duration_to_delta("P1W")
107
126
datetime.timedelta(0, 330)
108
127
>>> rfc3339_duration_to_delta("P1DT3M20S")
109
128
datetime.timedelta(1, 200)
129
>>> # Can not be empty:
130
>>> rfc3339_duration_to_delta("")
131
Traceback (most recent call last):
133
ValueError: Invalid RFC 3339 duration: u''
134
>>> # Must start with "P":
135
>>> rfc3339_duration_to_delta("1D")
136
Traceback (most recent call last):
138
ValueError: Invalid RFC 3339 duration: u'1D'
139
>>> # Must use correct order
140
>>> rfc3339_duration_to_delta("PT1S2M")
141
Traceback (most recent call last):
143
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
144
>>> # Time needs time marker
145
>>> rfc3339_duration_to_delta("P1H2S")
146
Traceback (most recent call last):
148
ValueError: Invalid RFC 3339 duration: u'P1H2S'
149
>>> # Weeks can not be combined with anything else
150
>>> rfc3339_duration_to_delta("P1D2W")
151
Traceback (most recent call last):
153
ValueError: Invalid RFC 3339 duration: u'P1D2W'
154
>>> rfc3339_duration_to_delta("P2W2H")
155
Traceback (most recent call last):
157
ValueError: Invalid RFC 3339 duration: u'P2W2H'
112
160
# Parsing an RFC 3339 duration with regular expressions is not
113
161
# possible - there would have to be multiple places for the same
114
162
# values, like seconds. The current code, while more esoteric, is
115
163
# cleaner without depending on a parsing library. If Python had a
116
164
# built-in library for parsing we would use it, but we'd like to
117
165
# avoid excessive use of external libraries.
119
167
# New type for defining tokens, syntax, and semantics all-in-one
120
168
Token = collections.namedtuple("Token", (
121
169
"regexp", # To match token; if "value" is not None, must have
154
202
frozenset((token_year, token_month,
155
203
token_day, token_time,
157
# Define starting values
158
value = datetime.timedelta() # Value so far
205
# Define starting values:
207
value = datetime.timedelta()
159
208
found_token = None
160
followers = frozenset((token_duration, )) # Following valid tokens
161
s = duration # String left to parse
209
# Following valid tokens
210
followers = frozenset((token_duration, ))
211
# String left to parse
162
213
# Loop until end token is found
163
214
while found_token is not token_end:
164
215
# Search for any currently valid tokens
189
240
def string_to_delta(interval):
190
241
"""Parse a string and return a datetime.timedelta
192
>>> string_to_delta('7d')
193
datetime.timedelta(7)
194
>>> string_to_delta('60s')
195
datetime.timedelta(0, 60)
196
>>> string_to_delta('60m')
197
datetime.timedelta(0, 3600)
198
>>> string_to_delta('24h')
199
datetime.timedelta(1)
200
>>> string_to_delta('1w')
201
datetime.timedelta(7)
202
>>> string_to_delta('5m 30s')
203
datetime.timedelta(0, 330)
207
245
return rfc3339_duration_to_delta(interval)
246
except ValueError as e:
247
log.warning("%s - Parsing as pre-1.6.1 interval instead",
249
return parse_pre_1_6_1_interval(interval)
252
def parse_pre_1_6_1_interval(interval):
253
"""Parse an interval string as documented by Mandos before 1.6.1, and
254
return a datetime.timedelta
255
>>> parse_pre_1_6_1_interval('7d')
256
datetime.timedelta(7)
257
>>> parse_pre_1_6_1_interval('60s')
258
datetime.timedelta(0, 60)
259
>>> parse_pre_1_6_1_interval('60m')
260
datetime.timedelta(0, 3600)
261
>>> parse_pre_1_6_1_interval('24h')
262
datetime.timedelta(1)
263
>>> parse_pre_1_6_1_interval('1w')
264
datetime.timedelta(7)
265
>>> parse_pre_1_6_1_interval('5m 30s')
266
datetime.timedelta(0, 330)
267
>>> parse_pre_1_6_1_interval('')
268
datetime.timedelta(0)
269
>>> # Ignore unknown characters, allow any order and repetitions
270
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
271
datetime.timedelta(2, 480, 18000)
211
275
value = datetime.timedelta(0)
212
276
regexp = re.compile(r"(\d+)([dsmhw]?)")
214
278
for num, suffix in regexp.findall(interval):
215
279
if suffix == "d":
216
280
value += datetime.timedelta(int(num))
230
294
def print_clients(clients, keywords):
231
295
def valuetostring(value, keyword):
232
if type(value) is dbus.Boolean:
296
if isinstance(value, dbus.Boolean):
233
297
return "Yes" if value else "No"
234
298
if keyword in ("Timeout", "Interval", "ApprovalDelay",
235
299
"ApprovalDuration", "ExtendedTimeout"):
236
300
return milliseconds_to_string(value)
237
301
return str(value)
239
303
# Create format string to print table rows
240
304
format_string = " ".join("{{{key}:{width}}}".format(
241
width = max(len(tablewords[key]),
242
max(len(valuetostring(client[key], key))
243
for client in clients)),
305
width=max(len(tablewords[key]),
306
max(len(valuetostring(client[key], key))
307
for client in clients)),
245
309
for key in keywords)
246
310
# Print header line
247
311
print(format_string.format(**tablewords))
248
312
for client in clients:
249
print(format_string.format(**{
250
key: valuetostring(client[key], key)
251
for key in keywords }))
314
.format(**{key: valuetostring(client[key], key)
315
for key in keywords}))
254
318
def has_actions(options):
276
340
parser = argparse.ArgumentParser()
277
341
parser.add_argument("--version", action="version",
278
version = "%(prog)s {}".format(version),
342
version="%(prog)s {}".format(version),
279
343
help="show version number and exit")
280
344
parser.add_argument("-a", "--all", action="store_true",
281
345
help="Select all clients")
327
391
help="Run self-test")
328
392
parser.add_argument("client", nargs="*", help="Client name")
329
393
options = parser.parse_args()
331
395
if has_actions(options) and not (options.client or options.all):
332
396
parser.error("Options require clients names or --all.")
333
397
if options.verbose and has_actions(options):
334
398
parser.error("--verbose can only be used alone.")
335
if options.dump_json and (options.verbose or has_actions(options)):
399
if options.dump_json and (options.verbose
400
or has_actions(options)):
336
401
parser.error("--dump-json can only be used alone.")
337
402
if options.all and not has_actions(options):
338
403
parser.error("--all requires an action.")
341
fail_count, test_count = doctest.testmod()
342
sys.exit(os.EX_OK if fail_count == 0 else 1)
345
406
bus = dbus.SystemBus()
346
407
mandos_dbus_objc = bus.get_object(busname, server_path)
347
408
except dbus.exceptions.DBusException:
348
print("Could not connect to Mandos server", file=sys.stderr)
409
log.critical("Could not connect to Mandos server")
351
412
mandos_serv = dbus.Interface(mandos_dbus_objc,
352
dbus_interface = server_interface)
413
dbus_interface=server_interface)
353
414
mandos_serv_object_manager = dbus.Interface(
354
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
356
#block stderr since dbus library prints to stderr
415
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
417
# block stderr since dbus library prints to stderr
357
418
null = os.open(os.path.devnull, os.O_RDWR)
358
419
stderrcopy = os.dup(sys.stderr.fileno())
359
420
os.dup2(null, sys.stderr.fileno())
363
mandos_clients = { path: ifs_and_props[client_interface]
364
for path, ifs_and_props in
365
mandos_serv_object_manager
366
.GetManagedObjects().items()
367
if client_interface in ifs_and_props }
424
mandos_clients = {path: ifs_and_props[client_interface]
425
for path, ifs_and_props in
426
mandos_serv_object_manager
427
.GetManagedObjects().items()
428
if client_interface in ifs_and_props}
370
431
os.dup2(stderrcopy, sys.stderr.fileno())
371
432
os.close(stderrcopy)
372
433
except dbus.exceptions.DBusException as e:
373
print("Access denied: Accessing mandos server through D-Bus: {}"
374
.format(e), file=sys.stderr)
434
log.critical("Failed to access Mandos server through D-Bus:"
377
438
# Compile dict of (clients: properties) to process
380
441
if options.all or not options.client:
381
clients = { bus.get_object(busname, path): properties
382
for path, properties in mandos_clients.items() }
442
clients = {bus.get_object(busname, path): properties
443
for path, properties in mandos_clients.items()}
384
445
for name in options.client:
385
446
for path, client in mandos_clients.items():
388
449
clients[client_objc] = client
391
print("Client not found on server: {!r}"
392
.format(name), file=sys.stderr)
452
log.critical("Client not found on server: %r", name)
395
455
if not has_actions(options) and clients:
396
456
if options.verbose or options.dump_json:
397
457
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
398
"Created", "Interval", "Host", "Fingerprint",
399
"CheckerRunning", "LastEnabled",
400
"ApprovalPending", "ApprovedByDefault",
401
"LastApprovalRequest", "ApprovalDelay",
402
"ApprovalDuration", "Checker",
458
"Created", "Interval", "Host", "KeyID",
459
"Fingerprint", "CheckerRunning",
460
"LastEnabled", "ApprovalPending",
461
"ApprovedByDefault", "LastApprovalRequest",
462
"ApprovalDelay", "ApprovalDuration",
463
"Checker", "ExtendedTimeout", "Expires",
405
466
keywords = defaultkeywords
407
468
if options.dump_json:
408
json.dump({client["Name"]: {key: client[key]
409
for key in keywords }
410
for client in clients.values() },
411
fp = sys.stdout, indent = 4,
412
separators = (',', ': '))
469
json.dump({client["Name"]: {key:
471
if isinstance(client[key],
475
for client in clients.values()},
476
fp=sys.stdout, indent=4,
477
separators=(',', ': '))
415
480
print_clients(clients.values(), keywords)
417
482
# Process each client in the list by all selected options
418
483
for client in clients:
420
485
def set_client_prop(prop, value):
421
486
"""Set a Client D-Bus property"""
422
487
client.Set(client_interface, prop, value,
423
488
dbus_interface=dbus.PROPERTIES_IFACE)
425
490
def set_client_prop_ms(prop, value):
426
491
"""Set a Client D-Bus property, converted
427
492
from a string to milliseconds."""
428
493
set_client_prop(prop,
429
494
string_to_delta(value).total_seconds()
432
497
if options.remove:
433
498
mandos_serv.RemoveClient(client.__dbus_object_path__)
434
499
if options.enable:
442
507
if options.stop_checker:
443
508
set_client_prop("CheckerRunning", dbus.Boolean(False))
444
509
if options.is_enabled:
445
sys.exit(0 if client.Get(client_interface,
448
dbus.PROPERTIES_IFACE)
510
if client.Get(client_interface, "Enabled",
511
dbus_interface=dbus.PROPERTIES_IFACE):
450
515
if options.checker is not None:
451
516
set_client_prop("Checker", options.checker)
452
517
if options.host is not None:
478
543
client.Approve(dbus.Boolean(False),
479
544
dbus_interface=client_interface)
547
class Test_milliseconds_to_string(unittest.TestCase):
549
self.assertEqual(milliseconds_to_string(93785000),
551
def test_no_days(self):
552
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
553
def test_all_zero(self):
554
self.assertEqual(milliseconds_to_string(0), "00:00:00")
555
def test_no_fractional_seconds(self):
556
self.assertEqual(milliseconds_to_string(400), "00:00:00")
557
self.assertEqual(milliseconds_to_string(900), "00:00:00")
558
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
561
def should_only_run_tests():
562
parser = argparse.ArgumentParser(add_help=False)
563
parser.add_argument("--check", action='store_true')
564
args, unknown_args = parser.parse_known_args()
565
run_tests = args.check
567
# Remove --check argument from sys.argv
568
sys.argv[1:] = unknown_args
571
# Add all tests from doctest strings
572
def load_tests(loader, tests, none):
574
tests.addTests(doctest.DocTestSuite())
482
577
if __name__ == "__main__":
578
if should_only_run_tests():
579
# Call using ./tdd-python-script --check [--verbose]