2
2
# -*- mode: python; coding: utf-8 -*-
4
from __future__ import division
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
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,
29
from future_builtins import *
7
from optparse import OptionParser
13
locale.setlocale(locale.LC_ALL, u'')
42
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',
48
"LastCheckedOK": "Last Successful Check",
49
"LastApprovalRequest": "Last Approval Request",
51
"Interval": "Interval",
53
"Fingerprint": "Fingerprint",
54
"CheckerRunning": "Check Is Running",
55
"LastEnabled": "Last Enabled",
56
"ApprovalPending": "Approval Is Pending",
57
"ApprovedByDefault": "Approved By Default",
58
"ApprovalDelay": "Approval Delay",
59
"ApprovalDuration": "Approval Duration",
61
"ExtendedTimeout" : "Extended Timeout"
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'
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
domain = "se.recompile"
65
busname = domain + ".Mandos"
67
server_interface = domain + ".Mandos"
68
client_interface = domain + ".Mandos.Client"
36
71
def timedelta_to_milliseconds(td):
37
"Convert a datetime.timedelta object to milliseconds"
72
"""Convert a datetime.timedelta object to milliseconds"""
38
73
return ((td.days * 24 * 60 * 60 * 1000)
39
74
+ (td.seconds * 1000)
40
75
+ (td.microseconds // 1000))
42
77
def milliseconds_to_string(ms):
43
78
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,
79
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
.format(days = "{0}T".format(td.days) if td.days else "",
81
hours = td.seconds // 3600,
82
minutes = (td.seconds % 3600) // 60,
83
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
116
# "value" is not None,
117
# must have a "group"
119
"value", # datetime.timedelta or
121
"followers")) # Tokens valid after
123
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
# the "duration" ABNF definition in RFC 3339, Appendix A.
125
token_end = Token(re.compile(r"$"), None, frozenset())
126
token_second = Token(re.compile(r"(\d+)S"),
127
datetime.timedelta(seconds=1),
128
frozenset((token_end,)))
129
token_minute = Token(re.compile(r"(\d+)M"),
130
datetime.timedelta(minutes=1),
131
frozenset((token_second, token_end)))
132
token_hour = Token(re.compile(r"(\d+)H"),
133
datetime.timedelta(hours=1),
134
frozenset((token_minute, token_end)))
135
token_time = Token(re.compile(r"T"),
137
frozenset((token_hour, token_minute,
139
token_day = Token(re.compile(r"(\d+)D"),
140
datetime.timedelta(days=1),
141
frozenset((token_time, token_end)))
142
token_month = Token(re.compile(r"(\d+)M"),
143
datetime.timedelta(weeks=4),
144
frozenset((token_day, token_end)))
145
token_year = Token(re.compile(r"(\d+)Y"),
146
datetime.timedelta(weeks=52),
147
frozenset((token_month, token_end)))
148
token_week = Token(re.compile(r"(\d+)W"),
149
datetime.timedelta(weeks=1),
150
frozenset((token_end,)))
151
token_duration = Token(re.compile(r"P"), None,
152
frozenset((token_year, token_month,
153
token_day, token_time,
155
# Define starting values
156
value = datetime.timedelta() # Value so far
158
followers = frozenset(token_duration,) # Following valid tokens
159
s = duration # String left to parse
160
# Loop until end token is found
161
while found_token is not token_end:
162
# Search for any currently valid tokens
163
for token in followers:
164
match = token.regexp.match(s)
165
if match is not None:
167
if token.value is not None:
168
# Value found, parse digits
169
factor = int(match.group(1), 10)
170
# Add to value so far
171
value += factor * token.value
172
# Strip token from string
173
s = token.regexp.sub("", s, 1)
176
# Set valid next tokens
177
followers = found_token.followers
180
# No currently valid tokens were found
181
raise ValueError("Invalid RFC 3339 duration")
52
186
def string_to_delta(interval):
53
187
"""Parse a string and return a datetime.timedelta
55
>>> string_to_delta('7d')
189
>>> string_to_delta("7d")
56
190
datetime.timedelta(7)
57
>>> string_to_delta('60s')
191
>>> string_to_delta("60s")
58
192
datetime.timedelta(0, 60)
59
>>> string_to_delta('60m')
193
>>> string_to_delta("60m")
60
194
datetime.timedelta(0, 3600)
61
>>> string_to_delta('24h')
195
>>> string_to_delta("24h")
62
196
datetime.timedelta(1)
63
>>> string_to_delta(u'1w')
197
>>> string_to_delta("1w")
64
198
datetime.timedelta(7)
65
>>> string_to_delta('5m 30s')
199
>>> string_to_delta("5m 30s")
66
200
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):
204
return rfc3339_duration_to_delta(interval)
208
value = datetime.timedelta(0)
209
regexp = re.compile(r"(\d+)([dsmhw]?)")
211
for num, suffix in regexp.findall(interval):
213
value += datetime.timedelta(int(num))
215
value += datetime.timedelta(0, int(num))
217
value += datetime.timedelta(0, 0, 0, 0, int(num))
219
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
221
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
223
value += datetime.timedelta(0, 0, 0, int(num))
92
226
def print_clients(clients, keywords):
93
227
def valuetostring(value, keyword):
94
228
if type(value) is dbus.Boolean:
95
return u"Yes" if value else u"No"
96
if keyword in (u"timeout", u"interval"):
229
return "Yes" if value else "No"
230
if keyword in ("Timeout", "Interval", "ApprovalDelay",
231
"ApprovalDuration", "ExtendedTimeout"):
97
232
return milliseconds_to_string(value)
98
233
return unicode(value)
100
235
# 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))
236
format_string = " ".join("{{{key}:{width}}}".format(
237
width = max(len(tablewords[key]),
238
max(len(valuetostring(client[key],
242
key = key) for key in keywords)
107
243
# Print header line
108
print format_string % tuple(tablewords[key] for key in keywords)
244
print(format_string.format(**tablewords))
109
245
for client in clients:
110
print format_string % tuple(valuetostring(client[key], key)
246
print(format_string.format(**dict((key,
247
valuetostring(client[key],
249
for key in keywords)))
112
251
def has_actions(options):
113
252
return any((options.enable,
120
259
options.checker is not None,
121
260
options.timeout is not None,
261
options.extended_timeout is not None,
122
262
options.interval is not None,
263
options.approved_by_default is not None,
264
options.approval_delay is not None,
265
options.approval_duration is not None,
123
266
options.host is not None,
124
267
options.secret is not None,
272
parser = argparse.ArgumentParser()
273
parser.add_argument("--version", action="version",
274
version = "%(prog)s {0}".format(version),
275
help="show version number and exit")
276
parser.add_argument("-a", "--all", action="store_true",
277
help="Select all clients")
278
parser.add_argument("-v", "--verbose", action="store_true",
279
help="Print all fields")
280
parser.add_argument("-e", "--enable", action="store_true",
281
help="Enable client")
282
parser.add_argument("-d", "--disable", action="store_true",
283
help="disable client")
284
parser.add_argument("-b", "--bump-timeout", action="store_true",
285
help="Bump timeout for client")
286
parser.add_argument("--start-checker", action="store_true",
287
help="Start checker for client")
288
parser.add_argument("--stop-checker", action="store_true",
289
help="Stop checker for client")
290
parser.add_argument("-V", "--is-enabled", action="store_true",
291
help="Check if client is enabled")
292
parser.add_argument("-r", "--remove", action="store_true",
293
help="Remove client")
294
parser.add_argument("-c", "--checker",
295
help="Set checker command for client")
296
parser.add_argument("-t", "--timeout",
297
help="Set timeout for client")
298
parser.add_argument("--extended-timeout",
299
help="Set extended timeout for client")
300
parser.add_argument("-i", "--interval",
301
help="Set checker interval for client")
302
parser.add_argument("--approve-by-default", action="store_true",
303
default=None, dest="approved_by_default",
304
help="Set client to be approved by default")
305
parser.add_argument("--deny-by-default", action="store_false",
306
dest="approved_by_default",
307
help="Set client to be denied by default")
308
parser.add_argument("--approval-delay",
309
help="Set delay before client approve/deny")
310
parser.add_argument("--approval-duration",
311
help="Set duration of one client approval")
312
parser.add_argument("-H", "--host", help="Set host for client")
313
parser.add_argument("-s", "--secret", type=file,
314
help="Set password blob (file) for client")
315
parser.add_argument("-A", "--approve", action="store_true",
316
help="Approve any current client request")
317
parser.add_argument("-D", "--deny", action="store_true",
318
help="Deny any current client request")
319
parser.add_argument("--check", action="store_true",
320
help="Run self-test")
321
parser.add_argument("client", nargs="*", help="Client name")
322
options = parser.parse_args()
324
if has_actions(options) and not (options.client or options.all):
325
parser.error("Options require clients names or --all.")
326
if options.verbose and has_actions(options):
327
parser.error("--verbose can only be used alone or with"
329
if options.all and not has_actions(options):
330
parser.error("--all requires an action.")
333
fail_count, test_count = doctest.testmod()
334
sys.exit(os.EX_OK if fail_count == 0 else 1)
337
bus = dbus.SystemBus()
338
mandos_dbus_objc = bus.get_object(busname, server_path)
339
except dbus.exceptions.DBusException:
340
print("Could not connect to Mandos server",
344
mandos_serv = dbus.Interface(mandos_dbus_objc,
345
dbus_interface = server_interface)
347
#block stderr since dbus library prints to stderr
348
null = os.open(os.path.devnull, os.O_RDWR)
349
stderrcopy = os.dup(sys.stderr.fileno())
350
os.dup2(null, sys.stderr.fileno())
354
mandos_clients = mandos_serv.GetAllClientsWithProperties()
357
os.dup2(stderrcopy, sys.stderr.fileno())
359
except dbus.exceptions.DBusException:
360
print("Access denied: Accessing mandos server through dbus.",
364
# Compile dict of (clients: properties) to process
367
if options.all or not options.client:
368
clients = dict((bus.get_object(busname, path), properties)
369
for path, properties in
370
mandos_clients.iteritems())
372
for name in options.client:
373
for path, client in mandos_clients.iteritems():
374
if client["Name"] == name:
375
client_objc = bus.get_object(busname, path)
376
clients[client_objc] = client
379
print("Client not found on server: {0!r}"
380
.format(name), file=sys.stderr)
383
if not has_actions(options) and clients:
385
keywords = ("Name", "Enabled", "Timeout",
386
"LastCheckedOK", "Created", "Interval",
387
"Host", "Fingerprint", "CheckerRunning",
388
"LastEnabled", "ApprovalPending",
390
"LastApprovalRequest", "ApprovalDelay",
391
"ApprovalDuration", "Checker",
394
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__':
396
print_clients(clients.values(), keywords)
398
# Process each client in the list by all selected options
399
for client in clients:
400
def set_client_prop(prop, value):
401
"""Set a Client D-Bus property"""
402
client.Set(client_interface, prop, value,
403
dbus_interface=dbus.PROPERTIES_IFACE)
404
def set_client_prop_ms(prop, value):
405
"""Set a Client D-Bus property, converted
406
from a string to milliseconds."""
407
set_client_prop(prop,
408
timedelta_to_milliseconds
409
(string_to_delta(value)))
411
mandos_serv.RemoveClient(client.__dbus_object_path__)
413
set_client_prop("Enabled", dbus.Boolean(True))
415
set_client_prop("Enabled", dbus.Boolean(False))
416
if options.bump_timeout:
417
set_client_prop("LastCheckedOK", "")
418
if options.start_checker:
419
set_client_prop("CheckerRunning", dbus.Boolean(True))
420
if options.stop_checker:
421
set_client_prop("CheckerRunning", dbus.Boolean(False))
422
if options.is_enabled:
423
sys.exit(0 if client.Get(client_interface,
426
dbus.PROPERTIES_IFACE)
428
if options.checker is not None:
429
set_client_prop("Checker", options.checker)
430
if options.host is not None:
431
set_client_prop("Host", options.host)
432
if options.interval is not None:
433
set_client_prop_ms("Interval", options.interval)
434
if options.approval_delay is not None:
435
set_client_prop_ms("ApprovalDelay",
436
options.approval_delay)
437
if options.approval_duration is not None:
438
set_client_prop_ms("ApprovalDuration",
439
options.approval_duration)
440
if options.timeout is not None:
441
set_client_prop_ms("Timeout", options.timeout)
442
if options.extended_timeout is not None:
443
set_client_prop_ms("ExtendedTimeout",
444
options.extended_timeout)
445
if options.secret is not None:
446
set_client_prop("Secret",
447
dbus.ByteArray(options.secret.read()))
448
if options.approved_by_default is not None:
449
set_client_prop("ApprovedByDefault",
451
.approved_by_default))
453
client.Approve(dbus.Boolean(True),
454
dbus_interface=client_interface)
456
client.Approve(dbus.Boolean(False),
457
dbus_interface=client_interface)
459
if __name__ == "__main__":