/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: Teddy Hogeborn
  • Date: 2014-02-16 13:42:31 UTC
  • mfrom: (237.4.41 release)
  • Revision ID: teddy@recompile.se-20140216134231-004xahgq7u4xpbvz
Merge from release branch.

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
 
#
 
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2008-2018 Teddy Hogeborn
7
 
# Copyright © 2008-2018 Björn Påhlsson
8
 
#
9
 
# This file is part of Mandos.
10
 
#
11
 
# Mandos is free software: you can redistribute it and/or modify it
12
 
# under the terms of the GNU General Public License as published by
 
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
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
17
#     GNU General Public License for more details.
20
 
#
 
18
# 
21
19
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
23
 
#
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
24
23
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
24
# 
26
25
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
29
28
 
30
 
try:
31
 
    from future_builtins import *
32
 
except ImportError:
33
 
    pass
 
29
from future_builtins import *
34
30
 
35
31
import sys
36
32
import argparse
39
35
import re
40
36
import os
41
37
import collections
42
 
import json
 
38
import doctest
43
39
 
44
40
import dbus
45
41
 
46
 
if sys.version_info.major == 2:
47
 
    str = unicode
48
 
 
49
42
locale.setlocale(locale.LC_ALL, "")
50
43
 
51
44
tablewords = {
58
51
    "Interval": "Interval",
59
52
    "Host": "Host",
60
53
    "Fingerprint": "Fingerprint",
61
 
    "KeyID": "Key ID",
62
54
    "CheckerRunning": "Check Is Running",
63
55
    "LastEnabled": "Last Enabled",
64
56
    "ApprovalPending": "Approval Is Pending",
66
58
    "ApprovalDelay": "Approval Delay",
67
59
    "ApprovalDuration": "Approval Duration",
68
60
    "Checker": "Checker",
69
 
    "ExtendedTimeout": "Extended Timeout",
70
 
    "Expires": "Expires",
71
 
    "LastCheckerStatus": "Last Checker Status",
72
 
}
 
61
    "ExtendedTimeout" : "Extended Timeout"
 
62
    }
73
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
74
64
domain = "se.recompile"
75
65
busname = domain + ".Mandos"
76
66
server_path = "/"
77
67
server_interface = domain + ".Mandos"
78
68
client_interface = domain + ".Mandos.Client"
79
 
version = "1.7.20"
80
 
 
81
 
 
82
 
try:
83
 
    dbus.OBJECT_MANAGER_IFACE
84
 
except AttributeError:
85
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
86
 
 
 
69
version = "1.6.4"
 
70
 
 
71
def timedelta_to_milliseconds(td):
 
72
    """Convert a datetime.timedelta object to milliseconds"""
 
73
    return ((td.days * 24 * 60 * 60 * 1000)
 
74
            + (td.seconds * 1000)
 
75
            + (td.microseconds // 1000))
87
76
 
88
77
def milliseconds_to_string(ms):
89
78
    td = datetime.timedelta(0, 0, 0, ms)
90
79
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
91
 
            .format(days="{}T".format(td.days) if td.days else "",
92
 
                    hours=td.seconds // 3600,
93
 
                    minutes=(td.seconds % 3600) // 60,
94
 
                    seconds=td.seconds % 60))
 
80
            .format(days = "{0}T".format(td.days) if td.days else "",
 
81
                    hours = td.seconds // 3600,
 
82
                    minutes = (td.seconds % 3600) // 60,
 
83
                    seconds = td.seconds % 60,
 
84
                    ))
95
85
 
96
86
 
97
87
def rfc3339_duration_to_delta(duration):
98
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
99
 
 
 
89
    
100
90
    >>> rfc3339_duration_to_delta("P7D")
101
91
    datetime.timedelta(7)
102
92
    >>> rfc3339_duration_to_delta("PT60S")
112
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
113
103
    datetime.timedelta(1, 200)
