/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: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
3
 
#
4
 
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2008-2019 Teddy Hogeborn
7
 
# Copyright © 2008-2019 Björn Påhlsson
 
1
#!/usr/bin/python3 -bbI
 
2
# -*- coding: utf-8; lexical-binding: t -*-
 
3
#
 
4
# Mandos Control - Control or query the Mandos server
 
5
#
 
6
# Copyright © 2008-2022 Teddy Hogeborn
 
7
# Copyright © 2008-2022 Björn Påhlsson
8
8
#
9
9
# This file is part of Mandos.
10
10
#
23
23
#
24
24
# Contact the authors at <mandos@recompile.se>.
25
25
#
26
 
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
29
28
 
33
32
    pass
34
33
 
35
34
import sys
 
35
import unittest
36
36
import argparse
 
37
import logging
 
38
import os
37
39
import locale
38
40
import datetime
39
41
import re
40
 
import os
41
42
import collections
42
43
import json
43
 
import unittest
44
 
import logging
45
44
import io
46
45
import tempfile
47
46
import contextlib
48
47
 
49
 
import dbus
 
48
if sys.version_info.major == 2:
 
49
    __metaclass__ = type
 
50
    str = unicode
 
51
    input = raw_input
 
52
 
 
53
 
 
54
class gi:
 
55
    """Dummy gi module, for the tests"""
 
56
    class repository:
 
57
        class GLib:
 
58
            class Error(Exception):
 
59
                pass
 
60
 
 
61
 
 
62
dbussy = None
 
63
ravel = None
 
64
dbus_python = None
 
65
pydbus = None
 
66
 
 
67
try:
 
68
    import dbussy
 
69
    import ravel
 
70
except ImportError:
 
71
    try:
 
72
        import pydbus
 
73
        import gi
 
74
    except ImportError:
 
75
        import dbus as dbus_python
 
76
 
50
77
 
51
78
# Show warnings by default
52
79
if not sys.warnoptions:
53
80
    import warnings
54
81
    warnings.simplefilter("default")
55
82
 
56
 
log = logging.getLogger(sys.argv[0])
57
 
