/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-07-20 00:18:59 UTC
  • Revision ID: teddy@recompile.se-20150720001859-4373dkxokj7bt666
plugin-runner: Minor fix: close helperdir before exiting in fork.

* plugin-runner.c: Minor fix: close helperdir before exiting in fork
                   if helper program could not be opened.

Show diffs side-by-side

added added

removed removed

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