/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: 2012-06-24 03:45:55 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20120624034555-7p0dtbpsz0dgsn4d
* mandos (Client.start_checker): Add comment.  Break long line.

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-2010 Teddy Hogeborn
7
 
# Copyright © 2008-2010 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
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
24
25
 
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
 
52
58
    "ApprovalDelay": "Approval Delay",
53
59
    "ApprovalDuration": "Approval Duration",
54
60
    "Checker": "Checker",
 
61
    "ExtendedTimeout" : "Extended Timeout"
55
62
    }
56
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
57
 
domain = "se.bsnet.fukt"
 
64
domain = "se.recompile"
58
65
busname = domain + ".Mandos"
59
66
server_path = "/"
60
67
server_interface = domain + ".Mandos"
61
68
client_interface = domain + ".Mandos.Client"
62
 
version = "1.3.0"
 
69
version = "1.6.0"
63
70
 
64
71
def timedelta_to_milliseconds(td):
65
72
    """Convert a datetime.timedelta object to milliseconds"""
69
76
 
70
77
def milliseconds_to_string(ms):
71
78
    td = datetime.timedelta(0, 0, 0, ms)
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
 
                })
 
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
 
78
185
 
79
186
def string_to_delta(interval):
80
187
    """Parse a string and return a datetime.timedelta
92
199
    >>> string_to_delta("5m 30s")
93
200
    datetime.timedelta(0, 330)
94
201
    """
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
 
202
    value = datetime.timedelta(0)
 
203
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
204
    
 
205
    try:
 
206
        return rfc3339_duration_to_delta(interval)
 
207
    except ValueError:
 
208
        pass
 
209
    
 
210
    for num, suffix in regexp.findall(interval):
 
211
        if suffix == "d":
 
212
            value += datetime.timedelta(int(num))
 
213
        elif suffix == "s":
 
214
            value += datetime.timedelta(0, int(num))
 
215
        elif suffix == "m":
 
216
            value += datetime.timedelta(0, 0, 0, 0, int(num))
 
217
        elif suffix == "h":
 
218
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
 
219
        elif suffix == "w":
 
220
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
 
221
        elif suffix == "":
 
222
            value += datetime.timedelta(0, 0, 0, int(num))
 
223
    return value
118
224
 
119
225
def print_clients(clients, keywords):
120
226
    def valuetostring(value, keyword):
121
227
        if type(value) is dbus.Boolean:
122
228
            return "Yes" if value else "No"
123
229
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
 
                       "ApprovalDuration"):
 
230
                       "ApprovalDuration", "ExtendedTimeout"):
125
231
            return milliseconds_to_string(value)
126
232
        return unicode(value)
127
233
    
128
234
    # Create format string to print table rows
129
 
    format_string = " ".join("%%-%ds" %
130
 
                             max(len(tablewords[key]),
131
 
                                 max(len(valuetostring(client[key],
132
 
                                                       key))
133
 
                                     for client in
134
 
                                     clients))
135
 
                             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)
136
242
    # Print header line
137
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
243
    print(format_string.format(**tablewords))
138
244
    for client in clients:
139
 
        print(format_string % tuple(valuetostring(client[key], key)
140
 
                                    for key in keywords))
 
245
        print(format_string.format(**dict((key,
 
246
                                           valuetostring(client[key],
 
247
                                                         key))
 
248
                                          for key in keywords)))
141
249
 
