/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-03-17 21:18:37 UTC
  • Revision ID: teddy@recompile.se-20160317211837-f2tz0c9284rsv3k8
Client: Document default directories more clearly

Document default plugin directory and default plugin helper directory
also in the FILES section of the manual.

* plugin-runner.xml (FILES): Add "/lib/mandos/plugins.d" and
                             "/lib/mandos/plugin-helpers".

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