/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2016-06-28 18:46:40 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 350.
  • Revision ID: teddy@recompile.se-20160628184640-22uh54op9nw0908b
mandos-ctl: Dump booleans as booleans in --dump-json output.

* mandos-ctl (main): Detect dbus.Boolean objects and recast them to
                     regular Python bool() objects to make them show
                     as boolean values in dump output.

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")
125
108
    >>> rfc3339_duration_to_delta("P1DT3M20S")
126
109
    datetime.timedelta(1, 200)
127
110
    """
128
 
 
 
111
    
129
112
    # Parsing an RFC 3339 duration with regular expressions is not
130
113
    # possible - there would have to be multiple places for the same
131
114
    # values, like seconds.  The current code, while more esoteric, is
132
115
    # cleaner without depending on a parsing library.  If Python had a
133
116
    # built-in library for parsing we would use it, but we'd like to
134
117
    # avoid excessive use of external libraries.
135
 
 
 
118
    
136
119
    # New type for defining tokens, syntax, and semantics all-in-one
137
120
    Token = collections.namedtuple("Token", (
138
121
        "regexp",  # To match token; if "value" is not None, must have
171
154
                           frozenset((token_year, token_month,
172
155
                                      token_day, token_time,
173
156
                                      token_week)))
174
 
    # Define starting values:
175
 
    # Value so far
176
 
    value = datetime.timedelta()
 
157
    # Define starting values
 
158
    value = datetime.timedelta() # Value so far
177
159
    found_token = None
178
 
    # Following valid tokens
179
 
    followers = frozenset((token_duration, ))
180
 
    # String left to parse
181
 
    s = duration
 
160
    followers = frozenset((token_duration, )) # Following valid tokens
 
161
    s = duration                # String left to parse
182
162
    # Loop until end token is found
183
163
    while found_token is not token_end:
184
164
        # Search for any currently valid tokens
208
188
 
209
189
def string_to_delta(interval):
210
190
    """Parse a string and return a datetime.timedelta
211
 
 
 
191
    
212
192
    >>> string_to_delta('7d')
213
193
    datetime.timedelta(7)
214
194
    >>> string_to_delta('60s')
222
202
    >>> string_to_delta('5m 30s')
223
203
    datetime.timedelta(0, 330)
