/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
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8 -*-
 
3
# 
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
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
 
11
# the Free Software Foundation, either version 3 of the License, or
 
12
# (at your option) any later version.
 
13
#
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
#     GNU General Public License for more details.
 
18
# 
 
19
# You should have received a copy of the GNU General Public License
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
 
23
# Contact the authors at <mandos@recompile.se>.
 
24
# 
 
25
 
 
26
from __future__ import (division, absolute_import, print_function,
 
27
                        unicode_literals)
 
28
 
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
 
33
 
 
34
import sys
 
35
import argparse
 
36
import locale
 
37
import datetime
 
38
import re
 
39
import os
 
40
import collections
 
41
import doctest
 
42
import json
 
43
 
 
44
import dbus
 
45
 
 
46
if sys.version_info.major == 2:
 
47
    str = unicode
 
48
 
 
49
locale.setlocale(locale.LC_ALL, "")
 
50
 
 
51
tablewords = {
 
52
    "Name": "Name",
 
53
    "Enabled": "Enabled",
 
54
    "Timeout": "Timeout",
 
55
    "LastCheckedOK": "Last Successful Check",
 
56
    "LastApprovalRequest": "Last Approval Request",
 
57
    "Created": "Created",
 
58
    "Interval": "Interval",
 
59
    "Host": "Host",
 
60
    "Fingerprint": "Fingerprint",
 
61
    "CheckerRunning": "Check Is Running",
 
62
    "LastEnabled": "Last Enabled",
 
63
    "ApprovalPending": "Approval Is Pending",
 
64
    "ApprovedByDefault": "Approved By Default",
 
65
    "ApprovalDelay": "Approval Delay",
 
66
    "ApprovalDuration": "Approval Duration",
 
67
    "Checker": "Checker",
 
68
    "ExtendedTimeout": "Extended Timeout",
 
69
    "Expires": "Expires",
 
70
    "LastCheckerStatus": "Last Checker Status",
 
71
}
 
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
 
73
domain = "se.recompile"
 
74
busname = domain + ".Mandos"
 
75
server_path = "/"
 
76
server_interface = domain + ".Mandos"
 
77
client_interface = domain + ".Mandos.Client"
 
78
version = "1.7.10"
 
79
 
 
80
 
 
81
try:
 
82
    dbus.OBJECT_MANAGER_IFACE
 
83
except AttributeError:
 
84
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
85
 
 
86
def milliseconds_to_string(ms):
 
87
    td = datetime.timedelta(0, 0, 0, ms)
 
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))
 
93
 
 
94
 
 
95
def rfc3339_duration_to_delta(duration):
 
96
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
97
    
 
98
    >>> rfc3339_duration_to_delta("P7D")
 
99
    datetime.timedelta(7)
 
100
    >>> rfc3339_duration_to_delta("PT60S")
 
101
    datetime.timedelta(0, 60)
 
102
    >>> rfc3339_duration_to_delta("PT60M")
 
103
    datetime.timedelta(0, 3600)
 
104
    >>> rfc3339_duration_to_delta("PT24H")
 
105
    datetime.timedelta(1)
 
106
    >>> rfc3339_duration_to_delta("P1W")
 
107
    datetime.timedelta(7)
 
108
    >>> rfc3339_duration_to_delta("PT5M30S")
 
109
    datetime.timedelta(0, 330)
 
110
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
111
    datetime.timedelta(1, 200)
 
