/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: 2019-02-28 20:57:45 UTC
  • Revision ID: teddy@recompile.se-20190228205745-zl3bd1yoz0q343lm
mandos-ctl: Use isinstance(x, X) instead of type(x) is X

* mandos-ctl (print_clients): Don't use type(value) and check for
                              dbus.Boolean instances exactly; use
                              isinstance() to be more generic.

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 -*-
3
 
# 
 
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
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
# 
6
 
# Copyright © 2008-2014 Teddy Hogeborn
7
 
# Copyright © 2008-2014 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
 
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
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
13
15
#
14
 
#     This program is distributed in the hope that it will be useful,
15
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     Mandos is distributed in the hope that it will be useful, but
 
17
#     WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
19
#     GNU General Public License for more details.
18
 
# 
 
20
#
19
21
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see
21
 
# <http://www.gnu.org/licenses/>.
22
 
# 
 
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
23
#
23
24
# Contact the authors at <mandos@recompile.se>.
24
 
# 
 
25
#
25
26
 
26
27
from __future__ import (division, absolute_import, print_function,
27
28
                        unicode_literals)
38
39
import re
39
40
import os
40
41
import collections
41
 
import doctest
 
42
import json
 
43
import unittest
 
44
import logging
42
45
 
43
46
import dbus
44
47
 
45
 
if sys.version_info[0] == 2:
 
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
if sys.version_info.major == 2:
46
60
    str = unicode
47
61
 
48
62
locale.setlocale(locale.LC_ALL, "")
57
71
    "Interval": "Interval",
58
72
    "Host": "Host",
59
73
    "Fingerprint": "Fingerprint",
 
74
    "KeyID": "Key ID",
60
75
    "CheckerRunning": "Check Is Running",
61
76
    "LastEnabled": "Last Enabled",
62
77
    "ApprovalPending": "Approval Is Pending",
64
79
    "ApprovalDelay": "Approval Delay",
65
80
    "ApprovalDuration": "Approval Duration",
66
81
    "Checker": "Checker",
67
 
    "ExtendedTimeout" : "Extended Timeout"
68
 
    }
 
82
    "ExtendedTimeout": "Extended Timeout",
 
83
    "Expires": "Expires",
 
84
    "LastCheckerStatus": "Last Checker Status",
 
85
}
69
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
87
domain = "se.recompile"
71
88
busname = domain + ".Mandos"
72
89
server_path = "/"
73
90
server_interface = domain + ".Mandos"
74
91
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.6"
76
 
 
77
 
def timedelta_to_milliseconds(td):
78
 
    """Convert a datetime.timedelta object to milliseconds"""
79
 
    return ((td.days * 24 * 60 * 60 * 1000)
80
 
            + (td.seconds * 1000)
81
 
            + (td.microseconds // 1000))
 
92
version = "1.8.3"
 
93
 
 
94
 
 
95
try:
 
96
    dbus.OBJECT_MANAGER_IFACE
 
97
except AttributeError:
 
98
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
99
 
82
100
 
83
101
def milliseconds_to_string(ms):
84
102
    td = datetime.timedelta(0, 0, 0, ms)
85
103
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
86
 
            .format(days = "{0}T".format(td.days) if td.days else "",
87
 
                    hours = td.seconds // 3600,
88
 
                    minutes = (td.seconds % 3600) // 60,
89
 
                    seconds = td.seconds % 60,
90
 
                    ))
 
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))
91
108
 
92
109
 
93
110
def rfc3339_duration_to_delta(duration):
94
111
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
95
 
    
 
112
 
96
113
    >>> rfc3339_duration_to_delta("P7D")
97
114
    datetime.timedelta(7)
98
115
    >>> rfc3339_duration_to_delta("PT60S")
108
125
    >>> rfc3339_duration_to_delta("P1DT3M20S")
109
126
    datetime.timedelta(1, 200)
