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 595
- compare with another revision
- download diff
- download tarball
- view history from revision 595
- Committer: Teddy Hogeborn
- Date: 2012-06-06 14:12:50 UTC
- Revision ID: teddy@recompile.se-20120606141250-5zxn3syowzb4t437
* Makefile (DOCBOOKTOMAN): Don't show errors from "locale".
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-2012 Teddy Hogeborn
7
# Copyright © 2008-2012 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
26
26
from __future__ import (division, absolute_import, print_function,
27
27
unicode_literals)
28
28
29
try:
30
from future_builtins import *
31
except ImportError:
32
pass
29
from future_builtins import *
33
30
34
31
import sys
32
import dbus
35
33
import argparse
36
34
import locale
37
35
import datetime
38
36
import re
39
37
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
38
49
39
locale.setlocale(locale.LC_ALL, "")
50
40
65
55
"ApprovalDelay": "Approval Delay",
66
56
"ApprovalDuration": "Approval Duration",
67
57
"Checker": "Checker",
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
58
"ExtendedTimeout" : "Extended Timeout"
59
}
72
60
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
61
domain = "se.recompile"
74
62
busname = domain + ".Mandos"
75
63
server_path = "/"
76
64
server_interface = domain + ".Mandos"
77
65
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"
66
version = "1.5.5"
67
68
def timedelta_to_milliseconds(td):
69
"""Convert a datetime.timedelta object to milliseconds"""
70
return ((td.days * 24 * 60 * 60 * 1000)
71
+ (td.seconds * 1000)
72
+ (td.microseconds // 1000))
85
73
86
74
def milliseconds_to_string(ms):
87
75
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
76
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
77
.format(days = "{0}T".format(td.days) if td.days else "",
78
hours = td.seconds // 3600,
79
minutes = (td.seconds % 3600) // 60,
80
seconds = td.seconds % 60,
81
))
190
82
191
83
def string_to_delta(interval):
192
84
"""Parse a string and return a datetime.timedelta
193
85
194
>>> string_to_delta('7d')
86
>>> string_to_delta("7d")
195
87
datetime.timedelta(7)
196
>>> string_to_delta('60s')
88
>>> string_to_delta("60s")
197
89
datetime.timedelta(0, 60)
198
>>> string_to_delta('60m')
90
>>> string_to_delta("60m")
199
91
datetime.timedelta(0, 3600)
200
>>> string_to_delta('24h')
92
>>> string_to_delta("24h")
201
93
datetime.timedelta(1)
202
>>> string_to_delta('1w')
94
>>> string_to_delta("1w")
203
95
datetime.timedelta(7)
204
>>> string_to_delta('5m 30s')
96
>>> string_to_delta("5m 30s")
205
97
datetime.timedelta(0, 330)
206
98
"""
207
208
try:
209
return rfc3339_duration_to_delta(interval)
210
except ValueError:
211
pass
212
213
99
value = datetime.timedelta(0)
214
regexp = re.compile(r"(\d+)([dsmhw]?)")
100
regexp = re.compile("(\d+)([dsmhw]?)")
215
101
216
102
for num, suffix in regexp.findall(interval):
217
103
if suffix == "d":
228
114
value += datetime.timedelta(0, 0, 0, int(num))
229
115
return value
230
116
231
232
117
def print_clients(clients, keywords):
233
118
def valuetostring(value, keyword):
234
119
if type(value) is dbus.Boolean:
236
121
if keyword in ("Timeout", "Interval", "ApprovalDelay",
237
122
"ApprovalDuration", "ExtendedTimeout"):
238
123
return milliseconds_to_string(value)
239
return str(value)
124
return unicode(value)
240
125
241
126
# Create format string to print table rows
242
127
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)
247
for key in keywords)
128
width = max(len(tablewords[key]),
129
max(len(valuetostring(client[key],
130
key))
131
for client in
132
clients)),
133
key = key) for key in keywords)
248
134
# Print header line
249
135
print(format_string.format(**tablewords))
250
136
for client in clients:
251
print(format_string.format(**{
252
key: valuetostring(client[key], key)
253
for key in keywords }))
254
137
print(format_string.format(**dict((key,
138
valuetostring(client[key],
139
key))
140
for key in keywords)))
255
141
256
142
def has_actions(options):
257
143
return any((options.enable,
273
159
options.approve,
274
160
options.deny))
275
161
276
277
162
def main():
278
163
parser = argparse.ArgumentParser()
279
164
parser.add_argument("--version", action="version",
280
version = "%(prog)s {}".format(version),
165
version = "%(prog)s {0}".format(version),
281
166
help="show version number and exit")
282
167
parser.add_argument("-a", "--all", action="store_true",
283
168
help="Select all clients")
284
169
parser.add_argument("-v", "--verbose", action="store_true",
285
170
help="Print all fields")
286
parser.add_argument("-j", "--dump-json", action="store_true",
287
help="Dump client data in JSON format")
288
171
parser.add_argument("-e", "--enable", action="store_true",
289
172
help="Enable client")
290
173
parser.add_argument("-d", "--disable", action="store_true",
318
201
parser.add_argument("--approval-duration",
319
202
help="Set duration of one client approval")
320
203
parser.add_argument("-H", "--host", help="Set host for client")
321
parser.add_argument("-s", "--secret",
322
type=argparse.FileType(mode="rb"),
204
parser.add_argument("-s", "--secret", type=file,
323
205
help="Set password blob (file) for client")
324
206
parser.add_argument("-A", "--approve", action="store_true",
325
207
help="Approve any current client request")
326
208
parser.add_argument("-D", "--deny", action="store_true",
327
209
help="Deny any current client request")
328
parser.add_argument("--check", action="store_true",
329
help="Run self-test")
330
210
parser.add_argument("client", nargs="*", help="Client name")
331
211
options = parser.parse_args()
332
212
333
213
if has_actions(options) and not (options.client or options.all):
334
214
parser.error("Options require clients names or --all.")
335
215
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.")
216
parser.error("--verbose can only be used alone or with"
217
" --all.")
339
218
if options.all and not has_actions(options):
340
219
parser.error("--all requires an action.")
341
220
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
221
try:
347
222
bus = dbus.SystemBus()
348
223
mandos_dbus_objc = bus.get_object(busname, server_path)
349
224
except dbus.exceptions.DBusException:
350
print("Could not connect to Mandos server", file=sys.stderr)
225
print("Could not connect to Mandos server",
226
file=sys.stderr)
351
227
sys.exit(1)
352
228
353
229
mandos_serv = dbus.Interface(mandos_dbus_objc,
354
230
dbus_interface = server_interface)
355
mandos_serv_object_manager = dbus.Interface(
356
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
357
231
358
232
#block stderr since dbus library prints to stderr
359
233
null = os.open(os.path.devnull, os.O_RDWR)
362
236
os.close(null)
363
237
try:
364
238
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 }
239
mandos_clients = mandos_serv.GetAllClientsWithProperties()
370
240
finally:
371
241
#restore stderr
372
242
os.dup2(stderrcopy, sys.stderr.fileno())
373
243
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)
244
except dbus.exceptions.DBusException:
245
print("Access denied: Accessing mandos server through dbus.",
246
file=sys.stderr)
377
247
sys.exit(1)
378
248
379
249
# Compile dict of (clients: properties) to process
380
250
clients={}
381
251
382
252
if options.all or not options.client:
383
clients = { bus.get_object(busname, path): properties
384
for path, properties in mandos_clients.items() }
253
clients = dict((bus.get_object(busname, path), properties)
254
for path, properties in
255
mandos_clients.iteritems())
385
256
else:
386
257
for name in options.client:
387
for path, client in mandos_clients.items():
258
for path, client in mandos_clients.iteritems():
388
259
if client["Name"] == name:
389
260
client_objc = bus.get_object(busname, path)
390
261
clients[client_objc] = client
391
262
break
392
263
else:
393
print("Client not found on server: {!r}"
264
print("Client not found on server: {0!r}"
394
265
.format(name), file=sys.stderr)
395
266
sys.exit(1)
396
267
397
268
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",
269
if options.verbose:
270
keywords = ("Name", "Enabled", "Timeout",
271
"LastCheckedOK", "Created", "Interval",
272
"Host", "Fingerprint", "CheckerRunning",
273
"LastEnabled", "ApprovalPending",
274
"ApprovedByDefault",
403
275
"LastApprovalRequest", "ApprovalDelay",
404
276
"ApprovalDuration", "Checker",
405
"ExtendedTimeout", "Expires",
406
"LastCheckerStatus")
277
"ExtendedTimeout")
407
278
else:
408
279
keywords = defaultkeywords
409
280
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)
281
print_clients(clients.values(), keywords)
423
282
else:
424
283
# Process each client in the list by all selected options
425
284
for client in clients:
426
427
285
def set_client_prop(prop, value):
428
286
"""Set a Client D-Bus property"""
429
287
client.Set(client_interface, prop, value,
430
288
dbus_interface=dbus.PROPERTIES_IFACE)
431
432
289
def set_client_prop_ms(prop, value):
433
290
"""Set a Client D-Bus property, converted
434
291
from a string to milliseconds."""
435
292
set_client_prop(prop,
436
string_to_delta(value).total_seconds()
437
* 1000)
438
293
timedelta_to_milliseconds
294
(string_to_delta(value)))
439
295
if options.remove:
440
296
mandos_serv.RemoveClient(client.__dbus_object_path__)
441
297
if options.enable:
485
341
client.Approve(dbus.Boolean(False),
486
342
dbus_interface=client_interface)
487
343
488
489
344
if __name__ == "__main__":
490
345
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0