/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: 2011-07-27 17:58:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110727175827-nrd1ysjl4jrh6qw1
Tags: version-1.3.1-1
* Makefile (version): Changed to "1.3.1".
* NEWS (Version 1.3.1): New entry.
* debian/changelog (1.3.1-1): - '' -

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
 
from optparse import OptionParser
 
30
import argparse
8
31
import locale
9
32
import datetime
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.1"
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,
48
76
                "seconds": td.seconds % 60,
49
77
                })
50
78
 
51
 
 
52
79
def string_to_delta(interval):
53
80
    """Parse a string and return a datetime.timedelta
54
 
 
55
 
    >>> string_to_delta('7d')
 
81
    
 
82
    >>> string_to_delta("7d")
56
83
    datetime.timedelta(7)
57
 
    >>> string_to_delta('60s')
 
84
    >>> string_to_delta("60s")
58
85
    datetime.timedelta(0, 60)
59
 
    >>> string_to_delta('60m')
 
86
    >>> string_to_delta("60m")
60
87
    datetime.timedelta(0, 3600)
61
 
    >>> string_to_delta('24h')
 
88
    >>> string_to_delta("24h")
62
89
    datetime.timedelta(1)
63
 
    >>> string_to_delta(u'1w')
 
90
    >>> string_to_delta("1w")
64
91
    datetime.timedelta(7)
65
 
    >>> string_to_delta('5m 30s')
 
92
    >>> string_to_delta("5m 30s")
66
93
    datetime.timedelta(0, 330)
67
94
    """
68
95
    timevalue = datetime.timedelta(0)
72
99
        try:
73
100
            suffix = unicode(s[-1])
74
101
            value = int(s[:-1])
75
 
            if suffix == u"d":
 
102
            if suffix == "d":
76
103
                delta = datetime.timedelta(value)
77
 
            elif suffix == u"s":
 
104
            elif suffix == "s":
78
105
                delta = datetime.timedelta(0, value)
79
 
            elif suffix == u"m":
 
106
            elif suffix == "m":
80
107
                delta = datetime.timedelta(0, 0, 0, 0, value)
81
 
            elif suffix == u"h":
 
108
            elif suffix == "h":
82
109
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
83
 
            elif suffix == u"w":
 
110
            elif suffix == "w":
84
111
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
85
112
            else:
86
113
                raise ValueError
92
119
def print_clients(clients, keywords):
93
120
    def valuetostring(value, keyword):
94
121
        if type(value) is dbus.Boolean:
95
 
            return u"Yes" if value else u"No"
96
 
        if keyword in (u"Timeout", u"Interval"):
 
122
            return "Yes" if value else "No"
 
123
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
124
                       "ApprovalDuration"):
97
125
            return milliseconds_to_string(value)
98
126
        return unicode(value)
99
127
    
100
128
    # 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)
 
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)
108
136
    # Print header line
109
 
    print format_string % tuple(tablewords[key] for key in keywords)
 
137
    print(format_string % tuple(tablewords[key] for key in keywords))
110
138
    for client in clients:
111
 
        print format_string % tuple(valuetostring(client[key], key)
112
 
                                    for key in keywords)
 
139
        print(format_string % tuple(valuetostring(client[key], key)
 
140
                                    for key in keywords))
113
141
 
114
142
def has_actions(options):
115
143
    return any((options.enable,
122
150
                options.checker is not None,
123
151
                options.timeout is not None,
124
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,
125
156
                options.host is not None,
126
157
                options.secret is not None,
127
158
                options.approve,
128
159
                options.deny))
129
 
        
 
160
 
130
161
def main():
131
 
        parser = OptionParser(version = "%%prog %s" % version)
132
 
        parser.add_option("-a", "--all", action="store_true",
133
 
                          help="Select all clients")
134
 
        parser.add_option("-v", "--verbose", action="store_true",
135
 
                          help="Print all fields")
136
 
        parser.add_option("-e", "--enable", action="store_true",
137
 
                          help="Enable client")
138
 
        parser.add_option("-d", "--disable", action="store_true",
139
 
                          help="disable client")
140
 
        parser.add_option("-b", "--bump-timeout", action="store_true",
141
 
                          help="Bump timeout for client")
142
 
        parser.add_option("--start-checker", action="store_true",
143
 
                          help="Start checker for client")
144
 
        parser.add_option("--stop-checker", action="store_true",
145
 
                          help="Stop checker for client")
146
 
        parser.add_option("-V", "--is-enabled", action="store_true",
147
 
                          help="Check if client is enabled")
148
 
        parser.add_option("-r", "--remove", action="store_true",
149
 
                          help="Remove client")