110
127
    """
111
 
    
 
128
 
112
129
    # Parsing an RFC 3339 duration with regular expressions is not
113
130
    # possible - there would have to be multiple places for the same
114
131
    # values, like seconds.  The current code, while more esoteric, is
115
132
    # cleaner without depending on a parsing library.  If Python had a
116
133
    # built-in library for parsing we would use it, but we'd like to
117
134
    # avoid excessive use of external libraries.
118
 
    
 
135
 
119
136
    # New type for defining tokens, syntax, and semantics all-in-one
120
 
    Token = collections.namedtuple("Token",
121
 
                                   ("regexp", # To match token; if
122
 
                                              # "value" is not None,
123
 
                                              # must have a "group"
124
 
                                              # containing digits
125
 
                                    "value",  # datetime.timedelta or
126
 
                                              # None
127
 
                                    "followers")) # Tokens valid after
128
 
                                                  # this token
 
137
    Token = collections.namedtuple("Token", (
 
138
        "regexp",  # To match token; if "value" is not None, must have
 
139
                   # a "group" containing digits
 
140
        "value",   # datetime.timedelta or None
 
141
        "followers"))           # Tokens valid after this token
129
142
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
143
    # the "duration" ABNF definition in RFC 3339, Appendix A.
131
144
    token_end = Token(re.compile(r"$"), None, frozenset())
132
145
    token_second = Token(re.compile(r"(\d+)S"),
133
146
                         datetime.timedelta(seconds=1),
134
 
                         frozenset((token_end,)))
 
147
                         frozenset((token_end, )))
135
148
    token_minute = Token(re.compile(r"(\d+)M"),
136
149
                         datetime.timedelta(minutes=1),
137
150
                         frozenset((token_second, token_end)))
153
166
                       frozenset((token_month, token_end)))
154
167
    token_week = Token(re.compile(r"(\d+)W"),
155
168
                       datetime.timedelta(weeks=1),
156
 
                       frozenset((token_end,)))
 
169
                       frozenset((token_end, )))
157
170
    token_duration = Token(re.compile(r"P"), None,
158
171
                           frozenset((token_year, token_month,
159
172
                                      token_day, token_time,
160
 
                                      token_week))),
161
 
    # Define starting values
162
 
    value = datetime.timedelta() # Value so far
 
173
                                      token_week)))
 
174
    # Define starting values:
 
175
    # Value so far
 
176
    value = datetime.timedelta()
163
177
    found_token = None
164
 
    followers = frozenset(token_duration,) # Following valid tokens
165
 
    s = duration                # String left to parse
 
178
    # Following valid tokens
 
179
    followers = frozenset((token_duration, ))
 
180
    # String left to parse
 
181
    s = duration
166
182
    # Loop until end token is found
167
183
    while found_token is not token_end:
168
184
        # Search for any currently valid tokens
184
200
                break
185
201
        else:
186
202
            # No currently valid tokens were found
187
 
            raise ValueError("Invalid RFC 3339 duration")
 
203
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
204
                             .format(duration))
188
205
    # End token found
189
206
    return value
190
207
 
191
208
 
192
209
def string_to_delta(interval):
193
210
    """Parse a string and return a datetime.timedelta
194
 
    
195
 
    >>> string_to_delta("7d")
 
211
 
 
212
    >>> string_to_delta('7d')
196
213
    datetime.timedelta(7)
197
 
    >>> string_to_delta("60s")
 
214
    >>> string_to_delta('60s')
198
215
    datetime.timedelta(0, 60)
199
 
    >>> string_to_delta("60m")
 
216
    >>> string_to_delta('60m')
200
217
    datetime.timedelta(0, 3600)
201
 
    >>> string_to_delta("24h")
 
218
    >>> string_to_delta('24h')
202
219
    datetime.timedelta(1)
203
 
    >>> string_to_delta("1w")
 
220
    >>> string_to_delta('1w')
204
221
    datetime.timedelta(7)
205
 
    >>> string_to_delta("5m 30s")
 
222
    >>> string_to_delta('5m 30s')
206
223
    datetime.timedelta(0, 330)
