/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-12 20:37:00 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190312203700-psenofay84b3szip
mandos-ctl: Refactor

* mandos-ctl (TestEnableCmd, TestDisableCmd): Rewrite to inherit from
                                              TestPropertyCmd instead
                                              of TestCmd.

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, properties in clients.items():
 
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)
282
534
            self.run_on_one_client(client, properties)
283
535
 
284
 
class PrintCmd(Command):
285
 
    """Abstract class for commands printing client details"""
 
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, properties):
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
    def run(self, clients, bus=None, mandos=None):
 
581
        print(self.output(clients.values()))
 
582
    def output(self, clients):
 
583
        raise NotImplementedError()
 
584
 
 
585
 
 
586
class DumpJSONCmd(OutputCmd):
 
587
    def output(self, clients):
 
588
        data = {client["Name"]:
 
589
                {key: self.dbus_boolean_to_bool(client[key])
 
590
                 for key in self.all_keywords}
 
591
                for client in clients.values()}
 
592
        return json.dumps(data, indent=4, separators=(',', ': '))
 
593
    @staticmethod
 
594
    def dbus_boolean_to_bool(value):
 
595
        if isinstance(value, dbus.Boolean):
 
596
            value = bool(value)
 
597
        return value
 
598
 
 
599
 
 
600
class PrintTableCmd(OutputCmd):
322
601
    def __init__(self, verbose=False):
323
602
        self.verbose = verbose
324
603
 
325
604
    def output(self, clients):
 
605
        default_keywords = ("Name", "Enabled", "Timeout",
 
606
                            "LastCheckedOK")
 
607
        keywords = default_keywords
326
608
        if self.verbose:
327
609
            keywords = self.all_keywords
328
 
        else:
329
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
330
 
        return str(self.TableOfClients(clients.values(), keywords))
 
610
        return str(self.TableOfClients(clients, keywords))
331
611
 
332
612
    class TableOfClients(object):
333
613
        tableheaders = {
386
666
        def string_from_client(self, client, key):
387
667
            return self.valuetostring(client[key], key)
388
668
 
389
 
        @staticmethod
390
 
        def valuetostring(value, keyword):
 
669
        @classmethod
 
670
        def valuetostring(cls, value, keyword):
391
671
            if isinstance(value, dbus.Boolean):
392
672
                return "Yes" if value else "No"
393
673
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
394
674
                           "ApprovalDuration", "ExtendedTimeout"):
395
 
                return milliseconds_to_string(value)
 
675
                return cls.milliseconds_to_string(value)
396
676
            return str(value)
397
677
 
398
678
        def header_line(self, format_string):
403
683
                **{key: self.string_from_client(client, key)
404
684
                   for key in self.keywords})
405
685
 
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, properties):
423
 
        if self.is_enabled(client, properties):
424
 
            sys.exit(0)
425
 
        sys.exit(1)
426
 
    def is_enabled(self, client, properties):
427
 
        return bool(properties["Enabled"])
428
 
 
429
 
class RemoveCmd(Command):
430
 
    def run_on_one_client(self, client, properties):
431
 
        self.mandos.RemoveClient(client.__dbus_object_path__)
432
 
 
433
 
class ApproveCmd(Command):
434
 
    def run_on_one_client(self, client, properties):
435
 
        client.Approve(dbus.Boolean(True),
436
 
                       dbus_interface=client_interface)
437
 
 
438
 
class DenyCmd(Command):
439
 
    def run_on_one_client(self, client, properties):
440
 
        client.Approve(dbus.Boolean(False),
441
 
                       dbus_interface=client_interface)
 
686
        @staticmethod
 
687
        def milliseconds_to_string(ms):
 
688
            td = datetime.timedelta(0, 0, 0, ms)
 
689
            return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
690
                    .format(days="{}T".format(td.days)
 
691
                            if td.days else "",
 
692
                            hours=td.seconds // 3600,
 
693
                            minutes=(td.seconds % 3600) // 60,
 
694
                            seconds=td.seconds % 60))
 
695
 
 
696
 
 
697
class PropertyCmd(Command):
 
698
    """Abstract class for Actions for setting one client property"""
 
699
    def run_on_one_client(self, client, properties):
 
700
        """Set the Client's D-Bus property"""
 
701
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
702
                  client.__dbus_object_path__,
 
703
                  dbus.PROPERTIES_IFACE, client_dbus_interface,
 
704
                  self.propname, self.value_to_set
 
705
                  if not isinstance(self.value_to_set, dbus.Boolean)
 
706
                  else bool(self.value_to_set))
 
707
        client.Set(client_dbus_interface, self.propname,
 
708
                   self.value_to_set,
 
709
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
710
    @property
 
711
    def propname(self):
 
712
        raise NotImplementedError()
 
713
 
442
714
 
443
715
class EnableCmd(PropertyCmd):
444
 
    property = "Enabled"
 
716
    propname = "Enabled"
445
717
    value_to_set = dbus.Boolean(True)
446
718
 
 
719
 
447
720
class DisableCmd(PropertyCmd):
448
 
    property = "Enabled"
 
721
    propname = "Enabled"
449
722
    value_to_set = dbus.Boolean(False)
450
723
 
 
724
 
451
725
class BumpTimeoutCmd(PropertyCmd):
452
 
    property = "LastCheckedOK"
 
726
    propname = "LastCheckedOK"
453
727
    value_to_set = ""
454
728
 
 
729
 
455
730
class StartCheckerCmd(PropertyCmd):
456
 
    property = "CheckerRunning"
 
731
    propname = "CheckerRunning"
457
732
    value_to_set = dbus.Boolean(True)
458
733
 
 
734
 
459
735
class StopCheckerCmd(PropertyCmd):
460
 
    property = "CheckerRunning"
 
736
    propname = "CheckerRunning"
461
737
    value_to_set = dbus.Boolean(False)
462
738
 
 
739
 
463
740
class ApproveByDefaultCmd(PropertyCmd):
464
 
    property = "ApprovedByDefault"
 
741
    propname = "ApprovedByDefault"
465
742
    value_to_set = dbus.Boolean(True)
466
743
 
 
744
 
467
745
class DenyByDefaultCmd(PropertyCmd):
468
 
    property = "ApprovedByDefault"
 
746
    propname = "ApprovedByDefault"
469
747
    value_to_set = dbus.Boolean(False)
470
748
 
471
 
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
472
 
    property = "Checker"
473
 
 
474
 
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
475
 
    property = "Host"
476
 
 
477
 
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
478
 
    property = "Secret"
479
 
 
480
 
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
481
 
    property = "Timeout"
482
 
 
483
 
class SetExtendedTimeoutCmd(PropertyCmd,
484
 
                            MillisecondsValueArgumentMixIn):
485
 
    property = "ExtendedTimeout"
486
 
 
487
 
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
488
 
    property = "Interval"
489
 
 
490
 
class SetApprovalDelayCmd(PropertyCmd,
491
 
                          MillisecondsValueArgumentMixIn):
492
 
    property = "ApprovalDelay"
493
 
 
494
 
class SetApprovalDurationCmd(PropertyCmd,
495
 
                             MillisecondsValueArgumentMixIn):
496
 
    property = "ApprovalDuration"
497
 
 
498
 
def has_actions(options):
499
 
    return any((options.enable,
500
 
                options.disable,
501
 
                options.bump_timeout,
502
 
                options.start_checker,
503
 
                options.stop_checker,
504
 
                options.is_enabled,
505
 
                options.remove,
506
 
                options.checker is not None,
507
 
                options.timeout is not None,
508
 
                options.extended_timeout is not None,
509
 
                options.interval is not None,
510
 
                options.approved_by_default is not None,
511
 
                options.approval_delay is not None,
512
 
                options.approval_duration is not None,
513
 
                options.host is not None,
514
 
                options.secret is not None,
515
 
                options.approve,
516
 
                options.deny))
517
 
 
518
 
def add_command_line_options(parser):
519
 
    parser.add_argument("--version", action="version",
520
 
                        version="%(prog)s {}".format(version),
521
 
                        help="show version number and exit")
522
 
    parser.add_argument("-a", "--all", action="store_true",
523
 
                        help="Select all clients")
524
 
    parser.add_argument("-v", "--verbose", action="store_true",
525
 
                        help="Print all fields")
526
 
    parser.add_argument("-j", "--dump-json", action="store_true",
527
 
                        help="Dump client data in JSON format")
528
 
    enable_disable = parser.add_mutually_exclusive_group()
529
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
530
 
                                help="Enable client")
