/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: Björn Påhlsson
  • Date: 2011-09-24 14:11:08 UTC
  • mto: This revision was merged to the branch mainline in revision 502.
  • Revision ID: belorn@fukt.bsnet.se-20110924141108-uejkiva9fqwt8il8
Refactoring code related to PropertyChanged dbus signal. Made sending
PropertyChanged signal to a python properties of interval variables.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
    "ExtendedTimeout" : "Extended Timeout"
 
56
    }
69
57
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
 
domain = "se.recompile"
 
58
domain = "se.bsnet.fukt"
71
59
busname = domain + ".Mandos"
72
60
server_path = "/"
73
61
server_interface = domain + ".Mandos"
74
62
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.9"
 
63
version = "1.3.1"
76
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))
77
70
 
78
71
def milliseconds_to_string(ms):
79
72
    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
 
 
 
73
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
 
74
            % { "days": "%dT" % td.days if td.days else "",
 
75
                "hours": td.seconds // 3600,
 
76
                "minutes": (td.seconds % 3600) // 60,
 
77
                "seconds": td.seconds % 60,
 
78
                })
182
79
 
183
80
def string_to_delta(interval):
184
81
    """Parse a string and return a datetime.timedelta
185
82
    
186
 
    >>> string_to_delta('7d')
 
83
    >>> string_to_delta("7d")
187
84
    datetime.timedelta(7)
188
 
    >>> string_to_delta('60s')
 
85
    >>> string_to_delta("60s")
189
86
    datetime.timedelta(0, 60)
190
 
    >>> string_to_delta('60m')
 
87
    >>> string_to_delta("60m")
191
88
    datetime.timedelta(0, 3600)
192
 
    >>> string_to_delta('24h')
 
89
    >>> string_to_delta("24h")
193
90
    datetime.timedelta(1)
194
 
    >>> string_to_delta('1w')
 
91
    >>> string_to_delta("1w")
195
92
    datetime.timedelta(7)
196
 
    >>> string_to_delta('5m 30s')
 
93
    >>> string_to_delta("5m 30s")
197
94
    datetime.timedelta(0, 330)
198
95
    """
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
 
 
 
96
    timevalue = datetime.timedelta(0)
 
97
    regexp = re.compile("\d+[dsmhw]")
 
98
    
 
99
    for s in regexp.findall(interval):
 
100
        try:
 
101
            suffix = unicode(s[-1])
 
102
            value = int(s[:-1])
 
103
            if suffix == "d":
 
104
                delta = datetime.timedelta(value)
 
105
            elif suffix == "s":
 
106
                delta = datetime.timedelta(0, value)
 
107
            elif suffix == "m":
 
108
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
109
            elif suffix == "h":
 
110
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
111
            elif suffix == "w":
 
112
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
113
            else:
 
114
                raise ValueError
 
115
        except (ValueError, IndexError):
 
116
            raise ValueError
 
117
        timevalue += delta
 
118
    return timevalue
223
119
 
224
120
def print_clients(clients, keywords):
225
121
    def valuetostring(value, keyword):
226
122
        if type(value) is dbus.Boolean:
227
123
            return "Yes" if value else "No"
228
124
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
229
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
125
                       "ApprovalDuration"):
230
126
            return milliseconds_to_string(value)
231
 
        return str(value)
 
127
        return unicode(value)
232
128
    
233
129
    # 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)
 
130
    format_string = " ".join("%%-%ds" %
 
131
                             max(len(tablewords[key]),
 
132
                                 max(len(valuetostring(client[key],
 
133
                                                       key))
 
134
                                     for client in
 
135
                                     clients))
239
136
                             for key in keywords)
240
137
    # Print header line
241
 
    print(format_string.format(**tablewords))
 
138
    print(format_string % tuple(tablewords[key] for key in keywords))
242
139
    for client in clients:
243
 
        print(format_string.format(**{
244
 
            key: valuetostring(client[key], key)
245
 
            for key in keywords }))
