/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: 2011-08-08 21:12:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110808211237-jejsz5brjytrjot8
* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

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-2010 Teddy Hogeborn
 
7
# Copyright © 2008-2010 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
21
 
# <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
21
# 
23
 
# Contact the authors at <mandos@recompile.se>.
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
24
23
# 
25
24
 
26
25
from __future__ import (division, absolute_import, print_function,
27
26
                        unicode_literals)
28
27
 
29
 
from future_builtins import *
30
 
 
31
28
import sys
 
29
import dbus
32
30
import argparse
33
31
import locale
34
32
import datetime
35
33
import re
36
34
import os
37
 
import collections
38
 
import doctest
39
 
 
40
 
import dbus
41
35
 
42
36
locale.setlocale(locale.LC_ALL, "")
43
37
 
58
52
    "ApprovalDelay": "Approval Delay",
59
53
    "ApprovalDuration": "Approval Duration",
60
54
    "Checker": "Checker",
61
 
    "ExtendedTimeout" : "Extended Timeout"
62
55
    }
63
56
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
 
domain = "se.recompile"
 
57
domain = "se.bsnet.fukt"
65
58
busname = domain + ".Mandos"
66
59
server_path = "/"
67
60
server_interface = domain + ".Mandos"
68
61
client_interface = domain + ".Mandos.Client"
69
 
version = "1.6.0"
 
62
version = "1.3.1"
70
63
 
71
64
def timedelta_to_milliseconds(td):
72
65
    """Convert a datetime.timedelta object to milliseconds"""
76
69
 
77
70
def milliseconds_to_string(ms):
78
71
    td = datetime.timedelta(0, 0, 0, ms)
79
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
 
            .format(days = "{0}T".format(td.days) if td.days else "",
81
 
                    hours = td.seconds // 3600,
82
 
                    minutes = (td.seconds % 3600) // 60,
83
 
                    seconds = td.seconds % 60,
84
 
                    ))
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
 
 
 
72
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
 
73
            % { "days": "%dT" % td.days if td.days else "",
 
74
                "hours": td.seconds // 3600,
 
75
                "minutes": (td.seconds % 3600) // 60,
 
76
                "seconds": td.seconds % 60,
 
77
                })
185
78
 
186
79
def string_to_delta(interval):
187
80
    """Parse a string and return a datetime.timedelta
199
92
    >>> string_to_delta("5m 30s")
200
93
    datetime.timedelta(0, 330)
201
94
    """
202
 
    value = datetime.timedelta(0)
203
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
204
 
    
205
 
    try:
206
 
        return rfc3339_duration_to_delta(interval)
207
 
    except ValueError:
208
 
        pass
209
 
    
210
 
    for num, suffix in regexp.findall(interval):
211
 
        if suffix == "d":
212
 
            value += datetime.timedelta(int(num))
213
 
        elif suffix == "s":
214
 
            value += datetime.timedelta(0, int(num))
215
 
        elif suffix == "m":
216
 
            value += datetime.timedelta(0, 0, 0, 0, int(num))
217
 
        elif suffix == "h":
218
 
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
219
 
        elif suffix == "w":
220
 
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
221
 
        elif suffix == "":
222
 
            value += datetime.timedelta(0, 0, 0, int(num))
223
 
    return value
 
95
    timevalue = datetime.timedelta(0)
 
96
    regexp = re.compile("\d+[dsmhw]")
 
97
    
 
98
    for s in regexp.findall(interval):
 
99
        try:
 
100
            suffix = unicode(s[-1])
 
101
            value = int(s[:-1])
 
102
            if suffix == "d":
 
103
                delta = datetime.timedelta(value)
 
104
            elif suffix == "s":
 
105
                delta = datetime.timedelta(0, value)
 
106
            elif suffix == "m":
 
107
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
108
            elif suffix == "h":
 
109
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
110
            elif suffix == "w":
 
111
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
112
            else:
 
113
                raise ValueError
 
114
        except (ValueError, IndexError):
 
115
            raise ValueError
 
116
        timevalue += delta
 
117
    return timevalue
224
118
 
225
119
def print_clients(clients, keywords):
226
120
    def valuetostring(value, keyword):
227
121
        if type(value) is dbus.Boolean:
228
122
            return "Yes" if value else "No"
229
123
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
230
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
124
                       "ApprovalDuration"):
231
125
            return milliseconds_to_string(value)
232
126
        return unicode(value)
233
127
    
