2
2
# -*- mode: python; coding: utf-8 -*-
4
from __future__ import division
4
# Mandos Monitor - Control and monitor the Mandos server
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
11
# the Free Software Foundation, either version 3 of the License, or
12
# (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
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
# GNU General Public License for more details.
19
# 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/>.
23
# Contact the authors at <mandos@recompile.se>.
26
from __future__ import (division, absolute_import, print_function,
30
from future_builtins import *
7
from optparse import OptionParser
12
locale.setlocale(locale.LC_ALL, u'')
46
if sys.version_info.major == 2:
49
locale.setlocale(locale.LC_ALL, "")
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))
55
"LastCheckedOK": "Last Successful Check",
56
"LastApprovalRequest": "Last Approval Request",
58
"Interval": "Interval",
60
"Fingerprint": "Fingerprint",
61
"CheckerRunning": "Check Is Running",
62
"LastEnabled": "Last Enabled",
63
"ApprovalPending": "Approval Is Pending",
64
"ApprovedByDefault": "Approved By Default",
65
"ApprovalDelay": "Approval Delay",
66
"ApprovalDuration": "Approval Duration",
68
"ExtendedTimeout": "Extended Timeout"
70
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
71
domain = "se.recompile"
72
busname = domain + ".Mandos"
74
server_interface = domain + ".Mandos"
75
client_interface = domain + ".Mandos.Client"
80
dbus.OBJECT_MANAGER_IFACE
81
except AttributeError:
82
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
47
84
def milliseconds_to_string(ms):
48
85
td = datetime.timedelta(0, 0, 0, ms)
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
86
return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
87
days = "{}T".format(td.days) if td.days else "",
88
hours = td.seconds // 3600,
89
minutes = (td.seconds % 3600) // 60,
90
seconds = td.seconds % 60))
93
def rfc3339_duration_to_delta(duration):
94
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
96
>>> rfc3339_duration_to_delta("P7D")
98
>>> rfc3339_duration_to_delta("PT60S")
99
datetime.timedelta(0, 60)
100
>>> rfc3339_duration_to_delta("PT60M")
101
datetime.timedelta(0, 3600)
102
>>> rfc3339_duration_to_delta("PT24H")
103
datetime.timedelta(1)
104
>>> rfc3339_duration_to_delta("P1W")
105
datetime.timedelta(7)
106
>>> rfc3339_duration_to_delta("PT5M30S")
107
datetime.timedelta(0, 330)
108
>>> rfc3339_duration_to_delta("P1DT3M20S")
109
datetime.timedelta(1, 200)
112
# Parsing an RFC 3339 duration with regular expressions is not
113
# possible - there would have to be multiple places for the same
114
# values, like seconds. The current code, while more esoteric, is
115
# cleaner without depending on a parsing library. If Python had a
116
# built-in library for parsing we would use it, but we'd like to
117
# avoid excessive use of external libraries.
119
# New type for defining tokens, syntax, and semantics all-in-one
120
Token = collections.namedtuple("Token", (
121
"regexp", # To match token; if "value" is not None, must have
122
# a "group" containing digits
123
"value", # datetime.timedelta or None
124
"followers")) # Tokens valid after this token
125
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
126
# the "duration" ABNF definition in RFC 3339, Appendix A.
127
token_end = Token(re.compile(r"$"), None, frozenset())
128
token_second = Token(re.compile(r"(\d+)S"),
129
datetime.timedelta(seconds=1),
130
frozenset((token_end, )))
131
token_minute = Token(re.compile(r"(\d+)M"),
132
datetime.timedelta(minutes=1),
133
frozenset((token_second, token_end)))
134
token_hour = Token(re.compile(r"(\d+)H"),
135
datetime.timedelta(hours=1),
136
frozenset((token_minute, token_end)))
137
token_time = Token(re.compile(r"T"),
139
frozenset((token_hour, token_minute,
141
token_day = Token(re.compile(r"(\d+)D"),
142
datetime.timedelta(days=1),
143
frozenset((token_time, token_end)))
144
token_month = Token(re.compile(r"(\d+)M"),
145
datetime.timedelta(weeks=4),
146
frozenset((token_day, token_end)))
147
token_year = Token(re.compile(r"(\d+)Y"),
148
datetime.timedelta(weeks=52),
149
frozenset((token_month, token_end)))
150
token_week = Token(re.compile(r"(\d+)W"),
151
datetime.timedelta(weeks=1),
152
frozenset((token_end, )))
153
token_duration = Token(re.compile(r"P"), None,
154
frozenset((token_year, token_month,
155
token_day, token_time,
157
# Define starting values
158
value = datetime.timedelta() # Value so far
160
followers = frozenset((token_duration, )) # Following valid tokens
161
s = duration # String left to parse
162
# Loop until end token is found
163
while found_token is not token_end:
164
# Search for any currently valid tokens
165
for token in followers:
166
match = token.regexp.match(s)
167
if match is not None:
169
if token.value is not None:
170
# Value found, parse digits
171
factor = int(match.group(1), 10)
172
# Add to value so far
173
value += factor * token.value
174
# Strip token from string
175
s = token.regexp.sub("", s, 1)
178
# Set valid next tokens
179
followers = found_token.followers
182
# No currently valid tokens were found
183
raise ValueError("Invalid RFC 3339 duration: {!r}"
55
189
def string_to_delta(interval):
56
190
"""Parse a string and return a datetime.timedelta
58
192
>>> string_to_delta('7d')
59
193
datetime.timedelta(7)
60
194
>>> string_to_delta('60s')
63
197
datetime.timedelta(0, 3600)
64
198
>>> string_to_delta('24h')
65
199
datetime.timedelta(1)
66
>>> string_to_delta(u'1w')
200
>>> string_to_delta('1w')
67
201
datetime.timedelta(7)
68
202
>>> string_to_delta('5m 30s')
69
203
datetime.timedelta(0, 330)
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):
207
return rfc3339_duration_to_delta(interval)
211
value = datetime.timedelta(0)
212
regexp = re.compile(r"(\d+)([dsmhw]?)")
214
for num, suffix in regexp.findall(interval):
216
value += datetime.timedelta(int(num))
218
value += datetime.timedelta(0, int(num))
220
value += datetime.timedelta(0, 0, 0, 0, int(num))
222
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
224
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
226
value += datetime.timedelta(0, 0, 0, int(num))
230
def print_clients(clients, keywords):
96
231
def valuetostring(value, keyword):
97
232
if type(value) is dbus.Boolean:
98
return u"Yes" if value else u"No"
99
if keyword in ("timeout", "interval"):
233
return "Yes" if value else "No"
234
if keyword in ("Timeout", "Interval", "ApprovalDelay",
235
"ApprovalDuration", "ExtendedTimeout"):
100
236
return milliseconds_to_string(value)
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)
239
# Create format string to print table rows
240
format_string = " ".join("{{{key}:{width}}}".format(
241
width = max(len(tablewords[key]),
242
max(len(valuetostring(client[key], key))
243
for client in clients)),
247
print(format_string.format(**tablewords))
110
248
for client in clients:
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 specified client")
119
parser.add_option("-d", "--disable", action="store_true",
120
help="disable specified client")
121
parser.add_option("-b", "--bump-timeout", action="store_true",
122
help="Bump timeout of specified client")
123
parser.add_option("--start-checker", action="store_true",
124
help="Start checker for specified client")
125
parser.add_option("--stop-checker", action="store_true",
126
help="Stop checker for specified client")
127
parser.add_option("-v", "--is-valid", action="store_true",
128
help="Stop checker for specified client")
129
parser.add_option("-c", "--checker", type="string",
130
help="Set checker command for specified client")
131
parser.add_option("-t", "--timeout", type="string",
132
help="Set timeout for specified client")
133
parser.add_option("-i", "--interval", type="string",
134
help="Set checker interval for specified client")
135
parser.add_option("-H", "--host", type="string",
136
help="Set host for specified client")
137
parser.add_option("-s", "--secret", type="string",
138
help="Set password blob (file) for specified client")
139
options, client_names = parser.parse_args()
142
for name in client_names:
143
for path, client in mandos_clients.iteritems():
144
if client['name'] == name:
145
client_objc = bus.get_object(busname, path)
146
clients.append(dbus.Interface(client_objc,
151
print >> sys.stderr, "Client not found on server: %r" % name
155
keywords = defaultkeywords
157
keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
158
'created', 'interval', 'host', 'fingerprint',
159
'checker_running', 'last_enabled', 'checker')
160
print_clients(mandos_clients.values())
162
for client in clients:
167
if options.bump_timeout:
169
if options.start_checker:
170
client.StartChecker()
171
if options.stop_checker:
174
sys.exit(0 if client.IsStillValid() else 1)
176
client.SetChecker(options.checker)
178
client.SetHost(options.host)
180
client.SetInterval(datetime_to_milliseconds
181
(string_to_delta(options.interval)))
183
client.SetTimeout(datetime_to_milliseconds
184
(string_to_delta(options.timeout)))
186
client.SetSecret(dbus.ByteArray(open(options.secret, 'rb').read()))
249
print(format_string.format(**{
250
key: valuetostring(client[key], key)
251
for key in keywords }))
254
def has_actions(options):
255
return any((options.enable,
257
options.bump_timeout,
258
options.start_checker,
259
options.stop_checker,
262
options.checker is not None,
263
options.timeout is not None,
264
options.extended_timeout is not None,
265
options.interval is not None,
266
options.approved_by_default is not None,
267
options.approval_delay is not None,
268
options.approval_duration is not None,
269
options.host is not None,
270
options.secret is not None,
276
parser = argparse.ArgumentParser()
277
parser.add_argument("--version", action="version",
278
version = "%(prog)s {}".format(version),
279
help="show version number and exit")
280
parser.add_argument("-a", "--all", action="store_true",
281
help="Select all clients")
282
parser.add_argument("-v", "--verbose", action="store_true",
283
help="Print all fields")
284
parser.add_argument("-j", "--dump-json", action="store_true",
285
help="Dump client data in JSON format")
286
parser.add_argument("-e", "--enable", action="store_true",
287
help="Enable client")
288
parser.add_argument("-d", "--disable", action="store_true",
289
help="disable client")
290
parser.add_argument("-b", "--bump-timeout", action="store_true",
291
help="Bump timeout for client")
292
parser.add_argument("--start-checker", action="store_true",
293
help="Start checker for client")
294
parser.add_argument("--stop-checker", action="store_true",
295
help="Stop checker for client")
296
parser.add_argument("-V", "--is-enabled", action="store_true",
297
help="Check if client is enabled")
298
parser.add_argument("-r", "--remove", action="store_true",
299
help="Remove client")
300
parser.add_argument("-c", "--checker",
301
help="Set checker command for client")
302
parser.add_argument("-t", "--timeout",
303
help="Set timeout for client")
304
parser.add_argument("--extended-timeout",
305
help="Set extended timeout for client")
306
parser.add_argument("-i", "--interval",
307
help="Set checker interval for client")
308
parser.add_argument("--approve-by-default", action="store_true",
309
default=None, dest="approved_by_default",
310
help="Set client to be approved by default")
311
parser.add_argument("--deny-by-default", action="store_false",
312
dest="approved_by_default",
313
help="Set client to be denied by default")
314
parser.add_argument("--approval-delay",
315
help="Set delay before client approve/deny")
316
parser.add_argument("--approval-duration",
317
help="Set duration of one client approval")
318
parser.add_argument("-H", "--host", help="Set host for client")
319
parser.add_argument("-s", "--secret",
320
type=argparse.FileType(mode="rb"),
321
help="Set password blob (file) for client")
322
parser.add_argument("-A", "--approve", action="store_true",
323
help="Approve any current client request")
324
parser.add_argument("-D", "--deny", action="store_true",
325
help="Deny any current client request")
326
parser.add_argument("--check", action="store_true",
327
help="Run self-test")
328
parser.add_argument("client", nargs="*", help="Client name")
329
options = parser.parse_args()
331
if has_actions(options) and not (options.client or options.all):
332
parser.error("Options require clients names or --all.")
333
if options.verbose and has_actions(options):
334
parser.error("--verbose can only be used alone.")
335
if options.dump_json and (options.verbose or has_actions(options)):
336
parser.error("--dump-json can only be used alone.")
337
if options.all and not has_actions(options):
338
parser.error("--all requires an action.")
341
fail_count, test_count = doctest.testmod()
342
sys.exit(os.EX_OK if fail_count == 0 else 1)
345
bus = dbus.SystemBus()
346
mandos_dbus_objc = bus.get_object(busname, server_path)
347
except dbus.exceptions.DBusException:
348
print("Could not connect to Mandos server", file=sys.stderr)
351
mandos_serv = dbus.Interface(mandos_dbus_objc,
352
dbus_interface = server_interface)
353
mandos_serv_object_manager = dbus.Interface(
354
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
356
#block stderr since dbus library prints to stderr
357
null = os.open(os.path.devnull, os.O_RDWR)
358
stderrcopy = os.dup(sys.stderr.fileno())
359
os.dup2(null, sys.stderr.fileno())
363
mandos_clients = { path: ifs_and_props[client_interface]
364
for path, ifs_and_props in
365
mandos_serv_object_manager
366
.GetManagedObjects().items()
367
if client_interface in ifs_and_props }
370
os.dup2(stderrcopy, sys.stderr.fileno())
372
except dbus.exceptions.DBusException as e:
373
print("Access denied: Accessing mandos server through D-Bus: {}"
374
.format(e), file=sys.stderr)
377
# Compile dict of (clients: properties) to process
380
if options.all or not options.client:
381
clients = { bus.get_object(busname, path): properties
382
for path, properties in mandos_clients.items() }
384
for name in options.client:
385
for path, client in mandos_clients.items():
386
if client["Name"] == name:
387
client_objc = bus.get_object(busname, path)
388
clients[client_objc] = client
391
print("Client not found on server: {!r}"
392
.format(name), file=sys.stderr)
395
if not has_actions(options) and clients:
396
if options.verbose or options.dump_json:
397
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
398
"Created", "Interval", "Host", "Fingerprint",
399
"CheckerRunning", "LastEnabled",
400
"ApprovalPending", "ApprovedByDefault",
401
"LastApprovalRequest", "ApprovalDelay",
402
"ApprovalDuration", "Checker",
405
keywords = defaultkeywords
407
if options.dump_json:
408
json.dump({client["Name"]: {key: client[key]
409
for key in keywords }
410
for client in clients.values() },
411
fp = sys.stdout, indent = 4,
412
separators = (',', ': '))
415
print_clients(clients.values(), keywords)
417
# Process each client in the list by all selected options
418
for client in clients:
420
def set_client_prop(prop, value):
421
"""Set a Client D-Bus property"""
422
client.Set(client_interface, prop, value,
423
dbus_interface=dbus.PROPERTIES_IFACE)
425
def set_client_prop_ms(prop, value):
426
"""Set a Client D-Bus property, converted
427
from a string to milliseconds."""
428
set_client_prop(prop,
429
string_to_delta(value).total_seconds()
433
mandos_serv.RemoveClient(client.__dbus_object_path__)
435
set_client_prop("Enabled", dbus.Boolean(True))
437
set_client_prop("Enabled", dbus.Boolean(False))
438
if options.bump_timeout:
439
set_client_prop("LastCheckedOK", "")
440
if options.start_checker:
441
set_client_prop("CheckerRunning", dbus.Boolean(True))
442
if options.stop_checker:
443
set_client_prop("CheckerRunning", dbus.Boolean(False))
444
if options.is_enabled:
445
sys.exit(0 if client.Get(client_interface,
448
dbus.PROPERTIES_IFACE)
450
if options.checker is not None:
451
set_client_prop("Checker", options.checker)
452
if options.host is not None:
453
set_client_prop("Host", options.host)
454
if options.interval is not None:
455
set_client_prop_ms("Interval", options.interval)
456
if options.approval_delay is not None:
457
set_client_prop_ms("ApprovalDelay",
458
options.approval_delay)
459
if options.approval_duration is not None:
460
set_client_prop_ms("ApprovalDuration",
461
options.approval_duration)
462
if options.timeout is not None:
463
set_client_prop_ms("Timeout", options.timeout)
464
if options.extended_timeout is not None:
465
set_client_prop_ms("ExtendedTimeout",
466
options.extended_timeout)
467
if options.secret is not None:
468
set_client_prop("Secret",
469
dbus.ByteArray(options.secret.read()))
470
if options.approved_by_default is not None:
471
set_client_prop("ApprovedByDefault",
473
.approved_by_default))
475
client.Approve(dbus.Boolean(True),
476
dbus_interface=client_interface)
478
client.Approve(dbus.Boolean(False),
479
dbus_interface=client_interface)
482
if __name__ == "__main__":