207
224
    """
208
 
    
 
225
 
209
226
    try:
210
227
        return rfc3339_duration_to_delta(interval)
211
228
    except ValueError:
212
229
        pass
213
 
    
 
230
 
214
231
    value = datetime.timedelta(0)
215
232
    regexp = re.compile(r"(\d+)([dsmhw]?)")
216
 
    
 
233
 
217
234
    for num, suffix in regexp.findall(interval):
218
235
        if suffix == "d":
219
236
            value += datetime.timedelta(int(num))
229
246
            value += datetime.timedelta(0, 0, 0, int(num))
230
247
    return value
231
248
 
 
249
 
232
250
def print_clients(clients, keywords):
233
251
    def valuetostring(value, keyword):
234
 
        if type(value) is dbus.Boolean:
 
252
        if isinstance(value, dbus.Boolean):
235
253
            return "Yes" if value else "No"
236
254
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
237
255
                       "ApprovalDuration", "ExtendedTimeout"):
238
256
            return milliseconds_to_string(value)
239
257
        return str(value)
240
 
    
 
258
 
241
259
    # Create format string to print table rows
242
260
    format_string = " ".join("{{{key}:{width}}}".format(
243
 
            width = max(len(tablewords[key]),
244
 
                        max(len(valuetostring(client[key],
245
 
                                              key))
246
 
                            for client in
247
 
                            clients)),
248
 
            key = key) for key in keywords)
 
261
        width=max(len(tablewords[key]),
 
262
                  max(len(valuetostring(client[key], key))
 
263
                      for client in clients)),
 
264
        key=key)
 
265
                             for key in keywords)
249
266
    # Print header line
250
267
    print(format_string.format(**tablewords))
251
268
    for client in clients:
252
 
        print(format_string.format(**dict((key,
253
 
                                           valuetostring(client[key],
254
 
                                                         key))
255
 
                                          for key in keywords)))
 
269
        print(format_string
 
270
              .format(**{key: valuetostring(client[key], key)
 
271
                         for key in keywords}))
 
272
 
256
273
 
257
274
def has_actions(options):
258
275
    return any((options.enable,
274
291
                options.approve,
275
292
                options.deny))
276
293
 
 
294
 
277
295
def main():
278
296
    parser = argparse.ArgumentParser()
279
297
    parser.add_argument("--version", action="version",
280
 
                        version = "%(prog)s {0}".format(version),
 
298
                        version="%(prog)s {}".format(version),
281
299
                        help="show version number and exit")
282
300
    parser.add_argument("-a", "--all", action="store_true",
283
301
                        help="Select all clients")
284
302
    parser.add_argument("-v", "--verbose", action="store_true",
285
303
                        help="Print all fields")
 
304
    parser.add_argument("-j", "--dump-json", action="store_true",
 
305
                        help="Dump client data in JSON format")
286
306
    parser.add_argument("-e", "--enable", action="store_true",
287
307
                        help="Enable client")
288
308
    parser.add_argument("-d", "--disable", action="store_true",
327
347
                        help="Run self-test")
328
348
    parser.add_argument("client", nargs="*", help="Client name")
329
349
    options = parser.parse_args()
330
 
    
 
350
 
331
351
    if has_actions(options) and not (options.client or options.all):
332
352
        parser.error("Options require clients names or --all.")
333
353
    if options.verbose and has_actions(options):
334
 
        parser.error("--verbose can only be used alone or with"
335
 
                     " --all.")
 
354
        parser.error("--verbose can only be used alone.")
 
355
    if options.dump_json and (options.verbose
 
356
                              or has_actions(options)):
 
357
        parser.error("--dump-json can only be used alone.")
336
358
    if options.all and not has_actions(options):
337
359
        parser.error("--all requires an action.")
338
360
 
339
 
    if options.check:
340
 
        fail_count, test_count = doctest.testmod()
341
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
342
 
    
343
361
    try:
344
362
        bus = dbus.SystemBus()
345
363
        mandos_dbus_objc = bus.get_object(busname, server_path)
346
364
    except dbus.exceptions.DBusException:
347
 
        print("Could not connect to Mandos server",
348
 
              file=sys.stderr)
 
365
        log.critical("Could not connect to Mandos server")
349
366
        sys.exit(1)
350
 
    
 
367
 
351
368
    mandos_serv = dbus.Interface(mandos_dbus_objc,
352
 
                                 dbus_interface = server_interface)
353
 
    
354
 
    #block stderr since dbus library prints to stderr
 
369
                                 dbus_interface=server_interface)
 
370
    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
355
374
    null = os.open(os.path.devnull, os.O_RDWR)
356
375
    stderrcopy = os.dup(sys.stderr.fileno())
357
376
    os.dup2(null, sys.stderr.fileno())
358
377
    os.close(null)
359
378
    try:
360
379
        try:
361
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
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}
362
385
        finally:
363
 
            #restore stderr
 
386
            # restore stderr
364
387
            os.dup2(stderrcopy, sys.stderr.fileno())
365
388
            os.close(stderrcopy)
366
 
    except dbus.exceptions.DBusException:
367
 
        print("Access denied: Accessing mandos server through dbus.",
368
 
              file=sys.stderr)
 
389
    except dbus.exceptions.DBusException as e:
 
390
        log.critical("Failed to access Mandos server through D-Bus:"
 
391
                     "\n%s", e)
369
392
        sys.exit(1)
370
 
    
 
393
 
371
394
    # Compile dict of (clients: properties) to process
372
 
    clients={}
373
 
    
 
395
    clients = {}
 
396
 
374
397
    if options.all or not options.client:
375
 
        clients = dict((bus.get_object(busname, path), properties)
376
 
                       for path, properties in
377
 
                       mandos_clients.items())
 
398
        clients = {bus.get_object(busname, path): properties
 
399
                   for path, properties in mandos_clients.items()}
378
400
    else:
379
401
        for name in options.client:
380
 
            for path, client in mandos_clients.iteritems():
 
402
            for path, client in mandos_clients.items():
381
403
                if client["Name"] == name:
382
404
                    client_objc = bus.get_object(busname, path)
383
405
                    clients[client_objc] = client
384
406
                    break
385
407
            else:
386
 
                print("Client not found on server: {0!r}"
387
 
                      .format(name), file=sys.stderr)
 
408
                log.critical("Client not found on server: %r", name)
388
409
                sys.exit(1)
389
 
    
 
410
 
390
411
    if not has_actions(options) and clients:
391
 
        if options.verbose:
392
 
            keywords = ("Name", "Enabled", "Timeout",
393
 
                        "LastCheckedOK", "Created", "Interval",
394
 
                        "Host", "Fingerprint", "CheckerRunning",
 
412
        if options.verbose or options.dump_json:
 
413
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
414
                        "Created", "Interval", "Host", "KeyID",
 
415
                        "Fingerprint", "CheckerRunning",
395
416
                        "LastEnabled", "ApprovalPending",
396
 
                        "ApprovedByDefault",
397
 
                        "LastApprovalRequest", "ApprovalDelay",
398
 
                        "ApprovalDuration", "Checker",
399
 
                        "ExtendedTimeout")
 
417
                        "ApprovedByDefault", "LastApprovalRequest",
 
418
                        "ApprovalDelay", "ApprovalDuration",
 
419
                        "Checker", "ExtendedTimeout", "Expires",
 
420
                        "LastCheckerStatus")
400
421
        else:
401
422
            keywords = defaultkeywords
402
 
        
403
 
        print_clients(clients.values(), keywords)
 
423
 
 
424
        if options.dump_json:
 
425
            json.dump({client["Name"]: {key:
 
426
                                        bool(client[key])
 
427
                                        if isinstance(client[key],
 
428
                                                      dbus.Boolean)
 
429
                                        else client[key]
 
430
                                        for key in keywords}
 
431
                       for client in clients.values()},
 
432
                      fp=sys.stdout, indent=4,
 
433
                      separators=(',', ': '))
 
434
            print()
 
435
        else:
 
436
            print_clients(clients.values(), keywords)
404
437
    else:
405
438
        # Process each client in the list by all selected options
406
439
        for client in clients:
 
440
 
407
441
            def set_client_prop(prop, value):
408
442
                """Set a Client D-Bus property"""
409
443
                client.Set(client_interface, prop, value,
410
444
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
445
 
411
446
            def set_client_prop_ms(prop, value):
412
447
                """Set a Client D-Bus property, converted
