/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-16 04:38:35 UTC
  • Revision ID: teddy@recompile.se-20190316043835-xlmz9xse3bh1u5u6
mandos-ctl: Refactor tests

* mandos-ctl (Test_get_managed_objects): Remove some useless
                                         "@staticmethod"s.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python
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 --test" (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 -*-
 
2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
46
46
import tempfile
47
47
import contextlib
48
48
 
49
 
try:
50
 
    import pydbus
51
 
    import gi
52
 
    dbus_python = None
53
 
except ImportError:
54
 
    import dbus as dbus_python
55
 
    pydbus = None
56
 
    class gi(object):
57
 
        """Dummy gi module, for the tests"""
58
 
        class repository(object):
59
 
            class GLib(object):
60
 
                class Error(Exception):
61
 
                    pass
 
49
import dbus
62
50
 
63
51
# Show warnings by default
64
52
if not sys.warnoptions:
73
61
 
74
62
if sys.version_info.major == 2:
75
63
    str = unicode
76
 
    import StringIO
77
 
    io.StringIO = StringIO.StringIO
78
64
 
79
65
locale.setlocale(locale.LC_ALL, "")
80
66
 
81
 
version = "1.8.4"
 
67
dbus_busname_domain = "se.recompile"
 
68
dbus_busname = dbus_busname_domain + ".Mandos"
 
69
server_dbus_path = "/"
 
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
 
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
 
72
del dbus_busname_domain
 
73
version = "1.8.3"
 
74
 
 
75
 
 
76
try:
 
77
    dbus.OBJECT_MANAGER_IFACE
 
78
except AttributeError:
 
79
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
82
80
 
83
81
 
84
82
def main():
85
83
    parser = argparse.ArgumentParser()
 
84
 
86
85
    add_command_line_options(parser)
87
86
 
88
87
    options = parser.parse_args()
 
88
 
89
89
    check_option_syntax(parser, options)
90
90
 
91
91
    clientnames = options.client
93
93
    if options.debug:
94
94
        log.setLevel(logging.DEBUG)
95
95
 
96
 
    if pydbus is not None:
97
 
        bus = pydbus_adapter.CachingBus(pydbus)
98
 
    else:
99
 
        bus = dbus_python_adapter.CachingBus(dbus_python)
100
 
 
101
 
    try:
102
 
        all_clients = bus.get_clients_and_properties()
103
 
    except dbus.ConnectFailed as e:
104
 
        log.critical("Could not connect to Mandos server: %s", e)
105
 
        sys.exit(1)
106
 
    except dbus.Error as e:
107
 
        log.critical(
108
 
            "Failed to access Mandos server through D-Bus:\n%s", e)
109
 
        sys.exit(1)
 
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
110
113
 
111
114
    # Compile dict of (clientpath: properties) to process
112
115
    if not clientnames:
122
125
                log.critical("Client not found on server: %r", name)
123
126
                sys.exit(1)
124
127
 
 
128
    # Run all commands on clients
125
129
    commands = commands_from_options(options)
126
 
 
127
130
    for command in commands:
128
 
        command.run(clients, bus)
 
131
        command.run(clients, bus, mandos_serv)
129
132
 
130
133
 
131
134
def add_command_line_options(parser):
136
139
                        help="Select all clients")
137
140
    parser.add_argument("-v", "--verbose", action="store_true",
138
141
                        help="Print all fields")
