/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
24.1.116 by Björn Påhlsson
added a mandos list client program
1
#!/usr/bin/python
240 by Teddy Hogeborn
Merge "mandos-list" from belorn.
2
# -*- mode: python; coding: utf-8 -*-
444 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
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.1.116 by Björn Påhlsson
added a mandos list client program
24
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
25
from __future__ import division, absolute_import, unicode_literals
26
24.1.119 by Björn Påhlsson
Added more method support for mandos clients through mandos-ctl
27
import sys
24.1.116 by Björn Påhlsson
added a mandos list client program
28
import dbus
29
from optparse import OptionParser
240 by Teddy Hogeborn
Merge "mandos-list" from belorn.
30
import locale
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
31
import datetime
32
import re
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
33
import os
240 by Teddy Hogeborn
Merge "mandos-list" from belorn.
34
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
35
locale.setlocale(locale.LC_ALL, "")
24.1.116 by Björn Påhlsson
added a mandos list client program
36
37
tablewords = {
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
38
    "Name": "Name",
39
    "Enabled": "Enabled",
40
    "Timeout": "Timeout",
41
    "LastCheckedOK": "Last Successful Check",
42
    "LastApprovalRequest": "Last Approval Request",
43
    "Created": "Created",
44
    "Interval": "Interval",
45
    "Host": "Host",
46
    "Fingerprint": "Fingerprint",
47
    "CheckerRunning": "Check Is Running",
48
    "LastEnabled": "Last Enabled",
49
    "ApprovalPending": "Approval Is Pending",
50
    "ApprovedByDefault": "Approved By Default",
51
    "ApprovalDelay": "Approval Delay",
52
    "ApprovalDuration": "Approval Duration",
53
    "Checker": "Checker",
24.1.116 by Björn Påhlsson
added a mandos list client program
54
    }
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
55
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
56
domain = "se.bsnet.fukt"
57
busname = domain + ".Mandos"
58
server_path = "/"
59
server_interface = domain + ".Mandos"
60
client_interface = domain + ".Mandos.Client"
61
version = "1.2.3"
24.1.118 by Björn Påhlsson
Added enable/disable
62
382 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
63
def timedelta_to_milliseconds(td):
463.1.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
64
    """Convert a datetime.timedelta object to milliseconds"""
382 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
65
    return ((td.days * 24 * 60 * 60 * 1000)
66
            + (td.seconds * 1000)
67
            + (td.microseconds // 1000))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
68
69
def milliseconds_to_string(ms):
70
    td = datetime.timedelta(0, 0, 0, ms)
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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,
382 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
76
                })
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
77
78
79
def string_to_delta(interval):
80
    """Parse a string and return a datetime.timedelta
81
463.1.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
82
    >>> string_to_delta("7d")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
83
    datetime.timedelta(7)
463.1.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
84
    >>> string_to_delta("60s")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
85
    datetime.timedelta(0, 60)
463.1.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
86
    >>> string_to_delta("60m")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
87
    datetime.timedelta(0, 3600)
463.1.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
88
    >>> string_to_delta("24h")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
89
    datetime.timedelta(1)
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
90
    >>> string_to_delta("1w")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
91
    datetime.timedelta(7)
463.1.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
92
    >>> string_to_delta("5m 30s")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
93
    datetime.timedelta(0, 330)
94
    """
95
    timevalue = datetime.timedelta(0)
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
96
    regexp = re.compile("\d+[dsmhw]")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
97
    
98
    for s in regexp.findall(interval):
99
        try:
100
            suffix = unicode(s[-1])
101
            value = int(s[:-1])
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
102
            if suffix == "d":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
103
                delta = datetime.timedelta(value)
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
104
            elif suffix == "s":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
105
                delta = datetime.timedelta(0, value)
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
106
            elif suffix == "m":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
107
                delta = datetime.timedelta(0, 0, 0, 0, value)
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
108
            elif suffix == "h":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
109
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
110
            elif suffix == "w":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
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
118
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
119
def print_clients(clients, keywords):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
120
    def valuetostring(value, keyword):
121
        if type(value) is dbus.Boolean:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
122
            return "Yes" if value else "No"
123
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
                       "ApprovalDuration"):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
125
            return milliseconds_to_string(value)
126
        return unicode(value)
127
    
382 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
128
    # Create format string to print table rows
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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)
382 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
136
    # Print header line
355 by Teddy Hogeborn
* mandos: White-space fixes only.
137
    print format_string % tuple(tablewords[key] for key in keywords)
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
138
    for client in clients:
139
        print format_string % tuple(valuetostring(client[key], key)
24.1.118 by Björn Påhlsson
Added enable/disable
140
                                    for key in keywords)
