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 24.1.130
- compare with another revision
- download diff
- download tarball
- view history from revision 24.1.130
- Committer: Björn Påhlsson
- Date: 2009-02-06 01:13:58 UTC
- mto: (24.1.154 mandos) (237.4.3 mandos-release)
- mto: This revision was merged to the branch mainline in revision 306.
- Revision ID: belorn@braxen-20090206011358-d92mnhobdv0d7csw
new domain name for d-bus
- files removed:
- 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
# 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
13
# the Free Software Foundation, either version 3 of the License, or
14
# (at your option) any later version.
15
#
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
# GNU General Public License for more details.
20
#
21
# 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
#
24
# Contact the authors at <mandos@recompile.se>.
25
#
26
27
from __future__ import (division, absolute_import, print_function,
28
unicode_literals)
29
30
try:
31
from future_builtins import *
32
except ImportError:
33
pass
34
3
4
from __future__ import division
35
5
import sys
36
import argparse
6
import dbus
7
from optparse import OptionParser
37
8
import locale
38
9
import datetime
39
10
import re
40
import os
41
import collections
42
import json
43
44
import dbus
45
46
if sys.version_info.major == 2:
47
str = unicode
48
49
locale.setlocale(locale.LC_ALL, "")
11
12
locale.setlocale(locale.LC_ALL, u'')
50
13
51
14
tablewords = {
52
"Name": "Name",
53
"Enabled": "Enabled",
54
"Timeout": "Timeout",
55
"LastCheckedOK": "Last Successful Check",
56
"LastApprovalRequest": "Last Approval Request",
57
"Created": "Created",
58
"Interval": "Interval",
59
"Host": "Host",
60
"Fingerprint": "Fingerprint",
61
"CheckerRunning": "Check Is Running",
62
"LastEnabled": "Last Enabled",
63
"ApprovalPending": "Approval Is Pending",
64
"ApprovedByDefault": "Approved By Default",
65
"ApprovalDelay": "Approval Delay",
66
"ApprovalDuration": "Approval Duration",
67
"Checker": "Checker",
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
domain = "se.recompile"
74
busname = domain + ".Mandos"
75
server_path = "/"
76
server_interface = domain + ".Mandos"
77
client_interface = domain + ".Mandos.Client"
78
version = "1.7.16"
79
80
81
try:
82
dbus.OBJECT_MANAGER_IFACE
83
except AttributeError:
84
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
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
domain = 'se.bsnet.fukt'
30
busname = domain + '.Mandos'
31
server_path = '/'
32
server_interface = domain + '.Mandos'
33
client_interface = domain + '.Mandos.Client'
34
version = "1.0.5"
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))
86
46
87
47
def milliseconds_to_string(ms):
88
48
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
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
193
53
194
54
195
55
def string_to_delta(interval):
203
63
datetime.timedelta(0, 3600)
204
64
>>> string_to_delta('24h')
205
65
datetime.timedelta(1)
206
>>> string_to_delta('1w')
66
>>> string_to_delta(u'1w')
207
67
datetime.timedelta(7)
208
68
>>> string_to_delta('5m 30s')
209
69
datetime.timedelta(0, 330)
210
70
"""
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
235
236
def print_clients(clients, keywords):
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):
237
96
def valuetostring(value, keyword):
238
97
if type(value) is dbus.Boolean:
239
return "Yes" if value else "No"
240
if keyword in ("Timeout", "Interval", "ApprovalDelay",
241
"ApprovalDuration", "ExtendedTimeout"):
98
return u"Yes" if value else u"No"
99
if keyword in ("timeout", "interval"):
242
100
return milliseconds_to_string(value)
243
return str(value)
244
245
# 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)
251
for key in keywords)
252
# Print header line
253
print(format_string.format(**tablewords))
101
return unicode(value)
102
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)
254
110
for client in clients:
255
print(format_string
256
.format(**{key: valuetostring(client[key], key)
257
for key in keywords}))
258
259
260
def has_actions(options):
261
return any((options.enable,
262
options.disable,
263
options.bump_timeout,
264
options.start_checker,
265
options.stop_checker,
266
options.is_enabled,
267
options.remove,
268
options.checker is not None,
269
options.timeout is not None,
270
options.extended_timeout is not None,
271
options.interval is not None,
272
options.approved_by_default is not None,
273
options.approval_delay is not None,
274
options.approval_duration is not None,
275
options.host is not None,
276
options.secret is not None,
277
options.approve,
278
options.deny))
279
280
281
def main():
282
parser = argparse.ArgumentParser()
283
parser.add_argument("--version", action="version",
284
version="%(prog)s {}".format(version),
285
help="show version number and exit")
286
parser.add_argument("-a", "--all", action="store_true",
287
help="Select all clients")
288
parser.add_argument("-v", "--verbose", action="store_true",
289
help="Print all fields")
290
parser.add_argument("-j", "--dump-json", action="store_true",
291
help="Dump client data in JSON format")
292
parser.add_argument("-e", "--enable", action="store_true",
293
help="Enable client")
294
parser.add_argument("-d", "--disable", action="store_true",
295
help="disable client")
296
parser.add_argument("-b", "--bump-timeout", action="store_true",
297
help="Bump timeout for client")
298
parser.add_argument("--start-checker", action="store_true",
299
help="Start checker for client")
300
parser.add_argument("--stop-checker", action="store_true",
301
help="Stop checker for client")
302
parser.add_argument("-V", "--is-enabled", action="store_true",
303
help="Check if client is enabled")
304
parser.add_argument("-r", "--remove", action="store_true",
305
help="Remove client")
306
parser.add_argument("-c", "--checker",
307
help="Set checker command for client")
308
parser.add_argument("-t", "--timeout",
309
help="Set timeout for client")
310
parser.add_argument("--extended-timeout",
311
help="Set extended timeout for client")
312
parser.add_argument("-i", "--interval",
313
help="Set checker interval for client")
314
parser.add_argument("--approve-by-default", action="store_true",
315
default=None, dest="approved_by_default",
316
help="Set client to be approved by default")
317
parser.add_argument("--deny-by-default", action="store_false",
318
dest="approved_by_default",
319
help="Set client to be denied by default")
320
parser.add_argument("--approval-delay",
321
help="Set delay before client approve/deny")
322
parser.add_argument("--approval-duration",
323
help="Set duration of one client approval")
324
parser.add_argument("-H", "--host", help="Set host for client")
325
parser.add_argument("-s", "--secret",
326
type=argparse.FileType(mode="rb"),
327
help="Set password blob (file) for client")
328
parser.add_argument("-A", "--approve", action="store_true",
329
help="Approve any current client request")
330
parser.add_argument("-D", "--deny", action="store_true",
331
help="Deny any current client request")
332
parser.add_argument("--check", action="store_true",
333
help="Run self-test")
334
parser.add_argument("client", nargs="*", help="Client name")
335
options = parser.parse_args()
336
337
if has_actions(options) and not (options.client or options.all):
338
parser.error("Options require clients names or --all.")
339
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.")
344
if options.all and not has_actions(options):
345
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
352
try:
353
bus = dbus.SystemBus()
354
mandos_dbus_objc = bus.get_object(busname, server_path)
355
except dbus.exceptions.DBusException:
356
print("Could not connect to Mandos server", file=sys.stderr)
357
sys.exit(1)
358
359
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
365
null = os.open(os.path.devnull, os.O_RDWR)
366
stderrcopy = os.dup(sys.stderr.fileno())
367
os.dup2(null, sys.stderr.fileno())
368
os.close(null)
369
try:
370
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}
376
finally:
377
# restore stderr
378
os.dup2(stderrcopy, sys.stderr.fileno())
379
os.close(stderrcopy)
380
except dbus.exceptions.DBusException as e:
381
print("Access denied: "
382
"Accessing mandos server through D-Bus: {}".format(e),
383
file=sys.stderr)
384
sys.exit(1)
385
386
# Compile dict of (clients: properties) to process
387
clients = {}
388
389
if options.all or not options.client:
390
clients = {bus.get_object(busname, path): properties
391
for path, properties in mandos_clients.items()}
392
else:
393
for name in options.client:
394
for path, client in mandos_clients.items():
395
if client["Name"] == name:
396
client_objc = bus.get_object(busname, path)
397
clients[client_objc] = client
398
break
399
else:
400
print("Client not found on server: {!r}"
401
.format(name), file=sys.stderr)
402
sys.exit(1)
403
404
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",
410
"LastApprovalRequest", "ApprovalDelay",
411
"ApprovalDuration", "Checker",
412
"ExtendedTimeout", "Expires",
413
"LastCheckerStatus")
414
else:
415
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)
430
else:
431
# Process each client in the list by all selected options
432
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
if options.remove:
447
mandos_serv.RemoveClient(client.__dbus_object_path__)
448
if options.enable:
449
set_client_prop("Enabled", dbus.Boolean(True))
450
if options.disable:
451
set_client_prop("Enabled", dbus.Boolean(False))
452
if options.bump_timeout:
453
set_client_prop("LastCheckedOK", "")
454
if options.start_checker:
455
set_client_prop("CheckerRunning", dbus.Boolean(True))
456
if options.stop_checker:
457
set_client_prop("CheckerRunning", dbus.Boolean(False))
458
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()))
484
if options.approved_by_default is not None:
485
set_client_prop("ApprovedByDefault",
486
dbus.Boolean(options
487
.approved_by_default))
488
if options.approve:
489
client.Approve(dbus.Boolean(True),
490
dbus_interface=client_interface)
491
elif options.deny:
492
client.Approve(dbus.Boolean(False),
493
dbus_interface=client_interface)
494
495
496
if __name__ == "__main__":
497
main()
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 client")
119
parser.add_option("-d", "--disable", action="store_true",
120
help="disable client")
121
parser.add_option("-b", "--bump-timeout", action="store_true",
122
help="Bump timeout for client")
123
parser.add_option("--start-checker", action="store_true",
124
help="Start checker for client")
125
parser.add_option("--stop-checker", action="store_true",
126
help="Stop checker for client")
127
parser.add_option("-V", "--is-valid", action="store_true",
128
help="Check if client is still valid")
129
parser.add_option("-r", "--remove", action="store_true",
130
help="Remove client")
131
parser.add_option("-c", "--checker", type="string",
132
help="Set checker command for client")
133
parser.add_option("-t", "--timeout", type="string",
134
help="Set timeout for client")
135
parser.add_option("-i", "--interval", type="string",
136
help="Set checker interval for client")
137
parser.add_option("-H", "--host", type="string",
138
help="Set host for client")
139
parser.add_option("-s", "--secret", type="string",
140
help="Set password blob (file) for client")
141
options, client_names = parser.parse_args()
142
143
# Compile list of clients to processed
144
clients=[]
145
for name in client_names:
146
for path, client in mandos_clients.iteritems():
147
if client['name'] == name:
148
client_objc = bus.get_object(busname, path)
149
clients.append(dbus.Interface(client_objc,
150
dbus_interface
151
= client_interface))
152
break
153
else:
154
print >> sys.stderr, "Client not found on server: %r" % name
155
sys.exit(1)
156
157
if not clients and mandos_clients.values():
158
keywords = defaultkeywords
159
if options.all:
160
keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
161
'created', 'interval', 'host', 'fingerprint',
162
'checker_running', 'last_enabled', 'checker')
163
print_clients(mandos_clients.values())
164
165
# Process each client in the list by all selected options
166
for client in clients:
167
if options.remove:
168
mandos_serv.RemoveClient(client.__dbus_object_path__)
169
if options.enable:
170
client.Enable()
171
if options.disable:
172
client.Disable()
173
if options.bump_timeout:
174
client.BumpTimeout()
175
if options.start_checker:
176
client.StartChecker()
177
if options.stop_checker:
178
client.StopChecker()
179
if options.is_valid:
180
sys.exit(0 if client.IsStillValid() else 1)
181
if options.checker:
182
client.SetChecker(options.checker)
183
if options.host:
184
client.SetHost(options.host)
185
if options.interval:
186
client.SetInterval(datetime_to_milliseconds
187
(string_to_delta(options.interval)))
188
if options.timeout:
189
client.SetTimeout(datetime_to_milliseconds
190
(string_to_delta(options.timeout)))
191
if options.secret:
192
client.SetSecret(dbus.ByteArray(open(options.secret, 'rb').read()))
193
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0