/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: teddy at bsnet
  • Date: 2011-02-15 19:27:23 UTC
  • mto: (237.7.13 mandos)
  • mto: This revision was merged to the branch mainline in revision 282.
  • Revision ID: teddy@fukt.bsnet.se-20110215192723-qpftjhlvzadm5cjc
* mandos-ctl: Use unicode string literals.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
 
1
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8 -*-
 
3
# 
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
5
# 
 
6
# Copyright © 2008-2010 Teddy Hogeborn
 
7
# Copyright © 2008-2010 Björn Påhlsson
 
8
# 
 
9
# This program is free software: you can redistribute it and/or modify
 
10
# it under the terms of the GNU General Public License as published by
 
11
# the Free Software Foundation, either version 3 of the License, or
 
12
# (at your option) any later version.
 
13
#
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
#     GNU General Public License for more details.
 
18
# 
 
19
# You should have received a copy of the GNU General Public License
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
21
# 
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# 
 
24
 
 
25
from __future__ import division, absolute_import, unicode_literals
 
26
 
 
27
import sys
 
28
import dbus
 
29
from optparse import OptionParser
 
30
import locale
 
31
import datetime
 
32
import re
 
33
import os
 
34
 
 
35
locale.setlocale(locale.LC_ALL, "")
 
36
 
 
37
tablewords = {
 
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",
 
54
    }
 
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"
 
62
 
 
63
def timedelta_to_milliseconds(td):
 
64
    """Convert a datetime.timedelta object to milliseconds"""
 
65
    return ((td.days * 24 * 60 * 60 * 1000)
 
66
            + (td.seconds * 1000)
 
67
            + (td.microseconds // 1000))
 
68
 
 
69
def milliseconds_to_string(ms):
 
70
    td = datetime.timedelta(0, 0, 0, ms)
 
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,
 
76
                })
 
77
 
 
78
 
 
79
def string_to_delta(interval):
 
80
    """Parse a string and return a datetime.timedelta
 
81
 
 
82
    >>> string_to_delta("7d")
 
83
    datetime.timedelta(7)
 
84
    >>> string_to_delta("60s")
 
85
    datetime.timedelta(0, 60)
 
86
    >>> string_to_delta("60m")
 
87
    datetime.timedelta(0, 3600)
 
88
    >>> string_to_delta("24h")
 
89
    datetime.timedelta(1)
 
90
    >>> string_to_delta("1w")
 
91
    datetime.timedelta(7)
 
92
    >>> string_to_delta("5m 30s")
 
93
    datetime.timedelta(0, 330)
 
94
    """
 
95
    timevalue = datetime.timedelta(0)
 
96
    regexp = re.compile("\d+[dsmhw]")
 
97
    
 
98
    for s in regexp.findall(interval):
 
99
        try:
 
100
            suffix = unicode(s[-1])
 
101
            value = int(s[:-1])
 
102
            if suffix == "d":
 
103
                delta = datetime.timedelta(value)
 
104
            elif suffix == "s":
 
105
                delta = datetime.timedelta(0, value)
 
106
            elif suffix == "m":
 
107
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
108
            elif suffix == "h":
 
109
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
110
            elif suffix == "w":
 
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
 
 
119
def print_clients(clients, keywords):
 
120
    def valuetostring(value, keyword):
 
121
        if type(value) is dbus.Boolean:
 
122
            return "Yes" if value else "No"
 
123
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
124
                       "ApprovalDuration"):
 
125
            return milliseconds_to_string(value)
 
126
        return unicode(value)
 
127
    
 
128
    # Create format string to print table rows
 
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)
 
136
    # Print header line
 
137
    print format_string % tuple(tablewords[key] for key in keywords)
 
138
    for client in clients:
 
139
        print format_string % tuple(valuetostring(client[key], key)
 
140
                                    for key in keywords)
 
141
 
 
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,
 
153
                options.approved_by_default is not None,
 
154
                options.approval_delay is not None,
 
155
                options.approval_duration is not None,
 
156
                options.host is not None,
 
157
                options.secret is not None,
 
158
                options.approve,
 
159
                options.deny))
 
160
        
 
161
def main():
 
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")
 
205
        options, client_names = parser.parse_args()
 
206
        
 
207
        if has_actions(options) and not client_names and not options.all:
 
208
            parser.error("Options require clients names or --all.")
 
209
        if options.verbose and has_actions(options):
 
210
            parser.error("--verbose can only be used alone or with"
 
211
                         " --all.")
 
212
        if options.all and not has_actions(options):
 
213
            parser.error("--all requires an action.")
 
214
        
 
215
        try:
 
216
            bus = dbus.SystemBus()
 
217
            mandos_dbus_objc = bus.get_object(busname, server_path)
 
218
        except dbus.exceptions.DBusException:
 
219
            print >> sys.stderr, "Could not connect to Mandos server"
 
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:
 
238
            print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
 
239
            sys.exit(1)
 
240
            
 
241
        # Compile dict of (clients: properties) to process
 
242
        clients={}
 
243
        
 
244
        if options.all or not client_names:
 
245
            clients = dict((bus.get_object(busname, path), properties)
 
246
                           for path, properties in
 
247
                           mandos_clients.iteritems())
 
248
        else:
 
249
            for name in client_names:
 
250
                for path, client in mandos_clients.iteritems():
 
251
                    if client["Name"] == name:
 
252
                        client_objc = bus.get_object(busname, path)
 
253
                        clients[client_objc] = client
 
254
                        break
 
255
                else:
 
256
                    print >> sys.stderr, "Client not found on server: %r" % name
 
257
                    sys.exit(1)
 
258
            
 
259
        if not has_actions(options) and clients:
 
260
            if options.verbose:
 
261
                keywords = ("Name", "Enabled", "Timeout",
 
262
                            "LastCheckedOK", "Created", "Interval",
 
263
                            "Host", "Fingerprint", "CheckerRunning",
 
264
                            "LastEnabled", "ApprovalPending",
 
265
                            "ApprovedByDefault",
 
266
                            "LastApprovalRequest", "ApprovalDelay",
 
267
                            "ApprovalDuration", "Checker")
 
268
            else:
 
269
                keywords = defaultkeywords
 
270
            
 
271
            print_clients(clients.values(), keywords)
 
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,
 
289
                                             "Enabled",
 
290
                                             dbus_interface=dbus.PROPERTIES_IFACE)
 
291
                             else 1)
 
292
                if options.checker:
 
293
                    client.Set(client_interface, "Checker", options.checker,
 
294
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
295
                if options.host:
 
296
                    client.Set(client_interface, "Host", options.host,
 
297
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
298
                if options.interval:
 
299
                    client.Set(client_interface, "Interval",
 
300
                               timedelta_to_milliseconds
 
301
                               (string_to_delta(options.interval)),
 
302
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
303
                if options.approval_delay:
 
304
                    client.Set(client_interface, "ApprovalDelay",
 
305
                               timedelta_to_milliseconds
 
306
                               (string_to_delta(options.
 
307
                                                approval_delay)),
 
308
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
309
                if options.approval_duration:
 
310
                    client.Set(client_interface, "ApprovalDuration",
 
311
                               timedelta_to_milliseconds
 
312
                               (string_to_delta(options.
 
313
                                                approval_duration)),
 
314
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
315
                if options.timeout:
 
316
                    client.Set(client_interface, "Timeout",
 
317
                               timedelta_to_milliseconds
 
318
                               (string_to_delta(options.timeout)),
 
319
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
320
                if options.secret:
 
321
                    client.Set(client_interface, "Secret",
 
322
                               dbus.ByteArray(open(options.secret,
 
323
                                                   "rb").read()),
 
324
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
325
                if options.approved_by_default is not None:
 
326
                    client.Set(client_interface, "ApprovedByDefault",
 
327
                               dbus.Boolean(options
 
328
                                            .approved_by_default),
 
329
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
330
                if options.approve:
 
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)
 
336
 
 
337
if __name__ == "__main__":
 
338
    main()