/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
 
# -*- 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-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
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
45
if sys.version_info.major == 2:
60
46
    str = unicode
61
47
 
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",
 
67
    "ExtendedTimeout": "Extended Timeout"
85
68
}
86
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
70
domain = "se.recompile"
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"
 
75
version = "1.6.9"
99
76
 
100
77
 
101
78
def milliseconds_to_string(ms):
102
79
    td = datetime.timedelta(0, 0, 0, ms)
103
 
    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))
 
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))
108
85
 
109
86
 
110
87
def rfc3339_duration_to_delta(duration):
111
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
89
    
113
90
    >>> rfc3339_duration_to_delta("P7D")
114
91
    datetime.timedelta(7)
115
92
    >>> rfc3339_duration_to_delta("PT60S")
116
93
    datetime.timedelta(0, 60)
117
94
    >>> rfc3339_duration_to_delta("PT60M")
118
95
    datetime.timedelta(0, 3600)
119
 
    >>> rfc3339_duration_to_delta("P60M")
120
 
    datetime.timedelta(1680)
121
96
    >>> rfc3339_duration_to_delta("PT24H")
122
97
    datetime.timedelta(1)
123
98
    >>> rfc3339_duration_to_delta("P1W")
126
101
    datetime.timedelta(0, 330)
127
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
128
103
    datetime.timedelta(1, 200)
129
 
    >>> # Can not be empty:
130
 
    >>> rfc3339_duration_to_delta("")
131
 
    Traceback (most recent call last):
132
 
    ...
133
 
    ValueError: Invalid RFC 3339 duration: u''
134
 
    >>> # Must start with "P":
135
 
    >>> rfc3339_duration_to_delta("1D")
136
 
    Traceback (most recent call last):
137
 
    ...
138
 
    ValueError: Invalid RFC 3339 duration: u'1D'
139
 
    >>> # Must use correct order
140
 
    >>> rfc3339_duration_to_delta("PT1S2M")
141
 
    Traceback (most recent call last):
142
 
    ...
143
 
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
144
 
    >>> # Time needs time marker
145
 
    >>> rfc3339_duration_to_delta("P1H2S")
146
 
    Traceback (most recent call last):
147
 
    ...
148
 
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
149
 
    >>> # Weeks can not be combined with anything else
150
 
    >>> rfc3339_duration_to_delta("P1D2W")
151
 
    Traceback (most recent call last):
152
 
    ...
153
 
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
154
 
    >>> rfc3339_duration_to_delta("P2W2H")
155
 
    Traceback (most recent call last):
156
 
    ...
157
 
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
158
104
    """
159
 
 
 
105
    
160
106
    # Parsing an RFC 3339 duration with regular expressions is not
161
107
    # possible - there would have to be multiple places for the same
162
108
    # values, like seconds.  The current code, while more esoteric, is
163
109
    # cleaner without depending on a parsing library.  If Python had a
164
110
    # built-in library for parsing we would use it, but we'd like to
165
111
    # avoid excessive use of external libraries.
166
 
 
 
112
    
167
113
    # New type for defining tokens, syntax, and semantics all-in-one
168
114
    Token = collections.namedtuple("Token", (
169
115
        "regexp",  # To match token; if "value" is not None, must have
202
148
                           frozenset((token_year, token_month,
203
149
                                      token_day, token_time,
204
150
                                      token_week)))
205
 
    # Define starting values:
206
 
    # Value so far
207
 
    value = datetime.timedelta()
 
151
    # Define starting values
 
152
    value = datetime.timedelta() # Value so far
208
153
    found_token = None
209
 
    # Following valid tokens
210
 
    followers = frozenset((token_duration, ))
211
 
    # String left to parse
212
 
    s = duration
 
154
    followers = frozenset((token_duration, )) # Following valid tokens
 
155
    s = duration                # String left to parse
213
156
    # Loop until end token is found
214
157
    while found_token is not token_end:
215
158
        # Search for any currently valid tokens
239
182
 
240
183
def string_to_delta(interval):
241
184
    """Parse a string and return a datetime.timedelta
242
 
 
 
185
    
243
186
    >>> string_to_delta('7d')
244
187
    datetime.timedelta(7)
245
188
    >>> string_to_delta('60s')
253
196
    >>> string_to_delta('5m 30s')
254
197
    datetime.timedelta(0, 330)
