/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2014-07-25 22:44:20 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 321.
  • Revision ID: teddy@recompile.se-20140725224420-4a5ct2ptt0hsc92z
Require Python 2.7.

This is in preparation for the eventual move to Python 3, which will
happen as soon as all Python modules required by Mandos are available.
The mandos-ctl and mandos-monitor programs are already portable
between Python 2.6 and Python 3 without changes; this change will
bring the requirement up to Python 2.7.

* INSTALL (Prerequisites/Libraries/Mandos Server): Document
                                                   requirement of
                                                   Python 2.7; remove
                                                   Python-argparse
                                                   which is in the
                                                   Python 2.7 standard
                                                   library.
* debian/control (Source: mandos/Build-Depends-Indep): Depend on
                                                       exactly the
                                                       python2.7
                                                       package and all
                                                       the Python 2.7
                                                       versions of the
                                                       python modules.
  (Package: mandos/Depends): - '' - but still depend on python (<=2.7)
                            and the generic versions of the Python
                            modules; this is for mandos-ctl and
                            mandos-monitor, both of which are
                            compatible with Python 3, and use
                            #!/usr/bin/python.
* mandos: Use #!/usr/bin/python2.7 instead of #!/usr/bin/python.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
3
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
# 
6
 
# Copyright © 2008-2011 Teddy Hogeborn
7
 
# Copyright © 2008-2011 Björn Påhlsson
 
6
# Copyright © 2008-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[0] == 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.4.1"
 
75
version = "1.6.7"
64
76
 
65
77
def timedelta_to_milliseconds(td):
66
78
    """Convert a datetime.timedelta object to milliseconds"""
70
82
 
71
83
def milliseconds_to_string(ms):
72
84
    td = datetime.timedelta(0, 0, 0, ms)
73
 
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
74
 
            % { "days": "%dT" % td.days if td.days else "",
75
 
                "hours": td.seconds // 3600,
76
 
                "minutes": (td.seconds % 3600) // 60,
77
 
                "seconds": td.seconds % 60,
78
 
                })
 
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
 
79
191
 
80
192
def string_to_delta(interval):
81
193
    """Parse a string and return a datetime.timedelta
93
205
    >>> string_to_delta("5m 30s")
94
206
    datetime.timedelta(0, 330)
95
207
    """
96
 
    timevalue = datetime.timedelta(0)
97
 
    regexp = re.compile("\d+[dsmhw]")
98
 
    
99
 
    for s in regexp.findall(interval):
100
 
        try:
101
 
            suffix = unicode(s[-1])
102
 
            value = int(s[:-1])
103
 
            if suffix == "d":
104
 
                delta = datetime.timedelta(value)
105
 
            elif suffix == "s":
106
 
                delta = datetime.timedelta(0, value)
107
 
            elif suffix == "m":
108
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
109
 
            elif suffix == "h":
110
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
111
 
            elif suffix == "w":
112
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
113
 
            else:
114
 
                raise ValueError
115
 
        except (ValueError, IndexError):
116
 
            raise ValueError
117
 
        timevalue += delta
118
 
    return timevalue
 
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
119
231
 
120
232
def print_clients(clients, keywords):
121
233
    def valuetostring(value, keyword):
122
234
        if type(value) is dbus.Boolean:
123
235
            return "Yes" if value else "No"
124
236
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
125
 
                       "ApprovalDuration"):
 
237
                       "ApprovalDuration", "ExtendedTimeout"):
126
238
            return milliseconds_to_string(value)
127
 
        return unicode(value)
 
239
        return str(value)
128
240
    
129
241
    # Create format string to print table rows
130
 
    format_string = " ".join("%%-%ds" %
131
 
                             max(len(tablewords[key]),
132
 
                                 max(len(valuetostring(client[key],
133
 
                                                       key))
134
 
                                     for client in
135
 
                                     clients))
136
 
                             for key in keywords)
 
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)
137
249
    # Print header line
138
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
250
    print(format_string.format(**tablewords))
139
251
    for client in clients:
140
 
        print(format_string % tuple(valuetostring(client[key], key)
141
 
                                    for key in keywords))
 
252
        print(format_string.format(**dict((key,
 
253
                                           valuetostring(client[key],
 
254
                                                         key))
 
255
                                          for key in keywords)))
142
256
 
