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 908
- compare with another revision
- download diff
- download tarball
- view history from revision 908
- Committer: Teddy Hogeborn
- Date: 2017-08-20 16:23:14 UTC
- Revision ID: teddy@recompile.se-20170820162314-hcvb6auvbm0mlppk
Use the https form of the Format URL in debian/copyright.
* debian/copyright (Format): Use https in URL.
* debian/copyright (Format): Use https in URL.
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
#
9
# This program is free software: you can redistribute it and/or modify
10
# it under the terms of the GNU General Public License as published by
5
#
6
# Copyright © 2008-2017 Teddy Hogeborn
7
# Copyright © 2008-2017 Björn Påhlsson
8
#
9
# This file is part of Mandos.
10
#
11
# Mandos is free software: you can redistribute it and/or modify it
12
# under the terms of the GNU General Public License as published by
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
13
15
#
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
19
# GNU General Public License for more details.
18
#
20
#
19
21
# 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/>.
22
#
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
23
#
23
24
# Contact the authors at <mandos@recompile.se>.
24
#
25
#
25
26
26
27
from __future__ import (division, absolute_import, print_function,
27
28
unicode_literals)
28
29
29
from future_builtins import *
30
try:
31
from future_builtins import *
32
except ImportError:
33
pass
30
34
31
35
import sys
32
36
import argparse
35
39
import re
36
40
import os
37
41
import collections
38
import doctest
42
import json
39
43
40
44
import dbus
41
45
46
if sys.version_info.major == 2:
47
str = unicode
48
42
49
locale.setlocale(locale.LC_ALL, "")
43
50
44
51
tablewords = {
58
65
"ApprovalDelay": "Approval Delay",
59
66
"ApprovalDuration": "Approval Duration",
60
67
"Checker": "Checker",
61
"ExtendedTimeout" : "Extended Timeout"
62
}
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
63
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
73
domain = "se.recompile"
65
74
busname = domain + ".Mandos"
66
75
server_path = "/"
67
76
server_interface = domain + ".Mandos"
68
77
client_interface = domain + ".Mandos.Client"
69
version = "1.6.5"
70
71
def timedelta_to_milliseconds(td):
72
"""Convert a datetime.timedelta object to milliseconds"""
73
return ((td.days * 24 * 60 * 60 * 1000)
74
+ (td.seconds * 1000)
75
+ (td.microseconds // 1000))
78
version = "1.7.15"
79
80
81
try:
82
dbus.OBJECT_MANAGER_IFACE
83
except AttributeError:
84
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
76
86
77
87
def milliseconds_to_string(ms):
78
88
td = datetime.timedelta(0, 0, 0, ms)
79
89
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
.format(days = "{0}T".format(td.days) if td.days else "",
81
hours = td.seconds // 3600,
82
minutes = (td.seconds % 3600) // 60,
83
seconds = td.seconds % 60,
84
))
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())
126
131
token_second = Token(re.compile(r"(\d+)S"),
127
132
datetime.timedelta(seconds=1),
128
frozenset((token_end,)))
133
frozenset((token_end, )))
129
134
token_minute = Token(re.compile(r"(\d+)M"),
130
135
datetime.timedelta(minutes=1),
131
136
frozenset((token_second, token_end)))
147
152
frozenset((token_month, token_end)))
148
153
token_week = Token(re.compile(r"(\d+)W"),
149
154
datetime.timedelta(weeks=1),
150
frozenset((token_end,)))
155
frozenset((token_end, )))
151
156
token_duration = Token(re.compile(r"P"), None,
152
157
frozenset((token_year, token_month,
153
158
token_day, token_time,
154
token_week))),
155
# Define starting values
156
value = datetime.timedelta() # Value so far
159
token_week)))
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))
223
232
value += datetime.timedelta(0, 0, 0, int(num))
224
233
return value
225
234
235
226
236
def print_clients(clients, keywords):
227
237
def valuetostring(value, keyword):
228
238
if type(value) is dbus.Boolean:
230
240
if keyword in ("Timeout", "Interval", "ApprovalDelay",
231
241
"ApprovalDuration", "ExtendedTimeout"):
232
242
return milliseconds_to_string(value)
233
return unicode(value)
234
243
return str(value)
244
235
245
# Create format string to print table rows
236
246
format_string = " ".join("{{{key}:{width}}}".format(
237
width = max(len(tablewords[key]),
238
max(len(valuetostring(client[key],
239
key))
240
for client in
241
clients)),
242
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)
243
252
# Print header line
244
253
print(format_string.format(**tablewords))
245
254
for client in clients:
246
print(format_string.format(**dict((key,
247
valuetostring(client[key],
248
key))
249
for key in keywords)))
255
print(format_string
256
.format(**{key: valuetostring(client[key], key)
257
for key in keywords}))
258
250
259
251
260
def has_actions(options):
252
261
return any((options.enable,
268
277
options.approve,
269
278
options.deny))
270
279
280
271
281
def main():
272
282
parser = argparse.ArgumentParser()
273
283
parser.add_argument("--version", action="version",
274
version = "%(prog)s {0}".format(version),
284
version="%(prog)s {}".format(version),
275
285
help="show version number and exit")
276
286
parser.add_argument("-a", "--all", action="store_true",
277
287
help="Select all clients")
278
288
parser.add_argument("-v", "--verbose", action="store_true",
279
289
help="Print all fields")
290
parser.add_argument("-j", "--dump-json", action="store_true",
291
help="Dump client data in JSON format")
280
292
parser.add_argument("-e", "--enable", action="store_true",
281
293
help="Enable client")
282
294
parser.add_argument("-d", "--disable", action="store_true",
310
322
parser.add_argument("--approval-duration",
311
323
help="Set duration of one client approval")
312
324
parser.add_argument("-H", "--host", help="Set host for client")
313
parser.add_argument("-s", "--secret", type=file,
325
parser.add_argument("-s", "--secret",
326
type=argparse.FileType(mode="rb"),
314
327
help="Set password blob (file) for client")
315
328
parser.add_argument("-A", "--approve", action="store_true",
316
329
help="Approve any current client request")
320
333
help="Run self-test")
321
334
parser.add_argument("client", nargs="*", help="Client name")
322
335
options = parser.parse_args()
323
336
324
337
if has_actions(options) and not (options.client or options.all):
325
338
parser.error("Options require clients names or --all.")
326
339
if options.verbose and has_actions(options):
327
parser.error("--verbose can only be used alone or with"
328
" --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.")
329
344
if options.all and not has_actions(options):
330
345
parser.error("--all requires an action.")
331
346
332
347
if options.check:
348
import doctest
333
349
fail_count, test_count = doctest.testmod()
334
350
sys.exit(os.EX_OK if fail_count == 0 else 1)
335
351
336
352
try:
337
353
bus = dbus.SystemBus()
338
354
mandos_dbus_objc = bus.get_object(busname, server_path)
339
355
except dbus.exceptions.DBusException:
340
print("Could not connect to Mandos server",
341
file=sys.stderr)
356
print("Could not connect to Mandos server", file=sys.stderr)
342
357
sys.exit(1)
343
358
344
359
mandos_serv = dbus.Interface(mandos_dbus_objc,
345
dbus_interface = server_interface)
346
347
#block stderr since dbus library prints to stderr
360
dbus_interface=server_interface)
361
mandos_serv_object_manager = dbus.Interface(
362
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
363
364
# block stderr since dbus library prints to stderr
348
365
null = os.open(os.path.devnull, os.O_RDWR)
349
366
stderrcopy = os.dup(sys.stderr.fileno())
350
367
os.dup2(null, sys.stderr.fileno())
351
368
os.close(null)
352
369
try:
353
370
try:
354
mandos_clients = mandos_serv.GetAllClientsWithProperties()
371
mandos_clients = {path: ifs_and_props[client_interface]
372
for path, ifs_and_props in
373
mandos_serv_object_manager
374
.GetManagedObjects().items()
375
if client_interface in ifs_and_props}
355
376
finally:
356
#restore stderr
377
# restore stderr
357
378
os.dup2(stderrcopy, sys.stderr.fileno())
358
379
os.close(stderrcopy)
359
except dbus.exceptions.DBusException:
360
print("Access denied: Accessing mandos server through dbus.",
380
except dbus.exceptions.DBusException as e:
381
print("Access denied: "
382
"Accessing mandos server through D-Bus: {}".format(e),
361
383
file=sys.stderr)
362
384
sys.exit(1)
363
385
364
386
# Compile dict of (clients: properties) to process
365
clients={}
366
387
clients = {}
388
367
389
if options.all or not options.client:
368
clients = dict((bus.get_object(busname, path), properties)
369
for path, properties in
370
mandos_clients.iteritems())
390
clients = {bus.get_object(busname, path): properties
391
for path, properties in mandos_clients.items()}
371
392
else:
372
393
for name in options.client:
373
for path, client in mandos_clients.iteritems():
394
for path, client in mandos_clients.items():
374
395
if client["Name"] == name:
375
396
client_objc = bus.get_object(busname, path)
376
397
clients[client_objc] = client
377
398
break
378
399
else:
379
print("Client not found on server: {0!r}"
400
print("Client not found on server: {!r}"
380
401
.format(name), file=sys.stderr)
381
402
sys.exit(1)
382
403
383
404
if not has_actions(options) and clients:
384
if options.verbose:
385
keywords = ("Name", "Enabled", "Timeout",
386
"LastCheckedOK", "Created", "Interval",
387
"Host", "Fingerprint", "CheckerRunning",
388
"LastEnabled", "ApprovalPending",
389
"ApprovedByDefault",
405
if options.verbose or options.dump_json:
406
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
"Created", "Interval", "Host", "Fingerprint",
408
"CheckerRunning", "LastEnabled",
409
"ApprovalPending", "ApprovedByDefault",
390
410
"LastApprovalRequest", "ApprovalDelay",
391
411
"ApprovalDuration", "Checker",
392
"ExtendedTimeout")
412
"ExtendedTimeout", "Expires",
413
"LastCheckerStatus")
393
414
else:
394
415
keywords = defaultkeywords
395
396
print_clients(clients.values(), keywords)
416
417
if options.dump_json:
418
json.dump({client["Name"]: {key:
419
bool(client[key])
420
if isinstance(client[key],
421
dbus.Boolean)
422
else client[key]
423
for key in keywords}
424
for client in clients.values()},
425
fp=sys.stdout, indent=4,
426
separators=(',', ': '))
427
print()
428
else:
429
print_clients(clients.values(), keywords)
397
430
else:
398
431
# Process each client in the list by all selected options
399
432
for client in clients:
433
400
434
def set_client_prop(prop, value):
401
435
"""Set a Client D-Bus property"""
402
436
client.Set(client_interface, prop, value,
403
437
dbus_interface=dbus.PROPERTIES_IFACE)
438
404
439
def set_client_prop_ms(prop, value):
405
440
"""Set a Client D-Bus property, converted
406
441
from a string to milliseconds."""
407
442
set_client_prop(prop,
408
timedelta_to_milliseconds
409
(string_to_delta(value)))
443
string_to_delta(value).total_seconds()
444
* 1000)
445
410
446
if options.remove:
411
447
mandos_serv.RemoveClient(client.__dbus_object_path__)
412
448
if options.enable:
420
456
if options.stop_checker:
421
457
set_client_prop("CheckerRunning", dbus.Boolean(False))
422
458
if options.is_enabled:
423
sys.exit(0 if client.Get(client_interface,
424
"Enabled",
425
dbus_interface=
426
dbus.PROPERTIES_IFACE)
427
else 1)
459
if client.Get(client_interface, "Enabled",
460
dbus_interface=dbus.PROPERTIES_IFACE):
461
sys.exit(0)
462
else:
463
sys.exit(1)
428
464
if options.checker is not None:
429
465
set_client_prop("Checker", options.checker)
430
466
if options.host is not None:
456
492
client.Approve(dbus.Boolean(False),
457
493
dbus_interface=client_interface)
458
494
495
459
496
if __name__ == "__main__":
460
497
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0