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 600
- compare with another revision
- download diff
- download tarball
- view history from revision 600
- Committer: Teddy Hogeborn
- Date: 2012-06-16 19:30:08 UTC
- Revision ID: teddy@recompile.se-20120616193008-2erbfaw5a5y3yay1
* debian/mandos-client.README.Debian: Update documentation for using
multiple interfaces.
multiple interfaces.
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-2017 Teddy Hogeborn
7
# Copyright © 2008-2017 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-2012 Teddy Hogeborn
7
# Copyright © 2008-2012 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
21
# <http://www.gnu.org/licenses/>.
22
#
24
23
# Contact the authors at <mandos@recompile.se>.
25
#
24
#
26
25
27
26
from __future__ import (division, absolute_import, print_function,
28
27
unicode_literals)
29
28
30
try:
31
from future_builtins import *
32
except ImportError:
33
pass
29
from future_builtins import *
34
30
35
31
import sys
32
import dbus
36
33
import argparse
37
34
import locale
38
35
import datetime
39
36
import re
40
37
import os
41
import collections
42
import json
43
44
import dbus
45
46
if sys.version_info.major == 2:
47
str = unicode
48
38
49
39
locale.setlocale(locale.LC_ALL, "")
50
40
65
55
"ApprovalDelay": "Approval Delay",
66
56
"ApprovalDuration": "Approval Duration",
67
57
"Checker": "Checker",
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
58
"ExtendedTimeout" : "Extended Timeout"
59
}
72
60
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
61
domain = "se.recompile"
74
62
busname = domain + ".Mandos"
75
63
server_path = "/"
76
64
server_interface = domain + ".Mandos"
77
65
client_interface = domain + ".Mandos.Client"
78
version = "1.7.15"
79
80
81
try:
82
dbus.OBJECT_MANAGER_IFACE
83
except AttributeError:
84
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
66
version = "1.5.5"
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))
86
73
87
74
def milliseconds_to_string(ms):
88
75
td = datetime.timedelta(0, 0, 0, ms)
89
76
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
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
))
194
82
195
83
def string_to_delta(interval):
196
84
"""Parse a string and return a datetime.timedelta
197
198
>>> string_to_delta('7d')
85
86
>>> string_to_delta("7d")
199
87
datetime.timedelta(7)
200
>>> string_to_delta('60s')
88
>>> string_to_delta("60s")
201
89
datetime.timedelta(0, 60)
202
>>> string_to_delta('60m')
90
>>> string_to_delta("60m")
203
91
datetime.timedelta(0, 3600)
204
>>> string_to_delta('24h')
92
>>> string_to_delta("24h")
205
93
datetime.timedelta(1)
206
>>> string_to_delta('1w')
94
>>> string_to_delta("1w")
207
95
datetime.timedelta(7)
208
>>> string_to_delta('5m 30s')
96
>>> string_to_delta("5m 30s")
209
97
datetime.timedelta(0, 330)
210
98
"""
211
212
try:
213
return rfc3339_duration_to_delta(interval)
214
except ValueError:
215
pass
216
217
99
value = datetime.timedelta(0)
218
regexp = re.compile(r"(\d+)([dsmhw]?)")
219
100
regexp = re.compile("(\d+)([dsmhw]?)")
101
220
102
for num, suffix in regexp.findall(interval):
221
103
if suffix == "d":
222
104
value += datetime.timedelta(int(num))
232
114
value += datetime.timedelta(0, 0, 0, int(num))
233
115
return value
234
116
235
236
117
def print_clients(clients, keywords):
237
118
def valuetostring(value, keyword):
238
119
if type(value) is dbus.Boolean:
240
121
if keyword in ("Timeout", "Interval", "ApprovalDelay",
241
122
"ApprovalDuration", "ExtendedTimeout"):
242
123
return milliseconds_to_string(value)
243
return str(value)
244
124
return unicode(value)
125
245
126
# Create format string to print table rows
246
127
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)
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)
252
134
# Print header line
253
135
print(format_string.format(**tablewords))
254
136
for client in clients:
255
print(format_string
256
.format(**{key: valuetostring(client[key], key)
257
for key in keywords}))
258
137
print(format_string.format(**dict((key,
138
valuetostring(client[key],
139
key))
140
for key in keywords)))
259
141
260
142
def has_actions(options):
261
143
return any((options.enable,
277
159
options.approve,
278
160
options.deny))
279
161
280
281
162
def main():
282
163
parser = argparse.ArgumentParser()
283
164
parser.add_argument("--version", action="version",
284
version="%(prog)s {}".format(version),
165
version = "%(prog)s {0}".format(version),
285
166
help="show version number and exit")
286
167
parser.add_argument("-a", "--all", action="store_true",
287
168
help="Select all clients")
288
169
parser.add_argument("-v", "--verbose", action="store_true",
289
170
help="Print all fields")
290
parser.add_argument("-j", "--dump-json", action="store_true",
291
help="Dump client data in JSON format")
292
171
parser.add_argument("-e", "--enable", action="store_true",
293
172
help="Enable client")
294
173
parser.add_argument("-d", "--disable", action="store_true",
322
201
parser.add_argument("--approval-duration",
323
202
help="Set duration of one client approval")
324
203
parser.add_argument("-H", "--host", help="Set host for client")
325
parser.add_argument("-s", "--secret",
326
type=argparse.FileType(mode="rb"),
204
parser.add_argument("-s", "--secret", type=file,
327
205
help="Set password blob (file) for client")
328
206
parser.add_argument("-A", "--approve", action="store_true",
329
207
help="Approve any current client request")
330
208
parser.add_argument("-D", "--deny", action="store_true",
331
209
help="Deny any current client request")
332
parser.add_argument("--check", action="store_true",
333
help="Run self-test")
334
210
parser.add_argument("client", nargs="*", help="Client name")
335
211
options = parser.parse_args()
336
212
337
213
if has_actions(options) and not (options.client or options.all):
338
214
parser.error("Options require clients names or --all.")
339
215
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.")
216
parser.error("--verbose can only be used alone or with"
217
" --all.")
344
218
if options.all and not has_actions(options):
345
219
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
220
352
221
try:
353
222
bus = dbus.SystemBus()
354
223
mandos_dbus_objc = bus.get_object(busname, server_path)
355
224
except dbus.exceptions.DBusException:
356
print("Could not connect to Mandos server", file=sys.stderr)
225
print("Could not connect to Mandos server",
226
file=sys.stderr)
357
227
sys.exit(1)
358
228
359
229
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
230
dbus_interface = server_interface)
231
232
#block stderr since dbus library prints to stderr
365
233
null = os.open(os.path.devnull, os.O_RDWR)
366
234
stderrcopy = os.dup(sys.stderr.fileno())
367
235
os.dup2(null, sys.stderr.fileno())
368
236
os.close(null)
369
237
try:
370
238
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}
239
mandos_clients = mandos_serv.GetAllClientsWithProperties()
376
240
finally:
377
# restore stderr
241
#restore stderr
378
242
os.dup2(stderrcopy, sys.stderr.fileno())
379
243
os.close(stderrcopy)
380
except dbus.exceptions.DBusException as e:
381
print("Access denied: "
382
"Accessing mandos server through D-Bus: {}".format(e),
244
except dbus.exceptions.DBusException:
245
print("Access denied: Accessing mandos server through dbus.",
383
246
file=sys.stderr)
384
247
sys.exit(1)
385
248
386
249
# Compile dict of (clients: properties) to process
387
clients = {}
388
250
clients={}
251
389
252
if options.all or not options.client:
390
clients = {bus.get_object(busname, path): properties
391
for path, properties in mandos_clients.items()}
253
clients = dict((bus.get_object(busname, path), properties)
254
for path, properties in
255
mandos_clients.iteritems())
392
256
else:
393
257
for name in options.client:
394
for path, client in mandos_clients.items():
258
for path, client in mandos_clients.iteritems():
395
259
if client["Name"] == name:
396
260
client_objc = bus.get_object(busname, path)
397
261
clients[client_objc] = client
398
262
break
399
263
else:
400
print("Client not found on server: {!r}"
264
print("Client not found on server: {0!r}"
401
265
.format(name), file=sys.stderr)
402
266
sys.exit(1)
403
267
404
268
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",
269
if options.verbose:
270
keywords = ("Name", "Enabled", "Timeout",
271
"LastCheckedOK", "Created", "Interval",
272
"Host", "Fingerprint", "CheckerRunning",
273
"LastEnabled", "ApprovalPending",
274
"ApprovedByDefault",
410
275
"LastApprovalRequest", "ApprovalDelay",
411
276
"ApprovalDuration", "Checker",
412
"ExtendedTimeout", "Expires",
413
"LastCheckerStatus")
277
"ExtendedTimeout")
414
278
else:
415
279
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)
280
281
print_clients(clients.values(), keywords)
430
282
else:
431
283
# Process each client in the list by all selected options
432
284
for client in clients:
433
434
285
def set_client_prop(prop, value):
435
286
"""Set a Client D-Bus property"""
436
287
client.Set(client_interface, prop, value,
437
288
dbus_interface=dbus.PROPERTIES_IFACE)
438
439
289
def set_client_prop_ms(prop, value):
440
290
"""Set a Client D-Bus property, converted
441
291
from a string to milliseconds."""
442
292
set_client_prop(prop,
443
string_to_delta(value).total_seconds()
444
* 1000)
445
293
timedelta_to_milliseconds
294
(string_to_delta(value)))
446
295
if options.remove:
447
296
mandos_serv.RemoveClient(client.__dbus_object_path__)
448
297
if options.enable:
456
305
if options.stop_checker:
457
306
set_client_prop("CheckerRunning", dbus.Boolean(False))
458
307
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)
308
sys.exit(0 if client.Get(client_interface,
309
"Enabled",
310
dbus_interface=
311
dbus.PROPERTIES_IFACE)
312
else 1)
464
313
if options.checker is not None:
465
314
set_client_prop("Checker", options.checker)
466
315
if options.host is not None:
492
341
client.Approve(dbus.Boolean(False),
493
342
dbus_interface=client_interface)
494
343
495
496
344
if __name__ == "__main__":
497
345
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0