logging.basicConfig(level="INFO", # Show info level messages
 
83
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
84
logging.basicConfig(level="INFO",         # Show info level messages
58
85
                    format="%(message)s") # Show basic log messages
59
86
 
60
87
logging.captureWarnings(True)   # Show warnings via the logging system
61
88
 
62
89
if sys.version_info.major == 2:
63
 
    str = unicode
64
90
    import StringIO
65
91
    io.StringIO = StringIO.StringIO
66
92
 
67
93
locale.setlocale(locale.LC_ALL, "")
68
94
 
69
 
dbus_busname_domain = "se.recompile"
70
 
dbus_busname = dbus_busname_domain + ".Mandos"
71
 
server_dbus_path = "/"
72
 
server_dbus_interface = dbus_busname_domain + ".Mandos"
73
 
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
74
 
del dbus_busname_domain
75
 
version = "1.8.3"
76
 
 
77
 
 
78
 
try:
79
 
    dbus.OBJECT_MANAGER_IFACE
80
 
except AttributeError:
81
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
95
version = "1.8.16"
82
96
 
83
97
 
84
98
def main():
85
99
    parser = argparse.ArgumentParser()
86
 
 
87
100
    add_command_line_options(parser)
88
101
 
89
102
    options = parser.parse_args()
90
 
 
91
103
    check_option_syntax(parser, options)
92
104
 
93
105
    clientnames = options.client
94
106
 
95
107
    if options.debug:
96
 
        log.setLevel(logging.DEBUG)
97
 
 
98
 
    bus = dbus.SystemBus()
99
 
 
100
 
    mandos_dbus_object = get_mandos_dbus_object(bus)
101
 
 
102
 
    mandos_serv = dbus.Interface(
103
 
        mandos_dbus_object, dbus_interface=server_dbus_interface)
104
 
    mandos_serv_object_manager = dbus.Interface(
105
 
        mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
106
 
 
107
 
    managed_objects = get_managed_objects(mandos_serv_object_manager)
108
 
 
109
 
    all_clients = {}
110
 
    for path, ifs_and_props in managed_objects.items():
111
 
        try:
112
 
            all_clients[path] = ifs_and_props[client_dbus_interface]
113
 
        except KeyError:
114
 
            pass
 
108
        logging.getLogger("").setLevel(logging.DEBUG)
 
109
 
 
110
    if dbussy is not None and ravel is not None:
 
111
        bus = dbussy_adapter.CachingBus(dbussy, ravel)
 
112
    elif pydbus is not None:
 
113
        bus = pydbus_adapter.CachingBus(pydbus)
 
114
    else:
 
115
        bus = dbus_python_adapter.CachingBus(dbus_python)
 
116
 
 
117
    try:
 
118
        all_clients = bus.get_clients_and_properties()
 
119
    except dbus.ConnectFailed as e:
 
120
        log.critical("Could not connect to Mandos server: %s", e)
 
121
        sys.exit(1)
 
122
    except dbus.Error as e:
 
123
        log.critical(
 
124
            "Failed to access Mandos server through D-Bus:\n%s", e)
 
125
        sys.exit(1)
115
126
 
116
127
    # Compile dict of (clientpath: properties) to process
117
128
    if not clientnames:
130
141
    commands = commands_from_options(options)
131
142
 
132
143
    for command in commands:
133
 
        command.run(clients, bus, mandos_serv)
 
144
        command.run(clients, bus)
134
145
 
135
146
 
136
147
def add_command_line_options(parser):
141
152
                        help="Select all clients")
142
153
    parser.add_argument("-v", "--verbose", action="store_true",
143
154
                        help="Print all fields")
144
 
    parser.add_argument("-j", "--dump-json", action="store_true",
 
155
    parser.add_argument("-j", "--dump-json", dest="commands",
 
156
                        action="append_const", default=[],
 
157
                        const=command.DumpJSON(),
145
158
                        help="Dump client data in JSON format")
146
159
    enable_disable = parser.add_mutually_exclusive_group()
147
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
160
    enable_disable.add_argument("-e", "--enable", dest="commands",
 
161
                                action="append_const", default=[],
 
162
                                const=command.Enable(),
148
163
                                help="Enable client")
149
 
    enable_disable.add_argument("-d", "--disable",
150
 
                                action="store_true",
 
164
    enable_disable.add_argument("-d", "--disable", dest="commands",
 
165
                                action="append_const", default=[],
 
166
                                const=command.Disable(),
151
167
                                help="disable client")
152
 
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
168
    parser.add_argument("-b", "--bump-timeout", dest="commands",
 
169
                        action="append_const", default=[],
 
170
                        const=command.BumpTimeout(),
153
171
                        help="Bump timeout for client")
154
172
    start_stop_checker = parser.add_mutually_exclusive_group()
155
173
    start_stop_checker.add_argument("--start-checker",
156
 
                                    action="store_true",
 
174
                                    dest="commands",
 
175
                                    action="append_const", default=[],
 
176
                                    const=command.StartChecker(),
157
177
                                    help="Start checker for client")
158
 
    start_stop_checker.add_argument("--stop-checker",
159
 
                                    action="store_true",
 
178
    start_stop_checker.add_argument("--stop-checker", dest="commands",
 
179
                                    action="append_const", default=[],
 
180
                                    const=command.StopChecker(),
160
181
                                    help="Stop checker for client")
161
 
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
182
    parser.add_argument("-V", "--is-enabled", dest="commands",
 
183
                        action="append_const", default=[],
 
184
                        const=command.IsEnabled(),
162
185
                        help="Check if client is enabled")
163
 
    parser.add_argument("-r", "--remove", action="store_true",
 
186
    parser.add_argument("-r", "--remove", dest="commands",
 
187
                        action="append_const", default=[],
 
188
                        const=command.Remove(),
164
189
                        help="Remove client")
165
 
    parser.add_argument("-c", "--checker",
 
190
    parser.add_argument("-c", "--checker", dest="commands",
 
191
                        action="append", default=[],
 
192
                        metavar="COMMAND", type=command.SetChecker,
166
193
                        help="Set checker command for client")
167
 
    parser.add_argument("-t", "--timeout", type=string_to_delta,
168
 
                        help="Set timeout for client")
169
 
    parser.add_argument("--extended-timeout", type=string_to_delta,
170
 
                        help="Set extended timeout for client")
171
 
    parser.add_argument("-i", "--interval", type=string_to_delta,
172
 
                        help="Set checker interval for client")
 
194
    parser.add_argument(
 
195
        "-t", "--timeout", dest="commands", action="append",
 
196
        default=[], metavar="TIME",
 
197
        type=command.SetTimeout.argparse(string_to_delta),
 
198
        help="Set timeout for client")
 
199
    parser.add_argument(
 
200
        "--extended-timeout", dest="commands", action="append",
 
201
        default=[], metavar="TIME",
 
202
        type=command.SetExtendedTimeout.argparse(string_to_delta),
 
203
        help="Set extended timeout for client")
 
204
    parser.add_argument(
 
205
        "-i", "--interval", dest="commands", action="append",
 
206
        default=[], metavar="TIME",
 
207
        type=command.SetInterval.argparse(string_to_delta),
 
208
        help="Set checker interval for client")
173
209
    approve_deny_default = parser.add_mutually_exclusive_group()
174
210
    approve_deny_default.add_argument(
175
 
        "--approve-by-default", action="store_true",
176
 
        default=None, dest="approved_by_default",
 
211
        "--approve-by-default", dest="commands",
 
212
        action="append_const", default=[],
 
213
        const=command.ApproveByDefault(),
177
214
        help="Set client to be approved by default")
178
215
    approve_deny_default.add_argument(
179
 
        "--deny-by-default", action="store_false",
180
 
        dest="approved_by_default",
 
216
        "--deny-by-default", dest="commands",
 
217
        action="append_const", default=[],
 
218
        const=command.DenyByDefault(),
181
219
        help="Set client to be denied by default")
182
 
    parser.add_argument("--approval-delay", type=string_to_delta,
183
 
                        help="Set delay before client approve/deny")
184
 
    parser.add_argument("--approval-duration", type=string_to_delta,
185
 
                        help="Set duration of one client approval")
186
 
    parser.add_argument("-H", "--host", help="Set host for client")
187
 
    parser.add_argument("-s", "--secret",
188
 
                        type=argparse.FileType(mode="rb"),
189
 
                        help="Set password blob (file) for client")
 
220
    parser.add_argument(
 
221
        "--approval-delay", dest="commands", action="append",
 
222
        default=[], metavar="TIME",
 
223
        type=command.SetApprovalDelay.argparse(string_to_delta),
 
224
        help="Set delay before client approve/deny")
 
225
    parser.add_argument(
 
226
        "--approval-duration", dest="commands", action="append",
 
227
        default=[], metavar="TIME",
 
228
        type=command.SetApprovalDuration.argparse(string_to_delta),
 
229
        help="Set duration of one client approval")
 
230
    parser.add_argument("-H", "--host", dest="commands",
 
231
                        action="append", default=[], metavar="STRING",
 
232
                        type=command.SetHost,
 
233
                        help="Set host for client")
 
234
    parser.add_argument(
 
235
        "-s", "--secret", dest="commands", action="append",
 
236
        default=[], metavar="FILENAME",
 
237
        type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
 
238
        help="Set password blob (file) for client")
190
239
    approve_deny = parser.add_mutually_exclusive_group()
191
240
    approve_deny.add_argument(
192
 
        "-A", "--approve", action="store_true",
 
241
        "-A", "--approve", dest="commands", action="append_const",
 
242
        default=[], const=command.Approve(),
193
243
        help="Approve any current client request")
194
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
244
    approve_deny.add_argument("-D", "--deny", dest="commands",
 
245
                              action="append_const", default=[],
 
246
                              const=command.Deny(),
195
247
                              help="Deny any current client request")
196
248
    parser.add_argument("--debug", action="store_true",
197
249
                        help="Debug mode (show D-Bus commands)")
207
259
        return rfc3339_duration_to_delta(interval)
208
260
    except ValueError as e:
209
261
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
210
 
                    ' '.join(e.args))
 
262
                    " ".join(e.args))
211
263
    return parse_pre_1_6_1_interval(interval)
212
264
 
213
265
 
214
266
def rfc3339_duration_to_delta(duration):
215
267
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
216
268
 
217
 
    >>> rfc3339_duration_to_delta("P7D")
218
 
    datetime.timedelta(7)
219
 
    >>> rfc3339_duration_to_delta("PT60S")
220
 
    datetime.timedelta(0, 60)
221
 
    >>> rfc3339_duration_to_delta("PT60M")
222
 
    datetime.timedelta(0, 3600)
223
 
    >>> rfc3339_duration_to_delta("P60M")
224
 
    datetime.timedelta(1680)
225
 
    >>> rfc3339_duration_to_delta("PT24H")
226
 
    datetime.timedelta(1)
227
 
    >>> rfc3339_duration_to_delta("P1W")
228
 
    datetime.timedelta(7)
229
 
    >>> rfc3339_duration_to_delta("PT5M30S")
230
 
    datetime.timedelta(0, 330)
231
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
232
 
    datetime.timedelta(1, 200)
 
269
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
270
    True
 
271
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
272
    True
 
273
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
 
274
    True
 
275
    >>> # 60 months
 
276
    >>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
 
277
    True
 
278
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
279
    True
 
280
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
281
    True
 
282
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
283
    True
 
284
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
285
    True
233
286
    >>> # Can not be empty:
234
287
    >>> rfc3339_duration_to_delta("")
235
288
    Traceback (most recent call last):
342
395
 
343
396
 
344
397
def parse_pre_1_6_1_interval(interval):
345
 
    """Parse an interval string as documented by Mandos before 1.6.1,
 
398
    r"""Parse an interval string as documented by Mandos before 1.6.1,
346
399
    and return a datetime.timedelta
347
400
 
348
 
    >>> parse_pre_1_6_1_interval('7d')
349
 
    datetime.timedelta(7)
350
 
    >>> parse_pre_1_6_1_interval('60s')
351
 
    datetime.timedelta(0, 60)
352
 
    >>> parse_pre_1_6_1_interval('60m')
353
 
    datetime.timedelta(0, 3600)
354
 
    >>> parse_pre_1_6_1_interval('24h')
355
 
    datetime.timedelta(1)
356
 
    >>> parse_pre_1_6_1_interval('1w')
357
 
    datetime.timedelta(7)
358
 
    >>> parse_pre_1_6_1_interval('5m 30s')
359
 
    datetime.timedelta(0, 330)
360
 
    >>> parse_pre_1_6_1_interval('')
361
 
    datetime.timedelta(0)
 
401
    >>> parse_pre_1_6_1_interval("7d") == datetime.timedelta(days=7)
 
402
    True
 
403
    >>> parse_pre_1_6_1_interval("60s") == datetime.timedelta(0, 60)
 
404
    True
 
405
    >>> parse_pre_1_6_1_interval("60m") == datetime.timedelta(hours=1)
 
406
    True
 
407
    >>> parse_pre_1_6_1_interval("24h") == datetime.timedelta(days=1)
 
408
    True
 
409
    >>> parse_pre_1_6_1_interval("1w") == datetime.timedelta(days=7)
 
410
    True
 
411
    >>> parse_pre_1_6_1_interval("5m 30s") == datetime.timedelta(0, 330)
 
412
    True
 
413
    >>> parse_pre_1_6_1_interval("") == datetime.timedelta(0)
 
414
    True
362
415
    >>> # Ignore unknown characters, allow any order and repetitions
363
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
364
 
    datetime.timedelta(2, 480, 18000)
 
416
    >>> parse_pre_1_6_1_interval("2dxy7zz11y3m5m") \
 
417
    ... == datetime.timedelta(2, 480, 18000)
 
418
    True
365
419
 
366
420
    """
367
421
 
388
442
    """Apply additional restrictions on options, not expressible in
389
443
argparse"""
390
444
 
391
 
    def has_actions(options):
392
 
        return any((options.enable,
393
 
                    options.disable,
394
 
                    options.bump_timeout,
395
 
                    options.start_checker,
396
 
                    options.stop_checker,
397
 
                    options.is_enabled,
398
 
                    options.remove,
399
 
                    options.checker is not None,
400
 
                    options.timeout is not None,
401
 
                    options.extended_timeout is not None,
402
 
                    options.interval is not None,
403
 
                    options.approved_by_default is not None,
404
 
                    options.approval_delay is not None,
405
 
                    options.approval_duration is not None,
406
 
                    options.host is not None,
407
 
                    options.secret is not None,
408
 
                    options.approve,
409
 
                    options.deny))
 
445
    def has_commands(options, commands=None):
 
446
        if commands is None:
 
447
            commands = (command.Enable,
 
448
                        command.Disable,
 
449
                        command.BumpTimeout,
 
450
                        command.StartChecker,
 
451
                        command.StopChecker,
 
452
                        command.IsEnabled,
 
453
                        command.Remove,
 
454
                        command.SetChecker,
 
455
                        command.SetTimeout,
 
456
                        command.SetExtendedTimeout,
 
457
                        command.SetInterval,
 
458
                        command.ApproveByDefault,
 
459
                        command.DenyByDefault,
 
460
                        command.SetApprovalDelay,
 
461
                        command.SetApprovalDuration,
 
462
                        command.SetHost,
 
463
                        command.SetSecret,
 
464
                        command.Approve,
 
465
                        command.Deny)
 
466
        return any(isinstance(cmd, commands)
 
467
                   for cmd in options.commands)
410
468
 
411
 
    if has_actions(options) and not (options.client or options.all):
 
469
    if has_commands(options) and not (options.client or options.all):
412
470
        parser.error("Options require clients names or --all.")
413
 
    if options.verbose and has_actions(options):
 
471
    if options.verbose and has_commands(options):
414
472
        parser.error("--verbose can only be used alone.")
415
 
    if options.dump_json and (options.verbose
416
 
                              or has_actions(options)):
 
473
    if (has_commands(options, (command.DumpJSON,))
 
474
        and (options.verbose or len(options.commands) > 1)):
417
475
        parser.error("--dump-json can only be used alone.")
418
 
    if options.all and not has_actions(options):
 
476
    if options.all and not has_commands(options):
419
477
        parser.error("--all requires an action.")
420
 
    if options.is_enabled and len(options.client) > 1:
 
478
    if (has_commands(options, (command.IsEnabled,))
 
479
        and len(options.client) > 1):
421
480
        parser.error("--is-enabled requires exactly one client")
422
 
    if options.remove:
423
 
        options.remove = False
424
 
        if has_actions(options) and not options.deny:
425
 
            parser.error("--remove can only be combined with --deny")
426
 
        options.remove = True
427
 
 
428
 
 
429
 
def get_mandos_dbus_object(bus):
430
 
    log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
431
 
              dbus_busname, server_dbus_path)
432
 
    with if_dbus_exception_log_with_exception_and_exit(
433
 
            "Could not connect to Mandos server: %s"):
434
 
        mandos_dbus_object = bus.get_object(dbus_busname,
435
 
                                            server_dbus_path)
436
 
    return mandos_dbus_object
437
 
 
438
 
 
439
 
@contextlib.contextmanager
440
 
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
 
    try:
442
 
        yield
443
 
    except dbus.exceptions.DBusException as e:
444
 
        log.critical(*(args + (e,)), **kwargs)
445
 
        sys.exit(1)
446
 
 
447
 
 
448
 
def get_managed_objects(object_manager):
449
 
    log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
450
 
              server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
451
 
    with if_dbus_exception_log_with_exception_and_exit(
452
 
            "Failed to access Mandos server through D-Bus:\n%s"):
453
 
        with SilenceLogger("dbus.proxies"):
454
 
            managed_objects = object_manager.GetManagedObjects()
455
 
    return managed_objects
456
 
 
457
 
 
458
 
class SilenceLogger(object):
459
 
    "Simple context manager to silence a particular logger"
460
 
    def __init__(self, loggername):
461
 
        self.logger = logging.getLogger(loggername)
462
 
 
463
 
    def __enter__(self):
464
 
        self.logger.addFilter(self.nullfilter)
465
 
        return self
466
 
 
467
 
    class NullFilter(logging.Filter):
468
 
        def filter(self, record):
469
 
            return False
470
 
 
471
 
    nullfilter = NullFilter()
472
 
 
473
 
    def __exit__(self, exc_type, exc_val, exc_tb):
474
 
        self.logger.removeFilter(self.nullfilter)
 
481
    if (len(options.commands) > 1
 
482
        and has_commands(options, (command.Remove,))
 
483
        and not has_commands(options, (command.Deny,))):
 
484
        parser.error("--remove can only be combined with --deny")
 
485
 
 
486
 
 
487
class dbus:
 
488
 
 
489
    class SystemBus:
 
490
 
 
491
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
 
492
 
 
493
        def get_managed_objects(self, busname, objectpath):
 
494
            return self.call_method("GetManagedObjects", busname,
 
495
                                    objectpath,
 
496
                                    self.object_manager_iface)
 
497
 
 
498
        properties_iface = "org.freedesktop.DBus.Properties"
 
499
 
 
500
        def set_property(self, busname, objectpath, interface, key,
 
501
                         value):
 
502
            self.call_method("Set", busname, objectpath,
 
503
                             self.properties_iface, interface, key,
 
504
                             value)
 
505
 
 
506
        def call_method(self, methodname, busname, objectpath,
 
507
                        interface, *args):
 
508
            raise NotImplementedError()
 
509
 
 
510
    class MandosBus(SystemBus):
 
511
        busname_domain = "se.recompile"
 
512
        busname = busname_domain + ".Mandos"
 
513
        server_path = "/"
 
514
        server_interface = busname_domain + ".Mandos"
 
515
        client_interface = busname_domain + ".Mandos.Client"
 
516
        del busname_domain
 
517
 
 
518
        def get_clients_and_properties(self):
 
519
            managed_objects = self.get_managed_objects(
 
520
                self.busname, self.server_path)
 
521
            return {objpath: properties[self.client_interface]
 
522
                    for objpath, properties in managed_objects.items()
 
523
                    if self.client_interface in properties}
 
524
 
 
525
        def set_client_property(self, objectpath, key, value):
 
526
            return self.set_property(self.busname, objectpath,
 
527
                                     self.client_interface, key,
 
528
                                     value)
 
529
 
 
530
        def call_client_method(self, objectpath, method, *args):
 
531
            return self.call_method(method, self.busname, objectpath,
 
532
                                    self.client_interface, *args)
 
533
 
 
534
        def call_server_method(self, method, *args):
 
535
            return self.call_method(method, self.busname,
 
536
                                    self.server_path,
 
537
                                    self.server_interface, *args)
 
538
 
 
539
    class Error(Exception):
 
540
        pass
 
541
 
 
542
    class ConnectFailed(Error):
 
543
        pass
 
544
 
 
545
 
 
546
class dbus_python_adapter:
 
547
 
 
548
    class SystemBus(dbus.MandosBus):
 
549
        """Use dbus-python"""
 
550
 
 
551
        def __init__(self, module=dbus_python):
 
552
            self.dbus_python = module
 
553
            self.bus = self.dbus_python.SystemBus()
 
554
 
 
555
        @contextlib.contextmanager
 
556
        def convert_exception(self, exception_class=dbus.Error):
 
557
            try:
 
558
                yield
 
559
            except self.dbus_python.exceptions.DBusException as e:
 
560
                # This does what "raise from" would do
 
561
                exc = exception_class(*e.args)
 
562
                exc.__cause__ = e
 
563
                raise exc
 
564
 
 
565
        def call_method(self, methodname, busname, objectpath,
 
566
                        interface, *args):
 
567
            proxy_object = self.get_object(busname, objectpath)
 
568
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
 
569
                      interface, methodname,
 
570
                      ", ".join(repr(a) for a in args))
 
571
            method = getattr(proxy_object, methodname)
 
572
            with self.convert_exception():
 
573
                with dbus_python_adapter.SilenceLogger(
 
574
                        "dbus.proxies"):
 
575
                    value = method(*args, dbus_interface=interface)
 
576
            return self.type_filter(value)
 
577
 
 
578
        def get_object(self, busname, objectpath):
 
579
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
580
                      busname, objectpath)
 
581
            with self.convert_exception(dbus.ConnectFailed):
 
582
                return self.bus.get_object(busname, objectpath)
 
583
 
 
584
        def type_filter(self, value):
 
585
            """Convert the most bothersome types to Python types"""
 
586
            if isinstance(value, self.dbus_python.Boolean):
 
587
                return bool(value)
 
588
            if isinstance(value, self.dbus_python.ObjectPath):
 
589
                return str(value)
 
590
            # Also recurse into dictionaries
 
591
            if isinstance(value, self.dbus_python.Dictionary):
 
592
                return {self.type_filter(key):
 
593
                        self.type_filter(subval)
 
594
                        for key, subval in value.items()}
 
595
            return value
 
596
 
 
597
        def set_client_property(self, objectpath, key, value):
 
598
            if key == "Secret":
 
599
                if not isinstance(value, bytes):
 
600
                    value = value.encode("utf-8")
 
601
                value = self.dbus_python.ByteArray(value)
 
602
            return self.set_property(self.busname, objectpath,
 
603
                                     self.client_interface, key,
 
604
                                     value)
 
605
 
 
606
    class SilenceLogger:
 
607
        "Simple context manager to silence a particular logger"
 
608
 
 
609
        def __init__(self, loggername):
 
610
            self.logger = logging.getLogger(loggername)
 
611
 
 
612
        def __enter__(self):
 
613
            self.logger.addFilter(self.nullfilter)
 
614
 
 
615
        class NullFilter(logging.Filter):
 
616
            def filter(self, record):
 
617
                return False
 
618
 
 
619
        nullfilter = NullFilter()
 
620
 
 
621
        def __exit__(self, exc_type, exc_val, exc_tb):
 
622
            self.logger.removeFilter(self.nullfilter)
 
623
 
 
624
    class CachingBus(SystemBus):
 
625
        """A caching layer for dbus_python_adapter.SystemBus"""
 
626
 
 
627
        def __init__(self, *args, **kwargs):
 
628
            self.object_cache = {}
 
629
            super(dbus_python_adapter.CachingBus,
 
630
                  self).__init__(*args, **kwargs)
 
631
 
 
632
        def get_object(self, busname, objectpath):
 
633
            try:
 
634
                return self.object_cache[(busname, objectpath)]
 
635
            except KeyError:
 
636
                new_object = super(
 
637
                    dbus_python_adapter.CachingBus,
 
638
                    self).get_object(busname, objectpath)
 
639
                self.object_cache[(busname, objectpath)] = new_object
 
640
                return new_object
 
641
 
 
642
 
 
643
class pydbus_adapter:
 
644
    class SystemBus(dbus.MandosBus):
 
645
        def __init__(self, module=pydbus):
 
646
            self.pydbus = module
 
647
            self.bus = self.pydbus.SystemBus()
 
648
 
 
649
        @contextlib.contextmanager
 
650
        def convert_exception(self, exception_class=dbus.Error):
 
651
            try:
 
652
                yield
 
653
            except gi.repository.GLib.Error as e:
 
654
                # This does what "raise from" would do
 
655
                exc = exception_class(*e.args)
 
656
                exc.__cause__ = e
 
657
                raise exc
 
658
 
 
659
        def call_method(self, methodname, busname, objectpath,
 
660
                        interface, *args):
 
661
            proxy_object = self.get(busname, objectpath)
 
662
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
 
663
                      interface, methodname,
 
664
                      ", ".join(repr(a) for a in args))
 
665
            method = getattr(proxy_object[interface], methodname)
 
666
            with self.convert_exception():
 
667
                return method(*args)
 
668
 
 
669
        def get(self, busname, objectpath):
 
670
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
671
                      busname, objectpath)
 
672
            with self.convert_exception(dbus.ConnectFailed):
 
673
                if sys.version_info.major <= 2:
 
674
                    with warnings.catch_warnings():
 
675
                        warnings.filterwarnings(
 
676
                            "ignore", "", DeprecationWarning,
 
677
                            r"^xml\.etree\.ElementTree$")
 
678
                        return self.bus.get(busname, objectpath)
 
679
                else:
 
680
                    return self.bus.get(busname, objectpath)
 
681
 
 
682
        def set_property(self, busname, objectpath, interface, key,
 
683
                         value):
 
684
            proxy_object = self.get(busname, objectpath)
 
685
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
 
686
                      objectpath, self.properties_iface, interface,
 
687
                      key, value)
 
688
            setattr(proxy_object[interface], key, value)
 
689
 
 
690
    class CachingBus(SystemBus):
 
691
        """A caching layer for pydbus_adapter.SystemBus"""
 
692
 
 
693
        def __init__(self, *args, **kwargs):
 
694
            self.object_cache = {}
 
695
            super(pydbus_adapter.CachingBus,
 
696
                  self).__init__(*args, **kwargs)
 
697
 
 
698
        def get(self, busname, objectpath):
 
699
            try:
 
700
                return self.object_cache[(busname, objectpath)]
 
701
            except KeyError:
 
702
                new_object = (super(pydbus_adapter.CachingBus, self)
 
703
                              .get(busname, objectpath))
 
704
                self.object_cache[(busname, objectpath)] = new_object
 
705
                return new_object
 
706
 
 
707
 
 
708
class dbussy_adapter:
 
709
    class SystemBus(dbus.SystemBus):
 
710
        """Use DBussy"""
 
711
 
 
712
        def __init__(self, dbussy, ravel):
 
713
            self.dbussy = dbussy
 
714
            self.ravel = ravel
 
715
            self.bus = ravel.system_bus()
 
716
 
 
717
        @contextlib.contextmanager
 
718
        def convert_exception(self, exception_class=dbus.Error):
 
719
            try:
 
720
                yield
 
721
            except self.dbussy.DBusError as e:
 
722
                # This does what "raise from" would do
 
723
                exc = exception_class(*e.args)
 
724
                exc.__cause__ = e
 
725
                raise exc
 
726
 
 
727
        def call_method(self, methodname, busname, objectpath,
 
728
                        interface, *args):
 
729
            proxy_object = self.get_object(busname, objectpath)
 
730
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
 
731
                      interface, methodname,
 
732
                      ", ".join(repr(a) for a in args))
 
733
            iface = proxy_object.get_interface(interface)
 
734
            method = getattr(iface, methodname)
 
735
            with self.convert_exception(dbus.Error):
 
736
                value = method(*args)
 
737
            # DBussy returns values either as an empty list or as a
 
738
            # list of one element with the return value
 
739
            if value:
 
740
                return self.type_filter(value[0])
 
741
 
 
742
        def get_object(self, busname, objectpath):
 
743
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
744
                      busname, objectpath)
 
745
            with self.convert_exception(dbus.ConnectFailed):
 
746
                return self.bus[busname][objectpath]
 
747
 
 
748
        def type_filter(self, value):
 
749
            """Convert the most bothersome types to Python types"""
 
750
            # A D-Bus Variant value is represented as the Python type
 
751
            # Tuple[dbussy.DBUS.Signature, Any]
 
752
            if isinstance(value, tuple):
 
753
                if (len(value) == 2
 
754
                    and isinstance(value[0],
 
755
                                   self.dbussy.DBUS.Signature)):
 
756
                    return self.type_filter(value[1])
 
757
            elif isinstance(value, self.dbussy.DBUS.ObjectPath):
 
758
                return str(value)
 
759
            # Also recurse into dictionaries
 
760
            elif isinstance(value, dict):
 
761
                return {self.type_filter(key):
 
762
                        self.type_filter(subval)
 
763
                        for key, subval in value.items()}
 
764
            return value
 
765
 
 
766
        def set_property(self, busname, objectpath, interface, key,
 
767
                         value):
 
768
            proxy_object = self.get_object(busname, objectpath)
 
769
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
 
770
                      objectpath, self.properties_iface, interface,
 
771
                      key, value)
 
772
            if key == "Secret":
 
773
                # DBussy wants a Byte Array to be a sequence of
 
774
                # values, not a byte string
 
775
                value = tuple(value)
 
776
            setattr(proxy_object.get_interface(interface), key, value)
 
777
 
 
778
    class MandosBus(SystemBus, dbus.MandosBus):
 
779
        pass
 
780
 
 
781
    class CachingBus(MandosBus):
 
782
        """A caching layer for dbussy_adapter.MandosBus"""
 
783
 
 
784
        def __init__(self, *args, **kwargs):
 
785
            self.object_cache = {}
 
786
            super(dbussy_adapter.CachingBus, self).__init__(*args,
 
787
                                                            **kwargs)
 
788
 
 
789
        def get_object(self, busname, objectpath):
 
790
            try:
 
791
                return self.object_cache[(busname, objectpath)]
 
792
            except KeyError:
 
793
                new_object = super(
 
794
                    dbussy_adapter.CachingBus,
 
795
                    self).get_object(busname, objectpath)
 
796
                self.object_cache[(busname, objectpath)] = new_object
 
797
                return new_object
475
798
 
476
799
 
477
800
def commands_from_options(options):
478
801
 
479
 
    commands = []
480
 
 
481
 
    if options.is_enabled:
482
 
        commands.append(command.IsEnabled())
483
 
 
484
 
    if options.approve:
485
 
        commands.append(command.Approve())
486
 
 
487
 
    if options.deny:
488
 
        commands.append(command.Deny())
489
 
 
490
 
    if options.remove:
491
 
        commands.append(command.Remove())
492
 
 
493
 
    if options.dump_json:
494
 
        commands.append(command.DumpJSON())
495
 
 
496
 
    if options.enable:
497
 
        commands.append(command.Enable())
498
 
 
499
 
    if options.disable:
500
 
        commands.append(command.Disable())
501
 
 
502
 
    if options.bump_timeout:
503
 
        commands.append(command.BumpTimeout())
504
 
 
505
 
    if options.start_checker:
506
 
        commands.append(command.StartChecker())
507
 
 
508
 
    if options.stop_checker:
509
 
        commands.append(command.StopChecker())
510
 
 
511
 
    if options.approved_by_default is not None:
512
 
        if options.approved_by_default:
513
 
            commands.append(command.ApproveByDefault())
 
802
    commands = list(options.commands)
 
803
 
 
804
    def find_cmd(cmd, commands):
 
805
        i = 0
 
806
        for i, c in enumerate(commands):
 
807
            if isinstance(c, cmd):
 
808
                return i
 
809
        return i+1
 
810
 
 
811
    # If command.Remove is present, move any instances of command.Deny
 
812
    # to occur ahead of command.Remove.
 
813
    index_of_remove = find_cmd(command.Remove, commands)
 
814
    before_remove = commands[:index_of_remove]
 
815
    after_remove = commands[index_of_remove:]
 
816
    cleaned_after = []
 
817
    for cmd in after_remove:
 
818
        if isinstance(cmd, command.Deny):
 
819
            before_remove.append(cmd)
514
820
        else:
515
 
            commands.append(command.DenyByDefault())
516
 
 
517
 
    if options.checker is not None:
518
 
        commands.append(command.SetChecker(options.checker))
519
 
 
520
 
    if options.host is not None:
521
 
        commands.append(command.SetHost(options.host))
522
 
 
523
 
    if options.secret is not None:
524
 
        commands.append(command.SetSecret(options.secret))
525
 
 
526
 
    if options.timeout is not None:
527
 
        commands.append(command.SetTimeout(options.timeout))
528
 
 
529
 
    if options.extended_timeout:
530
 
        commands.append(
531
 
            command.SetExtendedTimeout(options.extended_timeout))
532
 
 
533
 
    if options.interval is not None:
534
 
        commands.append(command.SetInterval(options.interval))
535
 
 
536
 
    if options.approval_delay is not None:
537
 
        commands.append(
538
 
            command.SetApprovalDelay(options.approval_delay))
539
 
 
540
 
    if options.approval_duration is not None:
541
 
        commands.append(
542
 
            command.SetApprovalDuration(options.approval_duration))
 
821
            cleaned_after.append(cmd)
 
822
    if cleaned_after != after_remove:
 
823
        commands = before_remove + cleaned_after
543
824
 
544
825
    # If no command option has been given, show table of clients,
545
826
    # optionally verbosely
549
830
    return commands
550
831
 
551
832
 
552
 
class command(object):
 
833
class command:
553
834
    """A namespace for command classes"""
554
835
 
555
 
    class Base(object):
 
836
    class Base:
556
837
        """Abstract base class for commands"""
557
 
        def run(self, clients, bus=None, mandos=None):
 
838
 
 
839
        def run(self, clients, bus=None):
558
840
            """Normal commands should implement run_on_one_client(),
559
841
but commands which want to operate on all clients at the same time can
560
842
override this run() method instead.
561
843
"""
562
 
            self.mandos = mandos
563
 
            for clientpath, properties in clients.items():
564
 
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
565
 
                          dbus_busname, str(clientpath))
566
 
                client = bus.get_object(dbus_busname, clientpath)
 
844
            self.bus = bus
 
845
            for client, properties in clients.items():
567
846
                self.run_on_one_client(client, properties)
568
847
 
569
 
 
570
848
    class IsEnabled(Base):
571
 
        def run(self, clients, bus=None, mandos=None):
572
 
            client, properties = next(iter(clients.items()))
573
 
            if self.is_enabled(client, properties):
 
849
        def run(self, clients, bus=None):
 
850
            properties = next(iter(clients.values()))
 
851
            if properties["Enabled"]:
574
852
                sys.exit(0)
575
853
            sys.exit(1)
576
 
        def is_enabled(self, client, properties):
577
 
            return properties["Enabled"]
578
 
 
579
854
 
580
855
    class Approve(Base):
581
856
        def run_on_one_client(self, client, properties):
582
 
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
583
 
                      client.__dbus_object_path__,
584
 
                      client_dbus_interface)
585
 
            client.Approve(dbus.Boolean(True),
586
 
                           dbus_interface=client_dbus_interface)
587
 
 
 
857
            self.bus.call_client_method(client, "Approve", True)
588
858
 
589
859
    class Deny(Base):
590
860
        def run_on_one_client(self, client, properties):
591
 
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
592
 
                      client.__dbus_object_path__,
593
 
                      client_dbus_interface)
594
 
            client.Approve(dbus.Boolean(False),
595
 
                           dbus_interface=client_dbus_interface)
596
 
 
 
861
            self.bus.call_client_method(client, "Approve", False)
597
862
 
598
863
    class Remove(Base):
599
 
        def run_on_one_client(self, client, properties):
600
 
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
601
 
                      dbus_busname, server_dbus_path,
602
 
                      server_dbus_interface,
603
 
                      str(client.__dbus_object_path__))
604
 
            self.mandos.RemoveClient(client.__dbus_object_path__)
605
 
 
 
864
        def run(self, clients, bus):
 
865
            for clientpath in frozenset(clients.keys()):
 
866
                bus.call_server_method("RemoveClient", clientpath)
606
867
 
607
868
    class Output(Base):
608
869
        """Abstract class for commands outputting client details"""
615
876
                        "Checker", "ExtendedTimeout", "Expires",
616
877
                        "LastCheckerStatus")
617
878
 
618
 
 
619
879
    class DumpJSON(Output):
620
 
        def run(self, clients, bus=None, mandos=None):
621
 
            data = {client["Name"]:
622
 
                    {key: self.dbus_boolean_to_bool(client[key])
 
880
        def run(self, clients, bus=None):
 
881
            data = {properties["Name"]:
 
882
                    {key: properties[key]
623
883
                     for key in self.all_keywords}
624
 
                    for client in clients.values()}
625
 
            print(json.dumps(data, indent=4, separators=(',', ': ')))
626
 
 
627
 
        @staticmethod
628
 
        def dbus_boolean_to_bool(value):
629
 
            if isinstance(value, dbus.Boolean):
630
 
                value = bool(value)
631
 
            return value
632
 
 
 
884
                    for properties in clients.values()}
 
885
            print(json.dumps(data, indent=4, separators=(",", ": ")))
633
886
 
634
887
    class PrintTable(Output):
635
888
        def __init__(self, verbose=False):
636
889
            self.verbose = verbose
637
890
 
638
 
        def run(self, clients, bus=None, mandos=None):
 
891
        def run(self, clients, bus=None):
639
892
            default_keywords = ("Name", "Enabled", "Timeout",
640
893
                                "LastCheckedOK")
641
894
            keywords = default_keywords
643
896
                keywords = self.all_keywords
644
897
            print(self.TableOfClients(clients.values(), keywords))
645
898
 
646
 
        class TableOfClients(object):
 
899
        class TableOfClients:
647
900
            tableheaders = {
648
901
                "Name": "Name",
649
902
                "Enabled": "Enabled",
676
929
 
677
930
            if sys.version_info.major == 2:
678
931
                __unicode__ = __str__
 
932
 
679
933
                def __str__(self):
680
934
                    return str(self).encode(
681
935
                        locale.getpreferredencoding())
702
956
 
703
957
            @classmethod
704
958
            def valuetostring(cls, value, keyword):
705
 
                if isinstance(value, dbus.Boolean):
 
959
                if isinstance(value, bool):
706
960
                    return "Yes" if value else "No"
707
961
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
708
962
                               "ApprovalDuration", "ExtendedTimeout"):
727
981
                                minutes=(td.seconds % 3600) // 60,
728
982
                                seconds=td.seconds % 60))
729
983
 
730
 
 
731
 
    class Property(Base):
 
984
    class PropertySetter(Base):
732
985
        "Abstract class for Actions for setting one client property"
733
986
 
734
 
        def run_on_one_client(self, client, properties):
 
987
        def run_on_one_client(self, client, properties=None):
735
988
            """Set the Client's D-Bus property"""
736
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
737
 
                      client.__dbus_object_path__,
738
 
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
739
 
                      self.propname, self.value_to_set
740
 
                      if not isinstance(self.value_to_set,
741
 
                                        dbus.Boolean)
742
 
                      else bool(self.value_to_set))
743
 
            client.Set(client_dbus_interface, self.propname,
744
 
                       self.value_to_set,
745
 
                       dbus_interface=dbus.PROPERTIES_IFACE)
 
989
            self.bus.set_client_property(client, self.propname,
 
990
                                         self.value_to_set)
746
991
 
747
992
        @property
748
993
        def propname(self):
749
994
            raise NotImplementedError()
750
995
 
751
 
 
752
 
    class Enable(Property):
753
 
        propname = "Enabled"
754
 
        value_to_set = dbus.Boolean(True)
755
 
 
756
 
 
757
 
    class Disable(Property):
758
 
        propname = "Enabled"
759
 
        value_to_set = dbus.Boolean(False)
760
 
 
761
 
 
762
 
    class BumpTimeout(Property):
 
996
    class Enable(PropertySetter):
 
997
        propname = "Enabled"
 
998
        value_to_set = True
 
999
 
 
1000
    class Disable(PropertySetter):
 
1001
        propname = "Enabled"
 
1002
        value_to_set = False
 
1003
 
 
1004
    class BumpTimeout(PropertySetter):
763
1005
        propname = "LastCheckedOK"
764
1006
        value_to_set = ""
765
1007
 
766
 
 
767
 
    class StartChecker(Property):
768
 
        propname = "CheckerRunning"
769
 
        value_to_set = dbus.Boolean(True)
770
 
 
771
 
 
772
 
    class StopChecker(Property):
773
 
        propname = "CheckerRunning"
774
 
        value_to_set = dbus.Boolean(False)
775
 
 
776
 
 
777
 
    class ApproveByDefault(Property):
778
 
        propname = "ApprovedByDefault"
779
 
        value_to_set = dbus.Boolean(True)
780
 
 
781
 
 
782
 
    class DenyByDefault(Property):
783
 
        propname = "ApprovedByDefault"
784
 
        value_to_set = dbus.Boolean(False)
785
 
 
786
 
 
787
 
    class PropertyValue(Property):
788
 
        "Abstract class for Property recieving a value as argument"
 
1008
    class StartChecker(PropertySetter):
 
1009
        propname = "CheckerRunning"
 
1010
        value_to_set = True
 
1011
 
 
1012
    class StopChecker(PropertySetter):
 
1013
        propname = "CheckerRunning"
 
1014
        value_to_set = False
 
1015
 
 
1016
    class ApproveByDefault(PropertySetter):
 
1017
        propname = "ApprovedByDefault"
 
1018
        value_to_set = True
 
1019
 
 
1020
    class DenyByDefault(PropertySetter):
 
1021
        propname = "ApprovedByDefault"
 
1022
        value_to_set = False
 
1023
 
 
1024
    class PropertySetterValue(PropertySetter):
 
1025
        """Abstract class for PropertySetter recieving a value as
 
1026
constructor argument instead of a class attribute."""
 
1027
 
789
1028
        def __init__(self, value):
790
1029
            self.value_to_set = value
791
1030
 
 
1031
        @classmethod
 
1032
        def argparse(cls, argtype):
 
1033
            def cmdtype(arg):
 
1034
                return cls(argtype(arg))
 
1035
            return cmdtype
792
1036
 
793
 
    class SetChecker(PropertyValue):
 
1037
    class SetChecker(PropertySetterValue):
794
1038
        propname = "Checker"
795
1039
 
796
 
 
797
 
    class SetHost(PropertyValue):
 
1040
    class SetHost(PropertySetterValue):
798
1041
        propname = "Host"
799
1042
 
800
 
 
801
 
    class SetSecret(PropertyValue):
 
1043
    class SetSecret(PropertySetterValue):
802
1044
        propname = "Secret"
803
1045
 
804
1046
        @property
811
1053
            self._vts = value.read()
812
1054
            value.close()
813
1055
 
814
 
 
815
 
    class MillisecondsPropertyValueArgument(PropertyValue):
816
 
        """Abstract class for PropertyValue taking a value argument as
817
 
a datetime.timedelta() but should store it as milliseconds."""
 
1056
    class PropertySetterValueMilliseconds(PropertySetterValue):
 
1057
        """Abstract class for PropertySetterValue taking a value
 
1058
argument as a datetime.timedelta() but should store it as
 
1059
milliseconds."""
818
1060
 
819
1061
        @property
820
1062
        def value_to_set(self):
825
1067
            "When setting, convert value from a datetime.timedelta"
826
1068
            self._vts = int(round(value.total_seconds() * 1000))
827
1069
 
828
 
 
829
 
    class SetTimeout(MillisecondsPropertyValueArgument):
 
1070
    class SetTimeout(PropertySetterValueMilliseconds):
830
1071
        propname = "Timeout"
831
1072
 
832
 
 
833
 
    class SetExtendedTimeout(MillisecondsPropertyValueArgument):
 
1073
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
834
1074
        propname = "ExtendedTimeout"
835
1075
 
836
 
 
837
 
    class SetInterval(MillisecondsPropertyValueArgument):
 
1076
    class SetInterval(PropertySetterValueMilliseconds):
838
1077
        propname = "Interval"
839
1078
 
840
 
 
841
 
    class SetApprovalDelay(MillisecondsPropertyValueArgument):
 
1079
    class SetApprovalDelay(PropertySetterValueMilliseconds):
842
1080
        propname = "ApprovalDelay"
843
1081
 
844
 
 
845
 
    class SetApprovalDuration(MillisecondsPropertyValueArgument):
 
1082
    class SetApprovalDuration(PropertySetterValueMilliseconds):
846
1083
        propname = "ApprovalDuration"
847
1084
 
848
1085
 
881
1118
                                                     "output"))
882
1119
 
883
1120
 
 
1121
class Unique:
 
1122
    """Class for objects which exist only to be unique objects, since
 
1123
unittest.mock.sentinel only exists in Python 3.3"""
 
1124
 
 
1125
 
884
1126
class Test_string_to_delta(TestCaseWithAssertLogs):
885
1127
    # Just test basic RFC 3339 functionality here, the doc string for
886
1128
    # rfc3339_duration_to_delta() already has more comprehensive
887
 
    # tests, which is run by doctest.
 
1129
    # tests, which are run by doctest.
888
1130
 
889
1131
    def test_rfc3339_zero_seconds(self):
890
1132
        self.assertEqual(datetime.timedelta(),
914
1156
 
915
1157
    def test_actions_requires_client_or_all(self):
916
1158
        for action, value in self.actions.items():
917
 
            options = self.parser.parse_args()
918
 
            setattr(options, action, value)
 
1159
            args = self.actionargs(action, value)
919
1160
            with self.assertParseError():
920
 
                self.check_option_syntax(options)
 
1161
                self.parse_args(args)
921
1162
 
922
 
    # This mostly corresponds to the definition from has_actions() in
 
1163
    # This mostly corresponds to the definition from has_commands() in
923
1164
    # check_option_syntax()
924
1165
    actions = {
925
 
        # The actual values set here are not that important, but we do
926
 
        # at least stick to the correct types, even though they are
927
 
        # never used
928
 
        "enable": True,
929
 
        "disable": True,
930
 
        "bump_timeout": True,
931
 
        "start_checker": True,
932
 
        "stop_checker": True,
933
 
        "is_enabled": True,
934
 
        "remove": True,
935
 
        "checker": "x",
936
 
        "timeout": datetime.timedelta(),
937
 
        "extended_timeout": datetime.timedelta(),
938
 
        "interval": datetime.timedelta(),
939
 
        "approved_by_default": True,
940
 
        "approval_delay": datetime.timedelta(),
941
 
        "approval_duration": datetime.timedelta(),
942
 
        "host": "x",
943
 
        "secret": io.BytesIO(b"x"),
944
 
        "approve": True,
945
 
        "deny": True,
 
1166
        "--enable": None,
 
1167
        "--disable": None,
 
1168
        "--bump-timeout": None,
 
1169
        "--start-checker": None,
 
1170
        "--stop-checker": None,
 
1171
        "--is-enabled": None,
 
1172
        "--remove": None,
 
1173
        "--checker": "x",
 
1174
        "--timeout": "PT0S",
 
1175
        "--extended-timeout": "PT0S",
 
1176
        "--interval": "PT0S",
 
1177
        "--approve-by-default": None,
 
1178
        "--deny-by-default": None,
 
1179
        "--approval-delay": "PT0S",
 
1180
        "--approval-duration": "PT0S",
 
1181
        "--host": "hostname",
 
1182
        "--secret": "/dev/null",
 
1183
        "--approve": None,
 
1184
        "--deny": None,
946
1185
    }
947
1186
 
 
1187
    @staticmethod
 
1188
    def actionargs(action, value, *args):
 
1189
        if value is not None:
 
1190
            return [action, value] + list(args)
 
1191
        else:
 
1192
            return [action] + list(args)
 
1193
 
948
1194
    @contextlib.contextmanager
949
1195
    def assertParseError(self):
950
1196
        with self.assertRaises(SystemExit) as e:
955
1201
        # /argparse.html#exiting-methods
956
1202
        self.assertEqual(2, e.exception.code)
957
1203
 
 
1204
    def parse_args(self, args):
 
1205
        options = self.parser.parse_args(args)
 
1206
        check_option_syntax(self.parser, options)
 
1207
 
958
1208
    @staticmethod
959
1209
    @contextlib.contextmanager
960
1210
    def redirect_stderr_to_devnull():
971
1221
 
972
1222
    def test_actions_all_conflicts_with_verbose(self):
973
1223
        for action, value in self.actions.items():
974
 
            options = self.parser.parse_args()
975
 
            setattr(options, action, value)
976
 
            options.all = True
977
 
            options.verbose = True
 
1224
            args = self.actionargs(action, value, "--all",
 
1225
                                   "--verbose")
978
1226
            with self.assertParseError():
979
 
                self.check_option_syntax(options)
 
1227
                self.parse_args(args)
980
1228
 
981
1229
    def test_actions_with_client_conflicts_with_verbose(self):
982
1230
        for action, value in self.actions.items():
983
 
            options = self.parser.parse_args()
984
 
            setattr(options, action, value)
985
 
            options.verbose = True
986
 
            options.client = ["foo"]
 
1231
            args = self.actionargs(action, value, "--verbose",
 
1232
                                   "client")
987
1233
            with self.assertParseError():
988
 
                self.check_option_syntax(options)
 
1234
                self.parse_args(args)
989
1235
 
990
1236
    def test_dump_json_conflicts_with_verbose(self):
991
 
        options = self.parser.parse_args()
992
 
        options.dump_json = True
993
 
        options.verbose = True
 
1237
        args = ["--dump-json", "--verbose"]
994
1238
        with self.assertParseError():
995
 
            self.check_option_syntax(options)
 
1239
            self.parse_args(args)
996
1240
 
997
1241
    def test_dump_json_conflicts_with_action(self):
998
1242
        for action, value in self.actions.items():
999
 
            options = self.parser.parse_args()
1000
 
            setattr(options, action, value)
1001
 
            options.dump_json = True
 
1243
            args = self.actionargs(action, value, "--dump-json")
1002
1244
            with self.assertParseError():
1003
 
                self.check_option_syntax(options)
 
1245
                self.parse_args(args)
1004
1246
 
1005
1247
    def test_all_can_not_be_alone(self):
1006
 
        options = self.parser.parse_args()
1007
 
        options.all = True
 
1248
        args = ["--all"]
1008
1249
        with self.assertParseError():
1009
 
            self.check_option_syntax(options)
 
1250
            self.parse_args(args)
1010
1251
 
1011
1252
    def test_all_is_ok_with_any_action(self):
1012
1253
        for action, value in self.actions.items():
1013
 
            options = self.parser.parse_args()
1014
 
            setattr(options, action, value)
1015
 
            options.all = True
1016
 
            self.check_option_syntax(options)
 
1254
            args = self.actionargs(action, value, "--all")
 
1255
            self.parse_args(args)
1017
1256
 
1018
1257
    def test_any_action_is_ok_with_one_client(self):
1019
1258
        for action, value in self.actions.items():
1020
 
            options = self.parser.parse_args()
1021
 
            setattr(options, action, value)
1022
 
            options.client = ["foo"]
1023
 
            self.check_option_syntax(options)
 
1259
            args = self.actionargs(action, value, "client")
 
1260
            self.parse_args(args)
1024
1261
 
1025
1262
    def test_one_client_with_all_actions_except_is_enabled(self):
1026
 
        options = self.parser.parse_args()
1027
1263
        for action, value in self.actions.items():
1028
 
            if action == "is_enabled":
 
1264
            if action == "--is-enabled":
1029
1265
                continue
1030
 
            setattr(options, action, value)
1031
 
        options.client = ["foo"]
1032
 
        self.check_option_syntax(options)
 
1266
            args = self.actionargs(action, value, "client")
 
1267
            self.parse_args(args)
1033
1268
 
1034
1269
    def test_two_clients_with_all_actions_except_is_enabled(self):
1035
 
        options = self.parser.parse_args()
1036
1270
        for action, value in self.actions.items():
1037
 
            if action == "is_enabled":
 
1271
            if action == "--is-enabled":
1038
1272
                continue
1039
 
            setattr(options, action, value)
1040
 
        options.client = ["foo", "barbar"]
1041
 
        self.check_option_syntax(options)
 
1273
            args = self.actionargs(action, value, "client1",
 
1274
                                   "client2")
 
1275
            self.parse_args(args)
1042
1276
 
1043
1277
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1044
1278
        for action, value in self.actions.items():
1045
 
            if action == "is_enabled":
 
1279
            if action == "--is-enabled":
1046
1280
                continue
1047
 
            options = self.parser.parse_args()
1048
 
            setattr(options, action, value)
1049
 
            options.client = ["foo", "barbar"]
1050
 
            self.check_option_syntax(options)
 
1281
            args = self.actionargs(action, value, "client1",
 
1282
                                   "client2")
 
1283
            self.parse_args(args)
1051
1284
 
1052
1285
    def test_is_enabled_fails_without_client(self):
1053
 
        options = self.parser.parse_args()
1054
 
        options.is_enabled = True
 
1286
        args = ["--is-enabled"]
1055
1287
        with self.assertParseError():
1056
 
            self.check_option_syntax(options)
 
1288
            self.parse_args(args)
1057
1289
 
1058
1290
    def test_is_enabled_fails_with_two_clients(self):
1059
 
        options = self.parser.parse_args()
1060
 
        options.is_enabled = True
1061
 
        options.client = ["foo", "barbar"]
 
1291
        args = ["--is-enabled", "client1", "client2"]
1062
1292
        with self.assertParseError():
1063
 
            self.check_option_syntax(options)
 
1293
            self.parse_args(args)
1064
1294
 
1065
1295
    def test_remove_can_only_be_combined_with_action_deny(self):
1066
1296
        for action, value in self.actions.items():
1067
 
            if action in {"remove", "deny"}:
 
1297
            if action in {"--remove", "--deny"}:
1068
1298
                continue
1069
 
            options = self.parser.parse_args()
1070
 
            setattr(options, action, value)
1071
 
            options.all = True
1072
 
            options.remove = True
 
1299
            args = self.actionargs(action, value, "--all",
 
1300
                                   "--remove")
1073
1301
            with self.assertParseError():
1074
 
                self.check_option_syntax(options)
1075
 
 
1076
 
 
1077
 
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1078
 
    def test_calls_and_returns_get_object_on_bus(self):
1079
 
        class MockBus(object):
1080
 
            called = False
1081
 
            def get_object(mockbus_self, busname, dbus_path):
1082
 
                # Note that "self" is still the testcase instance,
1083
 
                # this MockBus instance is in "mockbus_self".
1084
 
                self.assertEqual(dbus_busname, busname)
1085
 
                self.assertEqual(server_dbus_path, dbus_path)
1086
 
                mockbus_self.called = True
1087
 
                return mockbus_self
1088
 
 
1089
 
        mockbus = get_mandos_dbus_object(bus=MockBus())
1090
 
        self.assertIsInstance(mockbus, MockBus)
1091
 
        self.assertTrue(mockbus.called)
1092
 
 
1093
 
    def test_logs_and_exits_on_dbus_error(self):
1094
 
        class MockBusFailing(object):
1095
 
            def get_object(self, busname, dbus_path):
1096
 
                raise dbus.exceptions.DBusException("Test")
1097
 
 
1098
 
        with self.assertLogs(log, logging.CRITICAL):
1099
 
            with self.assertRaises(SystemExit) as e:
1100
 
                bus = get_mandos_dbus_object(bus=MockBusFailing())
1101
 
 
1102
 
        if isinstance(e.exception.code, int):
1103
 
            self.assertNotEqual(0, e.exception.code)
1104
 
        else:
1105
 
            self.assertIsNotNone(e.exception.code)
1106
 
 
1107
 
 
1108
 
class Test_get_managed_objects(TestCaseWithAssertLogs):
1109
 
    def test_calls_and_returns_GetManagedObjects(self):
1110
 
        managed_objects = {"/clients/foo": { "Name": "foo"}}
1111
 
        class MockObjectManager(object):
1112
 
            def GetManagedObjects(self):
1113
 
                return managed_objects
1114
 
        retval = get_managed_objects(MockObjectManager())
1115
 
        self.assertDictEqual(managed_objects, retval)
1116
 
 
1117
 
    def test_logs_and_exits_on_dbus_error(self):
 
1302
                self.parse_args(args)
 
1303
 
 
1304
 
 
1305
class Test_dbus_exceptions(unittest.TestCase):
 
1306
 
 
1307
    def test_dbus_ConnectFailed_is_Error(self):
 
1308
        with self.assertRaises(dbus.Error):
 
1309
            raise dbus.ConnectFailed()
 
1310
 
 
1311
 
 
1312
class Test_dbus_MandosBus(unittest.TestCase):
 
1313
 
 
1314
    class MockMandosBus(dbus.MandosBus):
 
1315
        def __init__(self):
 
1316
            self._name = "se.recompile.Mandos"
 
1317
            self._server_path = "/"
 
1318
            self._server_interface = "se.recompile.Mandos"
 
1319
            self._client_interface = "se.recompile.Mandos.Client"
 
1320
            self.calls = []
 
1321
            self.call_method_return = Unique()
 
1322
 
 
1323
        def call_method(self, methodname, busname, objectpath,
 
1324
                        interface, *args):
 
1325
            self.calls.append((methodname, busname, objectpath,
 
1326
                               interface, args))
 
1327
            return self.call_method_return
 
1328
 
 
1329
    def setUp(self):
 
1330
        self.bus = self.MockMandosBus()
 
1331
 
 
1332
    def test_set_client_property(self):
 
1333
        self.bus.set_client_property("objectpath", "key", "value")
 
1334
        expected_call = ("Set", self.bus._name, "objectpath",
 
1335
                         "org.freedesktop.DBus.Properties",
 
1336
                         (self.bus._client_interface, "key", "value"))
 
1337
        self.assertIn(expected_call, self.bus.calls)
 
1338
 
 
1339
    def test_call_client_method(self):
 
1340
        ret = self.bus.call_client_method("objectpath", "methodname")
 
1341
        self.assertIs(self.bus.call_method_return, ret)
 
1342
        expected_call = ("methodname", self.bus._name, "objectpath",
 
1343
                         self.bus._client_interface, ())
 
1344
        self.assertIn(expected_call, self.bus.calls)
 
1345
 
 
1346
    def test_call_client_method_with_args(self):
 
1347
        args = (Unique(), Unique())
 
1348
        ret = self.bus.call_client_method("objectpath", "methodname",
 
1349
                                          *args)
 
1350
        self.assertIs(self.bus.call_method_return, ret)
 
1351
        expected_call = ("methodname", self.bus._name, "objectpath",
 
1352
                         self.bus._client_interface,
 
1353
                         (args[0], args[1]))
 
1354
        self.assertIn(expected_call, self.bus.calls)
 
1355
 
 
1356
    def test_get_clients_and_properties(self):
 
1357
        managed_objects = {
 
1358
            "objectpath": {
 
1359
                self.bus._client_interface: {
 
1360
                    "key": "value",
 
1361
                    "bool": True,
 
1362
                },
 
1363
                "irrelevant_interface": {
 
1364
                    "key": "othervalue",
 
1365
                    "bool": False,
 
1366
                },
 
1367
            },
 
1368
            "other_objectpath": {
 
1369
                "other_irrelevant_interface": {
 
1370
                    "key": "value 3",
 
1371
                    "bool": None,
 
1372
                },
 
1373
            },
 
1374
        }
 
1375
        expected_clients_and_properties = {
 
1376
            "objectpath": {
 
1377
                "key": "value",
 
1378
                "bool": True,
 
1379
            }
 
1380
        }
 
1381
        self.bus.call_method_return = managed_objects
 
1382
        ret = self.bus.get_clients_and_properties()
 
1383
        self.assertDictEqual(expected_clients_and_properties, ret)
 
1384
        expected_call = ("GetManagedObjects", self.bus._name,
 
1385
                         self.bus._server_path,
 
1386
                         "org.freedesktop.DBus.ObjectManager", ())
 
1387
        self.assertIn(expected_call, self.bus.calls)
 
1388
 
 
1389
    def test_call_server_method(self):
 
1390
        ret = self.bus.call_server_method("methodname")
 
1391
        self.assertIs(self.bus.call_method_return, ret)
 
1392
        expected_call = ("methodname", self.bus._name,
 
1393
                         self.bus._server_path,
 
1394
                         self.bus._server_interface, ())
 
1395
        self.assertIn(expected_call, self.bus.calls)
 
1396
 
 
1397
    def test_call_server_method_with_args(self):
 
1398
        args = (Unique(), Unique())
 
1399
        ret = self.bus.call_server_method("methodname", *args)
 
1400
        self.assertIs(self.bus.call_method_return, ret)
 
1401
        expected_call = ("methodname", self.bus._name,
 
1402
                         self.bus._server_path,
 
1403
                         self.bus._server_interface,
 
1404
                         (args[0], args[1]))
 
1405
        self.assertIn(expected_call, self.bus.calls)
 
1406
 
 
1407
 
 
1408
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
 
1409
 
 
1410
    def MockDBusPython_func(self, func):
 
1411
        class mock_dbus_python:
 
1412
            """mock dbus-python module"""
 
1413
            class exceptions:
 
1414
                """Pseudo-namespace"""
 
1415
                class DBusException(Exception):
 
1416
                    pass
 
1417
            class SystemBus:
 
1418
                @staticmethod
 
1419
                def get_object(busname, objectpath):
 
1420
                    DBusObject = collections.namedtuple(
 
1421
                        "DBusObject", ("methodname", "Set"))
 
1422
                    def method(*args, **kwargs):
 
1423
                        self.assertEqual({"dbus_interface":
 
1424
                                          "interface"},
 
1425
                                         kwargs)
 
1426
                        return func(*args)
 
1427
                    def set_property(interface, key, value,
 
1428
                                     dbus_interface=None):
 
1429
                        self.assertEqual(
 
1430
                            "org.freedesktop.DBus.Properties",
 
1431
                            dbus_interface)
 
1432
                        self.assertEqual("Secret", key)
 
1433
                        return func(interface, key, value,
 
1434
                                    dbus_interface=dbus_interface)
 
1435
                    return DBusObject(methodname=method,
 
1436
                                      Set=set_property)
 
1437
            class Boolean:
 
1438
                def __init__(self, value):
 
1439
                    self.value = bool(value)
 
1440
                def __bool__(self):
 
1441
                    return self.value
 
1442
                if sys.version_info.major == 2:
 
1443
                    __nonzero__ = __bool__
 
1444
            class ObjectPath(str):
 
1445
                pass
 
1446
            class Dictionary(dict):
 
1447
                pass
 
1448
            class ByteArray(bytes):
 
1449
                pass
 
1450
        return mock_dbus_python
 
1451
 
 
1452
    def call_method(self, bus, methodname, busname, objectpath,
 
1453
                    interface, *args):
 
1454
        with self.assertLogs(log, logging.DEBUG):
 
1455
            return bus.call_method(methodname, busname, objectpath,
 
1456
                                   interface, *args)
 
1457
 
 
1458
    def test_call_method_returns(self):
 
1459
        expected_method_return = Unique()
 
1460
        method_args = (Unique(), Unique())
 
1461
        def func(*args):
 
1462
            self.assertEqual(len(method_args), len(args))
 
1463
            for marg, arg in zip(method_args, args):
 
1464
                self.assertIs(marg, arg)
 
1465
            return expected_method_return
 
1466
        mock_dbus_python = self.MockDBusPython_func(func)
 
1467
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1468
        ret = self.call_method(bus, "methodname", "busname",
 
1469
                               "objectpath", "interface",
 
1470
                               *method_args)
 
1471
        self.assertIs(ret, expected_method_return)
 
1472
 
 
1473
    def test_call_method_filters_bool_true(self):
 
1474
        def func():
 
1475
            return method_return
 
1476
        mock_dbus_python = self.MockDBusPython_func(func)
 
1477
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1478
        method_return = mock_dbus_python.Boolean(True)
 
1479
        ret = self.call_method(bus, "methodname", "busname",
 
1480
                               "objectpath", "interface")
 
1481
        self.assertTrue(ret)
 
1482
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
 
1483
 
 
1484
    def test_call_method_filters_bool_false(self):
 
1485
        def func():
 
1486
            return method_return
 
1487
        mock_dbus_python = self.MockDBusPython_func(func)
 
1488
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1489
        method_return = mock_dbus_python.Boolean(False)
 
1490
        ret = self.call_method(bus, "methodname", "busname",
 
1491
                               "objectpath", "interface")
 
1492
        self.assertFalse(ret)
 
1493
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
 
1494
 
 
1495
    def test_call_method_filters_objectpath(self):
 
1496
        def func():
 
1497
            return method_return
 
1498
        mock_dbus_python = self.MockDBusPython_func(func)
 
1499
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1500
        method_return = mock_dbus_python.ObjectPath("objectpath")
 
1501
        ret = self.call_method(bus, "methodname", "busname",
 
1502
                               "objectpath", "interface")
 
1503
        self.assertEqual("objectpath", ret)
 
1504
        self.assertIsNot("objectpath", ret)
 
1505
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
 
1506
 
 
1507
    def test_call_method_filters_booleans_in_dict(self):
 
1508
        def func():
 
1509
            return method_return
 
1510
        mock_dbus_python = self.MockDBusPython_func(func)
 
1511
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1512
        method_return = mock_dbus_python.Dictionary(
 
1513
        {mock_dbus_python.Boolean(True):
 
1514
         mock_dbus_python.Boolean(False),
 
1515
         mock_dbus_python.Boolean(False):
 
1516
         mock_dbus_python.Boolean(True)})
 
1517
        ret = self.call_method(bus, "methodname", "busname",
 
1518
                               "objectpath", "interface")
 
1519
        expected_method_return = {True: False,
 
1520
                                  False: True}
 
1521
        self.assertEqual(expected_method_return, ret)
 
1522
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1523
 
 
1524
    def test_call_method_filters_objectpaths_in_dict(self):
 
1525
        def func():
 
1526
            return method_return
 
1527
        mock_dbus_python = self.MockDBusPython_func(func)
 
1528
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1529
        method_return = mock_dbus_python.Dictionary(
 
1530
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
 
1531
         mock_dbus_python.ObjectPath("objectpath_value_1"),
 
1532
         mock_dbus_python.ObjectPath("objectpath_key_2"):
 
1533
         mock_dbus_python.ObjectPath("objectpath_value_2")})
 
1534
        ret = self.call_method(bus, "methodname", "busname",
 
1535
                               "objectpath", "interface")
 
1536
        expected_method_return = {str(key): str(value)
 
1537
                                  for key, value in
 
1538
                                  method_return.items()}
 
1539
        self.assertEqual(expected_method_return, ret)
 
1540
        self.assertIsInstance(ret, dict)
 
1541
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1542
 
 
1543
    def test_call_method_filters_dict_in_dict(self):
 
1544
        def func():
 
1545
            return method_return
 
1546
        mock_dbus_python = self.MockDBusPython_func(func)
 
1547
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1548
        method_return = mock_dbus_python.Dictionary(
 
1549
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
 
1550
                                              "key12": "value12"}),
 
1551
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
 
1552
                                              "key22": "value22"})})
 
1553
        ret = self.call_method(bus, "methodname", "busname",
 
1554
                               "objectpath", "interface")
 
1555
        expected_method_return = {
 
1556
            "key1": {"key11": "value11",
 
1557
                     "key12": "value12"},
 
1558
            "key2": {"key21": "value21",
 
1559
                     "key22": "value22"},
 
1560
        }
 
1561
        self.assertEqual(expected_method_return, ret)
 
1562
        self.assertIsInstance(ret, dict)
 
1563
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1564
        for key, value in ret.items():
 
1565
            self.assertIsInstance(value, dict)
 
1566
            self.assertEqual(expected_method_return[key], value)
 
1567
            self.assertNotIsInstance(value,
 
1568
                                     mock_dbus_python.Dictionary)
 
1569
 
 
1570
    def test_call_method_filters_dict_three_deep(self):
 
1571
        def func():
 
1572
            return method_return
 
1573
        mock_dbus_python = self.MockDBusPython_func(func)
 
1574
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1575
        method_return = mock_dbus_python.Dictionary(
 
1576
            {"key1":
 
1577
             mock_dbus_python.Dictionary(
 
1578
                 {"key2":
 
1579
                  mock_dbus_python.Dictionary(
 
1580
                      {"key3":
 
1581
                       mock_dbus_python.Boolean(True),
 
1582
                       }),
 
1583
                  }),
 
1584
             })
 
1585
        ret = self.call_method(bus, "methodname", "busname",
 
1586
                               "objectpath", "interface")
 
1587
        expected_method_return = {"key1": {"key2": {"key3": True}}}
 
1588
        self.assertEqual(expected_method_return, ret)
 
1589
        self.assertIsInstance(ret, dict)
 
1590
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1591
        self.assertIsInstance(ret["key1"], dict)
 
1592
        self.assertNotIsInstance(ret["key1"],
 
1593
                                 mock_dbus_python.Dictionary)
 
1594
        self.assertIsInstance(ret["key1"]["key2"], dict)
 
1595
        self.assertNotIsInstance(ret["key1"]["key2"],
 
1596
                                 mock_dbus_python.Dictionary)
 
1597
        self.assertTrue(ret["key1"]["key2"]["key3"])
 
1598
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
 
1599
                                 mock_dbus_python.Boolean)
 
1600
 
 
1601
    def test_call_method_handles_exception(self):
1118
1602
        dbus_logger = logging.getLogger("dbus.proxies")
1119
1603
 
1120
 
        class MockObjectManagerFailing(object):
1121
 
            def GetManagedObjects(self):
1122
 
                dbus_logger.error("Test")
1123
 
                raise dbus.exceptions.DBusException("Test")
 
1604
        def func():
 
1605
            dbus_logger.error("Test")
 
1606
            raise mock_dbus_python.exceptions.DBusException()
 
1607
 
 
1608
        mock_dbus_python = self.MockDBusPython_func(func)
 
1609
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1124
1610
 
1125
1611
        class CountingHandler(logging.Handler):
1126
1612
            count = 0
1132
1618
        dbus_logger.addHandler(counting_handler)
1133
1619
 
1134
1620
        try:
1135
 
            with self.assertLogs(log, logging.CRITICAL) as watcher:
1136
 
                with self.assertRaises(SystemExit) as e:
1137
 
                    get_managed_objects(MockObjectManagerFailing())
 
1621
            with self.assertRaises(dbus.Error) as e:
 
1622
                self.call_method(bus, "methodname", "busname",
 
1623
                                 "objectpath", "interface")
1138
1624
        finally:
1139
1625
            dbus_logger.removeFilter(counting_handler)
1140
1626
 
 
1627
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
 
1628
 
1141
1629
        # Make sure the dbus logger was suppressed
1142
1630
        self.assertEqual(0, counting_handler.count)
1143
1631
 
1144
 
        # Test that the dbus_logger still works
1145
 
        with self.assertLogs(dbus_logger, logging.ERROR):
1146
 
            dbus_logger.error("Test")
1147
 
 
1148
 
        if isinstance(e.exception.code, int):
1149
 
            self.assertNotEqual(0, e.exception.code)
1150
 
        else:
1151
 
            self.assertIsNotNone(e.exception.code)
 
1632
    def test_Set_Secret_sends_bytearray(self):
 
1633
        ret = [None]
 
1634
        def func(*args, **kwargs):
 
1635
            ret[0] = (args, kwargs)
 
1636
        mock_dbus_python = self.MockDBusPython_func(func)
 
1637
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1638
        bus.set_client_property("objectpath", "Secret", "value")
 
1639
        expected_call = (("se.recompile.Mandos.Client", "Secret",
 
1640
                          mock_dbus_python.ByteArray(b"value")),
 
1641
                         {"dbus_interface":
 
1642
                          "org.freedesktop.DBus.Properties"})
 
1643
        self.assertEqual(expected_call, ret[0])
 
1644
        if sys.version_info.major == 2:
 
1645
            self.assertIsInstance(ret[0][0][-1],
 
1646
                                  mock_dbus_python.ByteArray)
 
1647
 
 
1648
    def test_get_object_converts_to_correct_exception(self):
 
1649
        bus = dbus_python_adapter.SystemBus(
 
1650
            self.fake_dbus_python_raises_exception_on_connect)
 
1651
        with self.assertRaises(dbus.ConnectFailed):
 
1652
            self.call_method(bus, "methodname", "busname",
 
1653
                             "objectpath", "interface")
 
1654
 
 
1655
    class fake_dbus_python_raises_exception_on_connect:
 
1656
        """fake dbus-python module"""
 
1657
        class exceptions:
 
1658
            """Pseudo-namespace"""
 
1659
            class DBusException(Exception):
 
1660
                pass
 
1661
 
 
1662
        @classmethod
 
1663
        def SystemBus(cls):
 
1664
            def get_object(busname, objectpath):
 
1665
                raise cls.exceptions.DBusException()
 
1666
            Bus = collections.namedtuple("Bus", ["get_object"])
 
1667
            return Bus(get_object=get_object)
 
1668
 
 
1669
 
 
1670
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
 
1671
    class mock_dbus_python:
 
1672
        """mock dbus-python modules"""
 
1673
        class SystemBus:
 
1674
            @staticmethod
 
1675
            def get_object(busname, objectpath):
 
1676
                return Unique()
 
1677
 
 
1678
    def setUp(self):
 
1679
        self.bus = dbus_python_adapter.CachingBus(
 
1680
            self.mock_dbus_python)
 
1681
 
 
1682
    def test_returns_distinct_objectpaths(self):
 
1683
        obj1 = self.bus.get_object("busname", "objectpath1")
 
1684
        self.assertIsInstance(obj1, Unique)
 
1685
        obj2 = self.bus.get_object("busname", "objectpath2")
 
1686
        self.assertIsInstance(obj2, Unique)
 
1687
        self.assertIsNot(obj1, obj2)
 
1688
 
 
1689
    def test_returns_distinct_busnames(self):
 
1690
        obj1 = self.bus.get_object("busname1", "objectpath")
 
1691
        self.assertIsInstance(obj1, Unique)
 
1692
        obj2 = self.bus.get_object("busname2", "objectpath")
 
1693
        self.assertIsInstance(obj2, Unique)
 
1694
        self.assertIsNot(obj1, obj2)
 
1695
 
 
1696
    def test_returns_distinct_both(self):
 
1697
        obj1 = self.bus.get_object("busname1", "objectpath")
 
1698
        self.assertIsInstance(obj1, Unique)
 
1699
        obj2 = self.bus.get_object("busname2", "objectpath")
 
1700
        self.assertIsInstance(obj2, Unique)
 
1701
        self.assertIsNot(obj1, obj2)
 
1702
 
 
1703
    def test_returns_same(self):
 
1704
        obj1 = self.bus.get_object("busname", "objectpath")
 
1705
        self.assertIsInstance(obj1, Unique)
 
1706
        obj2 = self.bus.get_object("busname", "objectpath")
 
1707
        self.assertIsInstance(obj2, Unique)
 
1708
        self.assertIs(obj1, obj2)
 
1709
 
 
1710
    def test_returns_same_old(self):
 
1711
        obj1 = self.bus.get_object("busname1", "objectpath1")
 
1712
        self.assertIsInstance(obj1, Unique)
 
1713
        obj2 = self.bus.get_object("busname2", "objectpath2")
 
1714
        self.assertIsInstance(obj2, Unique)
 
1715
        obj1b = self.bus.get_object("busname1", "objectpath1")
 
1716
        self.assertIsInstance(obj1b, Unique)
 
1717
        self.assertIsNot(obj1, obj2)
 
1718
        self.assertIsNot(obj2, obj1b)
 
1719
        self.assertIs(obj1, obj1b)
 
1720
 
 
1721
 
 
1722
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
 
1723
 
 
1724
    def Stub_pydbus_func(self, func):
 
1725
        class stub_pydbus:
 
1726
            """stub pydbus module"""
 
1727
            class SystemBus:
 
1728
                @staticmethod
 
1729
                def get(busname, objectpath):
 
1730
                    DBusObject = collections.namedtuple(
 
1731
                        "DBusObject", ("methodname",))
 
1732
                    return {"interface":
 
1733
                            DBusObject(methodname=func)}
 
1734
        return stub_pydbus
 
1735
 
 
1736
    def call_method(self, bus, methodname, busname, objectpath,
 
1737
                    interface, *args):
 
1738
        with self.assertLogs(log, logging.DEBUG):
 
1739
            return bus.call_method(methodname, busname, objectpath,
 
1740
                                   interface, *args)
 
1741
 
 
1742
    def test_call_method_returns(self):
 
1743
        expected_method_return = Unique()
 
1744
        method_args = (Unique(), Unique())
 
1745
        def func(*args):
 
1746
            self.assertEqual(len(method_args), len(args))
 
1747
            for marg, arg in zip(method_args, args):
 
1748
                self.assertIs(marg, arg)
 
1749
            return expected_method_return
 
1750
        stub_pydbus = self.Stub_pydbus_func(func)
 
1751
        bus = pydbus_adapter.SystemBus(stub_pydbus)
 
1752
        ret = self.call_method(bus, "methodname", "busname",
 
1753
                               "objectpath", "interface",
 
1754
                               *method_args)
 
1755
        self.assertIs(ret, expected_method_return)
 
1756
 
 
1757
    def test_call_method_handles_exception(self):
 
1758
        def func():
 
1759
            raise gi.repository.GLib.Error()
 
1760
 
 
1761
        stub_pydbus = self.Stub_pydbus_func(func)
 
1762
        bus = pydbus_adapter.SystemBus(stub_pydbus)
 
1763
 
 
1764
        with self.assertRaises(dbus.Error) as e:
 
1765
            self.call_method(bus, "methodname", "busname",
 
1766
                             "objectpath", "interface")
 
1767
 
 
1768
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
 
1769
 
 
1770
    def test_get_converts_to_correct_exception(self):
 
1771
        bus = pydbus_adapter.SystemBus(
 
1772
            self.fake_pydbus_raises_exception_on_connect)
 
1773
        with self.assertRaises(dbus.ConnectFailed):
 
1774
            self.call_method(bus, "methodname", "busname",
 
1775
                             "objectpath", "interface")
 
1776
 
 
1777
    class fake_pydbus_raises_exception_on_connect:
 
1778
        """fake dbus-python module"""
 
1779
        @classmethod
 
1780
        def SystemBus(cls):
 
1781
            def get(busname, objectpath):
 
1782
                raise gi.repository.GLib.Error()
 
1783
            Bus = collections.namedtuple("Bus", ["get"])
 
1784
            return Bus(get=get)
 
1785
 
 
1786
    def test_set_property_uses_setattr(self):
 
1787
        class Object:
 
1788
            pass
 
1789
        obj = Object()
 
1790
        class pydbus_spy:
 
1791
            class SystemBus:
 
1792
                @staticmethod
 
1793
                def get(busname, objectpath):
 
1794
                    return {"interface": obj}
 
1795
        bus = pydbus_adapter.SystemBus(pydbus_spy)
 
1796
        value = Unique()
 
1797
        bus.set_property("busname", "objectpath", "interface", "key",
 
1798
                         value)
 
1799
        self.assertIs(value, obj.key)
 
1800
 
 
1801
    def test_get_suppresses_xml_deprecation_warning(self):
 
1802
        if sys.version_info.major >= 3:
 
1803
            return
 
1804
        class stub_pydbus_get:
 
1805
            class SystemBus:
 
1806
                @staticmethod
 
1807
                def get(busname, objectpath):
 
1808
                    warnings.warn_explicit(
 
1809
                        "deprecated", DeprecationWarning,
 
1810
                        "xml.etree.ElementTree", 0)
 
1811
        bus = pydbus_adapter.SystemBus(stub_pydbus_get)
 
1812
        with warnings.catch_warnings(record=True) as w:
 
1813
            warnings.simplefilter("always")
 
1814
            bus.get("busname", "objectpath")
 
1815
            self.assertEqual(0, len(w))
 
1816
 
 
1817
 
 
1818
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
 
1819
    class stub_pydbus:
 
1820
        """stub pydbus module"""
 
1821
        class SystemBus:
 
1822
            @staticmethod
 
1823
            def get(busname, objectpath):
 
1824
                return Unique()
 
1825
 
 
1826
    def setUp(self):
 
1827
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
 
1828
 
 
1829
    def test_returns_distinct_objectpaths(self):
 
1830
        obj1 = self.bus.get("busname", "objectpath1")
 
1831
        self.assertIsInstance(obj1, Unique)
 
1832
        obj2 = self.bus.get("busname", "objectpath2")
 
1833
        self.assertIsInstance(obj2, Unique)
 
1834
        self.assertIsNot(obj1, obj2)
 
1835
 
 
1836
    def test_returns_distinct_busnames(self):
 
1837
        obj1 = self.bus.get("busname1", "objectpath")
 
1838
        self.assertIsInstance(obj1, Unique)
 
1839
        obj2 = self.bus.get("busname2", "objectpath")
 
1840
        self.assertIsInstance(obj2, Unique)
 
1841
        self.assertIsNot(obj1, obj2)
 
1842
 
 
1843
    def test_returns_distinct_both(self):
 
1844
        obj1 = self.bus.get("busname1", "objectpath")
 
1845
        self.assertIsInstance(obj1, Unique)
 
1846
        obj2 = self.bus.get("busname2", "objectpath")
 
1847
        self.assertIsInstance(obj2, Unique)
 
1848
        self.assertIsNot(obj1, obj2)
 
1849
 
 
1850
    def test_returns_same(self):
 
1851
        obj1 = self.bus.get("busname", "objectpath")
 
1852
        self.assertIsInstance(obj1, Unique)
 
1853
        obj2 = self.bus.get("busname", "objectpath")
 
1854
        self.assertIsInstance(obj2, Unique)
 
1855
        self.assertIs(obj1, obj2)
 
1856
 
 
1857
    def test_returns_same_old(self):
 
1858
        obj1 = self.bus.get("busname1", "objectpath1")
 
1859
        self.assertIsInstance(obj1, Unique)
 
1860
        obj2 = self.bus.get("busname2", "objectpath2")
 
1861
        self.assertIsInstance(obj2, Unique)
 
1862
        obj1b = self.bus.get("busname1", "objectpath1")
 
1863
        self.assertIsInstance(obj1b, Unique)
 
1864
        self.assertIsNot(obj1, obj2)
 
1865
        self.assertIsNot(obj2, obj1b)
 
1866
        self.assertIs(obj1, obj1b)
 
1867
 
 
1868
 
 
1869
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
 
1870
 
 
1871
    class dummy_dbussy:
 
1872
        class DBUS:
 
1873
            class ObjectPath(str):
 
1874
                pass
 
1875
        class DBusError(Exception):
 
1876
            pass
 
1877
 
 
1878
    def fake_ravel_func(self, func):
 
1879
        class fake_ravel:
 
1880
            @staticmethod
 
1881
            def system_bus():
 
1882
                class DBusInterfaceProxy:
 
1883
                    @staticmethod
 
1884
                    def methodname(*args):
 
1885
                        return [func(*args)]
 
1886
                class DBusObject:
 
1887
                    @staticmethod
 
1888
                    def get_interface(interface):
 
1889
                        if interface == "interface":
 
1890
                            return DBusInterfaceProxy()
 
1891
                return {"busname": {"objectpath": DBusObject()}}
 
1892
        return fake_ravel
 
1893
 
 
1894
    def call_method(self, bus, methodname, busname, objectpath,
 
1895
                    interface, *args):
 
1896
        with self.assertLogs(log, logging.DEBUG):
 
1897
            return bus.call_method(methodname, busname, objectpath,
 
1898
                                   interface, *args)
 
1899
 
 
1900
    def test_call_method_returns(self):
 
1901
        expected_method_return = Unique()
 
1902
        method_args = (Unique(), Unique())
 
1903
        def func(*args):
 
1904
            self.assertEqual(len(method_args), len(args))
 
1905
            for marg, arg in zip(method_args, args):
 
1906
                self.assertIs(marg, arg)
 
1907
            return expected_method_return
 
1908
        fake_ravel = self.fake_ravel_func(func)
 
1909
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1910
        ret = self.call_method(bus, "methodname", "busname",
 
1911
                               "objectpath", "interface",
 
1912
                               *method_args)
 
1913
        self.assertIs(ret, expected_method_return)
 
1914
 
 
1915
    def test_call_method_filters_objectpath(self):
 
1916
        def func():
 
1917
            return method_return
 
1918
        fake_ravel = self.fake_ravel_func(func)
 
1919
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1920
        method_return = (self.dummy_dbussy.DBUS
 
1921
                         .ObjectPath("objectpath"))
 
1922
        ret = self.call_method(bus, "methodname", "busname",
 
1923
                               "objectpath", "interface")
 
1924
        self.assertEqual("objectpath", ret)
 
1925
        self.assertNotIsInstance(ret,
 
1926
                                 self.dummy_dbussy.DBUS.ObjectPath)
 
1927
 
 
1928
    def test_call_method_filters_objectpaths_in_dict(self):
 
1929
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
 
1930
        def func():
 
1931
            return method_return
 
1932
        fake_ravel = self.fake_ravel_func(func)
 
1933
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1934
        method_return = {
 
1935
            ObjectPath("objectpath_key_1"):
 
1936
            ObjectPath("objectpath_value_1"),
 
1937
            ObjectPath("objectpath_key_2"):
 
1938
            ObjectPath("objectpath_value_2"),
 
1939
        }
 
1940
        ret = self.call_method(bus, "methodname", "busname",
 
1941
                               "objectpath", "interface")
 
1942
        expected_method_return = {str(key): str(value)
 
1943
                                  for key, value in
 
1944
                                  method_return.items()}
 
1945
        for key, value in ret.items():
 
1946
            self.assertNotIsInstance(key, ObjectPath)
 
1947
            self.assertNotIsInstance(value, ObjectPath)
 
1948
        self.assertEqual(expected_method_return, ret)
 
1949
        self.assertIsInstance(ret, dict)
 
1950
 
 
1951
    def test_call_method_filters_objectpaths_in_dict_in_dict(self):
 
1952
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
 
1953
        def func():
 
1954
            return method_return
 
1955
        fake_ravel = self.fake_ravel_func(func)
 
1956
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1957
        method_return = {
 
1958
            ObjectPath("key1"): {
 
1959
                ObjectPath("key11"): ObjectPath("value11"),
 
1960
                ObjectPath("key12"): ObjectPath("value12"),
 
1961
            },
 
1962
            ObjectPath("key2"): {
 
1963
                ObjectPath("key21"): ObjectPath("value21"),
 
1964
                ObjectPath("key22"): ObjectPath("value22"),
 
1965
            },
 
1966
        }
 
1967
        ret = self.call_method(bus, "methodname", "busname",
 
1968
                               "objectpath", "interface")
 
1969
        expected_method_return = {
 
1970
            "key1": {"key11": "value11",
 
1971
                     "key12": "value12"},
 
1972
            "key2": {"key21": "value21",
 
1973
                     "key22": "value22"},
 
1974
        }
 
1975
        self.assertEqual(expected_method_return, ret)
 
1976
        for key, value in ret.items():
 
1977
            self.assertIsInstance(value, dict)
 
1978
            self.assertEqual(expected_method_return[key], value)
 
1979
            self.assertNotIsInstance(key, ObjectPath)
 
1980
            for inner_key, inner_value in value.items():
 
1981
                self.assertIsInstance(value, dict)
 
1982
                self.assertEqual(
 
1983
                    expected_method_return[key][inner_key],
 
1984
                    inner_value)
 
1985
                self.assertNotIsInstance(key, ObjectPath)
 
1986
 
 
1987
    def test_call_method_filters_objectpaths_in_dict_three_deep(self):
 
1988
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
 
1989
        def func():
 
1990
            return method_return
 
1991
        fake_ravel = self.fake_ravel_func(func)
 
1992
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1993
        method_return = {
 
1994
            ObjectPath("key1"): {
 
1995
                ObjectPath("key2"): {
 
1996
                    ObjectPath("key3"): ObjectPath("value"),
 
1997
                },
 
1998
            },
 
1999
        }
 
2000
        ret = self.call_method(bus, "methodname", "busname",
 
2001
                               "objectpath", "interface")
 
2002
        expected_method_return = {"key1": {"key2": {"key3": "value"}}}
 
2003
        self.assertEqual(expected_method_return, ret)
 
2004
        self.assertIsInstance(ret, dict)
 
2005
        self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
 
2006
        self.assertIsInstance(ret["key1"], dict)
 
2007
        self.assertNotIsInstance(next(iter(ret["key1"].keys())),
 
2008
                                 ObjectPath)
 
2009
        self.assertIsInstance(ret["key1"]["key2"], dict)
 
2010
        self.assertNotIsInstance(
 
2011
            next(iter(ret["key1"]["key2"].keys())),
 
2012
            ObjectPath)
 
2013
        self.assertEqual("value", ret["key1"]["key2"]["key3"])
 
2014
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
 
2015
                                 self.dummy_dbussy.DBUS.ObjectPath)
 
2016
 
 
2017
    def test_call_method_handles_exception(self):
 
2018
        def func():
 
2019
            raise self.dummy_dbussy.DBusError()
 
2020
 
 
2021
        fake_ravel = self.fake_ravel_func(func)
 
2022
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
2023
 
 
2024
        with self.assertRaises(dbus.Error) as e:
 
2025
            self.call_method(bus, "methodname", "busname",
 
2026
                             "objectpath", "interface")
 
2027
 
 
2028
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
 
2029
 
 
2030
    def test_get_object_converts_to_correct_exception(self):
 
2031
        class fake_ravel_raises_exception_on_connect:
 
2032
            @staticmethod
 
2033
            def system_bus():
 
2034
                class Bus:
 
2035
                    @staticmethod
 
2036
                    def __getitem__(key):
 
2037
                        if key == "objectpath":
 
2038
                            raise self.dummy_dbussy.DBusError()
 
2039
                        raise Exception(key)
 
2040
                return {"busname": Bus()}
 
2041
        def func():
 
2042
            raise self.dummy_dbussy.DBusError()
 
2043
        bus = dbussy_adapter.SystemBus(
 
2044
            self.dummy_dbussy,
 
2045
            fake_ravel_raises_exception_on_connect)
 
2046
        with self.assertRaises(dbus.ConnectFailed):
 
2047
            self.call_method(bus, "methodname", "busname",
 
2048
                             "objectpath", "interface")
1152
2049
 
1153
2050
 
1154
2051
class Test_commands_from_options(unittest.TestCase):
 
2052
 
1155
2053
    def setUp(self):
1156
2054
        self.parser = argparse.ArgumentParser()
1157
2055
        add_command_line_options(self.parser)
1158
2056
 
1159
2057
    def test_is_enabled(self):
1160
 
        self.assert_command_from_args(["--is-enabled", "foo"],
 
2058
        self.assert_command_from_args(["--is-enabled", "client"],
1161
2059
                                      command.IsEnabled)
1162
2060
 
1163
 
    def assert_command_from_args(self, args, command_cls,
1164
 
                                 **cmd_attrs):
 
2061
    def assert_command_from_args(self, args, command_cls, length=1,
 
2062
                                 clients=None, **cmd_attrs):
1165
2063
        """Assert that parsing ARGS should result in an instance of
1166
2064
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1167
2065
        options = self.parser.parse_args(args)
1168
2066
        check_option_syntax(self.parser, options)
1169
2067
        commands = commands_from_options(options)
1170
 
        self.assertEqual(1, len(commands))
1171
 
        command = commands[0]
1172
 
        self.assertIsInstance(command, command_cls)
 
2068
        self.assertEqual(length, len(commands))
 
2069
        for command in commands:
 
2070
            if isinstance(command, command_cls):
 
2071
                break
 
2072
        else:
 
2073
            self.assertIsInstance(command, command_cls)
 
2074
        if clients is not None:
 
2075
            self.assertEqual(clients, options.client)
1173
2076
        for key, value in cmd_attrs.items():
1174
2077
            self.assertEqual(value, getattr(command, key))
1175
2078
 
 
2079
    def assert_commands_from_args(self, args, commands, clients=None):
 
2080
        for cmd in commands:
 
2081
            self.assert_command_from_args(args, cmd,
 
2082
                                          length=len(commands),
 
2083
                                          clients=clients)
 
2084
 
1176
2085
    def test_is_enabled_short(self):
1177
 
        self.assert_command_from_args(["-V", "foo"],
 
2086
        self.assert_command_from_args(["-V", "client"],
1178
2087
                                      command.IsEnabled)
1179
2088
 
1180
2089
    def test_approve(self):
1181
 
        self.assert_command_from_args(["--approve", "foo"],
 
2090
        self.assert_command_from_args(["--approve", "client"],
1182
2091
                                      command.Approve)
1183
2092
 
1184
2093
    def test_approve_short(self):
1185
 
        self.assert_command_from_args(["-A", "foo"], command.Approve)
 
2094
        self.assert_command_from_args(["-A", "client"],
 
2095
                                      command.Approve)
1186
2096
 
1187
2097
    def test_deny(self):
1188
 
        self.assert_command_from_args(["--deny", "foo"], command.Deny)
 
2098
        self.assert_command_from_args(["--deny", "client"],
 
2099
                                      command.Deny)
1189
2100
 
1190
2101
    def test_deny_short(self):
1191
 
        self.assert_command_from_args(["-D", "foo"], command.Deny)
 
2102
        self.assert_command_from_args(["-D", "client"], command.Deny)
1192
2103
 
1193
2104
    def test_remove(self):
1194
 
        self.assert_command_from_args(["--remove", "foo"],
 
2105
        self.assert_command_from_args(["--remove", "client"],
1195
2106
                                      command.Remove)
1196
2107
 
1197
2108
    def test_deny_before_remove(self):
1198
2109
        options = self.parser.parse_args(["--deny", "--remove",
1199
 
                                          "foo"])
 
2110
                                          "client"])
1200
2111
        check_option_syntax(self.parser, options)
1201
2112
        commands = commands_from_options(options)
1202
2113
        self.assertEqual(2, len(commands))
1213
2124
        self.assertIsInstance(commands[1], command.Remove)
1214
2125
 
1215
2126
    def test_remove_short(self):
1216
 
        self.assert_command_from_args(["-r", "foo"], command.Remove)
 
2127
        self.assert_command_from_args(["-r", "client"],
 
2128
                                      command.Remove)
1217
2129
 
1218
2130
    def test_dump_json(self):
1219
2131
        self.assert_command_from_args(["--dump-json"],
1220
2132
                                      command.DumpJSON)
1221
2133
 
1222
2134
    def test_enable(self):
1223
 
        self.assert_command_from_args(["--enable", "foo"],
 
2135
        self.assert_command_from_args(["--enable", "client"],
1224
2136
                                      command.Enable)
1225
2137
 
1226
2138
    def test_enable_short(self):
1227
 
        self.assert_command_from_args(["-e", "foo"], command.Enable)
 
2139
        self.assert_command_from_args(["-e", "client"],
 
2140
                                      command.Enable)
1228
2141
 
1229
2142
    def test_disable(self):
1230
 
        self.assert_command_from_args(["--disable", "foo"],
 
2143
        self.assert_command_from_args(["--disable", "client"],
1231
2144
                                      command.Disable)
1232
2145
 
1233
2146
    def test_disable_short(self):
1234
 
        self.assert_command_from_args(["-d", "foo"], command.Disable)
 
2147
        self.assert_command_from_args(["-d", "client"],
 
2148
                                      command.Disable)
1235
2149
 
1236
2150
    def test_bump_timeout(self):
1237
 
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
2151
        self.assert_command_from_args(["--bump-timeout", "client"],
1238
2152
                                      command.BumpTimeout)
1239
2153
 
1240
2154
    def test_bump_timeout_short(self):
1241
 
        self.assert_command_from_args(["-b", "foo"],
 
2155
        self.assert_command_from_args(["-b", "client"],
1242
2156
                                      command.BumpTimeout)
1243
2157
 
1244
2158
    def test_start_checker(self):
1245
 
        self.assert_command_from_args(["--start-checker", "foo"],
 
2159
        self.assert_command_from_args(["--start-checker", "client"],
1246
2160
                                      command.StartChecker)
1247
2161
 
1248
2162
    def test_stop_checker(self):
1249
 
        self.assert_command_from_args(["--stop-checker", "foo"],
 
2163
        self.assert_command_from_args(["--stop-checker", "client"],
1250
2164
                                      command.StopChecker)
1251
2165
 
1252
2166
    def test_approve_by_default(self):
1253
 
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
2167
        self.assert_command_from_args(["--approve-by-default",
 
2168
                                       "client"],
1254
2169
                                      command.ApproveByDefault)
1255
2170
 
1256
2171
    def test_deny_by_default(self):
1257
 
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
2172
        self.assert_command_from_args(["--deny-by-default", "client"],
1258
2173
                                      command.DenyByDefault)
1259
2174
 
1260
2175
    def test_checker(self):
1261
 
        self.assert_command_from_args(["--checker", ":", "foo"],
 
2176
        self.assert_command_from_args(["--checker", ":", "client"],
1262
2177
                                      command.SetChecker,
1263
2178
                                      value_to_set=":")
1264
2179
 
1265
2180
    def test_checker_empty(self):
1266
 
        self.assert_command_from_args(["--checker", "", "foo"],
 
2181
        self.assert_command_from_args(["--checker", "", "client"],
1267
2182
                                      command.SetChecker,
1268
2183
                                      value_to_set="")
1269
2184
 
1270
2185
    def test_checker_short(self):
1271
 
        self.assert_command_from_args(["-c", ":", "foo"],
 
2186
        self.assert_command_from_args(["-c", ":", "client"],
1272
2187
                                      command.SetChecker,
1273
2188
                                      value_to_set=":")
1274
2189
 
1275
2190
    def test_host(self):
1276
 
        self.assert_command_from_args(["--host", "foo.example.org",
1277
 
                                       "foo"], command.SetHost,
1278
 
                                      value_to_set="foo.example.org")
 
2191
        self.assert_command_from_args(
 
2192
            ["--host", "client.example.org", "client"],
 
2193
            command.SetHost, value_to_set="client.example.org")
1279
2194
 
1280
2195
    def test_host_short(self):
1281
 
        self.assert_command_from_args(["-H", "foo.example.org",
1282
 
                                       "foo"], command.SetHost,
1283
 
                                      value_to_set="foo.example.org")
 
2196
        self.assert_command_from_args(
 
2197
            ["-H", "client.example.org", "client"], command.SetHost,
 
2198
            value_to_set="client.example.org")
1284
2199
 
1285
2200
    def test_secret_devnull(self):
1286
2201
        self.assert_command_from_args(["--secret", os.path.devnull,
1287
 
                                       "foo"], command.SetSecret,
 
2202
                                       "client"], command.SetSecret,
1288
2203
                                      value_to_set=b"")
1289
2204
 
1290
2205
    def test_secret_tempfile(self):
1293
2208
            f.write(value)
1294
2209
            f.seek(0)
1295
2210
            self.assert_command_from_args(["--secret", f.name,
1296
 
                                           "foo"], command.SetSecret,
 
2211
                                           "client"],
 
2212
                                          command.SetSecret,
1297
2213
                                          value_to_set=value)
1298
2214
 
1299
2215
    def test_secret_devnull_short(self):
1300
 
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1301
 
                                      command.SetSecret,
 
2216
        self.assert_command_from_args(["-s", os.path.devnull,
 
2217
                                       "client"], command.SetSecret,
1302
2218
                                      value_to_set=b"")
1303
2219
 
1304
2220
    def test_secret_tempfile_short(self):
1306
2222
            value = b"secret\0xyzzy\nbar"
1307
2223
            f.write(value)
1308
2224
            f.seek(0)
1309
 
            self.assert_command_from_args(["-s", f.name, "foo"],
 
2225
            self.assert_command_from_args(["-s", f.name, "client"],
1310
2226
                                          command.SetSecret,
1311
2227
                                          value_to_set=value)
1312
2228
 
1313
2229
    def test_timeout(self):
1314
 
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
2230
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
1315
2231
                                      command.SetTimeout,
1316
2232
                                      value_to_set=300000)
1317
2233
 
1318
2234
    def test_timeout_short(self):
1319
 
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
2235
        self.assert_command_from_args(["-t", "PT5M", "client"],
1320
2236
                                      command.SetTimeout,
1321
2237
                                      value_to_set=300000)
1322
2238
 
1323
2239
    def test_extended_timeout(self):
1324
2240
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1325
 
                                       "foo"],
 
2241
                                       "client"],
1326
2242
                                      command.SetExtendedTimeout,
1327
2243
                                      value_to_set=900000)
1328
2244
 
1329
2245
    def test_interval(self):
1330
 
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
1331
 
                                      command.SetInterval,
 
2246
        self.assert_command_from_args(["--interval", "PT2M",
 
2247
                                       "client"], command.SetInterval,
1332
2248
                                      value_to_set=120000)
1333
2249
 
1334
2250
    def test_interval_short(self):
1335
 
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
2251
        self.assert_command_from_args(["-i", "PT2M", "client"],
1336
2252
                                      command.SetInterval,
1337
2253
                                      value_to_set=120000)
1338
2254
 
1339
2255
    def test_approval_delay(self):
1340
2256
        self.assert_command_from_args(["--approval-delay", "PT30S",
1341
 
                                       "foo"],
 
2257
                                       "client"],
1342
2258
                                      command.SetApprovalDelay,
1343
2259
                                      value_to_set=30000)
1344
2260
 
1345
2261
    def test_approval_duration(self):
1346
2262
        self.assert_command_from_args(["--approval-duration", "PT1S",
1347
 
                                       "foo"],
 
2263
                                       "client"],
1348
2264
                                      command.SetApprovalDuration,
1349
2265
                                      value_to_set=1000)
1350
2266
 
1362
2278
                                      verbose=True)
1363
2279
 
1364
2280
 
 
2281
    def test_manual_page_example_1(self):
 
2282
        self.assert_command_from_args("",
 
2283
                                      command.PrintTable,
 
2284
                                      clients=[],
 
2285
                                      verbose=False)
 
2286
 
 
2287
    def test_manual_page_example_2(self):
 
2288
        self.assert_command_from_args(
 
2289
            "--verbose foo1.example.org foo2.example.org".split(),
 
2290
            command.PrintTable, clients=["foo1.example.org",
 
2291
                                         "foo2.example.org"],
 
2292
            verbose=True)
 
2293
 
 
2294
    def test_manual_page_example_3(self):
 
2295
        self.assert_command_from_args("--enable --all".split(),
 
2296
                                      command.Enable,
 
2297
                                      clients=[])
 
2298
 
 
2299
    def test_manual_page_example_4(self):
 
2300
        self.assert_commands_from_args(
 
2301
            ("--timeout=PT5M --interval=PT1M foo1.example.org"
 
2302
             " foo2.example.org").split(),
 
2303
            [command.SetTimeout, command.SetInterval],
 
2304
            clients=["foo1.example.org", "foo2.example.org"])
 
2305
 
 
2306
    def test_manual_page_example_5(self):
 
2307
        self.assert_command_from_args("--approve --all".split(),
 
2308
                                      command.Approve,
 
2309
                                      clients=[])
 
2310
 
 
2311
 
1365
2312
class TestCommand(unittest.TestCase):
1366
2313
    """Abstract class for tests of command classes"""
1367
2314
 
 
2315
    class FakeMandosBus(dbus.MandosBus):
 
2316
        def __init__(self, testcase):
 
2317
            self.client_properties = {
 
2318
                "Name": "foo",
 
2319
                "KeyID": ("92ed150794387c03ce684574b1139a65"
 
2320
                          "94a34f895daaaf09fd8ea90a27cddb12"),
 
2321
                "Secret": b"secret",
 
2322
                "Host": "foo.example.org",
 
2323
                "Enabled": True,
 
2324
                "Timeout": 300000,
 
2325
                "LastCheckedOK": "2019-02-03T00:00:00",
 
2326
                "Created": "2019-01-02T00:00:00",
 
2327
                "Interval": 120000,
 
2328
                "Fingerprint": ("778827225BA7DE539C5A"
 
2329
                                "7CFA59CFF7CDBD9A5920"),
 
2330
                "CheckerRunning": False,
 
2331
                "LastEnabled": "2019-01-03T00:00:00",
 
2332
                "ApprovalPending": False,
 
2333
                "ApprovedByDefault": True,
 
2334
                "LastApprovalRequest": "",
 
2335
                "ApprovalDelay": 0,
 
2336
                "ApprovalDuration": 1000,
 
2337
                "Checker": "fping -q -- %(host)s",
 
2338
                "ExtendedTimeout": 900000,
 
2339
                "Expires": "2019-02-04T00:00:00",
 
2340
                "LastCheckerStatus": 0,
 
2341
            }
 
2342
            self.other_client_properties = {
 
2343
                "Name": "barbar",
 
2344
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
2345
                          "6ab612cff5ad227247e46c2b020f441c"),
 
2346
                "Secret": b"secretbar",
 
2347
                "Host": "192.0.2.3",
 
2348
                "Enabled": True,
 
2349
                "Timeout": 300000,
 
2350
                "LastCheckedOK": "2019-02-04T00:00:00",
 
2351
                "Created": "2019-01-03T00:00:00",
 
2352
                "Interval": 120000,
 
2353
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
2354
                                "F547B3A107558FCA3A27"),
 
2355
                "CheckerRunning": True,
 
2356
                "LastEnabled": "2019-01-04T00:00:00",
 
2357
                "ApprovalPending": False,
 
2358
                "ApprovedByDefault": False,
 
2359
                "LastApprovalRequest": "2019-01-03T00:00:00",
 
2360
                "ApprovalDelay": 30000,
 
2361
                "ApprovalDuration": 93785000,
 
2362
                "Checker": ":",
 
2363
                "ExtendedTimeout": 900000,
 
2364
                "Expires": "2019-02-05T00:00:00",
 
2365
                "LastCheckerStatus": -2,
 
2366
            }
 
2367
            self.clients =  collections.OrderedDict(
 
2368
                [
 
2369
                    ("client_objectpath", self.client_properties),
 
2370
                    ("other_client_objectpath",
 
2371
                     self.other_client_properties),
 
2372
                ])
 
2373
            self.one_client = {"client_objectpath":
 
2374
                               self.client_properties}
 
2375
            self.testcase = testcase
 
2376
            self.calls = []
 
2377
 
 
2378
        def call_method(self, methodname, busname, objectpath,
 
2379
                        interface, *args):
 
2380
            self.testcase.assertEqual("se.recompile.Mandos", busname)
 
2381
            self.calls.append((methodname, busname, objectpath,
 
2382
                               interface, args))
 
2383
            if interface == "org.freedesktop.DBus.Properties":
 
2384
                if methodname == "Set":
 
2385
                    self.testcase.assertEqual(3, len(args))
 
2386
                    interface, key, value = args
 
2387
                    self.testcase.assertEqual(
 
2388
                        "se.recompile.Mandos.Client", interface)
 
2389
                    self.clients[objectpath][key] = value
 
2390
                    return
 
2391
            elif interface == "se.recompile.Mandos":
 
2392
                self.testcase.assertEqual("RemoveClient", methodname)
 
2393
                self.testcase.assertEqual(1, len(args))
 
2394
                clientpath = args[0]
 
2395
                del self.clients[clientpath]
 
2396
                return
 
2397
            elif interface == "se.recompile.Mandos.Client":
 
2398
                if methodname == "Approve":
 
2399
                    self.testcase.assertEqual(1, len(args))
 
2400
                    return
 
2401
            raise ValueError()
 
2402
 
1368
2403
    def setUp(self):
1369
 
        testcase = self
1370
 
        class MockClient(object):
1371
 
            def __init__(self, name, **attributes):
1372
 
                self.__dbus_object_path__ = "/clients/{}".format(name)
1373
 
                self.attributes = attributes
1374
 
                self.attributes["Name"] = name
1375
 
                self.calls = []
1376
 
            def Set(self, interface, propname, value, dbus_interface):
1377
 
                testcase.assertEqual(client_dbus_interface, interface)
1378
 
                testcase.assertEqual(dbus.PROPERTIES_IFACE,
1379
 
                                     dbus_interface)
1380
 
                self.attributes[propname] = value
1381
 
            def Approve(self, approve, dbus_interface):
1382
 
                testcase.assertEqual(client_dbus_interface,
1383
 
                                     dbus_interface)
1384
 
                self.calls.append(("Approve", (approve,
1385
 
                                               dbus_interface)))
1386
 
        self.client = MockClient(
1387
 
            "foo",
1388
 
            KeyID=("92ed150794387c03ce684574b1139a65"
1389
 
                   "94a34f895daaaf09fd8ea90a27cddb12"),
1390
 
            Secret=b"secret",
1391
 
            Host="foo.example.org",
1392
 
            Enabled=dbus.Boolean(True),
1393
 
            Timeout=300000,
1394
 
            LastCheckedOK="2019-02-03T00:00:00",
1395
 
            Created="2019-01-02T00:00:00",
1396
 
            Interval=120000,
1397
 
            Fingerprint=("778827225BA7DE539C5A"
1398
 
                         "7CFA59CFF7CDBD9A5920"),
1399
 
            CheckerRunning=dbus.Boolean(False),
1400
 
            LastEnabled="2019-01-03T00:00:00",
1401
 
            ApprovalPending=dbus.Boolean(False),
1402
 
            ApprovedByDefault=dbus.Boolean(True),
1403
 
            LastApprovalRequest="",
1404
 
            ApprovalDelay=0,
1405
 
            ApprovalDuration=1000,
1406
 
            Checker="fping -q -- %(host)s",
1407
 
            ExtendedTimeout=900000,
1408
 
            Expires="2019-02-04T00:00:00",
1409
 
            LastCheckerStatus=0)
1410
 
        self.other_client = MockClient(
1411
 
            "barbar",
1412
 
            KeyID=("0558568eedd67d622f5c83b35a115f79"
1413
 
                   "6ab612cff5ad227247e46c2b020f441c"),
1414
 
            Secret=b"secretbar",
1415
 
            Host="192.0.2.3",
1416
 
            Enabled=dbus.Boolean(True),
1417
 
            Timeout=300000,
1418
 
            LastCheckedOK="2019-02-04T00:00:00",
1419
 
            Created="2019-01-03T00:00:00",
1420
 
            Interval=120000,
1421
 
            Fingerprint=("3E393AEAEFB84C7E89E2"
1422
 
                         "F547B3A107558FCA3A27"),
1423
 
            CheckerRunning=dbus.Boolean(True),
1424
 
            LastEnabled="2019-01-04T00:00:00",
1425
 
            ApprovalPending=dbus.Boolean(False),
1426
 
            ApprovedByDefault=dbus.Boolean(False),
1427
 
            LastApprovalRequest="2019-01-03T00:00:00",
1428
 
            ApprovalDelay=30000,
1429
 
            ApprovalDuration=93785000,
1430
 
            Checker=":",
1431
 
            ExtendedTimeout=900000,
1432
 
            Expires="2019-02-05T00:00:00",
1433
 
            LastCheckerStatus=-2)
1434
 
        self.clients =  collections.OrderedDict(
1435
 
            [
1436
 
                ("/clients/foo", self.client.attributes),
1437
 
                ("/clients/barbar", self.other_client.attributes),
1438
 
            ])
1439
 
        self.one_client = {"/clients/foo": self.client.attributes}
1440
 
 
1441
 
    @property
1442
 
    def bus(self):
1443
 
        class Bus(object):
1444
 
            @staticmethod
1445
 
            def get_object(client_bus_name, path):
1446
 
                self.assertEqual(dbus_busname, client_bus_name)
1447
 
                return {
1448
 
                    # Note: "self" here is the TestCmd instance, not
1449
 
                    # the Bus instance, since this is a static method!
1450
 
                    "/clients/foo": self.client,
1451
 
                    "/clients/barbar": self.other_client,
1452
 
                }[path]
1453
 
        return Bus()
 
2404
        self.bus = self.FakeMandosBus(self)
1454
2405
 
1455
2406
 
1456
2407
class TestBaseCommands(TestCommand):
1457
2408
 
1458
2409
    def test_IsEnabled_exits_successfully(self):
1459
2410
        with self.assertRaises(SystemExit) as e:
1460
 
            command.IsEnabled().run(self.one_client)
 
2411
            command.IsEnabled().run(self.bus.one_client)
1461
2412
        if e.exception.code is not None:
1462
2413
            self.assertEqual(0, e.exception.code)
1463
2414
        else:
1464
2415
            self.assertIsNone(e.exception.code)
1465
2416
 
1466
2417
    def test_IsEnabled_exits_with_failure(self):
1467
 
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
2418
        self.bus.client_properties["Enabled"] = False
1468
2419
        with self.assertRaises(SystemExit) as e:
1469
 
            command.IsEnabled().run(self.one_client)
 
2420
            command.IsEnabled().run(self.bus.one_client)
1470
2421
        if isinstance(e.exception.code, int):
1471
2422
            self.assertNotEqual(0, e.exception.code)
1472
2423
        else:
1473
2424
            self.assertIsNotNone(e.exception.code)
1474
2425
 
1475
2426
    def test_Approve(self):
1476
 
        command.Approve().run(self.clients, self.bus)
1477
 
        for clientpath in self.clients:
1478
 
            client = self.bus.get_object(dbus_busname, clientpath)
1479
 
            self.assertIn(("Approve", (True, client_dbus_interface)),
1480
 
                          client.calls)
 
2427
        busname = "se.recompile.Mandos"
 
2428
        client_interface = "se.recompile.Mandos.Client"
 
2429
        command.Approve().run(self.bus.clients, self.bus)
 
2430
        self.assertTrue(self.bus.clients)
 
2431
        for clientpath in self.bus.clients:
 
2432
            self.assertIn(("Approve", busname, clientpath,
 
2433
                           client_interface, (True,)), self.bus.calls)
1481
2434
 
1482
2435
    def test_Deny(self):
1483
 
        command.Deny().run(self.clients, self.bus)
1484
 
        for clientpath in self.clients:
1485
 
            client = self.bus.get_object(dbus_busname, clientpath)
1486
 
            self.assertIn(("Approve", (False, client_dbus_interface)),
1487
 
                          client.calls)
 
2436
        busname = "se.recompile.Mandos"
 
2437
        client_interface = "se.recompile.Mandos.Client"
 
2438
        command.Deny().run(self.bus.clients, self.bus)
 
2439
        self.assertTrue(self.bus.clients)
 
2440
        for clientpath in self.bus.clients:
 
2441
            self.assertIn(("Approve", busname, clientpath,
 
2442
                           client_interface, (False,)),
 
2443
                          self.bus.calls)
1488
2444
 
1489
2445
    def test_Remove(self):
1490
 
        class MockMandos(object):
1491
 
            def __init__(self):
1492
 
                self.calls = []
1493
 
            def RemoveClient(self, dbus_path):
1494
 
                self.calls.append(("RemoveClient", (dbus_path,)))
1495
 
        mandos = MockMandos()
1496
 
        command.Remove().run(self.clients, self.bus, mandos)
1497
 
        for clientpath in self.clients:
1498
 
            self.assertIn(("RemoveClient", (clientpath,)),
1499
 
                          mandos.calls)
 
2446
        busname = "se.recompile.Mandos"
 
2447
        server_path = "/"
 
2448
        server_interface = "se.recompile.Mandos"
 
2449
        orig_clients = self.bus.clients.copy()
 
2450
        command.Remove().run(self.bus.clients, self.bus)
 
2451
        self.assertFalse(self.bus.clients)
 
2452
        for clientpath in orig_clients:
 
2453
            self.assertIn(("RemoveClient", busname,
 
2454
                           server_path, server_interface,
 
2455
                           (clientpath,)), self.bus.calls)
1500
2456
 
1501
2457
    expected_json = {
1502
2458
        "foo": {
1551
2507
 
1552
2508
    def test_DumpJSON_normal(self):
1553
2509
        with self.capture_stdout_to_buffer() as buffer:
1554
 
            command.DumpJSON().run(self.clients)
 
2510
            command.DumpJSON().run(self.bus.clients)
1555
2511
        json_data = json.loads(buffer.getvalue())
1556
2512
        self.assertDictEqual(self.expected_json, json_data)
1557
2513
 
1568
2524
 
1569
2525
    def test_DumpJSON_one_client(self):
1570
2526
        with self.capture_stdout_to_buffer() as buffer:
1571
 
            command.DumpJSON().run(self.one_client)
 
2527
            command.DumpJSON().run(self.bus.one_client)
1572
2528
        json_data = json.loads(buffer.getvalue())
1573
2529
        expected_json = {"foo": self.expected_json["foo"]}
1574
2530
        self.assertDictEqual(expected_json, json_data)
1575
2531
 
1576
2532
    def test_PrintTable_normal(self):
1577
2533
        with self.capture_stdout_to_buffer() as buffer:
1578
 
            command.PrintTable().run(self.clients)
 
2534
            command.PrintTable().run(self.bus.clients)
1579
2535
        expected_output = "\n".join((
1580
2536
            "Name   Enabled Timeout  Last Successful Check",
1581
2537
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1585
2541
 
1586
2542
    def test_PrintTable_verbose(self):
1587
2543
        with self.capture_stdout_to_buffer() as buffer:
1588
 
            command.PrintTable(verbose=True).run(self.clients)
 
2544
            command.PrintTable(verbose=True).run(self.bus.clients)
1589
2545
        columns = (
1590
2546
            (
1591
2547
                "Name   ",
1681
2637
 
1682
2638
    def test_PrintTable_one_client(self):
1683
2639
        with self.capture_stdout_to_buffer() as buffer:
1684
 
            command.PrintTable().run(self.one_client)
 
2640
            command.PrintTable().run(self.bus.one_client)
1685
2641
        expected_output = "\n".join((
1686
2642
            "Name Enabled Timeout  Last Successful Check",
1687
2643
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
1689
2645
        self.assertEqual(expected_output, buffer.getvalue())
1690
2646
 
1691
2647
 
1692
 
class TestPropertyCmd(TestCommand):
1693
 
    """Abstract class for tests of command.Property classes"""
 
2648
class TestPropertySetterCmd(TestCommand):
 
2649
    """Abstract class for tests of command.PropertySetter classes"""
 
2650
 
1694
2651
    def runTest(self):
1695
2652
        if not hasattr(self, "command"):
1696
 
            return
1697
 
        values_to_get = getattr(self, "values_to_get",
1698
 
                                self.values_to_set)
1699
 
        for value_to_set, value_to_get in zip(self.values_to_set,
1700
 
                                              values_to_get):
1701
 
            for clientpath in self.clients:
1702
 
                client = self.bus.get_object(dbus_busname, clientpath)
1703
 
                old_value = client.attributes[self.propname]
1704
 
                client.attributes[self.propname] = self.Unique()
1705
 
            self.run_command(value_to_set, self.clients)
1706
 
            for clientpath in self.clients:
1707
 
                client = self.bus.get_object(dbus_busname, clientpath)
1708
 
                value = client.attributes[self.propname]
1709
 
                self.assertNotIsInstance(value, self.Unique)
 
2653
            return              # Abstract TestCase class
 
2654
 
 
2655
        if hasattr(self, "values_to_set"):
 
2656
            cmd_args = [(value,) for value in self.values_to_set]
 
2657
            values_to_get = getattr(self, "values_to_get",
 
2658
                                    self.values_to_set)
 
2659
        else:
 
2660
            cmd_args = [() for x in range(len(self.values_to_get))]
 
2661
            values_to_get = self.values_to_get
 
2662
        self.assertTrue(values_to_get)
 
2663
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
 
2664
            for clientpath in self.bus.clients:
 
2665
                self.bus.clients[clientpath][self.propname] = (
 
2666
                    Unique())
 
2667
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
 
2668
            self.assertTrue(self.bus.clients)
 
2669
            for clientpath in self.bus.clients:
 
2670
                value = (self.bus.clients[clientpath]
 
2671
                         [self.propname])
 
2672
                self.assertNotIsInstance(value, Unique)
1710
2673
                self.assertEqual(value_to_get, value)
1711
2674
 
1712
 
    class Unique(object):
1713
 
        """Class for objects which exist only to be unique objects,
1714
 
since unittest.mock.sentinel only exists in Python 3.3"""
1715
 
 
1716
 
    def run_command(self, value, clients):
1717
 
        self.command().run(clients, self.bus)
1718
 
 
1719
 
 
1720
 
class TestEnableCmd(TestPropertyCmd):
 
2675
 
 
2676
class TestEnableCmd(TestPropertySetterCmd):
1721
2677
    command = command.Enable
1722
2678
    propname = "Enabled"
1723
 
    values_to_set = [dbus.Boolean(True)]
1724
 
 
1725
 
 
1726
 
class TestDisableCmd(TestPropertyCmd):
 
2679
    values_to_get = [True]
 
2680
 
 
2681
 
 
2682
class TestDisableCmd(TestPropertySetterCmd):
1727
2683
    command = command.Disable
1728
2684
    propname = "Enabled"
1729
 
    values_to_set = [dbus.Boolean(False)]
1730
 
 
1731
 
 
1732
 
class TestBumpTimeoutCmd(TestPropertyCmd):
 
2685
    values_to_get = [False]
 
2686
 
 
2687
 
 
2688
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1733
2689
    command = command.BumpTimeout
1734
2690
    propname = "LastCheckedOK"
1735
 
    values_to_set = [""]
1736
 
 
1737
 
 
1738
 
class TestStartCheckerCmd(TestPropertyCmd):
 
2691
    values_to_get = [""]
 
2692
 
 
2693
 
 
2694
class TestStartCheckerCmd(TestPropertySetterCmd):
1739
2695
    command = command.StartChecker
1740
2696
    propname = "CheckerRunning"
1741
 
    values_to_set = [dbus.Boolean(True)]
1742
 
 
1743
 
 
1744
 
class TestStopCheckerCmd(TestPropertyCmd):
 
2697
    values_to_get = [True]
 
2698
 
 
2699
 
 
2700
class TestStopCheckerCmd(TestPropertySetterCmd):
1745
2701
    command = command.StopChecker
1746
2702
    propname = "CheckerRunning"
1747
 
    values_to_set = [dbus.Boolean(False)]
1748
 
 
1749
 
 
1750
 
class TestApproveByDefaultCmd(TestPropertyCmd):
 
2703
    values_to_get = [False]
 
2704
 
 
2705
 
 
2706
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1751
2707
    command = command.ApproveByDefault
1752
2708
    propname = "ApprovedByDefault"
1753
 
    values_to_set = [dbus.Boolean(True)]
1754
 
 
1755
 
 
1756
 
class TestDenyByDefaultCmd(TestPropertyCmd):
 
2709
    values_to_get = [True]
 
2710
 
 
2711
 
 
2712
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1757
2713
    command = command.DenyByDefault
1758
2714
    propname = "ApprovedByDefault"
1759
 
    values_to_set = [dbus.Boolean(False)]
1760
 
 
1761
 
 
1762
 
class TestPropertyValueCmd(TestPropertyCmd):
1763
 
    """Abstract class for tests of PropertyValueCmd classes"""
1764
 
 
1765
 
    def runTest(self):
1766
 
        if type(self) is TestPropertyValueCmd:
1767
 
            return
1768
 
        return super(TestPropertyValueCmd, self).runTest()
1769
 
 
1770
 
    def run_command(self, value, clients):
1771
 
        self.command(value).run(clients, self.bus)
1772
 
 
1773
 
 
1774
 
class TestSetCheckerCmd(TestPropertyValueCmd):
 
2715
    values_to_get = [False]
 
2716
 
 
2717
 
 
2718
class TestSetCheckerCmd(TestPropertySetterCmd):
1775
2719
    command = command.SetChecker
1776
2720
    propname = "Checker"
1777
2721
    values_to_set = ["", ":", "fping -q -- %s"]
1778
2722
 
1779
2723
 
1780
 
class TestSetHostCmd(TestPropertyValueCmd):
 
2724
class TestSetHostCmd(TestPropertySetterCmd):
1781
2725
    command = command.SetHost
1782
2726
    propname = "Host"
1783
 
    values_to_set = ["192.0.2.3", "foo.example.org"]
1784
 
 
1785
 
 
1786
 
class TestSetSecretCmd(TestPropertyValueCmd):
 
2727
    values_to_set = ["192.0.2.3", "client.example.org"]
 
2728
 
 
2729
 
 
2730
class TestSetSecretCmd(TestPropertySetterCmd):
1787
2731
    command = command.SetSecret
1788
2732
    propname = "Secret"
1789
 
    values_to_set = [io.BytesIO(b""),
1790
 
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1791
 
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
1792
 
 
1793
 
 
1794
 
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
2733
    def __init__(self, *args, **kwargs):
 
2734
        self.values_to_set = [io.BytesIO(b""),
 
2735
                              io.BytesIO(b"secret\0xyzzy\nbar")]
 
2736
        self.values_to_get = [f.getvalue() for f in
 
2737
                              self.values_to_set]
 
2738
        super(TestSetSecretCmd, self).__init__(*args, **kwargs)
 
2739
 
 
2740
 
 
2741
class TestSetTimeoutCmd(TestPropertySetterCmd):
1795
2742
    command = command.SetTimeout
1796
2743
    propname = "Timeout"
1797
2744
    values_to_set = [datetime.timedelta(),
1799
2746
                     datetime.timedelta(seconds=1),
1800
2747
                     datetime.timedelta(weeks=1),
1801
2748
                     datetime.timedelta(weeks=52)]
1802
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1803
 
 
1804
 
 
1805
 
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
2749
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
2750
 
 
2751
 
 
2752
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1806
2753
    command = command.SetExtendedTimeout
1807
2754
    propname = "ExtendedTimeout"
1808
2755
    values_to_set = [datetime.timedelta(),
1810
2757
                     datetime.timedelta(seconds=1),
1811
2758
                     datetime.timedelta(weeks=1),
1812
2759
                     datetime.timedelta(weeks=52)]
1813
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1814
 
 
1815
 
 
1816
 
class TestSetIntervalCmd(TestPropertyValueCmd):
 
2760
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
2761
 
 
2762
 
 
2763
class TestSetIntervalCmd(TestPropertySetterCmd):
1817
2764
    command = command.SetInterval
1818
2765
    propname = "Interval"
1819
2766
    values_to_set = [datetime.timedelta(),
1821
2768
                     datetime.timedelta(seconds=1),
1822
2769
                     datetime.timedelta(weeks=1),
1823
2770
                     datetime.timedelta(weeks=52)]
1824
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1825
 
 
1826
 
 
1827
 
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
2771
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
2772
 
 
2773
 
 
2774
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1828
2775
    command = command.SetApprovalDelay
1829
2776
    propname = "ApprovalDelay"
1830
2777
    values_to_set = [datetime.timedelta(),
1832
2779
                     datetime.timedelta(seconds=1),
1833
2780
                     datetime.timedelta(weeks=1),
1834
2781
                     datetime.timedelta(weeks=52)]
1835
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1836
 
 
1837
 
 
1838
 
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
2782
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
2783
 
 
2784
 
 
2785
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1839
2786
    command = command.SetApprovalDuration
1840
2787
    propname = "ApprovalDuration"
1841
2788
    values_to_set = [datetime.timedelta(),
1843
2790
                     datetime.timedelta(seconds=1),
1844
2791
                     datetime.timedelta(weeks=1),
1845
2792
                     datetime.timedelta(weeks=52)]
1846
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
2793
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1847
2794
 
1848
2795
 
1849
2796
 
1850
 
def should_only_run_tests():
 
2797
def parse_test_args():
 
2798
    # type: () -> argparse.Namespace
1851
2799
    parser = argparse.ArgumentParser(add_help=False)
1852
 
    parser.add_argument("--check", action='store_true')
 
2800
    parser.add_argument("--check", action="store_true")
 
2801
    parser.add_argument("--prefix", )
1853
2802
    args, unknown_args = parser.parse_known_args()
1854
 
    run_tests = args.check
1855
 
    if run_tests:
1856
 
        # Remove --check argument from sys.argv
 
2803
    if args.check:
 
2804
        # Remove test options from sys.argv
1857
2805
        sys.argv[1:] = unknown_args
1858
 
    return run_tests
 
2806
    return args
1859
2807
 
1860
2808
# Add all tests from doctest strings
1861
2809
def load_tests(loader, tests, none):
1864
2812
    return tests
1865
2813
 
1866
2814
if __name__ == "__main__":
 
2815
    options = parse_test_args()
1867
2816
    try:
1868
 
        if should_only_run_tests():
1869
 
            # Call using ./tdd-python-script --check [--verbose]
1870
 
            unittest.main()
 
2817
        if options.check:
 
2818
            extra_test_prefix = options.prefix
 
2819
            if extra_test_prefix is not None:
 
2820
                if not (unittest.main(argv=[""], exit=False)
 
2821
                        .result.wasSuccessful()):
 
2822
                    sys.exit(1)
 
2823
                class ExtraTestLoader(unittest.TestLoader):
 
2824
                    testMethodPrefix = extra_test_prefix
 
2825
                # Call using ./scriptname --check [--verbose]
 
2826
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
2827
            else:
 
2828
                unittest.main(argv=[""])
1871
2829
        else:
1872
2830
            main()
1873
2831
    finally:
1874
2832
        logging.shutdown()
 
2833
 
 
2834
# Local Variables:
 
2835
# run-tests:
 
2836
# (lambda (&optional extra)
 
2837
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
2838
#             extra))
 
2839
#       (funcall show-test-buffer-in-test-window)
 
2840
#     (funcall remove-test-window)
 
2841
#     (if extra (message "Extra tests run successfully!"))))
 
2842
# run-tests-in-test-buffer:
 
2843
# (lambda (dir &optional extra)
 
2844
#   (with-current-buffer (get-buffer-create "*Test*")
 
2845
#     (setq buffer-read-only nil
 
2846
#           default-directory dir)
 
2847
#     (erase-buffer)
 
2848
#     (compilation-mode))
 
2849
#   (let ((process-result
 
2850
#          (let ((inhibit-read-only t))
 
2851
#            (process-file-shell-command
 
2852
#             (funcall get-command-line extra) nil "*Test*"))))
 
2853
#     (and (numberp process-result)
 
2854
#          (= process-result 0))))
 
2855
# get-command-line:
 
2856
# (lambda (&optional extra)
 
2857
#   (let ((quoted-script
 
2858
#          (shell-quote-argument (funcall get-script-name))))
 
2859
#     (format
 
2860
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
2861
#      quoted-script)))
 
2862
# get-script-name:
 
2863
# (lambda ()
 
2864
#   (if (fboundp 'file-local-name)
 
2865
#       (file-local-name (buffer-file-name))
 
2866
#     (or (file-remote-p (buffer-file-name) 'localname)
 
2867
#         (buffer-file-name))))
 
2868
# remove-test-window:
 
2869
# (lambda ()
 
2870
#   (let ((test-window (get-buffer-window "*Test*")))
 
2871
#     (if test-window (delete-window test-window))))
 
2872
# show-test-buffer-in-test-window:
 
2873
# (lambda ()
 
2874
#   (when (not (get-buffer-window-list "*Test*"))
 
2875
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
2876
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
2877
#            (display-buffer-overriding-action
 
2878
#             `((display-buffer-in-side-window) (side . ,side)
 
2879
#               (window-height . fit-window-to-buffer)
 
2880
#               (window-width . fit-window-to-buffer))))
 
2881
#       (display-buffer "*Test*"))))
 
2882
# eval:
 
2883
# (progn
 
2884
#   (let* ((run-extra-tests (lambda () (interactive)
 
2885
#                             (funcall run-tests t)))
 
2886
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
2887
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
2888
#     (setq minor-mode-overriding-map-alist
 
2889
#           (cons `(run-tests . ,outer-keymap)
 
2890
#                 minor-mode-overriding-map-alist)))
 
2891
#   (add-hook 'after-save-hook run-tests 90 t))
 
2892
# End: