/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

  • Committer: Teddy Hogeborn
  • Date: 2019-08-02 22:16:53 UTC
  • Revision ID: teddy@recompile.se-20190802221653-ic1iko9hbefzwsk7
Fix bug in server Debian package: Fails to start on first install

There has been a very long-standing bug where installation of the
server (the "mandos" Debian package) would fail to start the server
properly right after installation.  It would work on manual (re)start
after installation, or after reboot, and even after package purge and
reinstall, it would then work the first time.  The problem, it turns
out, is when the new "_mandos" user (and corresponding group) is
created, the D-Bus server is not reloaded, and is therefore not aware
of that user, and does not recognize the user and group name in the
/etc/dbus-1/system.d/mandos.conf file.  The Mandos server, when it
tries to start and access the D-Bus, is then not permitted to connect
to its D-Bus bus name, and disables D-Bus use as a fallback measure;
i.e. the server works, but it is not controllable via D-Bus commands
(via mandos-ctl or mandos-monitor).  The next time the D-Bus daemon is
reloaded for any reason, the new user & group would become visible to
the D-Bus daemon and after that, any restart of the Mandos server
would succeed and it would bind to its D-Bus name properly, and
thereby be visible and controllable by mandos-ctl & mandos-monitor.
This was mostly invisible when using sysvinit, but systemd makes the
problem visible since the systemd service file for the Mandos server
is configured to not consider the Mandos server "started" until the
D-Bus name has been bound; this makes the starting of the service wait
for 90 seconds and then fail with a timeout error.

Fixing this should also make the Debian CI autopkgtest tests work.

* debian/mandos.postinst (configure): After creating (or renaming)
                                      user & group, reload D-Bus
                                      daemon (if present).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
1
 
#!/usr/bin/python3 -bI
2
 
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
 
1
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
77
77
import itertools
78
78
import collections
79
79
import codecs
80
 
import unittest
81
 
import random
82
 
import shlex
83
80
 
84
81
import dbus
85
82
import dbus.service
86
 
import gi
87
83
from gi.repository import GLib
88
84
from dbus.mainloop.glib import DBusGMainLoop
89
85
import ctypes
91
87
import xml.dom.minidom
92
88
import inspect
93
89
 
94
 
if sys.version_info.major == 2:
95
 
    __metaclass__ = type
96
 
    str = unicode
97
 
 
98
 
# Add collections.abc.Callable if it does not exist
99
 
try:
100
 
    collections.abc.Callable
101
 
except AttributeError:
102
 
    class abc:
103
 
        Callable = collections.Callable
104
 
    collections.abc = abc
105
 
    del abc
106
 
 
107
 
# Add shlex.quote if it does not exist
108
 
try:
109
 
    shlex.quote
110
 
except AttributeError:
111
 
    shlex.quote = re.escape
112
 
 
113
 
# Show warnings by default
114
 
if not sys.warnoptions:
115
 
    import warnings
116
 
    warnings.simplefilter("default")
117
 
 
118
90
# Try to find the value of SO_BINDTODEVICE:
119
91
try:
120
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
140
112
            # No value found
141
113
            SO_BINDTODEVICE = None
142
114
 
143
 
if sys.version_info < (3, 2):
144
 
    configparser.Configparser = configparser.SafeConfigParser
 
115
if sys.version_info.major == 2:
 
116
    str = unicode
145
117
 
146
 
version = "1.8.9"
 
118
version = "1.8.5"
147
119
stored_state_file = "clients.pickle"
148
120
 
149
121
logger = logging.getLogger()
150
 
logging.captureWarnings(True)   # Show warnings via the logging system
151
122
syslogger = None
152
123
 
153
124
try:
208
179
    pass
209
180
 
210
181
 
211
 
class PGPEngine:
 
182
class PGPEngine(object):
212
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
213
184
 
214
185
    def __init__(self):
218
189
            output = subprocess.check_output(["gpgconf"])
219
190
            for line in output.splitlines():
220
191
                name, text, path = line.split(b":")
221
 
                if name == b"gpg":
 
192
                if name == "gpg":
222
193
                    self.gpg = path
223
194
                    break
224
195
        except OSError as e:
229
200
                          '--force-mdc',
230
201
                          '--quiet']
231
202
        # Only GPG version 1 has the --no-use-agent option.
232
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
233
204
            self.gnupgargs.append("--no-use-agent")
234
205
 
