/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: 2016-02-28 14:22:10 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160228142210-2df89dih7mzxxr0h
Update copyright year.

* DBUS-API: Update copyright year.
* debian/copyright: - '' -
* intro.xml (COPYRIGHT): - '' -
* mandos: - '' -
* mandos-clients.conf.xml (COPYRIGHT): - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml (COPYRIGHT): - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml (COPYRIGHT): - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml (COPYRIGHT): - '' -
* mandos.conf.xml (COPYRIGHT): - '' -
* mandos.xml (COPYRIGHT): - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml (COPYRIGHT): - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml (COPYRIGHT): - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml (COPYRIGHT): - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml (COPYRIGHT): - ''
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml (COPYRIGHT): - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml (COPYRIGHT): - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml (COPYRIGHT): - '' -

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.0"
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.1"
 
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)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}".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
 
    format_string = " ".join("%%-%ds" %
125
 
                             max(len(tablewords[key]),
126
 
                                 max(len(valuetostring(client[key],
127
 
                                                       key))
128
 
                                     for client in
129
 
                                     clients))
 
239
    format_string = " ".join("{{{key}:{width}}}".format(
 
240
        width = max(len(tablewords[key]),
 
241
                    max(len(valuetostring(client[key], key))
 
242
                        for client in clients)),
 
243
        key = key)
130
244
                             for key in keywords)
131
245
    # Print header line
132
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
246
    print(format_string.format(**tablewords))
133
247
    for client in clients:
134
 
        print(format_string % tuple(valuetostring(client[key], key)
135
 
                                    for key in keywords))
 
248
        print(format_string.format(**{
 
249
            key: valuetostring(client[key], key)
 
250
            for key in keywords }))
 
251
 
136
252
 
137
253
def has_actions(options):
138
254
    return any((options.enable,
154
270
                options.approve,
155
271
                options.deny))
156
272
 
 
273
 
157
274
def main():
158
275
    parser = argparse.ArgumentParser()
159
276
    parser.add_argument("--version", action="version",
160
 
                        version = "%%prog %s" % version,
 
277
                        version = "%(prog)s {}".format(version),
161
278
                        help="show version number and exit")
162
279
    parser.add_argument("-a", "--all", action="store_true",
163
280
                        help="Select all clients")
196
313
    parser.add_argument("--approval-duration",
197
314
                        help="Set duration of one client approval")
198
315
    parser.add_argument("-H", "--host", help="Set host for client")
199
 
    parser.add_argument("-s", "--secret", type=file,
 
316
    parser.add_argument("-s", "--secret",
 
317
                        type=argparse.FileType(mode="rb"),
200
318
                        help="Set password blob (file) for client")
201
319
    parser.add_argument("-A", "--approve", action="store_true",
202
320
                        help="Approve any current client request")
203
321
    parser.add_argument("-D", "--deny", action="store_true",
204
322
                        help="Deny any current client request")
 
323
    parser.add_argument("--check", action="store_true",
 
324
                        help="Run self-test")
205
325
    parser.add_argument("client", nargs="*", help="Client name")
206
326
    options = parser.parse_args()
207
327
    
208
 
    if has_actions(options) and not options.client and not options.all:
 
328
    if has_actions(options) and not (options.client or options.all):
209
329
        parser.error("Options require clients names or --all.")
210
330
    if options.verbose and has_actions(options):
211
331
        parser.error("--verbose can only be used alone or with"
212
332
                     " --all.")
213
333
    if options.all and not has_actions(options):
214
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)
215
339
    
216
340
    try:
217
341
        bus = dbus.SystemBus()
218
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
219
343
    except dbus.exceptions.DBusException:
220
 
        print("Could not connect to Mandos server",
221
 
              file=sys.stderr)
 
344
        print("Could not connect to Mandos server", file=sys.stderr)
222
345
        sys.exit(1)
223
346
    
224
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
225
348
                                 dbus_interface = server_interface)
 
349
    mandos_serv_object_manager = dbus.Interface(
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
226
351
    
227
352
    #block stderr since dbus library prints to stderr
228
353
    null = os.open(os.path.devnull, os.O_RDWR)
231
356
    os.close(null)
232
357
    try:
233
358
        try:
234
 
            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 }
235
364
        finally:
236
365
            #restore stderr
237
366
            os.dup2(stderrcopy, sys.stderr.fileno())
238
367
            os.close(stderrcopy)
239
 
    except dbus.exceptions.DBusException:
240
 
        print("Access denied: Accessing mandos server through dbus.",
241
 
              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)
242
371
        sys.exit(1)
243
372
    
244
373
    # Compile dict of (clients: properties) to process
245
374
    clients={}
246
375
    
247
376
    if options.all or not options.client:
248
 
        clients = dict((bus.get_object(busname, path), properties)
249
 
                       for path, properties in
250
 
                       mandos_clients.iteritems())
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
251
379
    else:
252
380
        for name in options.client:
253
 
            for path, client in mandos_clients.iteritems():
 
381
            for path, client in mandos_clients.items():
