To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 334
- compare with another revision
- download diff
- download tarball
- view history from revision 334
- Committer: Teddy Hogeborn
- Date: 2016-02-29 21:28:39 UTC
- Revision ID: teddy@recompile.se-20160229212839-hoz3rw1us3uds68n
Tags: version-1.7.3-1
* Makefile (version): Changed to "1.7.3".
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -
- files added:
- debian/mandos-client.examples
- 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-2010 Teddy Hogeborn
7
# Copyright © 2008-2010 Björn Påhlsson
6
# Copyright © 2008-2016 Teddy Hogeborn
7
# Copyright © 2008-2016 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 <http://www.gnu.org/licenses/>.
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
21
22
#
22
# Contact the authors at <mandos@fukt.bsnet.se>.
23
# Contact the authors at <mandos@recompile.se>.
23
24
#
24
25
25
26
from __future__ import (division, absolute_import, print_function,
26
27
unicode_literals)
27
28
29
try:
30
from future_builtins import *
31
except ImportError:
32
pass
33
28
34
import sys
29
import dbus
30
35
import argparse
31
36
import locale
32
37
import datetime
33
38
import re
34
39
import os
40
import collections
41
import doctest
42
43
import dbus
44
45
if sys.version_info.major == 2:
46
str = unicode
35
47
36
48
locale.setlocale(locale.LC_ALL, "")
37
49
52
64
"ApprovalDelay": "Approval Delay",
53
65
"ApprovalDuration": "Approval Duration",
54
66
"Checker": "Checker",
55
}
67
"ExtendedTimeout": "Extended Timeout"
68
}
56
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
57
domain = "se.bsnet.fukt"
70
domain = "se.recompile"
58
71
busname = domain + ".Mandos"
59
72
server_path = "/"
60
73
server_interface = domain + ".Mandos"
61
74
client_interface = domain + ".Mandos.Client"
62
version = "1.3.0"
63
64
def timedelta_to_milliseconds(td):
65
"""Convert a datetime.timedelta object to milliseconds"""
66
return ((td.days * 24 * 60 * 60 * 1000)
67
+ (td.seconds * 1000)
68
+ (td.microseconds // 1000))
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"
69
82
70
83
def milliseconds_to_string(ms):
71
84
td = datetime.timedelta(0, 0, 0, ms)
72
return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
73
% { "days": "%dT" % td.days if td.days else "",
74
"hours": td.seconds // 3600,
75
"minutes": (td.seconds % 3600) // 60,
76
"seconds": td.seconds % 60,
77
})
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
78
187
79
188
def string_to_delta(interval):
80
189
"""Parse a string and return a datetime.timedelta
81
190
82
>>> string_to_delta("7d")
191
>>> string_to_delta('7d')
83
192
datetime.timedelta(7)
84
>>> string_to_delta("60s")
193
>>> string_to_delta('60s')
85
194
datetime.timedelta(0, 60)
86
>>> string_to_delta("60m")
195
>>> string_to_delta('60m')
87
196
datetime.timedelta(0, 3600)
88
>>> string_to_delta("24h")
197
>>> string_to_delta('24h')
89
198
datetime.timedelta(1)
90
>>> string_to_delta("1w")
199
>>> string_to_delta('1w')
91
200
datetime.timedelta(7)
92
>>> string_to_delta("5m 30s")
201
>>> string_to_delta('5m 30s')
93
202
datetime.timedelta(0, 330)
94
203
"""
95
timevalue = datetime.timedelta(0)
96
regexp = re.compile("\d+[dsmhw]")
97
98
for s in regexp.findall(interval):
99
try:
100
suffix = unicode(s[-1])
101
value = int(s[:-1])
102
if suffix == "d":
103
delta = datetime.timedelta(value)
104
elif suffix == "s":
105
delta = datetime.timedelta(0, value)
106
elif suffix == "m":
107
delta = datetime.timedelta(0, 0, 0, 0, value)
108
elif suffix == "h":
109
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
110
elif suffix == "w":
111
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
112
else:
113
raise ValueError
114
except (ValueError, IndexError):
115
raise ValueError
116
timevalue += delta
117
return timevalue
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
118
228
119
229
def print_clients(clients, keywords):
120
230
def valuetostring(value, keyword):
121
231
if type(value) is dbus.Boolean:
122
232
return "Yes" if value else "No"
123
233
if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
"ApprovalDuration"):
234
"ApprovalDuration", "ExtendedTimeout"):
125
235
return milliseconds_to_string(value)
126
return unicode(value)
236
return str(value)
127
237
128
238
# Create format string to print table rows
129
format_string = " ".join("%%-%ds" %
130
max(len(tablewords[key]),
131
max(len(valuetostring(client[key],
132
key))
133
for client in
134
clients))
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)
135
244
for key in keywords)
136
245
# Print header line
137
print(format_string % tuple(tablewords[key] for key in keywords))
246
print(format_string.format(**tablewords))
138
247
for client in clients:
139
print(format_string % tuple(valuetostring(client[key], key)
140
for key in keywords))
248
print(format_string.format(**{
249
key: valuetostring(client[key], key)
250
for key in keywords }))
251
141
252
142
253
def has_actions(options):
143
254
return any((options.enable,
149
260
options.remove,
150
261
options.checker is not None,
151
262
options.timeout is not None,
263
options.extended_timeout is not None,
152
264
options.interval is not None,
153
265
options.approved_by_default is not None,
154
266
options.approval_delay is not None,
158
270
options.approve,
159
271
options.deny))
160
272
273
161
274
def main():
162
275
parser = argparse.ArgumentParser()
163
276
parser.add_argument("--version", action="version",
164
version = "%%prog %s" % version,
277
version = "%(prog)s {}".format(version),
165
278
help="show version number and exit")
166
279
parser.add_argument("-a", "--all", action="store_true",
167
280
help="Select all clients")
185
298
help="Set checker command for client")
186
299
parser.add_argument("-t", "--timeout",
187
300
help="Set timeout for client")
301
parser.add_argument("--extended-timeout",
302
help="Set extended timeout for client")
188
303
parser.add_argument("-i", "--interval",
189
304
help="Set checker interval for client")
190
305
parser.add_argument("--approve-by-default", action="store_true",
198
313
parser.add_argument("--approval-duration",
199
314
help="Set duration of one client approval")
200
315
parser.add_argument("-H", "--host", help="Set host for client")
201
parser.add_argument("-s", "--secret", type=file,
316
parser.add_argument("-s", "--secret",
317
type=argparse.FileType(mode="rb"),
202
318
help="Set password blob (file) for client")
203
319
parser.add_argument("-A", "--approve", action="store_true",
204
320
help="Approve any current client request")
205
321
parser.add_argument("-D", "--deny", action="store_true",
206
322
help="Deny any current client request")
323
parser.add_argument("--check", action="store_true",
324
help="Run self-test")
207
325
parser.add_argument("client", nargs="*", help="Client name")
208
326
options = parser.parse_args()
209
327
210
if has_actions(options) and not options.client and not options.all:
328
if has_actions(options) and not (options.client or options.all):
211
329
parser.error("Options require clients names or --all.")
212
330
if options.verbose and has_actions(options):
213
331
parser.error("--verbose can only be used alone or with"
214
332
" --all.")
215
333
if options.all and not has_actions(options):
216
334
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)
217
339
218
340
try:
219
341
bus = dbus.SystemBus()
220
342
mandos_dbus_objc = bus.get_object(busname, server_path)
221
343
except dbus.exceptions.DBusException:
222
print("Could not connect to Mandos server",
223
file=sys.stderr)
344
print("Could not connect to Mandos server", file=sys.stderr)
224
345
sys.exit(1)
225
346
226
347
mandos_serv = dbus.Interface(mandos_dbus_objc,
227
348
dbus_interface = server_interface)
349
mandos_serv_object_manager = dbus.Interface(
350
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
228
351
229
352
#block stderr since dbus library prints to stderr
230
353
null = os.open(os.path.devnull, os.O_RDWR)
233
356
os.close(null)
234
357
try:
235
358
try:
236
mandos_clients = mandos_serv.GetAllClientsWithProperties()
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 }
237
364
finally:
238
365
#restore stderr
239
366
os.dup2(stderrcopy, sys.stderr.fileno())
240
367
os.close(stderrcopy)
241
except dbus.exceptions.DBusException, e:
242
print("Access denied: Accessing mandos server through dbus.",
243
file=sys.stderr)
368
except dbus.exceptions.DBusException as e:
369
print("Access denied: Accessing mandos server through D-Bus: {}"
370
.format(e), file=sys.stderr)
244
371
sys.exit(1)
245
372
246
373
# Compile dict of (clients: properties) to process
247
374
clients={}
248
375
249
376
if options.all or not options.client:
250
clients = dict((bus.get_object(busname, path), properties)
251
for path, properties in
252
mandos_clients.iteritems())
377
clients = { bus.get_object(busname, path): properties
378
for path, properties in mandos_clients.items() }
253
379
else:
254
380
for name in options.client:
255
for path, client in mandos_clients.iteritems():
381
for path, client in mandos_clients.items():
256
382
if client["Name"] == name:
257
383
client_objc = bus.get_object(busname, path)
258
384
clients[client_objc] = client
259
385
break
260
386
else:
261
print("Client not found on server: %r" % name,
262
file=sys.stderr)
387
print("Client not found on server: {!r}"
388
.format(name), file=sys.stderr)
263
389
sys.exit(1)
264
390
265
391
if not has_actions(options) and clients:
266
392
if options.verbose:
267
keywords = ("Name", "Enabled", "Timeout",
268
"LastCheckedOK", "Created", "Interval",
269
"Host", "Fingerprint", "CheckerRunning",
270
"LastEnabled", "ApprovalPending",
271
"ApprovedByDefault",
393
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
"Created", "Interval", "Host", "Fingerprint",
395
"CheckerRunning", "LastEnabled",
396
"ApprovalPending", "ApprovedByDefault",
272
397
"LastApprovalRequest", "ApprovalDelay",
273
"ApprovalDuration", "Checker")
398
"ApprovalDuration", "Checker",
399
"ExtendedTimeout")
274
400
else:
275
401
keywords = defaultkeywords
276
402
278
404
else:
279
405
# Process each client in the list by all selected options
280
406
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
281
420
if options.remove:
282
421
mandos_serv.RemoveClient(client.__dbus_object_path__)
283
422
if options.enable:
284
client.Enable(dbus_interface=client_interface)
423
set_client_prop("Enabled", dbus.Boolean(True))
285
424
if options.disable:
286
client.Disable(dbus_interface=client_interface)
425
set_client_prop("Enabled", dbus.Boolean(False))
287
426
if options.bump_timeout:
288
client.CheckedOK(dbus_interface=client_interface)
427
set_client_prop("LastCheckedOK", "")
289
428
if options.start_checker:
290
client.StartChecker(dbus_interface=client_interface)
429
set_client_prop("CheckerRunning", dbus.Boolean(True))
291
430
if options.stop_checker:
292
client.StopChecker(dbus_interface=client_interface)
431
set_client_prop("CheckerRunning", dbus.Boolean(False))
293
432
if options.is_enabled:
294
433
sys.exit(0 if client.Get(client_interface,
295
434
"Enabled",
296
435
dbus_interface=
297
436
dbus.PROPERTIES_IFACE)
298
437
else 1)
299
if options.checker:
300
client.Set(client_interface, "Checker",
301
options.checker,
302
dbus_interface=dbus.PROPERTIES_IFACE)
303
if options.host:
304
client.Set(client_interface, "Host", options.host,
305
dbus_interface=dbus.PROPERTIES_IFACE)
306
if options.interval:
307
client.Set(client_interface, "Interval",
308
timedelta_to_milliseconds
309
(string_to_delta(options.interval)),
310
dbus_interface=dbus.PROPERTIES_IFACE)
311
if options.approval_delay:
312
client.Set(client_interface, "ApprovalDelay",
313
timedelta_to_milliseconds
314
(string_to_delta(options.
315
approval_delay)),
316
dbus_interface=dbus.PROPERTIES_IFACE)
317
if options.approval_duration:
318
client.Set(client_interface, "ApprovalDuration",
319
timedelta_to_milliseconds
320
(string_to_delta(options.
321
approval_duration)),
322
dbus_interface=dbus.PROPERTIES_IFACE)
323
if options.timeout:
324
client.Set(client_interface, "Timeout",
325
timedelta_to_milliseconds
326
(string_to_delta(options.timeout)),
327
dbus_interface=dbus.PROPERTIES_IFACE)
328
if options.secret:
329
client.Set(client_interface, "Secret",
330
dbus.ByteArray(open(options.secret,
331
"rb").read()),
332
dbus_interface=dbus.PROPERTIES_IFACE)
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()))
333
458
if options.approved_by_default is not None:
334
client.Set(client_interface, "ApprovedByDefault",
335
dbus.Boolean(options
336
.approved_by_default),
337
dbus_interface=dbus.PROPERTIES_IFACE)
459
set_client_prop("ApprovedByDefault",
460
dbus.Boolean(options
461
.approved_by_default))
338
462
if options.approve:
339
463
client.Approve(dbus.Boolean(True),
340
464
dbus_interface=client_interface)
342
466
client.Approve(dbus.Boolean(False),
343
467
dbus_interface=client_interface)
344
468
469
345
470
if __name__ == "__main__":
346
471
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0