/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-17 11:19:58 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190317111958-vpq5pvd70hdijadj
mandos-ctl: Refactor

* mandos-ctl (TestBaseCommands): Rename test methods to match names of
                                 tested command.
  (TestBaseCommands.test_is_enabled): Rename to "test_IsEnabled".
  (TestBaseCommands.test_is_enabled_run_exits_successfully): Rename to
                              "test_IsEnabled_run_exits_successfully".
  (TestBaseCommands.test_is_enabled_run_exits_with_failure): Rename to
                              "test_IsEnabled_run_exits_with_failure".
  (TestBaseCommands.test_approve): Rename to "test_Approve".
  (TestBaseCommands.test_deny): Rename to "test_Deny".
  (TestBaseCommands.test_remove): Rename to "test_Remove".

Show diffs side-by-side

added added

removed removed

Lines of Context:
64
64
 
65
65
locale.setlocale(locale.LC_ALL, "")
66
66
 
67
 
domain = "se.recompile"
68
 
busname = domain + ".Mandos"
69
 
server_path = "/"
70
 
server_interface = domain + ".Mandos"
71
 
client_interface = domain + ".Mandos.Client"
 
67
dbus_busname_domain = "se.recompile"
 
68
dbus_busname = dbus_busname_domain + ".Mandos"
 
69
server_dbus_path = "/"
 
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
 
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
 
72
del dbus_busname_domain
72
73
version = "1.8.3"
73
74
 
74
75
 
78
79
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
79
80
 
80
81
 
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))
 
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
    bus = dbus.SystemBus()
 
97
 
 
98
    mandos_dbus_object = get_mandos_dbus_object(bus)
 
99
 
 
100
    mandos_serv = dbus.Interface(
 
101
        mandos_dbus_object, dbus_interface=server_dbus_interface)
 
102
    mandos_serv_object_manager = dbus.Interface(
 
103
        mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
104
 
 
105
    managed_objects = get_managed_objects(mandos_serv_object_manager)
 
106
 
 
107
    all_clients = {}
 
108
    for path, ifs_and_props in managed_objects.items():
 
109
        try:
 
110
            all_clients[path] = ifs_and_props[client_dbus_interface]
 
111
        except KeyError:
 
112
            pass
 
113
 
 
114
    # Compile dict of (clientpath: properties) to process
 
115
    if not clientnames:
 
116
        clients = all_clients
 
117
    else:
 
118
        clients = {}
 
119
        for name in clientnames:
 
120
            for objpath, properties in all_clients.items():
 
121
                if properties["Name"] == name:
 
122
                    clients[objpath] = properties
 
123
                    break
 
124
            else:
 
125
                log.critical("Client not found on server: %r", name)
 
126
                sys.exit(1)
 
127
 
 
128
    commands = commands_from_options(options)
 
129
 
 
130
    for command in commands:
 
131
        command.run(clients, bus, mandos_serv)
 
132
 
 
133
 
 
134
def add_command_line_options(parser):
 
135
    parser.add_argument("--version", action="version",
 
136
                        version="%(prog)s {}".format(version),
 
137
                        help="show version number and exit")
 
138
    parser.add_argument("-a", "--all", action="store_true",
 
139
                        help="Select all clients")
 
140
    parser.add_argument("-v", "--verbose", action="store_true",
 
141
                        help="Print all fields")
 
142
    parser.add_argument("-j", "--dump-json", action="store_true",
 
143
                        help="Dump client data in JSON format")
 
144
    enable_disable = parser.add_mutually_exclusive_group()
 
145
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
146
                                help="Enable client")
 
147
    enable_disable.add_argument("-d", "--disable",
 
148
                                action="store_true",
 
149
                                help="disable client")
 
150
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
151
                        help="Bump timeout for client")
 
152
    start_stop_checker = parser.add_mutually_exclusive_group()
 
153
    start_stop_checker.add_argument("--start-checker",
 
154
                                    action="store_true",
 
155
                                    help="Start checker for client")
 
156
    start_stop_checker.add_argument("--stop-checker",
 
157
                                    action="store_true",
 
158
                                    help="Stop checker for client")
 
159
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
160
                        help="Check if client is enabled")
 
161
    parser.add_argument("-r", "--remove", action="store_true",
 
162
                        help="Remove client")
 
163
    parser.add_argument("-c", "--checker",
 
164
                        help="Set checker command for client")
 
165
    parser.add_argument("-t", "--timeout", type=string_to_delta,
 
166
                        help="Set timeout for client")
 
167
    parser.add_argument("--extended-timeout", type=string_to_delta,
 
168
                        help="Set extended timeout for client")
 
169
    parser.add_argument("-i", "--interval", type=string_to_delta,
 
170
                        help="Set checker interval for client")
 
171
    approve_deny_default = parser.add_mutually_exclusive_group()
 
172
    approve_deny_default.add_argument(
 
173
        "--approve-by-default", action="store_true",
 
174
        default=None, dest="approved_by_default",
 
175
        help="Set client to be approved by default")
 
176
    approve_deny_default.add_argument(
 
177
        "--deny-by-default", action="store_false",
 
178
        dest="approved_by_default",
 
179
        help="Set client to be denied by default")
 
180
    parser.add_argument("--approval-delay", type=string_to_delta,
 
181
                        help="Set delay before client approve/deny")
 
182
    parser.add_argument("--approval-duration", type=string_to_delta,
 
183
                        help="Set duration of one client approval")
 
184
    parser.add_argument("-H", "--host", help="Set host for client")
 
185
    parser.add_argument("-s", "--secret",
 
186
                        type=argparse.FileType(mode="rb"),
 
187
                        help="Set password blob (file) for client")
 
188
    approve_deny = parser.add_mutually_exclusive_group()
 
189
    approve_deny.add_argument(
 
190
        "-A", "--approve", action="store_true",
 
191
        help="Approve any current client request")
 
192
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
193
                              help="Deny any current client request")
 
194
    parser.add_argument("--debug", action="store_true",
 
195
                        help="Debug mode (show D-Bus commands)")
 
196
    parser.add_argument("--check", action="store_true",
 
197
                        help="Run self-test")
 
198
    parser.add_argument("client", nargs="*", help="Client name")
 
199
 
 
200
 
 
201
def string_to_delta(interval):
 
202
    """Parse a string and return a datetime.timedelta"""
 
203
 
 
204
    try:
 
205
        return rfc3339_duration_to_delta(interval)
 
206
    except ValueError as e:
 
207
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
208
                    ' '.join(e.args))
 
209
    return parse_pre_1_6_1_interval(interval)
88
210
 
89
211
 
90
212
def rfc3339_duration_to_delta(duration):
110
232
    >>> rfc3339_duration_to_delta("")
111
233
    Traceback (most recent call last):
112
234
    ...
113
 
    ValueError: Invalid RFC 3339 duration: u''
 
235
    ValueError: Invalid RFC 3339 duration: ""
114
236
    >>> # Must start with "P":
115
237
    >>> rfc3339_duration_to_delta("1D")
116
238
    Traceback (most recent call last):
117
239
    ...
118
 
    ValueError: Invalid RFC 3339 duration: u'1D'
 
240
    ValueError: Invalid RFC 3339 duration: "1D"
119
241
    >>> # Must use correct order
120
242
    >>> rfc3339_duration_to_delta("PT1S2M")
121
243
    Traceback (most recent call last):
122
244
    ...
123
 
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
 
245
    ValueError: Invalid RFC 3339 duration: "PT1S2M"
124
246
    >>> # Time needs time marker
125
247
    >>> rfc3339_duration_to_delta("P1H2S")
126
248
    Traceback (most recent call last):
127
249
    ...
128
 
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
 
250
    ValueError: Invalid RFC 3339 duration: "P1H2S"
129
251
    >>> # Weeks can not be combined with anything else
130
252
    >>> rfc3339_duration_to_delta("P1D2W")
131
253
    Traceback (most recent call last):
132
254
    ...
133
 
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
 
255
    ValueError: Invalid RFC 3339 duration: "P1D2W"
134
256
    >>> rfc3339_duration_to_delta("P2W2H")
135
257
    Traceback (most recent call last):
136
258
    ...
137
 
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
 
259
    ValueError: Invalid RFC 3339 duration: "P2W2H"
138
260
    """
139
261
 
140
262
    # Parsing an RFC 3339 duration with regular expressions is not
211
333
                break
212
334
        else:
213
335
            # No currently valid tokens were found
214
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
336
            raise ValueError("Invalid RFC 3339 duration: \"{}\""
215
337
                             .format(duration))
216
338
    # End token found
217
339
    return value
218
340
 
219
341
 
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
 
 
231
342
def parse_pre_1_6_1_interval(interval):
232
343
    """Parse an interval string as documented by Mandos before 1.6.1,
233
344
    and return a datetime.timedelta
271
382
    return value
272
383
 
273
384
 
274
 
## Classes for commands.
275
 
 
276
 
# Abstract classes first
277
 
class Command(object):
278
 
    """Abstract class for commands"""
279
 
    def run(self, mandos, mandos_objmgr, clients):
280
 
        """Normal commands should implement run_on_one_client(), but
281
 
        commands which want to operate on all clients at the same time
282
 
        can override this run() method instead."""
283
 
        self.mandos = mandos
284
 
        for client, properties in clients.items():
285
 
            self.run_on_one_client(client, properties)
286
 
 
287
 
class PrintCmd(Command):
288
 
    """Abstract class for commands printing client details"""
289
 
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
290
 
                    "Created", "Interval", "Host", "KeyID",
291
 
                    "Fingerprint", "CheckerRunning", "LastEnabled",
292
 
                    "ApprovalPending", "ApprovedByDefault",
293
 
                    "LastApprovalRequest", "ApprovalDelay",
294
 
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
295
 
                    "Expires", "LastCheckerStatus")
296
 
    def run(self, mandos, mandos_objmgr, clients):
297
 
        print(self.output(mandos_objmgr, clients.values()))
298
 
 
299
 
class PropertyCmd(Command):
300
 
    """Abstract class for Actions for setting one client property"""
301
 
    def run_on_one_client(self, client, properties):
302
 
        """Set the Client's D-Bus property"""
303
 
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
304
 
                  client.__dbus_object_path__,
305
 
                  dbus.PROPERTIES_IFACE, client_interface,
306
 
                  self.property, self.value_to_set
307
 
                  if not isinstance(self.value_to_set, dbus.Boolean)
308
 
                  else bool(self.value_to_set))
309
 
        client.Set(client_interface, self.property, self.value_to_set,
310
 
                   dbus_interface=dbus.PROPERTIES_IFACE)
311
 
 
312
 
class ValueArgumentMixIn(object):
313
 
    """Mixin class for commands taking a value as argument"""
314
 
    def __init__(self, value):
315
 
        self.value_to_set = value
316
 
 
317
 
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
318
 
    """Mixin class for commands taking a value argument as
319
 
    milliseconds."""
320
 
    @property
321
 
    def value_to_set(self):
322
 
        return self._vts
323
 
    @value_to_set.setter
324
 
    def value_to_set(self, value):
325
 
        """When setting, convert value to a datetime.timedelta"""
326
 
        self._vts = int(round(value.total_seconds() * 1000))
327
 
 
328
 
# Actual (non-abstract) command classes
329
 
 
330
 
class PrintTableCmd(PrintCmd):
331
 
    def __init__(self, verbose=False):
332
 
        self.verbose = verbose
333
 
 
334
 
    def output(self, mandos_objmgr, clients):
335
 
        default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
336
 
        keywords = default_keywords
337
 
        if self.verbose:
338
 
            keywords = self.all_keywords
339
 
        return str(self.TableOfClients(clients, keywords))
340
 
 
341
 
    class TableOfClients(object):
342
 
        tableheaders = {
343
 
            "Name": "Name",
344
 
            "Enabled": "Enabled",
345
 
            "Timeout": "Timeout",
346
 
            "LastCheckedOK": "Last Successful Check",
347
 
            "LastApprovalRequest": "Last Approval Request",
348
 
            "Created": "Created",
349
 
            "Interval": "Interval",
350
 
            "Host": "Host",
351
 
            "Fingerprint": "Fingerprint",
352
 
            "KeyID": "Key ID",
353
 
            "CheckerRunning": "Check Is Running",
354
 
            "LastEnabled": "Last Enabled",
355
 
            "ApprovalPending": "Approval Is Pending",
356
 
            "ApprovedByDefault": "Approved By Default",
357
 
            "ApprovalDelay": "Approval Delay",
358
 
            "ApprovalDuration": "Approval Duration",
359
 
            "Checker": "Checker",
360
 
            "ExtendedTimeout": "Extended Timeout",
361
 
            "Expires": "Expires",
362
 
            "LastCheckerStatus": "Last Checker Status",
363
 
        }
