/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-09 00:35:00 UTC
  • Revision ID: teddy@recompile.se-20190309003500-t0pdqxwy5g8jrfax
mandos-ctl: Make --deny always apply before --remove

* mandos-ctl (commands_from_options): Move options.remove clause to
                                      after options.deny.
  (Test_command_from_options.test_deny_before_remove): New.
  (Test_command_from_options.test_deny_before_remove_reversed): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python
2
 
# -*- after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --test" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
 
2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
46
46
import tempfile
47
47
import contextlib
48
48
 
49
 
try:
50
 
    import pydbus
51
 
    import gi
52
 
    dbus_python = None
53
 
except ImportError:
54
 
    import dbus as dbus_python
55
 
    pydbus = None
56
 
    class gi(object):
57
 
        """Dummy gi module, for the tests"""
58
 
        class repository(object):
59
 
            class GLib(object):
60
 
                class Error(Exception):
61
 
                    pass
 
49
import dbus
62
50
 
63
51
# Show warnings by default
64
52
if not sys.warnoptions:
73
61
 
74
62
if sys.version_info.major == 2:
75
63
    str = unicode
76
 
    import StringIO
77
 
    io.StringIO = StringIO.StringIO
78
64
 
79
65
locale.setlocale(locale.LC_ALL, "")
80
66
 
81
 
version = "1.8.4"
82
 
 
83
 
 
84
 
def main():
85
 
    parser = argparse.ArgumentParser()
86
 
    add_command_line_options(parser)
87
 
 
88
 
    options = parser.parse_args()
89
 
    check_option_syntax(parser, options)
90
 
 
91
 
    clientnames = options.client
92
 
 
93
 
    if options.debug:
94
 
        log.setLevel(logging.DEBUG)
95
 
 
96
 
    if pydbus is not None:
97
 
        bus = pydbus_adapter.CachingBus(pydbus)
98
 
    else:
99
 
        bus = dbus_python_adapter.CachingBus(dbus_python)
100
 
 
101
 
    try:
102
 
        all_clients = bus.get_clients_and_properties()
103
 
    except dbus.ConnectFailed as e:
104
 
        log.critical("Could not connect to Mandos server: %s", e)
105
 
        sys.exit(1)
106
 
    except dbus.Error as e:
107
 
        log.critical(
108
 
            "Failed to access Mandos server through D-Bus:\n%s", e)
109
 
        sys.exit(1)
110
 
 
111
 
    # Compile dict of (clientpath: properties) to process
112
 
    if not clientnames:
113
 
        clients = all_clients
114
 
    else:
115
 
        clients = {}
116
 
        for name in clientnames:
117
 
            for objpath, properties in all_clients.items():
118
 
                if properties["Name"] == name:
119
 
                    clients[objpath] = properties
120
 
                    break
121
 
            else:
122
 
                log.critical("Client not found on server: %r", name)
123
 
                sys.exit(1)
124
 
 
125
 
    commands = commands_from_options(options)
126
 
 
127
 
    for command in commands:
128
 
        command.run(clients, bus)
129
 
 
130
 
 
131
 
def add_command_line_options(parser):
132
 
    parser.add_argument("--version", action="version",
133
 
                        version="%(prog)s {}".format(version),
134
 
                        help="show version number and exit")
135
 
    parser.add_argument("-a", "--all", action="store_true",
136
 
                        help="Select all clients")
137
 
    parser.add_argument("-v", "--verbose", action="store_true",
138
 
                        help="Print all fields")
139
 
    parser.add_argument("-j", "--dump-json", dest="commands",
140
 
                        action="append_const", default=[],
141
 
                        const=command.DumpJSON(),
142
 
                        help="Dump client data in JSON format")
143
 
    enable_disable = parser.add_mutually_exclusive_group()
144
 
    enable_disable.add_argument("-e", "--enable", dest="commands",
145
 
                                action="append_const", default=[],
146
 
                                const=command.Enable(),
147
 
                                help="Enable client")
148
 
    enable_disable.add_argument("-d", "--disable", dest="commands",
149
 
                                action="append_const", default=[],
150
 
                                const=command.Disable(),
151
 
                                help="disable client")
152
 
    parser.add_argument("-b", "--bump-timeout", dest="commands",
153
 
                        action="append_const", default=[],
154
 
                        const=command.BumpTimeout(),
155
 
                        help="Bump timeout for client")
156
 
    start_stop_checker = parser.add_mutually_exclusive_group()
157
 
    start_stop_checker.add_argument("--start-checker",
158
 
                                    dest="commands",
159
 
                                    action="append_const", default=[],
160
 
                                    const=command.StartChecker(),
161
 
                                    help="Start checker for client")
162
 
    start_stop_checker.add_argument("--stop-checker", dest="commands",
163
 
                                    action="append_const", default=[],
164
 
                                    const=command.StopChecker(),
165
 
                                    help="Stop checker for client")
166
 
    parser.add_argument("-V", "--is-enabled", dest="commands",
167
 
                        action="append_const", default=[],
168
 
                        const=command.IsEnabled(),
169
 
                        help="Check if client is enabled")
170
 
    parser.add_argument("-r", "--remove", dest="commands",
171
 
                        action="append_const", default=[],
172
 
                        const=command.Remove(),
173
 
                        help="Remove client")
174
 
    parser.add_argument("-c", "--checker", dest="commands",
175
 
                        action="append", default=[],
176
 
                        metavar="COMMAND", type=command.SetChecker,
177
 
                        help="Set checker command for client")
178
 
    parser.add_argument(
179
 
        "-t", "--timeout", dest="commands", action="append",
180
 
        default=[], metavar="TIME",
181
 
        type=command.SetTimeout.argparse(string_to_delta),
182
 
        help="Set timeout for client")
183
 
    parser.add_argument(
184
 
        "--extended-timeout", dest="commands", action="append",
185
 
        default=[], metavar="TIME",
186
 
        type=command.SetExtendedTimeout.argparse(string_to_delta),
187
 
        help="Set extended timeout for client")
188
 
    parser.add_argument(
189
 
        "-i", "--interval", dest="commands", action="append",
190
 
        default=[], metavar="TIME",
191
 
        type=command.SetInterval.argparse(string_to_delta),
192
 
        help="Set checker interval for client")
193
 
    approve_deny_default = parser.add_mutually_exclusive_group()
194
 
    approve_deny_default.add_argument(
195
 
        "--approve-by-default", dest="commands",
196
 
        action="append_const", default=[],
197
 
        const=command.ApproveByDefault(),
198
 
        help="Set client to be approved by default")
199
 
    approve_deny_default.add_argument(
200
 
        "--deny-by-default", dest="commands",
201
 
        action="append_const", default=[],
202
 
        const=command.DenyByDefault(),
203
 
        help="Set client to be denied by default")
204
 
    parser.add_argument(
205
 
        "--approval-delay", dest="commands", action="append",
206
 
        default=[], metavar="TIME",
207
 
        type=command.SetApprovalDelay.argparse(string_to_delta),
208
 
        help="Set delay before client approve/deny")
209
 
    parser.add_argument(
210
 
        "--approval-duration", dest="commands", action="append",
211
 
        default=[], metavar="TIME",
212
 
        type=command.SetApprovalDuration.argparse(string_to_delta),
213
 
        help="Set duration of one client approval")
214
 
    parser.add_argument("-H", "--host", dest="commands",
215
 
                        action="append", default=[], metavar="STRING",
216
 
                        type=command.SetHost,
217
 
                        help="Set host for client")
218
 
    parser.add_argument(
219
 
        "-s", "--secret", dest="commands", action="append",
220
 
        default=[], metavar="FILENAME",
221
 
        type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
222
 
        help="Set password blob (file) for client")
223
 
    approve_deny = parser.add_mutually_exclusive_group()
224
 
    approve_deny.add_argument(
225
 
        "-A", "--approve", dest="commands", action="append_const",
226
 
        default=[], const=command.Approve(),
227
 
        help="Approve any current client request")
228
 
    approve_deny.add_argument("-D", "--deny", dest="commands",
229
 
                              action="append_const", default=[],
230
 
                              const=command.Deny(),
231
 
                              help="Deny any current client request")
232
 
    parser.add_argument("--debug", action="store_true",
233
 
                        help="Debug mode (show D-Bus commands)")
234
 
    parser.add_argument("--check", action="store_true",
235
 
                        help="Run self-test")
236
 
    parser.add_argument("client", nargs="*", help="Client name")
237
 
 
238
 
 
239
 
def string_to_delta(interval):
240
 
    """Parse a string and return a datetime.timedelta"""
241
 
 
242
 
    try:
243
 
        return rfc3339_duration_to_delta(interval)
244
 
    except ValueError as e:
245
 
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
246
 
                    ' '.join(e.args))
247
 
    return parse_pre_1_6_1_interval(interval)
 
67
domain = "se.recompile"
 
68
busname = domain + ".Mandos"
 
69
server_path = "/"
 
70
server_interface = domain + ".Mandos"
 
71
client_interface = domain + ".Mandos.Client"
 
72
version = "1.8.3"
 
73
 
 
74
 
 
75
try:
 
76
    dbus.OBJECT_MANAGER_IFACE
 
77
except AttributeError:
 
78
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
79
 
 
80
 
 
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))
248
88
 
249
89
 
250
90
def rfc3339_duration_to_delta(duration):
270
110
    >>> rfc3339_duration_to_delta("")
271
111
    Traceback (most recent call last):
272
112
    ...
273
 
    ValueError: Invalid RFC 3339 duration: ""
 
113
    ValueError: Invalid RFC 3339 duration: u''
274
114
    >>> # Must start with "P":
275
115
    >>> rfc3339_duration_to_delta("1D")
276
116
    Traceback (most recent call last):
277
117
    ...
278
 
    ValueError: Invalid RFC 3339 duration: "1D"
 
118
    ValueError: Invalid RFC 3339 duration: u'1D'
279
119
    >>> # Must use correct order
280
120
    >>> rfc3339_duration_to_delta("PT1S2M")
281
121
    Traceback (most recent call last):
282
122
    ...
283
 
    ValueError: Invalid RFC 3339 duration: "PT1S2M"
 
123
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
284
124
    >>> # Time needs time marker
285
125
    >>> rfc3339_duration_to_delta("P1H2S")
286
126
    Traceback (most recent call last):
287
127
    ...
288
 
    ValueError: Invalid RFC 3339 duration: "P1H2S"
 
128
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
289
129
    >>> # Weeks can not be combined with anything else
290
130
    >>> rfc3339_duration_to_delta("P1D2W")
291
131
    Traceback (most recent call last):
292
132
    ...
293
 
    ValueError: Invalid RFC 3339 duration: "P1D2W"
 
133
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
294
134
    >>> rfc3339_duration_to_delta("P2W2H")
295
135
    Traceback (most recent call last):
296
136
    ...
297
 
    ValueError: Invalid RFC 3339 duration: "P2W2H"
 
137
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
298
138
    """
299
139
 
300
140
    # Parsing an RFC 3339 duration with regular expressions is not
371
211
                break
372
212
        else:
373
213
            # No currently valid tokens were found
374
 
            raise ValueError("Invalid RFC 3339 duration: \"{}\""
 
214
            raise ValueError("Invalid RFC 3339 duration: {!r}"
375
215
                             .format(duration))
376
216
    # End token found
377
217
    return value
378
218
 
379
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
 
380
231
def parse_pre_1_6_1_interval(interval):
381
232
    """Parse an interval string as documented by Mandos before 1.6.1,
382
233
    and return a datetime.timedelta
420
271
    return value
421
272
 
422
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.checker is not None:
 
615
        commands.append(SetCheckerCmd(options.checker))
 
616
 
 
617
    if options.timeout is not None:
 
618
        commands.append(SetTimeoutCmd(options.timeout))
 
619
 
 
620
    if options.extended_timeout:
 
621
        commands.append(
 
622
            SetExtendedTimeoutCmd(options.extended_timeout))
 
623
 
 
624
    if options.interval is not None:
 
625
        commands.append(SetIntervalCmd(options.interval))
 
626
 
 
627
    if options.approved_by_default is not None:
 
628
        if options.approved_by_default:
 
629
            commands.append(ApproveByDefaultCmd())
 
630
        else:
 
631
            commands.append(DenyByDefaultCmd())
 
632
 
 
633
    if options.approval_delay is not None:
 
634
        commands.append(SetApprovalDelayCmd(options.approval_delay))
 
635
 
 
636
    if options.approval_duration is not None:
 
637
        commands.append(
 
638
            SetApprovalDurationCmd(options.approval_duration))
 
639
 
 
640
    if options.host is not None:
 
641
        commands.append(SetHostCmd(options.host))
 
642
 
 
643
    if options.secret is not None:
 
644
        commands.append(SetSecretCmd(options.secret))
 
645
 
 
646
    if options.approve:
 
647
        commands.append(ApproveCmd())
 
648
 
 
649
    if options.deny:
 
650
        commands.append(DenyCmd())
 
651
 
 
652
    if options.remove:
 
653
        commands.append(RemoveCmd())
 
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
 
423
663
def check_option_syntax(parser, options):
424
664
    """Apply additional restrictions on options, not expressible in
425
665
argparse"""
426
666
 
427
 
    def has_commands(options, commands=None):
428
 
        if commands is None:
429
 
            commands = (command.Enable,
430
 
                        command.Disable,
431
 
                        command.BumpTimeout,
432
 
                        command.StartChecker,
433
 
                        command.StopChecker,
434
 
                        command.IsEnabled,
435
 
                        command.Remove,
436
 
                        command.SetChecker,
437
 
                        command.SetTimeout,
438
 
                        command.SetExtendedTimeout,
439
 
                        command.SetInterval,
440
 
                        command.ApproveByDefault,
441
 
                        command.DenyByDefault,
442
 
                        command.SetApprovalDelay,
443
 
                        command.SetApprovalDuration,
444
 
                        command.SetHost,
445
 
                        command.SetSecret,
446
 
                        command.Approve,
447
 
                        command.Deny)
448
 
        return any(isinstance(cmd, commands)
449
 
                   for cmd in options.commands)
 
667
    def has_actions(options):
 
668
        return any((options.enable,
 
669
                    options.disable,
 
670
                    options.bump_timeout,
 
671
                    options.start_checker,
 
672
                    options.stop_checker,
 
673
                    options.is_enabled,
 
674
                    options.remove,
 
675
                    options.checker is not None,
 
676
                    options.timeout is not None,
 
677
                    options.extended_timeout is not None,
 
678
                    options.interval is not None,
 
679
                    options.approved_by_default is not None,
 
680
                    options.approval_delay is not None,
 
681
                    options.approval_duration is not None,
 
682
                    options.host is not None,
 
683
                    options.secret is not None,
 
684
                    options.approve,
 
685
                    options.deny))
