To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 237.7.433
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.433
- Committer: Teddy Hogeborn
- Date: 2016-10-29 14:22:26 UTC
- mto: (237.7.594 trunk)
- mto: This revision was merged to the branch mainline in revision 356.
- Revision ID: teddy@recompile.se-20161029142226-n4s9d70tuk615pg1
Makefile: Clarify message when running client.
* Makefile (run-client): Clarify message.
* Makefile (run-client): Clarify message.
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-2015 Teddy Hogeborn
7
# Copyright © 2008-2015 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
64
65
"ApprovalDelay": "Approval Delay",
65
66
"ApprovalDuration": "Approval Duration",
66
67
"Checker": "Checker",
67
"ExtendedTimeout": "Extended Timeout"
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
68
71
}
69
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
73
domain = "se.recompile"
72
75
server_path = "/"
73
76
server_interface = domain + ".Mandos"
74
77
client_interface = domain + ".Mandos.Client"
75
version = "1.6.9"
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"
76
85
77
86
78
87
def milliseconds_to_string(ms):
79
88
td = datetime.timedelta(0, 0, 0, ms)
80
return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
81
days = "{}T".format(td.days) if td.days else "",
82
hours = td.seconds // 3600,
83
minutes = (td.seconds % 3600) // 60,
84
seconds = td.seconds % 60))
89
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
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))
85
94
86
95
87
96
def rfc3339_duration_to_delta(duration):
88
97
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
89
98
90
99
>>> rfc3339_duration_to_delta("P7D")
91
100
datetime.timedelta(7)
92
101
>>> rfc3339_duration_to_delta("PT60S")
102
111
>>> rfc3339_duration_to_delta("P1DT3M20S")
103
112
datetime.timedelta(1, 200)
104
113
"""
105
114
106
115
# Parsing an RFC 3339 duration with regular expressions is not
107
116
# possible - there would have to be multiple places for the same
108
117
# values, like seconds. The current code, while more esoteric, is
109
118
# cleaner without depending on a parsing library. If Python had a
110
119
# built-in library for parsing we would use it, but we'd like to
111
120
# avoid excessive use of external libraries.
112
121
113
122
# New type for defining tokens, syntax, and semantics all-in-one
114
Token = collections.namedtuple("Token",
115
("regexp", # To match token; if
116
# "value" is not None,
117
# must have a "group"
118
# containing digits
119
"value", # datetime.timedelta or
120
# None
121
"followers")) # Tokens valid after
122
# 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
123
128
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
129
# the "duration" ABNF definition in RFC 3339, Appendix A.
125
130
token_end = Token(re.compile(r"$"), None, frozenset())
152
157
frozenset((token_year, token_month,
153
158
token_day, token_time,
154
159
token_week)))
155
# Define starting values
156
value = datetime.timedelta() # Value so far
160
# Define starting values:
161
# Value so far
162
value = datetime.timedelta()
157
163
found_token = None
158
followers = frozenset((token_duration, )) # Following valid tokens
159
s = duration # String left to parse
164
# Following valid tokens
165
followers = frozenset((token_duration, ))
166
# String left to parse
167
s = duration
160
168
# Loop until end token is found
161
169
while found_token is not token_end:
162
170
# Search for any currently valid tokens
178
186
break
179
187
else:
180
188
# No currently valid tokens were found
181
raise ValueError("Invalid RFC 3339 duration")
189
raise ValueError("Invalid RFC 3339 duration: {!r}"
190
.format(duration))
182
191
# End token found
183
192
return value
184
193
185
194
186
195
def string_to_delta(interval):
187
196
"""Parse a string and return a datetime.timedelta
188
189
>>> string_to_delta("7d")
197
198
>>> string_to_delta('7d')
190
199
datetime.timedelta(7)
191
>>> string_to_delta("60s")
200
>>> string_to_delta('60s')
192
201
datetime.timedelta(0, 60)
193
>>> string_to_delta("60m")
202
>>> string_to_delta('60m')
194
203
datetime.timedelta(0, 3600)
195
>>> string_to_delta("24h")
204
>>> string_to_delta('24h')
196
205
datetime.timedelta(1)
197
>>> string_to_delta("1w")
206
>>> string_to_delta('1w')
198
207
datetime.timedelta(7)
199
>>> string_to_delta("5m 30s")
208
>>> string_to_delta('5m 30s')
200
209
datetime.timedelta(0, 330)
201
210
"""
202
211
203
212
try:
204
213
return rfc3339_duration_to_delta(interval)
205
214
except ValueError:
206
215
pass
207
216
208
217
value = datetime.timedelta(0)
209
218
regexp = re.compile(r"(\d+)([dsmhw]?)")
210
219
211
220
for num, suffix in regexp.findall(interval):
212
221
if suffix == "d":
213
222
value += datetime.timedelta(int(num))
232
241
"ApprovalDuration", "ExtendedTimeout"):
233
242
return milliseconds_to_string(value)
234
243
return str(value)
235
244
236
245
# Create format string to print table rows
237
246
format_string = " ".join("{{{key}:{width}}}".format(
238
width = max(len(tablewords[key]),
239
max(len(valuetostring(client[key], key))
240
for client in clients)),
241
key = key)
247
width=max(len(tablewords[key]),
248
max(len(valuetostring(client[key], key))
249
for client in clients)),
250
key=key)
242
251
for key in keywords)
243
252
# Print header line
244
253
print(format_string.format(**tablewords))
245
254
for client in clients:
246
print(format_string.format(**{
247
key: valuetostring(client[key], key)
248
for key in keywords }))
255
print(format_string
256
.format(**{key: valuetostring(client[key], key)
257
for key in keywords}))
249
258
250
259
251
260
def has_actions(options):
272
281
def main():
273
282
parser = argparse.ArgumentParser()
274
283
parser.add_argument("--version", action="version",
275
version = "%(prog)s {}".format(version),
284
version="%(prog)s {}".format(version),
276
285
help="show version number and exit")
277
286
parser.add_argument("-a", "--all", action="store_true",
278
287
help="Select all clients")
279
288
parser.add_argument("-v", "--verbose", action="store_true",
280
289
help="Print all fields")
290
parser.add_argument("-j", "--dump-json", action="store_true",
291
help="Dump client data in JSON format")
281
292
parser.add_argument("-e", "--enable", action="store_true",
282
293
help="Enable client")
283
294
parser.add_argument("-d", "--disable", action="store_true",
322
333
help="Run self-test")
323
334
parser.add_argument("client", nargs="*", help="Client name")
324
335
options = parser.parse_args()
325
336
326
337
if has_actions(options) and not (options.client or options.all):
327
338
parser.error("Options require clients names or --all.")
328
339
if options.verbose and has_actions(options):
329
parser.error("--verbose can only be used alone or with"
330
" --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.")
331
344
if options.all and not has_actions(options):
332
345
parser.error("--all requires an action.")
333
346
334
347
if options.check:
335
348
fail_count, test_count = doctest.testmod()
336
349
sys.exit(os.EX_OK if fail_count == 0 else 1)
337
350
338
351
try:
339
352
bus = dbus.SystemBus()
340
353
mandos_dbus_objc = bus.get_object(busname, server_path)
341
354
except dbus.exceptions.DBusException:
342
355
print("Could not connect to Mandos server", file=sys.stderr)
343
356
sys.exit(1)
344
357
345
358
mandos_serv = dbus.Interface(mandos_dbus_objc,
346
dbus_interface = server_interface)
347
348
#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
349
364
null = os.open(os.path.devnull, os.O_RDWR)
350
365
stderrcopy = os.dup(sys.stderr.fileno())
351
366
os.dup2(null, sys.stderr.fileno())
352
367
os.close(null)
353
368
try:
354
369
try:
355
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}
356
375
finally:
357
#restore stderr
376
# restore stderr
358
377
os.dup2(stderrcopy, sys.stderr.fileno())
359
378
os.close(stderrcopy)
360
except dbus.exceptions.DBusException:
361
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),
362
382
file=sys.stderr)
363
383
sys.exit(1)
364
384
365
385
# Compile dict of (clients: properties) to process
366
clients={}
367
386
clients = {}
387
368
388
if options.all or not options.client:
369
clients = { bus.get_object(busname, path): properties
370
for path, properties in mandos_clients.items() }
389
clients = {bus.get_object(busname, path): properties
390
for path, properties in mandos_clients.items()}
371
391
else:
372
392
for name in options.client:
373
393
for path, client in mandos_clients.items():
379
399
print("Client not found on server: {!r}"
380
400
.format(name), file=sys.stderr)
381
401
sys.exit(1)
382
402
383
403
if not has_actions(options) and clients:
384
if options.verbose:
404
if options.verbose or options.dump_json:
385
405
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
386
406
"Created", "Interval", "Host", "Fingerprint",
387
407
"CheckerRunning", "LastEnabled",
388
408
"ApprovalPending", "ApprovedByDefault",
389
409
"LastApprovalRequest", "ApprovalDelay",
390
410
"ApprovalDuration", "Checker",
391
"ExtendedTimeout")
411
"ExtendedTimeout", "Expires",
412
"LastCheckerStatus")
392
413
else:
393
414
keywords = defaultkeywords
394
395
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)
396
429
else:
397
430
# Process each client in the list by all selected options
398
431
for client in clients:
399
432
400
433
def set_client_prop(prop, value):
401
434
"""Set a Client D-Bus property"""
402
435
client.Set(client_interface, prop, value,
403
436
dbus_interface=dbus.PROPERTIES_IFACE)
404
437
405
438
def set_client_prop_ms(prop, value):
406
439
"""Set a Client D-Bus property, converted
407
440
from a string to milliseconds."""
408
441
set_client_prop(prop,
409
442
string_to_delta(value).total_seconds()
410
443
* 1000)
411
444
412
445
if options.remove:
413
446
mandos_serv.RemoveClient(client.__dbus_object_path__)
414
447
if options.enable:
422
455
if options.stop_checker:
423
456
set_client_prop("CheckerRunning", dbus.Boolean(False))
424
457
if options.is_enabled:
425
sys.exit(0 if client.Get(client_interface,
426
"Enabled",
427
dbus_interface=
428
dbus.PROPERTIES_IFACE)
429
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)
430
463
if options.checker is not None:
431
464
set_client_prop("Checker", options.checker)
432
465
if options.host is not None:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0