531
 
    enable_disable.add_argument("-d", "--disable",
532
 
                                action="store_true",
533
 
                                help="disable client")
534
 
    parser.add_argument("-b", "--bump-timeout", action="store_true",
535
 
                        help="Bump timeout for client")
536
 
    start_stop_checker = parser.add_mutually_exclusive_group()
537
 
    start_stop_checker.add_argument("--start-checker",
538
 
                                    action="store_true",
539
 
                                    help="Start checker for client")
540
 
    start_stop_checker.add_argument("--stop-checker",
541
 
                                    action="store_true",
542
 
                                    help="Stop checker for client")
543
 
    parser.add_argument("-V", "--is-enabled", action="store_true",
544
 
                        help="Check if client is enabled")
545
 
    parser.add_argument("-r", "--remove", action="store_true",
546
 
                        help="Remove client")
547
 
    parser.add_argument("-c", "--checker",
548
 
                        help="Set checker command for client")
549
 
    parser.add_argument("-t", "--timeout",
550
 
                        help="Set timeout for client")
551
 
    parser.add_argument("--extended-timeout",
552
 
                        help="Set extended timeout for client")
553
 
    parser.add_argument("-i", "--interval",
554
 
                        help="Set checker interval for client")
555
 
    approve_deny_default = parser.add_mutually_exclusive_group()
556
 
    approve_deny_default.add_argument(
557
 
        "--approve-by-default", action="store_true",
558
 
        default=None, dest="approved_by_default",
559
 
        help="Set client to be approved by default")
560
 
    approve_deny_default.add_argument(
561
 
        "--deny-by-default", action="store_false",
562
 
        dest="approved_by_default",
563
 
        help="Set client to be denied by default")
564
 
    parser.add_argument("--approval-delay",
565
 
                        help="Set delay before client approve/deny")
566
 
    parser.add_argument("--approval-duration",
567
 
                        help="Set duration of one client approval")
568
 
    parser.add_argument("-H", "--host", help="Set host for client")
569
 
    parser.add_argument("-s", "--secret",
570
 
                        type=argparse.FileType(mode="rb"),
571
 
                        help="Set password blob (file) for client")
572
 
    approve_deny = parser.add_mutually_exclusive_group()
573
 
    approve_deny.add_argument(
574
 
        "-A", "--approve", action="store_true",
575
 
        help="Approve any current client request")
576
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
577
 
                              help="Deny any current client request")
578
 
    parser.add_argument("--check", action="store_true",
579
 
                        help="Run self-test")
580
 
    parser.add_argument("client", nargs="*", help="Client name")
581
 
 
582
 
 
583
 
def commands_from_options(options):
584
 
 
585
 
    commands = []
586
 
 
587
 
    if options.dump_json:
588
 
        commands.append(DumpJSONCmd())
589
 
 
590
 
    if options.enable:
591
 
        commands.append(EnableCmd())
592
 
 
593
 
    if options.disable:
594
 
        commands.append(DisableCmd())
595
 
 
596
 
    if options.bump_timeout:
597
 
        commands.append(BumpTimeoutCmd())
598
 
 
599
 
    if options.start_checker:
600
 
        commands.append(StartCheckerCmd())
601
 
 
602
 
    if options.stop_checker:
603
 
        commands.append(StopCheckerCmd())
604
 
 
605
 
    if options.is_enabled:
606
 
        commands.append(IsEnabledCmd())
607
 
 
608
 
    if options.remove:
609
 
        commands.append(RemoveCmd())
610
 
 
611
 
    if options.checker is not None:
612
 
        commands.append(SetCheckerCmd())
613
 
 
614
 
    if options.timeout is not None:
615
 
        commands.append(SetTimeoutCmd(options.timeout))
616
 
 
617
 
    if options.extended_timeout:
618
 
        commands.append(
619
 
            SetExtendedTimeoutCmd(options.extended_timeout))
620
 
 
621
 
    if options.interval is not None:
622
 
        command.append(SetIntervalCmd(options.interval))
623
 
 
624
 
    if options.approved_by_default is not None:
625
 
        if options.approved_by_default:
626
 
            command.append(ApproveByDefaultCmd())
627
 
        else:
628
 
            command.append(DenyByDefaultCmd())
629
 
 
630
 
    if options.approval_delay is not None:
631
 
        command.append(SetApprovalDelayCmd(options.approval_delay))
632
 
 
633
 
    if options.approval_duration is not None:
634
 
        command.append(
635
 
            SetApprovalDurationCmd(options.approval_duration))
636
 
 
637
 
    if options.host is not None:
638
 
        command.append(SetHostCmd(options.host))
639
 
 
640
 
    if options.secret is not None:
641
 
        command.append(SetSecretCmd(options.secret))
642
 
 
643
 
    if options.approve:
644
 
        commands.append(ApproveCmd())
645
 
 
646
 
    if options.deny:
647
 
        commands.append(DenyCmd())