450
686
 
451
 
    if has_commands(options) and not (options.client or options.all):
 
687
    if has_actions(options) and not (options.client or options.all):
452
688
        parser.error("Options require clients names or --all.")
453
 
    if options.verbose and has_commands(options):
 
689
    if options.verbose and has_actions(options):
454
690
        parser.error("--verbose can only be used alone.")
455
 
    if (has_commands(options, (command.DumpJSON,))
456
 
        and (options.verbose or len(options.commands) > 1)):
 
691
    if options.dump_json and (options.verbose
 
692
                              or has_actions(options)):
457
693
        parser.error("--dump-json can only be used alone.")
458
 
    if options.all and not has_commands(options):
 
694
    if options.all and not has_actions(options):
459
695
        parser.error("--all requires an action.")
460
 
    if (has_commands(options, (command.IsEnabled,))
461
 
        and len(options.client) > 1):
 
696
    if options.is_enabled and len(options.client) > 1:
462
697
        parser.error("--is-enabled requires exactly one client")
463
 
    if (len(options.commands) > 1
464
 
        and has_commands(options, (command.Remove,))
465
 
        and not has_commands(options, (command.Deny,))):
466
 
        parser.error("--remove can only be combined with --deny")
467
 
 
468
 
 
469
 
class dbus(object):
470
 
 
471
 
    class SystemBus(object):
472
 
 
473
 
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
474
 
        def get_managed_objects(self, busname, objectpath):
475
 
            return self.call_method("GetManagedObjects", busname,
476
 
                                    objectpath,
477
 
                                    self.object_manager_iface)
478
 
 
479
 
        properties_iface = "org.freedesktop.DBus.Properties"
480
 
        def set_property(self, busname, objectpath, interface, key,
481
 
                         value):
482
 
            self.call_method("Set", busname, objectpath,
483
 
                             self.properties_iface, interface, key,
484
 
                             value)
485
 
 
486
 
 
487
 
    class MandosBus(SystemBus):
488
 
        busname_domain = "se.recompile"
489
 
        busname = busname_domain + ".Mandos"
490
 
        server_path = "/"
491
 
        server_interface = busname_domain + ".Mandos"
492
 
        client_interface = busname_domain + ".Mandos.Client"
493
 
        del busname_domain
494
 
 
495
 
        def get_clients_and_properties(self):
496
 
            managed_objects = self.get_managed_objects(
497
 
                self.busname, self.server_path)
498
 
            return {objpath: properties[self.client_interface]
499
 
                    for objpath, properties in managed_objects.items()
500
 
                    if self.client_interface in properties}
501
 
 
502
 
        def set_client_property(self, objectpath, key, value):
503
 
            return self.set_property(self.busname, objectpath,
504
 
                                     self.client_interface, key,
505
 
                                     value)
506
 
 
507
 
        def call_client_method(self, objectpath, method, *args):
508
 
            return self.call_method(method, self.busname, objectpath,
509
 
                                    self.client_interface, *args)
510
 
 
511
 
        def call_server_method(self, method, *args):
512
 
            return self.call_method(method, self.busname,
513
 
                                    self.server_path,
514
 
                                    self.server_interface, *args)
515
 
 
516
 
    class Error(Exception):
517
 
        pass
518
 
 
519
 
    class ConnectFailed(Error):
520
 
        pass
521
 
 
522
 
 
523
 
class dbus_python_adapter(object):
524
 
 
525
 
    class SystemBus(dbus.MandosBus):
526
 
        """Use dbus-python"""
527
 
 
528
 
        def __init__(self, module=dbus_python):
529
 
            self.dbus_python = module
530
 
            self.bus = self.dbus_python.SystemBus()
531
 
 
532
 
        @contextlib.contextmanager
533
 
        def convert_exception(self, exception_class=dbus.Error):
534
 
            try:
535
 
                yield
536
 
            except self.dbus_python.exceptions.DBusException as e:
537
 
                # This does what "raise from" would do
538
 
                exc = exception_class(*e.args)
539
 
                exc.__cause__ = e
540
 
                raise exc
541
 
 
542
 
        def call_method(self, methodname, busname, objectpath,
543
 
                        interface, *args):
544
 
            proxy_object = self.get_object(busname, objectpath)
545
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
546
 
                      interface, methodname,
547
 
                      ", ".join(repr(a) for a in args))
548
 
            method = getattr(proxy_object, methodname)
549
 
            with self.convert_exception():
550
 
                with dbus_python_adapter.SilenceLogger(
551
 
                        "dbus.proxies"):
552
 
                    value = method(*args, dbus_interface=interface)
553
 
            return self.type_filter(value)
554
 
 
555
 
        def get_object(self, busname, objectpath):
556
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
557
 
                      busname, objectpath)
558
 
            with self.convert_exception(dbus.ConnectFailed):
559
 
                return self.bus.get_object(busname, objectpath)
560
 
 
561
 
        def type_filter(self, value):
562
 
            """Convert the most bothersome types to Python types"""
563
 
            if isinstance(value, self.dbus_python.Boolean):
564
 
                return bool(value)
565
 
            if isinstance(value, self.dbus_python.ObjectPath):
566
 
                return str(value)
567
 
            # Also recurse into dictionaries
568
 
            if isinstance(value, self.dbus_python.Dictionary):
569
 
                return {self.type_filter(key):
570
 
                        self.type_filter(subval)
571
 
                        for key, subval in value.items()}
572
 
            return value
573
 
 
574
 
        def set_client_property(self, objectpath, key, value):
575
 
            if key == "Secret":
576
 
                if not isinstance(value, bytes):
577
 
                    value = value.encode("utf-8")
578
 
                value = self.dbus_python.ByteArray(value)
579
 
            return self.set_property(self.busname, objectpath,
580
 
                                     self.client_interface, key,
581
 
                                     value)
582
 
 
583
 
    class SilenceLogger(object):
584
 
        "Simple context manager to silence a particular logger"
585
 
        def __init__(self, loggername):
586
 
            self.logger = logging.getLogger(loggername)
587
 
 
588
 
        def __enter__(self):
589
 
            self.logger.addFilter(self.nullfilter)
590
 
 
591
 
        class NullFilter(logging.Filter):
592
 
            def filter(self, record):
593
 
                return False
594
 
 
595
 
        nullfilter = NullFilter()
596
 
 
597
 
        def __exit__(self, exc_type, exc_val, exc_tb):
598
 
            self.logger.removeFilter(self.nullfilter)
599
 
 
600
 
 
601
 
    class CachingBus(SystemBus):
602
 
        """A caching layer for dbus_python_adapter.SystemBus"""
603
 
        def __init__(self, *args, **kwargs):
604
 
            self.object_cache = {}
605
 
            super(dbus_python_adapter.CachingBus,
606
 
                  self).__init__(*args, **kwargs)
607
 
        def get_object(self, busname, objectpath):
608
 
            try:
609
 
                return self.object_cache[(busname, objectpath)]
610
 
            except KeyError:
611
 
                new_object = super(
612
 
                    dbus_python_adapter.CachingBus,
613
 
                    self).get_object(busname, objectpath)
614
 
                self.object_cache[(busname, objectpath)]  = new_object
615
 
                return new_object
616
 
 
617
 
 
618
 
class pydbus_adapter(object):
619
 
    class SystemBus(dbus.MandosBus):
620
 
        def __init__(self, module=pydbus):
621
 
            self.pydbus = module
622
 
            self.bus = self.pydbus.SystemBus()
623
 
 
624
 
        @contextlib.contextmanager
625
 
        def convert_exception(self, exception_class=dbus.Error):
626
 
            try:
627
 
                yield
628
 
            except gi.repository.GLib.Error as e:
629
 
                # This does what "raise from" would do
630
 
                exc = exception_class(*e.args)
631
 
                exc.__cause__ = e
632
 
                raise exc
633
 
 
634
 
        def call_method(self, methodname, busname, objectpath,
635
 
                        interface, *args):
636
 
            proxy_object = self.get(busname, objectpath)
637
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
638
 
                      interface, methodname,
639
 
                      ", ".join(repr(a) for a in args))
640
 
            method = getattr(proxy_object[interface], methodname)
641
 
            with self.convert_exception():
642
 
                return method(*args)
643
 
 
644
 
        def get(self, busname, objectpath):
645
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
646
 
                      busname, objectpath)
647
 
            with self.convert_exception(dbus.ConnectFailed):
648
 
                if sys.version_info.major <= 2:
649
 
                    with warnings.catch_warnings():
650
 
                        warnings.filterwarnings(
651
 
                            "ignore", "", DeprecationWarning,
652
 
                            r"^xml\.etree\.ElementTree$")
653
 
                        return self.bus.get(busname, objectpath)
654
 
                else:
655
 
                    return self.bus.get(busname, objectpath)
656
 
 
657
 
        def set_property(self, busname, objectpath, interface, key,
658
 
                         value):
659
 
            proxy_object = self.get(busname, objectpath)
660
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
661
 
                      objectpath, self.properties_iface, interface,
662
 
                      key, value)
663
 
            setattr(proxy_object[interface], key, value)
664
 
 
665
 
    class CachingBus(SystemBus):
666
 
        """A caching layer for pydbus_adapter.SystemBus"""
667
 
        def __init__(self, *args, **kwargs):
668
 
            self.object_cache = {}
669
 
            super(pydbus_adapter.CachingBus,
670
 
                  self).__init__(*args, **kwargs)
671
 
        def get(self, busname, objectpath):
672
 
            try:
673
 
                return self.object_cache[(busname, objectpath)]
674
 
            except KeyError:
675
 
                new_object = (super(pydbus_adapter.CachingBus, self)
676
 
                              .get(busname, objectpath))
677
 
                self.object_cache[(busname, objectpath)]  = new_object
678
 
                return new_object
679
 
 
680
 
 
681
 
def commands_from_options(options):
682
 
 
683
 
    commands = list(options.commands)
684
 
 
685
 
    def find_cmd(cmd, commands):
686
 
        i = 0
687
 
        for i, c in enumerate(commands):
688
 
            if isinstance(c, cmd):
689
 
                return i
690
 
        return i+1
691
 
 
692
 
    # If command.Remove is present, move any instances of command.Deny
693
 
    # to occur ahead of command.Remove.
694
 
    index_of_remove = find_cmd(command.Remove, commands)
695
 
    before_remove = commands[:index_of_remove]
696
 
    after_remove = commands[index_of_remove:]
697
 
    cleaned_after = []
698
 
    for cmd in after_remove:
699
 
        if isinstance(cmd, command.Deny):
700
 
            before_remove.append(cmd)
701
 
        else:
702
 
            cleaned_after.append(cmd)
703
 
    if cleaned_after != after_remove:
704
 
        commands = before_remove + cleaned_after
705
 
 
706
 
    # If no command option has been given, show table of clients,
707
 
    # optionally verbosely
708
 
    if not commands:
709
 
        commands.append(command.PrintTable(verbose=options.verbose))
710
 
 
711
 
    return commands
712
 
 
713
 
 
714
 
class command(object):
715
 
    """A namespace for command classes"""
716
 
 
717
 
    class Base(object):
718
 
        """Abstract base class for commands"""
719
 
        def run(self, clients, bus=None):
720
 
            """Normal commands should implement run_on_one_client(),
721
 
but commands which want to operate on all clients at the same time can
722
 
override this run() method instead.
723
 
"""
724
 
            self.bus = bus
725
 
            for client, properties in clients.items():
726
 
                self.run_on_one_client(client, properties)
727
 
 
728
 
 
729
 
    class IsEnabled(Base):
730
 
        def run(self, clients, bus=None):
731
 
            properties = next(iter(clients.values()))
732
 
            if properties["Enabled"]:
733
 
                sys.exit(0)
734
 
            sys.exit(1)
735
 
 
736
 
 
737
 
    class Approve(Base):
738
 
        def run_on_one_client(self, client, properties):
739
 
            self.bus.call_client_method(client, "Approve", True)
740
 
 
741
 
 
742
 
    class Deny(Base):
743
 
        def run_on_one_client(self, client, properties):
744
 
            self.bus.call_client_method(client, "Approve", False)
745
 
 
746
 
 
747
 
    class Remove(Base):
748
 
        def run(self, clients, bus):
749
 
            for clientpath in frozenset(clients.keys()):
750
 
                bus.call_server_method("RemoveClient", clientpath)
751
 
 
752
 
 
753
 
    class Output(Base):
754
 
        """Abstract class for commands outputting client details"""
755
 
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
756
 
                        "Created", "Interval", "Host", "KeyID",
757
 
                        "Fingerprint", "CheckerRunning",
758
 
                        "LastEnabled", "ApprovalPending",
759
 
                        "ApprovedByDefault", "LastApprovalRequest",
760
 
                        "ApprovalDelay", "ApprovalDuration",
761
 
                        "Checker", "ExtendedTimeout", "Expires",
762
 
                        "LastCheckerStatus")
763
 
 
764
 
 
765
 
    class DumpJSON(Output):
766
 
        def run(self, clients, bus=None):
767
 
            data = {properties["Name"]:
768
 
                    {key: properties[key]
769
 
                     for key in self.all_keywords}
770
 
                    for properties in clients.values()}
771
 
            print(json.dumps(data, indent=4, separators=(',', ': ')))
772
 
 
773
 
 
774
 
    class PrintTable(Output):
775
 
        def __init__(self, verbose=False):
776
 
            self.verbose = verbose
777
 
 
778
 
        def run(self, clients, bus=None):
779
 
            default_keywords = ("Name", "Enabled", "Timeout",
780
 
                                "LastCheckedOK")
781
 
            keywords = default_keywords
782
 
            if self.verbose:
783
 
                keywords = self.all_keywords
784
 
            print(self.TableOfClients(clients.values(), keywords))
785
 
 
786
 
        class TableOfClients(object):