235
206
    def __enter__(self):
304
275
 
305
276
 
306
277
# Pretend that we have an Avahi module
307
 
class avahi:
 
278
class avahi(object):
308
279
    """This isn't so much a class as it is a module-like namespace."""
309
280
    IF_UNSPEC = -1               # avahi-common/address.h
310
281
    PROTO_UNSPEC = -1            # avahi-common/address.h
344
315
    pass
345
316
 
346
317
 
347
 
class AvahiService:
 
318
class AvahiService(object):
348
319
    """An Avahi (Zeroconf) service.
349
320
 
350
321
    Attributes:
532
503
 
533
504
 
534
505
# Pretend that we have a GnuTLS module
535
 
class gnutls:
 
506
class gnutls(object):
536
507
    """This isn't so much a class as it is a module-like namespace."""
537
508
 
538
509
    library = ctypes.util.find_library("gnutls")
601
572
        pass
602
573
 
603
574
    # Classes
604
 
    class Credentials:
 
575
    class Credentials(object):
605
576
        def __init__(self):
606
577
            self._c_object = gnutls.certificate_credentials_t()
607
578
            gnutls.certificate_allocate_credentials(
611
582
        def __del__(self):
612
583
            gnutls.certificate_free_credentials(self._c_object)
613
584
 
614
 
    class ClientSession:
 
585
    class ClientSession(object):
615
586
        def __init__(self, socket, credentials=None):
616
587
            self._c_object = gnutls.session_t()
617
588
            gnutls_flags = gnutls.CLIENT
843
814
    connection.close()
844
815
 
845
816
 
846
 
class Client:
 
817
class Client(object):
847
818
    """A representation of a client host served by this server.
848
819
 
849
820
    Attributes:
1052
1023
        if self.checker_initiator_tag is not None:
1053
1024
            GLib.source_remove(self.checker_initiator_tag)
1054
1025
        self.checker_initiator_tag = GLib.timeout_add(
1055
 
            random.randrange(int(self.interval.total_seconds() * 1000
1056
 
                                 + 1)),
 
1026
            int(self.interval.total_seconds() * 1000),
1057
1027
            self.start_checker)
1058
1028
        # Schedule a disable() when 'timeout' has passed
1059
1029
        if self.disable_initiator_tag is not None:
1069
1039
        # Read return code from connection (see call_pipe)
1070
1040
        returncode = connection.recv()
1071
1041
        connection.close()
1072
 
        if self.checker is not None:
1073
 
            self.checker.join()
 
1042
        self.checker.join()
1074
1043
        self.checker_callback_tag = None
1075
1044
        self.checker = None
1076
1045
 
1134
1103
        if self.checker is None:
1135
1104
            # Escape attributes for the shell
1136
1105
            escaped_attrs = {
1137
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1106
                attr: re.escape(str(getattr(self, attr)))
1138
1107
                for attr in self.runtime_expansions}
1139
1108
            try:
1140
1109
                command = self.checker_command % escaped_attrs
1167
1136
                kwargs=popen_args)
1168
1137
            self.checker.start()
1169
1138
            self.checker_callback_tag = GLib.io_add_watch(
1170
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1171
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1139
                pipe[0].fileno(), GLib.IO_IN,
1172
1140
                self.checker_callback, pipe[0], command)
1173
1141
        # Re-run this periodically if run by GLib.timeout_add
1174
1142
        return True
1429
1397
                raise ValueError("Byte arrays not supported for non-"
1430
1398
                                 "'ay' signature {!r}"
1431
1399
                                 .format(prop._dbus_signature))
1432
 
            value = dbus.ByteArray(bytes(value))
 
1400
            value = dbus.ByteArray(b''.join(chr(byte)
 
1401
                                            for byte in value))
1433
1402
        prop(value)
1434
1403
 
1435
1404
    @dbus.service.method(dbus.PROPERTIES_IFACE,
2240
2209
    del _interface
2241
2210
 
2242
2211
 
2243
 
class ProxyClient:
 
2212
class ProxyClient(object):
2244
2213
    def __init__(self, child_pipe, key_id, fpr, address):
2245
2214
        self._pipe = child_pipe
2246
2215
        self._pipe.send(('init', key_id, fpr, address))
2519
2488
        return hex_fpr
2520
2489
 
2521
2490
 
2522
 
class MultiprocessingMixIn:
 
2491
class MultiprocessingMixIn(object):
2523
2492
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2524
2493
 
2525
2494
    def sub_process_main(self, request, address):
2537
2506
        return proc
2538
2507
 
2539
2508
 
2540
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2509
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2541
2510
    """ adds a pipe to the MixIn """
2542
2511
 
2543
2512
    def process_request(self, request, client_address):
2558
2527
 
2559
2528
 
2560
2529
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2561
 
                     socketserver.TCPServer):
 
2530
                     socketserver.TCPServer, object):
2562
2531
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2563
2532
 
2564
2533
    Attributes:
2697
2666
    def add_pipe(self, parent_pipe, proc):
2698
2667
        # Call "handle_ipc" for both data and EOF events
2699
2668
        GLib.io_add_watch(
2700
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2701
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2669
            parent_pipe.fileno(),
 
2670
            GLib.IO_IN | GLib.IO_HUP,
2702
2671
            functools.partial(self.handle_ipc,
2703
2672
                              parent_pipe=parent_pipe,
2704
2673
                              proc=proc))
2742
2711
                return False
2743
2712
 
2744
2713
            GLib.io_add_watch(
2745
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2746
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2714
                parent_pipe.fileno(),
 
2715
                GLib.IO_IN | GLib.IO_HUP,
2747
2716
                functools.partial(self.handle_ipc,
2748
2717
                                  parent_pipe=parent_pipe,
2749
2718
                                  proc=proc,
2764
2733
        if command == 'getattr':
2765
2734
            attrname = request[1]
2766
2735
            if isinstance(client_object.__getattribute__(attrname),
2767
 
                          collections.abc.Callable):
 
2736
                          collections.Callable):
2768
2737
                parent_pipe.send(('function', ))
2769
2738
            else:
2770
2739
                parent_pipe.send((
2781
2750
def rfc3339_duration_to_delta(duration):
2782
2751
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2783
2752
 
2784
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2785
 
    True
2786
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2787
 
    True
2788
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2789
 
    True
2790
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2791
 
    True
2792
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2793
 
    True
2794
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2795
 
    True
2796
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2797
 
    True
 
2753
    >>> rfc3339_duration_to_delta("P7D")
 
2754
    datetime.timedelta(7)
 
2755
    >>> rfc3339_duration_to_delta("PT60S")
 
2756
    datetime.timedelta(0, 60)
 
2757
    >>> rfc3339_duration_to_delta("PT60M")
 
2758
    datetime.timedelta(0, 3600)
 
2759
    >>> rfc3339_duration_to_delta("PT24H")
 
2760
    datetime.timedelta(1)
 
2761
    >>> rfc3339_duration_to_delta("P1W")
 
2762
    datetime.timedelta(7)
 
2763
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2764
    datetime.timedelta(0, 330)
 
2765
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2766
    datetime.timedelta(1, 200)
2798
2767
    """
2799
2768
 
2800
2769
    # Parsing an RFC 3339 duration with regular expressions is not
2880
2849
def string_to_delta(interval):
2881
2850
    """Parse a string and return a datetime.timedelta
2882
2851
 
2883
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2884
 
    True
2885
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2886
 
    True
2887
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2888
 
    True
2889
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2890
 
    True
2891
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2892
 
    True
2893
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2894
 
    True
 
2852
    >>> string_to_delta('7d')
 
2853
    datetime.timedelta(7)
 
2854
    >>> string_to_delta('60s')
 
2855
    datetime.timedelta(0, 60)
 
2856
    >>> string_to_delta('60m')
 
2857
    datetime.timedelta(0, 3600)
 
2858
    >>> string_to_delta('24h')
 
2859
    datetime.timedelta(1)
 
2860
    >>> string_to_delta('1w')
 
2861
    datetime.timedelta(7)
 
2862
    >>> string_to_delta('5m 30s')
 
2863
    datetime.timedelta(0, 330)
2895
2864
    """
2896
2865
 
2897
2866
    try:
2999
2968
 
3000
2969
    options = parser.parse_args()
3001
2970
 
 
2971
    if options.check:
 
2972
        import doctest
 
2973
        fail_count, test_count = doctest.testmod()
 
2974
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2975
 
3002
2976
    # Default values for config file for server-global settings
3003
2977
    if gnutls.has_rawpk:
3004
2978
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3024
2998
    del priority
3025
2999
 
3026
3000
    # Parse config file for server-global settings
3027
 
    server_config = configparser.ConfigParser(server_defaults)
 
3001
    server_config = configparser.SafeConfigParser(server_defaults)
3028
3002
    del server_defaults
3029
3003
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3030
 
    # Convert the ConfigParser object to a dict
 
3004
    # Convert the SafeConfigParser object to a dict
3031
3005
    server_settings = server_config.defaults()
3032
3006
    # Use the appropriate methods on the non-string config options
3033
3007
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3105
3079
                                  server_settings["servicename"])))
