/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.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
45
46
import dbus
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
47
237.7.536 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
237.7.535 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
237.7.536 by Teddy Hogeborn
mandos-ctl: Show warnings
57
logging.captureWarnings(True)   # Show warnings via the logging system
58
237.23.7 by Teddy Hogeborn
Use the .major attribute on sys.version_info instead of using "[0]".
59
if sys.version_info.major == 2:
237.7.266 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
60
    str = unicode
61
237.8.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"
237.8.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"
377 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
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
71
237.7.333 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
237.7.420 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)
237.7.420 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
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
86
87
def rfc3339_duration_to_delta(duration):
237.7.157 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
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
89
237.7.156 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)
237.7.538 by Teddy Hogeborn
mandos-ctl (rfc3339_duration_to_delta): Improve tests
96
    >>> rfc3339_duration_to_delta("P60M")
97
    datetime.timedelta(1680)
237.7.156 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)
237.7.538 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'
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
135
    """
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
136
237.7.157 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
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
138
    # 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.
139
    # values, like seconds.  The current code, while more esoteric, is
140
    # cleaner without depending on a parsing library.  If Python had a
237.7.156 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.
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
143
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
144
    # New type for defining tokens, syntax, and semantics all-in-one
237.7.301 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
237.7.156 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),
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
155
                         frozenset((token_end, )))
237.7.156 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),
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
177
                       frozenset((token_end, )))
237.7.156 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,
237.7.269 by Teddy Hogeborn
Fix two mutually cancelling bugs.
181
                                      token_week)))
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
182
    # Define starting values:
183
    # Value so far
184
    value = datetime.timedelta()
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
185
    found_token = None
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
186
    # Following valid tokens
187
    followers = frozenset((token_duration, ))
188
    # String left to parse
189
    s = duration
237.7.156 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
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
211
            raise ValueError("Invalid RFC 3339 duration: {!r}"
212
                             .format(duration))
237.7.156 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):
237.7.549 by Teddy Hogeborn
mandos-ctl: White space changes only
218
    """Parse a string and return a datetime.timedelta"""
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
219
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
220
    try:
221
        return rfc3339_duration_to_delta(interval)
237.7.539 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):
237.7.549 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
237.7.539 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
    """
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
251
237.7.164 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]?)")
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
254
237.14.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
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
270
237.7.551 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"""
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
276
    def run(self, mandos, clients):
237.7.551 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."""
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
280
        self.mandos = mandos
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
281
        for client, properties in clients.items():
282
            self.run_on_one_client(client, properties)
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
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")
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
293
    def run(self, mandos, clients):
