/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: 2016-07-03 02:56:00 UTC
  • Revision ID: teddy@recompile.se-20160703025600-bn12vpzejr6zxx5v
mandos-client: Bug fix: flush stdout to detect write errors.

* plugins.d/mandos-client.c (start_mandos_communication): Do
                            fflush(stdout) to detect any write errors.

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-2014 Teddy Hogeborn
7
 
# Copyright © 2008-2014 Björn Påhlsson
 
6
# Copyright © 2008-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 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
39
39
import os
40
40
import collections
41
41
import doctest
 
42
import json
42
43
 
43
44
import dbus
44
45
 
45
 
if sys.version_info[0] == 2:
 
46
if sys.version_info.major == 2:
46
47
    str = unicode
47
48
 
48
49
locale.setlocale(locale.LC_ALL, "")
64
65
    "ApprovalDelay": "Approval Delay",
65
66
    "ApprovalDuration": "Approval Duration",
66
67
    "Checker": "Checker",
67
 
    "ExtendedTimeout" : "Extended Timeout"
68
 
    }
 
68
    "ExtendedTimeout": "Extended Timeout",
 
69
    "Expires": "Expires",
 
70
    "LastCheckerStatus": "Last Checker Status",
 
71
}
69
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
73
domain = "se.recompile"
71
74
busname = domain + ".Mandos"
72
75
server_path = "/"
73
76
server_interface = domain + ".Mandos"
74
77
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.7"
76
 
 
77
 
def timedelta_to_milliseconds(td):
78
 
    """Convert a datetime.timedelta object to milliseconds"""
79
 
    return ((td.days * 24 * 60 * 60 * 1000)
80
 
            + (td.seconds * 1000)
81
 
            + (td.microseconds // 1000))
 
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"
82
85
 
83
86
def milliseconds_to_string(ms):
84
87
    td = datetime.timedelta(0, 0, 0, ms)
85
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
86
 
            .format(days = "{0}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
 
                    ))
 
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))
91
93
 
92
94
 
93
95
def rfc3339_duration_to_delta(duration):
117
119
    # avoid excessive use of external libraries.
118
120
    
119
121
    # New type for defining tokens, syntax, and semantics all-in-one
120
 
    Token = collections.namedtuple("Token",
121
 
                                   ("regexp", # To match token; if
122
 
                                              # "value" is not None,
123
 
                                              # must have a "group"
124
 
                                              # containing digits
125
 
                                    "value",  # datetime.timedelta or
126
 
                                              # None
127
 
                                    "followers")) # Tokens valid after
128
 
                                                  # this token
 
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
129
127
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
128
    # the "duration" ABNF definition in RFC 3339, Appendix A.
131
129
    token_end = Token(re.compile(r"$"), None, frozenset())
132
130
    token_second = Token(re.compile(r"(\d+)S"),
133
131
                         datetime.timedelta(seconds=1),
134
 
                         frozenset((token_end,)))
 
132
                         frozenset((token_end, )))
135
133
    token_minute = Token(re.compile(r"(\d+)M"),
136
134
                         datetime.timedelta(minutes=1),
137
135
                         frozenset((token_second, token_end)))
153
151
                       frozenset((token_month, token_end)))
154
152
    token_week = Token(re.compile(r"(\d+)W"),
155
153
                       datetime.timedelta(weeks=1),
156
 
                       frozenset((token_end,)))
 
154
                       frozenset((token_end, )))
