/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-02 02:43:59 UTC
  • Revision ID: teddy@recompile.se-20190302024359-x3p601t67ki2h2mn
mandos-ctl: Refactor

* mandos-ctl (Test_TableOfClients): Don't test rows() method; test
                                    string representation directly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
3
 
# 
 
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*")))); -*-
 
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
# 
6
 
# Copyright © 2008-2012 Teddy Hogeborn
7
 
# Copyright © 2008-2012 Björn Påhlsson
8
 
# 
9
 
# This program is free software: you can redistribute it and/or modify
10
 
# it under the terms of the GNU General Public License as published by
 
5
#
 
6
# Copyright © 2008-2019 Teddy Hogeborn
 
7
# Copyright © 2008-2019 Björn Påhlsson
 
8
#
 
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
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
13
15
#
14
 
#     This program is distributed in the hope that it will be useful,
15
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     Mandos is distributed in the hope that it will be useful, but
 
17
#     WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
19
#     GNU General Public License for more details.
18
 
# 
 
20
#
19
21
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see
21
 
# <http://www.gnu.org/licenses/>.
22
 
# 
 
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
23
#
23
24
# Contact the authors at <mandos@recompile.se>.
24
 
# 
 
25
#
25
26
 
26
27
from __future__ import (division, absolute_import, print_function,
27
28
                        unicode_literals)
28
29
 
 
30
try:
 
31
    from future_builtins import *
 
32
except ImportError:
 
33
    pass
 
34
 
29
35
import sys
30
 
import dbus
31
36
import argparse
32
37
import locale
33
38
import datetime
34
39
import re
35
40
import os
 
41
import collections
 
42
import json
 
43
import unittest
 
44
import logging
 
45
 
 
46
import dbus
 
47
 
 
48
# Show warnings by default
 
49
if not sys.warnoptions:
 
50
    import warnings
 
51
    warnings.simplefilter("default")
 
52
 
 
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
 
 
57
logging.captureWarnings(True)   # Show warnings via the logging system
 
58
 
 
59
if sys.version_info.major == 2:
 
60
    str = unicode
36
61
 
37
62
locale.setlocale(locale.LC_ALL, "")
38
63
 
39
 
tablewords = {
40
 
    "Name": "Name",
41
 
    "Enabled": "Enabled",
42
 
    "Timeout": "Timeout",
43
 
    "LastCheckedOK": "Last Successful Check",
44
 
    "LastApprovalRequest": "Last Approval Request",
45
 
    "Created": "Created",
46
 
    "Interval": "Interval",
47
 
    "Host": "Host",
48
 
    "Fingerprint": "Fingerprint",
49
 
    "CheckerRunning": "Check Is Running",
50
 
    "LastEnabled": "Last Enabled",
51
 
    "ApprovalPending": "Approval Is Pending",
52
 
    "ApprovedByDefault": "Approved By Default",
53
 
    "ApprovalDelay": "Approval Delay",
54
 
    "ApprovalDuration": "Approval Duration",
55
 
    "Checker": "Checker",
56
 
    "ExtendedTimeout" : "Extended Timeout"
57
 
    }
58
64
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
59
65
domain = "se.recompile"
60
66
busname = domain + ".Mandos"
61
67
server_path = "/"
62
68
server_interface = domain + ".Mandos"
63
69
client_interface = domain + ".Mandos.Client"
64
 
version = "1.5.3"
65
 
 
66
 
def timedelta_to_milliseconds(td):
67
 
    """Convert a datetime.timedelta object to milliseconds"""
68
 
    return ((td.days * 24 * 60 * 60 * 1000)
69
 
            + (td.seconds * 1000)
70
 
            + (td.microseconds // 1000))
 
70
version = "1.8.3"
 
71
 
 
72
 
 
73
try:
 
74
    dbus.OBJECT_MANAGER_IFACE
 
75
except AttributeError:
 
76
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
77
 
71
78
 
72
79
def milliseconds_to_string(ms):
73
80
    td = datetime.timedelta(0, 0, 0, ms)
74
81
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
75
 
            .format(days = "{0}T".format(td.days) if td.days else "",
76
 
                    hours = td.seconds // 3600,
77
 
                    minutes = (td.seconds % 3600) // 60,
78
 
                    seconds = td.seconds % 60,
79
 
                    ))
 
82
            .format(days="{}T".format(td.days) if td.days else "",
 
83
                    hours=td.seconds // 3600,
 
84
                    minutes=(td.seconds % 3600) // 60,
 
85
                    seconds=td.seconds % 60))
 
