/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-07 20:37:15 UTC
  • Revision ID: teddy@recompile.se-20190307203715-nilyilg9adr8q7bm
mandos-ctl: Add tests for short options

* mandos-ctl
  (Test_command_from_options.test_print_table_verbose_short): New.
  (Test_command_from_options.test_enable_short): - '' -
  (Test_command_from_options.test_disable_short): - '' -
  (Test_command_from_options.test_bump_timeout_short): - '' -
  (Test_command_from_options.test_remove_short): - '' -
  (Test_command_from_options.test_checker_short): - '' -
  (Test_command_from_options.test_timeout_short): - '' -
  (Test_command_from_options.test_interval_short): - '' -
  (Test_command_from_options.test_host_short): - '' -
  (Test_command_from_options.test_secret_devnull_short): - '' -
  (Test_command_from_options.test_secret_tempfile_short): - '' -
  (Test_command_from_options.test_approve_short): - '' -
  (Test_command_from_options.test_deny_short): - '' -
  (Test_command_from_options.test_is_enabled_short): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
44
44
import logging
45
45
import io
46
46
import tempfile
47
 
import contextlib
48
47
 
49
48
import dbus
50
49
 
64
63
 
65
64
locale.setlocale(locale.LC_ALL, "")
66
65
 
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
 
66
domain = "se.recompile"
 
67
busname = domain + ".Mandos"
 
68
server_path = "/"
 
69
server_interface = domain + ".Mandos"
 
70
client_interface = domain + ".Mandos.Client"
73
71
version = "1.8.3"
74
72
 
75
73
 
79
77
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
78
 
81
79
 
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)
 
80
def milliseconds_to_string(ms):
 
81
    td = datetime.timedelta(0, 0, 0, ms)
 
82
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
83
            .format(days="{}T".format(td.days) if td.days else "",
 
84
                    hours=td.seconds // 3600,
 
85
                    minutes=(td.seconds % 3600) // 60,
 
86
                    seconds=td.seconds % 60))
231
87
 
232
88
 
233
89
def rfc3339_duration_to_delta(duration):
360
216
    return value
361
217
 
362
218
 
 
219
def string_to_delta(interval):
 
220
    """Parse a string and return a datetime.timedelta"""
 
221
 
 
222
    try:
 
223
        return rfc3339_duration_to_delta(interval)
 
224
    except ValueError as e:
 
225
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
226
                    ' '.join(e.args))
 
227
    return parse_pre_1_6_1_interval(interval)
 
228
 
 
229
 
363
230
def parse_pre_1_6_1_interval(interval):
364
231
    """Parse an interval string as documented by Mandos before 1.6.1,
365
232
    and return a datetime.timedelta
403
270
    return value
404
271
 
405
272
 
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
 
 
 
273
## Classes for commands.
 
274
 
 
275
# Abstract classes first
522
276
class Command(object):
523
277
    """Abstract class for commands"""
524
 
    def run(self, clients, bus=None, mandos=None):
 
278
    def run(self, mandos, clients):
525
279
        """Normal commands should implement run_on_one_client(), but
526
280
        commands which want to operate on all clients at the same time
527
281
        can override this run() method instead."""
528
282
        self.mandos = mandos
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
        for client, properties in clients.items():
533
284
            self.run_on_one_client(client, properties)
534
285
 
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"""
 
286
class PrintCmd(Command):
 
287
    """Abstract class for commands printing client details"""
572
288
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
573
289
                    "Created", "Interval", "Host", "KeyID",
574
290
                    "Fingerprint", "CheckerRunning", "LastEnabled",
576
292
                    "LastApprovalRequest", "ApprovalDelay",
577
293
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
578
294
                    "Expires", "LastCheckerStatus")
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):
 
295
    def run(self, mandos, clients):
 
296
        print(self.output(clients))
 
297
 
 
298
class PropertyCmd(Command):
 
299
    """Abstract class for Actions for setting one client property"""
 
300
    def run_on_one_client(self, client, properties):
 
301
        """Set the Client's D-Bus property"""
 
302
        client.Set(client_interface, self.property, self.value_to_set,
 
303
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
304
 
 
305
class ValueArgumentMixIn(object):
 
306
    """Mixin class for commands taking a value as argument"""
 
307
    def __init__(self, value):
 
308
        self.value_to_set = value
 
309
 
 
310
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
 
311
    """Mixin class for commands taking a value argument as
 
312
    milliseconds."""
 
313
    @property
 
314
    def value_to_set(self):
 
315
        return self._vts
 
316
    @value_to_set.setter
 
317
    def value_to_set(self, value):
 
318
        """When setting, convert value to a datetime.timedelta"""
 
319
        self._vts = int(round(value.total_seconds() * 1000))
 
320
 
 
321
# Actual (non-abstract) command classes
 
322
 
 
323
class PrintTableCmd(PrintCmd):
603
324
    def __init__(self, verbose=False):
604
325
        self.verbose = verbose
605
326
 
606
327
    def output(self, clients):
607
 
        default_keywords = ("Name", "Enabled", "Timeout",
608
 
                            "LastCheckedOK")
 
328
        default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
609
329
        keywords = default_keywords
610
330
        if self.verbose:
611
331
            keywords = self.all_keywords
612
 
        return str(self.TableOfClients(clients, keywords))
 
332
        return str(self.TableOfClients(clients.values(), keywords))
613
333
 
614
334
    class TableOfClients(object):
615
335
        tableheaders = {
635
355
            "LastCheckerStatus": "Last Checker Status",
636
356
        }
637
357
 
638
 
        def __init__(self, clients, keywords):
 
358
        def __init__(self, clients, keywords, tableheaders=None):
639
359
            self.clients = clients
640
360
            self.keywords = keywords
 
361
            if tableheaders is not None:
 
362
                self.tableheaders = tableheaders
641
363
 
642
364
        def __str__(self):
643
365
            return "\n".join(self.rows())
666
388
        def string_from_client(self, client, key):
667
389
            return self.valuetostring(client[key], key)
668
390
 
669
 
        @classmethod
670
 
        def valuetostring(cls, value, keyword):
 
391
        @staticmethod
 
392
        def valuetostring(value, keyword):
671
393
            if isinstance(value, dbus.Boolean):
672
394
                return "Yes" if value else "No"
673
395
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
674
396
                           "ApprovalDuration", "ExtendedTimeout"):
