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