139
 
    parser.add_argument("-j", "--dump-json", dest="commands",
140
 
                        action="append_const", default=[],
141
 
                        const=command.DumpJSON(),
 
142
    parser.add_argument("-j", "--dump-json", action="store_true",
142
143
                        help="Dump client data in JSON format")
143
144
    enable_disable = parser.add_mutually_exclusive_group()
144
 
    enable_disable.add_argument("-e", "--enable", dest="commands",
145
 
                                action="append_const", default=[],
146
 
                                const=command.Enable(),
 
145
    enable_disable.add_argument("-e", "--enable", action="store_true",
147
146
                                help="Enable client")
148
 
    enable_disable.add_argument("-d", "--disable", dest="commands",
149
 
                                action="append_const", default=[],
150
 
                                const=command.Disable(),
 
147
    enable_disable.add_argument("-d", "--disable",
 
148
                                action="store_true",
151
149
                                help="disable client")
152
 
    parser.add_argument("-b", "--bump-timeout", dest="commands",
153
 
                        action="append_const", default=[],
154
 
                        const=command.BumpTimeout(),
 
150
    parser.add_argument("-b", "--bump-timeout", action="store_true",
155
151
                        help="Bump timeout for client")
156
152
    start_stop_checker = parser.add_mutually_exclusive_group()
157
153
    start_stop_checker.add_argument("--start-checker",
158
 
                                    dest="commands",
159
 
                                    action="append_const", default=[],
160
 
                                    const=command.StartChecker(),
 
154
                                    action="store_true",
161
155
                                    help="Start checker for client")
162
 
    start_stop_checker.add_argument("--stop-checker", dest="commands",
163
 
                                    action="append_const", default=[],
164
 
                                    const=command.StopChecker(),
 
156
    start_stop_checker.add_argument("--stop-checker",
 
157
                                    action="store_true",
165
158
                                    help="Stop checker for client")
166
 
    parser.add_argument("-V", "--is-enabled", dest="commands",
167
 
                        action="append_const", default=[],
168
 
                        const=command.IsEnabled(),
 
159
    parser.add_argument("-V", "--is-enabled", action="store_true",
169
160
                        help="Check if client is enabled")
170
 
    parser.add_argument("-r", "--remove", dest="commands",
171
 
                        action="append_const", default=[],
172
 
                        const=command.Remove(),
 
161
    parser.add_argument("-r", "--remove", action="store_true",
173
162
                        help="Remove client")
174
 
    parser.add_argument("-c", "--checker", dest="commands",
175
 
                        action="append", default=[],
176
 
                        metavar="COMMAND", type=command.SetChecker,
 
163
    parser.add_argument("-c", "--checker",
177
164
                        help="Set checker command for client")
178
 
    parser.add_argument(
179
 
        "-t", "--timeout", dest="commands", action="append",
180
 
        default=[], metavar="TIME",
181
 
        type=command.SetTimeout.argparse(string_to_delta),
182
 
        help="Set timeout for client")
183
 
    parser.add_argument(
184
 
        "--extended-timeout", dest="commands", action="append",
185
 
        default=[], metavar="TIME",
186
 
        type=command.SetExtendedTimeout.argparse(string_to_delta),
187
 
        help="Set extended timeout for client")
188
 
    parser.add_argument(
189
 
        "-i", "--interval", dest="commands", action="append",
190
 
        default=[], metavar="TIME",
191
 
        type=command.SetInterval.argparse(string_to_delta),
192
 
        help="Set checker interval 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")
193
171
    approve_deny_default = parser.add_mutually_exclusive_group()
194
172
    approve_deny_default.add_argument(
195
 
        "--approve-by-default", dest="commands",
196
 
        action="append_const", default=[],
197
 
        const=command.ApproveByDefault(),
 
173
        "--approve-by-default", action="store_true",
 
174
        default=None, dest="approved_by_default",
198
175
        help="Set client to be approved by default")
199
176
    approve_deny_default.add_argument(
200
 
        "--deny-by-default", dest="commands",
201
 
        action="append_const", default=[],
202
 
        const=command.DenyByDefault(),
 
177
        "--deny-by-default", action="store_false",
 
178
        dest="approved_by_default",
203
179
        help="Set client to be denied by default")
204
 
    parser.add_argument(
205
 
        "--approval-delay", dest="commands", action="append",
206
 
        default=[], metavar="TIME",
207
 
        type=command.SetApprovalDelay.argparse(string_to_delta),
208
 
        help="Set delay before client approve/deny")
209
 
    parser.add_argument(
210
 
        "--approval-duration", dest="commands", action="append",
211
 
        default=[], metavar="TIME",
212
 
        type=command.SetApprovalDuration.argparse(string_to_delta),
213
 
        help="Set duration of one client approval")
214
 
    parser.add_argument("-H", "--host", dest="commands",
215
 
                        action="append", default=[], metavar="STRING",
216
 
                        type=command.SetHost,
217
 
                        help="Set host for client")
218
 
    parser.add_argument(
219
 
        "-s", "--secret", dest="commands", action="append",
220
 
        default=[], metavar="FILENAME",
221
 
        type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
222
 
        help="Set password blob (file) for client")
 
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")
223
188
    approve_deny = parser.add_mutually_exclusive_group()
224
189
    approve_deny.add_argument(
225
 
        "-A", "--approve", dest="commands", action="append_const",
226
 
        default=[], const=command.Approve(),
 
190
        "-A", "--approve", action="store_true",
227
191
        help="Approve any current client request")
228
 
    approve_deny.add_argument("-D", "--deny", dest="commands",
229
 
                              action="append_const", default=[],
230
 
                              const=command.Deny(),
 
192
    approve_deny.add_argument("-D", "--deny", action="store_true",
231
193
                              help="Deny any current client request")
232
194
    parser.add_argument("--debug", action="store_true",
233
195
                        help="Debug mode (show D-Bus commands)")
270
232
    >>> rfc3339_duration_to_delta("")
271
233
    Traceback (most recent call last):
272
234
    ...
273
 
    ValueError: Invalid RFC 3339 duration: ""
 
235
    ValueError: Invalid RFC 3339 duration: u''
274
236
    >>> # Must start with "P":
275
237
    >>> rfc3339_duration_to_delta("1D")
276
238
    Traceback (most recent call last):
277
239
    ...
278
 
    ValueError: Invalid RFC 3339 duration: "1D"
 
240
    ValueError: Invalid RFC 3339 duration: u'1D'
279
241
    >>> # Must use correct order
280
242
    >>> rfc3339_duration_to_delta("PT1S2M")
281
243
    Traceback (most recent call last):
282
244
    ...
283
 
    ValueError: Invalid RFC 3339 duration: "PT1S2M"
 
245
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
284
246
    >>> # Time needs time marker
285
247
    >>> rfc3339_duration_to_delta("P1H2S")
286
248
    Traceback (most recent call last):
287
249
    ...
288
 
    ValueError: Invalid RFC 3339 duration: "P1H2S"
 
250
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
289
251
    >>> # Weeks can not be combined with anything else
290
252
    >>> rfc3339_duration_to_delta("P1D2W")
291
253
    Traceback (most recent call last):
292
254
    ...
293
 
    ValueError: Invalid RFC 3339 duration: "P1D2W"
 
255
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
294
256
    >>> rfc3339_duration_to_delta("P2W2H")
295
257
    Traceback (most recent call last):
296
258
    ...
297
 
    ValueError: Invalid RFC 3339 duration: "P2W2H"
 
259
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
298
260
    """
299
261
 
300
262
    # Parsing an RFC 3339 duration with regular expressions is not
371
333
                break
372
334
        else:
373
335
            # No currently valid tokens were found
374
 
            raise ValueError("Invalid RFC 3339 duration: \"{}\""
 
336
            raise ValueError("Invalid RFC 3339 duration: {!r}"
375
337
                             .format(duration))
376
338
    # End token found
377
339
    return value
424
386
    """Apply additional restrictions on options, not expressible in
425
387
argparse"""
426
388
 
427
 
    def has_commands(options, commands=None):
428
 
        if commands is None:
429
 
            commands = (command.Enable,
430
 
                        command.Disable,
431
 
                        command.BumpTimeout,
432
 
                        command.StartChecker,
433
 
                        command.StopChecker,
434
 
                        command.IsEnabled,
435
 
                        command.Remove,
436
 
                        command.SetChecker,
437
 
                        command.SetTimeout,
438
 
                        command.SetExtendedTimeout,
439
 
                        command.SetInterval,
440
 
                        command.ApproveByDefault,
441
 
                        command.DenyByDefault,
442
 
                        command.SetApprovalDelay,
443
 
                        command.SetApprovalDuration,
444
 
                        command.SetHost,
445
 
                        command.SetSecret,
446
 
                        command.Approve,
447
 
                        command.Deny)
448
 
        return any(isinstance(cmd, commands)
449
 
                   for cmd in options.commands)
 
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))
450
408
 
451
 
    if has_commands(options) and not (options.client or options.all):
 
409
    if has_actions(options) and not (options.client or options.all):
452
410
        parser.error("Options require clients names or --all.")
453
 
    if options.verbose and has_commands(options):
 
411
    if options.verbose and has_actions(options):
454
412
        parser.error("--verbose can only be used alone.")
455
 
    if (has_commands(options, (command.DumpJSON,))
456
 
        and (options.verbose or len(options.commands) > 1)):
 
413
    if options.dump_json and (options.verbose
 
414
                              or has_actions(options)):
457
415
        parser.error("--dump-json can only be used alone.")
458
 
    if options.all and not has_commands(options):
 
416
    if options.all and not has_actions(options):
459
417
        parser.error("--all requires an action.")
460
 
    if (has_commands(options, (command.IsEnabled,))
461
 
        and len(options.client) > 1):
 
418
    if options.is_enabled and len(options.client) > 1:
462
419
        parser.error("--is-enabled requires exactly one client")
463
 
    if (len(options.commands) > 1
464
 
        and has_commands(options, (command.Remove,))
465
 
        and not has_commands(options, (command.Deny,))):
466
 
        parser.error("--remove can only be combined with --deny")
467
 
 
468
 
 
469
 
class dbus(object):
470
 
 
471
 
    class SystemBus(object):
472
 
 
473
 
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
474
 
        def get_managed_objects(self, busname, objectpath):
475
 
            return self.call_method("GetManagedObjects", busname,
476
 
                                    objectpath,
477
 
                                    self.object_manager_iface)
478
 
 
479
 
        properties_iface = "org.freedesktop.DBus.Properties"
480
 
        def set_property(self, busname, objectpath, interface, key,
481
 
                         value):
482
 
            self.call_method("Set", busname, objectpath,
483
 
                             self.properties_iface, interface, key,
484
 
                             value)
485
 
 
486
 
 
487
 
    class MandosBus(SystemBus):
488
 
        busname_domain = "se.recompile"
489
 
        busname = busname_domain + ".Mandos"
490
 
        server_path = "/"
491
 
        server_interface = busname_domain + ".Mandos"
492
 
        client_interface = busname_domain + ".Mandos.Client"
493
 
        del busname_domain
494
 
 
495
 
        def get_clients_and_properties(self):
496
 
            managed_objects = self.get_managed_objects(
497
 
                self.busname, self.server_path)
498
 
            return {objpath: properties[self.client_interface]
499
 
                    for objpath, properties in managed_objects.items()
500
 
                    if self.client_interface in properties}
501
 
 
502
 
        def set_client_property(self, objectpath, key, value):
503
 
            return self.set_property(self.busname, objectpath,
504
 
                                     self.client_interface, key,
505
 
                                     value)
506
 
 
507
 
        def call_client_method(self, objectpath, method, *args):
508
 
            return self.call_method(method, self.busname, objectpath,
509
 
                                    self.client_interface, *args)
510
 
 
511
 
        def call_server_method(self, method, *args):
512
 
            return self.call_method(method, self.busname,
513
 
                                    self.server_path,
514
 
                                    self.server_interface, *args)
515
 
 
516
 
    class Error(Exception):
517
 
        pass
518
 
 
519
 
    class ConnectFailed(Error):
520
 
        pass
521
 
 
522
 
 
523
 
class dbus_python_adapter(object):
524
 
 
525
 
    class SystemBus(dbus.MandosBus):
526
 
        """Use dbus-python"""
527
 
 
528
 
        def __init__(self, module=dbus_python):
529
 
            self.dbus_python = module
530
 
            self.bus = self.dbus_python.SystemBus()
531
 
 
532
 
        @contextlib.contextmanager
533
 
        def convert_exception(self, exception_class=dbus.Error):
534
 
            try:
535
 
                yield
536
 
            except self.dbus_python.exceptions.DBusException as e:
537
 
                # This does what "raise from" would do
538
 
                exc = exception_class(*e.args)
539
 
                exc.__cause__ = e
540
 
                raise exc
541
 
 
542
 
        def call_method(self, methodname, busname, objectpath,
543
 
                        interface, *args):
544
 
            proxy_object = self.get_object(busname, objectpath)
545
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
546
 
                      interface, methodname,
547
 
                      ", ".join(repr(a) for a in args))
548
 
            method = getattr(proxy_object, methodname)
549
 
            with self.convert_exception():
550
 
                with dbus_python_adapter.SilenceLogger(
551
 
                        "dbus.proxies"):
552
 
                    value = method(*args, dbus_interface=interface)
553
 
            return self.type_filter(value)
554
 
 
555
 
        def get_object(self, busname, objectpath):
556
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
557
 
                      busname, objectpath)
558
 
            with self.convert_exception(dbus.ConnectFailed):
559
 
                return self.bus.get_object(busname, objectpath)
560
 
 
561
 
        def type_filter(self, value):
562
 
            """Convert the most bothersome types to Python types"""
563
 
            if isinstance(value, self.dbus_python.Boolean):
564
 
                return bool(value)
565
 
            if isinstance(value, self.dbus_python.ObjectPath):
566
 
                return str(value)
567
 
            # Also recurse into dictionaries
568
 
            if isinstance(value, self.dbus_python.Dictionary):
569
 
                return {self.type_filter(key):
570
 
                        self.type_filter(subval)
571
 
                        for key, subval in value.items()}
572
 
            return value
573
 
 
574
 
        def set_client_property(self, objectpath, key, value):
575
 
            if key == "Secret":
576
 
                if not isinstance(value, bytes):
577
 
                    value = value.encode("utf-8")
578
 
                value = self.dbus_python.ByteArray(value)
579
 
            return self.set_property(self.busname, objectpath,
580
 
                                     self.client_interface, key,
581
 
                                     value)
582
 
 
583
 
    class SilenceLogger(object):
584
 
        "Simple context manager to silence a particular logger"
585
 
        def __init__(self, loggername):
586
 
            self.logger = logging.getLogger(loggername)
587
 
 
588
 
        def __enter__(self):
589
 
            self.logger.addFilter(self.nullfilter)
590
 
 
591
 
        class NullFilter(logging.Filter):
592
 
            def filter(self, record):
593
 
                return False
594
 
 
595
 
        nullfilter = NullFilter()
596
 
 
597
 
        def __exit__(self, exc_type, exc_val, exc_tb):
598
 
            self.logger.removeFilter(self.nullfilter)
599
 
 
600
 
 
601
 
    class CachingBus(SystemBus):
602
 
        """A caching layer for dbus_python_adapter.SystemBus"""
603
 
        def __init__(self, *args, **kwargs):
604
 
            self.object_cache = {}
605
 
            super(dbus_python_adapter.CachingBus,
606
 
                  self).__init__(*args, **kwargs)
607
 
        def get_object(self, busname, objectpath):
608
 
            try:
609
 
                return self.object_cache[(busname, objectpath)]
610
 
            except KeyError:
611
 
                new_object = super(
612
 
                    dbus_python_adapter.CachingBus,
613
 
                    self).get_object(busname, objectpath)
614
 
                self.object_cache[(busname, objectpath)]  = new_object
615
 
                return new_object
616
 
 
617
 
 
618
 
class pydbus_adapter(object):
619
 
    class SystemBus(dbus.MandosBus):
620
 
        def __init__(self, module=pydbus):
621
 
            self.pydbus = module
622
 
            self.bus = self.pydbus.SystemBus()
623
 
 
624
 
        @contextlib.contextmanager
625
 
        def convert_exception(self, exception_class=dbus.Error):
626
 
            try:
627
 
                yield
628
 
            except gi.repository.GLib.Error as e:
629
 
                # This does what "raise from" would do
630
 
                exc = exception_class(*e.args)
631
 
                exc.__cause__ = e
632
 
                raise exc
633
 
 
634
 
        def call_method(self, methodname, busname, objectpath,
635
 
                        interface, *args):
636
 
            proxy_object = self.get(busname, objectpath)
637
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
638
 
                      interface, methodname,
639
 
                      ", ".join(repr(a) for a in args))
640
 
            method = getattr(proxy_object[interface], methodname)
641
 
            with self.convert_exception():
642
 
                return method(*args)
643
 
 
644
 
        def get(self, busname, objectpath):
645
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
646
 
                      busname, objectpath)
647
 
            with self.convert_exception(dbus.ConnectFailed):
648
 
                if sys.version_info.major <= 2:
649
 
                    with warnings.catch_warnings():
650
 
                        warnings.filterwarnings(
651
 
                            "ignore", "", DeprecationWarning,
652
 
                            r"^xml\.etree\.ElementTree$")
653
 
                        return self.bus.get(busname, objectpath)
654
 
                else:
655
 
                    return self.bus.get(busname, objectpath)
656
 
 
657
 
        def set_property(self, busname, objectpath, interface, key,
658
 
                         value):
659
 
            proxy_object = self.get(busname, objectpath)
660
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
661
 
                      objectpath, self.properties_iface, interface,
662
 
                      key, value)
663
 
            setattr(proxy_object[interface], key, value)
664
 
 
665
 
    class CachingBus(SystemBus):
666
 
        """A caching layer for pydbus_adapter.SystemBus"""
667
 
        def __init__(self, *args, **kwargs):
668
 
            self.object_cache = {}
669
 
            super(pydbus_adapter.CachingBus,
670
 
                  self).__init__(*args, **kwargs)
671
 
        def get(self, busname, objectpath):
672
 
            try:
673
 
                return self.object_cache[(busname, objectpath)]
674
 
            except KeyError:
675
 
                new_object = (super(pydbus_adapter.CachingBus, self)
676
 
                              .get(busname, objectpath))
677
 
                self.object_cache[(busname, objectpath)]  = new_object
678
 
                return new_object
 
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
        return self
 
464
 
 
465
    class NullFilter(logging.Filter):
 
466
        def filter(self, record):
 
467
            return False
 
468
 
 
469
    nullfilter = NullFilter()
 
470
 
 
471
    def __exit__(self, exc_type, exc_val, exc_tb):
 
472
        self.logger.removeFilter(self.nullfilter)
679
473
 
680
474
 
681
475
def commands_from_options(options):
682
476
 
683
 
    commands = list(options.commands)
684
 
 
685
 
    def find_cmd(cmd, commands):
686
 
        i = 0
687
 
        for i, c in enumerate(commands):
688
 
            if isinstance(c, cmd):
689
 
                return i
690
 
        return i+1
691
 
 
692
 
    # If command.Remove is present, move any instances of command.Deny
693
 
    # to occur ahead of command.Remove.
694
 
    index_of_remove = find_cmd(command.Remove, commands)
695
 
    before_remove = commands[:index_of_remove]
696
 
    after_remove = commands[index_of_remove:]
697
 
    cleaned_after = []
698
 
    for cmd in after_remove:
699
 
        if isinstance(cmd, command.Deny):
700
 
            before_remove.append(cmd)
 
477
    commands = []
 
478
 
 
479
    if options.is_enabled:
 
480
        commands.append(IsEnabledCmd())
 
481
 
 
482
    if options.approve:
 
483
        commands.append(ApproveCmd())
 
484
 
 
485
    if options.deny:
 
486
        commands.append(DenyCmd())
 
487
 
 
488
    if options.remove:
 
489
        commands.append(RemoveCmd())
 
490
 
 
491
    if options.dump_json:
 
492
        commands.append(DumpJSONCmd())
 
493
 
 
494
    if options.enable:
 
495
        commands.append(EnableCmd())
 
496
 
 
497
    if options.disable:
 
498
        commands.append(DisableCmd())
 
499
 
 
500
    if options.bump_timeout:
 
501
        commands.append(BumpTimeoutCmd())
 
502
 
 
503
    if options.start_checker:
 
504
        commands.append(StartCheckerCmd())
 
505
 
 
506
    if options.stop_checker:
 
507
        commands.append(StopCheckerCmd())
 
508
 
 
509
    if options.approved_by_default is not None:
 
510
        if options.approved_by_default:
 
511
            commands.append(ApproveByDefaultCmd())
701
512
        else:
702
 
            cleaned_after.append(cmd)
703
 
    if cleaned_after != after_remove:
704
 
        commands = before_remove + cleaned_after
 
513
            commands.append(DenyByDefaultCmd())
 
514
 
 
515
    if options.checker is not None:
 
516
        commands.append(SetCheckerCmd(options.checker))
 
517
 
 
518
    if options.host is not None:
 
519
        commands.append(SetHostCmd(options.host))
 
520
 
 
521
    if options.secret is not None:
 
522
        commands.append(SetSecretCmd(options.secret))
 
523
 
 
524
    if options.timeout is not None:
 
525
        commands.append(SetTimeoutCmd(options.timeout))
 
526
 
 
527
    if options.extended_timeout:
 
528
        commands.append(
 
529
            SetExtendedTimeoutCmd(options.extended_timeout))
 
530
 
 
531
    if options.interval is not None:
 
532
        commands.append(SetIntervalCmd(options.interval))
 
533
 
 
534
    if options.approval_delay is not None:
 
535
        commands.append(SetApprovalDelayCmd(options.approval_delay))
 
536
 
 
537
    if options.approval_duration is not None:
 
538
        commands.append(
 
539
            SetApprovalDurationCmd(options.approval_duration))
705
540
 
706
541
    # If no command option has been given, show table of clients,
707
542
    # optionally verbosely
708
543
    if not commands:
709
 
        commands.append(command.PrintTable(verbose=options.verbose))
 
544
        commands.append(PrintTableCmd(verbose=options.verbose))
710
545
 
711
546
    return commands
712
547
 
713
548
 
714
 
class command(object):
715
 
    """A namespace for command classes"""
716
 
 
717
 
    class Base(object):
718
 
        """Abstract base class for commands"""
719
 
        def run(self, clients, bus=None):
720
 
            """Normal commands should implement run_on_one_client(),
721
 
but commands which want to operate on all clients at the same time can
722
 
override this run() method instead.
723
 
"""
724
 
            self.bus = bus
725
 
            for client, properties in clients.items():
726
 
                self.run_on_one_client(client, properties)
727
 
 
728
 
 
729
 
    class IsEnabled(Base):
730
 
        def run(self, clients, bus=None):
731
 
            properties = next(iter(clients.values()))
732
 
            if properties["Enabled"]:
733
 
                sys.exit(0)
734
 
            sys.exit(1)
735
 
 
736
 
 
737
 
    class Approve(Base):
738
 
        def run_on_one_client(self, client, properties):
739
 
            self.bus.call_client_method(client, "Approve", True)
740
 
 
741
 
 
742
 
    class Deny(Base):
743
 
        def run_on_one_client(self, client, properties):
744
 
            self.bus.call_client_method(client, "Approve", False)
745
 
 
746
 
 
747
 
    class Remove(Base):
748
 
        def run(self, clients, bus):
749
 
            for clientpath in frozenset(clients.keys()):
750
 
                bus.call_server_method("RemoveClient", clientpath)
751
 
 
752
 
 
753
 
    class Output(Base):
754
 
        """Abstract class for commands outputting client details"""
755
 
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
756
 
                        "Created", "Interval", "Host", "KeyID",
757
 
                        "Fingerprint", "CheckerRunning",
758
 
                        "LastEnabled", "ApprovalPending",
759
 
                        "ApprovedByDefault", "LastApprovalRequest",
760
 
                        "ApprovalDelay", "ApprovalDuration",
761
 
                        "Checker", "ExtendedTimeout", "Expires",
762
 
                        "LastCheckerStatus")
763
 
 
764
 
 
765
 
    class DumpJSON(Output):
766
 
        def run(self, clients, bus=None):
767
 
            data = {properties["Name"]:
768
 
                    {key: properties[key]
769
 
                     for key in self.all_keywords}
770
 
                    for properties in clients.values()}
771
 
            print(json.dumps(data, indent=4, separators=(',', ': ')))
772
 
 
773
 
 
774
 
    class PrintTable(Output):
775
 
        def __init__(self, verbose=False):
776
 
            self.verbose = verbose
777
 
 
778
 
        def run(self, clients, bus=None):
779
 
            default_keywords = ("Name", "Enabled", "Timeout",
780
 
                                "LastCheckedOK")
781
 
            keywords = default_keywords
782
 
            if self.verbose:
783
 
                keywords = self.all_keywords
784
 
            print(self.TableOfClients(clients.values(), keywords))
785
 
 
786
 
        class TableOfClients(object):
787
 
            tableheaders = {
788
 
                "Name": "Name",
789
 
                "Enabled": "Enabled",
790
 
                "Timeout": "Timeout",
791
 
                "LastCheckedOK": "Last Successful Check",
792
 
                "LastApprovalRequest": "Last Approval Request",
793
 
                "Created": "Created",
794
 
                "Interval": "Interval",
795
 
                "Host": "Host",
796
 
                "Fingerprint": "Fingerprint",
797
 
                "KeyID": "Key ID",
798
 
                "CheckerRunning": "Check Is Running",
799
 
                "LastEnabled": "Last Enabled",
800
 
                "ApprovalPending": "Approval Is Pending",
801
 
                "ApprovedByDefault": "Approved By Default",
802
 
                "ApprovalDelay": "Approval Delay",
803
 
                "ApprovalDuration": "Approval Duration",
804
 
                "Checker": "Checker",
805
 
                "ExtendedTimeout": "Extended Timeout",
806
 
                "Expires": "Expires",
807
 
                "LastCheckerStatus": "Last Checker Status",
808
 
            }
809
 
 
810
 
            def __init__(self, clients, keywords):
811
 
                self.clients = clients
812
 
                self.keywords = keywords
813
 
 
 
549
class Command(object):
 
550
    """Abstract class for commands"""
 
551
    def run(self, clients, bus=None, mandos=None):
 
552
        """Normal commands should implement run_on_one_client(), but
 
553
        commands which want to operate on all clients at the same time
 
554
        can override this run() method instead."""
 
555
        self.mandos = mandos
 
556
        for clientpath, properties in clients.items():
 
557
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
558
                      dbus_busname, str(clientpath))
 
559
            client = bus.get_object(dbus_busname, clientpath)
 
560
            self.run_on_one_client(client, properties)
 
561
 
 
562
 
 
563
class IsEnabledCmd(Command):
 
564
    def run(self, clients, bus=None, mandos=None):
 
565
        client, properties = next(iter(clients.items()))
 
566
        if self.is_enabled(client, properties):
 
567
            sys.exit(0)
 
568
        sys.exit(1)
 
569
    def is_enabled(self, client, properties):
 
570
        return properties["Enabled"]
 
571
 
 
572
 
 
573
class ApproveCmd(Command):
 
574
    def run_on_one_client(self, client, properties):
 
575
        log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
576
                  client.__dbus_object_path__, client_dbus_interface)
 
577
        client.Approve(dbus.Boolean(True),
 
578
                       dbus_interface=client_dbus_interface)
 
579
 
 
580
 
 
581
class DenyCmd(Command):
 
582
    def run_on_one_client(self, client, properties):
 
583
        log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
584
                  client.__dbus_object_path__, client_dbus_interface)
 
585
        client.Approve(dbus.Boolean(False),
 
586
                       dbus_interface=client_dbus_interface)
 
587
 
 
588
 
 
589
class RemoveCmd(Command):
 
590
    def run_on_one_client(self, client, properties):
 
591
        log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
 
592
                  server_dbus_path, server_dbus_interface,
 
593
                  str(client.__dbus_object_path__))
 
594
        self.mandos.RemoveClient(client.__dbus_object_path__)
 
595
 
 
596
 
 
597
class OutputCmd(Command):
 
598
    """Abstract class for commands outputting client details"""
 
599
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
600
                    "Created", "Interval", "Host", "KeyID",
 
601
                    "Fingerprint", "CheckerRunning", "LastEnabled",
 
602
                    "ApprovalPending", "ApprovedByDefault",
 
603
                    "LastApprovalRequest", "ApprovalDelay",
 
604
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
 
605
                    "Expires", "LastCheckerStatus")
 
606
 
 
607
    def run(self, clients, bus=None, mandos=None):
 
608
        print(self.output(clients.values()))
 
609
 
 
610
    def output(self, clients):
 
611
        raise NotImplementedError()
 
612
 
 
613
 
 
614
class DumpJSONCmd(OutputCmd):
 
615
    def output(self, clients):
 
616
        data = {client["Name"]:
 
617
                {key: self.dbus_boolean_to_bool(client[key])
 
618
                 for key in self.all_keywords}
 
619
                for client in clients}
 
620
        return json.dumps(data, indent=4, separators=(',', ': '))
 
621
 
 
622
    @staticmethod
 
623
    def dbus_boolean_to_bool(value):
 
624
        if isinstance(value, dbus.Boolean):
 
625
            value = bool(value)
 
626
        return value
 
627
 
 
628
 
 
629
class PrintTableCmd(OutputCmd):
 
630
    def __init__(self, verbose=False):
 
631
        self.verbose = verbose
 
632
 
 
633
    def output(self, clients):
 
634
        default_keywords = ("Name", "Enabled", "Timeout",
 
635
                            "LastCheckedOK")
 
636
        keywords = default_keywords
 
637
        if self.verbose:
 
638
            keywords = self.all_keywords
 
639
        return str(self.TableOfClients(clients, keywords))
 
640
 
 
641
    class TableOfClients(object):
 
642
        tableheaders = {
 
643
            "Name": "Name",
 
644
            "Enabled": "Enabled",
 
645
            "Timeout": "Timeout",
 
646
            "LastCheckedOK": "Last Successful Check",
 
647
            "LastApprovalRequest": "Last Approval Request",
 
648
            "Created": "Created",
 
649
            "Interval": "Interval",
 
650
            "Host": "Host",
 
651
            "Fingerprint": "Fingerprint",
 
652
            "KeyID": "Key ID",
 
653
            "CheckerRunning": "Check Is Running",
 
654
            "LastEnabled": "Last Enabled",
 
655
            "ApprovalPending": "Approval Is Pending",
 
656
            "ApprovedByDefault": "Approved By Default",
 
657
            "ApprovalDelay": "Approval Delay",
 
658
            "ApprovalDuration": "Approval Duration",
 
659
            "Checker": "Checker",
 
660
            "ExtendedTimeout": "Extended Timeout",
 
661
            "Expires": "Expires",
 
662
            "LastCheckerStatus": "Last Checker Status",
 
663
        }
 
664
 
 
665
        def __init__(self, clients, keywords):
 
666
            self.clients = clients
 
667
            self.keywords = keywords
 
668
 
 
669
        def __str__(self):
 
670
            return "\n".join(self.rows())
 
671
 
 
672
        if sys.version_info.major == 2:
 
673
            __unicode__ = __str__
814
674
            def __str__(self):
815
 
                return "\n".join(self.rows())
816
 
 
817
 
            if sys.version_info.major == 2:
818
 
                __unicode__ = __str__
819
 
                def __str__(self):
820
 
                    return str(self).encode(
821
 
                        locale.getpreferredencoding())
822
 
 
823
 
            def rows(self):
824
 
                format_string = self.row_formatting_string()
825
 
                rows = [self.header_line(format_string)]
826
 
                rows.extend(self.client_line(client, format_string)
827
 
                            for client in self.clients)
828
 
                return rows
829
 
 
830
 
            def row_formatting_string(self):
831
 
                "Format string used to format table rows"
832
 
                return " ".join("{{{key}:{width}}}".format(
833
 
                    width=max(len(self.tableheaders[key]),
834
 
                              *(len(self.string_from_client(client,
835
 
                                                            key))
836
 
                                for client in self.clients)),
837
 
                    key=key)
838
 
                                for key in self.keywords)
839
 
 
840
 
            def string_from_client(self, client, key):
841
 
                return self.valuetostring(client[key], key)
842
 
 
843
 
            @classmethod
844
 
            def valuetostring(cls, value, keyword):
845
 
                if isinstance(value, bool):
846
 
                    return "Yes" if value else "No"
847
 
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
848
 
                               "ApprovalDuration", "ExtendedTimeout"):
849
 
                    return cls.milliseconds_to_string(value)
850
 
                return str(value)
851
 
 
852
 
            def header_line(self, format_string):
853
 
                return format_string.format(**self.tableheaders)
854
 
 
855
 
            def client_line(self, client, format_string):
856
 
                return format_string.format(
857
 
                    **{key: self.string_from_client(client, key)
858
 
                       for key in self.keywords})
859
 
 
860
 
            @staticmethod
861
 
            def milliseconds_to_string(ms):
862
 
                td = datetime.timedelta(0, 0, 0, ms)
863
 
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
864
 
                        .format(days="{}T".format(td.days)
865
 
                                if td.days else "",
866
 
                                hours=td.seconds // 3600,
867
 
                                minutes=(td.seconds % 3600) // 60,
868
 
                                seconds=td.seconds % 60))
869
 
 
870
 
 
871
 
    class PropertySetter(Base):
872
 
        "Abstract class for Actions for setting one client property"
873
 
 
874
 
        def run_on_one_client(self, client, properties=None):
875
 
            """Set the Client's D-Bus property"""
876
 
            self.bus.set_client_property(client, self.propname,
877
 
                                         self.value_to_set)
878
 
 
879
 
        @property
880
 
        def propname(self):
881
 
            raise NotImplementedError()
882
 
 
883
 
 
884
 
    class Enable(PropertySetter):
885
 
        propname = "Enabled"
886
 
        value_to_set = True
887
 
 
888
 
 
889
 
    class Disable(PropertySetter):
890
 
        propname = "Enabled"
891
 
        value_to_set = False
892
 
 
893
 
 
894
 
    class BumpTimeout(PropertySetter):
895
 
        propname = "LastCheckedOK"
896
 
        value_to_set = ""
897
 
 
898
 
 
899
 
    class StartChecker(PropertySetter):
900
 
        propname = "CheckerRunning"
901
 
        value_to_set = True
902
 
 
903
 
 
904
 
    class StopChecker(PropertySetter):
905
 
        propname = "CheckerRunning"
906
 
        value_to_set = False
907
 
 
908
 
 
909
 
    class ApproveByDefault(PropertySetter):
910
 
        propname = "ApprovedByDefault"
911
 
        value_to_set = True
912
 
 
913
 
 
914
 
    class DenyByDefault(PropertySetter):
915
 
        propname = "ApprovedByDefault"
916
 
        value_to_set = False
917
 
 
918
 
 
919
 
    class PropertySetterValue(PropertySetter):
920
 
        """Abstract class for PropertySetter recieving a value as
921
 
constructor argument instead of a class attribute."""
922
 
        def __init__(self, value):
923
 
            self.value_to_set = value
 
675
                return str(self).encode(locale.getpreferredencoding())
 
676
 
 
677
        def rows(self):
 
678
            format_string = self.row_formatting_string()
 
679
            rows = [self.header_line(format_string)]
 
680
            rows.extend(self.client_line(client, format_string)
 
681
                        for client in self.clients)
 
682
            return rows
 
683
 
 
684
        def row_formatting_string(self):
 
685
            "Format string used to format table rows"
 
686
            return " ".join("{{{key}:{width}}}".format(
 
687
                width=max(len(self.tableheaders[key]),
 
688
                          *(len(self.string_from_client(client, key))
 
689
                            for client in self.clients)),
 
690
                key=key)
 
691
                            for key in self.keywords)
 
692
 
 
693
        def string_from_client(self, client, key):
 
694
            return self.valuetostring(client[key], key)
924
695
 
925
696
        @classmethod
926
 
        def argparse(cls, argtype):
927
 
            def cmdtype(arg):
928
 
                return cls(argtype(arg))
929
 
            return cmdtype
930
 
 
931
 
    class SetChecker(PropertySetterValue):
932
 
        propname = "Checker"
933
 
 
934
 
 
935
 
    class SetHost(PropertySetterValue):
936
 
        propname = "Host"
937
 
 
938
 
 
939
 
    class SetSecret(PropertySetterValue):
940
 
        propname = "Secret"
941
 
 
942
 
        @property
943
 
        def value_to_set(self):
944
 
            return self._vts
945
 
 
946
 
        @value_to_set.setter
947
 
        def value_to_set(self, value):
948
 
            """When setting, read data from supplied file object"""
949
 
            self._vts = value.read()
950
 
            value.close()
951
 
 
952
 
 
953
 
    class PropertySetterValueMilliseconds(PropertySetterValue):
954
 
        """Abstract class for PropertySetterValue taking a value
955
 
argument as a datetime.timedelta() but should store it as
956
 
milliseconds."""
957
 
 
958
 
        @property
959
 
        def value_to_set(self):
960
 
            return self._vts
961
 
 
962
 
        @value_to_set.setter
963
 
        def value_to_set(self, value):
964
 
            "When setting, convert value from a datetime.timedelta"
965
 
            self._vts = int(round(value.total_seconds() * 1000))
966
 
 
967
 
 
968
 
    class SetTimeout(PropertySetterValueMilliseconds):
969
 
        propname = "Timeout"
970
 
 
971
 
 
972
 
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
973
 
        propname = "ExtendedTimeout"
974
 
 
975
 
 
976
 
    class SetInterval(PropertySetterValueMilliseconds):
977
 
        propname = "Interval"
978
 
 
979
 
 
980
 
    class SetApprovalDelay(PropertySetterValueMilliseconds):
981
 
        propname = "ApprovalDelay"
982
 
 
983
 
 
984
 
    class SetApprovalDuration(PropertySetterValueMilliseconds):
985
 
        propname = "ApprovalDuration"
 
697
        def valuetostring(cls, value, keyword):
 
698
            if isinstance(value, dbus.Boolean):
 
699
                return "Yes" if value else "No"
 
700
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
701
                           "ApprovalDuration", "ExtendedTimeout"):
 
702
                return cls.milliseconds_to_string(value)
 
703
            return str(value)
 
704
 
 
705
        def header_line(self, format_string):
 
706
            return format_string.format(**self.tableheaders)
 
707
 
 
708
        def client_line(self, client, format_string):
 
709
            return format_string.format(
 
710
                **{key: self.string_from_client(client, key)
 
711
                   for key in self.keywords})
 
712
 
 
713
        @staticmethod
 
714
        def milliseconds_to_string(ms):
 
715
            td = datetime.timedelta(0, 0, 0, ms)
 
716
            return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
717
                    .format(days="{}T".format(td.days)
 
718
                            if td.days else "",
 
719
                            hours=td.seconds // 3600,
 
720
                            minutes=(td.seconds % 3600) // 60,
 
721
                            seconds=td.seconds % 60))
 
722
 
 
723
 
 
724
class PropertyCmd(Command):
 
725
    """Abstract class for Actions for setting one client property"""
 
726
 
 
727
    def run_on_one_client(self, client, properties):
 
728
        """Set the Client's D-Bus property"""
 
729
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
730
                  client.__dbus_object_path__,
 
731
                  dbus.PROPERTIES_IFACE, client_dbus_interface,
 
732
                  self.propname, self.value_to_set
 
733
                  if not isinstance(self.value_to_set, dbus.Boolean)
 
734
                  else bool(self.value_to_set))
 
735
        client.Set(client_dbus_interface, self.propname,
 
736
                   self.value_to_set,
 
737
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
738
 
 
739
    @property
 
740
    def propname(self):
 
741
        raise NotImplementedError()
 
742
 
 
743
 
 
744
class EnableCmd(PropertyCmd):
 
745
    propname = "Enabled"
 
746
    value_to_set = dbus.Boolean(True)
 
747
 
 
748
 
 
749
class DisableCmd(PropertyCmd):
 
750
    propname = "Enabled"
 
751
    value_to_set = dbus.Boolean(False)
 
752
 
 
753
 
 
754
class BumpTimeoutCmd(PropertyCmd):
 
755
    propname = "LastCheckedOK"
 
756
    value_to_set = ""
 
757
 
 
758
 
 
759
class StartCheckerCmd(PropertyCmd):
 
760
    propname = "CheckerRunning"
 
761
    value_to_set = dbus.Boolean(True)
 
762
 
 
763
 
 
764
class StopCheckerCmd(PropertyCmd):
 
765
    propname = "CheckerRunning"
 
766
    value_to_set = dbus.Boolean(False)
 
767
 
 
768
 
 
769
class ApproveByDefaultCmd(PropertyCmd):
 
770
    propname = "ApprovedByDefault"
 
771
    value_to_set = dbus.Boolean(True)
 
772
 
 
773
 
 
774
class DenyByDefaultCmd(PropertyCmd):
 
775
    propname = "ApprovedByDefault"
 
776
    value_to_set = dbus.Boolean(False)
 
777
 
 
778
 
 
779
class PropertyValueCmd(PropertyCmd):
 
780
    """Abstract class for PropertyCmd recieving a value as argument"""
 
781
    def __init__(self, value):
 
782
        self.value_to_set = value
 
783
 
 
784
 
 
785
class SetCheckerCmd(PropertyValueCmd):
 
786
    propname = "Checker"
 
787
 
 
788
 
 
789
class SetHostCmd(PropertyValueCmd):
 
790
    propname = "Host"
 
791
 
 
792
 
 
793
class SetSecretCmd(PropertyValueCmd):
 
794
    propname = "Secret"
 
795
 
 
796
    @property
 
797
    def value_to_set(self):
 
798
        return self._vts
 
799
 
 
800
    @value_to_set.setter
 
801
    def value_to_set(self, value):
 
802
        """When setting, read data from supplied file object"""
 
803
        self._vts = value.read()
 
804
        value.close()
 
805
 
 
806
 
 
807
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
 
808
    """Abstract class for PropertyValueCmd taking a value argument as
 
809
a datetime.timedelta() but should store it as milliseconds."""
 
810
 
 
811
    @property
 
812
    def value_to_set(self):
 
813
        return self._vts
 
814
 
 
815
    @value_to_set.setter
 
816
    def value_to_set(self, value):
 
817
        """When setting, convert value from a datetime.timedelta"""
 
818
        self._vts = int(round(value.total_seconds() * 1000))
 
819
 
 
820
 
 
821
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
822
    propname = "Timeout"
 
823
 
 
824
 
 
825
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
826
    propname = "ExtendedTimeout"
 
827
 
 
828
 
 
829
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
 
830
    propname = "Interval"
 
831
 
 
832
 
 
833
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
 
834
    propname = "ApprovalDelay"
 
835
 
 
836
 
 
837
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
 
838
    propname = "ApprovalDuration"
986
839
 
987
840
 
988
841
 
1019
872
                                                    ("records",
1020
873
                                                     "output"))
1021
874
 
1022
 
 
1023
 
class Unique(object):
1024
 
    """Class for objects which exist only to be unique objects, since
1025
 
unittest.mock.sentinel only exists in Python 3.3"""
1026
 
 
1027
 
 
1028
875
class Test_string_to_delta(TestCaseWithAssertLogs):
1029
 
    # Just test basic RFC 3339 functionality here, the doc string for
1030
 
    # rfc3339_duration_to_delta() already has more comprehensive
1031
 
    # tests, which are run by doctest.
1032
 
 
1033
 
    def test_rfc3339_zero_seconds(self):
1034
 
        self.assertEqual(datetime.timedelta(),
1035
 
                         string_to_delta("PT0S"))
1036
 
 
1037
 
    def test_rfc3339_zero_days(self):
1038
 
        self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1039
 
 
1040
 
    def test_rfc3339_one_second(self):
1041
 
        self.assertEqual(datetime.timedelta(0, 1),
1042
 
                         string_to_delta("PT1S"))
1043
 
 
1044
 
    def test_rfc3339_two_hours(self):
1045
 
        self.assertEqual(datetime.timedelta(0, 7200),
1046
 
                         string_to_delta("PT2H"))
 
876
    def test_handles_basic_rfc3339(self):
 
877
        self.assertEqual(string_to_delta("PT0S"),
 
878
                         datetime.timedelta())
 
879
        self.assertEqual(string_to_delta("P0D"),
 
880
                         datetime.timedelta())
 
881
        self.assertEqual(string_to_delta("PT1S"),
 
882
                         datetime.timedelta(0, 1))
 
883
        self.assertEqual(string_to_delta("PT2H"),
 
884
                         datetime.timedelta(0, 7200))
1047
885
 
1048
886
    def test_falls_back_to_pre_1_6_1_with_warning(self):
1049
887
        with self.assertLogs(log, logging.WARNING):
1050
888
            value = string_to_delta("2h")
1051
 
        self.assertEqual(datetime.timedelta(0, 7200), value)
 
889
        self.assertEqual(value, datetime.timedelta(0, 7200))
1052
890
 
1053
891
 
1054
892
class Test_check_option_syntax(unittest.TestCase):
1058
896
 
1059
897
    def test_actions_requires_client_or_all(self):
1060
898
        for action, value in self.actions.items():
1061
 
            args = self.actionargs(action, value)
 
899
            options = self.parser.parse_args()
 
900
            setattr(options, action, value)
1062
901
            with self.assertParseError():
1063
 
                self.parse_args(args)
 
902
                self.check_option_syntax(options)
1064
903
 
1065
 
    # This mostly corresponds to the definition from has_commands() in
 
904
    # This mostly corresponds to the definition from has_actions() in
1066
905
    # check_option_syntax()
1067
906
    actions = {
1068
 
        "--enable": None,
1069
 
        "--disable": None,
1070
 
        "--bump-timeout": None,
1071
 
        "--start-checker": None,
1072
 
        "--stop-checker": None,
1073
 
        "--is-enabled": None,
1074
 
        "--remove": None,
1075
 
        "--checker": "x",
1076
 
        "--timeout": "PT0S",
1077
 
        "--extended-timeout": "PT0S",
1078
 
        "--interval": "PT0S",
1079
 
        "--approve-by-default": None,
1080
 
        "--deny-by-default": None,
1081
 
        "--approval-delay": "PT0S",
1082
 
        "--approval-duration": "PT0S",
1083
 
        "--host": "hostname",
1084
 
        "--secret": "/dev/null",
1085
 
        "--approve": None,
1086
 
        "--deny": None,
 
907
        # The actual values set here are not that important, but we do
 
908
        # at least stick to the correct types, even though they are
 
909
        # never used
 
910
        "enable": True,
 
911
        "disable": True,
 
912
        "bump_timeout": True,
 
913
        "start_checker": True,
 
914
        "stop_checker": True,
 
915
        "is_enabled": True,
 
916
        "remove": True,
 
917
        "checker": "x",
 
918
        "timeout": datetime.timedelta(),
 
919
        "extended_timeout": datetime.timedelta(),
 
920
        "interval": datetime.timedelta(),
 
921
        "approved_by_default": True,
 
922
        "approval_delay": datetime.timedelta(),
 
923
        "approval_duration": datetime.timedelta(),
 
924
        "host": "x",
 
925
        "secret": io.BytesIO(b"x"),
 
926
        "approve": True,
 
927
        "deny": True,
1087
928
    }
1088
929
 
1089
 
    @staticmethod
1090
 
    def actionargs(action, value, *args):
1091
 
        if value is not None:
1092
 
            return [action, value] + list(args)
1093
 
        else:
1094
 
            return [action] + list(args)
1095
 
 
1096
930
    @contextlib.contextmanager
1097
931
    def assertParseError(self):
1098
932
        with self.assertRaises(SystemExit) as e:
1099
 
            with self.redirect_stderr_to_devnull():
 
933
            with self.temporarily_suppress_stderr():
1100
934
                yield
1101
935
        # Exit code from argparse is guaranteed to be "2".  Reference:
1102
936
        # https://docs.python.org/3/library
1103
937
        # /argparse.html#exiting-methods
1104
 
        self.assertEqual(2, e.exception.code)
1105
 
 
1106
 
    def parse_args(self, args):
1107
 
        options = self.parser.parse_args(args)
1108
 
        check_option_syntax(self.parser, options)
 
938
        self.assertEqual(e.exception.code, 2)
1109
939
 
1110
940
    @staticmethod
1111
941
    @contextlib.contextmanager
1112
 
    def redirect_stderr_to_devnull():
1113
 
        old_stderr = sys.stderr
1114
 
        with contextlib.closing(open(os.devnull, "w")) as null:
1115
 
            sys.stderr = null
1116
 
            try:
1117
 
                yield
1118
 
            finally:
1119
 
                sys.stderr = old_stderr
 
942
    def temporarily_suppress_stderr():
 
943
        null = os.open(os.path.devnull, os.O_RDWR)
 
944
        stderrcopy = os.dup(sys.stderr.fileno())
 
945
        os.dup2(null, sys.stderr.fileno())
 
946
        os.close(null)
 
947
        try:
 
948
            yield
 
949
        finally:
 
950
            # restore stderr
 
951
            os.dup2(stderrcopy, sys.stderr.fileno())
 
952
            os.close(stderrcopy)
1120
953
 
1121
954
    def check_option_syntax(self, options):
1122
955
        check_option_syntax(self.parser, options)
1123
956
 
1124
 
    def test_actions_all_conflicts_with_verbose(self):
1125
 
        for action, value in self.actions.items():
1126
 
            args = self.actionargs(action, value, "--all",
1127
 
                                   "--verbose")
1128
 
            with self.assertParseError():
1129
 
                self.parse_args(args)
1130
 
 
1131
 
    def test_actions_with_client_conflicts_with_verbose(self):
1132
 
        for action, value in self.actions.items():
1133
 
            args = self.actionargs(action, value, "--verbose",
1134
 
                                   "client")
1135
 
            with self.assertParseError():
1136
 
                self.parse_args(args)
 
957
    def test_actions_conflicts_with_verbose(self):
 
958
        for action, value in self.actions.items():
 
959
            options = self.parser.parse_args()
 
960
            setattr(options, action, value)
 
961
            options.verbose = True
 
962
            with self.assertParseError():
 
963
                self.check_option_syntax(options)
1137
964
 
1138
965
    def test_dump_json_conflicts_with_verbose(self):
1139
 
        args = ["--dump-json", "--verbose"]
 
966
        options = self.parser.parse_args()
 
967
        options.dump_json = True
 
968
        options.verbose = True
1140
969
        with self.assertParseError():
1141
 
            self.parse_args(args)
 
970
            self.check_option_syntax(options)
1142
971
 
1143
972
    def test_dump_json_conflicts_with_action(self):
1144
973
        for action, value in self.actions.items():
1145
 
            args = self.actionargs(action, value, "--dump-json")
 
974
            options = self.parser.parse_args()
 
975
            setattr(options, action, value)
 
976
            options.dump_json = True
1146
977
            with self.assertParseError():
1147
 
                self.parse_args(args)
 
978
                self.check_option_syntax(options)
1148
979
 
1149
980
    def test_all_can_not_be_alone(self):
1150
 
        args = ["--all"]
 
981
        options = self.parser.parse_args()
 
982
        options.all = True
1151
983
        with self.assertParseError():
1152
 
            self.parse_args(args)
 
984
            self.check_option_syntax(options)
1153
985
 
1154
986
    def test_all_is_ok_with_any_action(self):
1155
987
        for action, value in self.actions.items():
1156
 
            args = self.actionargs(action, value, "--all")
1157
 
            self.parse_args(args)
1158
 
 
1159
 
    def test_any_action_is_ok_with_one_client(self):
1160
 
        for action, value in self.actions.items():
1161
 
            args = self.actionargs(action, value, "client")
1162
 
            self.parse_args(args)
1163
 
 
1164
 
    def test_one_client_with_all_actions_except_is_enabled(self):
1165
 
        for action, value in self.actions.items():
1166
 
            if action == "--is-enabled":
1167
 
                continue
1168
 
            args = self.actionargs(action, value, "client")
1169
 
            self.parse_args(args)
1170
 
 
1171
 
    def test_two_clients_with_all_actions_except_is_enabled(self):
1172
 
        for action, value in self.actions.items():
1173
 
            if action == "--is-enabled":
1174
 
                continue
1175
 
            args = self.actionargs(action, value, "client1",
1176
 
                                   "client2")
1177
 
            self.parse_args(args)
1178
 
 
1179
 
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1180
 
        for action, value in self.actions.items():
1181
 
            if action == "--is-enabled":
1182
 
                continue
1183
 
            args = self.actionargs(action, value, "client1",
1184
 
                                   "client2")
1185
 
            self.parse_args(args)
 
988
            options = self.parser.parse_args()
 
989
            setattr(options, action, value)
 
990
            options.all = True
 
991
            self.check_option_syntax(options)
1186
992
 
1187
993
    def test_is_enabled_fails_without_client(self):
1188
 
        args = ["--is-enabled"]
 
994
        options = self.parser.parse_args()
 
995
        options.is_enabled = True
1189
996
        with self.assertParseError():
1190
 
            self.parse_args(args)
 
997
            self.check_option_syntax(options)
 
998
 
 
999
    def test_is_enabled_works_with_one_client(self):
 
1000
        options = self.parser.parse_args()
 
1001
        options.is_enabled = True
 
1002
        options.client = ["foo"]
 
1003
        self.check_option_syntax(options)
1191
1004
 
1192
1005
    def test_is_enabled_fails_with_two_clients(self):
1193
 
        args = ["--is-enabled", "client1", "client2"]
 
1006
        options = self.parser.parse_args()
 
1007
        options.is_enabled = True
 
1008
        options.client = ["foo", "barbar"]
1194
1009
        with self.assertParseError():
1195
 
            self.parse_args(args)
 
1010
            self.check_option_syntax(options)
1196
1011
 
1197
1012
    def test_remove_can_only_be_combined_with_action_deny(self):
1198
1013
        for action, value in self.actions.items():
1199
 
            if action in {"--remove", "--deny"}:
 
1014
            if action in {"remove", "deny"}:
1200
1015
                continue
1201
 
            args = self.actionargs(action, value, "--all",
1202
 
                                   "--remove")
 
1016
            options = self.parser.parse_args()
 
1017
            setattr(options, action, value)
 
1018
            options.all = True
 
1019
            options.remove = True
1203
1020
            with self.assertParseError():
1204
 
                self.parse_args(args)
1205
 
 
1206
 
 
1207
 
class Test_dbus_exceptions(unittest.TestCase):
1208
 
 
1209
 
    def test_dbus_ConnectFailed_is_Error(self):
1210
 
        with self.assertRaises(dbus.Error):
1211
 
            raise dbus.ConnectFailed()
1212
 
 
1213
 
 
1214
 
class Test_dbus_MandosBus(unittest.TestCase):
1215
 
 
1216
 
    class MockMandosBus(dbus.MandosBus):
1217
 
        def __init__(self):
1218
 
            self._name = "se.recompile.Mandos"
1219
 
            self._server_path = "/"
1220
 
            self._server_interface = "se.recompile.Mandos"
1221
 
            self._client_interface = "se.recompile.Mandos.Client"
1222
 
            self.calls = []
1223
 
            self.call_method_return = Unique()
1224
 
 
1225
 
        def call_method(self, methodname, busname, objectpath,
1226
 
                        interface, *args):
1227
 
            self.calls.append((methodname, busname, objectpath,
1228
 
                               interface, args))
1229
 
            return self.call_method_return
1230
 
 
1231
 
    def setUp(self):
1232
 
        self.bus = self.MockMandosBus()
1233
 
 
1234
 
    def test_set_client_property(self):
1235
 
        self.bus.set_client_property("objectpath", "key", "value")
1236
 
        expected_call = ("Set", self.bus._name, "objectpath",
1237
 
                         "org.freedesktop.DBus.Properties",
1238
 
                         (self.bus._client_interface, "key", "value"))
1239
 
        self.assertIn(expected_call, self.bus.calls)
1240
 
 
1241
 
    def test_call_client_method(self):
1242
 
        ret = self.bus.call_client_method("objectpath", "methodname")
1243
 
        self.assertIs(self.bus.call_method_return, ret)
1244
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1245
 
                         self.bus._client_interface, ())
1246
 
        self.assertIn(expected_call, self.bus.calls)
1247
 
 
1248
 
    def test_call_client_method_with_args(self):
1249
 
        args = (Unique(), Unique())
1250
 
        ret = self.bus.call_client_method("objectpath", "methodname",
1251
 
                                          *args)
1252
 
        self.assertIs(self.bus.call_method_return, ret)
1253
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1254
 
                         self.bus._client_interface,
1255
 
                         (args[0], args[1]))
1256
 
        self.assertIn(expected_call, self.bus.calls)
1257
 
 
1258
 
    def test_get_clients_and_properties(self):
1259
 
        managed_objects = {
1260
 
            "objectpath": {
1261
 
                self.bus._client_interface: {
1262
 
                    "key": "value",
1263
 
                    "bool": True,
1264
 
                },
1265
 
                "irrelevant_interface": {
1266
 
                    "key": "othervalue",
1267
 
                    "bool": False,
1268
 
                },
1269
 
            },
1270
 
            "other_objectpath": {
1271
 
                "other_irrelevant_interface": {
1272
 
                    "key": "value 3",
1273
 
                    "bool": None,
1274
 
                },
1275
 
            },
1276
 
        }
1277
 
        expected_clients_and_properties = {
1278
 
            "objectpath": {
1279
 
                "key": "value",
1280
 
                "bool": True,
1281
 
            }
1282
 
        }
1283
 
        self.bus.call_method_return = managed_objects
1284
 
        ret = self.bus.get_clients_and_properties()
1285
 
        self.assertDictEqual(expected_clients_and_properties, ret)
1286
 
        expected_call = ("GetManagedObjects", self.bus._name,
1287
 
                         self.bus._server_path,
1288
 
                         "org.freedesktop.DBus.ObjectManager", ())
1289
 
        self.assertIn(expected_call, self.bus.calls)
1290
 
 
1291
 
    def test_call_server_method(self):
1292
 
        ret = self.bus.call_server_method("methodname")
1293
 
        self.assertIs(self.bus.call_method_return, ret)
1294
 
        expected_call = ("methodname", self.bus._name,
1295
 
                         self.bus._server_path,
1296
 
                         self.bus._server_interface, ())
1297
 
        self.assertIn(expected_call, self.bus.calls)
1298
 
 
1299
 
    def test_call_server_method_with_args(self):
1300
 
        args = (Unique(), Unique())
1301
 
        ret = self.bus.call_server_method("methodname", *args)
1302
 
        self.assertIs(self.bus.call_method_return, ret)
1303
 
        expected_call = ("methodname", self.bus._name,
1304
 
                         self.bus._server_path,
1305
 
                         self.bus._server_interface,
1306
 
                         (args[0], args[1]))
1307
 
        self.assertIn(expected_call, self.bus.calls)
1308
 
 
1309
 
 
1310
 
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1311
 
 
1312
 
    def MockDBusPython_func(self, func):
1313
 
        class mock_dbus_python(object):
1314
 
            """mock dbus-python module"""
1315
 
            class exceptions(object):
1316
 
                """Pseudo-namespace"""
1317
 
                class DBusException(Exception):
1318
 
                    pass
1319
 
            class SystemBus(object):
1320
 
                @staticmethod
1321
 
                def get_object(busname, objectpath):
1322
 
                    DBusObject = collections.namedtuple(
1323
 
                        "DBusObject", ("methodname", "Set"))
1324
 
                    def method(*args, **kwargs):
1325
 
                        self.assertEqual({"dbus_interface":
1326
 
                                          "interface"},
1327
 
                                         kwargs)
1328
 
                        return func(*args)
1329
 
                    def set_property(interface, key, value,
1330
 
                                     dbus_interface=None):
1331
 
                        self.assertEqual(
1332
 
                            "org.freedesktop.DBus.Properties",
1333
 
                            dbus_interface)
1334
 
                        self.assertEqual("Secret", key)
1335
 
                        return func(interface, key, value,
1336
 
                                    dbus_interface=dbus_interface)
1337
 
                    return DBusObject(methodname=method,
1338
 
                                      Set=set_property)
1339
 
            class Boolean(object):
1340
 
                def __init__(self, value):
1341
 
                    self.value = bool(value)
1342
 
                def __bool__(self):
1343
 
                    return self.value
1344
 
                if sys.version_info.major == 2:
1345
 
                    __nonzero__ = __bool__
1346
 
            class ObjectPath(str):
1347
 
                pass
1348
 
            class Dictionary(dict):
1349
 
                pass
1350
 
            class ByteArray(bytes):
1351
 
                pass
1352
 
        return mock_dbus_python
1353
 
 
1354
 
    def call_method(self, bus, methodname, busname, objectpath,
1355
 
                    interface, *args):
1356
 
        with self.assertLogs(log, logging.DEBUG):
1357
 
            return bus.call_method(methodname, busname, objectpath,
1358
 
                                   interface, *args)
1359
 
 
1360
 
    def test_call_method_returns(self):
1361
 
        expected_method_return = Unique()
1362
 
        method_args = (Unique(), Unique())
1363
 
        def func(*args):
1364
 
            self.assertEqual(len(method_args), len(args))
1365
 
            for marg, arg in zip(method_args, args):
1366
 
                self.assertIs(marg, arg)
1367
 
            return expected_method_return
1368
 
        mock_dbus_python = self.MockDBusPython_func(func)
1369
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1370
 
        ret = self.call_method(bus, "methodname", "busname",
1371
 
                               "objectpath", "interface",
1372
 
                               *method_args)
1373
 
        self.assertIs(ret, expected_method_return)
1374
 
 
1375
 
    def test_call_method_filters_bool_true(self):
1376
 
        def func():
1377
 
            return method_return
1378
 
        mock_dbus_python = self.MockDBusPython_func(func)
1379
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1380
 
        method_return = mock_dbus_python.Boolean(True)
1381
 
        ret = self.call_method(bus, "methodname", "busname",
1382
 
                               "objectpath", "interface")
1383
 
        self.assertTrue(ret)
1384
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1385
 
 
1386
 
    def test_call_method_filters_bool_false(self):
1387
 
        def func():
1388
 
            return method_return
1389
 
        mock_dbus_python = self.MockDBusPython_func(func)
1390
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1391
 
        method_return = mock_dbus_python.Boolean(False)
1392
 
        ret = self.call_method(bus, "methodname", "busname",
1393
 
                               "objectpath", "interface")
1394
 
        self.assertFalse(ret)
1395
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1396
 
 
1397
 
    def test_call_method_filters_objectpath(self):
1398
 
        def func():
1399
 
            return method_return
1400
 
        mock_dbus_python = self.MockDBusPython_func(func)
1401
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1402
 
        method_return = mock_dbus_python.ObjectPath("objectpath")
1403
 
        ret = self.call_method(bus, "methodname", "busname",
1404
 
                               "objectpath", "interface")
1405
 
        self.assertEqual("objectpath", ret)
1406
 
        self.assertIsNot("objectpath", ret)
1407
 
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1408
 
 
1409
 
    def test_call_method_filters_booleans_in_dict(self):
1410
 
        def func():
1411
 
            return method_return
1412
 
        mock_dbus_python = self.MockDBusPython_func(func)
1413
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1414
 
        method_return = mock_dbus_python.Dictionary(
1415
 
        {mock_dbus_python.Boolean(True):
1416
 
         mock_dbus_python.Boolean(False),
1417
 
         mock_dbus_python.Boolean(False):
1418
 
         mock_dbus_python.Boolean(True)})
1419
 
        ret = self.call_method(bus, "methodname", "busname",
1420
 
                               "objectpath", "interface")
1421
 
        expected_method_return = {True: False,
1422
 
                                  False: True}
1423
 
        self.assertEqual(expected_method_return, ret)
1424
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1425
 
 
1426
 
    def test_call_method_filters_objectpaths_in_dict(self):
1427
 
        def func():
1428
 
            return method_return
1429
 
        mock_dbus_python = self.MockDBusPython_func(func)
1430
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1431
 
        method_return = mock_dbus_python.Dictionary(
1432
 
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
1433
 
         mock_dbus_python.ObjectPath("objectpath_value_1"),
1434
 
         mock_dbus_python.ObjectPath("objectpath_key_2"):
1435
 
         mock_dbus_python.ObjectPath("objectpath_value_2")})
1436
 
        ret = self.call_method(bus, "methodname", "busname",
1437
 
                               "objectpath", "interface")
1438
 
        expected_method_return = {str(key): str(value)
1439
 
                                  for key, value in
1440
 
                                  method_return.items()}
1441
 
        self.assertEqual(expected_method_return, ret)
1442
 
        self.assertIsInstance(ret, dict)
1443
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1444
 
 
1445
 
    def test_call_method_filters_dict_in_dict(self):
1446
 
        def func():
1447
 
            return method_return
1448
 
        mock_dbus_python = self.MockDBusPython_func(func)
1449
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1450
 
        method_return = mock_dbus_python.Dictionary(
1451
 
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
1452
 
                                              "key12": "value12"}),
1453
 
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
1454
 
                                              "key22": "value22"})})