675
 
                return cls.milliseconds_to_string(value)
 
397
                return milliseconds_to_string(value)
676
398
            return str(value)
677
399
 
678
400
        def header_line(self, format_string):
683
405
                **{key: self.string_from_client(client, key)
684
406
                   for key in self.keywords})
685
407
 
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
 
 
 
408
 
 
409
 
 
410
class DumpJSONCmd(PrintCmd):
 
411
    def output(self, clients):
 
412
        data = {client["Name"]:
 
413
                {key: self.dbus_boolean_to_bool(client[key])
 
414
                 for key in self.all_keywords}
 
415
                for client in clients.values()}
 
416
        return json.dumps(data, indent=4, separators=(',', ': '))
 
417
    @staticmethod
 
418
    def dbus_boolean_to_bool(value):
 
419
        if isinstance(value, dbus.Boolean):
 
420
            value = bool(value)
 
421
        return value
 
422
 
 
423
class IsEnabledCmd(Command):
 
424
    def run_on_one_client(self, client, properties):
 
425
        if self.is_enabled(client, properties):
 
426
            sys.exit(0)
 
427
        sys.exit(1)
 
428
    def is_enabled(self, client, properties):
 
429
        return bool(properties["Enabled"])
 
430
 
 
431
class RemoveCmd(Command):
 
432
    def run_on_one_client(self, client, properties):
 
433
        self.mandos.RemoveClient(client.__dbus_object_path__)
 
434
 
 
435
class ApproveCmd(Command):
 
436
    def run_on_one_client(self, client, properties):
 
437
        client.Approve(dbus.Boolean(True),
 
438
                       dbus_interface=client_interface)
 
439
 
 
440
class DenyCmd(Command):
 
441
    def run_on_one_client(self, client, properties):
 
442
        client.Approve(dbus.Boolean(False),
 
443
                       dbus_interface=client_interface)
716
444
 
717
445
class EnableCmd(PropertyCmd):
718
 
    propname = "Enabled"
 
446
    property = "Enabled"
719
447
    value_to_set = dbus.Boolean(True)
720
448
 
721
 
 
722
449
class DisableCmd(PropertyCmd):
723
 
    propname = "Enabled"
 
450
    property = "Enabled"
724
451
    value_to_set = dbus.Boolean(False)
725
452
 
726
 
 
727
453
class BumpTimeoutCmd(PropertyCmd):
728
 
    propname = "LastCheckedOK"
 
454
    property = "LastCheckedOK"
729
455
    value_to_set = ""
730
456
 
731
 
 
732
457
class StartCheckerCmd(PropertyCmd):
733
 
    propname = "CheckerRunning"
 
458
    property = "CheckerRunning"
734
459
    value_to_set = dbus.Boolean(True)
735
460
 
736
 
 
737
461
class StopCheckerCmd(PropertyCmd):
738
 
    propname = "CheckerRunning"
 
462
    property = "CheckerRunning"
739
463
    value_to_set = dbus.Boolean(False)
740
464
 
741
 
 
742
465
class ApproveByDefaultCmd(PropertyCmd):
743
 
    propname = "ApprovedByDefault"
 
466
    property = "ApprovedByDefault"
744
467
    value_to_set = dbus.Boolean(True)
745
468
 
746
 
 
747
469
class DenyByDefaultCmd(PropertyCmd):
748
 
    propname = "ApprovedByDefault"
 
470
    property = "ApprovedByDefault"
749
471
    value_to_set = dbus.Boolean(False)
750
472
 
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
 
 
 
473
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
 
474
    property = "Checker"
 
475
 
 
476
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
 
477
    property = "Host"
 
478
 
 
479
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
769
480
    @property
770
481
    def value_to_set(self):
771
482
        return self._vts
772
 
 
773
483
    @value_to_set.setter
774
484
    def value_to_set(self, value):
775
485
        """When setting, read data from supplied file object"""
776
486
        self._vts = value.read()
777
487
        value.close()
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
 
 
 
488
    property = "Secret"
 
489
 
 
490
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
 
491
    property = "Timeout"
 
492
 
 
493
class SetExtendedTimeoutCmd(PropertyCmd,
 
494
                            MillisecondsValueArgumentMixIn):
 
495
    property = "ExtendedTimeout"
 
496
 
 
497
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
 
498
    property = "Interval"
 
499
 
 
500
class SetApprovalDelayCmd(PropertyCmd,
 
501
                          MillisecondsValueArgumentMixIn):
 
502
    property = "ApprovalDelay"
 
