/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-06-02 17:43:53 UTC
  • Revision ID: teddy@recompile.se-20150602174353-tvqw31mgxfapl985
mandos.service ([Service]/KillMode): Changed to "mixed".

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")
125
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
126
103
    datetime.timedelta(1, 200)
127
104
    """
128
 
 
 
105
    
129
106
    # Parsing an RFC 3339 duration with regular expressions is not
130
107
    # possible - there would have to be multiple places for the same
131
108
    # values, like seconds.  The current code, while more esoteric, is
132
109
    # cleaner without depending on a parsing library.  If Python had a
133
110
    # built-in library for parsing we would use it, but we'd like to
134
111
    # avoid excessive use of external libraries.
135
 
 
 
112
    
136
113
    # New type for defining tokens, syntax, and semantics all-in-one
137
114
    Token = collections.namedtuple("Token", (
138
115
        "regexp",  # To match token; if "value" is not None, must have
171
148
                           frozenset((token_year, token_month,
172
149
                                      token_day, token_time,
173
150
                                      token_week)))
174
 
    # Define starting values:
175
 
    # Value so far
176
 
    value = datetime.timedelta()
 
151
    # Define starting values
 
152
    value = datetime.timedelta() # Value so far
177
153
    found_token = None
178
 
    # Following valid tokens
179
 
    followers = frozenset((token_duration, ))
180
 
    # String left to parse
181
 
    s = duration
 
154
    followers = frozenset((token_duration, )) # Following valid tokens
 
155
    s = duration                # String left to parse
182
156
    # Loop until end token is found
183
157
    while found_token is not token_end:
184
158
        # Search for any currently valid tokens
208
182
 
209
183
def string_to_delta(interval):
210
184
    """Parse a string and return a datetime.timedelta
211
 
 
 
185
    
212
186
    >>> string_to_delta('7d')
213
187
    datetime.timedelta(7)
214
188
    >>> string_to_delta('60s')
222
196
    >>> string_to_delta('5m 30s')
223
197
    datetime.timedelta(0, 330)
