/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-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

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
39
36
import os
40
37
import collections
41
38
import doctest
42
 
import json
43
39
 
44
40
import dbus
45
41
 
46
 
if sys.version_info.major == 2:
47
 
    str = unicode
48
 
 
49
42
locale.setlocale(locale.LC_ALL, "")
50
43
 
51
44
tablewords = {
65
58
    "ApprovalDelay": "Approval Delay",
66
59
    "ApprovalDuration": "Approval Duration",
67
60
    "Checker": "Checker",
68
 
    "ExtendedTimeout": "Extended Timeout"
69
 
}
 
61
    "ExtendedTimeout" : "Extended Timeout"
 
62
    }
70
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
71
64
domain = "se.recompile"
72
65
busname = domain + ".Mandos"
73
66
server_path = "/"
74
67
server_interface = domain + ".Mandos"
75
68
client_interface = domain + ".Mandos.Client"
76
 
version = "1.7.10"
77
 
 
78
 
 
79
 
try:
80
 
    dbus.OBJECT_MANAGER_IFACE
81
 
except AttributeError:
82
 
    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))
83
76
 
84
77
def milliseconds_to_string(ms):
85
78
    td = datetime.timedelta(0, 0, 0, ms)
86
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
87
 
        days = "{}T".format(td.days) if td.days else "",
88
 
        hours = td.seconds // 3600,
89
 
        minutes = (td.seconds % 3600) // 60,
90
 
        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
                    ))
91
85
 
92
86
 
93
87
def rfc3339_duration_to_delta(duration):
117
111
    # avoid excessive use of external libraries.
118
112
    
119
113
    # New type for defining tokens, syntax, and semantics all-in-one
120
 
    Token = collections.namedtuple("Token", (
121
 
        "regexp",  # To match token; if "value" is not None, must have
122
 
                   # a "group" containing digits
123
 
        "value",   # datetime.timedelta or None
124
 
        "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
125
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
126
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
127
125
    token_end = Token(re.compile(r"$"), None, frozenset())
128
126
    token_second = Token(re.compile(r"(\d+)S"),
129
127
                         datetime.timedelta(seconds=1),
130
 
                         frozenset((token_end, )))
 
128
                         frozenset((token_end,)))
131
129
    token_minute = Token(re.compile(r"(\d+)M"),
132
130
                         datetime.timedelta(minutes=1),
133
131
                         frozenset((token_second, token_end)))
149
147
                       frozenset((token_month, token_end)))
150
148
    token_week = Token(re.compile(r"(\d+)W"),
151
149
                       datetime.timedelta(weeks=1),
152
 
                       frozenset((token_end, )))
 
150
                       frozenset((token_end,)))
153
151
    token_duration = Token(re.compile(r"P"), None,
154
152
                           frozenset((token_year, token_month,
155
153
                                      token_day, token_time,
156
 
                                      token_week)))
 
154
                                      token_week))),
157
155
    # Define starting values
158
156
    value = datetime.timedelta() # Value so far
159
157
    found_token = None
160
 
    followers = frozenset((token_duration, )) # Following valid tokens
 
158
    followers = frozenset(token_duration,) # Following valid tokens
161
159
    s = duration                # String left to parse
162
160
    # Loop until end token is found
163
161
    while found_token is not token_end:
180
178
                break
181
179
        else:
182
180
            # No currently valid tokens were found
183
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
184
 
                             .format(duration))
 
181
            raise ValueError("Invalid RFC 3339 duration")
185
182
    # End token found
186
183
    return value
187
184
 
189
186
def string_to_delta(interval):
190
187
    """Parse a string and return a datetime.timedelta
191
188
    
192
 
    >>> string_to_delta('7d')
 
189
    >>> string_to_delta("7d")
193
190
    datetime.timedelta(7)
194
 
    >>> string_to_delta('60s')
 
191
    >>> string_to_delta("60s")
195
192
    datetime.timedelta(0, 60)
196
 
    >>> string_to_delta('60m')
 
193
    >>> string_to_delta("60m")
197
194
    datetime.timedelta(0, 3600)
198
 
    >>> string_to_delta('24h')
 
195
    >>> string_to_delta("24h")
199
196
    datetime.timedelta(1)
200
 
    >>> string_to_delta('1w')
 
197
    >>> string_to_delta("1w")
201
198
    datetime.timedelta(7)
202
 
    >>> string_to_delta('5m 30s')
 
199
    >>> string_to_delta("5m 30s")
203
200
    datetime.timedelta(0, 330)
204
201
    """
 
