/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: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: (237.7.53 trunk)
  • mto: This revision was merged to the branch mainline in revision 286.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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