/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

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