/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
            self.mandos = mandos
560
            for clientpath, properties in clients.items():
561
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
562
                          dbus_busname, str(clientpath))
563
                client = bus.get_object(dbus_busname, clientpath)
564
                self.run_on_one_client(client, properties)
565
566
567
    class IsEnabled(Base):
568
        def run(self, clients, bus=None, mandos=None):
569
            client, properties = next(iter(clients.items()))
570
            if self.is_enabled(client, properties):
571
                sys.exit(0)
572
            sys.exit(1)
573
        def is_enabled(self, client, properties):
574
            return properties["Enabled"]
575
576
577
    class Approve(Base):
578
        def run_on_one_client(self, client, properties):
579
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
580
                      client.__dbus_object_path__,
581
                      client_dbus_interface)
582
            client.Approve(dbus.Boolean(True),
583
                           dbus_interface=client_dbus_interface)
584
585
586
    class Deny(Base):
587
        def run_on_one_client(self, client, properties):
588
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
589
                      client.__dbus_object_path__,
590
                      client_dbus_interface)
591
            client.Approve(dbus.Boolean(False),
592
                           dbus_interface=client_dbus_interface)
593
594
595
    class Remove(Base):
596
        def run_on_one_client(self, client, properties):
597
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
598
                      dbus_busname, server_dbus_path,
599
                      server_dbus_interface,
600
                      str(client.__dbus_object_path__))
601
            self.mandos.RemoveClient(client.__dbus_object_path__)
602
603
604
    class Output(Base):
605
        """Abstract class for commands outputting client details"""
606
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
607
                        "Created", "Interval", "Host", "KeyID",
608
                        "Fingerprint", "CheckerRunning",
609
                        "LastEnabled", "ApprovalPending",
610
                        "ApprovedByDefault", "LastApprovalRequest",
611
                        "ApprovalDelay", "ApprovalDuration",
612
                        "Checker", "ExtendedTimeout", "Expires",
613
                        "LastCheckerStatus")
614
615
616
    class DumpJSON(Output):
237.7.633 by Teddy Hogeborn
mandos-ctl: Refactor
617
        def run(self, clients, bus=None, mandos=None):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
618
            data = {client["Name"]:
619
                    {key: self.dbus_boolean_to_bool(client[key])
620
                     for key in self.all_keywords}
237.7.633 by Teddy Hogeborn
mandos-ctl: Refactor
621
                    for client in clients.values()}
622
            print(json.dumps(data, indent=4, separators=(',', ': ')))
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
623
624
        @staticmethod
625
        def dbus_boolean_to_bool(value):
626
            if isinstance(value, dbus.Boolean):
627
                value = bool(value)
628
            return value
629
630
631
    class PrintTable(Output):
632
        def __init__(self, verbose=False):
633
            self.verbose = verbose
634
237.7.633 by Teddy Hogeborn
mandos-ctl: Refactor
635
        def run(self, clients, bus=None, mandos=None):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
636
            default_keywords = ("Name", "Enabled", "Timeout",
637
                                "LastCheckedOK")
638
            keywords = default_keywords
639
            if self.verbose:
640
                keywords = self.all_keywords
237.7.633 by Teddy Hogeborn
mandos-ctl: Refactor
641
            print(self.TableOfClients(clients.values(), keywords))
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
642
643
        class TableOfClients(object):
644
            tableheaders = {
645
                "Name": "Name",
646
                "Enabled": "Enabled",
647
                "Timeout": "Timeout",
648
                "LastCheckedOK": "Last Successful Check",
649
                "LastApprovalRequest": "Last Approval Request",
650
                "Created": "Created",
651
                "Interval": "Interval",
652
                "Host": "Host",
653
                "Fingerprint": "Fingerprint",
654
                "KeyID": "Key ID",
655
                "CheckerRunning": "Check Is Running",
656
                "LastEnabled": "Last Enabled",
657
                "ApprovalPending": "Approval Is Pending",
658
                "ApprovedByDefault": "Approved By Default",
659
                "ApprovalDelay": "Approval Delay",
660
                "ApprovalDuration": "Approval Duration",
661
                "Checker": "Checker",
662
                "ExtendedTimeout": "Extended Timeout",
663
                "Expires": "Expires",
664
                "LastCheckerStatus": "Last Checker Status",
665
            }
666
667
            def __init__(self, clients, keywords):
668
                self.clients = clients
669
                self.keywords = keywords
670
237.7.559 by Teddy Hogeborn
mandos-ctl: Refactor; move TableOfClients into PrintTableCmd
671
            def __str__(self):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
672
                return "\n".join(self.rows())
673
674
            if sys.version_info.major == 2:
675
                __unicode__ = __str__
676
                def __str__(self):
677
                    return str(self).encode(
678
                        locale.getpreferredencoding())
679
680
            def rows(self):
681
                format_string = self.row_formatting_string()
682
                rows = [self.header_line(format_string)]
683
                rows.extend(self.client_line(client, format_string)
684
                            for client in self.clients)
685
                return rows
686
687
            def row_formatting_string(self):
688
                "Format string used to format table rows"
689
                return " ".join("{{{key}:{width}}}".format(
690
                    width=max(len(self.tableheaders[key]),
691
                              *(len(self.string_from_client(client,
692
                                                            key))
693
                                for client in self.clients)),
694
                    key=key)
695
                                for key in self.keywords)
696
697
            def string_from_client(self, client, key):
698
                return self.valuetostring(client[key], key)
699
700
            @classmethod
701
            def valuetostring(cls, value, keyword):
702
                if isinstance(value, dbus.Boolean):
703
                    return "Yes" if value else "No"
704
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
705
                               "ApprovalDuration", "ExtendedTimeout"):
706
                    return cls.milliseconds_to_string(value)
707
                return str(value)
708
709
            def header_line(self, format_string):
710
                return format_string.format(**self.tableheaders)
711
712
            def client_line(self, client, format_string):
713
                return format_string.format(
714
                    **{key: self.string_from_client(client, key)
715
                       for key in self.keywords})
716
717
            @staticmethod
718
            def milliseconds_to_string(ms):
719
                td = datetime.timedelta(0, 0, 0, ms)
720
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
721
                        .format(days="{}T".format(td.days)
722
                                if td.days else "",
723
                                hours=td.seconds // 3600,
724
                                minutes=(td.seconds % 3600) // 60,
725
                                seconds=td.seconds % 60))
726
727
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
728
    class PropertySetter(Base):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
729
        "Abstract class for Actions for setting one client property"
730
731
        def run_on_one_client(self, client, properties):
732
            """Set the Client's D-Bus property"""
733
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
734
                      client.__dbus_object_path__,
735
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
736
                      self.propname, self.value_to_set
737
                      if not isinstance(self.value_to_set,
738
                                        dbus.Boolean)
739
                      else bool(self.value_to_set))
740
            client.Set(client_dbus_interface, self.propname,
741
                       self.value_to_set,
742
                       dbus_interface=dbus.PROPERTIES_IFACE)
743
744
        @property
745
        def propname(self):
746
            raise NotImplementedError()