438 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
141
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
142
def has_actions(options):
143
    return any((options.enable,
144
                options.disable,
145
                options.bump_timeout,
146
                options.start_checker,
147
                options.stop_checker,
148
                options.is_enabled,
149
                options.remove,
150
                options.checker is not None,
151
                options.timeout is not None,
152
                options.interval is not None,
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
153
                options.approved_by_default is not None,
154
                options.approval_delay is not None,
155
                options.approval_duration is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
156
                options.host is not None,
157
                options.secret is not None,
158
                options.approve,
159
                options.deny))
160
        
161
def main():
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
205
	options, client_names = parser.parse_args()
437 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
206
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
207
        if has_actions(options) and not client_names and not options.all:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
208
            parser.error("Options require clients names or --all.")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
209
        if options.verbose and has_actions(options):
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
210
            parser.error("--verbose can only be used alone or with"
211
                         " --all.")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
212
        if options.all and not has_actions(options):
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
213
            parser.error("--all requires an action.")
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
214
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
215
        try:
216
            bus = dbus.SystemBus()
217
            mandos_dbus_objc = bus.get_object(busname, server_path)
218
        except dbus.exceptions.DBusException:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
219
            print >> sys.stderr, "Could not connect to Mandos server"
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
238
            print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
239
            sys.exit(1)
240
            
437 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
241
	# Compile dict of (clients: properties) to process
242
	clients={}
243
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
244
        if options.all or not client_names:
437 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
245
            clients = dict((bus.get_object(busname, path), properties)
246
                           for path, properties in
247
                           mandos_clients.iteritems())
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
248
        else:
249
            for name in client_names:
250
                for path, client in mandos_clients.iteritems():
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
251
                    if client["Name"] == name:
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
252
                        client_objc = bus.get_object(busname, path)
437 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
253
                        clients[client_objc] = client
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
254
                        break
255
                else:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
256
                    print >> sys.stderr, "Client not found on server: %r" % name
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
257
                    sys.exit(1)
258
            
259
	if not has_actions(options) and clients:
260
	    if options.verbose:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
261
	        keywords = ("Name", "Enabled", "Timeout",
262
                            "LastCheckedOK", "Created", "Interval",
263
                            "Host", "Fingerprint", "CheckerRunning",
264
                            "LastEnabled", "ApprovalPending",
265
                            "ApprovedByDefault",
266
                            "LastApprovalRequest", "ApprovalDelay",
267
                            "ApprovalDuration", "Checker")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
268
            else:
269
                keywords = defaultkeywords
443 by Teddy Hogeborn
* mandos-ctl: Also show "LastApprovalRequest" property.
270
            
437 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
271
	    print_clients(clients.values(), keywords)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
272
        else:
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,
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
289
                                             "Enabled",
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
290
                                             dbus_interface=dbus.PROPERTIES_IFACE)
291
                             else 1)
292
                if options.checker:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
293
                    client.Set(client_interface, "Checker", options.checker,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
294
                               dbus_interface=dbus.PROPERTIES_IFACE)
295
                if options.host:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
296
                    client.Set(client_interface, "Host", options.host,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
297
                               dbus_interface=dbus.PROPERTIES_IFACE)
298
                if options.interval:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
299
                    client.Set(client_interface, "Interval",
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
300
                               timedelta_to_milliseconds
301
                               (string_to_delta(options.interval)),
302
                               dbus_interface=dbus.PROPERTIES_IFACE)
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
303
                if options.approval_delay:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
304
                    client.Set(client_interface, "ApprovalDelay",
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
305
                               timedelta_to_milliseconds
306
                               (string_to_delta(options.
307
                                                approval_delay)),
308
                               dbus_interface=dbus.PROPERTIES_IFACE)
309
                if options.approval_duration:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
310
                    client.Set(client_interface, "ApprovalDuration",
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
311
                               timedelta_to_milliseconds
312
                               (string_to_delta(options.
313
                                                approval_duration)),
314
                               dbus_interface=dbus.PROPERTIES_IFACE)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
315
                if options.timeout:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
316
                    client.Set(client_interface, "Timeout",
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
317
                               timedelta_to_milliseconds
318
                               (string_to_delta(options.timeout)),
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
319
                               dbus_interface=dbus.PROPERTIES_IFACE)
320
                if options.secret:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
321
                    client.Set(client_interface, "Secret",
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
322
                               dbus.ByteArray(open(options.secret,
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
323
                                                   "rb").read()),
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
324
                               dbus_interface=dbus.PROPERTIES_IFACE)
325
                if options.approved_by_default is not None:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
326
                    client.Set(client_interface, "ApprovedByDefault",
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
327
                               dbus.Boolean(options
328
                                            .approved_by_default),
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
329
                               dbus_interface=dbus.PROPERTIES_IFACE)
330
                if options.approve:
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
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)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
336
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
337
if __name__ == "__main__":
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
338
    main()