/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

* mandos: White space and other misc. format fixes only.

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