/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2014-07-17 03:17:22 UTC
  • mfrom: (719 trunk)
  • mto: This revision was merged to the branch mainline in revision 720.
  • Revision ID: teddy@recompile.se-20140717031722-whllsy5muoaefh4i
Merge from trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
3
 
#
 
2
# -*- mode: python; coding: utf-8 -*-
 
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2008-2019 Teddy Hogeborn
7
 
# Copyright © 2008-2019 Björn Påhlsson
8
 
#
9
 
# This file is part of Mandos.
10
 
#
11
 
# Mandos is free software: you can redistribute it and/or modify it
12
 
# under the terms of the GNU General Public License as published by
 
5
# 
 
6
# Copyright © 2008-2014 Teddy Hogeborn
 
7
# Copyright © 2008-2014 Björn Påhlsson
 
8
# 
 
9
# This program is free software: you can redistribute it and/or modify
 
10
# it under the terms of the GNU General Public License as published by
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
17
#     GNU General Public License for more details.
20
 
#
 
18
# 
21
19
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
23
 
#
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
24
23
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
24
# 
26
25
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
39
38
import re
40
39
import os
41
40
import collections
42
 
import json
43
 
import unittest
44
 
import logging
 
41
import doctest
45
42
 
46
43
import dbus
47
44
 
48
 
# Show warnings by default
49
 
if not sys.warnoptions:
50
 
    import warnings
51
 
    warnings.simplefilter("default")
52
 
 
53
 
log = logging.getLogger(sys.argv[0])
54
 
logging.basicConfig(level="INFO", # Show info level messages
55
 
                    format="%(message)s") # Show basic log messages
56
 
 
57
 
logging.captureWarnings(True)   # Show warnings via the logging system
58
 
 
59
 
if sys.version_info.major == 2:
 
45
if sys.version_info[0] == 2:
60
46
    str = unicode
61
47
 
62
48
locale.setlocale(locale.LC_ALL, "")
71
57
    "Interval": "Interval",
72
58
    "Host": "Host",
73
59
    "Fingerprint": "Fingerprint",
74
 
    "KeyID": "Key ID",
75
60
    "CheckerRunning": "Check Is Running",
76
61
    "LastEnabled": "Last Enabled",
77
62
    "ApprovalPending": "Approval Is Pending",
79
64
    "ApprovalDelay": "Approval Delay",
80
65
    "ApprovalDuration": "Approval Duration",
81
66
    "Checker": "Checker",
82
 
    "ExtendedTimeout": "Extended Timeout",
83
 
    "Expires": "Expires",
84
 
    "LastCheckerStatus": "Last Checker Status",
85
 
}
 
67
    "ExtendedTimeout" : "Extended Timeout"
 
68
    }
86
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
70
domain = "se.recompile"
88
71
busname = domain + ".Mandos"
89
72
server_path = "/"
90
73
server_interface = domain + ".Mandos"
91
74
client_interface = domain + ".Mandos.Client"
92
 
version = "1.8.3"
93
 
 
94
 
 
95
 
try:
96
 
    dbus.OBJECT_MANAGER_IFACE
97
 
except AttributeError:
98
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
99
 
 
 
75
version = "1.6.6"
 
76
 
 
77
def timedelta_to_milliseconds(td):
 
78
    """Convert a datetime.timedelta object to milliseconds"""
 
79
    return ((td.days * 24 * 60 * 60 * 1000)
 
80
            + (td.seconds * 1000)
 
81
            + (td.microseconds // 1000))
100
82
 
101
83
def milliseconds_to_string(ms):
102
84
    td = datetime.timedelta(0, 0, 0, ms)
103
85
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
104
 
            .format(days="{}T".format(td.days) if td.days else "",
105
 
                    hours=td.seconds // 3600,
106
 
                    minutes=(td.seconds % 3600) // 60,
107
 
                    seconds=td.seconds % 60))
 
86
            .format(days = "{0}T".format(td.days) if td.days else "",
 
87
                    hours = td.seconds // 3600,
 
88
                    minutes = (td.seconds % 3600) // 60,
 
89
                    seconds = td.seconds % 60,
 
90
                    ))
