/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-02-07 20:53:34 UTC
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
#
77
77
import itertools
78
78
import collections
79
79
import codecs
 
80
import unittest
 
81
import random
80
82
 
81
83
import dbus
82
84
import dbus.service
 
85
import gi
83
86
from gi.repository import GLib
84
87
from dbus.mainloop.glib import DBusGMainLoop
85
88
import ctypes
87
90
import xml.dom.minidom
88
91
import inspect
89
92
 
 
93
if sys.version_info.major == 2:
 
94
    __metaclass__ = type
 
95
    str = unicode
 
96
 
 
97
# Add collections.abc.Callable if it does not exist
 
98
try:
 
99
    collections.abc.Callable
 
100
except AttributeError:
 
101
    class abc:
 
102
        Callable = collections.Callable
 
103
    collections.abc = abc
 
104
    del abc
 
105
 
 
106
# Show warnings by default
 
107
if not sys.warnoptions:
 
108
    import warnings
 
109
    warnings.simplefilter("default")
 
110
 
90
111
# Try to find the value of SO_BINDTODEVICE:
91
112
try:
92
113
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
112
133
            # No value found
113
134
            SO_BINDTODEVICE = None
114
135
 
115
 
if sys.version_info.major == 2:
116
 
    str = unicode
 
136
if sys.version_info < (3, 2):
 
137
    configparser.Configparser = configparser.SafeConfigParser
117
138
 
118
 
version = "1.8.4"
 
139
version = "1.8.9"
119
140
stored_state_file = "clients.pickle"
120
141
 
121
142
logger = logging.getLogger()
 
143
logging.captureWarnings(True)   # Show warnings via the logging system
122
144
syslogger = None
123
145
 
124
146
try:
179
201
    pass
180
202
 
181
203
 
182
 
class PGPEngine(object):
 
204
class PGPEngine:
183
205
    """A simple class for OpenPGP symmetric encryption & decryption"""
184
206
 
185
207
    def __init__(self):
189
211
            output = subprocess.check_output(["gpgconf"])
190
212
            for line in output.splitlines():
191
213
                name, text, path = line.split(b":")
192
 
                if name == "gpg":
 
214
                if name == b"gpg":
193
215
                    self.gpg = path
194
216
                    break
195
217
        except OSError as e:
200
222
                          '--force-mdc',
201
223
                          '--quiet']
202
224
        # Only GPG version 1 has the --no-use-agent option.
203
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
225
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
204
226
            self.gnupgargs.append("--no-use-agent")
205
227
 
206
228
    def __enter__(self):
275
297
 
276
298
 
277
299
# Pretend that we have an Avahi module
278
 
class avahi(object):
 
300
class avahi:
279
301
    """This isn't so much a class as it is a module-like namespace."""
280
302
    IF_UNSPEC = -1               # avahi-common/address.h
281
303
    PROTO_UNSPEC = -1            # avahi-common/address.h
315
337
    pass
316
338
 
317
339
 
318
 
class AvahiService(object):
 
340
class AvahiService:
319
341
    """An Avahi (Zeroconf) service.
320
342
 
321
343
    Attributes:
503
525
 
504
526
 
505
527
# Pretend that we have a GnuTLS module
506
 
class gnutls(object):
 
528
class gnutls:
507
529
    """This isn't so much a class as it is a module-like namespace."""
508
530
 
509
531
    library = ctypes.util.find_library("gnutls")
572
594
        pass
573
595
 
574
596
    # Classes
575
 
    class Credentials(object):
 
597
    class Credentials:
576
598
        def __init__(self):
577
599
            self._c_object = gnutls.certificate_credentials_t()
578
600
            gnutls.certificate_allocate_credentials(
582
604
        def __del__(self):
583
605
            gnutls.certificate_free_credentials(self._c_object)
584
606
 
585
 
    class ClientSession(object):
 
607
    class ClientSession:
586
608
        def __init__(self, socket, credentials=None):
587
609
            self._c_object = gnutls.session_t()
588
610
            gnutls_flags = gnutls.CLIENT
589
 
            if gnutls.check_version("3.5.6"):
 
611
            if gnutls.check_version(b"3.5.6"):
590
612
                gnutls_flags |= gnutls.NO_TICKETS
591
613
            if gnutls.has_rawpk:
592
614
                gnutls_flags |= gnutls.ENABLE_RAWPK
794
816
                                                    ctypes.c_size_t)]
795
817
        openpgp_crt_get_fingerprint.restype = _error_code
796
818
 
797
 
    if check_version("3.6.4"):
 
819
    if check_version(b"3.6.4"):
