/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 at bsnet
  • Date: 2011-02-15 19:27:23 UTC
  • mto: This revision was merged to the branch mainline in revision 465.
  • Revision ID: teddy@fukt.bsnet.se-20110215192723-qpftjhlvzadm5cjc
* mandos-ctl: Use unicode string literals.

Show diffs side-by-side

added added

removed removed

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