/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

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