/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
24.1.116 by Björn Påhlsson
added a mandos list client program
1
#!/usr/bin/python
985 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*")))); -*-
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
3
#
444 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
4
# Mandos Monitor - Control and monitor the Mandos server
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
5
#
969 by Teddy Hogeborn
Update copyright year to 2019
6
# Copyright © 2008-2019 Teddy Hogeborn
7
# Copyright © 2008-2019 Björn Påhlsson
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
8
#
907 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
444 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
#
907 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
444 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.
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
20
#
444 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
21
# You should have received a copy of the GNU General Public License
907 by Teddy Hogeborn
Alter copyright notices slightly. Actual license is unchanged!
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
23
#
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
24
# Contact the authors at <mandos@recompile.se>.
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
25
#
24.1.116 by Björn Påhlsson
added a mandos list client program
26
463.1.9 by teddy at bsnet
* mandos-ctl: Use print function.
27
from __future__ import (division, absolute_import, print_function,
28
                        unicode_literals)
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
29
718 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
30
try:
31
    from future_builtins import *
32
except ImportError:
33
    pass
579 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
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
36
import argparse
240 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
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
41
import collections
863 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
42
import json
984 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
43
import unittest
987 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
44
import logging
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
45
46
import dbus
240 by Teddy Hogeborn
Merge "mandos-list" from belorn.
47
988 by Teddy Hogeborn
mandos-ctl: Show warnings
48
# Show warnings by default
49
if not sys.warnoptions:
50
    import warnings
51
    warnings.simplefilter("default")
52
987 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
53
log = logging.getLogger(sys.argv[0])
54
logging.basicConfig(level="INFO", # Show info level messages
55
                    format="%(message)s") # Show basic log messages
56
988 by Teddy Hogeborn
mandos-ctl: Show warnings
57
logging.captureWarnings(True)   # Show warnings via the logging system
58
723.1.7 by Teddy Hogeborn
Use the .major attribute on sys.version_info instead of using "[0]".
59
if sys.version_info.major == 2:
718 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
60
    str = unicode
61
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
62
locale.setlocale(locale.LC_ALL, "")
24.1.116 by Björn Påhlsson
added a mandos list client program
63
24.1.186 by Björn Påhlsson
transitional stuff actually working
64
domain = "se.recompile"
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
65
busname = domain + ".Mandos"
66
server_path = "/"
67
server_interface = domain + ".Mandos"
68
client_interface = domain + ".Mandos.Client"
237.4.108 by Teddy Hogeborn
* Makefile (version): Change to 1.8.3.
69
version = "1.8.3"
24.1.118 by Björn Påhlsson
Added enable/disable
70
745 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
71
785 by Teddy Hogeborn
Support the standard org.freedesktop.DBus.ObjectManager interface.
72
try:
73
    dbus.OBJECT_MANAGER_IFACE
74
except AttributeError:
75
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
76
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
77
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
78
def milliseconds_to_string(ms):
79
    td = datetime.timedelta(0, 0, 0, ms)
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
80
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
81
            .format(days="{}T".format(td.days) if td.days else "",
82
                    hours=td.seconds // 3600,
83
                    minutes=(td.seconds % 3600) // 60,
84
                    seconds=td.seconds % 60))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
85
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
86
87
def rfc3339_duration_to_delta(duration):
609 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
89
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
90
    >>> rfc3339_duration_to_delta("P7D")
91
    datetime.timedelta(7)
92
    >>> rfc3339_duration_to_delta("PT60S")
93
    datetime.timedelta(0, 60)
94
    >>> rfc3339_duration_to_delta("PT60M")
95
    datetime.timedelta(0, 3600)
990 by Teddy Hogeborn
mandos-ctl (rfc3339_duration_to_delta): Improve tests
96
    >>> rfc3339_duration_to_delta("P60M")
97
    datetime.timedelta(1680)
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
98
    >>> rfc3339_duration_to_delta("PT24H")
99
    datetime.timedelta(1)
100
    >>> rfc3339_duration_to_delta("P1W")
101
    datetime.timedelta(7)
102
    >>> rfc3339_duration_to_delta("PT5M30S")
103
    datetime.timedelta(0, 330)
104
    >>> rfc3339_duration_to_delta("P1DT3M20S")
105
    datetime.timedelta(1, 200)
990 by Teddy Hogeborn
mandos-ctl (rfc3339_duration_to_delta): Improve tests
106
    >>> # Can not be empty:
107
    >>> rfc3339_duration_to_delta("")
108
    Traceback (most recent call last):
109
    ...
110
    ValueError: Invalid RFC 3339 duration: u''
111
    >>> # Must start with "P":
112
    >>> rfc3339_duration_to_delta("1D")
113
    Traceback (most recent call last):
114
    ...
115
    ValueError: Invalid RFC 3339 duration: u'1D'
116
    >>> # Must use correct order
117
    >>> rfc3339_duration_to_delta("PT1S2M")
118
    Traceback (most recent call last):
119
    ...
120
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
121
    >>> # Time needs time marker
122
    >>> rfc3339_duration_to_delta("P1H2S")
123
    Traceback (most recent call last):
124
    ...
125
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
126
    >>> # Weeks can not be combined with anything else
127
    >>> rfc3339_duration_to_delta("P1D2W")
128
    Traceback (most recent call last):
129
    ...
