/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

* mandos: Change comment.
* mandos-clients.conf.xml (OPTIONS/checker): Rewrote without "you".
  (SEE ALSO): Reference fping(8).

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
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
 
 
 
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
                    ))
185
82
 
186
83
def string_to_delta(interval):
187
84
    """Parse a string and return a datetime.timedelta
199
96
    >>> string_to_delta("5m 30s")
200
97
    datetime.timedelta(0, 330)
201
98
    """
202
 
    
203
 
    try:
204
 
        return rfc3339_duration_to_delta(interval)
205
 
    except ValueError:
206
 
        pass
207
 
    
208
99
    value = datetime.timedelta(0)
209
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
100
    regexp = re.compile("(\d+)([dsmhw]?)")
210
101
    
211
102
    for num, suffix in regexp.findall(interval):
212
103
        if suffix == "d":
223
114
            value += datetime.timedelta(0, 0, 0, int(num))
224
115
    return value
225
116
 
226
 
 
227
117
def print_clients(clients, keywords):
228
118
    def valuetostring(value, keyword):
229
119
        if type(value) is dbus.Boolean:
231
121
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
232
122
                       "ApprovalDuration", "ExtendedTimeout"):
233
123
            return milliseconds_to_string(value)
234
 
        return str(value)
 
124
        return unicode(value)
235
125
    
236
126
    # Create format string to print table rows
237
127
    format_string = " ".join("{{{key}:{width}}}".format(
238
 
        width = max(len(tablewords[key]),
239
 
                    max(len(valuetostring(client[key], key))
240
 
                        for client in clients)),
241
 
        key = key)
242
 
                             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)
243
134
    # Print header line
244
135
    print(format_string.format(**tablewords))
245
136
    for client in clients:
246
 
        print(format_string.format(**{
247
 
            key: valuetostring(client[key], key)
248
 
            for key in keywords }))
249
 
 
 
137
        print(format_string.format(**dict((key,
 
138
                                           valuetostring(client[key],
 
139
                                                         key))
 
140
                                          for key in keywords)))
250
141
 
251
142
def has_actions(options):
252
143
    return any((options.enable,
268
159
                options.approve,
269
160
                options.deny))
270
161
 
271
 
 
272
162
def main():
273
163
    parser = argparse.ArgumentParser()
274
164
    parser.add_argument("--version", action="version",
275
 
                        version = "%(prog)s {}".format(version),
 
165
                        version = "%(prog)s {0}".format(version),
276
166
                        help="show version number and exit")
277
167
    parser.add_argument("-a", "--all", action="store_true",
278
168
                        help="Select all clients")
311
201
    parser.add_argument("--approval-duration",
312
202
                        help="Set duration of one client approval")
313
203
    parser.add_argument("-H", "--host", help="Set host for client")
314
 
    parser.add_argument("-s", "--secret",
315
 
                        type=argparse.FileType(mode="rb"),
 
204
    parser.add_argument("-s", "--secret", type=file,
316
205
                        help="Set password blob (file) for client")
317
206
    parser.add_argument("-A", "--approve", action="store_true",
318
207
                        help="Approve any current client request")
319
208
    parser.add_argument("-D", "--deny", action="store_true",
320
209
                        help="Deny any current client request")
321
 
    parser.add_argument("--check", action="store_true",
322
 
                        help="Run self-test")
323
210
    parser.add_argument("client", nargs="*", help="Client name")
324
211
    options = parser.parse_args()
325
212
    
330
217
                     " --all.")
331
218
    if options.all and not has_actions(options):
332
219
        parser.error("--all requires an action.")
333
 
 
334
 
    if options.check:
335
 
        fail_count, test_count = doctest.testmod()
336
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
337
220
    
338
221
    try:
339
222
        bus = dbus.SystemBus()
340
223
        mandos_dbus_objc = bus.get_object(busname, server_path)
341
224
    except dbus.exceptions.DBusException:
342
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
225
        print("Could not connect to Mandos server",
 
226
              file=sys.stderr)
343
227
        sys.exit(1)
344
228
    
345
229
    mandos_serv = dbus.Interface(mandos_dbus_objc,
366
250
    clients={}
367
251
    
368
252
    if options.all or not options.client:
369
 
        clients = { bus.get_object(busname, path): properties
370
 
                    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())
371
256
    else:
372
257
        for name in options.client:
373
 
            for path, client in mandos_clients.items():
 
258
            for path, client in mandos_clients.iteritems():
374
259
                if client["Name"] == name:
375
260
                    client_objc = bus.get_object(busname, path)
376
261
                    clients[client_objc] = client
377
262
                    break
378
263
            else:
379
 
                print("Client not found on server: {!r}"
 
264
                print("Client not found on server: {0!r}"
380
265
                      .format(name), file=sys.stderr)
381
266
                sys.exit(1)
382
267
    
383
268
    if not has_actions(options) and clients:
384
269
        if options.verbose:
385
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
386
 
                        "Created", "Interval", "Host", "Fingerprint",
387
 
                        "CheckerRunning", "LastEnabled",
388
 
                        "ApprovalPending", "ApprovedByDefault",
 
270
            keywords = ("Name", "Enabled", "Timeout",
 
271
                        "LastCheckedOK", "Created", "Interval",
 
272
                        "Host", "Fingerprint", "CheckerRunning",
 
273
                        "LastEnabled", "ApprovalPending",
 
274
                        "ApprovedByDefault",
389
275
                        "LastApprovalRequest", "ApprovalDelay",
390
276
                        "ApprovalDuration", "Checker",
391
277
                        "ExtendedTimeout")
396
282
    else:
397
283
        # Process each client in the list by all selected options
398
284
        for client in clients:
399
 
            
400
285
            def set_client_prop(prop, value):
401
286
                """Set a Client D-Bus property"""
402
287
                client.Set(client_interface, prop, value,
403
288
                           dbus_interface=dbus.PROPERTIES_IFACE)
404
 
            
405
289
            def set_client_prop_ms(prop, value):
406
290
                """Set a Client D-Bus property, converted
407
291
                from a string to milliseconds."""
408
292
                set_client_prop(prop,
409
 
                                string_to_delta(value).total_seconds()
410
 
                                * 1000)
411
 
            
 
293
                                timedelta_to_milliseconds
 
294
                                (string_to_delta(value)))
412
295
            if options.remove:
413
296
                mandos_serv.RemoveClient(client.__dbus_object_path__)
414
297
            if options.enable:
458
341
                client.Approve(dbus.Boolean(False),
459
342
                               dbus_interface=client_interface)
460
343
 
461
 
 
462
344
if __name__ == "__main__":
463
345
    main()