787
 
            tableheaders = {
788
 
                "Name": "Name",
789
 
                "Enabled": "Enabled",
790
 
                "Timeout": "Timeout",
791
 
                "LastCheckedOK": "Last Successful Check",
792
 
                "LastApprovalRequest": "Last Approval Request",
793
 
                "Created": "Created",
794
 
                "Interval": "Interval",
795
 
                "Host": "Host",
796
 
                "Fingerprint": "Fingerprint",
797
 
                "KeyID": "Key ID",
798
 
                "CheckerRunning": "Check Is Running",
799
 
                "LastEnabled": "Last Enabled",
800
 
                "ApprovalPending": "Approval Is Pending",
801
 
                "ApprovedByDefault": "Approved By Default",
802
 
                "ApprovalDelay": "Approval Delay",
803
 
                "ApprovalDuration": "Approval Duration",
804
 
                "Checker": "Checker",
805
 
                "ExtendedTimeout": "Extended Timeout",
806
 
                "Expires": "Expires",
807
 
                "LastCheckerStatus": "Last Checker Status",
808
 
            }
809
 
 
810
 
            def __init__(self, clients, keywords):
811
 
                self.clients = clients
812
 
                self.keywords = keywords
813
 
 
814
 
            def __str__(self):
815
 
                return "\n".join(self.rows())
816
 
 
817
 
            if sys.version_info.major == 2:
818
 
                __unicode__ = __str__
819
 
                def __str__(self):
820
 
                    return str(self).encode(
821
 
                        locale.getpreferredencoding())
822
 
 
823
 
            def rows(self):
824
 
                format_string = self.row_formatting_string()
825
 
                rows = [self.header_line(format_string)]
826
 
                rows.extend(self.client_line(client, format_string)
827
 
                            for client in self.clients)
828
 
                return rows
829
 
 
830
 
            def row_formatting_string(self):
831
 
                "Format string used to format table rows"
832
 
                return " ".join("{{{key}:{width}}}".format(
833
 
                    width=max(len(self.tableheaders[key]),
834
 
                              *(len(self.string_from_client(client,
835
 
                                                            key))
836
 
                                for client in self.clients)),
837
 
                    key=key)
838
 
                                for key in self.keywords)
839
 
 
840
 
            def string_from_client(self, client, key):
841
 
                return self.valuetostring(client[key], key)
842
 
 
843
 
            @classmethod
844
 
            def valuetostring(cls, value, keyword):
845
 
                if isinstance(value, bool):
846
 
                    return "Yes" if value else "No"
847
 
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
848
 
                               "ApprovalDuration", "ExtendedTimeout"):
849
 
                    return cls.milliseconds_to_string(value)
850
 
                return str(value)
851
 
 
852
 
            def header_line(self, format_string):
853
 
                return format_string.format(**self.tableheaders)
854
 
 
855
 
            def client_line(self, client, format_string):
856
 
                return format_string.format(
857
 
                    **{key: self.string_from_client(client, key)
858
 
                       for key in self.keywords})
859
 
 
860
 
            @staticmethod
861
 
            def milliseconds_to_string(ms):
862
 
                td = datetime.timedelta(0, 0, 0, ms)
863
 
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
864
 
                        .format(days="{}T".format(td.days)
865
 
                                if td.days else "",
866
 
                                hours=td.seconds // 3600,
867
 
                                minutes=(td.seconds % 3600) // 60,
868
 
                                seconds=td.seconds % 60))
869
 
 
870
 
 
871
 
    class PropertySetter(Base):
872
 
        "Abstract class for Actions for setting one client property"
873
 
 
874
 
        def run_on_one_client(self, client, properties=None):
875
 
            """Set the Client's D-Bus property"""
876
 
            self.bus.set_client_property(client, self.propname,
877
 
                                         self.value_to_set)
878
 
 
879
 
        @property
880
 
        def propname(self):
881
 
            raise NotImplementedError()
882
 
 
883
 
 
884
 
    class Enable(PropertySetter):
885
 
        propname = "Enabled"
886
 
        value_to_set = True
887
 
 
888
 
 
889
 
    class Disable(PropertySetter):
890
 
        propname = "Enabled"
891
 
        value_to_set = False
892
 
 
893
 
 
894
 
    class BumpTimeout(PropertySetter):
895
 
        propname = "LastCheckedOK"
896
 
        value_to_set = ""
897
 
 
898
 
 
899
 
    class StartChecker(PropertySetter):
900
 
        propname = "CheckerRunning"
901
 
        value_to_set = True
902
 
 
903
 
 
904
 
    class StopChecker(PropertySetter):
905
 
        propname = "CheckerRunning"
906
 
        value_to_set = False
907
 
 
908
 
 
909
 
    class ApproveByDefault(PropertySetter):
910
 
        propname = "ApprovedByDefault"
911
 
        value_to_set = True
912
 
 
913
 
 
914
 
    class DenyByDefault(PropertySetter):
915
 
        propname = "ApprovedByDefault"
916
 
        value_to_set = False
917
 
 
918
 
 
919
 
    class PropertySetterValue(PropertySetter):
920
 
        """Abstract class for PropertySetter recieving a value as
921
 
constructor argument instead of a class attribute."""
922
 
        def __init__(self, value):
923
 
            self.value_to_set = value
924
 
 
925
 
        @classmethod
926
 
        def argparse(cls, argtype):
927
 
            def cmdtype(arg):
928
 
                return cls(argtype(arg))
929
 
            return cmdtype
930
 
 
931
 
    class SetChecker(PropertySetterValue):
932
 
        propname = "Checker"
933
 
 
934
 
 
935
 
    class SetHost(PropertySetterValue):
936
 
        propname = "Host"
937
 
 
938
 
 
939
 
    class SetSecret(PropertySetterValue):
940
 
        propname = "Secret"
941
 
 
942
 
        @property
943
 
        def value_to_set(self):
944
 
            return self._vts
945
 
 
946
 
        @value_to_set.setter
947
 
        def value_to_set(self, value):
948
 
            """When setting, read data from supplied file object"""
949
 
            self._vts = value.read()
950
 
            value.close()
951
 
 
952
 
 
953
 
    class PropertySetterValueMilliseconds(PropertySetterValue):
954
 
        """Abstract class for PropertySetterValue taking a value
955
 
argument as a datetime.timedelta() but should store it as
956
 
milliseconds."""
957
 
 
958
 
        @property
959
 
        def value_to_set(self):
960
 
            return self._vts
961
 
 
962
 
        @value_to_set.setter
963
 
        def value_to_set(self, value):
964
 
            "When setting, convert value from a datetime.timedelta"
965
 
            self._vts = int(round(value.total_seconds() * 1000))
966
 
 
967
 
 
968
 
    class SetTimeout(PropertySetterValueMilliseconds):
969
 
        propname = "Timeout"
970
 
 
971
 
 
972
 
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
973
 
        propname = "ExtendedTimeout"
974
 
 
975
 
 
976
 
    class SetInterval(PropertySetterValueMilliseconds):
977
 
        propname = "Interval"
978
 
 
979
 
 
980
 
    class SetApprovalDelay(PropertySetterValueMilliseconds):
981
 
        propname = "ApprovalDelay"
982
 
 
983
 
 
984
 
    class SetApprovalDuration(PropertySetterValueMilliseconds):
985
 
        propname = "ApprovalDuration"
986
 
 
 
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
 
 
714
    try:
 
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")
 
721
        sys.exit(1)
 
722
 
 
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")
 
730
    class NullFilter(logging.Filter):
 
731
        def filter(self, record):
 
732
            return False
 
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)
987
772
 
988
773
 
989
 
class TestCaseWithAssertLogs(unittest.TestCase):
990
 
    """unittest.TestCase.assertLogs only exists in Python 3.4"""
991
 
 
992
 
    if not hasattr(unittest.TestCase, "assertLogs"):
993
 
        @contextlib.contextmanager
994
 
        def assertLogs(self, logger, level=logging.INFO):
995
 
            capturing_handler = self.CapturingLevelHandler(level)
996
 
            old_level = logger.level
997
 
            old_propagate = logger.propagate
998
 
            logger.addHandler(capturing_handler)
999
 
            logger.setLevel(level)
1000
 
            logger.propagate = False
1001
 
            try:
1002
 
                yield capturing_handler.watcher
1003
 
            finally:
1004
 
                logger.propagate = old_propagate
1005
 
                logger.removeHandler(capturing_handler)
1006
 
                logger.setLevel(old_level)
1007
 
            self.assertGreater(len(capturing_handler.watcher.records),
1008
 
                               0)
1009
 
 
1010
 
        class CapturingLevelHandler(logging.Handler):
1011
 
            def __init__(self, level, *args, **kwargs):
1012
 
                logging.Handler.__init__(self, *args, **kwargs)
1013
 
                self.watcher = self.LoggingWatcher([], [])
1014
 
            def emit(self, record):
1015
 
                self.watcher.records.append(record)
1016
 
                self.watcher.output.append(self.format(record))
1017
 
 
1018
 
            LoggingWatcher = collections.namedtuple("LoggingWatcher",
1019
 
                                                    ("records",
1020
 
                                                     "output"))
1021
 
 
1022
 
 
1023
 
class Unique(object):
1024
 
    """Class for objects which exist only to be unique objects, since
1025
 
unittest.mock.sentinel only exists in Python 3.3"""
1026
 
 
1027
 
 
1028
 
class Test_string_to_delta(TestCaseWithAssertLogs):
1029
 
    # Just test basic RFC 3339 functionality here, the doc string for
1030
 
    # rfc3339_duration_to_delta() already has more comprehensive
1031
 
    # tests, which are run by doctest.
1032
 
 
1033
 
    def test_rfc3339_zero_seconds(self):
1034
 
        self.assertEqual(datetime.timedelta(),
1035
 
                         string_to_delta("PT0S"))
1036
 
 
1037
 
    def test_rfc3339_zero_days(self):
1038
 
        self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1039
 
 
1040
 
    def test_rfc3339_one_second(self):
1041
 
        self.assertEqual(datetime.timedelta(0, 1),
1042
 
                         string_to_delta("PT1S"))
1043
 
 
1044
 
    def test_rfc3339_two_hours(self):
1045
 
        self.assertEqual(datetime.timedelta(0, 7200),
1046
 
                         string_to_delta("PT2H"))
1047
 
 
 
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):
 
789
        self.assertEqual(string_to_delta("PT0S"),
 
790
                         datetime.timedelta())
 
791
        self.assertEqual(string_to_delta("P0D"),
 
792
                         datetime.timedelta())
 
793
        self.assertEqual(string_to_delta("PT1S"),
 
794
                         datetime.timedelta(0, 1))
 
795
        self.assertEqual(string_to_delta("PT2H"),
 
796
                         datetime.timedelta(0, 7200))
1048
797
    def test_falls_back_to_pre_1_6_1_with_warning(self):
1049
 
        with self.assertLogs(log, logging.WARNING):
1050
 
            value = string_to_delta("2h")
1051
 
        self.assertEqual(datetime.timedelta(0, 7200), value)
1052
 
 
1053
 
 
1054
 
class Test_check_option_syntax(unittest.TestCase):
1055
 
    def setUp(self):
1056
 
        self.parser = argparse.ArgumentParser()
1057
 
        add_command_line_options(self.parser)
1058
 
 
1059
 
    def test_actions_requires_client_or_all(self):
1060
 
        for action, value in self.actions.items():
1061
 
            args = self.actionargs(action, value)
1062
 
            with self.assertParseError():
1063
 
                self.parse_args(args)
1064
 
 
1065
 
    # This mostly corresponds to the definition from has_commands() in
1066
 
    # check_option_syntax()
1067
 
    actions = {
1068
 
        "--enable": None,
1069
 
        "--disable": None,
1070
 
        "--bump-timeout": None,
1071
 
        "--start-checker": None,
1072
 
        "--stop-checker": None,
1073
 
        "--is-enabled": None,
1074
 
        "--remove": None,
1075
 
        "--checker": "x",
1076
 
        "--timeout": "PT0S",
1077
 
        "--extended-timeout": "PT0S",
1078
 
        "--interval": "PT0S",
1079
 
        "--approve-by-default": None,
1080
 
        "--deny-by-default": None,
1081
 
        "--approval-delay": "PT0S",
1082
 
        "--approval-duration": "PT0S",
1083
 
        "--host": "hostname",
1084
 
        "--secret": "/dev/null",
1085
 
        "--approve": None,
1086
 
        "--deny": None,
1087
 
    }
1088
 
 
1089
 
    @staticmethod
1090
 
    def actionargs(action, value, *args):
1091
 
        if value is not None:
1092
 
            return [action, value] + list(args)
 
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")
1093
802
        else:
1094
 
            return [action] + list(args)
1095
 
 
1096
 
    @contextlib.contextmanager
1097
 
    def assertParseError(self):
1098
 
        with self.assertRaises(SystemExit) as e:
1099
 
            with self.redirect_stderr_to_devnull():
1100
 
                yield
1101
 
        # Exit code from argparse is guaranteed to be "2".  Reference:
1102
 
        # https://docs.python.org/3/library
1103
 
        # /argparse.html#exiting-methods
1104
 
        self.assertEqual(2, e.exception.code)
1105
 
 
1106
 
    def parse_args(self, args):
1107
 
        options = self.parser.parse_args(args)
1108
 
        check_option_syntax(self.parser, options)
1109
 
 
1110
 
    @staticmethod
1111
 
    @contextlib.contextmanager
1112
 
    def redirect_stderr_to_devnull():
1113
 
        old_stderr = sys.stderr
1114
 
        with contextlib.closing(open(os.devnull, "w")) as null:
1115
 
            sys.stderr = null
 
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)
1116
812
            try:
1117
 
                yield
 
813
                value = string_to_delta("2h")
1118
814
            finally:
1119
 
                sys.stderr = old_stderr
1120
 
 
1121
 
    def check_option_syntax(self, options):
1122
 
        check_option_syntax(self.parser, options)
1123
 
 
1124
 
    def test_actions_all_conflicts_with_verbose(self):
1125
 
        for action, value in self.actions.items():
1126
 
            args = self.actionargs(action, value, "--all",
1127
 
                                   "--verbose")
1128
 
            with self.assertParseError():
1129
 
                self.parse_args(args)
1130
 
 
1131
 
    def test_actions_with_client_conflicts_with_verbose(self):
1132
 
        for action, value in self.actions.items():
1133
 
            args = self.actionargs(action, value, "--verbose",
1134
 
                                   "client")
1135
 
            with self.assertParseError():
1136
 
                self.parse_args(args)
1137
 
 
1138
 
    def test_dump_json_conflicts_with_verbose(self):
1139
 
        args = ["--dump-json", "--verbose"]
1140
 
        with self.assertParseError():
1141
 
            self.parse_args(args)
