/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-05-03 20:16:22 UTC
  • Revision ID: teddy@recompile.se-20120503201622-d9yezi9t17i00lio
* mandos-ctl: Use new string format method.  Bug fix: --version now
              shows the program name.

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-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
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.5.3"
70
64
 
71
65
def timedelta_to_milliseconds(td):
72
66
    """Convert a datetime.timedelta object to milliseconds"""
83
77
                    seconds = td.seconds % 60,
84
78
                    ))
85
79
 
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
 
 
185
 
 
186
80
def string_to_delta(interval):
187
81
    """Parse a string and return a datetime.timedelta
188
82
    
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
    
316
204
                        help="Approve any current client request")
317
205
    parser.add_argument("-D", "--deny", action="store_true",
318
206
                        help="Deny any current client request")
319
 
    parser.add_argument("--check", action="store_true",
320
 
                        help="Run self-test")
321
207
    parser.add_argument("client", nargs="*", help="Client name")
322
208
    options = parser.parse_args()
323
209
    
324
 
    if has_actions(options) and not (options.client or options.all):
 
210
    if has_actions(options) and not options.client and not options.all:
325
211
        parser.error("Options require clients names or --all.")
326
212
    if options.verbose and has_actions(options):
327
213
        parser.error("--verbose can only be used alone or with"
328
214
                     " --all.")
329
215
    if options.all and not has_actions(options):
330
216
        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
217
    
336
218
    try:
337
219
        bus = dbus.SystemBus()
397
279
    else:
398
280
        # Process each client in the list by all selected options
399
281
        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
282
            if options.remove:
411
283
                mandos_serv.RemoveClient(client.__dbus_object_path__)
412
284
            if options.enable:
413
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
285
                client.Enable(dbus_interface=client_interface)
414
286
            if options.disable:
415
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
287
                client.Disable(dbus_interface=client_interface)
416
288
            if options.bump_timeout:
417
 
                set_client_prop("LastCheckedOK", "")
 
289
                client.CheckedOK(dbus_interface=client_interface)
418
290
            if options.start_checker:
419
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
291
                client.StartChecker(dbus_interface=client_interface)
420
292
            if options.stop_checker:
421
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
293
                client.StopChecker(dbus_interface=client_interface)
422
294
            if options.is_enabled:
423
295
                sys.exit(0 if client.Get(client_interface,
424
296
                                         "Enabled",
426
298
                                         dbus.PROPERTIES_IFACE)
427
299
                         else 1)
428
300
            if options.checker is not None:
429
 
                set_client_prop("Checker", options.checker)
 
301
                client.Set(client_interface, "Checker",
 
302
                           options.checker,
 
303
                           dbus_interface=dbus.PROPERTIES_IFACE)
430
304
            if options.host is not None:
431
 
                set_client_prop("Host", options.host)
 
305
                client.Set(client_interface, "Host", options.host,
 
306
                           dbus_interface=dbus.PROPERTIES_IFACE)
432
307
            if options.interval is not None:
433
 
                set_client_prop_ms("Interval", options.interval)
 
308
                client.Set(client_interface, "Interval",
 
309
                           timedelta_to_milliseconds
 
310
                           (string_to_delta(options.interval)),
 
311
                           dbus_interface=dbus.PROPERTIES_IFACE)
434
312
            if options.approval_delay is not None:
435
 
                set_client_prop_ms("ApprovalDelay",
436
 
                                   options.approval_delay)
 
313
                client.Set(client_interface, "ApprovalDelay",
 
314
                           timedelta_to_milliseconds
 
315
                           (string_to_delta(options.
 
316
                                            approval_delay)),
 
317
                           dbus_interface=dbus.PROPERTIES_IFACE)
437
318
            if options.approval_duration is not None:
438
 
                set_client_prop_ms("ApprovalDuration",
439
 
                                   options.approval_duration)
 
319
                client.Set(client_interface, "ApprovalDuration",
 
320
                           timedelta_to_milliseconds
 
321
                           (string_to_delta(options.
 
322
                                            approval_duration)),
 
323
                           dbus_interface=dbus.PROPERTIES_IFACE)
440
324
            if options.timeout is not None:
441
 
                set_client_prop_ms("Timeout", options.timeout)
 
325
                client.Set(client_interface, "Timeout",
 
326
                           timedelta_to_milliseconds
 
327
                           (string_to_delta(options.timeout)),
 
328
                           dbus_interface=dbus.PROPERTIES_IFACE)
442
329
            if options.extended_timeout is not None:
443
 
                set_client_prop_ms("ExtendedTimeout",
444
 
                                   options.extended_timeout)
 
330
                client.Set(client_interface, "ExtendedTimeout",
 
331
                           timedelta_to_milliseconds
 
332
                           (string_to_delta(options.extended_timeout)),
 
333
                           dbus_interface=dbus.PROPERTIES_IFACE)
445
334
            if options.secret is not None:
446
 
                set_client_prop("Secret",
447
 
                                dbus.ByteArray(options.secret.read()))
 
335
                client.Set(client_interface, "Secret",
 
336
                           dbus.ByteArray(options.secret.read()),
 
337
                           dbus_interface=dbus.PROPERTIES_IFACE)
448
338
            if options.approved_by_default is not None:
449
 
                set_client_prop("ApprovedByDefault",
450
 
                                dbus.Boolean(options
451
 
                                             .approved_by_default))
 
339
                client.Set(client_interface, "ApprovedByDefault",
 
340
                           dbus.Boolean(options
 
341
                                        .approved_by_default),
 
342
                           dbus_interface=dbus.PROPERTIES_IFACE)
452
343
            if options.approve:
453
344
                client.Approve(dbus.Boolean(True),
454
345
                               dbus_interface=client_interface)