364
 
 
365
 
        def __init__(self, clients, keywords, tableheaders=None):
366
 
            self.clients = clients
367
 
            self.keywords = keywords
368
 
            if tableheaders is not None:
369
 
                self.tableheaders = tableheaders
370
 
 
371
 
        def __str__(self):
372
 
            return "\n".join(self.rows())
373
 
 
374
 
        if sys.version_info.major == 2:
375
 
            __unicode__ = __str__
376
 
            def __str__(self):
377
 
                return str(self).encode(locale.getpreferredencoding())
378
 
 
379
 
        def rows(self):
380
 
            format_string = self.row_formatting_string()
381
 
            rows = [self.header_line(format_string)]
382
 
            rows.extend(self.client_line(client, format_string)
383
 
                        for client in self.clients)
384
 
            return rows
385
 
 
386
 
        def row_formatting_string(self):
387
 
            "Format string used to format table rows"
388
 
            return " ".join("{{{key}:{width}}}".format(
389
 
                width=max(len(self.tableheaders[key]),
390
 
                          *(len(self.string_from_client(client, key))
391
 
                            for client in self.clients)),
392
 
                key=key)
393
 
                            for key in self.keywords)
394
 
 
395
 
        def string_from_client(self, client, key):
396
 
            return self.valuetostring(client[key], key)
397
 
 
398
 
        @staticmethod
399
 
        def valuetostring(value, keyword):
400
 
            if isinstance(value, dbus.Boolean):
401
 
                return "Yes" if value else "No"
402
 
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
403
 
                           "ApprovalDuration", "ExtendedTimeout"):
404
 
                return milliseconds_to_string(value)
405
 
            return str(value)
406
 
 
407
 
        def header_line(self, format_string):
408
 
            return format_string.format(**self.tableheaders)
409
 
 
410
 
        def client_line(self, client, format_string):
411
 
            return format_string.format(
412
 
                **{key: self.string_from_client(client, key)
413
 
                   for key in self.keywords})
414
 
 
415
 
 
416
 
 
417
 
class DumpJSONCmd(PrintCmd):
418
 
    def output(self, mandos_objmgr, clients):
419
 
        data = {client["Name"]:
420
 
                {key: self.dbus_boolean_to_bool(client[key])
421
 
                 for key in self.all_keywords}
422
 
                for client in clients.values()}
423
 
        return json.dumps(data, indent=4, separators=(',', ': '))
424
 
    @staticmethod
425
 
    def dbus_boolean_to_bool(value):
426
 
        if isinstance(value, dbus.Boolean):
427
 
            value = bool(value)
428
 
        return value
429
 
 
430
 
class IsEnabledCmd(Command):
431
 
    def run_on_one_client(self, client, properties):
432
 
        if self.is_enabled(client, properties):
433
 
            sys.exit(0)
434
 
        sys.exit(1)
435
 
    def is_enabled(self, client, properties):
436
 
        log.debug("D-Bus: %s:%s:%s.Get(%r, %r)", busname,
437
 
                  client.__dbus_object_path__,
438
 
                  dbus.PROPERTIES_IFACE, client_interface,
439
 
                  "Enabled")
440
 
        return bool(client.Get(client_interface, "Enabled",
441
 
                               dbus_interface=dbus.PROPERTIES_IFACE))
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)
463
 
 
464
 
class EnableCmd(PropertyCmd):
465
 
    property = "Enabled"
466
 
    value_to_set = dbus.Boolean(True)
467
 
 
468
 
class DisableCmd(PropertyCmd):
469
 
    property = "Enabled"
470
 
    value_to_set = dbus.Boolean(False)
471
 
 
472
 
class BumpTimeoutCmd(PropertyCmd):
473
 
    property = "LastCheckedOK"
474
 
    value_to_set = ""
475
 
 
476
 
class StartCheckerCmd(PropertyCmd):
477
 
    property = "CheckerRunning"
478
 
    value_to_set = dbus.Boolean(True)
479
 
 
480
 
class StopCheckerCmd(PropertyCmd):
481
 
    property = "CheckerRunning"
482
 
    value_to_set = dbus.Boolean(False)
483
 
 
484
 
class ApproveByDefaultCmd(PropertyCmd):
485
 
    property = "ApprovedByDefault"
486
 
    value_to_set = dbus.Boolean(True)
487
 
 
488
 
class DenyByDefaultCmd(PropertyCmd):
489
 
    property = "ApprovedByDefault"
490
 
    value_to_set = dbus.Boolean(False)
491
 
 
492
 
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
493
 
    property = "Checker"
494
 
 
495
 
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
496
 
    property = "Host"
497
 
 
498
 
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
499
 
    @property
500
 
    def value_to_set(self):
501
 
        return self._vts
502
 
    @value_to_set.setter
503
 
    def value_to_set(self, value):
504
 
        """When setting, read data from supplied file object"""
505
 
        self._vts = value.read()
506
 
        value.close()
507
 
    property = "Secret"
508
 
 
509
 
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
510
 
    property = "Timeout"
511
 
 
512
 
class SetExtendedTimeoutCmd(PropertyCmd,
513
 
                            MillisecondsValueArgumentMixIn):
514
 
    property = "ExtendedTimeout"
515
 
 
516
 
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
517
 
    property = "Interval"
518
 
 
519
 
class SetApprovalDelayCmd(PropertyCmd,
520
 
                          MillisecondsValueArgumentMixIn):
521
 
    property = "ApprovalDelay"
522
 
 
523
 
class SetApprovalDurationCmd(PropertyCmd,
524
 
                             MillisecondsValueArgumentMixIn):
525
 
    property = "ApprovalDuration"
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
385
def check_option_syntax(parser, options):
669
386
    """Apply additional restrictions on options, not expressible in
670
387
argparse"""
707
424
        options.remove = True
708
425
 
709
426
 
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
 
 
 
427
def get_mandos_dbus_object(bus):
 
428
    log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
429
              dbus_busname, server_dbus_path)
 
430
    with if_dbus_exception_log_with_exception_and_exit(
 
431
            "Could not connect to Mandos server: %s"):
 
432
        mandos_dbus_object = bus.get_object(dbus_busname,
 
433
                                            server_dbus_path)
 
434
    return mandos_dbus_object
 
435
 
 
436
 
 
437
@contextlib.contextmanager
 
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
724
439
    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")
 
440
        yield
 
441
    except dbus.exceptions.DBusException as e:
 
442
        log.critical(*(args + (e,)), **kwargs)
731
443
        sys.exit(1)
732
444
 
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")
 
445
 
 
446
def get_managed_objects(object_manager):
 
447
    log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
 
448
              server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
 
449
    with if_dbus_exception_log_with_exception_and_exit(
 
450
            "Failed to access Mandos server through D-Bus:\n%s"):
 
451
        with SilenceLogger("dbus.proxies"):
 
452
            managed_objects = object_manager.GetManagedObjects()
 
453
    return managed_objects
 
454
 
 
455
 
 
456
class SilenceLogger(object):
 
457
    "Simple context manager to silence a particular logger"
 
458
    def __init__(self, loggername):
 
459
        self.logger = logging.getLogger(loggername)
 
460
 
 
461
    def __enter__(self):
 
462
        self.logger.addFilter(self.nullfilter)
 
463
        return self
 
464
 
740
465
    class NullFilter(logging.Filter):
741
466
        def filter(self, record):
742
467
            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 = {bus.get_object(busname, path): properties
766
 
                   for path, properties in mandos_clients.items()}
767
 
    else:
768
 
        for name in clientnames:
769
 
            for path, client in mandos_clients.items():
770
 
                if client["Name"] == name:
771
 
                    client_objc = bus.get_object(busname, path)
772
 
                    clients[client_objc] = client
773
 
                    break
774
 
            else:
775
 
                log.critical("Client not found on server: %r", name)
776
 
                sys.exit(1)
777
 
 
778
 
    # Run all commands on clients
779
 
    commands = commands_from_options(options)
780
 
    for command in commands:
781
 
        command.run(mandos_serv, mandos_serv_object_manager, clients)
 
468
 
 
469
    nullfilter = NullFilter()
 
470
 
 
471
    def __exit__(self, exc_type, exc_val, exc_tb):
 
472
        self.logger.removeFilter(self.nullfilter)
 
473
 
 
474
 
 
475
def commands_from_options(options):
 
476
 
 
477
    commands = []
 
478
 
 
479
    if options.is_enabled:
 
480
        commands.append(command.IsEnabled())
 
481
 
 
482
    if options.approve:
 
483
        commands.append(command.Approve())
 
484
 
 
485
    if options.deny:
 
486
        commands.append(command.Deny())
 
487
 
 
488
    if options.remove:
 
489
        commands.append(command.Remove())
 
490
 
 
491
    if options.dump_json:
 
492
        commands.append(command.DumpJSON())
 
493
 
 
494
    if options.enable:
 
495
        commands.append(command.Enable())
 
496
 
 
497
    if options.disable:
 
498
        commands.append(command.Disable())
 
499
 
 
500
    if options.bump_timeout:
 
501
        commands.append(command.BumpTimeout())
 
502
 
 
503
    if options.start_checker:
 
504
        commands.append(command.StartChecker())
 
505
 
 
506
    if options.stop_checker:
 
507
        commands.append(command.StopChecker())
 
508
 
 
509
    if options.approved_by_default is not None:
 
510
        if options.approved_by_default:
 
511
            commands.append(command.ApproveByDefault())
 
512
        else:
 
513
            commands.append(command.DenyByDefault())
 
514
 
 
515
    if options.checker is not None:
 
516
        commands.append(command.SetChecker(options.checker))
 
517
 
 
518
    if options.host is not None:
 
519
        commands.append(command.SetHost(options.host))
 
520
 
 
521
    if options.secret is not None:
 
522
        commands.append(command.SetSecret(options.secret))
 
523
 
 
524
    if options.timeout is not None:
 
525
        commands.append(command.SetTimeout(options.timeout))
 
526
 
 
527
    if options.extended_timeout:
 
528
        commands.append(
 
529
            command.SetExtendedTimeout(options.extended_timeout))
 
530
 
 
531
    if options.interval is not None:
 
532
        commands.append(command.SetInterval(options.interval))
 
533
 
 
534
    if options.approval_delay is not None:
 
535
        commands.append(
 
536
            command.SetApprovalDelay(options.approval_delay))
 
537
 
 
538
    if options.approval_duration is not None:
 
539
        commands.append(
 
540
            command.SetApprovalDuration(options.approval_duration))
 
541
 
 
542
    # If no command option has been given, show table of clients,
 
543
    # optionally verbosely
 
544
    if not commands:
 
545
        commands.append(command.PrintTable(verbose=options.verbose))
 
546
 
 
547
    return commands
 
548
 
 
549
 
 
550
class command(object):
 
551
    """A namespace for command classes"""
 
552
 
 
553
    class Base(object):
 
554
        """Abstract base class for commands"""
 
555
        def run(self, clients, bus=None, mandos=None):
 
556
            """Normal commands should implement run_on_one_client(),
 
557
but commands which want to operate on all clients at the same time can
 
558
override this run() method instead.
 
559
"""
 
560
            self.mandos = mandos
 
561
            for clientpath, properties in clients.items():
 
562
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
563
                          dbus_busname, str(clientpath))
 
564
                client = bus.get_object(dbus_busname, clientpath)
 
565
                self.run_on_one_client(client, properties)
 
566
 
 
567
 
 
568
    class IsEnabled(Base):
 
569
        def run(self, clients, bus=None, mandos=None):
 
570
            client, properties = next(iter(clients.items()))
 
571
            if self.is_enabled(client, properties):
 
572
                sys.exit(0)
 
573
            sys.exit(1)
 
574
        def is_enabled(self, client, properties):
 
575
            return properties["Enabled"]
 
576
 
 
577
 
 
578
    class Approve(Base):
 
579
        def run_on_one_client(self, client, properties):
 
580
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
581
                      client.__dbus_object_path__,
 
582
                      client_dbus_interface)
 
583
            client.Approve(dbus.Boolean(True),
 
584
                           dbus_interface=client_dbus_interface)
 
585
 
 
586
 
 
587
    class Deny(Base):
 
588
        def run_on_one_client(self, client, properties):
 
589
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
590
                      client.__dbus_object_path__,
 
591
                      client_dbus_interface)
 
592
            client.Approve(dbus.Boolean(False),
 
593
                           dbus_interface=client_dbus_interface)
 
594
 
 
595
 
 
596
    class Remove(Base):
 
597
        def run_on_one_client(self, client, properties):
 
598
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
 
599
                      dbus_busname, server_dbus_path,
 
600
                      server_dbus_interface,
 
601
                      str(client.__dbus_object_path__))
 
602
            self.mandos.RemoveClient(client.__dbus_object_path__)
 
603
 
 
604
 
 
605
    class Output(Base):
 
