/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-17 00:49:30 UTC
  • Revision ID: teddy@recompile.se-20140717004930-tqfjwjvonrtfcr7w
mandos-ctl: Make it work in Python 3.

* mandos-ctl: Tolerate failure of importing future_builtins.  If
              Python 2, override "str" with "unicode".
  (print_clients): Use "str" instead of "unicode".
  (main): Use 'type=argparse.FileType(mode="rb")' instead of
          'type=file', and use the items() method instead of
          iteritems().

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
#
 
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2008-2018 Teddy Hogeborn
7
 
# Copyright © 2008-2018 Björn Påhlsson
8
 
#
9
 
# This file is part of Mandos.
10
 
#
11
 
# Mandos is free software: you can redistribute it and/or modify it
12
 
# under the terms of the GNU General Public License as published by
 
5
# 
 
6
# Copyright © 2008-2014 Teddy Hogeborn
 
7
# Copyright © 2008-2014 Björn Påhlsson
 
8
# 
 
9
# This program is free software: you can redistribute it and/or modify
 
10
# it under the terms of the GNU General Public License as published by
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
17
#     GNU General Public License for more details.
20
 
#
 
18
# 
21
19
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
23
 
#
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
24
23
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
24
# 
26
25
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
39
38
import re
40
39
import os
41
40
import collections
42
 
import json
 
41
import doctest
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
 
    "Expires": "Expires",
70
 
    "LastCheckerStatus": "Last Checker Status",
71
 
}
 
67
    "ExtendedTimeout" : "Extended Timeout"
 
68
    }
72
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
70
domain = "se.recompile"
74
71
busname = domain + ".Mandos"
75
72
server_path = "/"
76
73
server_interface = domain + ".Mandos"
77
74
client_interface = domain + ".Mandos.Client"
78
 
version = "1.7.18"
79
 
 
80
 
 
81
 
try:
82
 
    dbus.OBJECT_MANAGER_IFACE
83
 
except AttributeError:
84
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
 
 
 
75
version = "1.6.6"
 
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))
86
82
 
87
83
def milliseconds_to_string(ms):
88
84
    td = datetime.timedelta(0, 0, 0, ms)
89
85
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
90
 
            .format(days="{}T".format(td.days) if td.days else "",
91
 
                    hours=td.seconds // 3600,
92
 
                    minutes=(td.seconds % 3600) // 60,
93
 
                    seconds=td.seconds % 60))
 
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
                    ))
94
91
 
95
92
 
96
93
def rfc3339_duration_to_delta(duration):
97
94
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
98
 
 
 
95
    
99
96
    >>> rfc3339_duration_to_delta("P7D")
100
97
    datetime.timedelta(7)
101
98
    >>> rfc3339_duration_to_delta("PT60S")
111
108
    >>> rfc3339_duration_to_delta("P1DT3M20S")
112
109
    datetime.timedelta(1, 200)
