/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
24.1.116 by Björn Påhlsson
added a mandos list client program
1
#!/usr/bin/python
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
2
# -*- mode: python; coding: utf-8 -*-
237.2.207 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
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
25
from __future__ import (division, absolute_import, print_function,
26
                        unicode_literals)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
27
24.1.119 by Björn Påhlsson
Added more method support for mandos clients through mandos-ctl
28
import sys
24.1.116 by Björn Påhlsson
added a mandos list client program
29
import dbus
30
from optparse import OptionParser
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
31
import locale
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
32
import datetime
33
import re
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
34
import os
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
35
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
36
locale.setlocale(locale.LC_ALL, "")
24.1.116 by Björn Påhlsson
added a mandos list client program
37
38
tablewords = {
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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",
24.1.116 by Björn Påhlsson
added a mandos list client program
55
    }
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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"
283 by Teddy Hogeborn
* Makefile (version): Changed to "1.3.0".
62
version = "1.3.0"
24.1.118 by Björn Påhlsson
Added enable/disable
63
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
64
def timedelta_to_milliseconds(td):
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
65
    """Convert a datetime.timedelta object to milliseconds"""
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
66
    return ((td.days * 24 * 60 * 60 * 1000)
67
            + (td.seconds * 1000)
68
            + (td.microseconds // 1000))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
69
70
def milliseconds_to_string(ms):
71
    td = datetime.timedelta(0, 0, 0, ms)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
72
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
73
            % { "days": "%dT" % td.days if td.days else "",
74
                "hours": td.seconds // 3600,
75
                "minutes": (td.seconds % 3600) // 60,
76
                "seconds": td.seconds % 60,
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
77
                })
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
78
79
80
def string_to_delta(interval):
81
    """Parse a string and return a datetime.timedelta
82
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
83
    >>> string_to_delta("7d")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
84
    datetime.timedelta(7)
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
85
    >>> string_to_delta("60s")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
86
    datetime.timedelta(0, 60)
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
87
    >>> string_to_delta("60m")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
88
    datetime.timedelta(0, 3600)
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
89
    >>> string_to_delta("24h")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
90
    datetime.timedelta(1)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
91
    >>> string_to_delta("1w")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
92
    datetime.timedelta(7)
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
93
    >>> string_to_delta("5m 30s")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
94
    datetime.timedelta(0, 330)
95
    """
96
    timevalue = datetime.timedelta(0)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
97
    regexp = re.compile("\d+[dsmhw]")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
98
    
99
    for s in regexp.findall(interval):
100
        try:
101
            suffix = unicode(s[-1])
102
            value = int(s[:-1])
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
103
            if suffix == "d":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
104
                delta = datetime.timedelta(value)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
105
            elif suffix == "s":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
106
                delta = datetime.timedelta(0, value)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
107
            elif suffix == "m":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
108
                delta = datetime.timedelta(0, 0, 0, 0, value)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
109
            elif suffix == "h":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
110
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
111
            elif suffix == "w":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
112
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
113
            else:
114
                raise ValueError
115
        except (ValueError, IndexError):
116
            raise ValueError
117
        timevalue += delta
118
    return timevalue
119
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
120
def print_clients(clients, keywords):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
121
    def valuetostring(value, keyword):
122
        if type(value) is dbus.Boolean:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
123
            return "Yes" if value else "No"
124
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
125
                       "ApprovalDuration"):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
126
            return milliseconds_to_string(value)
127
        return unicode(value)
128
    
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
129
    # Create format string to print table rows
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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)
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
137
    # Print header line
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
138
    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
139
    for client in clients:
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
140
        print(format_string % tuple(valuetostring(client[key], key)
141
                                    for key in keywords))
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
142
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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,
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
154
                options.approved_by_default is not None,
155
                options.approval_delay is not None,
156
                options.approval_duration is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
157
                options.host is not None,
158
                options.secret is not None,
159
                options.approve,
160
                options.deny))
161
        
162
def main():
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
206
	options, client_names = parser.parse_args()
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
207
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
208
        if has_actions(options) and not client_names and not options.all:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
209
            parser.error("Options require clients names or --all.")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
