/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-22 23:33:56 UTC
  • Revision ID: teddy@recompile.se-20120622233356-odoqqt2ki2gssn37
* Makefile (check): Also check mandos-ctl.
* mandos-ctl: All options taking a time interval argument can now take
              an RFC 3339 duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
  (main): New "--check" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new "--check" 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-2016 Teddy Hogeborn
7
 
# Copyright © 2008-2016 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
35
32
import argparse
42
39
 
43
40
import dbus
44
41
 
45
 
if sys.version_info.major == 2:
46
 
    str = unicode
47
 
 
48
42
locale.setlocale(locale.LC_ALL, "")
49
43
 
50
44
tablewords = {
64
58
    "ApprovalDelay": "Approval Delay",
65
59
    "ApprovalDuration": "Approval Duration",
66
60
    "Checker": "Checker",
67
 
    "ExtendedTimeout": "Extended Timeout"
68
 
}
 
61
    "ExtendedTimeout" : "Extended Timeout"
 
62
    }
69
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
64
domain = "se.recompile"
71
65
busname = domain + ".Mandos"
72
66
server_path = "/"
73
67
server_interface = domain + ".Mandos"
74
68
client_interface = domain + ".Mandos.Client"
75
 
version = "1.7.5"
76
 
 
77
 
 
78
 
try:
79
 
    dbus.OBJECT_MANAGER_IFACE
80
 
except AttributeError:
81
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
69
version = "1.6.0"
 
70
 
 
71
def timedelta_to_milliseconds(td):
 
72
    """Convert a datetime.timedelta object to milliseconds"""
 
73
    return ((td.days * 24 * 60 * 60 * 1000)
 
74
            + (td.seconds * 1000)
 
75
            + (td.microseconds // 1000))
82
76
 
83
77
def milliseconds_to_string(ms):
84
78
    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))
 
79
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
80
            .format(days = "{0}T".format(td.days) if td.days else "",
 
81
                    hours = td.seconds // 3600,
 
82
                    minutes = (td.seconds % 3600) // 60,
 
83
                    seconds = td.seconds % 60,
 
84
                    ))
90
85
 
91
86
 
92
87
def rfc3339_duration_to_delta(duration):
93
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
88
    """Parse a RFC 3339 "duration" and return a datetime.timedelta
94
89
    
95
90
    >>> rfc3339_duration_to_delta("P7D")
96
91
    datetime.timedelta(7)
108
103
    datetime.timedelta(1, 200)
109
104
    """
110
105
    
111
 
    # Parsing an RFC 3339 duration with regular expressions is not
 
106
    # Parsing a RFC 3339 duration with regular expressions is not
112
107
    # 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
 
108
    # values, like seconds.  This, while more esoteric, is cleaner
 
109
    # without depending on a parsing library.  If Python had a
115
110
    # built-in library for parsing we would use it, but we'd like to
116
111
    # avoid excessive use of external libraries.
117
112
    
118
113
    # 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
 
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
124
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
125
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
126
125
    token_end = Token(re.compile(r"$"), None, frozenset())
127
126
    token_second = Token(re.compile(r"(\d+)S"),
128
127
                         datetime.timedelta(seconds=1),
129
 
                         frozenset((token_end, )))
 
128
                         frozenset((token_end,)))
130
129
    token_minute = Token(re.compile(r"(\d+)M"),
131
130
                         datetime.timedelta(minutes=1),
132
131
                         frozenset((token_second, token_end)))
148
147
                       frozenset((token_month, token_end)))
149
148
    token_week = Token(re.compile(r"(\d+)W"),
150
149
                       datetime.timedelta(weeks=1),
151
 
                       frozenset((token_end, )))
 
150
                       frozenset((token_end,)))
152
151
    token_duration = Token(re.compile(r"P"), None,
153
152
                           frozenset((token_year, token_month,
154
153
                                      token_day, token_time,
155
 
                                      token_week)))
 
154
                                      token_week))),
156
155
    # Define starting values
157
156
    value = datetime.timedelta() # Value so far
158
157
    found_token = None
159
 
    followers = frozenset((token_duration, )) # Following valid tokens
 
