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