747
748
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
749
    class Enable(PropertySetter):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
750
        propname = "Enabled"
751
        value_to_set = dbus.Boolean(True)
752
753
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
754
    class Disable(PropertySetter):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
755
        propname = "Enabled"
756
        value_to_set = dbus.Boolean(False)
757
758
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
759
    class BumpTimeout(PropertySetter):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
760
        propname = "LastCheckedOK"
761
        value_to_set = ""
762
763
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
764
    class StartChecker(PropertySetter):
765
        propname = "CheckerRunning"
766
        value_to_set = dbus.Boolean(True)
767
768
769
    class StopChecker(PropertySetter):
770
        propname = "CheckerRunning"
771
        value_to_set = dbus.Boolean(False)
772
773
774
    class ApproveByDefault(PropertySetter):
775
        propname = "ApprovedByDefault"
776
        value_to_set = dbus.Boolean(True)
777
778
779
    class DenyByDefault(PropertySetter):
780
        propname = "ApprovedByDefault"
781
        value_to_set = dbus.Boolean(False)
782
783
784
    class PropertySetterValue(PropertySetter):
785
        """Abstract class for PropertySetter recieving a value as
786
constructor argument instead of a class attribute."""
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
787
        def __init__(self, value):
788
            self.value_to_set = value
789
790
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
791
    class SetChecker(PropertySetterValue):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
792
        propname = "Checker"
793
794
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
795
    class SetHost(PropertySetterValue):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
796
        propname = "Host"
797
798
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
799
    class SetSecret(PropertySetterValue):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
800
        propname = "Secret"
801
802
        @property
803
        def value_to_set(self):
804
            return self._vts
805
806
        @value_to_set.setter
807
        def value_to_set(self, value):
808
            """When setting, read data from supplied file object"""
809
            self._vts = value.read()
810
            value.close()
811
812
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
813
    class PropertySetterValueMilliseconds(PropertySetterValue):
814
        """Abstract class for PropertySetterValue taking a value
815
argument as a datetime.timedelta() but should store it as
816
milliseconds."""
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
817
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
818
        @property
819
        def value_to_set(self):
820
            return self._vts
821
822
        @value_to_set.setter
823
        def value_to_set(self, value):
824
            "When setting, convert value from a datetime.timedelta"
825
            self._vts = int(round(value.total_seconds() * 1000))
826
827
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
828
    class SetTimeout(PropertySetterValueMilliseconds):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
829
        propname = "Timeout"
830
831
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
832
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
833
        propname = "ExtendedTimeout"
834
835
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
836
    class SetInterval(PropertySetterValueMilliseconds):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
837
        propname = "Interval"
838
839
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
840
    class SetApprovalDelay(PropertySetterValueMilliseconds):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
841
        propname = "ApprovalDelay"
842
843
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
844
    class SetApprovalDuration(PropertySetterValueMilliseconds):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
845
        propname = "ApprovalDuration"
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
846
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
847
237.7.532 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
848

237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
849
class TestCaseWithAssertLogs(unittest.TestCase):
850
    """unittest.TestCase.assertLogs only exists in Python 3.4"""
851
852
    if not hasattr(unittest.TestCase, "assertLogs"):
853
        @contextlib.contextmanager
854
        def assertLogs(self, logger, level=logging.INFO):
855
            capturing_handler = self.CapturingLevelHandler(level)
856
            old_level = logger.level
857
            old_propagate = logger.propagate
858
            logger.addHandler(capturing_handler)
859
            logger.setLevel(level)
860
            logger.propagate = False
861
            try:
862
                yield capturing_handler.watcher
863
            finally:
864
                logger.propagate = old_propagate
865
                logger.removeHandler(capturing_handler)
866
                logger.setLevel(old_level)
867
            self.assertGreater(len(capturing_handler.watcher.records),
868
                               0)
869
870
        class CapturingLevelHandler(logging.Handler):
871
            def __init__(self, level, *args, **kwargs):
872
                logging.Handler.__init__(self, *args, **kwargs)
873
                self.watcher = self.LoggingWatcher([], [])
874
            def emit(self, record):
875
                self.watcher.records.append(record)
876
                self.watcher.output.append(self.format(record))
877
878
            LoggingWatcher = collections.namedtuple("LoggingWatcher",
879
                                                    ("records",
880
                                                     "output"))
881
237.7.624 by Teddy Hogeborn
mandos-ctl: Refactor and add a few more tests
882
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
883
class Test_string_to_delta(TestCaseWithAssertLogs):
237.7.628 by Teddy Hogeborn
mandos-ctl: Refactor tests
884
    # Just test basic RFC 3339 functionality here, the doc string for
885
    # rfc3339_duration_to_delta() already has more comprehensive
886
    # tests, which is run by doctest.
887
888
    def test_rfc3339_zero_seconds(self):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
889
        self.assertEqual(datetime.timedelta(),
890
                         string_to_delta("PT0S"))
237.7.628 by Teddy Hogeborn
mandos-ctl: Refactor tests
891
892
    def test_rfc3339_zero_days(self):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
893
        self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
237.7.628 by Teddy Hogeborn
mandos-ctl: Refactor tests
894
895
    def test_rfc3339_one_second(self):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
896
        self.assertEqual(datetime.timedelta(0, 1),
897
                         string_to_delta("PT1S"))
237.7.628 by Teddy Hogeborn
mandos-ctl: Refactor tests
898
899
    def test_rfc3339_two_hours(self):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
900
        self.assertEqual(datetime.timedelta(0, 7200),
901
                         string_to_delta("PT2H"))
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
902
237.7.540 by Teddy Hogeborn
mandos-ctl: Add more tests
903
    def test_falls_back_to_pre_1_6_1_with_warning(self):
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
904
        with self.assertLogs(log, logging.WARNING):
905
            value = string_to_delta("2h")
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
906
        self.assertEqual(datetime.timedelta(0, 7200), value)
237.7.540 by Teddy Hogeborn
mandos-ctl: Add more tests
907
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
908
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
909
class Test_check_option_syntax(unittest.TestCase):
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
910
    def setUp(self):
911
        self.parser = argparse.ArgumentParser()
912
        add_command_line_options(self.parser)
913
914
    def test_actions_requires_client_or_all(self):
915
        for action, value in self.actions.items():
916
            options = self.parser.parse_args()
917
            setattr(options, action, value)
918
            with self.assertParseError():
919
                self.check_option_syntax(options)
920
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
921
    # This mostly corresponds to the definition from has_actions() in
922
    # check_option_syntax()
923
    actions = {
924
        # The actual values set here are not that important, but we do
925
        # at least stick to the correct types, even though they are
926
        # never used
927
        "enable": True,
928
        "disable": True,
929
        "bump_timeout": True,
930
        "start_checker": True,
931
        "stop_checker": True,
932
        "is_enabled": True,
933
        "remove": True,
934
        "checker": "x",
935
        "timeout": datetime.timedelta(),
936
        "extended_timeout": datetime.timedelta(),
937
        "interval": datetime.timedelta(),
938
        "approved_by_default": True,
939
        "approval_delay": datetime.timedelta(),
940
        "approval_duration": datetime.timedelta(),
941
        "host": "x",
942
        "secret": io.BytesIO(b"x"),
943
        "approve": True,
944
        "deny": True,
945
    }