142
250
def has_actions(options):
143
251
    return any((options.enable,
149
257
                options.remove,
150
258
                options.checker is not None,
151
259
                options.timeout is not None,
 
260
                options.extended_timeout is not None,
152
261
                options.interval is not None,
153
262
                options.approved_by_default is not None,
154
263
                options.approval_delay is not None,
161
270
def main():
162
271
    parser = argparse.ArgumentParser()
163
272
    parser.add_argument("--version", action="version",
164
 
                        version = "%%prog %s" % version,
 
273
                        version = "%(prog)s {0}".format(version),
165
274
                        help="show version number and exit")
166
275
    parser.add_argument("-a", "--all", action="store_true",
167
276
                        help="Select all clients")
185
294
                        help="Set checker command for client")
186
295
    parser.add_argument("-t", "--timeout",
187
296
                        help="Set timeout for client")
 
297
    parser.add_argument("--extended-timeout",
 
298
                        help="Set extended timeout for client")
188
299
    parser.add_argument("-i", "--interval",
189
300
                        help="Set checker interval for client")
190
301
    parser.add_argument("--approve-by-default", action="store_true",
204
315
                        help="Approve any current client request")
205
316
    parser.add_argument("-D", "--deny", action="store_true",
206
317
                        help="Deny any current client request")
 
318
    parser.add_argument("--check", action="store_true",
 
319
                        help="Run self-test")
207
320
    parser.add_argument("client", nargs="*", help="Client name")
208
321
    options = parser.parse_args()
209
322
    
210
 
    if has_actions(options) and not options.client and not options.all:
 
323
    if has_actions(options) and not (options.client or options.all):
211
324
        parser.error("Options require clients names or --all.")
212
325
    if options.verbose and has_actions(options):
213
326
        parser.error("--verbose can only be used alone or with"
214
327
                     " --all.")
215
328
    if options.all and not has_actions(options):
216
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)
217
334
    
218
335
    try:
219
336
        bus = dbus.SystemBus()
238
355
            #restore stderr
239
356
            os.dup2(stderrcopy, sys.stderr.fileno())
240
357
            os.close(stderrcopy)
241
 
    except dbus.exceptions.DBusException, e:
 
358
    except dbus.exceptions.DBusException:
242
359
        print("Access denied: Accessing mandos server through dbus.",
243
360
              file=sys.stderr)
244
361
        sys.exit(1)
258
375
                    clients[client_objc] = client
259
376
                    break
260
377
            else:
261
 
                print("Client not found on server: %r" % name,
262
 
                      file=sys.stderr)
 
378
                print("Client not found on server: {0!r}"
 
379
                      .format(name), file=sys.stderr)
263
380
                sys.exit(1)
264
381
    
265
382
    if not has_actions(options) and clients:
270
387
                        "LastEnabled", "ApprovalPending",
271
388
                        "ApprovedByDefault",
272
389
                        "LastApprovalRequest", "ApprovalDelay",
273
 
                        "ApprovalDuration", "Checker")
 
390
                        "ApprovalDuration", "Checker",
 
391
                        "ExtendedTimeout")
274
392
        else:
275
393
            keywords = defaultkeywords
276
394
        
278
396
    else:
279
397
        # Process each client in the list by all selected options
280
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)))
281
409
            if options.remove:
282
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
283
411
            if options.enable:
284
 
                client.Enable(dbus_interface=client_interface)
 
412
                set_client_prop("Enabled", dbus.Boolean(True))
285
413
            if options.disable:
286
 
                client.Disable(dbus_interface=client_interface)
 
414
                set_client_prop("Enabled", dbus.Boolean(False))
287
415
            if options.bump_timeout:
288
 
                client.CheckedOK(dbus_interface=client_interface)
 
416
                set_client_prop("LastCheckedOK", "")
289
417
            if options.start_checker:
290
 
                client.StartChecker(dbus_interface=client_interface)
 
418
                set_client_prop("CheckerRunning", dbus.Boolean(True))
291
419
            if options.stop_checker:
292
 
                client.StopChecker(dbus_interface=client_interface)
 
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
293
421
            if options.is_enabled:
294
422
                sys.exit(0 if client.Get(client_interface,
295
423
                                         "Enabled",
296
424
                                         dbus_interface=
297
425
                                         dbus.PROPERTIES_IFACE)
298
426
                         else 1)
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)
 
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()))
333
447
            if options.approved_by_default is not None:
334
 
                client.Set(client_interface, "ApprovedByDefault",
335
 
                           dbus.Boolean(options
336
 
                                        .approved_by_default),
337
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
448
                set_client_prop("ApprovedByDefault",
 
449
                                dbus.Boolean(options
 
450
                                             .approved_by_default))
338
451
            if options.approve:
339
452
                client.Approve(dbus.Boolean(True),
340
453
                               dbus_interface=client_interface)