/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-06-17 14:55:31 UTC
  • Revision ID: teddy@recompile.se-20120617145531-o24z982oerm6xb6s
* mandos: New "--foreground" option.

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.7.0"
76
 
 
77
 
 
78
 
try:
79
 
    dbus.OBJECT_MANAGER_IFACE
80
 
except AttributeError:
81
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
66
version = "1.5.5"
 
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))
82
73
 
83
74
def milliseconds_to_string(ms):
84
75
    td = datetime.timedelta(0, 0, 0, ms)
85
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
86
 
        days = "{}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
 
def rfc3339_duration_to_delta(duration):
93
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
94
 
    
95
 
    >>> rfc3339_duration_to_delta("P7D")
96
 
    datetime.timedelta(7)
97
 
    >>> rfc3339_duration_to_delta("PT60S")
98
 
    datetime.timedelta(0, 60)
99
 
    >>> rfc3339_duration_to_delta("PT60M")
100
 
    datetime.timedelta(0, 3600)
101
 
    >>> rfc3339_duration_to_delta("PT24H")
102
 
    datetime.timedelta(1)
103
 
    >>> rfc3339_duration_to_delta("P1W")
104
 
    datetime.timedelta(7)
105
 
    >>> rfc3339_duration_to_delta("PT5M30S")
106
 
    datetime.timedelta(0, 330)
107
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
108
 
    datetime.timedelta(1, 200)
109
 
    """
110
 
    
111
 
    # Parsing an RFC 3339 duration with regular expressions is not
112
 
    # possible - there would have to be multiple places for the same
113
 
    # values, like seconds.  The current code, while more esoteric, is
114
 
    # cleaner without depending on a parsing library.  If Python had a
115
 
    # built-in library for parsing we would use it, but we'd like to
116
 
    # avoid excessive use of external libraries.
117
 
    
118
 
    # New type for defining tokens, syntax, and semantics all-in-one
119
 
    Token = collections.namedtuple("Token", (
120
 
        "regexp",  # To match token; if "value" is not None, must have
121
 
                   # a "group" containing digits
122
 
        "value",   # datetime.timedelta or None
123
 
        "followers"))           # Tokens valid after this token
124
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
125
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
126
 
    token_end = Token(re.compile(r"$"), None, frozenset())
127
 
    token_second = Token(re.compile(r"(\d+)S"),
128
 
                         datetime.timedelta(seconds=1),
129
 
                         frozenset((token_end, )))
130
 
    token_minute = Token(re.compile(r"(\d+)M"),
131
 
                         datetime.timedelta(minutes=1),
132
 
                         frozenset((token_second, token_end)))
133
 
    token_hour = Token(re.compile(r"(\d+)H"),
134
 
                       datetime.timedelta(hours=1),
135
 
                       frozenset((token_minute, token_end)))
136
 
    token_time = Token(re.compile(r"T"),
137
 
                       None,
138
 
                       frozenset((token_hour, token_minute,
139
 
                                  token_second)))
140
 
    token_day = Token(re.compile(r"(\d+)D"),
141
 
                      datetime.timedelta(days=1),
142
 
                      frozenset((token_time, token_end)))
143
 
    token_month = Token(re.compile(r"(\d+)M"),
144
 
                        datetime.timedelta(weeks=4),
145
 
                        frozenset((token_day, token_end)))
146
 
    token_year = Token(re.compile(r"(\d+)Y"),
147
 
                       datetime.timedelta(weeks=52),
148
 
                       frozenset((token_month, token_end)))
149
 
    token_week = Token(re.compile(r"(\d+)W"),
150
 
                       datetime.timedelta(weeks=1),
151
 
                       frozenset((token_end, )))
152
 
    token_duration = Token(re.compile(r"P"), None,
153
 
                           frozenset((token_year, token_month,
154
 
                                      token_day, token_time,
155
 
                                      token_week)))
156
 
    # Define starting values
157
 
    value = datetime.timedelta() # Value so far
158
 
    found_token = None
159
 
    followers = frozenset((token_duration, )) # Following valid tokens
160
 
    s = duration                # String left to parse
161
 
    # Loop until end token is found
162
 
    while found_token is not token_end:
163
 
        # Search for any currently valid tokens
164
 
        for token in followers:
165
 
            match = token.regexp.match(s)
166
 
            if match is not None:
167
 
                # Token found
168
 
                if token.value is not None:
169
 
                    # Value found, parse digits
170
 
                    factor = int(match.group(1), 10)
171
 
                    # Add to value so far
172
 
                    value += factor * token.value
173
 
                # Strip token from string
174
 
                s = token.regexp.sub("", s, 1)
175
 
                # Go to found token
176
 
                found_token = token
177
 
                # Set valid next tokens
178
 
                followers = found_token.followers
179
 
                break
180
 
        else:
181
 
            # No currently valid tokens were found
182
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
183
 
                             .format(duration))
184
 
    # End token found
185
 
    return value
186
 
 
 
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
                    ))
187
82
 
188
83
def string_to_delta(interval):
189
84
    """Parse a string and return a datetime.timedelta
190
85
    
191
 
    >>> string_to_delta('7d')
 
86
    >>> string_to_delta("7d")
192
87
    datetime.timedelta(7)
193
 
    >>> string_to_delta('60s')
 
88
    >>> string_to_delta("60s")
194
89
    datetime.timedelta(0, 60)
195
 
    >>> string_to_delta('60m')
 
90
    >>> string_to_delta("60m")
196
91
    datetime.timedelta(0, 3600)
197
 
    >>> string_to_delta('24h')
 
92
    >>> string_to_delta("24h")
198
93
    datetime.timedelta(1)
199
 
    >>> string_to_delta('1w')
 
94
    >>> string_to_delta("1w")
200
95
    datetime.timedelta(7)
201
 
    >>> string_to_delta('5m 30s')
 
96
    >>> string_to_delta("5m 30s")
202
97
    datetime.timedelta(0, 330)
203
98
    """
204
 
    
205
 
    try:
206
 
        return rfc3339_duration_to_delta(interval)
207
 
    except ValueError:
208
 
        pass
209
 
    
210
99
    value = datetime.timedelta(0)
211
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
100
    regexp = re.compile("(\d+)([dsmhw]?)")
212
101
    
213
102
    for num, suffix in regexp.findall(interval):
214
103
        if suffix == "d":
225
114
            value += datetime.timedelta(0, 0, 0, int(num))
226
115
    return value
227
116
 
228
 
 
229
117
def print_clients(clients, keywords):
230
118
    def valuetostring(value, keyword):
231
119
        if type(value) is dbus.Boolean:
233
121
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
234
122
                       "ApprovalDuration", "ExtendedTimeout"):
235
123
            return milliseconds_to_string(value)
236
 
        return str(value)
 
124
        return unicode(value)
237
125
    
238
126
    # Create format string to print table rows
239
127
    format_string = " ".join("{{{key}:{width}}}".format(
240
 
        width = max(len(tablewords[key]),
241
 
                    max(len(valuetostring(client[key], key))
242
 
                        for client in clients)),
243
 
        key = key)
244
 
                             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)
245
134
    # Print header line
246
135
    print(format_string.format(**tablewords))
247
136
    for client in clients:
248
 
        print(format_string.format(**{
249
 
            key: valuetostring(client[key], key)
250
 
            for key in keywords }))
251
 
 
 
137
        print(format_string.format(**dict((key,
 
138
                                           valuetostring(client[key],
 
139
                                                         key))
 
140
                                          for key in keywords)))
252
141
 
253
142
def has_actions(options):
254
143
    return any((options.enable,
270
159
                options.approve,
271
160
                options.deny))
272
161
 
273
 
 
274
162
def main():
275
163
    parser = argparse.ArgumentParser()
276
164
    parser.add_argument("--version", action="version",
277
 
                        version = "%(prog)s {}".format(version),
 
165
                        version = "%(prog)s {0}".format(version),
278
166
                        help="show version number and exit")
279
167
    parser.add_argument("-a", "--all", action="store_true",
280
168
                        help="Select all clients")
313
201
    parser.add_argument("--approval-duration",
314
202
                        help="Set duration of one client approval")
315
203
    parser.add_argument("-H", "--host", help="Set host for client")
316
 
    parser.add_argument("-s", "--secret",
317
 
                        type=argparse.FileType(mode="rb"),
 
204
    parser.add_argument("-s", "--secret", type=file,
318
205
                        help="Set password blob (file) for client")
319
206
    parser.add_argument("-A", "--approve", action="store_true",
320
207
                        help="Approve any current client request")
321
208
    parser.add_argument("-D", "--deny", action="store_true",
322
209
                        help="Deny any current client request")
323
 
    parser.add_argument("--check", action="store_true",
324
 
                        help="Run self-test")
325
210
    parser.add_argument("client", nargs="*", help="Client name")
326
211
    options = parser.parse_args()
327
212
    
332
217
                     " --all.")
333
218
    if options.all and not has_actions(options):
334
219
        parser.error("--all requires an action.")
335
 
 
336
 
    if options.check:
337
 
        fail_count, test_count = doctest.testmod()
338
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
339
220
    
340
221
    try:
341
222
        bus = dbus.SystemBus()
342
223
        mandos_dbus_objc = bus.get_object(busname, server_path)
343
224
    except dbus.exceptions.DBusException:
344
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
225
        print("Could not connect to Mandos server",
 
226
              file=sys.stderr)
345
227
        sys.exit(1)
346
228
    
347
229
    mandos_serv = dbus.Interface(mandos_dbus_objc,
348
230
                                 dbus_interface = server_interface)
349
 
    mandos_serv_object_manager = dbus.Interface(
350
 
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
351
231
    
352
232
    #block stderr since dbus library prints to stderr
353
233
    null = os.open(os.path.devnull, os.O_RDWR)
356
236
    os.close(null)
357
237
    try:
358
238
        try:
359
 
            mandos_clients = { path: ifs_and_props[client_interface]
360
 
                               for path, ifs_and_props in
361
 
                               mandos_serv_object_manager
362
 
                               .GetManagedObjects().items()
363
 
                               if client_interface in ifs_and_props }
 
239
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
364
240
        finally:
365
241
            #restore stderr
366
242
            os.dup2(stderrcopy, sys.stderr.fileno())
367
243
            os.close(stderrcopy)
368
 
    except dbus.exceptions.DBusException as e:
369
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
370
 
              .format(e), file=sys.stderr)
 
244
    except dbus.exceptions.DBusException:
 
245
        print("Access denied: Accessing mandos server through dbus.",
 
246
              file=sys.stderr)
371
247
        sys.exit(1)
372
248
    
373
249
    # Compile dict of (clients: properties) to process
374
250
    clients={}
375
251
    
376
252
    if options.all or not options.client:
377
 
        clients = { bus.get_object(busname, path): properties
378
 
                    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())
379
256
    else:
380
257
        for name in options.client:
381
 
            for path, client in mandos_clients.items():
 
258
            for path, client in mandos_clients.iteritems():
382
259
                if client["Name"] == name:
383
260
                    client_objc = bus.get_object(busname, path)
384
261
                    clients[client_objc] = client
385
262
                    break
386
263
            else:
387
 
                print("Client not found on server: {!r}"
 
264
                print("Client not found on server: {0!r}"
388
265
                      .format(name), file=sys.stderr)
389
266
                sys.exit(1)
390
267
    
391
268
    if not has_actions(options) and clients:
392
269
        if options.verbose:
393
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
 
                        "Created", "Interval", "Host", "Fingerprint",
395
 
                        "CheckerRunning", "LastEnabled",
396
 
                        "ApprovalPending", "ApprovedByDefault",
 
270
            keywords = ("Name", "Enabled", "Timeout",
 
271
                        "LastCheckedOK", "Created", "Interval",
 
272
                        "Host", "Fingerprint", "CheckerRunning",
 
273
                        "LastEnabled", "ApprovalPending",
 
274
                        "ApprovedByDefault",
397
275
                        "LastApprovalRequest", "ApprovalDelay",
398
276
                        "ApprovalDuration", "Checker",
399
277
                        "ExtendedTimeout")
404
282
    else:
405
283
        # Process each client in the list by all selected options
406
284
        for client in clients:
407
 
            
408
285
            def set_client_prop(prop, value):
409
286
                """Set a Client D-Bus property"""
410
287
                client.Set(client_interface, prop, value,
411
288
                           dbus_interface=dbus.PROPERTIES_IFACE)
412
 
            
413
289
            def set_client_prop_ms(prop, value):
414
290
                """Set a Client D-Bus property, converted
415
291
                from a string to milliseconds."""
416
292
                set_client_prop(prop,
417
 
                                string_to_delta(value).total_seconds()
418
 
                                * 1000)
419
 
            
 
293
                                timedelta_to_milliseconds
 
294
                                (string_to_delta(value)))
420
295
            if options.remove:
421
296
                mandos_serv.RemoveClient(client.__dbus_object_path__)
422
297
            if options.enable:
466
341
                client.Approve(dbus.Boolean(False),
467
342
                               dbus_interface=client_interface)
468
343
 
469
 
 
470
344
if __name__ == "__main__":
471
345
    main()