/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 19:22:08 UTC
  • Revision ID: teddy@recompile.se-20190228192208-1bkaewjx1vzar0sl
mandos-ctl: Use logging module instead of print() for errors

* mandos-ctl (log): New logging object.
  (main): Use log instead of print("<message>", file=sys.stderr).

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
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:
46
53
    str = unicode
47
54
 
48
55
locale.setlocale(locale.LC_ALL, "")
57
64
    "Interval": "Interval",
58
65
    "Host": "Host",
59
66
    "Fingerprint": "Fingerprint",
 
67
    "KeyID": "Key ID",
60
68
    "CheckerRunning": "Check Is Running",
61
69
    "LastEnabled": "Last Enabled",
62
70
    "ApprovalPending": "Approval Is Pending",
64
72
    "ApprovalDelay": "Approval Delay",
65
73
    "ApprovalDuration": "Approval Duration",
66
74
    "Checker": "Checker",
67
 
    "ExtendedTimeout" : "Extended Timeout"
68
 
    }
 
75
    "ExtendedTimeout": "Extended Timeout",
 
76
    "Expires": "Expires",
 
77
    "LastCheckerStatus": "Last Checker Status",
 
78
}
69
79
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
80
domain = "se.recompile"
71
81
busname = domain + ".Mandos"
72
82
server_path = "/"
73
83
server_interface = domain + ".Mandos"
74
84
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.7"
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))
 
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
 
82
93
 
83
94
def milliseconds_to_string(ms):
84
95
    td = datetime.timedelta(0, 0, 0, ms)
85
96
    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
 
                    ))
 
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))
91
101
 
92
102
 
93
103
def rfc3339_duration_to_delta(duration):
94
104
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
95
 
    
 
105
 
96
106
    >>> rfc3339_duration_to_delta("P7D")
97
107
    datetime.timedelta(7)
98
108
    >>> rfc3339_duration_to_delta("PT60S")
108
118
    >>> rfc3339_duration_to_delta("P1DT3M20S")
109
119
    datetime.timedelta(1, 200)
110
120
    """
111
 
    
 
121
 
112
122
    # Parsing an RFC 3339 duration with regular expressions is not
113
123
    # possible - there would have to be multiple places for the same
114
124
    # values, like seconds.  The current code, while more esoteric, is
115
125
    # cleaner without depending on a parsing library.  If Python had a
116
126
    # built-in library for parsing we would use it, but we'd like to
117
127
    # avoid excessive use of external libraries.
118
 
    
 
128
 
119
129
    # 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
 
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
129
135
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
136
    # the "duration" ABNF definition in RFC 3339, Appendix A.
131
137
    token_end = Token(re.compile(r"$"), None, frozenset())
132
138
    token_second = Token(re.compile(r"(\d+)S"),
133
139
                         datetime.timedelta(seconds=1),
134
 
                         frozenset((token_end,)))
 
140
                         frozenset((token_end, )))
135
141
    token_minute = Token(re.compile(r"(\d+)M"),
136
142
                         datetime.timedelta(minutes=1),
137
143
                         frozenset((token_second, token_end)))
153
159
                       frozenset((token_month, token_end)))
154
160
    token_week = Token(re.compile(r"(\d+)W"),
155
161
                       datetime.timedelta(weeks=1),
156
 
                       frozenset((token_end,)))
 
162
                       frozenset((token_end, )))
157
163
    token_duration = Token(re.compile(r"P"), None,
158
164
                           frozenset((token_year, token_month,
159
165
                                      token_day, token_time,
160
166
                                      token_week)))
161
 
    # Define starting values
162
 
    value = datetime.timedelta() # Value so far
 
167
    # Define starting values:
 
168
    # Value so far
 
169
    value = datetime.timedelta()
163
170
    found_token = None
164
 
    followers = frozenset((token_duration,)) # Following valid tokens
165
 
    s = duration                # String left to parse
 
171
    # Following valid tokens
 
172
    followers = frozenset((token_duration, ))
 
173
    # String left to parse
 
174
    s = duration
166
175
    # Loop until end token is found
167
176
    while found_token is not token_end:
168
177
        # Search for any currently valid tokens
184
193
                break
185
194
        else:
186
195
            # No currently valid tokens were found
187
 
            raise ValueError("Invalid RFC 3339 duration")
 
196
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
197
                             .format(duration))
188
198
    # End token found
189
199
    return value
190
200
 
191
201
 
192
202
def string_to_delta(interval):
193
203
    """Parse a string and return a datetime.timedelta
