/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: teddy at bsnet
  • Date: 2011-03-15 19:15:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110315191524-jc3ajgqu2za7dcly
* mandos: Use the new argparse library instead of optparse.
* debian/control (mandos): Depend on python (<=2.7) | python-argparse

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
 
4
 
from __future__ import division
 
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, print_function,
 
26
                        unicode_literals)
 
27
 
5
28
import sys
6
29
import dbus
7
30
from optparse import OptionParser
10
33
import re
11
34
import os
12
35
 
13
 
locale.setlocale(locale.LC_ALL, u'')
 
36
locale.setlocale(locale.LC_ALL, "")
14
37
 
15
38
tablewords = {
16
 
    'Name': u'Name',
17
 
    'Enabled': u'Enabled',
18
 
    'Timeout': u'Timeout',
19
 
    'LastCheckedOK': u'Last Successful Check',
20
 
    'Created': u'Created',
21
 
    'Interval': u'Interval',
22
 
    'Host': u'Host',
23
 
    'Fingerprint': u'Fingerprint',
24
 
    'CheckerRunning': u'Check Is Running',
25
 
    'LastEnabled': u'Last Enabled',
26
 
    'Checker': u'Checker',
 
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",
27
55
    }
28
 
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
29
 
domain = 'se.bsnet.fukt'
30
 
busname = domain + '.Mandos'
31
 
server_path = '/'
32
 
server_interface = domain + '.Mandos'
33
 
client_interface = domain + '.Mandos.Client'
34
 
version = "1.0.14"
 
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"
 
62
version = "1.3.0"
35
63
 
36
64
def timedelta_to_milliseconds(td):
37
 
    "Convert a datetime.timedelta object to milliseconds"
 
65
    """Convert a datetime.timedelta object to milliseconds"""
