/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 Hogeborn
  • Date: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

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
 
import argparse
 
7
from optparse import OptionParser
31
8
import locale
32
9
import datetime
33
10
import re
34
 
import os
35
11
 
36
 
locale.setlocale(locale.LC_ALL, "")
 
12
locale.setlocale(locale.LC_ALL, u'')
37
13
 
38
14
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",
 
15
    'Name': u'Name',
 
16
    'Enabled': u'Enabled',
 
17
    'Timeout': u'Timeout',
 
18
    'LastCheckedOK': u'Last Successful Check',
 
19
    'Created': u'Created',
 
20
    'Interval': u'Interval',
 
21
    'Host': u'Host',
 
22
    'Fingerprint': u'Fingerprint',
 
23
    'CheckerRunning': u'Check Is Running',
 
24
    'LastEnabled': u'Last Enabled',
 
25
    'Checker': u'Checker',
55
26
    }
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"
 
27
defaultkeywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK')
 
28
domain = 'se.bsnet.fukt'
 
29
busname = domain + '.Mandos'
 
30
server_path = '/'
 
31
server_interface = domain + '.Mandos'
 
32
client_interface = domain + '.Mandos.Client'
 
33
version = "1.0.14"
 
34
try:
 
35
    bus = dbus.SystemBus()
 
36
    mandos_dbus_objc = bus.get_object(busname, server_path)
 
37
except dbus.exceptions.DBusException:
 
38
    sys.exit(1)
 
39
    
 
40
mandos_serv = dbus.Interface(mandos_dbus_objc,
 
41
                             dbus_interface = server_interface)
 
42
mandos_clients = mandos_serv.GetAllClientsWithProperties()
63
43
 
64
44
def timedelta_to_milliseconds(td):
65
 
    """Convert a datetime.timedelta object to milliseconds"""
 
45
    "Convert a datetime.timedelta object to milliseconds"
66
46
    return ((td.days * 24 * 60 * 60 * 1000)
67
47
            + (td.seconds * 1000)
68
48
            + (td.microseconds // 1000))
69
49
 
70
50
def milliseconds_to_string(ms):
71
51
    td = datetime.timedelta(0, 0, 0, ms)
72
 
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
 
52
    return (u"%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
73
53
            % { "days": "%dT" % td.days if td.days else "",
74
54
                "hours": td.seconds // 3600,
75
55
                "minutes": (td.seconds % 3600) // 60,
76
56
                "seconds": td.seconds % 60,
77
57
                })
78
58
 
 
59
 
79
60
def string_to_delta(interval):
80
61
    """Parse a string and return a datetime.timedelta
81
 
    
82
 
    >>> string_to_delta("7d")
 
62
 
 
63
    >>> string_to_delta('7d')
83
64
    datetime.timedelta(7)
84
 
    >>> string_to_delta("60s")
 
65
    >>> string_to_delta('60s')
85
66
    datetime.timedelta(0, 60)
86
 
    >>> string_to_delta("60m")
 
67
    >>> string_to_delta('60m')
87
68
    datetime.timedelta(0, 3600)
88
 
    >>> string_to_delta("24h")
 
69
    >>> string_to_delta('24h')
89
70
    datetime.timedelta(1)
90
 
    >>> string_to_delta("1w")
 
71
    >>> string_to_delta(u'1w')
91
72
    datetime.timedelta(7)
92
 
    >>> string_to_delta("5m 30s")
 
73
    >>> string_to_delta('5m 30s')
93
74
    datetime.timedelta(0, 330)
94
75
    """
95
76
    timevalue = datetime.timedelta(0)
99
80
        try:
100
81
            suffix = unicode(s[-1])
101
82
            value = int(s[:-1])
102
 
            if suffix == "d":
 
83
            if suffix == u"d":
103
84
                delta = datetime.timedelta(value)
104
 
            elif suffix == "s":
 
85
            elif suffix == u"s":
105
86
                delta = datetime.timedelta(0, value)
106
 
            elif suffix == "m":
 
87
            elif suffix == u"m":
107
88
                delta = datetime.timedelta(0, 0, 0, 0, value)
108
 
            elif suffix == "h":
 
89
            elif suffix == u"h":
109
90
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
110
 
            elif suffix == "w":
 
91
            elif suffix == u"w":
111
92
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
112
93
            else:
113
94
                raise ValueError
116
97
        timevalue += delta
117
98
    return timevalue
118
99
 
119
 
def print_clients(clients, keywords):
 
100
def print_clients(clients):
120
101
    def valuetostring(value, keyword):
121
102
        if type(value) is dbus.Boolean:
122
 
            return "Yes" if value else "No"
123
 
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
124
 
                       "ApprovalDuration"):
 
103
            return u"Yes" if value else u"No"
 
104
        if keyword in (u"timeout", u"interval"):
125
105
            return milliseconds_to_string(value)
126
106
        return unicode(value)
127
107
    
128
108
    # 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)
 
109
    format_string = u' '.join(u'%%-%ds' %
 
110
                              max(len(tablewords[key]),
 
111
                                  max(len(valuetostring(client[key],
 
112
                                                        key))
 
113
                                      for client in
 
114
                                      clients))
 
115
                              for key in keywords)
136
116
    # Print header line
137
 
    print(format_string % tuple(tablewords[key] for key in keywords))
 
117
    print format_string % tuple(tablewords[key] for key in keywords)
138
118
    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 = 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
260
 
            else:
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")
274
 
        else:
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)
344
 
 
345
 