237.7.551 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"""
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
298
    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
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
237.7.559 by Teddy Hogeborn
mandos-ctl: Refactor; move TableOfClients into PrintTableCmd
324
237.7.551 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")
237.7.559 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
237.7.551 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):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
422
    def run_on_one_client(self, client, properties):
423
        if self.is_enabled(client, properties):
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
424
            sys.exit(0)
425
        sys.exit(1)
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
426
    def is_enabled(self, client, properties):
427
        return bool(properties["Enabled"])
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
428
429
class RemoveCmd(Command):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
430
    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
431
        self.mandos.RemoveClient(client.__dbus_object_path__)
432
433
class ApproveCmd(Command):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
434
    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
435
        client.Approve(dbus.Boolean(True),
436
                       dbus_interface=client_interface)
437
438
class DenyCmd(Command):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
439
    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
440
        client.Approve(dbus.Boolean(False),
441
                       dbus_interface=client_interface)
442
443
class EnableCmd(PropertyCmd):
444
    property = "Enabled"
445
    value_to_set = dbus.Boolean(True)
446
447
class DisableCmd(PropertyCmd):
448
    property = "Enabled"
449
    value_to_set = dbus.Boolean(False)
450
451
class BumpTimeoutCmd(PropertyCmd):
452
    property = "LastCheckedOK"
453
    value_to_set = ""
454
455
class StartCheckerCmd(PropertyCmd):
456
    property = "CheckerRunning"
457
    value_to_set = dbus.Boolean(True)
458
459
class StopCheckerCmd(PropertyCmd):
460
    property = "CheckerRunning"
461
    value_to_set = dbus.Boolean(False)
462
463
class ApproveByDefaultCmd(PropertyCmd):
464
    property = "ApprovedByDefault"
465
    value_to_set = dbus.Boolean(True)
466
467
class DenyByDefaultCmd(PropertyCmd):
468
    property = "ApprovedByDefault"
469
    value_to_set = dbus.Boolean(False)
470
471
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
472
    property = "Checker"
473
474
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
475
    property = "Host"
476
477
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
478
    property = "Secret"
479
480
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
481
    property = "Timeout"
482
483
class SetExtendedTimeoutCmd(PropertyCmd,
484
                            MillisecondsValueArgumentMixIn):
485
    property = "ExtendedTimeout"
486
487
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
488
    property = "Interval"
489
490
class SetApprovalDelayCmd(PropertyCmd,
491
                          MillisecondsValueArgumentMixIn):
492
    property = "ApprovalDelay"
493
494
class SetApprovalDurationCmd(PropertyCmd,
495
                             MillisecondsValueArgumentMixIn):
496
    property = "ApprovalDuration"
497
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
498
def has_actions(options):
499
    return any((options.enable,
500
                options.disable,
501
                options.bump_timeout,
502
                options.start_checker,
503
                options.stop_checker,
504
                options.is_enabled,
505
                options.remove,
506
                options.checker is not None,
507
                options.timeout is not None,
24.1.179 by Björn Påhlsson
New feature:
508
                options.extended_timeout is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
509
                options.interval is not None,
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
510
                options.approved_by_default is not None,
511
                options.approval_delay is not None,
512
                options.approval_duration is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
513
                options.host is not None,
514
                options.secret is not None,
515
                options.approve,
516
                options.deny))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
517
237.7.562 by Teddy Hogeborn
mandos-ctl: Refactor
518
def add_command_line_options(parser):
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
519
    parser.add_argument("--version", action="version",
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
520
                        version="%(prog)s {}".format(version),
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
521
                        help="show version number and exit")
522
    parser.add_argument("-a", "--all", action="store_true",
523
                        help="Select all clients")
524
    parser.add_argument("-v", "--verbose", action="store_true",
525
                        help="Print all fields")
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
526
    parser.add_argument("-j", "--dump-json", action="store_true",
527
                        help="Dump client data in JSON format")
237.7.550 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
528
    enable_disable = parser.add_mutually_exclusive_group()
529
    enable_disable.add_argument("-e", "--enable", action="store_true",
530
                                help="Enable client")
531
    enable_disable.add_argument("-d", "--disable",
532
                                action="store_true",
533
                                help="disable client")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
534
    parser.add_argument("-b", "--bump-timeout", action="store_true",
535
                        help="Bump timeout for client")
237.7.550 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
536
    start_stop_checker = parser.add_mutually_exclusive_group()
537
    start_stop_checker.add_argument("--start-checker",
538
                                    action="store_true",
539
                                    help="Start checker for client")
540
    start_stop_checker.add_argument("--stop-checker",
541
                                    action="store_true",
542
                                    help="Stop checker for client")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
543
    parser.add_argument("-V", "--is-enabled", action="store_true",
544
                        help="Check if client is enabled")
545
    parser.add_argument("-r", "--remove", action="store_true",
546
                        help="Remove client")
547
    parser.add_argument("-c", "--checker",
548
                        help="Set checker command for client")
549
    parser.add_argument("-t", "--timeout",
550
                        help="Set timeout for client")
24.1.179 by Björn Påhlsson
New feature:
551
    parser.add_argument("--extended-timeout",
552
                        help="Set extended timeout for client")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
553
    parser.add_argument("-i", "--interval",
554
                        help="Set checker interval for client")
237.7.550 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
555
    approve_deny_default = parser.add_mutually_exclusive_group()
556
    approve_deny_default.add_argument(
557
        "--approve-by-default", action="store_true",
558
        default=None, dest="approved_by_default",
559
        help="Set client to be approved by default")
560
    approve_deny_default.add_argument(
561
        "--deny-by-default", action="store_false",
562
        dest="approved_by_default",
563
        help="Set client to be denied by default")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
564
    parser.add_argument("--approval-delay",
565
                        help="Set delay before client approve/deny")
566
    parser.add_argument("--approval-duration",
567
                        help="Set duration of one client approval")
568
    parser.add_argument("-H", "--host", help="Set host for client")
237.7.266 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
569
    parser.add_argument("-s", "--secret",
570
                        type=argparse.FileType(mode="rb"),
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
571
                        help="Set password blob (file) for client")
237.7.550 by Teddy Hogeborn
mandos-ctl: Make option parsing slightly more strict
572
    approve_deny = parser.add_mutually_exclusive_group()
573
    approve_deny.add_argument(
574
        "-A", "--approve", action="store_true",
575
        help="Approve any current client request")
576
    approve_deny.add_argument("-D", "--deny", action="store_true",
577
                              help="Deny any current client request")
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
578
    parser.add_argument("--check", action="store_true",
579
                        help="Run self-test")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
580
    parser.add_argument("client", nargs="*", help="Client name")
237.7.562 by Teddy Hogeborn
mandos-ctl: Refactor
581
582
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
583
def commands_from_options(options):
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
584
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
585
    commands = []
586
587
    if options.dump_json:
588
        commands.append(DumpJSONCmd())
589
590
    if options.enable:
591
        commands.append(EnableCmd())
592
593
    if options.disable:
594
        commands.append(DisableCmd())
595
596
    if options.bump_timeout:
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
597
        commands.append(BumpTimeoutCmd())
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
598
599
    if options.start_checker:
600
        commands.append(StartCheckerCmd())
601
602
    if options.stop_checker:
603
        commands.append(StopCheckerCmd())
604
605
    if options.is_enabled:
606
        commands.append(IsEnabledCmd())
607
608
    if options.remove:
237.7.555 by Teddy Hogeborn
mandos-ctl: Refactor
609
        commands.append(RemoveCmd())
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
610
611
    if options.checker is not None:
612
        commands.append(SetCheckerCmd())
613
614
    if options.timeout is not None:
615
        commands.append(SetTimeoutCmd(options.timeout))
616
617
    if options.extended_timeout:
618
        commands.append(
619
            SetExtendedTimeoutCmd(options.extended_timeout))
620
621
    if options.interval is not None:
622
        command.append(SetIntervalCmd(options.interval))
623
624
    if options.approved_by_default is not None:
625
        if options.approved_by_default:
626
            command.append(ApproveByDefaultCmd())
627
        else:
628
            command.append(DenyByDefaultCmd())
629
630
    if options.approval_delay is not None:
631
        command.append(SetApprovalDelayCmd(options.approval_delay))
632
633
    if options.approval_duration is not None:
634
        command.append(
635
            SetApprovalDurationCmd(options.approval_duration))
636
637
    if options.host is not None:
638
        command.append(SetHostCmd(options.host))
639
640
    if options.secret is not None:
641
        command.append(SetSecretCmd(options.secret))
642
643
    if options.approve:
644
        commands.append(ApproveCmd())
645
646
    if options.deny:
647
        commands.append(DenyCmd())
648
649
    # If no command option has been given, show table of clients,
650
    # optionally verbosely
651
    if not commands:
652
        commands.append(PrintTableCmd(verbose=options.verbose))
653
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
654
    return commands
237.7.556 by Teddy Hogeborn
mandos-ctl: Refactor
655
656
657
def main():
237.7.562 by Teddy Hogeborn
mandos-ctl: Refactor
658
    parser = argparse.ArgumentParser()
659
660
    add_command_line_options(parser)
661
662
    options = parser.parse_args()
663
664
    if has_actions(options) and not (options.client or options.all):
665
        parser.error("Options require clients names or --all.")
666
    if options.verbose and has_actions(options):
667
        parser.error("--verbose can only be used alone.")
668
    if options.dump_json and (options.verbose
669
                              or has_actions(options)):
670
        parser.error("--dump-json can only be used alone.")
671
    if options.all and not has_actions(options):
672
        parser.error("--all requires an action.")
673
    if options.is_enabled and len(options.client) > 1:
674
        parser.error("--is-enabled requires exactly one client")
675
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
676
    clientnames = options.client
237.7.556 by Teddy Hogeborn
mandos-ctl: Refactor
677
678
    try:
679
        bus = dbus.SystemBus()
680
        mandos_dbus_objc = bus.get_object(busname, server_path)
681
    except dbus.exceptions.DBusException:
682
        log.critical("Could not connect to Mandos server")
683
        sys.exit(1)
684
685
    mandos_serv = dbus.Interface(mandos_dbus_objc,
686
                                 dbus_interface=server_interface)
687
    mandos_serv_object_manager = dbus.Interface(
688
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
689
237.7.553 by Teddy Hogeborn
mandos-ctl: Filter logging instead of messing with stderr
690
    # Filter out log message from dbus module
691
    dbus_logger = logging.getLogger("dbus.proxies")
692
    class NullFilter(logging.Filter):
693
        def filter(self, record):
694
            return False
695
    dbus_filter = NullFilter()
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
696
    try:
237.7.563 by Teddy Hogeborn
mandos-ctl: Refactor
697
        dbus_logger.addFilter(dbus_filter)
698
        mandos_clients = {path: ifs_and_props[client_interface]
699
                          for path, ifs_and_props in
700
                          mandos_serv_object_manager
701
                          .GetManagedObjects().items()
702
                          if client_interface in ifs_and_props}
237.7.333 by Teddy Hogeborn
Support the standard org.freedesktop.DBus.ObjectManager interface.
703
    except dbus.exceptions.DBusException as e:
237.7.535 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
704
        log.critical("Failed to access Mandos server through D-Bus:"
705
                     "\n%s", e)
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
706
        sys.exit(1)
237.7.563 by Teddy Hogeborn
mandos-ctl: Refactor
707
    finally:
708
        # restore dbus logger
709
        dbus_logger.removeFilter(dbus_filter)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
710
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
711
    # Compile dict of (clients: properties) to process
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
712
    clients = {}
713
237.7.556 by Teddy Hogeborn
mandos-ctl: Refactor
714
    if not clientnames:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
715
        clients = {bus.get_object(busname, path): properties
716
                   for path, properties in mandos_clients.items()}
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
717
    else:
237.7.556 by Teddy Hogeborn
mandos-ctl: Refactor
718
        for name in clientnames:
237.23.4 by Teddy Hogeborn
Use the .items() method instead of .iteritems().
719
            for path, client in mandos_clients.items():
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
720
                if client["Name"] == name:
721
                    client_objc = bus.get_object(busname, path)
722
                    clients[client_objc] = client
723
                    break
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
724
            else:
237.7.535 by Teddy Hogeborn
mandos-ctl: Use logging module instead of print() for errors
725
                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.
726
                sys.exit(1)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
727
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
728
    # Run all commands on clients
237.7.570 by Teddy Hogeborn
mandos-ctl: Refactor
729
    commands = commands_from_options(options)
237.7.551 by Teddy Hogeborn
mandos-ctl: Separate determining what to do and actually doing it
730
    for command in commands:
237.7.555 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
237.7.532 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
733

237.7.534 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
237.7.540 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:
237.7.554 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))
237.7.540 by Teddy Hogeborn
mandos-ctl: Add more tests
771
        self.assertEqual(value, datetime.timedelta(0, 7200))
772
237.7.558 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"""
237.7.542 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
776
    def setUp(self):
237.7.558 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
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
783
                self.calls = []
784
            def Set(self, interface, property, value, dbus_interface):
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
785
                testcase.assertEqual(interface, client_interface)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
786
                testcase.assertEqual(dbus_interface,
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
787
                                     dbus.PROPERTIES_IFACE)
788
                self.attributes[property] = value
237.7.561 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):
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
792
                testcase.assertEqual(interface, client_interface)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
793
                testcase.assertEqual(dbus_interface,
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
794
                                     dbus.PROPERTIES_IFACE)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
795
                self.calls.append(("Get", (interface, property,
796
                                           dbus_interface)))
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
797
                return self.attributes[property]
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
798
            def Approve(self, approve, dbus_interface):
799
                testcase.assertEqual(dbus_interface, client_interface)
800
                self.calls.append(("Approve", (approve,
801
                                               dbus_interface)))
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
802
        self.client = MockClient(
803
            "foo",
804
            KeyID=("92ed150794387c03ce684574b1139a65"
805
                   "94a34f895daaaf09fd8ea90a27cddb12"),
806
            Secret=b"secret",
807
            Host="foo.example.org",
808
            Enabled=dbus.Boolean(True),
809
            Timeout=300000,
810
            LastCheckedOK="2019-02-03T00:00:00",
811
            Created="2019-01-02T00:00:00",
812
            Interval=120000,
813
            Fingerprint=("778827225BA7DE539C5A"
814
                         "7CFA59CFF7CDBD9A5920"),
815
            CheckerRunning=dbus.Boolean(False),
816
            LastEnabled="2019-01-03T00:00:00",
817
            ApprovalPending=dbus.Boolean(False),
818
            ApprovedByDefault=dbus.Boolean(True),
819
            LastApprovalRequest="",
820
            ApprovalDelay=0,
821
            ApprovalDuration=1000,
822
            Checker="fping -q -- %(host)s",
823
            ExtendedTimeout=900000,
824
            Expires="2019-02-04T00:00:00",
825
            LastCheckerStatus=0)
826
        self.other_client = MockClient(
827
            "barbar",
828
            KeyID=("0558568eedd67d622f5c83b35a115f79"
829
                   "6ab612cff5ad227247e46c2b020f441c"),
830
            Secret=b"secretbar",
831
            Host="192.0.2.3",
832
            Enabled=dbus.Boolean(True),
833
            Timeout=300000,
834
            LastCheckedOK="2019-02-04T00:00:00",
835
            Created="2019-01-03T00:00:00",
836
            Interval=120000,
837
            Fingerprint=("3E393AEAEFB84C7E89E2"
838
                         "F547B3A107558FCA3A27"),
839
            CheckerRunning=dbus.Boolean(True),
840
            LastEnabled="2019-01-04T00:00:00",
841
            ApprovalPending=dbus.Boolean(False),
842
            ApprovedByDefault=dbus.Boolean(False),
843
            LastApprovalRequest="2019-01-03T00:00:00",
844
            ApprovalDelay=30000,
845
            ApprovalDuration=1000,
846
            Checker=":",
847
            ExtendedTimeout=900000,
848
            Expires="2019-02-05T00:00:00",
849
            LastCheckerStatus=-2)
850
        self.clients =  collections.OrderedDict(
851
            [
852
                (self.client, self.client.attributes),
853
                (self.other_client, self.other_client.attributes),
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
854
            ])
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
855
        self.one_client = {self.client: self.client.attributes}
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
856
857
class TestPrintTableCmd(TestCmd):
858
    def test_normal(self):