255
198
    """
256
 
 
 
199
    
257
200
    try:
258
201
        return rfc3339_duration_to_delta(interval)
259
202
    except ValueError:
260
203
        pass
261
 
 
 
204
    
262
205
    value = datetime.timedelta(0)
263
206
    regexp = re.compile(r"(\d+)([dsmhw]?)")
264
 
 
 
207
    
265
208
    for num, suffix in regexp.findall(interval):
266
209
        if suffix == "d":
267
210
            value += datetime.timedelta(int(num))
280
223
 
281
224
def print_clients(clients, keywords):
282
225
    def valuetostring(value, keyword):
283
 
        if isinstance(value, dbus.Boolean):
 
226
        if type(value) is dbus.Boolean:
284
227
            return "Yes" if value else "No"
285
228
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
286
229
                       "ApprovalDuration", "ExtendedTimeout"):
287
230
            return milliseconds_to_string(value)
288
231
        return str(value)
289
 
 
 
232
    
290
233
    # Create format string to print table rows
291
234
    format_string = " ".join("{{{key}:{width}}}".format(
292
 
        width=max(len(tablewords[key]),
293
 
                  max(len(valuetostring(client[key], key))
294
 
                      for client in clients)),
295
 
        key=key)
 
235
        width = max(len(tablewords[key]),
 
236
                    max(len(valuetostring(client[key], key))
 
237
                        for client in clients)),
 
238
        key = key)
296
239
                             for key in keywords)
297
240
    # Print header line
298
241
    print(format_string.format(**tablewords))
299
242
    for client in clients:
300
 
        print(format_string
301
 
              .format(**{key: valuetostring(client[key], key)
302
 
                         for key in keywords}))
 
243
        print(format_string.format(**{
 
244
            key: valuetostring(client[key], key)
 
245
            for key in keywords }))
303
246
 
304
247
 
305
248
def has_actions(options):
326
269
def main():
327
270
    parser = argparse.ArgumentParser()
328
271
    parser.add_argument("--version", action="version",
329
 
                        version="%(prog)s {}".format(version),
 
272
                        version = "%(prog)s {}".format(version),
330
273
                        help="show version number and exit")
331
274
    parser.add_argument("-a", "--all", action="store_true",
332
275
                        help="Select all clients")
333
276
    parser.add_argument("-v", "--verbose", action="store_true",
334
277
                        help="Print all fields")
335
 
    parser.add_argument("-j", "--dump-json", action="store_true",
336
 
                        help="Dump client data in JSON format")
337
278
    parser.add_argument("-e", "--enable", action="store_true",
338
279
                        help="Enable client")
339
280
    parser.add_argument("-d", "--disable", action="store_true",
378
319
                        help="Run self-test")
379
320
    parser.add_argument("client", nargs="*", help="Client name")
380
321
    options = parser.parse_args()
381
 
 
 
322
    
382
323
    if has_actions(options) and not (options.client or options.all):
383
324
        parser.error("Options require clients names or --all.")
384
325
    if options.verbose and has_actions(options):
385
 
        parser.error("--verbose can only be used alone.")
386
 
    if options.dump_json and (options.verbose
387
 
                              or has_actions(options)):
388
 
        parser.error("--dump-json can only be used alone.")
 
326
        parser.error("--verbose can only be used alone or with"
 
327
                     " --all.")
389
328
    if options.all and not has_actions(options):
390
329
        parser.error("--all requires an action.")
391
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
    
392
335
    try:
393
336
        bus = dbus.SystemBus()
394
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
395
338
    except dbus.exceptions.DBusException:
396
 
        log.critical("Could not connect to Mandos server")
 
339
        print("Could not connect to Mandos server", file=sys.stderr)
397
340
        sys.exit(1)
398
 
 
 
341
    
399
342
    mandos_serv = dbus.Interface(mandos_dbus_objc,
400
 
                                 dbus_interface=server_interface)
401
 
    mandos_serv_object_manager = dbus.Interface(
402
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
403
 
 
404
 
    # block stderr since dbus library prints to stderr
 
343
                                 dbus_interface = server_interface)
 
344
    
 
345
    #block stderr since dbus library prints to stderr
405
346
    null = os.open(os.path.devnull, os.O_RDWR)
406
347
    stderrcopy = os.dup(sys.stderr.fileno())
407
348
    os.dup2(null, sys.stderr.fileno())
408
349
    os.close(null)
409
350
    try:
410
351
        try:
411
 
            mandos_clients = {path: ifs_and_props[client_interface]
412
 
                              for path, ifs_and_props in
413
 
                              mandos_serv_object_manager
414
 
                              .GetManagedObjects().items()
415
 
                              if client_interface in ifs_and_props}
 
352
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
416
353
        finally:
417
 
            # restore stderr
 
354
            #restore stderr
418
355
            os.dup2(stderrcopy, sys.stderr.fileno())
419
356
            os.close(stderrcopy)
420
 
    except dbus.exceptions.DBusException as e:
421
 
        log.critical("Failed to access Mandos server through D-Bus:"
422
 
                     "\n%s", e)
 
357
    except dbus.exceptions.DBusException:
 
358
        print("Access denied: Accessing mandos server through dbus.",
 
359
              file=sys.stderr)
423
360
        sys.exit(1)
424
 
 
 
361
    
425
362
    # Compile dict of (clients: properties) to process
426
 
    clients = {}
427
 
 
 
363
    clients={}
 
364
    
428
365
    if options.all or not options.client:
429
 
        clients = {bus.get_object(busname, path): properties
430
 
                   for path, properties in mandos_clients.items()}
 
366
        clients = { bus.get_object(busname, path): properties
 
367
                    for path, properties in mandos_clients.items() }
431
368
    else:
432
369
        for name in options.client:
433
370
            for path, client in mandos_clients.items():
436
373
                    clients[client_objc] = client
437
374
                    break
438
375
            else:
439
 
                log.critical("Client not found on server: %r", name)
 
376
                print("Client not found on server: {!r}"
 
377
                      .format(name), file=sys.stderr)
440
378
                sys.exit(1)
441
 
 
 
379
    
442
380
    if not has_actions(options) and clients:
443
 
        if options.verbose or options.dump_json:
 
381
        if options.verbose:
444
382
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
445
 
                        "Created", "Interval", "Host", "KeyID",
446
 
                        "Fingerprint", "CheckerRunning",
447
 
                        "LastEnabled", "ApprovalPending",
448
 
                        "ApprovedByDefault", "LastApprovalRequest",
449
 
                        "ApprovalDelay", "ApprovalDuration",
450
 
                        "Checker", "ExtendedTimeout", "Expires",
451
 
                        "LastCheckerStatus")
 
383
                        "Created", "Interval", "Host", "Fingerprint",
 
384
                        "CheckerRunning", "LastEnabled",
 
385
                        "ApprovalPending", "ApprovedByDefault",
 
386
                        "LastApprovalRequest", "ApprovalDelay",
 
387
                        "ApprovalDuration", "Checker",
 
388
                        "ExtendedTimeout")
452
389
        else:
453
390
            keywords = defaultkeywords
454
 
 
455
 
        if options.dump_json:
456
 
            json.dump({client["Name"]: {key:
457
 
                                        bool(client[key])
458
 
                                        if isinstance(client[key],
459
 
                                                      dbus.Boolean)
460
 
                                        else client[key]
461
 
                                        for key in keywords}
462
 
                       for client in clients.values()},
463
 
                      fp=sys.stdout, indent=4,
464
 
                      separators=(',', ': '))
465
 
            print()
466
 
        else:
467
 
            print_clients(clients.values(), keywords)
 
391
        
 
392
        print_clients(clients.values(), keywords)
468
393
    else:
469
394
        # Process each client in the list by all selected options
470
395
        for client in clients:
471
 
 
 
396
            
472
397
            def set_client_prop(prop, value):
473
398
                """Set a Client D-Bus property"""
474
399
                client.Set(client_interface, prop, value,
475
400
                           dbus_interface=dbus.PROPERTIES_IFACE)
476
 
 
 
401
            
477
402
            def set_client_prop_ms(prop, value):
478
403
                """Set a Client D-Bus property, converted