254
382
                if client["Name"] == name:
255
383
                    client_objc = bus.get_object(busname, path)
256
384
                    clients[client_objc] = client
257
385
                    break
258
386
            else:
259
 
                print("Client not found on server: %r" % name,
260
 
                      file=sys.stderr)
 
387
                print("Client not found on server: {!r}"
 
388
                      .format(name), file=sys.stderr)
261
389
                sys.exit(1)
262
390
    
263
391
    if not has_actions(options) and clients:
264
392
        if options.verbose:
265
 
            keywords = ("Name", "Enabled", "Timeout",
266
 
                        "LastCheckedOK", "Created", "Interval",
267
 
                        "Host", "Fingerprint", "CheckerRunning",
268
 
                        "LastEnabled", "ApprovalPending",
269
 
                        "ApprovedByDefault",
 
393
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
270
397
                        "LastApprovalRequest", "ApprovalDelay",
271
398
                        "ApprovalDuration", "Checker",
272
399
                        "ExtendedTimeout")
277
404
    else:
278
405
        # Process each client in the list by all selected options
279
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
            
280
420
            if options.remove:
281
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
282
422
            if options.enable:
283
 
                client.Enable(dbus_interface=client_interface)
 
423
                set_client_prop("Enabled", dbus.Boolean(True))
284
424
            if options.disable:
285
 
                client.Disable(dbus_interface=client_interface)
 
425
                set_client_prop("Enabled", dbus.Boolean(False))
286
426
            if options.bump_timeout:
287
 
                client.CheckedOK(dbus_interface=client_interface)
 
427
                set_client_prop("LastCheckedOK", "")
288
428
            if options.start_checker:
289
 
                client.StartChecker(dbus_interface=client_interface)
 
429
                set_client_prop("CheckerRunning", dbus.Boolean(True))
290
430
            if options.stop_checker:
291
 
                client.StopChecker(dbus_interface=client_interface)
 
431
                set_client_prop("CheckerRunning", dbus.Boolean(False))
292
432
            if options.is_enabled:
293
433
                sys.exit(0 if client.Get(client_interface,
294
434
                                         "Enabled",
296
436
                                         dbus.PROPERTIES_IFACE)
297
437
                         else 1)
298
438
            if options.checker is not None:
299
 
                client.Set(client_interface, "Checker",
300
 
                           options.checker,
301
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
439
                set_client_prop("Checker", options.checker)
302
440
            if options.host is not None:
303
 
                client.Set(client_interface, "Host", options.host,
304
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
441
                set_client_prop("Host", options.host)
305
442
            if options.interval is not None:
306
 
                client.Set(client_interface, "Interval",
307
 
                           timedelta_to_milliseconds
308
 
                           (string_to_delta(options.interval)),
309
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
443
                set_client_prop_ms("Interval", options.interval)
310
444
            if options.approval_delay is not None:
311
 
                client.Set(client_interface, "ApprovalDelay",
312
 
                           timedelta_to_milliseconds
313
 
                           (string_to_delta(options.
314
 
                                            approval_delay)),
315
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
445
                set_client_prop_ms("ApprovalDelay",
 
446
                                   options.approval_delay)
316
447
            if options.approval_duration is not None:
317
 
                client.Set(client_interface, "ApprovalDuration",
318
 
                           timedelta_to_milliseconds
319
 
                           (string_to_delta(options.
320
 
                                            approval_duration)),
321
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
448
                set_client_prop_ms("ApprovalDuration",
 
449
                                   options.approval_duration)
322
450
            if options.timeout is not None:
323
 
                client.Set(client_interface, "Timeout",
324
 
                           timedelta_to_milliseconds
325
 
                           (string_to_delta(options.timeout)),
326
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
451
                set_client_prop_ms("Timeout", options.timeout)
327
452
            if options.extended_timeout is not None:
328
 
                client.Set(client_interface, "ExtendedTimeout",
329
 
                           timedelta_to_milliseconds
330
 
                           (string_to_delta(options.extended_timeout)),
331
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
453
                set_client_prop_ms("ExtendedTimeout",
 
454
                                   options.extended_timeout)
332
455
            if options.secret is not None:
333
 
                client.Set(client_interface, "Secret",
334
 
                           dbus.ByteArray(options.secret.read()),
335
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
456
                set_client_prop("Secret",
 
457
                                dbus.ByteArray(options.secret.read()))
336
458
            if options.approved_by_default is not None:
337
 
                client.Set(client_interface, "ApprovedByDefault",
338
 
                           dbus.Boolean(options
339
 
                                        .approved_by_default),
340
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
459
                set_client_prop("ApprovedByDefault",
 
460
                                dbus.Boolean(options
 
461
                                             .approved_by_default))
341
462
            if options.approve:
342
463
                client.Approve(dbus.Boolean(True),
343
464
                               dbus_interface=client_interface)
345
466
                client.Approve(dbus.Boolean(False),
346
467
                               dbus_interface=client_interface)
347
468
 
 
469
 
348
470
if __name__ == "__main__":
349
471
    main()