/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-14 17:40:10 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190314174010-s0e2h0oq732ehilj
mandos-ctl: Refactor

* mandos-ctl (main): Rename "mandos_clients" to "all_clients".  When
                     no clients are given as options, use all_clients
                     directly instead of constructing a new dict.

Show diffs side-by-side

added added

removed removed

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