/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

* mandos (main.cleanup): Use tempfile.NamedTemporaryFile() instead of
                         tempfile.mkstemp().

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-2016 Teddy Hogeborn
7
 
# Copyright © 2008-2016 Björn Påhlsson
 
6
# Copyright © 2008-2012 Teddy Hogeborn
 
7
# Copyright © 2008-2012 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
 
 
34
29
import sys
 
30
import dbus
35
31
import argparse
36
32
import locale
37
33
import datetime
38
34
import re
39
35
import os
40
 
import collections
41
 
import doctest
42
 
 
43
 
import dbus
44
 
 
45
 
if sys.version_info.major == 2:
46
 
    str = unicode
47
36
 
48
37
locale.setlocale(locale.LC_ALL, "")
49
38
 
64
53
    "ApprovalDelay": "Approval Delay",
65
54
    "ApprovalDuration": "Approval Duration",
66
55
    "Checker": "Checker",
67
 
    "ExtendedTimeout": "Extended Timeout"
68
 
}
 
56
    "ExtendedTimeout" : "Extended Timeout"
 
57
    }
69
58
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
59
domain = "se.recompile"
71
60
busname = domain + ".Mandos"
72
61
server_path = "/"
73
62
server_interface = domain + ".Mandos"
74
63
client_interface = domain + ".Mandos.Client"
75
 
version = "1.7.1"
76
 
 
77
 
 
78
 
try:
79
 
    dbus.OBJECT_MANAGER_IFACE
80
 
except AttributeError:
81
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
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))
82
71
 
83
72
def milliseconds_to_string(ms):
84
73
    td = datetime.timedelta(0, 0, 0, ms)
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
 
 
 
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
                    ))
187
80
 
188
81
def string_to_delta(interval):
189
82
    """Parse a string and return a datetime.timedelta
190
83
    
191
 
    >>> string_to_delta('7d')
 
84
    >>> string_to_delta("7d")
192
85
    datetime.timedelta(7)
193
 
    >>> string_to_delta('60s')
 
86
    >>> string_to_delta("60s")
194
87
    datetime.timedelta(0, 60)
195
 
    >>> string_to_delta('60m')
 
88
    >>> string_to_delta("60m")
196
89
    datetime.timedelta(0, 3600)
197
 
    >>> string_to_delta('24h')
 
90
    >>> string_to_delta("24h")
198
91
    datetime.timedelta(1)
199
 
    >>> string_to_delta('1w')
 
92
    >>> string_to_delta("1w")
200
93
    datetime.timedelta(7)
201
 
    >>> string_to_delta('5m 30s')
 
94
    >>> string_to_delta("5m 30s")
202
95
    datetime.timedelta(0, 330)
203
96
    """
204
 
    
205
 
    try:
206
 
        return rfc3339_duration_to_delta(interval)
207
 
    except ValueError:
208
 
        pass
209
 
    
210
97
    value = datetime.timedelta(0)
211
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
98
    regexp = re.compile("(\d+)([dsmhw]?)")
212
99
    
213
100
    for num, suffix in regexp.findall(interval):
214
101
        if suffix == "d":
225
112
            value += datetime.timedelta(0, 0, 0, int(num))
226
113
    return value
227
114
 
228
 
 
229
115
def print_clients(clients, keywords):
230
116
    def valuetostring(value, keyword):
231
117
        if type(value) is dbus.Boolean:
233
119
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
234
120
                       "ApprovalDuration", "ExtendedTimeout"):
235
121
            return milliseconds_to_string(value)
236
 
        return str(value)
 
122
        return unicode(value)
237
123
    
238
124
    # Create format string to print table rows
239
125
    format_string = " ".join("{{{key}:{width}}}".format(
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)
 
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)
245
132
    # Print header line
246
133
    print(format_string.format(**tablewords))
247
134
    for client in clients:
248
 
        print(format_string.format(**{
249
 
            key: valuetostring(client[key], key)
250
 
            for key in keywords }))
251
 
 
 
135
        print(format_string.format(**dict((key,
 
136
                                           valuetostring(client[key],
 
137
                                                         key))
 
138
                                          for key in keywords)))
252
139
 
253
140
def has_actions(options):
254
141
    return any((options.enable,
270
157
                options.approve,
271
158
                options.deny))
272
159
 
273
 
 
274
160
def main():
275
161
    parser = argparse.ArgumentParser()
276
162
    parser.add_argument("--version", action="version",
277
 
                        version = "%(prog)s {}".format(version),
 
163
                        version = "%(prog)s {0}".format(version),
278
164
                        help="show version number and exit")
279
165
    parser.add_argument("-a", "--all", action="store_true",
280
166
                        help="Select all clients")
313
199
    parser.add_argument("--approval-duration",
314
200
                        help="Set duration of one client approval")
315
201
    parser.add_argument("-H", "--host", help="Set host for client")
