/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: 2015-08-10 21:23:46 UTC
  • mfrom: (237.4.57 release)
  • Revision ID: teddy@recompile.se-20150810212346-wvobzmqnnit9q8px
Merge from release branch.

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-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-2015 Teddy Hogeborn
 
7
# Copyright © 2008-2015 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
 
41
import doctest
44
42
 
45
43
import dbus
46
44
 
59
57
    "Interval": "Interval",
60
58
    "Host": "Host",
61
59
    "Fingerprint": "Fingerprint",
62
 
    "KeyID": "Key ID",
63
60
    "CheckerRunning": "Check Is Running",
64
61
    "LastEnabled": "Last Enabled",
65
62
    "ApprovalPending": "Approval Is Pending",
67
64
    "ApprovalDelay": "Approval Delay",
68
65
    "ApprovalDuration": "Approval Duration",
69
66
    "Checker": "Checker",
70
 
    "ExtendedTimeout": "Extended Timeout",
71
 
    "Expires": "Expires",
72
 
    "LastCheckerStatus": "Last Checker Status",
 
67
    "ExtendedTimeout": "Extended Timeout"
73
68
}
74
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
75
70
domain = "se.recompile"
77
72
server_path = "/"
78
73
server_interface = domain + ".Mandos"
79
74
client_interface = domain + ".Mandos.Client"
80
 
version = "1.8.3"
 
75
version = "1.7.0"
81
76
 
82
77
 
83
78
try:
85
80
except AttributeError:
86
81
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
87
82
 
88
 
 
89
83
def milliseconds_to_string(ms):
90
84
    td = datetime.timedelta(0, 0, 0, ms)
91
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
92
 
            .format(days="{}T".format(td.days) if td.days else "",
93
 
                    hours=td.seconds // 3600,
94
 
                    minutes=(td.seconds % 3600) // 60,
95
 
                    seconds=td.seconds % 60))
 
85
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
86
        days = "{}T".format(td.days) if td.days else "",
 
87
        hours = td.seconds // 3600,
 
88
        minutes = (td.seconds % 3600) // 60,
 
89
        seconds = td.seconds % 60))
96
90
 
97
91
 
98
92
def rfc3339_duration_to_delta(duration):
99
93
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
100
 
 
 
94
    
101
95
    >>> rfc3339_duration_to_delta("P7D")
102
96
    datetime.timedelta(7)
103
97
    >>> rfc3339_duration_to_delta("PT60S")
113
107
    >>> rfc3339_duration_to_delta("P1DT3M20S")
114
108
    datetime.timedelta(1, 200)
115
109
    """
116
 
 
 
110
    
117
111
    # Parsing an RFC 3339 duration with regular expressions is not
118
112
    # possible - there would have to be multiple places for the same
119
113
    # values, like seconds.  The current code, while more esoteric, is
120
114
    # cleaner without depending on a parsing library.  If Python had a
121
115
    # built-in library for parsing we would use it, but we'd like to
122
116
    # avoid excessive use of external libraries.
123
 
 
 
117
    
124
118
    # New type for defining tokens, syntax, and semantics all-in-one
125
119
    Token = collections.namedtuple("Token", (
126
120
        "regexp",  # To match token; if "value" is not None, must have
159
153
                           frozenset((token_year, token_month,
160
154
                                      token_day, token_time,
161
155
                                      token_week)))
162
 
    # Define starting values:
163
 
    # Value so far
164
 
    value = datetime.timedelta()
 
156
    # Define starting values
 
157
    value = datetime.timedelta() # Value so far
165
158
    found_token = None
166
 
    # Following valid tokens
167
 
    followers = frozenset((token_duration, ))
168
 
    # String left to parse
169
 
    s = duration
 
159
    followers = frozenset((token_duration, )) # Following valid tokens
 
160
    s = duration                # String left to parse
170
161
    # Loop until end token is found
171
162
    while found_token is not token_end:
172
163
        # Search for any currently valid tokens
196
187
 
197
188
def string_to_delta(interval):
198
189
    """Parse a string and return a datetime.timedelta
199
 
 
 
190
    
200
191
    >>> string_to_delta('7d')
201
192
    datetime.timedelta(7)
202
193
    >>> string_to_delta('60s')
210
201
    >>> string_to_delta('5m 30s')
211
202
    datetime.timedelta(0, 330)
212
203
    """
213
 
 
 
204
    
214
205
    try:
215
206
        return rfc3339_duration_to_delta(interval)
216
207
    except ValueError:
217
208
        pass
218
 
 
 
209
    
219
210
    value = datetime.timedelta(0)
220
211
    regexp = re.compile(r"(\d+)([dsmhw]?)")
221
 
 
 
212
    
222
213
    for num, suffix in regexp.findall(interval):
223
214
        if suffix == "d":
224
215
            value += datetime.timedelta(int(num))
243
234
                       "ApprovalDuration", "ExtendedTimeout"):
244
235
            return milliseconds_to_string(value)
245
236
        return str(value)
246
 
 
 
237
    
247
238
    # Create format string to print table rows
248
239
    format_string = " ".join("{{{key}:{width}}}".format(
249
 
        width=max(len(tablewords[key]),
250
 
                  max(len(valuetostring(client[key], key))
251
 
                      for client in clients)),
252
 
        key=key)
 
240
        width = max(len(tablewords[key]),
 
241
                    max(len(valuetostring(client[key], key))
 
242
                        for client in clients)),
 
243
        key = key)
253
244
                             for key in keywords)
254
245
    # Print header line
255
246
    print(format_string.format(**tablewords))
256
247
    for client in clients:
257
 
        print(format_string
258
 
              .format(**{key: valuetostring(client[key], key)
259
 
                         for key in keywords}))
 
248
        print(format_string.format(**{
 
249
            key: valuetostring(client[key], key)
 
250
            for key in keywords }))
260
251
 
261
252
 
262
253
def has_actions(options):
283
274
def main():
284
275
    parser = argparse.ArgumentParser()
285
276
    parser.add_argument("--version", action="version",
286
 
                        version="%(prog)s {}".format(version),
 
277
                        version = "%(prog)s {}".format(version),
287
278
                        help="show version number and exit")
288
279
    parser.add_argument("-a", "--all", action="store_true",
289
280
                        help="Select all clients")
290
281
    parser.add_argument("-v", "--verbose", action="store_true",
291
282
                        help="Print all fields")
292
 
    parser.add_argument("-j", "--dump-json", action="store_true",
293
 
                        help="Dump client data in JSON format")
294
283
    parser.add_argument("-e", "--enable", action="store_true",
295
284
                        help="Enable client")
296
285
    parser.add_argument("-d", "--disable", action="store_true",
335
324
                        help="Run self-test")
336
325
    parser.add_argument("client", nargs="*", help="Client name")
337
326
    options = parser.parse_args()
338
 
 
 
327
    
339
328
    if has_actions(options) and not (options.client or options.all):
340
329
        parser.error("Options require clients names or --all.")
341
330
    if options.verbose and has_actions(options):
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.")
 
331
        parser.error("--verbose can only be used alone or with"
 
332
                     " --all.")
346
333
    if options.all and not has_actions(options):
347
334
        parser.error("--all requires an action.")
348
335
 
 
336
    if options.check:
 
337
        fail_count, test_count = doctest.testmod()
 
338
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
339
    
349
340
    try:
350
341
        bus = dbus.SystemBus()
351
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
352
343
    except dbus.exceptions.DBusException:
353
344
        print("Could not connect to Mandos server", file=sys.stderr)
354
345
        sys.exit(1)
355
 
 
 
346
    
356
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
357
 
                                 dbus_interface=server_interface)
 
348
                                 dbus_interface = server_interface)
358
349
    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
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
351
    
 
352
    #block stderr since dbus library prints to stderr
362
353
    null = os.open(os.path.devnull, os.O_RDWR)
363
354
    stderrcopy = os.dup(sys.stderr.fileno())
364
355
    os.dup2(null, sys.stderr.fileno())
365
356
    os.close(null)
366
357
    try:
367
358
        try:
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}
 
359
            mandos_clients = { path: ifs_and_props[client_interface]
 
360
                               for path, ifs_and_props in
 
361
                               mandos_serv_object_manager
 
362
                               .GetManagedObjects().items()
 
363
                               if client_interface in ifs_and_props }
373
364
        finally:
374
 
            # restore stderr
 
365
            #restore stderr
375
366
            os.dup2(stderrcopy, sys.stderr.fileno())
376
367
            os.close(stderrcopy)
377
368
    except dbus.exceptions.DBusException as e:
378
 
        print("Access denied: "
379
 
              "Accessing mandos server through D-Bus: {}".format(e),
380
 
              file=sys.stderr)
 
369
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
370
              .format(e), file=sys.stderr)
381
371
        sys.exit(1)
382
 
 
 
372
    
383
373
    # Compile dict of (clients: properties) to process
384
 
    clients = {}
385
 
 
 
374
    clients={}
 
375
    
386
376
    if options.all or not options.client:
387
 
        clients = {bus.get_object(busname, path): properties
388
 
                   for path, properties in mandos_clients.items()}
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
389
379
    else:
390
380
        for name in options.client:
391
381
            for path, client in mandos_clients.items():
397
387
                print("Client not found on server: {!r}"
398
388
                      .format(name), file=sys.stderr)
399
389
                sys.exit(1)
400
 
 
 
390
    
401
391
    if not has_actions(options) and clients:
402
 
        if options.verbose or options.dump_json:
 
392
        if options.verbose:
403
393
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
404
 
                        "Created", "Interval", "Host", "KeyID",
405
 
                        "Fingerprint", "CheckerRunning",
406
 
                        "LastEnabled", "ApprovalPending",
407
 
                        "ApprovedByDefault", "LastApprovalRequest",
408
 
                        "ApprovalDelay", "ApprovalDuration",
409
 
                        "Checker", "ExtendedTimeout", "Expires",
410
 
                        "LastCheckerStatus")
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
 
397
                        "LastApprovalRequest", "ApprovalDelay",
 
398
                        "ApprovalDuration", "Checker",
 
399
                        "ExtendedTimeout")
411
400
        else:
412
401
            keywords = defaultkeywords
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)
 
402
        
 
403
        print_clients(clients.values(), keywords)
427
404
    else:
428
405
        # Process each client in the list by all selected options
429
406
        for client in clients:
430
 
 
 
407
            
431
408
            def set_client_prop(prop, value):
432
409
                """Set a Client D-Bus property"""
433
410
                client.Set(client_interface, prop, value,
434
411
                           dbus_interface=dbus.PROPERTIES_IFACE)
435
 
 
 
412
            
436
413
            def set_client_prop_ms(prop, value):
437
414
                """Set a Client D-Bus property, converted
