/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-20 14:37:17 UTC
  • mfrom: (237.4.31 release)
  • Revision ID: teddy@recompile.se-20120520143717-48406ypmuwgwl32f
Merge from release branch.

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-2010 Teddy Hogeborn
7
 
# Copyright © 2008-2010 Björn Påhlsson
 
6
# Copyright © 2008-2012 Teddy Hogeborn
 
7
# Copyright © 2008-2012 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
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
24
25
 
25
26
from __future__ import (division, absolute_import, print_function,
26
27
                        unicode_literals)
27
28
 
 
29
from future_builtins import *
 
30
 
28
31
import sys
29
32
import dbus
30
 
from optparse import OptionParser
 
33
import argparse
31
34
import locale
32
35
import datetime
33
36
import re
52
55
    "ApprovalDelay": "Approval Delay",
53
56
    "ApprovalDuration": "Approval Duration",
54
57
    "Checker": "Checker",
 
58
    "ExtendedTimeout" : "Extended Timeout"
55
59
    }
56
60
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
57
 
domain = "se.bsnet.fukt"
 
61
domain = "se.recompile"
58
62
busname = domain + ".Mandos"
59
63
server_path = "/"
60
64
server_interface = domain + ".Mandos"
61
65
client_interface = domain + ".Mandos.Client"
62
 
version = "1.2.3"
 
66
version = "1.5.4"
63
67
 
64
68
def timedelta_to_milliseconds(td):
65
69
    """Convert a datetime.timedelta object to milliseconds"""
69
73
 
70
74
def milliseconds_to_string(ms):
71
75
    td = datetime.timedelta(0, 0, 0, ms)
72
 
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
73
 
            % { "days": "%dT" % td.days if td.days else "",
74
 
                "hours": td.seconds // 3600,
75
 
                "minutes": (td.seconds % 3600) // 60,
76
 
                "seconds": td.seconds % 60,
77
 
                })
78
 
 
 
76
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
77
            .format(days = "{0}T".format(td.days) if td.days else "",
 
78
                    hours = td.seconds // 3600,
 
79
                    minutes = (td.seconds % 3600) // 60,
 
80
                    seconds = td.seconds % 60,
 
81
                    ))
79
82
 
80
83
def string_to_delta(interval):
81
84
    """Parse a string and return a datetime.timedelta
82
 
 
 
85
    
83
86
    >>> string_to_delta("7d")
84
87
    datetime.timedelta(7)
85
88
    >>> string_to_delta("60s")
93
96
    >>> string_to_delta("5m 30s")
94
97
    datetime.timedelta(0, 330)
95
98
    """
96
 
    timevalue = datetime.timedelta(0)
97
 
    regexp = re.compile("\d+[dsmhw]")
 
99
    value = datetime.timedelta(0)
 
100
    regexp = re.compile("(\d+)([dsmhw]?)")
98
101
    
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
 
102
    for num, suffix in regexp.findall(interval):
 
103
        if suffix == "d":
 
104
            value += datetime.timedelta(int(num))
 
105
        elif suffix == "s":
 
106
            value += datetime.timedelta(0, int(num))
 
107
        elif suffix == "m":
 
108
            value += datetime.timedelta(0, 0, 0, 0, int(num))
 
109
        elif suffix == "h":
 
110
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
 
111
        elif suffix == "w":
 
112
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
 
113
        elif suffix == "":
 
114
            value += datetime.timedelta(0, 0, 0, int(num))
 
115
    return value
119
116
 
120
117
def print_clients(clients, keywords):
121
118
    def valuetostring(value, keyword):
122
119
        if type(value) is dbus.Boolean:
123
120
            return "Yes" if value else "No"
124
121
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
125
 
                       "ApprovalDuration"):
 
122
                       "ApprovalDuration", "ExtendedTimeout"):
126
123
            return milliseconds_to_string(value)
127
124
        return unicode(value)
128
125
    
129
126
    # 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)
 
127
    format_string = " ".join("{{{key}:{width}}}".format(
 
128
            width = max(len(tablewords[key]),
 
129
                        max(len(valuetostring(client[key],
 
130
                                              key))
 
131
                            for client in
 
132
                            clients)),
 
133
            key = key) for key in keywords)
137
134
    # Print header line
138
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
135
    print(format_string.format(**tablewords))
139
136
    for client in clients:
