/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: 2014-07-25 23:16:04 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 321.
  • Revision ID: teddy@recompile.se-20140725231604-f5c4f82rn2o5ll1k
Use the .items() method instead of .iteritems().

This is strictly not a Python 2.7 change, but Python 2.7 backported
the new .viewitems() from Python 3, and instead of changing .items()
to .viewitems() and later having to change them all into .items()
again in Python 3, I opted to just change all .iteritems() to .items()
so the code will work both now and with Python 3.  The slowdown with
Python 2 is not significant, and with Python 3 it will again be fast.

* mandos (Client.__init__): Use .items() instead of .iteritems().
  (DBusObjectWithProperties.Introspect): - '' -
  (alternate_dbus_interfaces/wrapper): - '' -
  (main): - '' -
* mandos-ctl (main): - '' -

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-2014 Teddy Hogeborn
 
7
# Copyright © 2008-2014 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
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
 
33
 
28
34
import sys
29
 
import dbus
30
35
import argparse
31
36
import locale
32
37
import datetime
33
38
import re
34
39
import os
 
40
import collections
 
41
import doctest
 
42
 
 
43
import dbus
 
44
 
 
45
if sys.version_info[0] == 2:
 
46
    str = unicode
35
47
 
36
48
locale.setlocale(locale.LC_ALL, "")
37
49
 
52
64
    "ApprovalDelay": "Approval Delay",
53
65
    "ApprovalDuration": "Approval Duration",
54
66
    "Checker": "Checker",
 
67
    "ExtendedTimeout" : "Extended Timeout"
55
68
    }
56
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
57
 
domain = "se.bsnet.fukt"
 
70
domain = "se.recompile"
58
71
busname = domain + ".Mandos"
59
72
server_path = "/"
60
73
server_interface = domain + ".Mandos"
61
74
client_interface = domain + ".Mandos.Client"
62
 
version = "1.3.0"
 
75
version = "1.6.7"
63
76
 
64
77
def timedelta_to_milliseconds(td):
65
78
    """Convert a datetime.timedelta object to milliseconds"""
69
82
 
70
83
def milliseconds_to_string(ms):
71
84
    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
 
                })
 
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
 
78
191
 
79
192
def string_to_delta(interval):
80
193
    """Parse a string and return a datetime.timedelta
92
205
    >>> string_to_delta("5m 30s")
93
206
    datetime.timedelta(0, 330)
94
207
    """
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
 
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
118
231
 
119
232
def print_clients(clients, keywords):
120
233
    def valuetostring(value, keyword):
121
234
        if type(value) is dbus.Boolean:
122
235
            return "Yes" if value else "No"
123
236
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
 
                       "ApprovalDuration"):
 
237
                       "ApprovalDuration", "ExtendedTimeout"):
125
238
            return milliseconds_to_string(value)
126
 
        return unicode(value)
 
239
        return str(value)
127
240
    
128
241
    # 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)
 
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)
136
249
    # Print header line
137
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
250
    print(format_string.format(**tablewords))
138
251
    for client in clients:
139
 
        print(format_string % tuple(valuetostring(client[key], key)
140
 
                                    for key in keywords))
 
252
        print(format_string.format(**{ key:
 
253
                                           valuetostring(client[key],
 
254
                                                         key)
 
255
                                       for key in keywords }))
141
256
 
142
257
def has_actions(options):
143
258
    return any((options.enable,
149
264
                options.remove,
150
265
                options.checker is not None,
151
266
                options.timeout is not None,
 
267
                options.extended_timeout is not None,
152
268
                options.interval is not None,
153
269
                options.approved_by_default is not None,
154
270
                options.approval_delay is not None,
161
277
def main():
162
278
    parser = argparse.ArgumentParser()
163
279
    parser.add_argument("--version", action="version",
164
 
                        version = "%%prog %s" % version,
 
280
                        version = "%(prog)s {0}".format(version),
165
281
                        help="show version number and exit")
166
282
    parser.add_argument("-a", "--all", action="store_true",
167
283
                        help="Select all clients")
185
301
                        help="Set checker command for client")
186
302
    parser.add_argument("-t", "--timeout",
187
303
                        help="Set timeout for client")
 
304
    parser.add_argument("--extended-timeout",
 
305
                        help="Set extended timeout for client")
188
306
    parser.add_argument("-i", "--interval",
189
307
                        help="Set checker interval for client")
190
308
    parser.add_argument("--approve-by-default", action="store_true",
198
316
    parser.add_argument("--approval-duration",
199
317
                        help="Set duration of one client approval")
200
318
    parser.add_argument("-H", "--host", help="Set host for client")
201
 
    parser.add_argument("-s", "--secret", type=file,
 
319
    parser.add_argument("-s", "--secret",
 
320
                        type=argparse.FileType(mode="rb"),
202
321
                        help="Set password blob (file) for client")
203
322
    parser.add_argument("-A", "--approve", action="store_true",
204
323
                        help="Approve any current client request")
205
324
    parser.add_argument("-D", "--deny", action="store_true",
206
325
                        help="Deny any current client request")
 
326
    parser.add_argument("--check", action="store_true",
 
327
                        help="Run self-test")
207
328
    parser.add_argument("client", nargs="*", help="Client name")
208
329
    options = parser.parse_args()
209
330
    
210
 
    if has_actions(options) and not options.client and not options.all:
 
331
    if has_actions(options) and not (options.client or options.all):
211
332
        parser.error("Options require clients names or --all.")
212
333
    if options.verbose and has_actions(options):
213
334
        parser.error("--verbose can only be used alone or with"
214
335
                     " --all.")
215
336
    if options.all and not has_actions(options):
216
337
        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)
217
342
    
218
343
    try:
219
344
        bus = dbus.SystemBus()
238
363
            #restore stderr
239
364
            os.dup2(stderrcopy, sys.stderr.fileno())
240
365
            os.close(stderrcopy)
241
 
    except dbus.exceptions.DBusException, e:
 
366
    except dbus.exceptions.DBusException:
242
367
        print("Access denied: Accessing mandos server through dbus.",
243
368
              file=sys.stderr)
244
369
        sys.exit(1)
247
372
    clients={}
248
373
    
249
374
    if options.all or not options.client:
250
 
        clients = dict((bus.get_object(busname, path), properties)
251
 
                       for path, properties in
252
 
                       mandos_clients.iteritems())
 
375
        clients = { bus.get_object(busname, path): properties
 
376
                    for path, properties in mandos_clients.items() }
253
377
    else:
254
378
        for name in options.client:
255
 
            for path, client in mandos_clients.iteritems():
 
379
            for path, client in mandos_clients.items():
256
380
                if client["Name"] == name:
257
381
                    client_objc = bus.get_object(busname, path)
258
382
                    clients[client_objc] = client
259
383
                    break
260
384
            else:
261
 
                print("Client not found on server: %r" % name,
262
 
                      file=sys.stderr)
 
385
                print("Client not found on server: {0!r}"
 
386
                      .format(name), file=sys.stderr)
263
387
                sys.exit(1)
264
388
    
265
389
    if not has_actions(options) and clients:
270
394
                        "LastEnabled", "ApprovalPending",
271
395
                        "ApprovedByDefault",
272
396
                        "LastApprovalRequest", "ApprovalDelay",
273
 
                        "ApprovalDuration", "Checker")
 
397
                        "ApprovalDuration", "Checker",
 
398
                        "ExtendedTimeout")
274
399
        else:
275
400
            keywords = defaultkeywords
276
401
        
278
403
    else:
279
404
        # Process each client in the list by all selected options
280
405
        for client in clients:
 
406
            def set_client_prop(prop, value):
 
407
                """Set a Client D-Bus property"""
 
408
                client.Set(client_interface, prop, value,
 
409
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
410
            def set_client_prop_ms(prop, value):
 
411
                """Set a Client D-Bus property, converted
 
412
                from a string to milliseconds."""
 
413
                set_client_prop(prop,
 
414
                                timedelta_to_milliseconds
 
415
                                (string_to_delta(value)))
281
416
            if options.remove:
282
417
                mandos_serv.RemoveClient(client.__dbus_object_path__)
283
418
            if options.enable:
284
 
                client.Enable(dbus_interface=client_interface)
 
419
                set_client_prop("Enabled", dbus.Boolean(True))
285
420
            if options.disable:
286
 
                client.Disable(dbus_interface=client_interface)
 
421
                set_client_prop("Enabled", dbus.Boolean(False))
287
422
            if options.bump_timeout:
288
 
                client.CheckedOK(dbus_interface=client_interface)
 
423
                set_client_prop("LastCheckedOK", "")
289
424
            if options.start_checker:
290
 
                client.StartChecker(dbus_interface=client_interface)
 
425
                set_client_prop("CheckerRunning", dbus.Boolean(True))
291
426
            if options.stop_checker:
292
 
                client.StopChecker(dbus_interface=client_interface)
 
427
                set_client_prop("CheckerRunning", dbus.Boolean(False))
293
428
            if options.is_enabled:
294
429
                sys.exit(0 if client.Get(client_interface,
295
430
                                         "Enabled",
296
431
                                         dbus_interface=
297
432
                                         dbus.PROPERTIES_IFACE)
298
433
                         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)
 
434
            if options.checker is not None:
 
435
                set_client_prop("Checker", options.checker)
 
436
            if options.host is not None:
 
437
                set_client_prop("Host", options.host)
 
438
            if options.interval is not None:
 
439
                set_client_prop_ms("Interval", options.interval)
 
440
            if options.approval_delay is not None:
 
441
                set_client_prop_ms("ApprovalDelay",
 
442
                                   options.approval_delay)
 
443
            if options.approval_duration is not None:
 
444
                set_client_prop_ms("ApprovalDuration",
 
445
                                   options.approval_duration)
 
446
            if options.timeout is not None:
 
447
                set_client_prop_ms("Timeout", options.timeout)
 
448
            if options.extended_timeout is not None:
 
449
                set_client_prop_ms("ExtendedTimeout",
 
450
                                   options.extended_timeout)
 
451
            if options.secret is not None:
 
452
                set_client_prop("Secret",
 
453
                                dbus.ByteArray(options.secret.read()))
333
454
            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)
 
455
                set_client_prop("ApprovedByDefault",
 
456
                                dbus.Boolean(options
 
457
                                             .approved_by_default))
338
458
            if options.approve:
339
459
                client.Approve(dbus.Boolean(True),
340
460
                               dbus_interface=client_interface)