/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
 
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
3
 
#
 
2
# -*- mode: python; coding: utf-8 -*-
 
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2008-2019 Teddy Hogeborn
7
 
# Copyright © 2008-2019 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
43
 
import unittest
44
 
import logging
 
38
import doctest
45
39
 
46
40
import dbus
47
41
 
48
 
log = logging.getLogger(sys.argv[0])
49
 
logging.basicConfig(level="INFO", # Show info level messages
50
 
                    format="%(message)s") # Show basic log messages
51
 
 
52
 
if sys.version_info.major == 2:
53
 
    str = unicode
54
 
 
55
42
locale.setlocale(locale.LC_ALL, "")
56
43
 
57
44
tablewords = {
64
51
    "Interval": "Interval",
65
52
    "Host": "Host",
66
53
    "Fingerprint": "Fingerprint",
67
 
    "KeyID": "Key ID",
68
54
    "CheckerRunning": "Check Is Running",
69
55
    "LastEnabled": "Last Enabled",
70
56
    "ApprovalPending": "Approval Is Pending",
72
58
    "ApprovalDelay": "Approval Delay",
73
59
    "ApprovalDuration": "Approval Duration",
74
60
    "Checker": "Checker",
75
 
    "ExtendedTimeout": "Extended Timeout",
76
 
    "Expires": "Expires",
77
 
    "LastCheckerStatus": "Last Checker Status",
78
 
}
 
61
    "ExtendedTimeout" : "Extended Timeout"
 
62
    }
79
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
80
64
domain = "se.recompile"
81
65
busname = domain + ".Mandos"
82
66
server_path = "/"
83
67
server_interface = domain + ".Mandos"
84
68
client_interface = domain + ".Mandos.Client"
85
 
version = "1.8.3"
86
 
 
87
 
 
88
 
try:
89
 
    dbus.OBJECT_MANAGER_IFACE
90
 
except AttributeError:
91
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
92
 
 
 
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))
93
76
 
94
77
def milliseconds_to_string(ms):
95
78
    td = datetime.timedelta(0, 0, 0, ms)
96
79
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
97
 
            .format(days="{}T".format(td.days) if td.days else "",
98
 
                    hours=td.seconds // 3600,
99
 
                    minutes=(td.seconds % 3600) // 60,
100
 
                    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
                    ))
101
85
 
102
86
 
103
87
def rfc3339_duration_to_delta(duration):
104
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
105
 
 
 
89
    
106
90
    >>> rfc3339_duration_to_delta("P7D")
107
91
    datetime.timedelta(7)
108
92
    >>> rfc3339_duration_to_delta("PT60S")
118
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
119
103
    datetime.timedelta(1, 200)
120
104
    """
121
 
 
 
105
    
122
106
    # Parsing an RFC 3339 duration with regular expressions is not
123
107
    # possible - there would have to be multiple places for the same
124
108
    # values, like seconds.  The current code, while more esoteric, is
125
109
    # cleaner without depending on a parsing library.  If Python had a
126
110
    # built-in library for parsing we would use it, but we'd like to
127
111
    # avoid excessive use of external libraries.
128
 
 
 
112
    
129
113
    # New type for defining tokens, syntax, and semantics all-in-one
130
 
    Token = collections.namedtuple("Token", (
131
 
        "regexp",  # To match token; if "value" is not None, must have
132
 
                   # a "group" containing digits
133
 
        "value",   # datetime.timedelta or None
134
 
        "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
135
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
136
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
137
125
    token_end = Token(re.compile(r"$"), None, frozenset())
138
126
    token_second = Token(re.compile(r"(\d+)S"),
139
127
                         datetime.timedelta(seconds=1),
140
 
                         frozenset((token_end, )))
 
128
                         frozenset((token_end,)))
141
129
    token_minute = Token(re.compile(r"(\d+)M"),
142
130
                         datetime.timedelta(minutes=1),
143
131
                         frozenset((token_second, token_end)))
159
147
                       frozenset((token_month, token_end)))
160
148
    token_week = Token(re.compile(r"(\d+)W"),
161
149
                       datetime.timedelta(weeks=1),
162
 
                       frozenset((token_end, )))
 
150
                       frozenset((token_end,)))
163
151
    token_duration = Token(re.compile(r"P"), None,
164
152
                           frozenset((token_year, token_month,
165
153
                                      token_day, token_time,
166
 
                                      token_week)))
167
 
    # Define starting values:
168
 
    # Value so far
169
 
    value = datetime.timedelta()
 
154
                                      token_week))),
 
155
    # Define starting values
 
156
    value = datetime.timedelta() # Value so far
170
157
    found_token = None
171
 
    # Following valid tokens
172
 
    followers = frozenset((token_duration, ))
173
 
    # String left to parse
174
 
    s = duration
 
158
    followers = frozenset(token_duration,) # Following valid tokens
 
159
    s = duration                # String left to parse
175
160
    # Loop until end token is found
176
161
    while found_token is not token_end:
177
162
        # Search for any currently valid tokens
193
178
                break
194
179
        else:
195
180
            # No currently valid tokens were found
196
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
197
 
                             .format(duration))
 
181
            raise ValueError("Invalid RFC 3339 duration")
198
182
    # End token found
199
183
    return value
200
184
 
201
185
 
202
186
def string_to_delta(interval):
203
187
    """Parse a string and return a datetime.timedelta