648
 
 
649
 
    # If no command option has been given, show table of clients,
650
 
    # optionally verbosely
651
 
    if not commands:
652
 
        commands.append(PrintTableCmd(verbose=options.verbose))
653
 
 
654
 
    return commands
655
 
 
656
 
 
657
 
def main():
658
 
    parser = argparse.ArgumentParser()
659
 
 
660
 
    add_command_line_options(parser)
661
 
 
662
 
    options = parser.parse_args()
663
 
 
664
 
    if has_actions(options) and not (options.client or options.all):
665
 
        parser.error("Options require clients names or --all.")
666
 
    if options.verbose and has_actions(options):
667
 
        parser.error("--verbose can only be used alone.")
668
 
    if options.dump_json and (options.verbose
669
 
                              or has_actions(options)):
670
 
        parser.error("--dump-json can only be used alone.")
671
 
    if options.all and not has_actions(options):
672
 
        parser.error("--all requires an action.")
673
 
    if options.is_enabled and len(options.client) > 1:
674
 
        parser.error("--is-enabled requires exactly one client")
675
 
 
676
 
    clientnames = options.client
677
 
 
678
 
    try:
679
 
        bus = dbus.SystemBus()
680
 
        mandos_dbus_objc = bus.get_object(busname, server_path)
681
 
    except dbus.exceptions.DBusException:
682
 
        log.critical("Could not connect to Mandos server")
683
 
        sys.exit(1)
684
 
 
685
 
    mandos_serv = dbus.Interface(mandos_dbus_objc,
686
 
                                 dbus_interface=server_interface)
