/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: 2011-07-13 02:24:39 UTC
  • mfrom: (24.1.174 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20110713022439-wbv6kghshdsc2x24
Merge from Björn.

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