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