/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: 2016-07-03 02:56:00 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 350.
  • Revision ID: teddy@recompile.se-20160703025600-bn12vpzejr6zxx5v
mandos-client: Bug fix: flush stdout to detect write errors.

* plugins.d/mandos-client.c (start_mandos_communication): Do
                            fflush(stdout) to detect any write errors.

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-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 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
 
41
import doctest
42
42
import json
43
 
import unittest
44
 
import logging
45
43
 
46
44
import dbus
47
45
 
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
46
if sys.version_info.major == 2:
60
47
    str = unicode
61
48
 
71
58
    "Interval": "Interval",
72
59
    "Host": "Host",
73
60
    "Fingerprint": "Fingerprint",
74
 
    "KeyID": "Key ID",
75
61
    "CheckerRunning": "Check Is Running",
76
62
    "LastEnabled": "Last Enabled",
77
63
    "ApprovalPending": "Approval Is Pending",
89
75
server_path = "/"
90
76
server_interface = domain + ".Mandos"
91
77
client_interface = domain + ".Mandos.Client"
92
 
version = "1.8.3"
 
78
version = "1.7.10"
93
79
 
94
80
 
95
81
try:
97
83
except AttributeError:
98
84
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
99
85
 
100
 
 
101
86
def milliseconds_to_string(ms):
102
87
    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))
 
88
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
89
        days = "{}T".format(td.days) if td.days else "",
 
90
        hours = td.seconds // 3600,
 
91
        minutes = (td.seconds % 3600) // 60,
 
92
        seconds = td.seconds % 60))
108
93
 
109
94
 
110
95
def rfc3339_duration_to_delta(duration):
111
96
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
97
    
113
98
    >>> rfc3339_duration_to_delta("P7D")
114
99
    datetime.timedelta(7)
115
100
    >>> rfc3339_duration_to_delta("PT60S")
125
110
    >>> rfc3339_duration_to_delta("P1DT3M20S")
126
111
    datetime.timedelta(1, 200)
127
112
    """
128
 
 
 
113
    
129
114
    # Parsing an RFC 3339 duration with regular expressions is not
130
115
    # possible - there would have to be multiple places for the same
131
116
    # values, like seconds.  The current code, while more esoteric, is
132
117
    # cleaner without depending on a parsing library.  If Python had a
133
118
    # built-in library for parsing we would use it, but we'd like to
134
119
    # avoid excessive use of external libraries.
135
 
 
 
120
    
136
121
    # New type for defining tokens, syntax, and semantics all-in-one
137
122
    Token = collections.namedtuple("Token", (
138
123
        "regexp",  # To match token; if "value" is not None, must have
171
156
                           frozenset((token_year, token_month,
172
157
                                      token_day, token_time,
173
158
                                      token_week)))
174
 
    # Define starting values:
175
 
    # Value so far
176
 
    value = datetime.timedelta()
 
159
    # Define starting values
 
160
    value = datetime.timedelta() # Value so far
177
161
    found_token = None
178
 
    # Following valid tokens
179
 
    followers = frozenset((token_duration, ))
180
 
    # String left to parse
181
 
    s = duration
 
162
    followers = frozenset((token_duration, )) # Following valid tokens
 
163
    s = duration                # String left to parse
182
164
    # Loop until end token is found
183
165
    while found_token is not token_end:
184
166
        # Search for any currently valid tokens
208
190
 
209
191
def string_to_delta(interval):
210
192
    """Parse a string and return a datetime.timedelta
211
 
 
 
193
    
212
194
    >>> string_to_delta('7d')
213
195
    datetime.timedelta(7)
214
196
    >>> string_to_delta('60s')
222
204
    >>> string_to_delta('5m 30s')
223
205
    datetime.timedelta(0, 330)
224
206
    """
225
 
 
 
207
    
226
208
    try:
227
209
        return rfc3339_duration_to_delta(interval)
228
210
    except ValueError:
229
211
        pass
230
 
 
 
212
    
231
213
    value = datetime.timedelta(0)
232
214
    regexp = re.compile(r"(\d+)([dsmhw]?)")
233
 
 
 
215
    
234
216
    for num, suffix in regexp.findall(interval):
235
217
        if suffix == "d":
236
218
            value += datetime.timedelta(int(num))
255
237
                       "ApprovalDuration", "ExtendedTimeout"):
256
238
            return milliseconds_to_string(value)
257
239
        return str(value)
258
 
 
 
240
    
259
241
    # Create format string to print table rows
260
242
    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)
 
243
        width = max(len(tablewords[key]),
 
244
                    max(len(valuetostring(client[key], key))
 
245
                        for client in clients)),
 
246
        key = key)
265
247
                             for key in keywords)
266
248
    # Print header line
267
249
    print(format_string.format(**tablewords))
268
250
    for client in clients:
269
 
        print(format_string
270
 
              .format(**{key: valuetostring(client[key], key)
271
 
                         for key in keywords}))
 
251
        print(format_string.format(**{
 
252
            key: valuetostring(client[key], key)
 
253
            for key in keywords }))
272
254
 
273
255
 
274
256
def has_actions(options):
295
277
def main():
296
278
    parser = argparse.ArgumentParser()
297
279
    parser.add_argument("--version", action="version",
298
 
                        version="%(prog)s {}".format(version),
 
280
                        version = "%(prog)s {}".format(version),
299
281
                        help="show version number and exit")
300
282
    parser.add_argument("-a", "--all", action="store_true",
301
283
                        help="Select all clients")
347
329
                        help="Run self-test")
348
330
    parser.add_argument("client", nargs="*", help="Client name")
349
331
    options = parser.parse_args()
350
 
 
 
332
    
351
333
    if has_actions(options) and not (options.client or options.all):
352
334
        parser.error("Options require clients names or --all.")
353
335
    if options.verbose and has_actions(options):
354
336
        parser.error("--verbose can only be used alone.")
355
 
    if options.dump_json and (options.verbose
356
 
                              or has_actions(options)):
 
337
    if options.dump_json and (options.verbose or has_actions(options)):
357
338
        parser.error("--dump-json can only be used alone.")
358
339
    if options.all and not has_actions(options):
359
340
        parser.error("--all requires an action.")
360
 
 
 
341
    
 
342
    if options.check:
 
343
        fail_count, test_count = doctest.testmod()
 
344
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
345
    
361
346
    try:
362
347
        bus = dbus.SystemBus()
363
348
        mandos_dbus_objc = bus.get_object(busname, server_path)
364
349
    except dbus.exceptions.DBusException:
365
 
        log.critical("Could not connect to Mandos server")
 
350
        print("Could not connect to Mandos server", file=sys.stderr)
366
351
        sys.exit(1)
367
 
 
 
352
    
368
353
    mandos_serv = dbus.Interface(mandos_dbus_objc,
369
 
                                 dbus_interface=server_interface)
 
354
                                 dbus_interface = server_interface)
370
355
    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
 
356
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
357
    
 
358
    #block stderr since dbus library prints to stderr
374
359
    null = os.open(os.path.devnull, os.O_RDWR)
375
360
    stderrcopy = os.dup(sys.stderr.fileno())
376
361
    os.dup2(null, sys.stderr.fileno())
377
362
    os.close(null)
378
363
    try:
379
364
        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}
 
365
            mandos_clients = { path: ifs_and_props[client_interface]
 
366
                               for path, ifs_and_props in
 
367
                               mandos_serv_object_manager
 
368
                               .GetManagedObjects().items()
 
369
                               if client_interface in ifs_and_props }
385
370
        finally:
386
 
            # restore stderr
 
371
            #restore stderr
387
372
            os.dup2(stderrcopy, sys.stderr.fileno())
388
373
            os.close(stderrcopy)
389
374
    except dbus.exceptions.DBusException as e:
390
 
        log.critical("Failed to access Mandos server through D-Bus:"
391
 
                     "\n%s", e)
 
375
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
376
              .format(e), file=sys.stderr)
392
377
        sys.exit(1)
393
 
 
 
378
    
394
379
    # Compile dict of (clients: properties) to process
395
 
    clients = {}
396
 
 
 
380
    clients={}
 
381
    
397
382
    if options.all or not options.client:
398
 
        clients = {bus.get_object(busname, path): properties
399
 
                   for path, properties in mandos_clients.items()}
 
383
        clients = { bus.get_object(busname, path): properties
 
384
                    for path, properties in mandos_clients.items() }
400
385
    else:
401
386
        for name in options.client:
402
387
            for path, client in mandos_clients.items():
405
390
                    clients[client_objc] = client
406
391
                    break
407
392
            else:
408
 
                log.critical("Client not found on server: %r", name)
 
393
                print("Client not found on server: {!r}"
 
394
                      .format(name), file=sys.stderr)
409
395
                sys.exit(1)
410
 
 
 
396
    
411
397
    if not has_actions(options) and clients:
412
398
        if options.verbose or options.dump_json:
413
399
            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",
 
400
                        "Created", "Interval", "Host", "Fingerprint",
 
401
                        "CheckerRunning", "LastEnabled",
 
402
                        "ApprovalPending", "ApprovedByDefault",
 
403
                        "LastApprovalRequest", "ApprovalDelay",
 
404
                        "ApprovalDuration", "Checker",
 
405
                        "ExtendedTimeout", "Expires",
420
406
                        "LastCheckerStatus")
421
407
        else:
422
408
            keywords = defaultkeywords
423
 
 
 
409
        
424
410
        if options.dump_json:
425
411
            json.dump({client["Name"]: {key:
426
412
                                        bool(client[key])
427
413
                                        if isinstance(client[key],
428
414
                                                      dbus.Boolean)
429
415
                                        else client[key]
430
 
                                        for key in keywords}
431
 
                       for client in clients.values()},
432
 
                      fp=sys.stdout, indent=4,
433
 
                      separators=(',', ': '))
 
416
                                        for key in keywords }
 
417
                       for client in clients.values() },
 
418
                      fp = sys.stdout, indent = 4,
 
419
                      separators = (',', ': '))
434
420
            print()
435
421
        else:
436
422
            print_clients(clients.values(), keywords)
437
423
    else:
438
424
        # Process each client in the list by all selected options
439
425
        for client in clients:
440
 
 
 
426
            
441
427
            def set_client_prop(prop, value):
442
428
                """Set a Client D-Bus property"""
443
429
                client.Set(client_interface, prop, value,
444
430
                           dbus_interface=dbus.PROPERTIES_IFACE)
445
 
 
 
431
            
446
432
            def set_client_prop_ms(prop, value):
447
433
                """Set a Client D-Bus property, converted
448
434
                from a string to milliseconds."""
449
435
                set_client_prop(prop,
450
436
                                string_to_delta(value).total_seconds()
451
437
                                * 1000)
452
 
 
 
438
            
453
439
            if options.remove:
454
440
                mandos_serv.RemoveClient(client.__dbus_object_path__)
455
441
            if options.enable:
463
449
            if options.stop_checker:
464
450
                set_client_prop("CheckerRunning", dbus.Boolean(False))
465
451
            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)
 
452
                sys.exit(0 if client.Get(client_interface,
 
453
                                         "Enabled",
 
454
                                         dbus_interface=
 
455
                                         dbus.PROPERTIES_IFACE)
 
456
                         else 1)
471
457
            if options.checker is not None:
472
458
                set_client_prop("Checker", options.checker)
473
459
            if options.host is not None:
499
485
                client.Approve(dbus.Boolean(False),
500
486
                               dbus_interface=client_interface)
501
487
 
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
488
 
533
489
if __name__ == "__main__":
534
 
    if should_only_run_tests():
535
 
        # Call using ./tdd-python-script --check [--verbose]
536
 
        unittest.main()
537
 
    else:
538
 
        main()
 
490
    main()