/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-02-21 21:27:14 UTC
  • mfrom: (237.6.1 nmu)
  • mto: (237.4.31 release)
  • mto: This revision was merged to the branch mainline in revision 560.
  • Revision ID: teddy@recompile.se-20120221212714-40iub281d4yvrk9r
Tags: version-1.5.3-1.1
Merge NMU change.

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