/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: Björn Påhlsson
  • Date: 2010-09-09 22:06:10 UTC
  • mto: (237.4.3 mandos-release)
  • mto: This revision was merged to the branch mainline in revision 421.
  • Revision ID: belorn@fukt.bsnet.se-20100909220610-fcpkaykznlq22oaw
minor debug info for plugin-runner.
Commit before merge

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
 
# 
4
 
# Mandos Monitor - Control and monitor the Mandos server
5
 
# 
6
 
# Copyright © 2008-2010 Teddy Hogeborn
7
 
# Copyright © 2008-2010 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
11
 
# the Free Software Foundation, either version 3 of the License, or
12
 
# (at your option) any later version.
13
 
#
14
 
#     This program is distributed in the hope that it will be useful,
15
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 
#     GNU General Public License for more details.
18
 
# 
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/>.
21
 
# 
22
 
# Contact the authors at <mandos@fukt.bsnet.se>.
23
 
# 
24
 
 
25
 
from __future__ import (division, absolute_import, print_function,
26
 
                        unicode_literals)
27
 
 
 
3
 
 
4
from __future__ import division
28
5
import sys
29
6
import dbus
30
7
from optparse import OptionParser
31
8
import locale
32
9
import datetime
33
10
import re
34
 
import os
35
11
 
36
 
locale.setlocale(locale.LC_ALL, "")
 
12
locale.setlocale(locale.LC_ALL, u'')
37
13
 
38
14
tablewords = {
39
 
    "Name": "Name",
40
 
    "Enabled": "Enabled",
41
 
    "Timeout": "Timeout",
42
 
    "LastCheckedOK": "Last Successful Check",
43
 
    "LastApprovalRequest": "Last Approval Request",
44
 
    "Created": "Created",
45
 
    "Interval": "Interval",
46
 
    "Host": "Host",
47
 
    "Fingerprint": "Fingerprint",
48
 
    "CheckerRunning": "Check Is Running",
49
 
    "LastEnabled": "Last Enabled",
50
 
    "ApprovalPending": "Approval Is Pending",
51
 
    "ApprovedByDefault": "Approved By Default",
52
 
    "ApprovalDelay": "Approval Delay",
53
 
    "ApprovalDuration": "Approval Duration",
54
 
    "Checker": "Checker",
 
15
    'name': u'Name',
 
16
    'enabled': u'Enabled',
 
17
    'timeout': u'Timeout',
 
18
    'last_checked_ok': u'Last Successful Check',
 
19
    'created': u'Created',
 
20
    'interval': u'Interval',
 
21
    'host': u'Host',
 
22
    'fingerprint': u'Fingerprint',
 
23
    'checker_running': u'Check Is Running',
 
24
    'last_enabled': u'Last Enabled',
 
25
    'checker': u'Checker',
55
26
    }
56
 
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
57
 
domain = "se.bsnet.fukt"
58
 
busname = domain + ".Mandos"
59
 
server_path = "/"
60
 
server_interface = domain + ".Mandos"
61
 
client_interface = domain + ".Mandos.Client"
62
 
version = "1.2.3"
 
27
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok')
 
28
domain = 'se.bsnet.fukt'
 
29
busname = domain + '.Mandos'
 
30
server_path = '/'
 
31
server_interface = domain + '.Mandos'
 
32
client_interface = domain + '.Mandos.Client'
 
33
version = "1.0.14"
 
34
try:
 
35
    bus = dbus.SystemBus()
 
36
    mandos_dbus_objc = bus.get_object(busname, server_path)
 
37
except dbus.exceptions.DBusException:
 
38
    sys.exit(1)
 
39
    
 
40
mandos_serv = dbus.Interface(mandos_dbus_objc,
 
41
                             dbus_interface = server_interface)
 
42
mandos_clients = mandos_serv.GetAllClientsWithProperties()
63
43
 
64
44
def timedelta_to_milliseconds(td):
65
 
    """Convert a datetime.timedelta object to milliseconds"""
 
45
    "Convert a datetime.timedelta object to milliseconds"