606
        """Abstract class for commands outputting client details"""
 
607
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
608
                        "Created", "Interval", "Host", "KeyID",
 
609
                        "Fingerprint", "CheckerRunning",
 
610
                        "LastEnabled", "ApprovalPending",
 
611
                        "ApprovedByDefault", "LastApprovalRequest",
 
612
                        "ApprovalDelay", "ApprovalDuration",
 
613
                        "Checker", "ExtendedTimeout", "Expires",
 
614
                        "LastCheckerStatus")
 
615
 
 
616
        def run(self, clients, bus=None, mandos=None):
 
617
            print(self.output(clients.values()))
 
618
 
 
619
        def output(self, clients):
 
620
            raise NotImplementedError()
 
621
 
 
622
 
 
623
    class DumpJSON(Output):
 
624
        def output(self, clients):
 
625
            data = {client["Name"]:
 
626
                    {key: self.dbus_boolean_to_bool(client[key])
 
627
                     for key in self.all_keywords}
 
628
                    for client in clients}
 
629
            return json.dumps(data, indent=4, separators=(',', ': '))
 
630
 
 
631
        @staticmethod
 
632
        def dbus_boolean_to_bool(value):
 
633
            if isinstance(value, dbus.Boolean):
 
634
                value = bool(value)
 
635
            return value
 
636
 
 
637
 
 
638
    class PrintTable(Output):
 
639
        def __init__(self, verbose=False):
 
640
            self.verbose = verbose
 
641
 
 
642
        def output(self, clients):
 
643
            default_keywords = ("Name", "Enabled", "Timeout",
 
644
                                "LastCheckedOK")
 
645
            keywords = default_keywords
 
646
            if self.verbose:
 
647
                keywords = self.all_keywords
 
648
            return str(self.TableOfClients(clients, keywords))
 
649
 
 
650
        class TableOfClients(object):
 
651
            tableheaders = {
 
652
                "Name": "Name",
 
653
                "Enabled": "Enabled",
 
654
                "Timeout": "Timeout",
 
655
                "LastCheckedOK": "Last Successful Check",
 
656
                "LastApprovalRequest": "Last Approval Request",
 
657
                "Created": "Created",
 
658
                "Interval": "Interval",
 
659
                "Host": "Host",
 
660
                "Fingerprint": "Fingerprint",
 
661
                "KeyID": "Key ID",
 
662
                "CheckerRunning": "Check Is Running",
 
663
                "LastEnabled": "Last Enabled",
 
664
                "ApprovalPending": "Approval Is Pending",
 
665
                "ApprovedByDefault": "Approved By Default",
 
666
                "ApprovalDelay": "Approval Delay",
 
667
                "ApprovalDuration": "Approval Duration",
 
668
                "Checker": "Checker",
 
669
                "ExtendedTimeout": "Extended Timeout",
 
670
                "Expires": "Expires",
 
671
                "LastCheckerStatus": "Last Checker Status",
 
672
            }
 
673
 
 
674
            def __init__(self, clients, keywords):
 
675
                self.clients = clients
 
676
                self.keywords = keywords
 
677
 
 
678
            def __str__(self):
 
679
                return "\n".join(self.rows())
 
680
 
 
681
            if sys.version_info.major == 2:
 
682
                __unicode__ = __str__
 
683
                def __str__(self):
 
684
                    return str(self).encode(
 
685
                        locale.getpreferredencoding())
 
686
 
 
687
            def rows(self):
 
688
                format_string = self.row_formatting_string()
 
689
                rows = [self.header_line(format_string)]
 
690
                rows.extend(self.client_line(client, format_string)
 
691
                            for client in self.clients)
 
692
                return rows
 
693
 
 
694
            def row_formatting_string(self):
 
695
                "Format string used to format table rows"
 
696
                return " ".join("{{{key}:{width}}}".format(
 
697
                    width=max(len(self.tableheaders[key]),
 
698
                              *(len(self.string_from_client(client,
 
699
                                                            key))
 
700
                                for client in self.clients)),
 
701
                    key=key)
 
702
                                for key in self.keywords)
 
703
 
 
704
            def string_from_client(self, client, key):
 
705
                return self.valuetostring(client[key], key)
 
706
 
 
707
            @classmethod
 
708
            def valuetostring(cls, value, keyword):
 
709
                if isinstance(value, dbus.Boolean):
 
710
                    return "Yes" if value else "No"
 
711
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
712
                               "ApprovalDuration", "ExtendedTimeout"):
 
713
                    return cls.milliseconds_to_string(value)
 
714
                return str(value)
 
715
 
 
716
            def header_line(self, format_string):
 
717
                return format_string.format(**self.tableheaders)
 
718
 
 
719
            def client_line(self, client, format_string):
 
720
                return format_string.format(
 
721
                    **{key: self.string_from_client(client, key)
 
722
                       for key in self.keywords})
 
723
 
 
724
            @staticmethod
 
725
            def milliseconds_to_string(ms):
 
726
                td = datetime.timedelta(0, 0, 0, ms)
 
727
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
728
                        .format(days="{}T".format(td.days)
 
729
                                if td.days else "",
 
730
                                hours=td.seconds // 3600,
 
731
                                minutes=(td.seconds % 3600) // 60,
 
732
                                seconds=td.seconds % 60))
 
733
 
 
734
 
 
735
    class Property(Base):
 
736
        "Abstract class for Actions for setting one client property"
 
737
 
 
738
        def run_on_one_client(self, client, properties):
 
739
            """Set the Client's D-Bus property"""
 
740
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
741
                      client.__dbus_object_path__,
 
742
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
 
743
                      self.propname, self.value_to_set
 
744
                      if not isinstance(self.value_to_set,
 
745
                                        dbus.Boolean)
 
746
                      else bool(self.value_to_set))
 
747
            client.Set(client_dbus_interface, self.propname,
 
748
                       self.value_to_set,
 
749
                       dbus_interface=dbus.PROPERTIES_IFACE)
 
750
 
 
751
        @property
 
752
        def propname(self):
 
753
            raise NotImplementedError()
 
754
 
 
755
 
 
756
    class Enable(Property):
 
757
        propname = "Enabled"
 
758
        value_to_set = dbus.Boolean(True)
 
759
 
 
760
 
 
761
    class Disable(Property):
 
762
        propname = "Enabled"
 
763
        value_to_set = dbus.Boolean(False)
 
764
 
 
765
 
 
766
    class BumpTimeout(Property):
 
767
        propname = "LastCheckedOK"
 
768
        value_to_set = ""
 
769
 
 
770
 
 
771
    class StartChecker(Property):
 
772
        propname = "CheckerRunning"
 
773
        value_to_set = dbus.Boolean(True)
 
774
 
 
775
 
 
776
    class StopChecker(Property):
 
777
        propname = "CheckerRunning"
 
778
        value_to_set = dbus.Boolean(False)
 
779
 
 
780
 
 
781
    class ApproveByDefault(Property):
 
782
        propname = "ApprovedByDefault"
 
783
        value_to_set = dbus.Boolean(True)
 
784
 
 
785
 
 
786
    class DenyByDefault(Property):
 
787
        propname = "ApprovedByDefault"
 
788
        value_to_set = dbus.Boolean(False)
 
789
 
 
790
 
 
791
    class PropertyValue(Property):
 
792
        "Abstract class for Property recieving a value as argument"
 
793
        def __init__(self, value):
 
794
            self.value_to_set = value
 
795
 
 
796
 
 
797
    class SetChecker(PropertyValue):
 
798
        propname = "Checker"
 
799
 
 
800
 
 
801
    class SetHost(PropertyValue):
 
802
        propname = "Host"
 
803
 
 
804
 
 
805
    class SetSecret(PropertyValue):
 
806
        propname = "Secret"
 
807
 
 
808
        @property
 
809
        def value_to_set(self):
 
810
            return self._vts
 
811
 
 
812
        @value_to_set.setter
 
813
        def value_to_set(self, value):
 
814
            """When setting, read data from supplied file object"""
 
815
            self._vts = value.read()
 
816
            value.close()
 
817
 
 
818
 
 
819
    class MillisecondsPropertyValueArgument(PropertyValue):
 
820
        """Abstract class for PropertyValue taking a value argument as
 
821
a datetime.timedelta() but should store it as milliseconds."""
 
822
 
 
823
        @property
 
824
        def value_to_set(self):
 
825
            return self._vts
 
826
 
 
827
        @value_to_set.setter
 
828
        def value_to_set(self, value):
 
829
            "When setting, convert value from a datetime.timedelta"
 
830
            self._vts = int(round(value.total_seconds() * 1000))
 
831
 
 
832
 
 
833
    class SetTimeout(MillisecondsPropertyValueArgument):
 
834
        propname = "Timeout"
 
835
 
 
836
 
 
837
    class SetExtendedTimeout(MillisecondsPropertyValueArgument):
 
838
        propname = "ExtendedTimeout"
 
839
 
 
840
 
 
841
    class SetInterval(MillisecondsPropertyValueArgument):
 
842
        propname = "Interval"
 
843
 
 
844
 
 
845
    class SetApprovalDelay(MillisecondsPropertyValueArgument):
 
846
        propname = "ApprovalDelay"
 
847
 
 
848
 
 
849
    class SetApprovalDuration(MillisecondsPropertyValueArgument):
 
850
        propname = "ApprovalDuration"
 
851
 
782
852
 
783
853
 
784
 
class Test_milliseconds_to_string(unittest.TestCase):
785
 
    def test_all(self):
786
 
        self.assertEqual(milliseconds_to_string(93785000),
787
 
                         "1T02:03:05")
788
 
    def test_no_days(self):
789
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
790
 
    def test_all_zero(self):
791
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
792
 
    def test_no_fractional_seconds(self):
793
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
794
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
795
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
796
 
 
797
 
class Test_string_to_delta(unittest.TestCase):
 
854
class TestCaseWithAssertLogs(unittest.TestCase):
 
855
    """unittest.TestCase.assertLogs only exists in Python 3.4"""
 
856
 
 
857
    if not hasattr(unittest.TestCase, "assertLogs"):
 
858
        @contextlib.contextmanager
 
859
        def assertLogs(self, logger, level=logging.INFO):
 
860
            capturing_handler = self.CapturingLevelHandler(level)
 
861
            old_level = logger.level
 
862
            old_propagate = logger.propagate
 
863
            logger.addHandler(capturing_handler)
 
864
            logger.setLevel(level)
 
865
            logger.propagate = False
 
866
            try:
 
867
                yield capturing_handler.watcher
 
868
            finally:
 
869
                logger.propagate = old_propagate
 
870
                logger.removeHandler(capturing_handler)
 
871
                logger.setLevel(old_level)
 
872
            self.assertGreater(len(capturing_handler.watcher.records),
 
873
                               0)
 
874
 
 
875
        class CapturingLevelHandler(logging.Handler):
 
876
            def __init__(self, level, *args, **kwargs):
 
877
                logging.Handler.__init__(self, *args, **kwargs)
 
878
                self.watcher = self.LoggingWatcher([], [])
 
879
            def emit(self, record):
 
880
                self.watcher.records.append(record)
 
881
                self.watcher.output.append(self.format(record))
 
882
 
 
883
            LoggingWatcher = collections.namedtuple("LoggingWatcher",
 
884
                                                    ("records",
 
885
                                                     "output"))
 
886
 
 
887
 
 
888
class Test_string_to_delta(TestCaseWithAssertLogs):
798
889
    def test_handles_basic_rfc3339(self):
799
890
        self.assertEqual(string_to_delta("PT0S"),
800
891
                         datetime.timedelta())
804
895
                         datetime.timedelta(0, 1))
805
896
        self.assertEqual(string_to_delta("PT2H"),
806
897
                         datetime.timedelta(0, 7200))
 
898
 
807
899
    def test_falls_back_to_pre_1_6_1_with_warning(self):
808
 
        # assertLogs only exists in Python 3.4
809
 
        if hasattr(self, "assertLogs"):
810
 
            with self.assertLogs(log, logging.WARNING):
811
 
                value = string_to_delta("2h")
812
 
        else:
813
 
            class WarningFilter(logging.Filter):
814
 
                """Don't show, but record the presence of, warnings"""
815
 
                def filter(self, record):
816
 
                    is_warning = record.levelno >= logging.WARNING
817
 
                    self.found = is_warning or getattr(self, "found",
818
 
                                                       False)
819
 
                    return not is_warning
820
 
            warning_filter = WarningFilter()
821
 
            log.addFilter(warning_filter)
822
 
            try:
823
 
                value = string_to_delta("2h")
824
 
            finally:
825
 
                log.removeFilter(warning_filter)
826
 
            self.assertTrue(getattr(warning_filter, "found", False))
 
900
        with self.assertLogs(log, logging.WARNING):
 
901
            value = string_to_delta("2h")
827
902
        self.assertEqual(value, datetime.timedelta(0, 7200))
828
903
 
829
904
 
830
 
class TestCmd(unittest.TestCase):
 
905
class Test_check_option_syntax(unittest.TestCase):
 
906
    def setUp(self):
 
907
        self.parser = argparse.ArgumentParser()
 
908
        add_command_line_options(self.parser)
 
909
 
 
910
    def test_actions_requires_client_or_all(self):
 
911
        for action, value in self.actions.items():
 
912
            options = self.parser.parse_args()
 
913
            setattr(options, action, value)
 
914
            with self.assertParseError():
 
915
                self.check_option_syntax(options)
 
916
 
 
917
    # This mostly corresponds to the definition from has_actions() in
 
918
    # check_option_syntax()
 
919
    actions = {
 
920
        # The actual values set here are not that important, but we do
 
921
        # at least stick to the correct types, even though they are
 
922
        # never used
 
923
        "enable": True,
 
924
        "disable": True,
 
925
        "bump_timeout": True,
 
926
        "start_checker": True,
 
927
        "stop_checker": True,
 
928
        "is_enabled": True,
 
929
        "remove": True,
 
930
        "checker": "x",
 
931
        "timeout": datetime.timedelta(),
 
932
        "extended_timeout": datetime.timedelta(),
 
933
        "interval": datetime.timedelta(),
 
934
        "approved_by_default": True,
 
935
        "approval_delay": datetime.timedelta(),
 
936
        "approval_duration": datetime.timedelta(),
 
937
        "host": "x",
 
938
        "secret": io.BytesIO(b"x"),
 
939
        "approve": True,
 
940
        "deny": True,
 
941
    }
 
942
 
 
943
    @contextlib.contextmanager
 
944
    def assertParseError(self):
 
945
        with self.assertRaises(SystemExit) as e:
 
946
            with self.redirect_stderr_to_devnull():
 
947
                yield
 
948
        # Exit code from argparse is guaranteed to be "2".  Reference:
 
949
        # https://docs.python.org/3/library
 
950
        # /argparse.html#exiting-methods
 
951
        self.assertEqual(e.exception.code, 2)
 
952
 
 
953
    @staticmethod
 
954
    @contextlib.contextmanager
 
955
    def redirect_stderr_to_devnull():
 
956
        null = os.open(os.path.devnull, os.O_RDWR)
 
957
        stderrcopy = os.dup(sys.stderr.fileno())
 
958
        os.dup2(null, sys.stderr.fileno())
 
959
        os.close(null)
 
960
        try:
 
961
            yield
 
962
        finally:
 
963
            # restore stderr
 
964
            os.dup2(stderrcopy, sys.stderr.fileno())
 
965
            os.close(stderrcopy)
 
966
 
 
967
    def check_option_syntax(self, options):
 
968
        check_option_syntax(self.parser, options)
 
969
 
 
970
    def test_actions_all_conflicts_with_verbose(self):
 
971
        for action, value in self.actions.items():
 
972
            options = self.parser.parse_args()
 
973
            setattr(options, action, value)
 
974
            options.all = True
 
975
            options.verbose = True
 
976
            with self.assertParseError():
 
977
                self.check_option_syntax(options)
 
978
 
 
979
    def test_actions_with_client_conflicts_with_verbose(self):
 
980
        for action, value in self.actions.items():
 
981
            options = self.parser.parse_args()
 
982
            setattr(options, action, value)
 
983
            options.verbose = True
 
984
            options.client = ["foo"]
 
985
            with self.assertParseError():
 
986
                self.check_option_syntax(options)
 
987
 
 
988
    def test_dump_json_conflicts_with_verbose(self):
 
989
        options = self.parser.parse_args()
 
990
        options.dump_json = True
 
991
        options.verbose = True
 
992
        with self.assertParseError():
 
993
            self.check_option_syntax(options)
 
994
 
 
995
    def test_dump_json_conflicts_with_action(self):
 
996
        for action, value in self.actions.items():
 
997
            options = self.parser.parse_args()
 
998
            setattr(options, action, value)
 
999
            options.dump_json = True
 
1000
            with self.assertParseError():
 
1001
                self.check_option_syntax(options)
 
1002
 
 
1003
    def test_all_can_not_be_alone(self):
 
1004
        options = self.parser.parse_args()
 
1005
        options.all = True
 
1006
        with self.assertParseError():
 
1007
            self.check_option_syntax(options)
 
1008
 
 
1009
    def test_all_is_ok_with_any_action(self):
 
1010
        for action, value in self.actions.items():
 
1011
            options = self.parser.parse_args()
 
1012
            setattr(options, action, value)
 
1013
            options.all = True
 
1014
            self.check_option_syntax(options)
 
1015
 
 
1016
    def test_any_action_is_ok_with_one_client(self):
 
1017
        for action, value in self.actions.items():
 
1018
            options = self.parser.parse_args()
 
1019
            setattr(options, action, value)
 
1020
            options.client = ["foo"]
 
1021
            self.check_option_syntax(options)
 
1022
 
 
1023
    def test_one_client_with_all_actions_except_is_enabled(self):
 
1024
        options = self.parser.parse_args()
 
1025
        for action, value in self.actions.items():
 
1026
            if action == "is_enabled":
 
1027
                continue
 
1028
            setattr(options, action, value)
 
1029
        options.client = ["foo"]
 
1030
        self.check_option_syntax(options)
 
1031
 
 
1032
    def test_two_clients_with_all_actions_except_is_enabled(self):
 
1033
        options = self.parser.parse_args()
 
1034
        for action, value in self.actions.items():
 
1035
            if action == "is_enabled":
 
1036
                continue
 
1037
            setattr(options, action, value)
 
1038
        options.client = ["foo", "barbar"]
 
1039
        self.check_option_syntax(options)
 
1040
 
 
1041
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
 
1042
        for action, value in self.actions.items():
 
1043
            if action == "is_enabled":
 
1044
                continue
 
1045
            options = self.parser.parse_args()
 
1046
            setattr(options, action, value)
 
1047
            options.client = ["foo", "barbar"]
 
1048
            self.check_option_syntax(options)
 
1049
 
 
1050
    def test_is_enabled_fails_without_client(self):
 
1051
        options = self.parser.parse_args()
 
1052
        options.is_enabled = True
 
1053
        with self.assertParseError():
 
1054
            self.check_option_syntax(options)
 
1055
 
 
1056
    def test_is_enabled_fails_with_two_clients(self):
 
1057
        options = self.parser.parse_args()
 
1058
        options.is_enabled = True
 
1059
        options.client = ["foo", "barbar"]
 
1060
        with self.assertParseError():
 
1061
            self.check_option_syntax(options)
 
1062
 
 
1063
    def test_remove_can_only_be_combined_with_action_deny(self):
 
1064
        for action, value in self.actions.items():
 
1065
            if action in {"remove", "deny"}:
 
1066
                continue
 
1067
            options = self.parser.parse_args()
 
1068
            setattr(options, action, value)
 
1069
            options.all = True
 
1070
            options.remove = True
 
1071
            with self.assertParseError():
 
1072
                self.check_option_syntax(options)
 
1073
 
 
1074
 
 
1075
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
 
1076
    def test_calls_and_returns_get_object_on_bus(self):
 
1077
        class MockBus(object):
 
1078
            called = False
 
1079
            def get_object(mockbus_self, busname, dbus_path):
 
1080
                # Note that "self" is still the testcase instance,
 
1081
                # this MockBus instance is in "mockbus_self".
 
1082
                self.assertEqual(busname, dbus_busname)
 
1083
                self.assertEqual(dbus_path, server_dbus_path)
 
1084
                mockbus_self.called = True
 
1085
                return mockbus_self
 
1086
 
 
1087
        mockbus = get_mandos_dbus_object(bus=MockBus())
 
1088
        self.assertIsInstance(mockbus, MockBus)
 
1089
        self.assertTrue(mockbus.called)
 
1090
 
 
1091
    def test_logs_and_exits_on_dbus_error(self):
 
1092
        class MockBusFailing(object):
 
1093
            def get_object(self, busname, dbus_path):
 
1094
                raise dbus.exceptions.DBusException("Test")
 
1095
 
 
1096
        with self.assertLogs(log, logging.CRITICAL):
 
1097
            with self.assertRaises(SystemExit) as e:
 
1098
                bus = get_mandos_dbus_object(bus=MockBusFailing())
 
1099
 
 
1100
        if isinstance(e.exception.code, int):
 
1101
            self.assertNotEqual(e.exception.code, 0)
 
1102
        else:
 
1103
            self.assertIsNotNone(e.exception.code)
 
1104
 
 
1105
 
 
1106
class Test_get_managed_objects(TestCaseWithAssertLogs):
 
1107
    def test_calls_and_returns_GetManagedObjects(self):
 
1108
        managed_objects = {"/clients/foo": { "Name": "foo"}}
 
1109
        class MockObjectManager(object):
 
1110
            def GetManagedObjects(self):
 
1111
                return managed_objects
 
1112
        retval = get_managed_objects(MockObjectManager())
 
1113
        self.assertDictEqual(managed_objects, retval)
 
1114
 
 
1115
    def test_logs_and_exits_on_dbus_error(self):
 
1116
        dbus_logger = logging.getLogger("dbus.proxies")
 
1117
 
 
1118
        class MockObjectManagerFailing(object):
 
1119
            def GetManagedObjects(self):
 
1120
                dbus_logger.error("Test")
 
1121
                raise dbus.exceptions.DBusException("Test")
 
1122
 
 
1123
        class CountingHandler(logging.Handler):
 
1124
            count = 0
 
1125
            def emit(self, record):
 
1126
                self.count += 1
 
1127
 
 
1128
        counting_handler = CountingHandler()
 
1129
 
 
1130
        dbus_logger.addHandler(counting_handler)
 
1131
 
 
1132
        try:
 
1133
            with self.assertLogs(log, logging.CRITICAL) as watcher:
 
1134
                with self.assertRaises(SystemExit) as e:
 
1135
                    get_managed_objects(MockObjectManagerFailing())
 
1136
        finally:
 
1137
            dbus_logger.removeFilter(counting_handler)
 
1138
 
 
1139
        # Make sure the dbus logger was suppressed
 
1140
        self.assertEqual(counting_handler.count, 0)
 
1141
 
 
1142
        # Test that the dbus_logger still works
 
1143
        with self.assertLogs(dbus_logger, logging.ERROR):
 
1144
            dbus_logger.error("Test")
 
1145
 
 
1146
        if isinstance(e.exception.code, int):
 
1147
            self.assertNotEqual(e.exception.code, 0)
 
1148
        else:
 
1149
            self.assertIsNotNone(e.exception.code)
 
1150
 
 
1151
 
 
1152
class Test_commands_from_options(unittest.TestCase):
 
1153
    def setUp(self):
 
1154
        self.parser = argparse.ArgumentParser()
 
1155
        add_command_line_options(self.parser)
 
1156
 
 
1157
    def test_is_enabled(self):
 
1158
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1159
                                      command.IsEnabled)
 
1160
 
 
1161
    def assert_command_from_args(self, args, command_cls,
 
1162
                                 **cmd_attrs):
 
