/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-02 01:56:35 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190302015635-xgodxd3ivltju7qn
mandos-ctl: Refactor

* mandos-ctl (global tablewords): Refactor into TableOfClients.
  (TableOfClients.tablewords): New overrideable class attribute.

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
 
29
 
from future_builtins import *
 
30
try:
 
31
    from future_builtins import *
 
32
except ImportError:
 
33
    pass
30
34
 
31
35
import sys
32
 
import dbus
33
36
import argparse
34
37
import locale
35
38
import datetime
36
39
import re
37
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
38
61
 
39
62
locale.setlocale(locale.LC_ALL, "")
40
63
 
41
 
tablewords = {
42
 
    "Name": "Name",
43
 
    "Enabled": "Enabled",
44
 
    "Timeout": "Timeout",
45
 
    "LastCheckedOK": "Last Successful Check",
46
 
    "LastApprovalRequest": "Last Approval Request",
47
 
    "Created": "Created",
48
 
    "Interval": "Interval",
49
 
    "Host": "Host",
50
 
    "Fingerprint": "Fingerprint",
51
 
    "CheckerRunning": "Check Is Running",
52
 
    "LastEnabled": "Last Enabled",
53
 
    "ApprovalPending": "Approval Is Pending",
54
 
    "ApprovedByDefault": "Approved By Default",
55
 
    "ApprovalDelay": "Approval Delay",
56
 
    "ApprovalDuration": "Approval Duration",
57
 
    "Checker": "Checker",
58
 
    "ExtendedTimeout" : "Extended Timeout"
59
 
    }
60
64
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
61
65
domain = "se.recompile"
62
66
busname = domain + ".Mandos"
63
67
server_path = "/"
64
68
server_interface = domain + ".Mandos"
65
69
client_interface = domain + ".Mandos.Client"
66
 
version = "1.6.0"
67
 
 
68
 
def timedelta_to_milliseconds(td):
69
 
    """Convert a datetime.timedelta object to milliseconds"""
70
 
    return ((td.days * 24 * 60 * 60 * 1000)
71
 
            + (td.seconds * 1000)
72
 
            + (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
 
73
78
 
74
79
def milliseconds_to_string(ms):
75
80
    td = datetime.timedelta(0, 0, 0, ms)
76
81
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
77
 
            .format(days = "{0}T".format(td.days) if td.days else "",
78
 
                    hours = td.seconds // 3600,
79
 
                    minutes = (td.seconds % 3600) // 60,
80
 
                    seconds = td.seconds % 60,
81
 
                    ))
 
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
 
82
217
 
83
218
def string_to_delta(interval):
84
219
    """Parse a string and return a datetime.timedelta
85
 
    
86
 
    >>> 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')
87
234
    datetime.timedelta(7)
88
 
    >>> string_to_delta("60s")
 
235
    >>> parse_pre_1_6_1_interval('60s')
89
236
    datetime.timedelta(0, 60)
90
 
    >>> string_to_delta("60m")
 
237
    >>> parse_pre_1_6_1_interval('60m')
91
238
    datetime.timedelta(0, 3600)
92
 
    >>> string_to_delta("24h")
 
239
    >>> parse_pre_1_6_1_interval('24h')
93
240
    datetime.timedelta(1)
94
 
    >>> string_to_delta("1w")
 
241
    >>> parse_pre_1_6_1_interval('1w')
95
242
    datetime.timedelta(7)
96
 
    >>> string_to_delta("5m 30s")
 
243
    >>> parse_pre_1_6_1_interval('5m 30s')
97
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
 
98
251
    """
 
252
 
99
253
    value = datetime.timedelta(0)
100
 
    regexp = re.compile("(\d+)([dsmhw]?)")
101
 
    
 
254
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
255
 
102
256
    for num, suffix in regexp.findall(interval):
103
257
        if suffix == "d":
104
258
            value += datetime.timedelta(int(num))
114
268
            value += datetime.timedelta(0, 0, 0, int(num))
115
269
    return value
116
270
 
 
271
 
117
272
def print_clients(clients, keywords):
 
273
    print('\n'.join(TableOfClients(clients, keywords).rows()))
 
274
 
 
275
class TableOfClients(object):
 
276
    tablewords = {
 
277
        "Name": "Name",
 
278
        "Enabled": "Enabled",
 
279
        "Timeout": "Timeout",
 
280
        "LastCheckedOK": "Last Successful Check",
 
281
        "LastApprovalRequest": "Last Approval Request",
 
282
        "Created": "Created",
 
283
        "Interval": "Interval",
 
284
        "Host": "Host",
 
285
        "Fingerprint": "Fingerprint",
 
286
        "KeyID": "Key ID",
 
287
        "CheckerRunning": "Check Is Running",
 
288
        "LastEnabled": "Last Enabled",
 
289
        "ApprovalPending": "Approval Is Pending",
 
290
        "ApprovedByDefault": "Approved By Default",
 
291
        "ApprovalDelay": "Approval Delay",
 
292
        "ApprovalDuration": "Approval Duration",
 
293
        "Checker": "Checker",
 
294
        "ExtendedTimeout": "Extended Timeout",
 
295
        "Expires": "Expires",
 
296
        "LastCheckerStatus": "Last Checker Status",
 
297
    }
 
298
 
 
299
    def __init__(self, clients, keywords, tablewords=None):
 
300
        self.clients = clients
 
301
        self.keywords = keywords
 
302
        if tablewords is not None:
 
303
            self.tablewords = tablewords
 
304
 
 
305
    @staticmethod
118
306
    def valuetostring(value, keyword):
119
 
        if type(value) is dbus.Boolean:
 
307
        if isinstance(value, dbus.Boolean):
120
308
            return "Yes" if value else "No"
121
309
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
122
310
                       "ApprovalDuration", "ExtendedTimeout"):
123
311
            return milliseconds_to_string(value)
124
 
        return unicode(value)
125
 
    
126
 
    # Create format string to print table rows
127
 
    format_string = " ".join("{{{key}:{width}}}".format(
128
 
            width = max(len(tablewords[key]),
129
 
                        max(len(valuetostring(client[key],
130
 
                                              key))
131
 
                            for client in
132
 
                            clients)),
133
 
            key = key) for key in keywords)
134
 
    # Print header line
135
 
    print(format_string.format(**tablewords))
136
 
    for client in clients:
137
 
        print(format_string.format(**dict((key,
138
 
                                           valuetostring(client[key],
139
 
                                                         key))
140
 
                                          for key in keywords)))
 
312
        return str(value)
 
313
 
 
314
    def rows(self):
 
315
        # Create format string to format table rows
 
316
        format_string = " ".join("{{{key}:{width}}}".format(
 
317
            width=max(len(self.tablewords[key]),
 
318
                      max(len(self.valuetostring(client[key], key))
 
319
                          for client in self.clients)),
 
320
            key=key)
 
321
                                 for key in self.keywords)
 
322
        # Start with header line
 
323
        rows = [format_string.format(**self.tablewords)]
 
324
        for client in self.clients:
 
325
            rows.append(format_string
 
326
                        .format(**{key: self.valuetostring(client[key], key)
 
327
                                   for key in self.keywords}))
 
328
        return rows
 
329
 
141
330
 
142
331
def has_actions(options):
143
332
    return any((options.enable,
159
348
                options.approve,
160
349
                options.deny))
161
350
 
 
351
 
162
352
def main():
163
353
    parser = argparse.ArgumentParser()
164
354
    parser.add_argument("--version", action="version",
165
 
                        version = "%(prog)s {0}".format(version),
 
355
                        version="%(prog)s {}".format(version),
166
356
                        help="show version number and exit")
167
357
    parser.add_argument("-a", "--all", action="store_true",
168
358
                        help="Select all clients")
169
359
    parser.add_argument("-v", "--verbose", action="store_true",
170
360
                        help="Print all fields")
 
361
    parser.add_argument("-j", "--dump-json", action="store_true",
 
362
                        help="Dump client data in JSON format")
171
363
    parser.add_argument("-e", "--enable", action="store_true",
172
364
                        help="Enable client")
