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-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
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,
29
from future_builtins import *
31
from future_builtins import *
48
# Show warnings by default
49
if not sys.warnoptions:
51
warnings.simplefilter("default")
53
log = logging.getLogger(sys.argv[0])
54
logging.basicConfig(level="INFO", # Show info level messages
55
format="%(message)s") # Show basic log messages
57
logging.captureWarnings(True) # Show warnings via the logging system
59
if sys.version_info.major == 2:
39
62
locale.setlocale(locale.LC_ALL, "")
55
79
"ApprovalDelay": "Approval Delay",
56
80
"ApprovalDuration": "Approval Duration",
57
81
"Checker": "Checker",
58
"ExtendedTimeout" : "Extended Timeout"
82
"ExtendedTimeout": "Extended Timeout",
84
"LastCheckerStatus": "Last Checker Status",
60
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
61
87
domain = "se.recompile"
62
88
busname = domain + ".Mandos"
64
90
server_interface = domain + ".Mandos"
65
91
client_interface = domain + ".Mandos.Client"
68
def timedelta_to_milliseconds(td):
69
"""Convert a datetime.timedelta object to milliseconds"""
70
return ((td.days * 24 * 60 * 60 * 1000)
72
+ (td.microseconds // 1000))
96
dbus.OBJECT_MANAGER_IFACE
97
except AttributeError:
98
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
74
101
def milliseconds_to_string(ms):
75
102
td = datetime.timedelta(0, 0, 0, ms)
76
103
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
77
.format(days = "{0}T".format(td.days) if td.days else "",
78
hours = td.seconds // 3600,
79
minutes = (td.seconds % 3600) // 60,
80
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))
110
def rfc3339_duration_to_delta(duration):
111
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
113
>>> rfc3339_duration_to_delta("P7D")
114
datetime.timedelta(7)
115
>>> rfc3339_duration_to_delta("PT60S")
116
datetime.timedelta(0, 60)
117
>>> rfc3339_duration_to_delta("PT60M")
118
datetime.timedelta(0, 3600)
119
>>> rfc3339_duration_to_delta("P60M")
120
datetime.timedelta(1680)
121
>>> rfc3339_duration_to_delta("PT24H")
122
datetime.timedelta(1)
123
>>> rfc3339_duration_to_delta("P1W")
124
datetime.timedelta(7)
125
>>> rfc3339_duration_to_delta("PT5M30S")
126
datetime.timedelta(0, 330)
127
>>> rfc3339_duration_to_delta("P1DT3M20S")
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'
160
# Parsing an RFC 3339 duration with regular expressions is not
161
# possible - there would have to be multiple places for the same
162
# values, like seconds. The current code, while more esoteric, is
163
# cleaner without depending on a parsing library. If Python had a
164
# built-in library for parsing we would use it, but we'd like to
165
# avoid excessive use of external libraries.
167
# 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
173
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
174
# the "duration" ABNF definition in RFC 3339, Appendix A.
175
token_end = Token(re.compile(r"$"), None, frozenset())
176
token_second = Token(re.compile(r"(\d+)S"),
177
datetime.timedelta(seconds=1),
178
frozenset((token_end, )))
179
token_minute = Token(re.compile(r"(\d+)M"),
180
datetime.timedelta(minutes=1),
181
frozenset((token_second, token_end)))
182
token_hour = Token(re.compile(r"(\d+)H"),
183
datetime.timedelta(hours=1),
184
frozenset((token_minute, token_end)))
185
token_time = Token(re.compile(r"T"),
187
frozenset((token_hour, token_minute,
189
token_day = Token(re.compile(r"(\d+)D"),
190
datetime.timedelta(days=1),
191
frozenset((token_time, token_end)))
192
token_month = Token(re.compile(r"(\d+)M"),
193
datetime.timedelta(weeks=4),
194
frozenset((token_day, token_end)))
195
token_year = Token(re.compile(r"(\d+)Y"),
196
datetime.timedelta(weeks=52),
197
frozenset((token_month, token_end)))
198
token_week = Token(re.compile(r"(\d+)W"),
199
datetime.timedelta(weeks=1),
200
frozenset((token_end, )))
201
token_duration = Token(re.compile(r"P"), None,
202
frozenset((token_year, token_month,
203
token_day, token_time,
205
# Define starting values:
207
value = datetime.timedelta()
209
# Following valid tokens
210
followers = frozenset((token_duration, ))
211
# String left to parse
213
# Loop until end token is found
214
while found_token is not token_end:
215
# Search for any currently valid tokens
216
for token in followers:
217
match = token.regexp.match(s)
218
if match is not None:
220
if token.value is not None:
221
# Value found, parse digits
222
factor = int(match.group(1), 10)
223
# Add to value so far
224
value += factor * token.value
225
# Strip token from string
226
s = token.regexp.sub("", s, 1)
229
# Set valid next tokens
230
followers = found_token.followers
233
# No currently valid tokens were found
234
raise ValueError("Invalid RFC 3339 duration: {!r}"
83
240
def string_to_delta(interval):
84
241
"""Parse a string and return a datetime.timedelta
86
>>> string_to_delta("7d")
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')
87
256
datetime.timedelta(7)
88
>>> string_to_delta("60s")
257
>>> parse_pre_1_6_1_interval('60s')
89
258
datetime.timedelta(0, 60)
90
>>> string_to_delta("60m")
259
>>> parse_pre_1_6_1_interval('60m')
91
260
datetime.timedelta(0, 3600)
92
>>> string_to_delta("24h")
261
>>> parse_pre_1_6_1_interval('24h')
93
262
datetime.timedelta(1)
94
>>> string_to_delta("1w")
263
>>> parse_pre_1_6_1_interval('1w')
95
264
datetime.timedelta(7)
96
>>> string_to_delta("5m 30s")
265
>>> parse_pre_1_6_1_interval('5m 30s')
97
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)
99
275
value = datetime.timedelta(0)
100
regexp = re.compile("(\d+)([dsmhw]?)")
276
regexp = re.compile(r"(\d+)([dsmhw]?)")
102
278
for num, suffix in regexp.findall(interval):
103
279
if suffix == "d":
104
280
value += datetime.timedelta(int(num))
114
290
value += datetime.timedelta(0, 0, 0, int(num))
117
294
def print_clients(clients, keywords):
295
print('\n'.join(table_rows_of_clients(clients, keywords)))
297
def table_rows_of_clients(clients, keywords):
118
298
def valuetostring(value, keyword):
119
if type(value) is dbus.Boolean:
299
if isinstance(value, dbus.Boolean):
120
300
return "Yes" if value else "No"
121
301
if keyword in ("Timeout", "Interval", "ApprovalDelay",
122
302
"ApprovalDuration", "ExtendedTimeout"):
123
303
return milliseconds_to_string(value)
124
return unicode(value)
126
306
# Create format string to print table rows
127
307
format_string = " ".join("{{{key}:{width}}}".format(
128
width = max(len(tablewords[key]),
129
max(len(valuetostring(client[key],
133
key = key) for key in keywords)
135
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)]
136
315
for client in clients:
137
print(format_string.format(**dict((key,
138
valuetostring(client[key],
140
for key in keywords)))
316
rows.append(format_string
317
.format(**{key: valuetostring(client[key], key)
318
for key in keywords}))
142
322
def has_actions(options):
143
323
return any((options.enable,
201
384
parser.add_argument("--approval-duration",
202
385
help="Set duration of one client approval")
203
386
parser.add_argument("-H", "--host", help="Set host for client")
204
parser.add_argument("-s", "--secret", type=file,
387
parser.add_argument("-s", "--secret",
388
type=argparse.FileType(mode="rb"),
205
389
help="Set password blob (file) for client")
206
390
parser.add_argument("-A", "--approve", action="store_true",
207
391
help="Approve any current client request")
208
392
parser.add_argument("-D", "--deny", action="store_true",
209
393
help="Deny any current client request")
394
parser.add_argument("--check", action="store_true",
395
help="Run self-test")
210
396
parser.add_argument("client", nargs="*", help="Client name")
211
397
options = parser.parse_args()
213
399
if has_actions(options) and not (options.client or options.all):
214
400
parser.error("Options require clients names or --all.")
215
401
if options.verbose and has_actions(options):
216
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.")
218
406
if options.all and not has_actions(options):
219
407
parser.error("--all requires an action.")
222
410
bus = dbus.SystemBus()
223
411
mandos_dbus_objc = bus.get_object(busname, server_path)
224
412
except dbus.exceptions.DBusException:
225
print("Could not connect to Mandos server",
413
log.critical("Could not connect to Mandos server")
229
416
mandos_serv = dbus.Interface(mandos_dbus_objc,
230
dbus_interface = server_interface)
232
#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
233
422
null = os.open(os.path.devnull, os.O_RDWR)
234
423
stderrcopy = os.dup(sys.stderr.fileno())
235
424
os.dup2(null, sys.stderr.fileno())
239
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}
242
435
os.dup2(stderrcopy, sys.stderr.fileno())
243
436
os.close(stderrcopy)
244
except dbus.exceptions.DBusException:
245
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:"
249
442
# Compile dict of (clients: properties) to process
252
445
if options.all or not options.client:
253
clients = dict((bus.get_object(busname, path), properties)
254
for path, properties in
255
mandos_clients.iteritems())
446
clients = {bus.get_object(busname, path): properties
447
for path, properties in mandos_clients.items()}
257
449
for name in options.client:
258
for path, client in mandos_clients.iteritems():
450
for path, client in mandos_clients.items():
259
451
if client["Name"] == name:
260
452
client_objc = bus.get_object(busname, path)
261
453
clients[client_objc] = client
264
print("Client not found on server: {0!r}"
265
.format(name), file=sys.stderr)
456
log.critical("Client not found on server: %r", name)
268
459
if not has_actions(options) and clients:
270
keywords = ("Name", "Enabled", "Timeout",
271
"LastCheckedOK", "Created", "Interval",
272
"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",
273
464
"LastEnabled", "ApprovalPending",
275
"LastApprovalRequest", "ApprovalDelay",
276
"ApprovalDuration", "Checker",
465
"ApprovedByDefault", "LastApprovalRequest",
466
"ApprovalDelay", "ApprovalDuration",
467
"Checker", "ExtendedTimeout", "Expires",
279
470
keywords = defaultkeywords
281
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)
283
486
# Process each client in the list by all selected options
284
487
for client in clients:
285
489
def set_client_prop(prop, value):
286
490
"""Set a Client D-Bus property"""
287
491
client.Set(client_interface, prop, value,
288
492
dbus_interface=dbus.PROPERTIES_IFACE)
289
494
def set_client_prop_ms(prop, value):
290
495
"""Set a Client D-Bus property, converted
291
496
from a string to milliseconds."""
292
497
set_client_prop(prop,
293
timedelta_to_milliseconds
294
(string_to_delta(value)))
498
string_to_delta(value).total_seconds()
295
501
if options.remove:
296
502
mandos_serv.RemoveClient(client.__dbus_object_path__)
297
503
if options.enable:
341
547
client.Approve(dbus.Boolean(False),
342
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())
344
594
if __name__ == "__main__":
595
if should_only_run_tests():
596
# Call using ./tdd-python-script --check [--verbose]