108
91
 
109
92
 
110
93
def rfc3339_duration_to_delta(duration):
111
94
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
95
    
113
96
    >>> rfc3339_duration_to_delta("P7D")
114
97
    datetime.timedelta(7)
115
98
    >>> rfc3339_duration_to_delta("PT60S")
125
108
    >>> rfc3339_duration_to_delta("P1DT3M20S")
126
109
    datetime.timedelta(1, 200)
127
110
    """
128
 
 
 
111
    
129
112
    # Parsing an RFC 3339 duration with regular expressions is not
130
113
    # possible - there would have to be multiple places for the same
131
114
    # values, like seconds.  The current code, while more esoteric, is
132
115
    # cleaner without depending on a parsing library.  If Python had a
133
116
    # built-in library for parsing we would use it, but we'd like to
134
117
    # avoid excessive use of external libraries.
135
 
 
 
118
    
136
119
    # New type for defining tokens, syntax, and semantics all-in-one
137
 
    Token = collections.namedtuple("Token", (
138
 
        "regexp",  # To match token; if "value" is not None, must have
139
 
                   # a "group" containing digits
140
 
        "value",   # datetime.timedelta or None
141
 
        "followers"))           # Tokens valid after this token
 
120
    Token = collections.namedtuple("Token",
 
121
                                   ("regexp", # To match token; if
 
122
                                              # "value" is not None,
 
123
                                              # must have a "group"
 
124
                                              # containing digits
 
125
                                    "value",  # datetime.timedelta or
 
126
                                              # None
 
127
                                    "followers")) # Tokens valid after
 
128
                                                  # this token
142
129
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
143
130
    # the "duration" ABNF definition in RFC 3339, Appendix A.
144
131
    token_end = Token(re.compile(r"$"), None, frozenset())
145
132
    token_second = Token(re.compile(r"(\d+)S"),
146
133
                         datetime.timedelta(seconds=1),
147
 
                         frozenset((token_end, )))
 
134
                         frozenset((token_end,)))
148
135
    token_minute = Token(re.compile(r"(\d+)M"),
149
136
                         datetime.timedelta(minutes=1),
150
137
                         frozenset((token_second, token_end)))
166
153
                       frozenset((token_month, token_end)))
167
154
    token_week = Token(re.compile(r"(\d+)W"),
168
155
                       datetime.timedelta(weeks=1),
169
 
                       frozenset((token_end, )))
 
156
                       frozenset((token_end,)))
170
157
    token_duration = Token(re.compile(r"P"), None,
171
158
                           frozenset((token_year, token_month,
172
159
                                      token_day, token_time,
173
 
                                      token_week)))
174
 
    # Define starting values:
175
 
    # Value so far
176
 
    value = datetime.timedelta()
 
160
                                      token_week))),
 
161
    # Define starting values
 
162
    value = datetime.timedelta() # Value so far
177
163
    found_token = None
178
 
    # Following valid tokens
179
 
    followers = frozenset((token_duration, ))
180
 
    # String left to parse
181
 
    s = duration
 
164
    followers = frozenset(token_duration,) # Following valid tokens
 
165
    s = duration                # String left to parse
182
166
    # Loop until end token is found
183
167
    while found_token is not token_end:
184
168
        # Search for any currently valid tokens
200
184
                break
201
185
        else:
202
186
            # No currently valid tokens were found
203
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
204
 
                             .format(duration))
 
187
            raise ValueError("Invalid RFC 3339 duration")
205
188
    # End token found
206
189
    return value
207
190
 
208
191
 
209
192
def string_to_delta(interval):
210
193
    """Parse a string and return a datetime.timedelta
211
 
 
212
 
    >>> string_to_delta('7d')
 
194
    
 
195
    >>> string_to_delta("7d")
213
196
    datetime.timedelta(7)
214
 
    >>> string_to_delta('60s')
 
197
    >>> string_to_delta("60s")
