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