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
13
locale.setlocale(locale.LC_ALL, u'')
46
if sys.version_info.major == 2:
49
locale.setlocale(locale.LC_ALL, "")
17
'Enabled': u'Enabled',
18
'Timeout': u'Timeout',
19
'LastCheckedOK': u'Last Successful Check',
20
'Created': u'Created',
21
'Interval': u'Interval',
23
'Fingerprint': u'Fingerprint',
24
'CheckerRunning': u'Check Is Running',
25
'LastEnabled': u'Last Enabled',
26
'Checker': u'Checker',
28
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
29
domain = 'se.bsnet.fukt'
30
busname = domain + '.Mandos'
32
server_interface = domain + '.Mandos'
33
client_interface = domain + '.Mandos.Client'
36
def timedelta_to_milliseconds(td):
37
"Convert a datetime.timedelta object to milliseconds"
38
return ((td.days * 24 * 60 * 60 * 1000)
40
+ (td.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"
42
84
def milliseconds_to_string(ms):
43
85
td = datetime.timedelta(0, 0, 0, ms)
44
return (u"%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
45
% { "days": "%dT" % td.days if td.days else "",
46
"hours": td.seconds // 3600,
47
"minutes": (td.seconds % 3600) // 60,
48
"seconds": td.seconds % 60,
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}"
52
189
def string_to_delta(interval):
53
190
"""Parse a string and return a datetime.timedelta
55
192
>>> string_to_delta('7d')
56
193
datetime.timedelta(7)
57
194
>>> string_to_delta('60s')
60
197
datetime.timedelta(0, 3600)
61
198
>>> string_to_delta('24h')
62
199
datetime.timedelta(1)
63
>>> string_to_delta(u'1w')
200
>>> string_to_delta('1w')
64
201
datetime.timedelta(7)
65
202
>>> string_to_delta('5m 30s')
66
203
datetime.timedelta(0, 330)
68
timevalue = datetime.timedelta(0)
69
regexp = re.compile("\d+[dsmhw]")
71
for s in regexp.findall(interval):
73
suffix = unicode(s[-1])
76
delta = datetime.timedelta(value)
78
delta = datetime.timedelta(0, value)
80
delta = datetime.timedelta(0, 0, 0, 0, value)
82
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
84
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
87
except (ValueError, IndexError):
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))
92
230
def print_clients(clients, keywords):
93
231
def valuetostring(value, keyword):
94
232
if type(value) is dbus.Boolean:
95
return u"Yes" if value else u"No"
96
if keyword in (u"Timeout", u"Interval"):
233
return "Yes" if value else "No"
234
if keyword in ("Timeout", "Interval", "ApprovalDelay",
235
"ApprovalDuration", "ExtendedTimeout"):
97
236
return milliseconds_to_string(value)
100
239
# Create format string to print table rows
101
format_string = u' '.join(u'%%-%ds' %
102
max(len(tablewords[key]),
103
max(len(valuetostring(client[key],
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)),
108
246
# Print header line
109
print format_string % tuple(tablewords[key] for key in keywords)
247
print(format_string.format(**tablewords))
110
248
for client in clients:
111
print format_string % tuple(valuetostring(client[key], key)
249
print(format_string.format(**{
250
key: valuetostring(client[key], key)
251
for key in keywords }))
114
254
def has_actions(options):
115
255
return any((options.enable,
122
262
options.checker is not None,
123
263
options.timeout is not None,
264
options.extended_timeout is not None,
124
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,
125
269
options.host is not None,
126
270
options.secret is not None,
131
parser = OptionParser(version = "%%prog %s" % version)
132
parser.add_option("-a", "--all", action="store_true",
133
help="Select all clients")
134
parser.add_option("-v", "--verbose", action="store_true",
135
help="Print all fields")
136
parser.add_option("-e", "--enable", action="store_true",
137
help="Enable client")
138
parser.add_option("-d", "--disable", action="store_true",
139
help="disable client")
140
parser.add_option("-b", "--bump-timeout", action="store_true",
141
help="Bump timeout for client")
142
parser.add_option("--start-checker", action="store_true",
143
help="Start checker for client")
144
parser.add_option("--stop-checker", action="store_true",
145
help="Stop checker for client")
146
parser.add_option("-V", "--is-enabled", action="store_true",
147
help="Check if client is enabled")
148
parser.add_option("-r", "--remove", action="store_true",
149
help="Remove client")
150
parser.add_option("-c", "--checker", type="string",
151
help="Set checker command for client")
152
parser.add_option("-t", "--timeout", type="string",
153
help="Set timeout for client")
154
parser.add_option("-i", "--interval", type="string",
155
help="Set checker interval for client")
156
parser.add_option("-H", "--host", type="string",
157
help="Set host for client")
158
parser.add_option("-s", "--secret", type="string",
159
help="Set password blob (file) for client")
160
parser.add_option("-A", "--approve", action="store_true",
161
help="Approve any current client request")
162
parser.add_option("-D", "--deny", action="store_true",
163
help="Deny any current client request")
164
options, client_names = parser.parse_args()
166
if has_actions(options) and not client_names and not options.all:
167
parser.error('Options requires clients names or --all.')
168
if options.verbose and has_actions(options):
169
parser.error('Verbose option can only be used alone or with --all.')
170
if options.all and not has_actions(options):
171
parser.error('--all requires an action')
174
bus = dbus.SystemBus()
175
mandos_dbus_objc = bus.get_object(busname, server_path)
176
except dbus.exceptions.DBusException:
177
print >> sys.stderr, "Could not connect to Mandos server"
180
mandos_serv = dbus.Interface(mandos_dbus_objc,
181
dbus_interface = server_interface)
183
#block stderr since dbus library prints to stderr
184
null = os.open(os.path.devnull, os.O_RDWR)
185
stderrcopy = os.dup(sys.stderr.fileno())
186
os.dup2(null, sys.stderr.fileno())
190
mandos_clients = mandos_serv.GetAllClientsWithProperties()
193
os.dup2(stderrcopy, sys.stderr.fileno())
195
except dbus.exceptions.DBusException, e:
196
print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
199
# Compile dict of (clients: properties) to process
202
if options.all or not client_names:
203
clients = dict((bus.get_object(busname, path), properties)
204
for path, properties in
205
mandos_clients.iteritems())
207
for name in client_names:
208
for path, client in mandos_clients.iteritems():
209
if client['Name'] == name:
210
client_objc = bus.get_object(busname, path)
211
clients[client_objc] = client
214
print >> sys.stderr, "Client not found on server: %r" % name
217
if not has_actions(options) and clients:
219
keywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK',
220
'Created', 'Interval', 'Host', 'Fingerprint',
221
'CheckerRunning', 'LastEnabled', 'Checker')
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
223
keywords = defaultkeywords
225
print_clients(clients.values(), keywords)
227
# Process each client in the list by all selected options
228
for client in clients:
230
mandos_serv.RemoveClient(client.__dbus_object_path__)
232
client.Enable(dbus_interface=client_interface)
234
client.Disable(dbus_interface=client_interface)
235
if options.bump_timeout:
236
client.CheckedOK(dbus_interface=client_interface)
237
if options.start_checker:
238
client.StartChecker(dbus_interface=client_interface)
239
if options.stop_checker:
240
client.StopChecker(dbus_interface=client_interface)
241
if options.is_enabled:
242
sys.exit(0 if client.Get(client_interface,
244
dbus_interface=dbus.PROPERTIES_IFACE)
247
client.Set(client_interface, u"Checker", options.checker,
248
dbus_interface=dbus.PROPERTIES_IFACE)
250
client.Set(client_interface, u"Host", options.host,
251
dbus_interface=dbus.PROPERTIES_IFACE)
253
client.Set(client_interface, u"Interval",
254
timedelta_to_milliseconds
255
(string_to_delta(options.interval)),
256
dbus_interface=dbus.PROPERTIES_IFACE)
258
client.Set(client_interface, u"Timeout",
259
timedelta_to_milliseconds(string_to_delta
261
dbus_interface=dbus.PROPERTIES_IFACE)
263
client.Set(client_interface, u"Secret",
264
dbus.ByteArray(open(options.secret, u'rb').read()),
265
dbus_interface=dbus.PROPERTIES_IFACE)
267
client.Approve(dbus.Boolean(True), dbus_interface=client_interface)
269
client.Approve(dbus.Boolean(False), dbus_interface=client_interface)
271
if __name__ == '__main__':
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:
410
if isinstance(client[key],
413
for key in keywords }
414
for client in clients.values() },
415
fp = sys.stdout, indent = 4,
416
separators = (',', ': '))
419
print_clients(clients.values(), keywords)
421
# Process each client in the list by all selected options
422
for client in clients:
424
def set_client_prop(prop, value):
425
"""Set a Client D-Bus property"""
426
client.Set(client_interface, prop, value,
427
dbus_interface=dbus.PROPERTIES_IFACE)
429
def set_client_prop_ms(prop, value):
430
"""Set a Client D-Bus property, converted
431
from a string to milliseconds."""
432
set_client_prop(prop,
433
string_to_delta(value).total_seconds()
437
mandos_serv.RemoveClient(client.__dbus_object_path__)
439
set_client_prop("Enabled", dbus.Boolean(True))
441
set_client_prop("Enabled", dbus.Boolean(False))
442
if options.bump_timeout:
443
set_client_prop("LastCheckedOK", "")
444
if options.start_checker:
445
set_client_prop("CheckerRunning", dbus.Boolean(True))
446
if options.stop_checker:
447
set_client_prop("CheckerRunning", dbus.Boolean(False))
448
if options.is_enabled:
449
sys.exit(0 if client.Get(client_interface,
452
dbus.PROPERTIES_IFACE)
454
if options.checker is not None:
455
set_client_prop("Checker", options.checker)
456
if options.host is not None:
457
set_client_prop("Host", options.host)
458
if options.interval is not None:
459
set_client_prop_ms("Interval", options.interval)
460
if options.approval_delay is not None:
461
set_client_prop_ms("ApprovalDelay",
462
options.approval_delay)
463
if options.approval_duration is not None:
464
set_client_prop_ms("ApprovalDuration",
465
options.approval_duration)
466
if options.timeout is not None:
467
set_client_prop_ms("Timeout", options.timeout)
468
if options.extended_timeout is not None:
469
set_client_prop_ms("ExtendedTimeout",
470
options.extended_timeout)
471
if options.secret is not None:
472
set_client_prop("Secret",
473
dbus.ByteArray(options.secret.read()))
474
if options.approved_by_default is not None:
475
set_client_prop("ApprovedByDefault",
477
.approved_by_default))
479
client.Approve(dbus.Boolean(True),
480
dbus_interface=client_interface)
482
client.Approve(dbus.Boolean(False),
483
dbus_interface=client_interface)
486
if __name__ == "__main__":