/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 Hogeborn
  • Date: 2008-09-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
26
 
import sys
27
 
import dbus
28
 
from optparse import OptionParser
29
 
import locale
30
 
import datetime
31
 
import re
32
 
import os
33
 
 
34
 
locale.setlocale(locale.LC_ALL, u"")
35
 
 
36
 
tablewords = {
37
 
    u"Name": u"Name",
38
 
    u"Enabled": u"Enabled",
39
 
    u"Timeout": u"Timeout",
40
 
    u"LastCheckedOK": u"Last Successful Check",
41
 
    u"LastApprovalRequest": u"Last Approval Request",
42
 
    u"Created": u"Created",
43
 
    u"Interval": u"Interval",
44
 
    u"Host": u"Host",
45
 
    u"Fingerprint": u"Fingerprint",
46
 
    u"CheckerRunning": u"Check Is Running",
47
 
    u"LastEnabled": u"Last Enabled",
48
 
    u"ApprovalPending": u"Approval Is Pending",
49
 
    u"ApprovedByDefault": u"Approved By Default",
50
 
    u"ApprovalDelay": u"Approval Delay",
51
 
    u"ApprovalDuration": u"Approval Duration",
52
 
    u"Checker": u"Checker",
53
 
    }
54
 
defaultkeywords = (u"Name", u"Enabled", u"Timeout", u"LastCheckedOK")
55
 
domain = u"se.bsnet.fukt"
56
 
busname = domain + u".Mandos"
57
 
server_path = u"/"
58
 
server_interface = domain + u".Mandos"
59
 
client_interface = domain + u".Mandos.Client"
60
 
version = u"1.2.3"
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))
67
 
 
68
 
def milliseconds_to_string(ms):
69
 
    td = datetime.timedelta(0, 0, 0, ms)
70
 
    return (u"%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
71
 
            % { u"days": u"%dT" % td.days if td.days else u"",
72
 
                u"hours": td.seconds // 3600,
73
 
                u"minutes": (td.seconds % 3600) // 60,
74
 
                u"seconds": td.seconds % 60,
75
 
                })
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(u"\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
 
 
118
 
def print_clients(clients, keywords):
119
 
    def valuetostring(value, keyword):
120
 
        if type(value) is dbus.Boolean:
121
 
            return u"Yes" if value else u"No"
122
 
        if keyword in (u"Timeout", u"Interval", u"ApprovalDelay",
123
 
                       u"ApprovalDuration"):
124
 
            return milliseconds_to_string(value)
125
 
        return unicode(value)
126
 
    
127
 
    # Create format string to print table rows
128
 
    format_string = u" ".join(u"%%-%ds" %
129
 
                              max(len(tablewords[key]),
130
 
                                  max(len(valuetostring(client[key],
131
 
                                                        key))
132
 
                                      for client in
133
 
                                      clients))
134
 
                              for key in keywords)
135
 
    # Print header line
136
 
    print format_string % tuple(tablewords[key] for key in keywords)
137
 
    for client in clients:
138
 
        print format_string % tuple(valuetostring(client[key], key)
139
 
                                    for key in keywords)
140
 
 
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 = u"%%prog %s" % version)
162
 
        parser.add_option(u"-a", u"--all", action=u"store_true",
163
 
                          help=u"Select all clients")
164
 
        parser.add_option(u"-v", u"--verbose", action=u"store_true",
165
 
                          help=u"Print all fields")
166
 
        parser.add_option(u"-e", u"--enable", action=u"store_true",
167
 
                          help=u"Enable client")
168
 
        parser.add_option(u"-d", u"--disable", action=u"store_true",
169
 
                          help=u"disable client")
170
 
        parser.add_option(u"-b", u"--bump-timeout", action=u"store_true",
171
 
                          help=u"Bump timeout for client")
172
 
        parser.add_option(u"--start-checker", action=u"store_true",
173
 
                          help=u"Start checker for client")
174
 
        parser.add_option(u"--stop-checker", action=u"store_true",
175
 
                          help=u"Stop checker for client")
176
 
        parser.add_option(u"-V", u"--is-enabled", action=u"store_true",
177
 
                          help=u"Check if client is enabled")
178
 
        parser.add_option(u"-r", u"--remove", action=u"store_true",
179
 
                          help=u"Remove client")
180
 
        parser.add_option(u"-c", u"--checker", type=u"string",
181
 
                          help=u"Set checker command for client")
182
 
        parser.add_option(u"-t", u"--timeout", type=u"string",
183
 
                          help=u"Set timeout for client")
184
 
        parser.add_option(u"-i", u"--interval", type=u"string",
185
 
                          help=u"Set checker interval for client")
186
 
        parser.add_option(u"--approve-by-default", action=u"store_true",
187
 
                          dest=u"approved_by_default",
188
 
                          help=u"Set client to be approved by default")
189
 
        parser.add_option(u"--deny-by-default", action=u"store_false",
190
 
                          dest=u"approved_by_default",
191
 
                          help=u"Set client to be denied by default")
192
 
        parser.add_option(u"--approval-delay", type=u"string",
193
 
                          help=u"Set delay before client approve/deny")
194
 
        parser.add_option(u"--approval-duration", type=u"string",
195
 
                          help=u"Set duration of one client approval")
196
 
        parser.add_option(u"-H", u"--host", type=u"string",
197
 
                          help=u"Set host for client")
198
 
        parser.add_option(u"-s", u"--secret", type=u"string",
199
 
                          help=u"Set password blob (file) for client")
200
 
        parser.add_option(u"-A", u"--approve", action=u"store_true",
201
 
                          help=u"Approve any current client request")
202
 
        parser.add_option(u"-D", u"--deny", action=u"store_true",
203
 
                          help=u"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(u"Options require clients names or --all.")
208
 
        if options.verbose and has_actions(options):
209
 
            parser.error(u"--verbose can only be used alone or with"
210
 
                         u" --all.")
211
 
        if options.all and not has_actions(options):
212
 
            parser.error(u"--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, u"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, u"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[u"Name"] == name:
251
 
                        client_objc = bus.get_object(busname, path)
252
 
                        clients[client_objc] = client
253
 
                        break
254
 
                else:
255
 
                    print >> sys.stderr, u"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 = (u"Name", u"Enabled", u"Timeout",
261
 
                            u"LastCheckedOK", u"Created", u"Interval",
262
 
                            u"Host", u"Fingerprint", u"CheckerRunning",
263
 
                            u"LastEnabled", u"ApprovalPending",
264
 
                            u"ApprovedByDefault",
265
 
                            u"LastApprovalRequest", u"ApprovalDelay",
266
 
                            u"ApprovalDuration", u"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__ == u"__main__":
337
 
    main()