1455
 
        ret = self.call_method(bus, "methodname", "busname",
1456
 
                               "objectpath", "interface")
1457
 
        expected_method_return = {
1458
 
            "key1": {"key11": "value11",
1459
 
                     "key12": "value12"},
1460
 
            "key2": {"key21": "value21",
1461
 
                     "key22": "value22"},
1462
 
        }
1463
 
        self.assertEqual(expected_method_return, ret)
1464
 
        self.assertIsInstance(ret, dict)
1465
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1466
 
        for key, value in ret.items():
1467
 
            self.assertIsInstance(value, dict)
1468
 
            self.assertEqual(expected_method_return[key], value)
1469
 
            self.assertNotIsInstance(value,
1470
 
                                     mock_dbus_python.Dictionary)
1471
 
 
1472
 
    def test_call_method_filters_dict_three_deep(self):
1473
 
        def func():
1474
 
            return method_return
1475
 
        mock_dbus_python = self.MockDBusPython_func(func)
1476
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1477
 
        method_return = mock_dbus_python.Dictionary(
1478
 
            {"key1":
1479
 
             mock_dbus_python.Dictionary(
1480
 
                 {"key2":
1481
 
                  mock_dbus_python.Dictionary(
1482
 
                      {"key3":
1483
 
                       mock_dbus_python.Boolean(True),
1484
 
                       }),
1485
 
                  }),
1486
 
             })