1163
        """Assert that parsing ARGS should result in an instance of
 
1164
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
 
1165
        options = self.parser.parse_args(args)
 
1166
        check_option_syntax(self.parser, options)
 
1167
        commands = commands_from_options(options)
 
1168
        self.assertEqual(len(commands), 1)
 
1169
        command = commands[0]
 
1170
        self.assertIsInstance(command, command_cls)
 
1171
        for key, value in cmd_attrs.items():
 
1172
            self.assertEqual(getattr(command, key), value)
 
1173
 
 
1174
    def test_is_enabled_short(self):
 
1175
        self.assert_command_from_args(["-V", "foo"],
 
1176
                                      command.IsEnabled)
 
1177
 
 
1178
    def test_approve(self):
 
1179
        self.assert_command_from_args(["--approve", "foo"],
 
1180
                                      command.Approve)
 
1181
 
 
1182
    def test_approve_short(self):
 
1183
        self.assert_command_from_args(["-A", "foo"], command.Approve)
 
1184
 
 
1185
    def test_deny(self):
 
1186
        self.assert_command_from_args(["--deny", "foo"], command.Deny)
 
1187
 
 
1188
    def test_deny_short(self):
 
1189
        self.assert_command_from_args(["-D", "foo"], command.Deny)
 
1190
 
 
1191
    def test_remove(self):
 
1192
        self.assert_command_from_args(["--remove", "foo"],
 
1193
                                      command.Remove)
 
1194
 
 
1195
    def test_deny_before_remove(self):
 
1196
        options = self.parser.parse_args(["--deny", "--remove",
 
1197
                                          "foo"])
 
1198
        check_option_syntax(self.parser, options)
 
1199
        commands = commands_from_options(options)
 
1200
        self.assertEqual(len(commands), 2)
 
1201
        self.assertIsInstance(commands[0], command.Deny)
 
1202
        self.assertIsInstance(commands[1], command.Remove)
 
1203
 
 
1204
    def test_deny_before_remove_reversed(self):
 
1205
        options = self.parser.parse_args(["--remove", "--deny",
 
1206
                                          "--all"])
 
1207
        check_option_syntax(self.parser, options)
 
1208
        commands = commands_from_options(options)
 
1209
        self.assertEqual(len(commands), 2)
 
1210
        self.assertIsInstance(commands[0], command.Deny)
 
1211
        self.assertIsInstance(commands[1], command.Remove)
 
1212
 
 
1213
    def test_remove_short(self):
 
1214
        self.assert_command_from_args(["-r", "foo"], command.Remove)
 
1215
 
 
1216
    def test_dump_json(self):
 
1217
        self.assert_command_from_args(["--dump-json"],
 
1218
                                      command.DumpJSON)
 
1219
 
 
1220
    def test_enable(self):
 
1221
        self.assert_command_from_args(["--enable", "foo"],
 
1222
                                      command.Enable)
 
1223
 
 
1224
    def test_enable_short(self):
 
1225
        self.assert_command_from_args(["-e", "foo"], command.Enable)
 
1226
 
 
1227
    def test_disable(self):
 
1228
        self.assert_command_from_args(["--disable", "foo"],
 
1229
                                      command.Disable)
 
1230
 
 
1231
    def test_disable_short(self):
 
1232
        self.assert_command_from_args(["-d", "foo"], command.Disable)
 
1233
 
 
1234
    def test_bump_timeout(self):
 
1235
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1236
                                      command.BumpTimeout)
 
1237
 
 
1238
    def test_bump_timeout_short(self):
 
1239
        self.assert_command_from_args(["-b", "foo"],
 
1240
                                      command.BumpTimeout)
 
1241
 
 
1242
    def test_start_checker(self):
 
1243
        self.assert_command_from_args(["--start-checker", "foo"],
 
1244
                                      command.StartChecker)
 
1245
 
 
1246
    def test_stop_checker(self):
 
1247
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1248
                                      command.StopChecker)
 
1249
 
 
1250
    def test_approve_by_default(self):
 
1251
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1252
                                      command.ApproveByDefault)
 
1253
 
 
1254
    def test_deny_by_default(self):
 
1255
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1256
                                      command.DenyByDefault)
 
1257
 
 
1258
    def test_checker(self):
 
1259
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1260
                                      command.SetChecker,
 
1261
                                      value_to_set=":")
 
1262
 
 
1263
    def test_checker_empty(self):
 
1264
        self.assert_command_from_args(["--checker", "", "foo"],
 
1265
                                      command.SetChecker,
 
1266
                                      value_to_set="")
 
1267
 
 
1268
    def test_checker_short(self):
 
1269
        self.assert_command_from_args(["-c", ":", "foo"],
 
1270
                                      command.SetChecker,
 
1271
                                      value_to_set=":")
 
1272
 
 
1273
    def test_host(self):
 
1274
        self.assert_command_from_args(["--host", "foo.example.org",
 
1275
                                       "foo"], command.SetHost,
 
1276
                                      value_to_set="foo.example.org")
 
1277
 
 
1278
    def test_host_short(self):
 
1279
        self.assert_command_from_args(["-H", "foo.example.org",
 
1280
                                       "foo"], command.SetHost,
 
1281
                                      value_to_set="foo.example.org")
 
1282
 
 
1283
    def test_secret_devnull(self):
 
1284
        self.assert_command_from_args(["--secret", os.path.devnull,
 
1285
                                       "foo"], command.SetSecret,
 
1286
                                      value_to_set=b"")
 
1287
 
 
1288
    def test_secret_tempfile(self):
 
1289
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1290
            value = b"secret\0xyzzy\nbar"
 
1291
            f.write(value)
 
1292
            f.seek(0)
 
1293
            self.assert_command_from_args(["--secret", f.name,
 
1294
                                           "foo"], command.SetSecret,
 
1295
                                          value_to_set=value)
 
1296
 
 
1297
    def test_secret_devnull_short(self):
 
1298
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1299
                                      command.SetSecret,
 
1300
                                      value_to_set=b"")
 
1301
 
 
1302
    def test_secret_tempfile_short(self):
 
1303
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1304
            value = b"secret\0xyzzy\nbar"
 
1305
            f.write(value)
 
1306
            f.seek(0)
 
1307
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1308
                                          command.SetSecret,
 
1309
                                          value_to_set=value)
 
1310
 
 
1311
    def test_timeout(self):
 
1312
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1313
                                      command.SetTimeout,
 
1314
                                      value_to_set=300000)
 
1315
 
 
1316
    def test_timeout_short(self):
 
1317
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1318
                                      command.SetTimeout,
 
1319
                                      value_to_set=300000)
 
1320
 
 
1321
    def test_extended_timeout(self):
 
1322
        self.assert_command_from_args(["--extended-timeout", "PT15M",
 
1323
                                       "foo"],
 
1324
                                      command.SetExtendedTimeout,
 
1325
                                      value_to_set=900000)
 
1326
 
 
1327
    def test_interval(self):
 
1328
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1329
                                      command.SetInterval,
 
1330
                                      value_to_set=120000)
 
1331
 
 
1332
    def test_interval_short(self):
 
1333
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1334
                                      command.SetInterval,
 
1335
                                      value_to_set=120000)
 
1336
 
 
1337
    def test_approval_delay(self):
 
1338
        self.assert_command_from_args(["--approval-delay", "PT30S",
 
1339
                                       "foo"],
 
1340
                                      command.SetApprovalDelay,
 
1341
                                      value_to_set=30000)
 
1342
 
 
1343
    def test_approval_duration(self):
 
1344
        self.assert_command_from_args(["--approval-duration", "PT1S",
 
1345
                                       "foo"],
 
1346
                                      command.SetApprovalDuration,
 
1347
                                      value_to_set=1000)
 
1348
 
 
1349
    def test_print_table(self):
 
1350
        self.assert_command_from_args([], command.PrintTable,
 
1351
                                      verbose=False)
 
1352
 
 
1353
    def test_print_table_verbose(self):
 
1354
        self.assert_command_from_args(["--verbose"],
 
1355
                                      command.PrintTable,
 
1356
                                      verbose=True)
 
1357
 
 
1358
    def test_print_table_verbose_short(self):
 
1359
        self.assert_command_from_args(["-v"], command.PrintTable,
 
1360
                                      verbose=True)
 
1361
 
 
1362
 
 
1363
class TestCommand(unittest.TestCase):
831
1364
    """Abstract class for tests of command classes"""
 
1365
 
832
1366
    def setUp(self):
833
1367
        testcase = self
834
1368
        class MockClient(object):
835
1369
            def __init__(self, name, **attributes):
836
 
                self.__dbus_object_path__ = "objpath_{}".format(name)
 
1370
                self.__dbus_object_path__ = "/clients/{}".format(name)
837
1371
                self.attributes = attributes
838
1372
                self.attributes["Name"] = name
839
1373
                self.calls = []
840
 
            def Set(self, interface, property, value, dbus_interface):
841
 
                testcase.assertEqual(interface, client_interface)
842
 
                testcase.assertEqual(dbus_interface,
843
 
                                     dbus.PROPERTIES_IFACE)
844
 
                self.attributes[property] = value
845
 
            def Get(self, interface, property, dbus_interface):
846
 
                testcase.assertEqual(interface, client_interface)
847
 
                testcase.assertEqual(dbus_interface,
848
 
                                     dbus.PROPERTIES_IFACE)
849
 
                return self.attributes[property]
 
1374
            def Set(self, interface, propname, value, dbus_interface):
 
1375
                testcase.assertEqual(interface, client_dbus_interface)
 
1376
                testcase.assertEqual(dbus_interface,
 
1377
                                     dbus.PROPERTIES_IFACE)
 
1378
                self.attributes[propname] = value
 
1379
            def Get(self, interface, propname, dbus_interface):
 
1380
                testcase.assertEqual(interface, client_dbus_interface)
 
1381
                testcase.assertEqual(dbus_interface,
 
1382
                                     dbus.PROPERTIES_IFACE)
 
1383
                return self.attributes[propname]
850
1384
            def Approve(self, approve, dbus_interface):
851
 
                testcase.assertEqual(dbus_interface, client_interface)
 
1385
                testcase.assertEqual(dbus_interface,
 
1386
                                     client_dbus_interface)
852
1387
                self.calls.append(("Approve", (approve,
853
1388
                                               dbus_interface)))
854
1389
        self.client = MockClient(
894
1429
            ApprovedByDefault=dbus.Boolean(False),
895
1430
            LastApprovalRequest="2019-01-03T00:00:00",
896
1431
            ApprovalDelay=30000,
897
 
            ApprovalDuration=1000,
 
1432
            ApprovalDuration=93785000,
898
1433
            Checker=":",
899
1434
            ExtendedTimeout=900000,
900
1435
            Expires="2019-02-05T00:00:00",
901
1436
            LastCheckerStatus=-2)
902
1437
        self.clients =  collections.OrderedDict(
903
1438
            [
904
 
                (self.client, self.client.attributes),
905
 
                (self.other_client, self.other_client.attributes),
 
1439
                ("/clients/foo", self.client.attributes),
 
1440
                ("/clients/barbar", self.other_client.attributes),
906
1441
            ])
907
 
        self.one_client = {self.client: self.client.attributes}
908
 
 
909
 
class TestPrintTableCmd(TestCmd):
910
 
    def test_normal(self):
911
 
        output = PrintTableCmd().output(None, self.clients.values())
912
 
        expected_output = """
913
 
Name   Enabled Timeout  Last Successful Check
914
 
foo    Yes     00:05:00 2019-02-03T00:00:00  
915
 
barbar Yes     00:05:00 2019-02-04T00:00:00  
916
 
"""[1:-1]
917
 
        self.assertEqual(output, expected_output)
918
 
    def test_verbose(self):
919
 
        output = PrintTableCmd(verbose=True).output(
920
 
            None, self.clients.values())
921
 
        expected_output = """
922
 
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
923
 
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                  
924
 
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                 
925
 
"""[1:-1]
926
 
        self.assertEqual(output, expected_output)
927
 
    def test_one_client(self):
928
 
        output = PrintTableCmd().output(None, self.one_client.values())
929
 
        expected_output = """
930
 
Name Enabled Timeout  Last Successful Check
931
 
foo  Yes     00:05:00 2019-02-03T00:00:00  
932
 
