/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-06-27 20:21:50 UTC
  • Revision ID: teddy@recompile.se-20160627202150-ml201ilxwjf1g29w
mandos-ctl: Implement --dump-json option

* mandos-ctl (main): Implement --dump-json option
* mandos-ctl.xml (NAME, DESCRIPTION): Change description to the more
                                      accurate "control or query".
  (SYNOPSIS): Add required group around action options and add new
              "--dump-json" option.
  (OPTIONS): Document new "--dump-json" option.

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
 
41
import doctest
42
42
import json
43
 
import unittest
44
 
import logging
45
43
 
46
44
import dbus
47
45
 
48
 
# Show warnings by default
49
 
if not sys.warnoptions:
50
 
    import warnings
51
 
    warnings.simplefilter("default")
52
 
 
53
 
log = logging.getLogger(sys.argv[0])
54
 
logging.basicConfig(level="INFO", # Show info level messages
55
 
                    format="%(message)s") # Show basic log messages
56
 
 
57
 
logging.captureWarnings(True)   # Show warnings via the logging system
58
 
 
59
46
if sys.version_info.major == 2:
60
47
    str = unicode
61
48
 
71
58
    "Interval": "Interval",
72
59
    "Host": "Host",
73
60
    "Fingerprint": "Fingerprint",
74
 
    "KeyID": "Key ID",
75
61
    "CheckerRunning": "Check Is Running",
76
62
    "LastEnabled": "Last Enabled",
77
63
    "ApprovalPending": "Approval Is Pending",
79
65
    "ApprovalDelay": "Approval Delay",
80
66
    "ApprovalDuration": "Approval Duration",
81
67
    "Checker": "Checker",
82
 
    "ExtendedTimeout": "Extended Timeout",
83
 
    "Expires": "Expires",
84
 
    "LastCheckerStatus": "Last Checker Status",
 
68
    "ExtendedTimeout": "Extended Timeout"
85
69
}
86
70
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
71
domain = "se.recompile"
89
73
server_path = "/"
90
74
server_interface = domain + ".Mandos"
91
75
client_interface = domain + ".Mandos.Client"
92
 
version = "1.8.3"
 
76
version = "1.7.10"
93
77
 
94
78
 
95
79
try:
97
81
except AttributeError:
98
82
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
99
83
 
100
 
 
101
84
def milliseconds_to_string(ms):
102
85
    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))
 
86
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
87
        days = "{}T".format(td.days) if td.days else "",
 
88
        hours = td.seconds // 3600,
 
89
        minutes = (td.seconds % 3600) // 60,
 
90
        seconds = td.seconds % 60))
108
91
 
109
92
 
110
93
def rfc3339_duration_to_delta(duration):
111
94
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
95
    
113
96
    >>> rfc3339_duration_to_delta("P7D")
114
97
    datetime.timedelta(7)
115
98
    >>> rfc3339_duration_to_delta("PT60S")
116
99
    datetime.timedelta(0, 60)
117
100
    >>> rfc3339_duration_to_delta("PT60M")
118
101
    datetime.timedelta(0, 3600)
119
 
    >>> rfc3339_duration_to_delta("P60M")
120
 
    datetime.timedelta(1680)
121
102
    >>> rfc3339_duration_to_delta("PT24H")
122
103
    datetime.timedelta(1)
123
104
    >>> rfc3339_duration_to_delta("P1W")
126
107
    datetime.timedelta(0, 330)
127
108
    >>> rfc3339_duration_to_delta("P1DT3M20S")
128
109
    datetime.timedelta(1, 200)
129
 
    >>> # Can not be empty:
130
 
    >>> rfc3339_duration_to_delta("")
131
 
    Traceback (most recent call last):
132
 
    ...
133
 
    ValueError: Invalid RFC 3339 duration: u''
134
 
    >>> # Must start with "P":
135
 
    >>> rfc3339_duration_to_delta("1D")