1487
 
        ret = self.call_method(bus, "methodname", "busname",
1488
 
                               "objectpath", "interface")
1489
 
        expected_method_return = {"key1": {"key2": {"key3": True}}}
1490
 
        self.assertEqual(expected_method_return, ret)
1491
 
        self.assertIsInstance(ret, dict)
1492
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1493
 
        self.assertIsInstance(ret["key1"], dict)
1494
 
        self.assertNotIsInstance(ret["key1"],
1495
 
                                 mock_dbus_python.Dictionary)
1496
 
        self.assertIsInstance(ret["key1"]["key2"], dict)
1497
 
        self.assertNotIsInstance(ret["key1"]["key2"],
1498
 
                                 mock_dbus_python.Dictionary)
1499
 
        self.assertTrue(ret["key1"]["key2"]["key3"])
1500
 
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1501
 
                                 mock_dbus_python.Boolean)
1502
 
 
1503
 
    def test_call_method_handles_exception(self):
 
1021
                self.check_option_syntax(options)
 
1022
 
 
1023
 
 
1024
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
 
1025
    def test_calls_and_returns_get_object_on_bus(self):
 
1026
        class MockBus(object):
 
1027
            called = False
 
1028
            def get_object(mockbus_self, busname, dbus_path):
 
1029
                # Note that "self" is still the testcase instance,
 