503
 
 
504
class SetApprovalDurationCmd(PropertyCmd,
 
505
                             MillisecondsValueArgumentMixIn):
 
506
    property = "ApprovalDuration"
 
507
 
 
508
def add_command_line_options(parser):
 
509
    parser.add_argument("--version", action="version",
 
510
                        version="%(prog)s {}".format(version),
 
511
                        help="show version number and exit")
 
512
    parser.add_argument("-a", "--all", action="store_true",
 
513
                        help="Select all clients")
 
514
    parser.add_argument("-v", "--verbose", action="store_true",
 
515
                        help="Print all fields")
 
516
    parser.add_argument("-j", "--dump-json", action="store_true",
 
517
                        help="Dump client data in JSON format")
 
518
    enable_disable = parser.add_mutually_exclusive_group()
 
519
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
520
                                help="Enable client")
 
521
    enable_disable.add_argument("-d", "--disable",
 
522
                                action="store_true",
 
523
                                help="disable client")
 
524
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
525
                        help="Bump timeout for client")
 
526
    start_stop_checker = parser.add_mutually_exclusive_group()
 
527
    start_stop_checker.add_argument("--start-checker",
 
528
                                    action="store_true",
 
529
                                    help="Start checker for client")
 
530
    start_stop_checker.add_argument("--stop-checker",
 
531
                                    action="store_true",
 
532
                                    help="Stop checker for client")
 
533
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
534
                        help="Check if client is enabled")
 
535
    parser.add_argument("-r", "--remove", action="store_true",
 
536
                        help="Remove client")
 
537
    parser.add_argument("-c", "--checker",
 
538
                        help="Set checker command for client")
 
539
    parser.add_argument("-t", "--timeout", type=string_to_delta,
 
540
                        help="Set timeout for client")
 
541
    parser.add_argument("--extended-timeout", type=string_to_delta,
 
542
                        help="Set extended timeout for client")
 
543
    parser.add_argument("-i", "--interval", type=string_to_delta,
 
544
                        help="Set checker interval for client")
 
545
    approve_deny_default = parser.add_mutually_exclusive_group()
 
546
    approve_deny_default.add_argument(
 
547
        "--approve-by-default", action="store_true",
 
548
        default=None, dest="approved_by_default",
 
549
        help="Set client to be approved by default")
 
550
    approve_deny_default.add_argument(
 
551
        "--deny-by-default", action="store_false",
 
552
        dest="approved_by_default",
 
553
        help="Set client to be denied by default")
 
554
    parser.add_argument("--approval-delay", type=string_to_delta,
 
555
                        help="Set delay before client approve/deny")
 
556
    parser.add_argument("--approval-duration", type=string_to_delta,
 
557
                        help="Set duration of one client approval")
 
558
    parser.add_argument("-H", "--host", help="Set host for client")
 
559
    parser.add_argument("-s", "--secret",
 
560
                        type=argparse.FileType(mode="rb"),
 
561
                        help="Set password blob (file) for client")
 
562
    approve_deny = parser.add_mutually_exclusive_group()
 
563
    approve_deny.add_argument(
 
564
        "-A", "--approve", action="store_true",
 
565
        help="Approve any current client request")
 
566
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
567
                              help="Deny any current client request")
 
568
    parser.add_argument("--check", action="store_true",
 
569
                        help="Run self-test")
 
570
    parser.add_argument("client", nargs="*", help="Client name")
 
571
 
 
572
 
 
573
def commands_from_options(options):
 
574
 
 
575
    commands = []
 
576
 
 
577
    if options.dump_json:
 
578
        commands.append(DumpJSONCmd())
 
579
 
 
580
    if options.enable:
 
581
        commands.append(EnableCmd())
 
582
 
 
583
    if options.disable:
 
584
        commands.append(DisableCmd())
 
585
 
 
586
    if options.bump_timeout:
 
587
        commands.append(BumpTimeoutCmd())
 
588
 
 
589
    if options.start_checker:
 
590
        commands.append(StartCheckerCmd())
 
591
 
 
592
    if options.stop_checker:
 
593
        commands.append(StopCheckerCmd())
 
594
 
 
595
    if options.is_enabled:
 
596
        commands.append(IsEnabledCmd())
 
597
 
 
598
    if options.remove:
 
599
        commands.append(RemoveCmd())
 
600
 
 
601
    if options.checker is not None:
 
602
        commands.append(SetCheckerCmd(options.checker))
 
603
 
 
604
    if options.timeout is not None:
 
605
        commands.append(SetTimeoutCmd(options.timeout))
 
606
 
 
607
    if options.extended_timeout:
 
608
        commands.append(
 
609
            SetExtendedTimeoutCmd(options.extended_timeout))
 
610
 
 
611
    if options.interval is not None:
 
612
        commands.append(SetIntervalCmd(options.interval))
 
613
 
 
614
    if options.approved_by_default is not None:
 
615
        if options.approved_by_default:
 
616
            commands.append(ApproveByDefaultCmd())
 
617
        else:
 
618
            commands.append(DenyByDefaultCmd())
 
619
 
 
620
    if options.approval_delay is not None:
 
621
        commands.append(SetApprovalDelayCmd(options.approval_delay))
 
622
 
 
623
    if options.approval_duration is not None:
 
624
        commands.append(
 
625
            SetApprovalDurationCmd(options.approval_duration))
 
626
 
 
627
    if options.host is not None:
 
628
        commands.append(SetHostCmd(options.host))
 
629
 
 
630
    if options.secret is not None:
 