413
448
                from a string to milliseconds."""
414
449
                set_client_prop(prop,
415
 
                                timedelta_to_milliseconds
416
 
                                (string_to_delta(value)))
 
450
                                string_to_delta(value).total_seconds()
 
451
                                * 1000)
 
452
 
417
453
            if options.remove:
418
454
                mandos_serv.RemoveClient(client.__dbus_object_path__)
419
455
            if options.enable:
427
463
            if options.stop_checker:
428
464
                set_client_prop("CheckerRunning", dbus.Boolean(False))
429
465
            if options.is_enabled:
430
 
                sys.exit(0 if client.Get(client_interface,
431
 
                                         "Enabled",
432
 
                                         dbus_interface=
433
 
                                         dbus.PROPERTIES_IFACE)
434
 
                         else 1)
 
466
                if client.Get(client_interface, "Enabled",
 
467
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
468
                    sys.exit(0)
 
469
                else:
 
470
                    sys.exit(1)
435
471
            if options.checker is not None:
436
472
                set_client_prop("Checker", options.checker)
437
473
            if options.host is not None:
463
499
                client.Approve(dbus.Boolean(False),
464
500
                               dbus_interface=client_interface)
465
501
 
 
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
 
466
533
if __name__ == "__main__":
467
 
    main()
 
534
    if should_only_run_tests():
 
535
        # Call using ./tdd-python-script --check [--verbose]
 
536
        unittest.main()
 
537
    else:
 
538
        main()