1030
                # this MockBus instance is in "mockbus_self".
 
1031
                self.assertEqual(busname, dbus_busname)
 
1032
                self.assertEqual(dbus_path, server_dbus_path)
 
1033
                mockbus_self.called = True
 
1034
                return mockbus_self
 
1035
 
 
1036
        mockbus = get_mandos_dbus_object(bus=MockBus())
 
1037
        self.assertIsInstance(mockbus, MockBus)
 
1038
        self.assertTrue(mockbus.called)
 
1039
 
 
1040
    def test_logs_and_exits_on_dbus_error(self):
 
1041
        class MockBusFailing(object):
 
1042
            def get_object(self, busname, dbus_path):
 
1043
                raise dbus.exceptions.DBusException("Test")
 
1044
 
 
1045
        with self.assertLogs(log, logging.CRITICAL):
 
1046
            with self.assertRaises(SystemExit) as e:
 
1047
                bus = get_mandos_dbus_object(bus=MockBusFailing())
 
1048
 
 
1049
        if isinstance(e.exception.code, int):
 
1050
            self.assertNotEqual(e.exception.code, 0)
 
1051
        else:
 
1052
            self.assertIsNotNone(e.exception.code)
 
1053
 
 
1054
 
 
1055
class Test_get_managed_objects(TestCaseWithAssertLogs):
 
1056
    def test_calls_and_returns_GetManagedObjects(self):
 
1057
        managed_objects = {"/clients/foo": { "Name": "foo"}}
 
1058
        class MockObjectManager(object):
 
1059
            def GetManagedObjects(self):
 
1060
                return managed_objects
 
1061
        retval = get_managed_objects(MockObjectManager())
 
1062
        self.assertDictEqual(managed_objects, retval)
 
1063
 
 
1064
    def test_logs_and_exits_on_dbus_error(self):
1504
1065
        dbus_logger = logging.getLogger("dbus.proxies")
1505
1066
 
1506
 
        def func():
1507
 
            dbus_logger.error("Test")
1508
 
            raise mock_dbus_python.exceptions.DBusException()
1509
 
 
1510
 
        mock_dbus_python = self.MockDBusPython_func(func)
1511
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1067
        class MockObjectManagerFailing(object):
 
1068
            def GetManagedObjects(self):
 
1069
                dbus_logger.error("Test")
 
1070
                raise dbus.exceptions.DBusException("Test")
1512
1071
 
1513
1072
        class CountingHandler(logging.Handler):
1514
1073
            count = 0
1520
1079
        dbus_logger.addHandler(counting_handler)
1521
1080
 
1522
1081
        try:
1523
 
            with self.assertRaises(dbus.Error) as e:
1524
 
                self.call_method(bus, "methodname", "busname",
1525
 
                                 "objectpath", "interface")
 
1082
            with self.assertLogs(log, logging.CRITICAL) as watcher:
 
1083
                with self.assertRaises(SystemExit) as e:
 
1084
                    get_managed_objects(MockObjectManagerFailing())
1526
1085
        finally:
1527
1086
            dbus_logger.removeFilter(counting_handler)
1528
 
 
1529
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1530
 
 
1531
 
        # Make sure the dbus logger was suppressed
1532
 
        self.assertEqual(0, counting_handler.count)
1533
 
 
1534
 
    def test_Set_Secret_sends_bytearray(self):
1535
 
        ret = [None]
1536
 
        def func(*args, **kwargs):
1537
 
            ret[0] = (args, kwargs)
1538
 
        mock_dbus_python = self.MockDBusPython_func(func)
1539
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1540
 
        bus.set_client_property("objectpath", "Secret", "value")
1541
 
        expected_call = (("se.recompile.Mandos.Client", "Secret",
1542
 
                          mock_dbus_python.ByteArray(b"value")),
1543
 
                         {"dbus_interface":
1544
 
                          "org.freedesktop.DBus.Properties"})
1545
 
        self.assertEqual(expected_call, ret[0])
1546
 
        if sys.version_info.major == 2:
1547
 
            self.assertIsInstance(ret[0][0][-1],
1548
 
                                  mock_dbus_python.ByteArray)
1549
 
 
1550
 
    def test_get_object_converts_to_correct_exception(self):
1551
 
        bus = dbus_python_adapter.SystemBus(
1552
 
            self.fake_dbus_python_raises_exception_on_connect)
1553
 
        with self.assertRaises(dbus.ConnectFailed):
1554
 
            self.call_method(bus, "methodname", "busname",
1555
 
                             "objectpath", "interface")
1556
 
 
1557
 
    class fake_dbus_python_raises_exception_on_connect(object):
1558
 
        """fake dbus-python module"""
1559
 
        class exceptions(object):
1560
 
            """Pseudo-namespace"""
1561
 
            class DBusException(Exception):
1562
 
                pass
1563
 
 
1564
 
        @classmethod
1565
 
        def SystemBus(cls):
1566
 
            def get_object(busname, objectpath):
1567
 
                raise cls.exceptions.DBusException()
1568
 
            Bus = collections.namedtuple("Bus", ["get_object"])
1569
 
            return Bus(get_object=get_object)
1570
 
 
1571
 
 
1572
 
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1573
 
    class mock_dbus_python(object):
1574
 
        """mock dbus-python modules"""
1575
 
        class SystemBus(object):
1576
 
            @staticmethod
1577
 
            def get_object(busname, objectpath):
1578
 
                return Unique()
1579
 
 
1580
 
    def setUp(self):
1581
 
        self.bus = dbus_python_adapter.CachingBus(
1582
 
            self.mock_dbus_python)
1583
 
 
1584
 
    def test_returns_distinct_objectpaths(self):
1585
 
        obj1 = self.bus.get_object("busname", "objectpath1")
1586
 
        self.assertIsInstance(obj1, Unique)
1587
 
        obj2 = self.bus.get_object("busname", "objectpath2")
1588
 
        self.assertIsInstance(obj2, Unique)
1589
 
        self.assertIsNot(obj1, obj2)
1590
 
 
1591
 
    def test_returns_distinct_busnames(self):
1592
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1593
 
        self.assertIsInstance(obj1, Unique)
1594
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1595
 
        self.assertIsInstance(obj2, Unique)
1596
 
        self.assertIsNot(obj1, obj2)
1597
 
 
1598
 
    def test_returns_distinct_both(self):
1599
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1600
 
        self.assertIsInstance(obj1, Unique)
1601
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1602
 
        self.assertIsInstance(obj2, Unique)
1603
 
        self.assertIsNot(obj1, obj2)
1604
 
 
1605
 
    def test_returns_same(self):
1606
 
        obj1 = self.bus.get_object("busname", "objectpath")
1607
 
        self.assertIsInstance(obj1, Unique)
1608
 
        obj2 = self.bus.get_object("busname", "objectpath")
1609
 
        self.assertIsInstance(obj2, Unique)
1610
 
        self.assertIs(obj1, obj2)
1611
 
 
1612
 
    def test_returns_same_old(self):
1613
 
        obj1 = self.bus.get_object("busname1", "objectpath1")
1614
 
        self.assertIsInstance(obj1, Unique)
1615
 
        obj2 = self.bus.get_object("busname2", "objectpath2")
1616
 
        self.assertIsInstance(obj2, Unique)
1617
 
        obj1b = self.bus.get_object("busname1", "objectpath1")
1618
 
        self.assertIsInstance(obj1b, Unique)
1619
 
        self.assertIsNot(obj1, obj2)
1620
 
        self.assertIsNot(obj2, obj1b)
1621
 
        self.assertIs(obj1, obj1b)
1622
 
 
1623
 
 
1624
 
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1625
 
 
1626
 
    def Stub_pydbus_func(self, func):
1627
 
        class stub_pydbus(object):
1628
 
            """stub pydbus module"""
1629
 
            class SystemBus(object):
1630
 
                @staticmethod
1631
 
                def get(busname, objectpath):
1632
 
                    DBusObject = collections.namedtuple(
1633
 
                        "DBusObject", ("methodname",))
1634
 
                    return {"interface":
1635
 
                            DBusObject(methodname=func)}
1636
 
        return stub_pydbus
1637
 
 
1638
 
    def call_method(self, bus, methodname, busname, objectpath,
1639
 
                    interface, *args):
1640
 
        with self.assertLogs(log, logging.DEBUG):
1641
 
            return bus.call_method(methodname, busname, objectpath,
1642
 
                                   interface, *args)
1643
 
 
1644
 
    def test_call_method_returns(self):
1645
 
        expected_method_return = Unique()
1646
 
        method_args = (Unique(), Unique())
1647
 
        def func(*args):
1648
 
            self.assertEqual(len(method_args), len(args))
1649
 
            for marg, arg in zip(method_args, args):
1650
 
                self.assertIs(marg, arg)
1651
 
            return expected_method_return
1652
 
        stub_pydbus = self.Stub_pydbus_func(func)
1653
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1654
 
        ret = self.call_method(bus, "methodname", "busname",
1655
 
                               "objectpath", "interface",
1656
 
                               *method_args)
1657
 
        self.assertIs(ret, expected_method_return)
1658
 
 
1659
 
    def test_call_method_handles_exception(self):
1660
 
        dbus_logger = logging.getLogger("dbus.proxies")
1661
 
 
1662
 
        def func():
1663
 
            raise gi.repository.GLib.Error()
1664
 
 
1665
 
        stub_pydbus = self.Stub_pydbus_func(func)
1666
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1667
 
 
1668
 
        with self.assertRaises(dbus.Error) as e:
1669
 
            self.call_method(bus, "methodname", "busname",
1670
 
                             "objectpath", "interface")
1671
 
 
1672
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1673
 
 
1674
 
    def test_get_converts_to_correct_exception(self):
1675
 
        bus = pydbus_adapter.SystemBus(
1676
 
            self.fake_pydbus_raises_exception_on_connect)
1677
 
        with self.assertRaises(dbus.ConnectFailed):
1678
 
            self.call_method(bus, "methodname", "busname",
1679
 
                             "objectpath", "interface")
