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