86
 
 
87
 
 
88
def rfc3339_duration_to_delta(duration):
 
89
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
90
 
 
91
    >>> rfc3339_duration_to_delta("P7D")
 
92
    datetime.timedelta(7)
 
93
    >>> rfc3339_duration_to_delta("PT60S")
 
94
    datetime.timedelta(0, 60)
 
95
    >>> rfc3339_duration_to_delta("PT60M")
 
96
    datetime.timedelta(0, 3600)
 
97
    >>> rfc3339_duration_to_delta("P60M")
 
98
    datetime.timedelta(1680)
 
99
    >>> rfc3339_duration_to_delta("PT24H")
 
100
    datetime.timedelta(1)
 
101
    >>> rfc3339_duration_to_delta("P1W")
 
102
    datetime.timedelta(7)
 
103
    >>> rfc3339_duration_to_delta("PT5M30S")
 
104
    datetime.timedelta(0, 330)
 
105
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
106
    datetime.timedelta(1, 200)
 
107
    >>> # Can not be empty:
 
108
    >>> rfc3339_duration_to_delta("")
 
109
    Traceback (most recent call last):
 
110
    ...
 
111
    ValueError: Invalid RFC 3339 duration: u''
 
112
    >>> # Must start with "P":
 
113
    >>> rfc3339_duration_to_delta("1D")
 
114
    Traceback (most recent call last):
 
115
    ...
 
116
    ValueError: Invalid RFC 3339 duration: u'1D'
 
117
    >>> # Must use correct order
 
118
    >>> rfc3339_duration_to_delta("PT1S2M")
 
119
    Traceback (most recent call last):
 
120
    ...
 
121
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
 
122
    >>> # Time needs time marker
 
123
    >>> rfc3339_duration_to_delta("P1H2S")
 
124
    Traceback (most recent call last):
 
125
    ...
 
126
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
 
127
    >>> # Weeks can not be combined with anything else
 
128
    >>> rfc3339_duration_to_delta("P1D2W")
 
129
    Traceback (most recent call last):
 
130
    ...
 
131
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
 
132
    >>> rfc3339_duration_to_delta("P2W2H")
 
133
    Traceback (most recent call last):
 
134
    ...
 
135
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
 
136
    """
 
137
 
 
138
    # Parsing an RFC 3339 duration with regular expressions is not
 
139
    # possible - there would have to be multiple places for the same
 
140
    # values, like seconds.  The current code, while more esoteric, is
 
141
    # cleaner without depending on a parsing library.  If Python had a
 
142
    # built-in library for parsing we would use it, but we'd like to
 
143
    # avoid excessive use of external libraries.
 
144
 
 
145
    # New type for defining tokens, syntax, and semantics all-in-one
 
146
    Token = collections.namedtuple("Token", (
 
147
        "regexp",  # To match token; if "value" is not None, must have
 
148
                   # a "group" containing digits
 
149
        "value",   # datetime.timedelta or None
 
150
        "followers"))           # Tokens valid after this token
 
151
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
152
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
153
    token_end = Token(re.compile(r"$"), None, frozenset())
 
154
    token_second = Token(re.compile(r"(\d+)S"),
 
155
                         datetime.timedelta(seconds=1),
 
156
                         frozenset((token_end, )))
 
157
    token_minute = Token(re.compile(r"(\d+)M"),
 
158
                         datetime.timedelta(minutes=1),
 
159
                         frozenset((token_second, token_end)))
 
160
    token_hour = Token(re.compile(r"(\d+)H"),
 
161
                       datetime.timedelta(hours=1),
 
162
                       frozenset((token_minute, token_end)))
 
163
    token_time = Token(re.compile(r"T"),
 
164
                       None,
 
165
                       frozenset((token_hour, token_minute,
 
166
                                  token_second)))
 
167
    token_day = Token(re.compile(r"(\d+)D"),
 
168
                      datetime.timedelta(days=1),
 
169
                      frozenset((token_time, token_end)))
 
170
    token_month = Token(re.compile(r"(\d+)M"),
 
171
                        datetime.timedelta(weeks=4),
 
172
                        frozenset((token_day, token_end)))
 
173
    token_year = Token(re.compile(r"(\d+)Y"),
 
174
                       datetime.timedelta(weeks=52),
 
175
                       frozenset((token_month, token_end)))
 
176
    token_week = Token(re.compile(r"(\d+)W"),
 
177
                       datetime.timedelta(weeks=1),
 
178
                       frozenset((token_end, )))
 
179
    token_duration = Token(re.compile(r"P"), None,
 
180
                           frozenset((token_year, token_month,
 
181
                                      token_day, token_time,
 
182
                                      token_week)))
 
183
    # Define starting values:
 
184
    # Value so far
 
185
    value = datetime.timedelta()
 
186
    found_token = None
 
187
    # Following valid tokens
 
188
    followers = frozenset((token_duration, ))
 
189
    # String left to parse
 
190
    s = duration
 
191
    # Loop until end token is found
 
192
    while found_token is not token_end:
 
193
        # Search for any currently valid tokens
 
194
        for token in followers:
 
195
            match = token.regexp.match(s)
 
196
            if match is not None:
 
197
                # Token found
 
198
                if token.value is not None:
 
199
                    # Value found, parse digits
 
200
                    factor = int(match.group(1), 10)
 
201
                    # Add to value so far
 
202
                    value += factor * token.value
 
203
                # Strip token from string
 
204
                s = token.regexp.sub("", s, 1)
 
205
                # Go to found token
 
206
                found_token = token
 
207
                # Set valid next tokens
 
208
                followers = found_token.followers
 
209
                break
 
210
        else:
 
211
            # No currently valid tokens were found
 
212
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
213
                             .format(duration))
 
214
    # End token found
 
215
    return value
 
216
 
80
217
 
81
218
def string_to_delta(interval):
82
219
    """Parse a string and return a datetime.timedelta