1142
 
 
1143
 
    def test_dump_json_conflicts_with_action(self):
1144
 
        for action, value in self.actions.items():
1145
 
            args = self.actionargs(action, value, "--dump-json")
1146
 
            with self.assertParseError():
1147
 
                self.parse_args(args)
1148
 
 
1149
 
    def test_all_can_not_be_alone(self):
1150
 
        args = ["--all"]
1151
 
        with self.assertParseError():
1152
 
            self.parse_args(args)
1153
 
 
1154
 
    def test_all_is_ok_with_any_action(self):
1155
 
        for action, value in self.actions.items():
1156
 
            args = self.actionargs(action, value, "--all")
1157
 
            self.parse_args(args)
1158
 
 
1159
 
    def test_any_action_is_ok_with_one_client(self):
1160
 
        for action, value in self.actions.items():
1161
 
            args = self.actionargs(action, value, "client")
1162
 
            self.parse_args(args)
1163
 
 
1164
 
    def test_one_client_with_all_actions_except_is_enabled(self):
1165
 
        for action, value in self.actions.items():
1166
 
            if action == "--is-enabled":
1167
 
                continue
1168
 
            args = self.actionargs(action, value, "client")
1169
 
            self.parse_args(args)
1170
 
 
1171
 
    def test_two_clients_with_all_actions_except_is_enabled(self):
1172
 
        for action, value in self.actions.items():
1173
 
            if action == "--is-enabled":
1174
 
                continue
1175
 
            args = self.actionargs(action, value, "client1",
1176
 
                                   "client2")
1177
 
            self.parse_args(args)
1178
 
 
1179
 
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1180
 
        for action, value in self.actions.items():
1181
 
            if action == "--is-enabled":
1182
 
                continue
1183
 
            args = self.actionargs(action, value, "client1",
1184
 
                                   "client2")
1185
 
            self.parse_args(args)
1186
 
 
1187
 
    def test_is_enabled_fails_without_client(self):
1188
 
        args = ["--is-enabled"]
1189
 
        with self.assertParseError():
1190
 
            self.parse_args(args)
1191
 
 
1192
 
    def test_is_enabled_fails_with_two_clients(self):
1193
 
        args = ["--is-enabled", "client1", "client2"]
1194
 
        with self.assertParseError():
1195
 
            self.parse_args(args)
1196
 
 
1197
 
    def test_remove_can_only_be_combined_with_action_deny(self):
1198
 
        for action, value in self.actions.items():
1199
 
            if action in {"--remove", "--deny"}:
1200
 
                continue
1201
 
            args = self.actionargs(action, value, "--all",
1202
 
                                   "--remove")
1203
 
            with self.assertParseError():
1204
 
                self.parse_args(args)
1205
 
 
1206
 
 
1207
 
class Test_dbus_exceptions(unittest.TestCase):
1208
 
 
1209
 
    def test_dbus_ConnectFailed_is_Error(self):
1210
 
        with self.assertRaises(dbus.Error):
1211
 
            raise dbus.ConnectFailed()
1212
 
 
1213
 
 
1214
 
class Test_dbus_MandosBus(unittest.TestCase):
1215
 
 
1216
 
    class MockMandosBus(dbus.MandosBus):
1217
 
        def __init__(self):
1218
 
            self._name = "se.recompile.Mandos"
1219
 
            self._server_path = "/"
1220
 
            self._server_interface = "se.recompile.Mandos"
1221
 
            self._client_interface = "se.recompile.Mandos.Client"
1222
 
            self.calls = []
1223
 
            self.call_method_return = Unique()
1224
 
 
1225
 
        def call_method(self, methodname, busname, objectpath,
1226
 
                        interface, *args):
1227
 
            self.calls.append((methodname, busname, objectpath,
1228
 
                               interface, args))
1229
 
            return self.call_method_return
1230
 
 
1231
 
    def setUp(self):
1232
 
        self.bus = self.MockMandosBus()
1233
 
 
1234
 
    def test_set_client_property(self):
1235
 
        self.bus.set_client_property("objectpath", "key", "value")
1236
 
        expected_call = ("Set", self.bus._name, "objectpath",
1237
 
                         "org.freedesktop.DBus.Properties",
1238
 
                         (self.bus._client_interface, "key", "value"))
1239
 
        self.assertIn(expected_call, self.bus.calls)
1240
 
 
1241
 
    def test_call_client_method(self):
1242
 
        ret = self.bus.call_client_method("objectpath", "methodname")
1243
 
        self.assertIs(self.bus.call_method_return, ret)
1244
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1245
 
                         self.bus._client_interface, ())
1246
 
        self.assertIn(expected_call, self.bus.calls)
1247
 
 
1248
 
    def test_call_client_method_with_args(self):
1249
 
        args = (Unique(), Unique())
1250
 
        ret = self.bus.call_client_method("objectpath", "methodname",
1251
 
                                          *args)
1252
 
        self.assertIs(self.bus.call_method_return, ret)
1253
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1254
 
                         self.bus._client_interface,
1255
 
                         (args[0], args[1]))
1256
 
        self.assertIn(expected_call, self.bus.calls)
1257
 
 
1258
 
    def test_get_clients_and_properties(self):
1259
 
        managed_objects = {
1260
 
            "objectpath": {
1261
 
                self.bus._client_interface: {
1262
 
                    "key": "value",
1263
 
                    "bool": True,
1264
 
                },
1265
 
                "irrelevant_interface": {
1266
 
                    "key": "othervalue",
1267
 
                    "bool": False,
1268
 
                },
1269
 
            },
1270
 
            "other_objectpath": {
1271
 
                "other_irrelevant_interface": {
1272
 
                    "key": "value 3",
1273
 
                    "bool": None,
1274
 
                },
1275
 
            },
1276
 
        }
1277
 
        expected_clients_and_properties = {
1278
 
            "objectpath": {
1279
 
                "key": "value",
1280
 
                "bool": True,
1281
 
            }
1282
 
        }
1283
 
        self.bus.call_method_return = managed_objects
1284
 
        ret = self.bus.get_clients_and_properties()
1285
 
        self.assertDictEqual(expected_clients_and_properties, ret)
1286
 
        expected_call = ("GetManagedObjects", self.bus._name,
1287
 
                         self.bus._server_path,
1288
 
                         "org.freedesktop.DBus.ObjectManager", ())
1289
 
        self.assertIn(expected_call, self.bus.calls)
1290
 
 
1291
 
    def test_call_server_method(self):
1292
 
        ret = self.bus.call_server_method("methodname")
1293
 
        self.assertIs(self.bus.call_method_return, ret)
1294
 
        expected_call = ("methodname", self.bus._name,
1295
 
                         self.bus._server_path,
1296
 
                         self.bus._server_interface, ())
1297
 
        self.assertIn(expected_call, self.bus.calls)
1298
 
 
1299
 
    def test_call_server_method_with_args(self):
1300
 
        args = (Unique(), Unique())
1301
 
        ret = self.bus.call_server_method("methodname", *args)
1302
 
        self.assertIs(self.bus.call_method_return, ret)
1303
 
        expected_call = ("methodname", self.bus._name,
1304
 
                         self.bus._server_path,
1305
 
                         self.bus._server_interface,
1306
 
                         (args[0], args[1]))
1307
 
        self.assertIn(expected_call, self.bus.calls)
1308
 
 
1309
 
 
1310
 
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1311
 
 
1312
 
    def MockDBusPython_func(self, func):
1313
 
        class mock_dbus_python(object):
1314
 
            """mock dbus-python module"""
1315
 
            class exceptions(object):
1316
 
                """Pseudo-namespace"""
1317
 
                class DBusException(Exception):
1318
 
                    pass
1319
 
            class SystemBus(object):
1320
 
                @staticmethod
1321
 
                def get_object(busname, objectpath):
1322
 
                    DBusObject = collections.namedtuple(
1323
 
                        "DBusObject", ("methodname", "Set"))
1324
 
                    def method(*args, **kwargs):
1325
 
                        self.assertEqual({"dbus_interface":
1326
 
                                          "interface"},
1327
 
                                         kwargs)
1328
 
                        return func(*args)
1329
 
                    def set_property(interface, key, value,
1330
 
                                     dbus_interface=None):
1331
 
                        self.assertEqual(
1332
 
                            "org.freedesktop.DBus.Properties",
1333
 
                            dbus_interface)
1334
 
                        self.assertEqual("Secret", key)
1335
 
                        return func(interface, key, value,
1336
 
                                    dbus_interface=dbus_interface)
1337
 
                    return DBusObject(methodname=method,
1338
 
                                      Set=set_property)
1339
 
            class Boolean(object):
1340
 
                def __init__(self, value):
1341
 
                    self.value = bool(value)
1342
 
                def __bool__(self):
1343
 
                    return self.value
1344
 
                if sys.version_info.major == 2:
1345
 
                    __nonzero__ = __bool__
1346
 
            class ObjectPath(str):
1347
 
                pass
1348
 
            class Dictionary(dict):
1349
 
                pass
1350
 
            class ByteArray(bytes):
1351
 
                pass
1352
 
        return mock_dbus_python
1353
 
 
1354
 
    def call_method(self, bus, methodname, busname, objectpath,
1355
 
                    interface, *args):
1356
 
        with self.assertLogs(log, logging.DEBUG):
1357
 
            return bus.call_method(methodname, busname, objectpath,
1358
 
                                   interface, *args)
1359
 
 
1360
 
    def test_call_method_returns(self):
1361
 
        expected_method_return = Unique()
1362
 
        method_args = (Unique(), Unique())
1363
 
        def func(*args):
1364
 
            self.assertEqual(len(method_args), len(args))
1365
 
            for marg, arg in zip(method_args, args):
1366
 
                self.assertIs(marg, arg)
1367
 
            return expected_method_return
1368
 
        mock_dbus_python = self.MockDBusPython_func(func)
1369
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1370
 
        ret = self.call_method(bus, "methodname", "busname",
1371
 
                               "objectpath", "interface",
1372
 
                               *method_args)
1373
 
        self.assertIs(ret, expected_method_return)
1374
 
 
1375
 
    def test_call_method_filters_bool_true(self):
1376
 
        def func():
1377
 
            return method_return
1378
 
        mock_dbus_python = self.MockDBusPython_func(func)
1379
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1380
 
        method_return = mock_dbus_python.Boolean(True)
1381
 
        ret = self.call_method(bus, "methodname", "busname",
1382
 
                               "objectpath", "interface")
1383
 
        self.assertTrue(ret)
1384
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1385
 
 
1386
 
    def test_call_method_filters_bool_false(self):
1387
 
        def func():
1388
 
            return method_return
1389
 
        mock_dbus_python = self.MockDBusPython_func(func)
1390
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1391
 
        method_return = mock_dbus_python.Boolean(False)
1392
 
        ret = self.call_method(bus, "methodname", "busname",
1393
 
                               "objectpath", "interface")
1394
 
        self.assertFalse(ret)
1395
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1396
 
 
1397
 
    def test_call_method_filters_objectpath(self):
1398
 
        def func():
1399
 
            return method_return
1400
 
        mock_dbus_python = self.MockDBusPython_func(func)
1401
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1402
 
        method_return = mock_dbus_python.ObjectPath("objectpath")
1403
 
        ret = self.call_method(bus, "methodname", "busname",
1404
 
                               "objectpath", "interface")
1405
 
        self.assertEqual("objectpath", ret)
1406
 
        self.assertIsNot("objectpath", ret)
1407
 
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1408
 
 
1409
 
    def test_call_method_filters_booleans_in_dict(self):
1410
 
        def func():
1411
 
            return method_return
1412
 
        mock_dbus_python = self.MockDBusPython_func(func)
1413
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1414
 
        method_return = mock_dbus_python.Dictionary(
1415
 
        {mock_dbus_python.Boolean(True):
1416
 
         mock_dbus_python.Boolean(False),
1417
 
         mock_dbus_python.Boolean(False):
1418
 
         mock_dbus_python.Boolean(True)})
1419
 
        ret = self.call_method(bus, "methodname", "busname",
1420
 
                               "objectpath", "interface")
1421
 
        expected_method_return = {True: False,
1422
 
                                  False: True}
1423
 
        self.assertEqual(expected_method_return, ret)
1424
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1425
 
 
1426
 
    def test_call_method_filters_objectpaths_in_dict(self):
1427
 
        def func():
1428
 
            return method_return
1429
 
        mock_dbus_python = self.MockDBusPython_func(func)
1430
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1431
 
        method_return = mock_dbus_python.Dictionary(
1432
 
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
1433
 
         mock_dbus_python.ObjectPath("objectpath_value_1"),
1434
 
         mock_dbus_python.ObjectPath("objectpath_key_2"):
1435
 
         mock_dbus_python.ObjectPath("objectpath_value_2")})
1436
 
        ret = self.call_method(bus, "methodname", "busname",
1437
 
                               "objectpath", "interface")
1438
 
        expected_method_return = {str(key): str(value)
1439
 
                                  for key, value in
1440
 
                                  method_return.items()}
1441
 
        self.assertEqual(expected_method_return, ret)
1442
 
        self.assertIsInstance(ret, dict)
1443
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1444
 
 
1445
 
    def test_call_method_filters_dict_in_dict(self):
1446
 
        def func():
1447
 
            return method_return
1448
 
        mock_dbus_python = self.MockDBusPython_func(func)
1449
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1450
 
        method_return = mock_dbus_python.Dictionary(
1451
 
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
1452
 
                                              "key12": "value12"}),
1453
 
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
1454
 
                                              "key22": "value22"})})
1455
 
        ret = self.call_method(bus, "methodname", "busname",
1456
 
                               "objectpath", "interface")
1457
 
        expected_method_return = {
1458
 
            "key1": {"key11": "value11",
1459
 
                     "key12": "value12"},
1460
 
            "key2": {"key21": "value21",
1461
 
                     "key22": "value22"},
1462
 
        }
1463
 
        self.assertEqual(expected_method_return, ret)
1464
 
        self.assertIsInstance(ret, dict)
1465
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1466
 
        for key, value in ret.items():
1467
 
            self.assertIsInstance(value, dict)
1468
 
            self.assertEqual(expected_method_return[key], value)
1469
 
            self.assertNotIsInstance(value,
1470
 
                                     mock_dbus_python.Dictionary)
1471
 
 
1472
 
    def test_call_method_filters_dict_three_deep(self):
1473
 
        def func():
1474
 
            return method_return
1475
 
        mock_dbus_python = self.MockDBusPython_func(func)
