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