/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: 2012-05-06 17:23:08 UTC
  • Revision ID: teddy@recompile.se-20120506172308-xw7368koksmjmnv3
* mandos (Client.start_checker): Reworded comment.
 (MandosServer.handle_ipc): Removed dead code.

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
 
#
 
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2008-2016 Teddy Hogeborn
7
 
# Copyright © 2008-2016 Björn Påhlsson
8
 
#
 
5
# 
 
6
# Copyright © 2008-2012 Teddy Hogeborn
 
7
# Copyright © 2008-2012 Björn Påhlsson
 
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
11
11
# the Free Software Foundation, either version 3 of the License, or
15
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
16
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
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
20
# along with this program.  If not, see
21
21
# <http://www.gnu.org/licenses/>.
22
 
#
 
22
# 
23
23
# Contact the authors at <mandos@recompile.se>.
24
 
#
 
24
# 
25
25
 
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
28
 
29
 
try:
30
 
    from future_builtins import *
31
 
except ImportError:
32
 
    pass
33
 
 
34
29
import sys
 
30
import dbus
35
31
import argparse
36
32
import locale
37
33
import datetime
38
34
import re
39
35
import os
40
 
import collections
41
 
import doctest
42
 
import json
43
 
 
44
 
import dbus
45
 
 
46
 
if sys.version_info.major == 2:
47
 
    str = unicode
48
36
 
49
37
locale.setlocale(locale.LC_ALL, "")
50
38
 
65
53
    "ApprovalDelay": "Approval Delay",
66
54
    "ApprovalDuration": "Approval Duration",
67
55
    "Checker": "Checker",
68
 
    "ExtendedTimeout": "Extended Timeout",
69
 
    "Expires": "Expires",
70
 
    "LastCheckerStatus": "Last Checker Status",
71
 
}
 
56
    "ExtendedTimeout" : "Extended Timeout"
 
57
    }
72
58
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
59
domain = "se.recompile"
74
60
busname = domain + ".Mandos"
75
61
server_path = "/"
76
62
server_interface = domain + ".Mandos"
77
63
client_interface = domain + ".Mandos.Client"
78
 
version = "1.7.13"
79
 
 
80
 
 
81
 
try:
82
 
    dbus.OBJECT_MANAGER_IFACE
83
 
except AttributeError:
84
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
 
 
 
64
version = "1.5.3"
 
65
 
 
66
def timedelta_to_milliseconds(td):
 
67
    """Convert a datetime.timedelta object to milliseconds"""
 
