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