/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: 2012-03-08 21:57:33 UTC
  • mto: This revision was merged to the branch mainline in revision 562.
  • Revision ID: teddy@recompile.se-20120308215733-8pz2o2lbuc19e9uc
Add D-Bus annotations support to methods, signals and properties.

* mandos (dbus_annotations): New; decorator to add annotations.
  (DBusObjectWithProperties._get_all_dbus_things): Bug fix: return
                                                   normal name if no
                                                   "_dbus_name"
                                                   attribute.
  (DBusObjectWithProperties.Introspect): Add annotation tags.
  (AlternateDBusNamesMetaclass.__new__): Copy annotations.
  

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
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
22
# Contact the authors at <mandos@recompile.se>.
24
23
# 
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
58
domain = "se.recompile"
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.7.7"
76
 
 
77
 
 
78
 
try:
79
 
    dbus.OBJECT_MANAGER_IFACE
80
 
except AttributeError:
81
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
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))
82
70
 
83
71
def milliseconds_to_string(ms):
84
72
    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
 
 
 
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
                })
187
79
 
188
80
def string_to_delta(interval):
189
81
    """Parse a string and return a datetime.timedelta
190
82
    
191
 
    >>> string_to_delta('7d')
 
83
    >>> string_to_delta("7d")
192
84
    datetime.timedelta(7)
193
 
    >>> string_to_delta('60s')
 
85
    >>> string_to_delta("60s")
194
86
    datetime.timedelta(0, 60)
195
 
    >>> string_to_delta('60m')
 
87
    >>> string_to_delta("60m")
196
88
    datetime.timedelta(0, 3600)
197
 
    >>> string_to_delta('24h')
 
89
    >>> string_to_delta("24h")
198
90
    datetime.timedelta(1)
199
 
    >>> string_to_delta('1w')
 
91
    >>> string_to_delta("1w")
200
92
    datetime.timedelta(7)
201
 
    >>> string_to_delta('5m 30s')
 
93
    >>> string_to_delta("5m 30s")
202
94
    datetime.timedelta(0, 330)
203
95
    """
204
 
    
205
 
    try:
206
 
        return rfc3339_duration_to_delta(interval)
207
 
    except ValueError:
208
 
        pass
209
 
    
210
96
    value = datetime.timedelta(0)
211
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
97
    regexp = re.compile("(\d+)([dsmhw]?)")
212
98
    
213
99
    for num, suffix in regexp.findall(interval):
214
100
        if suffix == "d":
225
111
            value += datetime.timedelta(0, 0, 0, int(num))
226
112
    return value
227
113
 
228
 
 
229
114
def print_clients(clients, keywords):
230
115
    def valuetostring(value, keyword):
231
116
        if type(value) is dbus.Boolean:
232
117
            return "Yes" if value else "No"
233
118
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
234
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
119
                       "ApprovalDuration"):
235
120
            return milliseconds_to_string(value)
236
 
        return str(value)
 
121
        return unicode(value)
237
122
    
238
123
    # Create format string to print table rows
239
 
    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)
 
124
    format_string = " ".join("%%-%ds" %
 
125
                             max(len(tablewords[key]),
 
126
                                 max(len(valuetostring(client[key],
 
127
                                                       key))
 
128
                                     for client in
 
129
                                     clients))
244
130
                             for key in keywords)
245
131
    # Print header line
246
 
    print(format_string.format(**tablewords))
 
132
    print(format_string % tuple(tablewords[key] for key in keywords))
247
133
    for client in clients:
248
 
        print(format_string.format(**{
249
 
            key: valuetostring(client[key], key)
250
 
            for key in keywords }))
251
 
 
 
134
        print(format_string % tuple(valuetostring(client[key], key)
 
135
                                    for key in keywords))
252
136
 
253
137
def has_actions(options):
254
138
    return any((options.enable,
270
154
                options.approve,
271
155
                options.deny))
272
156
 
273
 
 
274
157
def main():
275
158
    parser = argparse.ArgumentParser()
276
159
    parser.add_argument("--version", action="version",
277
 
                        version = "%(prog)s {}".format(version),
 
160
                        version = "%%prog %s" % version,
278
161
                        help="show version number and exit")
279
162
    parser.add_argument("-a", "--all", action="store_true",
280
163
                        help="Select all clients")
313
196
    parser.add_argument("--approval-duration",
314
197
                        help="Set duration of one client approval")
315
198
    parser.add_argument("-H", "--host", help="Set host for client")
316
 
    parser.add_argument("-s", "--secret",
317
 
                        type=argparse.FileType(mode="rb"),
 
199
    parser.add_argument("-s", "--secret", type=file,
318
200
                        help="Set password blob (file) for client")
319
201
    parser.add_argument("-A", "--approve", action="store_true",
320
202
                        help="Approve any current client request")
321
203
    parser.add_argument("-D", "--deny", action="store_true",
322
204
                        help="Deny any current client request")
323
 
    parser.add_argument("--check", action="store_true",
324
 
                        help="Run self-test")
325
205
    parser.add_argument("client", nargs="*", help="Client name")
326
206
    options = parser.parse_args()
327
207
    
328
 
    if has_actions(options) and not (options.client or options.all):
 
208
    if has_actions(options) and not options.client and not options.all:
329
209
        parser.error("Options require clients names or --all.")
330
210
    if options.verbose and has_actions(options):
331
211
        parser.error("--verbose can only be used alone or with"
332
212
                     " --all.")
333
213
    if options.all and not has_actions(options):
334
214
        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
215
    
340
216
    try:
341
217
        bus = dbus.SystemBus()
342
218
        mandos_dbus_objc = bus.get_object(busname, server_path)
343
219
    except dbus.exceptions.DBusException:
344
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
220
        print("Could not connect to Mandos server",
 
221
              file=sys.stderr)
345
222
        sys.exit(1)
346
223
    
347
224
    mandos_serv = dbus.Interface(mandos_dbus_objc,
348
225
                                 dbus_interface = server_interface)
349
 
    mandos_serv_object_manager = dbus.Interface(
350
 
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
351
226
    
352
227
    #block stderr since dbus library prints to stderr
353
228
    null = os.open(os.path.devnull, os.O_RDWR)
356
231
    os.close(null)
357
232
    try:
358
233
        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 }
 
234
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
364
235
        finally:
365
236
            #restore stderr
366
237
            os.dup2(stderrcopy, sys.stderr.fileno())
367
238
            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)
 
239
    except dbus.exceptions.DBusException:
 
240
        print("Access denied: Accessing mandos server through dbus.",
 
241
              file=sys.stderr)
371
242
        sys.exit(1)
372
243
    
373
244
    # Compile dict of (clients: properties) to process
374
245
    clients={}
375
246
    
376
247
    if options.all or not options.client:
377
 
        clients = { bus.get_object(busname, path): properties
378
 
                    for path, properties in mandos_clients.items() }
 
248
        clients = dict((bus.get_object(busname, path), properties)
 
249
                       for path, properties in
 
250
                       mandos_clients.iteritems())
379
251
    else:
380
252
        for name in options.client:
381
 
            for path, client in mandos_clients.items():
 
253
            for path, client in mandos_clients.iteritems():
382
254
                if client["Name"] == name:
383
255
                    client_objc = bus.get_object(busname, path)
384
256
                    clients[client_objc] = client
385
257
                    break
386
258
            else:
387
 
                print("Client not found on server: {!r}"
388
 
                      .format(name), file=sys.stderr)
 
259
                print("Client not found on server: %r" % name,
 
260
                      file=sys.stderr)
389
261
                sys.exit(1)
390
262
    
391
263
    if not has_actions(options) and clients:
392
264
        if options.verbose:
393
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
 
                        "Created", "Interval", "Host", "Fingerprint",
395
 
                        "CheckerRunning", "LastEnabled",
396
 
                        "ApprovalPending", "ApprovedByDefault",
 
265
            keywords = ("Name", "Enabled", "Timeout",
 
266
                        "LastCheckedOK", "Created", "Interval",
 
267
                        "Host", "Fingerprint", "CheckerRunning",
 
268
                        "LastEnabled", "ApprovalPending",
 
269
                        "ApprovedByDefault",
397
270
                        "LastApprovalRequest", "ApprovalDelay",
398
271
                        "ApprovalDuration", "Checker",
399
272
                        "ExtendedTimeout")
404
277
    else:
405
278
        # Process each client in the list by all selected options
406
279
        for client in clients:
407
 
            
408
 
            def set_client_prop(prop, value):
409
 
                """Set a Client D-Bus property"""
410
 
                client.Set(client_interface, prop, value,
411
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
412
 
            
413
 
            def set_client_prop_ms(prop, value):
414
 
                """Set a Client D-Bus property, converted
415
 
                from a string to milliseconds."""
416
 
                set_client_prop(prop,
417
 
                                string_to_delta(value).total_seconds()
418
 
                                * 1000)
419
 
            
420
280
            if options.remove:
421
281
                mandos_serv.RemoveClient(client.__dbus_object_path__)
422
282
            if options.enable:
423
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
283
                client.Enable(dbus_interface=client_interface)
424
284
            if options.disable:
425
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
285
                client.Disable(dbus_interface=client_interface)
426
286
            if options.bump_timeout:
427
 
                set_client_prop("LastCheckedOK", "")
 
287
                client.CheckedOK(dbus_interface=client_interface)
428
288
            if options.start_checker:
429
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
289
                client.StartChecker(dbus_interface=client_interface)
430
290
            if options.stop_checker:
431
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
291
                client.StopChecker(dbus_interface=client_interface)
432
292
            if options.is_enabled:
433
293
                sys.exit(0 if client.Get(client_interface,
434
294
                                         "Enabled",
436
296
                                         dbus.PROPERTIES_IFACE)
437
297
                         else 1)
438
298
            if options.checker is not None:
439
 
                set_client_prop("Checker", options.checker)
 
299
                client.Set(client_interface, "Checker",
 
300
                           options.checker,
 
301
                           dbus_interface=dbus.PROPERTIES_IFACE)
440
302
            if options.host is not None:
441
 
                set_client_prop("Host", options.host)
 
303
                client.Set(client_interface, "Host", options.host,
 
304
                           dbus_interface=dbus.PROPERTIES_IFACE)
442
305
            if options.interval is not None:
443
 
                set_client_prop_ms("Interval", options.interval)
 
306
                client.Set(client_interface, "Interval",
 
307
                           timedelta_to_milliseconds
 
308
                           (string_to_delta(options.interval)),
 
309
                           dbus_interface=dbus.PROPERTIES_IFACE)
444
310
            if options.approval_delay is not None:
445
 
                set_client_prop_ms("ApprovalDelay",
446
 
                                   options.approval_delay)
 
311
                client.Set(client_interface, "ApprovalDelay",
 
312
                           timedelta_to_milliseconds
 
313
                           (string_to_delta(options.
 
314
                                            approval_delay)),
 
315
                           dbus_interface=dbus.PROPERTIES_IFACE)
447
316
            if options.approval_duration is not None:
448
 
                set_client_prop_ms("ApprovalDuration",
449
 
                                   options.approval_duration)
 
317
                client.Set(client_interface, "ApprovalDuration",
 
318
                           timedelta_to_milliseconds
 
319
                           (string_to_delta(options.
 
320
                                            approval_duration)),
 
321
                           dbus_interface=dbus.PROPERTIES_IFACE)
450
322
            if options.timeout is not None:
451
 
                set_client_prop_ms("Timeout", options.timeout)
 
323
                client.Set(client_interface, "Timeout",
 
324
                           timedelta_to_milliseconds
 
325
                           (string_to_delta(options.timeout)),
 
326
                           dbus_interface=dbus.PROPERTIES_IFACE)
452
327
            if options.extended_timeout is not None:
453
 
                set_client_prop_ms("ExtendedTimeout",
454
 
                                   options.extended_timeout)
 
328
                client.Set(client_interface, "ExtendedTimeout",
 
329
                           timedelta_to_milliseconds
 
330
                           (string_to_delta(options.extended_timeout)),
 
331
                           dbus_interface=dbus.PROPERTIES_IFACE)
455
332
            if options.secret is not None:
456
 
                set_client_prop("Secret",
457
 
                                dbus.ByteArray(options.secret.read()))
 
333
                client.Set(client_interface, "Secret",
 
334
                           dbus.ByteArray(options.secret.read()),
 
335
                           dbus_interface=dbus.PROPERTIES_IFACE)
458
336
            if options.approved_by_default is not None:
459
 
                set_client_prop("ApprovedByDefault",
460
 
                                dbus.Boolean(options
461
 
                                             .approved_by_default))
 
337
                client.Set(client_interface, "ApprovedByDefault",
 
338
                           dbus.Boolean(options
 
339
                                        .approved_by_default),
 
340
                           dbus_interface=dbus.PROPERTIES_IFACE)
462
341
            if options.approve:
463
342
                client.Approve(dbus.Boolean(True),
464
343
                               dbus_interface=client_interface)
466
345
                client.Approve(dbus.Boolean(False),
467
346
                               dbus_interface=client_interface)
468
347
 
469
 
 
470
348
if __name__ == "__main__":
471
349
    main()