"""[1:-1]
933
 
        self.assertEqual(output, expected_output)
934
 
 
935
 
class TestDumpJSONCmd(TestCmd):
936
 
    def setUp(self):
937
 
        self.expected_json = {
938
 
            "foo": {
939
 
                "Name": "foo",
940
 
                "KeyID": ("92ed150794387c03ce684574b1139a65"
941
 
                          "94a34f895daaaf09fd8ea90a27cddb12"),
942
 
                "Host": "foo.example.org",
943
 
                "Enabled": True,
944
 
                "Timeout": 300000,
945
 
                "LastCheckedOK": "2019-02-03T00:00:00",
946
 
                "Created": "2019-01-02T00:00:00",
947
 
                "Interval": 120000,
948
 
                "Fingerprint": ("778827225BA7DE539C5A"
949
 
                                "7CFA59CFF7CDBD9A5920"),
950
 
                "CheckerRunning": False,
951
 
                "LastEnabled": "2019-01-03T00:00:00",
952
 
                "ApprovalPending": False,
953
 
                "ApprovedByDefault": True,
954
 
                "LastApprovalRequest": "",
955
 
                "ApprovalDelay": 0,
956
 
                "ApprovalDuration": 1000,
957
 
                "Checker": "fping -q -- %(host)s",
958
 
                "ExtendedTimeout": 900000,
959
 
                "Expires": "2019-02-04T00:00:00",
960
 
                "LastCheckerStatus": 0,
961
 
            },
962
 
            "barbar": {
963
 
                "Name": "barbar",
964
 
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
965
 
                          "6ab612cff5ad227247e46c2b020f441c"),
966
 
                "Host": "192.0.2.3",
967
 
                "Enabled": True,
968
 
                "Timeout": 300000,
969
 
                "LastCheckedOK": "2019-02-04T00:00:00",
970
 
                "Created": "2019-01-03T00:00:00",
971
 
                "Interval": 120000,
972
 
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
973
 
                                "F547B3A107558FCA3A27"),
974
 
                "CheckerRunning": True,
975
 
                "LastEnabled": "2019-01-04T00:00:00",
976
 
                "ApprovalPending": False,
977
 
                "ApprovedByDefault": False,
978
 
                "LastApprovalRequest": "2019-01-03T00:00:00",
979
 
                "ApprovalDelay": 30000,
980
 
                "ApprovalDuration": 1000,
981
 
                "Checker": ":",
982
 
                "ExtendedTimeout": 900000,
983
 
                "Expires": "2019-02-05T00:00:00",
984
 
                "LastCheckerStatus": -2,
985
 
            },
986
 
        }
987
 
        return super(TestDumpJSONCmd, self).setUp()
988
 
    def test_normal(self):
989
 
        json_data = json.loads(DumpJSONCmd().output(None,
990
 
                                                    self.clients))
991
 
        self.assertDictEqual(json_data, self.expected_json)
992
 
    def test_one_client(self):
993
 
        clients = self.one_client
994
 
        json_data = json.loads(DumpJSONCmd().output(None, clients))
995
 
        expected_json = {"foo": self.expected_json["foo"]}
996
 
        self.assertDictEqual(json_data, expected_json)
997
 
 
998
 
class TestIsEnabledCmd(TestCmd):
999
 
    def test_is_enabled(self):
1000
 
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
1001
 
                            for client, properties in self.clients.items()))
1002
 
    def test_is_enabled_run_exits_successfully(self):
 
1442
        self.one_client = {"/clients/foo": self.client.attributes}
 
1443
 
 
1444
    @property
 
1445
    def bus(self):
 
1446
        class Bus(object):
 
1447
            @staticmethod
 
1448
            def get_object(client_bus_name, path):
 
1449
                self.assertEqual(client_bus_name, dbus_busname)
 
1450
                return {
 
1451
                    # Note: "self" here is the TestCmd instance, not
 
1452
                    # the Bus instance, since this is a static method!
 
1453
                    "/clients/foo": self.client,
 
1454
                    "/clients/barbar": self.other_client,
 
1455
                }[path]
 
1456
        return Bus()
 
1457
 
 
1458
 
 
1459
class TestBaseCommands(TestCommand):
 
1460
 
 
1461
    def test_IsEnabled(self):
 
1462
        self.assertTrue(all(command.IsEnabled().is_enabled(client,
 
1463
                                                      properties)
 
1464
                            for client, properties
 
1465
                            in self.clients.items()))
 
1466
 
 
1467
    def test_IsEnabled_run_exits_successfully(self):
1003
1468
        with self.assertRaises(SystemExit) as e:
1004
 
            IsEnabledCmd().run(None, None, self.one_client)
 
1469
            command.IsEnabled().run(self.one_client)
1005
1470
        if e.exception.code is not None:
1006
1471
            self.assertEqual(e.exception.code, 0)
1007
1472
        else:
1008
1473
            self.assertIsNone(e.exception.code)
1009
 
    def test_is_enabled_run_exits_with_failure(self):
 
1474
 
 
1475
    def test_IsEnabled_run_exits_with_failure(self):
1010
1476
        self.client.attributes["Enabled"] = dbus.Boolean(False)
1011
1477
        with self.assertRaises(SystemExit) as e:
1012
 
            IsEnabledCmd().run(None, None, self.one_client)
 
1478
            command.IsEnabled().run(self.one_client)
1013
1479
        if isinstance(e.exception.code, int):
1014
1480
            self.assertNotEqual(e.exception.code, 0)
1015
1481
        else:
1016
1482
            self.assertIsNotNone(e.exception.code)
1017
1483
 
1018
 
class TestRemoveCmd(TestCmd):
1019
 
    def test_remove(self):
 
1484
    def test_Approve(self):
 
1485
        command.Approve().run(self.clients, self.bus)
 
1486
        for clientpath in self.clients:
 
1487
            client = self.bus.get_object(dbus_busname, clientpath)
 
1488
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1489
                          client.calls)
 
1490
 
 
1491
    def test_Deny(self):
 
1492
        command.Deny().run(self.clients, self.bus)
 
1493
        for clientpath in self.clients:
 
1494
            client = self.bus.get_object(dbus_busname, clientpath)
 
1495
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1496
                          client.calls)
 
1497
 
 
1498
    def test_Remove(self):
1020
1499
        class MockMandos(object):
1021
1500
            def __init__(self):
1022
1501
                self.calls = []
1023
1502
            def RemoveClient(self, dbus_path):
1024
1503
                self.calls.append(("RemoveClient", (dbus_path,)))
1025
1504
        mandos = MockMandos()
1026
 
        super(TestRemoveCmd, self).setUp()
1027
 
        RemoveCmd().run(mandos, None, self.clients)
 
1505
        command.Remove().run(self.clients, self.bus, mandos)
1028
1506
        self.assertEqual(len(mandos.calls), 2)
1029
 
        for client in self.clients:
1030
 
            self.assertIn(("RemoveClient",
1031
 
                           (client.__dbus_object_path__,)),
 
1507
        for clientpath in self.clients:
 
1508
            self.assertIn(("RemoveClient", (clientpath,)),
1032
1509
                          mandos.calls)
1033
1510
 
1034
 
class TestApproveCmd(TestCmd):
1035
 
    def test_approve(self):
1036
 
        ApproveCmd().run(None, None, self.clients)
1037
 
        for client in self.clients:
1038
 
            self.assertIn(("Approve", (True, client_interface)),
1039
 
                          client.calls)
1040
 
 
1041
 
class TestDenyCmd(TestCmd):
1042
 
    def test_deny(self):
1043
 
        DenyCmd().run(None, None, self.clients)
1044
 
        for client in self.clients:
1045
 
            self.assertIn(("Approve", (False, client_interface)),
1046
 
                          client.calls)
1047
 
 
1048
 
class TestEnableCmd(TestCmd):
1049
 
    def test_enable(self):
1050
 
        for client in self.clients:
1051
 
            client.attributes["Enabled"] = False
1052
 
 
1053
 
        EnableCmd().run(None, None, self.clients)
1054
 
 
1055
 
        for client in self.clients:
1056
 
            self.assertTrue(client.attributes["Enabled"])
1057
 
 
1058
 
class TestDisableCmd(TestCmd):
1059
 
    def test_disable(self):
1060
 
        DisableCmd().run(None, None, self.clients)
1061
 
 
1062
 
        for client in self.clients:
1063
 
            self.assertFalse(client.attributes["Enabled"])
1064
 
 
1065
 
class Unique(object):
1066
 
    """Class for objects which exist only to be unique objects, since
1067
 
unittest.mock.sentinel only exists in Python 3.3"""
1068
 
 
1069
 
class TestPropertyCmd(TestCmd):
1070
 
    """Abstract class for tests of PropertyCmd classes"""
 
1511
    expected_json = {
 
1512
        "foo": {
 
1513
            "Name": "foo",
 
1514
            "KeyID": ("92ed150794387c03ce684574b1139a65"
 
1515
                      "94a34f895daaaf09fd8ea90a27cddb12"),
 
1516
            "Host": "foo.example.org",
 
1517
            "Enabled": True,
 
1518
            "Timeout": 300000,
 
1519
            "LastCheckedOK": "2019-02-03T00:00:00",
 
1520
            "Created": "2019-01-02T00:00:00",
 
1521
            "Interval": 120000,
 
1522
            "Fingerprint": ("778827225BA7DE539C5A"
 
1523
                            "7CFA59CFF7CDBD9A5920"),
 
1524
            "CheckerRunning": False,
 
1525
            "LastEnabled": "2019-01-03T00:00:00",
 
1526
            "ApprovalPending": False,
 
1527
            "ApprovedByDefault": True,
 
1528
            "LastApprovalRequest": "",
 
1529
            "ApprovalDelay": 0,
 
1530
            "ApprovalDuration": 1000,
 
1531
            "Checker": "fping -q -- %(host)s",
 
1532
            "ExtendedTimeout": 900000,
 
1533
            "Expires": "2019-02-04T00:00:00",
 
1534
            "LastCheckerStatus": 0,
 
1535
        },
 
1536
        "barbar": {
 
1537
            "Name": "barbar",
 
1538
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
1539
                      "6ab612cff5ad227247e46c2b020f441c"),
 
1540
            "Host": "192.0.2.3",
 
1541
            "Enabled": True,
 
1542
            "Timeout": 300000,
 
1543
            "LastCheckedOK": "2019-02-04T00:00:00",
 
1544
            "Created": "2019-01-03T00:00:00",
 
1545
            "Interval": 120000,
 
1546
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
1547
                            "F547B3A107558FCA3A27"),
 
1548
            "CheckerRunning": True,
 
1549
            "LastEnabled": "2019-01-04T00:00:00",
 
1550
            "ApprovalPending": False,
 
1551
            "ApprovedByDefault": False,
 
1552
            "LastApprovalRequest": "2019-01-03T00:00:00",
 
1553
            "ApprovalDelay": 30000,
 
1554
            "ApprovalDuration": 93785000,
 
1555
            "Checker": ":",
 
1556
            "ExtendedTimeout": 900000,
 
1557
            "Expires": "2019-02-05T00:00:00",
 
1558
            "LastCheckerStatus": -2,
 
1559
        },
 
1560
    }
 
1561
 
 
1562
    def test_DumpJSON_normal(self):
 
1563
        output = command.DumpJSON().output(self.clients.values())
 
1564
        json_data = json.loads(output)
 
1565
        self.assertDictEqual(json_data, self.expected_json)
 
1566
 
 
1567
    def test_DumpJSON_one_client(self):
 
1568
        output = command.DumpJSON().output(self.one_client.values())
 
1569
        json_data = json.loads(output)
 
1570
        expected_json = {"foo": self.expected_json["foo"]}
 
1571
        self.assertDictEqual(json_data, expected_json)
 
1572
 
 
1573
    def test_PrintTable_normal(self):
 
1574
        output = command.PrintTable().output(self.clients.values())
 
1575
        expected_output = "\n".join((
 
1576
            "Name   Enabled Timeout  Last Successful Check",
 
1577
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
 
1578
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
 
1579
        ))
 
1580
        self.assertEqual(output, expected_output)
 
1581
 
 
1582
    def test_PrintTable_verbose(self):
 
1583
        output = command.PrintTable(verbose=True).output(
 
1584
            self.clients.values())
 
1585
        columns = (
 
1586
            (
 
1587
                "Name   ",
 
1588
                "foo    ",
 
1589
                "barbar ",
 
1590
            ),(
 
1591
                "Enabled ",
 
1592
                "Yes     ",
 
1593
                "Yes     ",
 
1594
            ),(
 
1595
                "Timeout  ",
 
1596
                "00:05:00 ",
 
1597
                "00:05:00 ",
 
1598
            ),(
 
1599
                "Last Successful Check ",
 
1600
                "2019-02-03T00:00:00   ",
 
1601
                "2019-02-04T00:00:00   ",
 
1602
            ),(
 
1603
                "Created             ",
 
1604
                "2019-01-02T00:00:00 ",
 
1605
                "2019-01-03T00:00:00 ",
 
1606
            ),(
 
1607
                "Interval ",
 
1608
                "00:02:00 ",
 
1609
                "00:02:00 ",
 
1610
            ),(
 
1611
                "Host            ",
 
1612
                "foo.example.org ",
 
1613
                "192.0.2.3       ",
 
1614
            ),(
 
1615
                ("Key ID                                             "
 
1616
                 "              "),
 
1617
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
 
1618
                 "ea90a27cddb12 "),
 
1619
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
 
1620
                 "46c2b020f441c "),
 
1621
            ),(
 
1622
                "Fingerprint                              ",
 
1623
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
 
1624
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
 
1625
            ),(
 
1626
                "Check Is Running ",
 
1627
                "No               ",
 
1628
                "Yes              ",
 
1629
            ),(
 
1630
                "Last Enabled        ",
 
1631
                "2019-01-03T00:00:00 ",
 
1632
                "2019-01-04T00:00:00 ",
 
1633
            ),(
 
1634
                "Approval Is Pending ",
 
1635
                "No                  ",
 
1636
                "No                  ",
 
1637
            ),(
 
1638
                "Approved By Default ",
 
1639
                "Yes                 ",
 
1640
                "No                  ",
 
1641
            ),(
 
1642
                "Last Approval Request ",
 
1643
                "                      ",
 
1644
                "2019-01-03T00:00:00   ",
 
1645
            ),(
 
1646
                "Approval Delay ",
 
1647
                "00:00:00       ",
 
1648
                "00:00:30       ",
 
1649
            ),(
 
1650
                "Approval Duration ",
 
1651
                "00:00:01          ",
 
1652
                "1T02:03:05        ",
 
1653
            ),(
 
1654
                "Checker              ",
 
1655
                "fping -q -- %(host)s ",
 
1656
                ":                    ",
 
1657
            ),(
 
1658
                "Extended Timeout ",
 
1659
                "00:15:00         ",
 
1660
                "00:15:00         ",
 
1661
            ),(
 
1662
                "Expires             ",
 
1663
                "2019-02-04T00:00:00 ",
 
1664
                "2019-02-05T00:00:00 ",
 
1665
            ),(
 
1666
                "Last Checker Status",
 
1667
                "0                  ",
 
1668
                "-2                 ",
 
1669
            )
 
1670
        )
 
1671
        num_lines = max(len(rows) for rows in columns)
 
1672
        expected_output = "\n".join("".join(rows[line]
 
1673
                                            for rows in columns)
 
1674
                                    for line in range(num_lines))
 
1675
        self.assertEqual(output, expected_output)
 
1676
 
 
1677
    def test_PrintTable_one_client(self):
 
1678
        output = command.PrintTable().output(self.one_client.values())
 
1679
        expected_output = "\n".join((
 
1680
            "Name Enabled Timeout  Last Successful Check",
 
1681
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
 
1682
        ))
 
1683
        self.assertEqual(output, expected_output)
 
1684
 
 
1685
 
 
1686
class TestPropertyCmd(TestCommand):
 
1687
    """Abstract class for tests of command.Property classes"""
1071
1688
    def runTest(self):
1072
1689
        if not hasattr(self, "command"):
1073
1690
            return
1075
1692
                                self.values_to_set)
1076
1693
        for value_to_set, value_to_get in zip(self.values_to_set,
1077
1694
                                              values_to_get):
1078
 
            for client in self.clients:
1079
 
                old_value = client.attributes[self.property]
1080
 
                self.assertNotIsInstance(old_value, Unique)
1081
 
                client.attributes[self.property] = Unique()
 
1695
            for clientpath in self.clients:
 
1696
                client = self.bus.get_object(dbus_busname, clientpath)
 
1697
                old_value = client.attributes[self.propname]
 
1698
                self.assertNotIsInstance(old_value, self.Unique)
 
1699
                client.attributes[self.propname] = self.Unique()
1082
1700
            self.run_command(value_to_set, self.clients)
1083
 
            for client in self.clients:
1084
 
                value = client.attributes[self.property]
1085
 
                self.assertNotIsInstance(value, Unique)
 
1701
            for clientpath in self.clients:
 
1702
                client = self.bus.get_object(dbus_busname, clientpath)
 
1703
                value = client.attributes[self.propname]
 
1704
                self.assertNotIsInstance(value, self.Unique)
1086
1705
                self.assertEqual(value, value_to_get)
 
1706
 
 
1707
    class Unique(object):
 
1708
        """Class for objects which exist only to be unique objects,
 