210
        if options.verbose and has_actions(options):
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
211
            parser.error("--verbose can only be used alone or with"
212
                         " --all.")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
213
        if options.all and not has_actions(options):
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
214
            parser.error("--all requires an action.")
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
215
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
216
        try:
217
            bus = dbus.SystemBus()
218
            mandos_dbus_objc = bus.get_object(busname, server_path)
219
        except dbus.exceptions.DBusException:
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
220
            print("Could not connect to Mandos server",
221
                  file=sys.stderr)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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:
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
240
            print("Access denied: Accessing mandos server through dbus.",
241
                  file=sys.stderr)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
242
            sys.exit(1)
243
            
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
244
	# Compile dict of (clients: properties) to process
245
	clients={}
246
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
247
        if options.all or not client_names:
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
248
            clients = dict((bus.get_object(busname, path), properties)
249
                           for path, properties in
250
                           mandos_clients.iteritems())
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
251
        else:
252
            for name in client_names:
253
                for path, client in mandos_clients.iteritems():
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
254
                    if client["Name"] == name:
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
255
                        client_objc = bus.get_object(busname, path)
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
256
                        clients[client_objc] = client
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
257
                        break
258
                else:
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
259
                    print("Client not found on server: %r" % name,
260
                          file=sys.stderr)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
261
                    sys.exit(1)
262
            
263
	if not has_actions(options) and clients:
264
	    if options.verbose:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
265
	        keywords = ("Name", "Enabled", "Timeout",
266
                            "LastCheckedOK", "Created", "Interval",
267
                            "Host", "Fingerprint", "CheckerRunning",
268
                            "LastEnabled", "ApprovalPending",
269
                            "ApprovedByDefault",
270
                            "LastApprovalRequest", "ApprovalDelay",
271
                            "ApprovalDuration", "Checker")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
272
            else:
273
                keywords = defaultkeywords
237.2.206 by Teddy Hogeborn
* mandos-ctl: Also show "LastApprovalRequest" property.
274
            
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
275
	    print_clients(clients.values(), keywords)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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,
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
293
                                             "Enabled",
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
294
                                             dbus_interface=dbus.PROPERTIES_IFACE)
295
                             else 1)
296
                if options.checker:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
297
                    client.Set(client_interface, "Checker", options.checker,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
298
                               dbus_interface=dbus.PROPERTIES_IFACE)
299
                if options.host:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
300
                    client.Set(client_interface, "Host", options.host,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
301
                               dbus_interface=dbus.PROPERTIES_IFACE)
302
                if options.interval:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
303
                    client.Set(client_interface, "Interval",
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
304
                               timedelta_to_milliseconds
305
                               (string_to_delta(options.interval)),
306
                               dbus_interface=dbus.PROPERTIES_IFACE)
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
307
                if options.approval_delay:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
308
                    client.Set(client_interface, "ApprovalDelay",
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
309
                               timedelta_to_milliseconds
310
                               (string_to_delta(options.
311
                                                approval_delay)),
312
                               dbus_interface=dbus.PROPERTIES_IFACE)
313
                if options.approval_duration:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
314
                    client.Set(client_interface, "ApprovalDuration",
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
315
                               timedelta_to_milliseconds
316
                               (string_to_delta(options.
317
                                                approval_duration)),
318
                               dbus_interface=dbus.PROPERTIES_IFACE)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
319
                if options.timeout:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
320
                    client.Set(client_interface, "Timeout",
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
321
                               timedelta_to_milliseconds
322
                               (string_to_delta(options.timeout)),
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
323
                               dbus_interface=dbus.PROPERTIES_IFACE)
324
                if options.secret:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
325
                    client.Set(client_interface, "Secret",
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
326
                               dbus.ByteArray(open(options.secret,
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
327
                                                   "rb").read()),
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
328
                               dbus_interface=dbus.PROPERTIES_IFACE)
329
                if options.approved_by_default is not None:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
330
                    client.Set(client_interface, "ApprovedByDefault",
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
331
                               dbus.Boolean(options
332
                                            .approved_by_default),
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
333
                               dbus_interface=dbus.PROPERTIES_IFACE)
334
                if options.approve:
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
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)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
340
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
341
if __name__ == "__main__":
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
342
    main()