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