130
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
131
    >>> rfc3339_duration_to_delta("P2W2H")
132
    Traceback (most recent call last):
133
    ...
134
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
135
    """
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
136
609 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
137
    # Parsing an RFC 3339 duration with regular expressions is not
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
138
    # possible - there would have to be multiple places for the same
609 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
139
    # values, like seconds.  The current code, while more esoteric, is
140
    # cleaner without depending on a parsing library.  If Python had a
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
141
    # built-in library for parsing we would use it, but we'd like to
142
    # avoid excessive use of external libraries.
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
143
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
144
    # New type for defining tokens, syntax, and semantics all-in-one
753 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
145
    Token = collections.namedtuple("Token", (
146
        "regexp",  # To match token; if "value" is not None, must have
147
                   # a "group" containing digits
148
        "value",   # datetime.timedelta or None
149
        "followers"))           # Tokens valid after this token
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
150
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
151
    # the "duration" ABNF definition in RFC 3339, Appendix A.
152
    token_end = Token(re.compile(r"$"), None, frozenset())
153
    token_second = Token(re.compile(r"(\d+)S"),
154
                         datetime.timedelta(seconds=1),
745 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
155
                         frozenset((token_end, )))
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
156
    token_minute = Token(re.compile(r"(\d+)M"),
157
                         datetime.timedelta(minutes=1),
158
                         frozenset((token_second, token_end)))
159
    token_hour = Token(re.compile(r"(\d+)H"),
160
                       datetime.timedelta(hours=1),
161
                       frozenset((token_minute, token_end)))
162
    token_time = Token(re.compile(r"T"),
163
                       None,
164
                       frozenset((token_hour, token_minute,
165
                                  token_second)))
166
    token_day = Token(re.compile(r"(\d+)D"),
167
                      datetime.timedelta(days=1),
168
                      frozenset((token_time, token_end)))
169
    token_month = Token(re.compile(r"(\d+)M"),
170
                        datetime.timedelta(weeks=4),
171
                        frozenset((token_day, token_end)))
172
    token_year = Token(re.compile(r"(\d+)Y"),
173
                       datetime.timedelta(weeks=52),
174
                       frozenset((token_month, token_end)))
175
    token_week = Token(re.compile(r"(\d+)W"),
176
                       datetime.timedelta(weeks=1),
745 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
177
                       frozenset((token_end, )))
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
178
    token_duration = Token(re.compile(r"P"), None,
179
                           frozenset((token_year, token_month,
180
                                      token_day, token_time,
721 by Teddy Hogeborn
Fix two mutually cancelling bugs.
181
                                      token_week)))
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
182
    # Define starting values:
183
    # Value so far
184
    value = datetime.timedelta()
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
185
    found_token = None
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
186
    # Following valid tokens
187
    followers = frozenset((token_duration, ))
188
    # String left to parse
189
    s = duration
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
190
    # Loop until end token is found
191
    while found_token is not token_end:
192
        # Search for any currently valid tokens
193
        for token in followers:
194
            match = token.regexp.match(s)
195
            if match is not None:
196
                # Token found
197
                if token.value is not None:
198
                    # Value found, parse digits
199
                    factor = int(match.group(1), 10)
200
                    # Add to value so far
201
                    value += factor * token.value
202
                # Strip token from string
203
                s = token.regexp.sub("", s, 1)
204
                # Go to found token
205
                found_token = token
206
                # Set valid next tokens
207
                followers = found_token.followers
208
                break
209
        else:
210
            # No currently valid tokens were found
753 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
211
            raise ValueError("Invalid RFC 3339 duration: {!r}"
212
                             .format(duration))
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
213
    # End token found
214
    return value
215
216
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
217
def string_to_delta(interval):
1001 by Teddy Hogeborn
mandos-ctl: White space changes only
218
    """Parse a string and return a datetime.timedelta"""
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
219
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
220
    try:
221
        return rfc3339_duration_to_delta(interval)
991 by Teddy Hogeborn
mandos-ctl: Refactor and add more tests
222
    except ValueError as e:
223
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
224
                    ' '.join(e.args))
225
    return parse_pre_1_6_1_interval(interval)
226
227
228
def parse_pre_1_6_1_interval(interval):
1001 by Teddy Hogeborn
mandos-ctl: White space changes only
229
    """Parse an interval string as documented by Mandos before 1.6.1,
230
    and return a datetime.timedelta
231
991 by Teddy Hogeborn
mandos-ctl: Refactor and add more tests
232
    >>> parse_pre_1_6_1_interval('7d')
233
    datetime.timedelta(7)
234
    >>> parse_pre_1_6_1_interval('60s')
235
    datetime.timedelta(0, 60)
236
    >>> parse_pre_1_6_1_interval('60m')
237
    datetime.timedelta(0, 3600)
238
    >>> parse_pre_1_6_1_interval('24h')
239
    datetime.timedelta(1)
240
    >>> parse_pre_1_6_1_interval('1w')
241
    datetime.timedelta(7)
242
    >>> parse_pre_1_6_1_interval('5m 30s')
243
    datetime.timedelta(0, 330)
244
    >>> parse_pre_1_6_1_interval('')
245
    datetime.timedelta(0)
246
    >>> # Ignore unknown characters, allow any order and repetitions
247
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
248
    datetime.timedelta(2, 480, 18000)
249
250
    """
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
251
616 by Teddy Hogeborn
* mandos-ctl (string_to_delta): Try to parse RFC 3339 duration before
252
    value = datetime.timedelta(0)
253
    regexp = re.compile(r"(\d+)([dsmhw]?)")
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
254
518.2.9 by Teddy Hogeborn
* mandos (ClientDBus.approval_delay, ClientDBus.approval_duration,
255
    for num, suffix in regexp.findall(interval):
256
        if suffix == "d":
257
            value += datetime.timedelta(int(num))
258
        elif suffix == "s":
259
            value += datetime.timedelta(0, int(num))
260
        elif suffix == "m":
261
            value += datetime.timedelta(0, 0, 0, 0, int(num))
262
        elif suffix == "h":
263
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
264
        elif suffix == "w":
265
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
266
        elif suffix == "":
267
            value += datetime.timedelta(0, 0, 0, int(num))
268
    return value
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
269
745 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
270
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
271
## Classes for commands.
272
273
# Abstract classes first
274
class Command(object):
275
    """Abstract class for commands"""
1007 by Teddy Hogeborn
mandos-ctl: Refactor
276
    def run(self, mandos, clients):
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
277
        """Normal commands should implement run_on_one_client(), but
278
        commands which want to operate on all clients at the same time
279
        can override this run() method instead."""
1007 by Teddy Hogeborn
mandos-ctl: Refactor
280
        self.mandos = mandos
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
281
        for client in clients:
282
            self.run_on_one_client(client)
283
284
class PrintCmd(Command):
285
    """Abstract class for commands printing client details"""
286
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
287
                    "Created", "Interval", "Host", "KeyID",
288
                    "Fingerprint", "CheckerRunning", "LastEnabled",
289
                    "ApprovalPending", "ApprovedByDefault",
290
                    "LastApprovalRequest", "ApprovalDelay",
291
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
292
                    "Expires", "LastCheckerStatus")
1007 by Teddy Hogeborn
mandos-ctl: Refactor
293
    def run(self, mandos, clients):
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
294
        print(self.output(clients))
295
296
class PropertyCmd(Command):
297
    """Abstract class for Actions for setting one client property"""
298
    def run_on_one_client(self, client):
299
        """Set the Client's D-Bus property"""
300
        client.Set(client_interface, self.property, self.value_to_set,
301
                   dbus_interface=dbus.PROPERTIES_IFACE)
302
303
class ValueArgumentMixIn(object):
304
    """Mixin class for commands taking a value as argument"""
305
    def __init__(self, value):
306
        self.value_to_set = value
307
308
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
309
    """Mixin class for commands taking a value argument as
310
    milliseconds."""
311
    @property
312
    def value_to_set(self):
313
        return self._vts
314
    @value_to_set.setter
315
    def value_to_set(self, value):
316
        """When setting, convert value to a datetime.timedelta"""
317
        self._vts = string_to_delta(value).total_seconds() * 1000
318
319
# Actual (non-abstract) command classes
320
321
class PrintTableCmd(PrintCmd):
322
    def __init__(self, verbose=False):
323
        self.verbose = verbose
1011 by Teddy Hogeborn
mandos-ctl: Refactor; move TableOfClients into PrintTableCmd
324
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
325
    def output(self, clients):
326
        if self.verbose:
327
            keywords = self.all_keywords
328
        else:
329
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
1011 by Teddy Hogeborn
mandos-ctl: Refactor; move TableOfClients into PrintTableCmd
330
        return str(self.TableOfClients(clients.values(), keywords))
331
332
    class TableOfClients(object):
333
        tableheaders = {
334
            "Name": "Name",
335
            "Enabled": "Enabled",
336
            "Timeout": "Timeout",
337
            "LastCheckedOK": "Last Successful Check",
338
            "LastApprovalRequest": "Last Approval Request",
339
            "Created": "Created",
340
            "Interval": "Interval",
341
            "Host": "Host",
342
            "Fingerprint": "Fingerprint",
343
            "KeyID": "Key ID",
344
            "CheckerRunning": "Check Is Running",
345
            "LastEnabled": "Last Enabled",
346
            "ApprovalPending": "Approval Is Pending",
347
            "ApprovedByDefault": "Approved By Default",
348
            "ApprovalDelay": "Approval Delay",
349
            "ApprovalDuration": "Approval Duration",
350
            "Checker": "Checker",
351
            "ExtendedTimeout": "Extended Timeout",
352
            "Expires": "Expires",
353
            "LastCheckerStatus": "Last Checker Status",
354
        }
355
356
        def __init__(self, clients, keywords, tableheaders=None):
357
            self.clients = clients
358
            self.keywords = keywords
359
            if tableheaders is not None:
360
                self.tableheaders = tableheaders
361
362
        def __str__(self):
363
            return "\n".join(self.rows())
364
365
        if sys.version_info.major == 2:
366
            __unicode__ = __str__
367
            def __str__(self):
368
                return str(self).encode(locale.getpreferredencoding())
369
370
        def rows(self):
371
            format_string = self.row_formatting_string()
372
            rows = [self.header_line(format_string)]
373
            rows.extend(self.client_line(client, format_string)
374
                        for client in self.clients)
375
            return rows
376
377
        def row_formatting_string(self):
378
            "Format string used to format table rows"
