/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-06-23 13:50:05 UTC
  • Revision ID: teddy@recompile.se-20120623135005-t0wtkmlw0ymnr2kg
* mandos (Client.start_checker): Return True (retry later) if starting
                                 checker failed.  Check for ECHILD
                                 from waitpid().

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-2011 Teddy Hogeborn
7
 
# Copyright © 2008-2011 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 <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
from future_builtins import *
 
30
 
28
31
import sys
29
 
import dbus
30
32
import argparse
31
33
import locale
32
34
import datetime
33
35
import re
34
36
import os
 
37
import collections
 
38
import doctest
 
39
 
 
40
import dbus
35
41
 
36
42
locale.setlocale(locale.LC_ALL, "")
37
43
 
60
66
server_path = "/"
61
67
server_interface = domain + ".Mandos"
62
68
client_interface = domain + ".Mandos.Client"
63
 
version = "1.4.1"
 
69
version = "1.6.0"
64
70
 
65
71
def timedelta_to_milliseconds(td):
66
72
    """Convert a datetime.timedelta object to milliseconds"""
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 = "{0}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
94
200
    datetime.timedelta(0, 330)
95
201
    """
96
202
    value = datetime.timedelta(0)
97
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
203
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
204
    
 
205
    try:
 
206
        return rfc3339_duration_to_delta(interval)
 
207
    except ValueError:
 
208
        pass
98
209
    
99
210
    for num, suffix in regexp.findall(interval):
100
211
        if suffix == "d":
116
227
        if type(value) is dbus.Boolean:
117
228
            return "Yes" if value else "No"
118
229
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
119
 
                       "ApprovalDuration"):
 
230
                       "ApprovalDuration", "ExtendedTimeout"):
120
231
            return milliseconds_to_string(value)
121
232
        return unicode(value)
122
233
    
123
234
    # 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)
 
235
    format_string = " ".join("{{{key}:{width}}}".format(
 
236
            width = max(len(tablewords[key]),
 
237
                        max(len(valuetostring(client[key],
 
238
                                              key))
 
239
                            for client in
 
240
                            clients)),
 
241
            key = key) for key in keywords)
131
242
    # Print header line
132
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
243
    print(format_string.format(**tablewords))
133
244
    for client in clients:
134
 
        print(format_string % tuple(valuetostring(client[key], key)
135
 
                                    for key in keywords))
 
245
        print(format_string.format(**dict((key,
 
246
                                           valuetostring(client[key],
 
247
                                                         key))
 
248
                                          for key in keywords)))
136
249
 
137
250
def has_actions(options):
138
251
    return any((options.enable,
157
270
def main():
158
271
    parser = argparse.ArgumentParser()
159
272
    parser.add_argument("--version", action="version",
160
 
                        version = "%%prog %s" % version,
 
273
                        version = "%(prog)s {0}".format(version),
161
274
                        help="show version number and exit")
162
275
    parser.add_argument("-a", "--all", action="store_true",
163
276
                        help="Select all clients")
202
315
                        help="Approve any current client request")
203
316
    parser.add_argument("-D", "--deny", action="store_true",
204
317
                        help="Deny any current client request")
 
318
    parser.add_argument("--check", action="store_true",
 
319
                        help="Run self-test")
205
320
    parser.add_argument("client", nargs="*", help="Client name")
206
321
    options = parser.parse_args()
207
322
    
208
 
    if has_actions(options) and not options.client and not options.all:
 
323
    if has_actions(options) and not (options.client or options.all):
209
324
        parser.error("Options require clients names or --all.")
210
325
    if options.verbose and has_actions(options):
211
326
        parser.error("--verbose can only be used alone or with"
212
327
                     " --all.")
213
328
    if options.all and not has_actions(options):
214
329
        parser.error("--all requires an action.")
 
330
 
 
331
    if options.check:
 
332
        fail_count, test_count = doctest.testmod()
 
333
        sys.exit(0 if fail_count == 0 else 1)
215
334
    
216
335
    try:
217
336
        bus = dbus.SystemBus()
256
375
                    clients[client_objc] = client
257
376
                    break
258
377
            else:
259
 
                print("Client not found on server: %r" % name,
260
 
                      file=sys.stderr)
 
378
                print("Client not found on server: {0!r}"
 
379
                      .format(name), file=sys.stderr)
261
380
                sys.exit(1)
262
381
    
263
382
    if not has_actions(options) and clients:
277
396
    else:
278
397
        # Process each client in the list by all selected options
279
398
        for client in clients:
 
399
            def set_client_prop(prop, value):
 
400
                """Set a Client D-Bus property"""
 
401
                client.Set(client_interface, prop, value,
 
402
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
403
            def set_client_prop_ms(prop, value):
 
404
                """Set a Client D-Bus property, converted
 
405
                from a string to milliseconds."""
 
406
                set_client_prop(prop,
 
407
                                timedelta_to_milliseconds
 
408
                                (string_to_delta(value)))
280
409
            if options.remove:
281
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
282
411
            if options.enable:
283
 
                client.Enable(dbus_interface=client_interface)
 
412
                set_client_prop("Enabled", dbus.Boolean(True))
284
413
            if options.disable:
285
 
                client.Disable(dbus_interface=client_interface)
 
414
                set_client_prop("Enabled", dbus.Boolean(False))
286
415
            if options.bump_timeout:
287
 
                client.CheckedOK(dbus_interface=client_interface)
 
416
                set_client_prop("LastCheckedOK", "")
288
417
            if options.start_checker:
289
 
                client.StartChecker(dbus_interface=client_interface)
 
418
                set_client_prop("CheckerRunning", dbus.Boolean(True))
290
419
            if options.stop_checker:
291
 
                client.StopChecker(dbus_interface=client_interface)
 
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
292
421
            if options.is_enabled:
293
422
                sys.exit(0 if client.Get(client_interface,
294
423
                                         "Enabled",
296
425
                                         dbus.PROPERTIES_IFACE)
297
426
                         else 1)
298
427
            if options.checker is not None:
299
 
                client.Set(client_interface, "Checker",
300
 
                           options.checker,
301
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
428
                set_client_prop("Checker", options.checker)
302
429
            if options.host is not None:
303
 
                client.Set(client_interface, "Host", options.host,
304
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
430
                set_client_prop("Host", options.host)
305
431
            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)
 
432
                set_client_prop_ms("Interval", options.interval)
310
433
            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)
 
434
                set_client_prop_ms("ApprovalDelay",
 
435
                                   options.approval_delay)
316
436
            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)
 
437
                set_client_prop_ms("ApprovalDuration",
 
438
                                   options.approval_duration)
322
439
            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)
 
440
                set_client_prop_ms("Timeout", options.timeout)
327
441
            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)
 
442
                set_client_prop_ms("ExtendedTimeout",
 
443
                                   options.extended_timeout)
332
444
            if options.secret is not None:
333
 
                client.Set(client_interface, "Secret",
334
 
                           dbus.ByteArray(open(options.secret,
335
 
                                               "rb").read()),
336
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
445
                set_client_prop("Secret",
 
446
                                dbus.ByteArray(options.secret.read()))
337
447
            if options.approved_by_default is not None:
338
 
                client.Set(client_interface, "ApprovedByDefault",
339
 
                           dbus.Boolean(options
340
 
                                        .approved_by_default),
341
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
448
                set_client_prop("ApprovedByDefault",
 
449
                                dbus.Boolean(options
 
450
                                             .approved_by_default))
342
451
            if options.approve:
343
452
                client.Approve(dbus.Boolean(True),
344
453
                               dbus_interface=client_interface)