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 864
- compare with another revision
- download diff
- download tarball
- view history from revision 864
- Committer: Teddy Hogeborn
- Date: 2016-06-28 18:46:40 UTC
- Revision ID: teddy@recompile.se-20160628184640-22uh54op9nw0908b
mandos-ctl: Dump booleans as booleans in --dump-json output.
* mandos-ctl (main): Detect dbus.Boolean objects and recast them to
regular Python bool() objects to make them show
as boolean values in dump output.
* mandos-ctl (main): Detect dbus.Boolean objects and recast them to
regular Python bool() objects to make them show
as boolean values in dump output.
- files added:
- 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-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
import json
43
44
import dbus
45
46
if sys.version_info.major == 2:
47
str = unicode
35
48
36
49
locale.setlocale(locale.LC_ALL, "")
37
50
52
65
"ApprovalDelay": "Approval Delay",
53
66
"ApprovalDuration": "Approval Duration",
54
67
"Checker": "Checker",
55
}
68
"ExtendedTimeout": "Extended Timeout"
69
}
56
70
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
57
domain = "se.bsnet.fukt"
71
domain = "se.recompile"
58
72
busname = domain + ".Mandos"
59
73
server_path = "/"
60
74
server_interface = domain + ".Mandos"
61
75
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))
76
version = "1.7.10"
77
78
79
try:
80
dbus.OBJECT_MANAGER_IFACE
81
except AttributeError:
82
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
69
83
70
84
def milliseconds_to_string(ms):
71
85
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
})
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))
91
92
93
def rfc3339_duration_to_delta(duration):
94
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
95
96
>>> rfc3339_duration_to_delta("P7D")
97
datetime.timedelta(7)
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)
110
"""
111
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.
118
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"),
138
None,
139
frozenset((token_hour, token_minute,
140
token_second)))
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,
156
token_week)))
157
# Define starting values
158
value = datetime.timedelta() # Value so far
159
found_token = None
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:
168
# Token found
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)
176
# Go to found token
177
found_token = token
178
# Set valid next tokens
179
followers = found_token.followers
180
break
181
else:
182
# No currently valid tokens were found
183
raise ValueError("Invalid RFC 3339 duration: {!r}"
184
.format(duration))
185
# End token found
186
return value
187
78
188
79
189
def string_to_delta(interval):
80
190
"""Parse a string and return a datetime.timedelta
81
191
82
>>> string_to_delta("7d")
192
>>> string_to_delta('7d')
83
193
datetime.timedelta(7)
84
>>> string_to_delta("60s")
194
>>> string_to_delta('60s')
85
195
datetime.timedelta(0, 60)
86
>>> string_to_delta("60m")
196
>>> string_to_delta('60m')
87
197
datetime.timedelta(0, 3600)
88
>>> string_to_delta("24h")
198
>>> string_to_delta('24h')
89
199
datetime.timedelta(1)
90
>>> string_to_delta("1w")
200
>>> string_to_delta('1w')
91
201
datetime.timedelta(7)
92
>>> string_to_delta("5m 30s")
202
>>> string_to_delta('5m 30s')
93
203
datetime.timedelta(0, 330)
94
204
"""
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
205
206
try:
207
return rfc3339_duration_to_delta(interval)
208
except ValueError:
209
pass
210
211
value = datetime.timedelta(0)
212
regexp = re.compile(r"(\d+)([dsmhw]?)")
213
214
for num, suffix in regexp.findall(interval):
215
if suffix == "d":
216
value += datetime.timedelta(int(num))
217
elif suffix == "s":
218
value += datetime.timedelta(0, int(num))
219
elif suffix == "m":
220
value += datetime.timedelta(0, 0, 0, 0, int(num))
221
elif suffix == "h":
222
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
223
elif suffix == "w":
224
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
225
elif suffix == "":
226
value += datetime.timedelta(0, 0, 0, int(num))
227
return value
228
118
229
119
230
def print_clients(clients, keywords):
120
231
def valuetostring(value, keyword):
121
232
if type(value) is dbus.Boolean:
122
233
return "Yes" if value else "No"
123
234
if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
"ApprovalDuration"):
235
"ApprovalDuration", "ExtendedTimeout"):
125
236
return milliseconds_to_string(value)
126
return unicode(value)
237
return str(value)
127
238
128
239
# 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))
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)),
244
key = key)
135
245
for key in keywords)
136
246
# Print header line
137
print(format_string % tuple(tablewords[key] for key in keywords))
247
print(format_string.format(**tablewords))
138
248
for client in clients:
139
print(format_string % tuple(valuetostring(client[key], key)
140
for key in keywords))
249
print(format_string.format(**{
250
key: valuetostring(client[key], key)
251
for key in keywords }))
252
141
253
142
254
def has_actions(options):
143
255
return any((options.enable,
149
261
options.remove,
150
262
options.checker is not None,
151
263
options.timeout is not None,
264
options.extended_timeout is not None,
152
265
options.interval is not None,
153
266
options.approved_by_default is not None,
154
267
options.approval_delay is not None,
158
271
options.approve,
159
272
options.deny))
160
273
274
161
275
def main():
162
276
parser = argparse.ArgumentParser()
163
277
parser.add_argument("--version", action="version",
164
version = "%%prog %s" % version,
278
version = "%(prog)s {}".format(version),
165
279
help="show version number and exit")
166
280
parser.add_argument("-a", "--all", action="store_true",
167
281
help="Select all clients")
168
282
parser.add_argument("-v", "--verbose", action="store_true",
169
283
help="Print all fields")
284
parser.add_argument("-j", "--dump-json", action="store_true",
285
help="Dump client data in JSON format")
170
286
parser.add_argument("-e", "--enable", action="store_true",
171
287
help="Enable client")
172
288
parser.add_argument("-d", "--disable", action="store_true",
185
301
help="Set checker command for client")
186
302
parser.add_argument("-t", "--timeout",
187
303
help="Set timeout for client")
304
parser.add_argument("--extended-timeout",
305
help="Set extended timeout for client")
188
306
parser.add_argument("-i", "--interval",
189
307
help="Set checker interval for client")
190
308
parser.add_argument("--approve-by-default", action="store_true",
198
316
parser.add_argument("--approval-duration",
199
317
help="Set duration of one client approval")
200
318
parser.add_argument("-H", "--host", help="Set host for client")
201
parser.add_argument("-s", "--secret", type=file,
319
parser.add_argument("-s", "--secret",
320
type=argparse.FileType(mode="rb"),
202
321
help="Set password blob (file) for client")
203
322
parser.add_argument("-A", "--approve", action="store_true",
204
323
help="Approve any current client request")
205
324
parser.add_argument("-D", "--deny", action="store_true",
206
325
help="Deny any current client request")
326
parser.add_argument("--check", action="store_true",
327
help="Run self-test")
207
328
parser.add_argument("client", nargs="*", help="Client name")
208
329
options = parser.parse_args()
209
330
210
if has_actions(options) and not options.client and not options.all:
331
if has_actions(options) and not (options.client or options.all):
211
332
parser.error("Options require clients names or --all.")
212
333
if options.verbose and has_actions(options):
213
parser.error("--verbose can only be used alone or with"
214
" --all.")
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.")
215
337
if options.all and not has_actions(options):
216
338
parser.error("--all requires an action.")
217
339
340
if options.check:
341
fail_count, test_count = doctest.testmod()
342
sys.exit(os.EX_OK if fail_count == 0 else 1)
343
218
344
try:
219
345
bus = dbus.SystemBus()
220
346
mandos_dbus_objc = bus.get_object(busname, server_path)
221
347
except dbus.exceptions.DBusException:
222
print("Could not connect to Mandos server",
223
file=sys.stderr)
348
print("Could not connect to Mandos server", file=sys.stderr)
224
349
sys.exit(1)
225
350
226
351
mandos_serv = dbus.Interface(mandos_dbus_objc,
227
352
dbus_interface = server_interface)
353
mandos_serv_object_manager = dbus.Interface(
354
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
228
355
229
356
#block stderr since dbus library prints to stderr
230
357
null = os.open(os.path.devnull, os.O_RDWR)
233
360
os.close(null)
234
361
try:
235
362
try:
236
mandos_clients = mandos_serv.GetAllClientsWithProperties()
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 }
237
368
finally:
238
369
#restore stderr
239
370
os.dup2(stderrcopy, sys.stderr.fileno())
240
371
os.close(stderrcopy)
241
except dbus.exceptions.DBusException, e:
242
print("Access denied: Accessing mandos server through dbus.",
243
file=sys.stderr)
372
except dbus.exceptions.DBusException as e:
373
print("Access denied: Accessing mandos server through D-Bus: {}"
374
.format(e), file=sys.stderr)
244
375
sys.exit(1)
245
376
246
377
# Compile dict of (clients: properties) to process
247
378
clients={}
248
379
249
380
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())
381
clients = { bus.get_object(busname, path): properties
382
for path, properties in mandos_clients.items() }
253
383
else:
254
384
for name in options.client:
255
for path, client in mandos_clients.iteritems():
385
for path, client in mandos_clients.items():
256
386
if client["Name"] == name:
257
387
client_objc = bus.get_object(busname, path)
258
388
clients[client_objc] = client
259
389
break
260
390
else:
261
print("Client not found on server: %r" % name,
262
file=sys.stderr)
391
print("Client not found on server: {!r}"
392
.format(name), file=sys.stderr)
263
393
sys.exit(1)
264
394
265
395
if not has_actions(options) and clients:
266
if options.verbose:
267
keywords = ("Name", "Enabled", "Timeout",
268
"LastCheckedOK", "Created", "Interval",
269
"Host", "Fingerprint", "CheckerRunning",
270
"LastEnabled", "ApprovalPending",
271
"ApprovedByDefault",
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",
272
401
"LastApprovalRequest", "ApprovalDelay",
273
"ApprovalDuration", "Checker")
402
"ApprovalDuration", "Checker",
403
"ExtendedTimeout")
274
404
else:
275
405
keywords = defaultkeywords
276
406
277
print_clients(clients.values(), keywords)
407
if options.dump_json:
408
json.dump({client["Name"]: {key:
409
bool(client[key])
410
if isinstance(client[key],
411
dbus.Boolean)
412
else client[key]
413
for key in keywords }
414
for client in clients.values() },
415
fp = sys.stdout, indent = 4,
416
separators = (',', ': '))
417
print()
418
else:
419
print_clients(clients.values(), keywords)
278
420
else:
279
421
# Process each client in the list by all selected options
280
422
for client in clients:
423
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)
428
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()
434
* 1000)
435
281
436
if options.remove:
282
437
mandos_serv.RemoveClient(client.__dbus_object_path__)
283
438
if options.enable:
284
client.Enable(dbus_interface=client_interface)
439
set_client_prop("Enabled", dbus.Boolean(True))
285
440
if options.disable:
286
client.Disable(dbus_interface=client_interface)
441
set_client_prop("Enabled", dbus.Boolean(False))
287
442
if options.bump_timeout:
288
client.CheckedOK(dbus_interface=client_interface)
443
set_client_prop("LastCheckedOK", "")
289
444
if options.start_checker:
290
client.StartChecker(dbus_interface=client_interface)
445
set_client_prop("CheckerRunning", dbus.Boolean(True))
291
446
if options.stop_checker:
292
client.StopChecker(dbus_interface=client_interface)
447
set_client_prop("CheckerRunning", dbus.Boolean(False))
293
448
if options.is_enabled:
294
449
sys.exit(0 if client.Get(client_interface,
295
450
"Enabled",
296
451
dbus_interface=
297
452
dbus.PROPERTIES_IFACE)
298
453
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)
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()))
333
474
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)
475
set_client_prop("ApprovedByDefault",
476
dbus.Boolean(options
477
.approved_by_default))
338
478
if options.approve:
339
479
client.Approve(dbus.Boolean(True),
340
480
dbus_interface=client_interface)
342
482
client.Approve(dbus.Boolean(False),
343
483
dbus_interface=client_interface)
344
484
485
345
486
if __name__ == "__main__":
346
487
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0