136
 
    Traceback (most recent call last):
137
 
    ...
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):
142
 
    ...
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):
147
 
    ...
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):
152
 
    ...
153
 
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
154
 
    >>> rfc3339_duration_to_delta("P2W2H")
155
 
    Traceback (most recent call last):
156
 
    ...
157
 
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
158
110
    """
159
 
 
 
111
    
160
112
    # Parsing an RFC 3339 duration with regular expressions is not
161
113
    # possible - there would have to be multiple places for the same
162
114
    # values, like seconds.  The current code, while more esoteric, is
163
115
    # cleaner without depending on a parsing library.  If Python had a
164
116
    # built-in library for parsing we would use it, but we'd like to
165
117
    # avoid excessive use of external libraries.
166
 
 
 
118
    
167
119
    # New type for defining tokens, syntax, and semantics all-in-one
168
120
    Token = collections.namedtuple("Token", (
169
121
        "regexp",  # To match token; if "value" is not None, must have
202
154
                           frozenset((token_year, token_month,
203
155
                                      token_day, token_time,
204
156
                                      token_week)))
205
 
    # Define starting values:
206
 
    # Value so far
207
 
    value = datetime.timedelta()
 
157
    # Define starting values
 
158
    value = datetime.timedelta() # Value so far
208
159
    found_token = None
209
 
    # Following valid tokens
210
 
    followers = frozenset((token_duration, ))
211
 
    # String left to parse
212
 
    s = duration
 
160
    followers = frozenset((token_duration, )) # Following valid tokens
 
161
    s = duration                # String left to parse
213
162
    # Loop until end token is found
214
163
    while found_token is not token_end:
215
164
        # Search for any currently valid tokens
239
188
 
240
189
def string_to_delta(interval):
241
190
    """Parse a string and return a datetime.timedelta
242
 
 
 
191
    
243
192
    >>> string_to_delta('7d')
244
193
    datetime.timedelta(7)
245
194
    >>> string_to_delta('60s')
253
202
    >>> string_to_delta('5m 30s')
254
203
    datetime.timedelta(0, 330)
