/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-07-12 01:57:54 UTC
  • Revision ID: teddy@recompile.se-20150712015754-1lq7u2ejo7fdyfvi
* debian/mandos.prerm: Don't run init script, use only invoke-rc.d.

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