379
            return " ".join("{{{key}:{width}}}".format(
380
                width=max(len(self.tableheaders[key]),
381
                          *(len(self.string_from_client(client, key))
382
                            for client in self.clients)),
383
                key=key)
384
                            for key in self.keywords)
385
386
        def string_from_client(self, client, key):
387
            return self.valuetostring(client[key], key)
388
389
        @staticmethod
390
        def valuetostring(value, keyword):
391
            if isinstance(value, dbus.Boolean):
392
                return "Yes" if value else "No"
393
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
394
                           "ApprovalDuration", "ExtendedTimeout"):
395
                return milliseconds_to_string(value)
396
            return str(value)
397
398
        def header_line(self, format_string):
399
            return format_string.format(**self.tableheaders)
400
401
        def client_line(self, client, format_string):
402
            return format_string.format(
403
                **{key: self.string_from_client(client, key)
404
                   for key in self.keywords})
405
406
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
407
408
class DumpJSONCmd(PrintCmd):
409
    def output(self, clients):
410
        data = {client["Name"]:
411
                {key: self.dbus_boolean_to_bool(client[key])
412
                 for key in self.all_keywords}
413
                for client in clients.values()}
414
        return json.dumps(data, indent=4, separators=(',', ': '))
415
    @staticmethod
416
    def dbus_boolean_to_bool(value):
417
        if isinstance(value, dbus.Boolean):
418
            value = bool(value)
419
        return value
420
421
class IsEnabledCmd(Command):
422
    def run_on_one_client(self, client):
423
        if self.is_enabled(client):
424
            sys.exit(0)
425
        sys.exit(1)
426
    def is_enabled(self, client):
427
        return client.Get(client_interface, "Enabled",
428
                          dbus_interface=dbus.PROPERTIES_IFACE)
429
430
class RemoveCmd(Command):
431
    def run_on_one_client(self, client):
432
        self.mandos.RemoveClient(client.__dbus_object_path__)
433
434
class ApproveCmd(Command):
435
    def run_on_one_client(self, client):
436
        client.Approve(dbus.Boolean(True),
437
                       dbus_interface=client_interface)
438
439
class DenyCmd(Command):
440
    def run_on_one_client(self, client):
441
        client.Approve(dbus.Boolean(False),
442
                       dbus_interface=client_interface)
443
444
class EnableCmd(PropertyCmd):
445
    property = "Enabled"
446
    value_to_set = dbus.Boolean(True)
447
448
class DisableCmd(PropertyCmd):
449
    property = "Enabled"
450
    value_to_set = dbus.Boolean(False)
451
452
class BumpTimeoutCmd(PropertyCmd):
453
    property = "LastCheckedOK"
454
    value_to_set = ""
455
456
class StartCheckerCmd(PropertyCmd):
457
    property = "CheckerRunning"
458
    value_to_set = dbus.Boolean(True)
459
460
class StopCheckerCmd(PropertyCmd):
461
    property = "CheckerRunning"
462
    value_to_set = dbus.Boolean(False)
463
464
class ApproveByDefaultCmd(PropertyCmd):
465
    property = "ApprovedByDefault"
466
    value_to_set = dbus.Boolean(True)
467
468
class DenyByDefaultCmd(PropertyCmd):
469
    property = "ApprovedByDefault"
470
    value_to_set = dbus.Boolean(False)
471
472
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
473
    property = "Checker"
474
475
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
476
    property = "Host"
477
478
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
479
    property = "Secret"
480
481
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
482
    property = "Timeout"
483
484
class SetExtendedTimeoutCmd(PropertyCmd,
485
                            MillisecondsValueArgumentMixIn):
486
    property = "ExtendedTimeout"
487
488
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
489
    property = "Interval"
490
491
class SetApprovalDelayCmd(PropertyCmd,
492
                          MillisecondsValueArgumentMixIn):
493
    property = "ApprovalDelay"
494
495
class SetApprovalDurationCmd(PropertyCmd,
496
                             MillisecondsValueArgumentMixIn):
497
    property = "ApprovalDuration"
498
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
499
def has_actions(options):
500
    return any((options.enable,
501
                options.disable,
502
                options.bump_timeout,
503
                options.start_checker,
504
                options.stop_checker,
505
                options.is_enabled,
506
                options.remove,
507
                options.checker is not None,
508
                options.timeout is not None,
24.1.179 by Björn Påhlsson
New feature:
509
                options.extended_timeout is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
510
                options.interval is not None,
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
511
                options.approved_by_default is not None,
512
                options.approval_delay is not None,
513
                options.approval_duration is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
514
                options.host is not None,
515
                options.secret is not None,
516
                options.approve,
517
                options.deny))
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
518
1014 by Teddy Hogeborn
mandos-ctl: Refactor
519
def add_command_line_options(parser):
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
520
    parser.add_argument("--version", action="version",
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
521
                        version="%(prog)s {}".format(version),
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
522
                        help="show version number and exit")
523
    parser.add_argument("-a", "--all", action="store_true",
524
                        help="Select all clients")
525
    parser.add_argument("-v", "--verbose", action="store_true",
526
                        help="Print all fields")
863 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
527
    parser.add_argument("-j", "--dump-json", action="store_true",
528
                        help="Dump client data in JSON format")
1002 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
529
    enable_disable = parser.add_mutually_exclusive_group()