687
 
    mandos_serv_object_manager = dbus.Interface(
688
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
689
 
 
690
 
    # Filter out log message from dbus module
691
 
    dbus_logger = logging.getLogger("dbus.proxies")
692
 
    class NullFilter(logging.Filter):
693
 
        def filter(self, record):
694
 
            return False
695
 
    dbus_filter = NullFilter()
696
 
    try:
697
 
        dbus_logger.addFilter(dbus_filter)
698
 
        mandos_clients = {path: ifs_and_props[client_interface]
699
 
                          for path, ifs_and_props in
700
 
                          mandos_serv_object_manager
701
 
                          .GetManagedObjects().items()
702
 
                          if client_interface in ifs_and_props}
703
 
    except dbus.exceptions.DBusException as e:
704
 
        log.critical("Failed to access Mandos server through D-Bus:"
705
 
                     "\n%s", e)
706
 
        sys.exit(1)
707
 
    finally:
708
 
        # restore dbus logger
709
 
        dbus_logger.removeFilter(dbus_filter)
710
 
 
711
 
    # Compile dict of (clients: properties) to process
712
 
    clients = {}
713
 
 
714
 
    if not clientnames:
715
 
        clients = {bus.get_object(busname, path): properties
716
 
                   for path, properties in mandos_clients.items()}
717
 
    else:
718
 
        for name in clientnames:
719
 
            for path, client in mandos_clients.items():
720
 
                if client["Name"] == name:
721
 
                    client_objc = bus.get_object(busname, path)
722
 
                    clients[client_objc] = client
723
 
                    break
724
 
            else:
725
 
                log.critical("Client not found on server: %r", name)
726
 
                sys.exit(1)
727
 
 
728
 
    # Run all commands on clients
729
 
    commands = commands_from_options(options)
730
 
    for command in commands:
731
 
        command.run(mandos_serv, clients)
 
749
 
 
750
class PropertyValueCmd(PropertyCmd):
 
751
    """Abstract class for PropertyCmd recieving a value as argument"""
 
752
    def __init__(self, value):
 
753
        self.value_to_set = value
 
754
 
 
755
 
 
756
class SetCheckerCmd(PropertyValueCmd):
 
757
    propname = "Checker"
 
758
 
 
759
 
 
760
class SetHostCmd(PropertyValueCmd):
 
761
    propname = "Host"
 
762
 
 
763
 
 
764
class SetSecretCmd(PropertyValueCmd):
 
765
    propname = "Secret"
 
766
    @property
 
767
    def value_to_set(self):
 
768
        return self._vts
 
769
    @value_to_set.setter
 
770
    def value_to_set(self, value):
 
771
        """When setting, read data from supplied file object"""
 
772
        self._vts = value.read()
 
773
        value.close()
 
774
 
 
775
 
 
776
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
 
777
    """Abstract class for PropertyValueCmd taking a value argument as
 
778
a datetime.timedelta() but should store it as milliseconds."""
 
779
    @property
 
780
    def value_to_set(self):
 
781
        return self._vts
 
782
    @value_to_set.setter
 
783
    def value_to_set(self, value):
 
784
        """When setting, convert value from a datetime.timedelta"""
 
785
        self._vts = int(round(value.total_seconds() * 1000))
 
786
 
 
787
 
 
788
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
789
    propname = "Timeout"
 
790
 
 
791
 
 
792
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
793
    propname = "ExtendedTimeout"
 
794
 
 
795
 
 
796
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
 
797
    propname = "Interval"
 
798
 
 
799
 
 
800
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
 
801
    propname = "ApprovalDelay"
 
802
 
 
803
 
 
804
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
 
805
    propname = "ApprovalDuration"
 
806
 
732
807
 
733
808
 
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
809
class Test_string_to_delta(unittest.TestCase):
748
810
    def test_handles_basic_rfc3339(self):
 
811
        self.assertEqual(string_to_delta("PT0S"),
 
812
                         datetime.timedelta())
 
813
        self.assertEqual(string_to_delta("P0D"),
 
814
                         datetime.timedelta())
 
815
        self.assertEqual(string_to_delta("PT1S"),
 
816
                         datetime.timedelta(0, 1))
749
817
        self.assertEqual(string_to_delta("PT2H"),
750
818
                         datetime.timedelta(0, 7200))
751
819
    def test_falls_back_to_pre_1_6_1_with_warning(self):
771
839
        self.assertEqual(value, datetime.timedelta(0, 7200))
772
840
 
773
841
 
 
842
class Test_check_option_syntax(unittest.TestCase):
 
843
    # This mostly corresponds to the definition from has_actions() in
 
844
    # check_option_syntax()
 
845
    actions = {
 
846
        # The actual values set here are not that important, but we do
 
847
        # at least stick to the correct types, even though they are
 
848
        # never used
 
849
        "enable": True,
 
850
        "disable": True,
 
851
        "bump_timeout": True,
 
852
        "start_checker": True,
 
853
        "stop_checker": True,
 
854
        "is_enabled": True,
 
855
        "remove": True,
 
856
        "checker": "x",
 
857
        "timeout": datetime.timedelta(),
 
858
        "extended_timeout": datetime.timedelta(),
 
859
        "interval": datetime.timedelta(),
 
860
        "approved_by_default": True,
 
861
        "approval_delay": datetime.timedelta(),
 
862
        "approval_duration": datetime.timedelta(),
 
863
        "host": "x",
 
864
        "secret": io.BytesIO(b"x"),
 
865
        "approve": True,
 
866
        "deny": True,
 
867
    }
 
868
 
 
869
    def setUp(self):
 
870
        self.parser = argparse.ArgumentParser()
 
871
        add_command_line_options(self.parser)
 
872
 
 
873
    @contextlib.contextmanager
 
874
    def assertParseError(self):
 
875
        with self.assertRaises(SystemExit) as e:
 
876
            with self.temporarily_suppress_stderr():
 
877
                yield
 
878
        # Exit code from argparse is guaranteed to be "2".  Reference:
 
879
        # https://docs.python.org/3/library
 
880
        # /argparse.html#exiting-methods
 
881
        self.assertEqual(e.exception.code, 2)
 
882
 
 
883
    @staticmethod
 
884
    @contextlib.contextmanager
 
885
    def temporarily_suppress_stderr():
 
886
        null = os.open(os.path.devnull, os.O_RDWR)
 
887
        stderrcopy = os.dup(sys.stderr.fileno())
 
888
        os.dup2(null, sys.stderr.fileno())
 
889
        os.close(null)
 
890
        try:
 
891
            yield
 
892
        finally:
 
893
            # restore stderr
 
894
            os.dup2(stderrcopy, sys.stderr.fileno())
 
895
            os.close(stderrcopy)
 
896
 
 
897
    def check_option_syntax(self, options):
 
898
        check_option_syntax(self.parser, options)
 
899
 
 
900
    def test_actions_requires_client_or_all(self):
 
901
        for action, value in self.actions.items():
 
902
            options = self.parser.parse_args()
 
903
            setattr(options, action, value)
 
904
            with self.assertParseError():
 
905
                self.check_option_syntax(options)
 
906
 
 
907
    def test_actions_conflicts_with_verbose(self):
 
908
        for action, value in self.actions.items():
 
909
            options = self.parser.parse_args()
 
910
            setattr(options, action, value)
 
911
            options.verbose = True
 
912
            with self.assertParseError():
 
913
                self.check_option_syntax(options)
 
914
 
 
915
    def test_dump_json_conflicts_with_verbose(self):
 
916
        options = self.parser.parse_args()
 
917
        options.dump_json = True
 
918
        options.verbose = True
 
919
        with self.assertParseError():
 
920
            self.check_option_syntax(options)
 
921
 
 
922
    def test_dump_json_conflicts_with_action(self):
 
923
        for action, value in self.actions.items():
 
924
            options = self.parser.parse_args()
 
925
            setattr(options, action, value)
 
926
            options.dump_json = True
 
927
            with self.assertParseError():
 
928
                self.check_option_syntax(options)
 
929
 
 
930
    def test_all_can_not_be_alone(self):
 
931
        options = self.parser.parse_args()
 
932
        options.all = True
 
933
        with self.assertParseError():
 
934
            self.check_option_syntax(options)
 
935
 
 
936
    def test_all_is_ok_with_any_action(self):
 
937
        for action, value in self.actions.items():
 
938
            options = self.parser.parse_args()
 
939
            setattr(options, action, value)
 
940
            options.all = True
 
941
            self.check_option_syntax(options)
 
942
 
 
943
    def test_is_enabled_fails_without_client(self):
 
944
        options = self.parser.parse_args()
 
945
        options.is_enabled = True
 
946
        with self.assertParseError():
 
947
            self.check_option_syntax(options)
 
948
 
 
949
    def test_is_enabled_works_with_one_client(self):
 
950
        options = self.parser.parse_args()
 
951
        options.is_enabled = True
 
952
        options.client = ["foo"]
 
953
        self.check_option_syntax(options)
 
954
 
 
955
    def test_is_enabled_fails_with_two_clients(self):
 
956
        options = self.parser.parse_args()
 
957
        options.is_enabled = True
 
958
        options.client = ["foo", "barbar"]
 
959
        with self.assertParseError():
 
960
            self.check_option_syntax(options)
 
961
 
 
962
    def test_remove_can_only_be_combined_with_action_deny(self):
 
963
        for action, value in self.actions.items():
 
964
            if action in {"remove", "deny"}:
 
965
                continue
 
966
            options = self.parser.parse_args()
 
967
            setattr(options, action, value)
 
968
            options.all = True
 
969
            options.remove = True
 
970
            with self.assertParseError():
 
971
                self.check_option_syntax(options)
 
972
 
 
973
 
 
974
class Test_command_from_options(unittest.TestCase):
 
975
    def setUp(self):
 
976
        self.parser = argparse.ArgumentParser()
 
977
        add_command_line_options(self.parser)
 
978
    def assert_command_from_args(self, args, command_cls,
 
979
                                 **cmd_attrs):
 
980
        """Assert that parsing ARGS should result in an instance of
 
981
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
 
982
        options = self.parser.parse_args(args)
 
983
        check_option_syntax(self.parser, options)
 
984
        commands = commands_from_options(options)
 
985
        self.assertEqual(len(commands), 1)
 
986
        command = commands[0]
 
987
        self.assertIsInstance(command, command_cls)
 
988
        for key, value in cmd_attrs.items():
 
989
            self.assertEqual(getattr(command, key), value)
 
990
    def test_print_table(self):
 
991
        self.assert_command_from_args([], PrintTableCmd,
 
992
                                      verbose=False)
 
993
 
 
994
    def test_print_table_verbose(self):
 
995
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
 
996
                                      verbose=True)
 
997
 
 
998
    def test_print_table_verbose_short(self):
 
999
        self.assert_command_from_args(["-v"], PrintTableCmd,
 
1000
                                      verbose=True)
 
1001
 
 
1002
    def test_enable(self):
 
1003
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
 
1004
 
 
1005
    def test_enable_short(self):
 
1006
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
 
1007
 
 
1008
    def test_disable(self):
 
1009
        self.assert_command_from_args(["--disable", "foo"],
 
1010
                                      DisableCmd)
 
1011
 
 
1012
    def test_disable_short(self):
 
1013
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
 
1014
 
 
1015
    def test_bump_timeout(self):
 
1016
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1017
                                      BumpTimeoutCmd)
 
1018
 
 
1019
    def test_bump_timeout_short(self):
 
1020
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
 
1021
 
 
1022
    def test_start_checker(self):
 
1023
        self.assert_command_from_args(["--start-checker", "foo"],
 
1024
                                      StartCheckerCmd)
 
1025
 
 
1026
    def test_stop_checker(self):
 
1027
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1028
                                      StopCheckerCmd)
 
1029
 
 
1030
    def test_remove(self):
 
1031
        self.assert_command_from_args(["--remove", "foo"],
 
1032
                                      RemoveCmd)
 
1033
 
 
1034
    def test_remove_short(self):
 
1035
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
 
1036
 
 
1037
    def test_checker(self):
 
1038
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1039
                                      SetCheckerCmd, value_to_set=":")
 
1040
 
 
1041
    def test_checker_empty(self):
 
1042
        self.assert_command_from_args(["--checker", "", "foo"],
 
1043
                                      SetCheckerCmd, value_to_set="")
 
1044
 
 
1045
    def test_checker_short(self):
 
1046
        self.assert_command_from_args(["-c", ":", "foo"],
 
1047
                                      SetCheckerCmd, value_to_set=":")
 
1048
 
 
1049
    def test_timeout(self):
 
1050
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1051
                                      SetTimeoutCmd,
 
1052
                                      value_to_set=300000)
 
1053
 
 
1054
    def test_timeout_short(self):
 
1055
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1056
                                      SetTimeoutCmd,
 
1057
                                      value_to_set=300000)
 
1058
 
 
1059
    def test_extended_timeout(self):
 
1060
        self.assert_command_from_args(["--extended-timeout", "PT15M",
 
1061
                                       "foo"],
 
1062
                                      SetExtendedTimeoutCmd,
 
1063
                                      value_to_set=900000)
 
1064
 
 
1065
    def test_interval(self):
 
1066
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1067
                                      SetIntervalCmd,
 
1068
                                      value_to_set=120000)
 
1069
 
 
1070
    def test_interval_short(self):
 
1071
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1072
                                      SetIntervalCmd,
 
1073
                                      value_to_set=120000)
 
1074
 
 
1075
    def test_approve_by_default(self):
 
1076
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1077
                                      ApproveByDefaultCmd)
 
1078
 
 
1079
    def test_deny_by_default(self):
 
1080
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1081
                                      DenyByDefaultCmd)
 
1082
 
 
1083
    def test_approval_delay(self):
 
1084
        self.assert_command_from_args(["--approval-delay", "PT30S",
 
1085
                                       "foo"], SetApprovalDelayCmd,
 
1086
                                      value_to_set=30000)
 
1087
 
 
1088
    def test_approval_duration(self):
 
1089
        self.assert_command_from_args(["--approval-duration", "PT1S",
 
1090
                                       "foo"], SetApprovalDurationCmd,
 
1091
                                      value_to_set=1000)
 
1092
 
 
1093
    def test_host(self):
 
1094
        self.assert_command_from_args(["--host", "foo.example.org",
 
1095
                                       "foo"], SetHostCmd,
 
1096
                                      value_to_set="foo.example.org")
 
1097
 
 
1098
    def test_host_short(self):
 
1099
        self.assert_command_from_args(["-H", "foo.example.org",
 
1100
                                       "foo"], SetHostCmd,
 
1101
                                      value_to_set="foo.example.org")
 
1102
 
 
1103
    def test_secret_devnull(self):
 
1104
        self.assert_command_from_args(["--secret", os.path.devnull,
 
1105
                                       "foo"], SetSecretCmd,
 
1106
                                      value_to_set=b"")
 
1107
 
 
1108
    def test_secret_tempfile(self):
 
1109
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1110
            value = b"secret\0xyzzy\nbar"
 
1111
            f.write(value)
 
1112
            f.seek(0)
 
1113
            self.assert_command_from_args(["--secret", f.name,
 
1114
                                           "foo"], SetSecretCmd,
 
1115
                                          value_to_set=value)
 
1116
 
 
1117
    def test_secret_devnull_short(self):
 
1118
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1119
                                      SetSecretCmd, value_to_set=b"")
 
1120
 
 
1121
    def test_secret_tempfile_short(self):
 
1122
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1123
            value = b"secret\0xyzzy\nbar"
 
1124
            f.write(value)
 
1125
            f.seek(0)
 
1126
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1127
                                          SetSecretCmd,
 
1128
                                          value_to_set=value)
 
1129
 
 
1130
    def test_approve(self):
 
1131
        self.assert_command_from_args(["--approve", "foo"],
 
1132
                                      ApproveCmd)
 
1133
 
 
1134
    def test_approve_short(self):
 
1135
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
 
1136
 
 
1137
    def test_deny(self):
 
1138
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
 
1139
 
 
1140
    def test_deny_short(self):
 
1141
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
 
1142
 
 
1143
    def test_dump_json(self):
 
1144
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
 
1145
 
 
1146
    def test_is_enabled(self):
 
1147
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1148
                                      IsEnabledCmd)
 
1149
 
 
1150
    def test_is_enabled_short(self):
 
1151
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
 
1152
 
 
1153
    def test_deny_before_remove(self):
 
1154
        options = self.parser.parse_args(["--deny", "--remove",
 
1155
                                          "foo"])
 
1156
        check_option_syntax(self.parser, options)
 
1157
        commands = commands_from_options(options)
 
1158
        self.assertEqual(len(commands), 2)
 
1159
        self.assertIsInstance(commands[0], DenyCmd)
 
1160
        self.assertIsInstance(commands[1], RemoveCmd)
 
1161
 
 
1162
    def test_deny_before_remove_reversed(self):
 
1163
        options = self.parser.parse_args(["--remove", "--deny",
 
1164
                                          "--all"])
 
1165
        check_option_syntax(self.parser, options)
 
1166
        commands = commands_from_options(options)
 
1167
        self.assertEqual(len(commands), 2)
 
1168
        self.assertIsInstance(commands[0], DenyCmd)
 
1169
        self.assertIsInstance(commands[1], RemoveCmd)
 
1170
 
 
1171
 
774
1172
class TestCmd(unittest.TestCase):
775
1173
    """Abstract class for tests of command classes"""
776
1174
    def setUp(self):
777
1175
        testcase = self
778
1176
        class MockClient(object):
779
1177
            def __init__(self, name, **attributes):
780
 
                self.__dbus_object_path__ = "objpath_{}".format(name)
 
1178
                self.__dbus_object_path__ = "/clients/{}".format(name)
781
1179
                self.attributes = attributes
782
1180
                self.attributes["Name"] = name
783
1181
                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]
 
1182
            def Set(self, interface, propname, value, dbus_interface):
 
1183
                testcase.assertEqual(interface, client_dbus_interface)
 
1184
                testcase.assertEqual(dbus_interface,
 
1185
                                     dbus.PROPERTIES_IFACE)
 
1186
                self.attributes[propname] = value
 
1187
            def Get(self, interface, propname, dbus_interface):
 
1188
                testcase.assertEqual(interface, client_dbus_interface)
 
1189
                testcase.assertEqual(dbus_interface,
 
1190
                                     dbus.PROPERTIES_IFACE)
 
1191
                return self.attributes[propname]
798
1192
            def Approve(self, approve, dbus_interface):
799
 
                testcase.assertEqual(dbus_interface, client_interface)
 
1193
                testcase.assertEqual(dbus_interface,
 
1194
                                     client_dbus_interface)
800
1195
                self.calls.append(("Approve", (approve,
801
1196
                                               dbus_interface)))
802
1197
        self.client = MockClient(
842
1237
            ApprovedByDefault=dbus.Boolean(False),
843
1238
            LastApprovalRequest="2019-01-03T00:00:00",
844
1239
            ApprovalDelay=30000,
845
 
            ApprovalDuration=1000,
 
1240
            ApprovalDuration=93785000,
846
1241
            Checker=":",
847
1242
            ExtendedTimeout=900000,
848
1243
            Expires="2019-02-05T00:00:00",
849
1244
            LastCheckerStatus=-2)
850
1245
        self.clients =  collections.OrderedDict(
851
1246
            [
852
 
                (self.client, self.client.attributes),
853
 
                (self.other_client, self.other_client.attributes),
 
1247
                ("/clients/foo", self.client.attributes),
 
1248
                ("/clients/barbar", self.other_client.attributes),
854
1249
            ])
855
 
        self.one_client = {self.client: self.client.attributes}
856
 
 
857
 
class TestPrintTableCmd(TestCmd):
858
 
    def test_normal(self):
859
 
        output = PrintTableCmd().output(self.clients)
860
 
        expected_output = """
861
 
Name   Enabled Timeout  Last Successful Check
862
 
foo    Yes     00:05:00 2019-02-03T00:00:00  
863
 
barbar Yes     00:05:00 2019-02-04T00:00:00  
864
 
"""[1:-1]
865
 
        self.assertEqual(output, expected_output)
866
 
    def test_verbose(self):
867
 
        output = PrintTableCmd(verbose=True).output(self.clients)
868
 
        expected_output = """
869
 
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
870
 
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                  
871
 
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                 
872
 
"""[1:-1]
873
 
        self.assertEqual(output, expected_output)
874
 
    def test_one_client(self):
875
 
        output = PrintTableCmd().output(self.one_client)
876
 
        expected_output = """
877
 
Name Enabled Timeout  Last Successful Check
878
 
foo  Yes     00:05:00 2019-02-03T00:00:00  
879
 
"""[1:-1]
880
 
        self.assertEqual(output, expected_output)
 
1250
        self.one_client = {"/clients/foo": self.client.attributes}
 
1251
    @property
 
1252
    def bus(self):
 
1253
        class Bus(object):
 
1254
            @staticmethod
 
1255
            def get_object(client_bus_name, path):
 
1256
                self.assertEqual(client_bus_name, dbus_busname)
 
1257
                return {
 
1258
                    "/clients/foo": self.client,
 
1259
                    "/clients/barbar": self.other_client,
 
1260
                }[path]
 
1261
        return Bus()
 
1262
 
 
1263
 
 
1264
class TestIsEnabledCmd(TestCmd):
 
1265
    def test_is_enabled(self):
 
1266
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
 
1267
                                                      properties)
 
1268
                            for client, properties
 
1269
                            in self.clients.items()))
 
1270
    def test_is_enabled_run_exits_successfully(self):
 
1271
        with self.assertRaises(SystemExit) as e:
 
1272
            IsEnabledCmd().run(self.one_client)
 
1273
        if e.exception.code is not None:
 
1274
            self.assertEqual(e.exception.code, 0)
 
1275
        else:
 
1276
            self.assertIsNone(e.exception.code)
 
1277
    def test_is_enabled_run_exits_with_failure(self):
 
1278
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
1279
        with self.assertRaises(SystemExit) as e:
 
1280
            IsEnabledCmd().run(self.one_client)
 
1281
        if isinstance(e.exception.code, int):
 
1282
            self.assertNotEqual(e.exception.code, 0)
 
1283
        else:
 
1284
            self.assertIsNotNone(e.exception.code)
 
1285
 
 
1286
 
 
1287
class TestApproveCmd(TestCmd):
 
1288
    def test_approve(self):
 
1289
        ApproveCmd().run(self.clients, self.bus)
 
1290
        for clientpath in self.clients:
 
1291
            client = self.bus.get_object(dbus_busname, clientpath)
 
1292
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1293
                          client.calls)
 
1294
 
 
1295
 
 
1296
class TestDenyCmd(TestCmd):
 
1297
    def test_deny(self):
 
1298
        DenyCmd().run(self.clients, self.bus)
 
1299
        for clientpath in self.clients:
 
1300
            client = self.bus.get_object(dbus_busname, clientpath)
 
1301
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1302
                          client.calls)
 
1303
 
 
1304
class TestRemoveCmd(TestCmd):
 
1305
    def test_remove(self):
 
1306
        class MockMandos(object):
 
1307
            def __init__(self):
 
1308
                self.calls = []
 
1309
            def RemoveClient(self, dbus_path):
 
1310
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1311
        mandos = MockMandos()
 
1312
        super(TestRemoveCmd, self).setUp()
 
1313
        RemoveCmd().run(self.clients, self.bus, mandos)
 
1314
        self.assertEqual(len(mandos.calls), 2)
 
1315
        for clientpath in self.clients:
 
1316
            self.assertIn(("RemoveClient", (clientpath,)),
 
1317
                          mandos.calls)
 
1318
 
881
1319
 
882
1320
class TestDumpJSONCmd(TestCmd):
883
1321
    def setUp(self):
924
1362
                "ApprovedByDefault": False,
925
1363
                "LastApprovalRequest": "2019-01-03T00:00:00",
926
1364
                "ApprovalDelay": 30000,
927
 
                "ApprovalDuration": 1000,
 
1365
                "ApprovalDuration": 93785000,
928
1366
                "Checker": ":",
929
1367
                "ExtendedTimeout": 900000,
930
1368
                "Expires": "2019-02-05T00:00:00",
941
1379
        expected_json = {"foo": self.expected_json["foo"]}
942
1380
        self.assertDictEqual(json_data, expected_json)
943
1381
 
944
 
class TestIsEnabledCmd(TestCmd):
945
 
    def test_is_enabled(self):
946
 
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
947
 
                            for client, properties in self.clients.items()))
948
 
    def test_is_enabled_run_exits_successfully(self):
949
 
        with self.assertRaises(SystemExit) as e:
950
 
            IsEnabledCmd().run(None, self.one_client)
951
 
        if e.exception.code is not None:
952
 
            self.assertEqual(e.exception.code, 0)
953
 
        else:
954
 
            self.assertIsNone(e.exception.code)
955
 
    def test_is_enabled_run_exits_with_failure(self):
956
 
        self.client.attributes["Enabled"] = dbus.Boolean(False)
957
 
        with self.assertRaises(SystemExit) as e:
958
 
            IsEnabledCmd().run(None, self.one_client)
959
 
        if isinstance(e.exception.code, int):
960
 
            self.assertNotEqual(e.exception.code, 0)
961
 
        else:
962
 
            self.assertIsNotNone(e.exception.code)
963
 
 
964
 
class TestRemoveCmd(TestCmd):
965
 
    def test_remove(self):
966
 
        class MockMandos(object):
967
 
            def __init__(self):
968
 
                self.calls = []
969
 
            def RemoveClient(self, dbus_path):
970
 
                self.calls.append(("RemoveClient", (dbus_path,)))
971
 
        mandos = MockMandos()
972
 
        super(TestRemoveCmd, self).setUp()
973
 
        RemoveCmd().run(mandos, self.clients)
974
 
        self.assertEqual(len(mandos.calls), 2)
975
 
        for client in self.clients:
976
 
            self.assertIn(("RemoveClient",
977
 
                           (client.__dbus_object_path__,)),
978
 
                          mandos.calls)
979
 
 
980
 
class TestApproveCmd(TestCmd):
981
 
    def test_approve(self):
982
 
        ApproveCmd().run(None, self.clients)
983
 
        for client in self.clients:
984
 
            self.assertIn(("Approve", (True, client_interface)),
985
 
                          client.calls)
986
 
 
987
 
class TestDenyCmd(TestCmd):
988
 
    def test_deny(self):
989
 
        DenyCmd().run(None, self.clients)
990
 
        for client in self.clients:
991
 
            self.assertIn(("Approve", (False, client_interface)),
992
 
                          client.calls)
993
 
 
994
 
class TestEnableCmd(TestCmd):
995
 
    def test_enable(self):
996
 
        for client in self.clients:
997
 
            client.attributes["Enabled"] = False
998
 
 
999
 
        EnableCmd().run(None, self.clients)
1000
 
 
1001
 
        for client in self.clients:
1002
 
            self.assertTrue(client.attributes["Enabled"])
1003
 
 
1004
 
class TestDisableCmd(TestCmd):
1005
 
    def test_disable(self):
1006
 
        DisableCmd().run(None, self.clients)
1007
 
 
1008
 
        for client in self.clients:
1009
 
            self.assertFalse(client.attributes["Enabled"])
 
1382
 
 
1383
class TestPrintTableCmd(TestCmd):
 
1384
    def test_normal(self):
 
1385
        output = PrintTableCmd().output(self.clients.values())
 
1386
        expected_output = "\n".join((
 
1387
            "Name   Enabled Timeout  Last Successful Check",
 
1388
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
 
1389
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
 
1390
        ))
 
1391
        self.assertEqual(output, expected_output)
 
1392
    def test_verbose(self):
 
1393
        output = PrintTableCmd(verbose=True).output(
 
1394
            self.clients.values())
 
1395
        columns = (
 
1396
            (
 
1397
                "Name   ",
 
1398
                "foo    ",
 
1399
                "barbar ",
 
1400
            ),(
 
1401
                "Enabled ",
 
1402
                "Yes     ",
 
1403
                "Yes     ",
 
1404
            ),(
 
1405
                "Timeout  ",
 
1406
                "00:05:00 ",
 
1407
                "00:05:00 ",
 
1408
            ),(
 
1409
                "Last Successful Check ",
 
1410
                "2019-02-03T00:00:00   ",
 
1411
                "2019-02-04T00:00:00   ",
 
1412
            ),(
 
1413
                "Created             ",
 
1414
                "2019-01-02T00:00:00 ",
 
1415
                "2019-01-03T00:00:00 ",
 
1416
            ),(
 
1417
                "Interval ",
 
1418
                "00:02:00 ",
 
1419
                "00:02:00 ",
 
1420
            ),(
 
1421
                "Host            ",
 
1422
                "foo.example.org ",
 
1423
                "192.0.2.3       ",
 
1424
            ),(
 
1425
                ("Key ID                                             "
 
1426
                 "              "),
 
1427
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
 
1428
                 "ea90a27cddb12 "),
 
1429
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
 
1430
                 "46c2b020f441c "),
 
1431
            ),(
 
1432
                "Fingerprint                              ",
 
1433
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
 
1434
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
 
1435
            ),(
 
1436
                "Check Is Running ",
 
1437
                "No               ",
 
1438
                "Yes              ",
 
1439
            ),(
 
1440
                "Last Enabled        ",
 
1441
                "2019-01-03T00:00:00 ",
 
1442
                "2019-01-04T00:00:00 ",
 
1443
            ),(
 
1444
                "Approval Is Pending ",
 
1445
                "No                  ",
 
1446
                "No                  ",
 
1447
            ),(
 
1448
                "Approved By Default ",
 
1449
                "Yes                 ",
 
1450
                "No                  ",
 
1451
            ),(
 
1452
                "Last Approval Request ",
 
1453
                "                      ",
 
1454
                "2019-01-03T00:00:00   ",
 
1455
            ),(
 
1456
                "Approval Delay ",
 
1457
                "00:00:00       ",
 
1458
                "00:00:30       ",
 
1459
            ),(
 
1460
                "Approval Duration ",
 
1461
                "00:00:01          ",
 
1462
                "1T02:03:05        ",
 
1463
            ),(
 
1464
                "Checker              ",
 
1465
                "fping -q -- %(host)s ",
 
1466
                ":                    ",
 
1467
            ),(
 
1468
                "Extended Timeout ",
 
1469
                "00:15:00         ",
 
1470
                "00:15:00         ",
 
1471
            ),(
 
1472
                "Expires             ",
 
1473
                "2019-02-04T00:00:00 ",
 
1474
                "2019-02-05T00:00:00 ",
 
1475
            ),(
 
1476
                "Last Checker Status",
 
1477
                "0                  ",
 
1478
                "-2                 ",
 
1479
            )
 
1480
        )
 
1481
        num_lines = max(len(rows) for rows in columns)
 
1482
        expected_output = "\n".join("".join(rows[line]
 
1483
                                            for rows in columns)
 
1484
                                    for line in range(num_lines))
 
1485
        self.assertEqual(output, expected_output)
 
1486
    def test_one_client(self):
 
1487
        output = PrintTableCmd().output(self.one_client.values())
 
1488
        expected_output = "\n".join((
 
1489
            "Name Enabled Timeout  Last Successful Check",
 
1490
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
 
1491
        ))
 
1492
        self.assertEqual(output, expected_output)
 
1493
 
 
1494
 
 
1495
class Unique(object):
 
1496
    """Class for objects which exist only to be unique objects, since
 
1497
unittest.mock.sentinel only exists in Python 3.3"""
 
1498
 
 
1499
 
 
1500
class TestPropertyCmd(TestCmd):
 
1501
    """Abstract class for tests of PropertyCmd classes"""
 
1502
    def runTest(self):
 
1503
        if not hasattr(self, "command"):
 
1504
            return
 
1505
        values_to_get = getattr(self, "values_to_get",
 
1506
                                self.values_to_set)
 
1507
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1508
                                              values_to_get):
 
1509
            for clientpath in self.clients:
 
1510
                client = self.bus.get_object(dbus_busname, clientpath)
 
1511
                old_value = client.attributes[self.propname]
 
1512
                self.assertNotIsInstance(old_value, Unique)
 
1513
                client.attributes[self.propname] = Unique()
 
1514
            self.run_command(value_to_set, self.clients)
 
1515
            for clientpath in self.clients:
 
1516
                client = self.bus.get_object(dbus_busname, clientpath)
 
1517
                value = client.attributes[self.propname]
 
1518
                self.assertNotIsInstance(value, Unique)
 
1519
                self.assertEqual(value, value_to_get)
 
1520
    def run_command(self, value, clients):
 
1521
        self.command().run(clients, self.bus)
 
1522
 
 
1523
 
 
1524
class TestEnableCmd(TestPropertyCmd):
 
1525
    command = EnableCmd
 
1526
    propname = "Enabled"
 
1527
    values_to_set = [dbus.Boolean(True)]
 
1528
 
 
1529
 
 
1530
class TestDisableCmd(TestPropertyCmd):
 
1531
    command = DisableCmd
 
1532
    propname = "Enabled"
 
1533
    values_to_set = [dbus.Boolean(False)]
 
1534
 
 
1535
 
 
1536
class TestBumpTimeoutCmd(TestPropertyCmd):
 
1537
    command = BumpTimeoutCmd
 
1538
    propname = "LastCheckedOK"
 
1539
    values_to_set = [""]
 
1540
 
 
1541
 
 
1542
class TestStartCheckerCmd(TestPropertyCmd):
 
1543
    command = StartCheckerCmd
 
1544
    propname = "CheckerRunning"
 
1545
    values_to_set = [dbus.Boolean(True)]
 
1546
 
 
1547
 
 
1548
class TestStopCheckerCmd(TestPropertyCmd):
 
1549
    command = StopCheckerCmd
 
1550
    propname = "CheckerRunning"
 
1551
    values_to_set = [dbus.Boolean(False)]
 
1552
 
 
1553
 
 
1554
class TestApproveByDefaultCmd(TestPropertyCmd):
 
1555
    command = ApproveByDefaultCmd
 
1556
    propname = "ApprovedByDefault"
 
1557
    values_to_set = [dbus.Boolean(True)]
 
1558
 
 
1559
 
 
1560
class TestDenyByDefaultCmd(TestPropertyCmd):
 
1561
    command = DenyByDefaultCmd
 
1562
    propname = "ApprovedByDefault"
 
1563
    values_to_set = [dbus.Boolean(False)]
 
1564
 
 
1565
 
 
1566
class TestPropertyValueCmd(TestPropertyCmd):
 
1567
    """Abstract class for tests of PropertyValueCmd classes"""
 
1568
    def runTest(self):
 
1569
        if type(self) is TestPropertyValueCmd:
 
1570
            return
 
1571
        return super(TestPropertyValueCmd, self).runTest()
 
1572
    def run_command(self, value, clients):
 
1573
        self.command(value).run(clients, self.bus)
 
1574
 
 
1575
 
 
1576
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1577
    command = SetCheckerCmd
 
1578
    propname = "Checker"
 
1579
    values_to_set = ["", ":", "fping -q -- %s"]
 
1580
 
 
1581
 
 
1582
class TestSetHostCmd(TestPropertyValueCmd):
 
1583
    command = SetHostCmd
 
1584
    propname = "Host"
 
1585
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1586
 
 
1587
 
 
1588
class TestSetSecretCmd(TestPropertyValueCmd):
 
1589
    command = SetSecretCmd
 
1590
    propname = "Secret"
 
1591
    values_to_set = [io.BytesIO(b""),
 
1592
                     io.BytesIO(b"secret\0xyzzy\nbar")]
 
1593
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1594
 
 
1595
 
 
1596
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1597
    command = SetTimeoutCmd
 
1598
    propname = "Timeout"
 
1599
    values_to_set = [datetime.timedelta(),
 
1600
                     datetime.timedelta(minutes=5),
 
1601
                     datetime.timedelta(seconds=1),
 
1602
                     datetime.timedelta(weeks=1),
 
1603
                     datetime.timedelta(weeks=52)]
 
1604
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1605
 
 
1606
 
 
1607
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1608
    command = SetExtendedTimeoutCmd
 
1609
    propname = "ExtendedTimeout"
 
1610
    values_to_set = [datetime.timedelta(),
 
1611
                     datetime.timedelta(minutes=5),
 
1612
                     datetime.timedelta(seconds=1),
 
1613
                     datetime.timedelta(weeks=1),
 
1614
                     datetime.timedelta(weeks=52)]
 
1615
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1616
 
 
1617
 
 
1618
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1619
    command = SetIntervalCmd
 
1620
    propname = "Interval"
 
1621
    values_to_set = [datetime.timedelta(),
 
1622
                     datetime.timedelta(minutes=5),
 
1623
                     datetime.timedelta(seconds=1),
 
1624
                     datetime.timedelta(weeks=1),
 
1625
                     datetime.timedelta(weeks=52)]
 
1626
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1627
 
 
1628
 
 
1629
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1630
    command = SetApprovalDelayCmd
 
1631
    propname = "ApprovalDelay"
 
1632
    values_to_set = [datetime.timedelta(),
 
1633
                     datetime.timedelta(minutes=5),
 
1634
                     datetime.timedelta(seconds=1),
 
1635
                     datetime.timedelta(weeks=1),
 
1636
                     datetime.timedelta(weeks=52)]
 
1637
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1638
 
 
1639
 
 
1640
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1641
    command = SetApprovalDurationCmd
 
1642
    propname = "ApprovalDuration"
 
1643
    values_to_set = [datetime.timedelta(),
 
1644
                     datetime.timedelta(minutes=5),
 
1645
                     datetime.timedelta(seconds=1),
 
1646
                     datetime.timedelta(weeks=1),
 
1647
                     datetime.timedelta(weeks=52)]
 
1648
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1010
1649
 
1011
1650
 
1012
1651