68
    return ((td.days * 24 * 60 * 60 * 1000)
 
69
            + (td.seconds * 1000)
 
70
            + (td.microseconds // 1000))
86
71
 
87
72
def milliseconds_to_string(ms):
88
73
    td = datetime.timedelta(0, 0, 0, ms)
89
74
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
90
 
            .format(days="{}T".format(td.days) if td.days else "",
91
 
                    hours=td.seconds // 3600,
92
 
                    minutes=(td.seconds % 3600) // 60,
93
 
                    seconds=td.seconds % 60))
94
 
 
95
 
 
96
 
def rfc3339_duration_to_delta(duration):
97
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
98
 
 
99
 
    >>> rfc3339_duration_to_delta("P7D")
100
 
    datetime.timedelta(7)
101
 
    >>> rfc3339_duration_to_delta("PT60S")
102
 
    datetime.timedelta(0, 60)
103
 
    >>> rfc3339_duration_to_delta("PT60M")
104
 
    datetime.timedelta(0, 3600)
105
 
    >>> rfc3339_duration_to_delta("PT24H")
106
 
    datetime.timedelta(1)
107
 
    >>> rfc3339_duration_to_delta("P1W")
108
 
    datetime.timedelta(7)
109
 
    >>> rfc3339_duration_to_delta("PT5M30S")
110
 
    datetime.timedelta(0, 330)
111
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
112
 
    datetime.timedelta(1, 200)
113
 
    """
114
 
 
115
 
    # Parsing an RFC 3339 duration with regular expressions is not
116
 
    # possible - there would have to be multiple places for the same
117
 
    # values, like seconds.  The current code, while more esoteric, is
118
 
    # cleaner without depending on a parsing library.  If Python had a
119
 
    # built-in library for parsing we would use it, but we'd like to
120
 
    # avoid excessive use of external libraries.
121
 
 
122
 
    # New type for defining tokens, syntax, and semantics all-in-one
123
 
    Token = collections.namedtuple("Token", (
124
 
        "regexp",  # To match token; if "value" is not None, must have
125
 
                   # a "group" containing digits
126
 
        "value",   # datetime.timedelta or None
127
 
        "followers"))           # Tokens valid after this token
128
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
129
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
130
 
    token_end = Token(re.compile(r"$"), None, frozenset())
131
 
    token_second = Token(re.compile(r"(\d+)S"),
132
 
                         datetime.timedelta(seconds=1),
133
 
                         frozenset((token_end, )))
134
 
    token_minute = Token(re.compile(r"(\d+)M"),
135
 
                         datetime.timedelta(minutes=1),
136
 
                         frozenset((token_second, token_end)))
137
 
    token_hour = Token(re.compile(r"(\d+)H"),
138
 
                       datetime.timedelta(hours=1),
139
 
                       frozenset((token_minute, token_end)))
140
 
    token_time = Token(re.compile(r"T"),
141
 
                       None,
142
 
                       frozenset((token_hour, token_minute,
143
 
                                  token_second)))
144
 
    token_day = Token(re.compile(r"(\d+)D"),
145
 
                      datetime.timedelta(days=1),
146
 
                      frozenset((token_time, token_end)))
147
 
    token_month = Token(re.compile(r"(\d+)M"),
148
 
                        datetime.timedelta(weeks=4),
149
 
                        frozenset((token_day, token_end)))
150
 
    token_year = Token(re.compile(r"(\d+)Y"),
151
 
                       datetime.timedelta(weeks=52),
152
 
                       frozenset((token_month, token_end)))
153
 
    token_week = Token(re.compile(r"(\d+)W"),
154
 
                       datetime.timedelta(weeks=1),
155
 
                       frozenset((token_end, )))
156
 
    token_duration = Token(re.compile(r"P"), None,
157
 
                           frozenset((token_year, token_month,
158
 
                                      token_day, token_time,
159
 
                                      token_week)))
160
 
    # Define starting values:
161
 
    # Value so far
162
 
    value = datetime.timedelta()
163
 
    found_token = None
164
 
    # Following valid tokens
165
 
    followers = frozenset((token_duration, ))
166
 
    # String left to parse
167
 
    s = duration
168
 
    # Loop until end token is found
169
 
    while found_token is not token_end:
170
 
        # Search for any currently valid tokens
171
 
        for token in followers:
172
 
            match = token.regexp.match(s)
173
 
            if match is not None:
174
 
                # Token found
175
 
                if token.value is not None:
176
 
                    # Value found, parse digits
177
 
                    factor = int(match.group(1), 10)
178
 
                    # Add to value so far
179
 
                    value += factor * token.value
180
 
                # Strip token from string
181
 
                s = token.regexp.sub("", s, 1)
182
 
                # Go to found token
183
 
                found_token = token
184
 
                # Set valid next tokens
185
 
                followers = found_token.followers
186
 
                break
187
 
        else:
188
 
            # No currently valid tokens were found
189
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
190
 
                             .format(duration))
191
 
    # End token found
192
 
    return value
193
 
 
 
75
            .format(days = "{0}T".format(td.days) if td.days else "",
 
76
                    hours = td.seconds // 3600,
 
77
                    minutes = (td.seconds % 3600) // 60,
 
78
                    seconds = td.seconds % 60,
 
79
                    ))
194
80
 
195
81
def string_to_delta(interval):
196
82
    """Parse a string and return a datetime.timedelta
197
 
 
198
 
    >>> string_to_delta('7d')
 
83
    
 
84
    >>> string_to_delta("7d")
199
85
    datetime.timedelta(7)
200
 
    >>> string_to_delta('60s')
 
86
    >>> string_to_delta("60s")
201
87
    datetime.timedelta(0, 60)
202
 
    >>> string_to_delta('60m')
 
88
    >>> string_to_delta("60m")
203
89
    datetime.timedelta(0, 3600)
204
 
    >>> string_to_delta('24h')
 
90
    >>> string_to_delta("24h")
205
91
    datetime.timedelta(1)
206
 
    >>> string_to_delta('1w')
 
92
    >>> string_to_delta("1w")
207
93
    datetime.timedelta(7)
208
 
    >>> string_to_delta('5m 30s')
 
94
    >>> string_to_delta("5m 30s")
209
95
    datetime.timedelta(0, 330)
210
96
    """
211
 
 
212
 
    try:
213
 
        return rfc3339_duration_to_delta(interval)
214
 
    except ValueError:
215
 
        pass
216
 
 
217
97
    value = datetime.timedelta(0)
218
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
219
 
 
 
98
    regexp = re.compile("(\d+)([dsmhw]?)")
 
99
    
220
100
    for num, suffix in regexp.findall(interval):
221
101
        if suffix == "d":
222
102
            value += datetime.timedelta(int(num))
232
112
            value += datetime.timedelta(0, 0, 0, int(num))
233
113
    return value
234
114
 
235
 
 
236
115
def print_clients(clients, keywords):
237
116
    def valuetostring(value, keyword):
238
117
        if type(value) is dbus.Boolean:
240
119
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
241
120
                       "ApprovalDuration", "ExtendedTimeout"):
242
121
            return milliseconds_to_string(value)
243
 
        return str(value)
244
 
 
 
122
        return unicode(value)
 
123
    
245
124
    # Create format string to print table rows
246
125
    format_string = " ".join("{{{key}:{width}}}".format(
247
 
        width=max(len(tablewords[key]),
248
 
                  max(len(valuetostring(client[key], key))
249
 
                      for client in clients)),
250
 
        key=key)
251
 
                             for key in keywords)
 
126
            width = max(len(tablewords[key]),
 
127
                        max(len(valuetostring(client[key],
 
128
                                              key))
 
129
                            for client in
 
130
                            clients)),
 
131
            key = key) for key in keywords)
252
132
    # Print header line
253
133
    print(format_string.format(**tablewords))
254
134
    for client in clients:
255
 
        print(format_string
256
 
              .format(**{key: valuetostring(client[key], key)
257
 
                         for key in keywords}))
258
 
 
 
135
        print(format_string.format(**dict((key,
 
136
                                           valuetostring(client[key],
 
137
                                                         key))
 
138
                                          for key in keywords)))
259
139
 
260
140
def has_actions(options):
261
141
    return any((options.enable,
277
157
                options.approve,
278
158
                options.deny))
279
159
 
280
 
 
281
160
def main():
282
161
    parser = argparse.ArgumentParser()
283
162
    parser.add_argument("--version", action="version",
284
 
                        version="%(prog)s {}".format(version),
 
163
                        version = "%(prog)s {0}".format(version),
285
164
                        help="show version number and exit")
286
165
    parser.add_argument("-a", "--all", action="store_true",
287
166
                        help="Select all clients")
288
167
    parser.add_argument("-v", "--verbose", action="store_true",
289
168
                        help="Print all fields")
290
 
    parser.add_argument("-j", "--dump-json", action="store_true",
291
 
                        help="Dump client data in JSON format")
292
169
    parser.add_argument("-e", "--enable", action="store_true",
293
170
                        help="Enable client")
294
171
    parser.add_argument("-d", "--disable", action="store_true",
322
199
    parser.add_argument("--approval-duration",
323
200
                        help="Set duration of one client approval")
324
201
    parser.add_argument("-H", "--host", help="Set host for client")
325
 
    parser.add_argument("-s", "--secret",
326
 
                        type=argparse.FileType(mode="rb"),
 
202
    parser.add_argument("-s", "--secret", type=file,
327
203
                        help="Set password blob (file) for client")
328
204
    parser.add_argument("-A", "--approve", action="store_true",
329
205
                        help="Approve any current client request")
330
206
    parser.add_argument("-D", "--deny", action="store_true",
331
207
                        help="Deny any current client request")
332
 
    parser.add_argument("--check", action="store_true",
333
 
                        help="Run self-test")
334
208
    parser.add_argument("client", nargs="*", help="Client name")
335
209
    options = parser.parse_args()
336
 
 
 
210
    
337
211
    if has_actions(options) and not (options.client or options.all):
338
212
        parser.error("Options require clients names or --all.")
339
213
    if options.verbose and has_actions(options):
340
 
        parser.error("--verbose can only be used alone.")
341
 
    if options.dump_json and (options.verbose
342
 
                              or has_actions(options)):
343
 
        parser.error("--dump-json can only be used alone.")
 
214
        parser.error("--verbose can only be used alone or with"
 
215
                     " --all.")
344
216
    if options.all and not has_actions(options):
345
217
        parser.error("--all requires an action.")
346
 
 
347
 
    if options.check:
348
 
        fail_count, test_count = doctest.testmod()
349
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
350
 
 
 
218
    
351
219
    try:
352
220
        bus = dbus.SystemBus()
353
221
        mandos_dbus_objc = bus.get_object(busname, server_path)
354
222
    except dbus.exceptions.DBusException:
355
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
223
        print("Could not connect to Mandos server",
 
224
              file=sys.stderr)
356
225
        sys.exit(1)
357
 
 
 
226
    
358
227
    mandos_serv = dbus.Interface(mandos_dbus_objc,
359
 
                                 dbus_interface=server_interface)
360
 
    mandos_serv_object_manager = dbus.Interface(
361
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
362
 
 
363
 
    # block stderr since dbus library prints to stderr
 
228
                                 dbus_interface = server_interface)
 
229
    
 
230
    #block stderr since dbus library prints to stderr
364
231
    null = os.open(os.path.devnull, os.O_RDWR)
365
232
    stderrcopy = os.dup(sys.stderr.fileno())
366
233
    os.dup2(null, sys.stderr.fileno())
367
234
    os.close(null)
368
235
    try:
369
236
        try:
370
 
            mandos_clients = {path: ifs_and_props[client_interface]
371
 
                              for path, ifs_and_props in
372
 
                              mandos_serv_object_manager
373
 
                              .GetManagedObjects().items()
374
 
                              if client_interface in ifs_and_props}
 
237
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
375
238
        finally:
376
 
            # restore stderr
 
239
            #restore stderr
377
240
            os.dup2(stderrcopy, sys.stderr.fileno())
378
241
            os.close(stderrcopy)
379
 
    except dbus.exceptions.DBusException as e:
380
 
        print("Access denied: "
381
 
              "Accessing mandos server through D-Bus: {}".format(e),
 
242
    except dbus.exceptions.DBusException:
 
243
        print("Access denied: Accessing mandos server through dbus.",
382
244
              file=sys.stderr)
383
245
        sys.exit(1)
384
 
 
 
246
    
385
247
    # Compile dict of (clients: properties) to process
386
 
    clients = {}
387
 
 
 
248
    clients={}
 
249
    
388
250
    if options.all or not options.client:
389
 
        clients = {bus.get_object(busname, path): properties
390
 
                   for path, properties in mandos_clients.items()}
 
251
        clients = dict((bus.get_object(busname, path), properties)
 
252
                       for path, properties in
 
253
                       mandos_clients.iteritems())
391
254
    else:
392
255
        for name in options.client:
393
 
            for path, client in mandos_clients.items():
 
256
            for path, client in mandos_clients.iteritems():
394
257
                if client["Name"] == name:
395
258
                    client_objc = bus.get_object(busname, path)
396
259
                    clients[client_objc] = client
397
260
                    break
398
261
            else:
399
 
                print("Client not found on server: {!r}"
 
262
                print("Client not found on server: {0!r}"
400
263
                      .format(name), file=sys.stderr)
401
264
                sys.exit(1)
402
 
 
 
265
    
403
266
    if not has_actions(options) and clients:
404
 
        if options.verbose or options.dump_json:
405
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
406
 
                        "Created", "Interval", "Host", "Fingerprint",
407
 
                        "CheckerRunning", "LastEnabled",
408
 
                        "ApprovalPending", "ApprovedByDefault",
 
267
        if options.verbose:
 
268
            keywords = ("Name", "Enabled", "Timeout",
 
269
                        "LastCheckedOK", "Created", "Interval",
 
270
                        "Host", "Fingerprint", "CheckerRunning",
 
271
                        "LastEnabled", "ApprovalPending",
 
272
                        "ApprovedByDefault",
409
273
                        "LastApprovalRequest", "ApprovalDelay",
410
274
                        "ApprovalDuration", "Checker",
411
 
                        "ExtendedTimeout", "Expires",
412
 
                        "LastCheckerStatus")
 
275
                        "ExtendedTimeout")
413
276
        else:
414
277
            keywords = defaultkeywords
415
 
 
416
 
        if options.dump_json:
417
 
            json.dump({client["Name"]: {key:
418
 
                                        bool(client[key])
419
 
                                        if isinstance(client[key],
420
 
                                                      dbus.Boolean)
421
 
                                        else client[key]
422
 
                                        for key in keywords}
423
 
                       for client in clients.values()},
424
 
                      fp=sys.stdout, indent=4,
425
 
                      separators=(',', ': '))
426
 
            print()
427
 
        else:
428
 
            print_clients(clients.values(), keywords)
 
278
        
 
279
        print_clients(clients.values(), keywords)
429
280
    else:
430
281
        # Process each client in the list by all selected options
431
282
        for client in clients:
432
 
 
433
283
            def set_client_prop(prop, value):
434
284
                """Set a Client D-Bus property"""
435
285
                client.Set(client_interface, prop, value,
436
286
                           dbus_interface=dbus.PROPERTIES_IFACE)
437
 
 
438
287
            def set_client_prop_ms(prop, value):
439
288
                """Set a Client D-Bus property, converted
440
289
                from a string to milliseconds."""
441
290
                set_client_prop(prop,
442
 
                                string_to_delta(value).total_seconds()
443
 
                                * 1000)
444
 
 
 
291
                                timedelta_to_milliseconds
 
292
                                (string_to_delta(value)))
445
293
            if options.remove:
446
294
                mandos_serv.RemoveClient(client.__dbus_object_path__)
447
295
            if options.enable:
455
303
            if options.stop_checker:
456
304
                set_client_prop("CheckerRunning", dbus.Boolean(False))
457
305
            if options.is_enabled:
458
 
                if client.Get(client_interface, "Enabled",
459
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
460
 
                    sys.exit(0)
461
 
                else:
462
 
                    sys.exit(1)
 
306
                sys.exit(0 if client.Get(client_interface,
 
307
                                         "Enabled",
 
308
                                         dbus_interface=
 
309
                                         dbus.PROPERTIES_IFACE)
 
310
                         else 1)
463
311
            if options.checker is not None:
464
312
                set_client_prop("Checker", options.checker)
465
313
            if options.host is not None:
491
339
                client.Approve(dbus.Boolean(False),
492
340
                               dbus_interface=client_interface)
493
341
 
494
 
 
495
342
if __name__ == "__main__":
496
343
    main()