2
2
# -*- mode: python; coding: utf-8 -*-
4
from __future__ import division
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2008-2015 Teddy Hogeborn
7
# Copyright © 2008-2015 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'')
45
if sys.version_info.major == 2:
48
locale.setlocale(locale.LC_ALL, "")
17
'enabled': u'Enabled',
18
'timeout': u'Timeout',
19
'last_checked_ok': u'Last Successful Check',
20
'created': u'Created',
21
'interval': u'Interval',
23
'fingerprint': u'Fingerprint',
24
'checker_running': u'Check Is Running',
25
'last_enabled': u'Last Enabled',
26
'checker': u'Checker',
28
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok')
29
domain = 'se.bsnet.fukt'
30
busname = domain + '.Mandos'
32
server_interface = domain + '.Mandos'
33
client_interface = domain + '.Mandos.Client'
54
"LastCheckedOK": "Last Successful Check",
55
"LastApprovalRequest": "Last Approval Request",
57
"Interval": "Interval",
59
"Fingerprint": "Fingerprint",
60
"CheckerRunning": "Check Is Running",
61
"LastEnabled": "Last Enabled",
62
"ApprovalPending": "Approval Is Pending",
63
"ApprovedByDefault": "Approved By Default",
64
"ApprovalDelay": "Approval Delay",
65
"ApprovalDuration": "Approval Duration",
67
"ExtendedTimeout": "Extended Timeout"
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
domain = "se.recompile"
71
busname = domain + ".Mandos"
73
server_interface = domain + ".Mandos"
74
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))
42
78
def milliseconds_to_string(ms):
43
79
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,
80
return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
81
days = "{}T".format(td.days) if td.days else "",
82
hours = td.seconds // 3600,
83
minutes = (td.seconds % 3600) // 60,
84
seconds = td.seconds % 60))
87
def rfc3339_duration_to_delta(duration):
88
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
90
>>> rfc3339_duration_to_delta("P7D")
92
>>> rfc3339_duration_to_delta("PT60S")
93
datetime.timedelta(0, 60)
94
>>> rfc3339_duration_to_delta("PT60M")
95
datetime.timedelta(0, 3600)
96
>>> rfc3339_duration_to_delta("PT24H")
98
>>> rfc3339_duration_to_delta("P1W")
100
>>> rfc3339_duration_to_delta("PT5M30S")
101
datetime.timedelta(0, 330)
102
>>> rfc3339_duration_to_delta("P1DT3M20S")
103
datetime.timedelta(1, 200)
106
# Parsing an RFC 3339 duration with regular expressions is not
107
# possible - there would have to be multiple places for the same
108
# values, like seconds. The current code, while more esoteric, is
109
# cleaner without depending on a parsing library. If Python had a
110
# built-in library for parsing we would use it, but we'd like to
111
# avoid excessive use of external libraries.
113
# New type for defining tokens, syntax, and semantics all-in-one
114
Token = collections.namedtuple("Token", (
115
"regexp", # To match token; if "value" is not None, must have
116
# a "group" containing digits
117
"value", # datetime.timedelta or None
118
"followers")) # Tokens valid after this token
119
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
120
# the "duration" ABNF definition in RFC 3339, Appendix A.
121
token_end = Token(re.compile(r"$"), None, frozenset())
122
token_second = Token(re.compile(r"(\d+)S"),
123
datetime.timedelta(seconds=1),
124
frozenset((token_end, )))
125
token_minute = Token(re.compile(r"(\d+)M"),
126
datetime.timedelta(minutes=1),
127
frozenset((token_second, token_end)))
128
token_hour = Token(re.compile(r"(\d+)H"),
129
datetime.timedelta(hours=1),
130
frozenset((token_minute, token_end)))
131
token_time = Token(re.compile(r"T"),
133
frozenset((token_hour, token_minute,
135
token_day = Token(re.compile(r"(\d+)D"),
136
datetime.timedelta(days=1),
137
frozenset((token_time, token_end)))
138
token_month = Token(re.compile(r"(\d+)M"),
139
datetime.timedelta(weeks=4),
140
frozenset((token_day, token_end)))
141
token_year = Token(re.compile(r"(\d+)Y"),
142
datetime.timedelta(weeks=52),
143
frozenset((token_month, token_end)))
144
token_week = Token(re.compile(r"(\d+)W"),
145
datetime.timedelta(weeks=1),
146
frozenset((token_end, )))
147
token_duration = Token(re.compile(r"P"), None,
148
frozenset((token_year, token_month,
149
token_day, token_time,
151
# Define starting values
152
value = datetime.timedelta() # Value so far
154
followers = frozenset((token_duration, )) # Following valid tokens
155
s = duration # String left to parse
156
# Loop until end token is found
157
while found_token is not token_end:
158
# Search for any currently valid tokens
159
for token in followers:
160
match = token.regexp.match(s)
161
if match is not None:
163
if token.value is not None:
164
# Value found, parse digits
165
factor = int(match.group(1), 10)
166
# Add to value so far
167
value += factor * token.value
168
# Strip token from string
169
s = token.regexp.sub("", s, 1)
172
# Set valid next tokens
173
followers = found_token.followers
176
# No currently valid tokens were found
177
raise ValueError("Invalid RFC 3339 duration: {!r}"
52
183
def string_to_delta(interval):
53
184
"""Parse a string and return a datetime.timedelta
55
186
>>> string_to_delta('7d')
56
187
datetime.timedelta(7)
57
188
>>> string_to_delta('60s')
60
191
datetime.timedelta(0, 3600)
61
192
>>> string_to_delta('24h')
62
193
datetime.timedelta(1)
63
>>> string_to_delta(u'1w')
194
>>> string_to_delta('1w')
64
195
datetime.timedelta(7)
65
196
>>> string_to_delta('5m 30s')
66
197
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):
201
return rfc3339_duration_to_delta(interval)
205
value = datetime.timedelta(0)
206
regexp = re.compile(r"(\d+)([dsmhw]?)")
208
for num, suffix in regexp.findall(interval):
210
value += datetime.timedelta(int(num))
212
value += datetime.timedelta(0, int(num))
214
value += datetime.timedelta(0, 0, 0, 0, int(num))
216
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
218
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
220
value += datetime.timedelta(0, 0, 0, int(num))
92
224
def print_clients(clients, keywords):
93
225
def valuetostring(value, keyword):
94
226
if type(value) is dbus.Boolean:
95
return u"Yes" if value else u"No"
96
if keyword in (u"timeout", u"interval"):
227
return "Yes" if value else "No"
228
if keyword in ("Timeout", "Interval", "ApprovalDelay",
229
"ApprovalDuration", "ExtendedTimeout"):
97
230
return milliseconds_to_string(value)
100
233
# 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], key))
234
format_string = " ".join("{{{key}:{width}}}".format(
235
width = max(len(tablewords[key]),
236
max(len(valuetostring(client[key], key))
237
for client in clients)),
107
240
# Print header line
108
print format_string % tuple(tablewords[key] for key in keywords)
241
print(format_string.format(**tablewords))
109
242
for client in clients:
110
print format_string % tuple(valuetostring(client[key], key)
243
print(format_string.format(**{
244
key: valuetostring(client[key], key)
245
for key in keywords }))
112
248
def has_actions(options):
113
249
return any((options.enable,
120
256
options.checker is not None,
121
257
options.timeout is not None,
258
options.extended_timeout is not None,
122
259
options.interval is not None,
260
options.approved_by_default is not None,
261
options.approval_delay is not None,
262
options.approval_duration is not None,
123
263
options.host is not None,
124
264
options.secret is not None,
270
parser = argparse.ArgumentParser()
271
parser.add_argument("--version", action="version",
272
version = "%(prog)s {}".format(version),
273
help="show version number and exit")
274
parser.add_argument("-a", "--all", action="store_true",
275
help="Select all clients")
276
parser.add_argument("-v", "--verbose", action="store_true",
277
help="Print all fields")
278
parser.add_argument("-e", "--enable", action="store_true",
279
help="Enable client")
280
parser.add_argument("-d", "--disable", action="store_true",
281
help="disable client")
282
parser.add_argument("-b", "--bump-timeout", action="store_true",
283
help="Bump timeout for client")
284
parser.add_argument("--start-checker", action="store_true",
285
help="Start checker for client")
286
parser.add_argument("--stop-checker", action="store_true",
287
help="Stop checker for client")
288
parser.add_argument("-V", "--is-enabled", action="store_true",
289
help="Check if client is enabled")
290
parser.add_argument("-r", "--remove", action="store_true",
291
help="Remove client")
292
parser.add_argument("-c", "--checker",
293
help="Set checker command for client")
294
parser.add_argument("-t", "--timeout",
295
help="Set timeout for client")
296
parser.add_argument("--extended-timeout",
297
help="Set extended timeout for client")
298
parser.add_argument("-i", "--interval",
299
help="Set checker interval for client")
300
parser.add_argument("--approve-by-default", action="store_true",
301
default=None, dest="approved_by_default",
302
help="Set client to be approved by default")
303
parser.add_argument("--deny-by-default", action="store_false",
304
dest="approved_by_default",
305
help="Set client to be denied by default")
306
parser.add_argument("--approval-delay",
307
help="Set delay before client approve/deny")
308
parser.add_argument("--approval-duration",
309
help="Set duration of one client approval")
310
parser.add_argument("-H", "--host", help="Set host for client")
311
parser.add_argument("-s", "--secret",
312
type=argparse.FileType(mode="rb"),
313
help="Set password blob (file) for client")
314
parser.add_argument("-A", "--approve", action="store_true",
315
help="Approve any current client request")
316
parser.add_argument("-D", "--deny", action="store_true",
317
help="Deny any current client request")
318
parser.add_argument("--check", action="store_true",
319
help="Run self-test")
320
parser.add_argument("client", nargs="*", help="Client name")
321
options = parser.parse_args()
323
if has_actions(options) and not (options.client or options.all):
324
parser.error("Options require clients names or --all.")
325
if options.verbose and has_actions(options):
326
parser.error("--verbose can only be used alone or with"
328
if options.all and not has_actions(options):
329
parser.error("--all requires an action.")
332
fail_count, test_count = doctest.testmod()
333
sys.exit(os.EX_OK if fail_count == 0 else 1)
336
bus = dbus.SystemBus()
337
mandos_dbus_objc = bus.get_object(busname, server_path)
338
except dbus.exceptions.DBusException:
339
print("Could not connect to Mandos server", file=sys.stderr)
342
mandos_serv = dbus.Interface(mandos_dbus_objc,
343
dbus_interface = server_interface)
345
#block stderr since dbus library prints to stderr
346
null = os.open(os.path.devnull, os.O_RDWR)
347
stderrcopy = os.dup(sys.stderr.fileno())
348
os.dup2(null, sys.stderr.fileno())
352
mandos_clients = mandos_serv.GetAllClientsWithProperties()
355
os.dup2(stderrcopy, sys.stderr.fileno())
357
except dbus.exceptions.DBusException:
358
print("Access denied: Accessing mandos server through dbus.",
362
# Compile dict of (clients: properties) to process
365
if options.all or not options.client:
366
clients = { bus.get_object(busname, path): properties
367
for path, properties in mandos_clients.items() }
369
for name in options.client:
370
for path, client in mandos_clients.items():
371
if client["Name"] == name:
372
client_objc = bus.get_object(busname, path)
373
clients[client_objc] = client
376
print("Client not found on server: {!r}"
377
.format(name), file=sys.stderr)
380
if not has_actions(options) and clients:
382
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
383
"Created", "Interval", "Host", "Fingerprint",
384
"CheckerRunning", "LastEnabled",
385
"ApprovalPending", "ApprovedByDefault",
386
"LastApprovalRequest", "ApprovalDelay",
387
"ApprovalDuration", "Checker",
390
keywords = defaultkeywords
129
parser = OptionParser(version = "%%prog %s" % version)
130
parser.add_option("-a", "--all", action="store_true",
131
help="Select all clients")
132
parser.add_option("-v", "--verbose", action="store_true",
133
help="Print all fields")
134
parser.add_option("-e", "--enable", action="store_true",
135
help="Enable client")
136
parser.add_option("-d", "--disable", action="store_true",
137
help="disable client")
138
parser.add_option("-b", "--bump-timeout", action="store_true",
139
help="Bump timeout for client")
140
parser.add_option("--start-checker", action="store_true",
141
help="Start checker for client")
142
parser.add_option("--stop-checker", action="store_true",
143
help="Stop checker for client")
144
parser.add_option("-V", "--is-enabled", action="store_true",
145
help="Check if client is enabled")
146
parser.add_option("-r", "--remove", action="store_true",
147
help="Remove client")
148
parser.add_option("-c", "--checker", type="string",
149
help="Set checker command for client")
150
parser.add_option("-t", "--timeout", type="string",
151
help="Set timeout for client")
152
parser.add_option("-i", "--interval", type="string",
153
help="Set checker interval for client")
154
parser.add_option("-H", "--host", type="string",
155
help="Set host for client")
156
parser.add_option("-s", "--secret", type="string",
157
help="Set password blob (file) for client")
158
parser.add_option("-A", "--approve", action="store_true",
159
help="Approve any current client request")
160
parser.add_option("-D", "--deny", action="store_true",
161
help="Deny any current client request")
162
options, client_names = parser.parse_args()
164
if has_actions(options) and not client_names and not options.all:
165
parser.error('Options requires clients names or --all.')
166
if options.verbose and has_actions(options):
167
parser.error('Verbose option can only be used alone or with --all.')
168
if options.all and not has_actions(options):
169
parser.error('--all requires an action')
172
bus = dbus.SystemBus()
173
mandos_dbus_objc = bus.get_object(busname, server_path)
174
except dbus.exceptions.DBusException:
175
print >> sys.stderr, "Could not connect to Mandos server"
178
mandos_serv = dbus.Interface(mandos_dbus_objc,
179
dbus_interface = server_interface)
181
#block stderr since dbus library prints to stderr
182
null = os.open(os.path.devnull, os.O_RDWR)
183
stderrcopy = os.dup(sys.stderr.fileno())
184
os.dup2(null, sys.stderr.fileno())
188
mandos_clients = mandos_serv.GetAllClientsWithProperties()
191
os.dup2(stderrcopy, sys.stderr.fileno())
193
except dbus.exceptions.DBusException, e:
194
print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
197
# Compile list of clients to process
200
if options.all or not client_names:
201
clients = (bus.get_object(busname, path) for path in mandos_clients.iterkeys())
203
for name in client_names:
204
for path, client in mandos_clients.iteritems():
205
if client['name'] == name:
206
client_objc = bus.get_object(busname, path)
207
clients.append(client_objc)
210
print >> sys.stderr, "Client not found on server: %r" % name
213
if not has_actions(options) and clients:
215
keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
216
'created', 'interval', 'host', 'fingerprint',
217
'checker_running', 'last_enabled', 'checker')
219
keywords = defaultkeywords
221
print_clients(mandos_clients.values(), keywords)
223
# Process each client in the list by all selected options
224
for client in clients:
226
mandos_serv.RemoveClient(client.__dbus_object_path__)
228
client.Enable(dbus_interface=client_interface)
230
client.Disable(dbus_interface=client_interface)
231
if options.bump_timeout:
232
client.CheckedOK(dbus_interface=client_interface)
233
if options.start_checker:
234
client.StartChecker(dbus_interface=client_interface)
235
if options.stop_checker:
236
client.StopChecker(dbus_interface=client_interface)
237
if options.is_enabled:
238
sys.exit(0 if client.Get(client_interface,
240
dbus_interface=dbus.PROPERTIES_IFACE)
243
client.Set(client_interface, u"checker", options.checker,
244
dbus_interface=dbus.PROPERTIES_IFACE)
246
client.Set(client_interface, u"host", options.host,
247
dbus_interface=dbus.PROPERTIES_IFACE)
249
client.Set(client_interface, u"interval",
250
timedelta_to_milliseconds
251
(string_to_delta(options.interval)),
252
dbus_interface=dbus.PROPERTIES_IFACE)
254
client.Set(client_interface, u"timeout",
255
timedelta_to_milliseconds(string_to_delta
257
dbus_interface=dbus.PROPERTIES_IFACE)
259
client.Set(client_interface, u"secret",
260
dbus.ByteArray(open(options.secret, u'rb').read()),
261
dbus_interface=dbus.PROPERTIES_IFACE)
263
client.Approve(dbus.Boolean(True), dbus_interface=client_interface)
265
client.Approve(dbus.Boolean(False), dbus_interface=client_interface)
267
if __name__ == '__main__':
392
print_clients(clients.values(), keywords)
394
# Process each client in the list by all selected options
395
for client in clients:
397
def set_client_prop(prop, value):
398
"""Set a Client D-Bus property"""
399
client.Set(client_interface, prop, value,
400
dbus_interface=dbus.PROPERTIES_IFACE)
402
def set_client_prop_ms(prop, value):
403
"""Set a Client D-Bus property, converted
404
from a string to milliseconds."""
405
set_client_prop(prop,
406
string_to_delta(value).total_seconds()
410
mandos_serv.RemoveClient(client.__dbus_object_path__)
412
set_client_prop("Enabled", dbus.Boolean(True))
414
set_client_prop("Enabled", dbus.Boolean(False))
415
if options.bump_timeout:
416
set_client_prop("LastCheckedOK", "")
417
if options.start_checker:
418
set_client_prop("CheckerRunning", dbus.Boolean(True))
419
if options.stop_checker:
420
set_client_prop("CheckerRunning", dbus.Boolean(False))
421
if options.is_enabled:
422
sys.exit(0 if client.Get(client_interface,
425
dbus.PROPERTIES_IFACE)
427
if options.checker is not None:
428
set_client_prop("Checker", options.checker)
429
if options.host is not None:
430
set_client_prop("Host", options.host)
431
if options.interval is not None:
432
set_client_prop_ms("Interval", options.interval)
433
if options.approval_delay is not None:
434
set_client_prop_ms("ApprovalDelay",
435
options.approval_delay)
436
if options.approval_duration is not None:
437
set_client_prop_ms("ApprovalDuration",
438
options.approval_duration)
439
if options.timeout is not None:
440
set_client_prop_ms("Timeout", options.timeout)
441
if options.extended_timeout is not None:
442
set_client_prop_ms("ExtendedTimeout",
443
options.extended_timeout)
444
if options.secret is not None:
445
set_client_prop("Secret",
446
dbus.ByteArray(options.secret.read()))
447
if options.approved_by_default is not None:
448
set_client_prop("ApprovedByDefault",
450
.approved_by_default))
452
client.Approve(dbus.Boolean(True),
453
dbus_interface=client_interface)
455
client.Approve(dbus.Boolean(False),
456
dbus_interface=client_interface)
459
if __name__ == "__main__":