1709
since unittest.mock.sentinel only exists in Python 3.3"""
 
1710
 
1087
1711
    def run_command(self, value, clients):
1088
 
        self.command().run(None, None, clients)
 
1712
        self.command().run(clients, self.bus)
 
1713
 
 
1714
 
 
1715
class TestEnableCmd(TestPropertyCmd):
 
1716
    command = command.Enable
 
1717
    propname = "Enabled"
 
1718
    values_to_set = [dbus.Boolean(True)]
 
1719
 
 
1720
 
 
1721
class TestDisableCmd(TestPropertyCmd):
 
1722
    command = command.Disable
 
1723
    propname = "Enabled"
 
1724
    values_to_set = [dbus.Boolean(False)]
 
1725
 
1089
1726
 
1090
1727
class TestBumpTimeoutCmd(TestPropertyCmd):
1091
 
    command = BumpTimeoutCmd
1092
 
    property = "LastCheckedOK"
 
1728
    command = command.BumpTimeout
 
1729
    propname = "LastCheckedOK"
1093
1730
    values_to_set = [""]
1094
1731
 
 
1732
 
1095
1733
class TestStartCheckerCmd(TestPropertyCmd):
1096
 
    command = StartCheckerCmd
1097
 
    property = "CheckerRunning"
 
1734
    command = command.StartChecker
 
1735
    propname = "CheckerRunning"
1098
1736
    values_to_set = [dbus.Boolean(True)]
1099
1737
 
 
1738
 
1100
1739
class TestStopCheckerCmd(TestPropertyCmd):
1101
 
    command = StopCheckerCmd
1102
 
    property = "CheckerRunning"
 
1740
    command = command.StopChecker
 
1741
    propname = "CheckerRunning"
1103
1742
    values_to_set = [dbus.Boolean(False)]
1104
1743
 
 
1744
 
1105
1745
class TestApproveByDefaultCmd(TestPropertyCmd):
1106
 
    command = ApproveByDefaultCmd
1107
 
    property = "ApprovedByDefault"
 
1746
    command = command.ApproveByDefault
 
1747
    propname = "ApprovedByDefault"
1108
1748
    values_to_set = [dbus.Boolean(True)]
1109
1749
 
 
1750
 
1110
1751
class TestDenyByDefaultCmd(TestPropertyCmd):
1111
 
    command = DenyByDefaultCmd
1112
 
    property = "ApprovedByDefault"
 
1752
    command = command.DenyByDefault
 
1753
    propname = "ApprovedByDefault"
1113
1754
    values_to_set = [dbus.Boolean(False)]
1114
1755
 
1115
 
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1116
 
    """Abstract class for tests of PropertyCmd classes using the
1117
 
ValueArgumentMixIn"""
 
1756
 
 
1757
class TestPropertyValueCmd(TestPropertyCmd):
 
1758
    """Abstract class for tests of PropertyValueCmd classes"""
 
1759
 
1118
1760
    def runTest(self):
1119
 
        if type(self) is TestValueArgumentPropertyCmd:
 
1761
        if type(self) is TestPropertyValueCmd:
1120
1762
            return
1121
 
        return super(TestValueArgumentPropertyCmd, self).runTest()
 
1763
        return super(TestPropertyValueCmd, self).runTest()
 
1764
 
1122
1765
    def run_command(self, value, clients):
1123
 
        self.command(value).run(None, None, clients)
1124
 
 
1125
 
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1126
 
    command = SetCheckerCmd
1127
 
    property = "Checker"
 
1766
        self.command(value).run(clients, self.bus)
 
1767
 
 
1768
 
 
1769
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1770
    command = command.SetChecker
 
1771
    propname = "Checker"
1128
1772
    values_to_set = ["", ":", "fping -q -- %s"]
1129
1773
 
1130
 
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1131
 
    command = SetHostCmd
1132
 
    property = "Host"
 
1774
 
 
1775
class TestSetHostCmd(TestPropertyValueCmd):
 
1776
    command = command.SetHost
 
1777
    propname = "Host"
1133
1778
    values_to_set = ["192.0.2.3", "foo.example.org"]
1134
1779
 
1135
 
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1136
 
    command = SetSecretCmd
1137
 
    property = "Secret"
 
1780
 
 
1781
class TestSetSecretCmd(TestPropertyValueCmd):
 
1782
    command = command.SetSecret
 
1783
    propname = "Secret"
1138
1784
    values_to_set = [io.BytesIO(b""),
1139
1785
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1140
1786
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
1141
1787
 
1142
 
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1143
 
    command = SetTimeoutCmd
1144
 
    property = "Timeout"
1145
 
    values_to_set = [datetime.timedelta(),
1146
 
                     datetime.timedelta(minutes=5),
1147
 
                     datetime.timedelta(seconds=1),
1148
 
                     datetime.timedelta(weeks=1),
1149
 
                     datetime.timedelta(weeks=52)]
1150
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1151
 
 
1152
 
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1153
 
    command = SetExtendedTimeoutCmd
1154
 
    property = "ExtendedTimeout"
1155
 
    values_to_set = [datetime.timedelta(),
1156
 
                     datetime.timedelta(minutes=5),
1157
 
                     datetime.timedelta(seconds=1),
1158
 
                     datetime.timedelta(weeks=1),
1159
 
                     datetime.timedelta(weeks=52)]
1160
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1161
 
 
1162
 
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1163
 
    command = SetIntervalCmd
1164
 
    property = "Interval"
1165
 
    values_to_set = [datetime.timedelta(),
1166
 
                     datetime.timedelta(minutes=5),
1167
 
                     datetime.timedelta(seconds=1),
1168
 
                     datetime.timedelta(weeks=1),
1169
 
                     datetime.timedelta(weeks=52)]
1170
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1171
 
 
1172
 
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1173
 
    command = SetApprovalDelayCmd
1174
 
    property = "ApprovalDelay"
1175
 
    values_to_set = [datetime.timedelta(),
1176
 
                     datetime.timedelta(minutes=5),
1177
 
                     datetime.timedelta(seconds=1),
1178
 
                     datetime.timedelta(weeks=1),
1179
 
                     datetime.timedelta(weeks=52)]
1180
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1181
 
 
1182
 
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1183
 
    command = SetApprovalDurationCmd
1184
 
    property = "ApprovalDuration"
1185
 
    values_to_set = [datetime.timedelta(),
1186
 
                     datetime.timedelta(minutes=5),
1187
 
                     datetime.timedelta(seconds=1),
1188
 
                     datetime.timedelta(weeks=1),
1189
 
                     datetime.timedelta(weeks=52)]
1190
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1191
 
 
1192
 
class Test_command_from_options(unittest.TestCase):
1193
 
    def setUp(self):
1194
 
        self.parser = argparse.ArgumentParser()
1195
 
        add_command_line_options(self.parser)
1196
 
    def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1197
 
        """Assert that parsing ARGS should result in an instance of
1198
 
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1199
 
        options = self.parser.parse_args(args)
1200
 
        check_option_syntax(self.parser, options)
1201
 
        commands = commands_from_options(options)
1202
 
        self.assertEqual(len(commands), 1)
1203
 
        command = commands[0]
1204
 
        self.assertIsInstance(command, command_cls)
1205
 
        for key, value in cmd_attrs.items():
1206
 
            self.assertEqual(getattr(command, key), value)
1207
 
    def test_print_table(self):
1208
 
        self.assert_command_from_args([], PrintTableCmd,
1209
 
                                      verbose=False)
1210
 
 
1211
 
    def test_print_table_verbose(self):
1212
 
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
1213
 
                                      verbose=True)
1214
 
 
1215
 
    def test_print_table_verbose_short(self):
1216
 
        self.assert_command_from_args(["-v"], PrintTableCmd,
1217
 
                                      verbose=True)
1218
 
 
1219
 
    def test_enable(self):
1220
 
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1221
 
 
1222
 
    def test_enable_short(self):
1223
 
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
1224
 
 
1225
 
    def test_disable(self):
1226
 
        self.assert_command_from_args(["--disable", "foo"],
1227
 
                                      DisableCmd)
1228
 
 
1229
 
    def test_disable_short(self):
1230
 
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
1231
 
 
1232
 
    def test_bump_timeout(self):
1233
 
        self.assert_command_from_args(["--bump-timeout", "foo"],
1234
 
                                      BumpTimeoutCmd)
1235
 
 
1236
 
    def test_bump_timeout_short(self):
1237
 
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1238
 
 
1239
 
    def test_start_checker(self):
1240
 
        self.assert_command_from_args(["--start-checker", "foo"],
1241
 
                                      StartCheckerCmd)
1242
 
 
1243
 
    def test_stop_checker(self):
1244
 
        self.assert_command_from_args(["--stop-checker", "foo"],
1245
 
                                      StopCheckerCmd)
1246
 
 
1247
 
    def test_remove(self):
1248
 
        self.assert_command_from_args(["--remove", "foo"],
1249
 
                                      RemoveCmd)
1250
 
 
1251
 
    def test_remove_short(self):
1252
 
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1253
 
 
1254
 
    def test_checker(self):
1255
 
        self.assert_command_from_args(["--checker", ":", "foo"],
1256
 
                                      SetCheckerCmd, value_to_set=":")
1257
 
 
1258
 
    def test_checker_empty(self):
1259
 
        self.assert_command_from_args(["--checker", "", "foo"],
1260
 
                                      SetCheckerCmd, value_to_set="")
1261
 
 
1262
 
    def test_checker_short(self):
1263
 
        self.assert_command_from_args(["-c", ":", "foo"],
1264
 
                                      SetCheckerCmd, value_to_set=":")
1265
 
 
1266
 
    def test_timeout(self):
1267
 
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1268
 
                                      SetTimeoutCmd,
1269
 
                                      value_to_set=300000)
1270
 
 
1271
 
    def test_timeout_short(self):
1272
 
        self.assert_command_from_args(["-t", "PT5M", "foo"],
1273
 
                                      SetTimeoutCmd,
1274
 
                                      value_to_set=300000)
1275
 
 
1276
 
    def test_extended_timeout(self):
1277
 
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1278
 
                                       "foo"],
1279
 
                                      SetExtendedTimeoutCmd,
1280
 
                                      value_to_set=900000)
1281
 
 
1282
 
    def test_interval(self):