224
198
    """
225
 
 
 
199
    
226
200
    try:
227
201
        return rfc3339_duration_to_delta(interval)
228
202
    except ValueError:
229
203
        pass
230
 
 
 
204
    
231
205
    value = datetime.timedelta(0)
232
206
    regexp = re.compile(r"(\d+)([dsmhw]?)")
233
 
 
 
207
    
234
208
    for num, suffix in regexp.findall(interval):
235
209
        if suffix == "d":
236
210
            value += datetime.timedelta(int(num))
249
223
 
250
224
def print_clients(clients, keywords):
251
225
    def valuetostring(value, keyword):
252
 
        if isinstance(value, dbus.Boolean):
 
226
        if type(value) is dbus.Boolean:
253
227
            return "Yes" if value else "No"
254
228
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
255
229
                       "ApprovalDuration", "ExtendedTimeout"):
256
230
            return milliseconds_to_string(value)
257
231
        return str(value)
258
 
 
 
232
    
259
233
    # Create format string to print table rows
260
234
    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)
 
235
        width = max(len(tablewords[key]),
 
236
                    max(len(valuetostring(client[key], key))
 
237
                        for client in clients)),
 
238
        key = key)
265
239
                             for key in keywords)
266
240
    # Print header line
267
241
    print(format_string.format(**tablewords))
268
242
    for client in clients:
269
 
        print(format_string
270
 
              .format(**{key: valuetostring(client[key], key)
271
 
                         for key in keywords}))
 
243
        print(format_string.format(**{
 
244
            key: valuetostring(client[key], key)
 
245
            for key in keywords }))
272
246
 
273
247
 
274
248
def has_actions(options):
295
269
def main():
296
270
    parser = argparse.ArgumentParser()
297
271
    parser.add_argument("--version", action="version",
298
 
                        version="%(prog)s {}".format(version),
 
272
                        version = "%(prog)s {}".format(version),
299
273
                        help="show version number and exit")
300
274
    parser.add_argument("-a", "--all", action="store_true",
301
275
                        help="Select all clients")
302
276
    parser.add_argument("-v", "--verbose", action="store_true",
303
277
                        help="Print all fields")
304
 
    parser.add_argument("-j", "--dump-json", action="store_true",
305
 
                        help="Dump client data in JSON format")
306
278
    parser.add_argument("-e", "--enable", action="store_true",
307
279
                        help="Enable client")
308
280
    parser.add_argument("-d", "--disable", action="store_true",
347
319
                        help="Run self-test")
348
320
    parser.add_argument("client", nargs="*", help="Client name")
349
321
    options = parser.parse_args()
350
 
 
 
322
    
351
323
    if has_actions(options) and not (options.client or options.all):
352
324
        parser.error("Options require clients names or --all.")
353
325
    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.")
 
326
        parser.error("--verbose can only be used alone or with"
 
327
                     " --all.")
358
328
    if options.all and not has_actions(options):
359
329
        parser.error("--all requires an action.")
360
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
    
361
335
    try:
362
336
        bus = dbus.SystemBus()
363
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
364
338
    except dbus.exceptions.DBusException:
365
 
        log.critical("Could not connect to Mandos server")
 
339
        print("Could not connect to Mandos server", file=sys.stderr)
366
340
        sys.exit(1)
367
 
 
 
341
    
368
342
    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
 
343
                                 dbus_interface = server_interface)
 
344
    
 
345
    #block stderr since dbus library prints to stderr
374
346
    null = os.open(os.path.devnull, os.O_RDWR)
375
347
    stderrcopy = os.dup(sys.stderr.fileno())
376
348
    os.dup2(null, sys.stderr.fileno())
377
349
    os.close(null)
378
350
    try:
379
351
        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}
 
352
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
385
353
        finally:
386
 
            # restore stderr
 
354
            #restore stderr
387
355
            os.dup2(stderrcopy, sys.stderr.fileno())
388
356
            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)
 
357
    except dbus.exceptions.DBusException:
 
358
        print("Access denied: Accessing mandos server through dbus.",
 
359
              file=sys.stderr)
392
360
        sys.exit(1)
393
 
 
 
361
    
394
362
    # Compile dict of (clients: properties) to process
395
 
    clients = {}
396
 
 
 
363
    clients={}
 
364
    
397
365
    if options.all or not options.client:
398
 
        clients = {bus.get_object(busname, path): properties
399
 
                   for path, properties in mandos_clients.items()}
 
366
        clients = { bus.get_object(busname, path): properties
 
367
                    for path, properties in mandos_clients.items() }
400
368
    else:
401
369
        for name in options.client:
402
370
            for path, client in mandos_clients.items():
405
373
                    clients[client_objc] = client
406
374
                    break
407
375
            else:
408
 
                log.critical("Client not found on server: %r", name)
 
376
                print("Client not found on server: {!r}"
 
377
                      .format(name), file=sys.stderr)
409
378
                sys.exit(1)
410
 
 
 
379
    
411
380
    if not has_actions(options) and clients:
412
 
        if options.verbose or options.dump_json:
 
381
        if options.verbose:
413
382
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
414
 
                        "Created", "Interval", "Host", "KeyID",
415
 
                        "Fingerprint", "CheckerRunning",
416
 
                        "LastEnabled", "ApprovalPending",
417
 
                        "ApprovedByDefault", "LastApprovalRequest",
418
 
                        "ApprovalDelay", "ApprovalDuration",
419
 
                        "Checker", "ExtendedTimeout", "Expires",
420
 
                        "LastCheckerStatus")
 
383
                        "Created", "Interval", "Host", "Fingerprint",
 
384
                        "CheckerRunning", "LastEnabled",
 
385
                        "ApprovalPending", "ApprovedByDefault",
 
386
                        "LastApprovalRequest", "ApprovalDelay",
 
387
                        "ApprovalDuration", "Checker",
 
388
                        "ExtendedTimeout")
421
389
        else:
422
390
            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)
 
391
        
 
392
        print_clients(clients.values(), keywords)
437
393
    else:
438
394
        # Process each client in the list by all selected options
439
395
        for client in clients:
440
 
 
 
396
            
441
397
            def set_client_prop(prop, value):
442
398
                """Set a Client D-Bus property"""
443
399
                client.Set(client_interface, prop, value,
444
400
                           dbus_interface=dbus.PROPERTIES_IFACE)
445
 
 
 
401
            
446
402
            def set_client_prop_ms(prop, value):
447
403
                """Set a Client D-Bus property, converted
448
404
                from a string to milliseconds."""
449
405
                set_client_prop(prop,
450
406
                                string_to_delta(value).total_seconds()
451
407
                                * 1000)
452
 
 
 
408
            
453
409
            if options.remove:
454
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
455
411
            if options.enable:
463
419
            if options.stop_checker:
464
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
465
421
            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)
 
422
                sys.exit(0 if client.Get(client_interface,
 
423
                                         "Enabled",
 
424
                                         dbus_interface=
 
425
                                         dbus.PROPERTIES_IFACE)
 
426
                         else 1)
471
427
            if options.checker is not None:
472
428
                set_client_prop("Checker", options.checker)
473
429
            if options.host is not None:
499
455
                client.Approve(dbus.Boolean(False),
500
456
                               dbus_interface=client_interface)
501
457
 
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
458
 
533
459
if __name__ == "__main__":
534
 
    if should_only_run_tests():
535
 
        # Call using ./tdd-python-script --check [--verbose]
536
 
        unittest.main()
537
 
    else:
538
 
        main()
 
460
    main()