/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-09 23:55:43 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190309235543-g36rsz4ephch356t
mandos-ctl: Don't call D-Bus to get property for --is-enabled

* mandos-ctl (IsEnabledCmd.is_enabled): Check properties dict, don't
                                        use D-Bus.

Show diffs side-by-side

added added

removed removed

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