/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-07-25 21:42:40 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190725214240-31i9qehf60xb8yu4
Use hexadecimal unicode character references, not decimal

* mandos-options.xml (priority): Use "​" instead of "​"
  to make it slightly more clear that ZERO WIDTH SPACE is intended.

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
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2020 Teddy Hogeborn
15
 
# Copyright © 2008-2020 Björn Påhlsson
 
14
# Copyright © 2008-2019 Teddy Hogeborn
 
15
# Copyright © 2008-2019 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
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.11"
 
118
version = "1.8.4"
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
618
 
            if gnutls.check_version(b"3.5.6"):
 
589
            if gnutls.check_version("3.5.6"):
619
590
                gnutls_flags |= gnutls.NO_TICKETS
620
591
            if gnutls.has_rawpk:
621
592
                gnutls_flags |= gnutls.ENABLE_RAWPK
823
794
                                                    ctypes.c_size_t)]
824
795
        openpgp_crt_get_fingerprint.restype = _error_code
825
796
 
826
 
    if check_version(b"3.6.4"):
 
797
    if check_version("3.6.4"):
827
798
        certificate_type_get2 = _library.gnutls_certificate_type_get2
828
799
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
829
800
        certificate_type_get2.restype = _error_code
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:
850
821
    approved:   bool(); 'None' if not yet approved/disapproved
851
822
    approval_delay: datetime.timedelta(); Time to wait for approval
852
823
    approval_duration: datetime.timedelta(); Duration of one approval
853
 
    checker: multiprocessing.Process(); a running checker process used
854
 
             to see if the client lives. 'None' if no process is
855
 
             running.
 
824
    checker:    subprocess.Popen(); a running checker process used
 
825
                                    to see if the client lives.
 
826
                                    'None' if no process is running.
856
827
    checker_callback_tag: a GLib event source tag, or None
857
828
    checker_command: string; External command which is run to check
858
829
                     if client lives.  %() expansions are done at
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:
1066
1036
    def checker_callback(self, source, condition, connection,
1067
1037
                         command):
1068
1038
        """The checker has completed, so take appropriate actions."""
 
1039
        self.checker_callback_tag = None
 
1040
        self.checker = None
1069
1041
        # Read return code from connection (see call_pipe)
1070
1042
        returncode = connection.recv()
1071
1043
        connection.close()
1072
 
        if self.checker is not None:
1073
 
            self.checker.join()
1074
 
        self.checker_callback_tag = None
1075
 
        self.checker = None
1076
1044
 
1077
1045
        if returncode >= 0:
1078
1046
            self.last_checker_status = returncode
1134
1102
        if self.checker is None:
1135
1103
            # Escape attributes for the shell
1136
1104
            escaped_attrs = {
1137
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1105
                attr: re.escape(str(getattr(self, attr)))
1138
1106
                for attr in self.runtime_expansions}
1139
1107
            try:
1140
1108
                command = self.checker_command % escaped_attrs
1167
1135
                kwargs=popen_args)
1168
1136
            self.checker.start()
1169
1137
            self.checker_callback_tag = GLib.io_add_watch(
1170
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1171
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1138
                pipe[0].fileno(), GLib.IO_IN,
1172
1139
                self.checker_callback, pipe[0], command)
1173
1140
        # Re-run this periodically if run by GLib.timeout_add
1174
1141
        return True
1429
1396
                raise ValueError("Byte arrays not supported for non-"
1430
1397
                                 "'ay' signature {!r}"
1431
1398
                                 .format(prop._dbus_signature))
1432
 
            value = dbus.ByteArray(bytes(value))
 
1399
            value = dbus.ByteArray(b''.join(chr(byte)
 
1400
                                            for byte in value))
1433
1401
        prop(value)
1434
1402
 
