/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

* mandos: Use a class decorator instead of a metaclass to provide
          alternate D-Bus interface names on D-Bus object attributes.
  (alternate_dbus_interfaces): New class decorator.
  (AlternateDBusNamesMetaclass, ClientDBusTransitional,
   MandosDBusServiceTransitional): Removed; all users changed.
  (ClientDbus, MandosDBusService): Use new "alternate_dbus_interfaces"
                                   class decorator.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
#
 
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
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
 
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
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
17
#     GNU General Public License for more details.
20
 
#
 
18
# 
21
19
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
23
 
#
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
24
23
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
24
# 
26
25
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
29
28
 
30
 
try:
31
 
    from future_builtins import *
32
 
except ImportError:
33
 
    pass
34
 
 
35
29
import sys
 
30
import dbus
36
31
import argparse
37
32
import locale
38
33
import datetime
39
34
import re
40
35
import os
41
 
import collections
42
 
import json
43
 
import unittest
44
 
 
45
 
import dbus
46
 
 
47
 
if sys.version_info.major == 2:
48
 
    str = unicode
49
36
 
50
37
locale.setlocale(locale.LC_ALL, "")
51
38
 
59
46
    "Interval": "Interval",
60
47
    "Host": "Host",
61
48
    "Fingerprint": "Fingerprint",
62
 
    "KeyID": "Key ID",
63
49
    "CheckerRunning": "Check Is Running",
64
50
    "LastEnabled": "Last Enabled",
65
51
    "ApprovalPending": "Approval Is Pending",
67
53
    "ApprovalDelay": "Approval Delay",
68
54
    "ApprovalDuration": "Approval Duration",
69
55
    "Checker": "Checker",
70
 
    "ExtendedTimeout": "Extended Timeout",
71
 
    "Expires": "Expires",
72
 
    "LastCheckerStatus": "Last Checker Status",
73
 
}
 
56
    "ExtendedTimeout" : "Extended Timeout"
 
57
    }
74
58
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
75
59
domain = "se.recompile"
76
60
busname = domain + ".Mandos"
77
61
server_path = "/"
78
62
server_interface = domain + ".Mandos"
79
63
client_interface = domain + ".Mandos.Client"
80
 
version = "1.8.3"
81
 
 
82
 
 
83
 
try:
84
 
    dbus.OBJECT_MANAGER_IFACE
85
 
except AttributeError:
86
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
87
 
 
 
64
version = "1.5.3"
 
65
 
 
66
def timedelta_to_milliseconds(td):
 
67
    """Convert a datetime.timedelta object to milliseconds"""
 