150
 
        parser.add_option("-c", "--checker", type="string",
151
 
                          help="Set checker command for client")
152
 
        parser.add_option("-t", "--timeout", type="string",
153
 
                          help="Set timeout for client")
154
 
        parser.add_option("-i", "--interval", type="string",
155
 
                          help="Set checker interval for client")
156
 
        parser.add_option("-H", "--host", type="string",
157
 
                          help="Set host for client")
158
 
        parser.add_option("-s", "--secret", type="string",
159
 
                          help="Set password blob (file) for client")
160
 
        parser.add_option("-A", "--approve", action="store_true",
161
 
                          help="Approve any current client request")
162
 
        parser.add_option("-D", "--deny", action="store_true",
163
 
                          help="Deny any current client request")
164
 
        options, client_names = parser.parse_args()
165
 
        
166
 
        if has_actions(options) and not client_names and not options.all:
167
 
            parser.error('Options requires clients names or --all.')
168
 
        if options.verbose and has_actions(options):
169
 
            parser.error('Verbose option can only be used alone or with --all.')
170
 
        if options.all and not has_actions(options):
171
 
            parser.error('--all requires an action')
172
 
            
173
 
        try:
174
 
            bus = dbus.SystemBus()
175
 
            mandos_dbus_objc = bus.get_object(busname, server_path)
176
 
        except dbus.exceptions.DBusException:
177
 
            print >> sys.stderr, "Could not connect to Mandos server"
178
 
            sys.exit(1)
179
 
    
180
 
        mandos_serv = dbus.Interface(mandos_dbus_objc,
181
 
                                     dbus_interface = server_interface)
182
 
 
183
 
        #block stderr since dbus library prints to stderr
184
 
        null = os.open(os.path.devnull, os.O_RDWR)
185
 
        stderrcopy = os.dup(sys.stderr.fileno())
186
 
        os.dup2(null, sys.stderr.fileno())
187
 
        os.close(null)
188
 
        try:
189
 
            try:
190
 
                mandos_clients = mandos_serv.GetAllClientsWithProperties()
191
 
            finally:
192
 
                #restore stderr
193
 
                os.dup2(stderrcopy, sys.stderr.fileno())
194
 
                os.close(stderrcopy)
195
 
        except dbus.exceptions.DBusException, e:
196
 
            print >> sys.stderr, "Access denied: Accessing mandos server through dbus."
197
 
            sys.exit(1)
198
 
            
199
 
        # Compile dict of (clients: properties) to process
200
 
        clients={}
201
 
        
202
 
        if options.all or not client_names:
203
 
            clients = dict((bus.get_object(busname, path), properties)
204
 
                           for path, properties in
205
 
                           mandos_clients.iteritems())
206
 
        else:
207
 
            for name in client_names:
208
 
                for path, client in mandos_clients.iteritems():
209
 
                    if client['Name'] == name:
210
 
                        client_objc = bus.get_object(busname, path)
211
 
                        clients[client_objc] = client
212
 
                        break
213
 
                else:
214
 
                    print >> sys.stderr, "Client not found on server: %r" % name
215
 
                    sys.exit(1)
216
 
            
217
 
        if not has_actions(options) and clients:
218
 
            if options.verbose:
219
 
                keywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK',
220
 
                            'Created', 'Interval', 'Host', 'Fingerprint',
221
 
                            'CheckerRunning', 'LastEnabled', 'Checker')
 
162
    parser = argparse.ArgumentParser()
 
163
    parser.add_argument("--version", action="version",
 
164
                        version = "%%prog %s" % version,
 
165
                        help="show version number and exit")
 
166
    parser.add_argument("-a", "--all", action="store_true",
 
167
                        help="Select all clients")
 
168
    parser.add_argument("-v", "--verbose", action="store_true",
 
169
                        help="Print all fields")
 
170
    parser.add_argument("-e", "--enable", action="store_true",
 
171
                        help="Enable client")
 
172
    parser.add_argument("-d", "--disable", action="store_true",
 
173
                        help="disable client")
 
174
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
175
                        help="Bump timeout for client")
 
176
    parser.add_argument("--start-checker", action="store_true",
 
177
                        help="Start checker for client")
 
178
    parser.add_argument("--stop-checker", action="store_true",
 
179
                        help="Stop checker for client")
 
180
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
181
                        help="Check if client is enabled")
 
182
    parser.add_argument("-r", "--remove", action="store_true",
 
183
                        help="Remove client")
 
184
    parser.add_argument("-c", "--checker",
 
185
                        help="Set checker command for client")
 