479
404
                from a string to milliseconds."""
480
405
                set_client_prop(prop,
481
406
                                string_to_delta(value).total_seconds()
482
407
                                * 1000)
483
 
 
 
408
            
484
409
            if options.remove:
485
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
486
411
            if options.enable:
494
419
            if options.stop_checker:
495
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
496
421
            if options.is_enabled:
497
 
                if client.Get(client_interface, "Enabled",
498
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
499
 
                    sys.exit(0)
500
 
                else:
501
 
                    sys.exit(1)
 
422
                sys.exit(0 if client.Get(client_interface,
 
423
                                         "Enabled",
 
424
                                         dbus_interface=
 
425
                                         dbus.PROPERTIES_IFACE)
 
426
                         else 1)
502
427
            if options.checker is not None:
503
428
                set_client_prop("Checker", options.checker)
504
429
            if options.host is not None:
530
455
                client.Approve(dbus.Boolean(False),
531
456
                               dbus_interface=client_interface)
532
457
 
533
 
 
534
 
class Test_milliseconds_to_string(unittest.TestCase):
535
 
    def test_all(self):
536
 
        self.assertEqual(milliseconds_to_string(93785000),
537
 
                         "1T02:03:05")
538
 
    def test_no_days(self):
539
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
540
 
    def test_all_zero(self):
541
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
542
 
    def test_no_fractional_seconds(self):
543
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
544
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
545
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
546
 
 
547
 
 
548
 
def should_only_run_tests():
549
 
    parser = argparse.ArgumentParser(add_help=False)
550
 
    parser.add_argument("--check", action='store_true')
551
 
    args, unknown_args = parser.parse_known_args()
552
 
    run_tests = args.check
553
 
    if run_tests:
554
 
        # Remove --check argument from sys.argv
555
 
        sys.argv[1:] = unknown_args
556
 
    return run_tests
557
 
 
558
 
# Add all tests from doctest strings
559
 
def load_tests(loader, tests, none):
560
 
    import doctest
561
 
    tests.addTests(doctest.DocTestSuite())
562
 
    return tests
563
458
 
564
459
if __name__ == "__main__":
565
 
    if should_only_run_tests():
566
 
        # Call using ./tdd-python-script --check [--verbose]
567
 
        unittest.main()
568
 
    else:
569
 
        main()
 
460
    main()