2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2008-2019 Teddy Hogeborn
7
# Copyright © 2008-2019 Björn Påhlsson
9
# This file is part of Mandos.
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
13
# the Free Software Foundation, either version 3 of the License, or
14
# (at your option) any later version.
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
# GNU General Public License for more details.
21
# You should have received a copy of the GNU General Public License
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
24
# Contact the authors at <mandos@recompile.se>.
27
from __future__ import (division, absolute_import, print_function,
31
from future_builtins import *
2
# -*- mode: python; coding: utf-8 -*-
4
from __future__ import division
7
from optparse import OptionParser
48
# Show warnings by default
49
if not sys.warnoptions:
51
warnings.simplefilter("default")
53
log = logging.getLogger(sys.argv[0])
54
logging.basicConfig(level="INFO", # Show info level messages
55
format="%(message)s") # Show basic log messages
57
logging.captureWarnings(True) # Show warnings via the logging system
59
if sys.version_info.major == 2:
62
locale.setlocale(locale.LC_ALL, "")
12
locale.setlocale(locale.LC_ALL, u'')
68
"LastCheckedOK": "Last Successful Check",
69
"LastApprovalRequest": "Last Approval Request",
71
"Interval": "Interval",
73
"Fingerprint": "Fingerprint",
75
"CheckerRunning": "Check Is Running",
76
"LastEnabled": "Last Enabled",
77
"ApprovalPending": "Approval Is Pending",
78
"ApprovedByDefault": "Approved By Default",
79
"ApprovalDelay": "Approval Delay",
80
"ApprovalDuration": "Approval Duration",
82
"ExtendedTimeout": "Extended Timeout",
84
"LastCheckerStatus": "Last Checker Status",
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
domain = "se.recompile"
88
busname = domain + ".Mandos"
90
server_interface = domain + ".Mandos"
91
client_interface = domain + ".Mandos.Client"
96
dbus.OBJECT_MANAGER_IFACE
97
except AttributeError:
98
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
16
'enabled': u'Enabled',
17
'timeout': u'Timeout',
18
'last_checked_ok': u'Last Successful Check',
19
'created': u'Created',
20
'interval': u'Interval',
22
'fingerprint': u'Fingerprint',
23
'checker_running': u'Check Is Running',
24
'last_enabled': u'Last Enabled',
25
'checker': u'Checker',
27
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
29
domain = 'se.bsnet.fukt'
30
busname = domain + '.Mandos'
32
server_interface = domain + '.Mandos'
33
client_interface = domain + '.Mandos.Client'
35
bus = dbus.SystemBus()
36
mandos_dbus_objc = bus.get_object(busname, server_path)
37
mandos_serv = dbus.Interface(mandos_dbus_objc,
38
dbus_interface = server_interface)
39
mandos_clients = mandos_serv.GetAllClientsWithProperties()
41
def datetime_to_milliseconds(dt):
42
"Return the 'timeout' attribute in milliseconds"
43
return ((dt.days * 24 * 60 * 60 * 1000)
45
+ (dt.microseconds // 1000))
101
47
def milliseconds_to_string(ms):
102
48
td = datetime.timedelta(0, 0, 0, ms)
103
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
104
.format(days="{}T".format(td.days) if td.days else "",
105
hours=td.seconds // 3600,
106
minutes=(td.seconds % 3600) // 60,
107
seconds=td.seconds % 60))
110
def rfc3339_duration_to_delta(duration):
111
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
113
>>> rfc3339_duration_to_delta("P7D")
114
datetime.timedelta(7)
115
>>> rfc3339_duration_to_delta("PT60S")
116
datetime.timedelta(0, 60)
117
>>> rfc3339_duration_to_delta("PT60M")
118
datetime.timedelta(0, 3600)
119
>>> rfc3339_duration_to_delta("P60M")
120
datetime.timedelta(1680)
121
>>> rfc3339_duration_to_delta("PT24H")
122
datetime.timedelta(1)
123
>>> rfc3339_duration_to_delta("P1W")
124
datetime.timedelta(7)
125
>>> rfc3339_duration_to_delta("PT5M30S")
126
datetime.timedelta(0, 330)
127
>>> rfc3339_duration_to_delta("P1DT3M20S")
128
datetime.timedelta(1, 200)
129
>>> # Can not be empty:
130
>>> rfc3339_duration_to_delta("")
131
Traceback (most recent call last):
133
ValueError: Invalid RFC 3339 duration: u''
134
>>> # Must start with "P":
135
>>> rfc3339_duration_to_delta("1D")
136
Traceback (most recent call last):
138
ValueError: Invalid RFC 3339 duration: u'1D'
139
>>> # Must use correct order
140
>>> rfc3339_duration_to_delta("PT1S2M")
141
Traceback (most recent call last):
143
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
144
>>> # Time needs time marker
145
>>> rfc3339_duration_to_delta("P1H2S")
146
Traceback (most recent call last):
148
ValueError: Invalid RFC 3339 duration: u'P1H2S'
149
>>> # Weeks can not be combined with anything else
150
>>> rfc3339_duration_to_delta("P1D2W")
151
Traceback (most recent call last):
153
ValueError: Invalid RFC 3339 duration: u'P1D2W'
154
>>> rfc3339_duration_to_delta("P2W2H")
155
Traceback (most recent call last):
157
ValueError: Invalid RFC 3339 duration: u'P2W2H'
160
# Parsing an RFC 3339 duration with regular expressions is not
161
# possible - there would have to be multiple places for the same
162
# values, like seconds. The current code, while more esoteric, is
163
# cleaner without depending on a parsing library. If Python had a
164
# built-in library for parsing we would use it, but we'd like to
165
# avoid excessive use of external libraries.
167
# New type for defining tokens, syntax, and semantics all-in-one
168
Token = collections.namedtuple("Token", (
169
"regexp", # To match token; if "value" is not None, must have
170
# a "group" containing digits
171
"value", # datetime.timedelta or None
172
"followers")) # Tokens valid after this token
173
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
174
# the "duration" ABNF definition in RFC 3339, Appendix A.
175
token_end = Token(re.compile(r"$"), None, frozenset())
176
token_second = Token(re.compile(r"(\d+)S"),
177
datetime.timedelta(seconds=1),
178
frozenset((token_end, )))
179
token_minute = Token(re.compile(r"(\d+)M"),
180
datetime.timedelta(minutes=1),
181
frozenset((token_second, token_end)))
182
token_hour = Token(re.compile(r"(\d+)H"),
183
datetime.timedelta(hours=1),
184
frozenset((token_minute, token_end)))
185
token_time = Token(re.compile(r"T"),
187
frozenset((token_hour, token_minute,
189
token_day = Token(re.compile(r"(\d+)D"),
190
datetime.timedelta(days=1),
191
frozenset((token_time, token_end)))
192
token_month = Token(re.compile(r"(\d+)M"),
193
datetime.timedelta(weeks=4),
194
frozenset((token_day, token_end)))
195
token_year = Token(re.compile(r"(\d+)Y"),
196
datetime.timedelta(weeks=52),
197
frozenset((token_month, token_end)))
198
token_week = Token(re.compile(r"(\d+)W"),
199
datetime.timedelta(weeks=1),
200
frozenset((token_end, )))
201
token_duration = Token(re.compile(r"P"), None,
202
frozenset((token_year, token_month,
203
token_day, token_time,
205
# Define starting values:
207
value = datetime.timedelta()
209
# Following valid tokens
210
followers = frozenset((token_duration, ))
211
# String left to parse
213
# Loop until end token is found
214
while found_token is not token_end:
215
# Search for any currently valid tokens
216
for token in followers:
217
match = token.regexp.match(s)
218
if match is not None:
220
if token.value is not None:
221
# Value found, parse digits
222
factor = int(match.group(1), 10)
223
# Add to value so far
224
value += factor * token.value
225
# Strip token from string
226
s = token.regexp.sub("", s, 1)
229
# Set valid next tokens
230
followers = found_token.followers
233
# No currently valid tokens were found
234
raise ValueError("Invalid RFC 3339 duration: {!r}"
49
return "%s%02d:%02d:%02d" % (("%dT" % td.days) if td.days else "", # days
50
td.seconds // 3600, # hours
51
(td.seconds % 3600) // 60, # minutes
52
(td.seconds % 60)) # seconds
240
55
def string_to_delta(interval):
248
63
datetime.timedelta(0, 3600)
249
64
>>> string_to_delta('24h')
250
65
datetime.timedelta(1)
251
>>> string_to_delta('1w')
66
>>> string_to_delta(u'1w')
252
67
datetime.timedelta(7)
253
68
>>> string_to_delta('5m 30s')
254
69
datetime.timedelta(0, 330)
258
return rfc3339_duration_to_delta(interval)
262
value = datetime.timedelta(0)
263
regexp = re.compile(r"(\d+)([dsmhw]?)")
265
for num, suffix in regexp.findall(interval):
267
value += datetime.timedelta(int(num))
269
value += datetime.timedelta(0, int(num))
271
value += datetime.timedelta(0, 0, 0, 0, int(num))
273
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
275
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
277
value += datetime.timedelta(0, 0, 0, int(num))
281
def print_clients(clients, keywords):
71
timevalue = datetime.timedelta(0)
72
regexp = re.compile("\d+[dsmhw]")
74
for s in regexp.findall(interval):
76
suffix = unicode(s[-1])
79
delta = datetime.timedelta(value)
81
delta = datetime.timedelta(0, value)
83
delta = datetime.timedelta(0, 0, 0, 0, value)
85
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
87
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
90
except (ValueError, IndexError):
95
def print_clients(clients):
282
96
def valuetostring(value, keyword):
283
if isinstance(value, dbus.Boolean):
284
return "Yes" if value else "No"
285
if keyword in ("Timeout", "Interval", "ApprovalDelay",
286
"ApprovalDuration", "ExtendedTimeout"):
97
if type(value) is dbus.Boolean:
98
return u"Yes" if value else u"No"
99
if keyword in ("timeout", "interval"):
287
100
return milliseconds_to_string(value)
290
# Create format string to print table rows
291
format_string = " ".join("{{{key}:{width}}}".format(
292
width=max(len(tablewords[key]),
293
max(len(valuetostring(client[key], key))
294
for client in clients)),
298
print(format_string.format(**tablewords))
101
return unicode(value)
103
format_string = u' '.join(u'%%-%ds' %
104
max(len(tablewords[key]),
105
max(len(valuetostring(client[key], key))
109
print format_string % tuple(tablewords[key] for key in keywords)
299
110
for client in clients:
301
.format(**{key: valuetostring(client[key], key)
302
for key in keywords}))
305
def has_actions(options):
306
return any((options.enable,
308
options.bump_timeout,
309
options.start_checker,
310
options.stop_checker,
313
options.checker is not None,
314
options.timeout is not None,
315
options.extended_timeout is not None,
316
options.interval is not None,
317
options.approved_by_default is not None,
318
options.approval_delay is not None,
319
options.approval_duration is not None,
320
options.host is not None,
321
options.secret is not None,
327
parser = argparse.ArgumentParser()
328
parser.add_argument("--version", action="version",
329
version="%(prog)s {}".format(version),
330
help="show version number and exit")
331
parser.add_argument("-a", "--all", action="store_true",
332
help="Select all clients")
333
parser.add_argument("-v", "--verbose", action="store_true",
334
help="Print all fields")
335
parser.add_argument("-j", "--dump-json", action="store_true",
336
help="Dump client data in JSON format")
337
parser.add_argument("-e", "--enable", action="store_true",
338
help="Enable client")
339
parser.add_argument("-d", "--disable", action="store_true",
340
help="disable client")
341
parser.add_argument("-b", "--bump-timeout", action="store_true",
342
help="Bump timeout for client")
343
parser.add_argument("--start-checker", action="store_true",
344
help="Start checker for client")
345
parser.add_argument("--stop-checker", action="store_true",
346
help="Stop checker for client")
347
parser.add_argument("-V", "--is-enabled", action="store_true",
348
help="Check if client is enabled")
349
parser.add_argument("-r", "--remove", action="store_true",
350
help="Remove client")
351
parser.add_argument("-c", "--checker",
352
help="Set checker command for client")
353
parser.add_argument("-t", "--timeout",
354
help="Set timeout for client")
355
parser.add_argument("--extended-timeout",
356
help="Set extended timeout for client")
357
parser.add_argument("-i", "--interval",
358
help="Set checker interval for client")
359
parser.add_argument("--approve-by-default", action="store_true",
360
default=None, dest="approved_by_default",
361
help="Set client to be approved by default")
362
parser.add_argument("--deny-by-default", action="store_false",
363
dest="approved_by_default",
364
help="Set client to be denied by default")
365
parser.add_argument("--approval-delay",
366
help="Set delay before client approve/deny")
367
parser.add_argument("--approval-duration",
368
help="Set duration of one client approval")
369
parser.add_argument("-H", "--host", help="Set host for client")
370
parser.add_argument("-s", "--secret",
371
type=argparse.FileType(mode="rb"),
372
help="Set password blob (file) for client")
373
parser.add_argument("-A", "--approve", action="store_true",
374
help="Approve any current client request")
375
parser.add_argument("-D", "--deny", action="store_true",
376
help="Deny any current client request")
377
parser.add_argument("--check", action="store_true",
378
help="Run self-test")
379
parser.add_argument("client", nargs="*", help="Client name")
380
options = parser.parse_args()
382
if has_actions(options) and not (options.client or options.all):
383
parser.error("Options require clients names or --all.")
384
if options.verbose and has_actions(options):
385
parser.error("--verbose can only be used alone.")
386
if options.dump_json and (options.verbose
387
or has_actions(options)):
388
parser.error("--dump-json can only be used alone.")
389
if options.all and not has_actions(options):
390
parser.error("--all requires an action.")
393
bus = dbus.SystemBus()
394
mandos_dbus_objc = bus.get_object(busname, server_path)
395
except dbus.exceptions.DBusException:
396
log.critical("Could not connect to Mandos server")
399
mandos_serv = dbus.Interface(mandos_dbus_objc,
400
dbus_interface=server_interface)
401
mandos_serv_object_manager = dbus.Interface(
402
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
404
# block stderr since dbus library prints to stderr
405
null = os.open(os.path.devnull, os.O_RDWR)
406
stderrcopy = os.dup(sys.stderr.fileno())
407
os.dup2(null, sys.stderr.fileno())
411
mandos_clients = {path: ifs_and_props[client_interface]
412
for path, ifs_and_props in
413
mandos_serv_object_manager
414
.GetManagedObjects().items()
415
if client_interface in ifs_and_props}
418
os.dup2(stderrcopy, sys.stderr.fileno())
420
except dbus.exceptions.DBusException as e:
421
log.critical("Failed to access Mandos server through D-Bus:"
425
# Compile dict of (clients: properties) to process
428
if options.all or not options.client:
429
clients = {bus.get_object(busname, path): properties
430
for path, properties in mandos_clients.items()}
432
for name in options.client:
433
for path, client in mandos_clients.items():
434
if client["Name"] == name:
435
client_objc = bus.get_object(busname, path)
436
clients[client_objc] = client
439
log.critical("Client not found on server: %r", name)
442
if not has_actions(options) and clients:
443
if options.verbose or options.dump_json:
444
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
445
"Created", "Interval", "Host", "KeyID",
446
"Fingerprint", "CheckerRunning",
447
"LastEnabled", "ApprovalPending",
448
"ApprovedByDefault", "LastApprovalRequest",
449
"ApprovalDelay", "ApprovalDuration",
450
"Checker", "ExtendedTimeout", "Expires",
453
keywords = defaultkeywords
455
if options.dump_json:
456
json.dump({client["Name"]: {key:
458
if isinstance(client[key],
462
for client in clients.values()},
463
fp=sys.stdout, indent=4,
464
separators=(',', ': '))
467
print_clients(clients.values(), keywords)
469
# Process each client in the list by all selected options
470
for client in clients:
472
def set_client_prop(prop, value):
473
"""Set a Client D-Bus property"""
474
client.Set(client_interface, prop, value,
475
dbus_interface=dbus.PROPERTIES_IFACE)
477
def set_client_prop_ms(prop, value):
478
"""Set a Client D-Bus property, converted
479
from a string to milliseconds."""
480
set_client_prop(prop,
481
string_to_delta(value).total_seconds()
485
mandos_serv.RemoveClient(client.__dbus_object_path__)
487
set_client_prop("Enabled", dbus.Boolean(True))
489
set_client_prop("Enabled", dbus.Boolean(False))
490
if options.bump_timeout:
491
set_client_prop("LastCheckedOK", "")
492
if options.start_checker:
493
set_client_prop("CheckerRunning", dbus.Boolean(True))
494
if options.stop_checker:
495
set_client_prop("CheckerRunning", dbus.Boolean(False))
496
if options.is_enabled:
497
if client.Get(client_interface, "Enabled",
498
dbus_interface=dbus.PROPERTIES_IFACE):
502
if options.checker is not None:
503
set_client_prop("Checker", options.checker)
504
if options.host is not None:
505
set_client_prop("Host", options.host)
506
if options.interval is not None:
507
set_client_prop_ms("Interval", options.interval)
508
if options.approval_delay is not None:
509
set_client_prop_ms("ApprovalDelay",
510
options.approval_delay)
511
if options.approval_duration is not None:
512
set_client_prop_ms("ApprovalDuration",
513
options.approval_duration)
514
if options.timeout is not None:
515
set_client_prop_ms("Timeout", options.timeout)
516
if options.extended_timeout is not None:
517
set_client_prop_ms("ExtendedTimeout",
518
options.extended_timeout)
519
if options.secret is not None:
520
set_client_prop("Secret",
521
dbus.ByteArray(options.secret.read()))
522
if options.approved_by_default is not None:
523
set_client_prop("ApprovedByDefault",
525
.approved_by_default))
527
client.Approve(dbus.Boolean(True),
528
dbus_interface=client_interface)
530
client.Approve(dbus.Boolean(False),
531
dbus_interface=client_interface)
534
class Test_milliseconds_to_string(unittest.TestCase):
536
self.assertEqual(milliseconds_to_string(93785000),
538
def test_no_days(self):
539
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
540
def test_all_zero(self):
541
self.assertEqual(milliseconds_to_string(0), "00:00:00")
542
def test_no_fractional_seconds(self):
543
self.assertEqual(milliseconds_to_string(400), "00:00:00")
544
self.assertEqual(milliseconds_to_string(900), "00:00:00")
545
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
548
def should_only_run_tests():
549
parser = argparse.ArgumentParser(add_help=False)
550
parser.add_argument("--check", action='store_true')
551
args, unknown_args = parser.parse_known_args()
552
run_tests = args.check
554
# Remove --check argument from sys.argv
555
sys.argv[1:] = unknown_args
558
# Add all tests from doctest strings
559
def load_tests(loader, tests, none):
561
tests.addTests(doctest.DocTestSuite())
564
if __name__ == "__main__":
565
if should_only_run_tests():
566
# Call using ./tdd-python-script --check [--verbose]
111
print format_string % tuple(valuetostring(client[key], key)
114
parser = OptionParser(version = "%%prog %s" % version)
115
parser.add_option("-a", "--all", action="store_true",
116
help="Print all fields")
117
parser.add_option("-e", "--enable", action="store_true",
118
help="Enable client")
119
parser.add_option("-d", "--disable", action="store_true",
120
help="disable client")
121
parser.add_option("-b", "--bump-timeout", action="store_true",
122
help="Bump timeout for client")
123
parser.add_option("--start-checker", action="store_true",
124
help="Start checker for client")
125
parser.add_option("--stop-checker", action="store_true",
126
help="Stop checker for client")
127
parser.add_option("-V", "--is-valid", action="store_true",
128
help="Check if client is still valid")
129
parser.add_option("-r", "--remove", action="store_true",
130
help="Remove client")
131
parser.add_option("-c", "--checker", type="string",
132
help="Set checker command for client")
133
parser.add_option("-t", "--timeout", type="string",
134
help="Set timeout for client")
135
parser.add_option("-i", "--interval", type="string",
136
help="Set checker interval for client")
137
parser.add_option("-H", "--host", type="string",
138
help="Set host for client")
139
parser.add_option("-s", "--secret", type="string",
140
help="Set password blob (file) for client")
141
options, client_names = parser.parse_args()
143
# Compile list of clients to process
145
for name in client_names:
146
for path, client in mandos_clients.iteritems():
147
if client['name'] == name:
148
client_objc = bus.get_object(busname, path)
149
clients.append(dbus.Interface(client_objc,
154
print >> sys.stderr, "Client not found on server: %r" % name
157
if not clients and mandos_clients.values():
158
keywords = defaultkeywords
160
keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
161
'created', 'interval', 'host', 'fingerprint',
162
'checker_running', 'last_enabled', 'checker')
163
print_clients(mandos_clients.values())
165
# Process each client in the list by all selected options
166
for client in clients:
168
mandos_serv.RemoveClient(client.__dbus_object_path__)
173
if options.bump_timeout:
175
if options.start_checker:
176
client.StartChecker()
177
if options.stop_checker:
180
sys.exit(0 if client.IsStillValid() else 1)
182
client.SetChecker(options.checker)
184
client.SetHost(options.host)
186
client.SetInterval(datetime_to_milliseconds
187
(string_to_delta(options.interval)))
189
client.SetTimeout(datetime_to_milliseconds
190
(string_to_delta(options.timeout)))
192
client.SetSecret(dbus.ByteArray(open(options.secret, 'rb').read()))