/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-05 09:17:34 UTC
  • mto: This revision was merged to the branch mainline in revision 570.
  • 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-2018 Teddy Hogeborn
7
 
# Copyright © 2008-2018 Björn Påhlsson
8
 
#
9
 
# This file is part of Mandos.
10
 
#
11
 
# Mandos is free software: you can redistribute it and/or modify it
12
 
# under the terms of the GNU General Public License as published by
 
5
# 
 
6
# Copyright © 2008-2012 Teddy Hogeborn
 
7
# Copyright © 2008-2012 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
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
17
#     GNU General Public License for more details.
20
 
#
 
18
# 
21
19
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
23
 
#
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
21
# 
24
22
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
23
# 
26
24
 
27
25
from __future__ import (division, absolute_import, print_function,
28
26
                        unicode_literals)
29
27
 
30
 
try:
31
 
    from future_builtins import *
32
 
except ImportError:
33
 
    pass
34
 
 
35
28
import sys
 
29
import dbus
36
30
import argparse
37
31
import locale
38
32
import datetime
39
33
import re
40
34
import os
41
 
import collections
42
 
import json
43
 
 
44
 
import dbus
45
 
 
46
 
if sys.version_info.major == 2:
47
 
    str = unicode
48
35
 
49
36
locale.setlocale(locale.LC_ALL, "")
50
37
 
65
52
    "ApprovalDelay": "Approval Delay",
66
53
    "ApprovalDuration": "Approval Duration",
67
54
    "Checker": "Checker",
68
 
    "ExtendedTimeout": "Extended Timeout",
69
 
    "Expires": "Expires",
70
 
    "LastCheckerStatus": "Last Checker Status",
71
 
}
 
55
    "ExtendedTimeout" : "Extended Timeout"
 
56
    }
72
57
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
73
58
domain = "se.recompile"
74
59
busname = domain + ".Mandos"
75
60
server_path = "/"
76
61
server_interface = domain + ".Mandos"
77
62
client_interface = domain + ".Mandos.Client"
78
 
version = "1.7.19"
79
 
 
80
 
 
81
 
try:
82
 
    dbus.OBJECT_MANAGER_IFACE
83
 
except AttributeError:
84
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
 
 
 
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))
86
70
 
87
71
def milliseconds_to_string(ms):
88
72
    td = datetime.timedelta(0, 0, 0, ms)
89
73
    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
 
 
 
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
                    ))
194
79
 
195
80
def string_to_delta(interval):
196
81
    """Parse a string and return a datetime.timedelta
197
 
 
198
 
    >>> string_to_delta('7d')
 
82
    
 
83
    >>> string_to_delta("7d")
199
84
    datetime.timedelta(7)
200
 
    >>> string_to_delta('60s')
 
85
    >>> string_to_delta("60s")
201
86
    datetime.timedelta(0, 60)
202
 
    >>> string_to_delta('60m')
 
87
    >>> string_to_delta("60m")
203
88
    datetime.timedelta(0, 3600)
204
 
    >>> string_to_delta('24h')
 
89
    >>> string_to_delta("24h")
205
90
    datetime.timedelta(1)
206
 
    >>> string_to_delta('1w')
 
91
    >>> string_to_delta("1w")
207
92
    datetime.timedelta(7)
208
 
    >>> string_to_delta('5m 30s')
 
93
    >>> string_to_delta("5m 30s")
209
94
    datetime.timedelta(0, 330)
210
95
    """
211
 
 
212
 
    try:
213
 
        return rfc3339_duration_to_delta(interval)
214
 
    except ValueError:
215
 
        pass
216
 
 
217
96
    value = datetime.timedelta(0)
218
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
219
 
 
 
97
    regexp = re.compile("(\d+)([dsmhw]?)")
 
98
    
220
99
    for num, suffix in regexp.findall(interval):
221
100
        if suffix == "d":
222
101
            value += datetime.timedelta(int(num))
232
111
            value += datetime.timedelta(0, 0, 0, int(num))
233
112
    return value
234
113
 
235
 
 
236
114
def print_clients(clients, keywords):
237
115
    def valuetostring(value, keyword):
238
116
        if type(value) is dbus.Boolean:
239
117
            return "Yes" if value else "No"
240
118
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
241
 
                       "ApprovalDuration", "ExtendedTimeout"):
 
119
                       "ApprovalDuration"):
242
120
            return milliseconds_to_string(value)
243
 
        return str(value)
