/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: 2016-07-03 02:56:00 UTC
  • 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
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-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
43
 
44
44
import dbus
58
58
    "Interval": "Interval",
59
59
    "Host": "Host",
60
60
    "Fingerprint": "Fingerprint",
61
 
    "KeyID": "Key ID",
62
61
    "CheckerRunning": "Check Is Running",
63
62
    "LastEnabled": "Last Enabled",
64
63
    "ApprovalPending": "Approval Is Pending",
76
75
server_path = "/"
77
76
server_interface = domain + ".Mandos"
78
77
client_interface = domain + ".Mandos.Client"
79
 
version = "1.7.20"
 
78
version = "1.7.10"
80
79
 
81
80
 
82
81
try:
84
83
except AttributeError:
85
84
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
86
85
 
87
 
 
88
86
def milliseconds_to_string(ms):
89
87
    td = datetime.timedelta(0, 0, 0, ms)
90
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
91
 
            .format(days="{}T".format(td.days) if td.days else "",
92
 
                    hours=td.seconds // 3600,
93
 
                    minutes=(td.seconds % 3600) // 60,
94
 
                    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))
95
93
 
96
94
 
97
95
def rfc3339_duration_to_delta(duration):
98
96
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
99
 
 
 
97
    
100
98
    >>> rfc3339_duration_to_delta("P7D")
101
99
    datetime.timedelta(7)
102
100
    >>> rfc3339_duration_to_delta("PT60S")
112
110
    >>> rfc3339_duration_to_delta("P1DT3M20S")
113
111
    datetime.timedelta(1, 200)
114
112
    """
115
 
 
 
113
    
116
114
    # Parsing an RFC 3339 duration with regular expressions is not
117
115
    # possible - there would have to be multiple places for the same
118
116
    # values, like seconds.  The current code, while more esoteric, is
119
117
    # cleaner without depending on a parsing library.  If Python had a
120
118
    # built-in library for parsing we would use it, but we'd like to
121
119
    # avoid excessive use of external libraries.
122
 
 
 
120
    
123
121
    # New type for defining tokens, syntax, and semantics all-in-one
124
122
    Token = collections.namedtuple("Token", (
125
123
        "regexp",  # To match token; if "value" is not None, must have
158
156
                           frozenset((token_year, token_month,
159
157
                                      token_day, token_time,
160
158
                                      token_week)))
161
 
    # Define starting values:
162
 
    # Value so far
163
 
    value = datetime.timedelta()
 
159
    # Define starting values
 
160
    value = datetime.timedelta() # Value so far
164
161
    found_token = None
165
 
    # Following valid tokens
166
 
    followers = frozenset((token_duration, ))
167
 
    # String left to parse
168
 
    s = duration
 
162
    followers = frozenset((token_duration, )) # Following valid tokens
 
163
    s = duration                # String left to parse
169
164
    # Loop until end token is found
170
165
    while found_token is not token_end:
171
166
        # Search for any currently valid tokens
195
190
 
196
191
def string_to_delta(interval):
197
192
    """Parse a string and return a datetime.timedelta
198
 
 
 
193
    
199
194
    >>> string_to_delta('7d')
200
195
    datetime.timedelta(7)
201
196
    >>> string_to_delta('60s')
209
204
    >>> string_to_delta('5m 30s')
210
205
    datetime.timedelta(0, 330)
211
206
    """
212
 
 
 
207
    
213
208
    try:
214
209
        return rfc3339_duration_to_delta(interval)
215
210
    except ValueError:
216
211
        pass
217
 
 
 
212
    
218
213
    value = datetime.timedelta(0)
219
214
    regexp = re.compile(r"(\d+)([dsmhw]?)")
220
 
 
 
215
    
221
216
    for num, suffix in regexp.findall(interval):
222
217
        if suffix == "d":
223
218
            value += datetime.timedelta(int(num))
242
237
                       "ApprovalDuration", "ExtendedTimeout"):
243
238
            return milliseconds_to_string(value)
244
239
        return str(value)
245
 
 
 
240
    
246
241
    # Create format string to print table rows
247
242
    format_string = " ".join("{{{key}:{width}}}".format(
248
 
        width=max(len(tablewords[key]),
249
 
                  max(len(valuetostring(client[key], key))
250
 
                      for client in clients)),
251
 
        key=key)
 
243
        width = max(len(tablewords[key]),
 
244
                    max(len(valuetostring(client[key], key))
 
245
                        for client in clients)),
 
246
        key = key)
252
247
                             for key in keywords)
253
248
    # Print header line
254
249
    print(format_string.format(**tablewords))
255
250
    for client in clients:
256
 
        print(format_string
257
 
              .format(**{key: valuetostring(client[key], key)
258
 
                         for key in keywords}))
 
251
        print(format_string.format(**{
 
252
            key: valuetostring(client[key], key)
 
253
            for key in keywords }))
259
254
 
260
255
 
261
256
def has_actions(options):
282
277
def main():
283
278
    parser = argparse.ArgumentParser()
284
279
    parser.add_argument("--version", action="version",
285
 
                        version="%(prog)s {}".format(version),
 
280
                        version = "%(prog)s {}".format(version),
286
281
                        help="show version number and exit")
287
282
    parser.add_argument("-a", "--all", action="store_true",
288
283
                        help="Select all clients")
334
329
                        help="Run self-test")
335
330
    parser.add_argument("client", nargs="*", help="Client name")
336
331
    options = parser.parse_args()
337
 
 
 
332
    
338
333
    if has_actions(options) and not (options.client or options.all):
339
334
        parser.error("Options require clients names or --all.")
340
335
    if options.verbose and has_actions(options):
341
336
        parser.error("--verbose can only be used alone.")
342
 
    if options.dump_json and (options.verbose
343
 
                              or has_actions(options)):
 
337
    if options.dump_json and (options.verbose or has_actions(options)):
344
338
        parser.error("--dump-json can only be used alone.")
345
339
    if options.all and not has_actions(options):
346
340
        parser.error("--all requires an action.")
347
 
 
 
341
    
348
342
    if options.check:
349
 
        import doctest
350
343
        fail_count, test_count = doctest.testmod()
351
344
        sys.exit(os.EX_OK if fail_count == 0 else 1)
352
 
 
 
345
    
353
346
    try:
354
347
        bus = dbus.SystemBus()
355
348
        mandos_dbus_objc = bus.get_object(busname, server_path)
356
349
    except dbus.exceptions.DBusException:
357
350
        print("Could not connect to Mandos server", file=sys.stderr)
358
351
        sys.exit(1)
359
 
 
 
352
    
360
353
    mandos_serv = dbus.Interface(mandos_dbus_objc,
361
 
                                 dbus_interface=server_interface)
 
354
                                 dbus_interface = server_interface)
362
355
    mandos_serv_object_manager = dbus.Interface(
363
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
364
 
 
365
 
    # 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
366
359
    null = os.open(os.path.devnull, os.O_RDWR)
367
360
    stderrcopy = os.dup(sys.stderr.fileno())
368
361
    os.dup2(null, sys.stderr.fileno())
369
362
    os.close(null)
370
363
    try:
371
364
        try:
372
 
            mandos_clients = {path: ifs_and_props[client_interface]
373
 
                              for path, ifs_and_props in
374
 
                              mandos_serv_object_manager
375
 
                              .GetManagedObjects().items()
376
 
                              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 }
377
370
        finally:
378
 
            # restore stderr
 
371
            #restore stderr
379
372
            os.dup2(stderrcopy, sys.stderr.fileno())
380
373
            os.close(stderrcopy)
381
374
    except dbus.exceptions.DBusException as e:
382
 
        print("Access denied: "
383
 
              "Accessing mandos server through D-Bus: {}".format(e),
384
 
              file=sys.stderr)
 
375
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
376
              .format(e), file=sys.stderr)
385
377
        sys.exit(1)
386
 
 
 
378
    
387
379
    # Compile dict of (clients: properties) to process
388
 
    clients = {}
389
 
 
 
380
    clients={}
 
381
    
390
382
    if options.all or not options.client:
391
 
        clients = {bus.get_object(busname, path): properties
392
 
                   for path, properties in mandos_clients.items()}
 
383
        clients = { bus.get_object(busname, path): properties
 
384
                    for path, properties in mandos_clients.items() }
393
385
    else:
394
386
        for name in options.client:
395
387
            for path, client in mandos_clients.items():
401
393
                print("Client not found on server: {!r}"
402
394
                      .format(name), file=sys.stderr)
403
395
                sys.exit(1)
404
 
 
 
396
    
405
397
    if not has_actions(options) and clients:
406
398
        if options.verbose or options.dump_json:
407
399
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
408
 
                        "Created", "Interval", "Host", "KeyID",
409
 
                        "Fingerprint", "CheckerRunning",
410
 
                        "LastEnabled", "ApprovalPending",
411
 
                        "ApprovedByDefault", "LastApprovalRequest",
412
 
                        "ApprovalDelay", "ApprovalDuration",
413
 
                        "Checker", "ExtendedTimeout", "Expires",
 
400
                        "Created", "Interval", "Host", "Fingerprint",
 
401
                        "CheckerRunning", "LastEnabled",
 
402
                        "ApprovalPending", "ApprovedByDefault",
 
403
                        "LastApprovalRequest", "ApprovalDelay",
 
404
                        "ApprovalDuration", "Checker",
 
405
                        "ExtendedTimeout", "Expires",
414
406
                        "LastCheckerStatus")
415
407
        else:
416
408
            keywords = defaultkeywords
417
 
 
 
409
        
418
410
        if options.dump_json:
419
411
            json.dump({client["Name"]: {key:
420
412
                                        bool(client[key])
421
413
                                        if isinstance(client[key],
422
414
                                                      dbus.Boolean)
423
415
                                        else client[key]
424
 
                                        for key in keywords}
425
 
                       for client in clients.values()},
426
 
                      fp=sys.stdout, indent=4,
427
 
                      separators=(',', ': '))
 
416
                                        for key in keywords }
 
417
                       for client in clients.values() },
 
418
                      fp = sys.stdout, indent = 4,
 
419
                      separators = (',', ': '))
428
420
            print()
429
421
        else:
430
422
            print_clients(clients.values(), keywords)
431
423
    else:
432
424
        # Process each client in the list by all selected options
433
425
        for client in clients:
434
 
 
 
426
            
435
427
            def set_client_prop(prop, value):
436
428
                """Set a Client D-Bus property"""
437
429
                client.Set(client_interface, prop, value,
438
430
                           dbus_interface=dbus.PROPERTIES_IFACE)
439
 
 
 
431
            
440
432
            def set_client_prop_ms(prop, value):
441
433
                """Set a Client D-Bus property, converted
442
434
                from a string to milliseconds."""
443
435
                set_client_prop(prop,
444
436
                                string_to_delta(value).total_seconds()
445
437
                                * 1000)
446
 
 
 
438
            
447
439
            if options.remove:
448
440
                mandos_serv.RemoveClient(client.__dbus_object_path__)
449
441
            if options.enable:
457
449
            if options.stop_checker:
458
450
                set_client_prop("CheckerRunning", dbus.Boolean(False))
459
451
            if options.is_enabled:
460
 
                if client.Get(client_interface, "Enabled",
461
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
462
 
                    sys.exit(0)
463
 
                else:
464
 
                    sys.exit(1)
 
452
                sys.exit(0 if client.Get(client_interface,
 
453
                                         "Enabled",
 
454
                                         dbus_interface=
 
455
                                         dbus.PROPERTIES_IFACE)
 
456
                         else 1)
465
457
            if options.checker is not None:
466
458
                set_client_prop("Checker", options.checker)
467
459
            if options.host is not None: