/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: 2016-03-13 00:37:02 UTC
  • Revision ID: teddy@recompile.se-20160313003702-dulwtwt8ilpojra9
Server: Fix bug where it did not exit timely on signals

Use GLib.unix_signal_add() instead of signal.signal() to catch
signals; this will allow GLib to do its internal magic with signal
file descriptors.  (GLib does not handle signals properly otherwise.)
The function unix_signal_add() requires GLib 2.30 or later, which was
not required by PyGobject until version 3.7.1, so depend on this.

* INSTALL (Mandos Server): Document dependency on PyGObject 3.7.1
* mandos (main): Use GLib.unix_signal_add instead of signal.signal.
* init.d-mandos (do_stop): Remove workaround.
* mandos.service ([Service]): - '' -

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-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 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)
39
38
import re
40
39
import os
41
40
import collections
42
 
import json
43
 
import unittest
44
 
import logging
 
41
import doctest
45
42
 
46
43
import dbus
47
44
 
48
 
# Show warnings by default
49
 
if not sys.warnoptions:
50
 
    import warnings
51
 
    warnings.simplefilter("default")
52
 
 
53
 
log = logging.getLogger(sys.argv[0])
54
 
logging.basicConfig(level="INFO", # Show info level messages
55
 
                    format="%(message)s") # Show basic log messages
56
 
 
57
 
logging.captureWarnings(True)   # Show warnings via the logging system
58
 
 
59
45
if sys.version_info.major == 2:
60
46
    str = unicode
61
47
 
71
57
    "Interval": "Interval",
72
58
    "Host": "Host",
73
59
    "Fingerprint": "Fingerprint",
74
 
    "KeyID": "Key ID",
75
60
    "CheckerRunning": "Check Is Running",
76
61
    "LastEnabled": "Last Enabled",
77
62
    "ApprovalPending": "Approval Is Pending",
79
64
    "ApprovalDelay": "Approval Delay",
80
65
    "ApprovalDuration": "Approval Duration",
81
66
    "Checker": "Checker",
82
 
    "ExtendedTimeout": "Extended Timeout",
83
 
    "Expires": "Expires",
84
 
    "LastCheckerStatus": "Last Checker Status",
 
67
    "ExtendedTimeout": "Extended Timeout"
85
68
}
86
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
70
domain = "se.recompile"
89
72
server_path = "/"
90
73
server_interface = domain + ".Mandos"
91
74
client_interface = domain + ".Mandos.Client"
92
 
version = "1.8.3"
 
75
version = "1.7.5"
93
76
 
94
77
 
95
78
try:
97
80
except AttributeError:
98
81
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
99
82
 
100
 
 
101
83
def milliseconds_to_string(ms):
102
84
    td = datetime.timedelta(0, 0, 0, ms)
103
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
104
 
            .format(days="{}T".format(td.days) if td.days else "",
105
 
                    hours=td.seconds // 3600,
106
 
                    minutes=(td.seconds % 3600) // 60,
107
 
                    seconds=td.seconds % 60))
 
85
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
86
        days = "{}T".format(td.days) if td.days else "",
 
87
        hours = td.seconds // 3600,
 
88
        minutes = (td.seconds % 3600) // 60,
 
89
        seconds = td.seconds % 60))
108
90
 
109
91
 
110
92
def rfc3339_duration_to_delta(duration):
111
93
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
94
    
113
95
    >>> rfc3339_duration_to_delta("P7D")
114
96
    datetime.timedelta(7)
115
97
    >>> rfc3339_duration_to_delta("PT60S")
116
98
    datetime.timedelta(0, 60)
117
99
    >>> rfc3339_duration_to_delta("PT60M")
118
100
    datetime.timedelta(0, 3600)
119
 
    >>> rfc3339_duration_to_delta("P60M")
120
 
    datetime.timedelta(1680)
121
101
    >>> rfc3339_duration_to_delta("PT24H")
122
102
    datetime.timedelta(1)
123
103
    >>> rfc3339_duration_to_delta("P1W")