946
947
    @contextlib.contextmanager
948
    def assertParseError(self):
949
        with self.assertRaises(SystemExit) as e:
237.7.624 by Teddy Hogeborn
mandos-ctl: Refactor and add a few more tests
950
            with self.redirect_stderr_to_devnull():
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
951
                yield
952
        # Exit code from argparse is guaranteed to be "2".  Reference:
953
        # https://docs.python.org/3/library
954
        # /argparse.html#exiting-methods
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
955
        self.assertEqual(2, e.exception.code)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
956
957
    @staticmethod
958
    @contextlib.contextmanager
237.7.624 by Teddy Hogeborn
mandos-ctl: Refactor and add a few more tests
959
    def redirect_stderr_to_devnull():
237.7.631 by Teddy Hogeborn
mandos-ctl: Refactor tests
960
        old_stderr = sys.stderr
961
        with contextlib.closing(open(os.devnull, "w")) as null:
962
            sys.stderr = null
963
            try:
964
                yield
965
            finally:
966
                sys.stderr = old_stderr
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
967
968
    def check_option_syntax(self, options):
969
        check_option_syntax(self.parser, options)
970
237.7.623 by Teddy Hogeborn
mandos-ctl: Refactor and fix bug in tests.
971
    def test_actions_all_conflicts_with_verbose(self):
972
        for action, value in self.actions.items():
973
            options = self.parser.parse_args()
974
            setattr(options, action, value)
975
            options.all = True
976
            options.verbose = True
977
            with self.assertParseError():
978
                self.check_option_syntax(options)
979
980
    def test_actions_with_client_conflicts_with_verbose(self):
981
        for action, value in self.actions.items():
982
            options = self.parser.parse_args()
983
            setattr(options, action, value)
984
            options.verbose = True
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
985
            options.client = ["client"]
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
986
            with self.assertParseError():
987
                self.check_option_syntax(options)
988
989
    def test_dump_json_conflicts_with_verbose(self):
990
        options = self.parser.parse_args()
991
        options.dump_json = True
992
        options.verbose = True
993
        with self.assertParseError():
994
            self.check_option_syntax(options)
995
996
    def test_dump_json_conflicts_with_action(self):
997
        for action, value in self.actions.items():
998
            options = self.parser.parse_args()
999
            setattr(options, action, value)
1000
            options.dump_json = True
1001
            with self.assertParseError():
1002
                self.check_option_syntax(options)
1003
1004
    def test_all_can_not_be_alone(self):
1005
        options = self.parser.parse_args()
1006
        options.all = True
1007
        with self.assertParseError():
1008
            self.check_option_syntax(options)
1009
1010
    def test_all_is_ok_with_any_action(self):
1011
        for action, value in self.actions.items():
1012
            options = self.parser.parse_args()
1013
            setattr(options, action, value)
1014
            options.all = True
1015
            self.check_option_syntax(options)
1016
237.7.623 by Teddy Hogeborn
mandos-ctl: Refactor and fix bug in tests.
1017
    def test_any_action_is_ok_with_one_client(self):
1018
        for action, value in self.actions.items():
1019
            options = self.parser.parse_args()
1020
            setattr(options, action, value)
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1021
            options.client = ["client"]
237.7.623 by Teddy Hogeborn
mandos-ctl: Refactor and fix bug in tests.
1022
            self.check_option_syntax(options)
1023
237.7.624 by Teddy Hogeborn
mandos-ctl: Refactor and add a few more tests
1024
    def test_one_client_with_all_actions_except_is_enabled(self):
1025
        options = self.parser.parse_args()
1026
        for action, value in self.actions.items():
1027
            if action == "is_enabled":
1028
                continue
1029
            setattr(options, action, value)
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1030
        options.client = ["client"]
237.7.624 by Teddy Hogeborn
mandos-ctl: Refactor and add a few more tests
1031
        self.check_option_syntax(options)
1032
1033
    def test_two_clients_with_all_actions_except_is_enabled(self):
1034
        options = self.parser.parse_args()
1035
        for action, value in self.actions.items():
1036
            if action == "is_enabled":
1037
                continue
1038
            setattr(options, action, value)
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1039
        options.client = ["client1", "client2"]
237.7.624 by Teddy Hogeborn
mandos-ctl: Refactor and add a few more tests
1040
        self.check_option_syntax(options)
1041
1042
    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.
1043
        for action, value in self.actions.items():
1044
            if action == "is_enabled":
1045
                continue
1046
            options = self.parser.parse_args()
1047
            setattr(options, action, value)
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1048
            options.client = ["client1", "client2"]
237.7.623 by Teddy Hogeborn
mandos-ctl: Refactor and fix bug in tests.
1049
            self.check_option_syntax(options)
1050
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1051
    def test_is_enabled_fails_without_client(self):
1052
        options = self.parser.parse_args()
1053
        options.is_enabled = True
1054
        with self.assertParseError():
1055
            self.check_option_syntax(options)
1056
1057
    def test_is_enabled_fails_with_two_clients(self):
1058
        options = self.parser.parse_args()
1059
        options.is_enabled = True
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1060
        options.client = ["client1", "client2"]
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1061
        with self.assertParseError():
1062
            self.check_option_syntax(options)
1063
1064
    def test_remove_can_only_be_combined_with_action_deny(self):
1065
        for action, value in self.actions.items():
1066
            if action in {"remove", "deny"}:
1067
                continue
1068
            options = self.parser.parse_args()
1069
            setattr(options, action, value)
1070
            options.all = True
1071
            options.remove = True
1072
            with self.assertParseError():
1073
                self.check_option_syntax(options)
1074
1075
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1076
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
237.7.616 by Teddy Hogeborn
mandos-ctl: Refactor
1077
    def test_calls_and_returns_get_object_on_bus(self):
1078
        class MockBus(object):
1079
            called = False
1080
            def get_object(mockbus_self, busname, dbus_path):
1081
                # Note that "self" is still the testcase instance,
1082
                # this MockBus instance is in "mockbus_self".
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1083
                self.assertEqual(dbus_busname, busname)
1084
                self.assertEqual(server_dbus_path, dbus_path)
237.7.616 by Teddy Hogeborn
mandos-ctl: Refactor
1085
                mockbus_self.called = True
1086
                return mockbus_self
1087
1088
        mockbus = get_mandos_dbus_object(bus=MockBus())
1089
        self.assertIsInstance(mockbus, MockBus)
1090
        self.assertTrue(mockbus.called)
