/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
24.1.116 by Björn Påhlsson
added a mandos list client program
1
#!/usr/bin/python
240 by Teddy Hogeborn
Merge "mandos-list" from belorn.
2
# -*- mode: python; coding: utf-8 -*-
444 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
3
# 
4
# Mandos Monitor - Control and monitor the Mandos server
5
# 
544 by Teddy Hogeborn
Updated year in copyright notices.
6
# Copyright © 2008-2012 Teddy Hogeborn
7
# Copyright © 2008-2012 Björn Påhlsson
444 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
# 
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
22
# Contact the authors at <mandos@recompile.se>.
444 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
463.1.9 by teddy at bsnet
* mandos-ctl: Use print function.
25
from __future__ import (division, absolute_import, print_function,
26
                        unicode_literals)
463.1.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
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
30
import argparse
240 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
240 by Teddy Hogeborn
Merge "mandos-list" from belorn.
35
463.1.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 = {
463.1.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
    }
463.1.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"
463.1.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"
237.4.28 by Teddy Hogeborn
* Makefile (version): Changed to "1.5.3".
63
version = "1.5.3"
24.1.118 by Björn Påhlsson
Added enable/disable
64
382 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
65
def timedelta_to_milliseconds(td):
463.1.7 by teddy at bsnet
* mandos-ctl: Use only unicode string literals.
66
    """Convert a datetime.timedelta object to milliseconds"""
