/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-ctl

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