215
198
    datetime.timedelta(0, 60)
216
 
    >>> string_to_delta('60m')
 
199
    >>> string_to_delta("60m")
217
200
    datetime.timedelta(0, 3600)
218
 
    >>> string_to_delta('24h')
 
201
    >>> string_to_delta("24h")
219
202
    datetime.timedelta(1)
220
 
    >>> string_to_delta('1w')
 
203
    >>> string_to_delta("1w")
221
204
    datetime.timedelta(7)
222
 
    >>> string_to_delta('5m 30s')
 
205
    >>> string_to_delta("5m 30s")
223
206
    datetime.timedelta(0, 330)
224
207
    """
225
 
 
 
208
    
226
209
    try:
227
210
        return rfc3339_duration_to_delta(interval)
228
211
    except ValueError:
229
212
        pass
230
 
 
 
213
    
231
214
    value = datetime.timedelta(0)
232
215
    regexp = re.compile(r"(\d+)([dsmhw]?)")
233
 
 
 
216
    
234
217
    for num, suffix in regexp.findall(interval):
235
218
        if suffix == "d":
236
219
            value += datetime.timedelta(int(num))
246
229
            value += datetime.timedelta(0, 0, 0, int(num))
247
230
    return value
248
231
 
249
 
 
250
232
def print_clients(clients, keywords):
251
233
    def valuetostring(value, keyword):
252
 
        if isinstance(value, dbus.Boolean):
 
234
        if type(value) is dbus.Boolean:
253
235
            return "Yes" if value else "No"
254
236
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
255
237
                       "ApprovalDuration", "ExtendedTimeout"):
256
238
            return milliseconds_to_string(value)
257
239
        return str(value)
258
 
 
 
240
    
259
241
    # Create format string to print table rows
260
242
    format_string = " ".join("{{{key}:{width}}}".format(
261
 
        width=max(len(tablewords[key]),
262
 
                  max(len(valuetostring(client[key], key))
263
 
                      for client in clients)),
264
 
        key=key)
265
 
                             for key in keywords)
 
243
            width = max(len(tablewords[key]),
 
244
                        max(len(valuetostring(client[key],
 
245
                                              key))
 
246
                            for client in
 
247
                            clients)),
 
248
            key = key) for key in keywords)
266
249
    # Print header line
267
250
    print(format_string.format(**tablewords))
268
251
    for client in clients:
269
 
        print(format_string
270
 
              .format(**{key: valuetostring(client[key], key)
271
 
                         for key in keywords}))
272
 
 
 
252
        print(format_string.format(**dict((key,
 
253
                                           valuetostring(client[key],
 
254
                                                         key))
 
255
                                          for key in keywords)))
273
256
 
274
257
def has_actions(options):
275
258
    return any((options.enable,
291
274
                options.approve,
292
275
                options.deny))
293
276
 
294
 
 
295
277
def main():
296
278
    parser = argparse.ArgumentParser()
297
279
    parser.add_argument("--version", action="version",
298
 
                        version="%(prog)s {}".format(version),
 
280
                        version = "%(prog)s {0}".format(version),
299
281
                        help="show version number and exit")
300
282
    parser.add_argument("-a", "--all", action="store_true",
301
283
                        help="Select all clients")
302
284
    parser.add_argument("-v", "--verbose", action="store_true",
303
285
                        help="Print all fields")
304
 
    parser.add_argument("-j", "--dump-json", action="store_true",
305
 
                        help="Dump client data in JSON format")
306
286
    parser.add_argument("-e", "--enable", action="store_true",
307
287
                        help="Enable client")
308
288
    parser.add_argument("-d", "--disable", action="store_true",
347
327
                        help="Run self-test")
348
328
    parser.add_argument("client", nargs="*", help="Client name")
349
329
    options = parser.parse_args()
350
 
 
 
330
    
351
331
    if has_actions(options) and not (options.client or options.all):
352
332
        parser.error("Options require clients names or --all.")
353
333
    if options.verbose and has_actions(options):
354
 
        parser.error("--verbose can only be used alone.")
355
 
    if options.dump_json and (options.verbose
356
 
                              or has_actions(options)):
357
 
        parser.error("--dump-json can only be used alone.")
 
334
        parser.error("--verbose can only be used alone or with"
 
335
                     " --all.")
358
336
    if options.all and not has_actions(options):
359
337
        parser.error("--all requires an action.")
360
338
 
 
339
    if options.check:
 
340
        fail_count, test_count = doctest.testmod()
 
341
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
342
    
361
343
    try:
362
344
        bus = dbus.SystemBus()
363
345
        mandos_dbus_objc = bus.get_object(busname, server_path)
364
346
    except dbus.exceptions.DBusException:
365
 
        log.critical("Could not connect to Mandos server")
 
347
        print("Could not connect to Mandos server",
 
348
              file=sys.stderr)
366
349
        sys.exit(1)
367
 
 
 
350
    
368
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
369
 
                                 dbus_interface=server_interface)
370
 
    mandos_serv_object_manager = dbus.Interface(
371
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
372
 
 
373
 
    # block stderr since dbus library prints to stderr
 
352
                                 dbus_interface = server_interface)
 
353
    
 
354
    #block stderr since dbus library prints to stderr
374
355
    null = os.open(os.path.devnull, os.O_RDWR)
375
356
    stderrcopy = os.dup(sys.stderr.fileno())
376
357
    os.dup2(null, sys.stderr.fileno())
377
358
    os.close(null)
378
359
    try:
379
360
        try:
380
 
            mandos_clients = {path: ifs_and_props[client_interface]
381
 
                              for path, ifs_and_props in
382
 
                              mandos_serv_object_manager
383
 
                              .GetManagedObjects().items()
384
 
                              if client_interface in ifs_and_props}
 
361
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
385
362
        finally:
386
 
            # restore stderr
 
363
            #restore stderr
387
364
            os.dup2(stderrcopy, sys.stderr.fileno())
388
365
            os.close(stderrcopy)
389
 
    except dbus.exceptions.DBusException as e:
390
 
        log.critical("Failed to access Mandos server through D-Bus:"
391
 
                     "\n%s", e)
 
366
    except dbus.exceptions.DBusException:
 
367
        print("Access denied: Accessing mandos server through dbus.",
 
368
              file=sys.stderr)
392
369
        sys.exit(1)
393
 
 
 
370
    
394
371
    # Compile dict of (clients: properties) to process
395
 
    clients = {}
396
 
 
 
372
    clients={}
 
373
    
397
374
    if options.all or not options.client:
398
 
        clients = {bus.get_object(busname, path): properties
399
 
                   for path, properties in mandos_clients.items()}
 
375
        clients = dict((bus.get_object(busname, path), properties)
 
376
                       for path, properties in
 
377
                       mandos_clients.items())
400
378
    else:
401
379
        for name in options.client:
402
 
            for path, client in mandos_clients.items():
 
380
            for path, client in mandos_clients.iteritems():
403
381
                if client["Name"] == name:
404
382
                    client_objc = bus.get_object(busname, path)
405
383
                    clients[client_objc] = client
406
384
                    break
407
385
            else:
408
 
                log.critical("Client not found on server: %r", name)
 
386
                print("Client not found on server: {0!r}"
 
387
                      .format(name), file=sys.stderr)
409
388
                sys.exit(1)
410
 
 
 
389
    
411
390
    if not has_actions(options) and clients:
412
 
        if options.verbose or options.dump_json:
413
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
414
 
                        "Created", "Interval", "Host", "KeyID",
415
 
                        "Fingerprint", "CheckerRunning",
 
391
        if options.verbose:
 
392
            keywords = ("Name", "Enabled", "Timeout",
 
393
                        "LastCheckedOK", "Created", "Interval",
 
394
                        "Host", "Fingerprint", "CheckerRunning",
416
395
                        "LastEnabled", "ApprovalPending",
417
 
                        "ApprovedByDefault", "LastApprovalRequest",
418
 
                        "ApprovalDelay", "ApprovalDuration",
419
 
                        "Checker", "ExtendedTimeout", "Expires",
420
 
                        "LastCheckerStatus")
 
396
                        "ApprovedByDefault",
 
397
                        "LastApprovalRequest", "ApprovalDelay",
 
398
                        "ApprovalDuration", "Checker",
 
399
                        "ExtendedTimeout")
421
400
        else:
422
401
            keywords = defaultkeywords
423
 
 
424
 
        if options.dump_json:
425
 
            json.dump({client["Name"]: {key:
426
 
                                        bool(client[key])
427
 
                                        if isinstance(client[key],
428
 
                                                      dbus.Boolean)
429
 
                                        else client[key]
430
 
                                        for key in keywords}
431
 
                       for client in clients.values()},
432
 
                      fp=sys.stdout, indent=4,
433
 
                      separators=(',', ': '))
434
 
            print()
435
 
        else:
436
 
            print_clients(clients.values(), keywords)
 
402
        
 
403
        print_clients(clients.values(), keywords)
437
404
    else:
438
405
        # Process each client in the list by all selected options
439
406
        for client in clients:
440
 
 
441
407
            def set_client_prop(prop, value):
442
408
                """Set a Client D-Bus property"""
443
409
                client.Set(client_interface, prop, value,
444
410
                           dbus_interface=dbus.PROPERTIES_IFACE)
445
 
 
446
411
            def set_client_prop_ms(prop, value):
447
412
                """Set a Client D-Bus property, converted