438
415
                from a string to milliseconds."""
439
416
                set_client_prop(prop,
440
417
                                string_to_delta(value).total_seconds()
441
418
                                * 1000)
442
 
 
 
419
            
443
420
            if options.remove:
444
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
445
422
            if options.enable:
453
430
            if options.stop_checker:
454
431
                set_client_prop("CheckerRunning", dbus.Boolean(False))
455
432
            if options.is_enabled:
456
 
                if client.Get(client_interface, "Enabled",
457
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
458
 
                    sys.exit(0)
459
 
                else:
460
 
                    sys.exit(1)
 
433
                sys.exit(0 if client.Get(client_interface,
 
434
                                         "Enabled",
 
435
                                         dbus_interface=
 
436
                                         dbus.PROPERTIES_IFACE)
 
437
                         else 1)
461
438
            if options.checker is not None:
462
439
                set_client_prop("Checker", options.checker)
463
440
            if options.host is not None:
489
466
                client.Approve(dbus.Boolean(False),
490
467
                               dbus_interface=client_interface)
491
468
 
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
469
 
509
470
if __name__ == "__main__":
510
 
    if should_only_run_tests():
511
 
        # Call using ./tdd-python-script --check [--verbose]
512
 
        unittest.main()
513
 
    else:
514
 
        main()
 
471
    main()