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 183
- compare with another revision
- download diff
- download tarball
- view history from revision 183
- Committer: Teddy Hogeborn
- Date: 2008-09-13 15:36:18 UTC
- Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
errors.
* README: Kill the straight quotes. Add copyright notice.
* overview.xml: Improved wording.
errors.
* README: Kill the straight quotes. Add copyright notice.
* overview.xml: Improved wording.
- files added:
- etc-plugins.d-README
- files removed:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos-ctl
1
#!/usr/bin/python
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*")))); -*-
3
#
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
13
# the Free Software Foundation, either version 3 of the License, or
14
# (at your option) any later version.
15
#
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.
20
#
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/>.
23
#
24
# Contact the authors at <mandos@recompile.se>.
25
#
26
27
from __future__ import (division, absolute_import, print_function,
28
unicode_literals)
29
30
try:
31
from future_builtins import *
32
except ImportError:
33
pass
34
35
import sys
36
import argparse
37
import locale
38
import datetime
39
import re
40
import os
41
import collections
42
import json
43
import unittest
44
import logging
45
46
import dbus
47
48
log = logging.getLogger(sys.argv[0])
49
logging.basicConfig(level="INFO", # Show info level messages
50
format="%(message)s") # Show basic log messages
51
52
if sys.version_info.major == 2:
53
str = unicode
54
55
locale.setlocale(locale.LC_ALL, "")
56
57
tablewords = {
58
"Name": "Name",
59
"Enabled": "Enabled",
60
"Timeout": "Timeout",
61
"LastCheckedOK": "Last Successful Check",
62
"LastApprovalRequest": "Last Approval Request",
63
"Created": "Created",
64
"Interval": "Interval",
65
"Host": "Host",
66
"Fingerprint": "Fingerprint",
67
"KeyID": "Key ID",
68
"CheckerRunning": "Check Is Running",
69
"LastEnabled": "Last Enabled",
70
"ApprovalPending": "Approval Is Pending",
71
"ApprovedByDefault": "Approved By Default",
72
"ApprovalDelay": "Approval Delay",
73
"ApprovalDuration": "Approval Duration",
74
"Checker": "Checker",
75
"ExtendedTimeout": "Extended Timeout",
76
"Expires": "Expires",
77
"LastCheckerStatus": "Last Checker Status",
78
}
79
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
80
domain = "se.recompile"
81
busname = domain + ".Mandos"
82
server_path = "/"
83
server_interface = domain + ".Mandos"
84
client_interface = domain + ".Mandos.Client"
85
version = "1.8.3"
86
87
88
try:
89
dbus.OBJECT_MANAGER_IFACE
90
except AttributeError:
91
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
92
93
94
def milliseconds_to_string(ms):
95
td = datetime.timedelta(0, 0, 0, ms)
96
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
97
.format(days="{}T".format(td.days) if td.days else "",
98
hours=td.seconds // 3600,
99
minutes=(td.seconds % 3600) // 60,
100
seconds=td.seconds % 60))
101
102
103
def rfc3339_duration_to_delta(duration):
104
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
105
106
>>> rfc3339_duration_to_delta("P7D")
107
datetime.timedelta(7)
108
>>> rfc3339_duration_to_delta("PT60S")
109
datetime.timedelta(0, 60)
110
>>> rfc3339_duration_to_delta("PT60M")
111
datetime.timedelta(0, 3600)
112
>>> rfc3339_duration_to_delta("PT24H")
113
datetime.timedelta(1)
114
>>> rfc3339_duration_to_delta("P1W")
115
datetime.timedelta(7)
116
>>> rfc3339_duration_to_delta("PT5M30S")
117
datetime.timedelta(0, 330)
118
>>> rfc3339_duration_to_delta("P1DT3M20S")
119
datetime.timedelta(1, 200)
120
"""
121
122
# Parsing an RFC 3339 duration with regular expressions is not
123
# possible - there would have to be multiple places for the same
124
# values, like seconds. The current code, while more esoteric, is
125
# cleaner without depending on a parsing library. If Python had a
126
# built-in library for parsing we would use it, but we'd like to
127
# avoid excessive use of external libraries.
128
129
# New type for defining tokens, syntax, and semantics all-in-one
130
Token = collections.namedtuple("Token", (
131
"regexp", # To match token; if "value" is not None, must have
132
# a "group" containing digits
133
"value", # datetime.timedelta or None
134
"followers")) # Tokens valid after this token
135
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
136
# the "duration" ABNF definition in RFC 3339, Appendix A.
137
token_end = Token(re.compile(r"$"), None, frozenset())
138
token_second = Token(re.compile(r"(\d+)S"),
139
datetime.timedelta(seconds=1),
140
frozenset((token_end, )))
141
token_minute = Token(re.compile(r"(\d+)M"),
142
datetime.timedelta(minutes=1),
143
frozenset((token_second, token_end)))
144
token_hour = Token(re.compile(r"(\d+)H"),
145
datetime.timedelta(hours=1),
146
frozenset((token_minute, token_end)))
147
token_time = Token(re.compile(r"T"),
148
None,
149
frozenset((token_hour, token_minute,
150
token_second)))
151
token_day = Token(re.compile(r"(\d+)D"),
152
datetime.timedelta(days=1),
153
frozenset((token_time, token_end)))
154
token_month = Token(re.compile(r"(\d+)M"),
155
datetime.timedelta(weeks=4),
156
frozenset((token_day, token_end)))
157
token_year = Token(re.compile(r"(\d+)Y"),
158
datetime.timedelta(weeks=52),
159
frozenset((token_month, token_end)))
160
token_week = Token(re.compile(r"(\d+)W"),
161
datetime.timedelta(weeks=1),
162
frozenset((token_end, )))
163
token_duration = Token(re.compile(r"P"), None,
164
frozenset((token_year, token_month,
165
token_day, token_time,
166
token_week)))
167
# Define starting values:
168
# Value so far
169
value = datetime.timedelta()
170
found_token = None
171
# Following valid tokens
172
followers = frozenset((token_duration, ))
173
# String left to parse
174
s = duration
175
# Loop until end token is found
176
while found_token is not token_end:
177
# Search for any currently valid tokens
178
for token in followers:
179
match = token.regexp.match(s)
180
if match is not None:
181
# Token found
182
if token.value is not None:
183
# Value found, parse digits
184
factor = int(match.group(1), 10)
185
# Add to value so far
186
value += factor * token.value
187
# Strip token from string
188
s = token.regexp.sub("", s, 1)
189
# Go to found token
190
found_token = token
191
# Set valid next tokens
192
followers = found_token.followers
193
break
194
else:
195
# No currently valid tokens were found
196
raise ValueError("Invalid RFC 3339 duration: {!r}"
197
.format(duration))
198
# End token found
199
return value
200
201
202
def string_to_delta(interval):
203
"""Parse a string and return a datetime.timedelta
204
205
>>> string_to_delta('7d')
206
datetime.timedelta(7)
207
>>> string_to_delta('60s')
208
datetime.timedelta(0, 60)
209
>>> string_to_delta('60m')
210
datetime.timedelta(0, 3600)
211
>>> string_to_delta('24h')
212
datetime.timedelta(1)
213
>>> string_to_delta('1w')
214
datetime.timedelta(7)
215
>>> string_to_delta('5m 30s')
216
datetime.timedelta(0, 330)
217
"""
218
219
try:
220
return rfc3339_duration_to_delta(interval)
221
except ValueError:
222
pass
223
224
value = datetime.timedelta(0)
225
regexp = re.compile(r"(\d+)([dsmhw]?)")
226
227
for num, suffix in regexp.findall(interval):
228
if suffix == "d":
229
value += datetime.timedelta(int(num))
230
elif suffix == "s":
231
value += datetime.timedelta(0, int(num))
232
elif suffix == "m":
233
value += datetime.timedelta(0, 0, 0, 0, int(num))
234
elif suffix == "h":
235
value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
236
elif suffix == "w":
237
value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
238
elif suffix == "":
239
value += datetime.timedelta(0, 0, 0, int(num))
240
return value
241
242
243
def print_clients(clients, keywords):
244
def valuetostring(value, keyword):
245
if type(value) is dbus.Boolean:
246
return "Yes" if value else "No"
247
if keyword in ("Timeout", "Interval", "ApprovalDelay",
248
"ApprovalDuration", "ExtendedTimeout"):
249
return milliseconds_to_string(value)
250
return str(value)
251
252
# Create format string to print table rows
253
format_string = " ".join("{{{key}:{width}}}".format(
254
width=max(len(tablewords[key]),
255
max(len(valuetostring(client[key], key))
256
for client in clients)),
257
key=key)
258
for key in keywords)
259
# Print header line
260
print(format_string.format(**tablewords))
261
for client in clients:
262
print(format_string
263
.format(**{key: valuetostring(client[key], key)
264
for key in keywords}))
265
266
267
def has_actions(options):
268
return any((options.enable,
269
options.disable,
270
options.bump_timeout,
271
options.start_checker,
272
options.stop_checker,
273
options.is_enabled,
274
options.remove,
275
options.checker is not None,
276
options.timeout is not None,
277
options.extended_timeout is not None,
278
options.interval is not None,
279
options.approved_by_default is not None,
280
options.approval_delay is not None,
281
options.approval_duration is not None,
282
options.host is not None,
283
options.secret is not None,
284
options.approve,
285
options.deny))
286
287
288
def main():
289
parser = argparse.ArgumentParser()
290
parser.add_argument("--version", action="version",
291
version="%(prog)s {}".format(version),
292
help="show version number and exit")
293
parser.add_argument("-a", "--all", action="store_true",
294
help="Select all clients")
295
parser.add_argument("-v", "--verbose", action="store_true",
296
help="Print all fields")
297
parser.add_argument("-j", "--dump-json", action="store_true",
298
help="Dump client data in JSON format")
299
parser.add_argument("-e", "--enable", action="store_true",
300
help="Enable client")
301
parser.add_argument("-d", "--disable", action="store_true",
302
help="disable client")
303
parser.add_argument("-b", "--bump-timeout", action="store_true",
304
help="Bump timeout for client")
305
parser.add_argument("--start-checker", action="store_true",
306
help="Start checker for client")
307
parser.add_argument("--stop-checker", action="store_true",
308
help="Stop checker for client")
309
parser.add_argument("-V", "--is-enabled", action="store_true",
310
help="Check if client is enabled")
311
parser.add_argument("-r", "--remove", action="store_true",
312
help="Remove client")
313
parser.add_argument("-c", "--checker",
314
help="Set checker command for client")
315
parser.add_argument("-t", "--timeout",
316
help="Set timeout for client")
317
parser.add_argument("--extended-timeout",
318
help="Set extended timeout for client")
319
parser.add_argument("-i", "--interval",
320
help="Set checker interval for client")
321
parser.add_argument("--approve-by-default", action="store_true",
322
default=None, dest="approved_by_default",
323
help="Set client to be approved by default")
324
parser.add_argument("--deny-by-default", action="store_false",
325
dest="approved_by_default",
326
help="Set client to be denied by default")
327
parser.add_argument("--approval-delay",
328
help="Set delay before client approve/deny")
329
parser.add_argument("--approval-duration",
330
help="Set duration of one client approval")
331
parser.add_argument("-H", "--host", help="Set host for client")
332
parser.add_argument("-s", "--secret",
333
type=argparse.FileType(mode="rb"),
334
help="Set password blob (file) for client")
335
parser.add_argument("-A", "--approve", action="store_true",
336
help="Approve any current client request")
337
parser.add_argument("-D", "--deny", action="store_true",
338
help="Deny any current client request")
339
parser.add_argument("--check", action="store_true",
340
help="Run self-test")
341
parser.add_argument("client", nargs="*", help="Client name")
342
options = parser.parse_args()
343
344
if has_actions(options) and not (options.client or options.all):
345
parser.error("Options require clients names or --all.")
346
if options.verbose and has_actions(options):
347
parser.error("--verbose can only be used alone.")
348
if options.dump_json and (options.verbose
349
or has_actions(options)):
350
parser.error("--dump-json can only be used alone.")
351
if options.all and not has_actions(options):
352
parser.error("--all requires an action.")
353
354
try:
355
bus = dbus.SystemBus()
356
mandos_dbus_objc = bus.get_object(busname, server_path)
357
except dbus.exceptions.DBusException:
358
log.critical("Could not connect to Mandos server")
359
sys.exit(1)
360
361
mandos_serv = dbus.Interface(mandos_dbus_objc,
362
dbus_interface=server_interface)
363
mandos_serv_object_manager = dbus.Interface(
364
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
365
366
# block stderr since dbus library prints to stderr
367
null = os.open(os.path.devnull, os.O_RDWR)
368
stderrcopy = os.dup(sys.stderr.fileno())
369
os.dup2(null, sys.stderr.fileno())
370
os.close(null)
371
try:
372
try:
373
mandos_clients = {path: ifs_and_props[client_interface]
374
for path, ifs_and_props in
375
mandos_serv_object_manager
376
.GetManagedObjects().items()
377
if client_interface in ifs_and_props}
378
finally:
379
# restore stderr
380
os.dup2(stderrcopy, sys.stderr.fileno())
381
os.close(stderrcopy)
382
except dbus.exceptions.DBusException as e:
383
log.critical("Failed to access Mandos server through D-Bus:"
384
"\n%s", e)
385
sys.exit(1)
386
387
# Compile dict of (clients: properties) to process
388
clients = {}
389
390
if options.all or not options.client:
391
clients = {bus.get_object(busname, path): properties
392
for path, properties in mandos_clients.items()}
393
else:
394
for name in options.client:
395
for path, client in mandos_clients.items():
396
if client["Name"] == name:
397
client_objc = bus.get_object(busname, path)
398
clients[client_objc] = client
399
break
400
else:
401
log.critical("Client not found on server: %r", name)
402
sys.exit(1)
403
404
if not has_actions(options) and clients:
405
if options.verbose or options.dump_json:
406
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
"Created", "Interval", "Host", "KeyID",
408
"Fingerprint", "CheckerRunning",
409
"LastEnabled", "ApprovalPending",
410
"ApprovedByDefault", "LastApprovalRequest",
411
"ApprovalDelay", "ApprovalDuration",
412
"Checker", "ExtendedTimeout", "Expires",
413
"LastCheckerStatus")
414
else:
415
keywords = defaultkeywords
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)
430
else:
431
# Process each client in the list by all selected options
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
446
if options.remove:
447
mandos_serv.RemoveClient(client.__dbus_object_path__)
448
if options.enable:
449
set_client_prop("Enabled", dbus.Boolean(True))
450
if options.disable:
451
set_client_prop("Enabled", dbus.Boolean(False))
452
if options.bump_timeout:
453
set_client_prop("LastCheckedOK", "")
454
if options.start_checker:
455
set_client_prop("CheckerRunning", dbus.Boolean(True))
456
if options.stop_checker:
457
set_client_prop("CheckerRunning", dbus.Boolean(False))
458
if options.is_enabled:
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()))
484
if options.approved_by_default is not None:
485
set_client_prop("ApprovedByDefault",
486
dbus.Boolean(options
487
.approved_by_default))
488
if options.approve:
489
client.Approve(dbus.Boolean(True),
490
dbus_interface=client_interface)
491
elif options.deny:
492
client.Approve(dbus.Boolean(False),
493
dbus_interface=client_interface)
494
495
496
class Test_milliseconds_to_string(unittest.TestCase):
497
def test_all(self):
498
self.assertEqual(milliseconds_to_string(93785000),
499
"1T02:03:05")
500
def test_no_days(self):
501
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
502
def test_all_zero(self):
503
self.assertEqual(milliseconds_to_string(0), "00:00:00")
504
def test_no_fractional_seconds(self):
505
self.assertEqual(milliseconds_to_string(400), "00:00:00")
506
self.assertEqual(milliseconds_to_string(900), "00:00:00")
507
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
508
509
510
def should_only_run_tests():
511
parser = argparse.ArgumentParser(add_help=False)
512
parser.add_argument("--check", action='store_true')
513
args, unknown_args = parser.parse_known_args()
514
run_tests = args.check
515
if run_tests:
516
# Remove --check argument from sys.argv
517
sys.argv[1:] = unknown_args
518
return run_tests
519
520
# Add all tests from doctest strings
521
def load_tests(loader, tests, none):
522
import doctest
523
tests.addTests(doctest.DocTestSuite())
524
return tests
525
526
if __name__ == "__main__":
527
if should_only_run_tests():
528
# Call using ./tdd-python-script --check [--verbose]
529
unittest.main()
530
else:
531
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0