/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-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

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-2014 Teddy Hogeborn
 
7
# Copyright © 2008-2014 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
 
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.6.9"
70
76
 
71
77
def milliseconds_to_string(ms):
72
78
    td = datetime.timedelta(0, 0, 0, ms)
73
79
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
74
 
            .format(days = "{0}T".format(td.days) if td.days else "",
 
80
            .format(days = "{}T".format(td.days) if td.days else "",
75
81
                    hours = td.seconds // 3600,
76
82
                    minutes = (td.seconds % 3600) // 60,
77
83
                    seconds = td.seconds % 60,
78
84
                    ))
79
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
 
116
                                              # "value" is not None,
 
117
                                              # must have a "group"
 
118
                                              # containing digits
 
119
                                    "value",  # datetime.timedelta or
 
120
                                              # None
 
121
                                    "followers")) # Tokens valid after
 
122
                                                  # this token
 
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
125
    token_end = Token(re.compile(r"$"), None, frozenset())
 
126
    token_second = Token(re.compile(r"(\d+)S"),
 
127
                         datetime.timedelta(seconds=1),
 
128
                         frozenset((token_end,)))
 
129
    token_minute = Token(re.compile(r"(\d+)M"),
 
130
                         datetime.timedelta(minutes=1),
 
131
                         frozenset((token_second, token_end)))
 
132
    token_hour = Token(re.compile(r"(\d+)H"),
 
133
                       datetime.timedelta(hours=1),
 
134
                       frozenset((token_minute, token_end)))
 
135
    token_time = Token(re.compile(r"T"),
 
136
                       None,
 
137
                       frozenset((token_hour, token_minute,
 
138
                                  token_second)))
 
139
    token_day = Token(re.compile(r"(\d+)D"),
 
140
                      datetime.timedelta(days=1),
 
141
                      frozenset((token_time, token_end)))
 
142
    token_month = Token(re.compile(r"(\d+)M"),
 
143
                        datetime.timedelta(weeks=4),
 
144
                        frozenset((token_day, token_end)))
 
145
    token_year = Token(re.compile(r"(\d+)Y"),
 
146
                       datetime.timedelta(weeks=52),
 
147
                       frozenset((token_month, token_end)))
 
148
    token_week = Token(re.compile(r"(\d+)W"),
 
149
                       datetime.timedelta(weeks=1),
 
150
                       frozenset((token_end,)))
 
151
    token_duration = Token(re.compile(r"P"), None,
 
152
                           frozenset((token_year, token_month,
 
153
                                      token_day, token_time,
 
154
                                      token_week)))
 
155
    # Define starting values
 
156
    value = datetime.timedelta() # Value so far
 
157
    found_token = None
 
158
    followers = frozenset((token_duration,)) # Following valid tokens
 
159
    s = duration                # String left to parse
 
160
    # Loop until end token is found
 
161
    while found_token is not token_end:
 
162
        # Search for any currently valid tokens
 
163
        for token in followers:
 
164
            match = token.regexp.match(s)
 
165
            if match is not None:
 
166
                # Token found
 
167
                if token.value is not None:
 
168
                    # Value found, parse digits
 
169
                    factor = int(match.group(1), 10)
 
170
                    # Add to value so far
 
171
                    value += factor * token.value
 
172
                # Strip token from string
 
173
                s = token.regexp.sub("", s, 1)
 
174
                # Go to found token
 
175
                found_token = token
 
176
                # Set valid next tokens
 
177
                followers = found_token.followers
 
178
                break
 
179
        else:
 
180
            # No currently valid tokens were found
 
181
            raise ValueError("Invalid RFC 3339 duration")
 
182
    # End token found
 
183
    return value
 
184
 
 
185
 
80
186
def string_to_delta(interval):
81
187
    """Parse a string and return a datetime.timedelta
82
188
    
93
199
    >>> string_to_delta("5m 30s")
94
200
    datetime.timedelta(0, 330)
95
201
    """
 
202
    
 
203
    try:
 
204
        return rfc3339_duration_to_delta(interval)
 
205
    except ValueError:
 
206
        pass
 
207
    
96
208
    value = datetime.timedelta(0)
