/mandos/trunk

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

  • Committer: Teddy Hogeborn
  • Date: 2016-02-29 21:28:39 UTC
  • mto: This revision was merged to the branch mainline in revision 814.
  • Revision ID: teddy@recompile.se-20160229212839-hoz3rw1us3uds68n
Tags: version-1.7.3-1
* Makefile (version): Changed to "1.7.3".
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
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
 
#
 
2
# -*- mode: python; coding: utf-8 -*-
 
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-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 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
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
24
23
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
24
# 
26
25
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
39
38
import re
40
39
import os
41
40
import collections
42
 
import json
43
 
import unittest
44
 
import logging
 
41
import doctest
45
42
 
46
43
import dbus
47
44
 
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
45
if sys.version_info.major == 2:
53
46
    str = unicode
54
47
 
64
57
    "Interval": "Interval",
65
58
    "Host": "Host",
66
59
    "Fingerprint": "Fingerprint",
67
 
    "KeyID": "Key ID",
68
60
    "CheckerRunning": "Check Is Running",
69
61
    "LastEnabled": "Last Enabled",
70
62
    "ApprovalPending": "Approval Is Pending",
72
64
    "ApprovalDelay": "Approval Delay",
73
65
    "ApprovalDuration": "Approval Duration",
74
66
    "Checker": "Checker",
75
 
    "ExtendedTimeout": "Extended Timeout",
76
 
    "Expires": "Expires",
77
 
    "LastCheckerStatus": "Last Checker Status",
 
67
    "ExtendedTimeout": "Extended Timeout"
78
68
}
79
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
80
70
domain = "se.recompile"
82
72
server_path = "/"
83
73
server_interface = domain + ".Mandos"
84
74
client_interface = domain + ".Mandos.Client"
85
 
version = "1.8.3"
 
75
version = "1.7.3"
86
76
 
87
77
 
88
78
try:
90
80
except AttributeError:
91
81
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
92
82
 
93
 
 
94
83
def milliseconds_to_string(ms):
95
84
    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))
 
85
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
86
        days = "{}T".format(td.days) if td.days else "",
 
87
        hours = td.seconds // 3600,
 
88
        minutes = (td.seconds % 3600) // 60,
 
89
        seconds = td.seconds % 60))
101
90
 
102
91
 
103
92
def rfc3339_duration_to_delta(duration):
104
93
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
105
 
 
 
94
    
106
95
    >>> rfc3339_duration_to_delta("P7D")
107
96
    datetime.timedelta(7)
108
97
    >>> rfc3339_duration_to_delta("PT60S")
118
107
    >>> rfc3339_duration_to_delta("P1DT3M20S")
119
108
    datetime.timedelta(1, 200)
120
109
    """
121
 
 
 
110
    
122
111
    # Parsing an RFC 3339 duration with regular expressions is not
123
112
    # possible - there would have to be multiple places for the same
124
113
    # values, like seconds.  The current code, while more esoteric, is
125
114
    # cleaner without depending on a parsing library.  If Python had a
126
115
    # built-in library for parsing we would use it, but we'd like to
127
116
    # avoid excessive use of external libraries.
128
 
 
 
117
    
129
118
    # New type for defining tokens, syntax, and semantics all-in-one
130
119
    Token = collections.namedtuple("Token", (
131
120
        "regexp",  # To match token; if "value" is not None, must have
164
153
                           frozenset((token_year, token_month,
165
154
                                      token_day, token_time,
166
155
                                      token_week)))
167
 
    # Define starting values:
168
 
    # Value so far
169
 
    value = datetime.timedelta()
 
156
    # Define starting values
 
157
    value = datetime.timedelta() # Value so far
170
158
    found_token = None
171
 
    # Following valid tokens
172
 
    followers = frozenset((token_duration, ))
173
 
    # String left to parse
174
 
    s = duration
 
159
    followers = frozenset((token_duration, )) # Following valid tokens
 
160
    s = duration                # String left to parse
175
161
    # Loop until end token is found
176
162
    while found_token is not token_end:
177
163
        # Search for any currently valid tokens
201
187
 
202
188
def string_to_delta(interval):
203
189
    """Parse a string and return a datetime.timedelta
204
 
 
 
190
    
205
191
    >>> string_to_delta('7d')
206
192
    datetime.timedelta(7)
207
193
    >>> string_to_delta('60s')
215
201
    >>> string_to_delta('5m 30s')
216
202
    datetime.timedelta(0, 330)
217
203
    """
218
 
 
 
204
    
219
205
    try:
220
206
        return rfc3339_duration_to_delta(interval)
221
207
    except ValueError:
222
208
        pass
223
 
 
 
209
    
224
210
    value = datetime.timedelta(0)
225
211
    regexp = re.compile(r"(\d+)([dsmhw]?)")
226
 
 
 
212
    
227
213
    for num, suffix in regexp.findall(interval):
228
214
        if suffix == "d":
229
215
            value += datetime.timedelta(int(num))
248
234
                       "ApprovalDuration", "ExtendedTimeout"):
249
235
            return milliseconds_to_string(value)
250
236
        return str(value)
251
 
 
 
237
    
252
238
    # Create format string to print table rows
253
239
    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)
 
240
        width = max(len(tablewords[key]),
 
241
                    max(len(valuetostring(client[key], key))
 
242
                        for client in clients)),
 
243
        key = key)
258
244
                             for key in keywords)
259
245
    # Print header line
260
246
    print(format_string.format(**tablewords))
261
247
    for client in clients:
262
 
        print(format_string
263
 
              .format(**{key: valuetostring(client[key], key)
264
 
                         for key in keywords}))
 
248
        print(format_string.format(**{
 
249
            key: valuetostring(client[key], key)
 
250
            for key in keywords }))
265
251
 
266
252
 
267
253
def has_actions(options):
288
274
def main():
289
275
    parser = argparse.ArgumentParser()
290
276
    parser.add_argument("--version", action="version",
291
 
                        version="%(prog)s {}".format(version),
 
277
                        version = "%(prog)s {}".format(version),
292
278
                        help="show version number and exit")
293
279
    parser.add_argument("-a", "--all", action="store_true",
294
280
                        help="Select all clients")
295
281
    parser.add_argument("-v", "--verbose", action="store_true",
296
282
                        help="Print all fields")
297
 
    parser.add_argument("-j", "--dump-json", action="store_true",
298
 
                        help="Dump client data in JSON format")
299
283
    parser.add_argument("-e", "--enable", action="store_true",
300
284
                        help="Enable client")
301
285
    parser.add_argument("-d", "--disable", action="store_true",
340
324
                        help="Run self-test")
341
325
    parser.add_argument("client", nargs="*", help="Client name")
342
326
    options = parser.parse_args()
343
 
 
 
327
    
344
328
    if has_actions(options) and not (options.client or options.all):
345
329
        parser.error("Options require clients names or --all.")
346
330
    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.")
 
331
        parser.error("--verbose can only be used alone or with"
 
332
                     " --all.")
351
333
    if options.all and not has_actions(options):
352
334
        parser.error("--all requires an action.")
353
335
 
 
336
    if options.check:
 
337
        fail_count, test_count = doctest.testmod()
 
338
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
339
    
354
340
    try:
355
341
        bus = dbus.SystemBus()
356
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
357
343
    except dbus.exceptions.DBusException:
358
 
        log.critical("Could not connect to Mandos server")
 
344
        print("Could not connect to Mandos server", file=sys.stderr)
359
345
        sys.exit(1)
360
 
 
 
346
    
361
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
362
 
                                 dbus_interface=server_interface)
 
348
                                 dbus_interface = server_interface)
363
349
    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
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
351
    
 
352
    #block stderr since dbus library prints to stderr
367
353
    null = os.open(os.path.devnull, os.O_RDWR)
368
354
    stderrcopy = os.dup(sys.stderr.fileno())
369
355
    os.dup2(null, sys.stderr.fileno())
370
356
    os.close(null)
371
357
    try:
372
358
        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}
 
359
            mandos_clients = { path: ifs_and_props[client_interface]
 
360
                               for path, ifs_and_props in
 
361
                               mandos_serv_object_manager
 
362
                               .GetManagedObjects().items()
 
363
                               if client_interface in ifs_and_props }
378
364
        finally:
379
 
            # restore stderr
 
365
            #restore stderr
380
366
            os.dup2(stderrcopy, sys.stderr.fileno())
381
367
            os.close(stderrcopy)
382
368
    except dbus.exceptions.DBusException as e:
383
 
        log.critical("Failed to access Mandos server through D-Bus:"
384
 
                     "\n%s", e)
 
369
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
370
              .format(e), file=sys.stderr)
385
371
        sys.exit(1)
386
 
 
 
372
    
387
373
    # Compile dict of (clients: properties) to process
388
 
    clients = {}
389
 
 
 
374
    clients={}
 
375
    
390
376
    if options.all or not options.client:
391
 
        clients = {bus.get_object(busname, path): properties
392
 
                   for path, properties in mandos_clients.items()}
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
393
379
    else:
394
380
        for name in options.client:
395
381
            for path, client in mandos_clients.items():
398
384
                    clients[client_objc] = client
399
385
                    break
400
386
            else:
401
 
                log.critical("Client not found on server: %r", name)
 
387
                print("Client not found on server: {!r}"
 
388
                      .format(name), file=sys.stderr)
402
389
                sys.exit(1)
403
 
 
 
390
    
404
391
    if not has_actions(options) and clients:
405
 
        if options.verbose or options.dump_json:
 
392
        if options.verbose:
406
393
            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")
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
 
397
                        "LastApprovalRequest", "ApprovalDelay",
 
398
                        "ApprovalDuration", "Checker",
 
399
                        "ExtendedTimeout")
414
400
        else:
415
401
            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)
 
402
        
 
403
        print_clients(clients.values(), keywords)
430
404
    else:
431
405
        # Process each client in the list by all selected options
432
406
        for client in clients:
433
 
 
 
407
            
434
408
            def set_client_prop(prop, value):
435
409
                """Set a Client D-Bus property"""
436
410
                client.Set(client_interface, prop, value,
437
411
                           dbus_interface=dbus.PROPERTIES_IFACE)
438
 
 
 
412
            
439
413
            def set_client_prop_ms(prop, value):
440
414
                """Set a Client D-Bus property, converted
441
415
                from a string to milliseconds."""
442
416
                set_client_prop(prop,
443
417
                                string_to_delta(value).total_seconds()
444
418
                                * 1000)
445
 
 
 
419
            
446
420
            if options.remove:
447
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
448
422
            if options.enable:
456
430
            if options.stop_checker:
457
431
                set_client_prop("CheckerRunning", dbus.Boolean(False))
458
432
            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)
 
433
                sys.exit(0 if client.Get(client_interface,
 
434
                                         "Enabled",
 
435
                                         dbus_interface=
 
436
                                         dbus.PROPERTIES_IFACE)
 
437
                         else 1)
464
438
            if options.checker is not None:
465
439
                set_client_prop("Checker", options.checker)
466
440
            if options.host is not None:
492
466
                client.Approve(dbus.Boolean(False),
493
467
                               dbus_interface=client_interface)
494
468
 
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
469
 
526
470
if __name__ == "__main__":
527
 
    if should_only_run_tests():
528
 
        # Call using ./tdd-python-script --check [--verbose]
529
 
        unittest.main()
530
 
    else:
531
 
        main()
 
471
    main()