798
820
        certificate_type_get2 = _library.gnutls_certificate_type_get2
799
821
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
800
822
        certificate_type_get2.restype = _error_code
814
836
    connection.close()
815
837
 
816
838
 
817
 
class Client(object):
 
839
class Client:
818
840
    """A representation of a client host served by this server.
819
841
 
820
842
    Attributes:
821
843
    approved:   bool(); 'None' if not yet approved/disapproved
822
844
    approval_delay: datetime.timedelta(); Time to wait for approval
823
845
    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.
 
846
    checker: multiprocessing.Process(); a running checker process used
 
847
             to see if the client lives. 'None' if no process is
 
848
             running.
827
849
    checker_callback_tag: a GLib event source tag, or None
828
850
    checker_command: string; External command which is run to check
829
851
                     if client lives.  %() expansions are done at
1023
1045
        if self.checker_initiator_tag is not None:
1024
1046
            GLib.source_remove(self.checker_initiator_tag)
1025
1047
        self.checker_initiator_tag = GLib.timeout_add(
1026
 
            int(self.interval.total_seconds() * 1000),
 
1048
            random.randrange(int(self.interval.total_seconds() * 1000
 
1049
                                 + 1)),
1027
1050
            self.start_checker)
1028
1051
        # Schedule a disable() when 'timeout' has passed
1029
1052
        if self.disable_initiator_tag is not None:
1036
1059
    def checker_callback(self, source, condition, connection,
1037
1060
                         command):
1038
1061
        """The checker has completed, so take appropriate actions."""
1039
 
        self.checker_callback_tag = None
1040
 
        self.checker = None
1041
1062
        # Read return code from connection (see call_pipe)
1042
1063
        returncode = connection.recv()
1043
1064
        connection.close()
 
1065
        if self.checker is not None:
 
1066
            self.checker.join()
 
1067
        self.checker_callback_tag = None
 
1068
        self.checker = None
1044
1069
 
1045
1070
        if returncode >= 0:
1046
1071
            self.last_checker_status = returncode
1135
1160
                kwargs=popen_args)
1136
1161
            self.checker.start()
1137
1162
            self.checker_callback_tag = GLib.io_add_watch(
1138
 
                pipe[0].fileno(), GLib.IO_IN,
 
1163
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
1164
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1139
1165
                self.checker_callback, pipe[0], command)
1140
1166
        # Re-run this periodically if run by GLib.timeout_add
1141
1167
        return True
1396
1422
                raise ValueError("Byte arrays not supported for non-"
1397
1423
                                 "'ay' signature {!r}"
1398
1424
                                 .format(prop._dbus_signature))
1399
 
            value = dbus.ByteArray(b''.join(chr(byte)
1400
 
                                            for byte in value))
 
1425
            value = dbus.ByteArray(bytes(value))
1401
1426
        prop(value)
1402
1427
 
1403
1428
    @dbus.service.method(dbus.PROPERTIES_IFACE,
2208
2233
    del _interface
2209
2234
 
2210
2235
 
2211
 
class ProxyClient(object):
 
2236
class ProxyClient:
2212
2237
    def __init__(self, child_pipe, key_id, fpr, address):
2213
2238
        self._pipe = child_pipe
2214
2239
        self._pipe.send(('init', key_id, fpr, address))
2287
2312
            approval_required = False
2288
2313
            try:
2289
2314
                if gnutls.has_rawpk:
2290
 
                    fpr = ""
 
2315
                    fpr = b""
2291
2316
                    try:
2292
2317
                        key_id = self.key_id(
2293
2318
                            self.peer_certificate(session))
2297
2322
                    logger.debug("Key ID: %s", key_id)
2298
2323
 
2299
2324
                else:
2300
 
                    key_id = ""
 
2325
                    key_id = b""
2301
2326
                    try:
2302
2327
                        fpr = self.fingerprint(
2303
2328
                            self.peer_certificate(session))
2487
2512
        return hex_fpr
2488
2513
 
2489
2514
 
2490
 
class MultiprocessingMixIn(object):
 
2515
class MultiprocessingMixIn:
2491
2516
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2492
2517
 
2493
2518
    def sub_process_main(self, request, address):
2505
2530
        return proc
2506
2531
 
2507
2532
 
2508
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2533
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2509
2534
    """ adds a pipe to the MixIn """
2510
2535
 
2511
2536
    def process_request(self, request, client_address):
2526
2551
 
2527
2552
 
2528
2553
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2529
 
                     socketserver.TCPServer, object):
 
2554
                     socketserver.TCPServer):
2530
2555
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2531
2556
 
2532
2557
    Attributes:
2605
2630
                    raise
2606
2631
        # Only bind(2) the socket if we really need to.
2607
2632
        if self.server_address[0] or self.server_address[1]:
 
2633
            if self.server_address[1]:
 
2634
                self.allow_reuse_address = True
2608
2635
            if not self.server_address[0]:
2609
2636
                if self.address_family == socket.AF_INET6:
2610
2637
                    any_address = "::"  # in6addr_any
2663
2690
    def add_pipe(self, parent_pipe, proc):
2664
2691
        # Call "handle_ipc" for both data and EOF events
2665
2692
        GLib.io_add_watch(
2666
 
            parent_pipe.fileno(),
2667
 
            GLib.IO_IN | GLib.IO_HUP,
 
2693
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2694
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2668
2695
            functools.partial(self.handle_ipc,
2669
2696
                              parent_pipe=parent_pipe,
2670
2697
                              proc=proc))
2708
2735
                return False
2709
2736
 
2710
2737
            GLib.io_add_watch(
2711
 
                parent_pipe.fileno(),
2712
 
                GLib.IO_IN | GLib.IO_HUP,
 
2738
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2739
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2713
2740
                functools.partial(self.handle_ipc,
2714
2741
                                  parent_pipe=parent_pipe,
2715
2742
                                  proc=proc,
2730
2757
        if command == 'getattr':
2731
2758
            attrname = request[1]
2732
2759
            if isinstance(client_object.__getattribute__(attrname),
2733
 
                          collections.Callable):
 
2760
                          collections.abc.Callable):
2734
2761
                parent_pipe.send(('function', ))
2735
2762
            else:
2736
2763
                parent_pipe.send((
2747
2774
def rfc3339_duration_to_delta(duration):
2748
2775
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2749
2776
 
2750
 
    >>> rfc3339_duration_to_delta("P7D")
2751
 
    datetime.timedelta(7)
2752
 
    >>> rfc3339_duration_to_delta("PT60S")
2753
 
    datetime.timedelta(0, 60)
2754
 
    >>> rfc3339_duration_to_delta("PT60M")
2755
 
    datetime.timedelta(0, 3600)
2756
 
    >>> rfc3339_duration_to_delta("PT24H")
2757
 
    datetime.timedelta(1)
2758
 
    >>> rfc3339_duration_to_delta("P1W")
2759
 
    datetime.timedelta(7)
2760
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2761
 
    datetime.timedelta(0, 330)
2762
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2763
 
    datetime.timedelta(1, 200)
 
2777
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
2778
    True
 
2779
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
2780
    True
 
2781
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
 
2782
    True
 
2783
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
2784
    True
 
2785
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
2786
    True
 
2787
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
2788
    True
 
2789
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
2790
    True
2764
2791
    """
2765
2792
 
2766
2793
    # Parsing an RFC 3339 duration with regular expressions is not
2846
2873
def string_to_delta(interval):
2847
2874
    """Parse a string and return a datetime.timedelta
2848
2875
 
2849
 
    >>> string_to_delta('7d')
2850
 
    datetime.timedelta(7)
2851
 
    >>> string_to_delta('60s')
2852
 
    datetime.timedelta(0, 60)
2853
 
    >>> string_to_delta('60m')
2854
 
    datetime.timedelta(0, 3600)
2855
 
    >>> string_to_delta('24h')
2856
 
    datetime.timedelta(1)
2857
 
    >>> string_to_delta('1w')
2858
 
    datetime.timedelta(7)
2859
 
    >>> string_to_delta('5m 30s')
2860
 
    datetime.timedelta(0, 330)
 
2876
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2877
    True
 
2878
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2879
    True
 
2880
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2881
    True
 
2882
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2883
    True
 
2884
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2885
    True
 
2886
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
 
2887
    True
2861
2888
    """
2862
2889
 
2863
2890
    try:
2965
2992
 
2966
2993
    options = parser.parse_args()
2967
2994
 
2968
 
    if options.check:
2969
 
        import doctest
2970
 
        fail_count, test_count = doctest.testmod()
2971
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2972
 
 
2973
2995
    # Default values for config file for server-global settings
2974
2996
    if gnutls.has_rawpk:
2975
2997
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2995
3017
    del priority
2996
3018
 
2997
3019
    # Parse config file for server-global settings
2998
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
3020
    server_config = configparser.ConfigParser(server_defaults)
2999
3021
    del server_defaults
3000
3022
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3001
 
    # Convert the SafeConfigParser object to a dict
 
3023
    # Convert the ConfigParser object to a dict
3002
3024
    server_settings = server_config.defaults()
3003
3025
    # Use the appropriate methods on the non-string config options
3004
3026
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3076
3098
                                  server_settings["servicename"])))
3077
3099
 
3078
3100
    # Parse config file with clients
3079
 
    client_config = configparser.SafeConfigParser(Client
3080
 
                                                  .client_defaults)
 
3101
    client_config = configparser.ConfigParser(Client.client_defaults)
3081
3102
    client_config.read(os.path.join(server_settings["configdir"],
3082
3103
                                    "clients.conf"))
3083
3104
 
3154
3175
        # Close all input and output, do double fork, etc.
3155
3176
        daemon()
3156
3177
 
3157
 
    # multiprocessing will use threads, so before we use GLib we need
3158
 
    # to inform GLib that threads will be used.
3159
 
    GLib.threads_init()
 
3178
    if gi.version_info < (3, 10, 2):
 
3179
        # multiprocessing will use threads, so before we use GLib we
 
3180
        # need to inform GLib that threads will be used.
 
3181
        GLib.threads_init()
3160
3182
 
3161
3183
    global main_loop
3162
3184
    # From the Avahi example code
3238
3260
                             if isinstance(s, bytes)
3239
3261
                             else s) for s in
3240
3262
                            value["client_structure"]]
3241
 
                        # .name & .host
3242
 
                        for k in ("name", "host"):
 
3263
                        # .name, .host, and .checker_command
 
3264
                        for k in ("name", "host", "checker_command"):
3243
3265
                            if isinstance(value[k], bytes):
3244
3266
                                value[k] = value[k].decode("utf-8")
3245
 
                        if not value.has_key("key_id"):
 
3267
                        if "key_id" not in value:
3246
3268
                            value["key_id"] = ""
3247
 
                        elif not value.has_key("fingerprint"):
 
3269
                        elif "fingerprint" not in value:
3248
3270
                            value["fingerprint"] = ""
3249
3271
                    #  old_client_settings
3250
3272
                    # .keys()
3255
3277
                        for key, value in
3256
3278
                        bytes_old_client_settings.items()}
3257
3279
                    del bytes_old_client_settings
3258
 
                    # .host
 
3280
                    # .host and .checker_command
3259
3281
                    for value in old_client_settings.values():
3260
 
                        if isinstance(value["host"], bytes):
3261
 
                            value["host"] = (value["host"]
3262
 
                                             .decode("utf-8"))
 
3282
                        for attribute in ("host", "checker_command"):
 
3283
                            if isinstance(value[attribute], bytes):
 
3284
                                value[attribute] = (value[attribute]
 
3285
                                                    .decode("utf-8"))
3263
3286
            os.remove(stored_state_path)
3264
3287
        except IOError as e:
3265
3288
            if e.errno == errno.ENOENT:
3590
3613
                sys.exit(1)
3591
3614
            # End of Avahi example code
3592
3615
 
3593
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3594
 
                          lambda *args, **kwargs:
3595
 
                          (tcp_server.handle_request
3596
 
                           (*args[2:], **kwargs) or True))
 
3616
        GLib.io_add_watch(
 
3617
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
3618
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
3619
            lambda *args, **kwargs: (tcp_server.handle_request
 
3620
                                     (*args[2:], **kwargs) or True))
3597
3621
 
3598
3622
        logger.debug("Starting main loop")
3599
3623
        main_loop.run()
3609
3633
    # Must run before the D-Bus bus name gets deregistered
3610
3634
    cleanup()
3611
3635
 
 
3636
 
 
3637
def should_only_run_tests():
 
3638
    parser = argparse.ArgumentParser(add_help=False)
 
3639
    parser.add_argument("--check", action='store_true')
 
3640
    args, unknown_args = parser.parse_known_args()
 
3641
    run_tests = args.check
 
3642
    if run_tests:
 
3643
        # Remove --check argument from sys.argv
 
3644
        sys.argv[1:] = unknown_args
 
3645
    return run_tests
 
3646
 
 
3647
# Add all tests from doctest strings
 
3648
def load_tests(loader, tests, none):
 
3649
    import doctest
 
3650
    tests.addTests(doctest.DocTestSuite())
 
3651
    return tests
3612
3652
 
3613
3653
if __name__ == '__main__':
3614
 
    main()
 
3654
    try:
 
3655
        if should_only_run_tests():
 
3656
            # Call using ./mandos --check [--verbose]
 
3657
            unittest.main()
 
3658
        else:
 
3659
            main()
 
3660
    finally:
 
3661
        logging.shutdown()