/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-11-26 23:18:55 UTC
  • Revision ID: teddy@recompile.se-20161126231855-vseam120ph8856a1
Add more PEP8 compliance (as per the "pycodestyle" tool).

* mandos: Add an empty line to be more PEP8 compliant.
* mandos-monitor: - '' -

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-2015 Teddy Hogeborn
7
 
# Copyright © 2008-2015 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)
39
39
import os
40
40
import collections
41
41
import doctest
 
42
import json
42
43
 
43
44
import dbus
44
45
 
64
65
    "ApprovalDelay": "Approval Delay",
65
66
    "ApprovalDuration": "Approval Duration",
66
67
    "Checker": "Checker",
67
 
    "ExtendedTimeout": "Extended Timeout"
 
68
    "ExtendedTimeout": "Extended Timeout",
 
69
    "Expires": "Expires",
 
70
    "LastCheckerStatus": "Last Checker Status",
68
71
}
69
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
73
domain = "se.recompile"
72
75
server_path = "/"
73
76
server_interface = domain + ".Mandos"
74
77
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.9"
 
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"
76
85
 
77
86
 
78
87
def milliseconds_to_string(ms):
79
88
    td = datetime.timedelta(0, 0, 0, ms)
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))
 
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))
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
123
    Token = collections.namedtuple("Token", (
115
124
        "regexp",  # To match token; if "value" is not None, must have
148
157
                           frozenset((token_year, token_month,
149
158
                                      token_day, token_time,
150
159
                                      token_week)))
151
 
    # Define starting values
152
 
    value = datetime.timedelta() # Value so far
 
160
    # Define starting values:
 
161
    # Value so far
 
162
    value = datetime.timedelta()
153
163
    found_token = None
154
 
    followers = frozenset((token_duration, )) # Following valid tokens
155
 
    s = duration                # String left to parse
 
164
    # Following valid tokens
 
165
    followers = frozenset((token_duration, ))
 
166
    # String left to parse
 
167
    s = duration
156
168
    # Loop until end token is found
157
169
    while found_token is not token_end:
158
170
        # Search for any currently valid tokens
182
194
 
183
195
def string_to_delta(interval):
184
196
    """Parse a string and return a datetime.timedelta
185
 
    
 
197
 
186
198
    >>> string_to_delta('7d')
187
199
    datetime.timedelta(7)
188
200
    >>> string_to_delta('60s')
196
208
    >>> string_to_delta('5m 30s')
197
209
    datetime.timedelta(0, 330)
198
210
    """
199
 
    
 
211
 
200
212
    try:
201
213
        return rfc3339_duration_to_delta(interval)
202
214
    except ValueError:
203
215
        pass
204
 
    
 
216
 
205
217
    value = datetime.timedelta(0)
206
218
    regexp = re.compile(r"(\d+)([dsmhw]?)")
207
 
    
 
219
 
208
220
    for num, suffix in regexp.findall(interval):
209
221
        if suffix == "d":
210
222
            value += datetime.timedelta(int(num))
229
241
                       "ApprovalDuration", "ExtendedTimeout"):
230
242
            return milliseconds_to_string(value)
231
243
        return str(value)
232
 
    
 
244
 
233
245
    # Create format string to print table rows
234
246
    format_string = " ".join("{{{key}:{width}}}".format(
235
 
        width = max(len(tablewords[key]),
236
 
                    max(len(valuetostring(client[key], key))
237
 
                        for client in clients)),
238
 
        key = key)
 
247
        width=max(len(tablewords[key]),
 
248
                  max(len(valuetostring(client[key], key))
 
249
                      for client in clients)),
 
250
        key=key)
239
251
                             for key in keywords)
240
252
    # Print header line
241
253
    print(format_string.format(**tablewords))
242
254
    for client in clients:
243
 
        print(format_string.format(**{
244
 
            key: valuetostring(client[key], key)
245
 
            for key in keywords }))
 
255
        print(format_string
 
256
              .format(**{key: valuetostring(client[key], key)
 
257
                         for key in keywords}))