126
106
    datetime.timedelta(0, 330)
127
107
    >>> rfc3339_duration_to_delta("P1DT3M20S")
128
108
    datetime.timedelta(1, 200)
129
 
    >>> # Can not be empty:
130
 
    >>> rfc3339_duration_to_delta("")
131
 
    Traceback (most recent call last):
132
 
    ...
133
 
    ValueError: Invalid RFC 3339 duration: u''
134
 
    >>> # Must start with "P":
135
 
    >>> rfc3339_duration_to_delta("1D")
136
 
    Traceback (most recent call last):
137
 
    ...
138
 
    ValueError: Invalid RFC 3339 duration: u'1D'
139
 
    >>> # Must use correct order
140
 
    >>> rfc3339_duration_to_delta("PT1S2M")
141
 
    Traceback (most recent call last):
142
 
    ...
143
 
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
144
 
    >>> # Time needs time marker
145
 
    >>> rfc3339_duration_to_delta("P1H2S")
146
 
    Traceback (most recent call last):
147
 
    ...
148
 
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
149
 
    >>> # Weeks can not be combined with anything else
150
 
    >>> rfc3339_duration_to_delta("P1D2W")
151
 
    Traceback (most recent call last):
152
 
    ...
153
 
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
154
 
    >>> rfc3339_duration_to_delta("P2W2H")
155
 
    Traceback (most recent call last):
156
 
    ...
157
 
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
158
109
    """
159
 
 
 
110
    
160
111
    # Parsing an RFC 3339 duration with regular expressions is not
161
112
    # possible - there would have to be multiple places for the same
162
113
    # values, like seconds.  The current code, while more esoteric, is
163
114
    # cleaner without depending on a parsing library.  If Python had a
164
115
    # built-in library for parsing we would use it, but we'd like to
165
116
    # avoid excessive use of external libraries.
166
 
 
 
117
    
167
118
    # New type for defining tokens, syntax, and semantics all-in-one
168
119
    Token = collections.namedtuple("Token", (
169
120
        "regexp",  # To match token; if "value" is not None, must have
202
153
                           frozenset((token_year, token_month,
203
154
                                      token_day, token_time,
204
155
                                      token_week)))
205
 
    # Define starting values:
206
 
    # Value so far
207
 
    value = datetime.timedelta()
 
156
    # Define starting values
 
157
    value = datetime.timedelta() # Value so far
208
158
    found_token = None
209
 
    # Following valid tokens
210
 
    followers = frozenset((token_duration, ))
211
 
    # String left to parse
212
 
    s = duration
 
159
    followers = frozenset((token_duration, )) # Following valid tokens
 
160
    s = duration                # String left to parse
213
161
    # Loop until end token is found
214
162
    while found_token is not token_end:
215
163
        # Search for any currently valid tokens
239
187
 
240
188
def string_to_delta(interval):
241
189
    """Parse a string and return a datetime.timedelta
 
190
    
 
191
    >>> string_to_delta('7d')
 
192
    datetime.timedelta(7)
 
193
    >>> string_to_delta('60s')
 
194
    datetime.timedelta(0, 60)
 
195
    >>> string_to_delta('60m')
 
196
    datetime.timedelta(0, 3600)
 
197
    >>> string_to_delta('24h')
 
198
    datetime.timedelta(1)
 
199
    >>> string_to_delta('1w')
 
200
    datetime.timedelta(7)
 
201
    >>> string_to_delta('5m 30s')
 
202
    datetime.timedelta(0, 330)
242
203
    """
243
 
 
 
204
    
244
205
    try:
245
206
        return rfc3339_duration_to_delta(interval)
246
 
    except ValueError as e:
247
 
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
248
 
                    ' '.join(e.args))
249
 
    return parse_pre_1_6_1_interval(interval)
250
 
 
251
 
 
252
 
def parse_pre_1_6_1_interval(interval):
253
 
    """Parse an interval string as documented by Mandos before 1.6.1, and
254
 
    return a datetime.timedelta
255
 
    >>> parse_pre_1_6_1_interval('7d')