246
 
 
 
140
        print(format_string % tuple(valuetostring(client[key], key)
 
141
                                    for key in keywords))
247
142
 
248
143
def has_actions(options):
249
144
    return any((options.enable,
265
160
                options.approve,
266
161
                options.deny))
267
162
 
268
 
 
269
163
def main():
270
164
    parser = argparse.ArgumentParser()
271
165
    parser.add_argument("--version", action="version",
272
 
                        version = "%(prog)s {}".format(version),
 
166
                        version = "%%prog %s" % version,
273
167
                        help="show version number and exit")
274
168
    parser.add_argument("-a", "--all", action="store_true",
275
169
                        help="Select all clients")
308
202
    parser.add_argument("--approval-duration",
309
203
                        help="Set duration of one client approval")
310
204
    parser.add_argument("-H", "--host", help="Set host for client")
311
 
    parser.add_argument("-s", "--secret",
312
 
                        type=argparse.FileType(mode="rb"),
 
205
    parser.add_argument("-s", "--secret", type=file,
313
206
                        help="Set password blob (file) for client")
314
207
    parser.add_argument("-A", "--approve", action="store_true",
315
208
                        help="Approve any current client request")
316
209
    parser.add_argument("-D", "--deny", action="store_true",
317
210
                        help="Deny any current client request")
318
 
    parser.add_argument("--check", action="store_true",
319
 
                        help="Run self-test")
320
211
    parser.add_argument("client", nargs="*", help="Client name")
321
212
    options = parser.parse_args()
322
213
    
323
 
    if has_actions(options) and not (options.client or options.all):
 
214
    if has_actions(options) and not options.client and not options.all:
324
215
        parser.error("Options require clients names or --all.")
325
216
    if options.verbose and has_actions(options):
326
217
        parser.error("--verbose can only be used alone or with"
327
218
                     " --all.")
328
219
    if options.all and not has_actions(options):
329
220
        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
221
    
335
222
    try:
336
223
        bus = dbus.SystemBus()
337
224
        mandos_dbus_objc = bus.get_object(busname, server_path)
338
225
    except dbus.exceptions.DBusException:
339
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
226
        print("Could not connect to Mandos server",
 
227
              file=sys.stderr)
340
228
        sys.exit(1)
341
229
    
342
230
    mandos_serv = dbus.Interface(mandos_dbus_objc,
354
242
            #restore stderr
355
243
            os.dup2(stderrcopy, sys.stderr.fileno())
356
244
            os.close(stderrcopy)
357
 
    except dbus.exceptions.DBusException:
 
245
    except dbus.exceptions.DBusException, e:
358
246
        print("Access denied: Accessing mandos server through dbus.",
359
247
              file=sys.stderr)
360
248
        sys.exit(1)
363
251
    clients={}
364
252
    
365
253
    if options.all or not options.client:
366
 
        clients = { bus.get_object(busname, path): properties
367
 
                    for path, properties in mandos_clients.items() }
 
254
        clients = dict((bus.get_object(busname, path), properties)
 
255
                       for path, properties in
 
256
                       mandos_clients.iteritems())
368
257
    else:
369
258
        for name in options.client:
370
 
            for path, client in mandos_clients.items():
 
259
            for path, client in mandos_clients.iteritems():
371
260
                if client["Name"] == name:
372
261
                    client_objc = bus.get_object(busname, path)
373
262
                    clients[client_objc] = client
374
263
                    break
375
264
            else:
376
 
                print("Client not found on server: {!r}"
377
 
                      .format(name), file=sys.stderr)
 
265
                print("Client not found on server: %r" % name,
 
266
                      file=sys.stderr)
378
267
                sys.exit(1)
379
268
    
380
269
    if not has_actions(options) and clients:
381
270
        if options.verbose:
382
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
383
 
                        "Created", "Interval", "Host", "Fingerprint",
384
 
                        "CheckerRunning", "LastEnabled",
385
 
                        "ApprovalPending", "ApprovedByDefault",
 
271
            keywords = ("Name", "Enabled", "Timeout",
 
272
                        "LastCheckedOK", "Created", "Interval",
 
273
                        "Host", "Fingerprint", "CheckerRunning",
 
274
                        "LastEnabled", "ApprovalPending",
 
275
                        "ApprovedByDefault",
386
276
                        "LastApprovalRequest", "ApprovalDelay",
387
277
                        "ApprovalDuration", "Checker",
388
278
                        "ExtendedTimeout")
393
283
    else:
394
284
        # Process each client in the list by all selected options
395
285
        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
286
            if options.remove:
410
287
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
288
            if options.enable:
412
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
289
                client.Enable(dbus_interface=client_interface)
413
290
            if options.disable:
414
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
291
                client.Disable(dbus_interface=client_interface)
415
292
            if options.bump_timeout:
416
 
                set_client_prop("LastCheckedOK", "")
 
293
                client.CheckedOK(dbus_interface=client_interface)
417
294
            if options.start_checker:
418
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
295
                client.StartChecker(dbus_interface=client_interface)
419
296
            if options.stop_checker:
420
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
297
                client.StopChecker(dbus_interface=client_interface)
421
298
            if options.is_enabled:
422
299
                sys.exit(0 if client.Get(client_interface,
423
300
                                         "Enabled",
424
301
                                         dbus_interface=
425
302
                                         dbus.PROPERTIES_IFACE)
426
303
                         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()))
 
304
            if options.checker:
 
305
                client.Set(client_interface, "Checker",
 
306
                           options.checker,
 
307
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
308
            if options.host:
 
309
                client.Set(client_interface, "Host", options.host,
 
310
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
311
            if options.interval:
 
312
                client.Set(client_interface, "Interval",
 
313
                           timedelta_to_milliseconds
 
314
                           (string_to_delta(options.interval)),
 
315
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
316
            if options.approval_delay:
 
317
                client.Set(client_interface, "ApprovalDelay",
 
318
                           timedelta_to_milliseconds
 
319
                           (string_to_delta(options.
 
320
                                            approval_delay)),
 
321
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
322
            if options.approval_duration:
 
323
                client.Set(client_interface, "ApprovalDuration",
 
324
                           timedelta_to_milliseconds
 
325
                           (string_to_delta(options.
 
326
                                            approval_duration)),
 
327
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
328
            if options.timeout:
 
329
                client.Set(client_interface, "Timeout",
 
330
                           timedelta_to_milliseconds
 
331
                           (string_to_delta(options.timeout)),
 
332
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
333
            if options.extended_timeout:
 
334
                client.Set(client_interface, "ExtendedTimeout",
 
335
                           timedelta_to_milliseconds
 
336
                           (string_to_delta(options.extended_timeout)),
 
337
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
338
            if options.secret:
 
339
                client.Set(client_interface, "Secret",
 
340
                           dbus.ByteArray(open(options.secret,
 
341
                                               "rb").read()),
 
342
                           dbus_interface=dbus.PROPERTIES_IFACE)
447
343
            if options.approved_by_default is not None:
448
 
                set_client_prop("ApprovedByDefault",
449
 
                                dbus.Boolean(options
450
 
                                             .approved_by_default))
 
344
                client.Set(client_interface, "ApprovedByDefault",
 
345
                           dbus.Boolean(options
 
346
                                        .approved_by_default),
 
347
                           dbus_interface=dbus.PROPERTIES_IFACE)
451
348
            if options.approve:
452
349
                client.Approve(dbus.Boolean(True),
453
350
                               dbus_interface=client_interface)
455
352
                client.Approve(dbus.Boolean(False),
456
353
                               dbus_interface=client_interface)
457
354
 
458
 
 
459
355
if __name__ == "__main__":
460
356
    main()