157
155
    token_duration = Token(re.compile(r"P"), None,
158
156
                           frozenset((token_year, token_month,
159
157
                                      token_day, token_time,
161
159
    # Define starting values
162
160
    value = datetime.timedelta() # Value so far
163
161
    found_token = None
164
 
    followers = frozenset((token_duration,)) # Following valid tokens
 
162
    followers = frozenset((token_duration, )) # Following valid tokens
165
163
    s = duration                # String left to parse
166
164
    # Loop until end token is found
167
165
    while found_token is not token_end:
184
182
                break
185
183
        else:
186
184
            # No currently valid tokens were found
187
 
            raise ValueError("Invalid RFC 3339 duration")
 
185
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
186
                             .format(duration))
188
187
    # End token found
189
188
    return value
190
189
 
192
191
def string_to_delta(interval):
193
192
    """Parse a string and return a datetime.timedelta
194
193
    
195
 
    >>> string_to_delta("7d")
 
194
    >>> string_to_delta('7d')
196
195
    datetime.timedelta(7)
197
 
    >>> string_to_delta("60s")
 
196
    >>> string_to_delta('60s')
198
197
    datetime.timedelta(0, 60)
199
 
    >>> string_to_delta("60m")
 
198
    >>> string_to_delta('60m')
200
199
    datetime.timedelta(0, 3600)
201
 
    >>> string_to_delta("24h")
 
200
    >>> string_to_delta('24h')
202
201
    datetime.timedelta(1)
203
 
    >>> string_to_delta("1w")
 
202
    >>> string_to_delta('1w')
204
203
    datetime.timedelta(7)
205
 
    >>> string_to_delta("5m 30s")
 
204
    >>> string_to_delta('5m 30s')
206
205
    datetime.timedelta(0, 330)
207
206
    """
208
207
    
229
228
            value += datetime.timedelta(0, 0, 0, int(num))
230
229
    return value
231
230
 
 
231
 
232
232
def print_clients(clients, keywords):
233
233
    def valuetostring(value, keyword):
234
234
        if type(value) is dbus.Boolean:
240
240
    
241
241
    # Create format string to print table rows
242
242
    format_string = " ".join("{{{key}:{width}}}".format(
243
 
            width = max(len(tablewords[key]),
244
 
                        max(len(valuetostring(client[key],
245
 
                                              key))
246
 
                            for client in
247
 
                            clients)),
248
 
            key = key) for key in keywords)
 
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)
249
248
    # Print header line
250
249
    print(format_string.format(**tablewords))
251
250
    for client in clients:
252
 
        print(format_string.format(**dict((key,
253
 
                                           valuetostring(client[key],
254
 
                                                         key))
255
 
                                          for key in keywords)))
 
251
        print(format_string.format(**{
 
252
            key: valuetostring(client[key], key)
 
253
            for key in keywords }))
 
254
 
256
255
 
257
256
def has_actions(options):
258
257
    return any((options.enable,
274
273
                options.approve,
275
274
                options.deny))
276
275
 
 
276
 
277
277
def main():
278
278
    parser = argparse.ArgumentParser()
279
279
    parser.add_argument("--version", action="version",
280
 
                        version = "%(prog)s {0}".format(version),
 
280
                        version = "%(prog)s {}".format(version),
281
281
                        help="show version number and exit")
282
282
    parser.add_argument("-a", "--all", action="store_true",
283
283
                        help="Select all clients")
284
284
    parser.add_argument("-v", "--verbose", action="store_true",
285
285
                        help="Print all fields")
 
286
    parser.add_argument("-j", "--dump-json", action="store_true",
 
287
                        help="Dump client data in JSON format")
286
288
    parser.add_argument("-e", "--enable", action="store_true",
287
289
                        help="Enable client")
288
290
    parser.add_argument("-d", "--disable", action="store_true",
331
333
    if has_actions(options) and not (options.client or options.all):
332
334
        parser.error("Options require clients names or --all.")
333
335
    if options.verbose and has_actions(options):
334
 
        parser.error("--verbose can only be used alone or with"
335
 
                     " --all.")
 
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.")
336
339
    if options.all and not has_actions(options):
337
340
        parser.error("--all requires an action.")
338
 
 
 
341
    
339
342
    if options.check:
340
343
        fail_count, test_count = doctest.testmod()
341
344
        sys.exit(os.EX_OK if fail_count == 0 else 1)
344
347
        bus = dbus.SystemBus()
345
348
        mandos_dbus_objc = bus.get_object(busname, server_path)
346
349
    except dbus.exceptions.DBusException:
347
 
        print("Could not connect to Mandos server",
348
 
              file=sys.stderr)
 
350
        print("Could not connect to Mandos server", file=sys.stderr)
349
351
        sys.exit(1)
350
352
    
351
353
    mandos_serv = dbus.Interface(mandos_dbus_objc,
352
354
                                 dbus_interface = server_interface)
 
355
    mandos_serv_object_manager = dbus.Interface(
 
356
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
353
357
    
354
358
    #block stderr since dbus library prints to stderr
355
359
    null = os.open(os.path.devnull, os.O_RDWR)
358
362
    os.close(null)
359
363
    try:
360
364
        try:
361
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
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 }
362
370
        finally:
363
371
            #restore stderr
364
372
            os.dup2(stderrcopy, sys.stderr.fileno())
365
373
            os.close(stderrcopy)
366
 
    except dbus.exceptions.DBusException:
367
 
        print("Access denied: Accessing mandos server through dbus.",
368
 
              file=sys.stderr)
 
374
    except dbus.exceptions.DBusException as e:
 
375
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
376
              .format(e), file=sys.stderr)
369
377
        sys.exit(1)
370
378
    
371
379
    # Compile dict of (clients: properties) to process
372
380
    clients={}
373
381
    
374
382
    if options.all or not options.client:
375
 
        clients = dict((bus.get_object(busname, path), properties)
376
 
                       for path, properties in
377
 
                       mandos_clients.items())
 
383
        clients = { bus.get_object(busname, path): properties
 
384
                    for path, properties in mandos_clients.items() }
378
385
    else:
379
386
        for name in options.client:
380
 
            for path, client in mandos_clients.iteritems():
 
387
            for path, client in mandos_clients.items():
381
388
                if client["Name"] == name:
382
389
                    client_objc = bus.get_object(busname, path)
383
390
                    clients[client_objc] = client
384
391
                    break
385
392
            else:
386
 
                print("Client not found on server: {0!r}"
 
393
                print("Client not found on server: {!r}"
387
394
                      .format(name), file=sys.stderr)
388
395
                sys.exit(1)
389
396
    
390
397
    if not has_actions(options) and clients:
391
 
        if options.verbose:
392
 
            keywords = ("Name", "Enabled", "Timeout",
393
 
                        "LastCheckedOK", "Created", "Interval",
394
 
                        "Host", "Fingerprint", "CheckerRunning",
395
 
                        "LastEnabled", "ApprovalPending",
396
 
                        "ApprovedByDefault",
 
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",
397
403
                        "LastApprovalRequest", "ApprovalDelay",
398
404
                        "ApprovalDuration", "Checker",
399
 
                        "ExtendedTimeout")
 
405
                        "ExtendedTimeout", "Expires",
 
406
                        "LastCheckerStatus")
400
407
        else:
401
408
            keywords = defaultkeywords
402
409
        
403
 
        print_clients(clients.values(), keywords)
 
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)
404
423
    else:
405
424
        # Process each client in the list by all selected options
406
425
        for client in clients:
 
426
            
407
427
            def set_client_prop(prop, value):
408
428
                """Set a Client D-Bus property"""
409
429
                client.Set(client_interface, prop, value,
410
430
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
431
            
411
432
            def set_client_prop_ms(prop, value):
412
433
                """Set a Client D-Bus property, converted
413
434
                from a string to milliseconds."""
414
435
                set_client_prop(prop,
415
 
                                timedelta_to_milliseconds
416
 
                                (string_to_delta(value)))
 
436
                                string_to_delta(value).total_seconds()
 
437
                                * 1000)
 
438
            
417
439
            if options.remove:
418
440
                mandos_serv.RemoveClient(client.__dbus_object_path__)
419
441
            if options.enable:
463
485
                client.Approve(dbus.Boolean(False),
464
486
                               dbus_interface=client_interface)
465
487
 
 
488
 
466
489
if __name__ == "__main__":
467
490
    main()