/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-08-25 17:06:42 UTC
  • Revision ID: teddy@recompile.se-20160825170642-n4ough8ql1145zak
PEP8 compliance: mandos-monitor

* mandos-monitor: Add PEP8 compliance (as per the "pycodestyle" tool).

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