/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-13 21:38:35 UTC
  • Revision ID: teddy@recompile.se-20190313213835-vq9cv3lih2jp3au7
mandos-ctl: Refactor

* mandos-ctl (TestCmd.bus.Bus.get_object): Add explanatory comment
                                           about "self".
  (Unique): Move to "TestPropertyCmd.Unique".  All callers changed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
42
42
import json
43
43
import unittest
44
44
import logging
 
45
import io
 
46
import tempfile
 
47
import contextlib
45
48
 
46
49
import dbus
47
50
 
61
64
 
62
65
locale.setlocale(locale.LC_ALL, "")
63
66
 
64
 
domain = "se.recompile"
65
 
busname = domain + ".Mandos"
66
 
server_path = "/"
67
 
server_interface = domain + ".Mandos"
68
 
client_interface = domain + ".Mandos.Client"
 
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
69
73
version = "1.8.3"
70
74
 
71
75
 
75
79
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
76
80
 
77
81
 
78
 
def milliseconds_to_string(ms):
79
 
    td = datetime.timedelta(0, 0, 0, ms)
80
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
81
 
            .format(days="{}T".format(td.days) if td.days else "",
82
 
                    hours=td.seconds // 3600,
83
 
                    minutes=(td.seconds % 3600) // 60,
84
 
                    seconds=td.seconds % 60))
 
82
def main():
 
83
    parser = argparse.ArgumentParser()
 
84
 
 
85
    add_command_line_options(parser)
 
86
 
 
87
    options = parser.parse_args()
 
88
 
 
89
    check_option_syntax(parser, options)
 
90
 
 
91
    clientnames = options.client
 
92
 
 
93
    if options.debug:
 
94
        log.setLevel(logging.DEBUG)
 
95
 
 
96
    try:
 
97
        bus = dbus.SystemBus()
 
98
        log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
99
                  dbus_busname, server_dbus_path)
 
100
        mandos_dbus_objc = bus.get_object(dbus_busname,
 
101
                                          server_dbus_path)
 
102
    except dbus.exceptions.DBusException:
 
103
        log.critical("Could not connect to Mandos server")
 
104
        sys.exit(1)
 
105
 
 
106
    mandos_serv = dbus.Interface(mandos_dbus_objc,
 
107
                                 dbus_interface=server_dbus_interface)
 
108
    mandos_serv_object_manager = dbus.Interface(
 
109
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
110
 
 
111
    # Filter out log message from dbus module
 
112
    dbus_logger = logging.getLogger("dbus.proxies")
 
113
    class NullFilter(logging.Filter):
 
114
        def filter(self, record):
 
115
            return False
 
116
    dbus_filter = NullFilter()
 
117
    try:
 
118
        dbus_logger.addFilter(dbus_filter)
 
119
        log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
 
120
                  server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
 
121
        mandos_clients = {path: ifs_and_props[client_dbus_interface]
 
122
                          for path, ifs_and_props in
 
123
                          mandos_serv_object_manager
 
124
                          .GetManagedObjects().items()
 
125
                          if client_dbus_interface in ifs_and_props}
 
126
    except dbus.exceptions.DBusException as e:
 
127
        log.critical("Failed to access Mandos server through D-Bus:"
 
128
                     "\n%s", e)
 
129
        sys.exit(1)
 
130
    finally:
 
131
        # restore dbus logger
 
132
        dbus_logger.removeFilter(dbus_filter)
 
133
 
 
134
    # Compile dict of (clients: properties) to process
 
135
    clients = {}
 
136
 
 
137
    if not clientnames:
 
138
        clients = {objpath: properties
 
139
                   for objpath, properties in mandos_clients.items()}
 
140
    else:
 
141
        for name in clientnames:
 
142
            for objpath, properties in mandos_clients.items():
 
143
                if properties["Name"] == name:
 
144
                    clients[objpath] = properties
 
145
                    break
 
146
            else:
 
147
                log.critical("Client not found on server: %r", name)
 
148
                sys.exit(1)
 
149
 
 
150
    # Run all commands on clients
 
151
    commands = commands_from_options(options)
 
152
    for command in commands:
 
153
        command.run(clients, bus, mandos_serv)
 
154
 
 
155
 
 
156
def add_command_line_options(parser):
 
157
    parser.add_argument("--version", action="version",
 
158
                        version="%(prog)s {}".format(version),
 
159
                        help="show version number and exit")
 
160
    parser.add_argument("-a", "--all", action="store_true",
 
161
                        help="Select all clients")
 
162
    parser.add_argument("-v", "--verbose", action="store_true",
 
163
                        help="Print all fields")
 
164
    parser.add_argument("-j", "--dump-json", action="store_true",
 
165
                        help="Dump client data in JSON format")
 
166
    enable_disable = parser.add_mutually_exclusive_group()
 
167
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
168
                                help="Enable client")
 
169
    enable_disable.add_argument("-d", "--disable",
 
170
                                action="store_true",
 
171
                                help="disable client")
 
172
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
173
                        help="Bump timeout for client")
 
174
    start_stop_checker = parser.add_mutually_exclusive_group()
 
175
    start_stop_checker.add_argument("--start-checker",
 
176
                                    action="store_true",
 
177
                                    help="Start checker for client")
 
178
    start_stop_checker.add_argument("--stop-checker",
 
179
                                    action="store_true",
 
180
                                    help="Stop checker for client")
 
181
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
182
                        help="Check if client is enabled")
 
183
    parser.add_argument("-r", "--remove", action="store_true",
 
184
                        help="Remove client")
 
185
    parser.add_argument("-c", "--checker",
 
186
                        help="Set checker command for client")
 
187
    parser.add_argument("-t", "--timeout", type=string_to_delta,
 
188
                        help="Set timeout for client")
 
189
    parser.add_argument("--extended-timeout", type=string_to_delta,
 
190
                        help="Set extended timeout for client")
 
191
    parser.add_argument("-i", "--interval", type=string_to_delta,
 
192
                        help="Set checker interval for client")
 
193
    approve_deny_default = parser.add_mutually_exclusive_group()
 
194
    approve_deny_default.add_argument(
 
195
        "--approve-by-default", action="store_true",
 
196
        default=None, dest="approved_by_default",
 
197
        help="Set client to be approved by default")
 
198
    approve_deny_default.add_argument(
 
199
        "--deny-by-default", action="store_false",
 
200
        dest="approved_by_default",
 
201
        help="Set client to be denied by default")
 
202
    parser.add_argument("--approval-delay", type=string_to_delta,
 
203
                        help="Set delay before client approve/deny")
 
204
    parser.add_argument("--approval-duration", type=string_to_delta,
 
205
                        help="Set duration of one client approval")
 
206
    parser.add_argument("-H", "--host", help="Set host for client")
 
207
    parser.add_argument("-s", "--secret",
 
208
                        type=argparse.FileType(mode="rb"),
 
209
                        help="Set password blob (file) for client")
 
210
    approve_deny = parser.add_mutually_exclusive_group()
 
211
    approve_deny.add_argument(
 
212
        "-A", "--approve", action="store_true",
 
213
        help="Approve any current client request")
 
214
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
215
                              help="Deny any current client request")
 
216
    parser.add_argument("--debug", action="store_true",
 
217
                        help="Debug mode (show D-Bus commands)")
 
218
    parser.add_argument("--check", action="store_true",
 
219
                        help="Run self-test")
 
220
    parser.add_argument("client", nargs="*", help="Client name")
 
221
 
 
222
 
 
223
def string_to_delta(interval):
 
224
    """Parse a string and return a datetime.timedelta"""
 
225
 
 
226
    try:
 
227
        return rfc3339_duration_to_delta(interval)
 
228
    except ValueError as e:
 
229
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
230
                    ' '.join(e.args))
 
231
    return parse_pre_1_6_1_interval(interval)
85
232
 
86
233
 
87
234
def rfc3339_duration_to_delta(duration):
214
361
    return value
215
362
 
216
363
 
217
 
def string_to_delta(interval):
218
 
    """Parse a string and return a datetime.timedelta"""
219
 
 
220
 
    try:
221
 
        return rfc3339_duration_to_delta(interval)
222
 
    except ValueError as e:
223
 
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
224
 
                    ' '.join(e.args))
225
 
    return parse_pre_1_6_1_interval(interval)
226
 
 
227
 
 
228
364
def parse_pre_1_6_1_interval(interval):
229
365
    """Parse an interval string as documented by Mandos before 1.6.1,
230
366
    and return a datetime.timedelta
268
404
    return value
269
405
 
270
406
 
271
 
## Classes for commands.
272
 
 
273
 
# Abstract classes first
 
407
def check_option_syntax(parser, options):
 
408
    """Apply additional restrictions on options, not expressible in
 