38
66
    return ((td.days * 24 * 60 * 60 * 1000)
39
67
            + (td.seconds * 1000)
40
68
            + (td.microseconds // 1000))
41
69
 
42
70
def milliseconds_to_string(ms):
43
71
    td = datetime.timedelta(0, 0, 0, ms)
44
 
    return (u"%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
 
72
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
45
73
            % { "days": "%dT" % td.days if td.days else "",
46
74
                "hours": td.seconds // 3600,
47
75
                "minutes": (td.seconds % 3600) // 60,
52
80
def string_to_delta(interval):
53
81
    """Parse a string and return a datetime.timedelta
54
82
 
55
 
    >>> string_to_delta('7d')
 
83
    >>> string_to_delta("7d")
56
84
    datetime.timedelta(7)
57
 
    >>> string_to_delta('60s')
 
85
    >>> string_to_delta("60s")
58
86
    datetime.timedelta(0, 60)
59
 
    >>> string_to_delta('60m')
 
87
    >>> string_to_delta("60m")
60
88
    datetime.timedelta(0, 3600)
61
 
    >>> string_to_delta('24h')
 
89
    >>> string_to_delta("24h")
62
90
    datetime.timedelta(1)
63
 
    >>> string_to_delta(u'1w')
 
91
    >>> string_to_delta("1w")
64
92
    datetime.timedelta(7)
65
 
    >>> string_to_delta('5m 30s')
 
93
    >>> string_to_delta("5m 30s")
66
94
    datetime.timedelta(0, 330)
67
95
    """
68
96
    timevalue = datetime.timedelta(0)
72
100
        try:
73
101
            suffix = unicode(s[-1])
74
102
            value = int(s[:-1])
75
 
            if suffix == u"d":
 
103
            if suffix == "d":
76
104
                delta = datetime.timedelta(value)
77
 
            elif suffix == u"s":
 
105
            elif suffix == "s":
78
106
                delta = datetime.timedelta(0, value)
79
 
            elif suffix == u"m":
 
107
            elif suffix == "m":
80
108
                delta = datetime.timedelta(0, 0, 0, 0, value)
81
 
            elif suffix == u"h":
 
109
            elif suffix == "h":
82
110
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
83
 
            elif suffix == u"w":
 
111
            elif suffix == "w":
84
112
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
85
113
            else:
86
114
                raise ValueError
92
120
def print_clients(clients, keywords):
93
121
    def valuetostring(value, keyword):
94
122
        if type(value) is dbus.Boolean:
95
 
            return u"Yes" if value else u"No"
96
 
        if keyword in (u"timeout", u"interval"):
 
123
            return "Yes" if value else "No"
 
124
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
125
                       "ApprovalDuration"):
97
126
            return milliseconds_to_string(value)
98
127
        return unicode(value)
99
128
    
100
129
    # Create format string to print table rows
101
 
    format_string = u' '.join(u'%%-%ds' %
102
 
                              max(len(tablewords[key]),
103
 
                                  max(len(valuetostring(client[key],
104
 
                                                        key))
105
 
                                      for client in
106
 
                                      clients))
107
 
                              for key in keywords)
 
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)
108
137
    # Print header line
109
 
    print format_string % tuple(tablewords[key] for key in keywords)
 
138
    print(format_string % tuple(tablewords[key] for key in keywords))
110
139
    for client in clients:
111
 
        print format_string % tuple(valuetostring(client[key], key)
112
 
                                    for key in keywords)
 
140
        print(format_string % tuple(valuetostring(client[key], key)
 
141
                                    for key in keywords))
 
142
 
113
143
def has_actions(options):
114
144
    return any((options.enable,
115
145
                options.disable,
121
151
                options.checker is not None,
122
152
                options.timeout is not None,
123
153
                options.interval is not None,
 
154
                options.approved_by_default is not None,
 
155
                options.approval_delay is not None,
 
156
                options.approval_duration is not None,
124
157
                options.host is not None,
125
158
                options.secret is not None,
126
159
                options.approve,
152
185
                          help="Set timeout for client")
153
186
        parser.add_option("-i", "--interval", type="string",
154
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")
155
198
        parser.add_option("-H", "--host", type="string",
156
199
                          help="Set host for client")
157
200
        parser.add_option("-s", "--secret", type="string",
161
204
        parser.add_option("-D", "--deny", action="store_true",
162
205
                          help="Deny any current client request")
163
206
        options, client_names = parser.parse_args()
164
 
 
 
207
        
165
208
        if has_actions(options) and not client_names and not options.all:
166
 
            parser.error('Options requires clients names or --all.')
 
209
            parser.error("Options require clients names or --all.")
167
210
        if options.verbose and has_actions(options):
168
 
            parser.error('Verbose option can only be used alone or with --all.')
 
211
            parser.error("--verbose can only be used alone or with"
 
212
                         " --all.")
169
213
        if options.all and not has_actions(options):
170
 
            parser.error('--all requires an action')
171
 
            
 
214
            parser.error("--all requires an action.")
 
215
        
172
216
        try:
173
217
            bus = dbus.SystemBus()
174
218
            mandos_dbus_objc = bus.get_object(busname, server_path)
175
219
        except dbus.exceptions.DBusException:
176
 
            print >> sys.stderr, "Could not connect to Mandos server"
 
220
            print("Could not connect to Mandos server",
 
221
                  file=sys.stderr)
177
222
            sys.exit(1)
178
223
    
179
224
        mandos_serv = dbus.Interface(mandos_dbus_objc,
192
237
                os.dup2(stderrcopy, sys.stderr.fileno())
193
238
                os.close(stderrcopy)
194
239
        except dbus.exceptions.DBusException, e:
195
 
            print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
 
240
            print("Access denied: Accessing mandos server through dbus.",
 
241
                  file=sys.stderr)
196
242
            sys.exit(1)
197
243
            
198
 
        # Compile list of clients to process
199
 
        clients=[]
200
 
 
 
244
        # Compile dict of (clients: properties) to process
 
245
        clients={}
 
246
        
201
247
        if options.all or not client_names:
202
 
            clients = (bus.get_object(busname, path) for path in mandos_clients.iterkeys())
 
248
            clients = dict((bus.get_object(busname, path), properties)
 
249
                           for path, properties in
 
250
                           mandos_clients.iteritems())
203
251
        else:
204
252
            for name in client_names:
205
253
                for path, client in mandos_clients.iteritems():
206
 
                    if client['Name'] == name:
 
254
                    if client["Name"] == name:
207
255
                        client_objc = bus.get_object(busname, path)
208
 
                        clients.append(client_objc)
 
256
                        clients[client_objc] = client
209
257
                        break
210
258
                else:
211
 
                    print >> sys.stderr, "Client not found on server: %r" % name
 
259
                    print("Client not found on server: %r" % name,
 
260
                          file=sys.stderr)
212
261
                    sys.exit(1)
213
262
            
214
263
        if not has_actions(options) and clients:
215
264
            if options.verbose:
216
 
                keywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK',
217
 
                            'Created', 'Interval', 'Host', 'Fingerprint',
218
 
                            'CheckerRunning', 'LastEnabled', 'Checker')
 
265
                keywords = ("Name", "Enabled", "Timeout",
 
266
                            "LastCheckedOK", "Created", "Interval",
 
267
                            "Host", "Fingerprint", "CheckerRunning",
 
268
                            "LastEnabled", "ApprovalPending",
 
269
                            "ApprovedByDefault",
 
270
                            "LastApprovalRequest", "ApprovalDelay",
 
271
                            "ApprovalDuration", "Checker")
219
272
            else:
220
273
                keywords = defaultkeywords
221
 
                
222
 
            print_clients(mandos_clients.values(), keywords)
 
274
            
 
275
            print_clients(clients.values(), keywords)
223
276
        else:
224
277
            # Process each client in the list by all selected options
225
278
            for client in clients:
237
290
                    client.StopChecker(dbus_interface=client_interface)
238
291
                if options.is_enabled:
239
292
                    sys.exit(0 if client.Get(client_interface,
240
 
                                             u"Enabled",
 
293
                                             "Enabled",
241
294
                                             dbus_interface=dbus.PROPERTIES_IFACE)
242
295
                             else 1)
243
296
                if options.checker:
244
 
                    client.Set(client_interface, u"Checker", options.checker,
 
297
                    client.Set(client_interface, "Checker", options.checker,
245
298
                               dbus_interface=dbus.PROPERTIES_IFACE)
246
299
                if options.host:
247
 
                    client.Set(client_interface, u"Host", options.host,
 
300
                    client.Set(client_interface, "Host", options.host,
248
301
                               dbus_interface=dbus.PROPERTIES_IFACE)
249
302
                if options.interval:
250
 
                    client.Set(client_interface, u"Interval",
 
303
                    client.Set(client_interface, "Interval",
251
304
                               timedelta_to_milliseconds
252
305
                               (string_to_delta(options.interval)),
253
306
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
307
                if options.approval_delay:
 
308
                    client.Set(client_interface, "ApprovalDelay",
 
309
                               timedelta_to_milliseconds
 
310
                               (string_to_delta(options.
 
311
                                                approval_delay)),
 
312
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
313
                if options.approval_duration:
 
314
                    client.Set(client_interface, "ApprovalDuration",
 
315
                               timedelta_to_milliseconds
 
316
                               (string_to_delta(options.
 
317
                                                approval_duration)),
 
318
                               dbus_interface=dbus.PROPERTIES_IFACE)
254
319
                if options.timeout:
255
 
                    client.Set(client_interface, u"Timeout",
256
 
                               timedelta_to_milliseconds(string_to_delta
257
 
                                                         (options.timeout)),
 
320
                    client.Set(client_interface, "Timeout",
 
321
                               timedelta_to_milliseconds
 
322
                               (string_to_delta(options.timeout)),
258
323
                               dbus_interface=dbus.PROPERTIES_IFACE)
259
324
                if options.secret:
260
 
                    client.Set(client_interface, u"Secret",
261
 
                               dbus.ByteArray(open(options.secret, u'rb').read()),
 
325
                    client.Set(client_interface, "Secret",
 
326
                               dbus.ByteArray(open(options.secret,
 
327
                                                   "rb").read()),
 
328
                               dbus_interface=dbus.PROPERTIES_IFACE)
 
329
                if options.approved_by_default is not None:
 
330
                    client.Set(client_interface, "ApprovedByDefault",
 
331
                               dbus.Boolean(options
 
332
                                            .approved_by_default),
262
333
                               dbus_interface=dbus.PROPERTIES_IFACE)
263
334
                if options.approve:
264
 
                    client.Approve(dbus.Boolean(True), dbus_interface=client_interface)
265
 
                if options.deny:
266
 
                    client.Approve(dbus.Boolean(False), dbus_interface=client_interface)
 
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)
267
340
 
268
 
if __name__ == '__main__':
 
341
if __name__ == "__main__":
269
342
    main()