234
128
    # Create format string to print table rows
235
 
    format_string = " ".join("{{{key}:{width}}}".format(
236
 
            width = max(len(tablewords[key]),
237
 
                        max(len(valuetostring(client[key],
238
 
                                              key))
239
 
                            for client in
240
 
                            clients)),
241
 
            key = key) for key in keywords)
 
129
    format_string = " ".join("%%-%ds" %
 
130
                             max(len(tablewords[key]),
 
131
                                 max(len(valuetostring(client[key],
 
132
                                                       key))
 
133
                                     for client in
 
134
                                     clients))
 
135
                             for key in keywords)
242
136
    # Print header line
243
 
    print(format_string.format(**tablewords))
 
137
    print(format_string % tuple(tablewords[key] for key in keywords))
244
138
    for client in clients:
245
 
        print(format_string.format(**dict((key,
246
 
                                           valuetostring(client[key],
247
 
                                                         key))
248
 
                                          for key in keywords)))
 
139
        print(format_string % tuple(valuetostring(client[key], key)
 
140
                                    for key in keywords))
249
141
 
250
142
def has_actions(options):
251
143
    return any((options.enable,
257
149
                options.remove,
258
150
                options.checker is not None,
259
151
                options.timeout is not None,
260
 
                options.extended_timeout is not None,
261
152
                options.interval is not None,
262
153
                options.approved_by_default is not None,
263
154
                options.approval_delay is not None,
270
161
def main():
271
162
    parser = argparse.ArgumentParser()
272
163
    parser.add_argument("--version", action="version",
273
 
                        version = "%(prog)s {0}".format(version),
 
164
                        version = "%%prog %s" % version,
274
165
                        help="show version number and exit")
275
166
    parser.add_argument("-a", "--all", action="store_true",
276
167
                        help="Select all clients")
294
185
                        help="Set checker command for client")
295
186
    parser.add_argument("-t", "--timeout",
296
187
                        help="Set timeout for client")
297
 
    parser.add_argument("--extended-timeout",
298
 
                        help="Set extended timeout for client")
299
188
    parser.add_argument("-i", "--interval",
300
189
                        help="Set checker interval for client")
301
190
    parser.add_argument("--approve-by-default", action="store_true",
315
204
                        help="Approve any current client request")
316
205
    parser.add_argument("-D", "--deny", action="store_true",
317
206
                        help="Deny any current client request")
318
 
    parser.add_argument("--check", action="store_true",
319
 
                        help="Run self-test")
320
207
    parser.add_argument("client", nargs="*", help="Client name")
321
208
    options = parser.parse_args()
322
209
    
323
 
    if has_actions(options) and not (options.client or options.all):
 
210
    if has_actions(options) and not options.client and not options.all:
324
211
        parser.error("Options require clients names or --all.")
325
212
    if options.verbose and has_actions(options):
326
213
        parser.error("--verbose can only be used alone or with"
327
214
                     " --all.")
328
215
    if options.all and not has_actions(options):
329
216
        parser.error("--all requires an action.")
330
 
 
331
 
    if options.check:
332
 
        fail_count, test_count = doctest.testmod()
333
 
        sys.exit(0 if fail_count == 0 else 1)
334
217
    
335
218
    try:
336
219
        bus = dbus.SystemBus()
355
238
            #restore stderr
356
239
            os.dup2(stderrcopy, sys.stderr.fileno())
357
240
            os.close(stderrcopy)
358
 
    except dbus.exceptions.DBusException:
 
241
    except dbus.exceptions.DBusException, e:
359
242
        print("Access denied: Accessing mandos server through dbus.",
360
243
              file=sys.stderr)
361
244
        sys.exit(1)
375
258
                    clients[client_objc] = client
376
259
                    break
377
260
            else:
378
 
                print("Client not found on server: {0!r}"
379
 
                      .format(name), file=sys.stderr)
 
261
                print("Client not found on server: %r" % name,
 
262
                      file=sys.stderr)
380
263
                sys.exit(1)
381
264
    
382
265
    if not has_actions(options) and clients:
387
270
                        "LastEnabled", "ApprovalPending",
388
271
                        "ApprovedByDefault",
389
272
                        "LastApprovalRequest", "ApprovalDelay",
390
 
                        "ApprovalDuration", "Checker",
391
 
                        "ExtendedTimeout")
 
273
                        "ApprovalDuration", "Checker")
392
274
        else:
393
275
            keywords = defaultkeywords
394
276
        