113
110
    """
114
 
 
 
111
    
115
112
    # Parsing an RFC 3339 duration with regular expressions is not
116
113
    # possible - there would have to be multiple places for the same
117
114
    # values, like seconds.  The current code, while more esoteric, is
118
115
    # cleaner without depending on a parsing library.  If Python had a
119
116
    # built-in library for parsing we would use it, but we'd like to
120
117
    # avoid excessive use of external libraries.
121
 
 
 
118
    
122
119
    # New type for defining tokens, syntax, and semantics all-in-one
123
 
    Token = collections.namedtuple("Token", (
124
 
        "regexp",  # To match token; if "value" is not None, must have
125
 
                   # a "group" containing digits
126
 
        "value",   # datetime.timedelta or None
127
 
        "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
128
129
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
129
130
    # the "duration" ABNF definition in RFC 3339, Appendix A.
130
131
    token_end = Token(re.compile(r"$"), None, frozenset())
131
132
    token_second = Token(re.compile(r"(\d+)S"),
132
133
                         datetime.timedelta(seconds=1),
133
 
                         frozenset((token_end, )))
 
134
                         frozenset((token_end,)))
134
135
    token_minute = Token(re.compile(r"(\d+)M"),
135
136
                         datetime.timedelta(minutes=1),
136
137
                         frozenset((token_second, token_end)))
152
153
                       frozenset((token_month, token_end)))
153
154
    token_week = Token(re.compile(r"(\d+)W"),
154
155
                       datetime.timedelta(weeks=1),
155
 
                       frozenset((token_end, )))
 
156
                       frozenset((token_end,)))
156
157
    token_duration = Token(re.compile(r"P"), None,
157
158
                           frozenset((token_year, token_month,
158
159
                                      token_day, token_time,
159
 
                                      token_week)))
160
 
    # Define starting values:
161
 
    # Value so far
162
 
    value = datetime.timedelta()
 
160
                                      token_week))),
 
161
    # Define starting values
 
162
    value = datetime.timedelta() # Value so far
163
163
    found_token = None
164
 
    # Following valid tokens
165
 
    followers = frozenset((token_duration, ))
166
 
    # String left to parse
167
 
    s = duration
 
164
    followers = frozenset(token_duration,) # Following valid tokens
 
165
    s = duration                # String left to parse
168
166
    # Loop until end token is found
169
167
    while found_token is not token_end:
170
168
        # Search for any currently valid tokens
186
184
                break
187
185
        else:
188
186
            # No currently valid tokens were found
189
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
190
 
                             .format(duration))
 
187
            raise ValueError("Invalid RFC 3339 duration")
191
188
    # End token found
192
189
    return value
193
190
 
194
191
 
195
192
def string_to_delta(interval):
196
193
    """Parse a string and return a datetime.timedelta
197
 
 
198
 
    >>> string_to_delta('7d')
 
194
    
 
195
    >>> string_to_delta("7d")
199
196
    datetime.timedelta(7)
200
 
    >>> string_to_delta('60s')
 
197
    >>> string_to_delta("60s")
201
198
    datetime.timedelta(0, 60)
202
 
    >>> string_to_delta('60m')
 
199
    >>> string_to_delta("60m")
203
200
    datetime.timedelta(0, 3600)
204
 
    >>> string_to_delta('24h')
 
201
    >>> string_to_delta("24h")
205
202
    datetime.timedelta(1)
206
 
    >>> string_to_delta('1w')
 
203
    >>> string_to_delta("1w")
207
204
    datetime.timedelta(7)
208
 
    >>> string_to_delta('5m 30s')
 
205
    >>> string_to_delta("5m 30s")
209
206
    datetime.timedelta(0, 330)