244
 
 
 
121
        return unicode(value)
 
122
    
245
123
    # Create format string to print table rows
246
124
    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)
 
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)
252
131
    # Print header line
253
132
    print(format_string.format(**tablewords))
254
133
    for client in clients:
255
 
        print(format_string
256
 
              .format(**{key: valuetostring(client[key], key)
257
 
                         for key in keywords}))
258
 
 
 
134
        print(format_string.format(**dict((key,
 
135
                                           valuetostring(client[key],
 
136
                                                         key))
 
137
                                          for key in keywords)))
259
138
 
260
139
def has_actions(options):
261
140
    return any((options.enable,
277
156
                options.approve,
278
157
                options.deny))
279
158
 
280
 
 
281
159
def main():
282
160
    parser = argparse.ArgumentParser()
283
161
    parser.add_argument("--version", action="version",
284
 
                        version="%(prog)s {}".format(version),
 
162
                        version = "%(prog)s {0}".format(version),
285
163
                        help="show version number and exit")
286
164
    parser.add_argument("-a", "--all", action="store_true",
287
165
                        help="Select all clients")
288
166
    parser.add_argument("-v", "--verbose", action="store_true",
289
167
                        help="Print all fields")
290
 
    parser.add_argument("-j", "--dump-json", action="store_true",
291
 
                        help="Dump client data in JSON format")
292
168
    parser.add_argument("-e", "--enable", action="store_true",
293
169
                        help="Enable client")
