/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-08 23:55:34 UTC
  • Revision ID: teddy@recompile.se-20190308235534-kkiwc3oeyp0vxw5h
mandos-ctl: Add new --debug option to show D-Bus calls

* mandos-ctl (PropertyCmd, RemoveCmd, ApproveCmd, DenyCmd): Add debug
  output
  (add_command_line_options): Also add "--debug" options.
  (main): If debug option is set, set logging level to DEBUG.  Also
          add debug output when connecting to Mandos server.
* mandos-ctl.xml (SYNOPSIS): Show --debug option where appropriate.
  (OPTIONS): Document new "--debug" option.

Show diffs side-by-side

added added

removed removed

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