To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 501
- compare with another revision
- download diff
- download tarball
- view history from revision 501
- Committer: Teddy Hogeborn
- Date: 2011-09-26 19:34:23 UTC
- Revision ID: teddy@fukt.bsnet.se-20110926193423-5yc1fcv4joiwc1gq
* mandos-clients.conf.xml (OPTIONS/timeout): No longer used when
secret key is given;
refer to
"extended_timeout".
secret key is given;
refer to
"extended_timeout".
- files removed:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos-ctl
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
6
# Copyright © 2008-2016 Teddy Hogeborn
7
# Copyright © 2008-2016 Björn Påhlsson
6
# Copyright © 2008-2010 Teddy Hogeborn
7
# Copyright © 2008-2010 Björn Påhlsson
8
8
#
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
17
17
# GNU General Public License for more details.
18
18
#
19
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/>.
20
# along with this program. If not, see <http://www.gnu.org/licenses/>.
22
21
#
23
# Contact the authors at <mandos@recompile.se>.
22
# Contact the authors at <mandos@fukt.bsnet.se>.
24
23
#
25
24
26
25
from __future__ import (division, absolute_import, print_function,
27
26
unicode_literals)
28
27
29
try:
30
from future_builtins import *
31
except ImportError:
32
pass
33
34
28
import sys
29
import dbus
35
30
import argparse
36
31
import locale
37
32
import datetime
38
33
import re
39
34
import os
40
import collections
41
import doctest
42
43
import dbus
44
45
if sys.version_info.major == 2:
46
str = unicode
47
35
48
36
locale.setlocale(locale.LC_ALL, "")
49
37
64
52
"ApprovalDelay": "Approval Delay",
65
53
"ApprovalDuration": "Approval Duration",
66
54
"Checker": "Checker",
67
"ExtendedTimeout": "Extended Timeout"
68
}
55
"ExtendedTimeout" : "Extended Timeout"
56
}
69
57
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
domain = "se.recompile"
58
domain = "se.bsnet.fukt"
71
59
busname = domain + ".Mandos"
72
60
server_path = "/"
73
61
server_interface = domain + ".Mandos"
74
62
client_interface = domain + ".Mandos.Client"
75
version = "1.7.3"
76
77
78
try:
79
dbus.OBJECT_MANAGER_IFACE
80
except AttributeError:
81
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
63
version = "1.3.1"
64
65
def timedelta_to_milliseconds(td):
66
"""Convert a datetime.timedelta object to milliseconds"""
67
return ((td.days * 24 * 60 * 60 * 1000)
68
+ (td.seconds * 1000)
69
+ (td.microseconds // 1000))
82
70
83
71
def milliseconds_to_string(ms):
84
72
td = datetime.timedelta(0, 0, 0, ms)
85
return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
86
days = "{}T".format(td.days) if td.days else "",
87
hours = td.seconds // 3600,
88
minutes = (td.seconds % 3600) // 60,
89
seconds = td.seconds % 60))
90
91
92
def rfc3339_duration_to_delta(duration):
93
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
94
95
>>> rfc3339_duration_to_delta("P7D")
96
datetime.timedelta(7)
97
>>> rfc3339_duration_to_delta("PT60S")
98
datetime.timedelta(0, 60)
99
>>> rfc3339_duration_to_delta("PT60M")
100
datetime.timedelta(0, 3600)
101
>>> rfc3339_duration_to_delta("PT24H")
102
datetime.timedelta(1)
103
>>> rfc3339_duration_to_delta("P1W")
104
datetime.timedelta(7)
105
>>> rfc3339_duration_to_delta("PT5M30S")
106
datetime.timedelta(0, 330)
107
>>> rfc3339_duration_to_delta("P1DT3M20S")
108
datetime.timedelta(1, 200)
109
"""
110
111
# Parsing an RFC 3339 duration with regular expressions is not
112
# possible - there would have to be multiple places for the same
113
# values, like seconds. The current code, while more esoteric, is
114
# cleaner without depending on a parsing library. If Python had a
115
# built-in library for parsing we would use it, but we'd like to
116
# avoid excessive use of external libraries.
117
118
# New type for defining tokens, syntax, and semantics all-in-one
119
Token = collections.namedtuple("Token", (
120
"regexp", # To match token; if "value" is not None, must have
121
# a "group" containing digits
122
"value", # datetime.timedelta or None
123
"followers")) # Tokens valid after this token
124
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
125
# the "duration" ABNF definition in RFC 3339, Appendix A.
126
token_end = Token(re.compile(r"$"), None, frozenset())
127
token_second = Token(re.compile(r"(\d+)S"),
128
datetime.timedelta(seconds=1),
129
frozenset((token_end, )))
130
token_minute = Token(re.compile(r"(\d+)M"),
131
datetime.timedelta(minutes=1),
132
frozenset((token_second, token_end)))
133
token_hour = Token(re.compile(r"(\d+)H"),
134
datetime.timedelta(hours=1),
135
frozenset((token_minute, token_end)))
136
token_time = Token(re.compile(r"T"),
137
None,
138
frozenset((token_hour, token_minute,
139
token_second)))
140
token_day = Token(re.compile(r"(\d+)D"),
141
datetime.timedelta(days=1),
142
frozenset((token_time, token_end)))
143
token_month = Token(re.compile(r"(\d+)M"),
144
datetime.timedelta(weeks=4),
145
frozenset((token_day, token_end)))
146
token_year = Token(re.compile(r"(\d+)Y"),
147
datetime.timedelta(weeks=52),
148
frozenset((token_month, token_end)))
149
token_week = Token(re.compile(r"(\d+)W"),
150
datetime.timedelta(weeks=1),
151
frozenset((token_end, )))
152
token_duration = Token(re.compile(r"P"), None,
153
frozenset((token_year, token_month,
154
token_day, token_time,
155
token_week)))
156
# Define starting values
157
value = datetime.timedelta() # Value so far
158
found_token = None
159
followers = frozenset((token_duration, )) # Following valid tokens
160
s = duration # String left to parse
161
# Loop until end token is found
162
while found_token is not token_end:
163
# Search for any currently valid tokens
164
for token in followers:
165
match = token.regexp.match(s)
166
if match is not None:
167
# Token found
168
if token.value is not None:
169
# Value found, parse digits
170
factor = int(match.group(1), 10)
171
# Add to value so far
172
value += factor * token.value
173
# Strip token from string
174
s = token.regexp.sub("", s, 1)
175
# Go to found token
176
found_token = token
177
# Set valid next tokens
178
followers = found_token.followers
179
break
180
else:
181
# No currently valid tokens were found
182
raise ValueError("Invalid RFC 3339 duration: {!r}"
183
.format(duration))
184
# End token found
185
return value
186
73
return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
74
% { "days": "%dT" % td.days if td.days else "",
75
"hours": td.seconds // 3600,
76
"minutes": (td.seconds % 3600) // 60,
77
"seconds": td.seconds % 60,
78
})
187
79
188
80
def string_to_delta(interval):
189
81
"""Parse a string and return a datetime.timedelta
190
82
191
>>> string_to_delta('7d')
83
>>> string_to_delta("7d")
192
84
datetime.timedelta(7)
193
>>> string_to_delta('60s')
85
>>> string_to_delta("60s")
194
86
datetime.timedelta(0, 60)
195
>>> string_to_delta('60m')
87
>>> string_to_delta("60m")
196
88
datetime.timedelta(0, 3600)
197
>>> string_to_delta('24h')
89
>>> string_to_delta("24h")
198
90
datetime.timedelta(1)
199
>>> string_to_delta('1w')
91
>>> string_to_delta("1w")
200
92
datetime.timedelta(7)
201
>>> string_to_delta('5m 30s')
93
>>> string_to_delta("5m 30s")
202
94
datetime.timedelta(0, 330)
203
95
"""
204
205
try:
206
return rfc3339_duration_to_delta(interval)
207
except ValueError:
208
pass
209
210
value = datetime.timedelta(0)
211
regexp = re.compile(r"(\d+)([dsmhw]?)")
212
213
for num, suffix in regexp.findall(interval):
214
if suffix == "d":
215
value += datetime.timedelta(int(num))
216
elif suffix == "s":
217
value += datetime.timedelta(0, int(num))
218
elif suffix == "m":
219
value += datetime.timedelta(0, 0, 0, 0, int(num))
220
elif suffix == "h":
221
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
222
elif suffix == "w":
223
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
224
elif suffix == "":
225
value += datetime.timedelta(0, 0, 0, int(num))
226
return value
227
96
timevalue = datetime.timedelta(0)
97
regexp = re.compile("\d+[dsmhw]")
98
99
for s in regexp.findall(interval):
100
try:
101
suffix = unicode(s[-1])
102
value = int(s[:-1])
103
if suffix == "d":
104
delta = datetime.timedelta(value)
105
elif suffix == "s":
106
delta = datetime.timedelta(0, value)
107
elif suffix == "m":
108
delta = datetime.timedelta(0, 0, 0, 0, value)
109
elif suffix == "h":
110
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
111
elif suffix == "w":
112
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
113
else:
114
raise ValueError
115
except (ValueError, IndexError):
116
raise ValueError
117
timevalue += delta
118
return timevalue
228
119
229
120
def print_clients(clients, keywords):
230
121
def valuetostring(value, keyword):
231
122
if type(value) is dbus.Boolean:
232
123
return "Yes" if value else "No"
233
124
if keyword in ("Timeout", "Interval", "ApprovalDelay",
234
"ApprovalDuration", "ExtendedTimeout"):
125
"ApprovalDuration"):
235
126
return milliseconds_to_string(value)
236
return str(value)
127
return unicode(value)
237
128
238
129
# Create format string to print table rows
239
format_string = " ".join("{{{key}:{width}}}".format(
240
width = max(len(tablewords[key]),
241
max(len(valuetostring(client[key], key))
242
for client in clients)),
243
key = key)
130
format_string = " ".join("%%-%ds" %
131
max(len(tablewords[key]),
132
max(len(valuetostring(client[key],
133
key))
134
for client in
135
clients))
244
136
for key in keywords)
245
137
# Print header line
246
print(format_string.format(**tablewords))
138
print(format_string % tuple(tablewords[key] for key in keywords))
247
139
for client in clients:
248
print(format_string.format(**{
249
key: valuetostring(client[key], key)
250
for key in keywords }))
251
140
print(format_string % tuple(valuetostring(client[key], key)
141
for key in keywords))
252
142
253
143
def has_actions(options):
254
144
return any((options.enable,
270
160
options.approve,
271
161
options.deny))
272
162
273
274
163
def main():
275
164
parser = argparse.ArgumentParser()
276
165
parser.add_argument("--version", action="version",
277
version = "%(prog)s {}".format(version),
166
version = "%%prog %s" % version,
278
167
help="show version number and exit")
279
168
parser.add_argument("-a", "--all", action="store_true",
280
169
help="Select all clients")
313
202
parser.add_argument("--approval-duration",
314
203
help="Set duration of one client approval")
315
204
parser.add_argument("-H", "--host", help="Set host for client")
316
parser.add_argument("-s", "--secret",
317
type=argparse.FileType(mode="rb"),
205
parser.add_argument("-s", "--secret", type=file,
318
206
help="Set password blob (file) for client")
319
207
parser.add_argument("-A", "--approve", action="store_true",
320
208
help="Approve any current client request")
321
209
parser.add_argument("-D", "--deny", action="store_true",
322
210
help="Deny any current client request")
323
parser.add_argument("--check", action="store_true",
324
help="Run self-test")
325
211
parser.add_argument("client", nargs="*", help="Client name")
326
212
options = parser.parse_args()
327
213
328
if has_actions(options) and not (options.client or options.all):
214
if has_actions(options) and not options.client and not options.all:
329
215
parser.error("Options require clients names or --all.")
330
216
if options.verbose and has_actions(options):
331
217
parser.error("--verbose can only be used alone or with"
332
218
" --all.")
333
219
if options.all and not has_actions(options):
334
220
parser.error("--all requires an action.")
335
336
if options.check:
337
fail_count, test_count = doctest.testmod()
338
sys.exit(os.EX_OK if fail_count == 0 else 1)
339
221
340
222
try:
341
223
bus = dbus.SystemBus()
342
224
mandos_dbus_objc = bus.get_object(busname, server_path)
343
225
except dbus.exceptions.DBusException:
344
print("Could not connect to Mandos server", file=sys.stderr)
226
print("Could not connect to Mandos server",
227
file=sys.stderr)
345
228
sys.exit(1)
346
229
347
230
mandos_serv = dbus.Interface(mandos_dbus_objc,
348
231
dbus_interface = server_interface)
349
mandos_serv_object_manager = dbus.Interface(
350
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
351
232
352
233
#block stderr since dbus library prints to stderr
353
234
null = os.open(os.path.devnull, os.O_RDWR)
356
237
os.close(null)
357
238
try:
358
239
try:
359
mandos_clients = { path: ifs_and_props[client_interface]
360
for path, ifs_and_props in
361
mandos_serv_object_manager
362
.GetManagedObjects().items()
363
if client_interface in ifs_and_props }
240
mandos_clients = mandos_serv.GetAllClientsWithProperties()
364
241
finally:
365
242
#restore stderr
366
243
os.dup2(stderrcopy, sys.stderr.fileno())
367
244
os.close(stderrcopy)
368
except dbus.exceptions.DBusException as e:
369
print("Access denied: Accessing mandos server through D-Bus: {}"
370
.format(e), file=sys.stderr)
245
except dbus.exceptions.DBusException, e:
246
print("Access denied: Accessing mandos server through dbus.",
247
file=sys.stderr)
371
248
sys.exit(1)
372
249
373
250
# Compile dict of (clients: properties) to process
374
251
clients={}
375
252
376
253
if options.all or not options.client:
377
clients = { bus.get_object(busname, path): properties
378
for path, properties in mandos_clients.items() }
254
clients = dict((bus.get_object(busname, path), properties)
255
for path, properties in
256
mandos_clients.iteritems())
379
257
else:
380
258
for name in options.client:
381
for path, client in mandos_clients.items():
259
for path, client in mandos_clients.iteritems():
382
260
if client["Name"] == name:
383
261
client_objc = bus.get_object(busname, path)
384
262
clients[client_objc] = client
385
263
break
386
264
else:
387
print("Client not found on server: {!r}"
388
.format(name), file=sys.stderr)
265
print("Client not found on server: %r" % name,
266
file=sys.stderr)
389
267
sys.exit(1)
390
268
391
269
if not has_actions(options) and clients:
392
270
if options.verbose:
393
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
"Created", "Interval", "Host", "Fingerprint",
395
"CheckerRunning", "LastEnabled",
396
"ApprovalPending", "ApprovedByDefault",
271
keywords = ("Name", "Enabled", "Timeout",
272
"LastCheckedOK", "Created", "Interval",
273
"Host", "Fingerprint", "CheckerRunning",
274
"LastEnabled", "ApprovalPending",
275
"ApprovedByDefault",
397
276
"LastApprovalRequest", "ApprovalDelay",
398
277
"ApprovalDuration", "Checker",
399
278
"ExtendedTimeout")
404
283
else:
405
284
# Process each client in the list by all selected options
406
285
for client in clients:
407
408
def set_client_prop(prop, value):
409
"""Set a Client D-Bus property"""
410
client.Set(client_interface, prop, value,
411
dbus_interface=dbus.PROPERTIES_IFACE)
412
413
def set_client_prop_ms(prop, value):
414
"""Set a Client D-Bus property, converted
415
from a string to milliseconds."""
416
set_client_prop(prop,
417
string_to_delta(value).total_seconds()
418
* 1000)
419
420
286
if options.remove:
421
287
mandos_serv.RemoveClient(client.__dbus_object_path__)
422
288
if options.enable:
423
set_client_prop("Enabled", dbus.Boolean(True))
289
client.Enable(dbus_interface=client_interface)
424
290
if options.disable:
425
set_client_prop("Enabled", dbus.Boolean(False))
291
client.Disable(dbus_interface=client_interface)
426
292
if options.bump_timeout:
427
set_client_prop("LastCheckedOK", "")
293
client.CheckedOK(dbus_interface=client_interface)
428
294
if options.start_checker:
429
set_client_prop("CheckerRunning", dbus.Boolean(True))
295
client.StartChecker(dbus_interface=client_interface)
430
296
if options.stop_checker:
431
set_client_prop("CheckerRunning", dbus.Boolean(False))
297
client.StopChecker(dbus_interface=client_interface)
432
298
if options.is_enabled:
433
299
sys.exit(0 if client.Get(client_interface,
434
300
"Enabled",
435
301
dbus_interface=
436
302
dbus.PROPERTIES_IFACE)
437
303
else 1)
438
if options.checker is not None:
439
set_client_prop("Checker", options.checker)
440
if options.host is not None:
441
set_client_prop("Host", options.host)
442
if options.interval is not None:
443
set_client_prop_ms("Interval", options.interval)
444
if options.approval_delay is not None:
445
set_client_prop_ms("ApprovalDelay",
446
options.approval_delay)
447
if options.approval_duration is not None:
448
set_client_prop_ms("ApprovalDuration",
449
options.approval_duration)
450
if options.timeout is not None:
451
set_client_prop_ms("Timeout", options.timeout)
452
if options.extended_timeout is not None:
453
set_client_prop_ms("ExtendedTimeout",
454
options.extended_timeout)
455
if options.secret is not None:
456
set_client_prop("Secret",
457
dbus.ByteArray(options.secret.read()))
304
if options.checker:
305
client.Set(client_interface, "Checker",
306
options.checker,
307
dbus_interface=dbus.PROPERTIES_IFACE)
308
if options.host:
309
client.Set(client_interface, "Host", options.host,
310
dbus_interface=dbus.PROPERTIES_IFACE)
311
if options.interval:
312
client.Set(client_interface, "Interval",
313
timedelta_to_milliseconds
314
(string_to_delta(options.interval)),
315
dbus_interface=dbus.PROPERTIES_IFACE)
316
if options.approval_delay:
317
client.Set(client_interface, "ApprovalDelay",
318
timedelta_to_milliseconds
319
(string_to_delta(options.
320
approval_delay)),
321
dbus_interface=dbus.PROPERTIES_IFACE)
322
if options.approval_duration:
323
client.Set(client_interface, "ApprovalDuration",
324
timedelta_to_milliseconds
325
(string_to_delta(options.
326
approval_duration)),
327
dbus_interface=dbus.PROPERTIES_IFACE)
328
if options.timeout:
329
client.Set(client_interface, "Timeout",
330
timedelta_to_milliseconds
331
(string_to_delta(options.timeout)),
332
dbus_interface=dbus.PROPERTIES_IFACE)
333
if options.extended_timeout:
334
client.Set(client_interface, "ExtendedTimeout",
335
timedelta_to_milliseconds
336
(string_to_delta(options.extended_timeout)),
337
dbus_interface=dbus.PROPERTIES_IFACE)
338
if options.secret:
339
client.Set(client_interface, "Secret",
340
dbus.ByteArray(open(options.secret,
341
"rb").read()),
342
dbus_interface=dbus.PROPERTIES_IFACE)
458
343
if options.approved_by_default is not None:
459
set_client_prop("ApprovedByDefault",
460
dbus.Boolean(options
461
.approved_by_default))
344
client.Set(client_interface, "ApprovedByDefault",
345
dbus.Boolean(options
346
.approved_by_default),
347
dbus_interface=dbus.PROPERTIES_IFACE)
462
348
if options.approve:
463
349
client.Approve(dbus.Boolean(True),
464
350
dbus_interface=client_interface)
466
352
client.Approve(dbus.Boolean(False),
467
353
dbus_interface=client_interface)
468
354
469
470
355
if __name__ == "__main__":
471
356
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0