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 287
- compare with another revision
- download diff
- download tarball
- view history from revision 287
- Committer: Teddy Hogeborn
- Date: 2011-10-09 17:36:01 UTC
- Revision ID: teddy@recompile.se-20111009173601-ctzsqstad3q2bs4c
Tags: version-1.4.0-1
* Makefile (version): Changed to "1.4.0".
* NEWS (Version 1.4.0): New entry.
* debian/changelog (1.4.0-1): - '' -
* NEWS (Version 1.4.0): New entry.
* debian/changelog (1.4.0-1): - '' -
- files removed:
- bugs.xml
- 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
#
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
#
6
# Copyright © 2008-2018 Teddy Hogeborn
7
# Copyright © 2008-2018 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
5
#
6
# Copyright © 2008-2011 Teddy Hogeborn
7
# Copyright © 2008-2011 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
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
17
# GNU General Public License for more details.
20
#
18
#
21
19
# You should have received a copy of the GNU General Public License
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
23
#
20
# along with this program. If not, see <http://www.gnu.org/licenses/>.
21
#
24
22
# Contact the authors at <mandos@recompile.se>.
25
#
23
#
26
24
27
25
from __future__ import (division, absolute_import, print_function,
28
26
unicode_literals)
29
27
30
try:
31
from future_builtins import *
32
except ImportError:
33
pass
34
35
28
import sys
29
import dbus
36
30
import argparse
37
31
import locale
38
32
import datetime
39
33
import re
40
34
import os
41
import collections
42
import json
43
44
import dbus
45
46
if sys.version_info.major == 2:
47
str = unicode
48
35
49
36
locale.setlocale(locale.LC_ALL, "")
50
37
65
52
"ApprovalDelay": "Approval Delay",
66
53
"ApprovalDuration": "Approval Duration",
67
54
"Checker": "Checker",
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
55
"ExtendedTimeout" : "Extended Timeout"
56
}
72
57
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
58
domain = "se.recompile"
74
59
busname = domain + ".Mandos"
75
60
server_path = "/"
76
61
server_interface = domain + ".Mandos"
77
62
client_interface = domain + ".Mandos.Client"
78
version = "1.7.19"
79
80
81
try:
82
dbus.OBJECT_MANAGER_IFACE
83
except AttributeError:
84
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
63
version = "1.4.0"
64
65
def timedelta_to_milliseconds(td):
66
"""Convert a datetime.timedelta object to milliseconds"""
67
return ((td.days * 24 * 60 * 60 * 1000)
68
+ (td.seconds * 1000)
69
+ (td.microseconds // 1000))
86
70
87
71
def milliseconds_to_string(ms):
88
72
td = datetime.timedelta(0, 0, 0, ms)
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))
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
73
return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
74
% { "days": "%dT" % td.days if td.days else "",
75
"hours": td.seconds // 3600,
76
"minutes": (td.seconds % 3600) // 60,
77
"seconds": td.seconds % 60,
78
})
194
79
195
80
def string_to_delta(interval):
196
81
"""Parse a string and return a datetime.timedelta
197
198
>>> string_to_delta('7d')
82
83
>>> string_to_delta("7d")
199
84
datetime.timedelta(7)
200
>>> string_to_delta('60s')
85
>>> string_to_delta("60s")
201
86
datetime.timedelta(0, 60)
202
>>> string_to_delta('60m')
87
>>> string_to_delta("60m")
203
88
datetime.timedelta(0, 3600)
204
>>> string_to_delta('24h')
89
>>> string_to_delta("24h")
205
90
datetime.timedelta(1)
206
>>> string_to_delta('1w')
91
>>> string_to_delta("1w")
207
92
datetime.timedelta(7)
208
>>> string_to_delta('5m 30s')
93
>>> string_to_delta("5m 30s")
209
94
datetime.timedelta(0, 330)
210
95
"""
211
212
try:
213
return rfc3339_duration_to_delta(interval)
214
except ValueError:
215
pass
216
217
value = datetime.timedelta(0)
218
regexp = re.compile(r"(\d+)([dsmhw]?)")
219
220
for num, suffix in regexp.findall(interval):
221
if suffix == "d":
222
value += datetime.timedelta(int(num))
223
elif suffix == "s":
224
value += datetime.timedelta(0, int(num))
225
elif suffix == "m":
226
value += datetime.timedelta(0, 0, 0, 0, int(num))
227
elif suffix == "h":
228
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
229
elif suffix == "w":
230
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
231
elif suffix == "":
232
value += datetime.timedelta(0, 0, 0, int(num))
233
return value
234
96
timevalue = datetime.timedelta(0)
97
regexp = re.compile("\d+[dsmhw]")
98
99
for s in regexp.findall(interval):
100
try:
101
suffix = unicode(s[-1])
102
value = int(s[:-1])
103
if suffix == "d":
104
delta = datetime.timedelta(value)
105
elif suffix == "s":
106
delta = datetime.timedelta(0, value)
107
elif suffix == "m":
108
delta = datetime.timedelta(0, 0, 0, 0, value)
109
elif suffix == "h":
110
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
111
elif suffix == "w":
112
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
113
else:
114
raise ValueError
115
except (ValueError, IndexError):
116
raise ValueError
117
timevalue += delta
118
return timevalue
235
119
236
120
def print_clients(clients, keywords):
237
121
def valuetostring(value, keyword):
238
122
if type(value) is dbus.Boolean:
239
123
return "Yes" if value else "No"
240
124
if keyword in ("Timeout", "Interval", "ApprovalDelay",
241
"ApprovalDuration", "ExtendedTimeout"):
125
"ApprovalDuration"):
242
126
return milliseconds_to_string(value)
243
return str(value)
244
127
return unicode(value)
128
245
129
# Create format string to print table rows
246
format_string = " ".join("{{{key}:{width}}}".format(
247
width=max(len(tablewords[key]),
248
max(len(valuetostring(client[key], key))
249
for client in clients)),
250
key=key)
130
format_string = " ".join("%%-%ds" %
131
max(len(tablewords[key]),
132
max(len(valuetostring(client[key],
133
key))
134
for client in
135
clients))
251
136
for key in keywords)
252
137
# Print header line
253
print(format_string.format(**tablewords))
138
print(format_string % tuple(tablewords[key] for key in keywords))
254
139
for client in clients:
255
print(format_string
256
.format(**{key: valuetostring(client[key], key)
257
for key in keywords}))
258
140
print(format_string % tuple(valuetostring(client[key], key)
141
for key in keywords))
259
142
260
143
def has_actions(options):
261
144
return any((options.enable,
277
160
options.approve,
278
161
options.deny))
279
162
280
281
163
def main():
282
164
parser = argparse.ArgumentParser()
283
165
parser.add_argument("--version", action="version",
284
version="%(prog)s {}".format(version),
166
version = "%%prog %s" % version,
285
167
help="show version number and exit")
286
168
parser.add_argument("-a", "--all", action="store_true",
287
169
help="Select all clients")
288
170
parser.add_argument("-v", "--verbose", action="store_true",
289
171
help="Print all fields")
290
parser.add_argument("-j", "--dump-json", action="store_true",
291
help="Dump client data in JSON format")
292
172
parser.add_argument("-e", "--enable", action="store_true",
293
173
help="Enable client")
294
174
parser.add_argument("-d", "--disable", action="store_true",
322
202
parser.add_argument("--approval-duration",
323
203
help="Set duration of one client approval")
324
204
parser.add_argument("-H", "--host", help="Set host for client")
325
parser.add_argument("-s", "--secret",
326
type=argparse.FileType(mode="rb"),
205
parser.add_argument("-s", "--secret", type=file,
327
206
help="Set password blob (file) for client")
328
207
parser.add_argument("-A", "--approve", action="store_true",
329
208
help="Approve any current client request")
330
209
parser.add_argument("-D", "--deny", action="store_true",
331
210
help="Deny any current client request")
332
parser.add_argument("--check", action="store_true",
333
help="Run self-test")
334
211
parser.add_argument("client", nargs="*", help="Client name")
335
212
options = parser.parse_args()
336
337
if has_actions(options) and not (options.client or options.all):
213
214
if has_actions(options) and not options.client and not options.all:
338
215
parser.error("Options require clients names or --all.")
339
216
if options.verbose and has_actions(options):
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.")
217
parser.error("--verbose can only be used alone or with"
218
" --all.")
344
219
if options.all and not has_actions(options):
345
220
parser.error("--all requires an action.")
346
347
if options.check:
348
import doctest
349
fail_count, test_count = doctest.testmod()
350
sys.exit(os.EX_OK if fail_count == 0 else 1)
351
221
352
222
try:
353
223
bus = dbus.SystemBus()
354
224
mandos_dbus_objc = bus.get_object(busname, server_path)
355
225
except dbus.exceptions.DBusException:
356
print("Could not connect to Mandos server", file=sys.stderr)
226
print("Could not connect to Mandos server",
227
file=sys.stderr)
357
228
sys.exit(1)
358
229
359
230
mandos_serv = dbus.Interface(mandos_dbus_objc,
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
231
dbus_interface = server_interface)
232
233
#block stderr since dbus library prints to stderr
365
234
null = os.open(os.path.devnull, os.O_RDWR)
366
235
stderrcopy = os.dup(sys.stderr.fileno())
367
236
os.dup2(null, sys.stderr.fileno())
368
237
os.close(null)
369
238
try:
370
239
try:
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}
240
mandos_clients = mandos_serv.GetAllClientsWithProperties()
376
241
finally:
377
# restore stderr
242
#restore stderr
378
243
os.dup2(stderrcopy, sys.stderr.fileno())
379
244
os.close(stderrcopy)
380
except dbus.exceptions.DBusException as e:
381
print("Access denied: "
382
"Accessing mandos server through D-Bus: {}".format(e),
245
except dbus.exceptions.DBusException, e:
246
print("Access denied: Accessing mandos server through dbus.",
383
247
file=sys.stderr)
384
248
sys.exit(1)
385
249
386
250
# Compile dict of (clients: properties) to process
387
clients = {}
388
251
clients={}
252
389
253
if options.all or not options.client:
390
clients = {bus.get_object(busname, path): properties
391
for path, properties in mandos_clients.items()}
254
clients = dict((bus.get_object(busname, path), properties)
255
for path, properties in
256
mandos_clients.iteritems())
392
257
else:
393
258
for name in options.client:
394
for path, client in mandos_clients.items():
259
for path, client in mandos_clients.iteritems():
395
260
if client["Name"] == name:
396
261
client_objc = bus.get_object(busname, path)
397
262
clients[client_objc] = client
398
263
break
399
264
else:
400
print("Client not found on server: {!r}"
401
.format(name), file=sys.stderr)
265
print("Client not found on server: %r" % name,
266
file=sys.stderr)
402
267
sys.exit(1)
403
268
404
269
if not has_actions(options) and clients:
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",
270
if options.verbose:
271
keywords = ("Name", "Enabled", "Timeout",
272
"LastCheckedOK", "Created", "Interval",
273
"Host", "Fingerprint", "CheckerRunning",
274
"LastEnabled", "ApprovalPending",
275
"ApprovedByDefault",
410
276
"LastApprovalRequest", "ApprovalDelay",
411
277
"ApprovalDuration", "Checker",
412
"ExtendedTimeout", "Expires",
413
"LastCheckerStatus")
278
"ExtendedTimeout")
414
279
else:
415
280
keywords = defaultkeywords
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)
281
282
print_clients(clients.values(), keywords)
430
283
else:
431
284
# Process each client in the list by all selected options
432
285
for client in clients:
433
434
def set_client_prop(prop, value):
435
"""Set a Client D-Bus property"""
436
client.Set(client_interface, prop, value,
437
dbus_interface=dbus.PROPERTIES_IFACE)
438
439
def set_client_prop_ms(prop, value):
440
"""Set a Client D-Bus property, converted
441
from a string to milliseconds."""
442
set_client_prop(prop,
443
string_to_delta(value).total_seconds()
444
* 1000)
445
446
286
if options.remove:
447
287
mandos_serv.RemoveClient(client.__dbus_object_path__)
448
288
if options.enable:
449
set_client_prop("Enabled", dbus.Boolean(True))
289
client.Enable(dbus_interface=client_interface)
450
290
if options.disable:
451
set_client_prop("Enabled", dbus.Boolean(False))
291
client.Disable(dbus_interface=client_interface)
452
292
if options.bump_timeout:
453
set_client_prop("LastCheckedOK", "")
293
client.CheckedOK(dbus_interface=client_interface)
454
294
if options.start_checker:
455
set_client_prop("CheckerRunning", dbus.Boolean(True))
295
client.StartChecker(dbus_interface=client_interface)
456
296
if options.stop_checker:
457
set_client_prop("CheckerRunning", dbus.Boolean(False))
297
client.StopChecker(dbus_interface=client_interface)
458
298
if options.is_enabled:
459
if client.Get(client_interface, "Enabled",
460
dbus_interface=dbus.PROPERTIES_IFACE):
461
sys.exit(0)
462
else:
463
sys.exit(1)
464
if options.checker is not None:
465
set_client_prop("Checker", options.checker)
466
if options.host is not None:
467
set_client_prop("Host", options.host)
468
if options.interval is not None:
469
set_client_prop_ms("Interval", options.interval)
470
if options.approval_delay is not None:
471
set_client_prop_ms("ApprovalDelay",
472
options.approval_delay)
473
if options.approval_duration is not None:
474
set_client_prop_ms("ApprovalDuration",
475
options.approval_duration)
476
if options.timeout is not None:
477
set_client_prop_ms("Timeout", options.timeout)
478
if options.extended_timeout is not None:
479
set_client_prop_ms("ExtendedTimeout",
480
options.extended_timeout)
481
if options.secret is not None:
482
set_client_prop("Secret",
483
dbus.ByteArray(options.secret.read()))
299
sys.exit(0 if client.Get(client_interface,
300
"Enabled",
301
dbus_interface=
302
dbus.PROPERTIES_IFACE)
303
else 1)
304
if options.checker:
305
client.Set(client_interface, "Checker",
306
options.checker,
307
dbus_interface=dbus.PROPERTIES_IFACE)
308
if options.host:
309
client.Set(client_interface, "Host", options.host,
310
dbus_interface=dbus.PROPERTIES_IFACE)
311
if options.interval:
312
client.Set(client_interface, "Interval",
313
timedelta_to_milliseconds
314
(string_to_delta(options.interval)),
315
dbus_interface=dbus.PROPERTIES_IFACE)
316
if options.approval_delay:
317
client.Set(client_interface, "ApprovalDelay",
318
timedelta_to_milliseconds
319
(string_to_delta(options.
320
approval_delay)),
321
dbus_interface=dbus.PROPERTIES_IFACE)
322
if options.approval_duration:
323
client.Set(client_interface, "ApprovalDuration",
324
timedelta_to_milliseconds
325
(string_to_delta(options.
326
approval_duration)),
327
dbus_interface=dbus.PROPERTIES_IFACE)
328
if options.timeout:
329
client.Set(client_interface, "Timeout",
330
timedelta_to_milliseconds
331
(string_to_delta(options.timeout)),
332
dbus_interface=dbus.PROPERTIES_IFACE)
333
if options.extended_timeout:
334
client.Set(client_interface, "ExtendedTimeout",
335
timedelta_to_milliseconds
336
(string_to_delta(options.extended_timeout)),
337
dbus_interface=dbus.PROPERTIES_IFACE)
338
if options.secret:
339
client.Set(client_interface, "Secret",
340
dbus.ByteArray(open(options.secret,
341
"rb").read()),
342
dbus_interface=dbus.PROPERTIES_IFACE)
484
343
if options.approved_by_default is not None:
485
set_client_prop("ApprovedByDefault",
486
dbus.Boolean(options
487
.approved_by_default))
344
client.Set(client_interface, "ApprovedByDefault",
345
dbus.Boolean(options
346
.approved_by_default),
347
dbus_interface=dbus.PROPERTIES_IFACE)
488
348
if options.approve:
489
349
client.Approve(dbus.Boolean(True),
490
350
dbus_interface=client_interface)
492
352
client.Approve(dbus.Boolean(False),
493
353
dbus_interface=client_interface)
494
354
495
496
355
if __name__ == "__main__":
497
356
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0