530
    enable_disable.add_argument("-e", "--enable", action="store_true",
531
                                help="Enable client")
532
    enable_disable.add_argument("-d", "--disable",
533
                                action="store_true",
534
                                help="disable client")
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
535
    parser.add_argument("-b", "--bump-timeout", action="store_true",
536
                        help="Bump timeout for client")
1002 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
537
    start_stop_checker = parser.add_mutually_exclusive_group()
538
    start_stop_checker.add_argument("--start-checker",
539
                                    action="store_true",
540
                                    help="Start checker for client")
541
    start_stop_checker.add_argument("--stop-checker",
542
                                    action="store_true",
543
                                    help="Stop checker for client")
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
544
    parser.add_argument("-V", "--is-enabled", action="store_true",
545
                        help="Check if client is enabled")
546
    parser.add_argument("-r", "--remove", action="store_true",
547
                        help="Remove client")
548
    parser.add_argument("-c", "--checker",
549
                        help="Set checker command for client")
550
    parser.add_argument("-t", "--timeout",
551
                        help="Set timeout for client")
24.1.179 by Björn Påhlsson
New feature:
552
    parser.add_argument("--extended-timeout",
553
                        help="Set extended timeout for client")
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
554
    parser.add_argument("-i", "--interval",
555
                        help="Set checker interval for client")
1002 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
556
    approve_deny_default = parser.add_mutually_exclusive_group()
557
    approve_deny_default.add_argument(
558
        "--approve-by-default", action="store_true",
559
        default=None, dest="approved_by_default",
560
        help="Set client to be approved by default")
561
    approve_deny_default.add_argument(
562
        "--deny-by-default", action="store_false",
563
        dest="approved_by_default",
564
        help="Set client to be denied by default")
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
565
    parser.add_argument("--approval-delay",
566
                        help="Set delay before client approve/deny")
567
    parser.add_argument("--approval-duration",
568
                        help="Set duration of one client approval")
569
    parser.add_argument("-H", "--host", help="Set host for client")
718 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
570
    parser.add_argument("-s", "--secret",
571
                        type=argparse.FileType(mode="rb"),
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
572
                        help="Set password blob (file) for client")
1002 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
573
    approve_deny = parser.add_mutually_exclusive_group()
574
    approve_deny.add_argument(
575
        "-A", "--approve", action="store_true",
576
        help="Approve any current client request")
577
    approve_deny.add_argument("-D", "--deny", action="store_true",
578
                              help="Deny any current client request")
608 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
579
    parser.add_argument("--check", action="store_true",
580
                        help="Run self-test")
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
581
    parser.add_argument("client", nargs="*", help="Client name")
1014 by Teddy Hogeborn
mandos-ctl: Refactor
582
583
584
def commands_and_clients_from_options(options):
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
585
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
586
    commands = []
587
588
    if options.dump_json:
589
        commands.append(DumpJSONCmd())
590
591
    if options.enable:
592
        commands.append(EnableCmd())
593
594
    if options.disable:
595
        commands.append(DisableCmd())
596
597
    if options.bump_timeout:
598
        commands.append(BumpTimeoutCmd(options.bump_timeout))
599
600
    if options.start_checker:
601
        commands.append(StartCheckerCmd())
602
603
    if options.stop_checker:
604
        commands.append(StopCheckerCmd())
605
606
    if options.is_enabled:
607
        commands.append(IsEnabledCmd())
608
609
    if options.remove:
1007 by Teddy Hogeborn
mandos-ctl: Refactor
610
        commands.append(RemoveCmd())
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
611
612
    if options.checker is not None:
613
        commands.append(SetCheckerCmd())
614
615
    if options.timeout is not None:
616
        commands.append(SetTimeoutCmd(options.timeout))
617
618
    if options.extended_timeout:
619
        commands.append(
620
            SetExtendedTimeoutCmd(options.extended_timeout))
621
622
    if options.interval is not None:
623
        command.append(SetIntervalCmd(options.interval))
624
625
    if options.approved_by_default is not None:
626
        if options.approved_by_default:
627
            command.append(ApproveByDefaultCmd())
628
        else:
629
            command.append(DenyByDefaultCmd())
630
631
    if options.approval_delay is not None:
632
        command.append(SetApprovalDelayCmd(options.approval_delay))
633
634
    if options.approval_duration is not None:
635
        command.append(
636
            SetApprovalDurationCmd(options.approval_duration))
637
638
    if options.host is not None:
639
        command.append(SetHostCmd(options.host))
640
641
    if options.secret is not None:
642
        command.append(SetSecretCmd(options.secret))
643
644
    if options.approve:
645
        commands.append(ApproveCmd())
646
647
    if options.deny:
648
        commands.append(DenyCmd())
649
650
    # If no command option has been given, show table of clients,
651
    # optionally verbosely
652
    if not commands:
653
        commands.append(PrintTableCmd(verbose=options.verbose))
654
1008 by Teddy Hogeborn
mandos-ctl: Refactor
655
    return commands, options.client
656
657
658
def main():
1014 by Teddy Hogeborn
mandos-ctl: Refactor
659
    parser = argparse.ArgumentParser()
660
661
    add_command_line_options(parser)
662
663
    options = parser.parse_args()
664
665
    if has_actions(options) and not (options.client or options.all):
666
        parser.error("Options require clients names or --all.")
667
    if options.verbose and has_actions(options):