1476
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1477
 
        method_return = mock_dbus_python.Dictionary(
1478
 
            {"key1":
1479
 
             mock_dbus_python.Dictionary(
1480
 
                 {"key2":
1481
 
                  mock_dbus_python.Dictionary(
1482
 
                      {"key3":
1483
 
                       mock_dbus_python.Boolean(True),
1484
 
                       }),
1485
 
                  }),
1486
 
             })
1487
 
        ret = self.call_method(bus, "methodname", "busname",
1488
 
                               "objectpath", "interface")
1489
 
        expected_method_return = {"key1": {"key2": {"key3": True}}}
1490
 
        self.assertEqual(expected_method_return, ret)
1491
 
        self.assertIsInstance(ret, dict)
1492
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1493
 
        self.assertIsInstance(ret["key1"], dict)
1494
 
        self.assertNotIsInstance(ret["key1"],
1495
 
                                 mock_dbus_python.Dictionary)
1496
 
        self.assertIsInstance(ret["key1"]["key2"], dict)
1497
 
        self.assertNotIsInstance(ret["key1"]["key2"],
1498
 
                                 mock_dbus_python.Dictionary)
1499
 
        self.assertTrue(ret["key1"]["key2"]["key3"])
1500
 
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1501
 
                                 mock_dbus_python.Boolean)
1502
 
 
1503
 
    def test_call_method_handles_exception(self):
1504
 
        dbus_logger = logging.getLogger("dbus.proxies")
1505
 
 
1506
 
        def func():
1507
 
            dbus_logger.error("Test")
1508
 
            raise mock_dbus_python.exceptions.DBusException()
1509
 
 
1510
 
        mock_dbus_python = self.MockDBusPython_func(func)
1511
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1512
 
 
1513
 
        class CountingHandler(logging.Handler):
1514
 
            count = 0
1515
 
            def emit(self, record):
1516
 
                self.count += 1
1517
 
 
1518
 
        counting_handler = CountingHandler()
1519
 
 
1520
 
        dbus_logger.addHandler(counting_handler)
1521
 
 
1522
 
        try:
1523
 
            with self.assertRaises(dbus.Error) as e:
1524
 
                self.call_method(bus, "methodname", "busname",
1525
 
                                 "objectpath", "interface")
1526
 
        finally:
1527
 
            dbus_logger.removeFilter(counting_handler)
1528
 
 
1529
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1530
 
 
1531
 
        # Make sure the dbus logger was suppressed
1532
 
        self.assertEqual(0, counting_handler.count)
1533
 
 
1534
 
    def test_Set_Secret_sends_bytearray(self):
1535
 
        ret = [None]
1536
 
        def func(*args, **kwargs):
1537
 
            ret[0] = (args, kwargs)
1538
 
        mock_dbus_python = self.MockDBusPython_func(func)
1539
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1540
 
        bus.set_client_property("objectpath", "Secret", "value")
1541
 
        expected_call = (("se.recompile.Mandos.Client", "Secret",
1542
 
                          mock_dbus_python.ByteArray(b"value")),
1543
 
                         {"dbus_interface":
1544
 
                          "org.freedesktop.DBus.Properties"})
1545
 
        self.assertEqual(expected_call, ret[0])
1546
 
        if sys.version_info.major == 2:
1547
 
            self.assertIsInstance(ret[0][0][-1],
1548
 
                                  mock_dbus_python.ByteArray)
1549
 
 
1550
 
    def test_get_object_converts_to_correct_exception(self):
1551
 
        bus = dbus_python_adapter.SystemBus(
1552
 
            self.fake_dbus_python_raises_exception_on_connect)
1553
 
        with self.assertRaises(dbus.ConnectFailed):
1554
 
            self.call_method(bus, "methodname", "busname",
1555
 
                             "objectpath", "interface")
1556
 
 
1557
 
    class fake_dbus_python_raises_exception_on_connect(object):
1558
 
        """fake dbus-python module"""
1559
 
        class exceptions(object):
1560
 
            """Pseudo-namespace"""
1561
 
            class DBusException(Exception):
1562
 
                pass
1563
 
 
1564
 
        @classmethod
1565
 
        def SystemBus(cls):
1566
 
            def get_object(busname, objectpath):
1567
 
                raise cls.exceptions.DBusException()
1568
 
            Bus = collections.namedtuple("Bus", ["get_object"])
1569
 
            return Bus(get_object=get_object)
1570
 
 
1571
 
 
1572
 
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1573
 
    class mock_dbus_python(object):
1574
 
        """mock dbus-python modules"""
1575
 
        class SystemBus(object):
1576
 
            @staticmethod
1577
 
            def get_object(busname, objectpath):
1578
 
                return Unique()
1579
 
 
1580
 
    def setUp(self):
1581
 
        self.bus = dbus_python_adapter.CachingBus(
1582
 
            self.mock_dbus_python)
1583
 
 
1584
 
    def test_returns_distinct_objectpaths(self):
1585
 
        obj1 = self.bus.get_object("busname", "objectpath1")
1586
 
        self.assertIsInstance(obj1, Unique)
1587
 
        obj2 = self.bus.get_object("busname", "objectpath2")
1588
 
        self.assertIsInstance(obj2, Unique)
1589
 
        self.assertIsNot(obj1, obj2)
1590
 
 
1591
 
    def test_returns_distinct_busnames(self):
1592
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1593
 
        self.assertIsInstance(obj1, Unique)
1594
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1595
 
        self.assertIsInstance(obj2, Unique)
1596
 
        self.assertIsNot(obj1, obj2)
1597
 
 
1598
 
    def test_returns_distinct_both(self):
1599
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1600
 
        self.assertIsInstance(obj1, Unique)
1601
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1602
 
        self.assertIsInstance(obj2, Unique)
1603
 
        self.assertIsNot(obj1, obj2)
1604
 
 
1605
 
    def test_returns_same(self):
1606
 
        obj1 = self.bus.get_object("busname", "objectpath")
1607
 
        self.assertIsInstance(obj1, Unique)
1608
 
        obj2 = self.bus.get_object("busname", "objectpath")
1609
 
        self.assertIsInstance(obj2, Unique)
1610
 
        self.assertIs(obj1, obj2)
1611
 
 
1612
 
    def test_returns_same_old(self):
1613
 
        obj1 = self.bus.get_object("busname1", "objectpath1")
1614
 
        self.assertIsInstance(obj1, Unique)
1615
 
        obj2 = self.bus.get_object("busname2", "objectpath2")
1616
 
        self.assertIsInstance(obj2, Unique)
1617
 
        obj1b = self.bus.get_object("busname1", "objectpath1")
1618
 
        self.assertIsInstance(obj1b, Unique)
1619
 
        self.assertIsNot(obj1, obj2)
1620
 
        self.assertIsNot(obj2, obj1b)
1621
 
        self.assertIs(obj1, obj1b)
1622
 
 
1623
 
 
1624
 
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1625
 
 
1626
 
    def Stub_pydbus_func(self, func):
1627
 
        class stub_pydbus(object):
1628
 
            """stub pydbus module"""
1629
 
            class SystemBus(object):
1630
 
                @staticmethod
1631
 
                def get(busname, objectpath):
1632
 
                    DBusObject = collections.namedtuple(
1633
 
                        "DBusObject", ("methodname",))
1634
 
                    return {"interface":
1635
 
                            DBusObject(methodname=func)}
1636
 
        return stub_pydbus
1637
 
 
1638
 
    def call_method(self, bus, methodname, busname, objectpath,
1639
 
                    interface, *args):
1640
 
        with self.assertLogs(log, logging.DEBUG):
1641
 
            return bus.call_method(methodname, busname, objectpath,
1642
 
                                   interface, *args)
1643
 
 
1644
 
    def test_call_method_returns(self):
1645
 
        expected_method_return = Unique()
1646
 
        method_args = (Unique(), Unique())
1647
 
        def func(*args):
1648
 
            self.assertEqual(len(method_args), len(args))
1649
 
            for marg, arg in zip(method_args, args):
1650
 
                self.assertIs(marg, arg)
1651
 
            return expected_method_return
1652
 
        stub_pydbus = self.Stub_pydbus_func(func)
1653
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1654
 
        ret = self.call_method(bus, "methodname", "busname",
1655
 
                               "objectpath", "interface",
1656
 
                               *method_args)
1657
 
        self.assertIs(ret, expected_method_return)
1658
 
 
1659
 
    def test_call_method_handles_exception(self):
1660
 
        dbus_logger = logging.getLogger("dbus.proxies")
1661
 
 
1662
 
        def func():
1663
 
            raise gi.repository.GLib.Error()
1664
 
 
1665
 
        stub_pydbus = self.Stub_pydbus_func(func)
1666
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1667
 
 
1668
 
        with self.assertRaises(dbus.Error) as e:
1669
 
            self.call_method(bus, "methodname", "busname",
1670
 
                             "objectpath", "interface")
1671
 
 
1672
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1673
 
 
1674
 
    def test_get_converts_to_correct_exception(self):
1675
 
        bus = pydbus_adapter.SystemBus(
1676
 
            self.fake_pydbus_raises_exception_on_connect)
1677
 
        with self.assertRaises(dbus.ConnectFailed):
1678
 
            self.call_method(bus, "methodname", "busname",
1679
 
                             "objectpath", "interface")
1680
 
 
1681
 
    class fake_pydbus_raises_exception_on_connect(object):
1682
 
        """fake dbus-python module"""
1683
 
        @classmethod
1684
 
        def SystemBus(cls):
1685
 
            def get(busname, objectpath):
1686
 
                raise gi.repository.GLib.Error()
1687
 
            Bus = collections.namedtuple("Bus", ["get"])
1688
 
            return Bus(get=get)
1689
 
 
1690
 
    def test_set_property_uses_setattr(self):
1691
 
        class Object(object):
1692
 
            pass
1693
 
        obj = Object()
1694
 
        class pydbus_spy(object):
1695
 
            class SystemBus(object):
1696
 
                @staticmethod
1697
 
                def get(busname, objectpath):
1698
 
                    return {"interface": obj}
1699
 
        bus = pydbus_adapter.SystemBus(pydbus_spy)
1700
 
        value = Unique()
1701
 
        bus.set_property("busname", "objectpath", "interface", "key",
1702
 
                         value)
1703
 
        self.assertIs(value, obj.key)
1704
 
 
1705
 
    def test_get_suppresses_xml_deprecation_warning(self):
1706
 
        if sys.version_info.major >= 3:
1707
 
            return
1708
 
        class stub_pydbus_get(object):
1709
 
            class SystemBus(object):
1710
 
                @staticmethod
1711
 
                def get(busname, objectpath):
1712
 
                    warnings.warn_explicit(
1713
 
                        "deprecated", DeprecationWarning,
1714
 
                        "xml.etree.ElementTree", 0)
1715
 
        bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1716
 
        with warnings.catch_warnings(record=True) as w:
1717
 
            warnings.simplefilter("always")
1718
 
            bus.get("busname", "objectpath")
1719
 
            self.assertEqual(0, len(w))
1720
 
 
1721
 
 
1722
 
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1723
 
    class stub_pydbus(object):
1724
 
        """stub pydbus module"""
1725
 
        class SystemBus(object):
1726
 
            @staticmethod
1727
 
            def get(busname, objectpath):
1728
 
                return Unique()
1729
 
 
1730
 
    def setUp(self):
1731
 
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1732
 
 
1733
 
    def test_returns_distinct_objectpaths(self):
1734
 
        obj1 = self.bus.get("busname", "objectpath1")
1735
 
        self.assertIsInstance(obj1, Unique)
1736
 
        obj2 = self.bus.get("busname", "objectpath2")
1737
 
        self.assertIsInstance(obj2, Unique)
1738
 
        self.assertIsNot(obj1, obj2)
1739
 
 
1740
 
    def test_returns_distinct_busnames(self):
1741
 
        obj1 = self.bus.get("busname1", "objectpath")
1742
 
        self.assertIsInstance(obj1, Unique)
1743
 
        obj2 = self.bus.get("busname2", "objectpath")
1744
 
        self.assertIsInstance(obj2, Unique)
1745
 
        self.assertIsNot(obj1, obj2)
1746
 
 
1747
 
    def test_returns_distinct_both(self):
1748
 
        obj1 = self.bus.get("busname1", "objectpath")
1749
 
        self.assertIsInstance(obj1, Unique)
1750
 
        obj2 = self.bus.get("busname2", "objectpath")
1751
 
        self.assertIsInstance(obj2, Unique)
1752
 
        self.assertIsNot(obj1, obj2)
1753
 
 
1754
 
    def test_returns_same(self):
1755
 
        obj1 = self.bus.get("busname", "objectpath")
1756
 
        self.assertIsInstance(obj1, Unique)
1757
 
        obj2 = self.bus.get("busname", "objectpath")
1758
 
        self.assertIsInstance(obj2, Unique)
1759
 
        self.assertIs(obj1, obj2)
1760
 
 
1761
 
    def test_returns_same_old(self):
1762
 
        obj1 = self.bus.get("busname1", "objectpath1")
1763
 
        self.assertIsInstance(obj1, Unique)
1764
 
        obj2 = self.bus.get("busname2", "objectpath2")
1765
 
        self.assertIsInstance(obj2, Unique)
1766
 
        obj1b = self.bus.get("busname1", "objectpath1")
1767
 
        self.assertIsInstance(obj1b, Unique)
1768
 
        self.assertIsNot(obj1, obj2)
1769
 
        self.assertIsNot(obj2, obj1b)
1770
 
        self.assertIs(obj1, obj1b)
1771
 
 
1772
 
 
1773
 
class Test_commands_from_options(unittest.TestCase):
1774
 
 
1775
 
    def setUp(self):
1776
 
        self.parser = argparse.ArgumentParser()
1777
 
        add_command_line_options(self.parser)
1778
 
 
1779
 
    def test_is_enabled(self):
1780
 
        self.assert_command_from_args(["--is-enabled", "client"],
1781
 
                                      command.IsEnabled)
1782
 
 
1783
 
    def assert_command_from_args(self, args, command_cls, length=1,
1784
 
                                 clients=None, **cmd_attrs):
