/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.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
47
48
import dbus
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
49
237.7.536 by Teddy Hogeborn
mandos-ctl: Show warnings
50
# Show warnings by default
51
if not sys.warnoptions:
52
    import warnings
53
    warnings.simplefilter("default")
54
237.7.535 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
55
log = logging.getLogger(sys.argv[0])
56
logging.basicConfig(level="INFO", # Show info level messages
57
                    format="%(message)s") # Show basic log messages
58
237.7.536 by Teddy Hogeborn
mandos-ctl: Show warnings
59
logging.captureWarnings(True)   # Show warnings via the logging system
60
237.23.7 by Teddy Hogeborn
Use the .major attribute on sys.version_info instead of using "[0]".
61
if sys.version_info.major == 2:
237.7.266 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
62
    str = unicode
63
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
64
locale.setlocale(locale.LC_ALL, "")
24.1.116 by Björn Påhlsson
added a mandos list client program
65
24.1.186 by Björn Påhlsson
transitional stuff actually working
66
domain = "se.recompile"
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
67
busname = domain + ".Mandos"
68
server_path = "/"
69
server_interface = domain + ".Mandos"
70
client_interface = domain + ".Mandos.Client"
377 by Teddy Hogeborn
* Makefile (version): Change to 1.8.3.
71
version = "1.8.3"
24.1.118 by Björn Påhlsson
Added enable/disable
72
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
73
237.7.333 by Teddy Hogeborn
Support the standard org.freedesktop.DBus.ObjectManager interface.
74
try:
75
    dbus.OBJECT_MANAGER_IFACE
76
except AttributeError:
77
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
78
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
79
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
80
def milliseconds_to_string(ms):
81
    td = datetime.timedelta(0, 0, 0, ms)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
82
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
83
            .format(days="{}T".format(td.days) if td.days else "",
84
                    hours=td.seconds // 3600,
85
                    minutes=(td.seconds % 3600) // 60,
86
                    seconds=td.seconds % 60))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
87
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
88
89
def rfc3339_duration_to_delta(duration):
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
90
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
91
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
92
    >>> rfc3339_duration_to_delta("P7D")
93
    datetime.timedelta(7)
94
    >>> rfc3339_duration_to_delta("PT60S")
95
    datetime.timedelta(0, 60)
96
    >>> rfc3339_duration_to_delta("PT60M")
97
    datetime.timedelta(0, 3600)
237.7.538 by Teddy Hogeborn
mandos-ctl (rfc3339_duration_to_delta): Improve tests
98
    >>> rfc3339_duration_to_delta("P60M")
99
    datetime.timedelta(1680)
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
100
    >>> rfc3339_duration_to_delta("PT24H")
101
    datetime.timedelta(1)
102
    >>> rfc3339_duration_to_delta("P1W")
103
    datetime.timedelta(7)
104
    >>> rfc3339_duration_to_delta("PT5M30S")
105
    datetime.timedelta(0, 330)
106
    >>> rfc3339_duration_to_delta("P1DT3M20S")
107
    datetime.timedelta(1, 200)
237.7.538 by Teddy Hogeborn
mandos-ctl (rfc3339_duration_to_delta): Improve tests
108
    >>> # Can not be empty:
109
    >>> rfc3339_duration_to_delta("")
110
    Traceback (most recent call last):
111
    ...
112
    ValueError: Invalid RFC 3339 duration: u''
113
    >>> # Must start with "P":
114
    >>> rfc3339_duration_to_delta("1D")
115
    Traceback (most recent call last):
116
    ...
117
    ValueError: Invalid RFC 3339 duration: u'1D'
118
    >>> # Must use correct order
119
    >>> rfc3339_duration_to_delta("PT1S2M")
120
    Traceback (most recent call last):
121
    ...
122
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
123
    >>> # Time needs time marker
124
    >>> rfc3339_duration_to_delta("P1H2S")
125
    Traceback (most recent call last):
126
    ...
127
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
128
    >>> # Weeks can not be combined with anything else
129
    >>> rfc3339_duration_to_delta("P1D2W")
130
    Traceback (most recent call last):
131
    ...
132
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
133
    >>> rfc3339_duration_to_delta("P2W2H")
134
    Traceback (most recent call last):
135
    ...
136
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
137
    """
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
138
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
139
    # Parsing an RFC 3339 duration with regular expressions is not
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
140
    # 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.
141
    # values, like seconds.  The current code, while more esoteric, is
142
    # cleaner without depending on a parsing library.  If Python had a
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
143
    # built-in library for parsing we would use it, but we'd like to
144
    # avoid excessive use of external libraries.
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
145
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
146
    # New type for defining tokens, syntax, and semantics all-in-one
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
147
    Token = collections.namedtuple("Token", (
148
        "regexp",  # To match token; if "value" is not None, must have
149
                   # a "group" containing digits
150
        "value",   # datetime.timedelta or None
151
        "followers"))           # Tokens valid after this token
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
152
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
153
    # the "duration" ABNF definition in RFC 3339, Appendix A.
154
    token_end = Token(re.compile(r"$"), None, frozenset())
155
    token_second = Token(re.compile(r"(\d+)S"),
156
                         datetime.timedelta(seconds=1),
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
157
                         frozenset((token_end, )))
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
158
    token_minute = Token(re.compile(r"(\d+)M"),
159
                         datetime.timedelta(minutes=1),
160
                         frozenset((token_second, token_end)))
161
    token_hour = Token(re.compile(r"(\d+)H"),
162
                       datetime.timedelta(hours=1),
163
                       frozenset((token_minute, token_end)))
164
    token_time = Token(re.compile(r"T"),
165
                       None,
166
                       frozenset((token_hour, token_minute,
167
                                  token_second)))
168
    token_day = Token(re.compile(r"(\d+)D"),
169
                      datetime.timedelta(days=1),
170
                      frozenset((token_time, token_end)))
171
    token_month = Token(re.compile(r"(\d+)M"),
172
                        datetime.timedelta(weeks=4),
173
                        frozenset((token_day, token_end)))
174
    token_year = Token(re.compile(r"(\d+)Y"),
175
                       datetime.timedelta(weeks=52),
176
                       frozenset((token_month, token_end)))
177
    token_week = Token(re.compile(r"(\d+)W"),
178
                       datetime.timedelta(weeks=1),
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
179
                       frozenset((token_end, )))
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
180
    token_duration = Token(re.compile(r"P"), None,
181
                           frozenset((token_year, token_month,
182
                                      token_day, token_time,
237.7.269 by Teddy Hogeborn
Fix two mutually cancelling bugs.
183
                                      token_week)))
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
184
    # Define starting values:
185
    # Value so far
186
    value = datetime.timedelta()
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
187
    found_token = None
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
188
    # Following valid tokens
189
    followers = frozenset((token_duration, ))
190
    # String left to parse
191
    s = duration
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
192
    # Loop until end token is found
193
    while found_token is not token_end:
194
        # Search for any currently valid tokens
195
        for token in followers:
196
            match = token.regexp.match(s)
197
            if match is not None:
198
                # Token found
199
                if token.value is not None:
200
                    # Value found, parse digits
201
                    factor = int(match.group(1), 10)
202
                    # Add to value so far
203
                    value += factor * token.value
204
                # Strip token from string
205
                s = token.regexp.sub("", s, 1)
206
                # Go to found token
207
                found_token = token
208
                # Set valid next tokens
209
                followers = found_token.followers
210
                break
211
        else:
212
            # No currently valid tokens were found
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
213
            raise ValueError("Invalid RFC 3339 duration: {!r}"
214
                             .format(duration))
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
215
    # End token found
216
    return value
217
218
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
219
def string_to_delta(interval):
237.7.549 by Teddy Hogeborn
mandos-ctl: White space changes only
220
    """Parse a string and return a datetime.timedelta"""
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
221
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
222
    try:
223
        return rfc3339_duration_to_delta(interval)
237.7.539 by Teddy Hogeborn
mandos-ctl: Refactor and add more tests
224
    except ValueError as e:
225
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
226
                    ' '.join(e.args))
227
    return parse_pre_1_6_1_interval(interval)
228
229
230
def parse_pre_1_6_1_interval(interval):
237.7.549 by Teddy Hogeborn
mandos-ctl: White space changes only
231
    """Parse an interval string as documented by Mandos before 1.6.1,
232
    and return a datetime.timedelta
233
237.7.539 by Teddy Hogeborn
mandos-ctl: Refactor and add more tests
234
    >>> parse_pre_1_6_1_interval('7d')
235
    datetime.timedelta(7)
236
    >>> parse_pre_1_6_1_interval('60s')
237
    datetime.timedelta(0, 60)
238
    >>> parse_pre_1_6_1_interval('60m')
239
    datetime.timedelta(0, 3600)
240
    >>> parse_pre_1_6_1_interval('24h')
241
    datetime.timedelta(1)
242
    >>> parse_pre_1_6_1_interval('1w')
243
    datetime.timedelta(7)
244
    >>> parse_pre_1_6_1_interval('5m 30s')
245
    datetime.timedelta(0, 330)
246
    >>> parse_pre_1_6_1_interval('')
247
    datetime.timedelta(0)
248
    >>> # Ignore unknown characters, allow any order and repetitions
249
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
250
    datetime.timedelta(2, 480, 18000)
251
252
    """
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
253
237.7.164 by Teddy Hogeborn
* mandos-ctl (string_to_delta): Try to parse RFC 3339 duration before
254
    value = datetime.timedelta(0)
255
    regexp = re.compile(r"(\d+)([dsmhw]?)")
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
256
237.14.9 by Teddy Hogeborn
* mandos (ClientDBus.approval_delay, ClientDBus.approval_duration,
257
    for num, suffix in regexp.findall(interval):
258
        if suffix == "d":
259
            value += datetime.timedelta(int(num))
260
        elif suffix == "s":
261
            value += datetime.timedelta(0, int(num))
262
        elif suffix == "m":
263
            value += datetime.timedelta(0, 0, 0, 0, int(num))
264
        elif suffix == "h":
265
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
266
        elif suffix == "w":
267
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
268
        elif suffix == "":
269
            value += datetime.timedelta(0, 0, 0, int(num))
270
    return value
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
271
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
272
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
273
## Classes for commands.
274
275
# Abstract classes first
276
class Command(object):
277
    """Abstract class for commands"""
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
278
    def run(self, mandos, clients):
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
279
        """Normal commands should implement run_on_one_client(), but
280
        commands which want to operate on all clients at the same time
281
        can override this run() method instead."""
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
282
        self.mandos = mandos
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
283
        for client, properties in clients.items():
284
            self.run_on_one_client(client, properties)
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
285
286
class PrintCmd(Command):
287
    """Abstract class for commands printing client details"""
288
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
289
                    "Created", "Interval", "Host", "KeyID",
290
                    "Fingerprint", "CheckerRunning", "LastEnabled",
291
                    "ApprovalPending", "ApprovedByDefault",
292
                    "LastApprovalRequest", "ApprovalDelay",
293
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
294
                    "Expires", "LastCheckerStatus")
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
295
    def run(self, mandos, clients):
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
296
        print(self.output(clients))
297
298
class PropertyCmd(Command):
299
    """Abstract class for Actions for setting one client property"""
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
300
    def run_on_one_client(self, client, properties):
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
301
        """Set the Client's D-Bus property"""
302
        client.Set(client_interface, self.property, self.value_to_set,
303
                   dbus_interface=dbus.PROPERTIES_IFACE)
304
305
class ValueArgumentMixIn(object):
306
    """Mixin class for commands taking a value as argument"""
307
    def __init__(self, value):
308
        self.value_to_set = value
309
310
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
311
    """Mixin class for commands taking a value argument as
312
    milliseconds."""
313
    @property
314
    def value_to_set(self):
315
        return self._vts
316
    @value_to_set.setter
317
    def value_to_set(self, value):
318
        """When setting, convert value to a datetime.timedelta"""
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
319
        self._vts = int(round(value.total_seconds() * 1000))
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
320
321
# Actual (non-abstract) command classes
322
323
class PrintTableCmd(PrintCmd):
324
    def __init__(self, verbose=False):
325
        self.verbose = verbose
237.7.559 by Teddy Hogeborn
mandos-ctl: Refactor; move TableOfClients into PrintTableCmd
326
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
327
    def output(self, clients):
237.7.571 by Teddy Hogeborn
mandos-ctl: Refactor
328
        default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
329
        keywords = default_keywords
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
330
        if self.verbose:
331
            keywords = self.all_keywords
237.7.559 by Teddy Hogeborn
mandos-ctl: Refactor; move TableOfClients into PrintTableCmd
332
        return str(self.TableOfClients(clients.values(), keywords))
333
334
    class TableOfClients(object):
335
        tableheaders = {
336
            "Name": "Name",
337
            "Enabled": "Enabled",
338
            "Timeout": "Timeout",
339
            "LastCheckedOK": "Last Successful Check",
340
            "LastApprovalRequest": "Last Approval Request",
341
            "Created": "Created",
342
            "Interval": "Interval",
343
            "Host": "Host",
344
            "Fingerprint": "Fingerprint",
345
            "KeyID": "Key ID",
346
            "CheckerRunning": "Check Is Running",
347
            "LastEnabled": "Last Enabled",
348
            "ApprovalPending": "Approval Is Pending",
349
            "ApprovedByDefault": "Approved By Default",
350
            "ApprovalDelay": "Approval Delay",
351
            "ApprovalDuration": "Approval Duration",
352
            "Checker": "Checker",
353
            "ExtendedTimeout": "Extended Timeout",
354
            "Expires": "Expires",
355
            "LastCheckerStatus": "Last Checker Status",
356
        }
357
358
        def __init__(self, clients, keywords, tableheaders=None):
359
            self.clients = clients
360
            self.keywords = keywords
361
            if tableheaders is not None:
362
                self.tableheaders = tableheaders
363
364
        def __str__(self):
365
            return "\n".join(self.rows())
366
367
        if sys.version_info.major == 2:
368
            __unicode__ = __str__
369
            def __str__(self):
370
                return str(self).encode(locale.getpreferredencoding())
371
372
        def rows(self):
373
            format_string = self.row_formatting_string()
374
            rows = [self.header_line(format_string)]
375
            rows.extend(self.client_line(client, format_string)
376
                        for client in self.clients)
377
            return rows
378
379
        def row_formatting_string(self):
380
            "Format string used to format table rows"
381
            return " ".join("{{{key}:{width}}}".format(
382
                width=max(len(self.tableheaders[key]),
383
                          *(len(self.string_from_client(client, key))
384
                            for client in self.clients)),
385
                key=key)
386
                            for key in self.keywords)
387
388
        def string_from_client(self, client, key):
389
            return self.valuetostring(client[key], key)
390
391
        @staticmethod
392
        def valuetostring(value, keyword):
393
            if isinstance(value, dbus.Boolean):
394
                return "Yes" if value else "No"
395
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
396
                           "ApprovalDuration", "ExtendedTimeout"):
397
                return milliseconds_to_string(value)
398
            return str(value)
399
400
        def header_line(self, format_string):
401
            return format_string.format(**self.tableheaders)
402
403
        def client_line(self, client, format_string):
404
            return format_string.format(
405
                **{key: self.string_from_client(client, key)
406
                   for key in self.keywords})
407
408
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
409
410
class DumpJSONCmd(PrintCmd):
411
    def output(self, clients):
412
        data = {client["Name"]:
413
                {key: self.dbus_boolean_to_bool(client[key])
414
                 for key in self.all_keywords}
415
                for client in clients.values()}
416
        return json.dumps(data, indent=4, separators=(',', ': '))
417
    @staticmethod
418
    def dbus_boolean_to_bool(value):
419
        if isinstance(value, dbus.Boolean):
420
            value = bool(value)
421
        return value
422
423
class IsEnabledCmd(Command):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
424
    def run_on_one_client(self, client, properties):
425
        if self.is_enabled(client, properties):
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
426
            sys.exit(0)
427
        sys.exit(1)
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
428
    def is_enabled(self, client, properties):
429
        return bool(properties["Enabled"])
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
430
431
class RemoveCmd(Command):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
432
    def run_on_one_client(self, client, properties):
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
433
        self.mandos.RemoveClient(client.__dbus_object_path__)
434
435
class ApproveCmd(Command):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
436
    def run_on_one_client(self, client, properties):
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
437
        client.Approve(dbus.Boolean(True),
438
                       dbus_interface=client_interface)
439
440
class DenyCmd(Command):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
441
    def run_on_one_client(self, client, properties):
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
442
        client.Approve(dbus.Boolean(False),
443
                       dbus_interface=client_interface)
444
445
class EnableCmd(PropertyCmd):
446
    property = "Enabled"
447
    value_to_set = dbus.Boolean(True)
448
449
class DisableCmd(PropertyCmd):
450
    property = "Enabled"
451
    value_to_set = dbus.Boolean(False)
452
453
class BumpTimeoutCmd(PropertyCmd):
454
    property = "LastCheckedOK"
455
    value_to_set = ""
456
457
class StartCheckerCmd(PropertyCmd):
458
    property = "CheckerRunning"
459
    value_to_set = dbus.Boolean(True)
460
461
class StopCheckerCmd(PropertyCmd):
462
    property = "CheckerRunning"
463
    value_to_set = dbus.Boolean(False)
464
465
class ApproveByDefaultCmd(PropertyCmd):
466
    property = "ApprovedByDefault"
467
    value_to_set = dbus.Boolean(True)
468
469
class DenyByDefaultCmd(PropertyCmd):
470
    property = "ApprovedByDefault"
471
    value_to_set = dbus.Boolean(False)
472
473
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
474
    property = "Checker"
475
476
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
477
    property = "Host"
478
479
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
480
    @property
481
    def value_to_set(self):
482
        return self._vts
483
    @value_to_set.setter
484
    def value_to_set(self, value):
485
        """When setting, read data from supplied file object"""
486
        self._vts = value.read()
487
        value.close()
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
488
    property = "Secret"
489
490
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
491
    property = "Timeout"
492
493
class SetExtendedTimeoutCmd(PropertyCmd,
494
                            MillisecondsValueArgumentMixIn):
495
    property = "ExtendedTimeout"
496
497
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
498
    property = "Interval"
499
500
class SetApprovalDelayCmd(PropertyCmd,
501
                          MillisecondsValueArgumentMixIn):
502
    property = "ApprovalDelay"
503
504
class SetApprovalDurationCmd(PropertyCmd,
505
                             MillisecondsValueArgumentMixIn):
506
    property = "ApprovalDuration"
507
237.7.562 by Teddy Hogeborn
mandos-ctl: Refactor
508
def add_command_line_options(parser):
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
509
    parser.add_argument("--version", action="version",
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
510
                        version="%(prog)s {}".format(version),
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
511
                        help="show version number and exit")
512
    parser.add_argument("-a", "--all", action="store_true",
513
                        help="Select all clients")
514
    parser.add_argument("-v", "--verbose", action="store_true",
515
                        help="Print all fields")
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
516
    parser.add_argument("-j", "--dump-json", action="store_true",
517
                        help="Dump client data in JSON format")
237.7.550 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
518
    enable_disable = parser.add_mutually_exclusive_group()
519
    enable_disable.add_argument("-e", "--enable", action="store_true",
520
                                help="Enable client")
521
    enable_disable.add_argument("-d", "--disable",
522
                                action="store_true",
523
                                help="disable client")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
524
    parser.add_argument("-b", "--bump-timeout", action="store_true",
525
                        help="Bump timeout for client")
237.7.550 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
526
    start_stop_checker = parser.add_mutually_exclusive_group()
527
    start_stop_checker.add_argument("--start-checker",
528
                                    action="store_true",
529
                                    help="Start checker for client")
530
    start_stop_checker.add_argument("--stop-checker",
531
                                    action="store_true",
532
                                    help="Stop checker for client")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
533
    parser.add_argument("-V", "--is-enabled", action="store_true",
534
                        help="Check if client is enabled")
535
    parser.add_argument("-r", "--remove", action="store_true",
536
                        help="Remove client")
537
    parser.add_argument("-c", "--checker",
538
                        help="Set checker command for client")
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
539
    parser.add_argument("-t", "--timeout", type=string_to_delta,
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
540
                        help="Set timeout for client")
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
541
    parser.add_argument("--extended-timeout", type=string_to_delta,
24.1.179 by Björn Påhlsson
New feature:
542
                        help="Set extended timeout for client")
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
543
    parser.add_argument("-i", "--interval", type=string_to_delta,
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
544
                        help="Set checker interval for client")
237.7.550 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
545
    approve_deny_default = parser.add_mutually_exclusive_group()
546
    approve_deny_default.add_argument(
547
        "--approve-by-default", action="store_true",
548
        default=None, dest="approved_by_default",
549
        help="Set client to be approved by default")
550
    approve_deny_default.add_argument(
551
        "--deny-by-default", action="store_false",
552
        dest="approved_by_default",
553
        help="Set client to be denied by default")
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
554
    parser.add_argument("--approval-delay", type=string_to_delta,
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
555
                        help="Set delay before client approve/deny")
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
556
    parser.add_argument("--approval-duration", type=string_to_delta,
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
557
                        help="Set duration of one client approval")
558
    parser.add_argument("-H", "--host", help="Set host for client")
237.7.266 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
559
    parser.add_argument("-s", "--secret",
560
                        type=argparse.FileType(mode="rb"),
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
561
                        help="Set password blob (file) for client")
237.7.550 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
562
    approve_deny = parser.add_mutually_exclusive_group()
563
    approve_deny.add_argument(
564
        "-A", "--approve", action="store_true",
565
        help="Approve any current client request")
566
    approve_deny.add_argument("-D", "--deny", action="store_true",
567
                              help="Deny any current client request")
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
568
    parser.add_argument("--check", action="store_true",
569
                        help="Run self-test")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
570
    parser.add_argument("client", nargs="*", help="Client name")
237.7.562 by Teddy Hogeborn
mandos-ctl: Refactor
571
572
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
573
def commands_from_options(options):
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
574
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
575
    commands = []
576
577
    if options.dump_json:
578
        commands.append(DumpJSONCmd())
579
580
    if options.enable:
581
        commands.append(EnableCmd())
582
583
    if options.disable:
584
        commands.append(DisableCmd())
585
586
    if options.bump_timeout:
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
587
        commands.append(BumpTimeoutCmd())
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
588
589
    if options.start_checker:
590
        commands.append(StartCheckerCmd())
591
592
    if options.stop_checker:
593
        commands.append(StopCheckerCmd())
594
595
    if options.is_enabled:
596
        commands.append(IsEnabledCmd())
597
598
    if options.remove:
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
599
        commands.append(RemoveCmd())
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
600
601
    if options.checker is not None:
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
602
        commands.append(SetCheckerCmd(options.checker))
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
603
604
    if options.timeout is not None:
605
        commands.append(SetTimeoutCmd(options.timeout))
606
607
    if options.extended_timeout:
608
        commands.append(
609
            SetExtendedTimeoutCmd(options.extended_timeout))
610
611
    if options.interval is not None:
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
612
        commands.append(SetIntervalCmd(options.interval))
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
613
614
    if options.approved_by_default is not None:
615
        if options.approved_by_default:
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
616
            commands.append(ApproveByDefaultCmd())
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
617
        else:
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
618
            commands.append(DenyByDefaultCmd())
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
619
620
    if options.approval_delay is not None:
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
621
        commands.append(SetApprovalDelayCmd(options.approval_delay))
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
622
623
    if options.approval_duration is not None:
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
624
        commands.append(
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
625
            SetApprovalDurationCmd(options.approval_duration))
626
627
    if options.host is not None:
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
628
        commands.append(SetHostCmd(options.host))
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
629
630
    if options.secret is not None:
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
631
        commands.append(SetSecretCmd(options.secret))
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
632
633
    if options.approve:
634
        commands.append(ApproveCmd())
635
636
    if options.deny:
637
        commands.append(DenyCmd())
638
639
    # If no command option has been given, show table of clients,
640
    # optionally verbosely
641
    if not commands:
642
        commands.append(PrintTableCmd(verbose=options.verbose))
643
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
644
    return commands
237.7.556 by Teddy Hogeborn
mandos-ctl: Refactor
645
646
647
def main():
237.7.562 by Teddy Hogeborn
mandos-ctl: Refactor
648
    parser = argparse.ArgumentParser()
649
650
    add_command_line_options(parser)
651
652
    options = parser.parse_args()
653
237.7.582 by Teddy Hogeborn
mandos-ctl: Refactor
654
    def has_actions(options):
655
        return any((options.enable,
656
                    options.disable,
657
                    options.bump_timeout,
658
                    options.start_checker,
659
                    options.stop_checker,
660
                    options.is_enabled,
661
                    options.remove,
662
                    options.checker is not None,
663
                    options.timeout is not None,
664
                    options.extended_timeout is not None,
665
                    options.interval is not None,
666
                    options.approved_by_default is not None,
667
                    options.approval_delay is not None,
668
                    options.approval_duration is not None,
669
                    options.host is not None,
670
                    options.secret is not None,
671
                    options.approve,
672
                    options.deny))
673
237.7.562 by Teddy Hogeborn
mandos-ctl: Refactor
674
    if has_actions(options) and not (options.client or options.all):
675
        parser.error("Options require clients names or --all.")
676
    if options.verbose and has_actions(options):
677
        parser.error("--verbose can only be used alone.")
678
    if options.dump_json and (options.verbose
679
                              or has_actions(options)):
680
        parser.error("--dump-json can only be used alone.")
681
    if options.all and not has_actions(options):
682
        parser.error("--all requires an action.")
683
    if options.is_enabled and len(options.client) > 1:
684
        parser.error("--is-enabled requires exactly one client")
685
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
686
    clientnames = options.client
237.7.556 by Teddy Hogeborn
mandos-ctl: Refactor
687
688
    try:
689
        bus = dbus.SystemBus()
690
        mandos_dbus_objc = bus.get_object(busname, server_path)
691
    except dbus.exceptions.DBusException:
692
        log.critical("Could not connect to Mandos server")
693
        sys.exit(1)
694
695
    mandos_serv = dbus.Interface(mandos_dbus_objc,
696
                                 dbus_interface=server_interface)
