/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-ctl

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

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

Show diffs side-by-side

added added

removed removed

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