/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-02-28 18:48:33 UTC
  • Revision ID: teddy@recompile.se-20190228184833-nlg1xxlhnldso9ya
Make mandos-ctl use unittest instead of doctest module

* mandos-ctl: Before running main(), check if we should only run tests
              by seeing if the --check option was passed.
  (main): Don't look for the --check option.
  (should_only_run_tests): New.
  (load_tests): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
# 
 
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
36
import argparse
35
39
import re
36
40
import os
37
41
import collections
38
 
import doctest
 
42
import json
 
43
import unittest
39
44
 
40
45
import dbus
41
46
 
 
47
if sys.version_info.major == 2:
 
48
    str = unicode
 
49
 
42
50
locale.setlocale(locale.LC_ALL, "")
43
51
 
44
52
tablewords = {
51
59
    "Interval": "Interval",
52
60
    "Host": "Host",
53
61
    "Fingerprint": "Fingerprint",
 
62
    "KeyID": "Key ID",
54
63
    "CheckerRunning": "Check Is Running",
55
64
    "LastEnabled": "Last Enabled",
56
65
    "ApprovalPending": "Approval Is Pending",
58
67
    "ApprovalDelay": "Approval Delay",
59
68
    "ApprovalDuration": "Approval Duration",
60
69
    "Checker": "Checker",
61
 
    "ExtendedTimeout" : "Extended Timeout"
62
 
    }
 
70
    "ExtendedTimeout": "Extended Timeout",
 
71
    "Expires": "Expires",
 
72
    "LastCheckerStatus": "Last Checker Status",
 
73
}
63
74
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
75
domain = "se.recompile"
65
76
busname = domain + ".Mandos"
66
77
server_path = "/"
67
78
server_interface = domain + ".Mandos"
68
79
client_interface = domain + ".Mandos.Client"
69
 
version = "1.6.0"
70
 
 
71
 
def timedelta_to_milliseconds(td):
72
 
    """Convert a datetime.timedelta object to milliseconds"""
73
 
    return ((td.days * 24 * 60 * 60 * 1000)
74
 
            + (td.seconds * 1000)
75
 
            + (td.microseconds // 1000))
 
80
version = "1.8.3"
 
81
 
 
82
 
 
83
try:
 
84
    dbus.OBJECT_MANAGER_IFACE
 
85
except AttributeError:
 
86
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
87
 
76
88
 
77
89
def milliseconds_to_string(ms):
78
90
    td = datetime.timedelta(0, 0, 0, ms)
79
91
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
 
            .format(days = "{0}T".format(td.days) if td.days else "",
81
 
                    hours = td.seconds // 3600,
82
 
                    minutes = (td.seconds % 3600) // 60,
83
 
                    seconds = td.seconds % 60,
84
 
                    ))
 
92
            .format(days="{}T".format(td.days) if td.days else "",
 
93
                    hours=td.seconds // 3600,
 
94
                    minutes=(td.seconds % 3600) // 60,
 
95
                    seconds=td.seconds % 60))
85
96
 
86
97
 
87
98
def rfc3339_duration_to_delta(duration):
88
99
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
89
 
    
 
100
 
90
101
    >>> rfc3339_duration_to_delta("P7D")
91
102
    datetime.timedelta(7)
92
103
    >>> rfc3339_duration_to_delta("PT60S")
102
113
    >>> rfc3339_duration_to_delta("P1DT3M20S")
103
114
    datetime.timedelta(1, 200)
104
115
    """
105
 
    
 
116
 
106
117
    # Parsing an RFC 3339 duration with regular expressions is not
107
118
    # possible - there would have to be multiple places for the same
108
119
    # values, like seconds.  The current code, while more esoteric, is
109
120
    # cleaner without depending on a parsing library.  If Python had a
110
121
    # built-in library for parsing we would use it, but we'd like to
111
122
    # avoid excessive use of external libraries.
112
 
    
 
123
 
113
124
    # New type for defining tokens, syntax, and semantics all-in-one
114
 
    Token = collections.namedtuple("Token",
115
 
                                   ("regexp", # To match token; if
116
 
                                              # "value" is not None,
117
 
                                              # must have a "group"
118
 
                                              # containing digits
119
 
                                    "value",  # datetime.timedelta or
120
 
                                              # None
121
 
                                    "followers")) # Tokens valid after
122
 
                                                  # this token
 
125
    Token = collections.namedtuple("Token", (
 
126
        "regexp",  # To match token; if "value" is not None, must have
 
127
                   # a "group" containing digits
 
128
        "value",   # datetime.timedelta or None
 
129
        "followers"))           # Tokens valid after this token
123
130
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
131
    # the "duration" ABNF definition in RFC 3339, Appendix A.
125
132
    token_end = Token(re.compile(r"$"), None, frozenset())
126
133
    token_second = Token(re.compile(r"(\d+)S"),
127
134
                         datetime.timedelta(seconds=1),
128
 
                         frozenset((token_end,)))
 
135
                         frozenset((token_end, )))
129
136
    token_minute = Token(re.compile(r"(\d+)M"),
130
137
                         datetime.timedelta(minutes=1),
131
138
                         frozenset((token_second, token_end)))
147
154
                       frozenset((token_month, token_end)))
148
155
    token_week = Token(re.compile(r"(\d+)W"),
149
156
                       datetime.timedelta(weeks=1),
150
 
                       frozenset((token_end,)))
 
157
                       frozenset((token_end, )))
151
158
    token_duration = Token(re.compile(r"P"), None,
152
159
                           frozenset((token_year, token_month,
153
160
                                      token_day, token_time,
154
 
                                      token_week))),
155
 
    # Define starting values
156
 
    value = datetime.timedelta() # Value so far
 
161
                                      token_week)))
 
162
    # Define starting values:
 
163
    # Value so far
 
164
    value = datetime.timedelta()
157
165
    found_token = None
158
 
    followers = frozenset(token_duration,) # Following valid tokens
159
 
    s = duration                # String left to parse
 
166
    # Following valid tokens
 
167
    followers = frozenset((token_duration, ))
 
168
    # String left to parse
 
169
    s = duration
160
170
    # Loop until end token is found
161
171
    while found_token is not token_end:
162
172
        # Search for any currently valid tokens
178
188
                break
179
189
        else:
180
190
            # No currently valid tokens were found
181
 
            raise ValueError("Invalid RFC 3339 duration")
 
191
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
192
                             .format(duration))
182
193
    # End token found
183
194
    return value
184
195
 
185
196
 
186
197
def string_to_delta(interval):
187
198
    """Parse a string and return a datetime.timedelta
188
 
    
189
 
    >>> string_to_delta("7d")
 
199
 
 
200
    >>> string_to_delta('7d')
190
201
    datetime.timedelta(7)
191
 
    >>> string_to_delta("60s")
 
202
    >>> string_to_delta('60s')
192
203
    datetime.timedelta(0, 60)
193
 
    >>> string_to_delta("60m")
 
204
    >>> string_to_delta('60m')
194
205
    datetime.timedelta(0, 3600)
195
 
    >>> string_to_delta("24h")
 
206
    >>> string_to_delta('24h')
196
207
    datetime.timedelta(1)
197
 
    >>> string_to_delta("1w")
 
208
    >>> string_to_delta('1w')
198
209
    datetime.timedelta(7)
199
 
    >>> string_to_delta("5m 30s")
 
210
    >>> string_to_delta('5m 30s')
200
211
    datetime.timedelta(0, 330)
201
212
    """
202
 
    value = datetime.timedelta(0)
203
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
204
 
    
 
213
 
205
214
    try:
206
215
        return rfc3339_duration_to_delta(interval)
207
216
    except ValueError:
208
217
        pass
209
 
    
 
218
 
 
219
    value = datetime.timedelta(0)
 
220
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
221
 
210
222
    for num, suffix in regexp.findall(interval):
211
223
        if suffix == "d":
212
224
            value += datetime.timedelta(int(num))
222
234
            value += datetime.timedelta(0, 0, 0, int(num))
223
235
    return value
224
236
 
 
237
 
225
238
def print_clients(clients, keywords):
226
239
    def valuetostring(value, keyword):
227
240
        if type(value) is dbus.Boolean:
229
242
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
230
243
                       "ApprovalDuration", "ExtendedTimeout"):
231
244
            return milliseconds_to_string(value)
232
 
        return unicode(value)
233
 
    
 
245
        return str(value)
 
246
 
234
247
    # Create format string to print table rows
235
248
    format_string = " ".join("{{{key}:{width}}}".format(
236
 
            width = max(len(tablewords[key]),
237
 
                        max(len(valuetostring(client[key],
238
 
                                              key))
239
 
                            for client in
240
 
                            clients)),
241
 
            key = key) for key in keywords)
 
249
        width=max(len(tablewords[key]),
 
250
                  max(len(valuetostring(client[key], key))
 
251
                      for client in clients)),
 
252
        key=key)
 
253
                             for key in keywords)
242
254
    # Print header line
243
255
    print(format_string.format(**tablewords))
244
256
    for client in clients:
245
 
        print(format_string.format(**dict((key,
246
 
                                           valuetostring(client[key],
247
 
                                                         key))
248
 
                                          for key in keywords)))
 
257
        print(format_string
 
258
              .format(**{key: valuetostring(client[key], key)
 
259
                         for key in keywords}))
 
260
 
249
261
 
250
262
def has_actions(options):
251
263
    return any((options.enable,
267
279
                options.approve,
268
280
                options.deny))
269
281
 
 
282
 
270
283
def main():
271
284
    parser = argparse.ArgumentParser()
272
285
    parser.add_argument("--version", action="version",
273
 
                        version = "%(prog)s {0}".format(version),
 
286
                        version="%(prog)s {}".format(version),
274
287
                        help="show version number and exit")
275
288
    parser.add_argument("-a", "--all", action="store_true",
276
289
                        help="Select all clients")
277
290
    parser.add_argument("-v", "--verbose", action="store_true",
278
291
                        help="Print all fields")
 
292
    parser.add_argument("-j", "--dump-json", action="store_true",
 
293
                        help="Dump client data in JSON format")
279
294
    parser.add_argument("-e", "--enable", action="store_true",
280
295
                        help="Enable client")
281
296
    parser.add_argument("-d", "--disable", action="store_true",
309
324
    parser.add_argument("--approval-duration",
310
325
                        help="Set duration of one client approval")
311
326
    parser.add_argument("-H", "--host", help="Set host for client")
312
 
    parser.add_argument("-s", "--secret", type=file,
 
327
    parser.add_argument("-s", "--secret",
 
328
                        type=argparse.FileType(mode="rb"),
313
329
                        help="Set password blob (file) for client")
314
330
    parser.add_argument("-A", "--approve", action="store_true",
315
331
                        help="Approve any current client request")
319
335
                        help="Run self-test")
320
336
    parser.add_argument("client", nargs="*", help="Client name")
321
337
    options = parser.parse_args()
322
 
    
 
338
 
323
339
    if has_actions(options) and not (options.client or options.all):
324
340
        parser.error("Options require clients names or --all.")
325
341
    if options.verbose and has_actions(options):
326
 
        parser.error("--verbose can only be used alone or with"
327
 
                     " --all.")
 
342
        parser.error("--verbose can only be used alone.")
 
343
    if options.dump_json and (options.verbose
 
344
                              or has_actions(options)):
 
345
        parser.error("--dump-json can only be used alone.")
328
346
    if options.all and not has_actions(options):
329
347
        parser.error("--all requires an action.")
330
348
 
331
 
    if options.check:
332
 
        fail_count, test_count = doctest.testmod()
333
 
        sys.exit(0 if fail_count == 0 else 1)
334
 
    
335
349
    try:
336
350
        bus = dbus.SystemBus()
337
351
        mandos_dbus_objc = bus.get_object(busname, server_path)
338
352
    except dbus.exceptions.DBusException:
339
 
        print("Could not connect to Mandos server",
340
 
              file=sys.stderr)
 
353
        print("Could not connect to Mandos server", file=sys.stderr)
341
354
        sys.exit(1)
342
 
    
 
355
 
343
356
    mandos_serv = dbus.Interface(mandos_dbus_objc,
344
 
                                 dbus_interface = server_interface)
345
 
    
346
 
    #block stderr since dbus library prints to stderr
 
357
                                 dbus_interface=server_interface)
 
358
    mandos_serv_object_manager = dbus.Interface(
 
359
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
360
 
 
361
    # block stderr since dbus library prints to stderr
347
362
    null = os.open(os.path.devnull, os.O_RDWR)
348
363
    stderrcopy = os.dup(sys.stderr.fileno())
349
364
    os.dup2(null, sys.stderr.fileno())
350
365
    os.close(null)
351
366
    try:
352
367
        try:
353
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
368
            mandos_clients = {path: ifs_and_props[client_interface]
 
369
                              for path, ifs_and_props in
 
370
                              mandos_serv_object_manager
 
371
                              .GetManagedObjects().items()
 
372
                              if client_interface in ifs_and_props}
354
373
        finally:
355
 
            #restore stderr
 
374
            # restore stderr
356
375
            os.dup2(stderrcopy, sys.stderr.fileno())
357
376
            os.close(stderrcopy)
358
 
    except dbus.exceptions.DBusException:
359
 
        print("Access denied: Accessing mandos server through dbus.",
 
377
    except dbus.exceptions.DBusException as e:
 
378
        print("Access denied: "
 
379
              "Accessing mandos server through D-Bus: {}".format(e),
360
380
              file=sys.stderr)
361
381
        sys.exit(1)
362
 
    
 
382
 
363
383
    # Compile dict of (clients: properties) to process
364
 
    clients={}
365
 
    
 
384
    clients = {}
 
385
 
366
386
    if options.all or not options.client:
367
 
        clients = dict((bus.get_object(busname, path), properties)
368
 
                       for path, properties in
369
 
                       mandos_clients.iteritems())
 
387
        clients = {bus.get_object(busname, path): properties
 
388
                   for path, properties in mandos_clients.items()}
370
389
    else:
371
390
        for name in options.client:
372
 
            for path, client in mandos_clients.iteritems():
 
391
            for path, client in mandos_clients.items():
373
392
                if client["Name"] == name:
374
393
                    client_objc = bus.get_object(busname, path)
375
394
                    clients[client_objc] = client
376
395
                    break
377
396
            else:
378
 
                print("Client not found on server: {0!r}"
 
397
                print("Client not found on server: {!r}"
379
398
                      .format(name), file=sys.stderr)
380
399
                sys.exit(1)
381
 
    
 
400
 
382
401
    if not has_actions(options) and clients:
383
 
        if options.verbose:
384
 
            keywords = ("Name", "Enabled", "Timeout",
385
 
                        "LastCheckedOK", "Created", "Interval",
386
 
                        "Host", "Fingerprint", "CheckerRunning",
 
402
        if options.verbose or options.dump_json:
 
403
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
404
                        "Created", "Interval", "Host", "KeyID",
 
405
                        "Fingerprint", "CheckerRunning",
387
406
                        "LastEnabled", "ApprovalPending",
388
 
                        "ApprovedByDefault",
389
 
                        "LastApprovalRequest", "ApprovalDelay",
390
 
                        "ApprovalDuration", "Checker",
391
 
                        "ExtendedTimeout")
 
407
                        "ApprovedByDefault", "LastApprovalRequest",
 
408
                        "ApprovalDelay", "ApprovalDuration",
 
409
                        "Checker", "ExtendedTimeout", "Expires",
 
410
                        "LastCheckerStatus")
392
411
        else:
393
412
            keywords = defaultkeywords
394
 
        
395
 
        print_clients(clients.values(), keywords)
 
413
 
 
414
        if options.dump_json:
 
415
            json.dump({client["Name"]: {key:
 
416
                                        bool(client[key])
 
417
                                        if isinstance(client[key],
 
418
                                                      dbus.Boolean)
 
419
                                        else client[key]
 
420
                                        for key in keywords}
 
421
                       for client in clients.values()},
 
422
                      fp=sys.stdout, indent=4,
 
423
                      separators=(',', ': '))
 
424
            print()
 
425
        else:
 
426
            print_clients(clients.values(), keywords)
396
427
    else:
397
428
        # Process each client in the list by all selected options
398
429
        for client in clients:
 
430
 
399
431
            def set_client_prop(prop, value):
400
432
                """Set a Client D-Bus property"""
401
433
                client.Set(client_interface, prop, value,
402
434
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
435
 
403
436
            def set_client_prop_ms(prop, value):
404
437
                """Set a Client D-Bus property, converted
405
438
                from a string to milliseconds."""
406
439
                set_client_prop(prop,
407
 
                                timedelta_to_milliseconds
408
 
                                (string_to_delta(value)))
 
440
                                string_to_delta(value).total_seconds()
 
441
                                * 1000)
 
442
 
409
443
            if options.remove:
410
444
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
445
            if options.enable:
419
453
            if options.stop_checker:
420
454
                set_client_prop("CheckerRunning", dbus.Boolean(False))
421
455
            if options.is_enabled:
422
 
                sys.exit(0 if client.Get(client_interface,
423
 
                                         "Enabled",
424
 
                                         dbus_interface=
425
 
                                         dbus.PROPERTIES_IFACE)
426
 
                         else 1)
 
456
                if client.Get(client_interface, "Enabled",
 
457
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
458
                    sys.exit(0)
 
459
                else:
 
460
                    sys.exit(1)
427
461
            if options.checker is not None:
428
462
                set_client_prop("Checker", options.checker)
429
463
            if options.host is not None:
455
489
                client.Approve(dbus.Boolean(False),
456
490
                               dbus_interface=client_interface)
457
491
 
 
492
 
 
493
def should_only_run_tests():
 
494
    parser = argparse.ArgumentParser(add_help=False)
 
495
    parser.add_argument("--check", action='store_true')
 
496
    args, unknown_args = parser.parse_known_args()
 
497
    run_tests = args.check
 
498
    if run_tests:
 
499
        # Remove --check argument from sys.argv
 
500
        sys.argv[1:] = unknown_args
 
501
    return run_tests
 
502
 
 
503
# Add all tests from doctest strings
 
504
def load_tests(loader, tests, none):
 
505
    import doctest
 
506
    tests.addTests(doctest.DocTestSuite())
 
507
    return tests
 
508
 
458
509
if __name__ == "__main__":
459
 
    main()
 
510
    if should_only_run_tests():
 
511
        # Call using ./tdd-python-script --check [--verbose]
 
512
        unittest.main()
 
513
    else:
 
514
        main()