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