859
        output = PrintTableCmd().output(self.clients)
860
        expected_output = """
861
Name   Enabled Timeout  Last Successful Check
862
foo    Yes     00:05:00 2019-02-03T00:00:00  
863
barbar Yes     00:05:00 2019-02-04T00:00:00  
864
"""[1:-1]
865
        self.assertEqual(output, expected_output)
866
    def test_verbose(self):
867
        output = PrintTableCmd(verbose=True).output(self.clients)
868
        expected_output = """
869
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
870
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                  
871
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                 
872
"""[1:-1]
873
        self.assertEqual(output, expected_output)
874
    def test_one_client(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
875
        output = PrintTableCmd().output(self.one_client)
237.7.558 by Teddy Hogeborn
mandos-ctl: Refactor; test PrintTableCmd instead of TableOfClients
876
        expected_output = """
877
Name Enabled Timeout  Last Successful Check
878
foo  Yes     00:05:00 2019-02-03T00:00:00  
879
"""[1:-1]
880
        self.assertEqual(output, expected_output)
237.7.542 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
881
237.7.560 by Teddy Hogeborn
mandos-ctl: Add test for DumpJSONCmd class
882
class TestDumpJSONCmd(TestCmd):
883
    def setUp(self):
884
        self.expected_json = {
885
            "foo": {
886
                "Name": "foo",
887
                "KeyID": ("92ed150794387c03ce684574b1139a65"
888
                          "94a34f895daaaf09fd8ea90a27cddb12"),
889
                "Host": "foo.example.org",
890
                "Enabled": True,
891
                "Timeout": 300000,
892
                "LastCheckedOK": "2019-02-03T00:00:00",
893
                "Created": "2019-01-02T00:00:00",
894
                "Interval": 120000,
895
                "Fingerprint": ("778827225BA7DE539C5A"
896
                                "7CFA59CFF7CDBD9A5920"),
897
                "CheckerRunning": False,
898
                "LastEnabled": "2019-01-03T00:00:00",
899
                "ApprovalPending": False,
900
                "ApprovedByDefault": True,
901
                "LastApprovalRequest": "",
902
                "ApprovalDelay": 0,
903
                "ApprovalDuration": 1000,
904
                "Checker": "fping -q -- %(host)s",
905
                "ExtendedTimeout": 900000,
906
                "Expires": "2019-02-04T00:00:00",
907
                "LastCheckerStatus": 0,
908
            },
909
            "barbar": {
910
                "Name": "barbar",
911
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
912
                          "6ab612cff5ad227247e46c2b020f441c"),
913
                "Host": "192.0.2.3",
914
                "Enabled": True,
915
                "Timeout": 300000,
916
                "LastCheckedOK": "2019-02-04T00:00:00",
917
                "Created": "2019-01-03T00:00:00",
918
                "Interval": 120000,
919
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
920
                                "F547B3A107558FCA3A27"),
921
                "CheckerRunning": True,
922
                "LastEnabled": "2019-01-04T00:00:00",
923
                "ApprovalPending": False,
924
                "ApprovedByDefault": False,
925
                "LastApprovalRequest": "2019-01-03T00:00:00",
926
                "ApprovalDelay": 30000,
927
                "ApprovalDuration": 1000,
928
                "Checker": ":",
929
                "ExtendedTimeout": 900000,
930
                "Expires": "2019-02-05T00:00:00",
931
                "LastCheckerStatus": -2,
932
            },