409
argparse"""
 
410
 
 
411
    def has_actions(options):
 
412
        return any((options.enable,
 
413
                    options.disable,
 
414
                    options.bump_timeout,
 
415
                    options.start_checker,
 
416
                    options.stop_checker,
 
417
                    options.is_enabled,
 
418
                    options.remove,
 
419
                    options.checker is not None,
 
420
                    options.timeout is not None,
 
421
                    options.extended_timeout is not None,
 
422
                    options.interval is not None,
 
423
                    options.approved_by_default is not None,
 
424
                    options.approval_delay is not None,
 
425
                    options.approval_duration is not None,
 
426
                    options.host is not None,
 
427
                    options.secret is not None,
 
428
                    options.approve,
 
429
                    options.deny))
 
430
 
 
431
    if has_actions(options) and not (options.client or options.all):
 
432
        parser.error("Options require clients names or --all.")
 
433
    if options.verbose and has_actions(options):
 
434
        parser.error("--verbose can only be used alone.")
 
435
    if options.dump_json and (options.verbose
 
436
                              or has_actions(options)):
 
437
        parser.error("--dump-json can only be used alone.")
 
438
    if options.all and not has_actions(options):
 
439
        parser.error("--all requires an action.")
 
440
    if options.is_enabled and len(options.client) > 1:
 
441
        parser.error("--is-enabled requires exactly one client")
 
442
    if options.remove:
 
443
        options.remove = False
 
444
        if has_actions(options) and not options.deny:
 
445
            parser.error("--remove can only be combined with --deny")
 
446
        options.remove = True
 
447
 
 
448
 
 
449
def commands_from_options(options):
 
450
 
 
451
    commands = []
 
452
 
 
453
    if options.is_enabled:
 
454
        commands.append(IsEnabledCmd())
 
455
 
 
456
    if options.approve:
 
457
        commands.append(ApproveCmd())
 
458
 
 
459
    if options.deny:
 
460
        commands.append(DenyCmd())
 
461
 
 
462
    if options.remove:
 
463
        commands.append(RemoveCmd())
 
464
 
 
465
    if options.dump_json:
 
466
        commands.append(DumpJSONCmd())
 
467
 
 
468
    if options.enable:
 
469
        commands.append(EnableCmd())
 
470
 
 
471
    if options.disable:
 
472
        commands.append(DisableCmd())
 
473
 
 
474
    if options.bump_timeout:
 
475
        commands.append(BumpTimeoutCmd())
 
476
 
 
477
    if options.start_checker:
 
478
        commands.append(StartCheckerCmd())
 
479
 
 
480
    if options.stop_checker:
 
481
        commands.append(StopCheckerCmd())
 
482
 
 
483
    if options.approved_by_default is not None:
 
484
        if options.approved_by_default:
 
485
            commands.append(ApproveByDefaultCmd())
 
486
        else:
 
487
            commands.append(DenyByDefaultCmd())
 
488
 
 
489
    if options.checker is not None:
 
490
        commands.append(SetCheckerCmd(options.checker))
 
491
 
 
492
    if options.host is not None:
 
493
        commands.append(SetHostCmd(options.host))
 
494
 
 
495
    if options.secret is not None:
 
496
        commands.append(SetSecretCmd(options.secret))
 
497
 
 
498
    if options.timeout is not None:
 
499
        commands.append(SetTimeoutCmd(options.timeout))
 
500
 
 
501
    if options.extended_timeout:
 
502
        commands.append(
 
503
            SetExtendedTimeoutCmd(options.extended_timeout))
 
504
 
 
505
    if options.interval is not None:
 
506
        commands.append(SetIntervalCmd(options.interval))
 
507
 
 
508
    if options.approval_delay is not None:
 
509
        commands.append(SetApprovalDelayCmd(options.approval_delay))
 
510
 
 
511
    if options.approval_duration is not None:
 
512
        commands.append(
 
513
            SetApprovalDurationCmd(options.approval_duration))
 
514
 
 
515
    # If no command option has been given, show table of clients,
 
516
    # optionally verbosely
 
517
    if not commands:
 
518
        commands.append(PrintTableCmd(verbose=options.verbose))
 
519
 
 
520
    return commands
 
521
 
 
522
 
274
523
class Command(object):
275
524
    """Abstract class for commands"""
276
 
    def run(self, mandos, clients):
 
525
    def run(self, clients, bus=None, mandos=None):
277
526
        """Normal commands should implement run_on_one_client(), but
278
527
        commands which want to operate on all clients at the same time
279
528
        can override this run() method instead."""
280
529
        self.mandos = mandos
281
 
        for client in clients:
282
 
            self.run_on_one_client(client)
283
 
 
284
 
class PrintCmd(Command):
285
 
    """Abstract class for commands printing client details"""
 
530
        for clientpath, properties in clients.items():
 
531
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
532
                      dbus_busname, str(clientpath))
 
533
            client = bus.get_object(dbus_busname, clientpath)
 
534
            self.run_on_one_client(client, properties)
 
535
 
 
536
 
 
537
class IsEnabledCmd(Command):
 
538
    def run(self, clients, bus=None, mandos=None):
 
539
        client, properties = next(iter(clients.items()))
 
540
        if self.is_enabled(client, properties):
 
541
            sys.exit(0)
 
542
        sys.exit(1)
 
543
    def is_enabled(self, client, properties):
 
544
        return properties["Enabled"]
 
545
 
 
546
 
 
547
class ApproveCmd(Command):
 
548
    def run_on_one_client(self, client, properties):
 
549
        log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
550
                  client.__dbus_object_path__, client_dbus_interface)
 
551
        client.Approve(dbus.Boolean(True),
 
552
                       dbus_interface=client_dbus_interface)
 
553
 
 
554
 
 
555
class DenyCmd(Command):
 
556
    def run_on_one_client(self, client, properties):
 
557
        log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
558
                  client.__dbus_object_path__, client_dbus_interface)
 
559
        client.Approve(dbus.Boolean(False),
 
560
                       dbus_interface=client_dbus_interface)
 
561
 
 
562
 
 
563
class RemoveCmd(Command):
 
564
    def run_on_one_client(self, client, properties):
 
565
        log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
 
566
                  server_dbus_path, server_dbus_interface,
 
567
                  str(client.__dbus_object_path__))
 
568
        self.mandos.RemoveClient(client.__dbus_object_path__)
 
569
 
 
570
 
 
571
class OutputCmd(Command):
 
572
    """Abstract class for commands outputting client details"""
286
573
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
287
574
                    "Created", "Interval", "Host", "KeyID",
288
575
                    "Fingerprint", "CheckerRunning", "LastEnabled",
290
577
                    "LastApprovalRequest", "ApprovalDelay",
291
578
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
292
579
                    "Expires", "LastCheckerStatus")
293
 
    def run(self, mandos, clients):
294
 
        print(self.output(clients))
295
 
 
296
 
class PropertyCmd(Command):
297
 
    """Abstract class for Actions for setting one client property"""
298
 
    def run_on_one_client(self, client):
299
 
        """Set the Client's D-Bus property"""
300
 
        client.Set(client_interface, self.property, self.value_to_set,
301
 
                   dbus_interface=dbus.PROPERTIES_IFACE)
302
 
 
303
 
class ValueArgumentMixIn(object):
304
 
    """Mixin class for commands taking a value as argument"""
305
 
    def __init__(self, value):
306
 
        self.value_to_set = value
307
 
 
308
 
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
309
 
    """Mixin class for commands taking a value argument as
310
 
    milliseconds."""
311
 
    @property
312
 
    def value_to_set(self):
313
 
        return self._vts
314
 
    @value_to_set.setter
315
 
    def value_to_set(self, value):
316
 
        """When setting, convert value to a datetime.timedelta"""
317
 
        self._vts = string_to_delta(value).total_seconds() * 1000
318
 
 
319
 
# Actual (non-abstract) command classes
320
 
 
321
 
class PrintTableCmd(PrintCmd):
 
580
 
 
581
    def run(self, clients, bus=None, mandos=None):
 
582
        print(self.output(clients.values()))
 
583
 
 
584
    def output(self, clients):
 
585
        raise NotImplementedError()
 
586
 
 
587
 
 
588
class DumpJSONCmd(OutputCmd):
 
589
    def output(self, clients):
 
590
        data = {client["Name"]:
 
591
                {key: self.dbus_boolean_to_bool(client[key])
 
592
                 for key in self.all_keywords}
 
593
                for client in clients.values()}
 
594
        return json.dumps(data, indent=4, separators=(',', ': '))
 
595
 
 
596
    @staticmethod
 
597
    def dbus_boolean_to_bool(value):
 
598
        if isinstance(value, dbus.Boolean):
 
599
            value = bool(value)
 
600
        return value
 
601
 
 
602
 
 
603
class PrintTableCmd(OutputCmd):
322
604
    def __init__(self, verbose=False):
323
605
        self.verbose = verbose
324
606
 
325
607
    def output(self, clients):
 
608
        default_keywords = ("Name", "Enabled", "Timeout",
 
609
                            "LastCheckedOK")
 
610
        keywords = default_keywords
326
611
        if self.verbose:
327
612
            keywords = self.all_keywords
328
 
        else:
329
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
330
 
        return str(self.TableOfClients(clients.values(), keywords))
 
613
        return str(self.TableOfClients(clients, keywords))
331
614
 
332
615
    class TableOfClients(object):
333
616
        tableheaders = {
386
669
        def string_from_client(self, client, key):
387
670
            return self.valuetostring(client[key], key)
388
671
 
389
 
        @staticmethod
390
 
        def valuetostring(value, keyword):
 
672
        @classmethod
 
673
        def valuetostring(cls, value, keyword):
391
674
            if isinstance(value, dbus.Boolean):
392
675
                return "Yes" if value else "No"
393
676
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
394
677
                           "ApprovalDuration", "ExtendedTimeout"):
395
 
                return milliseconds_to_string(value)
 
678
                return cls.milliseconds_to_string(value)
396
679
            return str(value)
397
680
 
398
681
        def header_line(self, format_string):
403
686
                **{key: self.string_from_client(client, key)
404
687
                   for key in self.keywords})
405
688
 
406
 
 
407
 
 
408
 
class DumpJSONCmd(PrintCmd):
409
 
    def output(self, clients):
410
 
        data = {client["Name"]:
411
 
                {key: self.dbus_boolean_to_bool(client[key])
412
 
                 for key in self.all_keywords}
413
 
                for client in clients.values()}