140
 
        print(format_string % tuple(valuetostring(client[key], key)
141
 
                                    for key in keywords))
 
137
        print(format_string.format(**dict((key,
 
138
                                           valuetostring(client[key],
 
139
                                                         key))
 
140
                                          for key in keywords)))
142
141
 
143
142
def has_actions(options):
144
143
    return any((options.enable,
150
149
                options.remove,
151
150
                options.checker is not None,
152
151
                options.timeout is not None,
 
152
                options.extended_timeout is not None,
153
153
                options.interval is not None,
154
154
                options.approved_by_default is not None,
155
155
                options.approval_delay is not None,
158
158
                options.secret is not None,
159
159
                options.approve,
160
160
                options.deny))
161
 
        
 
161
 
162
162
def main():
163
 
        parser = OptionParser(version = "%%prog %s" % version)
164
 
        parser.add_option("-a", "--all", action="store_true",
165
 
                          help="Select all clients")
166
 
        parser.add_option("-v", "--verbose", action="store_true",
167
 
                          help="Print all fields")
168
 
        parser.add_option("-e", "--enable", action="store_true",
169
 
                          help="Enable client")
170
 
        parser.add_option("-d", "--disable", action="store_true",
171
 
                          help="disable client")
172
 
        parser.add_option("-b", "--bump-timeout", action="store_true",
173
 
                          help="Bump timeout for client")
174
 
        parser.add_option("--start-checker", action="store_true",
175
 
                          help="Start checker for client")
176
 
        parser.add_option("--stop-checker", action="store_true",
177
 
                          help="Stop checker for client")
178
 
        parser.add_option("-V", "--is-enabled", action="store_true",
179
 
                          help="Check if client is enabled")
180
 
        parser.add_option("-r", "--remove", action="store_true",
181
 
                          help="Remove client")
182
 
        parser.add_option("-c", "--checker", type="string",
183
 
                          help="Set checker command for client")
184
 
        parser.add_option("-t", "--timeout", type="string",
185
 
                          help="Set timeout for client")
186
 
        parser.add_option("-i", "--interval", type="string",
187
 
                          help="Set checker interval for client")
188
 
        parser.add_option("--approve-by-default", action="store_true",
189
 
                          dest="approved_by_default",
190
 
                          help="Set client to be approved by default")
191
 
        parser.add_option("--deny-by-default", action="store_false",
192
 
                          dest="approved_by_default",
193
 
                          help="Set client to be denied by default")
194
 
        parser.add_option("--approval-delay", type="string",
195
 
                          help="Set delay before client approve/deny")
196
 
        parser.add_option("--approval-duration", type="string",
197
 
                          help="Set duration of one client approval")
198
 
        parser.add_option("-H", "--host", type="string",
199
 
                          help="Set host for client")
200
 
        parser.add_option("-s", "--secret", type="string",
201
 
                          help="Set password blob (file) for client")
202
 
        parser.add_option("-A", "--approve", action="store_true",
203
 
                          help="Approve any current client request")
204
 
        parser.add_option("-D", "--deny", action="store_true",
205
 
                          help="Deny any current client request")
206
 
        options, client_names = parser.parse_args()
207
 
        
208
 
        if has_actions(options) and not client_names and not options.all:
209
 
            parser.error("Options require clients names or --all.")
210
 
        if options.verbose and has_actions(options):
211
 
            parser.error("--verbose can only be used alone or with"
212
 
                         " --all.")
213
 
        if options.all and not has_actions(options):
214
 
            parser.error("--all requires an action.")
215
 
        
216
 
        try:
217
 
            bus = dbus.SystemBus()
218
 
            mandos_dbus_objc = bus.get_object(busname, server_path)
219
 
        except dbus.exceptions.DBusException:
220
 
            print("Could not connect to Mandos server",
221
 
                  file=sys.stderr)
222
 
            sys.exit(1)
223
 
    
224
 
        mandos_serv = dbus.Interface(mandos_dbus_objc,
225
 
                                     dbus_interface = server_interface)
226
 
 
227
 
        #block stderr since dbus library prints to stderr
228
 
        null = os.open(os.path.devnull, os.O_RDWR)
229
 
        stderrcopy = os.dup(sys.stderr.fileno())
230
 
        os.dup2(null, sys.stderr.fileno())
231
 
        os.close(null)