66
46
    return ((td.days * 24 * 60 * 60 * 1000)
67
47
            + (td.seconds * 1000)
68
48
            + (td.microseconds // 1000))
69
49
 
70
50
def milliseconds_to_string(ms):
71
51
    td = datetime.timedelta(0, 0, 0, ms)
72
 
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
 
52
    return (u"%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
73
53
            % { "days": "%dT" % td.days if td.days else "",
74
54
                "hours": td.seconds // 3600,
75
55
                "minutes": (td.seconds % 3600) // 60,
80
60
def string_to_delta(interval):
81
61
    """Parse a string and return a datetime.timedelta
82
62
 
83
 
    >>> string_to_delta("7d")
 
63
    >>> string_to_delta('7d')
84
64
    datetime.timedelta(7)
85
 
    >>> string_to_delta("60s")
 
65
    >>> string_to_delta('60s')
86
66
    datetime.timedelta(0, 60)
87
 
    >>> string_to_delta("60m")
 
67
    >>> string_to_delta('60m')
88
68
    datetime.timedelta(0, 3600)
89
 
    >>> string_to_delta("24h")
 
69
    >>> string_to_delta('24h')
90
70
    datetime.timedelta(1)
91
 
    >>> string_to_delta("1w")
 
71
    >>> string_to_delta(u'1w')
92
72
    datetime.timedelta(7)
93
 
    >>> string_to_delta("5m 30s")
 
73
    >>> string_to_delta('5m 30s')
94
74
    datetime.timedelta(0, 330)
95
75
    """
96
76
    timevalue = datetime.timedelta(0)
100
80
        try:
101
81
            suffix = unicode(s[-1])
102
82
            value = int(s[:-1])
103
 
            if suffix == "d":
 
83
            if suffix == u"d":
104
84
                delta = datetime.timedelta(value)
105
 
            elif suffix == "s":
 
85
            elif suffix == u"s":
106
86
                delta = datetime.timedelta(0, value)
107
 
            elif suffix == "m":
 
87
            elif suffix == u"m":
108
88
                delta = datetime.timedelta(0, 0, 0, 0, value)
109
 
            elif suffix == "h":
 
89
            elif suffix == u"h":
110
90
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
111
 
            elif suffix == "w":
 
91
            elif suffix == u"w":
112
92
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
113
93
            else:
114
94
                raise ValueError
117
97
        timevalue += delta
118
98
    return timevalue
119
99
 
120
 
def print_clients(clients, keywords):
 
100
def print_clients(clients):
121
101
    def valuetostring(value, keyword):
122
102
        if type(value) is dbus.Boolean:
123
 
            return "Yes" if value else "No"
124
 
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
125
 
                       "ApprovalDuration"):
 
103
            return u"Yes" if value else u"No"
 
104
        if keyword in (u"timeout", u"interval"):
126
105
            return milliseconds_to_string(value)
127
106
        return unicode(value)
128
107
    
129
108
    # 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)
 
109
    format_string = u' '.join(u'%%-%ds' %
 
110
                              max(len(tablewords[key]),
 
111
                                  max(len(valuetostring(client[key], key))
 
112
                                      for client in
 
113
                                      clients))
 
114
                              for key in keywords)
137
115
    # Print header line
138
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
116
    print format_string % tuple(tablewords[key] for key in keywords)
139
117
    for client in clients:
140
 
        print(format_string % tuple(valuetostring(client[key], key)
141
 
                                    for key in keywords))
142
 
 
143
 
def has_actions(options):
144
 
    return any((options.enable,
145
 
                options.disable,
146
 
                options.bump_timeout,
147
 
                options.start_checker,
148
 
                options.stop_checker,
149
 
                options.is_enabled,
150
 
                options.remove,
151
 
                options.checker is not None,
152
 
                options.timeout is not None,
153
 
                options.interval is not None,
154
 
                options.approved_by_default is not None,
155
 
                options.approval_delay is not None,
156
 
                options.approval_duration is not None,
157
 
                options.host is not None,
158
 
                options.secret is not None,
159
 
                options.approve,
160
 
                options.deny))
161
 
        
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")
272
 
            else:
273
 
                keywords = defaultkeywords
274
 
            
275
 
            print_clients(clients.values(), keywords)
276
 
        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)
340
 
 
341
 
if __name__ == "__main__":
342
 
    main()
 
118
        print format_string % tuple(valuetostring(client[key], key)
 
119
                                    for key in keywords)
 
120
 
 
121
parser = OptionParser(version = "%%prog %s" % version)
 
122
parser.add_option("-a", "--all", action="store_true",
 
123
                  help="Print all fields")
 
124
parser.add_option("-e", "--enable", action="store_true",
 
125
                  help="Enable client")
 
126
parser.add_option("-d", "--disable", action="store_true",
 
127
                  help="disable client")
 
128
parser.add_option("-b", "--bump-timeout", action="store_true",
 
129
                  help="Bump timeout for client")
 
130
parser.add_option("--start-checker", action="store_true",
 
131
                  help="Start checker for client")
 
132
parser.add_option("--stop-checker", action="store_true",
 
133
                  help="Stop checker for client")
 
134
parser.add_option("-V", "--is-enabled", action="store_true",
 
135
                  help="Check if client is enabled")
 
136
parser.add_option("-r", "--remove", action="store_true",
 
137
                  help="Remove client")
 
138
parser.add_option("-c", "--checker", type="string",
 
139
                  help="Set checker command for client")
 
140
parser.add_option("-t", "--timeout", type="string",
 
141
                  help="Set timeout for client")
 
142
parser.add_option("-i", "--interval", type="string",
 
143
                  help="Set checker interval for client")
 
144
parser.add_option("-H", "--host", type="string",
 
145
                  help="Set host for client")
 
146
parser.add_option("-s", "--secret", type="string",
 
147
                  help="Set password blob (file) for client")
 
148
parser.add_option("-A", "--approve", action="store_true",
 
149
                  help="Approve any current client request")
 
150
parser.add_option("-D", "--deny", action="store_true",
 
151
                  help="Deny any current client request")
 
152
options, client_names = parser.parse_args()
 
153
 
 
154
# Compile list of clients to process
 
155
clients=[]
 
156
for name in client_names:
 
157
    for path, client in mandos_clients.iteritems():
 
158
        if client['name'] == name:
 
159
            client_objc = bus.get_object(busname, path)
 
160
            clients.append(client_objc)
 
161
            break
 
162
    else:
 
163
        print >> sys.stderr, "Client not found on server: %r" % name
 
164
        sys.exit(1)
 
165
 
 
166
if not clients and mandos_clients.values():
 
167
    keywords = defaultkeywords
 
168
    if options.all:
 
169
        keywords = ('name', 'enabled', 'timeout', 'last_checked_ok',
 
170
                    'created', 'interval', 'host', 'fingerprint',
 
171
                    'checker_running', 'last_enabled', 'checker')
 
172
    print_clients(mandos_clients.values())
 
173
 
 
174
# Process each client in the list by all selected options
 
175
for client in clients:
 
176
    if options.remove:
 
177
        mandos_serv.RemoveClient(client.__dbus_object_path__)
 
178
    if options.enable:
 
179
        client.Enable(dbus_interface=client_interface)
 
180
    if options.disable:
 
181
        client.Disable(dbus_interface=client_interface)
 
182
    if options.bump_timeout:
 
183
        client.CheckedOK(dbus_interface=client_interface)
 
184
    if options.start_checker:
 
185
        client.StartChecker(dbus_interface=client_interface)
 
186
    if options.stop_checker:
 
187
        client.StopChecker(dbus_interface=client_interface)
 
188
    if options.is_enabled:
 
189
        sys.exit(0 if client.Get(client_interface,
 
190
                                 u"enabled",
 
191
                                 dbus_interface=dbus.PROPERTIES_IFACE)
 
192
                 else 1)
 
193
    if options.checker:
 
194
        client.Set(client_interface, u"checker", options.checker,
 
195
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
196
    if options.host:
 
197
        client.Set(client_interface, u"host", options.host,
 
198
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
199
    if options.interval:
 
200
        client.Set(client_interface, u"interval",
 
201
                   timedelta_to_milliseconds
 
202
                   (string_to_delta(options.interval)),
 
203
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
204
    if options.timeout:
 
205
        client.Set(client_interface, u"timeout",
 
206
                   timedelta_to_milliseconds(string_to_delta
 
207
                                             (options.timeout)),
 
208
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
209
    if options.secret:
 
210
        client.Set(client_interface, u"secret",
 
211
                   dbus.ByteArray(open(options.secret, u'rb').read()),
 
212
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
213
    if options.approve:
 
214
        client.Approve(dbus.Boolean(True), dbus_interface=client_interface)
 
215
    if options.deny:
 
216
        client.Approve(dbus.Boolean(False), dbus_interface=client_interface)