/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

Update copyright year to "2011" wherever appropriate.

Show diffs side-by-side

added added

removed removed

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