114
104
    """
115
 
 
 
105
    
116
106
    # Parsing an RFC 3339 duration with regular expressions is not
117
107
    # possible - there would have to be multiple places for the same
118
108
    # values, like seconds.  The current code, while more esoteric, is
119
109
    # cleaner without depending on a parsing library.  If Python had a
120
110
    # built-in library for parsing we would use it, but we'd like to
121
111
    # avoid excessive use of external libraries.
122
 
 
 
112
    
123
113
    # New type for defining tokens, syntax, and semantics all-in-one
124
 
    Token = collections.namedtuple("Token", (
125
 
        "regexp",  # To match token; if "value" is not None, must have
126
 
                   # a "group" containing digits
127
 
        "value",   # datetime.timedelta or None
128
 
        "followers"))           # Tokens valid after this token
 
114
    Token = collections.namedtuple("Token",
 
115
                                   ("regexp", # To match token; if
 
116
                                              # "value" is not None,
 
117
                                              # must have a "group"
 
118
                                              # containing digits
 
119
                                    "value",  # datetime.timedelta or
 
120
                                              # None
 
121
                                    "followers")) # Tokens valid after
 
122
                                                  # this token
129
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
130
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
131
125
    token_end = Token(re.compile(r"$"), None, frozenset())
132
126
    token_second = Token(re.compile(r"(\d+)S"),
133
127
                         datetime.timedelta(seconds=1),
134
 
                         frozenset((token_end, )))
 
128
                         frozenset((token_end,)))
135
129
    token_minute = Token(re.compile(r"(\d+)M"),
136
130
                         datetime.timedelta(minutes=1),
137
131
                         frozenset((token_second, token_end)))
153
147
                       frozenset((token_month, token_end)))
154
148
    token_week = Token(re.compile(r"(\d+)W"),
155
149
                       datetime.timedelta(weeks=1),
156
 
                       frozenset((token_end, )))
 
150
                       frozenset((token_end,)))
157
151
    token_duration = Token(re.compile(r"P"), None,
158
152
                           frozenset((token_year, token_month,
159
153
                                      token_day, token_time,
160
 
                                      token_week)))
161
 
    # Define starting values:
162
 
    # Value so far
163
 
    value = datetime.timedelta()
 
154
                                      token_week))),
 
155
    # Define starting values
 
156
    value = datetime.timedelta() # Value so far
164
157
    found_token = None
165
 
    # Following valid tokens
166
 
    followers = frozenset((token_duration, ))
167
 
    # String left to parse
168
 
    s = duration
 
158
    followers = frozenset(token_duration,) # Following valid tokens
 
159
    s = duration                # String left to parse
169
160
    # Loop until end token is found
170
161
    while found_token is not token_end:
171
162
        # Search for any currently valid tokens
187
178
                break
188
179
        else:
189
180
            # No currently valid tokens were found
190
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
191
 
                             .format(duration))
 
181
            raise ValueError("Invalid RFC 3339 duration")
192
182
    # End token found
193
183
    return value
194
184
 
195
185
 
196
186
def string_to_delta(interval):
197
187
    """Parse a string and return a datetime.timedelta
198
 
 
199
 
    >>> string_to_delta('7d')
 
188
    
 
189
    >>> string_to_delta("7d")
200
190
    datetime.timedelta(7)
201
 
    >>> string_to_delta('60s')
 
191
    >>> string_to_delta("60s")
202
192
    datetime.timedelta(0, 60)
203
 
    >>> string_to_delta('60m')
 
193
    >>> string_to_delta("60m")
204
194
    datetime.timedelta(0, 3600)
205
 
    >>> string_to_delta('24h')
 
195
    >>> string_to_delta("24h")
206
196
    datetime.timedelta(1)
207
 
    >>> string_to_delta('1w')
 
197
    >>> string_to_delta("1w")
208
198
    datetime.timedelta(7)
209
 
    >>> string_to_delta('5m 30s')
 
199
    >>> string_to_delta("5m 30s")
210
200
    datetime.timedelta(0, 330)
