/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: 2011-07-27 17:58:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110727175827-nrd1ysjl4jrh6qw1
Tags: version-1.3.1-1
* Makefile (version): Changed to "1.3.1".
* NEWS (Version 1.3.1): New entry.
* debian/changelog (1.3.1-1): - '' -

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-2014 Teddy Hogeborn
7
 
# Copyright © 2008-2014 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[0] == 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
    }
69
56
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
 
domain = "se.recompile"
 
57
domain = "se.bsnet.fukt"
71
58
busname = domain + ".Mandos"
72
59
server_path = "/"
73
60
server_interface = domain + ".Mandos"
74
61
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.7"
 
62
version = "1.3.1"
76
63
 
77
64
def timedelta_to_milliseconds(td):
78
65
    """Convert a datetime.timedelta object to milliseconds"""
82
69
 
83
70
def milliseconds_to_string(ms):
84
71
    td = datetime.timedelta(0, 0, 0, ms)
85
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
86
 
            .format(days = "{0}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
 
 
93
 
def rfc3339_duration_to_delta(duration):
94
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
95
 
    
96
 
    >>> rfc3339_duration_to_delta("P7D")
97
 
    datetime.timedelta(7)
98
 
    >>> rfc3339_duration_to_delta("PT60S")
99
 
    datetime.timedelta(0, 60)
100
 
    >>> rfc3339_duration_to_delta("PT60M")
101
 
    datetime.timedelta(0, 3600)
102
 
    >>> rfc3339_duration_to_delta("PT24H")
103
 
    datetime.timedelta(1)
104
 
    >>> rfc3339_duration_to_delta("P1W")
105
 
    datetime.timedelta(7)
106
 
    >>> rfc3339_duration_to_delta("PT5M30S")
107
 
    datetime.timedelta(0, 330)
108
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
109
 
    datetime.timedelta(1, 200)
110
 
    """
111
 
    
112
 
    # Parsing an RFC 3339 duration with regular expressions is not
113
 
    # possible - there would have to be multiple places for the same
114
 
    # values, like seconds.  The current code, while more esoteric, is
115
 
    # cleaner without depending on a parsing library.  If Python had a
116
 
    # built-in library for parsing we would use it, but we'd like to
117
 
    # avoid excessive use of external libraries.
118
 
    
119
 
    # New type for defining tokens, syntax, and semantics all-in-one
120
 
    Token = collections.namedtuple("Token",
121
 
                                   ("regexp", # To match token; if
122
 
                                              # "value" is not None,
123
 
                                              # must have a "group"
124
 
                                              # containing digits
125
 
                                    "value",  # datetime.timedelta or
126
 
                                              # None
127
 
                                    "followers")) # Tokens valid after
128
 
                                                  # this token
129
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
131
 
    token_end = Token(re.compile(r"$"), None, frozenset())
132
 
    token_second = Token(re.compile(r"(\d+)S"),
133
 
                         datetime.timedelta(seconds=1),
134
 
                         frozenset((token_end,)))
135
 
    token_minute = Token(re.compile(r"(\d+)M"),
136
 
                         datetime.timedelta(minutes=1),
137
 
                         frozenset((token_second, token_end)))
138
 
    token_hour = Token(re.compile(r"(\d+)H"),
139
 
                       datetime.timedelta(hours=1),
140
 
                       frozenset((token_minute, token_end)))
141
 
    token_time = Token(re.compile(r"T"),
142
 
                       None,
143
 
                       frozenset((token_hour, token_minute,
144
 
                                  token_second)))
145
 
    token_day = Token(re.compile(r"(\d+)D"),
146
 
                      datetime.timedelta(days=1),
147
 
                      frozenset((token_time, token_end)))
148
 
    token_month = Token(re.compile(r"(\d+)M"),
149
 
                        datetime.timedelta(weeks=4),
150
 
                        frozenset((token_day, token_end)))
151
 
    token_year = Token(re.compile(r"(\d+)Y"),
152
 
                       datetime.timedelta(weeks=52),
153
 
                       frozenset((token_month, token_end)))
154
 
    token_week = Token(re.compile(r"(\d+)W"),
155
 
                       datetime.timedelta(weeks=1),
156
 
                       frozenset((token_end,)))
157
 
    token_duration = Token(re.compile(r"P"), None,
158
 
                           frozenset((token_year, token_month,
159
 
                                      token_day, token_time,
160
 
                                      token_week))),
161
 
    # Define starting values
162
 
    value = datetime.timedelta() # Value so far
163
 
    found_token = None
164
 
    followers = frozenset(token_duration,) # Following valid tokens
165
 
    s = duration                # String left to parse
166
 
    # Loop until end token is found
167
 
    while found_token is not token_end:
168
 
        # Search for any currently valid tokens
169
 
        for token in followers:
170
 
            match = token.regexp.match(s)
171
 
            if match is not None:
172
 
                # Token found
173
 
                if token.value is not None:
174
 
                    # Value found, parse digits
175
 
                    factor = int(match.group(1), 10)
176
 
                    # Add to value so far
177
 
                    value += factor * token.value
178
 
                # Strip token from string
179
 
                s = token.regexp.sub("", s, 1)
180
 
                # Go to found token
181
 
                found_token = token
182
 
                # Set valid next tokens
183
 
                followers = found_token.followers
184
 
                break
185
 
        else:
186
 
            # No currently valid tokens were found
187
 
            raise ValueError("Invalid RFC 3339 duration")
188
 
    # End token found
189
 
    return value
190
 
 
 
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
                })
191
78
 
192
79
def string_to_delta(interval):
193
80
    """Parse a string and return a datetime.timedelta
205
92
    >>> string_to_delta("5m 30s")
206
93
    datetime.timedelta(0, 330)
207
94
    """
208
 
    
209
 
    try:
210
 
        return rfc3339_duration_to_delta(interval)
211
 
    except ValueError:
212
 
        pass
213
 
    
214
 
    value = datetime.timedelta(0)
215
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
216
 
    
217
 
    for num, suffix in regexp.findall(interval):
218
 
        if suffix == "d":
219
 
            value += datetime.timedelta(int(num))
220
 
        elif suffix == "s":
221
 
            value += datetime.timedelta(0, int(num))
222
 
        elif suffix == "m":
223
 
            value += datetime.timedelta(0, 0, 0, 0, int(num))
224
 
        elif suffix == "h":
225
 
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
226
 
        elif suffix == "w":
227
 
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
228
 
        elif suffix == "":
229
 
            value += datetime.timedelta(0, 0, 0, int(num))
230
 
    return value
 
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
231
118
 
232
119
def print_clients(clients, keywords):
233
120
    def valuetostring(value, keyword):
234
121
        if type(value) is dbus.Boolean:
235
122
            return "Yes" if value else "No"
236
123
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
237
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
124
                       "ApprovalDuration"):
238
125
            return milliseconds_to_string(value)
239
 
        return str(value)
 
126
        return unicode(value)
240
127
    
241
128
    # Create format string to print table rows
242
 
    format_string = " ".join("{{{key}:{width}}}".format(
243
 
            width = max(len(tablewords[key]),
244
 
                        max(len(valuetostring(client[key],
245
 
                                              key))
246
 
                            for client in
247
 
                            clients)),
248
 
            key = key) for key in keywords)
 
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)
249
136
    # Print header line
250
 
    print(format_string.format(**tablewords))
 
137
    print(format_string % tuple(tablewords[key] for key in keywords))
251
138
    for client in clients:
252
 
        print(format_string.format(**dict((key,
253
 
                                           valuetostring(client[key],
254
 
                                                         key))
255
 
                                          for key in keywords)))
 
139
        print(format_string % tuple(valuetostring(client[key], key)
 
140
                                    for key in keywords))
256
141
 
257
142
def has_actions(options):
258
143
    return any((options.enable,
264
149
                options.remove,
265
150
                options.checker is not None,
266
151
                options.timeout is not None,
267
 
                options.extended_timeout is not None,
268
152
                options.interval is not None,
269
153
                options.approved_by_default is not None,
270
154
                options.approval_delay is not None,
277
161
def main():
278
162
    parser = argparse.ArgumentParser()
279
163
    parser.add_argument("--version", action="version",
280
 
                        version = "%(prog)s {0}".format(version),
 
164
                        version = "%%prog %s" % version,
281
165
                        help="show version number and exit")
282
166
    parser.add_argument("-a", "--all", action="store_true",
283
167
                        help="Select all clients")
301
185
                        help="Set checker command for client")
302
186
    parser.add_argument("-t", "--timeout",
303
187
                        help="Set timeout for client")
304
 
    parser.add_argument("--extended-timeout",
305
 
                        help="Set extended timeout for client")
306
188
    parser.add_argument("-i", "--interval",
307
189
                        help="Set checker interval for client")
308
190
    parser.add_argument("--approve-by-default", action="store_true",
316
198
    parser.add_argument("--approval-duration",
317
199
                        help="Set duration of one client approval")
318
200
    parser.add_argument("-H", "--host", help="Set host for client")
319
 
    parser.add_argument("-s", "--secret",
320
 
                        type=argparse.FileType(mode="rb"),
 
201
    parser.add_argument("-s", "--secret", type=file,
321
202
                        help="Set password blob (file) for client")
322
203
    parser.add_argument("-A", "--approve", action="store_true",
323
204
                        help="Approve any current client request")
324
205
    parser.add_argument("-D", "--deny", action="store_true",
325
206
                        help="Deny any current client request")
326
 
    parser.add_argument("--check", action="store_true",
327
 
                        help="Run self-test")
328
207
    parser.add_argument("client", nargs="*", help="Client name")
329
208
    options = parser.parse_args()
330
209
    
331
 
    if has_actions(options) and not (options.client or options.all):
 
210
    if has_actions(options) and not options.client and not options.all:
332
211
        parser.error("Options require clients names or --all.")
333
212
    if options.verbose and has_actions(options):
334
213
        parser.error("--verbose can only be used alone or with"
335
214
                     " --all.")
336
215
    if options.all and not has_actions(options):
337
216
        parser.error("--all requires an action.")
338
 
 
339
 
    if options.check:
340
 
        fail_count, test_count = doctest.testmod()
341
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
342
217
    
343
218
    try:
344
219
        bus = dbus.SystemBus()
363
238
            #restore stderr
364
239
            os.dup2(stderrcopy, sys.stderr.fileno())
365
240
            os.close(stderrcopy)
366
 
    except dbus.exceptions.DBusException:
 
241
    except dbus.exceptions.DBusException, e:
367
242
        print("Access denied: Accessing mandos server through dbus.",
368
243
              file=sys.stderr)
369
244
        sys.exit(1)
374
249
    if options.all or not options.client:
375
250
        clients = dict((bus.get_object(busname, path), properties)
376
251
                       for path, properties in
377
 
                       mandos_clients.items())
 
252
                       mandos_clients.iteritems())
378
253
    else:
379
254
        for name in options.client:
380
255
            for path, client in mandos_clients.iteritems():
383
258
                    clients[client_objc] = client
384
259
                    break
385
260
            else:
386
 
                print("Client not found on server: {0!r}"
387
 
                      .format(name), file=sys.stderr)
 
261
                print("Client not found on server: %r" % name,
 
262
                      file=sys.stderr)
388
263
                sys.exit(1)
389
264
    
390
265
    if not has_actions(options) and clients:
395
270
                        "LastEnabled", "ApprovalPending",
396
271
                        "ApprovedByDefault",
397
272
                        "LastApprovalRequest", "ApprovalDelay",
398
 
                        "ApprovalDuration", "Checker",
399
 
                        "ExtendedTimeout")
 
273
                        "ApprovalDuration", "Checker")
400
274
        else:
401
275
            keywords = defaultkeywords
402
276
        
404
278
    else:
405
279
        # Process each client in the list by all selected options
406
280
        for client in clients:
407
 
            def set_client_prop(prop, value):
408
 
                """Set a Client D-Bus property"""
409
 
                client.Set(client_interface, prop, value,
410
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
411
 
            def set_client_prop_ms(prop, value):
412
 
                """Set a Client D-Bus property, converted
413
 
                from a string to milliseconds."""
414
 
                set_client_prop(prop,
415
 
                                timedelta_to_milliseconds
416
 
                                (string_to_delta(value)))
417
281
            if options.remove:
418
282
                mandos_serv.RemoveClient(client.__dbus_object_path__)
419
283
            if options.enable:
420
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
284
                client.Enable(dbus_interface=client_interface)
421
285
            if options.disable:
422
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
286
                client.Disable(dbus_interface=client_interface)
423
287
            if options.bump_timeout:
424
 
                set_client_prop("LastCheckedOK", "")
 
288
                client.CheckedOK(dbus_interface=client_interface)
425
289
            if options.start_checker:
426
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
290
                client.StartChecker(dbus_interface=client_interface)
427
291
            if options.stop_checker:
428
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
292
                client.StopChecker(dbus_interface=client_interface)
429
293
            if options.is_enabled:
430
294
                sys.exit(0 if client.Get(client_interface,
431
295
                                         "Enabled",
432
296
                                         dbus_interface=
433
297
                                         dbus.PROPERTIES_IFACE)
434
298
                         else 1)
435
 
            if options.checker is not None:
436
 
                set_client_prop("Checker", options.checker)
437
 
            if options.host is not None:
438
 
                set_client_prop("Host", options.host)
439
 
            if options.interval is not None:
440
 
                set_client_prop_ms("Interval", options.interval)
441
 
            if options.approval_delay is not None:
442
 
                set_client_prop_ms("ApprovalDelay",
443
 
                                   options.approval_delay)
444
 
            if options.approval_duration is not None:
445
 
                set_client_prop_ms("ApprovalDuration",
446
 
                                   options.approval_duration)
447
 
            if options.timeout is not None:
448
 
                set_client_prop_ms("Timeout", options.timeout)
449
 
            if options.extended_timeout is not None:
450
 
                set_client_prop_ms("ExtendedTimeout",
451
 
                                   options.extended_timeout)
452
 
            if options.secret is not None:
453
 
                set_client_prop("Secret",
454
 
                                dbus.ByteArray(options.secret.read()))
 
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)
455
333
            if options.approved_by_default is not None:
456
 
                set_client_prop("ApprovedByDefault",
457
 
                                dbus.Boolean(options
458
 
                                             .approved_by_default))
 
334
                client.Set(client_interface, "ApprovedByDefault",
 
335
                           dbus.Boolean(options
 
336
                                        .approved_by_default),
 
337
                           dbus_interface=dbus.PROPERTIES_IFACE)
459
338
            if options.approve:
460
339
                client.Approve(dbus.Boolean(True),
461
340
                               dbus_interface=client_interface)