/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2015-07-12 01:57:54 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • 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
 
log = logging.getLogger(sys.argv[0])
49
 
logging.basicConfig(level="INFO", # Show info level messages
50
 
                    format="%(message)s") # Show basic log messages
51
 
 
52
45
if sys.version_info.major == 2:
53
46
    str = unicode
54
47
 
64
57
    "Interval": "Interval",
65
58
    "Host": "Host",
66
59
    "Fingerprint": "Fingerprint",
67
 
    "KeyID": "Key ID",
68
60
    "CheckerRunning": "Check Is Running",
69
61
    "LastEnabled": "Last Enabled",
70
62
    "ApprovalPending": "Approval Is Pending",
72
64
    "ApprovalDelay": "Approval Delay",
73
65
    "ApprovalDuration": "Approval Duration",
74
66
    "Checker": "Checker",
75
 
    "ExtendedTimeout": "Extended Timeout",
76
 
    "Expires": "Expires",
77
 
    "LastCheckerStatus": "Last Checker Status",
 
67
    "ExtendedTimeout": "Extended Timeout"
78
68
}
79
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
80
70
domain = "se.recompile"
82
72
server_path = "/"
83
73
server_interface = domain + ".Mandos"
84
74
client_interface = domain + ".Mandos.Client"
85
 
version = "1.8.3"
86
 
 
87
 
 
88
 
try:
89
 
    dbus.OBJECT_MANAGER_IFACE
90
 
except AttributeError:
91
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
75
version = "1.6.9"
92
76
 
93
77
 
94
78
def milliseconds_to_string(ms):
95
79
    td = datetime.timedelta(0, 0, 0, ms)
96
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
97
 
            .format(days="{}T".format(td.days) if td.days else "",
98
 
                    hours=td.seconds // 3600,
99
 
                    minutes=(td.seconds % 3600) // 60,
100
 
                    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))
101
85
 
102
86
 
103
87
def rfc3339_duration_to_delta(duration):
104
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
105
 
 
 
89
    
106
90
    >>> rfc3339_duration_to_delta("P7D")
107
91
    datetime.timedelta(7)
108
92
    >>> rfc3339_duration_to_delta("PT60S")
118
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
119
103
    datetime.timedelta(1, 200)
120
104
    """
121
 
 
 
105
    
122
106
    # Parsing an RFC 3339 duration with regular expressions is not
123
107
    # possible - there would have to be multiple places for the same
124
108
    # values, like seconds.  The current code, while more esoteric, is
125
109
    # cleaner without depending on a parsing library.  If Python had a
126
110
    # built-in library for parsing we would use it, but we'd like to
127
111
    # avoid excessive use of external libraries.
128
 
 
 
112
    
129
113
    # New type for defining tokens, syntax, and semantics all-in-one
130
114
    Token = collections.namedtuple("Token", (
131
115
        "regexp",  # To match token; if "value" is not None, must have
164
148
                           frozenset((token_year, token_month,
165
149
                                      token_day, token_time,
166
150
                                      token_week)))
167
 
    # Define starting values:
168
 
    # Value so far
169
 
    value = datetime.timedelta()
 
151
    # Define starting values
 
152
    value = datetime.timedelta() # Value so far
170
153
    found_token = None
171
 
    # Following valid tokens
172
 
    followers = frozenset((token_duration, ))
173
 
    # String left to parse
174
 
    s = duration
 
154
    followers = frozenset((token_duration, )) # Following valid tokens
 
155
    s = duration                # String left to parse
175
156
    # Loop until end token is found
176
157
    while found_token is not token_end:
177
158
        # Search for any currently valid tokens
201
182
 
202
183
def string_to_delta(interval):
203
184
    """Parse a string and return a datetime.timedelta
204
 
 
 
185
    
205
186
    >>> string_to_delta('7d')
206
187
    datetime.timedelta(7)
207
188
    >>> string_to_delta('60s')
215
196
    >>> string_to_delta('5m 30s')
216
197
    datetime.timedelta(0, 330)
217
198
    """
218
 
 
 
199
    
219
200
    try:
220
201
        return rfc3339_duration_to_delta(interval)
221
202
    except ValueError:
222
203
        pass
223
 
 
 
204
    
224
205
    value = datetime.timedelta(0)
225
206
    regexp = re.compile(r"(\d+)([dsmhw]?)")
226
 
 
 
207
    
227
208
    for num, suffix in regexp.findall(interval):
228
209
        if suffix == "d":
229
210
            value += datetime.timedelta(int(num))
248
229
                       "ApprovalDuration", "ExtendedTimeout"):
249
230
            return milliseconds_to_string(value)
250
231
        return str(value)
251
 
 
 
232
    
252
233
    # Create format string to print table rows
253
234
    format_string = " ".join("{{{key}:{width}}}".format(
254
 
        width=max(len(tablewords[key]),
255
 
                  max(len(valuetostring(client[key], key))
256
 
                      for client in clients)),
257
 
        key=key)
 
235
        width = max(len(tablewords[key]),
 
236
                    max(len(valuetostring(client[key], key))
 
237
                        for client in clients)),
 
238
        key = key)
258
239
                             for key in keywords)
259
240
    # Print header line
260
241
    print(format_string.format(**tablewords))
261
242
    for client in clients:
262
 
        print(format_string
263
 
              .format(**{key: valuetostring(client[key], key)
264
 
                         for key in keywords}))
 
243
        print(format_string.format(**{
 
244
            key: valuetostring(client[key], key)
 
245
            for key in keywords }))
265
246
 
266
247
 
267
248
def has_actions(options):
288
269
def main():
289
270
    parser = argparse.ArgumentParser()
290
271
    parser.add_argument("--version", action="version",
291
 
                        version="%(prog)s {}".format(version),
 
272
                        version = "%(prog)s {}".format(version),
292
273
                        help="show version number and exit")
293
274
    parser.add_argument("-a", "--all", action="store_true",
294
275
                        help="Select all clients")
295
276
    parser.add_argument("-v", "--verbose", action="store_true",
296
277
                        help="Print all fields")
297
 
    parser.add_argument("-j", "--dump-json", action="store_true",
298
 
                        help="Dump client data in JSON format")
299
278
    parser.add_argument("-e", "--enable", action="store_true",
300
279
                        help="Enable client")
301
280
    parser.add_argument("-d", "--disable", action="store_true",
340
319
                        help="Run self-test")
341
320
    parser.add_argument("client", nargs="*", help="Client name")
342
321
    options = parser.parse_args()
343
 
 
 
322
    
344
323
    if has_actions(options) and not (options.client or options.all):
345
324
        parser.error("Options require clients names or --all.")
346
325
    if options.verbose and has_actions(options):
347
 
        parser.error("--verbose can only be used alone.")
348
 
    if options.dump_json and (options.verbose
349
 
                              or has_actions(options)):
350
 
        parser.error("--dump-json can only be used alone.")
 
326
        parser.error("--verbose can only be used alone or with"
 
327
                     " --all.")
351
328
    if options.all and not has_actions(options):
352
329
        parser.error("--all requires an action.")
353
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
    
354
335
    try:
355
336
        bus = dbus.SystemBus()
356
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
357
338
    except dbus.exceptions.DBusException:
358
 
        log.critical("Could not connect to Mandos server")
 
339
        print("Could not connect to Mandos server", file=sys.stderr)
359
340
        sys.exit(1)
360
 
 
 
341
    
361
342
    mandos_serv = dbus.Interface(mandos_dbus_objc,
362
 
                                 dbus_interface=server_interface)
363
 
    mandos_serv_object_manager = dbus.Interface(
364
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
365
 
 
366
 
    # block stderr since dbus library prints to stderr
 
343
                                 dbus_interface = server_interface)
 
344
    
 
345
    #block stderr since dbus library prints to stderr
367
346
    null = os.open(os.path.devnull, os.O_RDWR)
368
347
    stderrcopy = os.dup(sys.stderr.fileno())
369
348
    os.dup2(null, sys.stderr.fileno())
370
349
    os.close(null)
371
350
    try:
372
351
        try:
373
 
            mandos_clients = {path: ifs_and_props[client_interface]
374
 
                              for path, ifs_and_props in
375
 
                              mandos_serv_object_manager
376
 
                              .GetManagedObjects().items()
377
 
                              if client_interface in ifs_and_props}
 
352
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
378
353
        finally:
379
 
            # restore stderr
 
354
            #restore stderr
380
355
            os.dup2(stderrcopy, sys.stderr.fileno())
381
356
            os.close(stderrcopy)
382
 
    except dbus.exceptions.DBusException as e:
383
 
        log.critical("Failed to access Mandos server through D-Bus:"
384
 
                     "\n%s", e)
 
357
    except dbus.exceptions.DBusException:
 
358
        print("Access denied: Accessing mandos server through dbus.",
 
359
              file=sys.stderr)
385
360
        sys.exit(1)
386
 
 
 
361
    
387
362
    # Compile dict of (clients: properties) to process
388
 
    clients = {}
389
 
 
 
363
    clients={}
 
364
    
390
365
    if options.all or not options.client:
391
 
        clients = {bus.get_object(busname, path): properties
392
 
                   for path, properties in mandos_clients.items()}
 
366
        clients = { bus.get_object(busname, path): properties
 
367
                    for path, properties in mandos_clients.items() }
393
368
    else:
394
369
        for name in options.client:
395
370
            for path, client in mandos_clients.items():
398
373
                    clients[client_objc] = client
399
374
                    break
400
375
            else:
401
 
                log.critical("Client not found on server: %r", name)
 
376
                print("Client not found on server: {!r}"
 
377
                      .format(name), file=sys.stderr)
402
378
                sys.exit(1)
403
 
 
 
379
    
404
380
    if not has_actions(options) and clients:
405
 
        if options.verbose or options.dump_json:
 
381
        if options.verbose:
406
382
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
 
                        "Created", "Interval", "Host", "KeyID",
408
 
                        "Fingerprint", "CheckerRunning",
409
 
                        "LastEnabled", "ApprovalPending",
410
 
                        "ApprovedByDefault", "LastApprovalRequest",
411
 
                        "ApprovalDelay", "ApprovalDuration",
412
 
                        "Checker", "ExtendedTimeout", "Expires",
413
 
                        "LastCheckerStatus")
 
383
                        "Created", "Interval", "Host", "Fingerprint",
 
384
                        "CheckerRunning", "LastEnabled",
 
385
                        "ApprovalPending", "ApprovedByDefault",
 
386
                        "LastApprovalRequest", "ApprovalDelay",
 
387
                        "ApprovalDuration", "Checker",
 
388
                        "ExtendedTimeout")
414
389
        else:
415
390
            keywords = defaultkeywords
416
 
 
417
 
        if options.dump_json:
418
 
            json.dump({client["Name"]: {key:
419
 
                                        bool(client[key])
420
 
                                        if isinstance(client[key],
421
 
                                                      dbus.Boolean)
422
 
                                        else client[key]
423
 
                                        for key in keywords}
424
 
                       for client in clients.values()},
425
 
                      fp=sys.stdout, indent=4,
426
 
                      separators=(',', ': '))
427
 
            print()
428
 
        else:
429
 
            print_clients(clients.values(), keywords)
 
391
        
 
392
        print_clients(clients.values(), keywords)
430
393
    else:
431
394
        # Process each client in the list by all selected options
432
395
        for client in clients:
433
 
 
 
396
            
434
397
            def set_client_prop(prop, value):
435
398
                """Set a Client D-Bus property"""
436
399
                client.Set(client_interface, prop, value,
437
400
                           dbus_interface=dbus.PROPERTIES_IFACE)
438
 
 
 
401
            
439
402
            def set_client_prop_ms(prop, value):
440
403
                """Set a Client D-Bus property, converted
441
404
                from a string to milliseconds."""
442
405
                set_client_prop(prop,
443
406
                                string_to_delta(value).total_seconds()
444
407
                                * 1000)
445
 
 
 
408
            
446
409
            if options.remove:
447
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
448
411
            if options.enable:
456
419
            if options.stop_checker:
457
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
458
421
            if options.is_enabled:
459
 
                if client.Get(client_interface, "Enabled",
460
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
461
 
                    sys.exit(0)
462
 
                else:
463
 
                    sys.exit(1)
 
422
                sys.exit(0 if client.Get(client_interface,
 
423
                                         "Enabled",
 
424
                                         dbus_interface=
 
425
                                         dbus.PROPERTIES_IFACE)
 
426
                         else 1)
464
427
            if options.checker is not None:
465
428
                set_client_prop("Checker", options.checker)
466
429
            if options.host is not None:
492
455
                client.Approve(dbus.Boolean(False),
493
456
                               dbus_interface=client_interface)
494
457
 
495
 
 
496
 
class Test_milliseconds_to_string(unittest.TestCase):
497
 
    def test_all(self):
498
 
        self.assertEqual(milliseconds_to_string(93785000),
499
 
                         "1T02:03:05")
500
 
    def test_no_days(self):
501
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
502
 
    def test_all_zero(self):
503
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
504
 
    def test_no_fractional_seconds(self):
505
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
506
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
507
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
508
 
 
509
 
 
510
 
def should_only_run_tests():
511
 
    parser = argparse.ArgumentParser(add_help=False)
512
 
    parser.add_argument("--check", action='store_true')
513
 
    args, unknown_args = parser.parse_known_args()
514
 
    run_tests = args.check
515
 
    if run_tests:
516
 
        # Remove --check argument from sys.argv
517
 
        sys.argv[1:] = unknown_args
518
 
    return run_tests
519
 
 
520
 
# Add all tests from doctest strings
521
 
def load_tests(loader, tests, none):
522
 
    import doctest
523
 
    tests.addTests(doctest.DocTestSuite())
524
 
    return tests
525
458
 
526
459
if __name__ == "__main__":
527
 
    if should_only_run_tests():
528
 
        # Call using ./tdd-python-script --check [--verbose]
529
 
        unittest.main()
530
 
    else:
531
 
        main()
 
460
    main()