224
204
    """
225
 
 
 
205
    
226
206
    try:
227
207
        return rfc3339_duration_to_delta(interval)
228
208
    except ValueError:
229
209
        pass
230
 
 
 
210
    
231
211
    value = datetime.timedelta(0)
232
212
    regexp = re.compile(r"(\d+)([dsmhw]?)")
233
 
 
 
213
    
234
214
    for num, suffix in regexp.findall(interval):
235
215
        if suffix == "d":
236
216
            value += datetime.timedelta(int(num))
255
235
                       "ApprovalDuration", "ExtendedTimeout"):
256
236
            return milliseconds_to_string(value)
257
237
        return str(value)
258
 
 
 
238
    
259
239
    # Create format string to print table rows
260
240
    format_string = " ".join("{{{key}:{width}}}".format(
261
 
        width=max(len(tablewords[key]),
262
 
                  max(len(valuetostring(client[key], key))
263
 
                      for client in clients)),
264
 
        key=key)
 
241
        width = max(len(tablewords[key]),
 
242
                    max(len(valuetostring(client[key], key))
 
243
                        for client in clients)),
 
244
        key = key)
265
245
                             for key in keywords)
266
246
    # Print header line
267
247
    print(format_string.format(**tablewords))
268
248
    for client in clients:
269
 
        print(format_string
270
 
              .format(**{key: valuetostring(client[key], key)
271
 
                         for key in keywords}))
 
249
        print(format_string.format(**{
 
250
            key: valuetostring(client[key], key)
 
251
            for key in keywords }))
272
252
 
273
253
 
274
254
def has_actions(options):
295
275
def main():
296
276
    parser = argparse.ArgumentParser()
297
277
    parser.add_argument("--version", action="version",
298
 
                        version="%(prog)s {}".format(version),
 
278
                        version = "%(prog)s {}".format(version),
299
279
                        help="show version number and exit")
300
280
    parser.add_argument("-a", "--all", action="store_true",
301
281
                        help="Select all clients")
347
327
                        help="Run self-test")
348
328
    parser.add_argument("client", nargs="*", help="Client name")
349
329
    options = parser.parse_args()
350
 
 
 
330
    
351
331
    if has_actions(options) and not (options.client or options.all):
352
332
        parser.error("Options require clients names or --all.")
353
333
    if options.verbose and has_actions(options):
354
334
        parser.error("--verbose can only be used alone.")
355
 
    if options.dump_json and (options.verbose
356
 
                              or has_actions(options)):
 
335
    if options.dump_json and (options.verbose or has_actions(options)):
357
336
        parser.error("--dump-json can only be used alone.")
358
337
    if options.all and not has_actions(options):
359
338
        parser.error("--all requires an action.")
360
 
 
 
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
    
361
344
    try:
362
345
        bus = dbus.SystemBus()
363
346
        mandos_dbus_objc = bus.get_object(busname, server_path)
364
347
    except dbus.exceptions.DBusException:
365
 
        log.critical("Could not connect to Mandos server")
 
348
        print("Could not connect to Mandos server", file=sys.stderr)
366
349
        sys.exit(1)
367
 
 
 
350
    
368
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
369
 
                                 dbus_interface=server_interface)
 
352
                                 dbus_interface = server_interface)
370
353
    mandos_serv_object_manager = dbus.Interface(
371
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
372
 
 
373
 
    # 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
374
357
    null = os.open(os.path.devnull, os.O_RDWR)
375
358
    stderrcopy = os.dup(sys.stderr.fileno())
376
359
    os.dup2(null, sys.stderr.fileno())
377
360
    os.close(null)
378
361
    try:
379
362
        try:
380
 
            mandos_clients = {path: ifs_and_props[client_interface]
381
 
                              for path, ifs_and_props in
382
 
                              mandos_serv_object_manager
383
 
                              .GetManagedObjects().items()
384
 
                              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 }
385
368
        finally:
386
 
            # restore stderr
 
369
            #restore stderr
387
370
            os.dup2(stderrcopy, sys.stderr.fileno())
388
371
            os.close(stderrcopy)
389
372
    except dbus.exceptions.DBusException as e:
390
 
        log.critical("Failed to access Mandos server through D-Bus:"
391
 
                     "\n%s", e)
 
373
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
374
              .format(e), file=sys.stderr)
392
375
        sys.exit(1)
393
 
 
 
376
    
394
377
    # Compile dict of (clients: properties) to process
395
 
    clients = {}
396
 
 
 
378
    clients={}
 
379
    
397
380
    if options.all or not options.client:
398
 
        clients = {bus.get_object(busname, path): properties
399
 
                   for path, properties in mandos_clients.items()}
 
381
        clients = { bus.get_object(busname, path): properties
 
382
                    for path, properties in mandos_clients.items() }
400
383
    else:
401
384
        for name in options.client:
402
385
            for path, client in mandos_clients.items():
405
388
                    clients[client_objc] = client
406
389
                    break
407
390
            else:
408
 
                log.critical("Client not found on server: %r", name)
 
391
                print("Client not found on server: {!r}"
 
392
                      .format(name), file=sys.stderr)
409
393
                sys.exit(1)
410
 
 
 
394
    
411
395
    if not has_actions(options) and clients:
412
396
        if options.verbose or options.dump_json:
413
397
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
414
 
                        "Created", "Interval", "Host", "KeyID",
415
 
                        "Fingerprint", "CheckerRunning",
416
 
                        "LastEnabled", "ApprovalPending",
417
 
                        "ApprovedByDefault", "LastApprovalRequest",
418
 
                        "ApprovalDelay", "ApprovalDuration",
419
 
                        "Checker", "ExtendedTimeout", "Expires",
420
 
                        "LastCheckerStatus")
 
398
                        "Created", "Interval", "Host", "Fingerprint",
 
399
                        "CheckerRunning", "LastEnabled",
 
400
                        "ApprovalPending", "ApprovedByDefault",
 
401
                        "LastApprovalRequest", "ApprovalDelay",
 
402
                        "ApprovalDuration", "Checker",
 
403
                        "ExtendedTimeout")
421
404
        else:
422
405
            keywords = defaultkeywords
423
 
 
 
406
        
424
407
        if options.dump_json:
425
408
            json.dump({client["Name"]: {key:
426
409
                                        bool(client[key])
427
410
                                        if isinstance(client[key],
428
411
                                                      dbus.Boolean)
429
412
                                        else client[key]
430
 
                                        for key in keywords}
431
 
                       for client in clients.values()},
432
 
                      fp=sys.stdout, indent=4,
433
 
                      separators=(',', ': '))
 
413
                                        for key in keywords }
 
414
                       for client in clients.values() },
 
415
                      fp = sys.stdout, indent = 4,
 
416
                      separators = (',', ': '))
434
417
            print()
435
418
        else:
436
419
            print_clients(clients.values(), keywords)
437
420
    else:
438
421
        # Process each client in the list by all selected options
439
422
        for client in clients:
440
 
 
 
423
            
441
424
            def set_client_prop(prop, value):
442
425
                """Set a Client D-Bus property"""
443
426
                client.Set(client_interface, prop, value,
444
427
                           dbus_interface=dbus.PROPERTIES_IFACE)
445
 
 
 
428
            
446
429
            def set_client_prop_ms(prop, value):
447
430
                """Set a Client D-Bus property, converted
448
431
                from a string to milliseconds."""
449
432
                set_client_prop(prop,
450
433
                                string_to_delta(value).total_seconds()
451
434
                                * 1000)
452
 
 
 
435
            
453
436
            if options.remove:
454
437
                mandos_serv.RemoveClient(client.__dbus_object_path__)
455
438
            if options.enable:
463
446
            if options.stop_checker:
464
447
                set_client_prop("CheckerRunning", dbus.Boolean(False))
465
448
            if options.is_enabled:
466
 
                if client.Get(client_interface, "Enabled",
467
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
468
 
                    sys.exit(0)
469
 
                else:
470
 
                    sys.exit(1)
 
449
                sys.exit(0 if client.Get(client_interface,
 
450
                                         "Enabled",
 
451
                                         dbus_interface=
 
452
                                         dbus.PROPERTIES_IFACE)
 
453
                         else 1)
471
454
            if options.checker is not None:
472
455
                set_client_prop("Checker", options.checker)
473
456
            if options.host is not None:
499
482
                client.Approve(dbus.Boolean(False),
500
483
                               dbus_interface=client_interface)
501
484
 
502
 
 
503
 
class Test_milliseconds_to_string(unittest.TestCase):
504
 
    def test_all(self):
505
 
        self.assertEqual(milliseconds_to_string(93785000),
506
 
                         "1T02:03:05")
507
 
    def test_no_days(self):
508
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
509
 
    def test_all_zero(self):
510
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
511
 
    def test_no_fractional_seconds(self):
512
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
513
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
514
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
515
 
 
516
 
 
517
 
def should_only_run_tests():
518
 
    parser = argparse.ArgumentParser(add_help=False)
519
 
    parser.add_argument("--check", action='store_true')
520
 
    args, unknown_args = parser.parse_known_args()
521
 
    run_tests = args.check
522
 
    if run_tests:
523
 
        # Remove --check argument from sys.argv
524
 
        sys.argv[1:] = unknown_args
525
 
    return run_tests
526
 
 
527
 
# Add all tests from doctest strings
528
 
def load_tests(loader, tests, none):
529
 
    import doctest
530
 
    tests.addTests(doctest.DocTestSuite())
531
 
    return tests
532
485
 
533
486
if __name__ == "__main__":
534
 
    if should_only_run_tests():
535
 
        # Call using ./tdd-python-script --check [--verbose]
536
 
        unittest.main()
537
 
    else:
538
 
        main()
 
487
    main()