933
        }
934
        return super(TestDumpJSONCmd, self).setUp()
935
    def test_normal(self):
936
        json_data = json.loads(DumpJSONCmd().output(self.clients))
937
        self.assertDictEqual(json_data, self.expected_json)
938
    def test_one_client(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
939
        clients = self.one_client
237.7.560 by Teddy Hogeborn
mandos-ctl: Add test for DumpJSONCmd class
940
        json_data = json.loads(DumpJSONCmd().output(clients))
941
        expected_json = {"foo": self.expected_json["foo"]}
942
        self.assertDictEqual(json_data, expected_json)
237.7.542 by Teddy Hogeborn
mandos-ctl: Add tests for table_rows_of_clients()
943
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
944
class TestIsEnabledCmd(TestCmd):
945
    def test_is_enabled(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
946
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
947
                            for client, properties in self.clients.items()))
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
948
    def test_is_enabled_run_exits_successfully(self):
949
        with self.assertRaises(SystemExit) as e:
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
950
            IsEnabledCmd().run(None, self.one_client)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
951
        if e.exception.code is not None:
952
            self.assertEqual(e.exception.code, 0)
953
        else:
954
            self.assertIsNone(e.exception.code)
955
    def test_is_enabled_run_exits_with_failure(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
956
        self.client.attributes["Enabled"] = dbus.Boolean(False)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
957
        with self.assertRaises(SystemExit) as e:
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
958
            IsEnabledCmd().run(None, self.one_client)
237.7.561 by Teddy Hogeborn
mandos-ctl: Add test for IsEnabledCmd class
959
        if isinstance(e.exception.code, int):
960
            self.assertNotEqual(e.exception.code, 0)
961
        else:
962
            self.assertIsNotNone(e.exception.code)
963
237.7.565 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
964
class TestRemoveCmd(TestCmd):
965
    def test_remove(self):
966
        class MockMandos(object):
967
            def __init__(self):
968
                self.calls = []
969
            def RemoveClient(self, dbus_path):
970
                self.calls.append(("RemoveClient", (dbus_path,)))
971
        mandos = MockMandos()
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
972
        super(TestRemoveCmd, self).setUp()
973
        RemoveCmd().run(mandos, self.clients)
974
        self.assertEqual(len(mandos.calls), 2)
975
        for client in self.clients:
976
            self.assertIn(("RemoveClient",
977
                           (client.__dbus_object_path__,)),
978
                          mandos.calls)
237.7.565 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
979
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
980
class TestApproveCmd(TestCmd):
981
    def test_approve(self):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
982
        ApproveCmd().run(None, self.clients)
983
        for client in self.clients:
984
            self.assertIn(("Approve", (True, client_interface)),
985
                          client.calls)
986
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
987
class TestDenyCmd(TestCmd):
237.7.568 by Teddy Hogeborn
mandos-ctl: Bug fix: fix client/properties confusion
988
    def test_deny(self):
989
        DenyCmd().run(None, self.clients)
990
        for client in self.clients:
991
            self.assertIn(("Approve", (False, client_interface)),
992
                          client.calls)
237.7.567 by Teddy Hogeborn
mandos-ctl: New tests for ApproveCmd and DenyCmd
993
237.7.569 by Teddy Hogeborn
mandos-ctl: Add test for EnableCmd and DisableCmd
994
class TestEnableCmd(TestCmd):
995
    def test_enable(self):
996
        for client in self.clients:
997
            client.attributes["Enabled"] = False
998
999
        EnableCmd().run(None, self.clients)
1000
1001
        for client in self.clients:
1002
            self.assertTrue(client.attributes["Enabled"])
1003
1004
class TestDisableCmd(TestCmd):
1005
    def test_disable(self):
1006
        DisableCmd().run(None, self.clients)
1007
1008
        for client in self.clients:
1009
            self.assertFalse(client.attributes["Enabled"])
1010
237.7.565 by Teddy Hogeborn
mandos-ctl: Add test for RemoveCmd
1011
237.7.534 by Teddy Hogeborn
Add tests to mandos-ctl's milliseconds_to_string function
1012

237.7.532 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
1013
def should_only_run_tests():
1014
    parser = argparse.ArgumentParser(add_help=False)
1015
    parser.add_argument("--check", action='store_true')
1016
    args, unknown_args = parser.parse_known_args()
1017
    run_tests = args.check
1018
    if run_tests:
1019
        # Remove --check argument from sys.argv
1020
        sys.argv[1:] = unknown_args
1021
    return run_tests
1022
1023
# Add all tests from doctest strings
1024
def load_tests(loader, tests, none):
1025
    import doctest
1026
    tests.addTests(doctest.DocTestSuite())
1027
    return tests
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
1028
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
1029
if __name__ == "__main__":
237.7.532 by Teddy Hogeborn
Make mandos-ctl use unittest instead of doctest module
1030
    if should_only_run_tests():
1031
        # Call using ./tdd-python-script --check [--verbose]
1032
        unittest.main()
1033
    else:
1034
        main()