/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: 2015-05-31 16:13:39 UTC
  • Revision ID: teddy@recompile.se-20150531161339-igb3l0ip3c10ejpz
mandos-ctl: Generate better messages in exceptions.

mandos (rfc3339_duration_to_delta): Remove dead code.  Adjust white
                                    space.
mandos-ctl (rfc3339_duration_to_delta): Do minor formatting and
                                        whitespace adjustments, and
                                        Generate better message in
                                        exception.
(string_to_delta): Adjust quote character in doc string.

Show diffs side-by-side

added added

removed removed

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