1435
1403
    @dbus.service.method(dbus.PROPERTIES_IFACE,
2240
2208
    del _interface
2241
2209
 
2242
2210
 
2243
 
class ProxyClient:
 
2211
class ProxyClient(object):
2244
2212
    def __init__(self, child_pipe, key_id, fpr, address):
2245
2213
        self._pipe = child_pipe
2246
2214
        self._pipe.send(('init', key_id, fpr, address))
2319
2287
            approval_required = False
2320
2288
            try:
2321
2289
                if gnutls.has_rawpk:
2322
 
                    fpr = b""
 
2290
                    fpr = ""
2323
2291
                    try:
2324
2292
                        key_id = self.key_id(
2325
2293
                            self.peer_certificate(session))
2329
2297
                    logger.debug("Key ID: %s", key_id)
2330
2298
 
2331
2299
                else:
2332
 
                    key_id = b""
 
2300
                    key_id = ""
2333
2301
                    try:
2334
2302
                        fpr = self.fingerprint(
2335
2303
                            self.peer_certificate(session))
2519
2487
        return hex_fpr
2520
2488
 
2521
2489
 
2522
 
class MultiprocessingMixIn:
 
2490
class MultiprocessingMixIn(object):
2523
2491
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2524
2492
 
2525
2493
    def sub_process_main(self, request, address):
2537
2505
        return proc
2538
2506
 
2539
2507
 
2540
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2541
2509
    """ adds a pipe to the MixIn """
2542
2510
 
2543
2511
    def process_request(self, request, client_address):
2558
2526
 
2559
2527
 
2560
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2561
 
                     socketserver.TCPServer):
 
2529
                     socketserver.TCPServer, object):
2562
2530
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2563
2531
 
2564
2532
    Attributes:
2697
2665
    def add_pipe(self, parent_pipe, proc):
2698
2666
        # Call "handle_ipc" for both data and EOF events
2699
2667
        GLib.io_add_watch(
2700
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2701
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2668
            parent_pipe.fileno(),
 
2669
            GLib.IO_IN | GLib.IO_HUP,
2702
2670
            functools.partial(self.handle_ipc,
2703
2671
                              parent_pipe=parent_pipe,
2704
2672
                              proc=proc))
2742
2710
                return False
2743
2711
 