414
 
        return json.dumps(data, indent=4, separators=(',', ': '))
415
 
    @staticmethod
416
 
    def dbus_boolean_to_bool(value):
417
 
        if isinstance(value, dbus.Boolean):
418
 
            value = bool(value)
419
 
        return value
420
 
 
421
 
class IsEnabledCmd(Command):
422
 
    def run_on_one_client(self, client):
423
 
        if self.is_enabled(client):
424
 
            sys.exit(0)
425
 
        sys.exit(1)
426
 
    def is_enabled(self, client):
427
 
        return client.Get(client_interface, "Enabled",
428
 
                          dbus_interface=dbus.PROPERTIES_IFACE)
429
 
 
430
 
class RemoveCmd(Command):
431
 
    def run_on_one_client(self, client):
432
 
        self.mandos.RemoveClient(client.__dbus_object_path__)
433
 
 
434
 
class ApproveCmd(Command):
435
 
    def run_on_one_client(self, client):
436
 
        client.Approve(dbus.Boolean(True),
437
 
                       dbus_interface=client_interface)
438
 
 
439
 
class DenyCmd(Command):
440
 
    def run_on_one_client(self, client):
441
 
        client.Approve(dbus.Boolean(False),
442
 
                       dbus_interface=client_interface)
 
689
        @staticmethod
 
690
        def milliseconds_to_string(ms):
 
691
            td = datetime.timedelta(0, 0, 0, ms)
 
692
            return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
693
                    .format(days="{}T".format(td.days)
 
694
                            if td.days else "",
 
695
                            hours=td.seconds // 3600,
 
696
                            minutes=(td.seconds % 3600) // 60,
 
697
                            seconds=td.seconds % 60))
 
698
 
 
699
 
 
700
class PropertyCmd(Command):
 
701
    """Abstract class for Actions for setting one client property"""
 
702
 
 
703
    def run_on_one_client(self, client, properties):
 
704
        """Set the Client's D-Bus property"""
 
705
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
706
                  client.__dbus_object_path__,
 
707
                  dbus.PROPERTIES_IFACE, client_dbus_interface,
 
708
                  self.propname, self.value_to_set
 
709
                  if not isinstance(self.value_to_set, dbus.Boolean)
 
710
                  else bool(self.value_to_set))
 
711
        client.Set(client_dbus_interface, self.propname,
 
712
                   self.value_to_set,
 
713
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
714
 
 
715
    @property
 
716
    def propname(self):
 
717
        raise NotImplementedError()
 
718
 
443
719
 
444
720
class EnableCmd(PropertyCmd):
445
 
    property = "Enabled"
 
721
    propname = "Enabled"
446
722
    value_to_set = dbus.Boolean(True)
447
723
 
 
724
 
448
725
class DisableCmd(PropertyCmd):
449
 
    property = "Enabled"
 
726
    propname = "Enabled"
450
727
    value_to_set = dbus.Boolean(False)
451
728
 
 
729
 
452
730
class BumpTimeoutCmd(PropertyCmd):
453
 
    property = "LastCheckedOK"
 
731
    propname = "LastCheckedOK"
454
732
    value_to_set = ""
455
733
 
 
734
 
456
735
class StartCheckerCmd(PropertyCmd):
457
 
    property = "CheckerRunning"
 
736
    propname = "CheckerRunning"
458
737
    value_to_set = dbus.Boolean(True)
459
738
 
 
739
 
460
740
class StopCheckerCmd(PropertyCmd):
461
 
    property = "CheckerRunning"
 
741
    propname = "CheckerRunning"
462
742
    value_to_set = dbus.Boolean(False)
463
743
 
 
744
 
464
745
class ApproveByDefaultCmd(PropertyCmd):
465
 
    property = "ApprovedByDefault"
 
746
    propname = "ApprovedByDefault"
466
747
    value_to_set = dbus.Boolean(True)
467
748
 
 
749
 
468
750
class DenyByDefaultCmd(PropertyCmd):
469
 
    property = "ApprovedByDefault"
 
751
    propname = "ApprovedByDefault"
470
752
    value_to_set = dbus.Boolean(False)
471
753
 
472
 
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
473
 
    property = "Checker"
474
 
 
475
 
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
476
 
    property = "Host"
477
 
 
478
 
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
479
 
    property = "Secret"
480
 
 
481
 
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
482
 
    property = "Timeout"
483
 
 
484
 
class SetExtendedTimeoutCmd(PropertyCmd,
485
 
                            MillisecondsValueArgumentMixIn):
486
 
    property = "ExtendedTimeout"
487
 
 
488
 
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
489
 
    property = "Interval"
490
 
 
491
 
class SetApprovalDelayCmd(PropertyCmd,
492
 
                          MillisecondsValueArgumentMixIn):
493
 
    property = "ApprovalDelay"
494
 
 
495
 
class SetApprovalDurationCmd(PropertyCmd,
496
 
                             MillisecondsValueArgumentMixIn):
497
 
    property = "ApprovalDuration"
498
 
 
499
 
def has_actions(options):
500
 
    return any((options.enable,
501
 
                options.disable,
502
 
                options.bump_timeout,
503
 
                options.start_checker,
504
 
                options.stop_checker,
505
 
                options.is_enabled,
506
 
                options.remove,
507
 
                options.checker is not None,
508
 
                options.timeout is not None,
509
 
                options.extended_timeout is not None,
510
 
                options.interval is not None,
511
 
                options.approved_by_default is not None,
512
 
                options.approval_delay is not None,
513
 
                options.approval_duration is not None,
514
 
                options.host is not None,
515
 
                options.secret is not None,
516
 
                options.approve,
517
 
                options.deny))
518
 
 
519
 
def add_command_line_options(parser):
520
 
    parser.add_argument("--version", action="version",
521
 
                        version="%(prog)s {}".format(version),
522
 
                        help="show version number and exit")
523
 
    parser.add_argument("-a", "--all", action="store_true",
524
 
                        help="Select all clients")
525
 
    parser.add_argument("-v", "--verbose", action="store_true",
526
 
                        help="Print all fields")
527
 
    parser.add_argument("-j", "--dump-json", action="store_true",
528
 
                        help="Dump client data in JSON format")
529
 
    enable_disable = parser.add_mutually_exclusive_group()
530
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
531
 
                                help="Enable client")
532
 
    enable_disable.add_argument("-d", "--disable",
533
 
                                action="store_true",
534
 
                                help="disable client")
535
 
    parser.add_argument("-b", "--bump-timeout", action="store_true",
536
 
                        help="Bump timeout for client")
537
 
    start_stop_checker = parser.add_mutually_exclusive_group()
538
 
    start_stop_checker.add_argument("--start-checker",
539
 
                                    action="store_true",
540
 
                                    help="Start checker for client")
541
 
    start_stop_checker.add_argument("--stop-checker",
542
 
                                    action="store_true",
543
 
                                    help="Stop checker for client")
544
 
    parser.add_argument("-V", "--is-enabled", action="store_true",
545
 
                        help="Check if client is enabled")
546
 
    parser.add_argument("-r", "--remove", action="store_true",
547
 
                        help="Remove client")
548
 
    parser.add_argument("-c", "--checker",
549
 
                        help="Set checker command for client")
550
 
    parser.add_argument("-t", "--timeout",
551
 
                        help="Set timeout for client")
552
 
    parser.add_argument("--extended-timeout",
553
 
                        help="Set extended timeout for client")
554
 
    parser.add_argument("-i", "--interval",
555
 
                        help="Set checker interval for client")
556
 
    approve_deny_default = parser.add_mutually_exclusive_group()
557
 
    approve_deny_default.add_argument(
558
 
        "--approve-by-default", action="store_true",
559
 
        default=None, dest="approved_by_default",
560
 
        help="Set client to be approved by default")
561
 
    approve_deny_default.add_argument(
562
 
        "--deny-by-default", action="store_false",
563
 
        dest="approved_by_default",
564
 
        help="Set client to be denied by default")
565
 
    parser.add_argument("--approval-delay",
566
 
                        help="Set delay before client approve/deny")
567
 
    parser.add_argument("--approval-duration",
568
 
                        help="Set duration of one client approval")
569
 
    parser.add_argument("-H", "--host", help="Set host for client")
570
 
    parser.add_argument("-s", "--secret",
571
 
                        type=argparse.FileType(mode="rb"),
572
 
                        help="Set password blob (file) for client")
573
 
    approve_deny = parser.add_mutually_exclusive_group()
574
 
    approve_deny.add_argument(
575
 
        "-A", "--approve", action="store_true",
576
 
        help="Approve any current client request")
577
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
578
 
                              help="Deny any current client request")
579
 
    parser.add_argument("--check", action="store_true",
580
 
                        help="Run self-test")
581
 
    parser.add_argument("client", nargs="*", help="Client name")
582
 
 
583
 
 
584
 
def commands_and_clients_from_options(options):
585
 
 
586
 
    commands = []
587
 
 
588
 
    if options.dump_json:
589
 
        commands.append(DumpJSONCmd())
590
 
 
591
 
    if options.enable:
592
 
        commands.append(EnableCmd())
593
 
 
594
 
    if options.disable:
595
 
        commands.append(DisableCmd())
596
 
 
597
 
    if options.bump_timeout:
598
 
        commands.append(BumpTimeoutCmd(options.bump_timeout))
599
 
 
600
 
    if options.start_checker:
601
 
        commands.append(StartCheckerCmd())
602
 
 
603
 
    if options.stop_checker:
604
 
        commands.append(StopCheckerCmd())