202
    value = datetime.timedelta(0)
 
203
    regexp = re.compile(r"(\d+)([dsmhw]?)")
205
204
    
206
205
    try:
207
206
        return rfc3339_duration_to_delta(interval)
208
207
    except ValueError:
209
208
        pass
210
209
    
211
 
    value = datetime.timedelta(0)
212
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
213
 
    
214
210
    for num, suffix in regexp.findall(interval):
215
211
        if suffix == "d":
216
212
            value += datetime.timedelta(int(num))
226
222
            value += datetime.timedelta(0, 0, 0, int(num))
227
223
    return value
228
224
 
229
 
 
230
225
def print_clients(clients, keywords):
231
226
    def valuetostring(value, keyword):
232
227
        if type(value) is dbus.Boolean:
234
229
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
235
230
                       "ApprovalDuration", "ExtendedTimeout"):
236
231
            return milliseconds_to_string(value)
237
 
        return str(value)
 
232
        return unicode(value)
238
233
    
239
234
    # Create format string to print table rows
240
235
    format_string = " ".join("{{{key}:{width}}}".format(
241
 
        width = max(len(tablewords[key]),
242
 
                    max(len(valuetostring(client[key], key))
243
 
                        for client in clients)),
244
 
        key = key)
245
 
                             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)
246
242
    # Print header line
247
243
    print(format_string.format(**tablewords))
248
244
    for client in clients:
249
 
        print(format_string.format(**{
250
 
            key: valuetostring(client[key], key)
251
 
            for key in keywords }))
252
 
 
 
245
        print(format_string.format(**dict((key,
 
246
                                           valuetostring(client[key],
 
247
                                                         key))
 
248
                                          for key in keywords)))
253
249
 
254
250
def has_actions(options):
255
251
    return any((options.enable,
271
267
                options.approve,
272
268
                options.deny))
273
269
 
274
 
 
275
270
def main():
276
271
    parser = argparse.ArgumentParser()
277
272
    parser.add_argument("--version", action="version",
278
 
                        version = "%(prog)s {}".format(version),
 
273
                        version = "%(prog)s {0}".format(version),
279
274
                        help="show version number and exit")
280
275
    parser.add_argument("-a", "--all", action="store_true",
281
276
                        help="Select all clients")
282
277
    parser.add_argument("-v", "--verbose", action="store_true",
283
278
                        help="Print all fields")
284
 
    parser.add_argument("-j", "--dump-json", action="store_true",
285
 
                        help="Dump client data in JSON format")
286
279
    parser.add_argument("-e", "--enable", action="store_true",
287
280
                        help="Enable client")
