/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-03-09 21:23:21 UTC
  • Revision ID: teddy@recompile.se-20160309212321-2qlkzj9tecepc8xq
Server: Add Python 3 compatibility

Add Python 3 compatibility by not using the python-avahi module.  Also
fix miscellaneous things which differs in Python 3.  Especially hard
to fix is loading and saving clients data between Python 3 and 2,
since pickle formats have problems with strings.

* INSTALL: Remove python-avahi (and change python-gobject to
  python-gi, which is preferred now).
* debian/control (Source: mandos/Build-Depends-Indep): Remove
  "python-avahi".
* mandos: Wrap future_builtins import in try-except clause.  Do not
  import avahi module.  Use codecs.decode(..., "base64) instead of
  .decode("base64).  Use .keys(), .values(), and .items() instead of
  .iterkeys(), .itervalues(), and .iteritems().
  (alternate_dbus_interfaces/wrapper): Python 3 still requires the
  "black magic", but luckily it still works.  The Python 3 type()
  constructor requires first argument to be a string, not a byte
  string.
  (copy_function): New.  Use throughout.
  (Avahi, avahi): New class and global variable.
  (GnuTLS._need_version): Changed to be a byte string.
  (main): Decode byte strings loaded from pickle file.
  (main/cleanup): Dump using pickle prototoc 2 which Python 2 can
  read.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
3
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
# 
6
 
# Copyright © 2008-2012 Teddy Hogeborn
7
 
# Copyright © 2008-2012 Björn Påhlsson
 
6
# Copyright © 2008-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 Björn Påhlsson
8
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
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
28
 
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
 
33
 
29
34
import sys
30
 
import dbus
31
35
import argparse
32
36
import locale
33
37
import datetime
34
38
import re
35
39
import os
 
40
import collections
 
41
import doctest
 
42
 
 
43
import dbus
 
44
 
 
45
if sys.version_info.major == 2:
 
46
    str = unicode
36
47
 
37
48
locale.setlocale(locale.LC_ALL, "")
38
49
 
53
64
    "ApprovalDelay": "Approval Delay",
54
65
    "ApprovalDuration": "Approval Duration",
55
66
    "Checker": "Checker",
56
 
    "ExtendedTimeout" : "Extended Timeout"
57
 
    }
 
67
    "ExtendedTimeout": "Extended Timeout"
 
68
}
58
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
59
70
domain = "se.recompile"
60
71
busname = domain + ".Mandos"
61
72
server_path = "/"
62
73
server_interface = domain + ".Mandos"
63
74
client_interface = domain + ".Mandos.Client"
64
 
version = "1.5.3"
65
 
 
66
 
def timedelta_to_milliseconds(td):
67
 
    """Convert a datetime.timedelta object to milliseconds"""
68
 
    return ((td.days * 24 * 60 * 60 * 1000)
69
 
            + (td.seconds * 1000)
70
 
            + (td.microseconds // 1000))
 
75
version = "1.7.5"
 
76
 
 
77
 
 
78
try:
 
79
    dbus.OBJECT_MANAGER_IFACE
 
80
except AttributeError:
 
81
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
71
82
 
72
83
def milliseconds_to_string(ms):
73
84
    td = datetime.timedelta(0, 0, 0, ms)
74
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
75
 
            .format(days = "{0}T".format(td.days) if td.days else "",
76
 
                    hours = td.seconds // 3600,
77
 
                    minutes = (td.seconds % 3600) // 60,
78
 
                    seconds = td.seconds % 60,
79
 
                    ))
 
85
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
86
        days = "{}T".format(td.days) if td.days else "",
 
87
        hours = td.seconds // 3600,
 
88
        minutes = (td.seconds % 3600) // 60,
 
89
        seconds = td.seconds % 60))
 
90
 
 
91
 
 
92
def rfc3339_duration_to_delta(duration):
 
93
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
94
    
 
95
    >>> rfc3339_duration_to_delta("P7D")
 
96
    datetime.timedelta(7)
 
97
    >>> rfc3339_duration_to_delta("PT60S")
 
98
    datetime.timedelta(0, 60)
 
99
    >>> rfc3339_duration_to_delta("PT60M")
 
