/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-03-16 04:51:11 UTC
  • Revision ID: teddy@recompile.se-20190316045111-63jv8d18i2tcakuw
mandos-ctl: Add comment

* mandos-ctl
  (Test_get_managed_objects.test_logs_and_exits_on_dbus_error): Add a
  comment.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
1
1
#!/usr/bin/python
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 -*-
 
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
80
 
82
81
import dbus
83
82
import dbus.service
84
 
import gi
85
83
from gi.repository import GLib
86
84
from dbus.mainloop.glib import DBusGMainLoop
87
85
import ctypes
89
87
import xml.dom.minidom
90
88
import inspect
91
89
 
92
 
if sys.version_info.major == 2:
93
 
    __metaclass__ = type
94
 
 
95
 
# Show warnings by default
96
 
if not sys.warnoptions:
97
 
    import warnings
98
 
    warnings.simplefilter("default")
99
 
 
100
90
# Try to find the value of SO_BINDTODEVICE:
101
91
try:
102
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
125
115
if sys.version_info.major == 2:
126
116
    str = unicode
127
117
 
128
 
if sys.version_info < (3, 2):
129
 
    configparser.Configparser = configparser.SafeConfigParser
130
 
 
131
 
version = "1.8.8"
 
118
version = "1.8.3"
132
119
stored_state_file = "clients.pickle"
133
120
 
134
121
logger = logging.getLogger()
135
 
logging.captureWarnings(True)   # Show warnings via the logging system
136
122
syslogger = None
137
123
 
138
124
try:
193
179
    pass
194
180
 
195
181
 
196
 
class PGPEngine:
 
182
class PGPEngine(object):
197
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
198
184
 
199
185
    def __init__(self):
289
275
 
290
276
 
291
277
# Pretend that we have an Avahi module
292
 
class avahi:
293
 
    """This isn't so much a class as it is a module-like namespace."""
 
278
class Avahi(object):
 
279
    """This isn't so much a class as it is a module-like namespace.
 
280
    It is instantiated once, and simulates having an Avahi module."""
294
281
    IF_UNSPEC = -1               # avahi-common/address.h
295
282
    PROTO_UNSPEC = -1            # avahi-common/address.h
296
283
    PROTO_INET = 0               # avahi-common/address.h
300
287
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
301
288
    DBUS_PATH_SERVER = "/"
302
289
 
303
 
    @staticmethod
304
 
    def string_array_to_txt_array(t):
 
290
    def string_array_to_txt_array(self, t):
305
291
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
306
292
                           for s in t), signature="ay")
307
293
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
312
298
    SERVER_RUNNING = 2           # avahi-common/defs.h
313
299
    SERVER_COLLISION = 3         # avahi-common/defs.h
314
300
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
301
avahi = Avahi()
315
302
 
316
303
 
317
304
class AvahiError(Exception):
329
316
    pass
330
317
 
331
318
 
332
 
class AvahiService:
 
319
class AvahiService(object):
333
320
    """An Avahi (Zeroconf) service.
334
321
 
335
322
    Attributes:
517
504
 
518
505
 
519
506
# Pretend that we have a GnuTLS module
520
 
class gnutls:
521
 
    """This isn't so much a class as it is a module-like namespace."""
 
507
class GnuTLS(object):
 
508
    """This isn't so much a class as it is a module-like namespace.
 
509
    It is instantiated once, and simulates having a GnuTLS module."""
522
510
 
523
511
    library = ctypes.util.find_library("gnutls")
524
512
    if library is None:
525
513
        library = ctypes.util.find_library("gnutls-deb0")
526
514
    _library = ctypes.cdll.LoadLibrary(library)
527
515
    del library
 
516
    _need_version = b"3.3.0"
 
517
    _tls_rawpk_version = b"3.6.6"
 
518
 
 
519
    def __init__(self):
 
520
        # Need to use "self" here, since this method is called before
 
521
        # the assignment to the "gnutls" global variable happens.
 
522
        if self.check_version(self._need_version) is None:
 
523
            raise self.Error("Needs GnuTLS {} or later"
 
524
                             .format(self._need_version))
528
525
 
529
526
    # Unless otherwise indicated, the constants and types below are
530
527
    # all from the gnutls/gnutls.h C header file.
572
569
 
573
570
    # Exceptions
574
571
    class Error(Exception):
 
572
        # We need to use the class name "GnuTLS" here, since this
 
573
        # exception might be raised from within GnuTLS.__init__,
 
574
        # which is called before the assignment to the "gnutls"
 
575
        # global variable has happened.
575
576
        def __init__(self, message=None, code=None, args=()):
576
577
            # Default usage is by a message string, but if a return
577
578
            # code is passed, convert it to a string with
578
579
            # gnutls.strerror()
579
580
            self.code = code
580
581
            if message is None and code is not None:
581
 
                message = gnutls.strerror(code)
582
 
            return super(gnutls.Error, self).__init__(
 
582
                message = GnuTLS.strerror(code)
 
583
            return super(GnuTLS.Error, self).__init__(
583
584
                message, *args)
584
585
 
585
586
    class CertificateSecurityError(Error):
586
587
        pass
587
588
 
588
589
    # Classes
589
 
    class Credentials:
 
590
    class Credentials(object):
590
591
        def __init__(self):
591
592
            self._c_object = gnutls.certificate_credentials_t()
592
593
            gnutls.certificate_allocate_credentials(
596
597
        def __del__(self):
597
598
            gnutls.certificate_free_credentials(self._c_object)
598
599
 
599
 
    class ClientSession:
 
600
    class ClientSession(object):
600
601
        def __init__(self, socket, credentials=None):
601
602
            self._c_object = gnutls.session_t()
602
603
            gnutls_flags = gnutls.CLIENT
603
 
            if gnutls.check_version(b"3.5.6"):
 
604
            if gnutls.check_version("3.5.6"):
604
605
                gnutls_flags |= gnutls.NO_TICKETS
605
606
            if gnutls.has_rawpk:
606
607
                gnutls_flags |= gnutls.ENABLE_RAWPK
743
744
    check_version.argtypes = [ctypes.c_char_p]
744
745
    check_version.restype = ctypes.c_char_p
745
746
 
746
 
    _need_version = b"3.3.0"
747
 
    if check_version(_need_version) is None:
748
 
        raise self.Error("Needs GnuTLS {} or later"
749
 
                         .format(_need_version))
750
 
 
751
 
    _tls_rawpk_version = b"3.6.6"
752
747
    has_rawpk = bool(check_version(_tls_rawpk_version))
753
748
 
754
749
    if has_rawpk:
808
803
                                                    ctypes.c_size_t)]
809
804
        openpgp_crt_get_fingerprint.restype = _error_code
810
805
 
811
 
    if check_version(b"3.6.4"):
 
806
    if check_version("3.6.4"):
812
807
        certificate_type_get2 = _library.gnutls_certificate_type_get2
813
808
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
809
        certificate_type_get2.restype = _error_code
815
810
 
816
811
    # Remove non-public functions
817
812
    del _error_code, _retry_on_error
 
813
# Create the global "gnutls" object, simulating a module
 
814
gnutls = GnuTLS()
818
815
 
819
816
 
820
817
def call_pipe(connection,       # : multiprocessing.Connection
828
825
    connection.close()
829
826
 
830
827
 
831
 
class Client:
 
828
class Client(object):
832
829
    """A representation of a client host served by this server.
833
830
 
834
831
    Attributes:
835
832
    approved:   bool(); 'None' if not yet approved/disapproved
836
833
    approval_delay: datetime.timedelta(); Time to wait for approval
837
834
    approval_duration: datetime.timedelta(); Duration of one approval
838
 
    checker: multiprocessing.Process(); a running checker process used
839
 
             to see if the client lives. 'None' if no process is
840
 
             running.
 
835
    checker:    subprocess.Popen(); a running checker process used
 
836
                                    to see if the client lives.
 
837
                                    'None' if no process is running.
841
838
    checker_callback_tag: a GLib event source tag, or None
842
839
    checker_command: string; External command which is run to check
843
840
                     if client lives.  %() expansions are done at
1050
1047
    def checker_callback(self, source, condition, connection,
1051
1048
                         command):
1052
1049
        """The checker has completed, so take appropriate actions."""
 
1050
        self.checker_callback_tag = None
 
1051
        self.checker = None
1053
1052
        # Read return code from connection (see call_pipe)
1054
1053
        returncode = connection.recv()
1055
1054
        connection.close()
1056
 
        self.checker.join()
1057
 
        self.checker_callback_tag = None
1058
 
        self.checker = None
1059
1055
 
1060
1056
        if returncode >= 0:
1061
1057
            self.last_checker_status = returncode
2223
2219
    del _interface
2224
2220
 
2225
2221
 
2226
 
class ProxyClient:
 
2222
class ProxyClient(object):
2227
2223
    def __init__(self, child_pipe, key_id, fpr, address):
2228
2224
        self._pipe = child_pipe
2229
2225
        self._pipe.send(('init', key_id, fpr, address))
2302
2298
            approval_required = False
2303
2299
            try:
2304
2300
                if gnutls.has_rawpk:
2305
 
                    fpr = b""
 
2301
                    fpr = ""
2306
2302
                    try:
2307
2303
                        key_id = self.key_id(
2308
2304
                            self.peer_certificate(session))
2312
2308
                    logger.debug("Key ID: %s", key_id)
2313
2309
 
2314
2310
                else:
2315
 
                    key_id = b""
 
2311
                    key_id = ""
2316
2312
                    try:
2317
2313
                        fpr = self.fingerprint(
2318
2314
                            self.peer_certificate(session))
2502
2498
        return hex_fpr
2503
2499
 
2504
2500
 
2505
 
class MultiprocessingMixIn:
 
2501
class MultiprocessingMixIn(object):
2506
2502
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2507
2503
 
2508
2504
    def sub_process_main(self, request, address):
2520
2516
        return proc
2521
2517
 
2522
2518
 
2523
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2519
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2524
2520
    """ adds a pipe to the MixIn """
2525
2521
 
2526
2522
    def process_request(self, request, client_address):
2541
2537
 
2542
2538
 
2543
2539
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2544
 
                     socketserver.TCPServer):
 
2540
                     socketserver.TCPServer, object):
2545
2541
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2546
2542
 
2547
2543
    Attributes:
2620
2616
                    raise
2621
2617
        # Only bind(2) the socket if we really need to.
2622
2618
        if self.server_address[0] or self.server_address[1]:
2623
 
            if self.server_address[1]:
2624
 
                self.allow_reuse_address = True
2625
2619
            if not self.server_address[0]:
2626
2620
                if self.address_family == socket.AF_INET6:
2627
2621
                    any_address = "::"  # in6addr_any
2982
2976
 
2983
2977
    options = parser.parse_args()
2984
2978
 
 
2979
    if options.check:
 
2980
        import doctest
 
2981
        fail_count, test_count = doctest.testmod()
 
2982
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2983
 
2985
2984
    # Default values for config file for server-global settings
2986
2985
    if gnutls.has_rawpk:
2987
2986
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3007
3006
    del priority
3008
3007
 
3009
3008
    # Parse config file for server-global settings
3010
 
    server_config = configparser.ConfigParser(server_defaults)
 
3009
    server_config = configparser.SafeConfigParser(server_defaults)
3011
3010
    del server_defaults
3012
3011
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3013
 
    # Convert the ConfigParser object to a dict
 
3012
    # Convert the SafeConfigParser object to a dict
3014
3013
    server_settings = server_config.defaults()
3015
3014
    # Use the appropriate methods on the non-string config options
3016
3015
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3088
3087
                                  server_settings["servicename"])))
3089
3088
 
3090
3089
    # Parse config file with clients
3091
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3090
    client_config = configparser.SafeConfigParser(Client
 
3091
                                                  .client_defaults)
3092
3092
    client_config.read(os.path.join(server_settings["configdir"],
3093
3093
                                    "clients.conf"))
3094
3094
 
3165
3165
        # Close all input and output, do double fork, etc.
3166
3166
        daemon()
3167
3167
 
3168
 
    if gi.version_info < (3, 10, 2):
3169
 
        # multiprocessing will use threads, so before we use GLib we
3170
 
        # need to inform GLib that threads will be used.
3171
 
        GLib.threads_init()
 
3168
    # multiprocessing will use threads, so before we use GLib we need
 
3169
    # to inform GLib that threads will be used.
 
3170
    GLib.threads_init()
3172
3171
 
3173
3172
    global main_loop
3174
3173
    # From the Avahi example code
3254
3253
                        for k in ("name", "host"):
3255
3254
                            if isinstance(value[k], bytes):
3256
3255
                                value[k] = value[k].decode("utf-8")
3257
 
                        if "key_id" not in value:
 
3256
                        if not value.has_key("key_id"):
3258
3257
                            value["key_id"] = ""
3259
 
                        elif "fingerprint" not in value:
 
3258
                        elif not value.has_key("fingerprint"):
3260
3259
                            value["fingerprint"] = ""
3261
3260
                    #  old_client_settings
3262
3261
                    # .keys()
3621
3620
    # Must run before the D-Bus bus name gets deregistered
3622
3621
    cleanup()
3623
3622
 
3624
 
 
3625
 
def should_only_run_tests():
3626
 
    parser = argparse.ArgumentParser(add_help=False)
3627
 
    parser.add_argument("--check", action='store_true')
3628
 
    args, unknown_args = parser.parse_known_args()
3629
 
    run_tests = args.check
3630
 
    if run_tests:
3631
 
        # Remove --check argument from sys.argv
3632
 
        sys.argv[1:] = unknown_args
3633
 
    return run_tests
3634
 
 
3635
 
# Add all tests from doctest strings
3636
 
def load_tests(loader, tests, none):
3637
 
    import doctest
3638
 
    tests.addTests(doctest.DocTestSuite())
3639
 
    return tests
3640
3623
 
3641
3624
if __name__ == '__main__':
3642
 
    try:
3643
 
        if should_only_run_tests():
3644
 
            # Call using ./mandos --check [--verbose]
3645
 
            unittest.main()
3646
 
        else:
3647
 
            main()
3648
 
    finally:
3649
 
        logging.shutdown()
 
3625
    main()