232
 
        try:
233
 
            try:
234
 
                mandos_clients = mandos_serv.GetAllClientsWithProperties()
235
 
            finally:
236
 
                #restore stderr
237
 
                os.dup2(stderrcopy, sys.stderr.fileno())
238
 
                os.close(stderrcopy)
239
 
        except dbus.exceptions.DBusException, e:
240
 
            print("Access denied: Accessing mandos server through dbus.",
241
 
                  file=sys.stderr)
242
 
            sys.exit(1)
243
 
            
244
 
        # Compile dict of (clients: properties) to process
245
 
        clients={}
246
 
        
247
 
        if options.all or not client_names:
248
 
            clients = dict((bus.get_object(busname, path), properties)
249
 
                           for path, properties in
250
 
                           mandos_clients.iteritems())
251
 
        else:
252
 
            for name in client_names:
253
 
                for path, client in mandos_clients.iteritems():
254
 
                    if client["Name"] == name:
255
 
                        client_objc = bus.get_object(busname, path)
256
 
                        clients[client_objc] = client
257
 
                        break
258
 
                else:
259
 
                    print("Client not found on server: %r" % name,
260
 
                          file=sys.stderr)
261
 
                    sys.exit(1)
262
 
            
263
 
        if not has_actions(options) and clients:
264
 
            if options.verbose:
265
 
                keywords = ("Name", "Enabled", "Timeout",
266
 
                            "LastCheckedOK", "Created", "Interval",
267
 
                            "Host", "Fingerprint", "CheckerRunning",
268
 
                            "LastEnabled", "ApprovalPending",
269
 
                            "ApprovedByDefault",
270
 
                            "LastApprovalRequest", "ApprovalDelay",
271
 
                            "ApprovalDuration", "Checker")
 
163
    parser = argparse.ArgumentParser()
 
164
    parser.add_argument("--version", action="version",
 
165
                        version = "%(prog)s {0}".format(version),
 
166
                        help="show version number and exit")
 
167
    parser.add_argument("-a", "--all", action="store_true",
 
168
                        help="Select all clients")
 
169
    parser.add_argument("-v", "--verbose", action="store_true",
 
170
                        help="Print all fields")
 
171
    parser.add_argument("-e", "--enable", action="store_true",
 
172
                        help="Enable client")
 
173
    parser.add_argument("-d", "--disable", action="store_true",
 
174
                        help="disable client")
 
175
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
176
                        help="Bump timeout for client")
 
177
    parser.add_argument("--start-checker", action="store_true",
 
178
                        help="Start checker for client")
 
179
    parser.add_argument("--stop-checker", action="store_true",
 
180
                        help="Stop checker for client")
 
181
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
182
                        help="Check if client is enabled")
 
183
    parser.add_argument("-r", "--remove", action="store_true",
 
184
                        help="Remove client")
 
185
    parser.add_argument("-c", "--checker",
 
186
                        help="Set checker command for client")
 
187
    parser.add_argument("-t", "--timeout",
 
188
                        help="Set timeout for client")
 
189
    parser.add_argument("--extended-timeout",
 
190
                        help="Set extended timeout for client")
 
191
    parser.add_argument("-i", "--interval",
 
192
                        help="Set checker interval for client")
 
193
    parser.add_argument("--approve-by-default", action="store_true",
 
194
                        default=None, dest="approved_by_default",
 
195
                        help="Set client to be approved by default")
 
196
    parser.add_argument("--deny-by-default", action="store_false",
 
197
                        dest="approved_by_default",
 
198
                        help="Set client to be denied by default")
 
199
    parser.add_argument("--approval-delay",
 
200
                        help="Set delay before client approve/deny")
 
201
    parser.add_argument("--approval-duration",
 
202
                        help="Set duration of one client approval")
 
203
    parser.add_argument("-H", "--host", help="Set host for client")
 
204
    parser.add_argument("-s", "--secret", type=file,
 
205
                        help="Set password blob (file) for client")
 
206
    parser.add_argument("-A", "--approve", action="store_true",
 
207
                        help="Approve any current client request")
 
208
    parser.add_argument("-D", "--deny", action="store_true",
 
209
                        help="Deny any current client request")
 
210
    parser.add_argument("client", nargs="*", help="Client name")
 
211
    options = parser.parse_args()
 
212
    
 
213
    if has_actions(options) and not (options.client or options.all):
 