382 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)
569 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
73
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
74
            .format(days = "{0}T".format(td.days) if td.days else "",
75
                    hours = td.seconds // 3600,
76
                    minutes = (td.seconds % 3600) // 60,
77
                    seconds = td.seconds % 60,
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
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
82
    
463.1.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)
463.1.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)
463.1.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)
463.1.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)
463.1.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)
463.1.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
    """
518.2.9 by Teddy Hogeborn
* mandos (ClientDBus.approval_delay, ClientDBus.approval_duration,
96
    value = datetime.timedelta(0)
97
    regexp = re.compile("(\d+)([dsmhw]?)")
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
98
    
518.2.9 by Teddy Hogeborn
* mandos (ClientDBus.approval_delay, ClientDBus.approval_duration,
99
    for num, suffix in regexp.findall(interval):
100
        if suffix == "d":
101
            value += datetime.timedelta(int(num))
102
        elif suffix == "s":
103
            value += datetime.timedelta(0, int(num))
104
        elif suffix == "m":
105
            value += datetime.timedelta(0, 0, 0, 0, int(num))
106
        elif suffix == "h":
107
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
108
        elif suffix == "w":
109
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
110
        elif suffix == "":
111
            value += datetime.timedelta(0, 0, 0, int(num))
112
    return value
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
113
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
114
def print_clients(clients, keywords):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
115
    def valuetostring(value, keyword):
116
        if type(value) is dbus.Boolean:
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
117
            return "Yes" if value else "No"
118
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
119
                       "ApprovalDuration"):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
120
            return milliseconds_to_string(value)
121
        return unicode(value)
122
    
382 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
123
    # Create format string to print table rows
569 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
124
    format_string = " ".join("{{{key}:{width}}}".format(
125
            width = max(len(tablewords[key]),
126
                        max(len(valuetostring(client[key],
127
                                              key))
128
                            for client in
129
                            clients)),
130
            key = key) for key in keywords)
382 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
131
    # Print header line
569 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
132
    print(format_string.format(**tablewords))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
133
    for client in clients:
569 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
134
        print(format_string.format(**dict((key,
135
                                           valuetostring(client[key],
136
                                                         key))
137
                                          for key in keywords)))
438 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
138
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
139
def has_actions(options):
140
    return any((options.enable,
141
                options.disable,
142
                options.bump_timeout,
143
                options.start_checker,
144
                options.stop_checker,
145
                options.is_enabled,
146
                options.remove,
147
                options.checker is not None,
148
                options.timeout is not None,
24.1.179 by Björn Påhlsson
New feature:
149
                options.extended_timeout is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
150
                options.interval is not None,
441 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
151
                options.approved_by_default is not None,
152
                options.approval_delay is not None,
153
                options.approval_duration is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
154
                options.host is not None,
155
                options.secret is not None,
156
                options.approve,
157
                options.deny))
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
158
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
159
def main():
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
160
    parser = argparse.ArgumentParser()
161
    parser.add_argument("--version", action="version",
569 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
162
                        version = "%(prog)s {0}".format(version),
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
163
                        help="show version number and exit")
164
    parser.add_argument("-a", "--all", action="store_true",
165
                        help="Select all clients")
166
    parser.add_argument("-v", "--verbose", action="store_true",
167
                        help="Print all fields")
168
    parser.add_argument("-e", "--enable", action="store_true",
169
                        help="Enable client")
170
    parser.add_argument("-d", "--disable", action="store_true",
171
                        help="disable client")
172
    parser.add_argument("-b", "--bump-timeout", action="store_true",
173
                        help="Bump timeout for client")
174
    parser.add_argument("--start-checker", action="store_true",
175
                        help="Start checker for client")
176
    parser.add_argument("--stop-checker", action="store_true",
177
                        help="Stop checker for client")
178
    parser.add_argument("-V", "--is-enabled", action="store_true",
179
                        help="Check if client is enabled")
180
    parser.add_argument("-r", "--remove", action="store_true",
181
                        help="Remove client")
182
    parser.add_argument("-c", "--checker",
183
                        help="Set checker command for client")
184
    parser.add_argument("-t", "--timeout",
185
                        help="Set timeout for client")
24.1.179 by Björn Påhlsson
New feature:
186
    parser.add_argument("--extended-timeout",
187
                        help="Set extended timeout for client")
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
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)
505.1.24 by Teddy Hogeborn
* mandos-ctl (main): Correct "except:" syntax.
241
    except dbus.exceptions.DBusException:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
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
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
260
            else:
569 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
261
                print("Client not found on server: {0!r}"
262
                      .format(name), file=sys.stderr)
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
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",
24.1.179 by Björn Påhlsson
New feature:
273
                        "ApprovalDuration", "Checker",
274
                        "ExtendedTimeout")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
275
        else:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
276
            keywords = defaultkeywords
277
        
278
        print_clients(clients.values(), keywords)
279
    else:
280
        # Process each client in the list by all selected options
281
        for client in clients:
282
            if options.remove:
283
                mandos_serv.RemoveClient(client.__dbus_object_path__)
284
            if options.enable:
285
                client.Enable(dbus_interface=client_interface)
286
            if options.disable:
287
                client.Disable(dbus_interface=client_interface)
288
            if options.bump_timeout:
289
                client.CheckedOK(dbus_interface=client_interface)
290
            if options.start_checker:
291
                client.StartChecker(dbus_interface=client_interface)
292
            if options.stop_checker:
293
                client.StopChecker(dbus_interface=client_interface)
294
            if options.is_enabled:
295
                sys.exit(0 if client.Get(client_interface,
296
                                         "Enabled",
297
                                         dbus_interface=
298
                                         dbus.PROPERTIES_IFACE)
299
                         else 1)
505.1.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
300
            if options.checker is not None:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
301
                client.Set(client_interface, "Checker",
302
                           options.checker,
303
                           dbus_interface=dbus.PROPERTIES_IFACE)
505.1.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
304
            if options.host is not None:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
305
                client.Set(client_interface, "Host", options.host,
306
                           dbus_interface=dbus.PROPERTIES_IFACE)
505.1.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
307
            if options.interval is not None:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
308
                client.Set(client_interface, "Interval",
309
                           timedelta_to_milliseconds
310
                           (string_to_delta(options.interval)),
311
                           dbus_interface=dbus.PROPERTIES_IFACE)
505.1.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
312
            if options.approval_delay is not None:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
313
                client.Set(client_interface, "ApprovalDelay",
314
                           timedelta_to_milliseconds
315
                           (string_to_delta(options.
316
                                            approval_delay)),
317
                           dbus_interface=dbus.PROPERTIES_IFACE)
505.1.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
318
            if options.approval_duration is not None:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
319
                client.Set(client_interface, "ApprovalDuration",
320
                           timedelta_to_milliseconds
321
                           (string_to_delta(options.
322
                                            approval_duration)),
323
                           dbus_interface=dbus.PROPERTIES_IFACE)
505.1.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
324
            if options.timeout is not None:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
325
                client.Set(client_interface, "Timeout",
326
                           timedelta_to_milliseconds
327
                           (string_to_delta(options.timeout)),
328
                           dbus_interface=dbus.PROPERTIES_IFACE)
505.1.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
329
            if options.extended_timeout is not None:
24.1.179 by Björn Påhlsson
New feature:
330
                client.Set(client_interface, "ExtendedTimeout",
331
                           timedelta_to_milliseconds
332
                           (string_to_delta(options.extended_timeout)),
333
                           dbus_interface=dbus.PROPERTIES_IFACE)
505.1.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
334
            if options.secret is not None:
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
335
                client.Set(client_interface, "Secret",
545 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Make --secret actually work.
336
                           dbus.ByteArray(options.secret.read()),
475 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
337
                           dbus_interface=dbus.PROPERTIES_IFACE)
338
            if options.approved_by_default is not None:
339
                client.Set(client_interface, "ApprovedByDefault",
340
                           dbus.Boolean(options
341
                                        .approved_by_default),
342
                           dbus_interface=dbus.PROPERTIES_IFACE)
343
            if options.approve:
344
                client.Approve(dbus.Boolean(True),
345
                               dbus_interface=client_interface)
346
            elif options.deny:
347
                client.Approve(dbus.Boolean(False),
348
                               dbus_interface=client_interface)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
349
463.1.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
350
if __name__ == "__main__":
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
351
    main()