/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
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
25
from __future__ import division
24.1.119 by Björn Påhlsson
Added more method support for mandos clients through mandos-ctl
26
import sys
24.1.116 by Björn Påhlsson
added a mandos list client program
27
import dbus
28
from optparse import OptionParser
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
29
import locale
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
30
import datetime
31
import re
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
32
import os
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
33
34
locale.setlocale(locale.LC_ALL, u'')
24.1.116 by Björn Påhlsson
added a mandos list client program
35
36
tablewords = {
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
37
    'Name': u'Name',
38
    'Enabled': u'Enabled',
39
    'Timeout': u'Timeout',
40
    'LastCheckedOK': u'Last Successful Check',
237.2.206 by Teddy Hogeborn
* mandos-ctl: Also show "LastApprovalRequest" property.
41
    'LastApprovalRequest': u'Last Approval Request',
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
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',
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
48
    'ApprovalPending': u'Approval Is Pending',
49
    'ApprovedByDefault': u'Approved By Default',
50
    'ApprovalDelay': u"Approval Delay",
51
    'ApprovalDuration': u"Approval Duration",
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
52
    'Checker': u'Checker',
24.1.116 by Björn Påhlsson
added a mandos list client program
53
    }
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
54
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
24.1.130 by Björn Påhlsson
new domain name for d-bus
55
domain = 'se.bsnet.fukt'
56
busname = domain + '.Mandos'
57
server_path = '/'
58
server_interface = domain + '.Mandos'
59
client_interface = domain + '.Mandos.Client'
279 by Teddy Hogeborn
* Makefile (version): Changed to "1.2.2".
60
version = "1.2.2"
24.1.118 by Björn Påhlsson
Added enable/disable
61
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
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))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
67
68
def milliseconds_to_string(ms):
69
    td = datetime.timedelta(0, 0, 0, ms)
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
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
                })
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
76
77
78
def string_to_delta(interval):
79
    """Parse a string and return a datetime.timedelta
80
81
    >>> string_to_delta('7d')
82
    datetime.timedelta(7)
83
    >>> string_to_delta('60s')
84
    datetime.timedelta(0, 60)
85
    >>> string_to_delta('60m')
86
    datetime.timedelta(0, 3600)
87
    >>> string_to_delta('24h')
88
    datetime.timedelta(1)
89
    >>> string_to_delta(u'1w')
90
    datetime.timedelta(7)
91
    >>> string_to_delta('5m 30s')
92
    datetime.timedelta(0, 330)
93
    """
94
    timevalue = datetime.timedelta(0)
95
    regexp = re.compile("\d+[dsmhw]")
96
    
97
    for s in regexp.findall(interval):
98
        try:
99
            suffix = unicode(s[-1])
100
            value = int(s[:-1])
101
            if suffix == u"d":
102
                delta = datetime.timedelta(value)
103
            elif suffix == u"s":
104
                delta = datetime.timedelta(0, value)
105
            elif suffix == u"m":
106
                delta = datetime.timedelta(0, 0, 0, 0, value)
107
            elif suffix == u"h":
108
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
109
            elif suffix == u"w":
110
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
111
            else:
112
                raise ValueError
113
        except (ValueError, IndexError):
114
            raise ValueError
115
        timevalue += delta
116
    return timevalue
117
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
118
def print_clients(clients, keywords):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
119
    def valuetostring(value, keyword):
120
        if type(value) is dbus.Boolean:
121
            return u"Yes" if value else u"No"
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
122
        if keyword in (u"Timeout", u"Interval", u"ApprovalDelay",
123
                       u"ApprovalDuration"):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
124
            return milliseconds_to_string(value)
125
        return unicode(value)
126
    
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
127
    # Create format string to print table rows
24.1.118 by Björn Påhlsson
Added enable/disable
128
    format_string = u' '.join(u'%%-%ds' %
129
                              max(len(tablewords[key]),
237.2.185 by Teddy Hogeborn
Rename all D-Bus properties to conform to D-Bus naming conventions;
130
                                  max(len(valuetostring(client[key],
131
                                                        key))
24.1.118 by Björn Påhlsson
Added enable/disable
132
                                      for client in
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
133
                                      clients))
24.1.118 by Björn Påhlsson
Added enable/disable
134
                              for key in keywords)
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
135
    # Print header line