1785
 
        """Assert that parsing ARGS should result in an instance of
1786
 
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1787
 
        options = self.parser.parse_args(args)
1788
 
        check_option_syntax(self.parser, options)
1789
 
        commands = commands_from_options(options)
1790
 
        self.assertEqual(length, len(commands))
1791
 
        for command in commands:
1792
 
            if isinstance(command, command_cls):
1793
 
                break
1794
 
        else:
1795
 
            self.assertIsInstance(command, command_cls)
1796
 
        if clients is not None:
1797
 
            self.assertEqual(clients, options.client)
1798
 
        for key, value in cmd_attrs.items():
1799
 
            self.assertEqual(value, getattr(command, key))
1800
 
 
1801
 
    def assert_commands_from_args(self, args, commands, clients=None):
1802
 
        for cmd in commands:
1803
 
            self.assert_command_from_args(args, cmd,
1804
 
                                          length=len(commands),
1805
 
                                          clients=clients)
1806
 
 
1807
 
    def test_is_enabled_short(self):
1808
 
        self.assert_command_from_args(["-V", "client"],
1809
 
                                      command.IsEnabled)
1810
 
 
1811
 
    def test_approve(self):
1812
 
        self.assert_command_from_args(["--approve", "client"],
1813
 
                                      command.Approve)
1814
 
 
1815
 
    def test_approve_short(self):
1816
 
        self.assert_command_from_args(["-A", "client"],
1817
 
                                      command.Approve)
1818
 
 
1819
 
    def test_deny(self):
1820
 
        self.assert_command_from_args(["--deny", "client"],
1821
 
                                      command.Deny)
1822
 
 
1823
 
    def test_deny_short(self):
1824
 
        self.assert_command_from_args(["-D", "client"], command.Deny)
1825
 
 
1826
 
    def test_remove(self):
1827
 
        self.assert_command_from_args(["--remove", "client"],
1828
 
                                      command.Remove)
1829
 
 
1830
 
    def test_deny_before_remove(self):
1831
 
        options = self.parser.parse_args(["--deny", "--remove",
1832
 
                                          "client"])
1833
 
        check_option_syntax(self.parser, options)
1834
 
        commands = commands_from_options(options)
1835
 
        self.assertEqual(2, len(commands))
1836
 
        self.assertIsInstance(commands[0], command.Deny)
1837
 
        self.assertIsInstance(commands[1], command.Remove)
1838
 
 
1839
 
    def test_deny_before_remove_reversed(self):
1840
 
        options = self.parser.parse_args(["--remove", "--deny",
1841
 
                                          "--all"])
1842
 
        check_option_syntax(self.parser, options)
1843
 
        commands = commands_from_options(options)
1844
 
        self.assertEqual(2, len(commands))
1845
 
        self.assertIsInstance(commands[0], command.Deny)
1846
 
        self.assertIsInstance(commands[1], command.Remove)
1847
 
 
1848
 
    def test_remove_short(self):
1849
 
        self.assert_command_from_args(["-r", "client"],
1850
 
                                      command.Remove)
1851
 
 
1852
 
    def test_dump_json(self):
1853
 
        self.assert_command_from_args(["--dump-json"],
1854
 
                                      command.DumpJSON)
1855
 
 
1856
 
    def test_enable(self):
1857
 
        self.assert_command_from_args(["--enable", "client"],
1858
 
                                      command.Enable)
1859
 
 
1860
 
    def test_enable_short(self):
1861
 
        self.assert_command_from_args(["-e", "client"],
1862
 
                                      command.Enable)
1863
 
 
1864
 
    def test_disable(self):
1865
 
        self.assert_command_from_args(["--disable", "client"],
1866
 
                                      command.Disable)
1867
 
 
1868
 
    def test_disable_short(self):
1869
 
        self.assert_command_from_args(["-d", "client"],
1870
 
                                      command.Disable)
1871
 
 
1872
 
    def test_bump_timeout(self):
1873
 
        self.assert_command_from_args(["--bump-timeout", "client"],
1874
 
                                      command.BumpTimeout)
1875
 
 
1876
 
    def test_bump_timeout_short(self):
1877
 
        self.assert_command_from_args(["-b", "client"],
1878
 
                                      command.BumpTimeout)
1879
 
 
1880
 
    def test_start_checker(self):
1881
 
        self.assert_command_from_args(["--start-checker", "client"],
1882
 
                                      command.StartChecker)
1883
 
 
1884
 
    def test_stop_checker(self):
1885
 
        self.assert_command_from_args(["--stop-checker", "client"],
1886
 
                                      command.StopChecker)
1887
 
 
1888
 
    def test_approve_by_default(self):
1889
 
        self.assert_command_from_args(["--approve-by-default",
1890
 
                                       "client"],
1891
 
                                      command.ApproveByDefault)
1892
 
 
1893
 
    def test_deny_by_default(self):
1894
 
        self.assert_command_from_args(["--deny-by-default", "client"],
1895
 
                                      command.DenyByDefault)
1896
 
 
1897
 
    def test_checker(self):
1898
 
        self.assert_command_from_args(["--checker", ":", "client"],
1899
 
                                      command.SetChecker,
1900
 
                                      value_to_set=":")
1901
 
 
1902
 
    def test_checker_empty(self):
1903
 
        self.assert_command_from_args(["--checker", "", "client"],
1904
 
                                      command.SetChecker,
1905
 
                                      value_to_set="")
1906
 
 
1907
 
    def test_checker_short(self):
1908
 
        self.assert_command_from_args(["-c", ":", "client"],
1909
 
                                      command.SetChecker,
1910
 
                                      value_to_set=":")
1911
 
 
1912
 
    def test_host(self):
1913
 
        self.assert_command_from_args(
1914
 
            ["--host", "client.example.org", "client"],
1915
 
            command.SetHost, value_to_set="client.example.org")
1916
 
 
1917
 
    def test_host_short(self):
1918
 
        self.assert_command_from_args(
1919
 
            ["-H", "client.example.org", "client"], command.SetHost,
1920
 
            value_to_set="client.example.org")
1921
 
 
1922
 
    def test_secret_devnull(self):
1923
 
        self.assert_command_from_args(["--secret", os.path.devnull,
1924
 
                                       "client"], command.SetSecret,
1925
 
                                      value_to_set=b"")
1926
 
 
1927
 
    def test_secret_tempfile(self):
1928
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1929
 
            value = b"secret\0xyzzy\nbar"
1930
 
            f.write(value)
1931
 
            f.seek(0)
1932
 
            self.assert_command_from_args(["--secret", f.name,
1933
 
                                           "client"],
1934
 
                                          command.SetSecret,
1935
 
                                          value_to_set=value)
1936
 
 
1937
 
    def test_secret_devnull_short(self):
1938
 
        self.assert_command_from_args(["-s", os.path.devnull,
1939
 
                                       "client"], command.SetSecret,
1940
 
                                      value_to_set=b"")
1941
 
 
1942
 
    def test_secret_tempfile_short(self):
1943
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1944
 
            value = b"secret\0xyzzy\nbar"
1945
 
            f.write(value)
1946
 
            f.seek(0)
1947
 
            self.assert_command_from_args(["-s", f.name, "client"],
1948
 
                                          command.SetSecret,
1949
 
                                          value_to_set=value)
1950
 
 
1951
 
    def test_timeout(self):
1952
 
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
1953
 
                                      command.SetTimeout,
1954
 
                                      value_to_set=300000)
1955
 
 
1956
 
    def test_timeout_short(self):
1957
 
        self.assert_command_from_args(["-t", "PT5M", "client"],
1958
 
                                      command.SetTimeout,
1959
 
                                      value_to_set=300000)
1960
 
 
1961
 
    def test_extended_timeout(self):
1962
 
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1963
 
                                       "client"],
1964
 
                                      command.SetExtendedTimeout,
1965
 
                                      value_to_set=900000)
1966
 
 
1967
 
    def test_interval(self):
1968
 
        self.assert_command_from_args(["--interval", "PT2M",
1969
 
                                       "client"], command.SetInterval,
1970
 
                                      value_to_set=120000)
1971
 
 
1972
 
    def test_interval_short(self):
1973
 
        self.assert_command_from_args(["-i", "PT2M", "client"],
1974
 
                                      command.SetInterval,
1975
 
                                      value_to_set=120000)
1976
 
 
1977
 
    def test_approval_delay(self):
1978
 
        self.assert_command_from_args(["--approval-delay", "PT30S",
1979
 
                                       "client"],
1980
 
                                      command.SetApprovalDelay,
1981
 
                                      value_to_set=30000)
1982
 
 
1983
 
    def test_approval_duration(self):
1984
 
        self.assert_command_from_args(["--approval-duration", "PT1S",
1985
 
                                       "client"],
1986
 
                                      command.SetApprovalDuration,
1987
 
                                      value_to_set=1000)
1988
 
 
1989
 
    def test_print_table(self):
1990
 
        self.assert_command_from_args([], command.PrintTable,
1991
 
                                      verbose=False)
1992
 
 
1993
 
    def test_print_table_verbose(self):
1994
 
        self.assert_command_from_args(["--verbose"],
1995
 
                                      command.PrintTable,
1996
 
                                      verbose=True)
1997
 
 
1998
 
    def test_print_table_verbose_short(self):
1999
 
        self.assert_command_from_args(["-v"], command.PrintTable,
2000
 
                                      verbose=True)
2001
 
 
2002
 
 
2003
 
    def test_manual_page_example_1(self):
2004
 
        self.assert_command_from_args("--verbose".split(),
2005
 
                                      command.PrintTable,
2006
 
                                      clients=[],
2007
 
                                      verbose=True)
2008
 
 
2009
 
    def test_manual_page_example_2(self):
2010
 
        self.assert_command_from_args(
2011
 
            "--verbose foo1.example.org foo2.example.org".split(),
2012
 
            command.PrintTable, clients=["foo1.example.org",
2013
 
                                         "foo2.example.org"],
2014
 
            verbose=True)
2015
 
 
2016
 
    def test_manual_page_example_3(self):
2017
 
        self.assert_command_from_args("--enable --all".split(),
2018
 
                                      command.Enable,
2019
 
                                      clients=[])
2020
 
 
2021
 
    def test_manual_page_example_4(self):
2022
 
        self.assert_commands_from_args(
2023
 
            ("--timeout=PT5M --interval=PT1M foo1.example.org"
2024
 
             " foo2.example.org").split(),
2025
 
            [command.SetTimeout, command.SetInterval],
2026
 
            clients=["foo1.example.org", "foo2.example.org"])
2027
 
 
2028
 
    def test_manual_page_example_5(self):
2029
 
        self.assert_command_from_args("--approve --all".split(),
2030
 
                                      command.Approve,
2031
 
                                      clients=[])
2032
 
 
2033
 
 
2034
 
class TestCommand(unittest.TestCase):
 
815
                log.removeFilter(warning_filter)
 
816
            self.assertTrue(getattr(warning_filter, "found", False))
 
817
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
818
 
 
819
 
 
820
class TestCmd(unittest.TestCase):
2035
821
    """Abstract class for tests of command classes"""
2036
 
 
2037
 
    class FakeMandosBus(dbus.MandosBus):
2038
 
        def __init__(self, testcase):
2039
 
            self.client_properties = {
 
822
    def setUp(self):
 
823
        testcase = self
 
824
        class MockClient(object):
 
825
            def __init__(self, name, **attributes):
 
826
                self.__dbus_object_path__ = "objpath_{}".format(name)
 
827
                self.attributes = attributes
 
828
                self.attributes["Name"] = name
 
829
                self.calls = []
 
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]
 
840
            def Approve(self, approve, dbus_interface):
 
841
                testcase.assertEqual(dbus_interface, client_interface)
 
842
                self.calls.append(("Approve", (approve,
 
843
                                               dbus_interface)))
 
844
        self.client = MockClient(
 
845
            "foo",
 
846
            KeyID=("92ed150794387c03ce684574b1139a65"
 
847
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
848
            Secret=b"secret",
 
849
            Host="foo.example.org",
 
850
            Enabled=dbus.Boolean(True),
 
851
            Timeout=300000,
 
852
            LastCheckedOK="2019-02-03T00:00:00",
 
853
            Created="2019-01-02T00:00:00",
 
854
            Interval=120000,
 
855
            Fingerprint=("778827225BA7DE539C5A"
 
856
                         "7CFA59CFF7CDBD9A5920"),
 
857
            CheckerRunning=dbus.Boolean(False),
 
858
            LastEnabled="2019-01-03T00:00:00",
 
859
            ApprovalPending=dbus.Boolean(False),
 
860
            ApprovedByDefault=dbus.Boolean(True),
 
861
            LastApprovalRequest="",
 
862
            ApprovalDelay=0,
 
863
            ApprovalDuration=1000,
 
864
            Checker="fping -q -- %(host)s",
 
865
            ExtendedTimeout=900000,
 
866
            Expires="2019-02-04T00:00:00",
 
867
            LastCheckerStatus=0)
 
868
        self.other_client = MockClient(
 
869
            "barbar",
 
870
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
871
                   "6ab612cff5ad227247e46c2b020f441c"),
 
872
            Secret=b"secretbar",
 
873
            Host="192.0.2.3",
 
874
            Enabled=dbus.Boolean(True),
 
875
            Timeout=300000,
 
876
            LastCheckedOK="2019-02-04T00:00:00",
 
877
            Created="2019-01-03T00:00:00",
 
878
            Interval=120000,
 
879
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
880
                         "F547B3A107558FCA3A27"),
 
881
            CheckerRunning=dbus.Boolean(True),
 
882
            LastEnabled="2019-01-04T00:00:00",
 
883
            ApprovalPending=dbus.Boolean(False),
 
884
            ApprovedByDefault=dbus.Boolean(False),
 
885
            LastApprovalRequest="2019-01-03T00:00:00",
 
886
            ApprovalDelay=30000,
 
887
            ApprovalDuration=1000,
 
888
            Checker=":",
 
889
            ExtendedTimeout=900000,
 
890
            Expires="2019-02-05T00:00:00",
 
891
            LastCheckerStatus=-2)
 
892
        self.clients =  collections.OrderedDict(
 
893
            [
 
894
                (self.client, self.client.attributes),
 
895
                (self.other_client, self.other_client.attributes),
 
896
            ])
 
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": {
2040
928
                "Name": "foo",
2041
929
                "KeyID": ("92ed150794387c03ce684574b1139a65"
2042
930
                          "94a34f895daaaf09fd8ea90a27cddb12"),
2043
 
                "Secret": b"secret",
2044
931
                "Host": "foo.example.org",
2045
932
                "Enabled": True,
2046
933
                "Timeout": 300000,
2060
947
                "ExtendedTimeout": 900000,
2061
948
                "Expires": "2019-02-04T00:00:00",
2062
949
                "LastCheckerStatus": 0,
2063
 
            }
2064
 
            self.other_client_properties = {
 
950
            },
 
951
            "barbar": {
2065
952
                "Name": "barbar",
2066
953
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
2067
954
                          "6ab612cff5ad227247e46c2b020f441c"),
2068
 
                "Secret": b"secretbar",
2069
955
                "Host": "192.0.2.3",
2070
956
                "Enabled": True,
2071
957
                "Timeout": 300000,
2080
966
                "ApprovedByDefault": False,
2081
967
                "LastApprovalRequest": "2019-01-03T00:00:00",
2082
968
                "ApprovalDelay": 30000,
2083
 
                "ApprovalDuration": 93785000,
 
969
                "ApprovalDuration": 1000,
2084
970
                "Checker": ":",
2085
971
                "ExtendedTimeout": 900000,
2086
972
                "Expires": "2019-02-05T00:00:00",
2087
973
                "LastCheckerStatus": -2,
2088
 
            }
2089
 
            self.clients =  collections.OrderedDict(
2090
 
                [
2091
 
                    ("client_objectpath", self.client_properties),
2092
 
                    ("other_client_objectpath",
2093
 
                     self.other_client_properties),
2094
 
                ])
2095
 
            self.one_client = {"client_objectpath":
2096
 
                               self.client_properties}
2097
 
            self.testcase = testcase
2098
 
            self.calls = []
2099
 
 
2100
 
        def call_method(self, methodname, busname, objectpath,
2101
 
                        interface, *args):
2102
 
            self.testcase.assertEqual("se.recompile.Mandos", busname)
2103
 
            self.calls.append((methodname, busname, objectpath,
2104
 
                               interface, args))
2105
 
            if interface == "org.freedesktop.DBus.Properties":
2106
 
                if methodname == "Set":
2107
 
                    self.testcase.assertEqual(3, len(args))
2108
 
                    interface, key, value = args
2109
 
                    self.testcase.assertEqual(
2110
 
                        "se.recompile.Mandos.Client", interface)
2111
 
                    self.clients[objectpath][key] = value
2112
 
                    return
2113
 
            elif interface == "se.recompile.Mandos":
2114
 
                self.testcase.assertEqual("RemoveClient", methodname)
2115
 
                self.testcase.assertEqual(1, len(args))
2116
 
                clientpath = args[0]
2117
 
                del self.clients[clientpath]
2118
 
                return
2119
 
            elif interface == "se.recompile.Mandos.Client":
2120
 
                if methodname == "Approve":
2121
 
                    self.testcase.assertEqual(1, len(args))
2122
 
                    return
2123
 
            raise ValueError()
2124
 
 
2125
 
    def setUp(self):
2126
 
        self.bus = self.FakeMandosBus(self)
2127
 
 
2128
 
 
2129
 
class TestBaseCommands(TestCommand):
2130
 
 
2131
 
    def test_IsEnabled_exits_successfully(self):
 
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):
2132
991
        with self.assertRaises(SystemExit) as e:
2133
 
            command.IsEnabled().run(self.bus.one_client)
 
992
            IsEnabledCmd().run(None, self.one_client)
2134
993
        if e.exception.code is not None:
2135
 
            self.assertEqual(0, e.exception.code)
 
994
            self.assertEqual(e.exception.code, 0)
2136
995
        else:
2137
996
            self.assertIsNone(e.exception.code)
2138
 
 
2139
 
    def test_IsEnabled_exits_with_failure(self):
2140
 
        self.bus.client_properties["Enabled"] = False
 
997
    def test_is_enabled_run_exits_with_failure(self):
 
998
        self.client.attributes["Enabled"] = dbus.Boolean(False)
2141
999
        with self.assertRaises(SystemExit) as e:
2142
 
            command.IsEnabled().run(self.bus.one_client)
 
1000
            IsEnabledCmd().run(None, self.one_client)
2143
1001
        if isinstance(e.exception.code, int):
2144
 
            self.assertNotEqual(0, e.exception.code)
 
1002
            self.assertNotEqual(e.exception.code, 0)
2145
1003
        else:
2146
1004
            self.assertIsNotNone(e.exception.code)
2147
1005
 
2148
 
    def test_Approve(self):
2149
 
        busname = "se.recompile.Mandos"
2150
 
        client_interface = "se.recompile.Mandos.Client"
2151
 
        command.Approve().run(self.bus.clients, self.bus)
2152
 
        for clientpath in self.bus.clients:
2153
 
            self.assertIn(("Approve", busname, clientpath,
2154
 
                           client_interface, (True,)), self.bus.calls)
2155
 
 
2156
 
    def test_Deny(self):
2157
 
        busname = "se.recompile.Mandos"
2158
 
        client_interface = "se.recompile.Mandos.Client"
2159
 
        command.Deny().run(self.bus.clients, self.bus)
2160
 
        for clientpath in self.bus.clients:
2161
 
            self.assertIn(("Approve", busname, clientpath,
2162
 
                           client_interface, (False,)),
2163
 
                          self.bus.calls)
2164
 
 
2165
 
    def test_Remove(self):
2166
 
        command.Remove().run(self.bus.clients, self.bus)
2167
 
        for clientpath in self.bus.clients:
2168
 
            self.assertIn(("RemoveClient", dbus_busname,
2169
 
                           dbus_server_path, dbus_server_interface,
2170
 
                           (clientpath,)), self.bus.calls)
2171
 
 
2172
 
    expected_json = {
2173
 
        "foo": {
2174
 
            "Name": "foo",
2175
 
            "KeyID": ("92ed150794387c03ce684574b1139a65"
2176
 
                      "94a34f895daaaf09fd8ea90a27cddb12"),
2177
 
            "Host": "foo.example.org",
2178
 
            "Enabled": True,
2179
 
            "Timeout": 300000,
2180
 
            "LastCheckedOK": "2019-02-03T00:00:00",
2181
 
            "Created": "2019-01-02T00:00:00",
2182
 
            "Interval": 120000,
2183
 
            "Fingerprint": ("778827225BA7DE539C5A"
2184
 
                            "7CFA59CFF7CDBD9A5920"),
2185
 
            "CheckerRunning": False,
2186
 
            "LastEnabled": "2019-01-03T00:00:00",
2187
 
            "ApprovalPending": False,
2188
 
            "ApprovedByDefault": True,
2189
 
            "LastApprovalRequest": "",
2190
 
            "ApprovalDelay": 0,
2191
 
            "ApprovalDuration": 1000,
2192
 
            "Checker": "fping -q -- %(host)s",
2193
 
            "ExtendedTimeout": 900000,
2194
 
            "Expires": "2019-02-04T00:00:00",
2195
 
            "LastCheckerStatus": 0,
2196
 
        },
2197
 
        "barbar": {
2198
 
            "Name": "barbar",
2199
 
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
2200
 
                      "6ab612cff5ad227247e46c2b020f441c"),
2201
 
            "Host": "192.0.2.3",
2202
 
            "Enabled": True,
2203
 
            "Timeout": 300000,
2204
 
            "LastCheckedOK": "2019-02-04T00:00:00",
2205
 
            "Created": "2019-01-03T00:00:00",
2206
 
            "Interval": 120000,
2207
 
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
2208
 
                            "F547B3A107558FCA3A27"),
2209
 
            "CheckerRunning": True,
2210
 
            "LastEnabled": "2019-01-04T00:00:00",
2211
 
            "ApprovalPending": False,
2212
 
            "ApprovedByDefault": False,
2213
 
            "LastApprovalRequest": "2019-01-03T00:00:00",
2214
 
            "ApprovalDelay": 30000,
2215
 
            "ApprovalDuration": 93785000,
2216
 
            "Checker": ":",
2217
 
            "ExtendedTimeout": 900000,
2218
 
            "Expires": "2019-02-05T00:00:00",
2219
 
            "LastCheckerStatus": -2,
2220
 
        },
2221
 
    }
2222
 
 
2223
 
    def test_DumpJSON_normal(self):
2224
 
        with self.capture_stdout_to_buffer() as buffer:
2225
 
            command.DumpJSON().run(self.bus.clients)
2226
 
        json_data = json.loads(buffer.getvalue())
2227
 
        self.assertDictEqual(self.expected_json, json_data)
2228
 
 
2229
 
    @staticmethod
2230
 
    @contextlib.contextmanager
2231
 
    def capture_stdout_to_buffer():
2232
 
        capture_buffer = io.StringIO()
2233
 
        old_stdout = sys.stdout
2234
 
        sys.stdout = capture_buffer
2235
 
        try:
2236
 
            yield capture_buffer
2237
 
        finally:
2238
 
            sys.stdout = old_stdout
2239
 
 
2240
 
    def test_DumpJSON_one_client(self):
2241
 
        with self.capture_stdout_to_buffer() as buffer:
2242
 
            command.DumpJSON().run(self.bus.one_client)
2243
 
        json_data = json.loads(buffer.getvalue())
2244
 
        expected_json = {"foo": self.expected_json["foo"]}
2245
 
        self.assertDictEqual(expected_json, json_data)
2246
 
 
2247
 
    def test_PrintTable_normal(self):
2248
 
        with self.capture_stdout_to_buffer() as buffer:
2249
 
            command.PrintTable().run(self.bus.clients)
2250
 
        expected_output = "\n".join((
2251
 
            "Name   Enabled Timeout  Last Successful Check",
2252
 
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
2253
 
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
2254
 
        )) + "\n"
2255
 
        self.assertEqual(expected_output, buffer.getvalue())
2256
 
 
2257
 
    def test_PrintTable_verbose(self):
2258
 
        with self.capture_stdout_to_buffer() as buffer:
2259
 
            command.PrintTable(verbose=True).run(self.bus.clients)
2260
 
        columns = (
2261
 
            (
2262
 
                "Name   ",
2263
 
                "foo    ",
2264
 
                "barbar ",
2265
 
            ),(
2266
 
                "Enabled ",
2267
 
                "Yes     ",
2268
 
                "Yes     ",
2269
 
            ),(
2270
 
                "Timeout  ",
2271
 
                "00:05:00 ",
2272
 
                "00:05:00 ",
2273
 
            ),(
2274
 
                "Last Successful Check ",
2275
 
                "2019-02-03T00:00:00   ",
2276
 
                "2019-02-04T00:00:00   ",
2277
 
            ),(
2278
 
                "Created             ",
2279
 
                "2019-01-02T00:00:00 ",
2280
 
                "2019-01-03T00:00:00 ",
2281
 
            ),(
2282
 
                "Interval ",
2283
 
                "00:02:00 ",
2284
 
                "00:02:00 ",
2285
 
            ),(
2286
 
                "Host            ",
2287
 
                "foo.example.org ",
2288
 
                "192.0.2.3       ",
2289
 
            ),(
2290
 
                ("Key ID                                             "
2291
 
                 "              "),
2292
 
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
2293
 
                 "ea90a27cddb12 "),
2294
 
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
2295
 
                 "46c2b020f441c "),
2296
 
            ),(
2297
 
                "Fingerprint                              ",
2298
 
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
2299
 
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
2300
 
            ),(
2301
 
                "Check Is Running ",
2302
 
                "No               ",
2303
 
                "Yes              ",
2304
 
            ),(
2305
 
                "Last Enabled        ",
2306
 
                "2019-01-03T00:00:00 ",
2307
 
                "2019-01-04T00:00:00 ",
2308
 
            ),(
2309
 
                "Approval Is Pending ",
2310
 
                "No                  ",
2311
 
                "No                  ",
2312
 
            ),(
2313
 
                "Approved By Default ",
2314
 
                "Yes                 ",
2315
 
                "No                  ",
2316
 
            ),(
2317
 
                "Last Approval Request ",
2318
 
                "                      ",
2319
 
                "2019-01-03T00:00:00   ",
2320
 
            ),(
2321
 
                "Approval Delay ",
2322
 
                "00:00:00       ",
2323
 
                "00:00:30       ",
2324
 
            ),(
2325
 
                "Approval Duration ",
2326
 
                "00:00:01          ",
2327
 
                "1T02:03:05        ",
2328
 
            ),(
2329
 
                "Checker              ",
2330
 
                "fping -q -- %(host)s ",
2331
 
                ":                    ",
2332
 
            ),(
2333
 
                "Extended Timeout ",
2334
 
                "00:15:00         ",
2335
 
                "00:15:00         ",
2336
 
            ),(
2337
 
                "Expires             ",
2338
 
                "2019-02-04T00:00:00 ",
2339
 
                "2019-02-05T00:00:00 ",
2340
 
            ),(
2341
 
                "Last Checker Status",
2342
 
                "0                  ",
2343
 
                "-2                 ",
2344
 
            )
2345
 
        )
2346
 
        num_lines = max(len(rows) for rows in columns)
2347
 
        expected_output = ("\n".join("".join(rows[line]
2348
 
                                             for rows in columns)
2349
 
                                     for line in range(num_lines))
2350
 
                           + "\n")
2351
 
        self.assertEqual(expected_output, buffer.getvalue())
2352
 
 
2353
 
    def test_PrintTable_one_client(self):
2354
 
        with self.capture_stdout_to_buffer() as buffer:
2355
 
            command.PrintTable().run(self.bus.one_client)
2356
 
        expected_output = "\n".join((
2357
 
            "Name Enabled Timeout  Last Successful Check",
2358
 
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
2359
 
        )) + "\n"
2360
 
        self.assertEqual(expected_output, buffer.getvalue())
2361
 
 
2362
 
 
2363
 
class TestPropertySetterCmd(TestCommand):
2364
 
    """Abstract class for tests of command.PropertySetter classes"""
2365
 
 
 
1006
class TestRemoveCmd(TestCmd):
 
1007
    def test_remove(self):
 
1008
        class MockMandos(object):
 
1009
            def __init__(self):
 
1010
                self.calls = []
 
1011
            def RemoveClient(self, dbus_path):
 
1012
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1013
        mandos = MockMandos()
 
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__,)),
 
1020
                          mandos.calls)
 
1021
 
 
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"""
2366
1059
    def runTest(self):
