/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-01-06 15:56:54 UTC
  • Revision ID: teddy@recompile.se-20140106155654-urx23ytuvy0nxzwp
Update init script to modern standards.

* init.d-mandos (status): Moved to standard location.  Re-added use of
                          -p switch compared to skeleton file.
  (*): Update message to include "status".

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