448
413
                from a string to milliseconds."""
449
414
                set_client_prop(prop,
450
 
                                string_to_delta(value).total_seconds()
451
 
                                * 1000)
452
 
 
 
415
                                timedelta_to_milliseconds
 
416
                                (string_to_delta(value)))
453
417
            if options.remove:
454
418
                mandos_serv.RemoveClient(client.__dbus_object_path__)
455
419
            if options.enable:
463
427
            if options.stop_checker:
464
428
                set_client_prop("CheckerRunning", dbus.Boolean(False))
465
429
            if options.is_enabled:
466
 
                if client.Get(client_interface, "Enabled",
467
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
468
 
                    sys.exit(0)
469
 
                else:
470
 
                    sys.exit(1)
 
430
                sys.exit(0 if client.Get(client_interface,
 
431
                                         "Enabled",
 
432
                                         dbus_interface=
 
433
                                         dbus.PROPERTIES_IFACE)
 
434
                         else 1)
471
435
            if options.checker is not None:
472
436
                set_client_prop("Checker", options.checker)
473
437
            if options.host is not None:
499
463
                client.Approve(dbus.Boolean(False),
500
464
                               dbus_interface=client_interface)
501
465
 
502
 
 
503
 
class Test_milliseconds_to_string(unittest.TestCase):
504
 
    def test_all(self):
505
 
        self.assertEqual(milliseconds_to_string(93785000),
506
 
                         "1T02:03:05")
507
 
    def test_no_days(self):
508
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
509
 
    def test_all_zero(self):
510
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
511
 
    def test_no_fractional_seconds(self):
512
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
513
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
514
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
515
 
 
516
 
 
517
 
def should_only_run_tests():
518
 
    parser = argparse.ArgumentParser(add_help=False)
519
 
    parser.add_argument("--check", action='store_true')
520
 
    args, unknown_args = parser.parse_known_args()
521
 
    run_tests = args.check
522
 
    if run_tests:
523
 
        # Remove --check argument from sys.argv
524
 
        sys.argv[1:] = unknown_args
525
 
    return run_tests
526
 
 
527
 
# Add all tests from doctest strings
528
 
def load_tests(loader, tests, none):
529
 
    import doctest
530
 
    tests.addTests(doctest.DocTestSuite())
531
 
    return tests
532
 
 
533
466
if __name__ == "__main__":
534
 
    if should_only_run_tests():
535
 
        # Call using ./tdd-python-script --check [--verbose]
536
 
        unittest.main()
537
 
    else:
538
 
        main()
 
467
    main()