/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

* mandos-ctl.xml: New.
* Makefile (DOCS): Added "mandos-ctl.8".
  (mandos-ctl.8): New.

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