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 369
- compare with another revision
- download diff
- download tarball
- view history from revision 369
- Committer: Teddy Hogeborn
- Date: 2018-08-19 20:17:48 UTC
- Revision ID: teddy@recompile.se-20180819201748-4o2n84ltphj9zikx
Tags: version-1.7.20-1
* Makefile (version): Change to 1.7.20.
* NEWS (Version 1.7.20): Add new entry.
* debian/changelog (1.7.20-1): - '' -
* NEWS (Version 1.7.20): Add new entry.
* debian/changelog (1.7.20-1): - '' -
- files added:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- 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-2010 Teddy Hogeborn
7
# Copyright © 2008-2010 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-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
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 <http://www.gnu.org/licenses/>.
21
#
22
# Contact the authors at <mandos@fukt.bsnet.se>.
23
#
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
23
#
24
# Contact the authors at <mandos@recompile.se>.
25
#
24
26
25
27
from __future__ import (division, absolute_import, print_function,
26
28
unicode_literals)
27
29
30
try:
31
from future_builtins import *
32
except ImportError:
33
pass
34
28
35
import sys
29
import dbus
30
36
import argparse
31
37
import locale
32
38
import datetime
33
39
import re
34
40
import os
41
import collections
42
import json
43
44
import dbus
45
46
if sys.version_info.major == 2:
47
str = unicode
35
48
36
49
locale.setlocale(locale.LC_ALL, "")
37
50
52
65
"ApprovalDelay": "Approval Delay",
53
66
"ApprovalDuration": "Approval Duration",
54
67
"Checker": "Checker",
55
}
68
"ExtendedTimeout": "Extended Timeout",
69
"Expires": "Expires",
70
"LastCheckerStatus": "Last Checker Status",
71
}
56
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
57
domain = "se.bsnet.fukt"
73
domain = "se.recompile"
58
74
busname = domain + ".Mandos"
59
75
server_path = "/"
60
76
server_interface = domain + ".Mandos"
61
77
client_interface = domain + ".Mandos.Client"
62
version = "1.3.0"
63
64
def timedelta_to_milliseconds(td):
65
"""Convert a datetime.timedelta object to milliseconds"""
66
return ((td.days * 24 * 60 * 60 * 1000)
67
+ (td.seconds * 1000)
68
+ (td.microseconds // 1000))
78
version = "1.7.20"
79
80
81
try:
82
dbus.OBJECT_MANAGER_IFACE
83
except AttributeError:
84
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
69
86
70
87
def milliseconds_to_string(ms):
71
88
td = datetime.timedelta(0, 0, 0, ms)
72
return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
73
% { "days": "%dT" % td.days if td.days else "",
74
"hours": td.seconds // 3600,
75
"minutes": (td.seconds % 3600) // 60,
76
"seconds": td.seconds % 60,
77
})
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
78
194
79
195
def string_to_delta(interval):
80
196
"""Parse a string and return a datetime.timedelta
81
82
>>> string_to_delta("7d")
197
198
>>> string_to_delta('7d')
83
199
datetime.timedelta(7)
84
>>> string_to_delta("60s")
200
>>> string_to_delta('60s')
85
201
datetime.timedelta(0, 60)
86
>>> string_to_delta("60m")
202
>>> string_to_delta('60m')
87
203
datetime.timedelta(0, 3600)
88
>>> string_to_delta("24h")
204
>>> string_to_delta('24h')
89
205
datetime.timedelta(1)
90
>>> string_to_delta("1w")
206
>>> string_to_delta('1w')
91
207
datetime.timedelta(7)
92
>>> string_to_delta("5m 30s")
208
>>> string_to_delta('5m 30s')
93
209
datetime.timedelta(0, 330)
94
210
"""
95
timevalue = datetime.timedelta(0)
96
regexp = re.compile("\d+[dsmhw]")
97
98
for s in regexp.findall(interval):
99
try:
100
suffix = unicode(s[-1])
101
value = int(s[:-1])
102
if suffix == "d":
103
delta = datetime.timedelta(value)
104
elif suffix == "s":
105
delta = datetime.timedelta(0, value)
106
elif suffix == "m":
107
delta = datetime.timedelta(0, 0, 0, 0, value)
108
elif suffix == "h":
109
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
110
elif suffix == "w":
111
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
112
else:
113
raise ValueError
114
except (ValueError, IndexError):
115
raise ValueError
116
timevalue += delta
117
return timevalue
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
118
235
119
236
def print_clients(clients, keywords):
120
237
def valuetostring(value, keyword):
121
238
if type(value) is dbus.Boolean:
122
239
return "Yes" if value else "No"
123
240
if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
"ApprovalDuration"):
241
"ApprovalDuration", "ExtendedTimeout"):
125
242
return milliseconds_to_string(value)
126
return unicode(value)
127
243
return str(value)
244
128
245
# Create format string to print table rows
129
format_string = " ".join("%%-%ds" %
130
max(len(tablewords[key]),
131
max(len(valuetostring(client[key],
132
key))
133
for client in
134
clients))
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)
135
251
for key in keywords)
136
252
# Print header line
137
print(format_string % tuple(tablewords[key] for key in keywords))
253
print(format_string.format(**tablewords))
138
254
for client in clients:
139
print(format_string % tuple(valuetostring(client[key], key)
140
for key in keywords))
255
print(format_string
256
.format(**{key: valuetostring(client[key], key)
257
for key in keywords}))
258
141
259
142
260
def has_actions(options):
143
261
return any((options.enable,
149
267
options.remove,
150
268
options.checker is not None,
151
269
options.timeout is not None,
270
options.extended_timeout is not None,
152
271
options.interval is not None,
153
272
options.approved_by_default is not None,
154
273
options.approval_delay is not None,
158
277
options.approve,
159
278
options.deny))
160
279
280
161
281
def main():
162
282
parser = argparse.ArgumentParser()
163
283
parser.add_argument("--version", action="version",
164
version = "%%prog %s" % version,
284
version="%(prog)s {}".format(version),
165
285
help="show version number and exit")
166
286
parser.add_argument("-a", "--all", action="store_true",
167
287
help="Select all clients")
168
288
parser.add_argument("-v", "--verbose", action="store_true",
169
289
help="Print all fields")
290
parser.add_argument("-j", "--dump-json", action="store_true",
291
help="Dump client data in JSON format")
170
292
parser.add_argument("-e", "--enable", action="store_true",
171
293
help="Enable client")
172
294
parser.add_argument("-d", "--disable", action="store_true",
185
307
help="Set checker command for client")
186
308
parser.add_argument("-t", "--timeout",
187
309
help="Set timeout for client")
310
parser.add_argument("--extended-timeout",
311
help="Set extended timeout for client")
188
312
parser.add_argument("-i", "--interval",
189
313
help="Set checker interval for client")
190
314
parser.add_argument("--approve-by-default", action="store_true",
198
322
parser.add_argument("--approval-duration",
199
323
help="Set duration of one client approval")
200
324
parser.add_argument("-H", "--host", help="Set host for client")
201
parser.add_argument("-s", "--secret", type=file,
325
parser.add_argument("-s", "--secret",
326
type=argparse.FileType(mode="rb"),
202
327
help="Set password blob (file) for client")
203
328
parser.add_argument("-A", "--approve", action="store_true",
204
329
help="Approve any current client request")
205
330
parser.add_argument("-D", "--deny", action="store_true",
206
331
help="Deny any current client request")
332
parser.add_argument("--check", action="store_true",
333
help="Run self-test")
207
334
parser.add_argument("client", nargs="*", help="Client name")
208
335
options = parser.parse_args()
209
210
if has_actions(options) and not options.client and not options.all:
336
337
if has_actions(options) and not (options.client or options.all):
211
338
parser.error("Options require clients names or --all.")
212
339
if options.verbose and has_actions(options):
213
parser.error("--verbose can only be used alone or with"
214
" --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.")
215
344
if options.all and not has_actions(options):
216
345
parser.error("--all requires an action.")
217
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
try:
219
353
bus = dbus.SystemBus()
220
354
mandos_dbus_objc = bus.get_object(busname, server_path)
221
355
except dbus.exceptions.DBusException:
222
print("Could not connect to Mandos server",
223
file=sys.stderr)
356
print("Could not connect to Mandos server", file=sys.stderr)
224
357
sys.exit(1)
225
358
226
359
mandos_serv = dbus.Interface(mandos_dbus_objc,
227
dbus_interface = server_interface)
228
229
#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
230
365
null = os.open(os.path.devnull, os.O_RDWR)
231
366
stderrcopy = os.dup(sys.stderr.fileno())
232
367
os.dup2(null, sys.stderr.fileno())
233
368
os.close(null)
234
369
try:
235
370
try:
236
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}
237
376
finally:
238
#restore stderr
377
# restore stderr
239
378
os.dup2(stderrcopy, sys.stderr.fileno())
240
379
os.close(stderrcopy)
241
except dbus.exceptions.DBusException, e:
242
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),
243
383
file=sys.stderr)
244
384
sys.exit(1)
245
385
246
386
# Compile dict of (clients: properties) to process
247
clients={}
248
387
clients = {}
388
249
389
if options.all or not options.client:
250
clients = dict((bus.get_object(busname, path), properties)
251
for path, properties in
252
mandos_clients.iteritems())
390
clients = {bus.get_object(busname, path): properties
391
for path, properties in mandos_clients.items()}
253
392
else:
254
393
for name in options.client:
255
for path, client in mandos_clients.iteritems():
394
for path, client in mandos_clients.items():
256
395
if client["Name"] == name:
257
396
client_objc = bus.get_object(busname, path)
258
397
clients[client_objc] = client
259
398
break
260
399
else:
261
print("Client not found on server: %r" % name,
262
file=sys.stderr)
400
print("Client not found on server: {!r}"
401
.format(name), file=sys.stderr)
263
402
sys.exit(1)
264
403
265
404
if not has_actions(options) and clients:
266
if options.verbose:
267
keywords = ("Name", "Enabled", "Timeout",
268
"LastCheckedOK", "Created", "Interval",
269
"Host", "Fingerprint", "CheckerRunning",
270
"LastEnabled", "ApprovalPending",
271
"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",
272
410
"LastApprovalRequest", "ApprovalDelay",
273
"ApprovalDuration", "Checker")
411
"ApprovalDuration", "Checker",
412
"ExtendedTimeout", "Expires",
413
"LastCheckerStatus")
274
414
else:
275
415
keywords = defaultkeywords
276
277
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)
278
430
else:
279
431
# Process each client in the list by all selected options
280
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
281
446
if options.remove:
282
447
mandos_serv.RemoveClient(client.__dbus_object_path__)
283
448
if options.enable:
284
client.Enable(dbus_interface=client_interface)
449
set_client_prop("Enabled", dbus.Boolean(True))
285
450
if options.disable:
286
client.Disable(dbus_interface=client_interface)
451
set_client_prop("Enabled", dbus.Boolean(False))
287
452
if options.bump_timeout:
288
client.CheckedOK(dbus_interface=client_interface)
453
set_client_prop("LastCheckedOK", "")
289
454
if options.start_checker:
290
client.StartChecker(dbus_interface=client_interface)
455
set_client_prop("CheckerRunning", dbus.Boolean(True))
291
456
if options.stop_checker:
292
client.StopChecker(dbus_interface=client_interface)
457
set_client_prop("CheckerRunning", dbus.Boolean(False))
293
458
if options.is_enabled:
294
sys.exit(0 if client.Get(client_interface,
295
"Enabled",
296
dbus_interface=
297
dbus.PROPERTIES_IFACE)
298
else 1)
299
if options.checker:
300
client.Set(client_interface, "Checker",
301
options.checker,
302
dbus_interface=dbus.PROPERTIES_IFACE)
303
if options.host:
304
client.Set(client_interface, "Host", options.host,
305
dbus_interface=dbus.PROPERTIES_IFACE)
306
if options.interval:
307
client.Set(client_interface, "Interval",
308
timedelta_to_milliseconds
309
(string_to_delta(options.interval)),
310
dbus_interface=dbus.PROPERTIES_IFACE)
311
if options.approval_delay:
312
client.Set(client_interface, "ApprovalDelay",
313
timedelta_to_milliseconds
314
(string_to_delta(options.
315
approval_delay)),
316
dbus_interface=dbus.PROPERTIES_IFACE)
317
if options.approval_duration:
318
client.Set(client_interface, "ApprovalDuration",
319
timedelta_to_milliseconds
320
(string_to_delta(options.
321
approval_duration)),
322
dbus_interface=dbus.PROPERTIES_IFACE)
323
if options.timeout:
324
client.Set(client_interface, "Timeout",
325
timedelta_to_milliseconds
326
(string_to_delta(options.timeout)),
327
dbus_interface=dbus.PROPERTIES_IFACE)
328
if options.secret:
329
client.Set(client_interface, "Secret",
330
dbus.ByteArray(open(options.secret,
331
"rb").read()),
332
dbus_interface=dbus.PROPERTIES_IFACE)
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()))
333
484
if options.approved_by_default is not None:
334
client.Set(client_interface, "ApprovedByDefault",
335
dbus.Boolean(options
336
.approved_by_default),
337
dbus_interface=dbus.PROPERTIES_IFACE)
485
set_client_prop("ApprovedByDefault",
486
dbus.Boolean(options
487
.approved_by_default))
338
488
if options.approve:
339
489
client.Approve(dbus.Boolean(True),
340
490
dbus_interface=client_interface)
342
492
client.Approve(dbus.Boolean(False),
343
493
dbus_interface=client_interface)
344
494
495
345
496
if __name__ == "__main__":
346
497
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0