1283
 
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
1284
 
                                      SetIntervalCmd,
1285
 
                                      value_to_set=120000)
1286
 
 
1287
 
    def test_interval_short(self):
1288
 
        self.assert_command_from_args(["-i", "PT2M", "foo"],
1289
 
                                      SetIntervalCmd,
1290
 
                                      value_to_set=120000)
1291
 
 
1292
 
    def test_approve_by_default(self):
1293
 
        self.assert_command_from_args(["--approve-by-default", "foo"],
1294
 
                                      ApproveByDefaultCmd)
1295
 
 
1296
 
    def test_deny_by_default(self):
1297
 
        self.assert_command_from_args(["--deny-by-default", "foo"],
1298
 
                                      DenyByDefaultCmd)
1299
 
 
1300
 
    def test_approval_delay(self):
1301
 
        self.assert_command_from_args(["--approval-delay", "PT30S",
1302
 
                                       "foo"], SetApprovalDelayCmd,
1303
 
                                      value_to_set=30000)
1304
 
 
1305
 
    def test_approval_duration(self):
1306
 
        self.assert_command_from_args(["--approval-duration", "PT1S",
1307
 
                                       "foo"], SetApprovalDurationCmd,
1308
 
                                      value_to_set=1000)
1309
 
 
1310
 
    def test_host(self):
1311
 
        self.assert_command_from_args(["--host", "foo.example.org",
1312
 
                                       "foo"], SetHostCmd,
1313
 
                                      value_to_set="foo.example.org")
1314
 
 
1315
 
    def test_host_short(self):
1316
 
        self.assert_command_from_args(["-H", "foo.example.org",
1317
 
                                       "foo"], SetHostCmd,
1318
 
                                      value_to_set="foo.example.org")
1319
 
 
1320
 
    def test_secret_devnull(self):
1321
 
        self.assert_command_from_args(["--secret", os.path.devnull,
1322
 
                                       "foo"], SetSecretCmd,
1323
 
                                      value_to_set=b"")
1324
 
 
1325
 
    def test_secret_tempfile(self):
1326
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1327
 
            value = b"secret\0xyzzy\nbar"
1328
 
            f.write(value)
1329
 
            f.seek(0)
1330
 
            self.assert_command_from_args(["--secret", f.name,
1331
 
                                           "foo"], SetSecretCmd,
1332
 
                                          value_to_set=value)
1333
 
 
1334
 
    def test_secret_devnull_short(self):
1335
 
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1336
 
                                      SetSecretCmd, value_to_set=b"")
1337
 
 
1338
 
    def test_secret_tempfile_short(self):
1339
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1340
 
            value = b"secret\0xyzzy\nbar"
1341
 
            f.write(value)
1342
 
            f.seek(0)
1343
 
            self.assert_command_from_args(["-s", f.name, "foo"],
1344
 
                                          SetSecretCmd,
1345
 
                                          value_to_set=value)
1346
 
 
1347
 
    def test_approve(self):
1348
 
        self.assert_command_from_args(["--approve", "foo"],
1349
 
                                      ApproveCmd)
1350
 
 
1351
 
    def test_approve_short(self):
1352
 
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1353
 
 
1354
 
    def test_deny(self):
1355
 
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1356
 
 
1357
 
    def test_deny_short(self):
1358
 
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
1359
 
 
1360
 
    def test_dump_json(self):
1361
 
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1362
 
 
1363
 
    def test_is_enabled(self):
1364
 
        self.assert_command_from_args(["--is-enabled", "foo"],
1365
 
                                      IsEnabledCmd)
1366
 
 
1367
 
    def test_is_enabled_short(self):
1368
 
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1369
 
 
1370
 
    def test_deny_before_remove(self):
1371
 
        options = self.parser.parse_args(["--deny", "--remove", "foo"])
1372
 
        check_option_syntax(self.parser, options)
1373
 
        commands = commands_from_options(options)
1374
 
        self.assertEqual(len(commands), 2)
1375
 
        self.assertIsInstance(commands[0], DenyCmd)
1376
 
        self.assertIsInstance(commands[1], RemoveCmd)
1377
 
 
1378
 
    def test_deny_before_remove_reversed(self):
1379
 
        options = self.parser.parse_args(["--remove", "--deny", "--all"])
1380
 
        check_option_syntax(self.parser, options)
1381
 
        commands = commands_from_options(options)
1382
 
        self.assertEqual(len(commands), 2)
1383
 
        self.assertIsInstance(commands[0], DenyCmd)
1384
 
        self.assertIsInstance(commands[1], RemoveCmd)
1385
 
 
1386
 
 
1387
 
class Test_check_option_syntax(unittest.TestCase):
1388
 
    # This mostly corresponds to the definition from has_actions() in
1389
 
    # check_option_syntax()
1390
 
    actions = {
1391
 
        # The actual values set here are not that important, but we do
1392
 
        # at least stick to the correct types, even though they are
1393
 
        # never used
1394
 
        "enable": True,
1395
 
        "disable": True,
1396
 
        "bump_timeout": True,
1397
 
        "start_checker": True,
1398
 
        "stop_checker": True,
1399
 
        "is_enabled": True,
1400
 
        "remove": True,
1401
 
        "checker": "x",
1402
 
        "timeout": datetime.timedelta(),
1403
 
        "extended_timeout": datetime.timedelta(),
1404
 
        "interval": datetime.timedelta(),
1405
 
        "approved_by_default": True,
1406
 
        "approval_delay": datetime.timedelta(),
1407
 
        "approval_duration": datetime.timedelta(),
1408
 
        "host": "x",
1409
 
        "secret": io.BytesIO(b"x"),
1410
 
        "approve": True,
1411
 
        "deny": True,
1412
 
    }
1413
 
 
1414
 
    def setUp(self):
1415
 
        self.parser = argparse.ArgumentParser()
1416
 
        add_command_line_options(self.parser)
1417
 
 
1418
 
    @contextlib.contextmanager
1419
 
    def assertParseError(self):
1420
 
        with self.assertRaises(SystemExit) as e:
1421
 
            with self.temporarily_suppress_stderr():
1422
 
                yield
1423
 
        # Exit code from argparse is guaranteed to be "2".  Reference:
1424
 
        # https://docs.python.org/3/library/argparse.html#exiting-methods
1425
 
        self.assertEqual(e.exception.code, 2)
1426
 
 
1427
 
    @staticmethod
1428
 
    @contextlib.contextmanager
1429
 
    def temporarily_suppress_stderr():
1430
 
        null = os.open(os.path.devnull, os.O_RDWR)
1431
 
        stderrcopy = os.dup(sys.stderr.fileno())
1432
 
        os.dup2(null, sys.stderr.fileno())
1433
 
        os.close(null)
1434
 
        try:
1435
 
            yield
1436
 
        finally:
1437
 
            # restore stderr
1438
 
            os.dup2(stderrcopy, sys.stderr.fileno())
1439
 
            os.close(stderrcopy)
1440
 
 
1441
 
    def check_option_syntax(self, options):
1442
 
        check_option_syntax(self.parser, options)
1443
 
 
1444
 
    def test_actions_requires_client_or_all(self):
1445
 
        for action, value in self.actions.items():
1446
 
            options = self.parser.parse_args()
1447
 
            setattr(options, action, value)
1448
 
            with self.assertParseError():
1449
 
                self.check_option_syntax(options)
1450
 
 
1451
 
    def test_actions_conflicts_with_verbose(self):
1452
 
        for action, value in self.actions.items():
1453
 
            options = self.parser.parse_args()
1454
 
            setattr(options, action, value)
1455
 
            options.verbose = True
1456
 
            with self.assertParseError():
1457
 
                self.check_option_syntax(options)
1458
 
 
1459
 
    def test_dump_json_conflicts_with_verbose(self):
1460
 
        options = self.parser.parse_args()
1461
 
        options.dump_json = True
1462
 
        options.verbose = True
1463
 
        with self.assertParseError():
1464
 
            self.check_option_syntax(options)
1465
 
 
1466
 
    def test_dump_json_conflicts_with_action(self):
1467
 
        for action, value in self.actions.items():
1468
 
            options = self.parser.parse_args()
1469
 
            setattr(options, action, value)
1470
 
            options.dump_json = True
1471
 
            with self.assertParseError():
1472
 
                self.check_option_syntax(options)
1473
 
 
1474
 
    def test_all_can_not_be_alone(self):
1475
 
        options = self.parser.parse_args()
1476
 
        options.all = True
1477
 
        with self.assertParseError():
1478
 
            self.check_option_syntax(options)
1479
 
 
1480
 
    def test_all_is_ok_with_any_action(self):
1481
 
        for action, value in self.actions.items():
1482
 
            options = self.parser.parse_args()
1483
 
            setattr(options, action, value)
1484
 
            options.all = True
1485
 
            self.check_option_syntax(options)
1486
 
 
1487
 
    def test_is_enabled_fails_without_client(self):
1488
 
        options = self.parser.parse_args()
1489
 
        options.is_enabled = True
1490
 
        with self.assertParseError():
1491
 
            self.check_option_syntax(options)
1492
 
 
1493
 
    def test_is_enabled_works_with_one_client(self):
1494
 
        options = self.parser.parse_args()
1495
 
        options.is_enabled = True
1496
 
        options.client = ["foo"]
1497
 
        self.check_option_syntax(options)
1498
 
 
1499
 
    def test_is_enabled_fails_with_two_clients(self):
1500
 
        options = self.parser.parse_args()
1501
 
        options.is_enabled = True
1502
 
        options.client = ["foo", "barbar"]
1503
 
        with self.assertParseError():
1504
 
            self.check_option_syntax(options)
1505
 
 
1506
 
    def test_remove_can_only_be_combined_with_action_deny(self):
1507
 
        for action, value in self.actions.items():
1508
 
            if action in {"remove", "deny"}:
1509
 
                continue
1510
 
            options = self.parser.parse_args()
1511
 
            setattr(options, action, value)
1512
 
            options.all = True
1513
 
            options.remove = True
1514
 
            with self.assertParseError():
1515
 
                self.check_option_syntax(options)
 
1788
 
 
1789
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1790
    command = command.SetTimeout
 
1791
    propname = "Timeout"
 
1792
    values_to_set = [datetime.timedelta(),
 
1793
                     datetime.timedelta(minutes=5),
 
1794
                     datetime.timedelta(seconds=1),
 
1795
                     datetime.timedelta(weeks=1),
 
1796
                     datetime.timedelta(weeks=52)]
 
1797
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1798
 
 
1799
 
 
1800
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1801
    command = command.SetExtendedTimeout
 
1802
    propname = "ExtendedTimeout"
 
1803
    values_to_set = [datetime.timedelta(),
 
1804
                     datetime.timedelta(minutes=5),
 
1805
                     datetime.timedelta(seconds=1),
 
1806
                     datetime.timedelta(weeks=1),
 
1807
                     datetime.timedelta(weeks=52)]
 
1808
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1809
 
 
1810
 
 
1811
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1812
    command = command.SetInterval
 
1813
    propname = "Interval"
 
1814
    values_to_set = [datetime.timedelta(),
 
1815
                     datetime.timedelta(minutes=5),
 
1816
                     datetime.timedelta(seconds=1),
 
1817
                     datetime.timedelta(weeks=1),
 
1818
                     datetime.timedelta(weeks=52)]
 
1819
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1820
 
 
1821
 
 
1822
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1823
    command = command.SetApprovalDelay
 
1824
    propname = "ApprovalDelay"
 
1825
    values_to_set = [datetime.timedelta(),
 
1826
                     datetime.timedelta(minutes=5),
 
1827
                     datetime.timedelta(seconds=1),
 
1828
                     datetime.timedelta(weeks=1),
 
1829
                     datetime.timedelta(weeks=52)]
 
1830
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1831
 
 
1832
 
 
1833
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1834
    command = command.SetApprovalDuration
 
1835
    propname = "ApprovalDuration"
 
1836
    values_to_set = [datetime.timedelta(),
 
1837
                     datetime.timedelta(minutes=5),
 
1838
                     datetime.timedelta(seconds=1),
 
1839
                     datetime.timedelta(weeks=1),
 
1840
                     datetime.timedelta(weeks=52)]
 
1841
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1516
1842
 
1517
1843
 
1518
1844
 
1533
1859
    return tests
1534
1860
 
1535
1861
if __name__ == "__main__":
1536
 
    if should_only_run_tests():
1537
 
        # Call using ./tdd-python-script --check [--verbose]
1538
 
        unittest.main()
1539
 
    else:
1540
 
        main()
 
1862
    try:
 
1863
        if should_only_run_tests():
 
1864
            # Call using ./tdd-python-script --check [--verbose]
 
1865
            unittest.main()
 
1866
        else:
 
1867
            main()
 
1868
    finally:
 
1869
        logging.shutdown()