631
        commands.append(SetSecretCmd(options.secret))
 
632
 
 
633
    if options.approve:
 
634
        commands.append(ApproveCmd())
 
635
 
 
636
    if options.deny:
 
637
        commands.append(DenyCmd())
 
638
 
 
639
    # If no command option has been given, show table of clients,
 
640
    # optionally verbosely
 
641
    if not commands:
 
642
        commands.append(PrintTableCmd(verbose=options.verbose))
 
643
 
 
644
    return commands
 
645
 
 
646
 
 
647
def main():
 
648
    parser = argparse.ArgumentParser()
 
649
 
 
650
    add_command_line_options(parser)
 
651
 
 
652
    options = parser.parse_args()
 
653
 
 
654
    def has_actions(options):
 
655
        return any((options.enable,
 
656
                    options.disable,
 
657
                    options.bump_timeout,
 
658
                    options.start_checker,
 
659
                    options.stop_checker,
 
660
                    options.is_enabled,
 
661
                    options.remove,
 
662
                    options.checker is not None,
 
663
                    options.timeout is not None,
 
664
                    options.extended_timeout is not None,
 
665
                    options.interval is not None,
 
666
                    options.approved_by_default is not None,
 
667
                    options.approval_delay is not None,
 
668
                    options.approval_duration is not None,
 
669
                    options.host is not None,
 
670
                    options.secret is not None,
 
671
                    options.approve,
 
672
                    options.deny))
 
673
 
 
674
    if has_actions(options) and not (options.client or options.all):
 
675
        parser.error("Options require clients names or --all.")
 
676
    if options.verbose and has_actions(options):
 
677
        parser.error("--verbose can only be used alone.")
 
678
    if options.dump_json and (options.verbose
 
679
                              or has_actions(options)):
 
680
        parser.error("--dump-json can only be used alone.")
 
681
    if options.all and not has_actions(options):
 
682
        parser.error("--all requires an action.")
 
683
    if options.is_enabled and len(options.client) > 1:
 
684
        parser.error("--is-enabled requires exactly one client")
 
685
 
 
686
    clientnames = options.client
 
687
 
 
688
    try:
 
689
        bus = dbus.SystemBus()
 
690
        mandos_dbus_objc = bus.get_object(busname, server_path)
 
691
    except dbus.exceptions.DBusException:
 
692
        log.critical("Could not connect to Mandos server")
 
693
        sys.exit(1)
 
694
 
 
695
    mandos_serv = dbus.Interface(mandos_dbus_objc,
 
696
                                 dbus_interface=server_interface)
 
697
    mandos_serv_object_manager = dbus.Interface(
 
698
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
699
 
 
700
    # Filter out log message from dbus module
 
701
    dbus_logger = logging.getLogger("dbus.proxies")
 
702
    class NullFilter(logging.Filter):
 
703
        def filter(self, record):
 
704
            return False
 
705
    dbus_filter = NullFilter()
 
706
    try:
 
707
        dbus_logger.addFilter(dbus_filter)
 
708
        mandos_clients = {path: ifs_and_props[client_interface]
 
709
                          for path, ifs_and_props in
 
710
                          mandos_serv_object_manager
 
711
                          .GetManagedObjects().items()
 
712
                          if client_interface in ifs_and_props}
 
713
    except dbus.exceptions.DBusException as e:
 
714
        log.critical("Failed to access Mandos server through D-Bus:"
 
715
                     "\n%s", e)
 
716
        sys.exit(1)
 
717
    finally:
 
718
        # restore dbus logger
 
719
        dbus_logger.removeFilter(dbus_filter)
 
720
 
 
721
    # Compile dict of (clients: properties) to process
 
722
    clients = {}
 
723
 
 
724
    if not clientnames:
 
725
        clients = {bus.get_object(busname, path): properties
 
726
                   for path, properties in mandos_clients.items()}
 
727
    else:
 
728
        for name in clientnames:
 
729
            for path, client in mandos_clients.items():
 
730
                if client["Name"] == name:
 
731
                    client_objc = bus.get_object(busname, path)
 
732
                    clients[client_objc] = client
 
733
                    break
 
734
            else:
 
735
                log.critical("Client not found on server: %r", name)
 
736
                sys.exit(1)
 
737
 
 
738
    # Run all commands on clients
 
739
    commands = commands_from_options(options)
 
740
    for command in commands:
 
741
        command.run(mandos_serv, clients)
813
742
 
814
743
 
 
744
class Test_milliseconds_to_string(unittest.TestCase):
 
745
    def test_all(self):
 
746
        self.assertEqual(milliseconds_to_string(93785000),
 
747
                         "1T02:03:05")
 
748
    def test_no_days(self):
 
749
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
750
    def test_all_zero(self):
 
751
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
752
    def test_no_fractional_seconds(self):
 
753
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
754
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
755
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
756
 
815
757
class Test_string_to_delta(unittest.TestCase):
816
758
    def test_handles_basic_rfc3339(self):
817
759
        self.assertEqual(string_to_delta("PT0S"),
822
764
                         datetime.timedelta(0, 1))
823
765
        self.assertEqual(string_to_delta("PT2H"),
824
766
                         datetime.timedelta(0, 7200))
825
 
 
826
767
    def test_falls_back_to_pre_1_6_1_with_warning(self):
827
768
        # assertLogs only exists in Python 3.4
828
769
        if hasattr(self, "assertLogs"):
846
787
        self.assertEqual(value, datetime.timedelta(0, 7200))
847
788
 
848
789
 
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
 
 
1181
790
class TestCmd(unittest.TestCase):
1182
791
    """Abstract class for tests of command classes"""
1183
 
 
1184
792
    def setUp(self):
1185
793
        testcase = self
1186
794
        class MockClient(object):
1187
795
            def __init__(self, name, **attributes):
1188
 
                self.__dbus_object_path__ = "/clients/{}".format(name)
 
796
                self.__dbus_object_path__ = "objpath_{}".format(name)
1189
797
                self.attributes = attributes
1190
798
                self.attributes["Name"] = name
1191
799
                self.calls = []
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]
 