210
207
    """
211
 
 
 
208
    
212
209
    try:
213
210
        return rfc3339_duration_to_delta(interval)
214
211
    except ValueError:
215
212
        pass
216
 
 
 
213
    
217
214
    value = datetime.timedelta(0)
218
215
    regexp = re.compile(r"(\d+)([dsmhw]?)")
219
 
 
 
216
    
220
217
    for num, suffix in regexp.findall(interval):
221
218
        if suffix == "d":
222
219
            value += datetime.timedelta(int(num))
232
229
            value += datetime.timedelta(0, 0, 0, int(num))
233
230
    return value
234
231
 
235
 
 
236
232
def print_clients(clients, keywords):
237
233
    def valuetostring(value, keyword):
238
234
        if type(value) is dbus.Boolean:
241
237
                       "ApprovalDuration", "ExtendedTimeout"):
242
238
            return milliseconds_to_string(value)
243
239
        return str(value)
244
 
 
 
240
    
245
241
    # Create format string to print table rows
246
242
    format_string = " ".join("{{{key}:{width}}}".format(
247
 
        width=max(len(tablewords[key]),
248
 
                  max(len(valuetostring(client[key], key))
249
 
                      for client in clients)),
250
 
        key=key)
251
 
                             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)
252
249
    # Print header line
253
250
    print(format_string.format(**tablewords))
254
251
    for client in clients:
255
 
        print(format_string
256
 
              .format(**{key: valuetostring(client[key], key)
257
 
                         for key in keywords}))
258
 
 
 
252
        print(format_string.format(**dict((key,
 
253
                                           valuetostring(client[key],
 
254
                                                         key))
 
255
                                          for key in keywords)))
259
256
 
260
257
def has_actions(options):
261
258
    return any((options.enable,
277
274
                options.approve,
278
275
                options.deny))
279
276
 
280
 
 
281
277
def main():
282
278
    parser = argparse.ArgumentParser()
283
279
    parser.add_argument("--version", action="version",
284
 
                        version="%(prog)s {}".format(version),
 
280
                        version = "%(prog)s {0}".format(version),
285
281
                        help="show version number and exit")
286
282
    parser.add_argument("-a", "--all", action="store_true",
287
283
                        help="Select all clients")
288
284
    parser.add_argument("-v", "--verbose", action="store_true",
289
285
                        help="Print all fields")
290
 
    parser.add_argument("-j", "--dump-json", action="store_true",
291
 
                        help="Dump client data in JSON format")
292
286
    parser.add_argument("-e", "--enable", action="store_true",
293
287
                        help="Enable client")
294
288
    parser.add_argument("-d", "--disable", action="store_true",
333
327
                        help="Run self-test")
334
328
    parser.add_argument("client", nargs="*", help="Client name")
335
329
    options = parser.parse_args()
336
 
 
 
330
    
337
331
    if has_actions(options) and not (options.client or options.all):
338
332
        parser.error("Options require clients names or --all.")
339
333
    if options.verbose and has_actions(options):
340
 
        parser.error("--verbose can only be used alone.")
341
 
    if options.dump_json and (options.verbose
342
 
                              or has_actions(options)):
343
 
        parser.error("--dump-json can only be used alone.")
 
334
        parser.error("--verbose can only be used alone or with"
 
335
                     " --all.")
344
336
    if options.all and not has_actions(options):
345
337
        parser.error("--all requires an action.")
346
338
 
347
339
    if options.check:
348
 
        import doctest
349
340
        fail_count, test_count = doctest.testmod()
350
341
        sys.exit(os.EX_OK if fail_count == 0 else 1)
351
 
 
 
342
    
352
343
    try:
353
344
        bus = dbus.SystemBus()
354
345
        mandos_dbus_objc = bus.get_object(busname, server_path)
355
346
    except dbus.exceptions.DBusException:
356
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
347
        print("Could not connect to Mandos server",
 
348
              file=sys.stderr)
357
349
        sys.exit(1)
358
 
 
 
350
    
359
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
360
 
                                 dbus_interface=server_interface)
361
 
    mandos_serv_object_manager = dbus.Interface(
362
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
363
 
 
364
 
    # block stderr since dbus library prints to stderr
 
352
                                 dbus_interface = server_interface)
 
353
    
 
354
    #block stderr since dbus library prints to stderr
365
355
    null = os.open(os.path.devnull, os.O_RDWR)
366
356
    stderrcopy = os.dup(sys.stderr.fileno())
367
357
    os.dup2(null, sys.stderr.fileno())
368
358
    os.close(null)
369
359
    try:
370
360
        try:
371
 
            mandos_clients = {path: ifs_and_props[client_interface]
372
 
                              for path, ifs_and_props in
373
 
                              mandos_serv_object_manager
374
 
                              .GetManagedObjects().items()
375
 
                              if client_interface in ifs_and_props}
 
361
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
376
362
        finally:
377
 
            # restore stderr
 
363
            #restore stderr
378
364
            os.dup2(stderrcopy, sys.stderr.fileno())
379
365
            os.close(stderrcopy)
380
 
    except dbus.exceptions.DBusException as e:
381
 
        print("Access denied: "
382
 
              "Accessing mandos server through D-Bus: {}".format(e),
 
366
    except dbus.exceptions.DBusException:
 
367
        print("Access denied: Accessing mandos server through dbus.",
383
368
              file=sys.stderr)
384
369
        sys.exit(1)
385
 
 
 
370
    
386
371
    # Compile dict of (clients: properties) to process
387
 
    clients = {}
388
 
 
 
372
    clients={}
 
373
    
389
374
    if options.all or not options.client:
390
 
        clients = {bus.get_object(busname, path): properties
391
 
                   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())
392
378
    else:
393
379
        for name in options.client:
394
 
            for path, client in mandos_clients.items():
 
380
            for path, client in mandos_clients.iteritems():
395
381
                if client["Name"] == name:
396
382
                    client_objc = bus.get_object(busname, path)
397
383
                    clients[client_objc] = client
398
384
                    break
399
385
            else:
400
 
                print("Client not found on server: {!r}"
 
386
                print("Client not found on server: {0!r}"
401
387
                      .format(name), file=sys.stderr)
402
388
                sys.exit(1)
403
 
 
 
389
    
404
390
    if not has_actions(options) and clients:
405
 
        if options.verbose or options.dump_json:
406
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
 
                        "Created", "Interval", "Host", "Fingerprint",
408
 
                        "CheckerRunning", "LastEnabled",
409
 
                        "ApprovalPending", "ApprovedByDefault",
 
391
        if options.verbose:
 
392
            keywords = ("Name", "Enabled", "Timeout",
 
393
                        "LastCheckedOK", "Created", "Interval",
 
394
                        "Host", "Fingerprint", "CheckerRunning",
 
395
                        "LastEnabled", "ApprovalPending",
 
396
                        "ApprovedByDefault",
410
397
                        "LastApprovalRequest", "ApprovalDelay",
411
398
                        "ApprovalDuration", "Checker",
412
 
                        "ExtendedTimeout", "Expires",
413
 
                        "LastCheckerStatus")
 
399
                        "ExtendedTimeout")
414
400
        else:
415
401
            keywords = defaultkeywords
416
 
 
417
 
        if options.dump_json:
418
 
            json.dump({client["Name"]: {key:
419
 
                                        bool(client[key])
420
 
                                        if isinstance(client[key],
421
 
                                                      dbus.Boolean)
422
 
                                        else client[key]
423
 
                                        for key in keywords}
424
 
                       for client in clients.values()},
425
 
                      fp=sys.stdout, indent=4,
426
 
                      separators=(',', ': '))
427
 
            print()
428
 
        else:
429
 
            print_clients(clients.values(), keywords)
 
402
        
 
403
        print_clients(clients.values(), keywords)
430
404
    else:
431
405
        # Process each client in the list by all selected options
432
406
        for client in clients:
433
 
 
434
407
            def set_client_prop(prop, value):
435
408
                """Set a Client D-Bus property"""
436
409
                client.Set(client_interface, prop, value,
437
410
                           dbus_interface=dbus.PROPERTIES_IFACE)
438
 
 
439
411
            def set_client_prop_ms(prop, value):
440
412
                """Set a Client D-Bus property, converted
441
413
                from a string to milliseconds."""
442
414
                set_client_prop(prop,
443
 
                                string_to_delta(value).total_seconds()
444
 
                                * 1000)
445
 
 
 
415
                                timedelta_to_milliseconds
 
416
                                (string_to_delta(value)))
446
417
            if options.remove:
447
418
                mandos_serv.RemoveClient(client.__dbus_object_path__)
448
419
            if options.enable:
456
427
            if options.stop_checker:
457
428
                set_client_prop("CheckerRunning", dbus.Boolean(False))
458
429
            if options.is_enabled:
459
 
                if client.Get(client_interface, "Enabled",
460
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
461
 
                    sys.exit(0)
462
 
                else:
463
 
                    sys.exit(1)
 
430
                sys.exit(0 if client.Get(client_interface,
 
431
                                         "Enabled",
 
432
                                         dbus_interface=
 
433
                                         dbus.PROPERTIES_IFACE)
 
434
                         else 1)
464
435
            if options.checker is not None:
465
436
                set_client_prop("Checker", options.checker)
466
437
            if options.host is not None:
492
463
                client.Approve(dbus.Boolean(False),
493
464
                               dbus_interface=client_interface)
494
465
 
495
 
 
496
466
if __name__ == "__main__":
497
467
    main()