/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: 2017-08-20 13:50:57 UTC
  • Revision ID: teddy@recompile.se-20170820135057-u069yh7hhk2ha1a2
Don't import doctest module in mandos-ctl unless running tests.

* mandos-ctl: Don't import doctest module unless running tests.

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