if __name__ == "__main__":
346
 
    main()
 
119
        print format_string % tuple(valuetostring(client[key], key)
 
120
                                    for key in keywords)
 
121
 
 
122
parser = OptionParser(version = "%%prog %s" % version)
 
123
parser.add_option("-a", "--all", action="store_true",
 
124
                  help="Print all fields")
 
125
parser.add_option("-e", "--enable", action="store_true",
 
126
                  help="Enable client")
 
127
parser.add_option("-d", "--disable", action="store_true",
 
128
                  help="disable client")
 
129
parser.add_option("-b", "--bump-timeout", action="store_true",
 
130
                  help="Bump timeout for client")
 
131
parser.add_option("--start-checker", action="store_true",
 
132
                  help="Start checker for client")
 
133
parser.add_option("--stop-checker", action="store_true",
 
134
                  help="Stop checker for client")
 
135
parser.add_option("-V", "--is-enabled", action="store_true",
 
136
                  help="Check if client is enabled")
 
137
parser.add_option("-r", "--remove", action="store_true",
 
138
                  help="Remove client")
 
139
parser.add_option("-c", "--checker", type="string",
 
140
                  help="Set checker command for client")
 
141
parser.add_option("-t", "--timeout", type="string",
 
142
                  help="Set timeout for client")
 
143
parser.add_option("-i", "--interval", type="string",
 
144
                  help="Set checker interval for client")
 
145
parser.add_option("-H", "--host", type="string",
 
146
                  help="Set host for client")
 
147
parser.add_option("-s", "--secret", type="string",
 
148
                  help="Set password blob (file) for client")
 
149
parser.add_option("-A", "--approve", action="store_true",
 
150
                  help="Approve any current client request")
 
151
parser.add_option("-D", "--deny", action="store_true",
 
152
                  help="Deny any current client request")
 
153
options, client_names = parser.parse_args()
 
154
 
 
155
# Compile list of clients to process
 
156
clients=[]
 
157
for name in client_names:
 
158
    for path, client in mandos_clients.iteritems():
 
159
        if client['name'] == name:
 
160
            client_objc = bus.get_object(busname, path)
 
161
            clients.append(client_objc)
 
162
            break
 
163
    else:
 
164
        print >> sys.stderr, "Client not found on server: %r" % name
 
165
        sys.exit(1)
 
166
 
 
167
if not clients and mandos_clients.values():
 
168
    keywords = defaultkeywords
 
169
    if options.all:
 
170
        keywords = ('Name', 'Enabled', 'Timeout', 'LastCheckedOK',
 
171
                    'Created', 'Interval', 'Host', 'Fingerprint',
 
172
                    'CheckerRunning', 'LastEnabled', 'Checker')
 
173
    print_clients(mandos_clients.values())
 
174
 
 
175
# Process each client in the list by all selected options
 
176
for client in clients:
 
177
    if options.remove:
 
178
        mandos_serv.RemoveClient(client.__dbus_object_path__)
 
179
    if options.enable:
 
180
        client.Enable(dbus_interface=client_interface)
 
181
    if options.disable:
 
182
        client.Disable(dbus_interface=client_interface)
 
183
    if options.bump_timeout:
 
184
        client.CheckedOK(dbus_interface=client_interface)
 
185
    if options.start_checker:
 
186
        client.StartChecker(dbus_interface=client_interface)
 
187
    if options.stop_checker:
 
188
        client.StopChecker(dbus_interface=client_interface)
 
189
    if options.is_enabled:
 
190
        sys.exit(0 if client.Get(client_interface,
 
191
                                 u"Enabled",
 
192
                                 dbus_interface=dbus.PROPERTIES_IFACE)
 
193
                 else 1)
 
194
    if options.checker:
 
195
        client.Set(client_interface, u"Checker", options.checker,
 
196
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
197
    if options.host:
 
198
        client.Set(client_interface, u"Host", options.host,
 
199
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
200
    if options.interval:
 
201
        client.Set(client_interface, u"Interval",
 
202
                   timedelta_to_milliseconds
 
203
                   (string_to_delta(options.interval)),
 
204
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
205
    if options.timeout:
 
206
        client.Set(client_interface, u"Timeout",
 
207
                   timedelta_to_milliseconds(string_to_delta
 
208
                                             (options.timeout)),
 
209
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
210
    if options.secret:
 
211
        client.Set(client_interface, u"Secret",
 
212
                   dbus.ByteArray(open(options.secret, u'rb').read()),
 
213
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
214
    if options.approve:
 
215
        client.Approve(dbus.Boolean(True),
 
216
                       dbus_interface=client_interface)
 
217
    if options.deny:
 
218
        client.Approve(dbus.Boolean(False),
 
219
                       dbus_interface=client_interface)