800
            def Set(self, interface, property, value, dbus_interface):
 
801
                testcase.assertEqual(interface, client_interface)
 
802
                testcase.assertEqual(dbus_interface,
 
803
                                     dbus.PROPERTIES_IFACE)
 
804
                self.attributes[property] = value
 
805
            def Get(self, interface, property, dbus_interface):
 
806
                testcase.assertEqual(interface, client_interface)
 
807
                testcase.assertEqual(dbus_interface,
 
808
                                     dbus.PROPERTIES_IFACE)
 
809
                return self.attributes[property]
1202
810
            def Approve(self, approve, dbus_interface):
1203
 
                testcase.assertEqual(dbus_interface,
1204
 
                                     client_dbus_interface)
 
811
                testcase.assertEqual(dbus_interface, client_interface)
1205
812
                self.calls.append(("Approve", (approve,
1206
813
                                               dbus_interface)))
1207
814
        self.client = MockClient(
1247
854
            ApprovedByDefault=dbus.Boolean(False),
1248
855
            LastApprovalRequest="2019-01-03T00:00:00",
1249
856
            ApprovalDelay=30000,
1250
 
            ApprovalDuration=93785000,
 
857
            ApprovalDuration=1000,
1251
858
            Checker=":",
1252
859
            ExtendedTimeout=900000,
1253
860
            Expires="2019-02-05T00:00:00",
1254
861
            LastCheckerStatus=-2)
1255
862
        self.clients =  collections.OrderedDict(
1256
863
            [
1257
 
                ("/clients/foo", self.client.attributes),
1258
 
                ("/clients/barbar", self.other_client.attributes),
 
864
                (self.client, self.client.attributes),
 
865
                (self.other_client, self.other_client.attributes),
1259
866
            ])
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
 
 
 
867
        self.one_client = {self.client: self.client.attributes}
 
868
 
 
869
class TestPrintTableCmd(TestCmd):
 
870
    def test_normal(self):
 
871
        output = PrintTableCmd().output(self.clients)
 
872
        expected_output = """
 
873
Name   Enabled Timeout  Last Successful Check
 
874
foo    Yes     00:05:00 2019-02-03T00:00:00  
 
875
barbar Yes     00:05:00 2019-02-04T00:00:00  
 
876
"""[1:-1]
 
877
        self.assertEqual(output, expected_output)
 
878
    def test_verbose(self):
 
879
        output = PrintTableCmd(verbose=True).output(self.clients)
 
880
        expected_output = """
 
881
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
 
882
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                  
 
883
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                 
 
884
"""[1:-1]
 
885
        self.assertEqual(output, expected_output)
 
886
    def test_one_client(self):
 
887
        output = PrintTableCmd().output(self.one_client)
 
888
        expected_output = """
 
889
Name Enabled Timeout  Last Successful Check
 
890
foo  Yes     00:05:00 2019-02-03T00:00:00  
 
891
"""[1:-1]
 
892
        self.assertEqual(output, expected_output)
1335
893
 
1336
894
class TestDumpJSONCmd(TestCmd):
1337
895
    def setUp(self):
1378
936
                "ApprovedByDefault": False,
1379
937
                "LastApprovalRequest": "2019-01-03T00:00:00",
1380
938
                "ApprovalDelay": 30000,
1381
 
                "ApprovalDuration": 93785000,
 
939
                "ApprovalDuration": 1000,
1382
940
                "Checker": ":",
1383
941
                "ExtendedTimeout": 900000,
1384
942
                "Expires": "2019-02-05T00:00:00",
1386
944
            },
1387
945
        }
1388
946
        return super(TestDumpJSONCmd, self).setUp()
1389
 
 
1390
947
    def test_normal(self):
1391
 
        output = DumpJSONCmd().output(self.clients.values())
1392
 
        json_data = json.loads(output)
 
948
        json_data = json.loads(DumpJSONCmd().output(self.clients))
1393
949
        self.assertDictEqual(json_data, self.expected_json)
1394
 
 
1395
950
    def test_one_client(self):
1396
 
        output = DumpJSONCmd().output(self.one_client.values())
1397
 
        json_data = json.loads(output)
 
951
        clients = self.one_client
 
952
        json_data = json.loads(DumpJSONCmd().output(clients))
1398
953
        expected_json = {"foo": self.expected_json["foo"]}
1399
954
        self.assertDictEqual(json_data, expected_json)
1400
955
 
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
 
 
 
956
class TestIsEnabledCmd(TestCmd):
 
957
    def test_is_enabled(self):
 
958
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
 
959
                            for client, properties in self.clients.items()))
 
960
    def test_is_enabled_run_exits_successfully(self):
 
961
        with self.assertRaises(SystemExit) as e:
 
962
            IsEnabledCmd().run(None, self.one_client)
 
963
        if e.exception.code is not None:
 
964
            self.assertEqual(e.exception.code, 0)
 
