/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-02-28 18:48:33 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • 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
 
 
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
 
 
45
import dbus
 
46
 
 
47
if sys.version_info.major == 2:
 
48
    str = unicode
36
49
 
37
50
locale.setlocale(locale.LC_ALL, "")
38
51
 
46
59
    "Interval": "Interval",
47
60
    "Host": "Host",
48
61
    "Fingerprint": "Fingerprint",
 
62
    "KeyID": "Key ID",
49
63
    "CheckerRunning": "Check Is Running",
50
64
    "LastEnabled": "Last Enabled",
51
65
    "ApprovalPending": "Approval Is Pending",
53
67
    "ApprovalDelay": "Approval Delay",
54
68
    "ApprovalDuration": "Approval Duration",
55
69
    "Checker": "Checker",
56
 
    "ExtendedTimeout" : "Extended Timeout"
57
 
    }
 
70
    "ExtendedTimeout": "Extended Timeout",
 
71
    "Expires": "Expires",
 
72
    "LastCheckerStatus": "Last Checker Status",
 
73
}
58
74
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
59
75
domain = "se.recompile"
60
76
busname = domain + ".Mandos"
61
77
server_path = "/"
62
78
server_interface = domain + ".Mandos"
63
79
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))
 
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
 
71
88
 
72
89
def milliseconds_to_string(ms):
73
90
    td = datetime.timedelta(0, 0, 0, ms)
74
91
    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
 
                    ))
 
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))
 
96
 
 
97
 
 
98
def rfc3339_duration_to_delta(duration):
 
99
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
100
 
 
101
    >>> rfc3339_duration_to_delta("P7D")
 
102
    datetime.timedelta(7)
 
103
    >>> rfc3339_duration_to_delta("PT60S")
 
104
    datetime.timedelta(0, 60)
 
105
    >>> rfc3339_duration_to_delta("PT60M")
 
106
    datetime.timedelta(0, 3600)
 
107
    >>> rfc3339_duration_to_delta("PT24H")
 
108
    datetime.timedelta(1)
 
109
    >>> rfc3339_duration_to_delta("P1W")
 
110
    datetime.timedelta(7)
 
111
    >>> rfc3339_duration_to_delta("PT5M30S")
 
112
    datetime.timedelta(0, 330)
 
113
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
114
    datetime.timedelta(1, 200)
 
115
    """
 
116
 
 
117
    # Parsing an RFC 3339 duration with regular expressions is not
 
118
    # possible - there would have to be multiple places for the same
 
119
    # values, like seconds.  The current code, while more esoteric, is
 
120
    # cleaner without depending on a parsing library.  If Python had a
 
121
    # built-in library for parsing we would use it, but we'd like to
 
122
    # avoid excessive use of external libraries.
 
123
 
 
124
    # New type for defining tokens, syntax, and semantics all-in-one
 
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
 
130
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
131
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
132
    token_end = Token(re.compile(r"$"), None, frozenset())
 
133
    token_second = Token(re.compile(r"(\d+)S"),
 
134
                         datetime.timedelta(seconds=1),
 
135
                         frozenset((token_end, )))
 
136
    token_minute = Token(re.compile(r"(\d+)M"),
 
137
                         datetime.timedelta(minutes=1),
 
138
                         frozenset((token_second, token_end)))
 
139
    token_hour = Token(re.compile(r"(\d+)H"),
 
140
                       datetime.timedelta(hours=1),
 
141
                       frozenset((token_minute, token_end)))
 
142
    token_time = Token(re.compile(r"T"),
 
143
                       None,
 
144
                       frozenset((token_hour, token_minute,
 
145
                                  token_second)))
 
146
    token_day = Token(re.compile(r"(\d+)D"),
 
147
                      datetime.timedelta(days=1),
 
148
                      frozenset((token_time, token_end)))
 
149
    token_month = Token(re.compile(r"(\d+)M"),
 
150
                        datetime.timedelta(weeks=4),
 
151
                        frozenset((token_day, token_end)))
 
152
    token_year = Token(re.compile(r"(\d+)Y"),
 
153
                       datetime.timedelta(weeks=52),
 
154
                       frozenset((token_month, token_end)))
 
155
    token_week = Token(re.compile(r"(\d+)W"),
 
156
                       datetime.timedelta(weeks=1),
 
157
                       frozenset((token_end, )))
 
158
    token_duration = Token(re.compile(r"P"), None,
 
159
                           frozenset((token_year, token_month,
 
160
                                      token_day, token_time,
 
161
                                      token_week)))
 
162
    # Define starting values:
 
163
    # Value so far
 
164
    value = datetime.timedelta()
 
165
    found_token = None
 
166
    # Following valid tokens
 
167
    followers = frozenset((token_duration, ))
 
168
    # String left to parse
 
169
    s = duration
 
170
    # Loop until end token is found
 
171
    while found_token is not token_end:
 
172
        # Search for any currently valid tokens
 
173
        for token in followers:
 
174
            match = token.regexp.match(s)
 
175
            if match is not None:
 
176
                # Token found
 
177
                if token.value is not None:
 
178
                    # Value found, parse digits
 
179
                    factor = int(match.group(1), 10)
 
180
                    # Add to value so far
 
181
                    value += factor * token.value
 
182
                # Strip token from string
 
183
                s = token.regexp.sub("", s, 1)
 
184
                # Go to found token
 
185
                found_token = token
 
186
                # Set valid next tokens
 
187
                followers = found_token.followers
 
188
                break
 
189
        else:
 
190
            # No currently valid tokens were found
 
191
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
192
                             .format(duration))
 
193
    # End token found
 
194
    return value
 
195
 
80
196
 
81
197
def string_to_delta(interval):
82
198
    """Parse a string and return a datetime.timedelta