211
201
    """
212
 
 
 
202
    
213
203
    try:
214
204
        return rfc3339_duration_to_delta(interval)
215
205
    except ValueError:
216
206
        pass
217
 
 
 
207
    
218
208
    value = datetime.timedelta(0)
219
209
    regexp = re.compile(r"(\d+)([dsmhw]?)")
220
 
 
 
210
    
221
211
    for num, suffix in regexp.findall(interval):
222
212
        if suffix == "d":
223
213
            value += datetime.timedelta(int(num))
233
223
            value += datetime.timedelta(0, 0, 0, int(num))
234
224
    return value
235
225
 
236
 
 
237
226
def print_clients(clients, keywords):
238
227
    def valuetostring(value, keyword):
239
228
        if type(value) is dbus.Boolean:
241
230
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
242
231
                       "ApprovalDuration", "ExtendedTimeout"):
243
232
            return milliseconds_to_string(value)
244
 
        return str(value)
245
 
 
 
233
        return unicode(value)
 
234
    
246
235
    # Create format string to print table rows
247
236
    format_string = " ".join("{{{key}:{width}}}".format(
248
 
        width=max(len(tablewords[key]),
249
 
                  max(len(valuetostring(client[key], key))
250
 
                      for client in clients)),
251
 
        key=key)
252
 
                             for key in keywords)
 
237
            width = max(len(tablewords[key]),
 
238
                        max(len(valuetostring(client[key],
 
239
                                              key))
 
240
                            for client in
 
241
                            clients)),
 
242
            key = key) for key in keywords)
253
243
    # Print header line
254
244
    print(format_string.format(**tablewords))
255
245
    for client in clients:
256
 
        print(format_string
257
 
              .format(**{key: valuetostring(client[key], key)
258
 
                         for key in keywords}))
259
 
 
 
246
        print(format_string.format(**dict((key,
 
247
                                           valuetostring(client[key],
 
248
                                                         key))
 
249
                                          for key in keywords)))
260
250
 
261
251
def has_actions(options):
262
252
    return any((options.enable,
278
268
                options.approve,
279
269
                options.deny))
280
270
 
281
 
 
282
271
def main():
283
272
    parser = argparse.ArgumentParser()
284
273
    parser.add_argument("--version", action="version",
285
 
                        version="%(prog)s {}".format(version),
 
274
                        version = "%(prog)s {0}".format(version),
286
275
                        help="show version number and exit")
287
276
    parser.add_argument("-a", "--all", action="store_true",
288
277
                        help="Select all clients")
289
278
    parser.add_argument("-v", "--verbose", action="store_true",
290
279
                        help="Print all fields")
291
 
    parser.add_argument("-j", "--dump-json", action="store_true",
292
 
                        help="Dump client data in JSON format")
293
280
    parser.add_argument("-e", "--enable", action="store_true",
294
281
                        help="Enable client")
295
282
    parser.add_argument("-d", "--disable", action="store_true",
323
310
    parser.add_argument("--approval-duration",
324
311
                        help="Set duration of one client approval")
325
312
    parser.add_argument("-H", "--host", help="Set host for client")
326
 
    parser.add_argument("-s", "--secret",
327
 
                        type=argparse.FileType(mode="rb"),
 
313
    parser.add_argument("-s", "--secret", type=file,
328
314
                        help="Set password blob (file) for client")
329
315
    parser.add_argument("-A", "--approve", action="store_true",
330
316
                        help="Approve any current client request")
334
320
                        help="Run self-test")
335
321
    parser.add_argument("client", nargs="*", help="Client name")
336
322
    options = parser.parse_args()
337
 
 
 
323
    
338
324
    if has_actions(options) and not (options.client or options.all):
339
325
        parser.error("Options require clients names or --all.")
340
326
    if options.verbose and has_actions(options):
341
 
        parser.error("--verbose can only be used alone.")
342
 
    if options.dump_json and (options.verbose
343
 
                              or has_actions(options)):
344
 
        parser.error("--dump-json can only be used alone.")
 
327
        parser.error("--verbose can only be used alone or with"
 
328
                     " --all.")
345
329
    if options.all and not has_actions(options):
346
330
        parser.error("--all requires an action.")
347
331
 
348
332
    if options.check:
349
 
        import doctest
350
333
        fail_count, test_count = doctest.testmod()
351
334
        sys.exit(os.EX_OK if fail_count == 0 else 1)
352
 
 
 
335
    
353
336
    try:
354
337
        bus = dbus.SystemBus()
355
338
        mandos_dbus_objc = bus.get_object(busname, server_path)
356
339
    except dbus.exceptions.DBusException:
357
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
340
        print("Could not connect to Mandos server",
 
341
              file=sys.stderr)
358
342
        sys.exit(1)
359
 
 
 
343
    
360
344
    mandos_serv = dbus.Interface(mandos_dbus_objc,
361
 
                                 dbus_interface=server_interface)
362
 
    mandos_serv_object_manager = dbus.Interface(
363
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
364
 
 
365
 
    # block stderr since dbus library prints to stderr
 
345
                                 dbus_interface = server_interface)
 
346
    
 
347
    #block stderr since dbus library prints to stderr
366
348
    null = os.open(os.path.devnull, os.O_RDWR)
367
349
    stderrcopy = os.dup(sys.stderr.fileno())
368
350
    os.dup2(null, sys.stderr.fileno())
369
351
    os.close(null)
370
352
    try:
371
353
        try:
372
 
            mandos_clients = {path: ifs_and_props[client_interface]
373
 
                              for path, ifs_and_props in
374
 
                              mandos_serv_object_manager
375
 
                              .GetManagedObjects().items()
376
 
                              if client_interface in ifs_and_props}
 
354
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
377
355
        finally:
378
 
            # restore stderr
 
356
            #restore stderr
379
357
            os.dup2(stderrcopy, sys.stderr.fileno())
380
358
            os.close(stderrcopy)
381
 
    except dbus.exceptions.DBusException as e:
382
 
        print("Access denied: "
383
 
              "Accessing mandos server through D-Bus: {}".format(e),
 
359
    except dbus.exceptions.DBusException:
 
360
        print("Access denied: Accessing mandos server through dbus.",
384
361
              file=sys.stderr)
385
362
        sys.exit(1)
386
 
 
 
363
    
387
364
    # Compile dict of (clients: properties) to process
388
 
    clients = {}
389
 
 
 
365
    clients={}
 
366
    
390
367
    if options.all or not options.client:
391
 
        clients = {bus.get_object(busname, path): properties
392
 
                   for path, properties in mandos_clients.items()}
 
368
        clients = dict((bus.get_object(busname, path), properties)
 
369
                       for path, properties in
 
370
                       mandos_clients.iteritems())
393
371
    else:
394
372
        for name in options.client:
395
 
            for path, client in mandos_clients.items():
 
373
            for path, client in mandos_clients.iteritems():
396
374
                if client["Name"] == name:
397
375
                    client_objc = bus.get_object(busname, path)
398
376
                    clients[client_objc] = client
399
377
                    break
400
378
            else:
401
 
                print("Client not found on server: {!r}"
 
379
                print("Client not found on server: {0!r}"
402
380
                      .format(name), file=sys.stderr)
403
381
                sys.exit(1)
404
 
 
 
382
    
405
383
    if not has_actions(options) and clients:
406
 
        if options.verbose or options.dump_json:
407
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
408
 
                        "Created", "Interval", "Host", "KeyID",
409
 
                        "Fingerprint", "CheckerRunning",
 
384
        if options.verbose:
 
385
            keywords = ("Name", "Enabled", "Timeout",
 
386
                        "LastCheckedOK", "Created", "Interval",
 
387
                        "Host", "Fingerprint", "CheckerRunning",
410
388
                        "LastEnabled", "ApprovalPending",
411
 
                        "ApprovedByDefault", "LastApprovalRequest",
412
 
                        "ApprovalDelay", "ApprovalDuration",
413
 
                        "Checker", "ExtendedTimeout", "Expires",
414
 
                        "LastCheckerStatus")
 
389
                        "ApprovedByDefault",
 
390
                        "LastApprovalRequest", "ApprovalDelay",
 
391
                        "ApprovalDuration", "Checker",
 
392
                        "ExtendedTimeout")
415
393
        else:
416
394
            keywords = defaultkeywords
417
 
 
418
 
        if options.dump_json:
419
 
            json.dump({client["Name"]: {key:
420
 
                                        bool(client[key])
421
 
                                        if isinstance(client[key],
422
 
                                                      dbus.Boolean)
423
 
                                        else client[key]
424
 
                                        for key in keywords}
425
 
                       for client in clients.values()},
426
 
                      fp=sys.stdout, indent=4,
427
 
                      separators=(',', ': '))
428
 
            print()
429
 
        else:
430
 
            print_clients(clients.values(), keywords)
 
395
        
 
396
        print_clients(clients.values(), keywords)
431
397
    else:
432
398
        # Process each client in the list by all selected options
433
399
        for client in clients:
434
 
 
435
400
            def set_client_prop(prop, value):
436
401
                """Set a Client D-Bus property"""
437
402
                client.Set(client_interface, prop, value,
438
403
                           dbus_interface=dbus.PROPERTIES_IFACE)
439
 
 
440
404
            def set_client_prop_ms(prop, value):
441
405
                """Set a Client D-Bus property, converted
442
406
                from a string to milliseconds."""
443
407
                set_client_prop(prop,
444
 
                                string_to_delta(value).total_seconds()
445
 
                                * 1000)
446
 
 
 
408
                                timedelta_to_milliseconds
 
409
                                (string_to_delta(value)))
447
410
            if options.remove:
448
411
                mandos_serv.RemoveClient(client.__dbus_object_path__)
449
412
            if options.enable:
457
420
            if options.stop_checker:
458
421
                set_client_prop("CheckerRunning", dbus.Boolean(False))
459
422
            if options.is_enabled:
460
 
                if client.Get(client_interface, "Enabled",
461
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
462
 
                    sys.exit(0)
463
 
                else:
464
 
                    sys.exit(1)
 
423
                sys.exit(0 if client.Get(client_interface,
 
424
                                         "Enabled",
 
425
                                         dbus_interface=
 
426
                                         dbus.PROPERTIES_IFACE)
 
427
                         else 1)
465
428
            if options.checker is not None:
466
429
                set_client_prop("Checker", options.checker)
467
430
            if options.host is not None:
493
456
                client.Approve(dbus.Boolean(False),
494
457
                               dbus_interface=client_interface)
495
458
 
496
 
 
497
459
if __name__ == "__main__":
498
460
    main()