204
 
 
205
 
    >>> string_to_delta('7d')
 
188
    
 
189
    >>> string_to_delta("7d")
206
190
    datetime.timedelta(7)
207
 
    >>> string_to_delta('60s')
 
191
    >>> string_to_delta("60s")
208
192
    datetime.timedelta(0, 60)
209
 
    >>> string_to_delta('60m')
 
193
    >>> string_to_delta("60m")
210
194
    datetime.timedelta(0, 3600)
211
 
    >>> string_to_delta('24h')
 
195
    >>> string_to_delta("24h")
212
196
    datetime.timedelta(1)
213
 
    >>> string_to_delta('1w')
 
197
    >>> string_to_delta("1w")
214
198
    datetime.timedelta(7)
215
 
    >>> string_to_delta('5m 30s')
 
199
    >>> string_to_delta("5m 30s")
216
200
    datetime.timedelta(0, 330)
217
201
    """
218
 
 
 
202
    
219
203
    try:
220
204
        return rfc3339_duration_to_delta(interval)
221
205
    except ValueError:
222
206
        pass
223
 
 
 
207
    
224
208
    value = datetime.timedelta(0)
225
209
    regexp = re.compile(r"(\d+)([dsmhw]?)")
226
 
 
 
210
    
227
211
    for num, suffix in regexp.findall(interval):
228
212
        if suffix == "d":
229
213
            value += datetime.timedelta(int(num))
239
223
            value += datetime.timedelta(0, 0, 0, int(num))
240
224
    return value
241
225
 
242
 
 
243
226
def print_clients(clients, keywords):
244
227
    def valuetostring(value, keyword):
245
228
        if type(value) is dbus.Boolean:
247
230
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
248
231
                       "ApprovalDuration", "ExtendedTimeout"):
249
232
            return milliseconds_to_string(value)
250
 
        return str(value)
251
 
 
 
233
        return unicode(value)
 
234
    
252
235
    # Create format string to print table rows
253
236
    format_string = " ".join("{{{key}:{width}}}".format(
254
 
        width=max(len(tablewords[key]),
255
 
                  max(len(valuetostring(client[key], key))
256
 
                      for client in clients)),
257
 
        key=key)
258
 
                             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)
259
243
    # Print header line
260
244
    print(format_string.format(**tablewords))
261
245
    for client in clients:
262
 
        print(format_string
263
 
              .format(**{key: valuetostring(client[key], key)
264
 
                         for key in keywords}))
265
 
 
 
246
        print(format_string.format(**dict((key,
 
247
                                           valuetostring(client[key],
 
248
                                                         key))
 
249
                                          for key in keywords)))
266
250
 
267
251
def has_actions(options):
268
252
    return any((options.enable,
284
268
                options.approve,
285
269
                options.deny))
286
270
 
287
 
 
288
271
def main():
289
272
    parser = argparse.ArgumentParser()
290
273
    parser.add_argument("--version", action="version",
291
 
                        version="%(prog)s {}".format(version),
 
274
                        version = "%(prog)s {0}".format(version),
292
275
                        help="show version number and exit")
293
276
    parser.add_argument("-a", "--all", action="store_true",
294
277
                        help="Select all clients")
295
278
    parser.add_argument("-v", "--verbose", action="store_true",
296
279
                        help="Print all fields")
297
 
    parser.add_argument("-j", "--dump-json", action="store_true",
298
 
                        help="Dump client data in JSON format")
299
280
    parser.add_argument("-e", "--enable", action="store_true",
300
281
                        help="Enable client")
301
282
    parser.add_argument("-d", "--disable", action="store_true",
329
310
    parser.add_argument("--approval-duration",
330
311
                        help="Set duration of one client approval")
331
312
    parser.add_argument("-H", "--host", help="Set host for client")
332
 
    parser.add_argument("-s", "--secret",
333
 
                        type=argparse.FileType(mode="rb"),
 
313
    parser.add_argument("-s", "--secret", type=file,
334
314
                        help="Set password blob (file) for client")
335
315
    parser.add_argument("-A", "--approve", action="store_true",
336
316
                        help="Approve any current client request")
340
320
                        help="Run self-test")
341
321
    parser.add_argument("client", nargs="*", help="Client name")
342
322
    options = parser.parse_args()
343
 
 
 
323
    
344
324
    if has_actions(options) and not (options.client or options.all):
345
325
        parser.error("Options require clients names or --all.")
346
326
    if options.verbose and has_actions(options):
347
 
        parser.error("--verbose can only be used alone.")
348
 
    if options.dump_json and (options.verbose
349
 
                              or has_actions(options)):
350
 
        parser.error("--dump-json can only be used alone.")
 
327
        parser.error("--verbose can only be used alone or with"
 
328
                     " --all.")
351
329
    if options.all and not has_actions(options):
352
330
        parser.error("--all requires an action.")
353
331
 
 
332
    if options.check:
 
333
        fail_count, test_count = doctest.testmod()
 
334
        sys.exit(0 if fail_count == 0 else 1)
 
335
    
354
336
    try:
355
337
        bus = dbus.SystemBus()
356
338
        mandos_dbus_objc = bus.get_object(busname, server_path)
357
339
    except dbus.exceptions.DBusException:
358
 
        log.critical("Could not connect to Mandos server")
 
340
        print("Could not connect to Mandos server",
 
341
              file=sys.stderr)
359
342
        sys.exit(1)
360
 
 
 
343
    
361
344
    mandos_serv = dbus.Interface(mandos_dbus_objc,
362
 
                                 dbus_interface=server_interface)
363
 
    mandos_serv_object_manager = dbus.Interface(
364
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
365
 
 
366
 
    # block stderr since dbus library prints to stderr
 
345
                                 dbus_interface = server_interface)
 
346
    
 
347
    #block stderr since dbus library prints to stderr
367
348
    null = os.open(os.path.devnull, os.O_RDWR)
368
349
    stderrcopy = os.dup(sys.stderr.fileno())
369
350
    os.dup2(null, sys.stderr.fileno())
370
351
    os.close(null)
371
352
    try:
372
353
        try:
373
 
            mandos_clients = {path: ifs_and_props[client_interface]
374
 
                              for path, ifs_and_props in
375
 
                              mandos_serv_object_manager
376
 
                              .GetManagedObjects().items()
377
 
                              if client_interface in ifs_and_props}
 
354
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
378
355
        finally:
379
 
            # restore stderr
 
356
            #restore stderr
380
357
            os.dup2(stderrcopy, sys.stderr.fileno())
381
358
            os.close(stderrcopy)
382
 
    except dbus.exceptions.DBusException as e:
383
 
        log.critical("Failed to access Mandos server through D-Bus:"
384
 
                     "\n%s", e)
 
359
    except dbus.exceptions.DBusException:
 
360
        print("Access denied: Accessing mandos server through dbus.",
 
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
 
                log.critical("Client not found on server: %r", name)
 
379
                print("Client not found on server: {0!r}"
 
380
                      .format(name), file=sys.stderr)
402
381
                sys.exit(1)
403
 
 
 
382
    
404
383
    if not has_actions(options) and clients:
405
 
        if options.verbose or options.dump_json:
406
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
 
                        "Created", "Interval", "Host", "KeyID",
408
 
                        "Fingerprint", "CheckerRunning",
 
384
        if options.verbose:
 
385
            keywords = ("Name", "Enabled", "Timeout",
 
386
                        "LastCheckedOK", "Created", "Interval",
 
387
                        "Host", "Fingerprint", "CheckerRunning",
409
388
                        "LastEnabled", "ApprovalPending",
410
 
                        "ApprovedByDefault", "LastApprovalRequest",
411
 
                        "ApprovalDelay", "ApprovalDuration",
412
 
                        "Checker", "ExtendedTimeout", "Expires",
413
 
                        "LastCheckerStatus")
 
389
                        "ApprovedByDefault",
 
390
                        "LastApprovalRequest", "ApprovalDelay",
 
391
                        "ApprovalDuration", "Checker",
 
392
                        "ExtendedTimeout")
414
393
        else:
415
394
            keywords = defaultkeywords
416
 
 
417
 
        if options.dump_json:
418
 
            json.dump({client["Name"]: {key:
419
 
                                        bool(client[key])
420
 
                                        if isinstance(client[key],
421
 
                                                      dbus.Boolean)
422
 
                                        else client[key]
423
 
                                        for key in keywords}
424
 
                       for client in clients.values()},
425
 
                      fp=sys.stdout, indent=4,
426
 
                      separators=(',', ': '))
427
 
            print()
428
 
        else:
429
 
            print_clients(clients.values(), keywords)
 
395
        
 
396
        print_clients(clients.values(), keywords)
430
397
    else:
431
398
        # Process each client in the list by all selected options
432
399
        for client in clients:
433
 
 
434
400
            def set_client_prop(prop, value):
435
401
                """Set a Client D-Bus property"""
436
402
                client.Set(client_interface, prop, value,
437
403
                           dbus_interface=dbus.PROPERTIES_IFACE)
438
 
 
439
404
            def set_client_prop_ms(prop, value):
440
405
                """Set a Client D-Bus property, converted
