/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-27 07:30:49 UTC
  • Revision ID: teddy@recompile.se-20120527073049-f153zv8otgosqonh
* plugins.d/mandos-client.xml (EXAMPLE): Doc fix: Network interface is
                                         now automatically determined,
                                         not always "eth0".

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
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
28
 
29
 
try:
30
 
    from future_builtins import *
31
 
except ImportError:
32
 
    pass
 
29
from future_builtins import *
33
30
 
34
31
import sys
 
32
import dbus
35
33
import argparse
36
34
import locale
37
35
import datetime
38
36
import re
39
37
import os
40
 
import collections
41
 
import doctest
42
 
 
43
 
import dbus
44
 
 
45
 
if sys.version_info.major == 2:
46
 
    str = unicode
47
38
 
48
39
locale.setlocale(locale.LC_ALL, "")
49
40
 
64
55
    "ApprovalDelay": "Approval Delay",
65
56
    "ApprovalDuration": "Approval Duration",
66
57
    "Checker": "Checker",
67
 
    "ExtendedTimeout": "Extended Timeout"
68
 
}
 
58
    "ExtendedTimeout" : "Extended Timeout"
 
59
    }
69
60
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
61
domain = "se.recompile"
71
62
busname = domain + ".Mandos"
72
63
server_path = "/"
73
64
server_interface = domain + ".Mandos"
74
65
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.9"
 
66
version = "1.5.4"
76
67
 
 
68
def timedelta_to_milliseconds(td):
 
69
    """Convert a datetime.timedelta object to milliseconds"""
 
70
    return ((td.days * 24 * 60 * 60 * 1000)
 
71
            + (td.seconds * 1000)
 
72
            + (td.microseconds // 1000))
77
73
 
78
74
def milliseconds_to_string(ms):
79
75
    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
 
 
 
76
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
77
            .format(days = "{0}T".format(td.days) if td.days else "",
 
78
                    hours = td.seconds // 3600,
 
79
                    minutes = (td.seconds % 3600) // 60,
 
80
                    seconds = td.seconds % 60,
 
81
                    ))
182
82
 
183
83
def string_to_delta(interval):
184
84
    """Parse a string and return a datetime.timedelta
185
85
    
186
 
    >>> string_to_delta('7d')
 
86
    >>> string_to_delta("7d")
187
87
    datetime.timedelta(7)
188
 
    >>> string_to_delta('60s')
 
88
    >>> string_to_delta("60s")
189
89
    datetime.timedelta(0, 60)
190
 
    >>> string_to_delta('60m')
 
90
    >>> string_to_delta("60m")
191
91
    datetime.timedelta(0, 3600)
192
 
    >>> string_to_delta('24h')
 
92
    >>> string_to_delta("24h")
193
93
    datetime.timedelta(1)
194
 
    >>> string_to_delta('1w')
 
94
    >>> string_to_delta("1w")
195
95
    datetime.timedelta(7)
196
 
    >>> string_to_delta('5m 30s')
 
96
    >>> string_to_delta("5m 30s")
197
97
    datetime.timedelta(0, 330)
198
98
    """
199
 
    
200
 
    try:
201
 
        return rfc3339_duration_to_delta(interval)
202
 
    except ValueError:
203
 
        pass
204
 
    
205
99
    value = datetime.timedelta(0)
206
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
100
    regexp = re.compile("(\d+)([dsmhw]?)")
207
101
    
208
102
    for num, suffix in regexp.findall(interval):
209
103
        if suffix == "d":
220
114
            value += datetime.timedelta(0, 0, 0, int(num))
221
115
    return value
222
116
 
223
 
 
224
117
def print_clients(clients, keywords):
225
118
    def valuetostring(value, keyword):
226
119
        if type(value) is dbus.Boolean:
228
121
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
229
122
                       "ApprovalDuration", "ExtendedTimeout"):
230
123
            return milliseconds_to_string(value)
231
 
        return str(value)
 
124
        return unicode(value)
232
125
    
233
126
    # Create format string to print table rows
234
127
    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)
239
 
                             for key in keywords)
 
128
            width = max(len(tablewords[key]),
 
129
                        max(len(valuetostring(client[key],
 
130
                                              key))
 
131
                            for client in
 
132
                            clients)),
 
133
            key = key) for key in keywords)
240
134
    # Print header line
241
135
    print(format_string.format(**tablewords))
242
136
    for client in clients:
243
 
        print(format_string.format(**{
244
 
            key: valuetostring(client[key], key)
245
 
            for key in keywords }))
246
 
 
 
137
        print(format_string.format(**dict((key,
 
138
                                           valuetostring(client[key],
 
139
                                                         key))
 
140
                                          for key in keywords)))
