/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: Björn Påhlsson
  • Date: 2008-07-20 02:52:20 UTC
  • Revision ID: belorn@braxen-20080720025220-r5u0388uy9iu23h6
Added following support:
Pluginbased client handler
rewritten Mandos client
       Avahi instead of udp server discovery
       openpgp encrypted key support
Passprompt stand alone application for direct console input
Added logging for Mandos server

Show diffs side-by-side

added added

removed removed

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