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 327
- compare with another revision
- download diff
- download tarball
- view history from revision 327
- Committer: Teddy Hogeborn
- Date: 2015-10-24 17:37:16 UTC
- mfrom: (237.7.338 trunk)
- Revision ID: teddy@recompile.se-20151024173716-cmst924xz22yq58z
Merge from trunk.
- files added:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos-ctl
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
4
from __future__ import division
3
#
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
#
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
11
# the Free Software Foundation, either version 3 of the License, or
12
# (at your option) any later version.
13
#
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
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
# GNU General Public License for more details.
18
#
19
# 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
#
23
# Contact the authors at <mandos@recompile.se>.
24
#
25
26
from __future__ import (division, absolute_import, print_function,
27
unicode_literals)
28
29
try:
30
from future_builtins import *
31
except ImportError:
32
pass
33
5
34
import sys
6
import dbus
7
from optparse import OptionParser
35
import argparse
8
36
import locale
9
37
import datetime
10
38
import re
11
12
locale.setlocale(locale.LC_ALL, u'')
39
import os
40
import collections
41
import doctest
42
43
import dbus
44
45
if sys.version_info.major == 2:
46
str = unicode
47
48
locale.setlocale(locale.LC_ALL, "")
13
49
14
50
tablewords = {
15
'name': u'Name',
16
'enabled': u'Enabled',
17
'timeout': u'Timeout',
18
'last_checked_ok': u'Last Successful Check',
19
'created': u'Created',
20
'interval': u'Interval',
21
'host': u'Host',
22
'fingerprint': u'Fingerprint',
23
'checker_running': u'Check Is Running',
24
'last_enabled': u'Last Enabled',
25
'checker': u'Checker',
26
}
27
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
28
'checker')
29
busname = 'org.mandos-system.Mandos'
30
server_path = '/Mandos'
31
server_interface = 'org.mandos_system.Mandos'
32
client_interface = 'org.mandos_system.Mandos.Client'
33
version = "1.0.5"
34
35
bus = dbus.SystemBus()
36
mandos_dbus_objc = bus.get_object(busname, server_path)
37
mandos_serv = dbus.Interface(mandos_dbus_objc,
38
dbus_interface = server_interface)
39
mandos_clients = mandos_serv.GetAllClientsWithProperties()
40
41
def datetime_to_milliseconds(dt):
42
"Return the 'timeout' attribute in milliseconds"
43
return ((dt.days * 24 * 60 * 60 * 1000)
44
+ (dt.seconds * 1000)
45
+ (dt.microseconds // 1000))
51
"Name": "Name",
52
"Enabled": "Enabled",
53
"Timeout": "Timeout",
54
"LastCheckedOK": "Last Successful Check",
55
"LastApprovalRequest": "Last Approval Request",
56
"Created": "Created",
57
"Interval": "Interval",
58
"Host": "Host",
59
"Fingerprint": "Fingerprint",
60
"CheckerRunning": "Check Is Running",
61
"LastEnabled": "Last Enabled",
62
"ApprovalPending": "Approval Is Pending",
63
"ApprovedByDefault": "Approved By Default",
64
"ApprovalDelay": "Approval Delay",
65
"ApprovalDuration": "Approval Duration",
66
"Checker": "Checker",
67
"ExtendedTimeout": "Extended Timeout"
68
}
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
domain = "se.recompile"
71
busname = domain + ".Mandos"
72
server_path = "/"
73
server_interface = domain + ".Mandos"
74
client_interface = domain + ".Mandos.Client"
75
version = "1.7.0"
76
77
78
try:
79
dbus.OBJECT_MANAGER_IFACE
80
except AttributeError:
81
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
46
82
47
83
def milliseconds_to_string(ms):
48
84
td = datetime.timedelta(0, 0, 0, ms)
49
return "%s%02d:%02d:%02d" % (("%dT" % td.days) if td.days else "", # days
50
td.seconds // 3600, # hours
51
(td.seconds % 3600) // 60, # minutes
52
(td.seconds % 60)) # seconds
85
return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
86
days = "{}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
91
92
def rfc3339_duration_to_delta(duration):
93
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
94
95
>>> rfc3339_duration_to_delta("P7D")
96
datetime.timedelta(7)
97
>>> rfc3339_duration_to_delta("PT60S")
98
datetime.timedelta(0, 60)
99
>>> rfc3339_duration_to_delta("PT60M")
100
datetime.timedelta(0, 3600)
101
>>> rfc3339_duration_to_delta("PT24H")
102
datetime.timedelta(1)
103
>>> rfc3339_duration_to_delta("P1W")
104
datetime.timedelta(7)
105
>>> rfc3339_duration_to_delta("PT5M30S")
106
datetime.timedelta(0, 330)
107
>>> rfc3339_duration_to_delta("P1DT3M20S")
108
datetime.timedelta(1, 200)
109
"""
110
111
# Parsing an RFC 3339 duration with regular expressions is not
112
# possible - there would have to be multiple places for the same
113
# values, like seconds. The current code, while more esoteric, is
114
# cleaner without depending on a parsing library. If Python had a
115
# built-in library for parsing we would use it, but we'd like to
116
# avoid excessive use of external libraries.
117
118
# New type for defining tokens, syntax, and semantics all-in-one
119
Token = collections.namedtuple("Token", (
120
"regexp", # To match token; if "value" is not None, must have
121
# a "group" containing digits
122
"value", # datetime.timedelta or None
123
"followers")) # Tokens valid after this token
124
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
125
# the "duration" ABNF definition in RFC 3339, Appendix A.
126
token_end = Token(re.compile(r"$"), None, frozenset())
127
token_second = Token(re.compile(r"(\d+)S"),
128
datetime.timedelta(seconds=1),
129
frozenset((token_end, )))
130
token_minute = Token(re.compile(r"(\d+)M"),
131
datetime.timedelta(minutes=1),
132
frozenset((token_second, token_end)))
133
token_hour = Token(re.compile(r"(\d+)H"),
134
datetime.timedelta(hours=1),
135
frozenset((token_minute, token_end)))
136
token_time = Token(re.compile(r"T"),
137
None,
138
frozenset((token_hour, token_minute,
139
token_second)))
140
token_day = Token(re.compile(r"(\d+)D"),
141
datetime.timedelta(days=1),
142
frozenset((token_time, token_end)))
143
token_month = Token(re.compile(r"(\d+)M"),
144
datetime.timedelta(weeks=4),
145
frozenset((token_day, token_end)))
146
token_year = Token(re.compile(r"(\d+)Y"),
147
datetime.timedelta(weeks=52),
148
frozenset((token_month, token_end)))
149
token_week = Token(re.compile(r"(\d+)W"),
150
datetime.timedelta(weeks=1),
151
frozenset((token_end, )))
152
token_duration = Token(re.compile(r"P"), None,
153
frozenset((token_year, token_month,
154
token_day, token_time,
155
token_week)))
156
# Define starting values
157
value = datetime.timedelta() # Value so far
158
found_token = None
159
followers = frozenset((token_duration, )) # Following valid tokens
160
s = duration # String left to parse
161
# Loop until end token is found
162
while found_token is not token_end:
163
# Search for any currently valid tokens
164
for token in followers:
165
match = token.regexp.match(s)
166
if match is not None:
167
# Token found
168
if token.value is not None:
169
# Value found, parse digits
170
factor = int(match.group(1), 10)
171
# Add to value so far
172
value += factor * token.value
173
# Strip token from string
174
s = token.regexp.sub("", s, 1)
175
# Go to found token
176
found_token = token
177
# Set valid next tokens
178
followers = found_token.followers
179
break
180
else:
181
# No currently valid tokens were found
182
raise ValueError("Invalid RFC 3339 duration: {!r}"
183
.format(duration))
184
# End token found
185
return value
53
186
54
187
55
188
def string_to_delta(interval):
56
189
"""Parse a string and return a datetime.timedelta
57
190
58
191
>>> string_to_delta('7d')
59
192
datetime.timedelta(7)
60
193
>>> string_to_delta('60s')
63
196
datetime.timedelta(0, 3600)
64
197
>>> string_to_delta('24h')
65
198
datetime.timedelta(1)
66
>>> string_to_delta(u'1w')
199
>>> string_to_delta('1w')
67
200
datetime.timedelta(7)
68
201
>>> string_to_delta('5m 30s')
69
202
datetime.timedelta(0, 330)
70
203
"""
71
timevalue = datetime.timedelta(0)
72
regexp = re.compile("\d+[dsmhw]")
73
74
for s in regexp.findall(interval):
75
try:
76
suffix = unicode(s[-1])
77
value = int(s[:-1])
78
if suffix == u"d":
79
delta = datetime.timedelta(value)
80
elif suffix == u"s":
81
delta = datetime.timedelta(0, value)
82
elif suffix == u"m":
83
delta = datetime.timedelta(0, 0, 0, 0, value)
84
elif suffix == u"h":
85
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
86
elif suffix == u"w":
87
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
88
else:
89
raise ValueError
90
except (ValueError, IndexError):
91
raise ValueError
92
timevalue += delta
93
return timevalue
94
95
def print_clients(clients):
204
205
try:
206
return rfc3339_duration_to_delta(interval)
207
except ValueError:
208
pass
209
210
value = datetime.timedelta(0)
211
regexp = re.compile(r"(\d+)([dsmhw]?)")
212
213
for num, suffix in regexp.findall(interval):
214
if suffix == "d":
215
value += datetime.timedelta(int(num))
216
elif suffix == "s":
217
value += datetime.timedelta(0, int(num))
218
elif suffix == "m":
219
value += datetime.timedelta(0, 0, 0, 0, int(num))
220
elif suffix == "h":
221
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
222
elif suffix == "w":
223
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
224
elif suffix == "":
225
value += datetime.timedelta(0, 0, 0, int(num))
226
return value
227
228
229
def print_clients(clients, keywords):
96
230
def valuetostring(value, keyword):
97
231
if type(value) is dbus.Boolean:
98
return u"Yes" if value else u"No"
99
if keyword in ("timeout", "interval"):
232
return "Yes" if value else "No"
233
if keyword in ("Timeout", "Interval", "ApprovalDelay",
234
"ApprovalDuration", "ExtendedTimeout"):
100
235
return milliseconds_to_string(value)
101
return unicode(value)
236
return str(value)
102
237
103
format_string = u' '.join(u'%%-%ds' %
104
max(len(tablewords[key]),
105
max(len(valuetostring(client[key], key))
106
for client in
107
clients))
108
for key in keywords)
109
print format_string % tuple(tablewords[key] for key in keywords)
238
# Create format string to print table rows
239
format_string = " ".join("{{{key}:{width}}}".format(
240
width = max(len(tablewords[key]),
241
max(len(valuetostring(client[key], key))
242
for client in clients)),
243
key = key)
244
for key in keywords)
245
# Print header line
246
print(format_string.format(**tablewords))
110
247
for client in clients:
111
print format_string % tuple(valuetostring(client[key], key)
112
for key in keywords)
113
114
parser = OptionParser(version = "%%prog %s" % version)
115
parser.add_option("-a", "--all", action="store_true",
116
help="Print all fields")
117
parser.add_option("-e", "--enable", action="store_true",
118
help="Enable specified client")
119
parser.add_option("-d", "--disable", action="store_true",
120
help="disable specified client")
121
parser.add_option("-b", "--bump-timeout", action="store_true",
122
help="Bump timeout of specified client")
123
parser.add_option("--start-checker", action="store_true",
124
help="Start checker for specified client")
125
parser.add_option("--stop-checker", action="store_true",
126
help="Stop checker for specified client")
127
parser.add_option("-v", "--is-valid", action="store_true",
128
help="Stop checker for specified client")
129
parser.add_option("-c", "--checker", type="string",
130
help="Set checker command for specified client")
131
parser.add_option("-t", "--timeout", type="string",
132
help="Set timeout for specified client")
133
parser.add_option("-i", "--interval", type="string",
134
help="Set checker interval for specified client")
135
parser.add_option("-H", "--host", type="string",
136
help="Set host for specified client")
137
parser.add_option("-s", "--secret", type="string",
138
help="Set password blob (file) for specified client")
139
options, client_names = parser.parse_args()
140
141
clients=[]
142
for name in client_names:
143
for path, client in mandos_clients.iteritems():
144
if client['name'] == name:
145
client_objc = bus.get_object(busname, path)
146
clients.append(dbus.Interface(client_objc,
147
dbus_interface
148
= client_interface))
149
break
150
else:
151
print >> sys.stderr, "Client not found on server: %r" % name
152
sys.exit(1)
153
154
if not clients:
155
keywords = defaultkeywords
156
if options.all:
157
keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
158
'created', 'interval', 'host', 'fingerprint',
159
'checker_running', 'last_enabled', 'checker')
160
print_clients(mandos_clients.values())
161
162
for client in clients:
163
if options.enable:
164
client.Enable()
165
if options.disable:
166
client.Disable()
167
if options.bump_timeout:
168
client.BumpTimeout()
169
if options.start_checker:
170
client.StartChecker()
171
if options.stop_checker:
172
client.StopChecker()
173
if options.is_valid:
174
sys.exit(0 if client.IsStillValid() else 1)
175
if options.checker:
176
client.SetChecker(options.checker)
177
if options.host:
178
client.SetHost(options.host)
179
if options.interval:
180
client.SetInterval(datetime_to_milliseconds
181
(string_to_delta(options.interval)))
182
if options.timeout:
183
client.SetTimeout(datetime_to_milliseconds
184
(string_to_delta(options.timeout)))
185
if options.secret:
186
client.SetSecret(dbus.ByteArray(open(options.secret, 'rb').read()))
187
248
print(format_string.format(**{
249
key: valuetostring(client[key], key)
250
for key in keywords }))
251
252
253
def has_actions(options):
254
return any((options.enable,
255
options.disable,
256
options.bump_timeout,
257
options.start_checker,
258
options.stop_checker,
259
options.is_enabled,
260
options.remove,
261
options.checker is not None,
262
options.timeout is not None,
263
options.extended_timeout is not None,
264
options.interval is not None,
265
options.approved_by_default is not None,
266
options.approval_delay is not None,
267
options.approval_duration is not None,
268
options.host is not None,
269
options.secret is not None,
270
options.approve,
271
options.deny))
272
273
274
def main():
275
parser = argparse.ArgumentParser()
276
parser.add_argument("--version", action="version",
277
version = "%(prog)s {}".format(version),
278
help="show version number and exit")
279
parser.add_argument("-a", "--all", action="store_true",
280
help="Select all clients")
281
parser.add_argument("-v", "--verbose", action="store_true",
282
help="Print all fields")
283
parser.add_argument("-e", "--enable", action="store_true",
284
help="Enable client")
285
parser.add_argument("-d", "--disable", action="store_true",
286
help="disable client")
287
parser.add_argument("-b", "--bump-timeout", action="store_true",
288
help="Bump timeout for client")
289
parser.add_argument("--start-checker", action="store_true",
290
help="Start checker for client")
291
parser.add_argument("--stop-checker", action="store_true",
292
help="Stop checker for client")
293
parser.add_argument("-V", "--is-enabled", action="store_true",
294
help="Check if client is enabled")
295
parser.add_argument("-r", "--remove", action="store_true",
296
help="Remove client")
297
parser.add_argument("-c", "--checker",
298
help="Set checker command for client")
299
parser.add_argument("-t", "--timeout",
300
help="Set timeout for client")
301
parser.add_argument("--extended-timeout",
302
help="Set extended timeout for client")
303
parser.add_argument("-i", "--interval",
304
help="Set checker interval for client")
305
parser.add_argument("--approve-by-default", action="store_true",
306
default=None, dest="approved_by_default",
307
help="Set client to be approved by default")
308
parser.add_argument("--deny-by-default", action="store_false",
309
dest="approved_by_default",
310
help="Set client to be denied by default")
311
parser.add_argument("--approval-delay",
312
help="Set delay before client approve/deny")
313
parser.add_argument("--approval-duration",
314
help="Set duration of one client approval")
315
parser.add_argument("-H", "--host", help="Set host for client")
316
parser.add_argument("-s", "--secret",
317
type=argparse.FileType(mode="rb"),
318
help="Set password blob (file) for client")
319
parser.add_argument("-A", "--approve", action="store_true",
320
help="Approve any current client request")
321
parser.add_argument("-D", "--deny", action="store_true",
322
help="Deny any current client request")
323
parser.add_argument("--check", action="store_true",
324
help="Run self-test")
325
parser.add_argument("client", nargs="*", help="Client name")
326
options = parser.parse_args()
327
328
if has_actions(options) and not (options.client or options.all):
329
parser.error("Options require clients names or --all.")
330
if options.verbose and has_actions(options):
331
parser.error("--verbose can only be used alone or with"
332
" --all.")
333
if options.all and not has_actions(options):
334
parser.error("--all requires an action.")
335
336
if options.check:
337
fail_count, test_count = doctest.testmod()
338
sys.exit(os.EX_OK if fail_count == 0 else 1)
339
340
try:
341
bus = dbus.SystemBus()
342
mandos_dbus_objc = bus.get_object(busname, server_path)
343
except dbus.exceptions.DBusException:
344
print("Could not connect to Mandos server", file=sys.stderr)
345
sys.exit(1)
346
347
mandos_serv = dbus.Interface(mandos_dbus_objc,
348
dbus_interface = server_interface)
349
mandos_serv_object_manager = dbus.Interface(
350
mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
351
352
#block stderr since dbus library prints to stderr
353
null = os.open(os.path.devnull, os.O_RDWR)
354
stderrcopy = os.dup(sys.stderr.fileno())
355
os.dup2(null, sys.stderr.fileno())
356
os.close(null)
357
try:
358
try:
359
mandos_clients = { path: ifs_and_props[client_interface]
360
for path, ifs_and_props in
361
mandos_serv_object_manager
362
.GetManagedObjects().items()
363
if client_interface in ifs_and_props }
364
finally:
365
#restore stderr
366
os.dup2(stderrcopy, sys.stderr.fileno())
367
os.close(stderrcopy)
368
except dbus.exceptions.DBusException as e:
369
print("Access denied: Accessing mandos server through D-Bus: {}"
370
.format(e), file=sys.stderr)
371
sys.exit(1)
372
373
# Compile dict of (clients: properties) to process
374
clients={}
375
376
if options.all or not options.client:
377
clients = { bus.get_object(busname, path): properties
378
for path, properties in mandos_clients.items() }
379
else:
380
for name in options.client:
381
for path, client in mandos_clients.items():
382
if client["Name"] == name:
383
client_objc = bus.get_object(busname, path)
384
clients[client_objc] = client
385
break
386
else:
387
print("Client not found on server: {!r}"
388
.format(name), file=sys.stderr)
389
sys.exit(1)
390
391
if not has_actions(options) and clients:
392
if options.verbose:
393
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
"Created", "Interval", "Host", "Fingerprint",
395
"CheckerRunning", "LastEnabled",
396
"ApprovalPending", "ApprovedByDefault",
397
"LastApprovalRequest", "ApprovalDelay",
398
"ApprovalDuration", "Checker",
399
"ExtendedTimeout")
400
else:
401
keywords = defaultkeywords
402
403
print_clients(clients.values(), keywords)
404
else:
405
# Process each client in the list by all selected options
406
for client in clients:
407
408
def set_client_prop(prop, value):
409
"""Set a Client D-Bus property"""
410
client.Set(client_interface, prop, value,
411
dbus_interface=dbus.PROPERTIES_IFACE)
412
413
def set_client_prop_ms(prop, value):
414
"""Set a Client D-Bus property, converted
415
from a string to milliseconds."""
416
set_client_prop(prop,
417
string_to_delta(value).total_seconds()
418
* 1000)
419
420
if options.remove:
421
mandos_serv.RemoveClient(client.__dbus_object_path__)
422
if options.enable:
423
set_client_prop("Enabled", dbus.Boolean(True))
424
if options.disable:
425
set_client_prop("Enabled", dbus.Boolean(False))
426
if options.bump_timeout:
427
set_client_prop("LastCheckedOK", "")
428
if options.start_checker:
429
set_client_prop("CheckerRunning", dbus.Boolean(True))
430
if options.stop_checker:
431
set_client_prop("CheckerRunning", dbus.Boolean(False))
432
if options.is_enabled:
433
sys.exit(0 if client.Get(client_interface,
434
"Enabled",
435
dbus_interface=
436
dbus.PROPERTIES_IFACE)
437
else 1)
438
if options.checker is not None:
439
set_client_prop("Checker", options.checker)
440
if options.host is not None:
441
set_client_prop("Host", options.host)
442
if options.interval is not None:
443
set_client_prop_ms("Interval", options.interval)
444
if options.approval_delay is not None:
445
set_client_prop_ms("ApprovalDelay",
446
options.approval_delay)
447
if options.approval_duration is not None:
448
set_client_prop_ms("ApprovalDuration",
449
options.approval_duration)
450
if options.timeout is not None:
451
set_client_prop_ms("Timeout", options.timeout)
452
if options.extended_timeout is not None:
453
set_client_prop_ms("ExtendedTimeout",
454
options.extended_timeout)
455
if options.secret is not None:
456
set_client_prop("Secret",
457
dbus.ByteArray(options.secret.read()))
458
if options.approved_by_default is not None:
459
set_client_prop("ApprovedByDefault",
460
dbus.Boolean(options
461
.approved_by_default))
462
if options.approve:
463
client.Approve(dbus.Boolean(True),
464
dbus_interface=client_interface)
465
elif options.deny:
466
client.Approve(dbus.Boolean(False),
467
dbus_interface=client_interface)
468
469
470
if __name__ == "__main__":
471
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0