2367
1060
        if not hasattr(self, "command"):
2368
 
            return              # Abstract TestCase class
2369
 
 
2370
 
        if hasattr(self, "values_to_set"):
2371
 
            cmd_args = [(value,) for value in self.values_to_set]
2372
 
            values_to_get = getattr(self, "values_to_get",
2373
 
                                    self.values_to_set)
2374
 
        else:
2375
 
            cmd_args = [() for x in range(len(self.values_to_get))]
2376
 
            values_to_get = self.values_to_get
2377
 
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2378
 
            for clientpath in self.bus.clients:
2379
 
                self.bus.clients[clientpath][self.propname] = (
2380
 
                    Unique())
2381
 
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
2382
 
            for clientpath in self.bus.clients:
2383
 
                value = (self.bus.clients[clientpath]
2384
 
                         [self.propname])
 
1061
            return
 
1062
        values_to_get = getattr(self, "values_to_get",
 
1063
                                self.values_to_set)
 
1064
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1065
                                              values_to_get):
 
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()
 
1070
            self.run_command(value_to_set, self.clients)
 
1071
            for client in self.clients:
 
1072
                value = client.attributes[self.property]
2385
1073
                self.assertNotIsInstance(value, Unique)
2386
 
                self.assertEqual(value_to_get, value)