83
 
    
84
 
    >>> string_to_delta("7d")
 
220
    """
 
221
 
 
222
    try:
 
223
        return rfc3339_duration_to_delta(interval)
 
224
    except ValueError as e:
 
225
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
226
                    ' '.join(e.args))
 
227
    return parse_pre_1_6_1_interval(interval)
 
228
 
 
229
 
 
230
def parse_pre_1_6_1_interval(interval):
 
231
    """Parse an interval string as documented by Mandos before 1.6.1, and
 
232
    return a datetime.timedelta
 
233
    >>> parse_pre_1_6_1_interval('7d')
85
234
    datetime.timedelta(7)
86
 
    >>> string_to_delta("60s")
 
235
    >>> parse_pre_1_6_1_interval('60s')
87
236
    datetime.timedelta(0, 60)
88
 
    >>> string_to_delta("60m")
 
237
    >>> parse_pre_1_6_1_interval('60m')
89
238
    datetime.timedelta(0, 3600)
90
 
    >>> string_to_delta("24h")
 
239
    >>> parse_pre_1_6_1_interval('24h')
91
240
    datetime.timedelta(1)
92
 
    >>> string_to_delta("1w")
 
241
    >>> parse_pre_1_6_1_interval('1w')
93
242
    datetime.timedelta(7)
94
 
    >>> string_to_delta("5m 30s")
 
243
    >>> parse_pre_1_6_1_interval('5m 30s')
95
244
    datetime.timedelta(0, 330)
 
245
    >>> parse_pre_1_6_1_interval('')
 
246
    datetime.timedelta(0)
 
247
    >>> # Ignore unknown characters, allow any order and repetitions
 
248
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
 
249
    datetime.timedelta(2, 480, 18000)
 
250
 
