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 505.1.24
- compare with another revision
- download diff
- download tarball
- view history from revision 505.1.24
- Committer: Teddy Hogeborn
- Date: 2011-12-21 17:17:32 UTC
- mto: This revision was merged to the branch mainline in revision 527.
- Revision ID: teddy@recompile.se-20111221171732-j1yfbekvztjk205a
* mandos-ctl (main): Correct "except:" syntax.
- files removed:
- bugs.xml
- debian/upstream
- 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-2011 Teddy Hogeborn
7
# Copyright © 2008-2011 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
22
# Contact the authors at <mandos@recompile.se>.
24
23
#
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
import json
43
44
import dbus
45
46
if sys.version_info.major == 2:
47
str = unicode
48
35
49
36
locale.setlocale(locale.LC_ALL, "")
50
37
65
52
"ApprovalDelay": "Approval Delay",
66
53
"ApprovalDuration": "Approval Duration",
67
54
"Checker": "Checker",
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
55
"ExtendedTimeout" : "Extended Timeout"
56
}
72
57
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
58
domain = "se.recompile"
74
59
busname = domain + ".Mandos"
75
60
server_path = "/"
76
61
server_interface = domain + ".Mandos"
77
62
client_interface = domain + ".Mandos.Client"
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"
63
version = "1.4.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))
85
70
86
71
def milliseconds_to_string(ms):
87
72
td = datetime.timedelta(0, 0, 0, ms)
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
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
})
190
79
191
80
def string_to_delta(interval):
192
81
"""Parse a string and return a datetime.timedelta
193
82
194
>>> string_to_delta('7d')
83
>>> string_to_delta("7d")
195
84
datetime.timedelta(7)
196
>>> string_to_delta('60s')
85
>>> string_to_delta("60s")
197
86
datetime.timedelta(0, 60)
198
>>> string_to_delta('60m')
87
>>> string_to_delta("60m")
199
88
datetime.timedelta(0, 3600)
200
>>> string_to_delta('24h')
89
>>> string_to_delta("24h")
201
90
datetime.timedelta(1)
202
>>> string_to_delta('1w')
91
>>> string_to_delta("1w")
203
92
datetime.timedelta(7)
204
>>> string_to_delta('5m 30s')
93
>>> string_to_delta("5m 30s")
205
94
datetime.timedelta(0, 330)
206
95
"""
207
208
try:
209
return rfc3339_duration_to_delta(interval)
210
except ValueError:
211
pass
212
213
96
value = datetime.timedelta(0)
214
regexp = re.compile(r"(\d+)([dsmhw]?)")
97
regexp = re.compile("(\d+)([dsmhw]?)")
215
98
216
99
for num, suffix in regexp.findall(interval):
217
100
if suffix == "d":
228
111
value += datetime.timedelta(0, 0, 0, int(num))
229
112
return value
230
113
231
232
114
def print_clients(clients, keywords):
233
115
def valuetostring(value, keyword):
234
116
if type(value) is dbus.Boolean:
235
117
return "Yes" if value else "No"
236
118
if keyword in ("Timeout", "Interval", "ApprovalDelay",
237
"ApprovalDuration", "ExtendedTimeout"):
119
"ApprovalDuration"):
238
120
return milliseconds_to_string(value)
239
return str(value)
121
return unicode(value)
240
122
241
123
# Create format string to print table rows
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)
124
format_string = " ".join("%%-%ds" %
125
max(len(tablewords[key]),
126
max(len(valuetostring(client[key],
127
key))
128
for client in
129
clients))
247
130
for key in keywords)
248
131
# Print header line
249
print(format_string.format(**tablewords))
132
print(format_string % tuple(tablewords[key] for key in keywords))
250
133
for client in clients:
251
print(format_string.format(**{
252
key: valuetostring(client[key], key)
253
for key in keywords }))
254
134
print(format_string % tuple(valuetostring(client[key], key)
135
for key in keywords))
255
136
256
137
def has_actions(options):
257
138
return any((options.enable,
273
154
options.approve,
274
155
options.deny))
275
156
276
277
157
def main():
278
158
parser = argparse.ArgumentParser()
279
159
parser.add_argument("--version", action="version",
280
version = "%(prog)s {}".format(version),
160
version = "%%prog %s" % version,
281
161
help="show version number and exit")
282
162
parser.add_argument("-a", "--all", action="store_true",
283
163
help="Select all clients")
284
164
parser.add_argument("-v", "--verbose", action="store_true",
285
165
help="Print all fields")
286
parser.add_argument("-j", "--dump-json", action="store_true",
287
help="Dump client data in JSON format")
288
166
parser.add_argument("-e", "--enable", action="store_true",
289
167
help="Enable client")
290
168
parser.add_argument("-d", "--disable", action="store_true",
318
196
parser.add_argument("--approval-duration",
319
197
help="Set duration of one client approval")
320
198
parser.add_argument("-H", "--host", help="Set host for client")
321
parser.add_argument("-s", "--secret",
322
type=argparse.FileType(mode="rb"),
199
parser.add_argument("-s", "--secret", type=file,
323
200
help="Set password blob (file) for client")
324
201
parser.add_argument("-A", "--approve", action="store_true",
325
202
help="Approve any current client request")
326
203
parser.add_argument("-D", "--deny", action="store_true",
327
204
help="Deny any current client request")
328
parser.add_argument("--check", action="store_true",
329
help="Run self-test")
330
205
parser.add_argument("client", nargs="*", help="Client name")
331
206
options = parser.parse_args()
332
207
333
if has_actions(options) and not (options.client or options.all):
208
if has_actions(options) and not options.client and not options.all:
334
209
parser.error("Options require clients names or --all.")
335
210
if options.verbose and has_actions(options):
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.")
211
parser.error("--verbose can only be used alone or with"
212
" --all.")
339
213
if options.all and not has_actions(options):
340
214
parser.error("--all requires an action.")
341
215
342
if options.check:
343
fail_count, test_count = doctest.testmod()
344
sys.exit(os.EX_OK if fail_count == 0 else 1)
345
346
216
try:
347
217
bus = dbus.SystemBus()
348
218
mandos_dbus_objc = bus.get_object(busname, server_path)
349
219
except dbus.exceptions.DBusException:
350
print("Could not connect to Mandos server", file=sys.stderr)
220
print("Could not connect to Mandos server",
221
file=sys.stderr)
351
222
sys.exit(1)
352
223
353
224
mandos_serv = dbus.Interface(mandos_dbus_objc,
354
225
dbus_interface = server_interface)
355
mandos_serv_object_manager = dbus.Interface(
356
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
357
226
358
227
#block stderr since dbus library prints to stderr
359
228
null = os.open(os.path.devnull, os.O_RDWR)
362
231
os.close(null)
363
232
try:
364
233
try:
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 }
234
mandos_clients = mandos_serv.GetAllClientsWithProperties()
370
235
finally:
371
236
#restore stderr
372
237
os.dup2(stderrcopy, sys.stderr.fileno())
373
238
os.close(stderrcopy)
374
except dbus.exceptions.DBusException as e:
375
print("Access denied: Accessing mandos server through D-Bus: {}"
376
.format(e), file=sys.stderr)
239
except dbus.exceptions.DBusException:
240
print("Access denied: Accessing mandos server through dbus.",
241
file=sys.stderr)
377
242
sys.exit(1)
378
243
379
244
# Compile dict of (clients: properties) to process
380
245
clients={}
381
246
382
247
if options.all or not options.client:
383
clients = { bus.get_object(busname, path): properties
384
for path, properties in mandos_clients.items() }
248
clients = dict((bus.get_object(busname, path), properties)
249
for path, properties in
250
mandos_clients.iteritems())
385
251
else:
386
252
for name in options.client:
387
for path, client in mandos_clients.items():
253
for path, client in mandos_clients.iteritems():
388
254
if client["Name"] == name:
389
255
client_objc = bus.get_object(busname, path)
390
256
clients[client_objc] = client
391
257
break
392
258
else:
393
print("Client not found on server: {!r}"
394
.format(name), file=sys.stderr)
259
print("Client not found on server: %r" % name,
260
file=sys.stderr)
395
261
sys.exit(1)
396
262
397
263
if not has_actions(options) and clients:
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",
264
if options.verbose:
265
keywords = ("Name", "Enabled", "Timeout",
266
"LastCheckedOK", "Created", "Interval",
267
"Host", "Fingerprint", "CheckerRunning",
268
"LastEnabled", "ApprovalPending",
269
"ApprovedByDefault",
403
270
"LastApprovalRequest", "ApprovalDelay",
404
271
"ApprovalDuration", "Checker",
405
"ExtendedTimeout", "Expires",
406
"LastCheckerStatus")
272
"ExtendedTimeout")
407
273
else:
408
274
keywords = defaultkeywords
409
275
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)
276
print_clients(clients.values(), keywords)
423
277
else:
424
278
# Process each client in the list by all selected options
425
279
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
439
280
if options.remove:
440
281
mandos_serv.RemoveClient(client.__dbus_object_path__)
441
282
if options.enable:
442
set_client_prop("Enabled", dbus.Boolean(True))
283
client.Enable(dbus_interface=client_interface)
443
284
if options.disable:
444
set_client_prop("Enabled", dbus.Boolean(False))
285
client.Disable(dbus_interface=client_interface)
445
286
if options.bump_timeout:
446
set_client_prop("LastCheckedOK", "")
287
client.CheckedOK(dbus_interface=client_interface)
447
288
if options.start_checker:
448
set_client_prop("CheckerRunning", dbus.Boolean(True))
289
client.StartChecker(dbus_interface=client_interface)
449
290
if options.stop_checker:
450
set_client_prop("CheckerRunning", dbus.Boolean(False))
291
client.StopChecker(dbus_interface=client_interface)
451
292
if options.is_enabled:
452
293
sys.exit(0 if client.Get(client_interface,
453
294
"Enabled",
455
296
dbus.PROPERTIES_IFACE)
456
297
else 1)
457
298
if options.checker is not None:
458
set_client_prop("Checker", options.checker)
299
client.Set(client_interface, "Checker",
300
options.checker,
301
dbus_interface=dbus.PROPERTIES_IFACE)
459
302
if options.host is not None:
460
set_client_prop("Host", options.host)
303
client.Set(client_interface, "Host", options.host,
304
dbus_interface=dbus.PROPERTIES_IFACE)
461
305
if options.interval is not None:
462
set_client_prop_ms("Interval", options.interval)
306
client.Set(client_interface, "Interval",
307
timedelta_to_milliseconds
308
(string_to_delta(options.interval)),
309
dbus_interface=dbus.PROPERTIES_IFACE)
463
310
if options.approval_delay is not None:
464
set_client_prop_ms("ApprovalDelay",
465
options.approval_delay)
311
client.Set(client_interface, "ApprovalDelay",
312
timedelta_to_milliseconds
313
(string_to_delta(options.
314
approval_delay)),
315
dbus_interface=dbus.PROPERTIES_IFACE)
466
316
if options.approval_duration is not None:
467
set_client_prop_ms("ApprovalDuration",
468
options.approval_duration)
317
client.Set(client_interface, "ApprovalDuration",
318
timedelta_to_milliseconds
319
(string_to_delta(options.
320
approval_duration)),
321
dbus_interface=dbus.PROPERTIES_IFACE)
469
322
if options.timeout is not None:
470
set_client_prop_ms("Timeout", options.timeout)
323
client.Set(client_interface, "Timeout",
324
timedelta_to_milliseconds
325
(string_to_delta(options.timeout)),
326
dbus_interface=dbus.PROPERTIES_IFACE)
471
327
if options.extended_timeout is not None:
472
set_client_prop_ms("ExtendedTimeout",
473
options.extended_timeout)
328
client.Set(client_interface, "ExtendedTimeout",
329
timedelta_to_milliseconds
330
(string_to_delta(options.extended_timeout)),
331
dbus_interface=dbus.PROPERTIES_IFACE)
474
332
if options.secret is not None:
475
set_client_prop("Secret",
476
dbus.ByteArray(options.secret.read()))
333
client.Set(client_interface, "Secret",
334
dbus.ByteArray(open(options.secret,
335
"rb").read()),
336
dbus_interface=dbus.PROPERTIES_IFACE)
477
337
if options.approved_by_default is not None:
478
set_client_prop("ApprovedByDefault",
479
dbus.Boolean(options
480
.approved_by_default))
338
client.Set(client_interface, "ApprovedByDefault",
339
dbus.Boolean(options
340
.approved_by_default),
341
dbus_interface=dbus.PROPERTIES_IFACE)
481
342
if options.approve:
482
343
client.Approve(dbus.Boolean(True),
483
344
dbus_interface=client_interface)
485
346
client.Approve(dbus.Boolean(False),
486
347
dbus_interface=client_interface)
487
348
488
489
349
if __name__ == "__main__":
490
350
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0