/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: 2014-07-25 22:44:20 UTC
  • mto: This revision was merged to the branch mainline in revision 724.
  • Revision ID: teddy@recompile.se-20140725224420-4a5ct2ptt0hsc92z
Require Python 2.7.

This is in preparation for the eventual move to Python 3, which will
happen as soon as all Python modules required by Mandos are available.
The mandos-ctl and mandos-monitor programs are already portable
between Python 2.6 and Python 3 without changes; this change will
bring the requirement up to Python 2.7.

* INSTALL (Prerequisites/Libraries/Mandos Server): Document
                                                   requirement of
                                                   Python 2.7; remove
                                                   Python-argparse
                                                   which is in the
                                                   Python 2.7 standard
                                                   library.
* debian/control (Source: mandos/Build-Depends-Indep): Depend on
                                                       exactly the
                                                       python2.7
                                                       package and all
                                                       the Python 2.7
                                                       versions of the
                                                       python modules.
  (Package: mandos/Depends): - '' - but still depend on python (<=2.7)
                            and the generic versions of the Python
                            modules; this is for mandos-ctl and
                            mandos-monitor, both of which are
                            compatible with Python 3, and use
                            #!/usr/bin/python.
* mandos: Use #!/usr/bin/python2.7 instead of #!/usr/bin/python.

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