697
    mandos_serv_object_manager = dbus.Interface(
698
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
699
237.7.553 by Teddy Hogeborn
mandos-ctl: Filter logging instead of messing with stderr
700
    # Filter out log message from dbus module
701
    dbus_logger = logging.getLogger("dbus.proxies")
702
    class NullFilter(logging.Filter):
703
        def filter(self, record):
704
            return False
705
    dbus_filter = NullFilter()
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
706
    try:
237.7.563 by Teddy Hogeborn
mandos-ctl: Refactor
707
        dbus_logger.addFilter(dbus_filter)
708
        mandos_clients = {path: ifs_and_props[client_interface]
709
                          for path, ifs_and_props in
710
                          mandos_serv_object_manager
711
                          .GetManagedObjects().items()
712
                          if client_interface in ifs_and_props}
237.7.333 by Teddy Hogeborn
Support the standard org.freedesktop.DBus.ObjectManager interface.
713
    except dbus.exceptions.DBusException as e:
237.7.535 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
714
        log.critical("Failed to access Mandos server through D-Bus:"
715
                     "\n%s", e)
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
716
        sys.exit(1)
237.7.563 by Teddy Hogeborn
mandos-ctl: Refactor
717
    finally:
718
        # restore dbus logger
719
        dbus_logger.removeFilter(dbus_filter)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
720
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
721
    # Compile dict of (clients: properties) to process
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
722
    clients = {}
723
237.7.556 by Teddy Hogeborn
mandos-ctl: Refactor
724
    if not clientnames:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
725
        clients = {bus.get_object(busname, path): properties
726
                   for path, properties in mandos_clients.items()}
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
727
    else:
237.7.556 by Teddy Hogeborn
mandos-ctl: Refactor
728
        for name in clientnames:
237.23.4 by Teddy Hogeborn
Use the .items() method instead of .iteritems().
729
            for path, client in mandos_clients.items():
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
730
                if client["Name"] == name:
731
                    client_objc = bus.get_object(busname, path)
732
                    clients[client_objc] = client
733
                    break
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
734
            else:
237.7.535 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
735
                log.critical("Client not found on server: %r", name)
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
736
                sys.exit(1)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
737
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
738
    # Run all commands on clients
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
739
    commands = commands_from_options(options)
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
740
    for command in commands:
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
741
        command.run(mandos_serv, clients)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
742
237.7.532 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
743

237.7.534 by Teddy Hogeborn
Add tests to mandos-ctl's milliseconds_to_string function
744
class Test_milliseconds_to_string(unittest.TestCase):
745
    def test_all(self):
746
        self.assertEqual(milliseconds_to_string(93785000),
747
                         "1T02:03:05")
748
    def test_no_days(self):
749
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
750
    def test_all_zero(self):
751
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
752
    def test_no_fractional_seconds(self):
753
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
754
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
755
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
756
237.7.540 by Teddy Hogeborn
mandos-ctl: Add more tests
757
class Test_string_to_delta(unittest.TestCase):
758
    def test_handles_basic_rfc3339(self):
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
759
        self.assertEqual(string_to_delta("PT0S"),
760
                         datetime.timedelta())
761
        self.assertEqual(string_to_delta("P0D"),
762
                         datetime.timedelta())
763
        self.assertEqual(string_to_delta("PT1S"),
764
                         datetime.timedelta(0, 1))
237.7.540 by Teddy Hogeborn
mandos-ctl: Add more tests
765
        self.assertEqual(string_to_delta("PT2H"),
766
                         datetime.timedelta(0, 7200))
767
    def test_falls_back_to_pre_1_6_1_with_warning(self):
768
        # assertLogs only exists in Python 3.4
769
        if hasattr(self, "assertLogs"):
770
            with self.assertLogs(log, logging.WARNING):
771
                value = string_to_delta("2h")
772
        else:
237.7.554 by Teddy Hogeborn
mandos-ctl: Improve a test when running Python older than 3.4.
773
            class WarningFilter(logging.Filter):
774
                """Don't show, but record the presence of, warnings"""
775
                def filter(self, record):
776
                    is_warning = record.levelno >= logging.WARNING
777
                    self.found = is_warning or getattr(self, "found",
778
                                                       False)
779
                    return not is_warning
780
            warning_filter = WarningFilter()
781
            log.addFilter(warning_filter)
782
            try:
783
                value = string_to_delta("2h")
784
            finally:
785
                log.removeFilter(warning_filter)
786
            self.assertTrue(getattr(warning_filter, "found", False))
237.7.540 by Teddy Hogeborn
mandos-ctl: Add more tests
787
        self.assertEqual(value, datetime.timedelta(0, 7200))
788
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
789
790
class TestCmd(unittest.TestCase):
791
    """Abstract class for tests of command classes"""
237.7.542 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
792
    def setUp(self):
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
793
        testcase = self
794
        class MockClient(object):
795
            def __init__(self, name, **attributes):
796
                self.__dbus_object_path__ = "objpath_{}".format(name)
797
                self.attributes = attributes
798
                self.attributes["Name"] = name
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
799
                self.calls = []
800
            def Set(self, interface, property, value, dbus_interface):
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
801
                testcase.assertEqual(interface, client_interface)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
802
                testcase.assertEqual(dbus_interface,
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
803
                                     dbus.PROPERTIES_IFACE)
804
                self.attributes[property] = value
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
805
            def Get(self, interface, property, dbus_interface):
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
806
                testcase.assertEqual(interface, client_interface)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
807
                testcase.assertEqual(dbus_interface,
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
808
                                     dbus.PROPERTIES_IFACE)
809
                return self.attributes[property]
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
810
            def Approve(self, approve, dbus_interface):
811
                testcase.assertEqual(dbus_interface, client_interface)
812
                self.calls.append(("Approve", (approve,
813
                                               dbus_interface)))
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
814
        self.client = MockClient(
815
            "foo",
816
            KeyID=("92ed150794387c03ce684574b1139a65"
817
                   "94a34f895daaaf09fd8ea90a27cddb12"),
818
            Secret=b"secret",
819
            Host="foo.example.org",
820
            Enabled=dbus.Boolean(True),
821
            Timeout=300000,
822
            LastCheckedOK="2019-02-03T00:00:00",
823
            Created="2019-01-02T00:00:00",
824
            Interval=120000,
825
            Fingerprint=("778827225BA7DE539C5A"
826
                         "7CFA59CFF7CDBD9A5920"),
827
            CheckerRunning=dbus.Boolean(False),
828
            LastEnabled="2019-01-03T00:00:00",
829
            ApprovalPending=dbus.Boolean(False),
830
            ApprovedByDefault=dbus.Boolean(True),
831
            LastApprovalRequest="",
832
            ApprovalDelay=0,
833
            ApprovalDuration=1000,
834
            Checker="fping -q -- %(host)s",
835
            ExtendedTimeout=900000,
836
            Expires="2019-02-04T00:00:00",
837
            LastCheckerStatus=0)
838
        self.other_client = MockClient(
839
            "barbar",
840
            KeyID=("0558568eedd67d622f5c83b35a115f79"
841
                   "6ab612cff5ad227247e46c2b020f441c"),
842
            Secret=b"secretbar",
843
            Host="192.0.2.3",
844
            Enabled=dbus.Boolean(True),
845
            Timeout=300000,
846
            LastCheckedOK="2019-02-04T00:00:00",
847
            Created="2019-01-03T00:00:00",
848
            Interval=120000,
849
            Fingerprint=("3E393AEAEFB84C7E89E2"
850
                         "F547B3A107558FCA3A27"),
851
            CheckerRunning=dbus.Boolean(True),
852
            LastEnabled="2019-01-04T00:00:00",
853
            ApprovalPending=dbus.Boolean(False),
854
            ApprovedByDefault=dbus.Boolean(False),
855
            LastApprovalRequest="2019-01-03T00:00:00",
856
            ApprovalDelay=30000,
857
            ApprovalDuration=1000,
858
            Checker=":",
859
            ExtendedTimeout=900000,
860
            Expires="2019-02-05T00:00:00",
861
            LastCheckerStatus=-2)
862
        self.clients =  collections.OrderedDict(
863
            [
864
                (self.client, self.client.attributes),
865
                (self.other_client, self.other_client.attributes),
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
866
            ])
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
867
        self.one_client = {self.client: self.client.attributes}
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
868
869
class TestPrintTableCmd(TestCmd):
870
    def test_normal(self):
871
        output = PrintTableCmd().output(self.clients)
872
        expected_output = """
873
Name   Enabled Timeout  Last Successful Check
874
foo    Yes     00:05:00 2019-02-03T00:00:00  
875
barbar Yes     00:05:00 2019-02-04T00:00:00  
876
"""[1:-1]
877
        self.assertEqual(output, expected_output)
878
    def test_verbose(self):
879
        output = PrintTableCmd(verbose=True).output(self.clients)
880
        expected_output = """
881
Name   Enabled Timeout  Last Successful Check Created             Interval Host            Key ID                                                           Fingerprint                              Check Is Running Last Enabled        Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker              Extended Timeout Expires             Last Checker Status
882
foo    Yes     00:05:00 2019-02-03T00:00:00   2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No               2019-01-03T00:00:00 No                  Yes                                       00:00:00       00:00:01          fping -q -- %(host)s 00:15:00         2019-02-04T00:00:00 0                  
883
barbar Yes     00:05:00 2019-02-04T00:00:00   2019-01-03T00:00:00 00:02:00 192.0.2.3       0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes              2019-01-04T00:00:00 No                  No                  2019-01-03T00:00:00   00:00:30       00:00:01          :                    00:15:00         2019-02-05T00:00:00 -2                 
884
"""[1:-1]
885
        self.assertEqual(output, expected_output)
886
    def test_one_client(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
887
        output = PrintTableCmd().output(self.one_client)
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
888
        expected_output = """
889
Name Enabled Timeout  Last Successful Check
890
foo  Yes     00:05:00 2019-02-03T00:00:00  
891
"""[1:-1]
892
        self.assertEqual(output, expected_output)
237.7.542 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
893
237.7.560 by Teddy Hogeborn
mandos-ctl: Add test for DumpJSONCmd class
894
class TestDumpJSONCmd(TestCmd):
895
    def setUp(self):
896
        self.expected_json = {
897
            "foo": {
898
                "Name": "foo",
899
                "KeyID": ("92ed150794387c03ce684574b1139a65"
900
                          "94a34f895daaaf09fd8ea90a27cddb12"),
901
                "Host": "foo.example.org",
902
                "Enabled": True,
903
                "Timeout": 300000,
904
                "LastCheckedOK": "2019-02-03T00:00:00",
905
                "Created": "2019-01-02T00:00:00",
906
                "Interval": 120000,
907
                "Fingerprint": ("778827225BA7DE539C5A"
908
                                "7CFA59CFF7CDBD9A5920"),
909
                "CheckerRunning": False,
910
                "LastEnabled": "2019-01-03T00:00:00",
911
                "ApprovalPending": False,
912
                "ApprovedByDefault": True,
913
                "LastApprovalRequest": "",
914
                "ApprovalDelay": 0,
915
                "ApprovalDuration": 1000,
916
                "Checker": "fping -q -- %(host)s",
917
                "ExtendedTimeout": 900000,
918
                "Expires": "2019-02-04T00:00:00",
919
                "LastCheckerStatus": 0,
920
            },
921
            "barbar": {
922
                "Name": "barbar",
923
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
924
                          "6ab612cff5ad227247e46c2b020f441c"),
925
                "Host": "192.0.2.3",
926
                "Enabled": True,
927
                "Timeout": 300000,
928
                "LastCheckedOK": "2019-02-04T00:00:00",
929
                "Created": "2019-01-03T00:00:00",
930
                "Interval": 120000,
931
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
932
                                "F547B3A107558FCA3A27"),
933
                "CheckerRunning": True,
934
                "LastEnabled": "2019-01-04T00:00:00",
935
                "ApprovalPending": False,
936
                "ApprovedByDefault": False,
937
                "LastApprovalRequest": "2019-01-03T00:00:00",
938
                "ApprovalDelay": 30000,
939
                "ApprovalDuration": 1000,
940
                "Checker": ":",
941
                "ExtendedTimeout": 900000,
942
                "Expires": "2019-02-05T00:00:00",
943
                "LastCheckerStatus": -2,
944
            },
945
        }