256
 
    datetime.timedelta(7)
257
 
    >>> parse_pre_1_6_1_interval('60s')
258
 
    datetime.timedelta(0, 60)
259
 
    >>> parse_pre_1_6_1_interval('60m')
260
 
    datetime.timedelta(0, 3600)
261
 
    >>> parse_pre_1_6_1_interval('24h')
262
 
    datetime.timedelta(1)
263
 
    >>> parse_pre_1_6_1_interval('1w')
264
 
    datetime.timedelta(7)
265
 
    >>> parse_pre_1_6_1_interval('5m 30s')
266
 
    datetime.timedelta(0, 330)
267
 
    >>> parse_pre_1_6_1_interval('')
268
 
    datetime.timedelta(0)
269
 
    >>> # Ignore unknown characters, allow any order and repetitions
270
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
271
 
    datetime.timedelta(2, 480, 18000)
272
 
 
273
 
    """
274
 
 
 
207
    except ValueError:
 
208
        pass
 
209
    
275
210
    value = datetime.timedelta(0)
276
211
    regexp = re.compile(r"(\d+)([dsmhw]?)")
277
 
 
 
212
    
278
213
    for num, suffix in regexp.findall(interval):
279
214
        if suffix == "d":
280
215
            value += datetime.timedelta(int(num))
293
228
 
294
229
def print_clients(clients, keywords):
295
230
    def valuetostring(value, keyword):
296
 
        if isinstance(value, dbus.Boolean):
 
231
        if type(value) is dbus.Boolean:
297
232
            return "Yes" if value else "No"
298
233
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
299
234
                       "ApprovalDuration", "ExtendedTimeout"):
300
235
            return milliseconds_to_string(value)
301
236
        return str(value)
302
 
 
 
237
    
303
238
    # Create format string to print table rows
304
239
    format_string = " ".join("{{{key}:{width}}}".format(
305
 
        width=max(len(tablewords[key]),
306
 
                  max(len(valuetostring(client[key], key))
307
 
                      for client in clients)),
308
 
        key=key)
 
240
        width = max(len(tablewords[key]),
 
241
                    max(len(valuetostring(client[key], key))
 
242
                        for client in clients)),
 
243
        key = key)
309
244
                             for key in keywords)
310
245
    # Print header line
311
246
    print(format_string.format(**tablewords))
312
247
    for client in clients:
313
 
        print(format_string
314
 
              .format(**{key: valuetostring(client[key], key)
315
 
                         for key in keywords}))
 
248
        print(format_string.format(**{
 
249
            key: valuetostring(client[key], key)
 
250
            for key in keywords }))
316
251
 
317
252
 
318
253
def has_actions(options):
339
274
def main():
340
275
    parser = argparse.ArgumentParser()
341
276
    parser.add_argument("--version", action="version",
342
 
                        version="%(prog)s {}".format(version),
 
277
                        version = "%(prog)s {}".format(version),
343
278
                        help="show version number and exit")
344
279
    parser.add_argument("-a", "--all", action="store_true",
345
280
                        help="Select all clients")
346
281
    parser.add_argument("-v", "--verbose", action="store_true",
347
282
                        help="Print all fields")
348
 
    parser.add_argument("-j", "--dump-json", action="store_true",
349
 
                        help="Dump client data in JSON format")
350
283
    parser.add_argument("-e", "--enable", action="store_true",
351
284
                        help="Enable client")
352
285
    parser.add_argument("-d", "--disable", action="store_true",
391
324
                        help="Run self-test")
392
325
    parser.add_argument("client", nargs="*", help="Client name")
393
326
    options = parser.parse_args()
394
 
 
 
327
    
395
328
    if has_actions(options) and not (options.client or options.all):
396
329
        parser.error("Options require clients names or --all.")
397
330
    if options.verbose and has_actions(options):
398
 
        parser.error("--verbose can only be used alone.")
399
 
    if options.dump_json and (options.verbose
400
 
                              or has_actions(options)):
401
 
        parser.error("--dump-json can only be used alone.")
 
331
        parser.error("--verbose can only be used alone or with"
 
332
                     " --all.")
402
333
    if options.all and not has_actions(options):
403
334
        parser.error("--all requires an action.")
404
335
 
 
336
    if options.check:
 
337
        fail_count, test_count = doctest.testmod()
 
338
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
339
    
405
340
    try:
406
341
        bus = dbus.SystemBus()
407
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
408
343
    except dbus.exceptions.DBusException:
409
 
        log.critical("Could not connect to Mandos server")
 
344
        print("Could not connect to Mandos server", file=sys.stderr)
410
345
        sys.exit(1)
411
 
 
 
346
    
412
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
413
 
                                 dbus_interface=server_interface)
 
348
                                 dbus_interface = server_interface)
414
349
    mandos_serv_object_manager = dbus.Interface(
415
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
416
 
 
417
 
    # block stderr since dbus library prints to stderr
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
351
    
 
352
    #block stderr since dbus library prints to stderr
418
353
    null = os.open(os.path.devnull, os.O_RDWR)
419
354
    stderrcopy = os.dup(sys.stderr.fileno())
420
355
    os.dup2(null, sys.stderr.fileno())
421
356
    os.close(null)
422
357
    try:
423
358
        try:
424
 
            mandos_clients = {path: ifs_and_props[client_interface]
425
 
                              for path, ifs_and_props in
426
 
                              mandos_serv_object_manager
427
 
                              .GetManagedObjects().items()
428
 
                              if client_interface in ifs_and_props}
 
359
            mandos_clients = { path: ifs_and_props[client_interface]
 
360
                               for path, ifs_and_props in
 
361
                               mandos_serv_object_manager
 
362
                               .GetManagedObjects().items()
 
363
                               if client_interface in ifs_and_props }
429
364
        finally:
430
 
            # restore stderr
 
365
            #restore stderr
431
366
            os.dup2(stderrcopy, sys.stderr.fileno())
432
367
            os.close(stderrcopy)
433
368
    except dbus.exceptions.DBusException as e:
434
 
        log.critical("Failed to access Mandos server through D-Bus:"
435
 
                     "\n%s", e)
 
369
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
370
              .format(e), file=sys.stderr)
436
371
        sys.exit(1)
437
 
 
 
372
    
438
373
    # Compile dict of (clients: properties) to process
439
 
    clients = {}
440
 
 
 
374
    clients={}
 
375
    
441
376
    if options.all or not options.client:
442
 
        clients = {bus.get_object(busname, path): properties
443
 
                   for path, properties in mandos_clients.items()}
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
444
379
    else:
445
380
        for name in options.client:
446
381
            for path, client in mandos_clients.items():
449
384
                    clients[client_objc] = client
450
385
                    break
451
386
            else:
452
 
                log.critical("Client not found on server: %r", name)
 
387
                print("Client not found on server: {!r}"
 
388
                      .format(name), file=sys.stderr)
453
389
                sys.exit(1)
454
 
 
 
390
    
455
391
    if not has_actions(options) and clients:
456
 
        if options.verbose or options.dump_json:
 
392
        if options.verbose:
457
393
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
458
 
                        "Created", "Interval", "Host", "KeyID",
459
 
                        "Fingerprint", "CheckerRunning",
460
 
                        "LastEnabled", "ApprovalPending",
461
 
                        "ApprovedByDefault", "LastApprovalRequest",
462
 
                        "ApprovalDelay", "ApprovalDuration",
463
 
                        "Checker", "ExtendedTimeout", "Expires",
464
 
                        "LastCheckerStatus")
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
 
397
                        "LastApprovalRequest", "ApprovalDelay",
 
398
                        "ApprovalDuration", "Checker",
 
399
                        "ExtendedTimeout")
465
400
        else:
466
401
            keywords = defaultkeywords
467
 
 
468
 
        if options.dump_json:
469
 
            json.dump({client["Name"]: {key:
470
 
                                        bool(client[key])
471
 
                                        if isinstance(client[key],
472
 
                                                      dbus.Boolean)
473
 
                                        else client[key]
474
 
                                        for key in keywords}
475
 
                       for client in clients.values()},
476
 
                      fp=sys.stdout, indent=4,
477
 
                      separators=(',', ': '))
478
 
            print()
479
 
        else:
480
 
            print_clients(clients.values(), keywords)
 
402
        
 
403
        print_clients(clients.values(), keywords)
481
404
    else:
482
405
        # Process each client in the list by all selected options
483
406
        for client in clients:
484
 
 
 
407
            
485
408
            def set_client_prop(prop, value):
486
409
                """Set a Client D-Bus property"""
487
410
                client.Set(client_interface, prop, value,
488
411
                           dbus_interface=dbus.PROPERTIES_IFACE)
489
 
 
 
412
            
490
413
            def set_client_prop_ms(prop, value):
491
414
                """Set a Client D-Bus property, converted