158
    followers = frozenset(token_duration,) # Following valid tokens
160
159
    s = duration                # String left to parse
161
160
    # Loop until end token is found
162
161
    while found_token is not token_end:
179
178
                break
180
179
        else:
181
180
            # No currently valid tokens were found
182
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
183
 
                             .format(duration))
 
181
            raise ValueError("Invalid RFC 3339 duration")
184
182
    # End token found
185
183
    return value
186
184
 
188
186
def string_to_delta(interval):
189
187
    """Parse a string and return a datetime.timedelta
190
188
    
191
 
    >>> string_to_delta('7d')
 
189
    >>> string_to_delta("7d")
192
190
    datetime.timedelta(7)
193
 
    >>> string_to_delta('60s')
 
191
    >>> string_to_delta("60s")
194
192
    datetime.timedelta(0, 60)
195
 
    >>> string_to_delta('60m')
 
193
    >>> string_to_delta("60m")
196
194
    datetime.timedelta(0, 3600)
197
 
    >>> string_to_delta('24h')
 
195
    >>> string_to_delta("24h")
198
196
    datetime.timedelta(1)
199
 
    >>> string_to_delta('1w')
 
197
    >>> string_to_delta("1w")
200
198
    datetime.timedelta(7)
201
 
    >>> string_to_delta('5m 30s')
 
199
    >>> string_to_delta("5m 30s")
202
200
    datetime.timedelta(0, 330)
203
201
    """
 
202
    value = datetime.timedelta(0)
 
203
    regexp = re.compile(r"(\d+)([dsmhw]?)")
204
204
    
205
205
    try:
206
206
        return rfc3339_duration_to_delta(interval)
207
207
    except ValueError:
208
208
        pass
209
209
    
210
 
    value = datetime.timedelta(0)
211
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
212
 
    
213
210
    for num, suffix in regexp.findall(interval):
214
211
        if suffix == "d":
215
212
            value += datetime.timedelta(int(num))
225
222
            value += datetime.timedelta(0, 0, 0, int(num))
226
223
    return value
227
224
 
228
 
 
229
225
def print_clients(clients, keywords):
230
226
    def valuetostring(value, keyword):
231
227
        if type(value) is dbus.Boolean:
233
229
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
234
230
                       "ApprovalDuration", "ExtendedTimeout"):
235
231
            return milliseconds_to_string(value)
236
 
        return str(value)
 
232
        return unicode(value)
237
233
    
238
234
    # Create format string to print table rows
239
235
    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)
 
236
            width = max(len(tablewords[key]),
 
237
                        max(len(valuetostring(client[key],
 
238
                                              key))
 
239
                            for client in
 
240
                            clients)),
 
241
            key = key) for key in keywords)
245
242
    # Print header line
246
243
    print(format_string.format(**tablewords))
247
244
    for client in clients:
248
 
        print(format_string.format(**{
249
 
            key: valuetostring(client[key], key)
250
 
            for key in keywords }))
251
 
 
 
245
        print(format_string.format(**dict((key,
 
246
                                           valuetostring(client[key],
 
247
                                                         key))
 
248
                                          for key in keywords)))
252
249
 
253
250
def has_actions(options):
254
251
    return any((options.enable,
270
267
                options.approve,
271
268
                options.deny))
272
269
 
273
 
 
274
270
def main():
275
271
    parser = argparse.ArgumentParser()
276
272
    parser.add_argument("--version", action="version",
277
 
                        version = "%(prog)s {}".format(version),
 
273
                        version = "%(prog)s {0}".format(version),
278
274
                        help="show version number and exit")
279
275
    parser.add_argument("-a", "--all", action="store_true",
280
276
                        help="Select all clients")
313
309
    parser.add_argument("--approval-duration",
314
310
                        help="Set duration of one client approval")
315
311
    parser.add_argument("-H", "--host", help="Set host for client")
316
 
    parser.add_argument("-s", "--secret",
317
 
                        type=argparse.FileType(mode="rb"),
 
312
    parser.add_argument("-s", "--secret", type=file,
318
313
                        help="Set password blob (file) for client")
319
314
    parser.add_argument("-A", "--approve", action="store_true",
320
315
                        help="Approve any current client request")
335
330
 
336
331
    if options.check:
337
332
        fail_count, test_count = doctest.testmod()
338
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
333
        sys.exit(0 if fail_count == 0 else 1)
339
334
    
340
335
    try:
341
336
        bus = dbus.SystemBus()
342
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
343
338
    except dbus.exceptions.DBusException:
344
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
339
        print("Could not connect to Mandos server",
 
340
              file=sys.stderr)
345
341
        sys.exit(1)
346
342
    
347
343
    mandos_serv = dbus.Interface(mandos_dbus_objc,
348
344
                                 dbus_interface = server_interface)
349
 
    mandos_serv_object_manager = dbus.Interface(
350
 
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
351
345
    
352
346
    #block stderr since dbus library prints to stderr
353
347
    null = os.open(os.path.devnull, os.O_RDWR)
356
350
    os.close(null)
357
351
    try:
358
352
        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 }
 
353
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
364
354
        finally:
365
355
            #restore stderr
366
356
            os.dup2(stderrcopy, sys.stderr.fileno())
367
357
            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)
 
358
    except dbus.exceptions.DBusException:
 
359
        print("Access denied: Accessing mandos server through dbus.",
 
360
              file=sys.stderr)
371
361
        sys.exit(1)
372
362
    
373
363
    # Compile dict of (clients: properties) to process
374
364
    clients={}
375
365
    
376
366
    if options.all or not options.client:
377
 
        clients = { bus.get_object(busname, path): properties
378
 
                    for path, properties in mandos_clients.items() }
 
367
        clients = dict((bus.get_object(busname, path), properties)
 
368
                       for path, properties in
 
369
                       mandos_clients.iteritems())
379
370
    else:
380
371
        for name in options.client:
381
 
            for path, client in mandos_clients.items():
 
372
            for path, client in mandos_clients.iteritems():
382
373
                if client["Name"] == name:
383
374
                    client_objc = bus.get_object(busname, path)
384
375
                    clients[client_objc] = client
385
376
                    break
386
377
            else:
387
 
                print("Client not found on server: {!r}"
 
378
                print("Client not found on server: {0!r}"
388
379
                      .format(name), file=sys.stderr)
389
380
                sys.exit(1)
390
381
    
391
382
    if not has_actions(options) and clients:
392
383
        if options.verbose:
393
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
 
                        "Created", "Interval", "Host", "Fingerprint",
395
 
                        "CheckerRunning", "LastEnabled",
396
 
                        "ApprovalPending", "ApprovedByDefault",
 
384
            keywords = ("Name", "Enabled", "Timeout",
 
385
                        "LastCheckedOK", "Created", "Interval",
 
386
                        "Host", "Fingerprint", "CheckerRunning",
 
387
                        "LastEnabled", "ApprovalPending",
 
388
                        "ApprovedByDefault",
397
389
                        "LastApprovalRequest", "ApprovalDelay",
398
390
                        "ApprovalDuration", "Checker",
399
391
                        "ExtendedTimeout")
404
396
    else:
405
397
        # Process each client in the list by all selected options
406
398
        for client in clients:
407
 
            
408
399
            def set_client_prop(prop, value):
409
400
                """Set a Client D-Bus property"""
410
401
                client.Set(client_interface, prop, value,
411
402
                           dbus_interface=dbus.PROPERTIES_IFACE)
412
 
            
413
403
            def set_client_prop_ms(prop, value):
414
404
                """Set a Client D-Bus property, converted
415
405
                from a string to milliseconds."""
416
406
                set_client_prop(prop,
417
 
                                string_to_delta(value).total_seconds()
418
 
                                * 1000)
419
 
            
 
407
                                timedelta_to_milliseconds
 
408
                                (string_to_delta(value)))
420
409
            if options.remove:
421
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
422
411
            if options.enable:
466
455
                client.Approve(dbus.Boolean(False),
467
456
                               dbus_interface=client_interface)
468
457
 
469
 
 
470
458
if __name__ == "__main__":
471
459
    main()