/mandos/release

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