186
    parser.add_argument("-t", "--timeout",
 
187
                        help="Set timeout for client")
 
188
    parser.add_argument("-i", "--interval",
 
189
                        help="Set checker interval for client")
 
190
    parser.add_argument("--approve-by-default", action="store_true",
 
191
                        default=None, dest="approved_by_default",
 
192
                        help="Set client to be approved by default")
 
193
    parser.add_argument("--deny-by-default", action="store_false",
 
194
                        dest="approved_by_default",
 
195
                        help="Set client to be denied by default")
 
196
    parser.add_argument("--approval-delay",
 
197
                        help="Set delay before client approve/deny")
 
198
    parser.add_argument("--approval-duration",
 
199
                        help="Set duration of one client approval")
 
200
    parser.add_argument("-H", "--host", help="Set host for client")
 
201
    parser.add_argument("-s", "--secret", type=file,
 
202
                        help="Set password blob (file) for client")
 
203
    parser.add_argument("-A", "--approve", action="store_true",
 
204
                        help="Approve any current client request")
 
205
    parser.add_argument("-D", "--deny", action="store_true",
 
206
                        help="Deny any current client request")
 
207
    parser.add_argument("client", nargs="*", help="Client name")
 
208
    options = parser.parse_args()
 
209
    
 
210
    if has_actions(options) and not options.client and not options.all:
 
211
        parser.error("Options require clients names or --all.")
 
212
    if options.verbose and has_actions(options):
 
213
        parser.error("--verbose can only be used alone or with"
 
214
                     " --all.")
 
215
    if options.all and not has_actions(options):
 
216
        parser.error("--all requires an action.")
 
217
    
 
218
    try:
 
219
        bus = dbus.SystemBus()
 
220
        mandos_dbus_objc = bus.get_object(busname, server_path)
 
221
    except dbus.exceptions.DBusException:
 
222
        print("Could not connect to Mandos server",
 
223
              file=sys.stderr)
 
224
        sys.exit(1)
 
225
    
 
226
    mandos_serv = dbus.Interface(mandos_dbus_objc,
 
227
                                 dbus_interface = server_interface)
 
228
    
 
229
    #block stderr since dbus library prints to stderr
 
230
    null = os.open(os.path.devnull, os.O_RDWR)
 
231
    stderrcopy = os.dup(sys.stderr.fileno())
 
232
    os.dup2(null, sys.stderr.fileno())
 
233
    os.close(null)
 
234
    try:
 
235
        try:
 
236
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
237
        finally:
 
238
            #restore stderr
 
239
            os.dup2(stderrcopy, sys.stderr.fileno())
 
240
            os.close(stderrcopy)
 
241
    except dbus.exceptions.DBusException, e:
 
242
        print("Access denied: Accessing mandos server through dbus.",
 
243
              file=sys.stderr)
 
244
        sys.exit(1)
 
245
    
 
246
    # Compile dict of (clients: properties) to process
 
247
    clients={}
 
248
    
 
249
    if options.all or not options.client:
 
250
        clients = dict((bus.get_object(busname, path), properties)
 
251
                       for path, properties in
 
252
                       mandos_clients.iteritems())
 
253
    else:
 
254
        for name in options.client:
 
255
            for path, client in mandos_clients.iteritems():
 
256
                if client["Name"] == name:
 
257
                    client_objc = bus.get_object(busname, path)
 
258
                    clients[client_objc] = client
 
259
                    break
222
260
            else:
223
 
                keywords = defaultkeywords
224
 
                
225
 
            print_clients(clients.values(), keywords)
 
261
                print("Client not found on server: %r" % name,
 
262
                      file=sys.stderr)
 
263
                sys.exit(1)
 
264
    
 
265
    if not has_actions(options) and clients:
 
266
        if options.verbose:
 
267
            keywords = ("Name", "Enabled", "Timeout",
 
268
                        "LastCheckedOK", "Created", "Interval",
 
269
                        "Host", "Fingerprint", "CheckerRunning",
 
270
                        "LastEnabled", "ApprovalPending",
 
271
                        "ApprovedByDefault",
 
272
                        "LastApprovalRequest", "ApprovalDelay",
 
273
                        "ApprovalDuration", "Checker")
226
274
        else:
227
 
            # Process each client in the list by all selected options
228
 
            for client in clients:
229
 
                if options.remove:
230
 
                    mandos_serv.RemoveClient(client.__dbus_object_path__)
231
 
                if options.enable:
232
 
                    client.Enable(dbus_interface=client_interface)
233
 
                if options.disable:
234
 
                    client.Disable(dbus_interface=client_interface)
235
 
                if options.bump_timeout:
236
 
                    client.CheckedOK(dbus_interface=client_interface)
237
 
                if options.start_checker:
238
 
                    client.StartChecker(dbus_interface=client_interface)
239
 
                if options.stop_checker:
240
 
                    client.StopChecker(dbus_interface=client_interface)
241
 
                if options.is_enabled:
242
 
                    sys.exit(0 if client.Get(client_interface,
243
 
                                             u"Enabled",
244
 
                                             dbus_interface=dbus.PROPERTIES_IFACE)
245
 
                             else 1)
246
 
                if options.checker:
247
 
                    client.Set(client_interface, u"Checker", options.checker,
248
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
249
 
                if options.host:
250
 
                    client.Set(client_interface, u"Host", options.host,
251
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
252
 
                if options.interval:
253
 
                    client.Set(client_interface, u"Interval",
254
 
                               timedelta_to_milliseconds
255
 
                               (string_to_delta(options.interval)),
256
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
257
 
                if options.timeout:
258
 
                    client.Set(client_interface, u"Timeout",
259
 
                               timedelta_to_milliseconds(string_to_delta
260
 
                                                         (options.timeout)),
261
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
262
 
                if options.secret:
263
 
                    client.Set(client_interface, u"Secret",
264
 
                               dbus.ByteArray(open(options.secret, u'rb').read()),
265
 
                               dbus_interface=dbus.PROPERTIES_IFACE)
266
 
                if options.approve:
267
 
                    client.Approve(dbus.Boolean(True), dbus_interface=client_interface)
268
 
                if options.deny:
269
 
                    client.Approve(dbus.Boolean(False), dbus_interface=client_interface)
 
275
            keywords = defaultkeywords
 
276
        
 
277
        print_clients(clients.values(), keywords)
 
278
    else:
 
279
        # Process each client in the list by all selected options
 
280
        for client in clients:
 
281
            if options.remove:
 
282
                mandos_serv.RemoveClient(client.__dbus_object_path__)
 
283
            if options.enable:
 
284
                client.Enable(dbus_interface=client_interface)
 
285
            if options.disable:
 
286
                client.Disable(dbus_interface=client_interface)
 
287
            if options.bump_timeout:
 
288
                client.CheckedOK(dbus_interface=client_interface)
 
289
            if options.start_checker:
 
290
                client.StartChecker(dbus_interface=client_interface)
 
291
            if options.stop_checker:
 
292
                client.StopChecker(dbus_interface=client_interface)
 
293
            if options.is_enabled:
 
294
                sys.exit(0 if client.Get(client_interface,
 
295
                                         "Enabled",
 
296
                                         dbus_interface=
 
297
                                         dbus.PROPERTIES_IFACE)
 
298
                         else 1)
 
299
            if options.checker:
 
300
                client.Set(client_interface, "Checker",
 
301
                           options.checker,
 
302
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
303
            if options.host:
 
304
                client.Set(client_interface, "Host", options.host,
 
305
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
306
            if options.interval:
 
307
                client.Set(client_interface, "Interval",
 
308
                           timedelta_to_milliseconds
 
309
                           (string_to_delta(options.interval)),
 
310
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
311
            if options.approval_delay:
 
312
                client.Set(client_interface, "ApprovalDelay",
 
313
                           timedelta_to_milliseconds
 
314
                           (string_to_delta(options.
 
315
                                            approval_delay)),
 
316
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
317
            if options.approval_duration:
 
318
                client.Set(client_interface, "ApprovalDuration",
 
319
                           timedelta_to_milliseconds
 
320
                           (string_to_delta(options.
 
321
                                            approval_duration)),
 
322
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
323
            if options.timeout:
 
324
                client.Set(client_interface, "Timeout",
 
325
                           timedelta_to_milliseconds
 
326
                           (string_to_delta(options.timeout)),
 
327
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
328
            if options.secret:
 
329
                client.Set(client_interface, "Secret",
 
330
                           dbus.ByteArray(open(options.secret,
 
331
                                               "rb").read()),
 
332
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
333
            if options.approved_by_default is not None:
 
334
                client.Set(client_interface, "ApprovedByDefault",
 
335
                           dbus.Boolean(options
 
336
                                        .approved_by_default),
 
337
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
338
            if options.approve:
 
339
                client.Approve(dbus.Boolean(True),
 
340
                               dbus_interface=client_interface)
 
341
            elif options.deny:
 
342
                client.Approve(dbus.Boolean(False),
 
343
                               dbus_interface=client_interface)
270
344
 
271
 
if __name__ == '__main__':
 
345
if __name__ == "__main__":
272
346
    main()