/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: 2014-07-25 22:17:55 UTC
  • Revision ID: teddy@recompile.se-20140725221755-7bak9szduz53wwtq
INSTALL: Add org-mode setting to show all text when opening.

* INSTALL (STARTUP): New org-mode setting; set to "showall".

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