492
415
                from a string to milliseconds."""
493
416
                set_client_prop(prop,
494
417
                                string_to_delta(value).total_seconds()
495
418
                                * 1000)
496
 
 
 
419
            
497
420
            if options.remove:
498
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
499
422
            if options.enable:
507
430
            if options.stop_checker:
508
431
                set_client_prop("CheckerRunning", dbus.Boolean(False))
509
432
            if options.is_enabled:
510
 
                if client.Get(client_interface, "Enabled",
511
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
512
 
                    sys.exit(0)
513
 
                else:
514
 
                    sys.exit(1)
 
433
                sys.exit(0 if client.Get(client_interface,
 
434
                                         "Enabled",
 
435
                                         dbus_interface=
 
436
                                         dbus.PROPERTIES_IFACE)
 
437
                         else 1)
515
438
            if options.checker is not None:
516
439
                set_client_prop("Checker", options.checker)
517
440
            if options.host is not None:
543
466
                client.Approve(dbus.Boolean(False),
544
467
                               dbus_interface=client_interface)
545
468
 
546
 
 
547
 
class Test_milliseconds_to_string(unittest.TestCase):
548
 
    def test_all(self):
549
 
        self.assertEqual(milliseconds_to_string(93785000),
550
 
                         "1T02:03:05")
551
 
    def test_no_days(self):
552
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
553
 
    def test_all_zero(self):
554
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
555
 
    def test_no_fractional_seconds(self):
556
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
557
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
558
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
559
 
 
560
 
class Test_string_to_delta(unittest.TestCase):
561
 
    def test_handles_basic_rfc3339(self):
562
 
        self.assertEqual(string_to_delta("PT2H"),
563
 
                         datetime.timedelta(0, 7200))
564
 
    def test_falls_back_to_pre_1_6_1_with_warning(self):
565
 
        # assertLogs only exists in Python 3.4
566
 
        if hasattr(self, "assertLogs"):
567
 
            with self.assertLogs(log, logging.WARNING):
568
 
                value = string_to_delta("2h")
569
 
        else:
570
 
            value = string_to_delta("2h")
571
 
        self.assertEqual(value, datetime.timedelta(0, 7200))
572
 
 
573
 
 
574
 
def should_only_run_tests():
575
 
    parser = argparse.ArgumentParser(add_help=False)
576
 
    parser.add_argument("--check", action='store_true')
577
 
    args, unknown_args = parser.parse_known_args()
578
 
    run_tests = args.check
579
 
    if run_tests:
580
 
        # Remove --check argument from sys.argv
581
 
        sys.argv[1:] = unknown_args
582
 
    return run_tests
583
 
 
584
 
# Add all tests from doctest strings
585
 
def load_tests(loader, tests, none):
586
 
    import doctest
587
 
    tests.addTests(doctest.DocTestSuite())
588
 
    return tests
589
469
 
590
470
if __name__ == "__main__":
591
 
    if should_only_run_tests():
592
 
        # Call using ./tdd-python-script --check [--verbose]
593
 
        unittest.main()
594
 
    else:
595
 
        main()
 
471
    main()