/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: 2014-07-24 01:35:55 UTC
  • Revision ID: teddy@recompile.se-20140724013555-zrgds2ft5cmwhugb
Fix two mutually cancelling bugs.

* mandos (rfc3339_duration_to_delta): Set "token_duration" to be a
                                      token (and not a tuple) by
                                      removing the final comma.
                                      Construct the needed tuple later
                                      when initializing the
                                      "followers" variable.
* mandos-ctl (rfc3339_duration_to_delta): - '' -

Show diffs side-by-side

added added

removed removed

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