247
141
 
248
142
def has_actions(options):
249
143
    return any((options.enable,
265
159
                options.approve,
266
160
                options.deny))
267
161
 
268
 
 
269
162
def main():
270
163
    parser = argparse.ArgumentParser()
271
164
    parser.add_argument("--version", action="version",
272
 
                        version = "%(prog)s {}".format(version),
 
165
                        version = "%(prog)s {0}".format(version),
273
166
                        help="show version number and exit")
274
167
    parser.add_argument("-a", "--all", action="store_true",
275
168
                        help="Select all clients")
308
201
    parser.add_argument("--approval-duration",
309
202
                        help="Set duration of one client approval")
310
203
    parser.add_argument("-H", "--host", help="Set host for client")
311
 
    parser.add_argument("-s", "--secret",
312
 
                        type=argparse.FileType(mode="rb"),
 
204
    parser.add_argument("-s", "--secret", type=file,
313
205
                        help="Set password blob (file) for client")
314
206
    parser.add_argument("-A", "--approve", action="store_true",
315
207
                        help="Approve any current client request")
316
208
    parser.add_argument("-D", "--deny", action="store_true",
317
209
                        help="Deny any current client request")
318
 
    parser.add_argument("--check", action="store_true",
319
 
                        help="Run self-test")
320
210
    parser.add_argument("client", nargs="*", help="Client name")
321
211
    options = parser.parse_args()
322
212
    
327
217
                     " --all.")
328
218
    if options.all and not has_actions(options):
329
219
        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
220
    
335
221
    try:
336
222
        bus = dbus.SystemBus()
337
223
        mandos_dbus_objc = bus.get_object(busname, server_path)
338
224
    except dbus.exceptions.DBusException:
339
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
225
        print("Could not connect to Mandos server",
 
226
              file=sys.stderr)
340
227
        sys.exit(1)
341
228
    
342
229
    mandos_serv = dbus.Interface(mandos_dbus_objc,
363
250
    clients={}
364
251
    
365
252
    if options.all or not options.client:
366
 
        clients = { bus.get_object(busname, path): properties
367
 
                    for path, properties in mandos_clients.items() }
 
253
        clients = dict((bus.get_object(busname, path), properties)
 
254
                       for path, properties in
 
255
                       mandos_clients.iteritems())
368
256
    else:
369
257
        for name in options.client:
370
 
            for path, client in mandos_clients.items():
 
258
            for path, client in mandos_clients.iteritems():
371
259
                if client["Name"] == name:
372
260
                    client_objc = bus.get_object(busname, path)
373
261
                    clients[client_objc] = client
374
262
                    break
375
263
            else:
376
 
                print("Client not found on server: {!r}"
 
264
                print("Client not found on server: {0!r}"
377
265
                      .format(name), file=sys.stderr)
378
266
                sys.exit(1)
379
267
    
380
268
    if not has_actions(options) and clients:
381
269
        if options.verbose:
382
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
383
 
                        "Created", "Interval", "Host", "Fingerprint",
384
 
                        "CheckerRunning", "LastEnabled",
385
 
                        "ApprovalPending", "ApprovedByDefault",
 
270
            keywords = ("Name", "Enabled", "Timeout",
 
271
                        "LastCheckedOK", "Created", "Interval",
 
272
                        "Host", "Fingerprint", "CheckerRunning",
 
273
                        "LastEnabled", "ApprovalPending",
 
274
                        "ApprovedByDefault",
386
275
                        "LastApprovalRequest", "ApprovalDelay",
387
276
                        "ApprovalDuration", "Checker",
388
277
                        "ExtendedTimeout")
393
282
    else:
394
283
        # Process each client in the list by all selected options
395
284
        for client in clients:
396
 
            
397
285
            def set_client_prop(prop, value):
398
286
                """Set a Client D-Bus property"""
399
287
                client.Set(client_interface, prop, value,
400
288
                           dbus_interface=dbus.PROPERTIES_IFACE)
401
 
            
402
289
            def set_client_prop_ms(prop, value):
403
290
                """Set a Client D-Bus property, converted
404
291
                from a string to milliseconds."""
405
292
                set_client_prop(prop,
406
 
                                string_to_delta(value).total_seconds()
407
 
                                * 1000)
408
 
            
 
293
                                timedelta_to_milliseconds
 
294
                                (string_to_delta(value)))
409
295
            if options.remove:
410
296
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
297
            if options.enable:
455
341
                client.Approve(dbus.Boolean(False),
456
342
                               dbus_interface=client_interface)
457
343
 
458
 
 
459
344
if __name__ == "__main__":
460
345
    main()