3106
3080
 
3107
3081
    # Parse config file with clients
3108
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3082
    client_config = configparser.SafeConfigParser(Client
 
3083
                                                  .client_defaults)
3109
3084
    client_config.read(os.path.join(server_settings["configdir"],
3110
3085
                                    "clients.conf"))
3111
3086
 
3182
3157
        # Close all input and output, do double fork, etc.
3183
3158
        daemon()
3184
3159
 
3185
 
    if gi.version_info < (3, 10, 2):
3186
 
        # multiprocessing will use threads, so before we use GLib we
3187
 
        # need to inform GLib that threads will be used.
3188
 
        GLib.threads_init()
 
3160
    # multiprocessing will use threads, so before we use GLib we need
 
3161
    # to inform GLib that threads will be used.
 
3162
    GLib.threads_init()
3189
3163
 
3190
3164
    global main_loop
3191
3165
    # From the Avahi example code
3267
3241
                             if isinstance(s, bytes)
3268
3242
                             else s) for s in
3269
3243
                            value["client_structure"]]
3270
 
                        # .name, .host, and .checker_command
3271
 
                        for k in ("name", "host", "checker_command"):
 
3244
                        # .name & .host
 
3245
                        for k in ("name", "host"):
3272
3246
                            if isinstance(value[k], bytes):