96
251
    """
 
252
 
97
253
    value = datetime.timedelta(0)
98
 
    regexp = re.compile("(\d+)([dsmhw]?)")
99
 
    
 
254
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
255
 
100
256
    for num, suffix in regexp.findall(interval):
101
257
        if suffix == "d":
102
258
            value += datetime.timedelta(int(num))
112
268
            value += datetime.timedelta(0, 0, 0, int(num))
113
269
    return value
114
270
 
115
 
def print_clients(clients, keywords):
 
271
 
 
272
class TableOfClients(object):
 
273
    tablewords = {
 
274
        "Name": "Name",
 
275
        "Enabled": "Enabled",
 
276
        "Timeout": "Timeout",
 
277
        "LastCheckedOK": "Last Successful Check",
 
278
        "LastApprovalRequest": "Last Approval Request",
 
279
        "Created": "Created",
 
280
        "Interval": "Interval",
 
281
        "Host": "Host",
 
282
        "Fingerprint": "Fingerprint",
 
283
        "KeyID": "Key ID",
 
284
        "CheckerRunning": "Check Is Running",
 
285
        "LastEnabled": "Last Enabled",
 
286
        "ApprovalPending": "Approval Is Pending",
 
287
        "ApprovedByDefault": "Approved By Default",
 
288
        "ApprovalDelay": "Approval Delay",
 
289
        "ApprovalDuration": "Approval Duration",
 
290
        "Checker": "Checker",
 
291
        "ExtendedTimeout": "Extended Timeout",
 
292
        "Expires": "Expires",
 
293
        "LastCheckerStatus": "Last Checker Status",
 
294
    }
 
295
 
 
296
    def __init__(self, clients, keywords, tablewords=None):
 
297
        self.clients = clients
 
298
        self.keywords = keywords
 
299
        if tablewords is not None:
 
300
            self.tablewords = tablewords
 
301
 
 
302
    def __str__(self):
 
303
        return "\n".join(self.rows())
 
304
 
 
305
    if sys.version_info.major == 2:
 
306
        __unicode__ = __str__
 
307
        def __str__(self):
 
308
            return str(self).encode(locale.getpreferredencoding())
 
309
 
 
310
    def rows(self):
 
311
        format_string = self.row_formatting_string()
 
312
        rows = [self.header_line(format_string)]
 
313
        rows.extend(self.client_line(client, format_string)
 
314
                    for client in self.clients)
 
315
        return rows
 
316
 
 
317
    def row_formatting_string(self):
 
318
        "Format string used to format table rows"
 
319
        return " ".join("{{{key}:{width}}}".format(
 
320
            width=max(len(self.tablewords[key]),
 
321
                      max(len(self.string_from_client(client, key))
 
322
                          for client in self.clients)),
 
323
            key=key)
 
324
                                 for key in self.keywords)
 
325
 
 
326
    def string_from_client(self, client, key):
 
327
        return self.valuetostring(client[key], key)
 
328
 
 
329
    @staticmethod
116
330
    def valuetostring(value, keyword):
117
 
        if type(value) is dbus.Boolean:
 
331
        if isinstance(value, dbus.Boolean):
118
332
            return "Yes" if value else "No"
119
333
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
120
334
                       "ApprovalDuration", "ExtendedTimeout"):
121
335
            return milliseconds_to_string(value)
122
 
        return unicode(value)
123
 
    
124
 
    # Create format string to print table rows
125
 
    format_string = " ".join("{{{key}:{width}}}".format(
126
 
            width = max(len(tablewords[key]),
127
 
                        max(len(valuetostring(client[key],
128
 
                                              key))
129
 
                            for client in
130
 
                            clients)),
131
 
            key = key) for key in keywords)
132
 
    # Print header line
133
 
    print(format_string.format(**tablewords))
134
 
    for client in clients:
135
 
        print(format_string.format(**dict((key,
136
 
                                           valuetostring(client[key],
137
 
                                                         key))
138
 
                                          for key in keywords)))
 
336
        return str(value)
 
337
 
 
338
    def header_line(self, format_string):
 
339
        return format_string.format(**self.tablewords)
 
340
 
 
341
    def client_line(self, client, format_string):
 
342
        return format_string.format(
 
343
            **{key: self.string_from_client(client, key)
 
344
               for key in self.keywords})
 
345
 
139
346
 
140
347
def has_actions(options):
141
348
    return any((options.enable,
157
364
                options.approve,
158
365
                options.deny))
159
366
 
 
367
 
160
368
def main():
161
369
    parser = argparse.ArgumentParser()
162
370
    parser.add_argument("--version", action="version",
163
 
                        version = "%(prog)s {0}".format(version),
 
371
                        version="%(prog)s {}".format(version),
164
372
                        help="show version number and exit")
165
373
    parser.add_argument("-a", "--all", action="store_true",
166
374
                        help="Select all clients")
167
375
    parser.add_argument("-v", "--verbose", action="store_true",
168
376
                        help="Print all fields")
 
377
    parser.add_argument("-j", "--dump-json", action="store_true",
 
378
                        help="Dump client data in JSON format")
169
379
    parser.add_argument("-e", "--enable", action="store_true",
170
380
                        help="Enable client")
171
381
    parser.add_argument("-d", "--disable", action="store_true",
199
409
    parser.add_argument("--approval-duration",
200
410
                        help="Set duration of one client approval")
201
411
    parser.add_argument("-H", "--host", help="Set host for client")
202
 
    parser.add_argument("-s", "--secret", type=file,
 
412
    parser.add_argument("-s", "--secret",
 
413
                        type=argparse.FileType(mode="rb"),
203
414
                        help="Set password blob (file) for client")
204
415
    parser.add_argument("-A", "--approve", action="store_true",
205
416
                        help="Approve any current client request")
206
417
    parser.add_argument("-D", "--deny", action="store_true",
207
418
                        help="Deny any current client request")
 
419
    parser.add_argument("--check", action="store_true",
 
420
                        help="Run self-test")
208
421
    parser.add_argument("client", nargs="*", help="Client name")
209
422
    options = parser.parse_args()
210
 
    
 
423
 
211
424
    if has_actions(options) and not (options.client or options.all):
212
425
        parser.error("Options require clients names or --all.")
213
426
    if options.verbose and has_actions(options):
214
 
        parser.error("--verbose can only be used alone or with"
215
 
                     " --all.")
 
427
        parser.error("--verbose can only be used alone.")
 
428
    if options.dump_json and (options.verbose
 
429
                              or has_actions(options)):
 
430
        parser.error("--dump-json can only be used alone.")
216
431
    if options.all and not has_actions(options):
217
432
        parser.error("--all requires an action.")
218
 
    
 
433
 
219
434
    try:
220
435
        bus = dbus.SystemBus()
221
436
        mandos_dbus_objc = bus.get_object(busname, server_path)
222
437
    except dbus.exceptions.DBusException:
223
 
        print("Could not connect to Mandos server",
224
 
              file=sys.stderr)
 
438
        log.critical("Could not connect to Mandos server")
225
439
        sys.exit(1)
226
 
    
 
440
 
227
441
    mandos_serv = dbus.Interface(mandos_dbus_objc,
228
 
                                 dbus_interface = server_interface)
229
 
    
230
 
    #block stderr since dbus library prints to stderr
 
442
                                 dbus_interface=server_interface)
 
443
    mandos_serv_object_manager = dbus.Interface(
 
444
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
445
 
 
446
    # block stderr since dbus library prints to stderr
231
447
    null = os.open(os.path.devnull, os.O_RDWR)
232
448
    stderrcopy = os.dup(sys.stderr.fileno())
233
449
    os.dup2(null, sys.stderr.fileno())
234
450
    os.close(null)
235
451
    try:
236
452
        try:
237
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
453
            mandos_clients = {path: ifs_and_props[client_interface]
 
454
                              for path, ifs_and_props in
 
455
                              mandos_serv_object_manager
 
456
                              .GetManagedObjects().items()
 
457
                              if client_interface in ifs_and_props}
238
458
        finally:
239
 
            #restore stderr
 
459
            # restore stderr
240
460
            os.dup2(stderrcopy, sys.stderr.fileno())
241
461
            os.close(stderrcopy)
242
 
    except dbus.exceptions.DBusException:
243
 
        print("Access denied: Accessing mandos server through dbus.",
244
 
              file=sys.stderr)
 
462
    except dbus.exceptions.DBusException as e:
 
463
        log.critical("Failed to access Mandos server through D-Bus:"
 
464
                     "\n%s", e)
245
465
        sys.exit(1)
246
 
    
 
466
 
247
467
    # Compile dict of (clients: properties) to process
248
 
    clients={}
249
 
    
 
468
    clients = {}
 
469
 
250
470
    if options.all or not options.client:
251
 
        clients = dict((bus.get_object(busname, path), properties)
252
 
                       for path, properties in
253
 
                       mandos_clients.iteritems())
 
471
        clients = {bus.get_object(busname, path): properties
 
472
                   for path, properties in mandos_clients.items()}
254
473
    else:
255
474
        for name in options.client:
256
 
            for path, client in mandos_clients.iteritems():
 
475
            for path, client in mandos_clients.items():
257
476
                if client["Name"] == name:
258
477
                    client_objc = bus.get_object(busname, path)
259
478
                    clients[client_objc] = client
260
479
                    break
261
480
            else:
262
 
                print("Client not found on server: {0!r}"
263
 
                      .format(name), file=sys.stderr)
 
481
                log.critical("Client not found on server: %r", name)
264
482
                sys.exit(1)
265
 
    
 
483
 
266
484
    if not has_actions(options) and clients:
267
 
        if options.verbose:
268
 
            keywords = ("Name", "Enabled", "Timeout",
269
 
                        "LastCheckedOK", "Created", "Interval",
270
 
                        "Host", "Fingerprint", "CheckerRunning",
 
485
        if options.verbose or options.dump_json:
 
486
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
487
                        "Created", "Interval", "Host", "KeyID",
 
488
                        "Fingerprint", "CheckerRunning",
271
489
                        "LastEnabled", "ApprovalPending",
272
 
                        "ApprovedByDefault",
273
 
                        "LastApprovalRequest", "ApprovalDelay",
274
 
                        "ApprovalDuration", "Checker",
275
 
                        "ExtendedTimeout")
 
490
                        "ApprovedByDefault", "LastApprovalRequest",
 
491
                        "ApprovalDelay", "ApprovalDuration",
 
492
                        "Checker", "ExtendedTimeout", "Expires",
 
493
                        "LastCheckerStatus")
276
494
        else:
277
495
            keywords = defaultkeywords
278
 
        
279
 
        print_clients(clients.values(), keywords)
 
496
 
 
497
        if options.dump_json:
 
498
            json.dump({client["Name"]: {key:
 
499
                                        bool(client[key])
 
500
                                        if isinstance(client[key],
 
501
                                                      dbus.Boolean)
 
502
                                        else client[key]
 
503
                                        for key in keywords}
 
504
                       for client in clients.values()},
 
505
                      fp=sys.stdout, indent=4,
 
506
                      separators=(',', ': '))
 
507
            print()
 
508
        else:
 
509
            print(TableOfClients(clients.values(), keywords))
280
510
    else:
281
511
        # Process each client in the list by all selected options
282
512
        for client in clients:
 
513
 
283
514
            def set_client_prop(prop, value):
284
515
                """Set a Client D-Bus property"""
285
516
                client.Set(client_interface, prop, value,
286
517
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
518
 
287
519
            def set_client_prop_ms(prop, value):
288
520
                """Set a Client D-Bus property, converted
289
521
                from a string to milliseconds."""
290
522
                set_client_prop(prop,
291
 
                                timedelta_to_milliseconds
292
 
                                (string_to_delta(value)))
 
523
                                string_to_delta(value).total_seconds()
 
524
                                * 1000)
 
525
 
293
526
            if options.remove:
294
527
                mandos_serv.RemoveClient(client.__dbus_object_path__)
295
528
            if options.enable:
303
536
            if options.stop_checker:
304
537
                set_client_prop("CheckerRunning", dbus.Boolean(False))
305
538
            if options.is_enabled:
306
 
                sys.exit(0 if client.Get(client_interface,
307
 
                                         "Enabled",
308
 
                                         dbus_interface=
309
 
                                         dbus.PROPERTIES_IFACE)
310
 
                         else 1)
 
539
                if client.Get(client_interface, "Enabled",
 
540
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
541
                    sys.exit(0)
 
542
                else:
 
543
                    sys.exit(1)
311
544
            if options.checker is not None:
312
545
                set_client_prop("Checker", options.checker)
313
546
            if options.host is not None:
339
572
                client.Approve(dbus.Boolean(False),
340
573
                               dbus_interface=client_interface)
341
574
 
 
575
 
 
576
class Test_milliseconds_to_string(unittest.TestCase):
 
577
    def test_all(self):
 
578
        self.assertEqual(milliseconds_to_string(93785000),
 
579
                         "1T02:03:05")
 
580
    def test_no_days(self):
 
581
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
582
    def test_all_zero(self):
 
583
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
584
    def test_no_fractional_seconds(self):
 
585
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
586
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
587
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
588
 
 
589
class Test_string_to_delta(unittest.TestCase):
 
590
    def test_handles_basic_rfc3339(self):
 
591
        self.assertEqual(string_to_delta("PT2H"),
 
592
                         datetime.timedelta(0, 7200))
 
593
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
594
        # assertLogs only exists in Python 3.4
 
595
        if hasattr(self, "assertLogs"):
 
596
            with self.assertLogs(log, logging.WARNING):
 
597
                value = string_to_delta("2h")
 
598
        else:
 
599
            value = string_to_delta("2h")
 
600
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
601
 
 
602
class Test_TableOfClients(unittest.TestCase):
 
603
    def setUp(self):
 
604
        self.tablewords = {
 
605
            "Attr1": "X",
 
606
            "AttrTwo": "Yy",
 
607
            "AttrThree": "Zzz",
 
608
            "Bool": "A D-BUS Boolean",
 
609
            "NonDbusBoolean": "A Non-D-BUS Boolean",
 
610
            "Integer": "An Integer",
 
611
            "Timeout": "Timedelta 1",
 
612
            "Interval": "Timedelta 2",
 
613
            "ApprovalDelay": "Timedelta 3",
 
614
            "ApprovalDuration": "Timedelta 4",
 
615
            "ExtendedTimeout": "Timedelta 5",
 
616
            "String": "A String",
 
617
        }
 
618
        self.keywords = ["Attr1", "AttrTwo"]
 
619
        self.clients = [
 
620
            {
 
621
                "Attr1": "x1",
 
622
                "AttrTwo": "y1",
 
623
                "AttrThree": "z1",
 
624
                "Bool": dbus.Boolean(False),
 
625
                "NonDbusBoolean": False,
 
626
                "Integer": 0,
 
627
                "Timeout": 0,
 
628
                "Interval": 1000,
 
629
                "ApprovalDelay": 2000,
 
630
                "ApprovalDuration": 3000,
 
631
                "ExtendedTimeout": 4000,
 
632
                "String": "",
 
633
            },
 
634
            {
 
635
                "Attr1": "x2",
 
636
                "AttrTwo": "y2",
 
637
                "AttrThree": "z2",
 
638
                "Bool": dbus.Boolean(True),
 
639
                "NonDbusBoolean": True,
 
640
                "Integer": 1,
 
641
                "Timeout": 93785000,
 
642
                "Interval": 93786000,
 
643
                "ApprovalDelay": 93787000,
 
644
                "ApprovalDuration": 93788000,
 
645
                "ExtendedTimeout": 93789000,
 
646
                "String": "A huge string which will not fit," * 10,
 
647
            },
 
648
        ]
 
649
    def test_short_header(self):
 
650
        text = str(TableOfClients(self.clients, self.keywords,
 
651
                                  self.tablewords))
 
652
        expected_text = """
 
