/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 at recompile
  • Date: 2020-07-04 08:59:37 UTC
  • Revision ID: teddy@recompile.se-20200704085937-r495zb32nfng9lnt
In initramfs-tools boots, only use setsid when available

* initramfs-tools-script: If available, use setsid to start
  mandos-to-cryptroot-unlock.

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