3273
3247
                                value[k] = value[k].decode("utf-8")
3274
3248
                        if "key_id" not in value:
3284
3258
                        for key, value in
3285
3259
                        bytes_old_client_settings.items()}
3286
3260
                    del bytes_old_client_settings
3287
 
                    # .host and .checker_command
 
3261
                    # .host
3288
3262
                    for value in old_client_settings.values():
3289
 
                        for attribute in ("host", "checker_command"):
3290
 
                            if isinstance(value[attribute], bytes):
3291
 
                                value[attribute] = (value[attribute]
3292
 
                                                    .decode("utf-8"))
 
3263
                        if isinstance(value["host"], bytes):
 
3264
                            value["host"] = (value["host"]
 
3265
                                             .decode("utf-8"))
3293
3266
            os.remove(stored_state_path)
3294
3267
        except IOError as e:
3295
3268
            if e.errno == errno.ENOENT:
3620
3593
                sys.exit(1)
3621
3594
            # End of Avahi example code
3622
3595
 
3623
 
        GLib.io_add_watch(
3624
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3625
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3626
 
            lambda *args, **kwargs: (tcp_server.handle_request
3627
 
                                     (*args[2:], **kwargs) or True))
 
3596
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3597
                          lambda *args, **kwargs:
 
3598
                          (tcp_server.handle_request
 
3599
                           (*args[2:], **kwargs) or True))
3628
3600
 
3629
3601
        logger.debug("Starting main loop")
3630
3602
        main_loop.run()
3640
3612
    # Must run before the D-Bus bus name gets deregistered
3641
3613
    cleanup()
3642
3614
 
3643
 
 
3644
 
def should_only_run_tests():
3645
 
    parser = argparse.ArgumentParser(add_help=False)
3646
 
    parser.add_argument("--check", action='store_true')
3647
 
    args, unknown_args = parser.parse_known_args()
3648
 
    run_tests = args.check
3649
 
    if run_tests:
3650
 
        # Remove --check argument from sys.argv
3651
 
        sys.argv[1:] = unknown_args
3652
 
    return run_tests
3653
 
 
3654
 
# Add all tests from doctest strings
3655
 
def load_tests(loader, tests, none):
3656
 
    import doctest
3657
 
    tests.addTests(doctest.DocTestSuite())
3658
 
    return tests
3659
3615
 
3660
3616
if __name__ == '__main__':
3661
 
    try:
3662
 
        if should_only_run_tests():
3663
 
            # Call using ./mandos --check [--verbose]
3664
 
            unittest.main()
3665
 
        else:
3666
 
            main()
3667
 
    finally:
3668
 
        logging.shutdown()
 
3617
    main()