2
2
# -*- mode: python; coding: utf-8 -*-
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
13
# the Free Software Foundation, either version 3 of the License, or
14
# (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
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
# GNU General Public License for more details.
21
# You should have received a copy of the GNU General Public License
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
24
# Contact the authors at <mandos@recompile.se>.
27
from __future__ import (division, absolute_import, print_function,
31
from future_builtins import *
4
from __future__ import division
7
from optparse import OptionParser
47
if sys.version_info.major == 2:
50
locale.setlocale(locale.LC_ALL, "")
12
locale.setlocale(locale.LC_ALL, u'')
56
"LastCheckedOK": "Last Successful Check",
57
"LastApprovalRequest": "Last Approval Request",
59
"Interval": "Interval",
61
"Fingerprint": "Fingerprint",
63
"CheckerRunning": "Check Is Running",
64
"LastEnabled": "Last Enabled",
65
"ApprovalPending": "Approval Is Pending",
66
"ApprovedByDefault": "Approved By Default",
67
"ApprovalDelay": "Approval Delay",
68
"ApprovalDuration": "Approval Duration",
70
"ExtendedTimeout": "Extended Timeout",
72
"LastCheckerStatus": "Last Checker Status",
74
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
75
domain = "se.recompile"
76
busname = domain + ".Mandos"
78
server_interface = domain + ".Mandos"
79
client_interface = domain + ".Mandos.Client"
84
dbus.OBJECT_MANAGER_IFACE
85
except AttributeError:
86
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
16
'enabled': u'Enabled',
17
'timeout': u'Timeout',
18
'last_checked_ok': u'Last Successful Check',
19
'created': u'Created',
20
'interval': u'Interval',
22
'fingerprint': u'Fingerprint',
23
'checker_running': u'Check Is Running',
24
'last_enabled': u'Last Enabled',
25
'checker': u'Checker',
27
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
29
busname = 'org.mandos-system.Mandos'
30
server_path = '/Mandos'
31
server_interface = 'org.mandos_system.Mandos'
32
client_interface = 'org.mandos_system.Mandos.Client'
35
bus = dbus.SystemBus()
36
mandos_dbus_objc = bus.get_object(busname, server_path)
37
mandos_serv = dbus.Interface(mandos_dbus_objc,
38
dbus_interface = server_interface)
39
mandos_clients = mandos_serv.GetAllClientsWithProperties()
41
def datetime_to_milliseconds(dt):
42
"Return the 'timeout' attribute in milliseconds"
43
return ((dt.days * 24 * 60 * 60 * 1000)
45
+ (dt.microseconds // 1000))
89
47
def milliseconds_to_string(ms):
90
48
td = datetime.timedelta(0, 0, 0, ms)
91
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
92
.format(days="{}T".format(td.days) if td.days else "",
93
hours=td.seconds // 3600,
94
minutes=(td.seconds % 3600) // 60,
95
seconds=td.seconds % 60))
98
def rfc3339_duration_to_delta(duration):
99
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
101
>>> rfc3339_duration_to_delta("P7D")
102
datetime.timedelta(7)
103
>>> rfc3339_duration_to_delta("PT60S")
104
datetime.timedelta(0, 60)
105
>>> rfc3339_duration_to_delta("PT60M")
106
datetime.timedelta(0, 3600)
107
>>> rfc3339_duration_to_delta("PT24H")
108
datetime.timedelta(1)
109
>>> rfc3339_duration_to_delta("P1W")
110
datetime.timedelta(7)
111
>>> rfc3339_duration_to_delta("PT5M30S")
112
datetime.timedelta(0, 330)
113
>>> rfc3339_duration_to_delta("P1DT3M20S")
114
datetime.timedelta(1, 200)
117
# Parsing an RFC 3339 duration with regular expressions is not
118
# possible - there would have to be multiple places for the same
119
# values, like seconds. The current code, while more esoteric, is
120
# cleaner without depending on a parsing library. If Python had a
121
# built-in library for parsing we would use it, but we'd like to
122
# avoid excessive use of external libraries.
124
# New type for defining tokens, syntax, and semantics all-in-one
125
Token = collections.namedtuple("Token", (
126
"regexp", # To match token; if "value" is not None, must have
127
# a "group" containing digits
128
"value", # datetime.timedelta or None
129
"followers")) # Tokens valid after this token
130
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
131
# the "duration" ABNF definition in RFC 3339, Appendix A.
132
token_end = Token(re.compile(r"$"), None, frozenset())
133
token_second = Token(re.compile(r"(\d+)S"),
134
datetime.timedelta(seconds=1),
135
frozenset((token_end, )))
136
token_minute = Token(re.compile(r"(\d+)M"),
137
datetime.timedelta(minutes=1),
138
frozenset((token_second, token_end)))
139
token_hour = Token(re.compile(r"(\d+)H"),
140
datetime.timedelta(hours=1),
141
frozenset((token_minute, token_end)))
142
token_time = Token(re.compile(r"T"),
144
frozenset((token_hour, token_minute,
146
token_day = Token(re.compile(r"(\d+)D"),
147
datetime.timedelta(days=1),
148
frozenset((token_time, token_end)))
149
token_month = Token(re.compile(r"(\d+)M"),
150
datetime.timedelta(weeks=4),
151
frozenset((token_day, token_end)))
152
token_year = Token(re.compile(r"(\d+)Y"),
153
datetime.timedelta(weeks=52),
154
frozenset((token_month, token_end)))
155
token_week = Token(re.compile(r"(\d+)W"),
156
datetime.timedelta(weeks=1),
157
frozenset((token_end, )))
158
token_duration = Token(re.compile(r"P"), None,
159
frozenset((token_year, token_month,
160
token_day, token_time,
162
# Define starting values:
164
value = datetime.timedelta()
166
# Following valid tokens
167
followers = frozenset((token_duration, ))
168
# String left to parse
170
# Loop until end token is found
171
while found_token is not token_end:
172
# Search for any currently valid tokens
173
for token in followers:
174
match = token.regexp.match(s)
175
if match is not None:
177
if token.value is not None:
178
# Value found, parse digits
179
factor = int(match.group(1), 10)
180
# Add to value so far
181
value += factor * token.value
182
# Strip token from string
183
s = token.regexp.sub("", s, 1)
186
# Set valid next tokens
187
followers = found_token.followers
190
# No currently valid tokens were found
191
raise ValueError("Invalid RFC 3339 duration: {!r}"
49
return "%s%02d:%02d:%02d" % (("%dT" % td.days) if td.days else "", # days
50
td.seconds // 3600, # hours
51
(td.seconds % 3600) // 60, # minutes
52
(td.seconds % 60)) # seconds
197
55
def string_to_delta(interval):
205
63
datetime.timedelta(0, 3600)
206
64
>>> string_to_delta('24h')
207
65
datetime.timedelta(1)
208
>>> string_to_delta('1w')
66
>>> string_to_delta(u'1w')
209
67
datetime.timedelta(7)
210
68
>>> string_to_delta('5m 30s')
211
69
datetime.timedelta(0, 330)
215
return rfc3339_duration_to_delta(interval)
219
value = datetime.timedelta(0)
220
regexp = re.compile(r"(\d+)([dsmhw]?)")
222
for num, suffix in regexp.findall(interval):
224
value += datetime.timedelta(int(num))
226
value += datetime.timedelta(0, int(num))
228
value += datetime.timedelta(0, 0, 0, 0, int(num))
230
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
232
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
234
value += datetime.timedelta(0, 0, 0, int(num))
238
def print_clients(clients, keywords):
71
timevalue = datetime.timedelta(0)
72
regexp = re.compile("\d+[dsmhw]")
74
for s in regexp.findall(interval):
76
suffix = unicode(s[-1])
79
delta = datetime.timedelta(value)
81
delta = datetime.timedelta(0, value)
83
delta = datetime.timedelta(0, 0, 0, 0, value)
85
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
87
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
90
except (ValueError, IndexError):
95
def print_clients(clients):
239
96
def valuetostring(value, keyword):
240
97
if type(value) is dbus.Boolean:
241
return "Yes" if value else "No"
242
if keyword in ("Timeout", "Interval", "ApprovalDelay",
243
"ApprovalDuration", "ExtendedTimeout"):
98
return u"Yes" if value else u"No"
99
if keyword in ("timeout", "interval"):
244
100
return milliseconds_to_string(value)
247
# Create format string to print table rows
248
format_string = " ".join("{{{key}:{width}}}".format(
249
width=max(len(tablewords[key]),
250
max(len(valuetostring(client[key], key))
251
for client in clients)),
255
print(format_string.format(**tablewords))
101
return unicode(value)
103
format_string = u' '.join(u'%%-%ds' %
104
max(len(tablewords[key]),
105
max(len(valuetostring(client[key], key))
109
print format_string % tuple(tablewords[key] for key in keywords)
256
110
for client in clients:
258
.format(**{key: valuetostring(client[key], key)
259
for key in keywords}))
262
def has_actions(options):
263
return any((options.enable,
265
options.bump_timeout,
266
options.start_checker,
267
options.stop_checker,
270
options.checker is not None,
271
options.timeout is not None,
272
options.extended_timeout is not None,
273
options.interval is not None,
274
options.approved_by_default is not None,
275
options.approval_delay is not None,
276
options.approval_duration is not None,
277
options.host is not None,
278
options.secret is not None,
284
parser = argparse.ArgumentParser()
285
parser.add_argument("--version", action="version",
286
version="%(prog)s {}".format(version),
287
help="show version number and exit")
288
parser.add_argument("-a", "--all", action="store_true",
289
help="Select all clients")
290
parser.add_argument("-v", "--verbose", action="store_true",
291
help="Print all fields")
292
parser.add_argument("-j", "--dump-json", action="store_true",
293
help="Dump client data in JSON format")
294
parser.add_argument("-e", "--enable", action="store_true",
295
help="Enable client")
296
parser.add_argument("-d", "--disable", action="store_true",
297
help="disable client")
298
parser.add_argument("-b", "--bump-timeout", action="store_true",
299
help="Bump timeout for client")
300
parser.add_argument("--start-checker", action="store_true",
301
help="Start checker for client")
302
parser.add_argument("--stop-checker", action="store_true",
303
help="Stop checker for client")
304
parser.add_argument("-V", "--is-enabled", action="store_true",
305
help="Check if client is enabled")
306
parser.add_argument("-r", "--remove", action="store_true",
307
help="Remove client")
308
parser.add_argument("-c", "--checker",
309
help="Set checker command for client")
310
parser.add_argument("-t", "--timeout",
311
help="Set timeout for client")
312
parser.add_argument("--extended-timeout",
313
help="Set extended timeout for client")
314
parser.add_argument("-i", "--interval",
315
help="Set checker interval for client")
316
parser.add_argument("--approve-by-default", action="store_true",
317
default=None, dest="approved_by_default",
318
help="Set client to be approved by default")
319
parser.add_argument("--deny-by-default", action="store_false",
320
dest="approved_by_default",
321
help="Set client to be denied by default")
322
parser.add_argument("--approval-delay",
323
help="Set delay before client approve/deny")
324
parser.add_argument("--approval-duration",
325
help="Set duration of one client approval")
326
parser.add_argument("-H", "--host", help="Set host for client")
327
parser.add_argument("-s", "--secret",
328
type=argparse.FileType(mode="rb"),
329
help="Set password blob (file) for client")
330
parser.add_argument("-A", "--approve", action="store_true",
331
help="Approve any current client request")
332
parser.add_argument("-D", "--deny", action="store_true",
333
help="Deny any current client request")
334
parser.add_argument("--check", action="store_true",
335
help="Run self-test")
336
parser.add_argument("client", nargs="*", help="Client name")
337
options = parser.parse_args()
339
if has_actions(options) and not (options.client or options.all):
340
parser.error("Options require clients names or --all.")
341
if options.verbose and has_actions(options):
342
parser.error("--verbose can only be used alone.")
343
if options.dump_json and (options.verbose
344
or has_actions(options)):
345
parser.error("--dump-json can only be used alone.")
346
if options.all and not has_actions(options):
347
parser.error("--all requires an action.")
350
bus = dbus.SystemBus()
351
mandos_dbus_objc = bus.get_object(busname, server_path)
352
except dbus.exceptions.DBusException:
353
print("Could not connect to Mandos server", file=sys.stderr)
356
mandos_serv = dbus.Interface(mandos_dbus_objc,
357
dbus_interface=server_interface)
358
mandos_serv_object_manager = dbus.Interface(
359
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
361
# block stderr since dbus library prints to stderr
362
null = os.open(os.path.devnull, os.O_RDWR)
363
stderrcopy = os.dup(sys.stderr.fileno())
364
os.dup2(null, sys.stderr.fileno())
368
mandos_clients = {path: ifs_and_props[client_interface]
369
for path, ifs_and_props in
370
mandos_serv_object_manager
371
.GetManagedObjects().items()
372
if client_interface in ifs_and_props}
375
os.dup2(stderrcopy, sys.stderr.fileno())
377
except dbus.exceptions.DBusException as e:
378
print("Access denied: "
379
"Accessing mandos server through D-Bus: {}".format(e),
383
# Compile dict of (clients: properties) to process
386
if options.all or not options.client:
387
clients = {bus.get_object(busname, path): properties
388
for path, properties in mandos_clients.items()}
390
for name in options.client:
391
for path, client in mandos_clients.items():
392
if client["Name"] == name:
393
client_objc = bus.get_object(busname, path)
394
clients[client_objc] = client
397
print("Client not found on server: {!r}"
398
.format(name), file=sys.stderr)
401
if not has_actions(options) and clients:
402
if options.verbose or options.dump_json:
403
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
404
"Created", "Interval", "Host", "KeyID",
405
"Fingerprint", "CheckerRunning",
406
"LastEnabled", "ApprovalPending",
407
"ApprovedByDefault", "LastApprovalRequest",
408
"ApprovalDelay", "ApprovalDuration",
409
"Checker", "ExtendedTimeout", "Expires",
412
keywords = defaultkeywords
414
if options.dump_json:
415
json.dump({client["Name"]: {key:
417
if isinstance(client[key],
421
for client in clients.values()},
422
fp=sys.stdout, indent=4,
423
separators=(',', ': '))
426
print_clients(clients.values(), keywords)
428
# Process each client in the list by all selected options
429
for client in clients:
431
def set_client_prop(prop, value):
432
"""Set a Client D-Bus property"""
433
client.Set(client_interface, prop, value,
434
dbus_interface=dbus.PROPERTIES_IFACE)
436
def set_client_prop_ms(prop, value):
437
"""Set a Client D-Bus property, converted
438
from a string to milliseconds."""
439
set_client_prop(prop,
440
string_to_delta(value).total_seconds()
444
mandos_serv.RemoveClient(client.__dbus_object_path__)
446
set_client_prop("Enabled", dbus.Boolean(True))
448
set_client_prop("Enabled", dbus.Boolean(False))
449
if options.bump_timeout:
450
set_client_prop("LastCheckedOK", "")
451
if options.start_checker:
452
set_client_prop("CheckerRunning", dbus.Boolean(True))
453
if options.stop_checker:
454
set_client_prop("CheckerRunning", dbus.Boolean(False))
455
if options.is_enabled:
456
if client.Get(client_interface, "Enabled",
457
dbus_interface=dbus.PROPERTIES_IFACE):
461
if options.checker is not None:
462
set_client_prop("Checker", options.checker)
463
if options.host is not None:
464
set_client_prop("Host", options.host)
465
if options.interval is not None:
466
set_client_prop_ms("Interval", options.interval)
467
if options.approval_delay is not None:
468
set_client_prop_ms("ApprovalDelay",
469
options.approval_delay)
470
if options.approval_duration is not None:
471
set_client_prop_ms("ApprovalDuration",
472
options.approval_duration)
473
if options.timeout is not None:
474
set_client_prop_ms("Timeout", options.timeout)
475
if options.extended_timeout is not None:
476
set_client_prop_ms("ExtendedTimeout",
477
options.extended_timeout)
478
if options.secret is not None:
479
set_client_prop("Secret",
480
dbus.ByteArray(options.secret.read()))
481
if options.approved_by_default is not None:
482
set_client_prop("ApprovedByDefault",
484
.approved_by_default))
486
client.Approve(dbus.Boolean(True),
487
dbus_interface=client_interface)
489
client.Approve(dbus.Boolean(False),
490
dbus_interface=client_interface)
493
def should_only_run_tests():
494
parser = argparse.ArgumentParser(add_help=False)
495
parser.add_argument("--check", action='store_true')
496
args, unknown_args = parser.parse_known_args()
497
run_tests = args.check
499
# Remove --check argument from sys.argv
500
sys.argv[1:] = unknown_args
503
# Add all tests from doctest strings
504
def load_tests(loader, tests, none):
506
tests.addTests(doctest.DocTestSuite())
509
if __name__ == "__main__":
510
if should_only_run_tests():
511
# Call using ./tdd-python-script --check [--verbose]
111
print format_string % tuple(valuetostring(client[key], key)
114
parser = OptionParser(version = "%%prog %s" % version)
115
parser.add_option("-a", "--all", action="store_true",
116
help="Print all fields")
117
parser.add_option("-e", "--enable", action="store_true",
118
help="Enable client")
119
parser.add_option("-d", "--disable", action="store_true",
120
help="disable client")
121
parser.add_option("-b", "--bump-timeout", action="store_true",
122
help="Bump timeout for client")
123
parser.add_option("--start-checker", action="store_true",
124
help="Start checker for client")
125
parser.add_option("--stop-checker", action="store_true",
126
help="Stop checker for client")
127
parser.add_option("-V", "--is-valid", action="store_true",
128
help="Check if client is still valid")
129
parser.add_option("-r", "--remove", action="store_true",
130
help="Remove client")
131
parser.add_option("-c", "--checker", type="string",
132
help="Set checker command for client")
133
parser.add_option("-t", "--timeout", type="string",
134
help="Set timeout for client")
135
parser.add_option("-i", "--interval", type="string",
136
help="Set checker interval for client")
137
parser.add_option("-H", "--host", type="string",
138
help="Set host for client")
139
parser.add_option("-s", "--secret", type="string",
140
help="Set password blob (file) for client")
141
options, client_names = parser.parse_args()
143
# Compile list of clients to process
145
for name in client_names:
146
for path, client in mandos_clients.iteritems():
147
if client['name'] == name:
148
client_objc = bus.get_object(busname, path)
149
clients.append(dbus.Interface(client_objc,
154
print >> sys.stderr, "Client not found on server: %r" % name
157
if not clients and mandos_clients.values():
158
keywords = defaultkeywords
160
keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
161
'created', 'interval', 'host', 'fingerprint',
162
'checker_running', 'last_enabled', 'checker')
163
print_clients(mandos_clients.values())
165
# Process each client in the list by all selected options
166
for client in clients:
168
mandos_serv.RemoveClient(client.__dbus_object_path__)
173
if options.bump_timeout:
175
if options.start_checker:
176
client.StartChecker()
177
if options.stop_checker:
180
sys.exit(0 if client.IsStillValid() else 1)
182
client.SetChecker(options.checker)
184
client.SetHost(options.host)
186
client.SetInterval(datetime_to_milliseconds
187
(string_to_delta(options.interval)))
189
client.SetTimeout(datetime_to_milliseconds
190
(string_to_delta(options.timeout)))
192
client.SetSecret(dbus.ByteArray(open(options.secret, 'rb').read()))