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-2014 Teddy Hogeborn
7
# Copyright © 2008-2014 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
79
"ApprovalDelay": "Approval Delay",
65
80
"ApprovalDuration": "Approval Duration",
66
81
"Checker": "Checker",
67
"ExtendedTimeout" : "Extended Timeout"
82
"ExtendedTimeout": "Extended Timeout",
84
"LastCheckerStatus": "Last Checker Status",
69
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
87
domain = "se.recompile"
71
88
busname = domain + ".Mandos"
73
90
server_interface = domain + ".Mandos"
74
91
client_interface = domain + ".Mandos.Client"
96
dbus.OBJECT_MANAGER_IFACE
97
except AttributeError:
98
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
77
101
def milliseconds_to_string(ms):
78
102
td = datetime.timedelta(0, 0, 0, ms)
79
103
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
.format(days = "{}T".format(td.days) if td.days else "",
81
hours = td.seconds // 3600,
82
minutes = (td.seconds % 3600) // 60,
83
seconds = td.seconds % 60,
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))
87
110
def rfc3339_duration_to_delta(duration):
88
111
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
90
113
>>> rfc3339_duration_to_delta("P7D")
91
114
datetime.timedelta(7)
92
115
>>> rfc3339_duration_to_delta("PT60S")
93
116
datetime.timedelta(0, 60)
94
117
>>> rfc3339_duration_to_delta("PT60M")
95
118
datetime.timedelta(0, 3600)
119
>>> rfc3339_duration_to_delta("P60M")
120
datetime.timedelta(1680)
96
121
>>> rfc3339_duration_to_delta("PT24H")
97
122
datetime.timedelta(1)
98
123
>>> rfc3339_duration_to_delta("P1W")
101
126
datetime.timedelta(0, 330)
102
127
>>> rfc3339_duration_to_delta("P1DT3M20S")
103
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'
106
160
# Parsing an RFC 3339 duration with regular expressions is not
107
161
# possible - there would have to be multiple places for the same
108
162
# values, like seconds. The current code, while more esoteric, is
109
163
# cleaner without depending on a parsing library. If Python had a
110
164
# built-in library for parsing we would use it, but we'd like to
111
165
# avoid excessive use of external libraries.
113
167
# New type for defining tokens, syntax, and semantics all-in-one
114
Token = collections.namedtuple("Token",
115
("regexp", # To match token; if
116
# "value" is not None,
117
# must have a "group"
119
"value", # datetime.timedelta or
121
"followers")) # Tokens valid after
168
Token = collections.namedtuple("Token", (
169
"regexp", # To match token; if "value" is not None, must have
170
# a "group" containing digits
171
"value", # datetime.timedelta or None
172
"followers")) # Tokens valid after this token
123
173
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
174
# the "duration" ABNF definition in RFC 3339, Appendix A.
125
175
token_end = Token(re.compile(r"$"), None, frozenset())
126
176
token_second = Token(re.compile(r"(\d+)S"),
127
177
datetime.timedelta(seconds=1),
128
frozenset((token_end,)))
178
frozenset((token_end, )))
129
179
token_minute = Token(re.compile(r"(\d+)M"),
130
180
datetime.timedelta(minutes=1),
131
181
frozenset((token_second, token_end)))
147
197
frozenset((token_month, token_end)))
148
198
token_week = Token(re.compile(r"(\d+)W"),
149
199
datetime.timedelta(weeks=1),
150
frozenset((token_end,)))
200
frozenset((token_end, )))
151
201
token_duration = Token(re.compile(r"P"), None,
152
202
frozenset((token_year, token_month,
153
203
token_day, token_time,
155
# Define starting values
156
value = datetime.timedelta() # Value so far
205
# Define starting values:
207
value = datetime.timedelta()
157
208
found_token = None
158
followers = frozenset((token_duration,)) # Following valid tokens
159
s = duration # String left to parse
209
# Following valid tokens
210
followers = frozenset((token_duration, ))
211
# String left to parse
160
213
# Loop until end token is found
161
214
while found_token is not token_end:
162
215
# Search for any currently valid tokens
180
233
# No currently valid tokens were found
181
raise ValueError("Invalid RFC 3339 duration")
234
raise ValueError("Invalid RFC 3339 duration: {!r}"
182
236
# End token found
186
240
def string_to_delta(interval):
187
241
"""Parse a string and return a datetime.timedelta
189
>>> string_to_delta("7d")
190
datetime.timedelta(7)
191
>>> string_to_delta("60s")
192
datetime.timedelta(0, 60)
193
>>> string_to_delta("60m")
194
datetime.timedelta(0, 3600)
195
>>> string_to_delta("24h")
196
datetime.timedelta(1)
197
>>> string_to_delta("1w")
198
datetime.timedelta(7)
199
>>> string_to_delta("5m 30s")
200
datetime.timedelta(0, 330)
204
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)
208
275
value = datetime.timedelta(0)
209
276
regexp = re.compile(r"(\d+)([dsmhw]?)")
211
278
for num, suffix in regexp.findall(interval):
212
279
if suffix == "d":
213
280
value += datetime.timedelta(int(num))
223
290
value += datetime.timedelta(0, 0, 0, int(num))
226
294
def print_clients(clients, keywords):
295
print('\n'.join(table_rows_of_clients(clients, keywords)))
297
def table_rows_of_clients(clients, keywords):
227
298
def valuetostring(value, keyword):
228
if type(value) is dbus.Boolean:
299
if isinstance(value, dbus.Boolean):
229
300
return "Yes" if value else "No"
230
301
if keyword in ("Timeout", "Interval", "ApprovalDelay",
231
302
"ApprovalDuration", "ExtendedTimeout"):
232
303
return milliseconds_to_string(value)
233
304
return str(value)
235
306
# Create format string to print table rows
236
307
format_string = " ".join("{{{key}:{width}}}".format(
237
width = max(len(tablewords[key]),
238
max(len(valuetostring(client[key],
242
key = key) for key in keywords)
244
print(format_string.format(**tablewords))
308
width=max(len(tablewords[key]),
309
max(len(valuetostring(client[key], key))
310
for client in clients)),
313
# Start with header line
314
rows = [format_string.format(**tablewords)]
245
315
for client in clients:
246
print(format_string.format(**{ key:
247
valuetostring(client[key],
249
for key in keywords }))
316
rows.append(format_string
317
.format(**{key: valuetostring(client[key], key)
318
for key in keywords}))
251
322
def has_actions(options):
252
323
return any((options.enable,
272
344
parser = argparse.ArgumentParser()
273
345
parser.add_argument("--version", action="version",
274
version = "%(prog)s {}".format(version),
346
version="%(prog)s {}".format(version),
275
347
help="show version number and exit")
276
348
parser.add_argument("-a", "--all", action="store_true",
277
349
help="Select all clients")
278
350
parser.add_argument("-v", "--verbose", action="store_true",
279
351
help="Print all fields")
352
parser.add_argument("-j", "--dump-json", action="store_true",
353
help="Dump client data in JSON format")
280
354
parser.add_argument("-e", "--enable", action="store_true",
281
355
help="Enable client")
282
356
parser.add_argument("-d", "--disable", action="store_true",
321
395
help="Run self-test")
322
396
parser.add_argument("client", nargs="*", help="Client name")
323
397
options = parser.parse_args()
325
399
if has_actions(options) and not (options.client or options.all):
326
400
parser.error("Options require clients names or --all.")
327
401
if options.verbose and has_actions(options):
328
parser.error("--verbose can only be used alone or with"
402
parser.error("--verbose can only be used alone.")
403
if options.dump_json and (options.verbose
404
or has_actions(options)):
405
parser.error("--dump-json can only be used alone.")
330
406
if options.all and not has_actions(options):
331
407
parser.error("--all requires an action.")
334
fail_count, test_count = doctest.testmod()
335
sys.exit(os.EX_OK if fail_count == 0 else 1)
338
410
bus = dbus.SystemBus()
339
411
mandos_dbus_objc = bus.get_object(busname, server_path)
340
412
except dbus.exceptions.DBusException:
341
print("Could not connect to Mandos server",
413
log.critical("Could not connect to Mandos server")
345
416
mandos_serv = dbus.Interface(mandos_dbus_objc,
346
dbus_interface = server_interface)
348
#block stderr since dbus library prints to stderr
417
dbus_interface=server_interface)
418
mandos_serv_object_manager = dbus.Interface(
419
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
421
# block stderr since dbus library prints to stderr
349
422
null = os.open(os.path.devnull, os.O_RDWR)
350
423
stderrcopy = os.dup(sys.stderr.fileno())
351
424
os.dup2(null, sys.stderr.fileno())
355
mandos_clients = mandos_serv.GetAllClientsWithProperties()
428
mandos_clients = {path: ifs_and_props[client_interface]
429
for path, ifs_and_props in
430
mandos_serv_object_manager
431
.GetManagedObjects().items()
432
if client_interface in ifs_and_props}
358
435
os.dup2(stderrcopy, sys.stderr.fileno())
359
436
os.close(stderrcopy)
360
except dbus.exceptions.DBusException:
361
print("Access denied: Accessing mandos server through dbus.",
437
except dbus.exceptions.DBusException as e:
438
log.critical("Failed to access Mandos server through D-Bus:"
365
442
# Compile dict of (clients: properties) to process
368
445
if options.all or not options.client:
369
clients = { bus.get_object(busname, path): properties
370
for path, properties in mandos_clients.items() }
446
clients = {bus.get_object(busname, path): properties
447
for path, properties in mandos_clients.items()}
372
449
for name in options.client:
373
450
for path, client in mandos_clients.items():
376
453
clients[client_objc] = client
379
print("Client not found on server: {!r}"
380
.format(name), file=sys.stderr)
456
log.critical("Client not found on server: %r", name)
383
459
if not has_actions(options) and clients:
385
keywords = ("Name", "Enabled", "Timeout",
386
"LastCheckedOK", "Created", "Interval",
387
"Host", "Fingerprint", "CheckerRunning",
460
if options.verbose or options.dump_json:
461
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
462
"Created", "Interval", "Host", "KeyID",
463
"Fingerprint", "CheckerRunning",
388
464
"LastEnabled", "ApprovalPending",
390
"LastApprovalRequest", "ApprovalDelay",
391
"ApprovalDuration", "Checker",
465
"ApprovedByDefault", "LastApprovalRequest",
466
"ApprovalDelay", "ApprovalDuration",
467
"Checker", "ExtendedTimeout", "Expires",
394
470
keywords = defaultkeywords
396
print_clients(clients.values(), keywords)
472
if options.dump_json:
473
json.dump({client["Name"]: {key:
475
if isinstance(client[key],
479
for client in clients.values()},
480
fp=sys.stdout, indent=4,
481
separators=(',', ': '))
484
print_clients(clients.values(), keywords)
398
486
# Process each client in the list by all selected options
399
487
for client in clients:
400
489
def set_client_prop(prop, value):
401
490
"""Set a Client D-Bus property"""
402
491
client.Set(client_interface, prop, value,
403
492
dbus_interface=dbus.PROPERTIES_IFACE)
404
494
def set_client_prop_ms(prop, value):
405
495
"""Set a Client D-Bus property, converted
406
496
from a string to milliseconds."""
407
497
set_client_prop(prop,
408
498
string_to_delta(value).total_seconds()
410
501
if options.remove:
411
502
mandos_serv.RemoveClient(client.__dbus_object_path__)
412
503
if options.enable:
420
511
if options.stop_checker:
421
512
set_client_prop("CheckerRunning", dbus.Boolean(False))
422
513
if options.is_enabled:
423
sys.exit(0 if client.Get(client_interface,
426
dbus.PROPERTIES_IFACE)
514
if client.Get(client_interface, "Enabled",
515
dbus_interface=dbus.PROPERTIES_IFACE):
428
519
if options.checker is not None:
429
520
set_client_prop("Checker", options.checker)
430
521
if options.host is not None:
456
547
client.Approve(dbus.Boolean(False),
457
548
dbus_interface=client_interface)
551
class Test_milliseconds_to_string(unittest.TestCase):
553
self.assertEqual(milliseconds_to_string(93785000),
555
def test_no_days(self):
556
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
557
def test_all_zero(self):
558
self.assertEqual(milliseconds_to_string(0), "00:00:00")
559
def test_no_fractional_seconds(self):
560
self.assertEqual(milliseconds_to_string(400), "00:00:00")
561
self.assertEqual(milliseconds_to_string(900), "00:00:00")
562
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
564
class Test_string_to_delta(unittest.TestCase):
565
def test_handles_basic_rfc3339(self):
566
self.assertEqual(string_to_delta("PT2H"),
567
datetime.timedelta(0, 7200))
568
def test_falls_back_to_pre_1_6_1_with_warning(self):
569
# assertLogs only exists in Python 3.4
570
if hasattr(self, "assertLogs"):
571
with self.assertLogs(log, logging.WARNING):
572
value = string_to_delta("2h")
574
value = string_to_delta("2h")
575
self.assertEqual(value, datetime.timedelta(0, 7200))
578
def should_only_run_tests():
579
parser = argparse.ArgumentParser(add_help=False)
580
parser.add_argument("--check", action='store_true')
581
args, unknown_args = parser.parse_known_args()
582
run_tests = args.check
584
# Remove --check argument from sys.argv
585
sys.argv[1:] = unknown_args
588
# Add all tests from doctest strings
589
def load_tests(loader, tests, none):
591
tests.addTests(doctest.DocTestSuite())
459
594
if __name__ == "__main__":
595
if should_only_run_tests():
596
# Call using ./tdd-python-script --check [--verbose]