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-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
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,
97
83
except AttributeError:
98
84
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
101
86
def milliseconds_to_string(ms):
102
87
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))
88
return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
89
days = "{}T".format(td.days) if td.days else "",
90
hours = td.seconds // 3600,
91
minutes = (td.seconds % 3600) // 60,
92
seconds = td.seconds % 60))
110
95
def rfc3339_duration_to_delta(duration):
111
96
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
113
98
>>> rfc3339_duration_to_delta("P7D")
114
99
datetime.timedelta(7)
115
100
>>> rfc3339_duration_to_delta("PT60S")
116
101
datetime.timedelta(0, 60)
117
102
>>> rfc3339_duration_to_delta("PT60M")
118
103
datetime.timedelta(0, 3600)
119
>>> rfc3339_duration_to_delta("P60M")
120
datetime.timedelta(1680)
121
104
>>> rfc3339_duration_to_delta("PT24H")
122
105
datetime.timedelta(1)
123
106
>>> rfc3339_duration_to_delta("P1W")
126
109
datetime.timedelta(0, 330)
127
110
>>> rfc3339_duration_to_delta("P1DT3M20S")
128
111
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'
160
114
# Parsing an RFC 3339 duration with regular expressions is not
161
115
# possible - there would have to be multiple places for the same
162
116
# values, like seconds. The current code, while more esoteric, is
163
117
# cleaner without depending on a parsing library. If Python had a
164
118
# built-in library for parsing we would use it, but we'd like to
165
119
# avoid excessive use of external libraries.
167
121
# New type for defining tokens, syntax, and semantics all-in-one
168
122
Token = collections.namedtuple("Token", (
169
123
"regexp", # To match token; if "value" is not None, must have
202
156
frozenset((token_year, token_month,
203
157
token_day, token_time,
205
# Define starting values:
207
value = datetime.timedelta()
159
# Define starting values
160
value = datetime.timedelta() # Value so far
208
161
found_token = None
209
# Following valid tokens
210
followers = frozenset((token_duration, ))
211
# String left to parse
162
followers = frozenset((token_duration, )) # Following valid tokens
163
s = duration # String left to parse
213
164
# Loop until end token is found
214
165
while found_token is not token_end:
215
166
# Search for any currently valid tokens
240
191
def string_to_delta(interval):
241
192
"""Parse a string and return a datetime.timedelta
194
>>> string_to_delta('7d')
195
datetime.timedelta(7)
196
>>> string_to_delta('60s')
197
datetime.timedelta(0, 60)
198
>>> string_to_delta('60m')
199
datetime.timedelta(0, 3600)
200
>>> string_to_delta('24h')
201
datetime.timedelta(1)
202
>>> string_to_delta('1w')
203
datetime.timedelta(7)
204
>>> string_to_delta('5m 30s')
205
datetime.timedelta(0, 330)
245
209
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)
275
213
value = datetime.timedelta(0)
276
214
regexp = re.compile(r"(\d+)([dsmhw]?)")
278
216
for num, suffix in regexp.findall(interval):
279
217
if suffix == "d":
280
218
value += datetime.timedelta(int(num))
294
232
def print_clients(clients, keywords):
295
233
def valuetostring(value, keyword):
296
if isinstance(value, dbus.Boolean):
234
if type(value) is dbus.Boolean:
297
235
return "Yes" if value else "No"
298
236
if keyword in ("Timeout", "Interval", "ApprovalDelay",
299
237
"ApprovalDuration", "ExtendedTimeout"):
300
238
return milliseconds_to_string(value)
301
239
return str(value)
303
241
# Create format string to print table rows
304
242
format_string = " ".join("{{{key}:{width}}}".format(
305
width=max(len(tablewords[key]),
306
max(len(valuetostring(client[key], key))
307
for client in clients)),
243
width = max(len(tablewords[key]),
244
max(len(valuetostring(client[key], key))
245
for client in clients)),
309
247
for key in keywords)
310
248
# Print header line
311
249
print(format_string.format(**tablewords))
312
250
for client in clients:
314
.format(**{key: valuetostring(client[key], key)
315
for key in keywords}))
251
print(format_string.format(**{
252
key: valuetostring(client[key], key)
253
for key in keywords }))
318
256
def has_actions(options):
340
278
parser = argparse.ArgumentParser()
341
279
parser.add_argument("--version", action="version",
342
version="%(prog)s {}".format(version),
280
version = "%(prog)s {}".format(version),
343
281
help="show version number and exit")
344
282
parser.add_argument("-a", "--all", action="store_true",
345
283
help="Select all clients")
391
329
help="Run self-test")
392
330
parser.add_argument("client", nargs="*", help="Client name")
393
331
options = parser.parse_args()
395
333
if has_actions(options) and not (options.client or options.all):
396
334
parser.error("Options require clients names or --all.")
397
335
if options.verbose and has_actions(options):
398
336
parser.error("--verbose can only be used alone.")
399
if options.dump_json and (options.verbose
400
or has_actions(options)):
337
if options.dump_json and (options.verbose or has_actions(options)):
401
338
parser.error("--dump-json can only be used alone.")
402
339
if options.all and not has_actions(options):
403
340
parser.error("--all requires an action.")
343
fail_count, test_count = doctest.testmod()
344
sys.exit(os.EX_OK if fail_count == 0 else 1)
406
347
bus = dbus.SystemBus()
407
348
mandos_dbus_objc = bus.get_object(busname, server_path)
408
349
except dbus.exceptions.DBusException:
409
log.critical("Could not connect to Mandos server")
350
print("Could not connect to Mandos server", file=sys.stderr)
412
353
mandos_serv = dbus.Interface(mandos_dbus_objc,
413
dbus_interface=server_interface)
354
dbus_interface = server_interface)
414
355
mandos_serv_object_manager = dbus.Interface(
415
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
417
# block stderr since dbus library prints to stderr
356
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
358
#block stderr since dbus library prints to stderr
418
359
null = os.open(os.path.devnull, os.O_RDWR)
419
360
stderrcopy = os.dup(sys.stderr.fileno())
420
361
os.dup2(null, sys.stderr.fileno())
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}
365
mandos_clients = { path: ifs_and_props[client_interface]
366
for path, ifs_and_props in
367
mandos_serv_object_manager
368
.GetManagedObjects().items()
369
if client_interface in ifs_and_props }
431
372
os.dup2(stderrcopy, sys.stderr.fileno())
432
373
os.close(stderrcopy)
433
374
except dbus.exceptions.DBusException as e:
434
log.critical("Failed to access Mandos server through D-Bus:"
375
print("Access denied: Accessing mandos server through D-Bus: {}"
376
.format(e), file=sys.stderr)
438
379
# Compile dict of (clients: properties) to process
441
382
if options.all or not options.client:
442
clients = {bus.get_object(busname, path): properties
443
for path, properties in mandos_clients.items()}
383
clients = { bus.get_object(busname, path): properties
384
for path, properties in mandos_clients.items() }
445
386
for name in options.client:
446
387
for path, client in mandos_clients.items():
449
390
clients[client_objc] = client
452
log.critical("Client not found on server: %r", name)
393
print("Client not found on server: {!r}"
394
.format(name), file=sys.stderr)
455
397
if not has_actions(options) and clients:
456
398
if options.verbose or options.dump_json:
457
399
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
458
"Created", "Interval", "Host", "KeyID",
459
"Fingerprint", "CheckerRunning",
460
"LastEnabled", "ApprovalPending",
461
"ApprovedByDefault", "LastApprovalRequest",
462
"ApprovalDelay", "ApprovalDuration",
463
"Checker", "ExtendedTimeout", "Expires",
400
"Created", "Interval", "Host", "Fingerprint",
401
"CheckerRunning", "LastEnabled",
402
"ApprovalPending", "ApprovedByDefault",
403
"LastApprovalRequest", "ApprovalDelay",
404
"ApprovalDuration", "Checker",
405
"ExtendedTimeout", "Expires",
464
406
"LastCheckerStatus")
466
408
keywords = defaultkeywords
468
410
if options.dump_json:
469
411
json.dump({client["Name"]: {key:
470
412
bool(client[key])
471
413
if isinstance(client[key],
475
for client in clients.values()},
476
fp=sys.stdout, indent=4,
477
separators=(',', ': '))
416
for key in keywords }
417
for client in clients.values() },
418
fp = sys.stdout, indent = 4,
419
separators = (',', ': '))
480
422
print_clients(clients.values(), keywords)
482
424
# Process each client in the list by all selected options
483
425
for client in clients:
485
427
def set_client_prop(prop, value):
486
428
"""Set a Client D-Bus property"""
487
429
client.Set(client_interface, prop, value,
488
430
dbus_interface=dbus.PROPERTIES_IFACE)
490
432
def set_client_prop_ms(prop, value):
491
433
"""Set a Client D-Bus property, converted
492
434
from a string to milliseconds."""
493
435
set_client_prop(prop,
494
436
string_to_delta(value).total_seconds()
497
439
if options.remove:
498
440
mandos_serv.RemoveClient(client.__dbus_object_path__)
499
441
if options.enable:
507
449
if options.stop_checker:
508
450
set_client_prop("CheckerRunning", dbus.Boolean(False))
509
451
if options.is_enabled:
510
if client.Get(client_interface, "Enabled",
511
dbus_interface=dbus.PROPERTIES_IFACE):
452
sys.exit(0 if client.Get(client_interface,
455
dbus.PROPERTIES_IFACE)
515
457
if options.checker is not None:
516
458
set_client_prop("Checker", options.checker)
517
459
if options.host is not None:
543
485
client.Approve(dbus.Boolean(False),
544
486
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")
560
class Test_string_to_delta(unittest.TestCase):
561
def test_handles_basic_rfc3339(self):
562
self.assertEqual(string_to_delta("PT2H"),
563
datetime.timedelta(0, 7200))
564
def test_falls_back_to_pre_1_6_1_with_warning(self):
565
# assertLogs only exists in Python 3.4
566
if hasattr(self, "assertLogs"):
567
with self.assertLogs(log, logging.WARNING):
568
value = string_to_delta("2h")
570
value = string_to_delta("2h")
571
self.assertEqual(value, datetime.timedelta(0, 7200))
574
def should_only_run_tests():
575
parser = argparse.ArgumentParser(add_help=False)
576
parser.add_argument("--check", action='store_true')
577
args, unknown_args = parser.parse_known_args()
578
run_tests = args.check
580
# Remove --check argument from sys.argv
581
sys.argv[1:] = unknown_args
584
# Add all tests from doctest strings
585
def load_tests(loader, tests, none):
587
tests.addTests(doctest.DocTestSuite())
590
489
if __name__ == "__main__":
591
if should_only_run_tests():
592
# Call using ./tdd-python-script --check [--verbose]