/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-06 22:24:59 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190306222459-7q5j7dqwtiiwglg7
mandos-ctl.xml: Fix documentation bug

* mandos-ctl.xml (SYNOPSIS): Remove duplicate "--interval" option.

Show diffs side-by-side

added added

removed removed

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