668
        parser.error("--verbose can only be used alone.")
669
    if options.dump_json and (options.verbose
670
                              or has_actions(options)):
671
        parser.error("--dump-json can only be used alone.")
672
    if options.all and not has_actions(options):
673
        parser.error("--all requires an action.")
674
    if options.is_enabled and len(options.client) > 1:
675
        parser.error("--is-enabled requires exactly one client")
676
677
    commands, clientnames = commands_and_clients_from_options(options)
1008 by Teddy Hogeborn
mandos-ctl: Refactor
678
679
    try:
680
        bus = dbus.SystemBus()
681
        mandos_dbus_objc = bus.get_object(busname, server_path)
682
    except dbus.exceptions.DBusException:
683
        log.critical("Could not connect to Mandos server")
684
        sys.exit(1)
685
686
    mandos_serv = dbus.Interface(mandos_dbus_objc,
687
                                 dbus_interface=server_interface)
688
    mandos_serv_object_manager = dbus.Interface(
689
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
690
1005 by Teddy Hogeborn
mandos-ctl: Filter logging instead of messing with stderr
691
    # Filter out log message from dbus module
692
    dbus_logger = logging.getLogger("dbus.proxies")
693
    class NullFilter(logging.Filter):
694
        def filter(self, record):
695
            return False
696
    dbus_filter = NullFilter()
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
697
    try:
1015 by Teddy Hogeborn
mandos-ctl: Refactor
698
        dbus_logger.addFilter(dbus_filter)
699
        mandos_clients = {path: ifs_and_props[client_interface]
700
                          for path, ifs_and_props in
701
                          mandos_serv_object_manager
702
                          .GetManagedObjects().items()
703
                          if client_interface in ifs_and_props}
785 by Teddy Hogeborn
Support the standard org.freedesktop.DBus.ObjectManager interface.
704
    except dbus.exceptions.DBusException as e:
987 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
705
        log.critical("Failed to access Mandos server through D-Bus:"
706
                     "\n%s", e)
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
707
        sys.exit(1)
1015 by Teddy Hogeborn
mandos-ctl: Refactor
708
    finally:
709
        # restore dbus logger
710
        dbus_logger.removeFilter(dbus_filter)
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
711
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
712
    # Compile dict of (clients: properties) to process
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
713
    clients = {}
714
1008 by Teddy Hogeborn
mandos-ctl: Refactor
715
    if not clientnames:
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
716
        clients = {bus.get_object(busname, path): properties
717
                   for path, properties in mandos_clients.items()}
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
718
    else:
1008 by Teddy Hogeborn
mandos-ctl: Refactor
719
        for name in clientnames:
723.1.4 by Teddy Hogeborn
Use the .items() method instead of .iteritems().
720
            for path, client in mandos_clients.items():
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
721
                if client["Name"] == name:
722
                    client_objc = bus.get_object(busname, path)
723
                    clients[client_objc] = client
724
                    break
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
725
            else:
987 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
726
                log.critical("Client not found on server: %r", name)
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
727
                sys.exit(1)
872 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
728
1003 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
729
    # Run all commands on clients
730
    for command in commands:
1007 by Teddy Hogeborn
mandos-ctl: Refactor
731
        command.run(mandos_serv, clients)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
732
984 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
733

986 by Teddy Hogeborn
Add tests to mandos-ctl's milliseconds_to_string function
734
class Test_milliseconds_to_string(unittest.TestCase):
735
    def test_all(self):
736
        self.assertEqual(milliseconds_to_string(93785000),
737
                         "1T02:03:05")
738
    def test_no_days(self):
739
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
740
    def test_all_zero(self):
741
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
742
    def test_no_fractional_seconds(self):
743
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
744
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
745
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
746
992 by Teddy Hogeborn
mandos-ctl: Add more tests
747
class Test_string_to_delta(unittest.TestCase):
748
    def test_handles_basic_rfc3339(self):
749
        self.assertEqual(string_to_delta("PT2H"),
750
                         datetime.timedelta(0, 7200))
751
    def test_falls_back_to_pre_1_6_1_with_warning(self):
752
        # assertLogs only exists in Python 3.4
753
        if hasattr(self, "assertLogs"):
754
            with self.assertLogs(log, logging.WARNING):
755
                value = string_to_delta("2h")
756
        else:
1006 by Teddy Hogeborn
mandos-ctl: Improve a test when running Python older than 3.4.
757
            class WarningFilter(logging.Filter):
758
                """Don't show, but record the presence of, warnings"""
759
                def filter(self, record):
760
                    is_warning = record.levelno >= logging.WARNING
761
                    self.found = is_warning or getattr(self, "found",
762
                                                       False)
763
                    return not is_warning
764
            warning_filter = WarningFilter()
765
            log.addFilter(warning_filter)
766
            try:
767
                value = string_to_delta("2h")
768
            finally:
769
                log.removeFilter(warning_filter)
770
            self.assertTrue(getattr(warning_filter, "found", False))
992 by Teddy Hogeborn
mandos-ctl: Add more tests
771
        self.assertEqual(value, datetime.timedelta(0, 7200))
772
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
773
774
class TestCmd(unittest.TestCase):
775
    """Abstract class for tests of command classes"""
994 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
776
    def setUp(self):
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
777
        testcase = self
778
        class MockClient(object):
779
            def __init__(self, name, **attributes):
780
                self.__dbus_object_path__ = "objpath_{}".format(name)
781
                self.attributes = attributes
782
                self.attributes["Name"] = name
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
783
                self.calls = []
784
            def Set(self, interface, property, value, dbus_interface):
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
785
                testcase.assertEqual(interface, client_interface)
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
786
                testcase.assertEqual(dbus_interface,
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
787
                                     dbus.PROPERTIES_IFACE)
788
                self.attributes[property] = value
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
789
                self.calls.append(("Set", (interface, property, value,
790
                                           dbus_interface)))
791
            def Get(self, interface, property, dbus_interface):
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
792
                testcase.assertEqual(interface, client_interface)
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
793
                testcase.assertEqual(dbus_interface,
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
794
                                     dbus.PROPERTIES_IFACE)
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
795
                self.calls.append(("Get", (interface, property,
796
                                           dbus_interface)))
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
797
                return self.attributes[property]
798
            def __getitem__(self, key):
799
                return self.attributes[key]
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
800
            def __setitem__(self, key, value):
801
                self.attributes[key] = value
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
802
        self.clients = collections.OrderedDict([
803
            ("foo",
804
             MockClient(
805
                 "foo",
806
                 KeyID=("92ed150794387c03ce684574b1139a65"
807
                        "94a34f895daaaf09fd8ea90a27cddb12"),
808
                 Secret=b"secret",
809
                 Host="foo.example.org",
810
                 Enabled=dbus.Boolean(True),
811
                 Timeout=300000,
812
                 LastCheckedOK="2019-02-03T00:00:00",
813
                 Created="2019-01-02T00:00:00",
814
                 Interval=120000,
815
                 Fingerprint=("778827225BA7DE539C5A"
816
                              "7CFA59CFF7CDBD9A5920"),
817
                 CheckerRunning=dbus.Boolean(False),
818
                 LastEnabled="2019-01-03T00:00:00",
819
                 ApprovalPending=dbus.Boolean(False),
820
                 ApprovedByDefault=dbus.Boolean(True),
821
                 LastApprovalRequest="",
822
                 ApprovalDelay=0,
823
                 ApprovalDuration=1000,
824
                 Checker="fping -q -- %(host)s",
825
                 ExtendedTimeout=900000,
826
                 Expires="2019-02-04T00:00:00",
827
                 LastCheckerStatus=0)),
828
            ("barbar",
829
             MockClient(
830
                 "barbar",
831
                 KeyID=("0558568eedd67d622f5c83b35a115f79"
832
                        "6ab612cff5ad227247e46c2b020f441c"),
833
                 Secret=b"secretbar",
834
                 Host="192.0.2.3",
835
                 Enabled=dbus.Boolean(True),
836
                 Timeout=300000,
837
                 LastCheckedOK="2019-02-04T00:00:00",
838
                 Created="2019-01-03T00:00:00",
839
                 Interval=120000,
840
                 Fingerprint=("3E393AEAEFB84C7E89E2"
841
                              "F547B3A107558FCA3A27"),
842
                 CheckerRunning=dbus.Boolean(True),
843
                 LastEnabled="2019-01-04T00:00:00",
844
                 ApprovalPending=dbus.Boolean(False),
845
                 ApprovedByDefault=dbus.Boolean(False),
846
                 LastApprovalRequest="2019-01-03T00:00:00",
847
                 ApprovalDelay=30000,
848
                 ApprovalDuration=1000,
849
                 Checker=":",
850
                 ExtendedTimeout=900000,
851
                 Expires="2019-02-05T00:00:00",
852
                 LastCheckerStatus=-2)),
853
            ])
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
854
        self.client = self.clients["foo"]
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
855
856
class TestPrintTableCmd(TestCmd):
857
    def test_normal(self):
858
        output = PrintTableCmd().output(self.clients)
859
        expected_output = """
860
Name   Enabled Timeout  Last Successful Check
861
foo    Yes     00:05:00 2019-02-03T00:00:00  
862
barbar Yes     00:05:00 2019-02-04T00:00:00  
863
"""[1:-1]
864
        self.assertEqual(output, expected_output)
865
    def test_verbose(self):
866
        output = PrintTableCmd(verbose=True).output(self.clients)
867
        expected_output = """
868
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
869
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                  
870
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                 
871
"""[1:-1]
872
        self.assertEqual(output, expected_output)
873
    def test_one_client(self):
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
874
        output = PrintTableCmd().output({"foo": self.client})
1010 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
875
        expected_output = """
876
Name Enabled Timeout  Last Successful Check
877
foo  Yes     00:05:00 2019-02-03T00:00:00  
878
"""[1:-1]
879
        self.assertEqual(output, expected_output)
994 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
880
1012 by Teddy Hogeborn
mandos-ctl: Add test for DumpJSONCmd class
881
class TestDumpJSONCmd(TestCmd):
882
    def setUp(self):
883
        self.expected_json = {
884
            "foo": {
885
                "Name": "foo",
886
                "KeyID": ("92ed150794387c03ce684574b1139a65"
887
                          "94a34f895daaaf09fd8ea90a27cddb12"),
888
                "Host": "foo.example.org",
889
                "Enabled": True,
890
                "Timeout": 300000,
891
                "LastCheckedOK": "2019-02-03T00:00:00",
892
                "Created": "2019-01-02T00:00:00",
893
                "Interval": 120000,
894
                "Fingerprint": ("778827225BA7DE539C5A"
895
                                "7CFA59CFF7CDBD9A5920"),
896
                "CheckerRunning": False,
897
                "LastEnabled": "2019-01-03T00:00:00",
898
                "ApprovalPending": False,
899
                "ApprovedByDefault": True,
900
                "LastApprovalRequest": "",
901
                "ApprovalDelay": 0,
902
                "ApprovalDuration": 1000,
903
                "Checker": "fping -q -- %(host)s",
904
                "ExtendedTimeout": 900000,
905
                "Expires": "2019-02-04T00:00:00",
906
                "LastCheckerStatus": 0,
907
            },
908
            "barbar": {
909
                "Name": "barbar",
910
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
911
                          "6ab612cff5ad227247e46c2b020f441c"),
912
                "Host": "192.0.2.3",
913
                "Enabled": True,
914
                "Timeout": 300000,
915
                "LastCheckedOK": "2019-02-04T00:00:00",
916
                "Created": "2019-01-03T00:00:00",
917
                "Interval": 120000,
918
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
919
                                "F547B3A107558FCA3A27"),
920
                "CheckerRunning": True,
921
                "LastEnabled": "2019-01-04T00:00:00",
922
                "ApprovalPending": False,
923
                "ApprovedByDefault": False,
924
                "LastApprovalRequest": "2019-01-03T00:00:00",
925
                "ApprovalDelay": 30000,
926
                "ApprovalDuration": 1000,
927
                "Checker": ":",
928
                "ExtendedTimeout": 900000,
929
                "Expires": "2019-02-05T00:00:00",
930
                "LastCheckerStatus": -2,
931
            },
