/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: 2016-10-30 21:08:05 UTC
  • Revision ID: teddy@recompile.se-20161030210805-dasmuea2fkwlk86h
"RequisiteOverridable" is deprecated in systemd unit files

* mandos.service ([Unit]/RequisiteOverridable): Change to "Requisite".

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