965
        else:
 
966
            self.assertIsNone(e.exception.code)
 
967
    def test_is_enabled_run_exits_with_failure(self):
 
968
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
969
        with self.assertRaises(SystemExit) as e:
 
970
            IsEnabledCmd().run(None, self.one_client)
 
971
        if isinstance(e.exception.code, int):
 
972
            self.assertNotEqual(e.exception.code, 0)
 
973
        else:
 
974
            self.assertIsNotNone(e.exception.code)
 
975
 
 
976
class TestRemoveCmd(TestCmd):
 
977
    def test_remove(self):
 
978
        class MockMandos(object):
 
979
            def __init__(self):
 
980
                self.calls = []
 
981
            def RemoveClient(self, dbus_path):
 
982
                self.calls.append(("RemoveClient", (dbus_path,)))
 
983
        mandos = MockMandos()
 
984
        super(TestRemoveCmd, self).setUp()
 
985
        RemoveCmd().run(mandos, self.clients)
 
986
        self.assertEqual(len(mandos.calls), 2)
 
987
        for client in self.clients:
 
988
            self.assertIn(("RemoveClient",
 
989
                           (client.__dbus_object_path__,)),
 
990
                          mandos.calls)
 
991
 
 
992
class TestApproveCmd(TestCmd):
 
993
    def test_approve(self):
 
994
        ApproveCmd().run(None, self.clients)
 
995
        for client in self.clients:
 
996
            self.assertIn(("Approve", (True, client_interface)),
 
997
                          client.calls)
 
998
 
 
999
class TestDenyCmd(TestCmd):
 
1000
    def test_deny(self):
 
1001
        DenyCmd().run(None, self.clients)
 
1002
        for client in self.clients:
 
1003
            self.assertIn(("Approve", (False, client_interface)),
 
1004
                          client.calls)
 
1005
 
 
1006
class TestEnableCmd(TestCmd):
 
1007
    def test_enable(self):
 
1008
        for client in self.clients:
 
1009
            client.attributes["Enabled"] = False
 
1010
 
 
1011
        EnableCmd().run(None, self.clients)
 
1012
 
 
1013
        for client in self.clients:
 
1014
            self.assertTrue(client.attributes["Enabled"])
 
1015
 
 
1016
class TestDisableCmd(TestCmd):
 
1017
    def test_disable(self):
 
1018
        DisableCmd().run(None, self.clients)
 
1019
 
 
1020
        for client in self.clients:
 
1021
            self.assertFalse(client.attributes["Enabled"])
 
1022
 
 
1023
class Unique(object):
 
1024
    """Class for objects which exist only to be unique objects, since
 
1025
unittest.mock.sentinel only exists in Python 3.3"""
1515
1026
 
1516
1027
class TestPropertyCmd(TestCmd):
1517
1028
    """Abstract class for tests of PropertyCmd classes"""
1522
1033
                                self.values_to_set)
1523
1034
        for value_to_set, value_to_get in zip(self.values_to_set,
1524
1035
                                              values_to_get):
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()
 
1036
            for client in self.clients:
 
1037
                old_value = client.attributes[self.property]
 
1038
                self.assertNotIsInstance(old_value, Unique)
 
1039
                client.attributes[self.property] = Unique()
1530
1040
            self.run_command(value_to_set, self.clients)
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)
 
1041
            for client in self.clients:
 
1042
                value = client.attributes[self.property]
 
1043
                self.assertNotIsInstance(value, Unique)
1535
1044
                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
 
 