100
    datetime.timedelta(0, 3600)
 
101
    >>> rfc3339_duration_to_delta("PT24H")
 
102
    datetime.timedelta(1)
 
103
    >>> rfc3339_duration_to_delta("P1W")
 
104
    datetime.timedelta(7)
 
105
    >>> rfc3339_duration_to_delta("PT5M30S")
 
106
    datetime.timedelta(0, 330)
 
107
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
108
    datetime.timedelta(1, 200)
 
109
    """
 
110
    
 
111
    # Parsing an RFC 3339 duration with regular expressions is not
 
112
    # possible - there would have to be multiple places for the same
 
113
    # values, like seconds.  The current code, while more esoteric, is
 
114
    # cleaner without depending on a parsing library.  If Python had a
 
115
    # built-in library for parsing we would use it, but we'd like to
 
116
    # avoid excessive use of external libraries.
 
117
    
 
118
    # New type for defining tokens, syntax, and semantics all-in-one
 
119
    Token = collections.namedtuple("Token", (
 
120
        "regexp",  # To match token; if "value" is not None, must have
 
121
                   # a "group" containing digits
 
122
        "value",   # datetime.timedelta or None
 
123
        "followers"))           # Tokens valid after this token
 
124
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
125
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
126
    token_end = Token(re.compile(r"$"), None, frozenset())
 
127
    token_second = Token(re.compile(r"(\d+)S"),
 
128
                         datetime.timedelta(seconds=1),
 
129
                         frozenset((token_end, )))
 
130
    token_minute = Token(re.compile(r"(\d+)M"),
 
131
                         datetime.timedelta(minutes=1),
 
132
                         frozenset((token_second, token_end)))
 
133
    token_hour = Token(re.compile(r"(\d+)H"),
 
134
                       datetime.timedelta(hours=1),
 
135
                       frozenset((token_minute, token_end)))
 
136
    token_time = Token(re.compile(r"T"),
 
137
                       None,
 
138
                       frozenset((token_hour, token_minute,
 
139
                                  token_second)))
 
140
    token_day = Token(re.compile(r"(\d+)D"),
 
141
                      datetime.timedelta(days=1),
 
142
                      frozenset((token_time, token_end)))
 
143
    token_month = Token(re.compile(r"(\d+)M"),
 
144
                        datetime.timedelta(weeks=4),
 
145
                        frozenset((token_day, token_end)))
 
146
    token_year = Token(re.compile(r"(\d+)Y"),
 
147
                       datetime.timedelta(weeks=52),
 
148
                       frozenset((token_month, token_end)))
 
149
    token_week = Token(re.compile(r"(\d+)W"),
 
150
                       datetime.timedelta(weeks=1),
 
151
                       frozenset((token_end, )))
 
152
    token_duration = Token(re.compile(r"P"), None,
 
153
                           frozenset((token_year, token_month,
 
154
                                      token_day, token_time,
 
155
                                      token_week)))
 
156
    # Define starting values
 
157
    value = datetime.timedelta() # Value so far
 
158
    found_token = None
 
159
    followers = frozenset((token_duration, )) # Following valid tokens
 
160
    s = duration                # String left to parse
 
161
    # Loop until end token is found
 
162
    while found_token is not token_end:
 
163
        # Search for any currently valid tokens
 
164
        for token in followers:
 
165
            match = token.regexp.match(s)
 
166
            if match is not None:
 
167
                # Token found
 
168
                if token.value is not None:
 
169
                    # Value found, parse digits
 
170
                    factor = int(match.group(1), 10)
 
171
                    # Add to value so far
 
172
                    value += factor * token.value
 
173
                # Strip token from string
 
174
                s = token.regexp.sub("", s, 1)
 
175
                # Go to found token
 
176
                found_token = token
 
177
                # Set valid next tokens
 
178
                followers = found_token.followers
 
179
                break
 
180
        else:
 
181
            # No currently valid tokens were found
 
182
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
183
                             .format(duration))
 
184
    # End token found
 
185
    return value
 
186
 
80
187
 
81
188
def string_to_delta(interval):
82
189
    """Parse a string and return a datetime.timedelta
