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