441
406
                from a string to milliseconds."""
442
407
                set_client_prop(prop,
443
 
                                string_to_delta(value).total_seconds()
444
 
                                * 1000)
445
 
 
 
408
                                timedelta_to_milliseconds
 
409
                                (string_to_delta(value)))
446
410
            if options.remove:
447
411
                mandos_serv.RemoveClient(client.__dbus_object_path__)
448
412
            if options.enable:
456
420
            if options.stop_checker:
457
421
                set_client_prop("CheckerRunning", dbus.Boolean(False))
458
422
            if options.is_enabled:
459
 
                if client.Get(client_interface, "Enabled",
460
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
461
 
                    sys.exit(0)
462
 
                else:
463
 
                    sys.exit(1)
 
423
                sys.exit(0 if client.Get(client_interface,
 
424
                                         "Enabled",
 
425
                                         dbus_interface=
 
426
                                         dbus.PROPERTIES_IFACE)
 
427
                         else 1)
464
428
            if options.checker is not None:
465
429
                set_client_prop("Checker", options.checker)
466
430
            if options.host is not None:
492
456
                client.Approve(dbus.Boolean(False),
493
457
                               dbus_interface=client_interface)
494
458
 
495
 
 
496
 
class Test_milliseconds_to_string(unittest.TestCase):
497
 
    def test_all(self):
498
 
        self.assertEqual(milliseconds_to_string(93785000),
499
 
                         "1T02:03:05")
500
 
    def test_no_days(self):
501
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
502
 
    def test_all_zero(self):
503
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
504
 
    def test_no_fractional_seconds(self):
505
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
506
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
507
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
508
 
 
509
 
 
510
 
def should_only_run_tests():
511
 
    parser = argparse.ArgumentParser(add_help=False)
512
 
    parser.add_argument("--check", action='store_true')
513
 
    args, unknown_args = parser.parse_known_args()
514
 
    run_tests = args.check
515
 
    if run_tests:
516
 
        # Remove --check argument from sys.argv
517
 
        sys.argv[1:] = unknown_args
518
 
    return run_tests
519
 
 
520
 
# Add all tests from doctest strings
521
 
def load_tests(loader, tests, none):
522
 
    import doctest
523
 
    tests.addTests(doctest.DocTestSuite())
524
 
    return tests
525
 
 
526
459
if __name__ == "__main__":
527
 
    if should_only_run_tests():
528
 
        # Call using ./tdd-python-script --check [--verbose]
529
 
        unittest.main()
530
 
    else:
531
 
        main()
 
460
    main()