83
190
    
84
 
    >>> string_to_delta("7d")
 
191
    >>> string_to_delta('7d')
85
192
    datetime.timedelta(7)
86
 
    >>> string_to_delta("60s")
 
193
    >>> string_to_delta('60s')
87
194
    datetime.timedelta(0, 60)
88
 
    >>> string_to_delta("60m")
 
195
    >>> string_to_delta('60m')
89
196
    datetime.timedelta(0, 3600)
90
 
    >>> string_to_delta("24h")
 
197
    >>> string_to_delta('24h')
91
198
    datetime.timedelta(1)
92
 
    >>> string_to_delta("1w")
 
199
    >>> string_to_delta('1w')
93
200
    datetime.timedelta(7)
94
 
    >>> string_to_delta("5m 30s")
 
201
    >>> string_to_delta('5m 30s')
95
202
    datetime.timedelta(0, 330)
96
203
    """
 
204
    
 
205
    try:
 
206
        return rfc3339_duration_to_delta(interval)
 
207
    except ValueError:
 
208
        pass
 
209
    
97
210
    value = datetime.timedelta(0)
98
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
211
    regexp = re.compile(r"(\d+)([dsmhw]?)")
99
212
    
100
213
    for num, suffix in regexp.findall(interval):
101
214
        if suffix == "d":
112
225
            value += datetime.timedelta(0, 0, 0, int(num))
113
226
    return value
114
227
 
 
228
 
115
229
def print_clients(clients, keywords):
116
230
    def valuetostring(value, keyword):
117
231
        if type(value) is dbus.Boolean:
119
233
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
120
234
                       "ApprovalDuration", "ExtendedTimeout"):
121
235
            return milliseconds_to_string(value)
122
 
        return unicode(value)
 
236
        return str(value)
123
237
    
124
238
    # Create format string to print table rows
125
239
    format_string = " ".join("{{{key}:{width}}}".format(
126
 
            width = max(len(tablewords[key]),
127
 
                        max(len(valuetostring(client[key],
128
 
                                              key))
129
 
                            for client in
130
 
                            clients)),
131
 
            key = key) for key in keywords)
 
240
        width = max(len(tablewords[key]),
 
241
                    max(len(valuetostring(client[key], key))
 
242
                        for client in clients)),
 
243
        key = key)
 
244
                             for key in keywords)
132
245
    # Print header line
133
246
    print(format_string.format(**tablewords))
134
247
    for client in clients:
135
 
        print(format_string.format(**dict((key,
136
 
                                           valuetostring(client[key],
137
 
                                                         key))
138
 
                                          for key in keywords)))
 
248
        print(format_string.format(**{
 
249
            key: valuetostring(client[key], key)
 
250
            for key in keywords }))
 
251
 
139
252
 
140
253
def has_actions(options):
141
254
    return any((options.enable,
157
270
                options.approve,
158
271
                options.deny))
159
272
 
 
273
 
160
274
def main():
161
275
    parser = argparse.ArgumentParser()
162
276
    parser.add_argument("--version", action="version",
163
 
                        version = "%(prog)s {0}".format(version),
 
277
                        version = "%(prog)s {}".format(version),
164
278
                        help="show version number and exit")
165
279
    parser.add_argument("-a", "--all", action="store_true",
166
280
                        help="Select all clients")
199
313
    parser.add_argument("--approval-duration",
200
314
                        help="Set duration of one client approval")
201
315
    parser.add_argument("-H", "--host", help="Set host for client")
202
 
    parser.add_argument("-s", "--secret", type=file,
 
316
    parser.add_argument("-s", "--secret",
 
317
                        type=argparse.FileType(mode="rb"),
203
318
                        help="Set password blob (file) for client")
204
319
    parser.add_argument("-A", "--approve", action="store_true",
205
320
                        help="Approve any current client request")
206
321
    parser.add_argument("-D", "--deny", action="store_true",
207
322
                        help="Deny any current client request")
 
323
    parser.add_argument("--check", action="store_true",
 
324
                        help="Run self-test")
208
325
    parser.add_argument("client", nargs="*", help="Client name")
209
326
    options = parser.parse_args()
210
327
    
215
332
                     " --all.")
216
333
    if options.all and not has_actions(options):
217
334
        parser.error("--all requires an action.")
 
335
 
 
336
    if options.check:
 
337
        fail_count, test_count = doctest.testmod()
 
338
        sys.exit(os.EX_OK if fail_count == 0 else 1)
218
339
    
219
340
    try:
220
341
        bus = dbus.SystemBus()
221
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
222
343
    except dbus.exceptions.DBusException:
223
 
        print("Could not connect to Mandos server",
224
 
              file=sys.stderr)
 
344
        print("Could not connect to Mandos server", file=sys.stderr)
225
345
        sys.exit(1)
226
346
    
227
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
228
348
                                 dbus_interface = server_interface)
 
349
    mandos_serv_object_manager = dbus.Interface(
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
229
351
    
230
352
    #block stderr since dbus library prints to stderr
231
353
    null = os.open(os.path.devnull, os.O_RDWR)
234
356
    os.close(null)
235
357
    try:
236
358
        try:
237
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
359
            mandos_clients = { path: ifs_and_props[client_interface]
 
360
                               for path, ifs_and_props in
 
361
                               mandos_serv_object_manager
 
362
                               .GetManagedObjects().items()
 
363
                               if client_interface in ifs_and_props }
238
364
        finally:
239
365
            #restore stderr
240
366
            os.dup2(stderrcopy, sys.stderr.fileno())
241
367
            os.close(stderrcopy)
242
 
    except dbus.exceptions.DBusException:
243
 
        print("Access denied: Accessing mandos server through dbus.",
244
 
              file=sys.stderr)
 
368
    except dbus.exceptions.DBusException as e:
 
369
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
370
              .format(e), file=sys.stderr)
245
371
        sys.exit(1)
246
372
    
247
373
    # Compile dict of (clients: properties) to process
248
374
    clients={}
249
375
    
250
376
    if options.all or not options.client:
251
 
        clients = dict((bus.get_object(busname, path), properties)
252
 
                       for path, properties in
253
 
                       mandos_clients.iteritems())
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
254
379
    else:
255
380
        for name in options.client:
256
 
            for path, client in mandos_clients.iteritems():
 
381
            for path, client in mandos_clients.items():
257
382
                if client["Name"] == name:
258
383
                    client_objc = bus.get_object(busname, path)
259
384
                    clients[client_objc] = client
260
385
                    break
261
386
            else:
262
 
                print("Client not found on server: {0!r}"
 
387
                print("Client not found on server: {!r}"
263
388
                      .format(name), file=sys.stderr)
264
389
                sys.exit(1)
265
390
    
266
391
    if not has_actions(options) and clients:
267
392
        if options.verbose:
268
 
            keywords = ("Name", "Enabled", "Timeout",
269
 
                        "LastCheckedOK", "Created", "Interval",
270
 
                        "Host", "Fingerprint", "CheckerRunning",
271
 
                        "LastEnabled", "ApprovalPending",
272
 
                        "ApprovedByDefault",
 
393
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
273
397
                        "LastApprovalRequest", "ApprovalDelay",
274
398
                        "ApprovalDuration", "Checker",
275
399
                        "ExtendedTimeout")
280
404
    else:
281
405
        # Process each client in the list by all selected options
282
406
        for client in clients:
 
407
            
283
408
            def set_client_prop(prop, value):
284
409
                """Set a Client D-Bus property"""
285
410
                client.Set(client_interface, prop, value,
286
411
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
412
            
287
413
            def set_client_prop_ms(prop, value):
288
414
                """Set a Client D-Bus property, converted
289
415
                from a string to milliseconds."""
290
416
                set_client_prop(prop,
291
 
                                timedelta_to_milliseconds
292
 
                                (string_to_delta(value)))
 
417
                                string_to_delta(value).total_seconds()
 
418
                                * 1000)
 
419
            
293
420
            if options.remove:
294
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
295
422
            if options.enable:
339
466
                client.Approve(dbus.Boolean(False),
340
467
                               dbus_interface=client_interface)
341
468
 
 
469
 
342
470
if __name__ == "__main__":
343
471
    main()