932
        }
933
        return super(TestDumpJSONCmd, self).setUp()
934
    def test_normal(self):
935
        json_data = json.loads(DumpJSONCmd().output(self.clients))
936
        self.assertDictEqual(json_data, self.expected_json)
937
    def test_one_client(self):
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
938
        clients = {"foo": self.client}
1012 by Teddy Hogeborn
mandos-ctl: Add test for DumpJSONCmd class
939
        json_data = json.loads(DumpJSONCmd().output(clients))
940
        expected_json = {"foo": self.expected_json["foo"]}
941
        self.assertDictEqual(json_data, expected_json)
994 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
942
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
943
class TestIsEnabledCmd(TestCmd):
944
    def test_is_enabled(self):
945
        self.assertTrue(all(IsEnabledCmd().is_enabled(client)
946
                            for client in self.clients.values()))
947
    def test_is_enabled_does_get_attribute(self):
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
948
        self.assertTrue(IsEnabledCmd().is_enabled(self.client))
949
        self.assertListEqual(self.client.calls,
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
950
                             [("Get",
951
                               ("se.recompile.Mandos.Client",
952
                                "Enabled",
953
                                "org.freedesktop.DBus.Properties"))])
954
    def test_is_enabled_run_exits_successfully(self):
955
        with self.assertRaises(SystemExit) as e:
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
956
            IsEnabledCmd().run(None, [self.client])
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
957
        if e.exception.code is not None:
958
            self.assertEqual(e.exception.code, 0)
959
        else:
960
            self.assertIsNone(e.exception.code)
961
    def test_is_enabled_run_exits_with_failure(self):
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
962
        self.client["Enabled"] = dbus.Boolean(False)
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
963
        with self.assertRaises(SystemExit) as e:
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
964
            IsEnabledCmd().run(None, [self.client])
1013 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
965
        if isinstance(e.exception.code, int):
966
            self.assertNotEqual(e.exception.code, 0)
967
        else:
968
            self.assertIsNotNone(e.exception.code)
969
970
1017 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
971
class TestRemoveCmd(TestCmd):
972
    def test_remove(self):
973
        class MockMandos(object):
974
            def __init__(self):
975
                self.calls = []
976
            def RemoveClient(self, dbus_path):
977
                self.calls.append(("RemoveClient", (dbus_path,)))
978
        mandos = MockMandos()
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
979
        RemoveCmd().run(mandos, [self.client])
1017 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
980
        self.assertEqual(len(mandos.calls), 1)
981
        self.assertListEqual(mandos.calls,
982
                             [("RemoveClient",
1018 by Teddy Hogeborn
mandos-ctl: Refactor tests
983
                               (self.client.__dbus_object_path__,))])
1017 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
984
985
986 by Teddy Hogeborn
Add tests to mandos-ctl's milliseconds_to_string function
986

984 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
987
def should_only_run_tests():
988
    parser = argparse.ArgumentParser(add_help=False)
989
    parser.add_argument("--check", action='store_true')
990
    args, unknown_args = parser.parse_known_args()
991
    run_tests = args.check
992
    if run_tests:
993
        # Remove --check argument from sys.argv
994
        sys.argv[1:] = unknown_args
995
    return run_tests
996
997
# Add all tests from doctest strings
998
def load_tests(loader, tests, none):
999
    import doctest
1000
    tests.addTests(doctest.DocTestSuite())
1001
    return tests
745 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
1002
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
1003
if __name__ == "__main__":
984 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
1004
    if should_only_run_tests():
1005
        # Call using ./tdd-python-script --check [--verbose]
1006
        unittest.main()
1007
    else:
1008
        main()