288
281
    parser.add_argument("-d", "--disable", action="store_true",
316
309
    parser.add_argument("--approval-duration",
317
310
                        help="Set duration of one client approval")
318
311
    parser.add_argument("-H", "--host", help="Set host for client")
319
 
    parser.add_argument("-s", "--secret",
320
 
                        type=argparse.FileType(mode="rb"),
 
312
    parser.add_argument("-s", "--secret", type=file,
321
313
                        help="Set password blob (file) for client")
322
314
    parser.add_argument("-A", "--approve", action="store_true",
323
315
                        help="Approve any current client request")
331
323
    if has_actions(options) and not (options.client or options.all):
332
324
        parser.error("Options require clients names or --all.")
333
325
    if options.verbose and has_actions(options):
334
 
        parser.error("--verbose can only be used alone.")
335
 
    if options.dump_json and (options.verbose or has_actions(options)):
336
 
        parser.error("--dump-json can only be used alone.")
 
326
        parser.error("--verbose can only be used alone or with"
 
327
                     " --all.")
337
328
    if options.all and not has_actions(options):
338
329
        parser.error("--all requires an action.")
339
 
    
 
330
 
340
331
    if options.check:
341
332
        fail_count, test_count = doctest.testmod()
342
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
333
        sys.exit(0 if fail_count == 0 else 1)
343
334
    
344
335
    try:
345
336
        bus = dbus.SystemBus()
346
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
347
338
    except dbus.exceptions.DBusException:
348
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
339
        print("Could not connect to Mandos server",
 
340
              file=sys.stderr)
349
341
        sys.exit(1)
350
342
    
351
343
    mandos_serv = dbus.Interface(mandos_dbus_objc,
352
344
                                 dbus_interface = server_interface)
353
 
    mandos_serv_object_manager = dbus.Interface(
354
 
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
355
345
    
356
346
    #block stderr since dbus library prints to stderr
357
347
    null = os.open(os.path.devnull, os.O_RDWR)
360
350
    os.close(null)
361
351
    try:
362
352
        try:
363
 
            mandos_clients = { path: ifs_and_props[client_interface]
364
 
                               for path, ifs_and_props in
365
 
                               mandos_serv_object_manager
366
 
                               .GetManagedObjects().items()
367
 
                               if client_interface in ifs_and_props }
 
353
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
368
354
        finally:
369
355
            #restore stderr
370
356
            os.dup2(stderrcopy, sys.stderr.fileno())
371
357
            os.close(stderrcopy)
372
 
    except dbus.exceptions.DBusException as e:
373
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
374
 
              .format(e), file=sys.stderr)
 
358
    except dbus.exceptions.DBusException:
 
359
        print("Access denied: Accessing mandos server through dbus.",
 
360
              file=sys.stderr)
375
361
        sys.exit(1)
376
362
    
377
363
    # Compile dict of (clients: properties) to process
378
364
    clients={}
379
365
    
380
366
    if options.all or not options.client:
381
 
        clients = { bus.get_object(busname, path): properties
382
 
                    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())
383
370
    else:
384
371
        for name in options.client:
385
 
            for path, client in mandos_clients.items():
 
372
            for path, client in mandos_clients.iteritems():
386
373
                if client["Name"] == name:
387
374
                    client_objc = bus.get_object(busname, path)
388
375
                    clients[client_objc] = client
389
376
                    break
390
377
            else:
391
 
                print("Client not found on server: {!r}"
 
378
                print("Client not found on server: {0!r}"
392
379
                      .format(name), file=sys.stderr)
393
380
                sys.exit(1)
394
381
    
395
382
    if not has_actions(options) and clients:
396
 
        if options.verbose or options.dump_json:
397
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
398
 
                        "Created", "Interval", "Host", "Fingerprint",
399
 
                        "CheckerRunning", "LastEnabled",
400
 
                        "ApprovalPending", "ApprovedByDefault",
 
383
        if options.verbose:
 
384
            keywords = ("Name", "Enabled", "Timeout",
 
385
                        "LastCheckedOK", "Created", "Interval",
 
386
                        "Host", "Fingerprint", "CheckerRunning",
 
387
                        "LastEnabled", "ApprovalPending",
 
388
                        "ApprovedByDefault",
401
389
                        "LastApprovalRequest", "ApprovalDelay",
402
390
                        "ApprovalDuration", "Checker",
403
391
                        "ExtendedTimeout")
404
392
        else:
405
393
            keywords = defaultkeywords
406
394
        
407
 
        if options.dump_json:
408
 
            json.dump({client["Name"]: {key: client[key]
409
 
                                        for key in keywords }
410
 
                       for client in clients.values() },
411
 
                      fp = sys.stdout, indent = 4,
412
 
                      separators = (',', ': '))
413
 
            print()
414
 
        else:
415
 
            print_clients(clients.values(), keywords)
 
395
        print_clients(clients.values(), keywords)
416
396
    else:
417
397
        # Process each client in the list by all selected options
418
398
        for client in clients:
419
 
            
420
399
            def set_client_prop(prop, value):
421
400
                """Set a Client D-Bus property"""
422
401
                client.Set(client_interface, prop, value,
423
402
                           dbus_interface=dbus.PROPERTIES_IFACE)
424
 
            
425
403
            def set_client_prop_ms(prop, value):
426
404
                """Set a Client D-Bus property, converted
427
405
                from a string to milliseconds."""
428
406
                set_client_prop(prop,
429
 
                                string_to_delta(value).total_seconds()
430
 
                                * 1000)
431
 
            
 
407
                                timedelta_to_milliseconds
 
408
                                (string_to_delta(value)))
432
409
            if options.remove:
433
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
434
411
            if options.enable:
478
455
                client.Approve(dbus.Boolean(False),
479
456
                               dbus_interface=client_interface)
480
457
 
481
 
 
482
458
if __name__ == "__main__":
483
459
    main()