194
 
    
195
 
    >>> string_to_delta("7d")
 
204
 
 
205
    >>> string_to_delta('7d')
196
206
    datetime.timedelta(7)
197
 
    >>> string_to_delta("60s")
 
207
    >>> string_to_delta('60s')
198
208
    datetime.timedelta(0, 60)
199
 
    >>> string_to_delta("60m")
 
209
    >>> string_to_delta('60m')
200
210
    datetime.timedelta(0, 3600)
201
 
    >>> string_to_delta("24h")
 
211
    >>> string_to_delta('24h')
202
212
    datetime.timedelta(1)
203
 
    >>> string_to_delta("1w")
 
213
    >>> string_to_delta('1w')
204
214
    datetime.timedelta(7)
205
 
    >>> string_to_delta("5m 30s")
 
215
    >>> string_to_delta('5m 30s')
206
216
    datetime.timedelta(0, 330)
207
217
    """
208
 
    
 
218
 
209
219
    try:
210
220
        return rfc3339_duration_to_delta(interval)
211
221
    except ValueError:
212
222
        pass
213
 
    
 
223
 
214
224
    value = datetime.timedelta(0)
215
225
    regexp = re.compile(r"(\d+)([dsmhw]?)")
216
 
    
 
226
 
217
227
    for num, suffix in regexp.findall(interval):
218
228
        if suffix == "d":
219
229
            value += datetime.timedelta(int(num))
229
239
            value += datetime.timedelta(0, 0, 0, int(num))
230
240
    return value
231
241
 
 
242
 
232
243
def print_clients(clients, keywords):
233
244
    def valuetostring(value, keyword):
234
245
        if type(value) is dbus.Boolean:
237
248
                       "ApprovalDuration", "ExtendedTimeout"):
238
249
            return milliseconds_to_string(value)
239
250
        return str(value)
240
 
    
 
251
 
241
252
    # Create format string to print table rows
242
253
    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)
 
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)
249
259
    # Print header line
250
260
    print(format_string.format(**tablewords))
251
261
    for client in clients:
252
 
        print(format_string.format(**dict((key,
253
 
                                           valuetostring(client[key],
254
 
                                                         key))
255
 
                                          for key in keywords)))
 
262
        print(format_string
 
263
              .format(**{key: valuetostring(client[key], key)
 
264
                         for key in keywords}))
 
265
 
256
266
 
257
267
def has_actions(options):
258
268
    return any((options.enable,
274
284
                options.approve,
275
285
                options.deny))
276
286
 
 
287
 
277
288
def main():
278
289
    parser = argparse.ArgumentParser()
279
290
    parser.add_argument("--version", action="version",
280
 
                        version = "%(prog)s {0}".format(version),
 
291
                        version="%(prog)s {}".format(version),
281
292
                        help="show version number and exit")
282
293
    parser.add_argument("-a", "--all", action="store_true",
283
294
                        help="Select all clients")
284
295
    parser.add_argument("-v", "--verbose", action="store_true",
285
296
                        help="Print all fields")
 
297
    parser.add_argument("-j", "--dump-json", action="store_true",
 
298
                        help="Dump client data in JSON format")
286
299
    parser.add_argument("-e", "--enable", action="store_true",
287
300
                        help="Enable client")
288
301
    parser.add_argument("-d", "--disable", action="store_true",
327
340
                        help="Run self-test")
328
341
    parser.add_argument("client", nargs="*", help="Client name")
329
342
    options = parser.parse_args()
330
 
    
 
343
 
331
344
    if has_actions(options) and not (options.client or options.all):
332
345
        parser.error("Options require clients names or --all.")
333
346
    if options.verbose and has_actions(options):
334
 
        parser.error("--verbose can only be used alone or with"
335
 
                     " --all.")
 
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.")
336
351
    if options.all and not has_actions(options):
337
352
        parser.error("--all requires an action.")
338
353
 
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
354
    try:
344
355
        bus = dbus.SystemBus()
345
356
        mandos_dbus_objc = bus.get_object(busname, server_path)
346
357
    except dbus.exceptions.DBusException:
347
 
        print("Could not connect to Mandos server",
348
 
              file=sys.stderr)
 
358
        log.critical("Could not connect to Mandos server")
349
359
        sys.exit(1)
350
 
    
 
360
 
351
361
    mandos_serv = dbus.Interface(mandos_dbus_objc,
352
 
                                 dbus_interface = server_interface)
353
 
    
354
 
    #block stderr since dbus library prints to stderr
 
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
355
367
    null = os.open(os.path.devnull, os.O_RDWR)
356
368
    stderrcopy = os.dup(sys.stderr.fileno())
357
369
    os.dup2(null, sys.stderr.fileno())
358
370
    os.close(null)
359
371
    try:
360
372
        try:
361
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
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}
362
378
        finally:
363
 
            #restore stderr
 
379
            # restore stderr
364
380
            os.dup2(stderrcopy, sys.stderr.fileno())
365
381
            os.close(stderrcopy)
366
 
    except dbus.exceptions.DBusException:
367
 
        print("Access denied: Accessing mandos server through dbus.",
368
 
              file=sys.stderr)
 
382
    except dbus.exceptions.DBusException as e:
 
383
        log.critical("Failed to access Mandos server through D-Bus:"
 
384
                     "\n%s", e)
369
385
        sys.exit(1)
370
 
    
 
386
 
371
387
    # Compile dict of (clients: properties) to process
372
 
    clients={}
373
 
    
 
388
    clients = {}
 
389
 
374
390
    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())
 
391
        clients = {bus.get_object(busname, path): properties
 
392
                   for path, properties in mandos_clients.items()}
378
393
    else:
379
394
        for name in options.client:
380
 
            for path, client in mandos_clients.iteritems():
 
395
            for path, client in mandos_clients.items():
381
396
                if client["Name"] == name:
382
397
                    client_objc = bus.get_object(busname, path)
383
398
                    clients[client_objc] = client
384
399
                    break
385
400
            else:
386
 
                print("Client not found on server: {0!r}"
387
 
                      .format(name), file=sys.stderr)
 
401
                log.critical("Client not found on server: %r", name)
388
402
                sys.exit(1)
389
 
    
 
403
 
390
404
    if not has_actions(options) and clients:
391
 
        if options.verbose:
392
 
            keywords = ("Name", "Enabled", "Timeout",
393
 
                        "LastCheckedOK", "Created", "Interval",
394
 
                        "Host", "Fingerprint", "CheckerRunning",
 
405
        if options.verbose or options.dump_json:
 
406
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
407
                        "Created", "Interval", "Host", "KeyID",
 
408
                        "Fingerprint", "CheckerRunning",
395
409
                        "LastEnabled", "ApprovalPending",
396
 
                        "ApprovedByDefault",
397
 
                        "LastApprovalRequest", "ApprovalDelay",
398
 
                        "ApprovalDuration", "Checker",
399
 
                        "ExtendedTimeout")
 
410
                        "ApprovedByDefault", "LastApprovalRequest",
 
411
                        "ApprovalDelay", "ApprovalDuration",
 
412
                        "Checker", "ExtendedTimeout", "Expires",
 
413
                        "LastCheckerStatus")
400
414
        else:
401
415
            keywords = defaultkeywords
402
 
        
403
 
        print_clients(clients.values(), keywords)
 
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)
404
430
    else:
405
431
        # Process each client in the list by all selected options
406
432
        for client in clients:
 
433
 
407
434
            def set_client_prop(prop, value):
408
435
                """Set a Client D-Bus property"""
409
436
                client.Set(client_interface, prop, value,
410
437
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
438
 
411
439
            def set_client_prop_ms(prop, value):
412
440
                """Set a Client D-Bus property, converted
413
441
                from a string to milliseconds."""
414
442
                set_client_prop(prop,
415
 
                                timedelta_to_milliseconds
416
 
                                (string_to_delta(value)))
 
443
                                string_to_delta(value).total_seconds()
 
444
                                * 1000)
 
445
 
417
446
            if options.remove:
418
447
                mandos_serv.RemoveClient(client.__dbus_object_path__)
419
448
            if options.enable:
427
456
            if options.stop_checker:
428
457
                set_client_prop("CheckerRunning", dbus.Boolean(False))
429
458
            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)
 
459
                if client.Get(client_interface, "Enabled",
 
460
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
461
                    sys.exit(0)
 
462
                else:
 
463
                    sys.exit(1)
435
464
            if options.checker is not None:
436
465
                set_client_prop("Checker", options.checker)
437
466
            if options.host is not None:
463
492
                client.Approve(dbus.Boolean(False),
464
493
                               dbus_interface=client_interface)
465
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
 
466
526
if __name__ == "__main__":
467
 
    main()
 
527
    if should_only_run_tests():
 
528
        # Call using ./tdd-python-script --check [--verbose]
 
529
        unittest.main()
 
530
    else:
 
531
        main()