68
    return ((td.days * 24 * 60 * 60 * 1000)
 
69
            + (td.seconds * 1000)
 
70
            + (td.microseconds // 1000))
88
71
 
89
72
def milliseconds_to_string(ms):
90
73
    td = datetime.timedelta(0, 0, 0, ms)
91
74
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
92
 
            .format(days="{}T".format(td.days) if td.days else "",
93
 
                    hours=td.seconds // 3600,
94
 
                    minutes=(td.seconds % 3600) // 60,
95
 
                    seconds=td.seconds % 60))
96
 
 
97
 
 
98
 
def rfc3339_duration_to_delta(duration):
99
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
100
 
 
101
 
    >>> rfc3339_duration_to_delta("P7D")
102
 
    datetime.timedelta(7)
103
 
    >>> rfc3339_duration_to_delta("PT60S")
104
 
    datetime.timedelta(0, 60)
105
 
    >>> rfc3339_duration_to_delta("PT60M")
106
 
    datetime.timedelta(0, 3600)
107
 
    >>> rfc3339_duration_to_delta("PT24H")
108
 
    datetime.timedelta(1)
109
 
    >>> rfc3339_duration_to_delta("P1W")
110
 
    datetime.timedelta(7)
111
 
    >>> rfc3339_duration_to_delta("PT5M30S")
112
 
    datetime.timedelta(0, 330)
113
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
114
 
    datetime.timedelta(1, 200)
115
 
    """
116
 
 
117
 
    # Parsing an RFC 3339 duration with regular expressions is not
118
 
    # possible - there would have to be multiple places for the same
119
 
    # values, like seconds.  The current code, while more esoteric, is
120
 
    # cleaner without depending on a parsing library.  If Python had a
121
 
    # built-in library for parsing we would use it, but we'd like to
122
 
    # avoid excessive use of external libraries.
123
 
 
124
 
    # New type for defining tokens, syntax, and semantics all-in-one
125
 
    Token = collections.namedtuple("Token", (
126
 
        "regexp",  # To match token; if "value" is not None, must have
127
 
                   # a "group" containing digits
128
 
        "value",   # datetime.timedelta or None
129
 
        "followers"))           # Tokens valid after this token
130
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
131
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
132
 
    token_end = Token(re.compile(r"$"), None, frozenset())
133
 
    token_second = Token(re.compile(r"(\d+)S"),
134
 
                         datetime.timedelta(seconds=1),
135
 
                         frozenset((token_end, )))
136
 
    token_minute = Token(re.compile(r"(\d+)M"),
137
 
                         datetime.timedelta(minutes=1),
138
 
                         frozenset((token_second, token_end)))
139
 
    token_hour = Token(re.compile(r"(\d+)H"),
140
 
                       datetime.timedelta(hours=1),
141
 
                       frozenset((token_minute, token_end)))
142
 
    token_time = Token(re.compile(r"T"),
143
 
                       None,
144
 
                       frozenset((token_hour, token_minute,
145
 
                                  token_second)))
146
 
    token_day = Token(re.compile(r"(\d+)D"),
147
 
                      datetime.timedelta(days=1),
148
 
                      frozenset((token_time, token_end)))
149
 
    token_month = Token(re.compile(r"(\d+)M"),
150
 
                        datetime.timedelta(weeks=4),
151
 
                        frozenset((token_day, token_end)))
152
 
    token_year = Token(re.compile(r"(\d+)Y"),
153
 
                       datetime.timedelta(weeks=52),
154
 
                       frozenset((token_month, token_end)))
155
 
    token_week = Token(re.compile(r"(\d+)W"),
156
 
                       datetime.timedelta(weeks=1),
157
 
                       frozenset((token_end, )))
158
 
    token_duration = Token(re.compile(r"P"), None,
159
 
                           frozenset((token_year, token_month,
160
 
                                      token_day, token_time,
161
 
                                      token_week)))
162
 
    # Define starting values:
163
 
    # Value so far
164
 
    value = datetime.timedelta()
165
 
    found_token = None
166
 
    # Following valid tokens
167
 
    followers = frozenset((token_duration, ))
168
 
    # String left to parse
169
 
    s = duration
170
 
    # Loop until end token is found
171
 
    while found_token is not token_end:
172
 
        # Search for any currently valid tokens
173
 
        for token in followers:
174
 
            match = token.regexp.match(s)
175
 
            if match is not None:
176
 
                # Token found
177
 
                if token.value is not None:
178
 
                    # Value found, parse digits
179
 
                    factor = int(match.group(1), 10)
180
 
                    # Add to value so far
181
 
                    value += factor * token.value
182
 
                # Strip token from string
183
 
                s = token.regexp.sub("", s, 1)
184
 
                # Go to found token
185
 
                found_token = token
186
 
                # Set valid next tokens
187
 
                followers = found_token.followers
188
 
                break
189
 
        else:
190
 
            # No currently valid tokens were found
191
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
192
 
                             .format(duration))
193
 
    # End token found
194
 
    return value
195
 
 
 
75
            .format(days = "{0}T".format(td.days) if td.days else "",
 
76
                    hours = td.seconds // 3600,
 
77
                    minutes = (td.seconds % 3600) // 60,
 
78
                    seconds = td.seconds % 60,
 
79
                    ))
196
80
 
197
81
def string_to_delta(interval):
198
82
    """Parse a string and return a datetime.timedelta
199
 
 
200
 
    >>> string_to_delta('7d')
 
83
    
 
84
    >>> string_to_delta("7d")
201
85
    datetime.timedelta(7)
202
 
    >>> string_to_delta('60s')
 
86
    >>> string_to_delta("60s")
203
87
    datetime.timedelta(0, 60)
204
 
    >>> string_to_delta('60m')
 
88
    >>> string_to_delta("60m")
205
89
    datetime.timedelta(0, 3600)
206
 
    >>> string_to_delta('24h')
 
90
    >>> string_to_delta("24h")
207
91
    datetime.timedelta(1)
208
 
    >>> string_to_delta('1w')
 
92
    >>> string_to_delta("1w")
209
93
    datetime.timedelta(7)
210
 
    >>> string_to_delta('5m 30s')
 
94
    >>> string_to_delta("5m 30s")
211
95
    datetime.timedelta(0, 330)
212
96
    """
213
 
 
214
 
    try:
215
 
        return rfc3339_duration_to_delta(interval)
216
 
    except ValueError:
217
 
        pass
218
 
 
219
97
    value = datetime.timedelta(0)
220
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
221
 
 
 
98
    regexp = re.compile("(\d+)([dsmhw]?)")
 
99
    
222
100
    for num, suffix in regexp.findall(interval):
223
101
        if suffix == "d":
224
102
            value += datetime.timedelta(int(num))
234
112
            value += datetime.timedelta(0, 0, 0, int(num))
235
113
    return value
236
114
 
237
 
 
238
115
def print_clients(clients, keywords):
239
116
    def valuetostring(value, keyword):
240
117
        if type(value) is dbus.Boolean:
242
119
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
243
120
                       "ApprovalDuration", "ExtendedTimeout"):
244
121
            return milliseconds_to_string(value)
245
 
        return str(value)
246
 
 
 
122
        return unicode(value)
 
123
    
247
124
    # Create format string to print table rows
248
125
    format_string = " ".join("{{{key}:{width}}}".format(
249
 
        width=max(len(tablewords[key]),
250
 
                  max(len(valuetostring(client[key], key))
251
 
                      for client in clients)),
252
 
        key=key)
253
 
                             for key in keywords)
 
126
            width = max(len(tablewords[key]),
 
127
                        max(len(valuetostring(client[key],
 
128
                                              key))
 
129
                            for client in
 
130
                            clients)),
 
131
            key = key) for key in keywords)
254
132
    # Print header line
255
133
    print(format_string.format(**tablewords))
256
134
    for client in clients:
257
 
        print(format_string
258
 
              .format(**{key: valuetostring(client[key], key)
259
 
                         for key in keywords}))
260
 
 
 
135
        print(format_string.format(**dict((key,
 
136
                                           valuetostring(client[key],
 
137
                                                         key))
 
138
                                          for key in keywords)))
261
139
 
262
140
def has_actions(options):
263
141
    return any((options.enable,
279
157
                options.approve,
280
158
                options.deny))
281
159
 
282
 
 
283
160
def main():
284
161
    parser = argparse.ArgumentParser()
285
162
    parser.add_argument("--version", action="version",
286
 
                        version="%(prog)s {}".format(version),
 
163
                        version = "%(prog)s {0}".format(version),
287
164
                        help="show version number and exit")
288
165
    parser.add_argument("-a", "--all", action="store_true",
289
166
                        help="Select all clients")
290
167
    parser.add_argument("-v", "--verbose", action="store_true",
291
168
                        help="Print all fields")
292
 
    parser.add_argument("-j", "--dump-json", action="store_true",
293
 
                        help="Dump client data in JSON format")
294
169
    parser.add_argument("-e", "--enable", action="store_true",
295
170
                        help="Enable client")
296
171
    parser.add_argument("-d", "--disable", action="store_true",
324
199
    parser.add_argument("--approval-duration",
325
200
                        help="Set duration of one client approval")
326
201
    parser.add_argument("-H", "--host", help="Set host for client")
327
 
    parser.add_argument("-s", "--secret",
328
 
                        type=argparse.FileType(mode="rb"),
 
202
    parser.add_argument("-s", "--secret", type=file,
329
203
                        help="Set password blob (file) for client")
330
204
    parser.add_argument("-A", "--approve", action="store_true",
331
205
                        help="Approve any current client request")
332
206
    parser.add_argument("-D", "--deny", action="store_true",
333
207
                        help="Deny any current client request")
334
 
    parser.add_argument("--check", action="store_true",
335
 
                        help="Run self-test")
336
208
    parser.add_argument("client", nargs="*", help="Client name")
337
209
    options = parser.parse_args()
338
 
 
 
210
    
339
211
    if has_actions(options) and not (options.client or options.all):
340
212
        parser.error("Options require clients names or --all.")
341
213
    if options.verbose and has_actions(options):
342
 
        parser.error("--verbose can only be used alone.")
343
 
    if options.dump_json and (options.verbose
344
 
                              or has_actions(options)):
345
 
        parser.error("--dump-json can only be used alone.")
 
214
        parser.error("--verbose can only be used alone or with"
 
215
                     " --all.")
346
216
    if options.all and not has_actions(options):
347
217
        parser.error("--all requires an action.")
348
 
 
 
218
    
349
219
    try:
350
220
        bus = dbus.SystemBus()
351
221
        mandos_dbus_objc = bus.get_object(busname, server_path)
352
222
    except dbus.exceptions.DBusException:
353
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
223
        print("Could not connect to Mandos server",
 
224
              file=sys.stderr)
354
225
        sys.exit(1)
355
 
 
 
226
    
356
227
    mandos_serv = dbus.Interface(mandos_dbus_objc,
357
 
                                 dbus_interface=server_interface)
358
 
    mandos_serv_object_manager = dbus.Interface(
359
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
360
 
 
361
 
    # block stderr since dbus library prints to stderr
 
228
                                 dbus_interface = server_interface)
 
229
    
 
230
    #block stderr since dbus library prints to stderr
362
231
    null = os.open(os.path.devnull, os.O_RDWR)
363
232
    stderrcopy = os.dup(sys.stderr.fileno())
364
233
    os.dup2(null, sys.stderr.fileno())
365
234
    os.close(null)
366
235
    try:
367
236
        try:
368
 
            mandos_clients = {path: ifs_and_props[client_interface]
369
 
                              for path, ifs_and_props in
370
 
                              mandos_serv_object_manager
371
 
                              .GetManagedObjects().items()
372
 
                              if client_interface in ifs_and_props}
 
237
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
373
238
        finally:
374
 
            # restore stderr
 
239
            #restore stderr
375
240
            os.dup2(stderrcopy, sys.stderr.fileno())
376
241
            os.close(stderrcopy)
377
 
    except dbus.exceptions.DBusException as e:
378
 
        print("Access denied: "
379
 
              "Accessing mandos server through D-Bus: {}".format(e),
 
242
    except dbus.exceptions.DBusException:
 
243
        print("Access denied: Accessing mandos server through dbus.",
380
244
              file=sys.stderr)
381
245
        sys.exit(1)
382
 
 
 
246
    
383
247
    # Compile dict of (clients: properties) to process
384
 
    clients = {}
385
 
 
 
248
    clients={}
 
249
    
386
250
    if options.all or not options.client:
387
 
        clients = {bus.get_object(busname, path): properties
388
 
                   for path, properties in mandos_clients.items()}
 
251
        clients = dict((bus.get_object(busname, path), properties)
 
252
                       for path, properties in
 
253
                       mandos_clients.iteritems())
389
254
    else:
390
255
        for name in options.client:
391
 
            for path, client in mandos_clients.items():
 
256
            for path, client in mandos_clients.iteritems():
392
257
                if client["Name"] == name:
393
258
                    client_objc = bus.get_object(busname, path)
394
259
                    clients[client_objc] = client
395
260
                    break
396
261
            else:
397
 
                print("Client not found on server: {!r}"
 
262
                print("Client not found on server: {0!r}"
398
263
                      .format(name), file=sys.stderr)
399
264
                sys.exit(1)
400
 
 
 
265
    
401
266
    if not has_actions(options) and clients:
402
 
        if options.verbose or options.dump_json:
403
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
404
 
                        "Created", "Interval", "Host", "KeyID",
405
 
                        "Fingerprint", "CheckerRunning",
 
267
        if options.verbose:
 
268
            keywords = ("Name", "Enabled", "Timeout",
 
269
                        "LastCheckedOK", "Created", "Interval",
 
270
                        "Host", "Fingerprint", "CheckerRunning",
406
271
                        "LastEnabled", "ApprovalPending",
407
 
                        "ApprovedByDefault", "LastApprovalRequest",
408
 
                        "ApprovalDelay", "ApprovalDuration",
409
 
                        "Checker", "ExtendedTimeout", "Expires",
410
 
                        "LastCheckerStatus")
 
272
                        "ApprovedByDefault",
 
273
                        "LastApprovalRequest", "ApprovalDelay",
 
274
                        "ApprovalDuration", "Checker",
 
275
                        "ExtendedTimeout")
411
276
        else:
412
277
            keywords = defaultkeywords
413
 
 
414
 
        if options.dump_json:
415
 
            json.dump({client["Name"]: {key:
416
 
                                        bool(client[key])
417
 
                                        if isinstance(client[key],
418
 
                                                      dbus.Boolean)
419
 
                                        else client[key]
420
 
                                        for key in keywords}
421
 
                       for client in clients.values()},
422
 
                      fp=sys.stdout, indent=4,
423
 
                      separators=(',', ': '))
424
 
            print()
425
 
        else:
426
 
            print_clients(clients.values(), keywords)
 
278
        
 
279
        print_clients(clients.values(), keywords)
427
280
    else:
428
281
        # Process each client in the list by all selected options
429
282
        for client in clients:
430
 
 
431
283
            def set_client_prop(prop, value):
432
284
                """Set a Client D-Bus property"""
433
285
                client.Set(client_interface, prop, value,
434
286
                           dbus_interface=dbus.PROPERTIES_IFACE)
435
 
 
436
287
            def set_client_prop_ms(prop, value):
437
288
                """Set a Client D-Bus property, converted
438
289
                from a string to milliseconds."""
439
290
                set_client_prop(prop,
440
 
                                string_to_delta(value).total_seconds()
441
 
                                * 1000)
442
 
 
 
291
                                timedelta_to_milliseconds
 
292
                                (string_to_delta(value)))
443
293
            if options.remove:
444
294
                mandos_serv.RemoveClient(client.__dbus_object_path__)
445
295
            if options.enable:
453
303
            if options.stop_checker:
454
304
                set_client_prop("CheckerRunning", dbus.Boolean(False))
455
305
            if options.is_enabled:
456
 
                if client.Get(client_interface, "Enabled",
457
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
458
 
                    sys.exit(0)
459
 
                else:
460
 
                    sys.exit(1)
 
306
                sys.exit(0 if client.Get(client_interface,
 
307
                                         "Enabled",
 
308
                                         dbus_interface=
 
309
                                         dbus.PROPERTIES_IFACE)
 
310
                         else 1)
461
311
            if options.checker is not None:
462
312
                set_client_prop("Checker", options.checker)
463
313
            if options.host is not None:
489
339
                client.Approve(dbus.Boolean(False),
490
340
                               dbus_interface=client_interface)
491
341
 
492
 
 
493
 
def should_only_run_tests():
494
 
    parser = argparse.ArgumentParser(add_help=False)
495
 
    parser.add_argument("--check", action='store_true')
496
 
    args, unknown_args = parser.parse_known_args()
497
 
    run_tests = args.check
498
 
    if run_tests:
499
 
        # Remove --check argument from sys.argv
500
 
        sys.argv[1:] = unknown_args
501
 
    return run_tests
502
 
 
503
 
# Add all tests from doctest strings
504
 
def load_tests(loader, tests, none):
505
 
    import doctest
506
 
    tests.addTests(doctest.DocTestSuite())
507
 
    return tests
508
 
 
509
342
if __name__ == "__main__":
510
 
    if should_only_run_tests():
511
 
        # Call using ./tdd-python-script --check [--verbose]
512
 
        unittest.main()
513
 
    else:
514
 
        main()
 
343
    main()