653
X  Yy
 
654
x1 y1
 
655
x2 y2
 
656
"""[1:-1]
 
657
        self.assertEqual(text, expected_text)
 
658
    def test_booleans(self):
 
659
        keywords = ["Bool", "NonDbusBoolean"]
 
660
        text = str(TableOfClients(self.clients, keywords,
 
661
                                  self.tablewords))
 
662
        expected_text = """
 
663
A D-BUS Boolean A Non-D-BUS Boolean
 
664
No              False              
 
665
Yes             True               
 
666
"""[1:-1]
 
667
        self.assertEqual(text, expected_text)
 
668
    def test_milliseconds_detection(self):
 
669
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
 
670
                    "ApprovalDuration", "ExtendedTimeout"]
 
671
        text = str(TableOfClients(self.clients, keywords,
 
672
                                  self.tablewords))
 
673
        expected_text = """
 
674
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
 
675
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
 
676
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
 
677
"""[1:-1]
 
678
        self.assertEqual(text, expected_text)
 
679
    def test_empty_and_long_string_values(self):
 
680
        keywords = ["String"]
 
681
        text = str(TableOfClients(self.clients, keywords,
 
682
                                  self.tablewords))
 
683
        expected_text = """
 
684
A String                                                                                                                                                                                                                                                                                                                                  
 
685
                                                                                                                                                                                                                                                                                                                                          
 
686
A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,
 
687
"""[1:-1]
 
688
        self.assertEqual(text, expected_text)
 
689
 
 
690
 
 
691
 
 
692
def should_only_run_tests():
 
693
    parser = argparse.ArgumentParser(add_help=False)
 
694
    parser.add_argument("--check", action='store_true')
 
695
    args, unknown_args = parser.parse_known_args()
 
696
    run_tests = args.check
 
697
    if run_tests:
 
698
        # Remove --check argument from sys.argv
 
699
        sys.argv[1:] = unknown_args
 
700
    return run_tests
 
701
 
 
702
# Add all tests from doctest strings
 
703
def load_tests(loader, tests, none):
 
704
    import doctest
 
705
    tests.addTests(doctest.DocTestSuite())
 
706
    return tests
 
707
 
342
708
if __name__ == "__main__":
343
 
    main()
 
709
    if should_only_run_tests():
 
710
        # Call using ./tdd-python-script --check [--verbose]
 
711
        unittest.main()
 
712
    else:
 
713
        main()