396
278
    else:
397
279
        # Process each client in the list by all selected options
398
280
        for client in clients:
399
 
            def set_client_prop(prop, value):
400
 
                """Set a Client D-Bus property"""
401
 
                client.Set(client_interface, prop, value,
402
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
403
 
            def set_client_prop_ms(prop, value):
404
 
                """Set a Client D-Bus property, converted
405
 
                from a string to milliseconds."""
406
 
                set_client_prop(prop,
407
 
                                timedelta_to_milliseconds
408
 
                                (string_to_delta(value)))
409
281
            if options.remove:
410
282
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
283
            if options.enable:
412
 
                set_client_prop("Enabled", dbus.Boolean(True))
 
284
                client.Enable(dbus_interface=client_interface)
413
285
            if options.disable:
414
 
                set_client_prop("Enabled", dbus.Boolean(False))
 
286
                client.Disable(dbus_interface=client_interface)
415
287
            if options.bump_timeout:
416
 
                set_client_prop("LastCheckedOK", "")
 
288
                client.CheckedOK(dbus_interface=client_interface)
417
289
            if options.start_checker:
418
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
290
                client.StartChecker(dbus_interface=client_interface)
419
291
            if options.stop_checker:
420
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
292
                client.StopChecker(dbus_interface=client_interface)
421
293
            if options.is_enabled:
422
294
                sys.exit(0 if client.Get(client_interface,
423
295
                                         "Enabled",
424
296
                                         dbus_interface=
425
297
                                         dbus.PROPERTIES_IFACE)
426
298
                         else 1)
427
 
            if options.checker is not None:
428
 
                set_client_prop("Checker", options.checker)
429
 
            if options.host is not None:
430
 
                set_client_prop("Host", options.host)
431
 
            if options.interval is not None:
432
 
                set_client_prop_ms("Interval", options.interval)
433
 
            if options.approval_delay is not None:
434
 
                set_client_prop_ms("ApprovalDelay",
435
 
                                   options.approval_delay)
436
 
            if options.approval_duration is not None:
437
 
                set_client_prop_ms("ApprovalDuration",
438
 
                                   options.approval_duration)
439
 
            if options.timeout is not None:
440
 
                set_client_prop_ms("Timeout", options.timeout)
441
 
            if options.extended_timeout is not None:
442
 
                set_client_prop_ms("ExtendedTimeout",
443
 
                                   options.extended_timeout)
444
 
            if options.secret is not None:
445
 
                set_client_prop("Secret",
446
 
                                dbus.ByteArray(options.secret.read()))
 
299
            if options.checker:
 
300
                client.Set(client_interface, "Checker",
 
301
                           options.checker,
 
302
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
303
            if options.host:
 
304
                client.Set(client_interface, "Host", options.host,
 
305
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
306
            if options.interval:
 
307
                client.Set(client_interface, "Interval",
 
308
                           timedelta_to_milliseconds
 
309
                           (string_to_delta(options.interval)),
 
310
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
311
            if options.approval_delay:
 
312
                client.Set(client_interface, "ApprovalDelay",
 
313
                           timedelta_to_milliseconds
 
314
                           (string_to_delta(options.
 
315
                                            approval_delay)),
 
316
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
317
            if options.approval_duration:
 
318
                client.Set(client_interface, "ApprovalDuration",
 
319
                           timedelta_to_milliseconds
 
320
                           (string_to_delta(options.
 
321
                                            approval_duration)),
 
322
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
323
            if options.timeout:
 
324
                client.Set(client_interface, "Timeout",
 
325
                           timedelta_to_milliseconds
 
326
                           (string_to_delta(options.timeout)),
 
327
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
328
            if options.secret:
 
329
                client.Set(client_interface, "Secret",
 
330
                           dbus.ByteArray(open(options.secret,
 
331
                                               "rb").read()),
 
332
                           dbus_interface=dbus.PROPERTIES_IFACE)
447
333
            if options.approved_by_default is not None:
448
 
                set_client_prop("ApprovedByDefault",
449
 
                                dbus.Boolean(options
450
 
                                             .approved_by_default))
 
334
                client.Set(client_interface, "ApprovedByDefault",
 
335
                           dbus.Boolean(options
 
336
                                        .approved_by_default),
 
337
                           dbus_interface=dbus.PROPERTIES_IFACE)
451
338
            if options.approve:
452
339
                client.Approve(dbus.Boolean(True),
453
340
                               dbus_interface=client_interface)