/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
24.1.116 by Björn Påhlsson
added a mandos list client program
1
#!/usr/bin/python
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
2
# -*- mode: python; coding: utf-8 -*-
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
3
# 
4
# Mandos Monitor - Control and monitor the Mandos server
5
# 
237.11.8 by Teddy Hogeborn
* mandos-ctl: Update copyright year to 2011.
6
# Copyright © 2008-2011 Teddy Hogeborn
7
# Copyright © 2008-2011 Björn Påhlsson
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
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
# 
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
22
# Contact the authors at <mandos@recompile.se>.
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
23
# 
24.1.116 by Björn Påhlsson
added a mandos list client program
24
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
25
from __future__ import (division, absolute_import, print_function,
26
                        unicode_literals)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
27
24.1.119 by Björn Påhlsson
Added more method support for mandos clients through mandos-ctl
28
import sys
24.1.116 by Björn Påhlsson
added a mandos list client program
29
import dbus
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
30
import argparse
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
31
import locale
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
32
import datetime
33
import re
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
34
import os
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
35
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
36
locale.setlocale(locale.LC_ALL, "")
24.1.116 by Björn Påhlsson
added a mandos list client program
37
38
tablewords = {
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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",
24.1.179 by Björn Påhlsson
New feature:
55
    "ExtendedTimeout" : "Extended Timeout"
24.1.116 by Björn Påhlsson
added a mandos list client program
56
    }
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
57
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
24.1.186 by Björn Påhlsson
transitional stuff actually working
58
domain = "se.recompile"
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
59
busname = domain + ".Mandos"
60
server_path = "/"
61
server_interface = domain + ".Mandos"
62
client_interface = domain + ".Mandos.Client"
287 by Teddy Hogeborn
* Makefile (version): Changed to "1.4.0".
63
version = "1.4.0"
24.1.118 by Björn Påhlsson
Added enable/disable
64
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
65
def timedelta_to_milliseconds(td):
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
66
    """Convert a datetime.timedelta object to milliseconds"""
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
67
    return ((td.days * 24 * 60 * 60 * 1000)
68
            + (td.seconds * 1000)
69
            + (td.microseconds // 1000))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
70
71
def milliseconds_to_string(ms):
72
    td = datetime.timedelta(0, 0, 0, ms)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
73
    return ("%(days)s%(hours)02d:%(minutes)02d:%(seconds)02d"
74
            % { "days": "%dT" % td.days if td.days else "",
75
                "hours": td.seconds // 3600,
76
                "minutes": (td.seconds % 3600) // 60,
77
                "seconds": td.seconds % 60,
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
78
                })
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
79
80
def string_to_delta(interval):
81
    """Parse a string and return a datetime.timedelta
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
82
    
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
83
    >>> string_to_delta("7d")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
84
    datetime.timedelta(7)
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
85
    >>> string_to_delta("60s")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
86
    datetime.timedelta(0, 60)
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
87
    >>> string_to_delta("60m")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
88
    datetime.timedelta(0, 3600)
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
89
    >>> string_to_delta("24h")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
90
    datetime.timedelta(1)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
91
    >>> string_to_delta("1w")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
92
    datetime.timedelta(7)
237.8.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
93
    >>> string_to_delta("5m 30s")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
94
    datetime.timedelta(0, 330)
95
    """
96
    timevalue = datetime.timedelta(0)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
97
    regexp = re.compile("\d+[dsmhw]")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
98
    
99
    for s in regexp.findall(interval):
100
        try:
101
            suffix = unicode(s[-1])
102
            value = int(s[:-1])
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
103
            if suffix == "d":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
104
                delta = datetime.timedelta(value)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
105
            elif suffix == "s":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
106
                delta = datetime.timedelta(0, value)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
107
            elif suffix == "m":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
108
                delta = datetime.timedelta(0, 0, 0, 0, value)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
109
            elif suffix == "h":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
110
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
111
            elif suffix == "w":
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
112
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
113
            else:
114
                raise ValueError
115
        except (ValueError, IndexError):
116
            raise ValueError
117
        timevalue += delta
118
    return timevalue
119
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
120
def print_clients(clients, keywords):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
121
    def valuetostring(value, keyword):
122
        if type(value) is dbus.Boolean:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
123
            return "Yes" if value else "No"
124
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
125
                       "ApprovalDuration"):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
126
            return milliseconds_to_string(value)
127
        return unicode(value)
128
    
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
129
    # Create format string to print table rows
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
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)
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
137
    # Print header line
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
138
    print(format_string % tuple(tablewords[key] for key in keywords))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
139
    for client in clients:
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
140
        print(format_string % tuple(valuetostring(client[key], key)
141
                                    for key in keywords))
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
142
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
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,
24.1.179 by Björn Påhlsson
New feature:
153
                options.extended_timeout is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
154
                options.interval is not None,
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
155
                options.approved_by_default is not None,
156
                options.approval_delay is not None,
157
                options.approval_duration is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
158
                options.host is not None,
159
                options.secret is not None,
160
                options.approve,
161
                options.deny))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
162
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
163
def main():
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
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")
24.1.179 by Björn Påhlsson
New feature:
190
    parser.add_argument("--extended-timeout",
191
                        help="Set extended timeout for client")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
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
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
264
            else:
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
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",
24.1.179 by Björn Påhlsson
New feature:
277
                        "ApprovalDuration", "Checker",
278
                        "ExtendedTimeout")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
279
        else:
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
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)
24.1.179 by Björn Påhlsson
New feature:
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)
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
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)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
354
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
355
if __name__ == "__main__":
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
356
    main()