255
204
    """
256
 
 
 
205
    
257
206
    try:
258
207
        return rfc3339_duration_to_delta(interval)
259
208
    except ValueError:
260
209
        pass
261
 
 
 
210
    
262
211
    value = datetime.timedelta(0)
263
212
    regexp = re.compile(r"(\d+)([dsmhw]?)")
264
 
 
 
213
    
265
214
    for num, suffix in regexp.findall(interval):
266
215
        if suffix == "d":
267
216
            value += datetime.timedelta(int(num))
280
229
 
281
230
def print_clients(clients, keywords):
282
231
    def valuetostring(value, keyword):
283
 
        if isinstance(value, dbus.Boolean):
 
232
        if type(value) is dbus.Boolean:
284
233
            return "Yes" if value else "No"
285
234
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
286
235
                       "ApprovalDuration", "ExtendedTimeout"):
287
236
            return milliseconds_to_string(value)
288
237
        return str(value)
289
 
 
 
238
    
290
239
    # Create format string to print table rows
291
240
    format_string = " ".join("{{{key}:{width}}}".format(
292
 
        width=max(len(tablewords[key]),
293
 
                  max(len(valuetostring(client[key], key))
294
 
                      for client in clients)),
295
 
        key=key)
 
241
        width = max(len(tablewords[key]),
 
242
                    max(len(valuetostring(client[key], key))
 
243
                        for client in clients)),
 
244
        key = key)
296
245
                             for key in keywords)
297
246
    # Print header line
298
247
    print(format_string.format(**tablewords))
299
248
    for client in clients:
300
 
        print(format_string
301
 
              .format(**{key: valuetostring(client[key], key)
302
 
                         for key in keywords}))
 
249
        print(format_string.format(**{
 
250
            key: valuetostring(client[key], key)
 
251
            for key in keywords }))
303
252
 
304
253
 
305
254
def has_actions(options):
326
275
def main():
327
276
    parser = argparse.ArgumentParser()
328
277
    parser.add_argument("--version", action="version",
329
 
                        version="%(prog)s {}".format(version),
 
278
                        version = "%(prog)s {}".format(version),
330
279
                        help="show version number and exit")
331
280
    parser.add_argument("-a", "--all", action="store_true",
332
281
                        help="Select all clients")
378
327
                        help="Run self-test")
379
328
    parser.add_argument("client", nargs="*", help="Client name")
380
329
    options = parser.parse_args()
381
 
 
 
330
    
382
331
    if has_actions(options) and not (options.client or options.all):
383
332
        parser.error("Options require clients names or --all.")
384
333
    if options.verbose and has_actions(options):
385
334
        parser.error("--verbose can only be used alone.")
386
 
    if options.dump_json and (options.verbose
387
 
                              or has_actions(options)):
 
335
    if options.dump_json and (options.verbose or has_actions(options)):
388
336
        parser.error("--dump-json can only be used alone.")
389
337
    if options.all and not has_actions(options):
390
338
        parser.error("--all requires an action.")
391
 
 
 
339
    
 
340
    if options.check:
 
341
        fail_count, test_count = doctest.testmod()
 
342
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
343
    
392
344
    try:
393
345
        bus = dbus.SystemBus()
394
346
        mandos_dbus_objc = bus.get_object(busname, server_path)
395
347
    except dbus.exceptions.DBusException:
396
 
        log.critical("Could not connect to Mandos server")
 
348
        print("Could not connect to Mandos server", file=sys.stderr)
397
349
        sys.exit(1)
398
 
 
 
350
    
399
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
400
 
                                 dbus_interface=server_interface)
 
352
                                 dbus_interface = server_interface)
401
353
    mandos_serv_object_manager = dbus.Interface(
402
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
403
 
 
404
 
    # block stderr since dbus library prints to stderr
 
354
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
355
    
 
356
    #block stderr since dbus library prints to stderr
405
357
    null = os.open(os.path.devnull, os.O_RDWR)
406
358
    stderrcopy = os.dup(sys.stderr.fileno())
407
359
    os.dup2(null, sys.stderr.fileno())
408
360
    os.close(null)
409
361
    try:
410
362
        try:
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}
 
363
            mandos_clients = { path: ifs_and_props[client_interface]
 
364
                               for path, ifs_and_props in
 
365
                               mandos_serv_object_manager
 
366
                               .GetManagedObjects().items()
 
367
                               if client_interface in ifs_and_props }
416
368
        finally:
417
 
            # restore stderr
 
369
            #restore stderr
418
370
            os.dup2(stderrcopy, sys.stderr.fileno())
419
371
            os.close(stderrcopy)
420
372
    except dbus.exceptions.DBusException as e:
421
 
        log.critical("Failed to access Mandos server through D-Bus:"
422
 
                     "\n%s", e)
 
373
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
374
              .format(e), file=sys.stderr)
423
375
        sys.exit(1)
424
 
 
 
376
    
425
377
    # Compile dict of (clients: properties) to process
426
 
    clients = {}
427
 
 
 
378
    clients={}
 
379
    
428
380
    if options.all or not options.client:
429
 
        clients = {bus.get_object(busname, path): properties
430
 
                   for path, properties in mandos_clients.items()}
 
381
        clients = { bus.get_object(busname, path): properties
 
382
                    for path, properties in mandos_clients.items() }
431
383
    else:
432
384
        for name in options.client:
433
385
            for path, client in mandos_clients.items():
436
388
                    clients[client_objc] = client
437
389
                    break
438
390
            else:
439
 
                log.critical("Client not found on server: %r", name)
 
391
                print("Client not found on server: {!r}"
 
392
                      .format(name), file=sys.stderr)
440
393
                sys.exit(1)
441
 
 
 
394
    
442
395
    if not has_actions(options) and clients:
443
396
        if options.verbose or options.dump_json:
444
397
            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",
451
 
                        "LastCheckerStatus")
 
398
                        "Created", "Interval", "Host", "Fingerprint",
 
399
                        "CheckerRunning", "LastEnabled",
 
400
                        "ApprovalPending", "ApprovedByDefault",
 
401
                        "LastApprovalRequest", "ApprovalDelay",
 
402
                        "ApprovalDuration", "Checker",
 
403
                        "ExtendedTimeout")
452
404
        else:
453
405
            keywords = defaultkeywords
454
 
 
 
406
        
455
407
        if options.dump_json:
456
 
            json.dump({client["Name"]: {key:
457
 
                                        bool(client[key])
458
 
                                        if isinstance(client[key],
459
 
                                                      dbus.Boolean)
460
 
                                        else client[key]
461
 
                                        for key in keywords}
462
 
                       for client in clients.values()},
463
 
                      fp=sys.stdout, indent=4,
464
 
                      separators=(',', ': '))
 
408
            json.dump({client["Name"]: {key: client[key]
 
409
                                        for key in keywords }
 
410
                       for client in clients.values() },
 
411
                      fp = sys.stdout, indent = 4,
 
412
                      separators = (',', ': '))
465
413
            print()
466
414
        else:
467
415
            print_clients(clients.values(), keywords)
468
416
    else:
469
417
        # Process each client in the list by all selected options
470
418
        for client in clients:
471
 
 
 
419
            
472
420
            def set_client_prop(prop, value):
473
421
                """Set a Client D-Bus property"""
474
422
                client.Set(client_interface, prop, value,
475
423
                           dbus_interface=dbus.PROPERTIES_IFACE)
476
 
 
 
424
            
477
425
            def set_client_prop_ms(prop, value):
478
426
                """Set a Client D-Bus property, converted
479
427
                from a string to milliseconds."""
480
428
                set_client_prop(prop,
481
429
                                string_to_delta(value).total_seconds()
482
430
                                * 1000)
483
 
 
 
431
            
484
432
            if options.remove:
485
433
                mandos_serv.RemoveClient(client.__dbus_object_path__)
486
434
            if options.enable:
494
442
            if options.stop_checker:
495
443
                set_client_prop("CheckerRunning", dbus.Boolean(False))
496
444
            if options.is_enabled:
497
 
                if client.Get(client_interface, "Enabled",
498
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
499
 
                    sys.exit(0)
500
 
                else:
501
 
                    sys.exit(1)
 
445
                sys.exit(0 if client.Get(client_interface,
 
446
                                         "Enabled",
 
447
                                         dbus_interface=
 
448
                                         dbus.PROPERTIES_IFACE)
 
449
                         else 1)
502
450
            if options.checker is not None:
503
451
                set_client_prop("Checker", options.checker)
504
452
            if options.host is not None:
530
478
                client.Approve(dbus.Boolean(False),
531
479
                               dbus_interface=client_interface)
532
480
 
533
 
 
534
 
class Test_milliseconds_to_string(unittest.TestCase):
535
 
    def test_all(self):
536
 
        self.assertEqual(milliseconds_to_string(93785000),
537
 
                         "1T02:03:05")
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")
546
 
 
547
 
 
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
553
 
    if run_tests:
554
 
        # Remove --check argument from sys.argv
555
 
        sys.argv[1:] = unknown_args
556
 
    return run_tests
557
 
 
558
 
# Add all tests from doctest strings
559
 
def load_tests(loader, tests, none):
560
 
    import doctest
561
 
    tests.addTests(doctest.DocTestSuite())
562
 
    return tests
563
481
 
564
482
if __name__ == "__main__":
565
 
    if should_only_run_tests():
566
 
        # Call using ./tdd-python-script --check [--verbose]
567
 
        unittest.main()
568
 
    else:
569
 
        main()
 
483
    main()