143
257
def has_actions(options):
144
258
    return any((options.enable,
163
277
def main():
164
278
    parser = argparse.ArgumentParser()
165
279
    parser.add_argument("--version", action="version",
166
 
                        version = "%%prog %s" % version,
 
280
                        version = "%(prog)s {0}".format(version),
167
281
                        help="show version number and exit")
168
282
    parser.add_argument("-a", "--all", action="store_true",
169
283
                        help="Select all clients")
202
316
    parser.add_argument("--approval-duration",
203
317
                        help="Set duration of one client approval")
204
318
    parser.add_argument("-H", "--host", help="Set host for client")
205
 
    parser.add_argument("-s", "--secret", type=file,
 
319
    parser.add_argument("-s", "--secret",
 
320
                        type=argparse.FileType(mode="rb"),
206
321
                        help="Set password blob (file) for client")
207
322
    parser.add_argument("-A", "--approve", action="store_true",
208
323
                        help="Approve any current client request")
209
324
    parser.add_argument("-D", "--deny", action="store_true",
210
325
                        help="Deny any current client request")
 
326
    parser.add_argument("--check", action="store_true",
 
327
                        help="Run self-test")
211
328
    parser.add_argument("client", nargs="*", help="Client name")
212
329
    options = parser.parse_args()
213
330
    
214
 
    if has_actions(options) and not options.client and not options.all:
 
331
    if has_actions(options) and not (options.client or options.all):
215
332
        parser.error("Options require clients names or --all.")
216
333
    if options.verbose and has_actions(options):
217
334
        parser.error("--verbose can only be used alone or with"
218
335
                     " --all.")
219
336
    if options.all and not has_actions(options):
220
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)
221
342
    
222
343
    try:
223
344
        bus = dbus.SystemBus()
242
363
            #restore stderr
243
364
            os.dup2(stderrcopy, sys.stderr.fileno())
244
365
            os.close(stderrcopy)
245
 
    except dbus.exceptions.DBusException, e:
 
366
    except dbus.exceptions.DBusException:
246
367
        print("Access denied: Accessing mandos server through dbus.",
247
368
              file=sys.stderr)
248
369
        sys.exit(1)
253
374
    if options.all or not options.client:
254
375
        clients = dict((bus.get_object(busname, path), properties)
255
376
                       for path, properties in
256
 
                       mandos_clients.iteritems())
 
377
                       mandos_clients.items())
257
378
    else:
258
379
        for name in options.client:
259
380
            for path, client in mandos_clients.iteritems():
262
383
                    clients[client_objc] = client
263
384
                    break
264
385
            else:
265
 
                print("Client not found on server: %r" % name,
266
 
                      file=sys.stderr)
 
386
                print("Client not found on server: {0!r}"
 
387
                      .format(name), file=sys.stderr)
267
388
                sys.exit(1)
268
389
    
269
390
    if not has_actions(options) and clients:
283
404
    else:
284
405
        # Process each client in the list by all selected options
285
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)))
286
417
            if options.remove:
287
418
                mandos_serv.RemoveClient(client.__dbus_object_path__)
288
419
            if options.enable:
289
 
                client.Enable(dbus_interface=client_interface)
 
420
                set_client_prop("Enabled", dbus.Boolean(True))
290
421
            if options.disable:
291
 
                client.Disable(dbus_interface=client_interface)
 
422
                set_client_prop("Enabled", dbus.Boolean(False))
292
423
            if options.bump_timeout:
293
 
                client.CheckedOK(dbus_interface=client_interface)
 
424
                set_client_prop("LastCheckedOK", "")
294
425
            if options.start_checker:
295
 
                client.StartChecker(dbus_interface=client_interface)
 
426
                set_client_prop("CheckerRunning", dbus.Boolean(True))
296
427
            if options.stop_checker:
297
 
                client.StopChecker(dbus_interface=client_interface)
 
428
                set_client_prop("CheckerRunning", dbus.Boolean(False))
298
429
            if options.is_enabled:
299
430
                sys.exit(0 if client.Get(client_interface,
300
431
                                         "Enabled",
302
433
                                         dbus.PROPERTIES_IFACE)
303
434
                         else 1)
304
435
            if options.checker is not None:
305
 
                client.Set(client_interface, "Checker",
306
 
                           options.checker,
307
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
436
                set_client_prop("Checker", options.checker)
308
437
            if options.host is not None:
309
 
                client.Set(client_interface, "Host", options.host,
310
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
438
                set_client_prop("Host", options.host)
311
439
            if options.interval is not None:
312
 
                client.Set(client_interface, "Interval",
313
 
                           timedelta_to_milliseconds
314
 
                           (string_to_delta(options.interval)),
315
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
440
                set_client_prop_ms("Interval", options.interval)
316
441
            if options.approval_delay is not None:
317
 
                client.Set(client_interface, "ApprovalDelay",
318
 
                           timedelta_to_milliseconds
319
 
                           (string_to_delta(options.
320
 
                                            approval_delay)),
321
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
442
                set_client_prop_ms("ApprovalDelay",
 
443
                                   options.approval_delay)
322
444
            if options.approval_duration is not None:
323
 
                client.Set(client_interface, "ApprovalDuration",
324
 
                           timedelta_to_milliseconds
325
 
                           (string_to_delta(options.
326
 
                                            approval_duration)),
327
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
445
                set_client_prop_ms("ApprovalDuration",
 
446
                                   options.approval_duration)
328
447
            if options.timeout is not None:
329
 
                client.Set(client_interface, "Timeout",
330
 
                           timedelta_to_milliseconds
331
 
                           (string_to_delta(options.timeout)),
332
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
448
                set_client_prop_ms("Timeout", options.timeout)
333
449
            if options.extended_timeout is not None:
334
 
                client.Set(client_interface, "ExtendedTimeout",
335
 
                           timedelta_to_milliseconds
336
 
                           (string_to_delta(options.extended_timeout)),
337
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
450
                set_client_prop_ms("ExtendedTimeout",
 
451
                                   options.extended_timeout)
338
452
            if options.secret is not None:
339
 
                client.Set(client_interface, "Secret",
340
 
                           dbus.ByteArray(open(options.secret,
341
 
                                               "rb").read()),
342
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
453
                set_client_prop("Secret",
 
454
                                dbus.ByteArray(options.secret.read()))
343
455
            if options.approved_by_default is not None:
344
 
                client.Set(client_interface, "ApprovedByDefault",
345
 
                           dbus.Boolean(options
346
 
                                        .approved_by_default),
347
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
456
                set_client_prop("ApprovedByDefault",
 
457
                                dbus.Boolean(options
 
458
                                             .approved_by_default))
348
459
            if options.approve:
349
460
                client.Approve(dbus.Boolean(True),
350
461
                               dbus_interface=client_interface)