83
 
    
84
 
    >>> string_to_delta("7d")
 
199
 
 
200
    >>> string_to_delta('7d')
85
201
    datetime.timedelta(7)
86
 
    >>> string_to_delta("60s")
 
202
    >>> string_to_delta('60s')
87
203
    datetime.timedelta(0, 60)
88
 
    >>> string_to_delta("60m")
 
204
    >>> string_to_delta('60m')
89
205
    datetime.timedelta(0, 3600)
90
 
    >>> string_to_delta("24h")
 
206
    >>> string_to_delta('24h')
91
207
    datetime.timedelta(1)
92
 
    >>> string_to_delta("1w")
 
208
    >>> string_to_delta('1w')
93
209
    datetime.timedelta(7)
94
 
    >>> string_to_delta("5m 30s")
 
210
    >>> string_to_delta('5m 30s')
95
211
    datetime.timedelta(0, 330)
96
212
    """
 
213
 
 
214
    try:
 
215
        return rfc3339_duration_to_delta(interval)
 
216
    except ValueError:
 
217
        pass
 
218
 
97
219
    value = datetime.timedelta(0)
98
 
    regexp = re.compile("(\d+)([dsmhw]?)")
99
 
    
 
220
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
221
 
100
222
    for num, suffix in regexp.findall(interval):
101
223
        if suffix == "d":
102
224
            value += datetime.timedelta(int(num))
112
234
            value += datetime.timedelta(0, 0, 0, int(num))
113
235
    return value
114
236
 
 
237
 
115
238
def print_clients(clients, keywords):
116
239
    def valuetostring(value, keyword):
117
240
        if type(value) is dbus.Boolean:
119
242
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
120
243
                       "ApprovalDuration", "ExtendedTimeout"):
121
244
            return milliseconds_to_string(value)
122
 
        return unicode(value)
123
 
    
 
245
        return str(value)
 
246
 
124
247
    # Create format string to print table rows
125
248
    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)
 
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)
132
254
    # Print header line
133
255
    print(format_string.format(**tablewords))
134
256
    for client in clients:
135
 
        print(format_string.format(**dict((key,
136
 
                                           valuetostring(client[key],
137
 
                                                         key))
138
 
                                          for key in keywords)))
 
257
        print(format_string
 
258
              .format(**{key: valuetostring(client[key], key)
 
259
                         for key in keywords}))
 
260
 
139
261
 
140
262
def has_actions(options):
141
263
    return any((options.enable,
157
279
                options.approve,
158
280
                options.deny))
159
281
 
 
282
 
160
283
def main():
161
284
    parser = argparse.ArgumentParser()
162
285
    parser.add_argument("--version", action="version",
163
 
                        version = "%(prog)s {0}".format(version),
 
286
                        version="%(prog)s {}".format(version),
164
287
                        help="show version number and exit")
165
288
    parser.add_argument("-a", "--all", action="store_true",
166
289
                        help="Select all clients")
167
290
    parser.add_argument("-v", "--verbose", action="store_true",
168
291
                        help="Print all fields")
 
292
    parser.add_argument("-j", "--dump-json", action="store_true",
 
293
                        help="Dump client data in JSON format")
169
294
    parser.add_argument("-e", "--enable", action="store_true",
170
295
                        help="Enable client")
171
296
    parser.add_argument("-d", "--disable", action="store_true",
199
324
    parser.add_argument("--approval-duration",
200
325
                        help="Set duration of one client approval")
201
326
    parser.add_argument("-H", "--host", help="Set host for client")
202
 
    parser.add_argument("-s", "--secret", type=file,
 
327
    parser.add_argument("-s", "--secret",
 
328
                        type=argparse.FileType(mode="rb"),
203
329
                        help="Set password blob (file) for client")
204
330
    parser.add_argument("-A", "--approve", action="store_true",
205
331
                        help="Approve any current client request")
206
332
    parser.add_argument("-D", "--deny", action="store_true",
207
333
                        help="Deny any current client request")
 
334
    parser.add_argument("--check", action="store_true",
 
335
                        help="Run self-test")
208
336
    parser.add_argument("client", nargs="*", help="Client name")
209
337
    options = parser.parse_args()
210
 
    
 
338
 
211
339
    if has_actions(options) and not (options.client or options.all):
212
340
        parser.error("Options require clients names or --all.")
213
341
    if options.verbose and has_actions(options):
214
 
        parser.error("--verbose can only be used alone or with"
215
 
                     " --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.")
216
346
    if options.all and not has_actions(options):
217
347
        parser.error("--all requires an action.")
218
 
    
 
348
 
219
349
    try:
220
350
        bus = dbus.SystemBus()
221
351
        mandos_dbus_objc = bus.get_object(busname, server_path)
222
352
    except dbus.exceptions.DBusException:
223
 
        print("Could not connect to Mandos server",
224
 
              file=sys.stderr)
 
353
        print("Could not connect to Mandos server", file=sys.stderr)
225
354
        sys.exit(1)
226
 
    
 
355
 
227
356
    mandos_serv = dbus.Interface(mandos_dbus_objc,
228
 
                                 dbus_interface = server_interface)
229
 
    
230
 
    #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
231
362
    null = os.open(os.path.devnull, os.O_RDWR)
232
363
    stderrcopy = os.dup(sys.stderr.fileno())
233
364
    os.dup2(null, sys.stderr.fileno())
234
365
    os.close(null)
235
366
    try:
236
367
        try:
237
 
            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}
238
373
        finally:
239
 
            #restore stderr
 
374
            # restore stderr
240
375
            os.dup2(stderrcopy, sys.stderr.fileno())
241
376
            os.close(stderrcopy)
242
 
    except dbus.exceptions.DBusException:
243
 
        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),
244
380
              file=sys.stderr)
245
381
        sys.exit(1)
246
 
    
 
382
 
247
383
    # Compile dict of (clients: properties) to process
248
 
    clients={}
249
 
    
 
384
    clients = {}
 
385
 
250
386
    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())
 
387
        clients = {bus.get_object(busname, path): properties
 
388
                   for path, properties in mandos_clients.items()}
254
389
    else:
255
390
        for name in options.client:
256
 
            for path, client in mandos_clients.iteritems():
 
391
            for path, client in mandos_clients.items():
257
392
                if client["Name"] == name:
258
393
                    client_objc = bus.get_object(busname, path)
259
394
                    clients[client_objc] = client
260
395
                    break
261
396
            else:
262
 
                print("Client not found on server: {0!r}"
 
397
                print("Client not found on server: {!r}"
263
398
                      .format(name), file=sys.stderr)
264
399
                sys.exit(1)
265
 
    
 
400
 
266
401
    if not has_actions(options) and clients:
267
 
        if options.verbose:
268
 
            keywords = ("Name", "Enabled", "Timeout",
269
 
                        "LastCheckedOK", "Created", "Interval",
270
 
                        "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",
271
406
                        "LastEnabled", "ApprovalPending",
272
 
                        "ApprovedByDefault",
273
 
                        "LastApprovalRequest", "ApprovalDelay",
274
 
                        "ApprovalDuration", "Checker",
275
 
                        "ExtendedTimeout")
 
407
                        "ApprovedByDefault", "LastApprovalRequest",
 
408
                        "ApprovalDelay", "ApprovalDuration",
 
409
                        "Checker", "ExtendedTimeout", "Expires",
 
410
                        "LastCheckerStatus")
276
411
        else:
277
412
            keywords = defaultkeywords
278
 
        
279
 
        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)
280
427
    else:
281
428
        # Process each client in the list by all selected options
282
429
        for client in clients:
 
430
 
283
431
            def set_client_prop(prop, value):
284
432
                """Set a Client D-Bus property"""
285
433
                client.Set(client_interface, prop, value,
286
434
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
435
 
287
436
            def set_client_prop_ms(prop, value):
288
437
                """Set a Client D-Bus property, converted
289
438
                from a string to milliseconds."""
290
439
                set_client_prop(prop,
291
 
                                timedelta_to_milliseconds
292
 
                                (string_to_delta(value)))
 
440
                                string_to_delta(value).total_seconds()
 
441
                                * 1000)
 
442
 
293
443
            if options.remove:
294
444
                mandos_serv.RemoveClient(client.__dbus_object_path__)
295
445
            if options.enable:
303
453
            if options.stop_checker:
304
454
                set_client_prop("CheckerRunning", dbus.Boolean(False))
305
455
            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)
 
456
                if client.Get(client_interface, "Enabled",
 
457
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
458
                    sys.exit(0)
 
459
                else:
 
460
                    sys.exit(1)
311
461
            if options.checker is not None:
312
462
                set_client_prop("Checker", options.checker)
313
463
            if options.host is not None:
339
489
                client.Approve(dbus.Boolean(False),
340
490
                               dbus_interface=client_interface)
341
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
 
342
509
if __name__ == "__main__":
343
 
    main()
 
510
    if should_only_run_tests():
 
511
        # Call using ./tdd-python-script --check [--verbose]
 
512
        unittest.main()
 
513
    else:
 
514
        main()