/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

  • Committer: Teddy Hogeborn
  • Date: 2014-08-10 14:13:02 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 323.
  • Revision ID: teddy@recompile.se-20140810141302-8q1xaaxlh8ho5joz
Emit D-Bus "org.freedesktop.DBus.Properties.PropertiesChanged" signal.

This deprecates the "se.recompile.Mandos.Client.PropertyChanged"
signal.  The new signal also adds support for noticing changes to the
"se.recompile.Mandos.Client.Secret" write-only property.

* mandos (dbus_annotations): Fix usage example in doc string.
  (DBusObjectWithProperties.PropertiesChanged): New; from D-Bus
                                                standard.
  (ClientDBus._interface): Set early instead of later.
  (ClientDBus.notifychangeproperty): Take new "invalidate_only"
                                     parameter, and pass in _interface
                                     as a default keyword argument.
  (ClientDBus.notifychangeproperty/setter): Also emit
                                            PropertiesChanged signal;
                                            emit new value or
                                            invalidation depending on
                                            "invalidate_only".
  (ClientDBus.secret): Apply notifychangeproperty with
                       "invalidate_only=True".
  (ClientDBus._foo): Removed defunct interface annotation.
  (ClientDBus.PropertyChanged): Add annotation; this method is now
                                deprecated.
  (main/MandosDBusService.GetAllClientsWithProperties): Use dictionary
                                                        comprehension.
* DBUS-API (Mandos Client Interface/Signals/PropertyChanged): Removed.
* mandos-monitor: Use standard "PropertiesChanged" signal instead of
                  old signal "PropertyChanged".
  (MandosClientPropertyCache.__init__): Connect to signal
                                        PropertiesChanged instead of
                                        PropertyChanged.
  (MandosClientPropertyCache._property_changed): Removed.
  (MandosClientPropertyCache.property_changed): Renamed to
                                                "properties_changed"
                                                and adapted to new
                                                call signature.
  (MandosClientWidget.properties_changed): - '' -

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-2014 Teddy Hogeborn
 
7
# Copyright © 2008-2014 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 <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
21
22
# 
22
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
25
26
from __future__ import (division, absolute_import, print_function,
26
27
                        unicode_literals)
27
28
 
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
 
33
 
28
34
import sys
29
 
import dbus
30
35
import argparse
31
36
import locale
32
37
import datetime
33
38
import re
34
39
import os
 
40
import collections
 
41
import doctest
 
42
 
 
43
import dbus
 
44
 
 
45
if sys.version_info.major == 2:
 
46
    str = unicode
35
47
 
36
48
locale.setlocale(locale.LC_ALL, "")
37
49
 
60
72
server_path = "/"
61
73
server_interface = domain + ".Mandos"
62
74
client_interface = domain + ".Mandos.Client"
63
 
version = "1.5.1"
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))
 
75
version = "1.6.8"
70
76
 
71
77
def milliseconds_to_string(ms):
72
78
    td = datetime.timedelta(0, 0, 0, ms)
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
 
                })
 
79
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
80
            .format(days = "{}T".format(td.days) if td.days else "",
 
81
                    hours = td.seconds // 3600,
 
82
                    minutes = (td.seconds % 3600) // 60,
 
83
                    seconds = td.seconds % 60,
 
84
                    ))
 
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
 
116
                                              # "value" is not None,
 
117
                                              # must have a "group"
 
118
                                              # containing digits
 
119
                                    "value",  # datetime.timedelta or
 
120
                                              # None
 
121
                                    "followers")) # Tokens valid after
 
122
                                                  # this token
 
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
125
    token_end = Token(re.compile(r"$"), None, frozenset())
 
126
    token_second = Token(re.compile(r"(\d+)S"),
 
127
                         datetime.timedelta(seconds=1),
 
128
                         frozenset((token_end,)))
 
129
    token_minute = Token(re.compile(r"(\d+)M"),
 
130
                         datetime.timedelta(minutes=1),
 
131
                         frozenset((token_second, token_end)))
 
132
    token_hour = Token(re.compile(r"(\d+)H"),
 
133
                       datetime.timedelta(hours=1),
 
134
                       frozenset((token_minute, token_end)))
 
135
    token_time = Token(re.compile(r"T"),
 
136
                       None,
 
137
                       frozenset((token_hour, token_minute,
 
138
                                  token_second)))
 
139
    token_day = Token(re.compile(r"(\d+)D"),
 
140
                      datetime.timedelta(days=1),
 
141
                      frozenset((token_time, token_end)))
 
142
    token_month = Token(re.compile(r"(\d+)M"),
 
143
                        datetime.timedelta(weeks=4),
 
144
                        frozenset((token_day, token_end)))
 
145
    token_year = Token(re.compile(r"(\d+)Y"),
 
146
                       datetime.timedelta(weeks=52),
 
147
                       frozenset((token_month, token_end)))
 
148
    token_week = Token(re.compile(r"(\d+)W"),
 
149
                       datetime.timedelta(weeks=1),
 
150
                       frozenset((token_end,)))
 
151
    token_duration = Token(re.compile(r"P"), None,
 
152
                           frozenset((token_year, token_month,
 
153
                                      token_day, token_time,
 
154
                                      token_week)))
 
155
    # Define starting values
 
156
    value = datetime.timedelta() # Value so far
 
157
    found_token = None
 
158
    followers = frozenset((token_duration,)) # Following valid tokens
 
159
    s = duration                # String left to parse
 
160
    # Loop until end token is found
 
161
    while found_token is not token_end:
 
162
        # Search for any currently valid tokens
 
163
        for token in followers:
 
164
            match = token.regexp.match(s)
 
165
            if match is not None:
 
166
                # Token found
 
167
                if token.value is not None:
 
168
                    # Value found, parse digits
 
169
                    factor = int(match.group(1), 10)
 
170
                    # Add to value so far
 
171
                    value += factor * token.value
 
172
                # Strip token from string
 
173
                s = token.regexp.sub("", s, 1)
 
174
                # Go to found token
 
175
                found_token = token
 
176
                # Set valid next tokens
 
177
                followers = found_token.followers
 
178
                break
 
179
        else:
 
180
            # No currently valid tokens were found
 
181
            raise ValueError("Invalid RFC 3339 duration")
 
182
    # End token found
 
183
    return value
 
184
 
79
185
 
80
186
def string_to_delta(interval):
81
187
    """Parse a string and return a datetime.timedelta
93
199
    >>> string_to_delta("5m 30s")
94
200
    datetime.timedelta(0, 330)
95
201
    """
 
202
    
 
203
    try:
 
204
        return rfc3339_duration_to_delta(interval)
 
205
    except ValueError:
 
206
        pass
 
207
    
96
208
    value = datetime.timedelta(0)
97
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
209
    regexp = re.compile(r"(\d+)([dsmhw]?)")
98
210
    
99
211
    for num, suffix in regexp.findall(interval):
100
212
        if suffix == "d":
116
228
        if type(value) is dbus.Boolean:
117
229
            return "Yes" if value else "No"
118
230
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
119
 
                       "ApprovalDuration"):
 
231
                       "ApprovalDuration", "ExtendedTimeout"):
120
232
            return milliseconds_to_string(value)
121
 
        return unicode(value)
 
233
        return str(value)
122
234
    
123
235
    # Create format string to print table rows
124
 
    format_string = " ".join("%%-%ds" %
125
 
                             max(len(tablewords[key]),
126
 
                                 max(len(valuetostring(client[key],
127
 
                                                       key))
128
 
                                     for client in
129
 
                                     clients))
130
 
                             for key in keywords)
 
236
    format_string = " ".join("{{{key}:{width}}}".format(
 
237
            width = max(len(tablewords[key]),
 
238
                        max(len(valuetostring(client[key],
 
239
                                              key))
 
240
                            for client in
 
241
                            clients)),
 
242
            key = key) for key in keywords)
131
243
    # Print header line
132
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
244
    print(format_string.format(**tablewords))
133
245
    for client in clients:
134
 
        print(format_string % tuple(valuetostring(client[key], key)
135
 
                                    for key in keywords))
 
246
        print(format_string.format(**{ key:
 
247
                                           valuetostring(client[key],
 
248
                                                         key)
 
249
                                       for key in keywords }))
136
250
 
137
251
def has_actions(options):
138
252
    return any((options.enable,
157
271
def main():
158
272
    parser = argparse.ArgumentParser()
159
273
    parser.add_argument("--version", action="version",
160
 
                        version = "%%prog %s" % version,
 
274
                        version = "%(prog)s {}".format(version),
161
275
                        help="show version number and exit")
162
276
    parser.add_argument("-a", "--all", action="store_true",
163
277
                        help="Select all clients")
196
310
    parser.add_argument("--approval-duration",
197
311
                        help="Set duration of one client approval")
198
312
    parser.add_argument("-H", "--host", help="Set host for client")
199
 
    parser.add_argument("-s", "--secret", type=file,
 
313
    parser.add_argument("-s", "--secret",
 
314
                        type=argparse.FileType(mode="rb"),
200
315
                        help="Set password blob (file) for client")
201
316
    parser.add_argument("-A", "--approve", action="store_true",
202
317
                        help="Approve any current client request")
203
318
    parser.add_argument("-D", "--deny", action="store_true",
204
319
                        help="Deny any current client request")
 
320
    parser.add_argument("--check", action="store_true",
 
321
                        help="Run self-test")
205
322
    parser.add_argument("client", nargs="*", help="Client name")
206
323
    options = parser.parse_args()
207
324
    
208
 
    if has_actions(options) and not options.client and not options.all:
 
325
    if has_actions(options) and not (options.client or options.all):
209
326
        parser.error("Options require clients names or --all.")
210
327
    if options.verbose and has_actions(options):
211
328
        parser.error("--verbose can only be used alone or with"
212
329
                     " --all.")
213
330
    if options.all and not has_actions(options):
214
331
        parser.error("--all requires an action.")
 
332
 
 
333
    if options.check:
 
334
        fail_count, test_count = doctest.testmod()
 
335
        sys.exit(os.EX_OK if fail_count == 0 else 1)
215
336
    
216
337
    try:
217
338
        bus = dbus.SystemBus()
245
366
    clients={}
246
367
    
247
368
    if options.all or not options.client:
248
 
        clients = dict((bus.get_object(busname, path), properties)
249
 
                       for path, properties in
250
 
                       mandos_clients.iteritems())
 
369
        clients = { bus.get_object(busname, path): properties
 
370
                    for path, properties in mandos_clients.items() }
251
371
    else:
252
372
        for name in options.client:
253
 
            for path, client in mandos_clients.iteritems():
 
373
            for path, client in mandos_clients.items():
254
374
                if client["Name"] == name:
255
375
                    client_objc = bus.get_object(busname, path)
256
376
                    clients[client_objc] = client
257
377
                    break
258
378
            else:
259
 
                print("Client not found on server: %r" % name,
260
 
                      file=sys.stderr)
 
379
                print("Client not found on server: {!r}"
 
380
                      .format(name), file=sys.stderr)
261
381
                sys.exit(1)
262
382
    
263
383
    if not has_actions(options) and clients:
277
397
    else:
278
398
        # Process each client in the list by all selected options
279
399
        for client in clients:
 
400
            def set_client_prop(prop, value):
 
401
                """Set a Client D-Bus property"""
 
402
                client.Set(client_interface, prop, value,
 
403
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
404
            def set_client_prop_ms(prop, value):
 
405
                """Set a Client D-Bus property, converted
 
406
                from a string to milliseconds."""
 
407
                set_client_prop(prop,
 
408
                                string_to_delta(value).total_seconds()
 
409
                                * 1000)
280
410
            if options.remove:
281
411
                mandos_serv.RemoveClient(client.__dbus_object_path__)
282
412
            if options.enable:
283
 
                client.Enable(dbus_interface=client_interface)
 
413
                set_client_prop("Enabled", dbus.Boolean(True))
284
414
            if options.disable:
285
 
                client.Disable(dbus_interface=client_interface)
 
415
                set_client_prop("Enabled", dbus.Boolean(False))
286
416
            if options.bump_timeout:
287
 
                client.CheckedOK(dbus_interface=client_interface)
 
417
                set_client_prop("LastCheckedOK", "")
288
418
            if options.start_checker:
289
 
                client.StartChecker(dbus_interface=client_interface)
 
419
                set_client_prop("CheckerRunning", dbus.Boolean(True))
290
420
            if options.stop_checker:
291
 
                client.StopChecker(dbus_interface=client_interface)
 
421
                set_client_prop("CheckerRunning", dbus.Boolean(False))
292
422
            if options.is_enabled:
293
423
                sys.exit(0 if client.Get(client_interface,
294
424
                                         "Enabled",
296
426
                                         dbus.PROPERTIES_IFACE)
297
427
                         else 1)
298
428
            if options.checker is not None:
299
 
                client.Set(client_interface, "Checker",
300
 
                           options.checker,
301
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
429
                set_client_prop("Checker", options.checker)
302
430
            if options.host is not None:
303
 
                client.Set(client_interface, "Host", options.host,
304
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
431
                set_client_prop("Host", options.host)
305
432
            if options.interval is not None:
306
 
                client.Set(client_interface, "Interval",
307
 
                           timedelta_to_milliseconds
308
 
                           (string_to_delta(options.interval)),
309
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
433
                set_client_prop_ms("Interval", options.interval)
310
434
            if options.approval_delay is not None:
311
 
                client.Set(client_interface, "ApprovalDelay",
312
 
                           timedelta_to_milliseconds
313
 
                           (string_to_delta(options.
314
 
                                            approval_delay)),
315
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
435
                set_client_prop_ms("ApprovalDelay",
 
436
                                   options.approval_delay)
316
437
            if options.approval_duration is not None:
317
 
                client.Set(client_interface, "ApprovalDuration",
318
 
                           timedelta_to_milliseconds
319
 
                           (string_to_delta(options.
320
 
                                            approval_duration)),
321
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
438
                set_client_prop_ms("ApprovalDuration",
 
439
                                   options.approval_duration)
322
440
            if options.timeout is not None:
323
 
                client.Set(client_interface, "Timeout",
324
 
                           timedelta_to_milliseconds
325
 
                           (string_to_delta(options.timeout)),
326
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
441
                set_client_prop_ms("Timeout", options.timeout)
327
442
            if options.extended_timeout is not None:
328
 
                client.Set(client_interface, "ExtendedTimeout",
329
 
                           timedelta_to_milliseconds
330
 
                           (string_to_delta(options.extended_timeout)),
331
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
443
                set_client_prop_ms("ExtendedTimeout",
 
444
                                   options.extended_timeout)
332
445
            if options.secret is not None:
333
 
                client.Set(client_interface, "Secret",
334
 
                           dbus.ByteArray(options.secret.read()),
335
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
446
                set_client_prop("Secret",
 
447
                                dbus.ByteArray(options.secret.read()))
336
448
            if options.approved_by_default is not None:
337
 
                client.Set(client_interface, "ApprovedByDefault",
338
 
                           dbus.Boolean(options
339
 
                                        .approved_by_default),
340
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
449
                set_client_prop("ApprovedByDefault",
 
450
                                dbus.Boolean(options
 
451
                                             .approved_by_default))
341
452
            if options.approve:
342
453
                client.Approve(dbus.Boolean(True),
343
454
                               dbus_interface=client_interface)