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