294
170
    parser.add_argument("-d", "--disable", action="store_true",
322
198
    parser.add_argument("--approval-duration",
323
199
                        help="Set duration of one client approval")
324
200
    parser.add_argument("-H", "--host", help="Set host for client")
325
 
    parser.add_argument("-s", "--secret",
326
 
                        type=argparse.FileType(mode="rb"),
 
201
    parser.add_argument("-s", "--secret", type=file,
327
202
                        help="Set password blob (file) for client")
328
203
    parser.add_argument("-A", "--approve", action="store_true",
329
204
                        help="Approve any current client request")
330
205
    parser.add_argument("-D", "--deny", action="store_true",
331
206
                        help="Deny any current client request")
332
 
    parser.add_argument("--check", action="store_true",
333
 
                        help="Run self-test")
334
207
    parser.add_argument("client", nargs="*", help="Client name")
335
208
    options = parser.parse_args()
336
 
 
337
 
    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:
338
211
        parser.error("Options require clients names or --all.")
339
212
    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.")
 
213
        parser.error("--verbose can only be used alone or with"
 
214
                     " --all.")
344
215
    if options.all and not has_actions(options):
345
216
        parser.error("--all requires an action.")
346
 
 
347
 
    if options.check:
348
 
        import doctest
349
 
        fail_count, test_count = doctest.testmod()
350
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
351
 
 
 
217
    
352
218
    try:
353
219
        bus = dbus.SystemBus()
354
220
        mandos_dbus_objc = bus.get_object(busname, server_path)
355
221
    except dbus.exceptions.DBusException:
356
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
222
        print("Could not connect to Mandos server",
 
223
              file=sys.stderr)
357
224
        sys.exit(1)
358
 
 
 
225
    
359
226
    mandos_serv = dbus.Interface(mandos_dbus_objc,
360
 
                                 dbus_interface=server_interface)
361
 
    mandos_serv_object_manager = dbus.Interface(
362
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
363
 
 
364
 
    # block stderr since dbus library prints to stderr
 
227
                                 dbus_interface = server_interface)
 
228
    
 
229
    #block stderr since dbus library prints to stderr
365
230
    null = os.open(os.path.devnull, os.O_RDWR)
366
231
    stderrcopy = os.dup(sys.stderr.fileno())
367
232
    os.dup2(null, sys.stderr.fileno())
368
233
    os.close(null)
369
234
    try:
370
235
        try:
371
 
            mandos_clients = {path: ifs_and_props[client_interface]
372
 
                              for path, ifs_and_props in
373
 
                              mandos_serv_object_manager
374
 
                              .GetManagedObjects().items()
375
 
                              if client_interface in ifs_and_props}
 
236
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
376
237
        finally:
377
 
            # restore stderr
 
238
            #restore stderr
378
239
            os.dup2(stderrcopy, sys.stderr.fileno())
379
240
            os.close(stderrcopy)
380
 
    except dbus.exceptions.DBusException as e:
381
 
        print("Access denied: "
382
 
              "Accessing mandos server through D-Bus: {}".format(e),
 
241
    except dbus.exceptions.DBusException:
 
242
        print("Access denied: Accessing mandos server through dbus.",
383
243
              file=sys.stderr)
384
244
        sys.exit(1)
385
 
 
 
245
    
386
246
    # Compile dict of (clients: properties) to process
387
 
    clients = {}
388
 
 
 
247
    clients={}
 
248
    
389
249
    if options.all or not options.client:
390
 
        clients = {bus.get_object(busname, path): properties
391
 
                   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())
392
253
    else:
393
254
        for name in options.client:
394
 
            for path, client in mandos_clients.items():
 
255
            for path, client in mandos_clients.iteritems():
395
256
                if client["Name"] == name:
396
257
                    client_objc = bus.get_object(busname, path)
397
258
                    clients[client_objc] = client
398
259
                    break
399
260
            else:
400
 
                print("Client not found on server: {!r}"
 
261
                print("Client not found on server: {0!r}"
401
262
                      .format(name), file=sys.stderr)
402
263
                sys.exit(1)
403
 
 
 
264
    
404
265
    if not has_actions(options) and clients:
405
 
        if options.verbose or options.dump_json:
406
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
 
                        "Created", "Interval", "Host", "Fingerprint",
408
 
                        "CheckerRunning", "LastEnabled",
409
 
                        "ApprovalPending", "ApprovedByDefault",
 
266
        if options.verbose:
 
267
            keywords = ("Name", "Enabled", "Timeout",
 
268
                        "LastCheckedOK", "Created", "Interval",
 
269
                        "Host", "Fingerprint", "CheckerRunning",
 
270
                        "LastEnabled", "ApprovalPending",
 
271
                        "ApprovedByDefault",
410
272
                        "LastApprovalRequest", "ApprovalDelay",
411
273
                        "ApprovalDuration", "Checker",
412
 
                        "ExtendedTimeout", "Expires",
413
 
                        "LastCheckerStatus")
 
274
                        "ExtendedTimeout")
414
275
        else:
415
276
            keywords = defaultkeywords
416
 
 
417
 
        if options.dump_json:
418
 
            json.dump({client["Name"]: {key:
419
 
                                        bool(client[key])
420
 
                                        if isinstance(client[key],
421
 
                                                      dbus.Boolean)
422
 
                                        else client[key]
423
 
                                        for key in keywords}
424
 
                       for client in clients.values()},
425
 
                      fp=sys.stdout, indent=4,
426
 
                      separators=(',', ': '))
427
 
            print()
428
 
        else:
429
 
            print_clients(clients.values(), keywords)
 
277
        
 
278
        print_clients(clients.values(), keywords)
430
279
    else:
431
280
        # Process each client in the list by all selected options
432
281
        for client in clients:
433
 
 
434
282
            def set_client_prop(prop, value):
435
283
                """Set a Client D-Bus property"""
436
284
                client.Set(client_interface, prop, value,
437
285
                           dbus_interface=dbus.PROPERTIES_IFACE)
438
 
 
439
286
            def set_client_prop_ms(prop, value):
440
287
                """Set a Client D-Bus property, converted
441
288
                from a string to milliseconds."""
442
289
                set_client_prop(prop,
443
 
                                string_to_delta(value).total_seconds()
444
 
                                * 1000)
445
 
 
 
290
                                timedelta_to_milliseconds
 
291
                                (string_to_delta(value)))
446
292
            if options.remove:
447
293
                mandos_serv.RemoveClient(client.__dbus_object_path__)
448
294
            if options.enable:
456
302
            if options.stop_checker:
457
303
                set_client_prop("CheckerRunning", dbus.Boolean(False))
458
304
            if options.is_enabled:
459
 
                if client.Get(client_interface, "Enabled",
460
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
461
 
                    sys.exit(0)
462
 
                else:
463
 
                    sys.exit(1)
 
305
                sys.exit(0 if client.Get(client_interface,
 
306
                                         "Enabled",
 
307
                                         dbus_interface=
 
308
                                         dbus.PROPERTIES_IFACE)
 
309
                         else 1)
464
310
            if options.checker is not None:
465
311
                set_client_prop("Checker", options.checker)
466
312
            if options.host is not None:
492
338
                client.Approve(dbus.Boolean(False),
493
339
                               dbus_interface=client_interface)
494
340
 
495
 
 
496
341
if __name__ == "__main__":
497
342
    main()