237.2.118 by Teddy Hogeborn
* mandos: White-space fixes only.
136
    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
137
    for client in clients:
138
        print format_string % tuple(valuetostring(client[key], key)
24.1.118 by Björn Påhlsson
Added enable/disable
139
                                    for key in keywords)
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
140
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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,
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
152
                options.approved_by_default is not None,
153
                options.approval_delay is not None,
154
                options.approval_duration is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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")
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
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")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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()
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
205
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
206
        if has_actions(options) and not client_names and not options.all:
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
207
            parser.error('Options require clients names or --all.')
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
208
        if options.verbose and has_actions(options):
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
209
            parser.error('--verbose can only be used alone or with'
210
                         ' --all.')
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
211
        if options.all and not has_actions(options):
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
212
            parser.error('--all requires an action.')
213
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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)
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
            
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
240
	# Compile dict of (clients: properties) to process
241
	clients={}
242
        
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
243
        if options.all or not client_names:
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
244
            clients = dict((bus.get_object(busname, path), properties)
245
                           for path, properties in
246
                           mandos_clients.iteritems())
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
247
        else:
248
            for name in client_names:
249
                for path, client in mandos_clients.iteritems():
24.1.164 by Björn Påhlsson
merge
250
                    if client['Name'] == name:
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
251
                        client_objc = bus.get_object(busname, path)
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
252
                        clients[client_objc] = client
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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:
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
260
	        keywords = ('Name', 'Enabled', 'Timeout',
261
                            'LastCheckedOK', 'Created', 'Interval',
262
                            'Host', 'Fingerprint', 'CheckerRunning',
263
                            'LastEnabled', 'ApprovalPending',
237.2.206 by Teddy Hogeborn
* mandos-ctl: Also show "LastApprovalRequest" property.
264
                            'ApprovedByDefault',
265
                            'LastApprovalRequest', 'ApprovalDelay',
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
266
                            'ApprovalDuration', 'Checker')
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
267
            else:
268
                keywords = defaultkeywords
237.2.206 by Teddy Hogeborn
* mandos-ctl: Also show "LastApprovalRequest" property.
269
            
237.2.200 by Teddy Hogeborn
* mandos-ctl: Bug fix: only show properties of specifies clients.
270
	    print_clients(clients.values(), keywords)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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,
24.1.164 by Björn Påhlsson
merge
288
                                             u"Enabled",
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
289
                                             dbus_interface=dbus.PROPERTIES_IFACE)
290
                             else 1)
291
                if options.checker:
24.1.164 by Björn Påhlsson
merge
292
                    client.Set(client_interface, u"Checker", options.checker,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
293
                               dbus_interface=dbus.PROPERTIES_IFACE)
294
                if options.host:
24.1.164 by Björn Påhlsson
merge
295
                    client.Set(client_interface, u"Host", options.host,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
296
                               dbus_interface=dbus.PROPERTIES_IFACE)
297
                if options.interval:
24.1.164 by Björn Påhlsson
merge
298
                    client.Set(client_interface, u"Interval",
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
299
                               timedelta_to_milliseconds
300
                               (string_to_delta(options.interval)),
301
                               dbus_interface=dbus.PROPERTIES_IFACE)
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
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)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
314
                if options.timeout:
24.1.164 by Björn Påhlsson
merge
315
                    client.Set(client_interface, u"Timeout",
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
316
                               timedelta_to_milliseconds
317
                               (string_to_delta(options.timeout)),
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
318
                               dbus_interface=dbus.PROPERTIES_IFACE)
319
                if options.secret:
24.1.164 by Björn Påhlsson
merge
320
                    client.Set(client_interface, u"Secret",
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
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),
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
328
                               dbus_interface=dbus.PROPERTIES_IFACE)
329
                if options.approve:
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
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)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
335
336
if __name__ == '__main__':
337
    main()