97
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
209
    regexp = re.compile(r"(\d+)([dsmhw]?)")
98
210
    
99
211
    for num, suffix in regexp.findall(interval):
100
212
        if suffix == "d":
116
228
        if type(value) is dbus.Boolean:
117
229
            return "Yes" if value else "No"
118
230
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
119
 
                       "ApprovalDuration"):
 
231
                       "ApprovalDuration", "ExtendedTimeout"):
120
232
            return milliseconds_to_string(value)
121
 
        return unicode(value)
 
233
        return str(value)
122
234
    
123
235
    # Create format string to print table rows
124
236
    format_string = " ".join("{{{key}:{width}}}".format(
131
243
    # Print header line
132
244
    print(format_string.format(**tablewords))
133
245
    for client in clients:
134
 
        print(format_string.format(**dict((key,
 
246
        print(format_string.format(**{ key:
135
247
                                           valuetostring(client[key],
136
 
                                                         key))
137
 
                                          for key in keywords)))
 
248
                                                         key)
 
249
                                       for key in keywords }))
138
250
 
139
251
def has_actions(options):
140
252
    return any((options.enable,
159
271
def main():
160
272
    parser = argparse.ArgumentParser()
161
273
    parser.add_argument("--version", action="version",
162
 
                        version = "%(prog)s {0}".format(version),
 
274
                        version = "%(prog)s {}".format(version),
163
275
                        help="show version number and exit")
164
276
    parser.add_argument("-a", "--all", action="store_true",
165
277
                        help="Select all clients")
198
310
    parser.add_argument("--approval-duration",
199
311
                        help="Set duration of one client approval")
200
312
    parser.add_argument("-H", "--host", help="Set host for client")
201
 
    parser.add_argument("-s", "--secret", type=file,
 
313
    parser.add_argument("-s", "--secret",
 
314
                        type=argparse.FileType(mode="rb"),
202
315
                        help="Set password blob (file) for client")
203
316
    parser.add_argument("-A", "--approve", action="store_true",
204
317
                        help="Approve any current client request")
205
318
    parser.add_argument("-D", "--deny", action="store_true",
206
319
                        help="Deny any current client request")
 
320
    parser.add_argument("--check", action="store_true",
 
321
                        help="Run self-test")
207
322
    parser.add_argument("client", nargs="*", help="Client name")
208
323
    options = parser.parse_args()
209
324
    
210
 
    if has_actions(options) and not options.client and not options.all:
 
325
    if has_actions(options) and not (options.client or options.all):
211
326
        parser.error("Options require clients names or --all.")
212
327
    if options.verbose and has_actions(options):
213
328
        parser.error("--verbose can only be used alone or with"
214
329
                     " --all.")
215
330
    if options.all and not has_actions(options):
216
331
        parser.error("--all requires an action.")
 
332
 
 
333
    if options.check:
 
334
        fail_count, test_count = doctest.testmod()
 
335
        sys.exit(os.EX_OK if fail_count == 0 else 1)
217
336
    
218
337
    try:
219
338
        bus = dbus.SystemBus()
247
366
    clients={}
248
367
    
249
368
    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())
 
369
        clients = { bus.get_object(busname, path): properties
 
370
                    for path, properties in mandos_clients.items() }
253
371
    else:
254
372
        for name in options.client:
255
 
            for path, client in mandos_clients.iteritems():
 
373
            for path, client in mandos_clients.items():
256
374
                if client["Name"] == name:
257
375
                    client_objc = bus.get_object(busname, path)
258
376
                    clients[client_objc] = client
259
377
                    break
260
378
            else:
261
 
                print("Client not found on server: {0!r}"
 
379
                print("Client not found on server: {!r}"
262
380
                      .format(name), file=sys.stderr)
263
381
                sys.exit(1)
264
382
    
279
397
    else:
280
398
        # Process each client in the list by all selected options
281
399
        for client in clients:
 
400
            def set_client_prop(prop, value):
 
401
                """Set a Client D-Bus property"""
 
402
                client.Set(client_interface, prop, value,
 
403
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
404
            def set_client_prop_ms(prop, value):
 
405
                """Set a Client D-Bus property, converted
 
406
                from a string to milliseconds."""
 
407
                set_client_prop(prop,
 
408
                                string_to_delta(value).total_seconds()
 
409
                                * 1000)
282
410
            if options.remove:
283
411
                mandos_serv.RemoveClient(client.__dbus_object_path__)
284
412
            if options.enable:
285
 
                client.Set(client_interface, "Enabled",
286
 
                           dbus.Boolean(True),
287
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
413
                set_client_prop("Enabled", dbus.Boolean(True))
288
414
            if options.disable:
289
 
                client.Set(client_interface, "Enabled",
290
 
                           dbus.Boolean(False),
291
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
415
                set_client_prop("Enabled", dbus.Boolean(False))
292
416
            if options.bump_timeout:
293
 
                client.Set(client_interface, "LastCheckedOK", "",
294
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
417
                set_client_prop("LastCheckedOK", "")
295
418
            if options.start_checker:
296
 
                client.Set(client_interface, "CheckerRunning",
297
 
                           dbus.Boolean(True),
298
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
419
                set_client_prop("CheckerRunning", dbus.Boolean(True))
299
420
            if options.stop_checker:
300
 
                client.Set(client_interface, "CheckerRunning",
301
 
                           dbus.Boolean(False),
302
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
421
                set_client_prop("CheckerRunning", dbus.Boolean(False))
303
422
            if options.is_enabled:
304
423
                sys.exit(0 if client.Get(client_interface,
305
424
                                         "Enabled",
307
426
                                         dbus.PROPERTIES_IFACE)
308
427
                         else 1)
309
428
            if options.checker is not None:
310
 
                client.Set(client_interface, "Checker",
311
 
                           options.checker,
312
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
429
                set_client_prop("Checker", options.checker)
313
430
            if options.host is not None:
314
 
                client.Set(client_interface, "Host", options.host,
315
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
431
                set_client_prop("Host", options.host)
316
432
            if options.interval is not None:
317
 
                client.Set(client_interface, "Interval",
318
 
                           timedelta_to_milliseconds
319
 
                           (string_to_delta(options.interval)),
320
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
433
                set_client_prop_ms("Interval", options.interval)
321
434
            if options.approval_delay is not None:
322
 
                client.Set(client_interface, "ApprovalDelay",
323
 
                           timedelta_to_milliseconds
324
 
                           (string_to_delta(options.
325
 
                                            approval_delay)),
326
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
435
                set_client_prop_ms("ApprovalDelay",
 
436
                                   options.approval_delay)
327
437
            if options.approval_duration is not None:
328
 
                client.Set(client_interface, "ApprovalDuration",
329
 
                           timedelta_to_milliseconds
330
 
                           (string_to_delta(options.
331
 
                                            approval_duration)),
332
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
438
                set_client_prop_ms("ApprovalDuration",
 
439
                                   options.approval_duration)
333
440
            if options.timeout is not None:
334
 
                client.Set(client_interface, "Timeout",
335
 
                           timedelta_to_milliseconds
336
 
                           (string_to_delta(options.timeout)),
337
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
441
                set_client_prop_ms("Timeout", options.timeout)
338
442
            if options.extended_timeout is not None:
339
 
                client.Set(client_interface, "ExtendedTimeout",
340
 
                           timedelta_to_milliseconds
341
 
                           (string_to_delta(options.extended_timeout)),
342
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
443
                set_client_prop_ms("ExtendedTimeout",
 
444
                                   options.extended_timeout)
343
445
            if options.secret is not None:
344
 
                client.Set(client_interface, "Secret",
345
 
                           dbus.ByteArray(options.secret.read()),
346
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
446
                set_client_prop("Secret",
 
447
                                dbus.ByteArray(options.secret.read()))
347
448
            if options.approved_by_default is not None:
348
 
                client.Set(client_interface, "ApprovedByDefault",
349
 
                           dbus.Boolean(options
350
 
                                        .approved_by_default),
351
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
449
                set_client_prop("ApprovedByDefault",
 
450
                                dbus.Boolean(options
 
451
                                             .approved_by_default))
352
452
            if options.approve:
353
453
                client.Approve(dbus.Boolean(True),
354
454
                               dbus_interface=client_interface)