Blame test/shlibloadtest.c

Packit c4476c
/*
Packit c4476c
 * Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
 *
Packit c4476c
 * Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
 * this file except in compliance with the License.  You can obtain a copy
Packit c4476c
 * in the file LICENSE in the source distribution or at
Packit c4476c
 * https://www.openssl.org/source/license.html
Packit c4476c
 */
Packit c4476c
Packit c4476c
#include <stdio.h>
Packit c4476c
#include <string.h>
Packit c4476c
#include <stdlib.h>
Packit c4476c
#include <openssl/opensslv.h>
Packit c4476c
#include <openssl/ssl.h>
Packit c4476c
#include <openssl/ossl_typ.h>
Packit c4476c
#include "crypto/dso_conf.h"
Packit c4476c
Packit c4476c
typedef void DSO;
Packit c4476c
Packit c4476c
typedef const SSL_METHOD * (*TLS_method_t)(void);
Packit c4476c
typedef SSL_CTX * (*SSL_CTX_new_t)(const SSL_METHOD *meth);
Packit c4476c
typedef void (*SSL_CTX_free_t)(SSL_CTX *);
Packit c4476c
typedef int (*OPENSSL_init_crypto_t)(uint64_t, void *);
Packit c4476c
typedef int (*OPENSSL_atexit_t)(void (*handler)(void));
Packit c4476c
typedef unsigned long (*ERR_get_error_t)(void);
Packit c4476c
typedef unsigned long (*OpenSSL_version_num_t)(void);
Packit c4476c
typedef DSO * (*DSO_dsobyaddr_t)(void (*addr)(void), int flags);
Packit c4476c
typedef int (*DSO_free_t)(DSO *dso);
Packit c4476c
Packit c4476c
typedef enum test_types_en {
Packit c4476c
    CRYPTO_FIRST,
Packit c4476c
    SSL_FIRST,
Packit c4476c
    JUST_CRYPTO,
Packit c4476c
    DSO_REFTEST,
Packit c4476c
    NO_ATEXIT
Packit c4476c
} TEST_TYPE;
Packit c4476c
Packit c4476c
static TEST_TYPE test_type;
Packit c4476c
static const char *path_crypto;
Packit c4476c
static const char *path_ssl;
Packit c4476c
static const char *path_atexit;
Packit c4476c
Packit c4476c
#ifdef DSO_DLFCN
Packit c4476c
Packit c4476c
# include <dlfcn.h>
Packit c4476c
Packit c4476c
# define SHLIB_INIT NULL
Packit c4476c
Packit c4476c
typedef void *SHLIB;
Packit c4476c
typedef void *SHLIB_SYM;
Packit c4476c
Packit c4476c
static int shlib_load(const char *filename, SHLIB *lib)
Packit c4476c
{
Packit c4476c
    int dl_flags = (RTLD_GLOBAL|RTLD_LAZY);
Packit c4476c
#ifdef _AIX
Packit c4476c
    if (filename[strlen(filename) - 1] == ')')
Packit c4476c
        dl_flags |= RTLD_MEMBER;
Packit c4476c
#endif
Packit c4476c
    *lib = dlopen(filename, dl_flags);
Packit c4476c
    return *lib == NULL ? 0 : 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int shlib_sym(SHLIB lib, const char *symname, SHLIB_SYM *sym)
Packit c4476c
{
Packit c4476c
    *sym = dlsym(lib, symname);
Packit c4476c
    return *sym != NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int shlib_close(SHLIB lib)
Packit c4476c
{
Packit c4476c
    return dlclose(lib) != 0 ? 0 : 1;
Packit c4476c
}
Packit c4476c
#endif
Packit c4476c
Packit c4476c
#ifdef DSO_WIN32
Packit c4476c
Packit c4476c
# include <windows.h>
Packit c4476c
Packit c4476c
# define SHLIB_INIT 0
Packit c4476c
Packit c4476c
typedef HINSTANCE SHLIB;
Packit c4476c
typedef void *SHLIB_SYM;
Packit c4476c
Packit c4476c
static int shlib_load(const char *filename, SHLIB *lib)
Packit c4476c
{
Packit c4476c
    *lib = LoadLibraryA(filename);
Packit c4476c
    return *lib == NULL ? 0 : 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int shlib_sym(SHLIB lib, const char *symname, SHLIB_SYM *sym)
Packit c4476c
{
Packit c4476c
    *sym = (SHLIB_SYM)GetProcAddress(lib, symname);
Packit c4476c
    return *sym != NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int shlib_close(SHLIB lib)
Packit c4476c
{
Packit c4476c
    return FreeLibrary(lib) == 0 ? 0 : 1;
Packit c4476c
}
Packit c4476c
#endif
Packit c4476c
Packit c4476c
Packit c4476c
#if defined(DSO_DLFCN) || defined(DSO_WIN32)
Packit c4476c
Packit c4476c
static int atexit_handler_done = 0;
Packit c4476c
Packit c4476c
static void atexit_handler(void)
Packit c4476c
{
Packit c4476c
    FILE *atexit_file = fopen(path_atexit, "w");
Packit c4476c
Packit c4476c
    if (atexit_file == NULL)
Packit c4476c
        return;
Packit c4476c
Packit c4476c
    fprintf(atexit_file, "atexit() run\n");
Packit c4476c
    fclose(atexit_file);
Packit c4476c
    atexit_handler_done++;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int test_lib(void)
Packit c4476c
{
Packit c4476c
    SHLIB ssllib = SHLIB_INIT;
Packit c4476c
    SHLIB cryptolib = SHLIB_INIT;
Packit c4476c
    SSL_CTX *ctx;
Packit c4476c
    union {
Packit c4476c
        void (*func)(void);
Packit c4476c
        SHLIB_SYM sym;
Packit c4476c
    } symbols[3];
Packit c4476c
    TLS_method_t myTLS_method;
Packit c4476c
    SSL_CTX_new_t mySSL_CTX_new;
Packit c4476c
    SSL_CTX_free_t mySSL_CTX_free;
Packit c4476c
    ERR_get_error_t myERR_get_error;
Packit c4476c
    OpenSSL_version_num_t myOpenSSL_version_num;
Packit c4476c
    OPENSSL_atexit_t myOPENSSL_atexit;
Packit c4476c
    int result = 0;
Packit c4476c
Packit c4476c
    switch (test_type) {
Packit c4476c
    case JUST_CRYPTO:
Packit c4476c
    case DSO_REFTEST:
Packit c4476c
    case NO_ATEXIT:
Packit c4476c
    case CRYPTO_FIRST:
Packit c4476c
        if (!shlib_load(path_crypto, &cryptolib)) {
Packit c4476c
            fprintf(stderr, "Failed to load libcrypto\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
        if (test_type != CRYPTO_FIRST)
Packit c4476c
            break;
Packit c4476c
        /* Fall through */
Packit c4476c
Packit c4476c
    case SSL_FIRST:
Packit c4476c
        if (!shlib_load(path_ssl, &ssllib)) {
Packit c4476c
            fprintf(stderr, "Failed to load libssl\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
        if (test_type != SSL_FIRST)
Packit c4476c
            break;
Packit c4476c
        if (!shlib_load(path_crypto, &cryptolib)) {
Packit c4476c
            fprintf(stderr, "Failed to load libcrypto\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (test_type == NO_ATEXIT) {
Packit c4476c
        OPENSSL_init_crypto_t myOPENSSL_init_crypto;
Packit c4476c
Packit c4476c
        if (!shlib_sym(cryptolib, "OPENSSL_init_crypto", &symbols[0].sym)) {
Packit c4476c
            fprintf(stderr, "Failed to load OPENSSL_init_crypto symbol\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
        myOPENSSL_init_crypto = (OPENSSL_init_crypto_t)symbols[0].func;
Packit c4476c
        if (!myOPENSSL_init_crypto(OPENSSL_INIT_NO_ATEXIT, NULL)) {
Packit c4476c
            fprintf(stderr, "Failed to initialise libcrypto\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (test_type != JUST_CRYPTO
Packit c4476c
            && test_type != DSO_REFTEST
Packit c4476c
            && test_type != NO_ATEXIT) {
Packit c4476c
        if (!shlib_sym(ssllib, "TLS_method", &symbols[0].sym)
Packit c4476c
                || !shlib_sym(ssllib, "SSL_CTX_new", &symbols[1].sym)
Packit c4476c
                || !shlib_sym(ssllib, "SSL_CTX_free", &symbols[2].sym)) {
Packit c4476c
            fprintf(stderr, "Failed to load libssl symbols\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
        myTLS_method = (TLS_method_t)symbols[0].func;
Packit c4476c
        mySSL_CTX_new = (SSL_CTX_new_t)symbols[1].func;
Packit c4476c
        mySSL_CTX_free = (SSL_CTX_free_t)symbols[2].func;
Packit c4476c
        ctx = mySSL_CTX_new(myTLS_method());
Packit c4476c
        if (ctx == NULL) {
Packit c4476c
            fprintf(stderr, "Failed to create SSL_CTX\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
        mySSL_CTX_free(ctx);
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (!shlib_sym(cryptolib, "ERR_get_error", &symbols[0].sym)
Packit c4476c
           || !shlib_sym(cryptolib, "OpenSSL_version_num", &symbols[1].sym)
Packit c4476c
           || !shlib_sym(cryptolib, "OPENSSL_atexit", &symbols[2].sym)) {
Packit c4476c
        fprintf(stderr, "Failed to load libcrypto symbols\n");
Packit c4476c
        goto end;
Packit c4476c
    }
Packit c4476c
    myERR_get_error = (ERR_get_error_t)symbols[0].func;
Packit c4476c
    if (myERR_get_error() != 0) {
Packit c4476c
        fprintf(stderr, "Unexpected ERR_get_error() response\n");
Packit c4476c
        goto end;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    myOpenSSL_version_num = (OpenSSL_version_num_t)symbols[1].func;
Packit c4476c
    if (myOpenSSL_version_num()  != OPENSSL_VERSION_NUMBER) {
Packit c4476c
        fprintf(stderr, "Invalid library version number\n");
Packit c4476c
        goto end;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    myOPENSSL_atexit = (OPENSSL_atexit_t)symbols[2].func;
Packit c4476c
    if (!myOPENSSL_atexit(atexit_handler)) {
Packit c4476c
        fprintf(stderr, "Failed to register atexit handler\n");
Packit c4476c
        goto end;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (test_type == DSO_REFTEST) {
Packit c4476c
# ifdef DSO_DLFCN
Packit c4476c
        DSO_dsobyaddr_t myDSO_dsobyaddr;
Packit c4476c
        DSO_free_t myDSO_free;
Packit c4476c
Packit c4476c
        /*
Packit c4476c
         * This is resembling the code used in ossl_init_base() and
Packit c4476c
         * OPENSSL_atexit() to block unloading the library after dlclose().
Packit c4476c
         * We are not testing this on Windows, because it is done there in a
Packit c4476c
         * completely different way. Especially as a call to DSO_dsobyaddr()
Packit c4476c
         * will always return an error, because DSO_pathbyaddr() is not
Packit c4476c
         * implemented there.
Packit c4476c
         */
Packit c4476c
        if (!shlib_sym(cryptolib, "DSO_dsobyaddr", &symbols[0].sym)
Packit c4476c
                || !shlib_sym(cryptolib, "DSO_free", &symbols[1].sym)) {
Packit c4476c
            fprintf(stderr, "Unable to load DSO symbols\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        myDSO_dsobyaddr = (DSO_dsobyaddr_t)symbols[0].func;
Packit c4476c
        myDSO_free = (DSO_free_t)symbols[1].func;
Packit c4476c
Packit c4476c
        {
Packit c4476c
            DSO *hndl;
Packit c4476c
            /* use known symbol from crypto module */
Packit c4476c
            hndl = myDSO_dsobyaddr((void (*)(void))myERR_get_error, 0);
Packit c4476c
            if (hndl == NULL) {
Packit c4476c
                fprintf(stderr, "DSO_dsobyaddr() failed\n");
Packit c4476c
                goto end;
Packit c4476c
            }
Packit c4476c
            myDSO_free(hndl);
Packit c4476c
        }
Packit c4476c
# endif /* DSO_DLFCN */
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (!shlib_close(cryptolib)) {
Packit c4476c
        fprintf(stderr, "Failed to close libcrypto\n");
Packit c4476c
        goto end;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (test_type == CRYPTO_FIRST || test_type == SSL_FIRST) {
Packit c4476c
        if (!shlib_close(ssllib)) {
Packit c4476c
            fprintf(stderr, "Failed to close libssl\n");
Packit c4476c
            goto end;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
# if defined(OPENSSL_NO_PINSHARED) \
Packit c4476c
    && defined(__GLIBC__) \
Packit c4476c
    && defined(__GLIBC_PREREQ) \
Packit c4476c
    && defined(OPENSSL_SYS_LINUX)
Packit c4476c
#  if __GLIBC_PREREQ(2, 3)
Packit c4476c
    /*
Packit c4476c
     * If we didn't pin the so then we are hopefully on a platform that supports
Packit c4476c
     * running atexit() on so unload. If not we might crash. We know this is
Packit c4476c
     * true on linux since glibc 2.2.3
Packit c4476c
     */
Packit c4476c
    if (test_type != NO_ATEXIT && atexit_handler_done != 1) {
Packit c4476c
        fprintf(stderr, "atexit() handler did not run\n");
Packit c4476c
        goto end;
Packit c4476c
    }
Packit c4476c
#  endif
Packit c4476c
# endif
Packit c4476c
Packit c4476c
    result = 1;
Packit c4476c
end:
Packit c4476c
    return result;
Packit c4476c
}
Packit c4476c
#endif
Packit c4476c
Packit c4476c
Packit c4476c
/*
Packit c4476c
 * shlibloadtest should not use the normal test framework because we don't want
Packit c4476c
 * it to link against libcrypto (which the framework uses). The point of the
Packit c4476c
 * test is to check dynamic loading and unloading of libcrypto/libssl.
Packit c4476c
 */
Packit c4476c
int main(int argc, char *argv[])
Packit c4476c
{
Packit c4476c
    const char *p;
Packit c4476c
Packit c4476c
    if (argc != 5) {
Packit c4476c
        fprintf(stderr, "Incorrect number of arguments\n");
Packit c4476c
        return 1;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    p = argv[1];
Packit c4476c
Packit c4476c
    if (strcmp(p, "-crypto_first") == 0) {
Packit c4476c
        test_type = CRYPTO_FIRST;
Packit c4476c
    } else if (strcmp(p, "-ssl_first") == 0) {
Packit c4476c
        test_type = SSL_FIRST;
Packit c4476c
    } else if (strcmp(p, "-just_crypto") == 0) {
Packit c4476c
        test_type = JUST_CRYPTO;
Packit c4476c
    } else if (strcmp(p, "-dso_ref") == 0) {
Packit c4476c
        test_type = DSO_REFTEST;
Packit c4476c
    } else if (strcmp(p, "-no_atexit") == 0) {
Packit c4476c
        test_type = NO_ATEXIT;
Packit c4476c
    } else {
Packit c4476c
        fprintf(stderr, "Unrecognised argument\n");
Packit c4476c
        return 1;
Packit c4476c
    }
Packit c4476c
    path_crypto = argv[2];
Packit c4476c
    path_ssl = argv[3];
Packit c4476c
    path_atexit = argv[4];
Packit c4476c
    if (path_crypto == NULL || path_ssl == NULL) {
Packit c4476c
        fprintf(stderr, "Invalid libcrypto/libssl path\n");
Packit c4476c
        return 1;
Packit c4476c
    }
Packit c4476c
Packit c4476c
#if defined(DSO_DLFCN) || defined(DSO_WIN32)
Packit c4476c
    if (!test_lib())
Packit c4476c
        return 1;
Packit c4476c
#endif
Packit c4476c
    return 0;
Packit c4476c
}