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 237.4.111
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.111
- Committer: Teddy Hogeborn
- Date: 2019-02-13 08:47:02 UTC
- mto: This revision was merged to the branch mainline in revision 1100.
- Revision ID: teddy@recompile.se-20190213084702-oca64n46uaf85kr3
Merge from trunk
- files added:
- bugs.xml
- debian/upstream
- 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-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-2019 Teddy Hogeborn
7
# Copyright © 2008-2019 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
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
23
#
22
24
# Contact the authors at <mandos@recompile.se>.
23
#
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
45
58
"Interval": "Interval",
46
59
"Host": "Host",
47
60
"Fingerprint": "Fingerprint",
61
"KeyID": "Key ID",
48
62
"CheckerRunning": "Check Is Running",
49
63
"LastEnabled": "Last Enabled",
50
64
"ApprovalPending": "Approval Is Pending",
52
66
"ApprovalDelay": "Approval Delay",
53
67
"ApprovalDuration": "Approval Duration",
54
68
"Checker": "Checker",
55
"ExtendedTimeout" : "Extended Timeout"
56
}
69
"ExtendedTimeout": "Extended Timeout",
70
"Expires": "Expires",
71
"LastCheckerStatus": "Last Checker Status",
72
}
57
73
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
58
74
domain = "se.recompile"
59
75
busname = domain + ".Mandos"
60
76
server_path = "/"
61
77
server_interface = domain + ".Mandos"
62
78
client_interface = domain + ".Mandos.Client"
63
version = "1.5.3"
64
65
def timedelta_to_milliseconds(td):
66
"""Convert a datetime.timedelta object to milliseconds"""
67
return ((td.days * 24 * 60 * 60 * 1000)
68
+ (td.seconds * 1000)
69
+ (td.microseconds // 1000))
79
version = "1.8.3"
80
81
82
try:
83
dbus.OBJECT_MANAGER_IFACE
84
except AttributeError:
85
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
86
70
87
71
88
def milliseconds_to_string(ms):
72
89
td = datetime.timedelta(0, 0, 0, ms)
73
90
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
74
.format(days = "{0}T".format(td.days) if td.days else "",
75
hours = td.seconds // 3600,
76
minutes = (td.seconds % 3600) // 60,
77
seconds = td.seconds % 60,
78
))
91
.format(days="{}T".format(td.days) if td.days else "",
92
hours=td.seconds // 3600,
93
minutes=(td.seconds % 3600) // 60,
94
seconds=td.seconds % 60))
95
96
97
def rfc3339_duration_to_delta(duration):
98
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
99
100
>>> rfc3339_duration_to_delta("P7D")
101
datetime.timedelta(7)
102
>>> rfc3339_duration_to_delta("PT60S")
103
datetime.timedelta(0, 60)
104
>>> rfc3339_duration_to_delta("PT60M")
105
datetime.timedelta(0, 3600)
106
>>> rfc3339_duration_to_delta("PT24H")
107
datetime.timedelta(1)
108
>>> rfc3339_duration_to_delta("P1W")
109
datetime.timedelta(7)
110
>>> rfc3339_duration_to_delta("PT5M30S")
111
datetime.timedelta(0, 330)
112
>>> rfc3339_duration_to_delta("P1DT3M20S")
113
datetime.timedelta(1, 200)
114
"""
115
116
# Parsing an RFC 3339 duration with regular expressions is not
117
# possible - there would have to be multiple places for the same
118
# values, like seconds. The current code, while more esoteric, is
119
# cleaner without depending on a parsing library. If Python had a
120
# built-in library for parsing we would use it, but we'd like to
121
# avoid excessive use of external libraries.
122
123
# New type for defining tokens, syntax, and semantics all-in-one
124
Token = collections.namedtuple("Token", (
125
"regexp", # To match token; if "value" is not None, must have
126
# a "group" containing digits
127
"value", # datetime.timedelta or None
128
"followers")) # Tokens valid after this token
129
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
# the "duration" ABNF definition in RFC 3339, Appendix A.
131
token_end = Token(re.compile(r"$"), None, frozenset())
132
token_second = Token(re.compile(r"(\d+)S"),
133
datetime.timedelta(seconds=1),
134
frozenset((token_end, )))
135
token_minute = Token(re.compile(r"(\d+)M"),
136
datetime.timedelta(minutes=1),
137
frozenset((token_second, token_end)))
138
token_hour = Token(re.compile(r"(\d+)H"),
139
datetime.timedelta(hours=1),
140
frozenset((token_minute, token_end)))
141
token_time = Token(re.compile(r"T"),
142
None,
143
frozenset((token_hour, token_minute,
144
token_second)))
145
token_day = Token(re.compile(r"(\d+)D"),
146
datetime.timedelta(days=1),
147
frozenset((token_time, token_end)))
148
token_month = Token(re.compile(r"(\d+)M"),
149
datetime.timedelta(weeks=4),
150
frozenset((token_day, token_end)))
151
token_year = Token(re.compile(r"(\d+)Y"),
152
datetime.timedelta(weeks=52),
153
frozenset((token_month, token_end)))
154
token_week = Token(re.compile(r"(\d+)W"),
155
datetime.timedelta(weeks=1),
156
frozenset((token_end, )))
157
token_duration = Token(re.compile(r"P"), None,
158
frozenset((token_year, token_month,
159
token_day, token_time,
160
token_week)))
161
# Define starting values:
162
# Value so far
163
value = datetime.timedelta()
164
found_token = None
165
# Following valid tokens
166
followers = frozenset((token_duration, ))
167
# String left to parse
168
s = duration
169
# Loop until end token is found
170
while found_token is not token_end:
171
# Search for any currently valid tokens
172
for token in followers:
173
match = token.regexp.match(s)
174
if match is not None:
175
# Token found
176
if token.value is not None:
177
# Value found, parse digits
178
factor = int(match.group(1), 10)
179
# Add to value so far
180
value += factor * token.value
181
# Strip token from string
182
s = token.regexp.sub("", s, 1)
183
# Go to found token
184
found_token = token
185
# Set valid next tokens
186
followers = found_token.followers
187
break
188
else:
189
# No currently valid tokens were found
190
raise ValueError("Invalid RFC 3339 duration: {!r}"
191
.format(duration))
192
# End token found
193
return value
194
79
195
80
196
def string_to_delta(interval):
81
197
"""Parse a string and return a datetime.timedelta
82
83
>>> string_to_delta("7d")
198
199
>>> string_to_delta('7d')
84
200
datetime.timedelta(7)
85
>>> string_to_delta("60s")
201
>>> string_to_delta('60s')
86
202
datetime.timedelta(0, 60)
87
>>> string_to_delta("60m")
203
>>> string_to_delta('60m')
88
204
datetime.timedelta(0, 3600)
89
>>> string_to_delta("24h")
205
>>> string_to_delta('24h')
90
206
datetime.timedelta(1)
91
>>> string_to_delta("1w")
207
>>> string_to_delta('1w')
92
208
datetime.timedelta(7)
93
>>> string_to_delta("5m 30s")
209
>>> string_to_delta('5m 30s')
94
210
datetime.timedelta(0, 330)
95
211
"""
212
213
try:
214
return rfc3339_duration_to_delta(interval)
215
except ValueError:
216
pass
217
96
218
value = datetime.timedelta(0)
97
regexp = re.compile("(\d+)([dsmhw]?)")
98
219
regexp = re.compile(r"(\d+)([dsmhw]?)")
220
99
221
for num, suffix in regexp.findall(interval):
100
222
if suffix == "d":
101
223
value += datetime.timedelta(int(num))
111
233
value += datetime.timedelta(0, 0, 0, int(num))
112
234
return value
113
235
236
114
237
def print_clients(clients, keywords):
115
238
def valuetostring(value, keyword):
116
239
if type(value) is dbus.Boolean:
118
241
if keyword in ("Timeout", "Interval", "ApprovalDelay",
119
242
"ApprovalDuration", "ExtendedTimeout"):
120
243
return milliseconds_to_string(value)
121
return unicode(value)
122
244
return str(value)
245
123
246
# Create format string to print table rows
124
247
format_string = " ".join("{{{key}:{width}}}".format(
125
width = max(len(tablewords[key]),
126
max(len(valuetostring(client[key],
127
key))
128
for client in
129
clients)),
130
key = key) for key in keywords)
248
width=max(len(tablewords[key]),
249
max(len(valuetostring(client[key], key))
250
for client in clients)),
251
key=key)
252
for key in keywords)
131
253
# Print header line
132
254
print(format_string.format(**tablewords))
133
255
for client in clients:
134
print(format_string.format(**dict((key,
135
valuetostring(client[key],
136
key))
137
for key in keywords)))
256
print(format_string
257
.format(**{key: valuetostring(client[key], key)
258
for key in keywords}))
259
138
260
139
261
def has_actions(options):
140
262
return any((options.enable,
156
278
options.approve,
157
279
options.deny))
158
280
281
159
282
def main():
160
283
parser = argparse.ArgumentParser()
161
284
parser.add_argument("--version", action="version",
162
version = "%(prog)s {0}".format(version),
285
version="%(prog)s {}".format(version),
163
286
help="show version number and exit")
164
287
parser.add_argument("-a", "--all", action="store_true",
165
288
help="Select all clients")
166
289
parser.add_argument("-v", "--verbose", action="store_true",
167
290
help="Print all fields")
291
parser.add_argument("-j", "--dump-json", action="store_true",
292
help="Dump client data in JSON format")
168
293
parser.add_argument("-e", "--enable", action="store_true",
169
294
help="Enable client")
170
295
parser.add_argument("-d", "--disable", action="store_true",
198
323
parser.add_argument("--approval-duration",
199
324
help="Set duration of one client approval")
200
325
parser.add_argument("-H", "--host", help="Set host for client")
201
parser.add_argument("-s", "--secret", type=file,
326
parser.add_argument("-s", "--secret",
327
type=argparse.FileType(mode="rb"),
202
328
help="Set password blob (file) for client")
203
329
parser.add_argument("-A", "--approve", action="store_true",
204
330
help="Approve any current client request")
205
331
parser.add_argument("-D", "--deny", action="store_true",
206
332
help="Deny any current client request")
333
parser.add_argument("--check", action="store_true",
334
help="Run self-test")
207
335
parser.add_argument("client", nargs="*", help="Client name")
208
336
options = parser.parse_args()
209
210
if has_actions(options) and not options.client and not options.all:
337
338
if has_actions(options) and not (options.client or options.all):
211
339
parser.error("Options require clients names or --all.")
212
340
if options.verbose and has_actions(options):
213
parser.error("--verbose can only be used alone or with"
214
" --all.")
341
parser.error("--verbose can only be used alone.")
342
if options.dump_json and (options.verbose
343
or has_actions(options)):
344
parser.error("--dump-json can only be used alone.")
215
345
if options.all and not has_actions(options):
216
346
parser.error("--all requires an action.")
217
347
348
if options.check:
349
import doctest
350
fail_count, test_count = doctest.testmod()
351
sys.exit(os.EX_OK if fail_count == 0 else 1)
352
218
353
try:
219
354
bus = dbus.SystemBus()
220
355
mandos_dbus_objc = bus.get_object(busname, server_path)
221
356
except dbus.exceptions.DBusException:
222
print("Could not connect to Mandos server",
223
file=sys.stderr)
357
print("Could not connect to Mandos server", file=sys.stderr)
224
358
sys.exit(1)
225
359
226
360
mandos_serv = dbus.Interface(mandos_dbus_objc,
227
dbus_interface = server_interface)
228
229
#block stderr since dbus library prints to stderr
361
dbus_interface=server_interface)
362
mandos_serv_object_manager = dbus.Interface(
363
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
364
365
# block stderr since dbus library prints to stderr
230
366
null = os.open(os.path.devnull, os.O_RDWR)
231
367
stderrcopy = os.dup(sys.stderr.fileno())
232
368
os.dup2(null, sys.stderr.fileno())
233
369
os.close(null)
234
370
try:
235
371
try:
236
mandos_clients = mandos_serv.GetAllClientsWithProperties()
372
mandos_clients = {path: ifs_and_props[client_interface]
373
for path, ifs_and_props in
374
mandos_serv_object_manager
375
.GetManagedObjects().items()
376
if client_interface in ifs_and_props}
237
377
finally:
238
#restore stderr
378
# restore stderr
239
379
os.dup2(stderrcopy, sys.stderr.fileno())
240
380
os.close(stderrcopy)
241
except dbus.exceptions.DBusException:
242
print("Access denied: Accessing mandos server through dbus.",
381
except dbus.exceptions.DBusException as e:
382
print("Access denied: "
383
"Accessing mandos server through D-Bus: {}".format(e),
243
384
file=sys.stderr)
244
385
sys.exit(1)
245
386
246
387
# Compile dict of (clients: properties) to process
247
clients={}
248
388
clients = {}
389
249
390
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())
391
clients = {bus.get_object(busname, path): properties
392
for path, properties in mandos_clients.items()}
253
393
else:
254
394
for name in options.client:
255
for path, client in mandos_clients.iteritems():
395
for path, client in mandos_clients.items():
256
396
if client["Name"] == name:
257
397
client_objc = bus.get_object(busname, path)
258
398
clients[client_objc] = client
259
399
break
260
400
else:
261
print("Client not found on server: {0!r}"
401
print("Client not found on server: {!r}"
262
402
.format(name), file=sys.stderr)
263
403
sys.exit(1)
264
404
265
405
if not has_actions(options) and clients:
266
if options.verbose:
267
keywords = ("Name", "Enabled", "Timeout",
268
"LastCheckedOK", "Created", "Interval",
269
"Host", "Fingerprint", "CheckerRunning",
406
if options.verbose or options.dump_json:
407
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
408
"Created", "Interval", "Host", "KeyID",
409
"Fingerprint", "CheckerRunning",
270
410
"LastEnabled", "ApprovalPending",
271
"ApprovedByDefault",
272
"LastApprovalRequest", "ApprovalDelay",
273
"ApprovalDuration", "Checker",
274
"ExtendedTimeout")
411
"ApprovedByDefault", "LastApprovalRequest",
412
"ApprovalDelay", "ApprovalDuration",
413
"Checker", "ExtendedTimeout", "Expires",
414
"LastCheckerStatus")
275
415
else:
276
416
keywords = defaultkeywords
277
278
print_clients(clients.values(), keywords)
417
418
if options.dump_json:
419
json.dump({client["Name"]: {key:
420
bool(client[key])
421
if isinstance(client[key],
422
dbus.Boolean)
423
else client[key]
424
for key in keywords}
425
for client in clients.values()},
426
fp=sys.stdout, indent=4,
427
separators=(',', ': '))
428
print()
429
else:
430
print_clients(clients.values(), keywords)
279
431
else:
280
432
# Process each client in the list by all selected options
281
433
for client in clients:
434
282
435
def set_client_prop(prop, value):
283
436
"""Set a Client D-Bus property"""
284
437
client.Set(client_interface, prop, value,
285
438
dbus_interface=dbus.PROPERTIES_IFACE)
439
286
440
def set_client_prop_ms(prop, value):
287
441
"""Set a Client D-Bus property, converted
288
442
from a string to milliseconds."""
289
443
set_client_prop(prop,
290
timedelta_to_milliseconds
291
(string_to_delta(value)))
444
string_to_delta(value).total_seconds()
445
* 1000)
446
292
447
if options.remove:
293
448
mandos_serv.RemoveClient(client.__dbus_object_path__)
294
449
if options.enable:
302
457
if options.stop_checker:
303
458
set_client_prop("CheckerRunning", dbus.Boolean(False))
304
459
if options.is_enabled:
305
sys.exit(0 if client.Get(client_interface,
306
"Enabled",
307
dbus_interface=
308
dbus.PROPERTIES_IFACE)
309
else 1)
460
if client.Get(client_interface, "Enabled",
461
dbus_interface=dbus.PROPERTIES_IFACE):
462
sys.exit(0)
463
else:
464
sys.exit(1)
310
465
if options.checker is not None:
311
466
set_client_prop("Checker", options.checker)
312
467
if options.host is not None:
338
493
client.Approve(dbus.Boolean(False),
339
494
dbus_interface=client_interface)
340
495
496
341
497
if __name__ == "__main__":
342
498
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0