/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

  • Committer: Teddy Hogeborn
  • Date: 2018-02-22 09:20:19 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 366.
  • Revision ID: teddy@recompile.se-20180222092019-ehyz79hzti9dnk2g
Client bug fix: Don't use leak sanitizer with leaking libraries

* Makefile (plugin-helpers/mandos-client): Remove "-fsanitize=leak"
  from CFLAGS.

Show diffs side-by-side

added added

removed removed

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