605
 
 
606
 
    if options.is_enabled:
607
 
        commands.append(IsEnabledCmd())
608
 
 
609
 
    if options.remove:
610
 
        commands.append(RemoveCmd())
611
 
 
612
 
    if options.checker is not None:
613
 
        commands.append(SetCheckerCmd())
614
 
 
615
 
    if options.timeout is not None:
616
 
        commands.append(SetTimeoutCmd(options.timeout))
617
 
 
618
 
    if options.extended_timeout:
619
 
        commands.append(
620
 
            SetExtendedTimeoutCmd(options.extended_timeout))
621
 
 
622
 
    if options.interval is not None:
623
 
        command.append(SetIntervalCmd(options.interval))
624
 
 
625
 
    if options.approved_by_default is not None:
626
 
        if options.approved_by_default:
627
 
            command.append(ApproveByDefaultCmd())
628
 
        else:
629
 
            command.append(DenyByDefaultCmd())
630
 
 
631
 
    if options.approval_delay is not None:
632
 
        command.append(SetApprovalDelayCmd(options.approval_delay))
633
 
 
634
 
    if options.approval_duration is not None:
635
 
        command.append(
636
 
            SetApprovalDurationCmd(options.approval_duration))
637
 
 
638
 
    if options.host is not None:
639
 
        command.append(SetHostCmd(options.host))
640
 
 
641
 
    if options.secret is not None:
642
 
        command.append(SetSecretCmd(options.secret))
643
 
 
644
 
    if options.approve:
645
 
        commands.append(ApproveCmd())
646
 
 
647
 
    if options.deny:
648
 
        commands.append(DenyCmd())
649
 
 
650
 
    # If no command option has been given, show table of clients,
651
 
    # optionally verbosely
652
 
    if not commands:
653
 
        commands.append(PrintTableCmd(verbose=options.verbose))
654
 
 
655
 
    return commands, options.client
656
 
 
657
 
 
658
 
def main():
659
 
    parser = argparse.ArgumentParser()
660
 
 
661
 
    add_command_line_options(parser)
662
 
 
663
 
    options = parser.parse_args()
664
 
 
665
 
    if has_actions(options) and not (options.client or options.all):
666
 
        parser.error("Options require clients names or --all.")
667
 
    if options.verbose and has_actions(options):
668
 
        parser.error("--verbose can only be used alone.")
669
 
    if options.dump_json and (options.verbose
670
 
                              or has_actions(options)):
671
 
        parser.error("--dump-json can only be used alone.")
672
 
    if options.all and not has_actions(options):
673
 
        parser.error("--all requires an action.")
674
 
    if options.is_enabled and len(options.client) > 1:
675
 
        parser.error("--is-enabled requires exactly one client")
676
 
 
677
 
    commands, clientnames = commands_and_clients_from_options(options)
678
 
 
679
 
    try:
680
 
        bus = dbus.SystemBus()
681
 
        mandos_dbus_objc = bus.get_object(busname, server_path)
682
 
    except dbus.exceptions.DBusException:
683
 
        log.critical("Could not connect to Mandos server")
684
 
        sys.exit(1)
685
 
 
686
 
    mandos_serv = dbus.Interface(mandos_dbus_objc,
687
 
                                 dbus_interface=server_interface)
