/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-05-31 15:29:22 UTC
  • Revision ID: teddy@recompile.se-20150531152922-o1xv6qr3hbj1twm0
mandos: Use codecs.open() and print() for PID file.

Use more Pythonic code, closer to the Python 3 style.

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