/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 14:14:14 UTC
  • Revision ID: teddy@recompile.se-20170820141414-m034xuebg7ccaeui
Add some more restrictions to the systemd service file.

* mandos.service ([Service]/ProtectKernelTunables): New; set to "yes".
  ([Service]/ProtectControlGroups): - '' -

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-2017 Teddy Hogeborn
 
7
# Copyright © 2008-2017 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
 
11
# the Free Software Foundation, either version 3 of the License, or
 
12
# (at your option) any later version.
 
13
#
 
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
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
#     GNU General Public License for more details.
 
18
#
 
19
# 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
#
 
23
# Contact the authors at <mandos@recompile.se>.
 
24
#
 
25
 
 
26
from __future__ import (division, absolute_import, print_function,
 
27
                        unicode_literals)
 
28
 
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
 
33
 
 
34
import sys
 
35
import argparse
 
36
import locale
 
37
import datetime
 
38
import re
 
39
import os
 
40
import collections
 
41
import json
 
42
 
 
43
import dbus
 
44
 
 
45
if sys.version_info.major == 2:
 
46
    str = unicode
 
47
 
 
48
locale.setlocale(locale.LC_ALL, "")
 
49
 
 
50
tablewords = {
 
51
    "Name": "Name",
 
52
    "Enabled": "Enabled",
 
53
    "Timeout": "Timeout",
 
54
    "LastCheckedOK": "Last Successful Check",
 
55
    "LastApprovalRequest": "Last Approval Request",
 
56
    "Created": "Created",
 
57
    "Interval": "Interval",
 
58
    "Host": "Host",
 
59
    "Fingerprint": "Fingerprint",
 
60
    "CheckerRunning": "Check Is Running",
 
61
    "LastEnabled": "Last Enabled",
 
62
    "ApprovalPending": "Approval Is Pending",
 
63
    "ApprovedByDefault": "Approved By Default",
 
64
    "ApprovalDelay": "Approval Delay",
 
65
    "ApprovalDuration": "Approval Duration",
 
66
    "Checker": "Checker",
 
67
    "ExtendedTimeout": "Extended Timeout",
 
68
    "Expires": "Expires",
 
69
    "LastCheckerStatus": "Last Checker Status",
 
70
}
 
71
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
 
72
domain = "se.recompile"
 
73
busname = domain + ".Mandos"
 
74
server_path = "/"
 
75
server_interface = domain + ".Mandos"
 
76
client_interface = domain + ".Mandos.Client"
 
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
 
 
85
 
 
86
def milliseconds_to_string(ms):
 
87
    td = datetime.timedelta(0, 0, 0, ms)
 
88
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
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
 
 
193
 
 
194
def string_to_delta(interval):
 
195
    """Parse a string and return a datetime.timedelta
 
196
 
 
197
    >>> string_to_delta('7d')
 
198
    datetime.timedelta(7)
 
199
    >>> string_to_delta('60s')
 
200
    datetime.timedelta(0, 60)
 
201
    >>> string_to_delta('60m')
 
202
    datetime.timedelta(0, 3600)
 
203
    >>> string_to_delta('24h')
 
204
    datetime.timedelta(1)
 
205
    >>> string_to_delta('1w')
 
206
    datetime.timedelta(7)
 
207
    >>> string_to_delta('5m 30s')
 
208
    datetime.timedelta(0, 330)
 
209
    """
 
210
 
 
211
    try:
 
212
        return rfc3339_duration_to_delta(interval)
 
213
    except ValueError:
 
214
        pass
 
215
 
 
216
    value = datetime.timedelta(0)
 
217
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
218
 
 
219
    for num, suffix in regexp.findall(interval):
 
220
        if suffix == "d":
 
221
            value += datetime.timedelta(int(num))
 
222
        elif suffix == "s":
 
223
            value += datetime.timedelta(0, int(num))
 
224
        elif suffix == "m":
 
225
            value += datetime.timedelta(0, 0, 0, 0, int(num))
 
226
        elif suffix == "h":
 
227
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
 
228
        elif suffix == "w":
 
229
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
 
230
        elif suffix == "":
 
231
            value += datetime.timedelta(0, 0, 0, int(num))
 
232
    return value
 
233
 
 
234
 
 
235
def print_clients(clients, keywords):
 
236
    def valuetostring(value, keyword):
 
237
        if type(value) is dbus.Boolean:
 
238
            return "Yes" if value else "No"
 
239
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
240
                       "ApprovalDuration", "ExtendedTimeout"):
 
241
            return milliseconds_to_string(value)
 
242
        return str(value)
 
243
 
 
244
    # Create format string to print table rows
 
245
    format_string = " ".join("{{{key}:{width}}}".format(
 
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)
 
251
    # Print header line
 
252
    print(format_string.format(**tablewords))
 
253
    for client in clients:
 
254
        print(format_string
 
255
              .format(**{key: valuetostring(client[key], key)
 
256
                         for key in keywords}))
 
257
 
 
258
 
 
259
def has_actions(options):
 
260
    return any((options.enable,
 
261
                options.disable,
 
262
                options.bump_timeout,
 
263
                options.start_checker,
 
264
                options.stop_checker,
 
265
                options.is_enabled,
 
266
                options.remove,
 
267
                options.checker is not None,
 
268
                options.timeout is not None,
 
269
                options.extended_timeout is not None,
 
270
                options.interval is not None,
 
271
                options.approved_by_default is not None,
 
272
                options.approval_delay is not None,
 
273
                options.approval_duration is not None,
 
274
                options.host is not None,
 
275
                options.secret is not None,
 
276
                options.approve,
 
277
                options.deny))
 
278
 
 
279
 
 
280
def main():
 
281
    parser = argparse.ArgumentParser()
 
282
    parser.add_argument("--version", action="version",
 
283
                        version="%(prog)s {}".format(version),
 
284
                        help="show version number and exit")
 
285
    parser.add_argument("-a", "--all", action="store_true",
 
286
                        help="Select all clients")
 
287
    parser.add_argument("-v", "--verbose", action="store_true",
 
288
                        help="Print all fields")
 
289
    parser.add_argument("-j", "--dump-json", action="store_true",
 
290
                        help="Dump client data in JSON format")
 
291
    parser.add_argument("-e", "--enable", action="store_true",
 
292
                        help="Enable client")
 
293
    parser.add_argument("-d", "--disable", action="store_true",
 
294
                        help="disable client")
 
295
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
296
                        help="Bump timeout for client")
 
297
    parser.add_argument("--start-checker", action="store_true",
 
298
                        help="Start checker for client")
 
299
    parser.add_argument("--stop-checker", action="store_true",
 
300
                        help="Stop checker for client")
 
301
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
302
                        help="Check if client is enabled")
 
303
    parser.add_argument("-r", "--remove", action="store_true",
 
304
                        help="Remove client")
 
305
    parser.add_argument("-c", "--checker",
 
306
                        help="Set checker command for client")
 
307
    parser.add_argument("-t", "--timeout",
 
308
                        help="Set timeout for client")
 
309
    parser.add_argument("--extended-timeout",
 
310
                        help="Set extended timeout for client")
 
311
    parser.add_argument("-i", "--interval",
 
312
                        help="Set checker interval for client")
 
313
    parser.add_argument("--approve-by-default", action="store_true",
 
314
                        default=None, dest="approved_by_default",
 
315
                        help="Set client to be approved by default")
 
316
    parser.add_argument("--deny-by-default", action="store_false",
 
317
                        dest="approved_by_default",
 
318
                        help="Set client to be denied by default")
 
319
    parser.add_argument("--approval-delay",
 
320
                        help="Set delay before client approve/deny")
 
321
    parser.add_argument("--approval-duration",
 
322
                        help="Set duration of one client approval")
 
323
    parser.add_argument("-H", "--host", help="Set host for client")
 
324
    parser.add_argument("-s", "--secret",
 
325
                        type=argparse.FileType(mode="rb"),
 
326
                        help="Set password blob (file) for client")
 
327
    parser.add_argument("-A", "--approve", action="store_true",
 
328
                        help="Approve any current client request")
 
329
    parser.add_argument("-D", "--deny", action="store_true",
 
330
                        help="Deny any current client request")
 
331
    parser.add_argument("--check", action="store_true",
 
332
                        help="Run self-test")
 
333
    parser.add_argument("client", nargs="*", help="Client name")
 
334
    options = parser.parse_args()
 
335
 
 
336
    if has_actions(options) and not (options.client or options.all):
 
337
        parser.error("Options require clients names or --all.")
 
338
    if options.verbose and has_actions(options):
 
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.")
 
343
    if options.all and not has_actions(options):
 
344
        parser.error("--all requires an action.")
 
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
 
 
351
    try:
 
352
        bus = dbus.SystemBus()
 
353
        mandos_dbus_objc = bus.get_object(busname, server_path)
 
354
    except dbus.exceptions.DBusException:
 
355
        print("Could not connect to Mandos server", file=sys.stderr)
 
356
        sys.exit(1)
 
357
 
 
358
    mandos_serv = dbus.Interface(mandos_dbus_objc,
 
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
 
364
    null = os.open(os.path.devnull, os.O_RDWR)
 
365
    stderrcopy = os.dup(sys.stderr.fileno())
 
366
    os.dup2(null, sys.stderr.fileno())
 
367
    os.close(null)
 
368
    try:
 
369
        try:
 
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}
 
375
        finally:
 
376
            # restore stderr
 
377
            os.dup2(stderrcopy, sys.stderr.fileno())
 
378
            os.close(stderrcopy)
 
379
    except dbus.exceptions.DBusException as e:
 
380
        print("Access denied: "
 
381
              "Accessing mandos server through D-Bus: {}".format(e),
 
382
              file=sys.stderr)
 
383
        sys.exit(1)
 
384
 
 
385
    # Compile dict of (clients: properties) to process
 
386
    clients = {}
 
387
 
 
388
    if options.all or not options.client:
 
389
        clients = {bus.get_object(busname, path): properties
 
390
                   for path, properties in mandos_clients.items()}
 
391
    else:
 
392
        for name in options.client:
 
393
            for path, client in mandos_clients.items():
 
394
                if client["Name"] == name:
 
395
                    client_objc = bus.get_object(busname, path)
 
396
                    clients[client_objc] = client
 
397
                    break
 
398
            else:
 
399
                print("Client not found on server: {!r}"
 
400
                      .format(name), file=sys.stderr)
 
401
                sys.exit(1)
 
402
 
 
403
    if not has_actions(options) and clients:
 
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",
 
409
                        "LastApprovalRequest", "ApprovalDelay",
 
410
                        "ApprovalDuration", "Checker",
 
411
                        "ExtendedTimeout", "Expires",
 
412
                        "LastCheckerStatus")
 
413
        else:
 
414
            keywords = defaultkeywords
 
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)
 
429
    else:
 
430
        # Process each client in the list by all selected options
 
431
        for client in clients:
 
432
 
 
433
            def set_client_prop(prop, value):
 
434
                """Set a Client D-Bus property"""
 
435
                client.Set(client_interface, prop, value,
 
436
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
437
 
 
438
            def set_client_prop_ms(prop, value):
 
439
                """Set a Client D-Bus property, converted
 
440
                from a string to milliseconds."""
 
441
                set_client_prop(prop,
 
442
                                string_to_delta(value).total_seconds()
 
443
                                * 1000)
 
444
 
 
445
            if options.remove:
 
446
                mandos_serv.RemoveClient(client.__dbus_object_path__)
 
447
            if options.enable:
 
448
                set_client_prop("Enabled", dbus.Boolean(True))
 
449
            if options.disable:
 
450
                set_client_prop("Enabled", dbus.Boolean(False))
 
451
            if options.bump_timeout:
 
452
                set_client_prop("LastCheckedOK", "")
 
453
            if options.start_checker:
 
454
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
455
            if options.stop_checker:
 
456
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
457
            if options.is_enabled:
 
458
                if client.Get(client_interface, "Enabled",
 
459
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
460
                    sys.exit(0)
 
461
                else:
 
462
                    sys.exit(1)
 
463
            if options.checker is not None:
 
464
                set_client_prop("Checker", options.checker)
 
465
            if options.host is not None:
 
466
                set_client_prop("Host", options.host)
 
467
            if options.interval is not None:
 
468
                set_client_prop_ms("Interval", options.interval)
 
469
            if options.approval_delay is not None:
 
470
                set_client_prop_ms("ApprovalDelay",
 
471
                                   options.approval_delay)
 
472
            if options.approval_duration is not None:
 
473
                set_client_prop_ms("ApprovalDuration",
 
474
                                   options.approval_duration)
 
475
            if options.timeout is not None:
 
476
                set_client_prop_ms("Timeout", options.timeout)
 
477
            if options.extended_timeout is not None:
 
478
                set_client_prop_ms("ExtendedTimeout",
 
479
                                   options.extended_timeout)
 
480
            if options.secret is not None:
 
481
                set_client_prop("Secret",
 
482
                                dbus.ByteArray(options.secret.read()))
 
483
            if options.approved_by_default is not None:
 
484
                set_client_prop("ApprovedByDefault",
 
485
                                dbus.Boolean(options
 
486
                                             .approved_by_default))
 
487
            if options.approve:
 
488
                client.Approve(dbus.Boolean(True),
 
489
                               dbus_interface=client_interface)
 
490
            elif options.deny:
 
491
                client.Approve(dbus.Boolean(False),
 
492
                               dbus_interface=client_interface)
 
493
 
 
494
 
 
495
if __name__ == "__main__":
 
496
    main()