1680
 
 
1681
 
    class fake_pydbus_raises_exception_on_connect(object):
1682
 
        """fake dbus-python module"""
1683
 
        @classmethod
1684
 
        def SystemBus(cls):
1685
 
            def get(busname, objectpath):
1686
 
                raise gi.repository.GLib.Error()
1687
 
            Bus = collections.namedtuple("Bus", ["get"])
1688
 
            return Bus(get=get)
1689
 
 
1690
 
    def test_set_property_uses_setattr(self):
1691
 
        class Object(object):
1692
 
            pass
1693
 
        obj = Object()
1694
 
        class pydbus_spy(object):
1695
 
            class SystemBus(object):
1696
 
                @staticmethod
1697
 
                def get(busname, objectpath):
1698
 
                    return {"interface": obj}
1699
 
        bus = pydbus_adapter.SystemBus(pydbus_spy)
1700
 
        value = Unique()
1701
 
        bus.set_property("busname", "objectpath", "interface", "key",
1702
 
                         value)
1703
 
        self.assertIs(value, obj.key)
1704
 
 
1705
 
    def test_get_suppresses_xml_deprecation_warning(self):
1706
 
        if sys.version_info.major >= 3:
1707
 
            return
1708
 
        class stub_pydbus_get(object):
1709
 
            class SystemBus(object):
1710
 
                @staticmethod
1711
 
                def get(busname, objectpath):
1712
 
                    warnings.warn_explicit(
1713
 
                        "deprecated", DeprecationWarning,
1714
 
                        "xml.etree.ElementTree", 0)
1715
 
        bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1716
 
        with warnings.catch_warnings(record=True) as w:
1717
 
            warnings.simplefilter("always")
1718
 
            bus.get("busname", "objectpath")
1719
 
            self.assertEqual(0, len(w))
1720
 
 
1721
 
 
1722
 
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1723
 
    class stub_pydbus(object):
1724
 
        """stub pydbus module"""
1725
 
        class SystemBus(object):
1726
 
            @staticmethod
1727
 
            def get(busname, objectpath):
1728
 
                return Unique()
1729
 
 
1730
 
    def setUp(self):
1731
 
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1732
 
 
1733
 
    def test_returns_distinct_objectpaths(self):
1734
 
        obj1 = self.bus.get("busname", "objectpath1")
1735
 
        self.assertIsInstance(obj1, Unique)
1736
 
        obj2 = self.bus.get("busname", "objectpath2")
1737
 
        self.assertIsInstance(obj2, Unique)
1738
 
        self.assertIsNot(obj1, obj2)
1739
 
 
1740
 
    def test_returns_distinct_busnames(self):
1741
 
        obj1 = self.bus.get("busname1", "objectpath")
1742
 
        self.assertIsInstance(obj1, Unique)
1743
 
        obj2 = self.bus.get("busname2", "objectpath")
1744
 
        self.assertIsInstance(obj2, Unique)
1745
 
        self.assertIsNot(obj1, obj2)
1746
 
 
1747
 
    def test_returns_distinct_both(self):
1748
 
        obj1 = self.bus.get("busname1", "objectpath")
1749
 
        self.assertIsInstance(obj1, Unique)
1750
 
        obj2 = self.bus.get("busname2", "objectpath")
1751
 
        self.assertIsInstance(obj2, Unique)
1752
 
        self.assertIsNot(obj1, obj2)
1753
 
 
1754
 
    def test_returns_same(self):
1755
 
        obj1 = self.bus.get("busname", "objectpath")
1756
 
        self.assertIsInstance(obj1, Unique)
1757
 
        obj2 = self.bus.get("busname", "objectpath")
1758
 
        self.assertIsInstance(obj2, Unique)
1759
 
        self.assertIs(obj1, obj2)
1760
 
 
1761
 
    def test_returns_same_old(self):
1762
 
        obj1 = self.bus.get("busname1", "objectpath1")
1763
 
        self.assertIsInstance(obj1, Unique)
1764
 
        obj2 = self.bus.get("busname2", "objectpath2")
1765
 
        self.assertIsInstance(obj2, Unique)
1766
 
        obj1b = self.bus.get("busname1", "objectpath1")
1767
 
        self.assertIsInstance(obj1b, Unique)
1768
 
        self.assertIsNot(obj1, obj2)
1769
 
        self.assertIsNot(obj2, obj1b)
1770
 
        self.assertIs(obj1, obj1b)
 
1087
        self.assertEqual(counting_handler.count, 0)
 
1088
 
 
1089
        # Test that the dbus_logger still works
 
1090
        with self.assertLogs(dbus_logger, logging.ERROR):
 
1091
            dbus_logger.error("Test")
 
1092
 
 
1093
        if isinstance(e.exception.code, int):
 
1094
            self.assertNotEqual(e.exception.code, 0)
 
1095
        else:
 
1096
            self.assertIsNotNone(e.exception.code)
1771
1097
 
1772
1098
 
1773
1099
class Test_commands_from_options(unittest.TestCase):
1774
 
 
1775
1100
    def setUp(self):
1776
1101
        self.parser = argparse.ArgumentParser()
1777
1102
        add_command_line_options(self.parser)
1778
1103
 
1779
1104
    def test_is_enabled(self):
1780
 
        self.assert_command_from_args(["--is-enabled", "client"],
1781
 
                                      command.IsEnabled)
 
1105
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1106
                                      IsEnabledCmd)
1782
1107
 
1783
 
    def assert_command_from_args(self, args, command_cls, length=1,
1784
 
                                 clients=None, **cmd_attrs):
 
1108
    def assert_command_from_args(self, args, command_cls,
 
1109
                                 **cmd_attrs):