214
        parser.error("Options require clients names or --all.")
 
215
    if options.verbose and has_actions(options):
 
216
        parser.error("--verbose can only be used alone or with"
 
217
                     " --all.")
 
218
    if options.all and not has_actions(options):
 
219
        parser.error("--all requires an action.")
 
220
    
 
221
    try:
 
222
        bus = dbus.SystemBus()
 
223
        mandos_dbus_objc = bus.get_object(busname, server_path)
 
224
    except dbus.exceptions.DBusException:
 
225
        print("Could not connect to Mandos server",
 
226
              file=sys.stderr)
 
227
        sys.exit(1)
 
228
    
 
229
    mandos_serv = dbus.Interface(mandos_dbus_objc,
 
230
                                 dbus_interface = server_interface)
 
231
    
 
232
    #block stderr since dbus library prints to stderr
 
233
    null = os.open(os.path.devnull, os.O_RDWR)
 
234
    stderrcopy = os.dup(sys.stderr.fileno())
 
235
    os.dup2(null, sys.stderr.fileno())
 
236
    os.close(null)
 
237
    try:
 
238
        try:
 
239
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
240
        finally:
 
241
            #restore stderr
 
242
            os.dup2(stderrcopy, sys.stderr.fileno())
 
243
            os.close(stderrcopy)
 
244
    except dbus.exceptions.DBusException:
 
245
        print("Access denied: Accessing mandos server through dbus.",
 
246
              file=sys.stderr)
 
247
        sys.exit(1)
 
248
    
 
249
    # Compile dict of (clients: properties) to process
 
250
    clients={}
 
251
    
 
252
    if options.all or not options.client:
 
253
        clients = dict((bus.get_object(busname, path), properties)
 
254
                       for path, properties in
 
255
                       mandos_clients.iteritems())
 
256
    else:
 
257
        for name in options.client:
 
258
            for path, client in mandos_clients.iteritems():
 
259
                if client["Name"] == name:
 
260
                    client_objc = bus.get_object(busname, path)
 
261
                    clients[client_objc] = client
 
262
                    break
272
263
            else:
273
 
                keywords = defaultkeywords
274
 
            
275
 
            print_clients(clients.values(), keywords)
 
264
                print("Client not found on server: {0!r}"
 
265
                      .format(name), file=sys.stderr)
 
266
                sys.exit(1)
 
267
    
 
268
    if not has_actions(options) and clients:
 
269
        if options.verbose:
 
270
            keywords = ("Name", "Enabled", "Timeout",
 
271
                        "LastCheckedOK", "Created", "Interval",
 
272
                        "Host", "Fingerprint", "CheckerRunning",
 
273
                        "LastEnabled", "ApprovalPending",
 
274
                        "ApprovedByDefault",
 
275
                        "LastApprovalRequest", "ApprovalDelay",
 
276
                        "ApprovalDuration", "Checker",
 
277
                        "ExtendedTimeout")
276
278
        else:
277
 
            # Process each client in the list by all selected options
278
 
            for client in clients:
279
 
                if options.remove:
280
 
                    mandos_serv.RemoveClient(client.__dbus_object_path__)
281
 
                if options.enable:
282
 
                    client.Enable(dbus_interface=client_interface)
283
 
                if options.disable:
284
 
                    client.Disable(dbus_interface=client_interface)
285
 
                if options.bump_timeout:
286
 
                    client.CheckedOK(dbus_interface=client_interface)
287
 
                if options.start_checker:
288
 
                    client.StartChecker(dbus_interface=client_interface)
289
 
                if options.stop_checker:
290
 
                    client.StopChecker(dbus_interface=client_interface)
291
 
                if options.is_enabled:
292
 
                    sys.exit(0 if client.Get(client_interface,
293
 
                                             "Enabled",
294
 
                                             dbus_interface=dbus.PROPERTIES_IFACE)
295
 
                             else 1)
296
 
                if options.checker:
297
 
                    client.Set(client_interface, "Checker", options.checker,
298
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
299
 
                if options.host:
300
 
                    client.Set(client_interface, "Host", options.host,
301
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
302
 
                if options.interval:
303
 
                    client.Set(client_interface, "Interval",
304
 
                               timedelta_to_milliseconds
305
 
                               (string_to_delta(options.interval)),
306
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
307
 
                if options.approval_delay:
308
 
                    client.Set(client_interface, "ApprovalDelay",
309
 
                               timedelta_to_milliseconds
310
 
                               (string_to_delta(options.
311
 
                                                approval_delay)),
312
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
313
 
                if options.approval_duration:
314
 
                    client.Set(client_interface, "ApprovalDuration",
315
 
                               timedelta_to_milliseconds
316
 
                               (string_to_delta(options.
317
 
                                                approval_duration)),
318
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
319
 
                if options.timeout:
320
 
                    client.Set(client_interface, "Timeout",
321
 
                               timedelta_to_milliseconds
322
 
                               (string_to_delta(options.timeout)),
323
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
324
 
                if options.secret:
325
 
                    client.Set(client_interface, "Secret",
326
 
                               dbus.ByteArray(open(options.secret,
327
 
                                                   "rb").read()),
328
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
329
 
                if options.approved_by_default is not None:
330
 
                    client.Set(client_interface, "ApprovedByDefault",
331
 
                               dbus.Boolean(options
332
 
                                            .approved_by_default),
333
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
334
 
                if options.approve:
335
 
                    client.Approve(dbus.Boolean(True),
336
 
                                   dbus_interface=client_interface)
337
 
                elif options.deny:
338
 
                    client.Approve(dbus.Boolean(False),
339
 
                                   dbus_interface=client_interface)
 
279
            keywords = defaultkeywords
 
280
        
 
281
        print_clients(clients.values(), keywords)
 
282
    else:
 
283
        # Process each client in the list by all selected options
 
284
        for client in clients:
 
285
            def set_client_prop(prop, value):
 
286
                """Set a Client D-Bus property"""
 
287
                client.Set(client_interface, prop, value,
 
288
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
289
            def set_client_prop_ms(prop, value):
 
290
                """Set a Client D-Bus property, converted
 
291
                from a string to milliseconds."""
 
292
                set_client_prop(prop,
 
293
                                timedelta_to_milliseconds
 
294
                                (string_to_delta(value)))
 
295
            if options.remove:
 
296
                mandos_serv.RemoveClient(client.__dbus_object_path__)
 
297
            if options.enable:
 
298
                set_client_prop("Enabled", dbus.Boolean(True))
 
299
            if options.disable:
 
300
                set_client_prop("Enabled", dbus.Boolean(False))
 
301
            if options.bump_timeout:
 
302
                set_client_prop("LastCheckedOK", "")
 
303
            if options.start_checker:
 
304
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
305
            if options.stop_checker:
 
306
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
307
            if options.is_enabled:
 
308
                sys.exit(0 if client.Get(client_interface,
 
309
                                         "Enabled",
 
310
                                         dbus_interface=
 
311
                                         dbus.PROPERTIES_IFACE)
 
312
                         else 1)
 
313
            if options.checker is not None:
 
314
                set_client_prop("Checker", options.checker)
 
315
            if options.host is not None:
 
316
                set_client_prop("Host", options.host)
 
317
            if options.interval is not None:
 
318
                set_client_prop_ms("Interval", options.interval)
 
319
            if options.approval_delay is not None:
 
320
                set_client_prop_ms("ApprovalDelay",
 
321
                                   options.approval_delay)
 
322
            if options.approval_duration is not None:
 
323
                set_client_prop_ms("ApprovalDuration",
 
324
                                   options.approval_duration)
 
325
            if options.timeout is not None:
 
326
                set_client_prop_ms("Timeout", options.timeout)
 
327
            if options.extended_timeout is not None:
 
328
                set_client_prop_ms("ExtendedTimeout",
 
329
                                   options.extended_timeout)
 
330
            if options.secret is not None:
 
331
                set_client_prop("Secret",
 
332
                                dbus.ByteArray(options.secret.read()))
 
333
            if options.approved_by_default is not None:
 
334
                set_client_prop("ApprovedByDefault",
 
335
                                dbus.Boolean(options
 
336
                                             .approved_by_default))
 
337
            if options.approve:
 
338
                client.Approve(dbus.Boolean(True),
 
339
                               dbus_interface=client_interface)
 
340
            elif options.deny:
 
341
                client.Approve(dbus.Boolean(False),
 
342
                               dbus_interface=client_interface)
340
343
 
341
344
if __name__ == "__main__":
342
345
    main()