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 888
- compare with another revision
- download diff
- download tarball
- view history from revision 888
- Committer: Teddy Hogeborn
- Date: 2016-11-26 23:18:55 UTC
- Revision ID: teddy@recompile.se-20161126231855-vseam120ph8856a1
Add more PEP8 compliance (as per the "pycodestyle" tool).
* mandos: Add an empty line to be more PEP8 compliant.
* mandos-monitor: - '' -
* mandos: Add an empty line to be more PEP8 compliant.
* mandos-monitor: - '' -
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-2014 Teddy Hogeborn
7
# Copyright © 2008-2014 Björn Påhlsson
8
#
5
#
6
# Copyright © 2008-2016 Teddy Hogeborn
7
# Copyright © 2008-2016 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)
39
39
import os
40
40
import collections
41
41
import doctest
42
import json
42
43
43
44
import dbus
44
45
45
if sys.version_info[0] == 2:
46
if sys.version_info.major == 2:
46
47
str = unicode
47
48
48
49
locale.setlocale(locale.LC_ALL, "")
64
65
"ApprovalDelay": "Approval Delay",
65
66
"ApprovalDuration": "Approval Duration",
66
67
"Checker": "Checker",
67
"ExtendedTimeout" : "Extended Timeout"
68
}
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
69
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
73
domain = "se.recompile"
71
74
busname = domain + ".Mandos"
72
75
server_path = "/"
73
76
server_interface = domain + ".Mandos"
74
77
client_interface = domain + ".Mandos.Client"
75
version = "1.6.7"
76
77
def timedelta_to_milliseconds(td):
78
"""Convert a datetime.timedelta object to milliseconds"""
79
return ((td.days * 24 * 60 * 60 * 1000)
80
+ (td.seconds * 1000)
81
+ (td.microseconds // 1000))
78
version = "1.7.13"
79
80
81
try:
82
dbus.OBJECT_MANAGER_IFACE
83
except AttributeError:
84
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
82
86
83
87
def milliseconds_to_string(ms):
84
88
td = datetime.timedelta(0, 0, 0, ms)
85
89
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
86
.format(days = "{0}T".format(td.days) if td.days else "",
87
hours = td.seconds // 3600,
88
minutes = (td.seconds % 3600) // 60,
89
seconds = td.seconds % 60,
90
))
90
.format(days="{}T".format(td.days) if td.days else "",
91
hours=td.seconds // 3600,
92
minutes=(td.seconds % 3600) // 60,
93
seconds=td.seconds % 60))
91
94
92
95
93
96
def rfc3339_duration_to_delta(duration):
94
97
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
95
98
96
99
>>> rfc3339_duration_to_delta("P7D")
97
100
datetime.timedelta(7)
98
101
>>> rfc3339_duration_to_delta("PT60S")
108
111
>>> rfc3339_duration_to_delta("P1DT3M20S")
109
112
datetime.timedelta(1, 200)
110
113
"""
111
114
112
115
# Parsing an RFC 3339 duration with regular expressions is not
113
116
# possible - there would have to be multiple places for the same
114
117
# values, like seconds. The current code, while more esoteric, is
115
118
# cleaner without depending on a parsing library. If Python had a
116
119
# built-in library for parsing we would use it, but we'd like to
117
120
# avoid excessive use of external libraries.
118
121
119
122
# New type for defining tokens, syntax, and semantics all-in-one
120
Token = collections.namedtuple("Token",
121
("regexp", # To match token; if
122
# "value" is not None,
123
# must have a "group"
124
# containing digits
125
"value", # datetime.timedelta or
126
# None
127
"followers")) # Tokens valid after
128
# this token
123
Token = collections.namedtuple("Token", (
124
"regexp", # To match token; if "value" is not None, must have
125
# a "group" containing digits
126
"value", # datetime.timedelta or None
127
"followers")) # Tokens valid after this token
129
128
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
129
# the "duration" ABNF definition in RFC 3339, Appendix A.
131
130
token_end = Token(re.compile(r"$"), None, frozenset())
132
131
token_second = Token(re.compile(r"(\d+)S"),
133
132
datetime.timedelta(seconds=1),
134
frozenset((token_end,)))
133
frozenset((token_end, )))
135
134
token_minute = Token(re.compile(r"(\d+)M"),
136
135
datetime.timedelta(minutes=1),
137
136
frozenset((token_second, token_end)))
153
152
frozenset((token_month, token_end)))
154
153
token_week = Token(re.compile(r"(\d+)W"),
155
154
datetime.timedelta(weeks=1),
156
frozenset((token_end,)))
155
frozenset((token_end, )))
157
156
token_duration = Token(re.compile(r"P"), None,
158
157
frozenset((token_year, token_month,
159
158
token_day, token_time,
160
159
token_week)))
161
# Define starting values
162
value = datetime.timedelta() # Value so far
160
# Define starting values:
161
# Value so far
162
value = datetime.timedelta()
163
163
found_token = None
164
followers = frozenset((token_duration,)) # Following valid tokens
165
s = duration # String left to parse
164
# Following valid tokens
165
followers = frozenset((token_duration, ))
166
# String left to parse
167
s = duration
166
168
# Loop until end token is found
167
169
while found_token is not token_end:
168
170
# Search for any currently valid tokens
184
186
break
185
187
else:
186
188
# No currently valid tokens were found
187
raise ValueError("Invalid RFC 3339 duration")
189
raise ValueError("Invalid RFC 3339 duration: {!r}"
190
.format(duration))
188
191
# End token found
189
192
return value
190
193
191
194
192
195
def string_to_delta(interval):
193
196
"""Parse a string and return a datetime.timedelta
194
195
>>> string_to_delta("7d")
197
198
>>> string_to_delta('7d')
196
199
datetime.timedelta(7)
197
>>> string_to_delta("60s")
200
>>> string_to_delta('60s')
198
201
datetime.timedelta(0, 60)
199
>>> string_to_delta("60m")
202
>>> string_to_delta('60m')
200
203
datetime.timedelta(0, 3600)
201
>>> string_to_delta("24h")
204
>>> string_to_delta('24h')
202
205
datetime.timedelta(1)
203
>>> string_to_delta("1w")
206
>>> string_to_delta('1w')
204
207
datetime.timedelta(7)
205
>>> string_to_delta("5m 30s")
208
>>> string_to_delta('5m 30s')
206
209
datetime.timedelta(0, 330)
207
210
"""
208
211
209
212
try:
210
213
return rfc3339_duration_to_delta(interval)
211
214
except ValueError:
212
215
pass
213
216
214
217
value = datetime.timedelta(0)
215
218
regexp = re.compile(r"(\d+)([dsmhw]?)")
216
219
217
220
for num, suffix in regexp.findall(interval):
218
221
if suffix == "d":
219
222
value += datetime.timedelta(int(num))
229
232
value += datetime.timedelta(0, 0, 0, int(num))
230
233
return value
231
234
235
232
236
def print_clients(clients, keywords):
233
237
def valuetostring(value, keyword):
234
238
if type(value) is dbus.Boolean:
237
241
"ApprovalDuration", "ExtendedTimeout"):
238
242
return milliseconds_to_string(value)
239
243
return str(value)
240
244
241
245
# Create format string to print table rows
242
246
format_string = " ".join("{{{key}:{width}}}".format(
243
width = max(len(tablewords[key]),
244
max(len(valuetostring(client[key],
245
key))
246
for client in
247
clients)),
248
key = key) for key in keywords)
247
width=max(len(tablewords[key]),
248
max(len(valuetostring(client[key], key))
249
for client in clients)),
250
key=key)
251
for key in keywords)
249
252
# Print header line
250
253
print(format_string.format(**tablewords))
251
254
for client in clients:
252
print(format_string.format(**dict((key,
253
valuetostring(client[key],
254
key))
255
for key in keywords)))
255
print(format_string
256
.format(**{key: valuetostring(client[key], key)
257
for key in keywords}))
258
256
259
257
260
def has_actions(options):
258
261
return any((options.enable,
274
277
options.approve,
275
278
options.deny))
276
279
280
277
281
def main():
278
282
parser = argparse.ArgumentParser()
279
283
parser.add_argument("--version", action="version",
280
version = "%(prog)s {0}".format(version),
284
version="%(prog)s {}".format(version),
281
285
help="show version number and exit")
282
286
parser.add_argument("-a", "--all", action="store_true",
283
287
help="Select all clients")
284
288
parser.add_argument("-v", "--verbose", action="store_true",
285
289
help="Print all fields")
290
parser.add_argument("-j", "--dump-json", action="store_true",
291
help="Dump client data in JSON format")
286
292
parser.add_argument("-e", "--enable", action="store_true",
287
293
help="Enable client")
288
294
parser.add_argument("-d", "--disable", action="store_true",
327
333
help="Run self-test")
328
334
parser.add_argument("client", nargs="*", help="Client name")
329
335
options = parser.parse_args()
330
336
331
337
if has_actions(options) and not (options.client or options.all):
332
338
parser.error("Options require clients names or --all.")
333
339
if options.verbose and has_actions(options):
334
parser.error("--verbose can only be used alone or with"
335
" --all.")
340
parser.error("--verbose can only be used alone.")
341
if options.dump_json and (options.verbose
342
or has_actions(options)):
343
parser.error("--dump-json can only be used alone.")
336
344
if options.all and not has_actions(options):
337
345
parser.error("--all requires an action.")
338
346
339
347
if options.check:
340
348
fail_count, test_count = doctest.testmod()
341
349
sys.exit(os.EX_OK if fail_count == 0 else 1)
342
350
343
351
try:
344
352
bus = dbus.SystemBus()
345
353
mandos_dbus_objc = bus.get_object(busname, server_path)
346
354
except dbus.exceptions.DBusException:
347
print("Could not connect to Mandos server",
348
file=sys.stderr)
355
print("Could not connect to Mandos server", file=sys.stderr)
349
356
sys.exit(1)
350
357
351
358
mandos_serv = dbus.Interface(mandos_dbus_objc,
352
dbus_interface = server_interface)
353
354
#block stderr since dbus library prints to stderr
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
355
364
null = os.open(os.path.devnull, os.O_RDWR)
356
365
stderrcopy = os.dup(sys.stderr.fileno())
357
366
os.dup2(null, sys.stderr.fileno())
358
367
os.close(null)
359
368
try:
360
369
try:
361
mandos_clients = mandos_serv.GetAllClientsWithProperties()
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}
362
375
finally:
363
#restore stderr
376
# restore stderr
364
377
os.dup2(stderrcopy, sys.stderr.fileno())
365
378
os.close(stderrcopy)
366
except dbus.exceptions.DBusException:
367
print("Access denied: Accessing mandos server through dbus.",
379
except dbus.exceptions.DBusException as e:
380
print("Access denied: "
381
"Accessing mandos server through D-Bus: {}".format(e),
368
382
file=sys.stderr)
369
383
sys.exit(1)
370
384
371
385
# Compile dict of (clients: properties) to process
372
clients={}
373
386
clients = {}
387
374
388
if options.all or not options.client:
375
clients = dict((bus.get_object(busname, path), properties)
376
for path, properties in
377
mandos_clients.items())
389
clients = {bus.get_object(busname, path): properties
390
for path, properties in mandos_clients.items()}
378
391
else:
379
392
for name in options.client:
380
for path, client in mandos_clients.iteritems():
393
for path, client in mandos_clients.items():
381
394
if client["Name"] == name:
382
395
client_objc = bus.get_object(busname, path)
383
396
clients[client_objc] = client
384
397
break
385
398
else:
386
print("Client not found on server: {0!r}"
399
print("Client not found on server: {!r}"
387
400
.format(name), file=sys.stderr)
388
401
sys.exit(1)
389
402
390
403
if not has_actions(options) and clients:
391
if options.verbose:
392
keywords = ("Name", "Enabled", "Timeout",
393
"LastCheckedOK", "Created", "Interval",
394
"Host", "Fingerprint", "CheckerRunning",
395
"LastEnabled", "ApprovalPending",
396
"ApprovedByDefault",
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",
397
409
"LastApprovalRequest", "ApprovalDelay",
398
410
"ApprovalDuration", "Checker",
399
"ExtendedTimeout")
411
"ExtendedTimeout", "Expires",
412
"LastCheckerStatus")
400
413
else:
401
414
keywords = defaultkeywords
402
403
print_clients(clients.values(), keywords)
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)
404
429
else:
405
430
# Process each client in the list by all selected options
406
431
for client in clients:
432
407
433
def set_client_prop(prop, value):
408
434
"""Set a Client D-Bus property"""
409
435
client.Set(client_interface, prop, value,
410
436
dbus_interface=dbus.PROPERTIES_IFACE)
437
411
438
def set_client_prop_ms(prop, value):
412
439
"""Set a Client D-Bus property, converted
413
440
from a string to milliseconds."""
414
441
set_client_prop(prop,
415
timedelta_to_milliseconds
416
(string_to_delta(value)))
442
string_to_delta(value).total_seconds()
443
* 1000)
444
417
445
if options.remove:
418
446
mandos_serv.RemoveClient(client.__dbus_object_path__)
419
447
if options.enable:
427
455
if options.stop_checker:
428
456
set_client_prop("CheckerRunning", dbus.Boolean(False))
429
457
if options.is_enabled:
430
sys.exit(0 if client.Get(client_interface,
431
"Enabled",
432
dbus_interface=
433
dbus.PROPERTIES_IFACE)
434
else 1)
458
if client.Get(client_interface, "Enabled",
459
dbus_interface=dbus.PROPERTIES_IFACE):
460
sys.exit(0)
461
else:
462
sys.exit(1)
435
463
if options.checker is not None:
436
464
set_client_prop("Checker", options.checker)
437
465
if options.host is not None:
463
491
client.Approve(dbus.Boolean(False),
464
492
dbus_interface=client_interface)
465
493
494
466
495
if __name__ == "__main__":
467
496
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0