1785
1110
        """Assert that parsing ARGS should result in an instance of
1786
1111
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1787
1112
        options = self.parser.parse_args(args)
1788
1113
        check_option_syntax(self.parser, options)
1789
1114
        commands = commands_from_options(options)
1790
 
        self.assertEqual(length, len(commands))
1791
 
        for command in commands:
1792
 
            if isinstance(command, command_cls):
1793
 
                break
1794
 
        else:
1795
 
            self.assertIsInstance(command, command_cls)
1796
 
        if clients is not None:
1797
 
            self.assertEqual(clients, options.client)
 
1115
        self.assertEqual(len(commands), 1)
 
1116
        command = commands[0]
 
1117
        self.assertIsInstance(command, command_cls)
1798
1118
        for key, value in cmd_attrs.items():
1799
 
            self.assertEqual(value, getattr(command, key))
1800
 
 
1801
 
    def assert_commands_from_args(self, args, commands, clients=None):
1802
 
        for cmd in commands:
1803
 
            self.assert_command_from_args(args, cmd,
1804
 
                                          length=len(commands),
1805
 
                                          clients=clients)
 
1119
            self.assertEqual(getattr(command, key), value)
1806
1120
 
1807
1121
    def test_is_enabled_short(self):
1808
 
        self.assert_command_from_args(["-V", "client"],
1809
 
                                      command.IsEnabled)
 
1122
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1810
1123
 
1811
1124
    def test_approve(self):
1812
 
        self.assert_command_from_args(["--approve", "client"],
1813
 
                                      command.Approve)
 
1125
        self.assert_command_from_args(["--approve", "foo"],
 
1126
                                      ApproveCmd)
1814
1127
 
1815
1128
    def test_approve_short(self):
1816
 
        self.assert_command_from_args(["-A", "client"],
1817
 
                                      command.Approve)
 
1129
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1818
1130
 
1819
1131
    def test_deny(self):
1820
 
        self.assert_command_from_args(["--deny", "client"],
1821
 
                                      command.Deny)
 
1132
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1822
1133
 
1823
1134
    def test_deny_short(self):
1824
 
        self.assert_command_from_args(["-D", "client"], command.Deny)
 
1135
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
1825
1136
 
1826
1137
    def test_remove(self):
1827
 
        self.assert_command_from_args(["--remove", "client"],
1828
 
                                      command.Remove)
 
1138
        self.assert_command_from_args(["--remove", "foo"],
 
1139
                                      RemoveCmd)
1829
1140
 
1830
1141
    def test_deny_before_remove(self):
1831
1142
        options = self.parser.parse_args(["--deny", "--remove",
1832
 
                                          "client"])
 
1143
                                          "foo"])
1833
1144
        check_option_syntax(self.parser, options)
1834
1145
        commands = commands_from_options(options)
1835
 
        self.assertEqual(2, len(commands))
1836
 
        self.assertIsInstance(commands[0], command.Deny)
1837
 
        self.assertIsInstance(commands[1], command.Remove)
 
1146
        self.assertEqual(len(commands), 2)
 
1147
        self.assertIsInstance(commands[0], DenyCmd)
 
1148
        self.assertIsInstance(commands[1], RemoveCmd)
1838
1149
 
1839
1150
    def test_deny_before_remove_reversed(self):
1840
1151
        options = self.parser.parse_args(["--remove", "--deny",
1841
1152
                                          "--all"])
1842
1153
        check_option_syntax(self.parser, options)
1843
1154
        commands = commands_from_options(options)
1844
 
        self.assertEqual(2, len(commands))
1845
 
        self.assertIsInstance(commands[0], command.Deny)
1846
 
        self.assertIsInstance(commands[1], command.Remove)
 
1155
        self.assertEqual(len(commands), 2)
 
1156
        self.assertIsInstance(commands[0], DenyCmd)
 
1157
        self.assertIsInstance(commands[1], RemoveCmd)
1847
1158
 
1848
1159
    def test_remove_short(self):
1849
 
        self.assert_command_from_args(["-r", "client"],
1850
 
                                      command.Remove)
 
1160
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1851
1161
 
1852
1162
    def test_dump_json(self):
1853
 
        self.assert_command_from_args(["--dump-json"],
1854
 
                                      command.DumpJSON)
 
1163
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1855
1164
 
1856
1165
    def test_enable(self):
1857
 
        self.assert_command_from_args(["--enable", "client"],
1858
 
                                      command.Enable)
 
1166
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1859
1167
 
1860
1168
    def test_enable_short(self):
1861
 
        self.assert_command_from_args(["-e", "client"],
1862
 
                                      command.Enable)
 
1169
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
1863
1170
 
1864
1171
    def test_disable(self):
1865
 
        self.assert_command_from_args(["--disable", "client"],
1866
 
                                      command.Disable)
 
1172
        self.assert_command_from_args(["--disable", "foo"],
 
1173
                                      DisableCmd)
1867
1174
 
1868
1175
    def test_disable_short(self):
1869
 
        self.assert_command_from_args(["-d", "client"],
1870
 
                                      command.Disable)
 
1176
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
1871
1177
 
1872
1178
    def test_bump_timeout(self):
1873
 
        self.assert_command_from_args(["--bump-timeout", "client"],
1874
 
                                      command.BumpTimeout)
 
1179
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1180
                                      BumpTimeoutCmd)
1875
1181
 
1876
1182
    def test_bump_timeout_short(self):
1877
 
        self.assert_command_from_args(["-b", "client"],
1878
 
                                      command.BumpTimeout)
 
1183
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1879
1184
 
1880
1185
    def test_start_checker(self):
1881
 
        self.assert_command_from_args(["--start-checker", "client"],
1882
 
                                      command.StartChecker)
 
1186
        self.assert_command_from_args(["--start-checker", "foo"],
 
1187
                                      StartCheckerCmd)
1883
1188
 
1884
1189
    def test_stop_checker(self):
1885
 
        self.assert_command_from_args(["--stop-checker", "client"],
1886
 
                                      command.StopChecker)
 
1190
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1191
                                      StopCheckerCmd)
1887
1192
 
1888
1193
    def test_approve_by_default(self):
1889
 
        self.assert_command_from_args(["--approve-by-default",
1890
 
                                       "client"],
1891
 
                                      command.ApproveByDefault)
 
1194
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1195
                                      ApproveByDefaultCmd)
1892
1196
 
1893
1197
    def test_deny_by_default(self):
1894
 
        self.assert_command_from_args(["--deny-by-default", "client"],
1895
 
                                      command.DenyByDefault)
 
1198
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1199
                                      DenyByDefaultCmd)
1896
1200
 
1897
1201
    def test_checker(self):
1898
 
        self.assert_command_from_args(["--checker", ":", "client"],
1899
 
                                      command.SetChecker,
1900
 
                                      value_to_set=":")
 
1202
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1203
                                      SetCheckerCmd, value_to_set=":")
1901
1204
 
1902
1205
    def test_checker_empty(self):
1903
 
        self.assert_command_from_args(["--checker", "", "client"],
1904
 
                                      command.SetChecker,
1905
 
                                      value_to_set="")
 
1206
        self.assert_command_from_args(["--checker", "", "foo"],
 
1207
                                      SetCheckerCmd, value_to_set="")
1906
1208
 
1907
1209
    def test_checker_short(self):
1908
 
        self.assert_command_from_args(["-c", ":", "client"],
1909
 
                                      command.SetChecker,
1910
 
                                      value_to_set=":")
 
1210
        self.assert_command_from_args(["-c", ":", "foo"],
 
1211
                                      SetCheckerCmd, value_to_set=":")
1911
1212
 
1912
1213
    def test_host(self):
1913
 
        self.assert_command_from_args(
1914
 
            ["--host", "client.example.org", "client"],
1915
 
            command.SetHost, value_to_set="client.example.org")
 
1214
        self.assert_command_from_args(["--host", "foo.example.org",
 
1215
                                       "foo"], SetHostCmd,
 
1216
                                      value_to_set="foo.example.org")
1916
1217
 
1917
1218
    def test_host_short(self):
1918
 
        self.assert_command_from_args(
1919
 
            ["-H", "client.example.org", "client"], command.SetHost,
1920
 
            value_to_set="client.example.org")
 
1219
        self.assert_command_from_args(["-H", "foo.example.org",
 
1220
                                       "foo"], SetHostCmd,
 
1221
                                      value_to_set="foo.example.org")
1921
1222
 
1922
1223
    def test_secret_devnull(self):
1923
1224
        self.assert_command_from_args(["--secret", os.path.devnull,
1924
 
                                       "client"], command.SetSecret,
 
1225
                                       "foo"], SetSecretCmd,
1925
1226
                                      value_to_set=b"")
1926
1227
 
1927
1228
    def test_secret_tempfile(self):
1930
1231
            f.write(value)
1931
1232
            f.seek(0)
1932
1233
            self.assert_command_from_args(["--secret", f.name,
1933
 
                                           "client"],
1934
 
                                          command.SetSecret,
 
1234
                                           "foo"], SetSecretCmd,
1935
1235
                                          value_to_set=value)
1936
1236
 
1937
1237
    def test_secret_devnull_short(self):
1938
 
        self.assert_command_from_args(["-s", os.path.devnull,
1939
 
                                       "client"], command.SetSecret,
1940
 
                                      value_to_set=b"")
 
1238
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1239
                                      SetSecretCmd, value_to_set=b"")
1941
1240
 
1942
1241
    def test_secret_tempfile_short(self):
1943
1242
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1944
1243
            value = b"secret\0xyzzy\nbar"
1945
1244
            f.write(value)
1946
1245
            f.seek(0)
1947
 
            self.assert_command_from_args(["-s", f.name, "client"],
1948
 
                                          command.SetSecret,
 
1246
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1247
                                          SetSecretCmd,
1949
1248
                                          value_to_set=value)
1950
1249
 
1951
1250
    def test_timeout(self):
1952
 
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
1953
 
                                      command.SetTimeout,
 
1251
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1252
                                      SetTimeoutCmd,
1954
1253
                                      value_to_set=300000)
1955
1254
 
1956
1255
    def test_timeout_short(self):
1957
 
        self.assert_command_from_args(["-t", "PT5M", "client"],
1958
 
                                      command.SetTimeout,
 
1256
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1257
                                      SetTimeoutCmd,
1959
1258
                                      value_to_set=300000)
1960
1259
 
1961
1260
    def test_extended_timeout(self):
1962
1261
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1963
 
                                       "client"],
1964
 
                                      command.SetExtendedTimeout,
 
1262
                                       "foo"],
 
1263
                                      SetExtendedTimeoutCmd,
1965
1264
                                      value_to_set=900000)
1966
1265
 
1967
1266
    def test_interval(self):
1968
 
        self.assert_command_from_args(["--interval", "PT2M",
1969
 
                                       "client"], command.SetInterval,
 
1267
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1268
                                      SetIntervalCmd,
1970
1269
                                      value_to_set=120000)
1971
1270
 
1972
1271
    def test_interval_short(self):
1973
 
        self.assert_command_from_args(["-i", "PT2M", "client"],
1974
 
                                      command.SetInterval,
 
1272
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1273
                                      SetIntervalCmd,
1975
1274
                                      value_to_set=120000)
1976
1275
 
1977
1276
    def test_approval_delay(self):
1978
1277
        self.assert_command_from_args(["--approval-delay", "PT30S",
1979
 
                                       "client"],
1980
 
                                      command.SetApprovalDelay,
 
1278
                                       "foo"], SetApprovalDelayCmd,
1981
1279
                                      value_to_set=30000)
1982
1280
 
1983
1281
    def test_approval_duration(self):
1984
1282
        self.assert_command_from_args(["--approval-duration", "PT1S",
1985
 
                                       "client"],
1986
 
                                      command.SetApprovalDuration,
 
1283
                                       "foo"], SetApprovalDurationCmd,
1987
1284
                                      value_to_set=1000)
1988
1285
 
1989
1286
    def test_print_table(self):
1990
 
        self.assert_command_from_args([], command.PrintTable,
 
1287
        self.assert_command_from_args([], PrintTableCmd,
1991
1288
                                      verbose=False)
1992
1289
 
1993
1290
    def test_print_table_verbose(self):
1994
 
        self.assert_command_from_args(["--verbose"],
1995
 
                                      command.PrintTable,
 
1291
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
1996
1292
                                      verbose=True)
1997
1293
 
1998
1294
    def test_print_table_verbose_short(self):
1999
 
        self.assert_command_from_args(["-v"], command.PrintTable,
2000
 
                                      verbose=True)
2001
 
 
2002
 
 
2003
 
    def test_manual_page_example_1(self):
2004
 
        self.assert_command_from_args("--verbose".split(),
2005
 
                                      command.PrintTable,
2006
 
                                      clients=[],
2007
 
                                      verbose=True)
2008
 
 
2009
 
    def test_manual_page_example_2(self):
2010
 
        self.assert_command_from_args(
2011
 
            "--verbose foo1.example.org foo2.example.org".split(),
2012
 
            command.PrintTable, clients=["foo1.example.org",
2013
 
                                         "foo2.example.org"],
2014
 
            verbose=True)
2015
 
 
2016
 
    def test_manual_page_example_3(self):
2017
 
        self.assert_command_from_args("--enable --all".split(),
2018
 
                                      command.Enable,
2019
 
                                      clients=[])
2020
 
 
2021
 
    def test_manual_page_example_4(self):
2022
 
        self.assert_commands_from_args(
2023
 
            ("--timeout=PT5M --interval=PT1M foo1.example.org"
2024
 
             " foo2.example.org").split(),
2025
 
            [command.SetTimeout, command.SetInterval],
2026
 
            clients=["foo1.example.org", "foo2.example.org"])
2027
 
 
2028
 
    def test_manual_page_example_5(self):
2029
 
        self.assert_command_from_args("--approve --all".split(),
2030
 
                                      command.Approve,
2031
 
                                      clients=[])
2032
 
 
2033
 
 
2034
 
class TestCommand(unittest.TestCase):
 
1295
        self.assert_command_from_args(["-v"], PrintTableCmd,
 
1296
                                      verbose=True)
 
1297
 
 
1298
 
 
1299
class TestCmd(unittest.TestCase):
2035
1300
    """Abstract class for tests of command classes"""
2036
1301
 
2037
 
    class FakeMandosBus(dbus.MandosBus):
2038
 
        def __init__(self, testcase):
2039
 
            self.client_properties = {
 
1302
    def setUp(self):
 
1303
        testcase = self
 
1304
        class MockClient(object):
 
1305
            def __init__(self, name, **attributes):
 
1306
                self.__dbus_object_path__ = "/clients/{}".format(name)
 
1307
                self.attributes = attributes
 
1308
                self.attributes["Name"] = name
 
1309
                self.calls = []
 
1310
            def Set(self, interface, propname, value, dbus_interface):
 
1311
                testcase.assertEqual(interface, client_dbus_interface)
 
1312
                testcase.assertEqual(dbus_interface,
 
1313
                                     dbus.PROPERTIES_IFACE)
 
1314
                self.attributes[propname] = value
 
1315
            def Get(self, interface, propname, dbus_interface):
 
1316
                testcase.assertEqual(interface, client_dbus_interface)
 
1317
                testcase.assertEqual(dbus_interface,
 
1318
                                     dbus.PROPERTIES_IFACE)
 
1319
                return self.attributes[propname]
 
1320
            def Approve(self, approve, dbus_interface):
 
1321
                testcase.assertEqual(dbus_interface,
 
1322
                                     client_dbus_interface)
 
1323
                self.calls.append(("Approve", (approve,
 
1324
                                               dbus_interface)))
 
1325
        self.client = MockClient(
 
1326
            "foo",
 
1327
            KeyID=("92ed150794387c03ce684574b1139a65"
 
1328
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
1329
            Secret=b"secret",
 
1330
            Host="foo.example.org",
 
1331
            Enabled=dbus.Boolean(True),
 
1332
            Timeout=300000,
 
1333
            LastCheckedOK="2019-02-03T00:00:00",
 
1334
            Created="2019-01-02T00:00:00",
 
1335
            Interval=120000,
 
1336
            Fingerprint=("778827225BA7DE539C5A"
 
1337
                         "7CFA59CFF7CDBD9A5920"),
 
1338
            CheckerRunning=dbus.Boolean(False),
 
1339
            LastEnabled="2019-01-03T00:00:00",
 
1340
            ApprovalPending=dbus.Boolean(False),
 
1341
            ApprovedByDefault=dbus.Boolean(True),
 
1342
            LastApprovalRequest="",
 
1343
            ApprovalDelay=0,
 
1344
            ApprovalDuration=1000,
 
1345
            Checker="fping -q -- %(host)s",
 
1346
            ExtendedTimeout=900000,
 
1347
            Expires="2019-02-04T00:00:00",
 
1348
            LastCheckerStatus=0)
 
1349
        self.other_client = MockClient(
 
1350
            "barbar",
 
1351
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
1352
                   "6ab612cff5ad227247e46c2b020f441c"),
 
1353
            Secret=b"secretbar",
 
1354
            Host="192.0.2.3",
 
1355
            Enabled=dbus.Boolean(True),
 
1356
            Timeout=300000,
 
1357
            LastCheckedOK="2019-02-04T00:00:00",
 
1358
            Created="2019-01-03T00:00:00",
 
1359
            Interval=120000,
 
1360
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
1361
                         "F547B3A107558FCA3A27"),
 
1362
            CheckerRunning=dbus.Boolean(True),
 
1363
            LastEnabled="2019-01-04T00:00:00",
 
1364
            ApprovalPending=dbus.Boolean(False),
 
1365
            ApprovedByDefault=dbus.Boolean(False),
 
1366
            LastApprovalRequest="2019-01-03T00:00:00",
 
1367
            ApprovalDelay=30000,
 
1368
            ApprovalDuration=93785000,
 
1369
            Checker=":",
 
1370
            ExtendedTimeout=900000,
 
1371
            Expires="2019-02-05T00:00:00",
 
1372
            LastCheckerStatus=-2)
 
1373
        self.clients =  collections.OrderedDict(
 
1374
            [
 
1375
                ("/clients/foo", self.client.attributes),
 
1376
                ("/clients/barbar", self.other_client.attributes),
 
1377
            ])
 
1378
        self.one_client = {"/clients/foo": self.client.attributes}
 
1379
 
 
1380
    @property
 
1381
    def bus(self):
 
1382
        class Bus(object):
 
1383
            @staticmethod
 
1384
            def get_object(client_bus_name, path):
 
1385
                self.assertEqual(client_bus_name, dbus_busname)
 
1386
                return {
 
1387
                    # Note: "self" here is the TestCmd instance, not
 
1388
                    # the Bus instance, since this is a static method!
 
1389
                    "/clients/foo": self.client,
 
1390
                    "/clients/barbar": self.other_client,
 
1391
                }[path]
 
1392
        return Bus()
 
1393
 
 
1394
 
 
1395
class TestIsEnabledCmd(TestCmd):
 
1396
    def test_is_enabled(self):
 
1397
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
 
1398
                                                      properties)
 
1399
                            for client, properties
 
1400
                            in self.clients.items()))
 
1401
 
 
1402
    def test_is_enabled_run_exits_successfully(self):
 
1403
        with self.assertRaises(SystemExit) as e:
 
1404
            IsEnabledCmd().run(self.one_client)
 
1405
        if e.exception.code is not None:
 
1406
            self.assertEqual(e.exception.code, 0)
 
1407
        else:
 
1408
            self.assertIsNone(e.exception.code)
 
1409
 
 
1410
    def test_is_enabled_run_exits_with_failure(self):
 
1411
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
1412
        with self.assertRaises(SystemExit) as e:
 
1413
            IsEnabledCmd().run(self.one_client)
 
1414
        if isinstance(e.exception.code, int):
 
1415
            self.assertNotEqual(e.exception.code, 0)
 
1416
        else:
 
1417
            self.assertIsNotNone(e.exception.code)
 
1418
 
 
1419
 
 
1420
class TestApproveCmd(TestCmd):
 
1421
    def test_approve(self):
 
1422
        ApproveCmd().run(self.clients, self.bus)
 
1423
        for clientpath in self.clients:
 
1424
            client = self.bus.get_object(dbus_busname, clientpath)
 
1425
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1426
                          client.calls)
 
1427
 
 
1428
 
 
1429
class TestDenyCmd(TestCmd):
 
1430
    def test_deny(self):
 
1431
        DenyCmd().run(self.clients, self.bus)
 
1432
        for clientpath in self.clients:
 
1433
            client = self.bus.get_object(dbus_busname, clientpath)
 
1434
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1435
                          client.calls)
 
1436
 
 
1437
 
 
1438
class TestRemoveCmd(TestCmd):
 
1439
    def test_remove(self):
 
1440
        class MockMandos(object):
 
1441
            def __init__(self):
 
1442
                self.calls = []
 
1443
            def RemoveClient(self, dbus_path):
 
1444
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1445
        mandos = MockMandos()
 
1446
        super(TestRemoveCmd, self).setUp()
 
1447
        RemoveCmd().run(self.clients, self.bus, mandos)
 
1448
        self.assertEqual(len(mandos.calls), 2)
 
1449
        for clientpath in self.clients:
 
1450
            self.assertIn(("RemoveClient", (clientpath,)),
 
1451
                          mandos.calls)
 
1452
 
 
1453
 
 
1454
class TestDumpJSONCmd(TestCmd):
 
1455
    def setUp(self):
 
1456
        self.expected_json = {
 
1457
            "foo": {
2040
1458
                "Name": "foo",
2041
1459
                "KeyID": ("92ed150794387c03ce684574b1139a65"
2042
1460
                          "94a34f895daaaf09fd8ea90a27cddb12"),
2043
 
                "Secret": b"secret",
2044
1461
                "Host": "foo.example.org",
2045
1462
                "Enabled": True,
2046
1463
                "Timeout": 300000,
2060
1477
                "ExtendedTimeout": 900000,
2061
1478
                "Expires": "2019-02-04T00:00:00",
2062
1479
                "LastCheckerStatus": 0,
2063
 
            }
2064
 
            self.other_client_properties = {
 
1480
            },
 
1481
            "barbar": {
2065
1482
                "Name": "barbar",
2066
1483
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
2067
1484
                          "6ab612cff5ad227247e46c2b020f441c"),
2068
 
                "Secret": b"secretbar",
2069
1485
                "Host": "192.0.2.3",
2070
1486
                "Enabled": True,
2071
1487
                "Timeout": 300000,
2085
1501
                "ExtendedTimeout": 900000,
2086
1502
                "Expires": "2019-02-05T00:00:00",
2087
1503
                "LastCheckerStatus": -2,
2088
 
            }
2089
 
            self.clients =  collections.OrderedDict(
2090
 
                [
2091
 
                    ("client_objectpath", self.client_properties),
2092
 
                    ("other_client_objectpath",
2093
 
                     self.other_client_properties),
2094
 
                ])
2095
 
            self.one_client = {"client_objectpath":
2096
 
                               self.client_properties}
2097
 
            self.testcase = testcase
2098
 
            self.calls = []
2099
 
 
2100
 
        def call_method(self, methodname, busname, objectpath,
2101
 
                        interface, *args):
2102
 
            self.testcase.assertEqual("se.recompile.Mandos", busname)
2103
 
            self.calls.append((methodname, busname, objectpath,
2104
 
                               interface, args))
2105
 
            if interface == "org.freedesktop.DBus.Properties":
2106
 
                if methodname == "Set":
2107
 
                    self.testcase.assertEqual(3, len(args))
2108
 
                    interface, key, value = args
2109
 
                    self.testcase.assertEqual(
2110
 
                        "se.recompile.Mandos.Client", interface)
2111
 
                    self.clients[objectpath][key] = value
2112
 
                    return
2113
 
            elif interface == "se.recompile.Mandos":
2114
 
                self.testcase.assertEqual("RemoveClient", methodname)
2115
 
                self.testcase.assertEqual(1, len(args))
2116
 
                clientpath = args[0]
2117
 
                del self.clients[clientpath]
2118
 
                return
2119
 
            elif interface == "se.recompile.Mandos.Client":
2120
 
                if methodname == "Approve":
2121
 
                    self.testcase.assertEqual(1, len(args))
2122
 
                    return
2123
 
            raise ValueError()
2124
 
 
2125
 
    def setUp(self):
2126
 
        self.bus = self.FakeMandosBus(self)
2127
 
 
2128
 
 
2129
 
class TestBaseCommands(TestCommand):
2130
 
 
2131
 
    def test_IsEnabled_exits_successfully(self):
2132
 
        with self.assertRaises(SystemExit) as e:
2133
 
            command.IsEnabled().run(self.bus.one_client)
2134
 
        if e.exception.code is not None:
2135
 
            self.assertEqual(0, e.exception.code)
2136
 
        else:
2137
 
            self.assertIsNone(e.exception.code)
2138
 
 
2139
 
    def test_IsEnabled_exits_with_failure(self):
2140
 
        self.bus.client_properties["Enabled"] = False
2141
 
        with self.assertRaises(SystemExit) as e:
2142
 
            command.IsEnabled().run(self.bus.one_client)
2143
 
        if isinstance(e.exception.code, int):
2144
 
            self.assertNotEqual(0, e.exception.code)
2145
 
        else:
2146
 
            self.assertIsNotNone(e.exception.code)
2147
 
 
2148
 
    def test_Approve(self):
2149
 
        busname = "se.recompile.Mandos"
2150
 
        client_interface = "se.recompile.Mandos.Client"
2151
 
        command.Approve().run(self.bus.clients, self.bus)
2152
 
        for clientpath in self.bus.clients:
2153
 
            self.assertIn(("Approve", busname, clientpath,
2154
 
                           client_interface, (True,)), self.bus.calls)
2155
 
 
2156
 
    def test_Deny(self):
2157
 
        busname = "se.recompile.Mandos"
2158
 
        client_interface = "se.recompile.Mandos.Client"
2159
 
        command.Deny().run(self.bus.clients, self.bus)
2160
 
        for clientpath in self.bus.clients:
2161
 
            self.assertIn(("Approve", busname, clientpath,
2162
 
                           client_interface, (False,)),
2163
 
                          self.bus.calls)
2164
 
 
2165
 
    def test_Remove(self):
2166
 
        command.Remove().run(self.bus.clients, self.bus)
2167
 
        for clientpath in self.bus.clients:
2168
 
            self.assertIn(("RemoveClient", dbus_busname,
2169
 
                           dbus_server_path, dbus_server_interface,
2170
 
                           (clientpath,)), self.bus.calls)
2171
 
 
2172
 
    expected_json = {
2173
 
        "foo": {
2174
 
            "Name": "foo",
2175
 
            "KeyID": ("92ed150794387c03ce684574b1139a65"
2176
 
                      "94a34f895daaaf09fd8ea90a27cddb12"),
2177
 
            "Host": "foo.example.org",
2178
 
            "Enabled": True,
2179
 
            "Timeout": 300000,
2180
 
            "LastCheckedOK": "2019-02-03T00:00:00",
2181
 
            "Created": "2019-01-02T00:00:00",
2182
 
            "Interval": 120000,
2183
 
            "Fingerprint": ("778827225BA7DE539C5A"
2184
 
                            "7CFA59CFF7CDBD9A5920"),
2185
 
            "CheckerRunning": False,
2186
 
            "LastEnabled": "2019-01-03T00:00:00",
2187
 
            "ApprovalPending": False,
2188
 
            "ApprovedByDefault": True,
2189
 
            "LastApprovalRequest": "",
2190
 
            "ApprovalDelay": 0,
2191
 
            "ApprovalDuration": 1000,
2192
 
            "Checker": "fping -q -- %(host)s",
2193
 
            "ExtendedTimeout": 900000,
2194
 
            "Expires": "2019-02-04T00:00:00",
2195
 
            "LastCheckerStatus": 0,
2196
 
        },
2197
 
        "barbar": {
2198
 
            "Name": "barbar",
2199
 
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
2200
 
                      "6ab612cff5ad227247e46c2b020f441c"),
2201
 
            "Host": "192.0.2.3",
2202
 
            "Enabled": True,
2203
 
            "Timeout": 300000,
2204
 
            "LastCheckedOK": "2019-02-04T00:00:00",
2205
 
            "Created": "2019-01-03T00:00:00",
2206
 
            "Interval": 120000,
2207
 
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
2208
 
                            "F547B3A107558FCA3A27"),
2209
 
            "CheckerRunning": True,
2210
 
            "LastEnabled": "2019-01-04T00:00:00",
2211
 
            "ApprovalPending": False,
2212
 
            "ApprovedByDefault": False,
2213
 
            "LastApprovalRequest": "2019-01-03T00:00:00",
2214
 
            "ApprovalDelay": 30000,
2215
 
            "ApprovalDuration": 93785000,
2216
 
            "Checker": ":",
2217
 
            "ExtendedTimeout": 900000,
2218
 
            "Expires": "2019-02-05T00:00:00",
2219
 
            "LastCheckerStatus": -2,
2220
 
        },
2221
 
    }
2222
 
 
2223
 
    def test_DumpJSON_normal(self):
2224
 
        with self.capture_stdout_to_buffer() as buffer:
2225
 
            command.DumpJSON().run(self.bus.clients)
2226
 
        json_data = json.loads(buffer.getvalue())
2227
 
        self.assertDictEqual(self.expected_json, json_data)
2228
 
 
2229
 
    @staticmethod
2230
 
    @contextlib.contextmanager
2231
 
    def capture_stdout_to_buffer():
2232
 
        capture_buffer = io.StringIO()
2233
 
        old_stdout = sys.stdout
2234
 
        sys.stdout = capture_buffer
2235
 
        try:
2236
 
            yield capture_buffer
2237
 
        finally:
2238
 
            sys.stdout = old_stdout
2239
 
 
2240
 
    def test_DumpJSON_one_client(self):
2241
 
        with self.capture_stdout_to_buffer() as buffer:
2242
 
            command.DumpJSON().run(self.bus.one_client)
2243
 
        json_data = json.loads(buffer.getvalue())
 
1504
            },
 
1505
        }
 
1506
        return super(TestDumpJSONCmd, self).setUp()
 
1507
 
 
1508
    def test_normal(self):
 
1509
        output = DumpJSONCmd().output(self.clients.values())
 
1510
        json_data = json.loads(output)
 
1511
        self.assertDictEqual(json_data, self.expected_json)
 
1512
 
 
1513
    def test_one_client(self):
 
1514
        output = DumpJSONCmd().output(self.one_client.values())
 
1515
        json_data = json.loads(output)
2244
1516
        expected_json = {"foo": self.expected_json["foo"]}
2245
 
        self.assertDictEqual(expected_json, json_data)
2246
 
 
2247
 
    def test_PrintTable_normal(self):
2248
 
        with self.capture_stdout_to_buffer() as buffer:
2249
 
            command.PrintTable().run(self.bus.clients)
 
1517
        self.assertDictEqual(json_data, expected_json)
 
1518
 
 
1519
 
 
1520
class TestPrintTableCmd(TestCmd):
 
1521
    def test_normal(self):
 
1522
        output = PrintTableCmd().output(self.clients.values())
2250
1523
        expected_output = "\n".join((
2251
1524
            "Name   Enabled Timeout  Last Successful Check",
2252
1525
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
2253
1526
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
2254
 
        )) + "\n"
2255
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1527
        ))
 
1528
        self.assertEqual(output, expected_output)
2256
1529
 
2257
 
    def test_PrintTable_verbose(self):
2258
 
        with self.capture_stdout_to_buffer() as buffer:
2259
 
            command.PrintTable(verbose=True).run(self.bus.clients)
 
1530
    def test_verbose(self):
 
1531
        output = PrintTableCmd(verbose=True).output(
 
1532
            self.clients.values())
2260
1533
        columns = (
2261
1534
            (
2262
1535
                "Name   ",
2344
1617
            )
2345
1618
        )
2346
1619
        num_lines = max(len(rows) for rows in columns)
2347
 
        expected_output = ("\n".join("".join(rows[line]
2348
 
                                             for rows in columns)
2349
 
                                     for line in range(num_lines))
2350
 
                           + "\n")
2351
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1620
        expected_output = "\n".join("".join(rows[line]
 
1621
                                            for rows in columns)
 
1622
                                    for line in range(num_lines))
 
1623
        self.assertEqual(output, expected_output)
2352
1624
 
2353
 
    def test_PrintTable_one_client(self):
2354
 
        with self.capture_stdout_to_buffer() as buffer:
2355
 
            command.PrintTable().run(self.bus.one_client)
 
1625
    def test_one_client(self):
 
1626
        output = PrintTableCmd().output(self.one_client.values())
2356
1627
        expected_output = "\n".join((
2357
1628
            "Name Enabled Timeout  Last Successful Check",
2358
1629
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
2359
 
        )) + "\n"
2360
 
        self.assertEqual(expected_output, buffer.getvalue())
2361
 
 
2362
 
 
2363
 
class TestPropertySetterCmd(TestCommand):
2364
 
    """Abstract class for tests of command.PropertySetter classes"""
2365
 
 
 
1630
        ))
 
1631
        self.assertEqual(output, expected_output)
 
1632
 
 
1633
 
 
1634
class TestPropertyCmd(TestCmd):
 
1635
    """Abstract class for tests of PropertyCmd classes"""
2366
1636
    def runTest(self):
2367
1637
        if not hasattr(self, "command"):
2368
 
            return              # Abstract TestCase class
2369
 
 
2370
 
        if hasattr(self, "values_to_set"):
2371
 
            cmd_args = [(value,) for value in self.values_to_set]
2372
 
            values_to_get = getattr(self, "values_to_get",
2373
 
                                    self.values_to_set)
2374
 
        else:
2375
 
            cmd_args = [() for x in range(len(self.values_to_get))]
2376
 
            values_to_get = self.values_to_get
2377
 
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2378
 
            for clientpath in self.bus.clients:
2379
 
                self.bus.clients[clientpath][self.propname] = (
2380
 
                    Unique())
2381
 
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
2382
 
            for clientpath in self.bus.clients:
2383
 
                value = (self.bus.clients[clientpath]
2384
 
                         [self.propname])
2385
 
                self.assertNotIsInstance(value, Unique)
2386
 
                self.assertEqual(value_to_get, value)
2387
 
 
2388
 
 
2389
 
class TestEnableCmd(TestPropertySetterCmd):
2390
 
    command = command.Enable
2391
 
    propname = "Enabled"
2392
 
    values_to_get = [True]
2393
 
 
2394
 
 
2395
 
class TestDisableCmd(TestPropertySetterCmd):
2396
 
    command = command.Disable
2397
 
    propname = "Enabled"
2398
 
    values_to_get = [False]
2399
 
 
2400
 
 
2401
 
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2402
 
    command = command.BumpTimeout
 
1638
            return
 
1639
        values_to_get = getattr(self, "values_to_get",
 
1640
                                self.values_to_set)
 
1641
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1642
                                              values_to_get):
 
1643
            for clientpath in self.clients:
 
1644
                client = self.bus.get_object(dbus_busname, clientpath)
 
1645
                old_value = client.attributes[self.propname]
 
1646
                self.assertNotIsInstance(old_value, self.Unique)
 
1647
                client.attributes[self.propname] = self.Unique()
 
1648
            self.run_command(value_to_set, self.clients)
 
1649
            for clientpath in self.clients:
 
1650
                client = self.bus.get_object(dbus_busname, clientpath)
 
1651
                value = client.attributes[self.propname]
 
1652
                self.assertNotIsInstance(value, self.Unique)
 
1653
                self.assertEqual(value, value_to_get)
 
1654
 
 
1655
    class Unique(object):
 
1656
        """Class for objects which exist only to be unique objects,
 