2744
2712
            GLib.io_add_watch(
2745
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2746
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2713
                parent_pipe.fileno(),
 
2714
                GLib.IO_IN | GLib.IO_HUP,
2747
2715
                functools.partial(self.handle_ipc,
2748
2716
                                  parent_pipe=parent_pipe,
2749
2717
                                  proc=proc,
2764
2732
        if command == 'getattr':
2765
2733
            attrname = request[1]
2766
2734
            if isinstance(client_object.__getattribute__(attrname),
2767
 
                          collections.abc.Callable):
 
2735
                          collections.Callable):
2768
2736
                parent_pipe.send(('function', ))
2769
2737
            else:
2770
2738
                parent_pipe.send((
2781
2749
def rfc3339_duration_to_delta(duration):
2782
2750
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2783
2751
 
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
 
2752
    >>> rfc3339_duration_to_delta("P7D")
 
2753
    datetime.timedelta(7)
 
2754
    >>> rfc3339_duration_to_delta("PT60S")
 
2755
    datetime.timedelta(0, 60)
 
2756
    >>> rfc3339_duration_to_delta("PT60M")
 
2757
    datetime.timedelta(0, 3600)
 
2758
    >>> rfc3339_duration_to_delta("PT24H")
 
2759
    datetime.timedelta(1)
 
2760
    >>> rfc3339_duration_to_delta("P1W")
 
2761
    datetime.timedelta(7)
 
2762
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2763
    datetime.timedelta(0, 330)
 
2764
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2765
    datetime.timedelta(1, 200)
2798
2766
    """
2799
2767
 
2800
2768
    # Parsing an RFC 3339 duration with regular expressions is not
2880
2848
def string_to_delta(interval):
2881
2849
    """Parse a string and return a datetime.timedelta
2882
2850
 
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
 
2851
    >>> string_to_delta('7d')
 
2852
    datetime.timedelta(7)
 
2853
    >>> string_to_delta('60s')
 
2854
    datetime.timedelta(0, 60)
 
2855
    >>> string_to_delta('60m')
 
2856
    datetime.timedelta(0, 3600)
 
2857
    >>> string_to_delta('24h')
 
2858
    datetime.timedelta(1)
 
2859
    >>> string_to_delta('1w')
 
2860
    datetime.timedelta(7)
 
2861
    >>> string_to_delta('5m 30s')
 
2862
    datetime.timedelta(0, 330)
2895
2863
    """
2896
2864
 
2897
2865
    try:
2999
2967
 
3000
2968
    options = parser.parse_args()
3001
2969
 
 
2970
    if options.check:
 
2971
        import doctest
 
2972
        fail_count, test_count = doctest.testmod()
 
2973
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2974
 
3002
2975
    # Default values for config file for server-global settings
3003
2976
    if gnutls.has_rawpk:
3004
2977
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3024
2997
    del priority
3025
2998
 
3026
2999
    # Parse config file for server-global settings
3027
 
    server_config = configparser.ConfigParser(server_defaults)
 
3000
    server_config = configparser.SafeConfigParser(server_defaults)
3028
3001
    del server_defaults
3029
3002
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3030
 
    # Convert the ConfigParser object to a dict
 
3003
    # Convert the SafeConfigParser object to a dict
3031
3004
    server_settings = server_config.defaults()
3032
3005
    # Use the appropriate methods on the non-string config options
3033
3006
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3105
3078
                                  server_settings["servicename"])))
3106
3079
 
3107
3080
    # Parse config file with clients
3108
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3081
    client_config = configparser.SafeConfigParser(Client
 
3082
                                                  .client_defaults)
3109
3083
    client_config.read(os.path.join(server_settings["configdir"],
3110
3084
                                    "clients.conf"))
3111
3085
 
3182
3156
        # Close all input and output, do double fork, etc.
3183
3157
        daemon()
3184
3158
 
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()
 
3159
    # multiprocessing will use threads, so before we use GLib we need
 
3160
    # to inform GLib that threads will be used.
 
3161
    GLib.threads_init()
3189
3162
 
3190
3163
    global main_loop
3191
3164
    # From the Avahi example code
3267
3240
                             if isinstance(s, bytes)
3268
3241
                             else s) for s in
3269
3242
                            value["client_structure"]]
3270
 
                        # .name, .host, and .checker_command
3271
 
                        for k in ("name", "host", "checker_command"):
 
3243
                        # .name & .host
 
3244
                        for k in ("name", "host"):
3272
3245
                            if isinstance(value[k], bytes):
3273
3246
                                value[k] = value[k].decode("utf-8")
3274
 
                        if "key_id" not in value:
 
3247
                        if not value.has_key("key_id"):
3275
3248
                            value["key_id"] = ""
3276
 
                        elif "fingerprint" not in value:
 
3249
                        elif not value.has_key("fingerprint"):
3277
3250
                            value["fingerprint"] = ""
3278
3251
                    #  old_client_settings
3279
3252
                    # .keys()
3284
3257
                        for key, value in
3285
3258
                        bytes_old_client_settings.items()}
3286
3259
                    del bytes_old_client_settings
3287
 
                    # .host and .checker_command
 
3260
                    # .host
3288
3261
                    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"))
 
3262
                        if isinstance(value["host"], bytes):
 
3263
                            value["host"] = (value["host"]
 
3264
                                             .decode("utf-8"))
3293
3265
            os.remove(stored_state_path)
3294
3266
        except IOError as e:
3295
3267
            if e.errno == errno.ENOENT:
3620
3592
                sys.exit(1)
3621
3593
            # End of Avahi example code
3622
3594
 
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))
 
3595
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3596
                          lambda *args, **kwargs:
 
3597
                          (tcp_server.handle_request
 
3598
                           (*args[2:], **kwargs) or True))
3628
3599
 
3629
3600
        logger.debug("Starting main loop")
3630
3601
        main_loop.run()
3640
3611
    # Must run before the D-Bus bus name gets deregistered
3641
3612
    cleanup()
3642
3613
 
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
3614
 
3660
3615
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()
 
3616
    main()