316
 
    parser.add_argument("-s", "--secret",
317
 
                        type=argparse.FileType(mode="rb"),
 
202
    parser.add_argument("-s", "--secret", type=file,
318
203
                        help="Set password blob (file) for client")
319
204
    parser.add_argument("-A", "--approve", action="store_true",
320
205
                        help="Approve any current client request")
321
206
    parser.add_argument("-D", "--deny", action="store_true",
322
207
                        help="Deny any current client request")
323
 
    parser.add_argument("--check", action="store_true",
324
 
                        help="Run self-test")
325
208
    parser.add_argument("client", nargs="*", help="Client name")
326
209
    options = parser.parse_args()
327
210
    
332
215
                     " --all.")
333
216
    if options.all and not has_actions(options):
334
217
        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)
339
218
    
340
219
    try:
341
220
        bus = dbus.SystemBus()
342
221
        mandos_dbus_objc = bus.get_object(busname, server_path)
343
222
    except dbus.exceptions.DBusException:
344
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
223
        print("Could not connect to Mandos server",
 
224
              file=sys.stderr)
345
225
        sys.exit(1)
346
226
    
347
227
    mandos_serv = dbus.Interface(mandos_dbus_objc,
348
228
                                 dbus_interface = server_interface)
349
 
    mandos_serv_object_manager = dbus.Interface(
350
 
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
351
229
    
352
230
    #block stderr since dbus library prints to stderr
353
231
    null = os.open(os.path.devnull, os.O_RDWR)
356
234
    os.close(null)
357
235
    try:
358
236
        try:
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 }
 
237
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
364
238
        finally:
365
239
            #restore stderr
366
240
            os.dup2(stderrcopy, sys.stderr.fileno())
367
241
            os.close(stderrcopy)
368
 
    except dbus.exceptions.DBusException as e:
369
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
370
 
              .format(e), file=sys.stderr)
 
242
    except dbus.exceptions.DBusException:
 
243
        print("Access denied: Accessing mandos server through dbus.",
 
244
              file=sys.stderr)
371
245
        sys.exit(1)
372
246
    
373
247
    # Compile dict of (clients: properties) to process
374
248
    clients={}
375
249
    
376
250
    if options.all or not options.client:
377
 
        clients = { bus.get_object(busname, path): properties
378
 
                    for path, properties in mandos_clients.items() }
 
251
        clients = dict((bus.get_object(busname, path), properties)
 
252
                       for path, properties in
 
253
                       mandos_clients.iteritems())
379
254
    else:
380
255
        for name in options.client:
381
 
            for path, client in mandos_clients.items():
 
256
            for path, client in mandos_clients.iteritems():
382
257
                if client["Name"] == name:
383
258
                    client_objc = bus.get_object(busname, path)
384
259
                    clients[client_objc] = client
385
260
                    break
386
261
            else:
387
 
                print("Client not found on server: {!r}"
 
262
                print("Client not found on server: {0!r}"
388
263
                      .format(name), file=sys.stderr)
389
264
                sys.exit(1)
390
265
    
391
266
    if not has_actions(options) and clients:
392
267
        if options.verbose:
393
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
 
                        "Created", "Interval", "Host", "Fingerprint",
395
 
                        "CheckerRunning", "LastEnabled",
396
 
                        "ApprovalPending", "ApprovedByDefault",
 
268
            keywords = ("Name", "Enabled", "Timeout",
 
269
                        "LastCheckedOK", "Created", "Interval",
 
270
                        "Host", "Fingerprint", "CheckerRunning",
 
271
                        "LastEnabled", "ApprovalPending",
 
272
                        "ApprovedByDefault",
397
273
                        "LastApprovalRequest", "ApprovalDelay",
398
274
                        "ApprovalDuration", "Checker",
399
275
                        "ExtendedTimeout")
404
280
    else:
405
281
        # Process each client in the list by all selected options
406
282
        for client in clients:
407
 
            
408
283
            def set_client_prop(prop, value):
409
284
                """Set a Client D-Bus property"""
410
285
                client.Set(client_interface, prop, value,
411
286
                           dbus_interface=dbus.PROPERTIES_IFACE)
412
 
            
413
287
            def set_client_prop_ms(prop, value):
414
288
                """Set a Client D-Bus property, converted
415
289
                from a string to milliseconds."""
416
290
                set_client_prop(prop,
417
 
                                string_to_delta(value).total_seconds()
418
 
                                * 1000)
419
 
            
 
291
                                timedelta_to_milliseconds
 
292
                                (string_to_delta(value)))
420
293
            if options.remove:
421
294
                mandos_serv.RemoveClient(client.__dbus_object_path__)
422
295
            if options.enable:
466
339
                client.Approve(dbus.Boolean(False),
467
340
                               dbus_interface=client_interface)
468
341
 
469
 
 
470
342
if __name__ == "__main__":
471
343
    main()