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