173
365
    parser.add_argument("-d", "--disable", action="store_true",
201
393
    parser.add_argument("--approval-duration",
202
394
                        help="Set duration of one client approval")
203
395
    parser.add_argument("-H", "--host", help="Set host for client")
204
 
    parser.add_argument("-s", "--secret", type=file,
 
396
    parser.add_argument("-s", "--secret",
 
397
                        type=argparse.FileType(mode="rb"),
205
398
                        help="Set password blob (file) for client")
206
399
    parser.add_argument("-A", "--approve", action="store_true",
207
400
                        help="Approve any current client request")
208
401
    parser.add_argument("-D", "--deny", action="store_true",
209
402
                        help="Deny any current client request")
 
403
    parser.add_argument("--check", action="store_true",
 
404
                        help="Run self-test")
210
405
    parser.add_argument("client", nargs="*", help="Client name")
211
406
    options = parser.parse_args()
212
 
    
 
407
 
213
408
    if has_actions(options) and not (options.client or options.all):
214
409
        parser.error("Options require clients names or --all.")
215
410
    if options.verbose and has_actions(options):
216
 
        parser.error("--verbose can only be used alone or with"
217
 
                     " --all.")
 
411
        parser.error("--verbose can only be used alone.")
 
412
    if options.dump_json and (options.verbose
 
413
                              or has_actions(options)):
 
414
        parser.error("--dump-json can only be used alone.")
218
415
    if options.all and not has_actions(options):
219
416
        parser.error("--all requires an action.")
220
 
    
 
417
 
221
418
    try:
222
419
        bus = dbus.SystemBus()
223
420
        mandos_dbus_objc = bus.get_object(busname, server_path)
224
421
    except dbus.exceptions.DBusException:
225
 
        print("Could not connect to Mandos server",
226
 
              file=sys.stderr)
 
422
        log.critical("Could not connect to Mandos server")
227
423
        sys.exit(1)
228
 
    
 
424
 
229
425
    mandos_serv = dbus.Interface(mandos_dbus_objc,
230
 
                                 dbus_interface = server_interface)
231
 
    
232
 
    #block stderr since dbus library prints to stderr
 
426
                                 dbus_interface=server_interface)
 
427
    mandos_serv_object_manager = dbus.Interface(
 
428
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
429
 
 
430
    # block stderr since dbus library prints to stderr
233
431
    null = os.open(os.path.devnull, os.O_RDWR)
234
432
    stderrcopy = os.dup(sys.stderr.fileno())
235
433
    os.dup2(null, sys.stderr.fileno())
236
434
    os.close(null)
237
435
    try:
238
436
        try:
239
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
437
            mandos_clients = {path: ifs_and_props[client_interface]
 
438
                              for path, ifs_and_props in
 
439
                              mandos_serv_object_manager
 
440
                              .GetManagedObjects().items()
 
441
                              if client_interface in ifs_and_props}
240
442
        finally:
241
 
            #restore stderr
 
443
            # restore stderr
242
444
            os.dup2(stderrcopy, sys.stderr.fileno())
243
445
            os.close(stderrcopy)
244
 
    except dbus.exceptions.DBusException:
245
 
        print("Access denied: Accessing mandos server through dbus.",
246
 
              file=sys.stderr)
 
446
    except dbus.exceptions.DBusException as e:
 
447
        log.critical("Failed to access Mandos server through D-Bus:"
 
448
                     "\n%s", e)
247
449
        sys.exit(1)
248
 
    
 
450
 
249
451
    # Compile dict of (clients: properties) to process
250
 
    clients={}
251
 
    
 
452
    clients = {}
 
453
 
252
454
    if options.all or not options.client:
253
 
        clients = dict((bus.get_object(busname, path), properties)
254
 
                       for path, properties in
255
 
                       mandos_clients.iteritems())
 
455
        clients = {bus.get_object(busname, path): properties
 
456
                   for path, properties in mandos_clients.items()}
256
457
    else:
257
458
        for name in options.client:
258
 
            for path, client in mandos_clients.iteritems():
 
459
            for path, client in mandos_clients.items():
259
460
                if client["Name"] == name:
260
461
                    client_objc = bus.get_object(busname, path)
261
462
                    clients[client_objc] = client
262
463
                    break
263
464
            else:
264
 
                print("Client not found on server: {0!r}"
265
 
                      .format(name), file=sys.stderr)
 
465
                log.critical("Client not found on server: %r", name)
266
466
                sys.exit(1)
267
 
    
 
467
 
268
468
    if not has_actions(options) and clients:
269
 
        if options.verbose:
270
 
            keywords = ("Name", "Enabled", "Timeout",
271
 
                        "LastCheckedOK", "Created", "Interval",
272
 
                        "Host", "Fingerprint", "CheckerRunning",
 
469
        if options.verbose or options.dump_json:
 
470
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
471
                        "Created", "Interval", "Host", "KeyID",
 
472
                        "Fingerprint", "CheckerRunning",
273
473
                        "LastEnabled", "ApprovalPending",
274
 
                        "ApprovedByDefault",
275
 
                        "LastApprovalRequest", "ApprovalDelay",
276
 
                        "ApprovalDuration", "Checker",
277
 
                        "ExtendedTimeout")
 
474
                        "ApprovedByDefault", "LastApprovalRequest",
 
475
                        "ApprovalDelay", "ApprovalDuration",
 
476
                        "Checker", "ExtendedTimeout", "Expires",
 
477
                        "LastCheckerStatus")
278
478
        else:
279
479
            keywords = defaultkeywords
280
 
        
281
 
        print_clients(clients.values(), keywords)
 
480
 
 
481
        if options.dump_json:
 
482
            json.dump({client["Name"]: {key:
 
483
                                        bool(client[key])
 
484
                                        if isinstance(client[key],
 
485
                                                      dbus.Boolean)
 
486
                                        else client[key]
 
487
                                        for key in keywords}
 
488
                       for client in clients.values()},
 
489
                      fp=sys.stdout, indent=4,
 
490
                      separators=(',', ': '))
 
491
            print()
 
492
        else:
 
493
            print_clients(clients.values(), keywords)
282
494
    else:
283
495
        # Process each client in the list by all selected options
284
496
        for client in clients:
 
497
 
285
498
            def set_client_prop(prop, value):
286
499
                """Set a Client D-Bus property"""
287
500
                client.Set(client_interface, prop, value,
288
501
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
502
 
289
503
            def set_client_prop_ms(prop, value):
290
504
                """Set a Client D-Bus property, converted
291
505
                from a string to milliseconds."""
292
506
                set_client_prop(prop,
293
 
                                timedelta_to_milliseconds
294
 
                                (string_to_delta(value)))
 
507
                                string_to_delta(value).total_seconds()
 
508
                                * 1000)
 
509
 
295
510
            if options.remove:
296
511
                mandos_serv.RemoveClient(client.__dbus_object_path__)
297
512
            if options.enable:
305
520
            if options.stop_checker:
306
521
                set_client_prop("CheckerRunning", dbus.Boolean(False))
307
522
            if options.is_enabled:
308
 
                sys.exit(0 if client.Get(client_interface,
309
 
                                         "Enabled",
310
 
                                         dbus_interface=
311
 
                                         dbus.PROPERTIES_IFACE)
312
 
                         else 1)
 
523
                if client.Get(client_interface, "Enabled",
 
524
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
525
                    sys.exit(0)
 
526
                else:
 
527
                    sys.exit(1)
313
528
            if options.checker is not None:
314
529
                set_client_prop("Checker", options.checker)
315
530
            if options.host is not None:
341
556
                client.Approve(dbus.Boolean(False),
342
557
                               dbus_interface=client_interface)
343
558
 
 
559
 
 
560
class Test_milliseconds_to_string(unittest.TestCase):
 
561
    def test_all(self):
 
562
        self.assertEqual(milliseconds_to_string(93785000),
 
563
                         "1T02:03:05")
 
564
    def test_no_days(self):
 
565
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
566
    def test_all_zero(self):
 
567
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
568
    def test_no_fractional_seconds(self):
 
569
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
570
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
571
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
572
 
 
573
class Test_string_to_delta(unittest.TestCase):
 
574
    def test_handles_basic_rfc3339(self):
 
575
        self.assertEqual(string_to_delta("PT2H"),
 
576
                         datetime.timedelta(0, 7200))
 
577
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
578
        # assertLogs only exists in Python 3.4
 
579
        if hasattr(self, "assertLogs"):
 
580
            with self.assertLogs(log, logging.WARNING):
 
581
                value = string_to_delta("2h")
 
582
        else:
 
583
            value = string_to_delta("2h")
 
584
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
585
 
 
586
class Test_TableOfClients(unittest.TestCase):
 
587
    def setUp(self):
 
588
        self.tablewords = {
 
589
            "Attr1": "X",
 
590
            "AttrTwo": "Yy",
 
591
            "AttrThree": "Zzz",
 
592
            "Bool": "A D-BUS Boolean",
 
593
            "NonDbusBoolean": "A Non-D-BUS Boolean",
 
594
            "Integer": "An Integer",
 
595
            "Timeout": "Timedelta 1",
 
596
            "Interval": "Timedelta 2",
 
597
            "ApprovalDelay": "Timedelta 3",
 
598
            "ApprovalDuration": "Timedelta 4",
 
599
            "ExtendedTimeout": "Timedelta 5",
 
600
            "String": "A String",
 
601
        }
 
602
        self.keywords = ["Attr1", "AttrTwo"]
 
603
        self.clients = [
 
604
            {
 
605
                "Attr1": "x1",
 
606
                "AttrTwo": "y1",
 
607
                "AttrThree": "z1",
 
608
                "Bool": dbus.Boolean(False),
 
609
                "NonDbusBoolean": False,
 
610
                "Integer": 0,
 
611
                "Timeout": 0,
 
612
                "Interval": 1000,
 
613
                "ApprovalDelay": 2000,
 
614
                "ApprovalDuration": 3000,
 
615
                "ExtendedTimeout": 4000,
 
616
                "String": "",
 
617
            },
 
618
            {
 
619
                "Attr1": "x2",
 
620
                "AttrTwo": "y2",
 
621
                "AttrThree": "z2",
 
622
                "Bool": dbus.Boolean(True),
 
623
                "NonDbusBoolean": True,
 
624
                "Integer": 1,
 
625
                "Timeout": 93785000,
 
626
                "Interval": 93786000,
 
627
                "ApprovalDelay": 93787000,
 
628
                "ApprovalDuration": 93788000,
 
629
                "ExtendedTimeout": 93789000,
 
630
                "String": "A huge string which will not fit," * 10,
 
631
            },
 
632
        ]
 
633
    def test_short_header(self):
 
634
        rows = TableOfClients(self.clients, self.keywords,
 
635
                              self.tablewords).rows()
 
636
        expected_rows = [
 
637
            "X  Yy",
 
638
            "x1 y1",
 
639
            "x2 y2"]
 
640
        self.assertEqual(rows, expected_rows)
 
641
    def test_booleans(self):
 
642
        keywords = ["Bool", "NonDbusBoolean"]
 
643
        rows = TableOfClients(self.clients, keywords,
 
644
                              self.tablewords).rows()
 
645
        expected_rows = [
 
646
            "A D-BUS Boolean A Non-D-BUS Boolean",
 
647
            "No              False              ",
 
648
            "Yes             True               ",
 
649
        ]
 
650
        self.assertEqual(rows, expected_rows)
 
651
    def test_milliseconds_detection(self):
 
652
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
 
653
                    "ApprovalDuration", "ExtendedTimeout"]
 
654
        rows = TableOfClients(self.clients, keywords,
 
655
                              self.tablewords).rows()
 
656
        expected_rows = ("""
 
657
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
 
658
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
 
659
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
 
660
"""
 
661
        ).splitlines()[1:]
 
662
        self.assertEqual(rows, expected_rows)
 
663
    def test_empty_and_long_string_values(self):
 
664
        keywords = ["String"]
 
665
        rows = TableOfClients(self.clients, keywords,
 
666
                              self.tablewords).rows()
 
667
        expected_rows = ("""
 
668
A String                                                                                                                                                                                                                                                                                                                                  
 
669
                                                                                                                                                                                                                                                                                                                                          
 
670
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,
 
671
"""
 
672
        ).splitlines()[1:]
 
673
        self.assertEqual(rows, expected_rows)
 
674
 
 
675
 
 
676
 
 
677
def should_only_run_tests():
 
678
    parser = argparse.ArgumentParser(add_help=False)
 
679
    parser.add_argument("--check", action='store_true')
 
680
    args, unknown_args = parser.parse_known_args()
 
681
    run_tests = args.check
 
682
    if run_tests:
 
683
        # Remove --check argument from sys.argv
 
684
        sys.argv[1:] = unknown_args
 
685
    return run_tests
 
686
 
 
687
# Add all tests from doctest strings
 
688
def load_tests(loader, tests, none):
 
689
    import doctest
 
690
    tests.addTests(doctest.DocTestSuite())
 
691
    return tests
 
692
 
344
693
if __name__ == "__main__":
345
 
    main()
 
694
    if should_only_run_tests():
 
695
        # Call using ./tdd-python-script --check [--verbose]
 
696
        unittest.main()
 
697
    else:
 
698
        main()