1091
1092
    def test_logs_and_exits_on_dbus_error(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1093
        class FailingBusStub(object):
237.7.616 by Teddy Hogeborn
mandos-ctl: Refactor
1094
            def get_object(self, busname, dbus_path):
1095
                raise dbus.exceptions.DBusException("Test")
1096
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1097
        with self.assertLogs(log, logging.CRITICAL):
1098
            with self.assertRaises(SystemExit) as e:
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1099
                bus = get_mandos_dbus_object(bus=FailingBusStub())
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1100
237.7.616 by Teddy Hogeborn
mandos-ctl: Refactor
1101
        if isinstance(e.exception.code, int):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1102
            self.assertNotEqual(0, e.exception.code)
237.7.616 by Teddy Hogeborn
mandos-ctl: Refactor
1103
        else:
1104
            self.assertIsNotNone(e.exception.code)
1105
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1106
1107
class Test_get_managed_objects(TestCaseWithAssertLogs):
237.7.618 by Teddy Hogeborn
mandos-ctl: Refactor
1108
    def test_calls_and_returns_GetManagedObjects(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1109
        managed_objects = {"/clients/client": { "Name": "client"}}
1110
        class ObjectManagerStub(object):
237.7.621 by Teddy Hogeborn
mandos-ctl: Refactor tests
1111
            def GetManagedObjects(self):
237.7.618 by Teddy Hogeborn
mandos-ctl: Refactor
1112
                return managed_objects
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1113
        retval = get_managed_objects(ObjectManagerStub())
237.7.618 by Teddy Hogeborn
mandos-ctl: Refactor
1114
        self.assertDictEqual(managed_objects, retval)
1115
1116
    def test_logs_and_exits_on_dbus_error(self):
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1117
        dbus_logger = logging.getLogger("dbus.proxies")
1118
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1119
        class ObjectManagerFailingStub(object):
237.7.621 by Teddy Hogeborn
mandos-ctl: Refactor tests
1120
            def GetManagedObjects(self):
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1121
                dbus_logger.error("Test")
237.7.618 by Teddy Hogeborn
mandos-ctl: Refactor
1122
                raise dbus.exceptions.DBusException("Test")
1123
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1124
        class CountingHandler(logging.Handler):
1125
            count = 0
1126
            def emit(self, record):
1127
                self.count += 1
1128
1129
        counting_handler = CountingHandler()
1130
1131
        dbus_logger.addHandler(counting_handler)
1132
1133
        try:
1134
            with self.assertLogs(log, logging.CRITICAL) as watcher:
237.7.618 by Teddy Hogeborn
mandos-ctl: Refactor
1135
                with self.assertRaises(SystemExit) as e:
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1136
                    get_managed_objects(ObjectManagerFailingStub())
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1137
        finally:
1138
            dbus_logger.removeFilter(counting_handler)
237.7.622 by Teddy Hogeborn
mandos-ctl: Add comment
1139
1140
        # Make sure the dbus logger was suppressed
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1141
        self.assertEqual(0, counting_handler.count)
237.7.620 by Teddy Hogeborn
mandos-ctl: Refactor tests
1142
1143
        # Test that the dbus_logger still works
1144
        with self.assertLogs(dbus_logger, logging.ERROR):
1145
            dbus_logger.error("Test")
1146
237.7.618 by Teddy Hogeborn
mandos-ctl: Refactor
1147
        if isinstance(e.exception.code, int):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1148
            self.assertNotEqual(0, e.exception.code)
237.7.618 by Teddy Hogeborn
mandos-ctl: Refactor
1149
        else:
1150
            self.assertIsNotNone(e.exception.code)
1151
237.7.614 by Teddy Hogeborn
mandos-ctl: Refactor
1152
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1153
class Test_commands_from_options(unittest.TestCase):
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1154
    def setUp(self):
1155
        self.parser = argparse.ArgumentParser()
1156
        add_command_line_options(self.parser)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1157
1158
    def test_is_enabled(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1159
        self.assert_command_from_args(["--is-enabled", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1160
                                      command.IsEnabled)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1161
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1162
    def assert_command_from_args(self, args, command_cls,
1163
                                 **cmd_attrs):
1164
        """Assert that parsing ARGS should result in an instance of
1165
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1166
        options = self.parser.parse_args(args)
1167
        check_option_syntax(self.parser, options)
1168
        commands = commands_from_options(options)
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1169
        self.assertEqual(1, len(commands))
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1170
        command = commands[0]
1171
        self.assertIsInstance(command, command_cls)
1172
        for key, value in cmd_attrs.items():
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1173
            self.assertEqual(value, getattr(command, key))
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1174
1175
    def test_is_enabled_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1176
        self.assert_command_from_args(["-V", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1177
                                      command.IsEnabled)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1178
1179
    def test_approve(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1180
        self.assert_command_from_args(["--approve", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1181
                                      command.Approve)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1182
1183
    def test_approve_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1184
        self.assert_command_from_args(["-A", "client"],
1185
                                      command.Approve)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1186
1187
    def test_deny(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1188
        self.assert_command_from_args(["--deny", "client"],
1189
                                      command.Deny)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1190
1191
    def test_deny_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1192
        self.assert_command_from_args(["-D", "client"], command.Deny)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1193
1194
    def test_remove(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1195
        self.assert_command_from_args(["--remove", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1196
                                      command.Remove)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1197
1198
    def test_deny_before_remove(self):
1199
        options = self.parser.parse_args(["--deny", "--remove",
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1200
                                          "client"])
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1201
        check_option_syntax(self.parser, options)
1202
        commands = commands_from_options(options)
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1203
        self.assertEqual(2, len(commands))
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1204
        self.assertIsInstance(commands[0], command.Deny)
1205
        self.assertIsInstance(commands[1], command.Remove)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1206
1207
    def test_deny_before_remove_reversed(self):
1208
        options = self.parser.parse_args(["--remove", "--deny",
1209
                                          "--all"])
1210
        check_option_syntax(self.parser, options)
1211
        commands = commands_from_options(options)
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1212
        self.assertEqual(2, len(commands))
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1213
        self.assertIsInstance(commands[0], command.Deny)
1214
        self.assertIsInstance(commands[1], command.Remove)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1215
1216
    def test_remove_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1217
        self.assert_command_from_args(["-r", "client"],
1218
                                      command.Remove)
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1219
1220
    def test_dump_json(self):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1221
        self.assert_command_from_args(["--dump-json"],
1222
                                      command.DumpJSON)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1223
1224
    def test_enable(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1225
        self.assert_command_from_args(["--enable", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1226
                                      command.Enable)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1227
1228
    def test_enable_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1229
        self.assert_command_from_args(["-e", "client"],
1230
                                      command.Enable)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1231
1232
    def test_disable(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1233
        self.assert_command_from_args(["--disable", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1234
                                      command.Disable)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1235
1236
    def test_disable_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1237
        self.assert_command_from_args(["-d", "client"],
1238
                                      command.Disable)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1239
1240
    def test_bump_timeout(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1241
        self.assert_command_from_args(["--bump-timeout", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1242
                                      command.BumpTimeout)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1243
1244
    def test_bump_timeout_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1245
        self.assert_command_from_args(["-b", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1246
                                      command.BumpTimeout)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1247
1248
    def test_start_checker(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1249
        self.assert_command_from_args(["--start-checker", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1250
                                      command.StartChecker)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1251
1252
    def test_stop_checker(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1253
        self.assert_command_from_args(["--stop-checker", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1254
                                      command.StopChecker)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1255
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1256
    def test_approve_by_default(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1257
        self.assert_command_from_args(["--approve-by-default",
1258
                                       "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1259
                                      command.ApproveByDefault)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1260
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1261
    def test_deny_by_default(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1262
        self.assert_command_from_args(["--deny-by-default", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1263
                                      command.DenyByDefault)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1264
1265
    def test_checker(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1266
        self.assert_command_from_args(["--checker", ":", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1267
                                      command.SetChecker,
1268
                                      value_to_set=":")
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1269
1270
    def test_checker_empty(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1271
        self.assert_command_from_args(["--checker", "", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1272
                                      command.SetChecker,
1273
                                      value_to_set="")
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1274
1275
    def test_checker_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1276
        self.assert_command_from_args(["-c", ":", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1277
                                      command.SetChecker,
1278
                                      value_to_set=":")
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1279
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1280
    def test_host(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1281
        self.assert_command_from_args(
1282
            ["--host", "client.example.org", "client"],
1283
            command.SetHost, value_to_set="client.example.org")
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1284
1285
    def test_host_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1286
        self.assert_command_from_args(
1287
            ["-H", "client.example.org", "client"], command.SetHost,
1288
            value_to_set="client.example.org")
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1289
1290
    def test_secret_devnull(self):
1291
        self.assert_command_from_args(["--secret", os.path.devnull,
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1292
                                       "client"], command.SetSecret,
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1293
                                      value_to_set=b"")
1294
1295
    def test_secret_tempfile(self):
1296
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1297
            value = b"secret\0xyzzy\nbar"
1298
            f.write(value)
1299
            f.seek(0)
1300
            self.assert_command_from_args(["--secret", f.name,
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1301
                                           "client"],
1302
                                          command.SetSecret,
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1303
                                          value_to_set=value)
1304
1305
    def test_secret_devnull_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1306
        self.assert_command_from_args(["-s", os.path.devnull,
1307
                                       "client"], command.SetSecret,
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1308
                                      value_to_set=b"")
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1309
1310
    def test_secret_tempfile_short(self):
1311
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1312
            value = b"secret\0xyzzy\nbar"
1313
            f.write(value)
1314
            f.seek(0)
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1315
            self.assert_command_from_args(["-s", f.name, "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1316
                                          command.SetSecret,
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1317
                                          value_to_set=value)
1318
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1319
    def test_timeout(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1320
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1321
                                      command.SetTimeout,
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1322
                                      value_to_set=300000)
1323
1324
    def test_timeout_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1325
        self.assert_command_from_args(["-t", "PT5M", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1326
                                      command.SetTimeout,
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1327
                                      value_to_set=300000)
1328
1329
    def test_extended_timeout(self):
1330
        self.assert_command_from_args(["--extended-timeout", "PT15M",
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1331
                                       "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1332
                                      command.SetExtendedTimeout,
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1333
                                      value_to_set=900000)
1334
1335
    def test_interval(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1336
        self.assert_command_from_args(["--interval", "PT2M",
1337
                                       "client"], command.SetInterval,
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1338
                                      value_to_set=120000)
1339
1340
    def test_interval_short(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1341
        self.assert_command_from_args(["-i", "PT2M", "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1342
                                      command.SetInterval,
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1343
                                      value_to_set=120000)
1344
1345
    def test_approval_delay(self):
1346
        self.assert_command_from_args(["--approval-delay", "PT30S",
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1347
                                       "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1348
                                      command.SetApprovalDelay,
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1349
                                      value_to_set=30000)
1350
1351
    def test_approval_duration(self):
1352
        self.assert_command_from_args(["--approval-duration", "PT1S",
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1353
                                       "client"],
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1354
                                      command.SetApprovalDuration,
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1355
                                      value_to_set=1000)
1356
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1357
    def test_print_table(self):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1358
        self.assert_command_from_args([], command.PrintTable,
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1359
                                      verbose=False)
1360
1361
    def test_print_table_verbose(self):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1362
        self.assert_command_from_args(["--verbose"],
1363
                                      command.PrintTable,
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1364
                                      verbose=True)
1365
1366
    def test_print_table_verbose_short(self):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1367
        self.assert_command_from_args(["-v"], command.PrintTable,
237.7.608 by Teddy Hogeborn
mandos-ctl: Refactor
1368
                                      verbose=True)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1369
1370
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1371
class TestCommand(unittest.TestCase):
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
1372
    """Abstract class for tests of command classes"""
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
1373
237.7.542 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
1374
    def setUp(self):
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
1375
        testcase = self
1376
        class MockClient(object):
1377
            def __init__(self, name, **attributes):
237.7.598 by Teddy Hogeborn
mandos-ctl: Minimize number of D-Bus calls
1378
                self.__dbus_object_path__ = "/clients/{}".format(name)
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
1379
                self.attributes = attributes
1380
                self.attributes["Name"] = name
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
1381
                self.calls = []
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1382
            def Set(self, interface, propname, value, dbus_interface):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1383
                testcase.assertEqual(client_dbus_interface, interface)
1384
                testcase.assertEqual(dbus.PROPERTIES_IFACE,
1385
                                     dbus_interface)
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1386
                self.attributes[propname] = value
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
1387
            def Approve(self, approve, dbus_interface):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1388
                testcase.assertEqual(client_dbus_interface,
1389
                                     dbus_interface)
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
1390
                self.calls.append(("Approve", (approve,
1391
                                               dbus_interface)))
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
1392
        self.client = MockClient(
1393
            "foo",
1394
            KeyID=("92ed150794387c03ce684574b1139a65"
1395
                   "94a34f895daaaf09fd8ea90a27cddb12"),
1396
            Secret=b"secret",
1397
            Host="foo.example.org",
1398
            Enabled=dbus.Boolean(True),
1399
            Timeout=300000,
1400
            LastCheckedOK="2019-02-03T00:00:00",
1401
            Created="2019-01-02T00:00:00",
1402
            Interval=120000,
1403
            Fingerprint=("778827225BA7DE539C5A"
1404
                         "7CFA59CFF7CDBD9A5920"),
1405
            CheckerRunning=dbus.Boolean(False),
1406
            LastEnabled="2019-01-03T00:00:00",
1407
            ApprovalPending=dbus.Boolean(False),
1408
            ApprovedByDefault=dbus.Boolean(True),
1409
            LastApprovalRequest="",
1410
            ApprovalDelay=0,
1411
            ApprovalDuration=1000,
1412
            Checker="fping -q -- %(host)s",
1413
            ExtendedTimeout=900000,
1414
            Expires="2019-02-04T00:00:00",
1415
            LastCheckerStatus=0)
1416
        self.other_client = MockClient(
1417
            "barbar",
1418
            KeyID=("0558568eedd67d622f5c83b35a115f79"
1419
                   "6ab612cff5ad227247e46c2b020f441c"),
1420
            Secret=b"secretbar",
1421
            Host="192.0.2.3",
1422
            Enabled=dbus.Boolean(True),
1423
            Timeout=300000,
1424
            LastCheckedOK="2019-02-04T00:00:00",
1425
            Created="2019-01-03T00:00:00",
1426
            Interval=120000,
1427
            Fingerprint=("3E393AEAEFB84C7E89E2"
1428
                         "F547B3A107558FCA3A27"),
1429
            CheckerRunning=dbus.Boolean(True),
1430
            LastEnabled="2019-01-04T00:00:00",
1431
            ApprovalPending=dbus.Boolean(False),
1432
            ApprovedByDefault=dbus.Boolean(False),
1433
            LastApprovalRequest="2019-01-03T00:00:00",
1434
            ApprovalDelay=30000,
237.7.604 by Teddy Hogeborn
mandos-ctl: Refactor
1435
            ApprovalDuration=93785000,
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
1436
            Checker=":",
1437
            ExtendedTimeout=900000,
1438
            Expires="2019-02-05T00:00:00",
1439
            LastCheckerStatus=-2)
1440
        self.clients =  collections.OrderedDict(
1441
            [
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1442
                (self.client.__dbus_object_path__,
1443
                 self.client.attributes),
1444
                (self.other_client.__dbus_object_path__,
1445
                 self.other_client.attributes),
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
1446
            ])
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1447
        self.one_client = {self.client.__dbus_object_path__:
1448
                           self.client.attributes}
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
1449
237.7.598 by Teddy Hogeborn
mandos-ctl: Minimize number of D-Bus calls
1450
    @property
1451
    def bus(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1452
        class MockBus(object):
237.7.598 by Teddy Hogeborn
mandos-ctl: Minimize number of D-Bus calls
1453
            @staticmethod
1454
            def get_object(client_bus_name, path):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1455
                self.assertEqual(dbus_busname, client_bus_name)
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1456
                # Note: "self" here is the TestCmd instance, not the
1457
                # MockBus instance, since this is a static method!
1458
                if path == self.client.__dbus_object_path__:
1459
                    return self.client
1460
                elif path == self.other_client.__dbus_object_path__:
1461
                    return self.other_client
1462
        return MockBus()
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
1463
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1464
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1465
class TestBaseCommands(TestCommand):
1466
237.7.629 by Teddy Hogeborn
mandos-ctl: Refactor tests
1467
    def test_IsEnabled_exits_successfully(self):
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1468
        with self.assertRaises(SystemExit) as e:
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1469
            command.IsEnabled().run(self.one_client)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1470
        if e.exception.code is not None:
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1471
            self.assertEqual(0, e.exception.code)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1472
        else:
1473
            self.assertIsNone(e.exception.code)
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
1474
237.7.629 by Teddy Hogeborn
mandos-ctl: Refactor tests
1475
    def test_IsEnabled_exits_with_failure(self):
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1476
        self.client.attributes["Enabled"] = dbus.Boolean(False)
1477
        with self.assertRaises(SystemExit) as e:
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1478
            command.IsEnabled().run(self.one_client)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1479
        if isinstance(e.exception.code, int):
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1480
            self.assertNotEqual(0, e.exception.code)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1481
        else:
1482
            self.assertIsNotNone(e.exception.code)
1483
237.7.627 by Teddy Hogeborn
mandos-ctl: Refactor
1484
    def test_Approve(self):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1485
        command.Approve().run(self.clients, self.bus)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1486
        for clientpath in self.clients:
1487
            client = self.bus.get_object(dbus_busname, clientpath)
1488
            self.assertIn(("Approve", (True, client_dbus_interface)),
1489
                          client.calls)
1490
237.7.627 by Teddy Hogeborn
mandos-ctl: Refactor
1491
    def test_Deny(self):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1492
        command.Deny().run(self.clients, self.bus)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1493
        for clientpath in self.clients:
1494
            client = self.bus.get_object(dbus_busname, clientpath)
1495
            self.assertIn(("Approve", (False, client_dbus_interface)),
1496
                          client.calls)
1497
237.7.627 by Teddy Hogeborn
mandos-ctl: Refactor
1498
    def test_Remove(self):
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1499
        class MandosSpy(object):
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1500
            def __init__(self):
1501
                self.calls = []
1502
            def RemoveClient(self, dbus_path):
1503
                self.calls.append(("RemoveClient", (dbus_path,)))
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1504
        mandos = MandosSpy()
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1505
        command.Remove().run(self.clients, self.bus, mandos)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1506
        for clientpath in self.clients:
1507
            self.assertIn(("RemoveClient", (clientpath,)),
1508
                          mandos.calls)
1509
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1510
    expected_json = {
1511
        "foo": {
1512
            "Name": "foo",
1513
            "KeyID": ("92ed150794387c03ce684574b1139a65"
1514
                      "94a34f895daaaf09fd8ea90a27cddb12"),
1515
            "Host": "foo.example.org",
1516
            "Enabled": True,
1517
            "Timeout": 300000,
1518
            "LastCheckedOK": "2019-02-03T00:00:00",
1519
            "Created": "2019-01-02T00:00:00",
1520
            "Interval": 120000,
1521
            "Fingerprint": ("778827225BA7DE539C5A"
1522
                            "7CFA59CFF7CDBD9A5920"),
1523
            "CheckerRunning": False,
1524
            "LastEnabled": "2019-01-03T00:00:00",
1525
            "ApprovalPending": False,
1526
            "ApprovedByDefault": True,
1527
            "LastApprovalRequest": "",
1528
            "ApprovalDelay": 0,
1529
            "ApprovalDuration": 1000,
1530
            "Checker": "fping -q -- %(host)s",
1531
            "ExtendedTimeout": 900000,
1532
            "Expires": "2019-02-04T00:00:00",
1533
            "LastCheckerStatus": 0,
1534
        },
1535
        "barbar": {
1536
            "Name": "barbar",
1537
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
1538
                      "6ab612cff5ad227247e46c2b020f441c"),
1539
            "Host": "192.0.2.3",
1540
            "Enabled": True,
1541
            "Timeout": 300000,
1542
            "LastCheckedOK": "2019-02-04T00:00:00",
1543
            "Created": "2019-01-03T00:00:00",
1544
            "Interval": 120000,
1545
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
1546
                            "F547B3A107558FCA3A27"),
1547
            "CheckerRunning": True,
1548
            "LastEnabled": "2019-01-04T00:00:00",
1549
            "ApprovalPending": False,
1550
            "ApprovedByDefault": False,
1551
            "LastApprovalRequest": "2019-01-03T00:00:00",
1552
            "ApprovalDelay": 30000,
1553
            "ApprovalDuration": 93785000,
1554
            "Checker": ":",
1555
            "ExtendedTimeout": 900000,
1556
            "Expires": "2019-02-05T00:00:00",
1557
            "LastCheckerStatus": -2,
1558
        },
1559
    }
1560
1561
    def test_DumpJSON_normal(self):
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1562
        with self.capture_stdout_to_buffer() as buffer:
1563
            command.DumpJSON().run(self.clients)
1564
        json_data = json.loads(buffer.getvalue())
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1565
        self.assertDictEqual(self.expected_json, json_data)
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
1566
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1567
    @staticmethod
1568
    @contextlib.contextmanager
1569
    def capture_stdout_to_buffer():
1570
        capture_buffer = io.StringIO()
1571
        old_stdout = sys.stdout
1572
        sys.stdout = capture_buffer
1573
        try:
1574
            yield capture_buffer
1575
        finally:
1576
            sys.stdout = old_stdout
1577
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1578
    def test_DumpJSON_one_client(self):
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1579
        with self.capture_stdout_to_buffer() as buffer:
1580
            command.DumpJSON().run(self.one_client)
1581
        json_data = json.loads(buffer.getvalue())
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1582
        expected_json = {"foo": self.expected_json["foo"]}
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1583
        self.assertDictEqual(expected_json, json_data)
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1584
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1585
    def test_PrintTable_normal(self):
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1586
        with self.capture_stdout_to_buffer() as buffer:
1587
            command.PrintTable().run(self.clients)
237.7.601 by Teddy Hogeborn
mandos-ctl: White space and other non-semantic changes only
1588
        expected_output = "\n".join((
1589
            "Name   Enabled Timeout  Last Successful Check",
1590
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1591
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1592
        )) + "\n"
1593
        self.assertEqual(expected_output, buffer.getvalue())
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
1594
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1595
    def test_PrintTable_verbose(self):
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1596
        with self.capture_stdout_to_buffer() as buffer:
1597
            command.PrintTable(verbose=True).run(self.clients)
237.7.602 by Teddy Hogeborn
mandos-ctl: Refactor
1598
        columns = (
1599
            (
1600
                "Name   ",
1601
                "foo    ",
1602
                "barbar ",
1603
            ),(
1604
                "Enabled ",
1605
                "Yes     ",
1606
                "Yes     ",
1607
            ),(
1608
                "Timeout  ",
1609
                "00:05:00 ",
1610
                "00:05:00 ",
1611
            ),(
1612
                "Last Successful Check ",
1613
                "2019-02-03T00:00:00   ",
1614
                "2019-02-04T00:00:00   ",
1615
            ),(
1616
                "Created             ",
1617
                "2019-01-02T00:00:00 ",
1618
                "2019-01-03T00:00:00 ",
1619
            ),(
1620
                "Interval ",
1621
                "00:02:00 ",
1622
                "00:02:00 ",
1623
            ),(
1624
                "Host            ",
1625
                "foo.example.org ",
1626
                "192.0.2.3       ",
1627
            ),(
1628
                ("Key ID                                             "
1629
                 "              "),
1630
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1631
                 "ea90a27cddb12 "),
1632
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1633
                 "46c2b020f441c "),
1634
            ),(
1635
                "Fingerprint                              ",
1636
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1637
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1638
            ),(
1639
                "Check Is Running ",
1640
                "No               ",
1641
                "Yes              ",
1642
            ),(
1643
                "Last Enabled        ",
1644
                "2019-01-03T00:00:00 ",
1645
                "2019-01-04T00:00:00 ",
1646
            ),(
1647
                "Approval Is Pending ",
1648
                "No                  ",
1649
                "No                  ",
1650
            ),(
1651
                "Approved By Default ",
1652
                "Yes                 ",
1653
                "No                  ",
1654
            ),(
1655
                "Last Approval Request ",
1656
                "                      ",
1657
                "2019-01-03T00:00:00   ",
1658
            ),(
1659
                "Approval Delay ",
1660
                "00:00:00       ",
1661
                "00:00:30       ",
1662
            ),(
1663
                "Approval Duration ",
1664
                "00:00:01          ",
237.7.604 by Teddy Hogeborn
mandos-ctl: Refactor
1665
                "1T02:03:05        ",
237.7.602 by Teddy Hogeborn
mandos-ctl: Refactor
1666
            ),(
1667
                "Checker              ",
1668
                "fping -q -- %(host)s ",
1669
                ":                    ",
1670
            ),(
1671
                "Extended Timeout ",
1672
                "00:15:00         ",
1673
                "00:15:00         ",
1674
            ),(
1675
                "Expires             ",
1676
                "2019-02-04T00:00:00 ",
1677
                "2019-02-05T00:00:00 ",
1678
            ),(
1679
                "Last Checker Status",
1680
                "0                  ",
1681
                "-2                 ",
1682
            )
1683
        )
1684
        num_lines = max(len(rows) for rows in columns)
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1685
        expected_output = ("\n".join("".join(rows[line]
1686
                                             for rows in columns)
1687
                                     for line in range(num_lines))
1688
                           + "\n")
1689
        self.assertEqual(expected_output, buffer.getvalue())
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
1690
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1691
    def test_PrintTable_one_client(self):
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1692
        with self.capture_stdout_to_buffer() as buffer:
1693
            command.PrintTable().run(self.one_client)
237.7.605 by Teddy Hogeborn
mandos-ctl: Refactor
1694
        expected_output = "\n".join((
1695
            "Name Enabled Timeout  Last Successful Check",
1696
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
237.7.632 by Teddy Hogeborn
mandos-ctl: Refactor tests
1697
        )) + "\n"
1698
        self.assertEqual(expected_output, buffer.getvalue())
237.7.542 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
1699
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1700
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1701
class TestPropertySetterCmd(TestCommand):
1702
    """Abstract class for tests of command.PropertySetter classes"""
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1703
    def runTest(self):
1704
        if not hasattr(self, "command"):
1705
            return
1706
        values_to_get = getattr(self, "values_to_get",
1707
                                self.values_to_set)
1708
        for value_to_set, value_to_get in zip(self.values_to_set,
1709
                                              values_to_get):
237.7.598 by Teddy Hogeborn
mandos-ctl: Minimize number of D-Bus calls
1710
            for clientpath in self.clients:
237.7.600 by Teddy Hogeborn
mandos-ctl: Refactor
1711
                client = self.bus.get_object(dbus_busname, clientpath)
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1712
                old_value = client.attributes[self.propname]
237.7.610 by Teddy Hogeborn
mandos-ctl: Refactor
1713
                client.attributes[self.propname] = self.Unique()
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1714
            self.run_command(value_to_set, self.clients)
237.7.598 by Teddy Hogeborn
mandos-ctl: Minimize number of D-Bus calls
1715
            for clientpath in self.clients:
237.7.600 by Teddy Hogeborn
mandos-ctl: Refactor
1716
                client = self.bus.get_object(dbus_busname, clientpath)
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1717
                value = client.attributes[self.propname]
237.7.610 by Teddy Hogeborn
mandos-ctl: Refactor
1718
                self.assertNotIsInstance(value, self.Unique)
237.7.630 by Teddy Hogeborn
mandos-ctl: Refactor tests
1719
                self.assertEqual(value_to_get, value)
237.7.610 by Teddy Hogeborn
mandos-ctl: Refactor
1720
1721
    class Unique(object):
1722
        """Class for objects which exist only to be unique objects,
1723
since unittest.mock.sentinel only exists in Python 3.3"""
1724
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1725
    def run_command(self, value, clients):
237.7.598 by Teddy Hogeborn
mandos-ctl: Minimize number of D-Bus calls
1726
        self.command().run(clients, self.bus)
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1727
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1728
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1729
class TestEnableCmd(TestPropertySetterCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1730
    command = command.Enable
237.7.607 by Teddy Hogeborn
mandos-ctl: Refactor
1731
    propname = "Enabled"
1732
    values_to_set = [dbus.Boolean(True)]
1733
1734
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1735
class TestDisableCmd(TestPropertySetterCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1736
    command = command.Disable
237.7.607 by Teddy Hogeborn
mandos-ctl: Refactor
1737
    propname = "Enabled"
1738
    values_to_set = [dbus.Boolean(False)]
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1739
1740
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1741
class TestBumpTimeoutCmd(TestPropertySetterCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1742
    command = command.BumpTimeout
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1743
    propname = "LastCheckedOK"
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1744
    values_to_set = [""]
1745
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1746
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1747
class TestStartCheckerCmd(TestPropertySetterCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1748
    command = command.StartChecker
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1749
    propname = "CheckerRunning"
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1750
    values_to_set = [dbus.Boolean(True)]
1751
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1752
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1753
class TestStopCheckerCmd(TestPropertySetterCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1754
    command = command.StopChecker
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1755
    propname = "CheckerRunning"
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1756
    values_to_set = [dbus.Boolean(False)]
1757
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1758
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1759
class TestApproveByDefaultCmd(TestPropertySetterCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1760
    command = command.ApproveByDefault
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1761
    propname = "ApprovedByDefault"
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1762
    values_to_set = [dbus.Boolean(True)]
1763
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1764
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1765
class TestDenyByDefaultCmd(TestPropertySetterCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1766
    command = command.DenyByDefault
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1767
    propname = "ApprovedByDefault"
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1768
    values_to_set = [dbus.Boolean(False)]
1769
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1770
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1771
class TestPropertySetterValueCmd(TestPropertySetterCmd):
1772
    """Abstract class for tests of PropertySetterValueCmd classes"""
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
1773
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1774
    def runTest(self):
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1775
        if type(self) is TestPropertySetterValueCmd:
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1776
            return
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1777
        return super(TestPropertySetterValueCmd, self).runTest()
237.7.609 by Teddy Hogeborn
mandos-ctl: White space changes only
1778
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1779
    def run_command(self, value, clients):
237.7.598 by Teddy Hogeborn
mandos-ctl: Minimize number of D-Bus calls
1780
        self.command(value).run(clients, self.bus)
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1781
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1782
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1783
class TestSetCheckerCmd(TestPropertySetterValueCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1784
    command = command.SetChecker
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1785
    propname = "Checker"
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1786
    values_to_set = ["", ":", "fping -q -- %s"]
1787
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1788
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1789
class TestSetHostCmd(TestPropertySetterValueCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1790
    command = command.SetHost
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1791
    propname = "Host"
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1792
    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
1793
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1794
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1795
class TestSetSecretCmd(TestPropertySetterValueCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1796
    command = command.SetSecret
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1797
    propname = "Secret"
237.7.590 by Teddy Hogeborn
mandos-ctl: Bug fix: close an open file
1798
    values_to_set = [io.BytesIO(b""),
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
1799
                     io.BytesIO(b"secret\0xyzzy\nbar")]
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1800
    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
1801
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1802
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1803
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1804
    command = command.SetTimeout
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1805
    propname = "Timeout"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1806
    values_to_set = [datetime.timedelta(),
1807
                     datetime.timedelta(minutes=5),
1808
                     datetime.timedelta(seconds=1),
1809
                     datetime.timedelta(weeks=1),
1810
                     datetime.timedelta(weeks=52)]
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1811
    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
1812
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1813
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1814
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1815
    command = command.SetExtendedTimeout
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1816
    propname = "ExtendedTimeout"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1817
    values_to_set = [datetime.timedelta(),
1818
                     datetime.timedelta(minutes=5),
1819
                     datetime.timedelta(seconds=1),
1820
                     datetime.timedelta(weeks=1),
1821
                     datetime.timedelta(weeks=52)]
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1822
    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
1823
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1824
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1825
class TestSetIntervalCmd(TestPropertySetterValueCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1826
    command = command.SetInterval
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1827
    propname = "Interval"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1828
    values_to_set = [datetime.timedelta(),
1829
                     datetime.timedelta(minutes=5),
1830
                     datetime.timedelta(seconds=1),
1831
                     datetime.timedelta(weeks=1),
1832
                     datetime.timedelta(weeks=52)]
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1833
    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
1834
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1835
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1836
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1837
    command = command.SetApprovalDelay
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1838
    propname = "ApprovalDelay"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1839
    values_to_set = [datetime.timedelta(),
1840
                     datetime.timedelta(minutes=5),
1841
                     datetime.timedelta(seconds=1),
1842
                     datetime.timedelta(weeks=1),
1843
                     datetime.timedelta(weeks=52)]
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1844
    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
1845
237.7.603 by Teddy Hogeborn
mandos-ctl: Refactor
1846
237.7.635 by Teddy Hogeborn
mandos-ctl: Refactor
1847
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
237.7.625 by Teddy Hogeborn
mandos-ctl: Refactor
1848
    command = command.SetApprovalDuration
237.7.595 by Teddy Hogeborn
mandos-ctl: Refactor
1849
    propname = "ApprovalDuration"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1850
    values_to_set = [datetime.timedelta(),
1851
                     datetime.timedelta(minutes=5),
1852
                     datetime.timedelta(seconds=1),
1853
                     datetime.timedelta(weeks=1),
1854
                     datetime.timedelta(weeks=52)]
237.7.634 by Teddy Hogeborn
mandos-ctl: Refactor tests
1855
    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
1856
237.7.589 by Teddy Hogeborn
mandos-ctl: Add tests for option syntax checks
1857
237.7.534 by Teddy Hogeborn
Add tests to mandos-ctl's milliseconds_to_string function
1858

237.7.532 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
1859
def should_only_run_tests():
1860
    parser = argparse.ArgumentParser(add_help=False)
1861
    parser.add_argument("--check", action='store_true')
1862
    args, unknown_args = parser.parse_known_args()
1863
    run_tests = args.check
1864
    if run_tests:
1865
        # Remove --check argument from sys.argv
1866
        sys.argv[1:] = unknown_args
1867
    return run_tests
1868
1869
# Add all tests from doctest strings
1870
def load_tests(loader, tests, none):
1871
    import doctest
1872
    tests.addTests(doctest.DocTestSuite())
1873
    return tests
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
1874
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
1875
if __name__ == "__main__":
237.7.615 by Teddy Hogeborn
mandos-ctl: Bug fix: always shutdown logging.
1876
    try:
1877
        if should_only_run_tests():
1878
            # Call using ./tdd-python-script --check [--verbose]
1879
            unittest.main()
1880
        else:
1881
            main()
1882
    finally:
1883
        logging.shutdown()