1657
since unittest.mock.sentinel only exists in Python 3.3"""
 
1658
 
 
1659
    def run_command(self, value, clients):
 
1660
        self.command().run(clients, self.bus)
 
1661
 
 
1662
 
 
1663
class TestEnableCmd(TestPropertyCmd):
 
1664
    command = EnableCmd
 
1665
    propname = "Enabled"
 
1666
    values_to_set = [dbus.Boolean(True)]
 
1667
 
 
1668
 
 
1669
class TestDisableCmd(TestPropertyCmd):
 
1670
    command = DisableCmd
 
1671
    propname = "Enabled"
 
1672
    values_to_set = [dbus.Boolean(False)]
 
1673
 
 
1674
 
 
1675
class TestBumpTimeoutCmd(TestPropertyCmd):
 
1676
    command = BumpTimeoutCmd
2403
1677
    propname = "LastCheckedOK"
2404
 
    values_to_get = [""]
2405
 
 
2406
 
 
2407
 
class TestStartCheckerCmd(TestPropertySetterCmd):
2408
 
    command = command.StartChecker
2409
 
    propname = "CheckerRunning"
2410
 
    values_to_get = [True]
2411
 
 
2412
 
 
2413
 
class TestStopCheckerCmd(TestPropertySetterCmd):
2414
 
    command = command.StopChecker
2415
 
    propname = "CheckerRunning"
2416
 
    values_to_get = [False]
2417
 
 
2418
 
 
2419
 
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2420
 
    command = command.ApproveByDefault
2421
 
    propname = "ApprovedByDefault"
2422
 
    values_to_get = [True]
2423
 
 
2424
 
 
2425
 
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2426
 
    command = command.DenyByDefault
2427
 
    propname = "ApprovedByDefault"
2428
 
    values_to_get = [False]
2429
 
 
2430
 
 
2431
 
class TestSetCheckerCmd(TestPropertySetterCmd):
2432
 
    command = command.SetChecker
 
1678
    values_to_set = [""]
 
1679
 
 
1680
 
 
1681
class TestStartCheckerCmd(TestPropertyCmd):
 
1682
    command = StartCheckerCmd
 
1683
    propname = "CheckerRunning"
 
1684
    values_to_set = [dbus.Boolean(True)]
 
1685
 
 
1686
 
 
1687
class TestStopCheckerCmd(TestPropertyCmd):
 
1688
    command = StopCheckerCmd
 
1689
    propname = "CheckerRunning"
 
1690
    values_to_set = [dbus.Boolean(False)]
 
1691
 
 
1692
 
 
1693
class TestApproveByDefaultCmd(TestPropertyCmd):
 
1694
    command = ApproveByDefaultCmd
 
1695
    propname = "ApprovedByDefault"
 
1696
    values_to_set = [dbus.Boolean(True)]
 
1697
 
 
1698
 
 
1699
class TestDenyByDefaultCmd(TestPropertyCmd):
 
1700
    command = DenyByDefaultCmd
 
1701
    propname = "ApprovedByDefault"
 
1702
    values_to_set = [dbus.Boolean(False)]
 
1703
 
 
1704
 
 
1705
class TestPropertyValueCmd(TestPropertyCmd):
 
1706
    """Abstract class for tests of PropertyValueCmd classes"""
 
1707
 
 
1708
    def runTest(self):
 
1709
        if type(self) is TestPropertyValueCmd:
 
1710
            return
 
1711
        return super(TestPropertyValueCmd, self).runTest()
 
1712
 
 
1713
    def run_command(self, value, clients):
 
1714
        self.command(value).run(clients, self.bus)
 
1715
 
 
1716
 
 
1717
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1718
    command = SetCheckerCmd
2433
1719
    propname = "Checker"
2434
1720
    values_to_set = ["", ":", "fping -q -- %s"]
2435
1721
 
2436
1722
 
2437
 
class TestSetHostCmd(TestPropertySetterCmd):
2438
 
    command = command.SetHost
 
1723
class TestSetHostCmd(TestPropertyValueCmd):
 
1724
    command = SetHostCmd
2439
1725
    propname = "Host"
2440
 
    values_to_set = ["192.0.2.3", "client.example.org"]
2441
 
 
2442
 
 
2443
 
class TestSetSecretCmd(TestPropertySetterCmd):
2444
 
    command = command.SetSecret
 
1726
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1727
 
 
1728
 
 
1729
class TestSetSecretCmd(TestPropertyValueCmd):
 
1730
    command = SetSecretCmd
2445
1731
    propname = "Secret"
2446
1732
    values_to_set = [io.BytesIO(b""),
2447
1733
                     io.BytesIO(b"secret\0xyzzy\nbar")]
2448
 
    values_to_get = [f.getvalue() for f in values_to_set]
2449
 
 
2450
 
 
2451
 
class TestSetTimeoutCmd(TestPropertySetterCmd):
2452
 
    command = command.SetTimeout
 
1734
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1735
 
 
1736
 
 
1737
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1738
    command = SetTimeoutCmd
2453
1739
    propname = "Timeout"
2454
1740
    values_to_set = [datetime.timedelta(),
2455
1741
                     datetime.timedelta(minutes=5),
2456
1742
                     datetime.timedelta(seconds=1),
2457
1743
                     datetime.timedelta(weeks=1),
2458
1744
                     datetime.timedelta(weeks=52)]
2459
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2460
 
 
2461
 
 
2462
 
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2463
 
    command = command.SetExtendedTimeout
 
1745
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1746
 
 
1747
 
 
1748
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1749
    command = SetExtendedTimeoutCmd
2464
1750
    propname = "ExtendedTimeout"
2465
1751
    values_to_set = [datetime.timedelta(),
2466
1752
                     datetime.timedelta(minutes=5),
2467
1753
                     datetime.timedelta(seconds=1),
2468
1754
                     datetime.timedelta(weeks=1),
2469
1755
                     datetime.timedelta(weeks=52)]
2470
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2471
 
 
2472
 
 
2473
 
class TestSetIntervalCmd(TestPropertySetterCmd):
2474
 
    command = command.SetInterval
 
1756
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1757
 
 
1758
 
 
1759
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1760
    command = SetIntervalCmd
2475
1761
    propname = "Interval"
2476
1762
    values_to_set = [datetime.timedelta(),
2477
1763
                     datetime.timedelta(minutes=5),
2478
1764
                     datetime.timedelta(seconds=1),
2479
1765
                     datetime.timedelta(weeks=1),
2480
1766
                     datetime.timedelta(weeks=52)]
2481
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2482
 
 
2483
 
 
2484
 
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2485
 
    command = command.SetApprovalDelay
 
1767
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1768
 
 
1769
 
 
1770
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1771
    command = SetApprovalDelayCmd
2486
1772
    propname = "ApprovalDelay"
2487
1773
    values_to_set = [datetime.timedelta(),
2488
1774
                     datetime.timedelta(minutes=5),
2489
1775
                     datetime.timedelta(seconds=1),
2490
1776
                     datetime.timedelta(weeks=1),
2491
1777
                     datetime.timedelta(weeks=52)]
2492
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2493
 
 
2494
 
 
2495
 
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2496
 
    command = command.SetApprovalDuration
 
1778
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1779
 
 
1780
 
 
1781
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1782
    command = SetApprovalDurationCmd
2497
1783
    propname = "ApprovalDuration"
2498
1784
    values_to_set = [datetime.timedelta(),
2499
1785
                     datetime.timedelta(minutes=5),
2500
1786
                     datetime.timedelta(seconds=1),
2501
1787
                     datetime.timedelta(weeks=1),
2502
1788
                     datetime.timedelta(weeks=52)]
2503
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
1789
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2504
1790
 
2505
1791
 
2506
1792