2387
 
 
2388
 
 
2389
 
class TestEnableCmd(TestPropertySetterCmd):
2390
 
    command = command.Enable
2391
 
    propname = "Enabled"
2392
 
    values_to_get = [True]
2393
 
 
2394
 
 
2395
 
class TestDisableCmd(TestPropertySetterCmd):
2396
 
    command = command.Disable
2397
 
    propname = "Enabled"
2398
 
    values_to_get = [False]
2399
 
 
2400
 
 
2401
 
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2402
 
    command = command.BumpTimeout
2403
 
    propname = "LastCheckedOK"
2404
 
    values_to_get = [""]
2405
 
 
2406
 
 
2407
 
class TestStartCheckerCmd(TestPropertySetterCmd):
2408
 
    command = command.StartChecker
2409
 
    propname = "CheckerRunning"
2410
 
    values_to_get = [True]
2411
 
 
2412
 
 
2413
 
class TestStopCheckerCmd(TestPropertySetterCmd):
2414
 
    command = command.StopChecker
2415
 
    propname = "CheckerRunning"
2416
 
    values_to_get = [False]
2417
 
 
2418
 
 
2419
 
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2420
 
    command = command.ApproveByDefault
2421
 
    propname = "ApprovedByDefault"
2422
 
    values_to_get = [True]
2423
 
 
2424
 
 
2425
 
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2426
 
    command = command.DenyByDefault
2427
 
    propname = "ApprovedByDefault"
2428
 
    values_to_get = [False]
2429
 
 
2430
 
 
2431
 
class TestSetCheckerCmd(TestPropertySetterCmd):
2432
 
    command = command.SetChecker
2433
 
    propname = "Checker"
 
1074
                self.assertEqual(value, value_to_get)
 
1075
    def run_command(self, value, clients):
 
1076
        self.command().run(None, clients)
 
1077
 
 
1078
class TestBumpTimeoutCmd(TestPropertyCmd):
 
1079
    command = BumpTimeoutCmd
 
1080
    property = "LastCheckedOK"
 
1081
    values_to_set = [""]
 
1082
 
 
1083
class TestStartCheckerCmd(TestPropertyCmd):
 
1084
    command = StartCheckerCmd
 
1085
    property = "CheckerRunning"
 
1086
    values_to_set = [dbus.Boolean(True)]
 
1087
 
 
1088
class TestStopCheckerCmd(TestPropertyCmd):
 
1089
    command = StopCheckerCmd
 
1090
    property = "CheckerRunning"
 
1091
    values_to_set = [dbus.Boolean(False)]
 
1092
 
 
1093
class TestApproveByDefaultCmd(TestPropertyCmd):
 
1094
    command = ApproveByDefaultCmd
 
1095
    property = "ApprovedByDefault"
 
1096
    values_to_set = [dbus.Boolean(True)]
 
1097
 
 
1098
class TestDenyByDefaultCmd(TestPropertyCmd):
 
1099
    command = DenyByDefaultCmd
 
1100
    property = "ApprovedByDefault"
 
1101
    values_to_set = [dbus.Boolean(False)]
 
1102
 
 
1103
class TestValueArgumentPropertyCmd(TestPropertyCmd):
 
1104
    """Abstract class for tests of PropertyCmd classes using the
 
1105
ValueArgumentMixIn"""
 
1106
    def runTest(self):
 
1107
        if type(self) is TestValueArgumentPropertyCmd:
 
1108
            return
 
1109
        return super(TestValueArgumentPropertyCmd, self).runTest()
 
1110
    def run_command(self, value, clients):
 
1111
        self.command(value).run(None, clients)
 
1112
 
 
1113
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
 
1114
    command = SetCheckerCmd
 
1115
    property = "Checker"
2434
1116
    values_to_set = ["", ":", "fping -q -- %s"]
2435
1117
 
2436
 
 
2437
 
class TestSetHostCmd(TestPropertySetterCmd):
2438
 
    command = command.SetHost
2439
 
    propname = "Host"
2440
 
    values_to_set = ["192.0.2.3", "client.example.org"]
2441
 
 
2442
 
 
2443
 
class TestSetSecretCmd(TestPropertySetterCmd):
2444
 
    command = command.SetSecret
2445
 
    propname = "Secret"
 
1118
class TestSetHostCmd(TestValueArgumentPropertyCmd):
 
1119
    command = SetHostCmd
 
1120
    property = "Host"
 
1121
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1122
 
 
1123
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
 
1124
    command = SetSecretCmd
 
1125
    property = "Secret"
2446
1126
    values_to_set = [io.BytesIO(b""),
2447
1127
                     io.BytesIO(b"secret\0xyzzy\nbar")]
2448
 
    values_to_get = [f.getvalue() for f in values_to_set]
2449
 
 
2450
 
 
2451
 
class TestSetTimeoutCmd(TestPropertySetterCmd):
2452
 
    command = command.SetTimeout
2453
 
    propname = "Timeout"
2454
 
    values_to_set = [datetime.timedelta(),
2455
 
                     datetime.timedelta(minutes=5),
2456
 
                     datetime.timedelta(seconds=1),
2457
 
                     datetime.timedelta(weeks=1),
2458
 
                     datetime.timedelta(weeks=52)]
2459
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2460
 
 
2461
 
 
2462
 
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2463
 
    command = command.SetExtendedTimeout
2464
 
    propname = "ExtendedTimeout"
2465
 
    values_to_set = [datetime.timedelta(),
2466
 
                     datetime.timedelta(minutes=5),
2467
 
                     datetime.timedelta(seconds=1),
2468
 
                     datetime.timedelta(weeks=1),
2469
 
                     datetime.timedelta(weeks=52)]
2470
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2471
 
 
2472
 
 
2473
 
class TestSetIntervalCmd(TestPropertySetterCmd):
2474
 
    command = command.SetInterval
2475
 
    propname = "Interval"
2476
 
    values_to_set = [datetime.timedelta(),
2477
 
                     datetime.timedelta(minutes=5),
2478
 
                     datetime.timedelta(seconds=1),
2479
 
                     datetime.timedelta(weeks=1),
2480
 
                     datetime.timedelta(weeks=52)]
2481
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2482
 
 
2483
 
 
2484
 
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2485
 
    command = command.SetApprovalDelay
2486
 
    propname = "ApprovalDelay"
2487
 
    values_to_set = [datetime.timedelta(),
2488
 
                     datetime.timedelta(minutes=5),
2489
 
                     datetime.timedelta(seconds=1),
2490
 
                     datetime.timedelta(weeks=1),
2491
 
                     datetime.timedelta(weeks=52)]
2492
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2493
 
 
2494
 
 
2495
 
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2496
 
    command = command.SetApprovalDuration
2497
 
    propname = "ApprovalDuration"
2498
 
    values_to_set = [datetime.timedelta(),
2499
 
                     datetime.timedelta(minutes=5),
2500
 
                     datetime.timedelta(seconds=1),
2501
 
                     datetime.timedelta(weeks=1),
2502
 
                     datetime.timedelta(weeks=52)]
2503
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
1128
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1129
 
 
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
    def test_deny_before_remove(self):
 
1359
        options = self.parser.parse_args(["--deny", "--remove", "foo"])
 
1360
        check_option_syntax(self.parser, options)
 
1361
        commands = commands_from_options(options)
 
1362
        self.assertEqual(len(commands), 2)
 
1363
        self.assertIsInstance(commands[0], DenyCmd)
 
1364
        self.assertIsInstance(commands[1], RemoveCmd)
 
1365
 
 
1366
    def test_deny_before_remove_reversed(self):
 
1367
        options = self.parser.parse_args(["--remove", "--deny", "--all"])
 
1368
        check_option_syntax(self.parser, options)
 
1369
        commands = commands_from_options(options)
 
1370
        self.assertEqual(len(commands), 2)
 
1371
        self.assertIsInstance(commands[0], DenyCmd)
 
1372
        self.assertIsInstance(commands[1], RemoveCmd)
 
1373
 
 
1374
 
 
1375
class Test_check_option_syntax(unittest.TestCase):
 
1376
    # This mostly corresponds to the definition from has_actions() in
 
1377
    # check_option_syntax()
 
1378
    actions = {
 
1379
        # The actual values set here are not that important, but we do
 
1380
        # at least stick to the correct types, even though they are
 
1381
        # never used
 
1382
        "enable": True,
 
1383
        "disable": True,
 
1384
        "bump_timeout": True,
 
1385
        "start_checker": True,
 
1386
        "stop_checker": True,
 
1387
        "is_enabled": True,
 
1388
        "remove": True,
 
1389
        "checker": "x",
 
1390
        "timeout": datetime.timedelta(),
 
1391
        "extended_timeout": datetime.timedelta(),
 
1392
        "interval": datetime.timedelta(),
 
1393
        "approved_by_default": True,
 
1394
        "approval_delay": datetime.timedelta(),
 
1395
        "approval_duration": datetime.timedelta(),
 
1396
        "host": "x",
 
1397
        "secret": io.BytesIO(b"x"),
 
1398
        "approve": True,
 
1399
        "deny": True,
 
1400
    }
 
1401
 
 
1402
    def setUp(self):
 
1403
        self.parser = argparse.ArgumentParser()
 
1404
        add_command_line_options(self.parser)
 
1405
 
 
1406
    @contextlib.contextmanager
 
1407
    def assertParseError(self):
 
1408
        with self.assertRaises(SystemExit) as e:
 
1409
            with self.temporarily_suppress_stderr():
 
1410
                yield
 
1411
        # Exit code from argparse is guaranteed to be "2".  Reference:
 
1412
        # https://docs.python.org/3/library/argparse.html#exiting-methods
 
1413
        self.assertEqual(e.exception.code, 2)
 
1414
 
 
1415
    @staticmethod
 
1416
    @contextlib.contextmanager
 
1417
    def temporarily_suppress_stderr():
 
1418
        null = os.open(os.path.devnull, os.O_RDWR)
 
1419
        stderrcopy = os.dup(sys.stderr.fileno())
 
1420
        os.dup2(null, sys.stderr.fileno())
 
1421
        os.close(null)
 
1422
        try:
 
1423
            yield
 
1424
        finally:
 
1425
            # restore stderr
 
1426
            os.dup2(stderrcopy, sys.stderr.fileno())
 
1427
            os.close(stderrcopy)
 
1428
 
 
1429
    def check_option_syntax(self, options):
 
1430
        check_option_syntax(self.parser, options)
 
1431
 
 
1432
    def test_actions_requires_client_or_all(self):
 
1433
        for action, value in self.actions.items():
 
1434
            options = self.parser.parse_args()
 
1435
            setattr(options, action, value)
 
1436
            with self.assertParseError():
 
1437
                self.check_option_syntax(options)
 
1438
 
 
1439
    def test_actions_conflicts_with_verbose(self):
 
1440
        for action, value in self.actions.items():
 
1441
            options = self.parser.parse_args()
 
1442
            setattr(options, action, value)
 
1443
            options.verbose = True
 
1444
            with self.assertParseError():
 
1445
                self.check_option_syntax(options)
 
1446
 
 
1447
    def test_dump_json_conflicts_with_verbose(self):
 
1448
        options = self.parser.parse_args()
 
1449
        options.dump_json = True
 
1450
        options.verbose = True
 
1451
        with self.assertParseError():
 
1452
            self.check_option_syntax(options)
 
1453
 
 
1454
    def test_dump_json_conflicts_with_action(self):
 
1455
        for action, value in self.actions.items():
 
1456
            options = self.parser.parse_args()
 
1457
            setattr(options, action, value)
 
1458
            options.dump_json = True
 
1459
            with self.assertParseError():
 
1460
                self.check_option_syntax(options)
 
1461
 
 
1462
    def test_all_can_not_be_alone(self):
 
1463
        options = self.parser.parse_args()
 
1464
        options.all = True
 
1465
        with self.assertParseError():
 
1466
            self.check_option_syntax(options)
 
1467
 
 
1468
    def test_all_is_ok_with_any_action(self):
 
1469
        for action, value in self.actions.items():
 
1470
            options = self.parser.parse_args()
 
1471
            setattr(options, action, value)
 
1472
            options.all = True
 
1473
            self.check_option_syntax(options)
 
1474
 
 
1475
    def test_is_enabled_fails_without_client(self):
 
1476
        options = self.parser.parse_args()
 
1477
        options.is_enabled = True
 
1478
        with self.assertParseError():
 
1479
            self.check_option_syntax(options)
 
1480
 
 
1481
    def test_is_enabled_works_with_one_client(self):
 
1482
        options = self.parser.parse_args()
 
1483
        options.is_enabled = True
 
1484
        options.client = ["foo"]
 
1485
        self.check_option_syntax(options)
 
1486
 
 
1487
    def test_is_enabled_fails_with_two_clients(self):
 
1488
        options = self.parser.parse_args()
 
1489
        options.is_enabled = True
 
1490
        options.client = ["foo", "barbar"]
 
1491
        with self.assertParseError():
 
1492
            self.check_option_syntax(options)
2504
1493
 
2505
1494
 
2506
1495
 
2521
1510
    return tests
2522
1511
 
2523
1512
if __name__ == "__main__":
2524
 
    try:
2525
 
        if should_only_run_tests():
2526
 
            # Call using ./tdd-python-script --check [--verbose]
2527
 
            unittest.main()
2528
 
        else:
2529
 
            main()
2530
 
    finally:
2531
 
        logging.shutdown()
 
1513
    if should_only_run_tests():
 
1514
        # Call using ./tdd-python-script --check [--verbose]
 
1515
        unittest.main()
 
1516
    else:
 
1517
        main()