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 885
- compare with another revision
- download diff
- download tarball
- view history from revision 885
- Committer: Teddy Hogeborn
- Date: 2016-10-29 14:22:26 UTC
- 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-2012 Teddy Hogeborn
7
# Copyright © 2008-2012 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)
28
28
29
from future_builtins import *
29
try:
30
from future_builtins import *
31
except ImportError:
32
pass
30
33
31
34
import sys
32
import dbus
33
35
import argparse
34
36
import locale
35
37
import datetime
36
38
import re
37
39
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
38
48
39
49
locale.setlocale(locale.LC_ALL, "")
40
50
55
65
"ApprovalDelay": "Approval Delay",
56
66
"ApprovalDuration": "Approval Duration",
57
67
"Checker": "Checker",
58
"ExtendedTimeout" : "Extended Timeout"
59
}
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
60
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
61
73
domain = "se.recompile"
62
74
busname = domain + ".Mandos"
63
75
server_path = "/"
64
76
server_interface = domain + ".Mandos"
65
77
client_interface = domain + ".Mandos.Client"
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))
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
73
86
74
87
def milliseconds_to_string(ms):
75
88
td = datetime.timedelta(0, 0, 0, ms)
76
89
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
))
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))
94
95
96
def rfc3339_duration_to_delta(duration):
97
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
98
99
>>> rfc3339_duration_to_delta("P7D")
100
datetime.timedelta(7)
101
>>> rfc3339_duration_to_delta("PT60S")
102
datetime.timedelta(0, 60)
103
>>> rfc3339_duration_to_delta("PT60M")
104
datetime.timedelta(0, 3600)
105
>>> rfc3339_duration_to_delta("PT24H")
106
datetime.timedelta(1)
107
>>> rfc3339_duration_to_delta("P1W")
108
datetime.timedelta(7)
109
>>> rfc3339_duration_to_delta("PT5M30S")
110
datetime.timedelta(0, 330)
111
>>> rfc3339_duration_to_delta("P1DT3M20S")
112
datetime.timedelta(1, 200)
113
"""
114
115
# Parsing an RFC 3339 duration with regular expressions is not
116
# possible - there would have to be multiple places for the same
117
# values, like seconds. The current code, while more esoteric, is
118
# cleaner without depending on a parsing library. If Python had a
119
# built-in library for parsing we would use it, but we'd like to
120
# avoid excessive use of external libraries.
121
122
# New type for defining tokens, syntax, and semantics all-in-one
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
128
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
129
# the "duration" ABNF definition in RFC 3339, Appendix A.
130
token_end = Token(re.compile(r"$"), None, frozenset())
131
token_second = Token(re.compile(r"(\d+)S"),
132
datetime.timedelta(seconds=1),
133
frozenset((token_end, )))
134
token_minute = Token(re.compile(r"(\d+)M"),
135
datetime.timedelta(minutes=1),
136
frozenset((token_second, token_end)))
137
token_hour = Token(re.compile(r"(\d+)H"),
138
datetime.timedelta(hours=1),
139
frozenset((token_minute, token_end)))
140
token_time = Token(re.compile(r"T"),
141
None,
142
frozenset((token_hour, token_minute,
143
token_second)))
144
token_day = Token(re.compile(r"(\d+)D"),
145
datetime.timedelta(days=1),
146
frozenset((token_time, token_end)))
147
token_month = Token(re.compile(r"(\d+)M"),
148
datetime.timedelta(weeks=4),
149
frozenset((token_day, token_end)))
150
token_year = Token(re.compile(r"(\d+)Y"),
151
datetime.timedelta(weeks=52),
152
frozenset((token_month, token_end)))
153
token_week = Token(re.compile(r"(\d+)W"),
154
datetime.timedelta(weeks=1),
155
frozenset((token_end, )))
156
token_duration = Token(re.compile(r"P"), None,
157
frozenset((token_year, token_month,
158
token_day, token_time,
159
token_week)))
160
# Define starting values:
161
# Value so far
162
value = datetime.timedelta()
163
found_token = None
164
# Following valid tokens
165
followers = frozenset((token_duration, ))
166
# String left to parse
167
s = duration
168
# Loop until end token is found
169
while found_token is not token_end:
170
# Search for any currently valid tokens
171
for token in followers:
172
match = token.regexp.match(s)
173
if match is not None:
174
# Token found
175
if token.value is not None:
176
# Value found, parse digits
177
factor = int(match.group(1), 10)
178
# Add to value so far
179
value += factor * token.value
180
# Strip token from string
181
s = token.regexp.sub("", s, 1)
182
# Go to found token
183
found_token = token
184
# Set valid next tokens
185
followers = found_token.followers
186
break
187
else:
188
# No currently valid tokens were found
189
raise ValueError("Invalid RFC 3339 duration: {!r}"
190
.format(duration))
191
# End token found
192
return value
193
82
194
83
195
def string_to_delta(interval):
84
196
"""Parse a string and return a datetime.timedelta
85
86
>>> string_to_delta("7d")
197
198
>>> string_to_delta('7d')
87
199
datetime.timedelta(7)
88
>>> string_to_delta("60s")
200
>>> string_to_delta('60s')
89
201
datetime.timedelta(0, 60)
90
>>> string_to_delta("60m")
202
>>> string_to_delta('60m')
91
203
datetime.timedelta(0, 3600)
92
>>> string_to_delta("24h")
204
>>> string_to_delta('24h')
93
205
datetime.timedelta(1)
94
>>> string_to_delta("1w")
206
>>> string_to_delta('1w')
95
207
datetime.timedelta(7)
96
>>> string_to_delta("5m 30s")
208
>>> string_to_delta('5m 30s')
97
209
datetime.timedelta(0, 330)
98
210
"""
211
212
try:
213
return rfc3339_duration_to_delta(interval)
214
except ValueError:
215
pass
216
99
217
value = datetime.timedelta(0)
100
regexp = re.compile("(\d+)([dsmhw]?)")
101
218
regexp = re.compile(r"(\d+)([dsmhw]?)")
219
102
220
for num, suffix in regexp.findall(interval):
103
221
if suffix == "d":
104
222
value += datetime.timedelta(int(num))
114
232
value += datetime.timedelta(0, 0, 0, int(num))
115
233
return value
116
234
235
117
236
def print_clients(clients, keywords):
118
237
def valuetostring(value, keyword):
119
238
if type(value) is dbus.Boolean:
121
240
if keyword in ("Timeout", "Interval", "ApprovalDelay",
122
241
"ApprovalDuration", "ExtendedTimeout"):
123
242
return milliseconds_to_string(value)
124
return unicode(value)
125
243
return str(value)
244
126
245
# Create format string to print table rows
127
246
format_string = " ".join("{{{key}:{width}}}".format(
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)
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)
134
252
# Print header line
135
253
print(format_string.format(**tablewords))
136
254
for client in clients:
137
print(format_string.format(**dict((key,
138
valuetostring(client[key],
139
key))
140
for key in keywords)))
255
print(format_string
256
.format(**{key: valuetostring(client[key], key)
257
for key in keywords}))
258
141
259
142
260
def has_actions(options):
143
261
return any((options.enable,
159
277
options.approve,
160
278
options.deny))
161
279
280
162
281
def main():
163
282
parser = argparse.ArgumentParser()
164
283
parser.add_argument("--version", action="version",
165
version = "%(prog)s {0}".format(version),
284
version="%(prog)s {}".format(version),
166
285
help="show version number and exit")
167
286
parser.add_argument("-a", "--all", action="store_true",
168
287
help="Select all clients")
169
288
parser.add_argument("-v", "--verbose", action="store_true",
170
289
help="Print all fields")
290
parser.add_argument("-j", "--dump-json", action="store_true",
291
help="Dump client data in JSON format")
171
292
parser.add_argument("-e", "--enable", action="store_true",
172
293
help="Enable client")
173
294
parser.add_argument("-d", "--disable", action="store_true",
201
322
parser.add_argument("--approval-duration",
202
323
help="Set duration of one client approval")
203
324
parser.add_argument("-H", "--host", help="Set host for client")
204
parser.add_argument("-s", "--secret", type=file,
325
parser.add_argument("-s", "--secret",
326
type=argparse.FileType(mode="rb"),
205
327
help="Set password blob (file) for client")
206
328
parser.add_argument("-A", "--approve", action="store_true",
207
329
help="Approve any current client request")
208
330
parser.add_argument("-D", "--deny", action="store_true",
209
331
help="Deny any current client request")
332
parser.add_argument("--check", action="store_true",
333
help="Run self-test")
210
334
parser.add_argument("client", nargs="*", help="Client name")
211
335
options = parser.parse_args()
212
336
213
337
if has_actions(options) and not (options.client or options.all):
214
338
parser.error("Options require clients names or --all.")
215
339
if options.verbose and has_actions(options):
216
parser.error("--verbose can only be used alone or with"
217
" --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.")
218
344
if options.all and not has_actions(options):
219
345
parser.error("--all requires an action.")
220
346
347
if options.check:
348
fail_count, test_count = doctest.testmod()
349
sys.exit(os.EX_OK if fail_count == 0 else 1)
350
221
351
try:
222
352
bus = dbus.SystemBus()
223
353
mandos_dbus_objc = bus.get_object(busname, server_path)
224
354
except dbus.exceptions.DBusException:
225
print("Could not connect to Mandos server",
226
file=sys.stderr)
355
print("Could not connect to Mandos server", file=sys.stderr)
227
356
sys.exit(1)
228
357
229
358
mandos_serv = dbus.Interface(mandos_dbus_objc,
230
dbus_interface = server_interface)
231
232
#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
233
364
null = os.open(os.path.devnull, os.O_RDWR)
234
365
stderrcopy = os.dup(sys.stderr.fileno())
235
366
os.dup2(null, sys.stderr.fileno())
236
367
os.close(null)
237
368
try:
238
369
try:
239
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}
240
375
finally:
241
#restore stderr
376
# restore stderr
242
377
os.dup2(stderrcopy, sys.stderr.fileno())
243
378
os.close(stderrcopy)
244
except dbus.exceptions.DBusException:
245
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),
246
382
file=sys.stderr)
247
383
sys.exit(1)
248
384
249
385
# Compile dict of (clients: properties) to process
250
clients={}
251
386
clients = {}
387
252
388
if options.all or not options.client:
253
clients = dict((bus.get_object(busname, path), properties)
254
for path, properties in
255
mandos_clients.iteritems())
389
clients = {bus.get_object(busname, path): properties
390
for path, properties in mandos_clients.items()}
256
391
else:
257
392
for name in options.client:
258
for path, client in mandos_clients.iteritems():
393
for path, client in mandos_clients.items():
259
394
if client["Name"] == name:
260
395
client_objc = bus.get_object(busname, path)
261
396
clients[client_objc] = client
262
397
break
263
398
else:
264
print("Client not found on server: {0!r}"
399
print("Client not found on server: {!r}"
265
400
.format(name), file=sys.stderr)
266
401
sys.exit(1)
267
402
268
403
if not has_actions(options) and clients:
269
if options.verbose:
270
keywords = ("Name", "Enabled", "Timeout",
271
"LastCheckedOK", "Created", "Interval",
272
"Host", "Fingerprint", "CheckerRunning",
273
"LastEnabled", "ApprovalPending",
274
"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",
275
409
"LastApprovalRequest", "ApprovalDelay",
276
410
"ApprovalDuration", "Checker",
277
"ExtendedTimeout")
411
"ExtendedTimeout", "Expires",
412
"LastCheckerStatus")
278
413
else:
279
414
keywords = defaultkeywords
280
281
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)
282
429
else:
283
430
# Process each client in the list by all selected options
284
431
for client in clients:
432
285
433
def set_client_prop(prop, value):
286
434
"""Set a Client D-Bus property"""
287
435
client.Set(client_interface, prop, value,
288
436
dbus_interface=dbus.PROPERTIES_IFACE)
437
289
438
def set_client_prop_ms(prop, value):
290
439
"""Set a Client D-Bus property, converted
291
440
from a string to milliseconds."""
292
441
set_client_prop(prop,
293
timedelta_to_milliseconds
294
(string_to_delta(value)))
442
string_to_delta(value).total_seconds()
443
* 1000)
444
295
445
if options.remove:
296
446
mandos_serv.RemoveClient(client.__dbus_object_path__)
297
447
if options.enable:
305
455
if options.stop_checker:
306
456
set_client_prop("CheckerRunning", dbus.Boolean(False))
307
457
if options.is_enabled:
308
sys.exit(0 if client.Get(client_interface,
309
"Enabled",
310
dbus_interface=
311
dbus.PROPERTIES_IFACE)
312
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)
313
463
if options.checker is not None:
314
464
set_client_prop("Checker", options.checker)
315
465
if options.host is not None:
341
491
client.Approve(dbus.Boolean(False),
342
492
dbus_interface=client_interface)
343
493
494
344
495
if __name__ == "__main__":
345
496
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0