/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-10 03:43:48 UTC
  • Revision ID: teddy@recompile.se-20160710034348-5qc50yeyyn7peirm
Update RFC references to their modern equivalents.

* plugins.d/mandos-client.xml (SEE ALSO): Replace RFC 4346 (TLS 1.1)
  with RFC 5246 (TLS 1.2), and replace RFC 5081 (TLS OpenPGP) with its
  replacement RFC 6091.

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