/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: 2015-07-12 01:57:54 UTC
  • Revision ID: teddy@recompile.se-20150712015754-1lq7u2ejo7fdyfvi
* debian/mandos.prerm: Don't run init script, use only invoke-rc.d.

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