946
        return super(TestDumpJSONCmd, self).setUp()
947
    def test_normal(self):
948
        json_data = json.loads(DumpJSONCmd().output(self.clients))
949
        self.assertDictEqual(json_data, self.expected_json)
950
    def test_one_client(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
951
        clients = self.one_client
237.7.560 by Teddy Hogeborn
mandos-ctl: Add test for DumpJSONCmd class
952
        json_data = json.loads(DumpJSONCmd().output(clients))
953
        expected_json = {"foo": self.expected_json["foo"]}
954
        self.assertDictEqual(json_data, expected_json)
237.7.542 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
955
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
956
class TestIsEnabledCmd(TestCmd):
957
    def test_is_enabled(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
958
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
959
                            for client, properties in self.clients.items()))
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
960
    def test_is_enabled_run_exits_successfully(self):
961
        with self.assertRaises(SystemExit) as e:
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
962
            IsEnabledCmd().run(None, self.one_client)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
963
        if e.exception.code is not None:
964
            self.assertEqual(e.exception.code, 0)
965
        else:
966
            self.assertIsNone(e.exception.code)
967
    def test_is_enabled_run_exits_with_failure(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
968
        self.client.attributes["Enabled"] = dbus.Boolean(False)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
969
        with self.assertRaises(SystemExit) as e:
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
970
            IsEnabledCmd().run(None, self.one_client)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
971
        if isinstance(e.exception.code, int):
972
            self.assertNotEqual(e.exception.code, 0)
973
        else:
974
            self.assertIsNotNone(e.exception.code)
975
237.7.565 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
976
class TestRemoveCmd(TestCmd):
977
    def test_remove(self):
978
        class MockMandos(object):
979
            def __init__(self):
980
                self.calls = []
981
            def RemoveClient(self, dbus_path):
982
                self.calls.append(("RemoveClient", (dbus_path,)))
983
        mandos = MockMandos()
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
984
        super(TestRemoveCmd, self).setUp()
985
        RemoveCmd().run(mandos, self.clients)
986
        self.assertEqual(len(mandos.calls), 2)
987
        for client in self.clients:
988
            self.assertIn(("RemoveClient",
989
                           (client.__dbus_object_path__,)),
990
                          mandos.calls)
237.7.565 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
991
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
992
class TestApproveCmd(TestCmd):
993
    def test_approve(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
994
        ApproveCmd().run(None, self.clients)
995
        for client in self.clients:
996
            self.assertIn(("Approve", (True, client_interface)),
997
                          client.calls)
998
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
999
class TestDenyCmd(TestCmd):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
1000
    def test_deny(self):
1001
        DenyCmd().run(None, self.clients)
1002
        for client in self.clients:
1003
            self.assertIn(("Approve", (False, client_interface)),
1004
                          client.calls)
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
1005
237.7.569 by Teddy Hogeborn
mandos-ctl: Add test for EnableCmd and DisableCmd
1006
class TestEnableCmd(TestCmd):
1007
    def test_enable(self):
1008
        for client in self.clients:
1009
            client.attributes["Enabled"] = False
1010
1011
        EnableCmd().run(None, self.clients)
1012
1013
        for client in self.clients:
1014
            self.assertTrue(client.attributes["Enabled"])
1015
1016
class TestDisableCmd(TestCmd):
1017
    def test_disable(self):
1018
        DisableCmd().run(None, self.clients)
1019
1020
        for client in self.clients:
1021
            self.assertFalse(client.attributes["Enabled"])
1022
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1023
class Unique(object):
1024
    """Class for objects which exist only to be unique objects, since
1025
unittest.mock.sentinel only exists in Python 3.3"""
1026
1027
class TestPropertyCmd(TestCmd):
1028
    """Abstract class for tests of PropertyCmd classes"""
1029
    def runTest(self):
1030
        if not hasattr(self, "command"):
1031
            return
1032
        values_to_get = getattr(self, "values_to_get",
1033
                                self.values_to_set)
1034
        for value_to_set, value_to_get in zip(self.values_to_set,
1035
                                              values_to_get):
1036
            for client in self.clients:
1037
                old_value = client.attributes[self.property]
1038
                self.assertNotIsInstance(old_value, Unique)
1039
                client.attributes[self.property] = Unique()
1040
            self.run_command(value_to_set, self.clients)
1041
            for client in self.clients:
1042
                value = client.attributes[self.property]
1043
                self.assertNotIsInstance(value, Unique)
1044
                self.assertEqual(value, value_to_get)
1045
    def run_command(self, value, clients):
1046
        self.command().run(None, clients)
1047
1048
class TestBumpTimeoutCmd(TestPropertyCmd):
1049
    command = BumpTimeoutCmd
1050
    property = "LastCheckedOK"
1051
    values_to_set = [""]
1052
1053
class TestStartCheckerCmd(TestPropertyCmd):
1054
    command = StartCheckerCmd
1055
    property = "CheckerRunning"
1056
    values_to_set = [dbus.Boolean(True)]
1057
1058
class TestStopCheckerCmd(TestPropertyCmd):
1059
    command = StopCheckerCmd
1060
    property = "CheckerRunning"
1061
    values_to_set = [dbus.Boolean(False)]
1062
1063
class TestApproveByDefaultCmd(TestPropertyCmd):
1064
    command = ApproveByDefaultCmd
1065
    property = "ApprovedByDefault"
1066
    values_to_set = [dbus.Boolean(True)]
1067
1068
class TestDenyByDefaultCmd(TestPropertyCmd):
1069
    command = DenyByDefaultCmd
1070
    property = "ApprovedByDefault"
1071
    values_to_set = [dbus.Boolean(False)]
1072
1073
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1074
    """Abstract class for tests of PropertyCmd classes using the
1075
ValueArgumentMixIn"""
1076
    def runTest(self):
1077
        if type(self) is TestValueArgumentPropertyCmd:
1078
            return
1079
        return super(TestValueArgumentPropertyCmd, self).runTest()
1080
    def run_command(self, value, clients):
1081
        self.command(value).run(None, clients)
1082
1083
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1084
    command = SetCheckerCmd
1085
    property = "Checker"
1086
    values_to_set = ["", ":", "fping -q -- %s"]
1087
1088
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1089
    command = SetHostCmd
1090
    property = "Host"
1091
    values_to_set = ["192.0.2.3", "foo.example.org"]
1092
1093
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1094
    command = SetSecretCmd
1095
    property = "Secret"
237.7.578 by Teddy Hogeborn
mandos-ctl: Fix bugs
1096
    values_to_set = [open("/dev/null", "rb"),
1097
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1098
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1099
1100
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1101
    command = SetTimeoutCmd
1102
    property = "Timeout"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1103
    values_to_set = [datetime.timedelta(),
1104
                     datetime.timedelta(minutes=5),
1105
                     datetime.timedelta(seconds=1),
1106
                     datetime.timedelta(weeks=1),
1107
                     datetime.timedelta(weeks=52)]
1108
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1109
1110
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1111
    command = SetExtendedTimeoutCmd
1112
    property = "ExtendedTimeout"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1113
    values_to_set = [datetime.timedelta(),
1114
                     datetime.timedelta(minutes=5),
1115
                     datetime.timedelta(seconds=1),
1116
                     datetime.timedelta(weeks=1),
1117
                     datetime.timedelta(weeks=52)]
1118
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1119
1120
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1121
    command = SetIntervalCmd
1122
    property = "Interval"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1123
    values_to_set = [datetime.timedelta(),
1124
                     datetime.timedelta(minutes=5),
1125
                     datetime.timedelta(seconds=1),
1126
                     datetime.timedelta(weeks=1),
1127
                     datetime.timedelta(weeks=52)]
1128
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1129
1130
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1131
    command = SetApprovalDelayCmd
1132
    property = "ApprovalDelay"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1133
    values_to_set = [datetime.timedelta(),
1134
                     datetime.timedelta(minutes=5),
1135
                     datetime.timedelta(seconds=1),
1136
                     datetime.timedelta(weeks=1),
1137
                     datetime.timedelta(weeks=52)]
1138
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1139
1140
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1141
    command = SetApprovalDurationCmd
1142
    property = "ApprovalDuration"
237.7.583 by Teddy Hogeborn
mandos-ctl: Refactor; move parsing of intervals into argument parsing
1143
    values_to_set = [datetime.timedelta(),
1144
                     datetime.timedelta(minutes=5),
1145
                     datetime.timedelta(seconds=1),
1146
                     datetime.timedelta(weeks=1),
1147
                     datetime.timedelta(weeks=52)]
1148
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
237.7.572 by Teddy Hogeborn
mandos-ctl: Add more tests, including tests for all commands
1149
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1150
class Test_command_from_options(unittest.TestCase):
237.7.573 by Teddy Hogeborn
mandos-ctl: Add more tests, starting with the --verbose option
1151
    def setUp(self):
1152
        self.parser = argparse.ArgumentParser()
1153
        add_command_line_options(self.parser)
237.7.576 by Teddy Hogeborn
mandos-ctl: Refactor test
1154
    def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1155
        """Assert that parsing ARGS should result in an instance of
1156
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1157
        options = self.parser.parse_args(args)
1158
        commands = commands_from_options(options)
1159
        self.assertEqual(len(commands), 1)
1160
        command = commands[0]
1161
        self.assertIsInstance(command, command_cls)
1162
        for key, value in cmd_attrs.items():
1163
            self.assertEqual(getattr(command, key), value)
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1164
    def test_print_table(self):
237.7.576 by Teddy Hogeborn
mandos-ctl: Refactor test
1165
        self.assert_command_from_args([], PrintTableCmd,
1166
                                      verbose=False)
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1167
1168
    def test_print_table_verbose(self):
237.7.576 by Teddy Hogeborn
mandos-ctl: Refactor test
1169
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
1170
                                      verbose=True)
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1171
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1172
    def test_print_table_verbose_short(self):
1173
        self.assert_command_from_args(["-v"], PrintTableCmd,
1174
                                      verbose=True)
1175
237.7.574 by Teddy Hogeborn
mandos-ctl: Add test for the --enable option
1176
    def test_enable(self):
237.7.577 by Teddy Hogeborn
mandos-ctl: Refactor test
1177
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1178
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1179
    def test_enable_short(self):
1180
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
1181
237.7.575 by Teddy Hogeborn
mandos-ctl: Add test for the --disable option
1182
    def test_disable(self):
237.7.577 by Teddy Hogeborn
mandos-ctl: Refactor test
1183
        self.assert_command_from_args(["--disable", "foo"],
1184
                                      DisableCmd)
237.7.573 by Teddy Hogeborn
mandos-ctl: Add more tests, starting with the --verbose option
1185
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1186
    def test_disable_short(self):
1187
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
1188
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1189
    def test_bump_timeout(self):
1190
        self.assert_command_from_args(["--bump-timeout", "foo"],
1191
                                      BumpTimeoutCmd)
1192
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1193
    def test_bump_timeout_short(self):
1194
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1195
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1196
    def test_start_checker(self):
1197
        self.assert_command_from_args(["--start-checker", "foo"],
1198
                                      StartCheckerCmd)
1199
1200
    def test_stop_checker(self):
1201
        self.assert_command_from_args(["--stop-checker", "foo"],
1202
                                      StopCheckerCmd)
1203
1204
    def test_remove(self):
1205
        self.assert_command_from_args(["--remove", "foo"],
1206
                                      RemoveCmd)
1207
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1208
    def test_remove_short(self):
1209
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1210
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1211
    def test_checker(self):
1212
        self.assert_command_from_args(["--checker", ":", "foo"],
1213
                                      SetCheckerCmd, value_to_set=":")
1214
237.7.581 by Teddy Hogeborn
mandos-ctl: Add test for --checker ""
1215
    def test_checker_empty(self):
1216
        self.assert_command_from_args(["--checker", "", "foo"],
1217
                                      SetCheckerCmd, value_to_set="")
1218
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1219
    def test_checker_short(self):
1220
        self.assert_command_from_args(["-c", ":", "foo"],
1221
                                      SetCheckerCmd, value_to_set=":")
1222
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1223
    def test_timeout(self):
1224
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1225
                                      SetTimeoutCmd,
1226
                                      value_to_set=300000)
1227
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1228
    def test_timeout_short(self):
1229
        self.assert_command_from_args(["-t", "PT5M", "foo"],
1230
                                      SetTimeoutCmd,
1231
                                      value_to_set=300000)
1232
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1233
    def test_extended_timeout(self):
1234
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1235
                                       "foo"],
1236
                                      SetExtendedTimeoutCmd,
1237
                                      value_to_set=900000)
1238
1239
    def test_interval(self):
1240
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
1241
                                      SetIntervalCmd,
1242
                                      value_to_set=120000)
1243
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1244
    def test_interval_short(self):
1245
        self.assert_command_from_args(["-i", "PT2M", "foo"],
1246
                                      SetIntervalCmd,
1247
                                      value_to_set=120000)
1248
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1249
    def test_approve_by_default(self):
1250
        self.assert_command_from_args(["--approve-by-default", "foo"],
1251
                                      ApproveByDefaultCmd)
1252
1253
    def test_deny_by_default(self):
1254
        self.assert_command_from_args(["--deny-by-default", "foo"],
1255
                                      DenyByDefaultCmd)
1256
1257
    def test_approval_delay(self):
1258
        self.assert_command_from_args(["--approval-delay", "PT30S",
1259
                                       "foo"], SetApprovalDelayCmd,
1260
                                      value_to_set=30000)
1261
1262
    def test_approval_duration(self):
1263
        self.assert_command_from_args(["--approval-duration", "PT1S",
1264
                                       "foo"], SetApprovalDurationCmd,
1265
                                      value_to_set=1000)
1266
1267
    def test_host(self):
1268
        self.assert_command_from_args(["--host", "foo.example.org",
1269
                                       "foo"], SetHostCmd,
1270
                                      value_to_set="foo.example.org")
1271
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1272
    def test_host_short(self):
1273
        self.assert_command_from_args(["-H", "foo.example.org",
1274
                                       "foo"], SetHostCmd,
1275
                                      value_to_set="foo.example.org")
1276
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1277
    def test_secret_devnull(self):
1278
        self.assert_command_from_args(["--secret", os.path.devnull,
1279
                                       "foo"], SetSecretCmd,
1280
                                      value_to_set=b"")
1281
1282
    def test_secret_tempfile(self):
1283
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1284
            value = b"secret\0xyzzy\nbar"
1285
            f.write(value)
1286
            f.seek(0)
1287
            self.assert_command_from_args(["--secret", f.name,
1288
                                           "foo"], SetSecretCmd,
1289
                                          value_to_set=value)
1290
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1291
    def test_secret_devnull_short(self):
1292
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1293
                                      SetSecretCmd, value_to_set=b"")
1294
1295
    def test_secret_tempfile_short(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(["-s", f.name, "foo"],
1301
                                          SetSecretCmd,
1302
                                          value_to_set=value)
1303
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1304
    def test_approve(self):
1305
        self.assert_command_from_args(["--approve", "foo"],
1306
                                      ApproveCmd)
1307
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1308
    def test_approve_short(self):
1309
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1310
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1311
    def test_deny(self):
1312
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1313
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1314
    def test_deny_short(self):
1315
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
1316
237.7.579 by Teddy Hogeborn
mandos-ctl: Refactor tests and add more tests
1317
    def test_dump_json(self):
1318
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1319
1320
    def test_is_enabled(self):
1321
        self.assert_command_from_args(["--is-enabled", "foo"],
1322
                                      IsEnabledCmd)
1323
237.7.584 by Teddy Hogeborn
mandos-ctl: Add tests for short options
1324
    def test_is_enabled_short(self):
1325
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1326
237.7.565 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
1327
237.7.534 by Teddy Hogeborn
Add tests to mandos-ctl's milliseconds_to_string function
1328

237.7.532 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
1329
def should_only_run_tests():
1330
    parser = argparse.ArgumentParser(add_help=False)
1331
    parser.add_argument("--check", action='store_true')
1332
    args, unknown_args = parser.parse_known_args()
1333
    run_tests = args.check
1334
    if run_tests:
1335
        # Remove --check argument from sys.argv
1336
        sys.argv[1:] = unknown_args
1337
    return run_tests
1338
1339
# Add all tests from doctest strings
1340
def load_tests(loader, tests, none):
1341
    import doctest
1342
    tests.addTests(doctest.DocTestSuite())
1343
    return tests
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
1344
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
1345
if __name__ == "__main__":
237.7.532 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
1346
    if should_only_run_tests():
1347
        # Call using ./tdd-python-script --check [--verbose]
1348
        unittest.main()
1349
    else:
1350
        main()