246
258
 
247
259
 
248
260
def has_actions(options):
269
281
def main():
270
282
    parser = argparse.ArgumentParser()
271
283
    parser.add_argument("--version", action="version",
272
 
                        version = "%(prog)s {}".format(version),
 
284
                        version="%(prog)s {}".format(version),
273
285
                        help="show version number and exit")
274
286
    parser.add_argument("-a", "--all", action="store_true",
275
287
                        help="Select all clients")
276
288
    parser.add_argument("-v", "--verbose", action="store_true",
277
289
                        help="Print all fields")
 
290
    parser.add_argument("-j", "--dump-json", action="store_true",
 
291
                        help="Dump client data in JSON format")
278
292
    parser.add_argument("-e", "--enable", action="store_true",
279
293
                        help="Enable client")
280
294
    parser.add_argument("-d", "--disable", action="store_true",
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
349
        sys.exit(os.EX_OK if fail_count == 0 else 1)
334
 
    
 
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
355
        print("Could not connect to Mandos server", file=sys.stderr)
340
356
        sys.exit(1)
341
 
    
 
357
 
342
358
    mandos_serv = dbus.Interface(mandos_dbus_objc,
343
 
                                 dbus_interface = server_interface)
344
 
    
345
 
    #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
346
364
    null = os.open(os.path.devnull, os.O_RDWR)
347
365
    stderrcopy = os.dup(sys.stderr.fileno())
348
366
    os.dup2(null, sys.stderr.fileno())
349
367
    os.close(null)
350
368
    try:
351
369
        try:
352
 
            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}
353
375
        finally:
354
 
            #restore stderr
 
376
            # restore stderr
355
377
            os.dup2(stderrcopy, sys.stderr.fileno())
356
378
            os.close(stderrcopy)
357
 
    except dbus.exceptions.DBusException:
358
 
        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),
359
382
              file=sys.stderr)
360
383
        sys.exit(1)
361
 
    
 
384
 
362
385
    # Compile dict of (clients: properties) to process
363
 
    clients={}
364
 
    
 
386
    clients = {}
 
387
 
365
388
    if options.all or not options.client:
366
 
        clients = { bus.get_object(busname, path): properties
367
 
                    for path, properties in mandos_clients.items() }
 
389
        clients = {bus.get_object(busname, path): properties
 
390
                   for path, properties in mandos_clients.items()}
368
391
    else:
369
392
        for name in options.client:
370
393
            for path, client in mandos_clients.items():
376
399
                print("Client not found on server: {!r}"
377
400
                      .format(name), file=sys.stderr)
378
401
                sys.exit(1)
379
 
    
 
402
 
380
403
    if not has_actions(options) and clients:
381
 
        if options.verbose:
 
404
        if options.verbose or options.dump_json:
382
405
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
383
406
                        "Created", "Interval", "Host", "Fingerprint",
384
407
                        "CheckerRunning", "LastEnabled",
385
408
                        "ApprovalPending", "ApprovedByDefault",
386
409
                        "LastApprovalRequest", "ApprovalDelay",
387
410
                        "ApprovalDuration", "Checker",
388
 
                        "ExtendedTimeout")
 
411
                        "ExtendedTimeout", "Expires",
 
412
                        "LastCheckerStatus")
389
413
        else:
390
414
            keywords = defaultkeywords
391
 
        
392
 
        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)
393
429
    else:
394
430
        # Process each client in the list by all selected options
395
431
        for client in clients:
396
 
            
 
432
 
397
433
            def set_client_prop(prop, value):
398
434
                """Set a Client D-Bus property"""
399
435
                client.Set(client_interface, prop, value,
400
436
                           dbus_interface=dbus.PROPERTIES_IFACE)
401
 
            
 
437
 
402
438
            def set_client_prop_ms(prop, value):
403
439
                """Set a Client D-Bus property, converted
404
440
                from a string to milliseconds."""
405
441
                set_client_prop(prop,
406
442
                                string_to_delta(value).total_seconds()
407
443
                                * 1000)
408
 
            
 
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: