/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 at recompile
  • Date: 2020-07-04 11:58:52 UTC
  • Revision ID: teddy@recompile.se-20200704115852-oquhnmng3zom4ldl
Update copyright year

* DBUS-API: Update copyright year to 2020
* debian/copyright: - '' -
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/password-agent.c: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/plymouth.c: - '' -
* mandos-to-cryptroot-unlock: Update copyright year to 2019.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
1
 
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
 
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 -*-
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-2019 Teddy Hogeborn
15
 
# Copyright © 2008-2019 Björn Påhlsson
 
14
# Copyright © 2008-2020 Teddy Hogeborn
 
15
# Copyright © 2008-2020 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
80
83
 
81
84
import dbus
82
85
import dbus.service
 
86
import gi
83
87
from gi.repository import GLib
84
88
from dbus.mainloop.glib import DBusGMainLoop
85
89
import ctypes
87
91
import xml.dom.minidom
88
92
import inspect
89
93
 
 
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
 
90
118
# Try to find the value of SO_BINDTODEVICE:
91
119
try:
92
120
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
112
140
            # No value found
113
141
            SO_BINDTODEVICE = None
114
142
 
115
 
if sys.version_info.major == 2:
116
 
    str = unicode
 
143
if sys.version_info < (3, 2):
 
144
    configparser.Configparser = configparser.SafeConfigParser
117
145
 
118
 
version = "1.8.4"
 
146
version = "1.8.11"
119
147
stored_state_file = "clients.pickle"
120
148
 
121
149
logger = logging.getLogger()
 
150
logging.captureWarnings(True)   # Show warnings via the logging system
122
151
syslogger = None
123
152
 
124
153
try:
179
208
    pass
180
209
 
181
210
 
182
 
class PGPEngine(object):
 
211
class PGPEngine:
183
212
    """A simple class for OpenPGP symmetric encryption & decryption"""
184
213
 
185
214
    def __init__(self):
189
218
            output = subprocess.check_output(["gpgconf"])
190
219
            for line in output.splitlines():
191
220
                name, text, path = line.split(b":")
192
 
                if name == "gpg":
 
221
                if name == b"gpg":
193
222
                    self.gpg = path
194
223
                    break
195
224
        except OSError as e:
200
229
                          '--force-mdc',
201
230
                          '--quiet']
202
231
        # Only GPG version 1 has the --no-use-agent option.
203
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
204
233
            self.gnupgargs.append("--no-use-agent")
205
234
 
206
235
    def __enter__(self):
275
304
 
276
305
 
277
306
# Pretend that we have an Avahi module
278
 
class avahi(object):
 
307
class avahi:
279
308
    """This isn't so much a class as it is a module-like namespace."""
280
309
    IF_UNSPEC = -1               # avahi-common/address.h
281
310
    PROTO_UNSPEC = -1            # avahi-common/address.h
315
344
    pass
316
345
 
317
346
 
318
 
class AvahiService(object):
 
347
class AvahiService:
319
348
    """An Avahi (Zeroconf) service.
320
349
 
321
350
    Attributes:
503
532
 
504
533
 
505
534
# Pretend that we have a GnuTLS module
506
 
class gnutls(object):
 
535
class gnutls:
507
536
    """This isn't so much a class as it is a module-like namespace."""
508
537
 
509
538
    library = ctypes.util.find_library("gnutls")
572
601
        pass
573
602
 
574
603
    # Classes
575
 
    class Credentials(object):
 
604
    class Credentials:
576
605
        def __init__(self):
577
606
            self._c_object = gnutls.certificate_credentials_t()
578
607
            gnutls.certificate_allocate_credentials(
582
611
        def __del__(self):
583
612
            gnutls.certificate_free_credentials(self._c_object)
584
613
 
585
 
    class ClientSession(object):
 
614
    class ClientSession:
586
615
        def __init__(self, socket, credentials=None):
587
616
            self._c_object = gnutls.session_t()
588
617
            gnutls_flags = gnutls.CLIENT
589
 
            if gnutls.check_version("3.5.6"):
 
618
            if gnutls.check_version(b"3.5.6"):
590
619
                gnutls_flags |= gnutls.NO_TICKETS
591
620
            if gnutls.has_rawpk:
592
621
                gnutls_flags |= gnutls.ENABLE_RAWPK
794
823
                                                    ctypes.c_size_t)]
795
824
        openpgp_crt_get_fingerprint.restype = _error_code
796
825
 
797
 
    if check_version("3.6.4"):
 
826
    if check_version(b"3.6.4"):
798
827
        certificate_type_get2 = _library.gnutls_certificate_type_get2
799
828
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
800
829
        certificate_type_get2.restype = _error_code
814
843
    connection.close()
815
844
 
816
845
 
817
 
class Client(object):
 
846
class Client:
818
847
    """A representation of a client host served by this server.
819
848
 
820
849
    Attributes:
821
850
    approved:   bool(); 'None' if not yet approved/disapproved
822
851
    approval_delay: datetime.timedelta(); Time to wait for approval
823
852
    approval_duration: datetime.timedelta(); Duration of one approval
824
 
    checker:    subprocess.Popen(); a running checker process used
825
 
                                    to see if the client lives.
826
 
                                    'None' if no process is running.
 
853
    checker: multiprocessing.Process(); a running checker process used
 
854
             to see if the client lives. 'None' if no process is
 
855
             running.
827
856
    checker_callback_tag: a GLib event source tag, or None
828
857
    checker_command: string; External command which is run to check
829
858
                     if client lives.  %() expansions are done at
1023
1052
        if self.checker_initiator_tag is not None:
1024
1053
            GLib.source_remove(self.checker_initiator_tag)
1025
1054
        self.checker_initiator_tag = GLib.timeout_add(
1026
 
            int(self.interval.total_seconds() * 1000),
 
1055
            random.randrange(int(self.interval.total_seconds() * 1000
 
1056
                                 + 1)),
1027
1057
            self.start_checker)
1028
1058
        # Schedule a disable() when 'timeout' has passed
1029
1059
        if self.disable_initiator_tag is not None:
1036
1066
    def checker_callback(self, source, condition, connection,
1037
1067
                         command):
1038
1068
        """The checker has completed, so take appropriate actions."""
1039
 
        self.checker_callback_tag = None
1040
 
        self.checker = None
1041
1069
        # Read return code from connection (see call_pipe)
1042
1070
        returncode = connection.recv()
1043
1071
        connection.close()
 
1072
        if self.checker is not None:
 
1073
            self.checker.join()
 
1074
        self.checker_callback_tag = None
 
1075
        self.checker = None
1044
1076
 
1045
1077
        if returncode >= 0:
1046
1078
            self.last_checker_status = returncode
1102
1134
        if self.checker is None:
1103
1135
            # Escape attributes for the shell
1104
1136
            escaped_attrs = {
1105
 
                attr: re.escape(str(getattr(self, attr)))
 
1137
                attr: shlex.quote(str(getattr(self, attr)))
1106
1138
                for attr in self.runtime_expansions}
1107
1139
            try:
1108
1140
                command = self.checker_command % escaped_attrs
1135
1167
                kwargs=popen_args)
1136
1168
            self.checker.start()
1137
1169
            self.checker_callback_tag = GLib.io_add_watch(
1138
 
                pipe[0].fileno(), GLib.IO_IN,
 
1170
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
1171
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1139
1172
                self.checker_callback, pipe[0], command)
1140
1173
        # Re-run this periodically if run by GLib.timeout_add
1141
1174
        return True
1396
1429
                raise ValueError("Byte arrays not supported for non-"
1397
1430
                                 "'ay' signature {!r}"
1398
1431
                                 .format(prop._dbus_signature))
1399
 
            value = dbus.ByteArray(b''.join(chr(byte)
1400
 
                                            for byte in value))
 
1432
            value = dbus.ByteArray(bytes(value))
1401
1433
        prop(value)
1402
1434
 
1403
1435
    @dbus.service.method(dbus.PROPERTIES_IFACE,
2208
2240
    del _interface
2209
2241
 
2210
2242
 
2211
 
class ProxyClient(object):
 
2243
class ProxyClient:
2212
2244
    def __init__(self, child_pipe, key_id, fpr, address):
2213
2245
        self._pipe = child_pipe
2214
2246
        self._pipe.send(('init', key_id, fpr, address))
2287
2319
            approval_required = False
2288
2320
            try:
2289
2321
                if gnutls.has_rawpk:
2290
 
                    fpr = ""
 
2322
                    fpr = b""
2291
2323
                    try:
2292
2324
                        key_id = self.key_id(
2293
2325
                            self.peer_certificate(session))
2297
2329
                    logger.debug("Key ID: %s", key_id)
2298
2330
 
2299
2331
                else:
2300
 
                    key_id = ""
 
2332
                    key_id = b""
2301
2333
                    try:
2302
2334
                        fpr = self.fingerprint(
2303
2335
                            self.peer_certificate(session))
2487
2519
        return hex_fpr
2488
2520
 
2489
2521
 
2490
 
class MultiprocessingMixIn(object):
 
2522
class MultiprocessingMixIn:
2491
2523
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2492
2524
 
2493
2525
    def sub_process_main(self, request, address):
2505
2537
        return proc
2506
2538
 
2507
2539
 
2508
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2540
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2509
2541
    """ adds a pipe to the MixIn """
2510
2542
 
2511
2543
    def process_request(self, request, client_address):
2526
2558
 
2527
2559
 
2528
2560
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2529
 
                     socketserver.TCPServer, object):
 
2561
                     socketserver.TCPServer):
2530
2562
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2531
2563
 
2532
2564
    Attributes:
2665
2697
    def add_pipe(self, parent_pipe, proc):
2666
2698
        # Call "handle_ipc" for both data and EOF events
2667
2699
        GLib.io_add_watch(
2668
 
            parent_pipe.fileno(),
2669
 
            GLib.IO_IN | GLib.IO_HUP,
 
2700
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2701
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2670
2702
            functools.partial(self.handle_ipc,
2671
2703
                              parent_pipe=parent_pipe,
2672
2704
                              proc=proc))
2710
2742
                return False
2711
2743
 
2712
2744
            GLib.io_add_watch(
2713
 
                parent_pipe.fileno(),
2714
 
                GLib.IO_IN | GLib.IO_HUP,
 
2745
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2746
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2715
2747
                functools.partial(self.handle_ipc,
2716
2748
                                  parent_pipe=parent_pipe,
2717
2749
                                  proc=proc,
2732
2764
        if command == 'getattr':
2733
2765
            attrname = request[1]
2734
2766
            if isinstance(client_object.__getattribute__(attrname),
2735
 
                          collections.Callable):
 
2767
                          collections.abc.Callable):
2736
2768
                parent_pipe.send(('function', ))
2737
2769
            else:
2738
2770
                parent_pipe.send((
2749
2781
def rfc3339_duration_to_delta(duration):
2750
2782
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2751
2783
 
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)
 
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
2766
2798
    """
2767
2799
 
2768
2800
    # Parsing an RFC 3339 duration with regular expressions is not
2848
2880
def string_to_delta(interval):
2849
2881
    """Parse a string and return a datetime.timedelta
2850
2882
 
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)
 
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
2863
2895
    """
2864
2896
 
2865
2897
    try:
2967
2999
 
2968
3000
    options = parser.parse_args()
2969
3001
 
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
 
 
2975
3002
    # Default values for config file for server-global settings
2976
3003
    if gnutls.has_rawpk:
2977
3004
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2997
3024
    del priority
2998
3025
 
2999
3026
    # Parse config file for server-global settings
3000
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
3027
    server_config = configparser.ConfigParser(server_defaults)
3001
3028
    del server_defaults
3002
3029
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3003
 
    # Convert the SafeConfigParser object to a dict
 
3030
    # Convert the ConfigParser object to a dict
3004
3031
    server_settings = server_config.defaults()
3005
3032
    # Use the appropriate methods on the non-string config options
3006
3033
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3078
3105
                                  server_settings["servicename"])))
3079
3106
 
3080
3107
    # Parse config file with clients
3081
 
    client_config = configparser.SafeConfigParser(Client
3082
 
                                                  .client_defaults)
 
3108
    client_config = configparser.ConfigParser(Client.client_defaults)
3083
3109
    client_config.read(os.path.join(server_settings["configdir"],
3084
3110
                                    "clients.conf"))
3085
3111
 
3156
3182
        # Close all input and output, do double fork, etc.
3157
3183
        daemon()
3158
3184
 
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()
 
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()
3162
3189
 
3163
3190
    global main_loop
3164
3191
    # From the Avahi example code
3240
3267
                             if isinstance(s, bytes)
3241
3268
                             else s) for s in
3242
3269
                            value["client_structure"]]
3243
 
                        # .name & .host
3244
 
                        for k in ("name", "host"):
 
3270
                        # .name, .host, and .checker_command
 
3271
                        for k in ("name", "host", "checker_command"):
3245
3272
                            if isinstance(value[k], bytes):
3246
3273
                                value[k] = value[k].decode("utf-8")
3247
 
                        if not value.has_key("key_id"):
 
3274
                        if "key_id" not in value:
3248
3275
                            value["key_id"] = ""
3249
 
                        elif not value.has_key("fingerprint"):
 
3276
                        elif "fingerprint" not in value:
3250
3277
                            value["fingerprint"] = ""
3251
3278
                    #  old_client_settings
3252
3279
                    # .keys()
3257
3284
                        for key, value in
3258
3285
                        bytes_old_client_settings.items()}
3259
3286
                    del bytes_old_client_settings
3260
 
                    # .host
 
3287
                    # .host and .checker_command
3261
3288
                    for value in old_client_settings.values():
3262
 
                        if isinstance(value["host"], bytes):
3263
 
                            value["host"] = (value["host"]
3264
 
                                             .decode("utf-8"))
 
3289
                        for attribute in ("host", "checker_command"):
 
3290
                            if isinstance(value[attribute], bytes):
 
3291
                                value[attribute] = (value[attribute]
 
3292
                                                    .decode("utf-8"))
3265
3293
            os.remove(stored_state_path)
3266
3294
        except IOError as e:
3267
3295
            if e.errno == errno.ENOENT:
3592
3620
                sys.exit(1)
3593
3621
            # End of Avahi example code
3594
3622
 
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))
 
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))
3599
3628
 
3600
3629
        logger.debug("Starting main loop")
3601
3630
        main_loop.run()
3611
3640
    # Must run before the D-Bus bus name gets deregistered
3612
3641
    cleanup()
3613
3642
 
 
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
3614
3659
 
3615
3660
if __name__ == '__main__':
3616
 
    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()