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