/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2014-07-25 23:16:04 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 321.
  • Revision ID: teddy@recompile.se-20140725231604-f5c4f82rn2o5ll1k
Use the .items() method instead of .iteritems().

This is strictly not a Python 2.7 change, but Python 2.7 backported
the new .viewitems() from Python 3, and instead of changing .items()
to .viewitems() and later having to change them all into .items()
again in Python 3, I opted to just change all .iteritems() to .items()
so the code will work both now and with Python 3.  The slowdown with
Python 2 is not significant, and with Python 3 it will again be fast.

* mandos (Client.__init__): Use .items() instead of .iteritems().
  (DBusObjectWithProperties.Introspect): - '' -
  (alternate_dbus_interfaces/wrapper): - '' -
  (main): - '' -
* mandos-ctl (main): - '' -

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