/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 19:22:08 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190228192208-1bkaewjx1vzar0sl
mandos-ctl: Use logging module instead of print() for errors

* mandos-ctl (log): New logging object.
  (main): Use log instead of print("<message>", file=sys.stderr).

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