1541
1045
    def run_command(self, value, 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
        self.command().run(None, clients)
1556
1047
 
1557
1048
class TestBumpTimeoutCmd(TestPropertyCmd):
1558
1049
    command = BumpTimeoutCmd
1559
 
    propname = "LastCheckedOK"
 
1050
    property = "LastCheckedOK"
1560
1051
    values_to_set = [""]
1561
1052
 
1562
 
 
1563
1053
class TestStartCheckerCmd(TestPropertyCmd):
1564
1054
    command = StartCheckerCmd
1565
 
    propname = "CheckerRunning"
 
1055
    property = "CheckerRunning"
1566
1056
    values_to_set = [dbus.Boolean(True)]
1567
1057
 
1568
 
 
1569
1058
class TestStopCheckerCmd(TestPropertyCmd):
1570
1059
    command = StopCheckerCmd
1571
 
    propname = "CheckerRunning"
 
1060
    property = "CheckerRunning"
1572
1061
    values_to_set = [dbus.Boolean(False)]
1573
1062
 
1574
 
 
1575
1063
class TestApproveByDefaultCmd(TestPropertyCmd):
1576
1064
    command = ApproveByDefaultCmd
1577
 
    propname = "ApprovedByDefault"
 
1065
    property = "ApprovedByDefault"
1578
1066
    values_to_set = [dbus.Boolean(True)]
1579
1067
 
1580
 
 
1581
1068
class TestDenyByDefaultCmd(TestPropertyCmd):
1582
1069
    command = DenyByDefaultCmd
1583
 
    propname = "ApprovedByDefault"
 
1070
    property = "ApprovedByDefault"
1584
1071
    values_to_set = [dbus.Boolean(False)]
1585
1072
 
1586
 
 
1587
 
class TestPropertyValueCmd(TestPropertyCmd):
1588
 
    """Abstract class for tests of PropertyValueCmd classes"""
1589
 
 
 
1073
class TestValueArgumentPropertyCmd(TestPropertyCmd):
 
1074
    """Abstract class for tests of PropertyCmd classes using the
 
1075
ValueArgumentMixIn"""
1590
1076
    def runTest(self):
1591
 
        if type(self) is TestPropertyValueCmd:
 
1077
        if type(self) is TestValueArgumentPropertyCmd:
1592
1078
            return
1593
 
        return super(TestPropertyValueCmd, self).runTest()
1594
 
 
 
1079
        return super(TestValueArgumentPropertyCmd, self).runTest()
1595
1080
    def run_command(self, value, clients):
1596
 
        self.command(value).run(clients, self.bus)
1597
 
 
1598
 
 
1599
 
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1081
        self.command(value).run(None, clients)
 
1082
 
 
1083
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1600
1084
    command = SetCheckerCmd
1601
 
    propname = "Checker"
 
1085
    property = "Checker"
1602
1086
    values_to_set = ["", ":", "fping -q -- %s"]
1603
1087
 
1604
 
 
1605
 
class TestSetHostCmd(TestPropertyValueCmd):
 
1088
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1606
1089
    command = SetHostCmd
1607
 
    propname = "Host"
 
1090
    property = "Host"
1608
1091
    values_to_set = ["192.0.2.3", "foo.example.org"]
1609
1092
 
1610
 
 
1611
 
class TestSetSecretCmd(TestPropertyValueCmd):
 
1093
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1612
1094
    command = SetSecretCmd
1613
 
    propname = "Secret"
1614
 
    values_to_set = [io.BytesIO(b""),
 
1095
    property = "Secret"
 
1096
    values_to_set = [open("/dev/null", "rb"),
1615
1097
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1616
1098
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
1617
1099
 
1618
 
 
1619
 
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1100
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1620
1101
    command = SetTimeoutCmd
1621
 
    propname = "Timeout"
 
1102
    property = "Timeout"
1622
1103
    values_to_set = [datetime.timedelta(),
1623
1104
                     datetime.timedelta(minutes=5),
1624
1105
                     datetime.timedelta(seconds=1),
1626
1107
                     datetime.timedelta(weeks=52)]
1627
1108
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1628
1109
 
1629
 
 
1630
 
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1110
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1631
1111
    command = SetExtendedTimeoutCmd
1632
 
    propname = "ExtendedTimeout"
 
1112
    property = "ExtendedTimeout"
1633
1113
    values_to_set = [datetime.timedelta(),
1634
1114
                     datetime.timedelta(minutes=5),
1635
1115
                     datetime.timedelta(seconds=1),
1637
1117
                     datetime.timedelta(weeks=52)]
1638
1118
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1639
1119
 
1640
 
 
1641
 
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1120
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1642
1121
    command = SetIntervalCmd
1643
 
    propname = "Interval"
 
1122
    property = "Interval"
1644
1123
    values_to_set = [datetime.timedelta(),
1645
1124
                     datetime.timedelta(minutes=5),
1646
1125
                     datetime.timedelta(seconds=1),
1648
1127
                     datetime.timedelta(weeks=52)]
1649
1128
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1650
1129
 
1651
 
 
1652
 
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1130
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1653
1131
    command = SetApprovalDelayCmd
1654
 
    propname = "ApprovalDelay"
 
1132
    property = "ApprovalDelay"
1655
1133
    values_to_set = [datetime.timedelta(),
1656
1134
                     datetime.timedelta(minutes=5),
1657
1135
                     datetime.timedelta(seconds=1),
1659
1137
                     datetime.timedelta(weeks=52)]
1660
1138
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1661
1139
 
1662
 
 
1663
 
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1140
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1664
1141
    command = SetApprovalDurationCmd
1665
 
    propname = "ApprovalDuration"
 
1142
    property = "ApprovalDuration"
1666
1143
    values_to_set = [datetime.timedelta(),
1667
1144
                     datetime.timedelta(minutes=5),
1668
1145
                     datetime.timedelta(seconds=1),
1670
1147
                     datetime.timedelta(weeks=52)]
1671
1148
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1672
1149
 
 
1150
class Test_command_from_options(unittest.TestCase):
 
1151
    def setUp(self):
 
1152
        self.parser = argparse.ArgumentParser()
 
1153
        add_command_line_options(self.parser)
 
1154
    def assert_command_from_args(self, args, command_cls, **cmd_attrs):
 
1155
        """Assert that parsing ARGS should result in an instance of
 
1156
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
 
1157
        options = self.parser.parse_args(args)
 
1158
        commands = commands_from_options(options)
 
1159
        self.assertEqual(len(commands), 1)
 
1160
        command = commands[0]
 
1161
        self.assertIsInstance(command, command_cls)
 
1162
        for key, value in cmd_attrs.items():
 
1163
            self.assertEqual(getattr(command, key), value)
 
1164
    def test_print_table(self):
 
1165
        self.assert_command_from_args([], PrintTableCmd,
 
1166
                                      verbose=False)
 
1167
 
 
1168
    def test_print_table_verbose(self):
 
1169
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
 
1170
                                      verbose=True)
 
1171
 
 
1172
    def test_print_table_verbose_short(self):
 
1173
        self.assert_command_from_args(["-v"], PrintTableCmd,
 
1174
                                      verbose=True)
 
1175
 
 
1176
    def test_enable(self):
 
1177
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
 
1178
 
 
1179
    def test_enable_short(self):
 
1180
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
 
1181
 
 
1182
    def test_disable(self):
 
1183
        self.assert_command_from_args(["--disable", "foo"],
 
1184
                                      DisableCmd)
 
1185
 
 
1186
    def test_disable_short(self):
 
1187
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
 
1188
 
 
1189
    def test_bump_timeout(self):
 
1190
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1191
                                      BumpTimeoutCmd)
 
1192
 
 
1193
    def test_bump_timeout_short(self):
 
1194
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
 
1195
 
 
1196
    def test_start_checker(self):
 
1197
        self.assert_command_from_args(["--start-checker", "foo"],
 
1198
                                      StartCheckerCmd)
 
1199
 
 
1200
    def test_stop_checker(self):
 
1201
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1202
                                      StopCheckerCmd)
 
1203
 
 
1204
    def test_remove(self):
 
1205
        self.assert_command_from_args(["--remove", "foo"],
 
1206
                                      RemoveCmd)
 
1207
 
 
1208
    def test_remove_short(self):
 
1209
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
 
1210
 
 
1211
    def test_checker(self):
 
1212
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1213
                                      SetCheckerCmd, value_to_set=":")
 
1214
 
 
1215
    def test_checker_empty(self):
 
1216
        self.assert_command_from_args(["--checker", "", "foo"],
 
1217
                                      SetCheckerCmd, value_to_set="")
 
1218
 
 
1219
    def test_checker_short(self):
 
1220
        self.assert_command_from_args(["-c", ":", "foo"],
 
1221
                                      SetCheckerCmd, value_to_set=":")
 
1222
 
 
1223
    def test_timeout(self):
 
1224
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1225
                                      SetTimeoutCmd,
 
1226
                                      value_to_set=300000)
 
1227
 
 
1228
    def test_timeout_short(self):
 
1229
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1230
                                      SetTimeoutCmd,
 
1231
                                      value_to_set=300000)
 
1232
 
 
1233
    def test_extended_timeout(self):
 
1234
        self.assert_command_from_args(["--extended-timeout", "PT15M",
 
1235
                                       "foo"],
 
1236
                                      SetExtendedTimeoutCmd,
 
1237
                                      value_to_set=900000)
 
1238
 
 
1239
    def test_interval(self):
 
1240
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1241
                                      SetIntervalCmd,
 
1242
                                      value_to_set=120000)
 
1243
 
 
1244
    def test_interval_short(self):
 
1245
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1246
                                      SetIntervalCmd,
 
1247
                                      value_to_set=120000)
 
1248
 
 
1249
    def test_approve_by_default(self):
 
1250
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1251
                                      ApproveByDefaultCmd)
 
1252
 
 
1253
    def test_deny_by_default(self):
 
1254
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1255
                                      DenyByDefaultCmd)
 
1256
 
 
1257
    def test_approval_delay(self):
 
1258
        self.assert_command_from_args(["--approval-delay", "PT30S",
 
1259
                                       "foo"], SetApprovalDelayCmd,
 
1260
                                      value_to_set=30000)
 
1261
 
 
1262
    def test_approval_duration(self):
 
1263
        self.assert_command_from_args(["--approval-duration", "PT1S",
 
1264
                                       "foo"], SetApprovalDurationCmd,
 
1265
                                      value_to_set=1000)
 
1266
 
 
1267
    def test_host(self):
 
1268
        self.assert_command_from_args(["--host", "foo.example.org",
 
1269
                                       "foo"], SetHostCmd,
 
1270
                                      value_to_set="foo.example.org")
 
1271
 
 
1272
    def test_host_short(self):
 
1273
        self.assert_command_from_args(["-H", "foo.example.org",
 
1274
                                       "foo"], SetHostCmd,
 
1275
                                      value_to_set="foo.example.org")
 
1276
 
 
1277
    def test_secret_devnull(self):
 
1278
        self.assert_command_from_args(["--secret", os.path.devnull,
 
1279
                                       "foo"], SetSecretCmd,
 
1280
                                      value_to_set=b"")
 
1281
 
 
1282
    def test_secret_tempfile(self):
 
1283
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1284
            value = b"secret\0xyzzy\nbar"
 
1285
            f.write(value)
 
1286
            f.seek(0)
 
1287
            self.assert_command_from_args(["--secret", f.name,
 
1288
                                           "foo"], SetSecretCmd,
 
1289
                                          value_to_set=value)
 
1290
 
 
1291
    def test_secret_devnull_short(self):
 
1292
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1293
                                      SetSecretCmd, value_to_set=b"")
 
1294
 
 
1295
    def test_secret_tempfile_short(self):
 
1296
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1297
            value = b"secret\0xyzzy\nbar"
 
1298
            f.write(value)
 
1299
            f.seek(0)
 
1300
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1301
                                          SetSecretCmd,
 
1302
                                          value_to_set=value)
 
1303
 
 
1304
    def test_approve(self):
 
1305
        self.assert_command_from_args(["--approve", "foo"],
 
1306
                                      ApproveCmd)
 
1307
 
 
1308
    def test_approve_short(self):
 
1309
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
 
1310
 
 
1311
    def test_deny(self):
 
1312
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
 
1313
 
 
1314
    def test_deny_short(self):
 
1315
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
 
1316
 
 
1317
    def test_dump_json(self):
 
1318
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
 
1319
 
 
1320
    def test_is_enabled(self):
 
1321
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1322
                                      IsEnabledCmd)
 
1323
 
 
1324
    def test_is_enabled_short(self):
 
1325
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
 
1326
 
1673
1327
 
1674
1328
 
1675
1329
def should_only_run_tests():