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-2012 Teddy Hogeborn
7
# Copyright © 2008-2012 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,
31
from future_builtins import *
29
from future_builtins import *
79
58
"ApprovalDelay": "Approval Delay",
80
59
"ApprovalDuration": "Approval Duration",
81
60
"Checker": "Checker",
82
"ExtendedTimeout": "Extended Timeout",
84
"LastCheckerStatus": "Last Checker Status",
61
"ExtendedTimeout" : "Extended Timeout"
86
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
64
domain = "se.recompile"
88
65
busname = domain + ".Mandos"
90
67
server_interface = domain + ".Mandos"
91
68
client_interface = domain + ".Mandos.Client"
96
dbus.OBJECT_MANAGER_IFACE
97
except AttributeError:
98
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
71
def timedelta_to_milliseconds(td):
72
"""Convert a datetime.timedelta object to milliseconds"""
73
return ((td.days * 24 * 60 * 60 * 1000)
75
+ (td.microseconds // 1000))
101
77
def milliseconds_to_string(ms):
102
78
td = datetime.timedelta(0, 0, 0, ms)
103
79
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
.format(days = "{0}T".format(td.days) if td.days else "",
81
hours = td.seconds // 3600,
82
minutes = (td.seconds % 3600) // 60,
83
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")
116
93
datetime.timedelta(0, 60)
117
94
>>> rfc3339_duration_to_delta("PT60M")
118
95
datetime.timedelta(0, 3600)
119
>>> rfc3339_duration_to_delta("P60M")
120
datetime.timedelta(1680)
121
96
>>> rfc3339_duration_to_delta("PT24H")
122
97
datetime.timedelta(1)
123
98
>>> rfc3339_duration_to_delta("P1W")
126
101
datetime.timedelta(0, 330)
127
102
>>> rfc3339_duration_to_delta("P1DT3M20S")
128
103
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
106
# Parsing an RFC 3339 duration with regular expressions is not
161
107
# possible - there would have to be multiple places for the same
162
108
# values, like seconds. The current code, while more esoteric, is
163
109
# cleaner without depending on a parsing library. If Python had a
164
110
# built-in library for parsing we would use it, but we'd like to
165
111
# avoid excessive use of external libraries.
167
113
# New type for defining tokens, syntax, and semantics all-in-one
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
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
173
123
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
174
124
# the "duration" ABNF definition in RFC 3339, Appendix A.
175
125
token_end = Token(re.compile(r"$"), None, frozenset())
176
126
token_second = Token(re.compile(r"(\d+)S"),
177
127
datetime.timedelta(seconds=1),
178
frozenset((token_end, )))
128
frozenset((token_end,)))
179
129
token_minute = Token(re.compile(r"(\d+)M"),
180
130
datetime.timedelta(minutes=1),
181
131
frozenset((token_second, token_end)))
233
180
# No currently valid tokens were found
234
raise ValueError("Invalid RFC 3339 duration: {!r}"
181
raise ValueError("Invalid RFC 3339 duration")
236
182
# End token found
240
186
def string_to_delta(interval):
241
187
"""Parse a string and return a datetime.timedelta
243
>>> string_to_delta('7d')
189
>>> string_to_delta("7d")
244
190
datetime.timedelta(7)
245
>>> string_to_delta('60s')
191
>>> string_to_delta("60s")
246
192
datetime.timedelta(0, 60)
247
>>> string_to_delta('60m')
193
>>> string_to_delta("60m")
248
194
datetime.timedelta(0, 3600)
249
>>> string_to_delta('24h')
195
>>> string_to_delta("24h")
250
196
datetime.timedelta(1)
251
>>> string_to_delta('1w')
197
>>> string_to_delta("1w")
252
198
datetime.timedelta(7)
253
>>> string_to_delta('5m 30s')
199
>>> string_to_delta("5m 30s")
254
200
datetime.timedelta(0, 330)
202
value = datetime.timedelta(0)
203
regexp = re.compile(r"(\d+)([dsmhw]?)")
258
206
return rfc3339_duration_to_delta(interval)
259
207
except ValueError:
262
value = datetime.timedelta(0)
263
regexp = re.compile(r"(\d+)([dsmhw]?)")
265
210
for num, suffix in regexp.findall(interval):
266
211
if suffix == "d":
267
212
value += datetime.timedelta(int(num))
277
222
value += datetime.timedelta(0, 0, 0, int(num))
281
225
def print_clients(clients, keywords):
282
226
def valuetostring(value, keyword):
283
if isinstance(value, dbus.Boolean):
227
if type(value) is dbus.Boolean:
284
228
return "Yes" if value else "No"
285
229
if keyword in ("Timeout", "Interval", "ApprovalDelay",
286
230
"ApprovalDuration", "ExtendedTimeout"):
287
231
return milliseconds_to_string(value)
232
return unicode(value)
290
234
# Create format string to print table rows
291
235
format_string = " ".join("{{{key}:{width}}}".format(
292
width=max(len(tablewords[key]),
293
max(len(valuetostring(client[key], key))
294
for client in clients)),
236
width = max(len(tablewords[key]),
237
max(len(valuetostring(client[key],
241
key = key) for key in keywords)
297
242
# Print header line
298
243
print(format_string.format(**tablewords))
299
244
for client in clients:
301
.format(**{key: valuetostring(client[key], key)
302
for key in keywords}))
245
print(format_string.format(**dict((key,
246
valuetostring(client[key],
248
for key in keywords)))
305
250
def has_actions(options):
306
251
return any((options.enable,
327
271
parser = argparse.ArgumentParser()
328
272
parser.add_argument("--version", action="version",
329
version="%(prog)s {}".format(version),
273
version = "%(prog)s {0}".format(version),
330
274
help="show version number and exit")
331
275
parser.add_argument("-a", "--all", action="store_true",
332
276
help="Select all clients")
333
277
parser.add_argument("-v", "--verbose", action="store_true",
334
278
help="Print all fields")
335
parser.add_argument("-j", "--dump-json", action="store_true",
336
help="Dump client data in JSON format")
337
279
parser.add_argument("-e", "--enable", action="store_true",
338
280
help="Enable client")
339
281
parser.add_argument("-d", "--disable", action="store_true",
378
319
help="Run self-test")
379
320
parser.add_argument("client", nargs="*", help="Client name")
380
321
options = parser.parse_args()
382
323
if has_actions(options) and not (options.client or options.all):
383
324
parser.error("Options require clients names or --all.")
384
325
if options.verbose and has_actions(options):
385
parser.error("--verbose can only be used alone.")
386
if options.dump_json and (options.verbose
387
or has_actions(options)):
388
parser.error("--dump-json can only be used alone.")
326
parser.error("--verbose can only be used alone or with"
389
328
if options.all and not has_actions(options):
390
329
parser.error("--all requires an action.")
332
fail_count, test_count = doctest.testmod()
333
sys.exit(0 if fail_count == 0 else 1)
393
336
bus = dbus.SystemBus()
394
337
mandos_dbus_objc = bus.get_object(busname, server_path)
395
338
except dbus.exceptions.DBusException:
396
log.critical("Could not connect to Mandos server")
339
print("Could not connect to Mandos server",
399
343
mandos_serv = dbus.Interface(mandos_dbus_objc,
400
dbus_interface=server_interface)
401
mandos_serv_object_manager = dbus.Interface(
402
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
404
# block stderr since dbus library prints to stderr
344
dbus_interface = server_interface)
346
#block stderr since dbus library prints to stderr
405
347
null = os.open(os.path.devnull, os.O_RDWR)
406
348
stderrcopy = os.dup(sys.stderr.fileno())
407
349
os.dup2(null, sys.stderr.fileno())
411
mandos_clients = {path: ifs_and_props[client_interface]
412
for path, ifs_and_props in
413
mandos_serv_object_manager
414
.GetManagedObjects().items()
415
if client_interface in ifs_and_props}
353
mandos_clients = mandos_serv.GetAllClientsWithProperties()
418
356
os.dup2(stderrcopy, sys.stderr.fileno())
419
357
os.close(stderrcopy)
420
except dbus.exceptions.DBusException as e:
421
log.critical("Failed to access Mandos server through D-Bus:"
358
except dbus.exceptions.DBusException:
359
print("Access denied: Accessing mandos server through dbus.",
425
363
# Compile dict of (clients: properties) to process
428
366
if options.all or not options.client:
429
clients = {bus.get_object(busname, path): properties
430
for path, properties in mandos_clients.items()}
367
clients = dict((bus.get_object(busname, path), properties)
368
for path, properties in
369
mandos_clients.iteritems())
432
371
for name in options.client:
433
for path, client in mandos_clients.items():
372
for path, client in mandos_clients.iteritems():
434
373
if client["Name"] == name:
435
374
client_objc = bus.get_object(busname, path)
436
375
clients[client_objc] = client
439
log.critical("Client not found on server: %r", name)
378
print("Client not found on server: {0!r}"
379
.format(name), file=sys.stderr)
442
382
if not has_actions(options) and clients:
443
if options.verbose or options.dump_json:
444
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
445
"Created", "Interval", "Host", "KeyID",
446
"Fingerprint", "CheckerRunning",
384
keywords = ("Name", "Enabled", "Timeout",
385
"LastCheckedOK", "Created", "Interval",
386
"Host", "Fingerprint", "CheckerRunning",
447
387
"LastEnabled", "ApprovalPending",
448
"ApprovedByDefault", "LastApprovalRequest",
449
"ApprovalDelay", "ApprovalDuration",
450
"Checker", "ExtendedTimeout", "Expires",
389
"LastApprovalRequest", "ApprovalDelay",
390
"ApprovalDuration", "Checker",
453
393
keywords = defaultkeywords
455
if options.dump_json:
456
json.dump({client["Name"]: {key:
458
if isinstance(client[key],
462
for client in clients.values()},
463
fp=sys.stdout, indent=4,
464
separators=(',', ': '))
467
print_clients(clients.values(), keywords)
395
print_clients(clients.values(), keywords)
469
397
# Process each client in the list by all selected options
470
398
for client in clients:
472
399
def set_client_prop(prop, value):
473
400
"""Set a Client D-Bus property"""
474
401
client.Set(client_interface, prop, value,
475
402
dbus_interface=dbus.PROPERTIES_IFACE)
477
403
def set_client_prop_ms(prop, value):
478
404
"""Set a Client D-Bus property, converted
479
405
from a string to milliseconds."""
480
406
set_client_prop(prop,
481
string_to_delta(value).total_seconds()
407
timedelta_to_milliseconds
408
(string_to_delta(value)))
484
409
if options.remove:
485
410
mandos_serv.RemoveClient(client.__dbus_object_path__)
486
411
if options.enable:
530
455
client.Approve(dbus.Boolean(False),
531
456
dbus_interface=client_interface)
534
class Test_milliseconds_to_string(unittest.TestCase):
536
self.assertEqual(milliseconds_to_string(93785000),
538
def test_no_days(self):
539
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
540
def test_all_zero(self):
541
self.assertEqual(milliseconds_to_string(0), "00:00:00")
542
def test_no_fractional_seconds(self):
543
self.assertEqual(milliseconds_to_string(400), "00:00:00")
544
self.assertEqual(milliseconds_to_string(900), "00:00:00")
545
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
548
def should_only_run_tests():
549
parser = argparse.ArgumentParser(add_help=False)
550
parser.add_argument("--check", action='store_true')
551
args, unknown_args = parser.parse_known_args()
552
run_tests = args.check
554
# Remove --check argument from sys.argv
555
sys.argv[1:] = unknown_args
558
# Add all tests from doctest strings
559
def load_tests(loader, tests, none):
561
tests.addTests(doctest.DocTestSuite())
564
458
if __name__ == "__main__":
565
if should_only_run_tests():
566
# Call using ./tdd-python-script --check [--verbose]