688
 
    mandos_serv_object_manager = dbus.Interface(
689
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
690
 
 
691
 
    # Filter out log message from dbus module
692
 
    dbus_logger = logging.getLogger("dbus.proxies")
693
 
    class NullFilter(logging.Filter):
694
 
        def filter(self, record):
695
 
            return False
696
 
    dbus_filter = NullFilter()
697
 
    try:
698
 
        dbus_logger.addFilter(dbus_filter)
699
 
        mandos_clients = {path: ifs_and_props[client_interface]
700
 
                          for path, ifs_and_props in
701
 
                          mandos_serv_object_manager
702
 
                          .GetManagedObjects().items()
703
 
                          if client_interface in ifs_and_props}
704
 
    except dbus.exceptions.DBusException as e:
705
 
        log.critical("Failed to access Mandos server through D-Bus:"
706
 
                     "\n%s", e)
707
 
        sys.exit(1)
708
 
    finally:
709
 
        # restore dbus logger
710
 
        dbus_logger.removeFilter(dbus_filter)
711
 
 
712
 
    # Compile dict of (clients: properties) to process
713
 
    clients = {}
714
 
 
715
 
    if not clientnames:
716
 
        clients = {bus.get_object(busname, path): properties
717
 
                   for path, properties in mandos_clients.items()}
718
 
    else:
719
 
        for name in clientnames:
720
 
            for path, client in mandos_clients.items():
721
 
                if client["Name"] == name:
722
 
                    client_objc = bus.get_object(busname, path)
723
 
                    clients[client_objc] = client
724
 
                    break
725
 
            else:
726
 
                log.critical("Client not found on server: %r", name)
727
 
                sys.exit(1)
728
 
 
729
 
    # Run all commands on clients
730
 
    for command in commands:
731
 
        command.run(mandos_serv, clients)
 
754
 
 
755
class PropertyValueCmd(PropertyCmd):
 
756
    """Abstract class for PropertyCmd recieving a value as argument"""
 
757
    def __init__(self, value):
 
758
        self.value_to_set = value
 
759
 
 
760
 
 
761
class SetCheckerCmd(PropertyValueCmd):
 
762
    propname = "Checker"
 
763
 
 
764
 
 
765
class SetHostCmd(PropertyValueCmd):
 
766
    propname = "Host"
 
767
 
 
768
 
 
769
class SetSecretCmd(PropertyValueCmd):
 
770
    propname = "Secret"
 
771
 
 
772
    @property
 
773
    def value_to_set(self):
 
774
        return self._vts
 
775
 
 
776
    @value_to_set.setter
 
777
    def value_to_set(self, value):
 
778
        """When setting, read data from supplied file object"""
 
779
        self._vts = value.read()
 
780
        value.close()
 
781
 
 
782
 
 
783
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
 
784
    """Abstract class for PropertyValueCmd taking a value argument as
 
785
a datetime.timedelta() but should store it as milliseconds."""
 
786
 
 
787
    @property
 
788
    def value_to_set(self):
 
789
        return self._vts
 
790
 
 
791
    @value_to_set.setter
 
792
    def value_to_set(self, value):
 
793
        """When setting, convert value from a datetime.timedelta"""
 
794
        self._vts = int(round(value.total_seconds() * 1000))
 
795
 
 
796
 
 
797
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
798
    propname = "Timeout"
 
799
 
 
800
 
 
801
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
802
    propname = "ExtendedTimeout"
 
803
 
 
804
 
 
805
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
 
806
    propname = "Interval"
 
807
 
 
808
 
 
809
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
 
810
    propname = "ApprovalDelay"
 
811
 
 
812
 
 
813
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
 
814
    propname = "ApprovalDuration"
 
815
 
732
816
 
733
817
 
734
 
class Test_milliseconds_to_string(unittest.TestCase):
735
 
    def test_all(self):
736
 
        self.assertEqual(milliseconds_to_string(93785000),
737
 
                         "1T02:03:05")
738
 
    def test_no_days(self):
739
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
740
 
    def test_all_zero(self):
741
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
742
 
    def test_no_fractional_seconds(self):
743
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
744
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
745
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
746
 
 
747
818
class Test_string_to_delta(unittest.TestCase):
748
819
    def test_handles_basic_rfc3339(self):
 
820
        self.assertEqual(string_to_delta("PT0S"),
 
821
                         datetime.timedelta())
 
822
        self.assertEqual(string_to_delta("P0D"),
 
823
                         datetime.timedelta())
 
824
        self.assertEqual(string_to_delta("PT1S"),
 
825
                         datetime.timedelta(0, 1))
749
826
        self.assertEqual(string_to_delta("PT2H"),
750
827
                         datetime.timedelta(0, 7200))
 
828
 
751
829
    def test_falls_back_to_pre_1_6_1_with_warning(self):
752
830
        # assertLogs only exists in Python 3.4
753
831
        if hasattr(self, "assertLogs"):
771
849
        self.assertEqual(value, datetime.timedelta(0, 7200))
772
850
 
773
851
 
 
852
class Test_check_option_syntax(unittest.TestCase):
 
853
    def setUp(self):
 
854
        self.parser = argparse.ArgumentParser()
 
855
        add_command_line_options(self.parser)
 
856
 
 
857
    def test_actions_requires_client_or_all(self):
 
858
        for action, value in self.actions.items():
 
859
            options = self.parser.parse_args()
 
860
            setattr(options, action, value)
 
861
            with self.assertParseError():
 
862
                self.check_option_syntax(options)
 
863
 
 
864
    # This mostly corresponds to the definition from has_actions() in
 
865
    # check_option_syntax()
 
866
    actions = {
 
867
        # The actual values set here are not that important, but we do
 
868
        # at least stick to the correct types, even though they are
 
869
        # never used
 
870
        "enable": True,
 
871
        "disable": True,
 
872
        "bump_timeout": True,
 
873
        "start_checker": True,
 
874
        "stop_checker": True,
 
875
        "is_enabled": True,
 
876
        "remove": True,
 
877
        "checker": "x",
 
878
        "timeout": datetime.timedelta(),
 
879
        "extended_timeout": datetime.timedelta(),
 
880
        "interval": datetime.timedelta(),
 
881
        "approved_by_default": True,
 
882
        "approval_delay": datetime.timedelta(),
 
883
        "approval_duration": datetime.timedelta(),
 
884
        "host": "x",
 
885
        "secret": io.BytesIO(b"x"),
 
886
        "approve": True,
 
887
        "deny": True,
 
888
    }
 
889
 
 
890
    @contextlib.contextmanager
 
891
    def assertParseError(self):
 
892
        with self.assertRaises(SystemExit) as e:
 
893
            with self.temporarily_suppress_stderr():
 
894
                yield
 
895
        # Exit code from argparse is guaranteed to be "2".  Reference:
 
896
        # https://docs.python.org/3/library
 
897
        # /argparse.html#exiting-methods
 
898
        self.assertEqual(e.exception.code, 2)
 
899
 
 
900
    @staticmethod
 
901
    @contextlib.contextmanager
 
902
    def temporarily_suppress_stderr():
 
903
        null = os.open(os.path.devnull, os.O_RDWR)
 
904
        stderrcopy = os.dup(sys.stderr.fileno())
 
905
        os.dup2(null, sys.stderr.fileno())
 
906
        os.close(null)
 
907
        try:
 
908
            yield
 
909
        finally:
 
910
            # restore stderr
 
911
            os.dup2(stderrcopy, sys.stderr.fileno())
 
912
            os.close(stderrcopy)
 
913
 
 
914
    def check_option_syntax(self, options):
 
915
        check_option_syntax(self.parser, options)
 
916
 
 
917
    def test_actions_conflicts_with_verbose(self):
 
918
        for action, value in self.actions.items():
 
919
            options = self.parser.parse_args()
 
920
            setattr(options, action, value)
 
921
            options.verbose = True
 
922
            with self.assertParseError():
 
923
                self.check_option_syntax(options)
 
924
 
 
925
    def test_dump_json_conflicts_with_verbose(self):
 
926
        options = self.parser.parse_args()
 
927
        options.dump_json = True
 
928
        options.verbose = True
 
929
        with self.assertParseError():
 
930
            self.check_option_syntax(options)
 
931
 
 
932
    def test_dump_json_conflicts_with_action(self):
 
933
        for action, value in self.actions.items():
 
934
            options = self.parser.parse_args()
 
935
            setattr(options, action, value)
 
936
            options.dump_json = True
 
937
            with self.assertParseError():
 
938
                self.check_option_syntax(options)
 
939
 
 
940
    def test_all_can_not_be_alone(self):
 
941
        options = self.parser.parse_args()
 
942
        options.all = True
 
943
        with self.assertParseError():
 
944
            self.check_option_syntax(options)
 
945
 
 
946
    def test_all_is_ok_with_any_action(self):
 
947
        for action, value in self.actions.items():
 
948
            options = self.parser.parse_args()
 
949
            setattr(options, action, value)
 
950
            options.all = True
 
951
            self.check_option_syntax(options)
 
952
 
 
953
    def test_is_enabled_fails_without_client(self):
 
954
        options = self.parser.parse_args()
 
955
        options.is_enabled = True
 
956
        with self.assertParseError():
 
957
            self.check_option_syntax(options)
 
958
 
 
959
    def test_is_enabled_works_with_one_client(self):
 
960
        options = self.parser.parse_args()
 
961
        options.is_enabled = True
 
962
        options.client = ["foo"]
 
963
        self.check_option_syntax(options)
 
964
 
 
965
    def test_is_enabled_fails_with_two_clients(self):
 
966
        options = self.parser.parse_args()
 
967
        options.is_enabled = True
 
968
        options.client = ["foo", "barbar"]
 
969
        with self.assertParseError():
 
970
            self.check_option_syntax(options)
 
971
 
 
972
    def test_remove_can_only_be_combined_with_action_deny(self):
 
973
        for action, value in self.actions.items():
 
974
            if action in {"remove", "deny"}:
 
975
                continue
 
976
            options = self.parser.parse_args()
 
977
            setattr(options, action, value)
 
978
            options.all = True
 
979
            options.remove = True
 
980
            with self.assertParseError():
 
981
                self.check_option_syntax(options)
 
982
 
 
983
 
 
984
class Test_commands_from_options(unittest.TestCase):
 
985
    def setUp(self):
 
986
        self.parser = argparse.ArgumentParser()
 
987
        add_command_line_options(self.parser)
 
988
 
 
989
    def test_is_enabled(self):
 
990
        self.assert_command_from_args(["--is-enabled", "foo"],
 
991
                                      IsEnabledCmd)
 
992
 
 
993
    def assert_command_from_args(self, args, command_cls,
 
994
                                 **cmd_attrs):
 
995
        """Assert that parsing ARGS should result in an instance of
 
996
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
 
997
        options = self.parser.parse_args(args)
 
998
        check_option_syntax(self.parser, options)
 
999
        commands = commands_from_options(options)
 
1000
        self.assertEqual(len(commands), 1)
 
1001
        command = commands[0]
 
1002
        self.assertIsInstance(command, command_cls)
 
1003
        for key, value in cmd_attrs.items():
 
1004
            self.assertEqual(getattr(command, key), value)
 
1005
 
 
1006
    def test_is_enabled_short(self):
 
1007
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
 
1008
 
 
1009
    def test_approve(self):
 
1010
        self.assert_command_from_args(["--approve", "foo"],
 
1011
                                      ApproveCmd)
 
1012
 
 
1013
    def test_approve_short(self):
 
1014
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
 
1015
 
 
1016
    def test_deny(self):
 
1017
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
 
1018
 
 
1019
    def test_deny_short(self):
 
1020
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
 
1021
 
 
1022
    def test_remove(self):
 
1023
        self.assert_command_from_args(["--remove", "foo"],
 
1024
                                      RemoveCmd)
 
1025
 
 
1026
    def test_deny_before_remove(self):
 
1027
        options = self.parser.parse_args(["--deny", "--remove",
 
1028
                                          "foo"])
 
1029
        check_option_syntax(self.parser, options)
 
1030
        commands = commands_from_options(options)
 
1031
        self.assertEqual(len(commands), 2)
 
1032
        self.assertIsInstance(commands[0], DenyCmd)
 
1033
        self.assertIsInstance(commands[1], RemoveCmd)
 
1034
 
 
1035
    def test_deny_before_remove_reversed(self):
 
1036
        options = self.parser.parse_args(["--remove", "--deny",
 
1037
                                          "--all"])
 
1038
        check_option_syntax(self.parser, options)
 
1039
        commands = commands_from_options(options)
 
1040
        self.assertEqual(len(commands), 2)
 
1041
        self.assertIsInstance(commands[0], DenyCmd)
 
1042
        self.assertIsInstance(commands[1], RemoveCmd)
 
1043
 
 
1044
    def test_remove_short(self):
 
1045
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
 
1046
 
 
1047
    def test_dump_json(self):
 
1048
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
 
1049
 
 
1050
    def test_enable(self):
 
1051
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
 
1052
 
 
1053
    def test_enable_short(self):
 
1054
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
 
1055
 
 
1056
    def test_disable(self):
 
1057
        self.assert_command_from_args(["--disable", "foo"],
 
1058
                                      DisableCmd)
 
1059
 
 
1060
    def test_disable_short(self):
 
1061
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
 
1062
 
 
1063
    def test_bump_timeout(self):
 
1064
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1065
                                      BumpTimeoutCmd)
 
1066
 
 
1067
    def test_bump_timeout_short(self):
 
1068
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
 
1069
 
 
1070
    def test_start_checker(self):
 
1071
        self.assert_command_from_args(["--start-checker", "foo"],
 
1072
                                      StartCheckerCmd)
 
1073
 
 
1074
    def test_stop_checker(self):
 
1075
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1076
                                      StopCheckerCmd)
 
1077
 
 
1078
    def test_approve_by_default(self):
 
1079
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1080
                                      ApproveByDefaultCmd)
 
1081
 
 
1082
    def test_deny_by_default(self):
 
1083
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1084
                                      DenyByDefaultCmd)
 
1085
 
 
1086
    def test_checker(self):
 
1087
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1088
                                      SetCheckerCmd, value_to_set=":")
 
1089
 
 
1090
    def test_checker_empty(self):
 
1091
        self.assert_command_from_args(["--checker", "", "foo"],
 
1092
                                      SetCheckerCmd, value_to_set="")
 
1093
 
 
1094
    def test_checker_short(self):
 
1095
        self.assert_command_from_args(["-c", ":", "foo"],
 
1096
                                      SetCheckerCmd, value_to_set=":")
 
1097
 
 
1098
    def test_host(self):
 
1099
        self.assert_command_from_args(["--host", "foo.example.org",
 
1100
                                       "foo"], SetHostCmd,
 
1101
                                      value_to_set="foo.example.org")
 
1102
 
 
1103
    def test_host_short(self):
 
1104
        self.assert_command_from_args(["-H", "foo.example.org",
 
1105
                                       "foo"], SetHostCmd,
 
1106
                                      value_to_set="foo.example.org")
 
1107
 
 
1108
    def test_secret_devnull(self):
 
1109
        self.assert_command_from_args(["--secret", os.path.devnull,
 
1110
                                       "foo"], SetSecretCmd,
 
1111
                                      value_to_set=b"")
 
1112
 
 
1113
    def test_secret_tempfile(self):
 
1114
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1115
            value = b"secret\0xyzzy\nbar"
 
1116
            f.write(value)
 
1117
            f.seek(0)
 
1118
            self.assert_command_from_args(["--secret", f.name,
 
1119
                                           "foo"], SetSecretCmd,
 
1120
                                          value_to_set=value)
 
1121
 
 
1122
    def test_secret_devnull_short(self):
 
1123
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1124
                                      SetSecretCmd, value_to_set=b"")
 
1125
 
 
1126
    def test_secret_tempfile_short(self):
 
1127
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1128
            value = b"secret\0xyzzy\nbar"
 
1129
            f.write(value)
 
1130
            f.seek(0)
 
1131
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1132
                                          SetSecretCmd,
 
1133
                                          value_to_set=value)
 
1134
 
 
1135
    def test_timeout(self):
 
1136
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1137
                                      SetTimeoutCmd,
 
1138
                                      value_to_set=300000)
 
1139
 
 
1140
    def test_timeout_short(self):
 
1141
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1142
                                      SetTimeoutCmd,
 
1143
                                      value_to_set=300000)
 
1144
 
 
1145
    def test_extended_timeout(self):
 
1146
        self.assert_command_from_args(["--extended-timeout", "PT15M",
 
1147
                                       "foo"],
 
1148
                                      SetExtendedTimeoutCmd,
 
1149
                                      value_to_set=900000)
 
1150
 
 
1151
    def test_interval(self):
 
1152
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1153
                                      SetIntervalCmd,
 
1154
                                      value_to_set=120000)
 
1155
 
 
1156
    def test_interval_short(self):
 
1157
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1158
                                      SetIntervalCmd,
 
1159
                                      value_to_set=120000)
 
1160
 
 
1161
    def test_approval_delay(self):
 
1162
        self.assert_command_from_args(["--approval-delay", "PT30S",
 
1163
                                       "foo"], SetApprovalDelayCmd,
 
1164
                                      value_to_set=30000)
 
1165
 
 
1166
    def test_approval_duration(self):
 
1167
        self.assert_command_from_args(["--approval-duration", "PT1S",
 
1168
                                       "foo"], SetApprovalDurationCmd,
 
1169
                                      value_to_set=1000)
 
1170
 
 
1171
    def test_print_table(self):
 
1172
        self.assert_command_from_args([], PrintTableCmd,
 
1173
                                      verbose=False)
 
1174
 
 
1175
    def test_print_table_verbose(self):
 
1176
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
 
1177
                                      verbose=True)
 
1178
 
 
1179
    def test_print_table_verbose_short(self):
 
1180
        self.assert_command_from_args(["-v"], PrintTableCmd,
 
1181
                                      verbose=True)
 
1182
 
 
1183
 
774
1184
class TestCmd(unittest.TestCase):
775
1185
    """Abstract class for tests of command classes"""
 
1186
 
776
1187
    def setUp(self):
777
1188
        testcase = self
778
1189
        class MockClient(object):
779
1190
            def __init__(self, name, **attributes):
780
 
                self.__dbus_object_path__ = "objpath_{}".format(name)
 
1191
                self.__dbus_object_path__ = "/clients/{}".format(name)
781
1192
                self.attributes = attributes
782
1193
                self.attributes["Name"] = name
783
1194
                self.calls = []
784
 
            def Set(self, interface, property, value, dbus_interface):
785
 
                testcase.assertEqual(interface, client_interface)
786
 
                testcase.assertEqual(dbus_interface,
787
 
                                     dbus.PROPERTIES_IFACE)
788
 
                self.attributes[property] = value
789
 
                self.calls.append(("Set", (interface, property, value,
790
 
                                           dbus_interface)))
791
 
            def Get(self, interface, property, dbus_interface):
792
 
                testcase.assertEqual(interface, client_interface)
793
 
                testcase.assertEqual(dbus_interface,
794
 
                                     dbus.PROPERTIES_IFACE)
795
 
                self.calls.append(("Get", (interface, property,
796
 
                                           dbus_interface)))
797
 
                return self.attributes[property]
798
 
            def __getitem__(self, key):
799
 
                return self.attributes[key]
800
 
            def __setitem__(self, key, value):
801
 
                self.attributes[key] = value
802
 
        self.clients = collections.OrderedDict([
803
 
            ("foo",
804
 
             MockClient(
805
 
                 "foo",
806
 
                 KeyID=("92ed150794387c03ce684574b1139a65"
807
 
                        "94a34f895daaaf09fd8ea90a27cddb12"),
808
 
                 Secret=b"secret",
809
 
                 Host="foo.example.org",
810
 
                 Enabled=dbus.Boolean(True),
811
 
                 Timeout=300000,
812
 
                 LastCheckedOK="2019-02-03T00:00:00",
813
 
                 Created="2019-01-02T00:00:00",
814
 
                 Interval=120000,
815
 
                 Fingerprint=("778827225BA7DE539C5A"
816
 
                              "7CFA59CFF7CDBD9A5920"),
817
 
                 CheckerRunning=dbus.Boolean(False),
818
 
                 LastEnabled="2019-01-03T00:00:00",
819
 
                 ApprovalPending=dbus.Boolean(False),
820
 
                 ApprovedByDefault=dbus.Boolean(True),
821
 
                 LastApprovalRequest="",
822
 
                 ApprovalDelay=0,
823
 
                 ApprovalDuration=1000,
824
 
                 Checker="fping -q -- %(host)s",
825
 
                 ExtendedTimeout=900000,
826
 
                 Expires="2019-02-04T00:00:00",
827
 
                 LastCheckerStatus=0)),
828
 
            ("barbar",
829
 
             MockClient(
830
 
                 "barbar",
831
 
                 KeyID=("0558568eedd67d622f5c83b35a115f79"
832
 
                        "6ab612cff5ad227247e46c2b020f441c"),
833
 
                 Secret=b"secretbar",
834
 
                 Host="192.0.2.3",
835
 
                 Enabled=dbus.Boolean(True),
836
 
                 Timeout=300000,
837
 
                 LastCheckedOK="2019-02-04T00:00:00",
838
 
                 Created="2019-01-03T00:00:00",
839
 
                 Interval=120000,
840
 
                 Fingerprint=("3E393AEAEFB84C7E89E2"
841
 
                              "F547B3A107558FCA3A27"),
842
 
                 CheckerRunning=dbus.Boolean(True),
843
 
                 LastEnabled="2019-01-04T00:00:00",
844
 
                 ApprovalPending=dbus.Boolean(False),
845
 
                 ApprovedByDefault=dbus.Boolean(False),
846
 
                 LastApprovalRequest="2019-01-03T00:00:00",
847
 
                 ApprovalDelay=30000,
848
 
                 ApprovalDuration=1000,
849
 
                 Checker=":",
850
 
                 ExtendedTimeout=900000,
851
 
                 Expires="2019-02-05T00:00:00",
852
 
                 LastCheckerStatus=-2)),
 
1195
            def Set(self, interface, propname, value, dbus_interface):
 
1196
                testcase.assertEqual(interface, client_dbus_interface)
 
1197
                testcase.assertEqual(dbus_interface,
 
1198
                                     dbus.PROPERTIES_IFACE)
 
1199
                self.attributes[propname] = value
 
1200
            def Get(self, interface, propname, dbus_interface):
 
1201
                testcase.assertEqual(interface, client_dbus_interface)
 
1202
                testcase.assertEqual(dbus_interface,
 
1203
                                     dbus.PROPERTIES_IFACE)
 
1204
                return self.attributes[propname]
 
1205
            def Approve(self, approve, dbus_interface):
 
1206
                testcase.assertEqual(dbus_interface,
 
1207
                                     client_dbus_interface)
 
1208
                self.calls.append(("Approve", (approve,
 
1209
                                               dbus_interface)))
 
1210
        self.client = MockClient(
 
1211
            "foo",
 
1212
            KeyID=("92ed150794387c03ce684574b1139a65"
 
1213
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
1214
            Secret=b"secret",
 
1215
            Host="foo.example.org",
 
1216
            Enabled=dbus.Boolean(True),
 
1217
            Timeout=300000,
 
1218
            LastCheckedOK="2019-02-03T00:00:00",
 
1219
            Created="2019-01-02T00:00:00",
 
1220
            Interval=120000,
 
1221
            Fingerprint=("778827225BA7DE539C5A"
 
1222
                         "7CFA59CFF7CDBD9A5920"),
 
1223
            CheckerRunning=dbus.Boolean(False),
 
1224
            LastEnabled="2019-01-03T00:00:00",
 
1225
            ApprovalPending=dbus.Boolean(False),
 
1226
            ApprovedByDefault=dbus.Boolean(True),
 
1227
            LastApprovalRequest="",
 
1228
            ApprovalDelay=0,
 
1229
            ApprovalDuration=1000,
 
1230
            Checker="fping -q -- %(host)s",
 
1231
            ExtendedTimeout=900000,
 
1232
            Expires="2019-02-04T00:00:00",
 
1233
            LastCheckerStatus=0)
 
1234
        self.other_client = MockClient(
 
1235
            "barbar",
 
1236
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
1237
                   "6ab612cff5ad227247e46c2b020f441c"),
 
1238
            Secret=b"secretbar",
 
1239
            Host="192.0.2.3",
 
1240
            Enabled=dbus.Boolean(True),
 
1241
            Timeout=300000,
 
1242
            LastCheckedOK="2019-02-04T00:00:00",
 
1243
            Created="2019-01-03T00:00:00",
 
1244
            Interval=120000,
 
1245
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
1246
                         "F547B3A107558FCA3A27"),
 
1247
            CheckerRunning=dbus.Boolean(True),
 
1248
            LastEnabled="2019-01-04T00:00:00",
 
1249
            ApprovalPending=dbus.Boolean(False),
 
1250
            ApprovedByDefault=dbus.Boolean(False),
 
1251
            LastApprovalRequest="2019-01-03T00:00:00",
 
1252
            ApprovalDelay=30000,
 
1253
            ApprovalDuration=93785000,
 
1254
            Checker=":",
 
1255
            ExtendedTimeout=900000,
 
1256
            Expires="2019-02-05T00:00:00",
 
1257
            LastCheckerStatus=-2)
 
1258
        self.clients =  collections.OrderedDict(
 
1259
            [
 
1260
                ("/clients/foo", self.client.attributes),
 
1261
                ("/clients/barbar", self.other_client.attributes),
853
1262
            ])
854
 
 
855
 
class TestPrintTableCmd(TestCmd):
856
 
    def test_normal(self):
857
 
        output = PrintTableCmd().output(self.clients)
858
 
        expected_output = """
859
 
Name   Enabled Timeout  Last Successful Check
860
 
foo    Yes     00:05:00 2019-02-03T00:00:00  
861
 
barbar Yes     00:05:00 2019-02-04T00:00:00  
862
 
"""[1:-1]
863
 
        self.assertEqual(output, expected_output)
864
 
    def test_verbose(self):
865
 
        output = PrintTableCmd(verbose=True).output(self.clients)
866
 
        expected_output = """
867
 
Name   Enabled Timeout  Last Successful Check Created             Interval Host            Key ID                                                           Fingerprint                              Check Is Running Last Enabled        Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker              Extended Timeout Expires             Last Checker Status
868
 
foo    Yes     00:05:00 2019-02-03T00:00:00   2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No               2019-01-03T00:00:00 No                  Yes                                       00:00:00       00:00:01          fping -q -- %(host)s 00:15:00         2019-02-04T00:00:00 0                  
869
 
barbar Yes     00:05:00 2019-02-04T00:00:00   2019-01-03T00:00:00 00:02:00 192.0.2.3       0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes              2019-01-04T00:00:00 No                  No                  2019-01-03T00:00:00   00:00:30       00:00:01          :                    00:15:00         2019-02-05T00:00:00 -2                 
870
 
"""[1:-1]
871
 
        self.assertEqual(output, expected_output)
872
 
    def test_one_client(self):
873
 
        output = PrintTableCmd().output({"foo": self.clients["foo"]})
874
 
        expected_output = """
875
 
Name Enabled Timeout  Last Successful Check
876
 
foo  Yes     00:05:00 2019-02-03T00:00:00  
877
 
"""[1:-1]
878
 
        self.assertEqual(output, expected_output)
 
1263
        self.one_client = {"/clients/foo": self.client.attributes}
 
1264
 
 
1265
    @property
 
1266
    def bus(self):
 
1267
        class Bus(object):
 
1268
            @staticmethod
 
1269
            def get_object(client_bus_name, path):
 
1270
                self.assertEqual(client_bus_name, dbus_busname)
 
1271
                return {
 
1272
                    # Note: "self" here is the TestCmd instance, not
 
1273
                    # the Bus instance, since this is a static method!
 
1274
                    "/clients/foo": self.client,
 
1275
                    "/clients/barbar": self.other_client,
 
1276
                }[path]
 
1277
        return Bus()
 
1278
 
 
1279
 
 
1280
class TestIsEnabledCmd(TestCmd):
 
1281
    def test_is_enabled(self):
 
1282
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
 
1283
                                                      properties)
 
1284
                            for client, properties
 
1285
                            in self.clients.items()))
 
1286
 
 
1287
    def test_is_enabled_run_exits_successfully(self):
 
1288
        with self.assertRaises(SystemExit) as e:
 
1289
            IsEnabledCmd().run(self.one_client)
 
1290
        if e.exception.code is not None:
 
1291
            self.assertEqual(e.exception.code, 0)
 
1292
        else:
 
1293
            self.assertIsNone(e.exception.code)
 
1294
 
 
1295
    def test_is_enabled_run_exits_with_failure(self):
 
1296
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
1297
        with self.assertRaises(SystemExit) as e:
 
1298
            IsEnabledCmd().run(self.one_client)
 
1299
        if isinstance(e.exception.code, int):
 
1300
            self.assertNotEqual(e.exception.code, 0)
 
1301
        else:
 
1302
            self.assertIsNotNone(e.exception.code)
 
1303
 
 
1304
 
 
1305
class TestApproveCmd(TestCmd):
 
1306
    def test_approve(self):
 
1307
        ApproveCmd().run(self.clients, self.bus)
 
1308
        for clientpath in self.clients:
 
1309
            client = self.bus.get_object(dbus_busname, clientpath)
 
1310
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1311
                          client.calls)
 
1312
 
 
1313
 
 
1314
class TestDenyCmd(TestCmd):
 
1315
    def test_deny(self):
 
1316
        DenyCmd().run(self.clients, self.bus)
 
1317
        for clientpath in self.clients:
 
1318
            client = self.bus.get_object(dbus_busname, clientpath)
 
1319
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1320
                          client.calls)
 
1321
 
 
1322
 
 
1323
class TestRemoveCmd(TestCmd):
 
1324
    def test_remove(self):
 
1325
        class MockMandos(object):
 
1326
            def __init__(self):
 
1327
                self.calls = []
 
1328
            def RemoveClient(self, dbus_path):
 
1329
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1330
        mandos = MockMandos()
 
1331
        super(TestRemoveCmd, self).setUp()
 
1332
        RemoveCmd().run(self.clients, self.bus, mandos)
 
1333
        self.assertEqual(len(mandos.calls), 2)
 
1334
        for clientpath in self.clients:
 
1335
            self.assertIn(("RemoveClient", (clientpath,)),
 
1336
                          mandos.calls)
 
1337
 
879
1338
 
880
1339
class TestDumpJSONCmd(TestCmd):
881
1340
    def setUp(self):
922
1381
                "ApprovedByDefault": False,
923
1382
                "LastApprovalRequest": "2019-01-03T00:00:00",
924
1383
                "ApprovalDelay": 30000,
925
 
                "ApprovalDuration": 1000,
 
1384
                "ApprovalDuration": 93785000,
926
1385
                "Checker": ":",
927
1386
                "ExtendedTimeout": 900000,
928
1387
                "Expires": "2019-02-05T00:00:00",
930
1389
            },
931
1390
        }
932
1391
        return super(TestDumpJSONCmd, self).setUp()
 
1392
 
933
1393
    def test_normal(self):
934
1394
        json_data = json.loads(DumpJSONCmd().output(self.clients))
935
1395
        self.assertDictEqual(json_data, self.expected_json)
 
1396
 
936
1397
    def test_one_client(self):
937
 
        clients = {"foo": self.clients["foo"]}
 
1398
        clients = self.one_client
938
1399
        json_data = json.loads(DumpJSONCmd().output(clients))
939
1400
        expected_json = {"foo": self.expected_json["foo"]}
940
1401
        self.assertDictEqual(json_data, expected_json)
941
1402
 
942
 
class TestIsEnabledCmd(TestCmd):
943
 
    def test_is_enabled(self):
944
 
        self.assertTrue(all(IsEnabledCmd().is_enabled(client)
945
 
                            for client in self.clients.values()))
946
 
    def test_is_enabled_does_get_attribute(self):
947
 
        client = self.clients["foo"]
948
 
        self.assertTrue(IsEnabledCmd().is_enabled(client))
949
 
        self.assertListEqual(client.calls,
950
 
                             [("Get",
951
 
                               ("se.recompile.Mandos.Client",
952
 
                                "Enabled",
953
 
                                "org.freedesktop.DBus.Properties"))])
954
 
    def test_is_enabled_run_exits_successfully(self):
955
 
        client = self.clients["foo"]
956
 
        with self.assertRaises(SystemExit) as e:
957
 
            IsEnabledCmd().run(None, [client])
958
 
        if e.exception.code is not None:
959
 
            self.assertEqual(e.exception.code, 0)
960
 
        else:
961
 
            self.assertIsNone(e.exception.code)
962
 
    def test_is_enabled_run_exits_with_failure(self):
963
 
        client = self.clients["foo"]
964
 
        client["Enabled"] = dbus.Boolean(False)
965
 
        with self.assertRaises(SystemExit) as e:
966
 
            IsEnabledCmd().run(None, [client])
967
 
        if isinstance(e.exception.code, int):
968
 
            self.assertNotEqual(e.exception.code, 0)
969
 
        else:
970
 
            self.assertIsNotNone(e.exception.code)
 
1403
 
 
1404
class TestPrintTableCmd(TestCmd):
 
1405
    def test_normal(self):
 
1406
        output = PrintTableCmd().output(self.clients.values())
 
1407
        expected_output = "\n".join((
 
1408
            "Name   Enabled Timeout  Last Successful Check",
 
1409
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
 
1410
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
 
1411
        ))
 
1412
        self.assertEqual(output, expected_output)
 
1413
 
 
1414
    def test_verbose(self):
 
1415
        output = PrintTableCmd(verbose=True).output(
 
1416
            self.clients.values())
 
1417
        columns = (
 
1418
            (
 
1419
                "Name   ",
 
1420
                "foo    ",
 
1421
                "barbar ",
 
1422
            ),(
 
1423
                "Enabled ",
 
1424
                "Yes     ",
 
1425
                "Yes     ",
 
1426
            ),(
 
1427
                "Timeout  ",
 
1428
                "00:05:00 ",
 
1429
                "00:05:00 ",
 
1430
            ),(
 
1431
                "Last Successful Check ",
 
1432
                "2019-02-03T00:00:00   ",
 
1433
                "2019-02-04T00:00:00   ",
 
1434
            ),(
 
1435
                "Created             ",
 
1436
                "2019-01-02T00:00:00 ",
 
1437
                "2019-01-03T00:00:00 ",
 
1438
            ),(
 
1439
                "Interval ",
 
1440
                "00:02:00 ",
 
1441
                "00:02:00 ",
 
1442
            ),(
 
1443
                "Host            ",
 
1444
                "foo.example.org ",
 
1445
                "192.0.2.3       ",
 
1446
            ),(
 
1447
                ("Key ID                                             "
 
1448
                 "              "),
 
1449
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
 
1450
                 "ea90a27cddb12 "),
 
1451
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
 
1452
                 "46c2b020f441c "),
 
1453
            ),(
 
1454
                "Fingerprint                              ",
 
1455
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
 
1456
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
 
1457
            ),(
 
1458
                "Check Is Running ",
 
1459
                "No               ",
 
1460
                "Yes              ",
 
1461
            ),(
 
1462
                "Last Enabled        ",
 
1463
                "2019-01-03T00:00:00 ",
 
1464
                "2019-01-04T00:00:00 ",
 
1465
            ),(
 
1466
                "Approval Is Pending ",
 
1467
                "No                  ",
 
1468
                "No                  ",
 
1469
            ),(
 
1470
                "Approved By Default ",
 
1471
                "Yes                 ",
 
1472
                "No                  ",
 
1473
            ),(
 
1474
                "Last Approval Request ",
 
1475
                "                      ",
 
1476
                "2019-01-03T00:00:00   ",
 
1477
            ),(
 
1478
                "Approval Delay ",
 
1479
                "00:00:00       ",
 
1480
                "00:00:30       ",
 
1481
            ),(
 
1482
                "Approval Duration ",
 
1483
                "00:00:01          ",
 
1484
                "1T02:03:05        ",
 
1485
            ),(
 
1486
                "Checker              ",
 
1487
                "fping -q -- %(host)s ",
 
1488
                ":                    ",
 
1489
            ),(
 
1490
                "Extended Timeout ",
 
1491
                "00:15:00         ",
 
1492
                "00:15:00         ",
 
1493
            ),(
 
1494
                "Expires             ",
 
1495
                "2019-02-04T00:00:00 ",
 
1496
                "2019-02-05T00:00:00 ",
 
1497
            ),(
 
1498
                "Last Checker Status",
 
1499
                "0                  ",
 
1500
                "-2                 ",
 
1501
            )
 
1502
        )
 
1503
        num_lines = max(len(rows) for rows in columns)
 
1504
        expected_output = "\n".join("".join(rows[line]
 
1505
                                            for rows in columns)
 
1506
                                    for line in range(num_lines))
 
1507
        self.assertEqual(output, expected_output)
 
1508
 
 
1509
    def test_one_client(self):
 
1510
        output = PrintTableCmd().output(self.one_client.values())
 
1511
        expected_output = "\n".join((
 
1512
            "Name Enabled Timeout  Last Successful Check",
 
1513
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
 
1514
        ))
 
1515
        self.assertEqual(output, expected_output)
 
1516
 
 
1517
 
 
1518
class TestPropertyCmd(TestCmd):
 
1519
    """Abstract class for tests of PropertyCmd classes"""
 
1520
    def runTest(self):
 
1521
        if not hasattr(self, "command"):
 
1522
            return
 
1523
        values_to_get = getattr(self, "values_to_get",
 
1524
                                self.values_to_set)
 
1525
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1526
                                              values_to_get):
 
1527
            for clientpath in self.clients:
 
1528
                client = self.bus.get_object(dbus_busname, clientpath)
 
1529
                old_value = client.attributes[self.propname]
 
1530
                self.assertNotIsInstance(old_value, self.Unique)
 
1531
                client.attributes[self.propname] = self.Unique()
 
1532
            self.run_command(value_to_set, self.clients)
 
1533
            for clientpath in self.clients:
 
1534
                client = self.bus.get_object(dbus_busname, clientpath)
 
1535
                value = client.attributes[self.propname]
 
1536
                self.assertNotIsInstance(value, self.Unique)
 
1537
                self.assertEqual(value, value_to_get)
 
1538
 
 
1539
    class Unique(object):
 
1540
        """Class for objects which exist only to be unique objects,
 
1541
since unittest.mock.sentinel only exists in Python 3.3"""
 
1542
 
 
1543
    def run_command(self, value, clients):
 
1544
        self.command().run(clients, self.bus)
 
1545
 
 
1546
 
 
1547
class TestEnableCmd(TestPropertyCmd):
 
1548
    command = EnableCmd
 
1549
    propname = "Enabled"
 
1550
    values_to_set = [dbus.Boolean(True)]
 
1551
 
 
1552
 
 
1553
class TestDisableCmd(TestPropertyCmd):
 
1554
    command = DisableCmd
 
1555
    propname = "Enabled"
 
1556
    values_to_set = [dbus.Boolean(False)]
 
1557
 
 
1558
 
 
1559
class TestBumpTimeoutCmd(TestPropertyCmd):
 
1560
    command = BumpTimeoutCmd
 
1561
    propname = "LastCheckedOK"
 
1562
    values_to_set = [""]
 
1563
 
 
1564
 
 
1565
class TestStartCheckerCmd(TestPropertyCmd):
 
1566
    command = StartCheckerCmd
 
1567
    propname = "CheckerRunning"
 
1568
    values_to_set = [dbus.Boolean(True)]
 
1569
 
 
1570
 
 
1571
class TestStopCheckerCmd(TestPropertyCmd):
 
1572
    command = StopCheckerCmd
 
1573
    propname = "CheckerRunning"
 
1574
    values_to_set = [dbus.Boolean(False)]
 
1575
 
 
1576
 
 
1577
class TestApproveByDefaultCmd(TestPropertyCmd):
 
1578
    command = ApproveByDefaultCmd
 
1579
    propname = "ApprovedByDefault"
 
1580
    values_to_set = [dbus.Boolean(True)]
 
1581
 
 
1582
 
 
1583
class TestDenyByDefaultCmd(TestPropertyCmd):
 
1584
    command = DenyByDefaultCmd
 
1585
    propname = "ApprovedByDefault"
 
1586
    values_to_set = [dbus.Boolean(False)]
 
1587
 
 
1588
 
 
1589
class TestPropertyValueCmd(TestPropertyCmd):
 
1590
    """Abstract class for tests of PropertyValueCmd classes"""
 
1591
 
 
1592
    def runTest(self):
 
1593
        if type(self) is TestPropertyValueCmd:
 
1594
            return
 
1595
        return super(TestPropertyValueCmd, self).runTest()
 
1596
 
 
1597
    def run_command(self, value, clients):
 
1598
        self.command(value).run(clients, self.bus)
 
1599
 
 
1600
 
 
1601
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1602
    command = SetCheckerCmd
 
1603
    propname = "Checker"
 
1604
    values_to_set = ["", ":", "fping -q -- %s"]
 
1605
 
 
1606
 
 
1607
class TestSetHostCmd(TestPropertyValueCmd):
 
1608
    command = SetHostCmd
 
1609
    propname = "Host"
 
1610
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1611
 
 
1612
 
 
1613
class TestSetSecretCmd(TestPropertyValueCmd):
 
1614
    command = SetSecretCmd
 
1615
    propname = "Secret"
 
1616
    values_to_set = [io.BytesIO(b""),
 
1617
                     io.BytesIO(b"secret\0xyzzy\nbar")]
 
1618
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1619
 
 
1620
 
 
1621
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1622
    command = SetTimeoutCmd
 
1623
    propname = "Timeout"
 
1624
    values_to_set = [datetime.timedelta(),
 
1625
                     datetime.timedelta(minutes=5),
 
1626
                     datetime.timedelta(seconds=1),
 
1627
                     datetime.timedelta(weeks=1),
 
1628
                     datetime.timedelta(weeks=52)]
 
1629
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1630
 
 
1631
 
 
1632
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1633
    command = SetExtendedTimeoutCmd
 
1634
    propname = "ExtendedTimeout"
 
1635
    values_to_set = [datetime.timedelta(),
 
1636
                     datetime.timedelta(minutes=5),
 
1637
                     datetime.timedelta(seconds=1),
 
1638
                     datetime.timedelta(weeks=1),
 
1639
                     datetime.timedelta(weeks=52)]
 
1640
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1641
 
 
1642
 
 
1643
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1644
    command = SetIntervalCmd
 
1645
    propname = "Interval"
 
1646
    values_to_set = [datetime.timedelta(),
 
1647
                     datetime.timedelta(minutes=5),
 
1648
                     datetime.timedelta(seconds=1),
 
1649
                     datetime.timedelta(weeks=1),
 
1650
                     datetime.timedelta(weeks=52)]
 
1651
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1652
 
 
1653
 
 
1654
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1655
    command = SetApprovalDelayCmd
 
1656
    propname = "ApprovalDelay"
 
1657
    values_to_set = [datetime.timedelta(),
 
1658
                     datetime.timedelta(minutes=5),
 
1659
                     datetime.timedelta(seconds=1),
 
1660
                     datetime.timedelta(weeks=1),
 
1661
                     datetime.timedelta(weeks=52)]
 
1662
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1663
 
 
1664
 
 
1665
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1666
    command = SetApprovalDurationCmd
 
1667
    propname = "ApprovalDuration"
 
1668
    values_to_set = [datetime.timedelta(),
 
1669
                     datetime.timedelta(minutes=5),
 
1670
                     datetime.timedelta(seconds=1),
 
1671
                     datetime.timedelta(weeks=1),
 
1672
                     datetime.timedelta(weeks=52)]
 
1673
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
971
1674
 
972
1675
 
973
1676