/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 at bsnet
  • Date: 2011-12-23 20:00:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20111223200052-nehnjfy0fogvm4ii
* mandos (initlogger): Take new "debug" argument; all callers changed.
                       Only add console logger in debug mode.
  (main/cleanup): Remove temp file on failure.

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