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 585
- compare with another revision
- download diff
- download tarball
- view history from revision 585
- Committer: Teddy Hogeborn
- Date: 2012-05-17 01:55:58 UTC
- Revision ID: teddy@recompile.se-20120517015558-5703p8nkquc2rhgd
* .bzrignore (statedir): Added.
added
removed
mandos-ctl
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
#
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
#
6
# Copyright © 2008-2017 Teddy Hogeborn
7
# Copyright © 2008-2017 Björn Påhlsson
8
#
5
#
6
# Copyright © 2008-2012 Teddy Hogeborn
7
# Copyright © 2008-2012 Björn Påhlsson
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
11
11
# the Free Software Foundation, either version 3 of the License, or
15
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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
20
# along with this program. If not, see
21
21
# <http://www.gnu.org/licenses/>.
22
#
22
#
23
23
# Contact the authors at <mandos@recompile.se>.
24
#
24
#
25
25
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 json
42
43
import dbus
44
45
if sys.version_info.major == 2:
46
str = unicode
47
38
48
39
locale.setlocale(locale.LC_ALL, "")
49
40
64
55
"ApprovalDelay": "Approval Delay",
65
56
"ApprovalDuration": "Approval Duration",
66
57
"Checker": "Checker",
67
"ExtendedTimeout": "Extended Timeout",
68
"Expires": "Expires",
69
"LastCheckerStatus": "Last Checker Status",
70
}
58
"ExtendedTimeout" : "Extended Timeout"
59
}
71
60
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
72
61
domain = "se.recompile"
73
62
busname = domain + ".Mandos"
74
63
server_path = "/"
75
64
server_interface = domain + ".Mandos"
76
65
client_interface = domain + ".Mandos.Client"
77
version = "1.7.15"
78
79
80
try:
81
dbus.OBJECT_MANAGER_IFACE
82
except AttributeError:
83
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
84
66
version = "1.5.3"
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
76
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
89
.format(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 so far
161
value = datetime.timedelta()
162
found_token = None
163
# Following valid tokens
164
followers = frozenset((token_duration, ))
165
# String left to parse
166
s = duration
167
# Loop until end token is found
168
while found_token is not token_end:
169
# Search for any currently valid tokens
170
for token in followers:
171
match = token.regexp.match(s)
172
if match is not None:
173
# Token found
174
if token.value is not None:
175
# Value found, parse digits
176
factor = int(match.group(1), 10)
177
# Add to value so far
178
value += factor * token.value
179
# Strip token from string
180
s = token.regexp.sub("", s, 1)
181
# Go to found token
182
found_token = token
183
# Set valid next tokens
184
followers = found_token.followers
185
break
186
else:
187
# No currently valid tokens were found
188
raise ValueError("Invalid RFC 3339 duration: {!r}"
189
.format(duration))
190
# End token found
191
return value
192
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
))
193
82
194
83
def string_to_delta(interval):
195
84
"""Parse a string and return a datetime.timedelta
196
197
>>> string_to_delta('7d')
85
86
>>> string_to_delta("7d")
198
87
datetime.timedelta(7)
199
>>> string_to_delta('60s')
88
>>> string_to_delta("60s")
200
89
datetime.timedelta(0, 60)
201
>>> string_to_delta('60m')
90
>>> string_to_delta("60m")
202
91
datetime.timedelta(0, 3600)
203
>>> string_to_delta('24h')
92
>>> string_to_delta("24h")
204
93
datetime.timedelta(1)
205
>>> string_to_delta('1w')
94
>>> string_to_delta("1w")
206
95
datetime.timedelta(7)
207
>>> string_to_delta('5m 30s')
96
>>> string_to_delta("5m 30s")
208
97
datetime.timedelta(0, 330)
209
98
"""
210
211
try:
212
return rfc3339_duration_to_delta(interval)
213
except ValueError:
214
pass
215
216
99
value = datetime.timedelta(0)
217
regexp = re.compile(r"(\d+)([dsmhw]?)")
218
100
regexp = re.compile("(\d+)([dsmhw]?)")
101
219
102
for num, suffix in regexp.findall(interval):
220
103
if suffix == "d":
221
104
value += datetime.timedelta(int(num))
231
114
value += datetime.timedelta(0, 0, 0, int(num))
232
115
return value
233
116
234
235
117
def print_clients(clients, keywords):
236
118
def valuetostring(value, keyword):
237
119
if type(value) is dbus.Boolean:
239
121
if keyword in ("Timeout", "Interval", "ApprovalDelay",
240
122
"ApprovalDuration", "ExtendedTimeout"):
241
123
return milliseconds_to_string(value)
242
return str(value)
243
124
return unicode(value)
125
244
126
# Create format string to print table rows
245
127
format_string = " ".join("{{{key}:{width}}}".format(
246
width=max(len(tablewords[key]),
247
max(len(valuetostring(client[key], key))
248
for client in clients)),
249
key=key)
250
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)
251
134
# Print header line
252
135
print(format_string.format(**tablewords))
253
136
for client in clients:
254
print(format_string
255
.format(**{key: valuetostring(client[key], key)
256
for key in keywords}))
257
137
print(format_string.format(**dict((key,
138
valuetostring(client[key],
139
key))
140
for key in keywords)))
258
141
259
142
def has_actions(options):
260
143
return any((options.enable,
276
159
options.approve,
277
160
options.deny))
278
161
279
280
162
def main():
281
163
parser = argparse.ArgumentParser()
282
164
parser.add_argument("--version", action="version",
283
version="%(prog)s {}".format(version),
165
version = "%(prog)s {0}".format(version),
284
166
help="show version number and exit")
285
167
parser.add_argument("-a", "--all", action="store_true",
286
168
help="Select all clients")
287
169
parser.add_argument("-v", "--verbose", action="store_true",
288
170
help="Print all fields")
289
parser.add_argument("-j", "--dump-json", action="store_true",
290
help="Dump client data in JSON format")
291
171
parser.add_argument("-e", "--enable", action="store_true",
292
172
help="Enable client")
293
173
parser.add_argument("-d", "--disable", action="store_true",
321
201
parser.add_argument("--approval-duration",
322
202
help="Set duration of one client approval")
323
203
parser.add_argument("-H", "--host", help="Set host for client")
324
parser.add_argument("-s", "--secret",
325
type=argparse.FileType(mode="rb"),
204
parser.add_argument("-s", "--secret", type=file,
326
205
help="Set password blob (file) for client")
327
206
parser.add_argument("-A", "--approve", action="store_true",
328
207
help="Approve any current client request")
329
208
parser.add_argument("-D", "--deny", action="store_true",
330
209
help="Deny any current client request")
331
parser.add_argument("--check", action="store_true",
332
help="Run self-test")
333
210
parser.add_argument("client", nargs="*", help="Client name")
334
211
options = parser.parse_args()
335
212
336
213
if has_actions(options) and not (options.client or options.all):
337
214
parser.error("Options require clients names or --all.")
338
215
if options.verbose and has_actions(options):
339
parser.error("--verbose can only be used alone.")
340
if options.dump_json and (options.verbose
341
or has_actions(options)):
342
parser.error("--dump-json can only be used alone.")
216
parser.error("--verbose can only be used alone or with"
217
" --all.")
343
218
if options.all and not has_actions(options):
344
219
parser.error("--all requires an action.")
345
346
if options.check:
347
import doctest
348
fail_count, test_count = doctest.testmod()
349
sys.exit(os.EX_OK if fail_count == 0 else 1)
350
220
351
221
try:
352
222
bus = dbus.SystemBus()
353
223
mandos_dbus_objc = bus.get_object(busname, server_path)
354
224
except dbus.exceptions.DBusException:
355
print("Could not connect to Mandos server", file=sys.stderr)
225
print("Could not connect to Mandos server",
226
file=sys.stderr)
356
227
sys.exit(1)
357
228
358
229
mandos_serv = dbus.Interface(mandos_dbus_objc,
359
dbus_interface=server_interface)
360
mandos_serv_object_manager = dbus.Interface(
361
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
362
363
# block stderr since dbus library prints to stderr
230
dbus_interface = server_interface)
231
232
#block stderr since dbus library prints to stderr
364
233
null = os.open(os.path.devnull, os.O_RDWR)
365
234
stderrcopy = os.dup(sys.stderr.fileno())
366
235
os.dup2(null, sys.stderr.fileno())
367
236
os.close(null)
368
237
try:
369
238
try:
370
mandos_clients = {path: ifs_and_props[client_interface]
371
for path, ifs_and_props in
372
mandos_serv_object_manager
373
.GetManagedObjects().items()
374
if client_interface in ifs_and_props}
239
mandos_clients = mandos_serv.GetAllClientsWithProperties()
375
240
finally:
376
# restore stderr
241
#restore stderr
377
242
os.dup2(stderrcopy, sys.stderr.fileno())
378
243
os.close(stderrcopy)
379
except dbus.exceptions.DBusException as e:
380
print("Access denied: "
381
"Accessing mandos server through D-Bus: {}".format(e),
244
except dbus.exceptions.DBusException:
245
print("Access denied: Accessing mandos server through dbus.",
382
246
file=sys.stderr)
383
247
sys.exit(1)
384
248
385
249
# Compile dict of (clients: properties) to process
386
clients = {}
387
250
clients={}
251
388
252
if options.all or not options.client:
389
clients = {bus.get_object(busname, path): properties
390
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())
391
256
else:
392
257
for name in options.client:
393
for path, client in mandos_clients.items():
258
for path, client in mandos_clients.iteritems():
394
259
if client["Name"] == name:
395
260
client_objc = bus.get_object(busname, path)
396
261
clients[client_objc] = client
397
262
break
398
263
else:
399
print("Client not found on server: {!r}"
264
print("Client not found on server: {0!r}"
400
265
.format(name), file=sys.stderr)
401
266
sys.exit(1)
402
267
403
268
if not has_actions(options) and clients:
404
if options.verbose or options.dump_json:
405
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
406
"Created", "Interval", "Host", "Fingerprint",
407
"CheckerRunning", "LastEnabled",
408
"ApprovalPending", "ApprovedByDefault",
269
if options.verbose:
270
keywords = ("Name", "Enabled", "Timeout",
271
"LastCheckedOK", "Created", "Interval",
272
"Host", "Fingerprint", "CheckerRunning",
273
"LastEnabled", "ApprovalPending",
274
"ApprovedByDefault",
409
275
"LastApprovalRequest", "ApprovalDelay",
410
276
"ApprovalDuration", "Checker",
411
"ExtendedTimeout", "Expires",
412
"LastCheckerStatus")
277
"ExtendedTimeout")
413
278
else:
414
279
keywords = defaultkeywords
415
416
if options.dump_json:
417
json.dump({client["Name"]: {key:
418
bool(client[key])
419
if isinstance(client[key],
420
dbus.Boolean)
421
else client[key]
422
for key in keywords}
423
for client in clients.values()},
424
fp=sys.stdout, indent=4,
425
separators=(',', ': '))
426
print()
427
else:
428
print_clients(clients.values(), keywords)
280
281
print_clients(clients.values(), keywords)
429
282
else:
430
283
# Process each client in the list by all selected options
431
284
for client in clients:
432
433
285
def set_client_prop(prop, value):
434
286
"""Set a Client D-Bus property"""
435
287
client.Set(client_interface, prop, value,
436
288
dbus_interface=dbus.PROPERTIES_IFACE)
437
438
289
def set_client_prop_ms(prop, value):
439
290
"""Set a Client D-Bus property, converted
440
291
from a string to milliseconds."""
441
292
set_client_prop(prop,
442
string_to_delta(value).total_seconds()
443
* 1000)
444
293
timedelta_to_milliseconds
294
(string_to_delta(value)))
445
295
if options.remove:
446
296
mandos_serv.RemoveClient(client.__dbus_object_path__)
447
297
if options.enable:
455
305
if options.stop_checker:
456
306
set_client_prop("CheckerRunning", dbus.Boolean(False))
457
307
if options.is_enabled:
458
if client.Get(client_interface, "Enabled",
459
dbus_interface=dbus.PROPERTIES_IFACE):
460
sys.exit(0)
461
else:
462
sys.exit(1)
308
sys.exit(0 if client.Get(client_interface,
309
"Enabled",
310
dbus_interface=
311
dbus.PROPERTIES_IFACE)
312
else 1)
463
313
if options.checker is not None:
464
314
set_client_prop("Checker", options.checker)
465
315
if options.host is not None:
491
341
client.Approve(dbus.Boolean(False),
492
342
dbus_interface=client_interface)
493
343
494
495
344
if __name__ == "__main__":
496
345
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0