112
    """
 
113
    
 
114
    # Parsing an RFC 3339 duration with regular expressions is not
 
115
    # possible - there would have to be multiple places for the same
 
116
    # values, like seconds.  The current code, while more esoteric, is
 
117
    # cleaner without depending on a parsing library.  If Python had a
 
118
    # built-in library for parsing we would use it, but we'd like to
 
119
    # avoid excessive use of external libraries.
 
120
    
 
121
    # New type for defining tokens, syntax, and semantics all-in-one
 
122
    Token = collections.namedtuple("Token", (
 
123
        "regexp",  # To match token; if "value" is not None, must have
 
124
                   # a "group" containing digits
 
125
        "value",   # datetime.timedelta or None
 
126
        "followers"))           # Tokens valid after this token
 
127
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
128
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
129
    token_end = Token(re.compile(r"$"), None, frozenset())
 
130
    token_second = Token(re.compile(r"(\d+)S"),
 
131
                         datetime.timedelta(seconds=1),
 
132
                         frozenset((token_end, )))
 
133
    token_minute = Token(re.compile(r"(\d+)M"),
 
134
                         datetime.timedelta(minutes=1),
 
135
                         frozenset((token_second, token_end)))
 
136
    token_hour = Token(re.compile(r"(\d+)H"),
 
137
                       datetime.timedelta(hours=1),
 
138
                       frozenset((token_minute, token_end)))
 
139
    token_time = Token(re.compile(r"T"),
 
140
                       None,
 
141
                       frozenset((token_hour, token_minute,
 
142
                                  token_second)))
 
143
    token_day = Token(re.compile(r"(\d+)D"),
 
144
                      datetime.timedelta(days=1),
 
145
                      frozenset((token_time, token_end)))
 
146
    token_month = Token(re.compile(r"(\d+)M"),
 
147
                        datetime.timedelta(weeks=4),
 
148
                        frozenset((token_day, token_end)))
 
149
    token_year = Token(re.compile(r"(\d+)Y"),
 
150
                       datetime.timedelta(weeks=52),
 
151
                       frozenset((token_month, token_end)))
 
152
    token_week = Token(re.compile(r"(\d+)W"),
 
153
                       datetime.timedelta(weeks=1),
 
154
                       frozenset((token_end, )))
 
155
    token_duration = Token(re.compile(r"P"), None,
 
156
                           frozenset((token_year, token_month,
 
157
                                      token_day, token_time,
 
158
                                      token_week)))
 
159
    # Define starting values
 
160
    value = datetime.timedelta() # Value so far
 
161
    found_token = None
 
162
    followers = frozenset((token_duration, )) # Following valid tokens
 
163
    s = duration                # String left to parse
 
164
    # Loop until end token is found
 
165
    while found_token is not token_end:
 
166
        # Search for any currently valid tokens
 
167
        for token in followers:
 
168
            match = token.regexp.match(s)
 
169
            if match is not None:
 
170
                # Token found
 
171
                if token.value is not None:
 
172
                    # Value found, parse digits
 
173
                    factor = int(match.group(1), 10)
 
174
                    # Add to value so far
 
175
                    value += factor * token.value
 
176
                # Strip token from string
 
177
                s = token.regexp.sub("", s, 1)
 
178
                # Go to found token
 
179
                found_token = token
 
180
                # Set valid next tokens
 
181
                followers = found_token.followers
 
182
                break
 
183
        else:
 
184
            # No currently valid tokens were found
 
185
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
186
                             .format(duration))
 
187
    # End token found
 
188
    return value
 
189
 
 
190
 
 
191
def string_to_delta(interval):
 
192
    """Parse a string and return a datetime.timedelta
 
193
    
 
194
    >>> string_to_delta('7d')
 
195
    datetime.timedelta(7)
 
196
    >>> string_to_delta('60s')
 
197
    datetime.timedelta(0, 60)
 
198
    >>> string_to_delta('60m')
 
199
    datetime.timedelta(0, 3600)
 
200
    >>> string_to_delta('24h')
 
201
    datetime.timedelta(1)
 
202
    >>> string_to_delta('1w')
 
203
    datetime.timedelta(7)
 
204
    >>> string_to_delta('5m 30s')
 
205
    datetime.timedelta(0, 330)
 
206
    """
 
207
    
 
208
    try:
 
209
        return rfc3339_duration_to_delta(interval)
 
210
    except ValueError:
 
211
        pass
 
212
    
 
213
    value = datetime.timedelta(0)
 
214
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
215
    
 
216
    for num, suffix in regexp.findall(interval):
 
217
        if suffix == "d":
 
218
            value += datetime.timedelta(int(num))
 
219
        elif suffix == "s":
 
220
            value += datetime.timedelta(0, int(num))
 
221
        elif suffix == "m":
 
222
            value += datetime.timedelta(0, 0, 0, 0, int(num))
 
223
        elif suffix == "h":
 
224
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
 
225
        elif suffix == "w":
 
226
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
 
227
        elif suffix == "":
 
228
            value += datetime.timedelta(0, 0, 0, int(num))
 
229
    return value
 
230
 
 
231
 
 
232
def print_clients(clients, keywords):
 
233
    def valuetostring(value, keyword):
 
234
        if type(value) is dbus.Boolean:
 
235
            return "Yes" if value else "No"
 
236
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
237
                       "ApprovalDuration", "ExtendedTimeout"):
 
238
            return milliseconds_to_string(value)
 
239
        return str(value)
 
240
    
 
241
    # Create format string to print table rows
 
242
    format_string = " ".join("{{{key}:{width}}}".format(
 
243
        width = max(len(tablewords[key]),
 
244
                    max(len(valuetostring(client[key], key))
 
245
                        for client in clients)),
 
246
        key = key)
 
247
                             for key in keywords)
 
248
    # Print header line
 
249
    print(format_string.format(**tablewords))
 
250
    for client in clients:
 
251
        print(format_string.format(**{
 
252
            key: valuetostring(client[key], key)
 
253
            for key in keywords }))
 
254
 
 
255
 
 
256
def has_actions(options):
 
257
    return any((options.enable,
 
258
                options.disable,
 
259
                options.bump_timeout,
 
260
                options.start_checker,
 
261
                options.stop_checker,
 
262
                options.is_enabled,
 
263
                options.remove,
 
264
                options.checker is not None,
 
265
                options.timeout is not None,
 
266
                options.extended_timeout is not None,
 
267
                options.interval is not None,
 
268
                options.approved_by_default is not None,
 
269
                options.approval_delay is not None,
 
270
                options.approval_duration is not None,
 
271
                options.host is not None,
 
272
                options.secret is not None,
 
273
                options.approve,
 
274
                options.deny))
 
275
 
 
276
 
 
277
def main():
 
278
    parser = argparse.ArgumentParser()
 
279
    parser.add_argument("--version", action="version",
 
280
                        version = "%(prog)s {}".format(version),
 
281
                        help="show version number and exit")
 
282
    parser.add_argument("-a", "--all", action="store_true",
 
283
                        help="Select all clients")
 
284
    parser.add_argument("-v", "--verbose", action="store_true",
 
285
                        help="Print all fields")
 
286
    parser.add_argument("-j", "--dump-json", action="store_true",
 
287
                        help="Dump client data in JSON format")
 
288
    parser.add_argument("-e", "--enable", action="store_true",
 
289
                        help="Enable client")
 
290
    parser.add_argument("-d", "--disable", action="store_true",
 
291
                        help="disable client")
 
292
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
293
                        help="Bump timeout for client")
 
294
    parser.add_argument("--start-checker", action="store_true",
 
295
                        help="Start checker for client")
 
296
    parser.add_argument("--stop-checker", action="store_true",
 
297
                        help="Stop checker for client")
 
298
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
299
                        help="Check if client is enabled")
 
300
    parser.add_argument("-r", "--remove", action="store_true",
 
301
                        help="Remove client")
 
302
    parser.add_argument("-c", "--checker",
 
303
                        help="Set checker command for client")
 
304
    parser.add_argument("-t", "--timeout",
 
305
                        help="Set timeout for client")
 
306
    parser.add_argument("--extended-timeout",
 
307
                        help="Set extended timeout for client")
 
308
    parser.add_argument("-i", "--interval",
 
309
                        help="Set checker interval for client")
 
310
    parser.add_argument("--approve-by-default", action="store_true",
 
311
                        default=None, dest="approved_by_default",
 
312
                        help="Set client to be approved by default")
 
313
    parser.add_argument("--deny-by-default", action="store_false",
 
314
                        dest="approved_by_default",
 
315
                        help="Set client to be denied by default")
 
316
    parser.add_argument("--approval-delay",
 
317
                        help="Set delay before client approve/deny")
 
318
    parser.add_argument("--approval-duration",
 
319
                        help="Set duration of one client approval")
 
320
    parser.add_argument("-H", "--host", help="Set host for client")
 
321
    parser.add_argument("-s", "--secret",
 
322
                        type=argparse.FileType(mode="rb"),
 
323
                        help="Set password blob (file) for client")
 
324
    parser.add_argument("-A", "--approve", action="store_true",
 
325
                        help="Approve any current client request")
 
326
    parser.add_argument("-D", "--deny", action="store_true",
 
327
                        help="Deny any current client request")
 
328
    parser.add_argument("--check", action="store_true",
 
329
                        help="Run self-test")
 
330
    parser.add_argument("client", nargs="*", help="Client name")
 
331
    options = parser.parse_args()
 
332
    
 
333
    if has_actions(options) and not (options.client or options.all):
 
334
        parser.error("Options require clients names or --all.")
 
335
    if options.verbose and has_actions(options):
 
336
        parser.error("--verbose can only be used alone.")
 
337
    if options.dump_json and (options.verbose or has_actions(options)):
 
338
        parser.error("--dump-json can only be used alone.")
 
339
    if options.all and not has_actions(options):
 
340
        parser.error("--all requires an action.")
 
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
    
 
346
    try:
 
347
        bus = dbus.SystemBus()
 
348
        mandos_dbus_objc = bus.get_object(busname, server_path)
 
349
    except dbus.exceptions.DBusException:
 
350
        print("Could not connect to Mandos server", file=sys.stderr)
 
351
        sys.exit(1)
 
352
    
 
353
    mandos_serv = dbus.Interface(mandos_dbus_objc,
 
354
                                 dbus_interface = server_interface)
 
355
    mandos_serv_object_manager = dbus.Interface(
 
356
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
357
    
 
358
    #block stderr since dbus library prints to stderr
 
359
    null = os.open(os.path.devnull, os.O_RDWR)
 
360
    stderrcopy = os.dup(sys.stderr.fileno())
 
361
    os.dup2(null, sys.stderr.fileno())
 
362
    os.close(null)
 
363
    try:
 
364
        try:
 
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 }
 
370
        finally:
 
371
            #restore stderr
 
372
            os.dup2(stderrcopy, sys.stderr.fileno())
 
373
            os.close(stderrcopy)
 
374
    except dbus.exceptions.DBusException as e:
 
375
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
376
              .format(e), file=sys.stderr)
 
377
        sys.exit(1)
 
378
    
 
379
    # Compile dict of (clients: properties) to process
 
380
    clients={}
 
381
    
 
382
    if options.all or not options.client:
 
383
        clients = { bus.get_object(busname, path): properties
 
384
                    for path, properties in mandos_clients.items() }
 
385
    else:
 
386
        for name in options.client:
 
387
            for path, client in mandos_clients.items():
 
388
                if client["Name"] == name:
 
389
                    client_objc = bus.get_object(busname, path)
 
390
                    clients[client_objc] = client
 
391
                    break
 
392
            else:
 
393
                print("Client not found on server: {!r}"
 
394
                      .format(name), file=sys.stderr)
 
395
                sys.exit(1)
 
396
    
 
397
    if not has_actions(options) and clients:
 
398
        if options.verbose or options.dump_json:
 
399
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
400
                        "Created", "Interval", "Host", "Fingerprint",
 
401
                        "CheckerRunning", "LastEnabled",
 
402
                        "ApprovalPending", "ApprovedByDefault",
 
403
                        "LastApprovalRequest", "ApprovalDelay",
 
404
                        "ApprovalDuration", "Checker",
 
405
                        "ExtendedTimeout", "Expires",
 
406
                        "LastCheckerStatus")
 
407
        else:
 
408
            keywords = defaultkeywords
 
409
        
 
410
        if options.dump_json:
 
411
            json.dump({client["Name"]: {key:
 
412
                                        bool(client[key])
 
413
                                        if isinstance(client[key],
 
414
                                                      dbus.Boolean)
 
415
                                        else client[key]
 
416
                                        for key in keywords }
 
417
                       for client in clients.values() },
 
418
                      fp = sys.stdout, indent = 4,
 
419
                      separators = (',', ': '))
 
420
            print()
 
421
        else:
 
422
            print_clients(clients.values(), keywords)
 
423
    else:
 
424
        # Process each client in the list by all selected options
 
425
        for client in clients:
 
426
            
 
427
            def set_client_prop(prop, value):
 
428
                """Set a Client D-Bus property"""
 
429
                client.Set(client_interface, prop, value,
 
430
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
431
            
 
432
            def set_client_prop_ms(prop, value):
 
433
                """Set a Client D-Bus property, converted
 
434
                from a string to milliseconds."""
 
435
                set_client_prop(prop,
 
436
                                string_to_delta(value).total_seconds()
 
437
                                * 1000)
 
438
            
 
439
            if options.remove:
 
440
                mandos_serv.RemoveClient(client.__dbus_object_path__)
 
441
            if options.enable:
 
442
                set_client_prop("Enabled", dbus.Boolean(True))
 
443
            if options.disable:
 
444
                set_client_prop("Enabled", dbus.Boolean(False))
 
445
            if options.bump_timeout:
 
446
                set_client_prop("LastCheckedOK", "")
 
447
            if options.start_checker:
 
448
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
449
            if options.stop_checker:
 
450
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
451
            if options.is_enabled:
 
452
                sys.exit(0 if client.Get(client_interface,
 
453
                                         "Enabled",
 
454
                                         dbus_interface=
 
455
                                         dbus.PROPERTIES_IFACE)
 
456
                         else 1)
 
457
            if options.checker is not None:
 
458
                set_client_prop("Checker", options.checker)
 
459
            if options.host is not None:
 
460
                set_client_prop("Host", options.host)
 
461
            if options.interval is not None:
 
462
                set_client_prop_ms("Interval", options.interval)
 
463
            if options.approval_delay is not None:
 
464
                set_client_prop_ms("ApprovalDelay",
 
465
                                   options.approval_delay)
 
466
            if options.approval_duration is not None:
 
467
                set_client_prop_ms("ApprovalDuration",
 
468
                                   options.approval_duration)
 
469
            if options.timeout is not None:
 
470
                set_client_prop_ms("Timeout", options.timeout)
 
471
            if options.extended_timeout is not None:
 
472
                set_client_prop_ms("ExtendedTimeout",
 
473
                                   options.extended_timeout)
 
474
            if options.secret is not None:
 
475
                set_client_prop("Secret",
 
476
                                dbus.ByteArray(options.secret.read()))
 
477
            if options.approved_by_default is not None:
 
478
                set_client_prop("ApprovedByDefault",
 
479
                                dbus.Boolean(options
 
480
                                             .approved_by_default))
 
481
            if options.approve:
 
482
                client.Approve(dbus.Boolean(True),
 
483
                               dbus_interface=client_interface)
 
484
            elif options.deny:
 
485
                client.Approve(dbus.Boolean(False),
 
486
                               dbus_interface=client_interface)
 
487
 
 
488
 
 
489
if __name__ == "__main__":
 
490
    main()