Move more general parts of internal/cryptlib.h to new internal/common.h Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/15847)
diff --git a/apps/fipsinstall.c b/apps/fipsinstall.c index 8152f39..3636311 100644 --- a/apps/fipsinstall.c +++ b/apps/fipsinstall.c
@@ -7,7 +7,6 @@ * https://www.openssl.org/source/license.html */ -#include "internal/cryptlib.h" #include <openssl/evp.h> #include <openssl/err.h> #include <openssl/provider.h>
diff --git a/apps/include/apps.h b/apps/include/apps.h index 7d9b64a..f95238a 100644 --- a/apps/include/apps.h +++ b/apps/include/apps.h
@@ -11,7 +11,7 @@ # define OSSL_APPS_H # include "e_os.h" /* struct timeval for DTLS */ -# include "internal/cryptlib.h" /* for HAS_PREFIX */ +# include "internal/common.h" /* for HAS_PREFIX */ # include "internal/nelem.h" # include "internal/sockets.h" /* for openssl_fdset() */ # include <assert.h>
diff --git a/apps/openssl.c b/apps/openssl.c index f347d64..d61acbb 100644 --- a/apps/openssl.c +++ b/apps/openssl.c
@@ -9,7 +9,7 @@ #include <stdio.h> #include <stdlib.h> -#include "internal/cryptlib.h" +#include "internal/common.h" #include <openssl/bio.h> #include <openssl/crypto.h> #include <openssl/trace.h>
diff --git a/crypto/cmp/cmp_http.c b/crypto/cmp/cmp_http.c index 6ac4212..43c2acb 100644 --- a/crypto/cmp/cmp_http.c +++ b/crypto/cmp/cmp_http.c
@@ -14,7 +14,6 @@ #include <openssl/asn1t.h> #include <openssl/http.h> -#include "internal/sockets.h" #include <openssl/cmp.h> #include "cmp_local.h"
diff --git a/crypto/http/http_client.c b/crypto/http/http_client.c index 9d66d7b..6be3e64 100644 --- a/crypto/http/http_client.c +++ b/crypto/http/http_client.c
@@ -21,7 +21,7 @@ #include <openssl/buffer.h> #include <openssl/http.h> #include "internal/sockets.h" -#include "internal/cryptlib.h" /* for ossl_assert() */ +#include "internal/common.h" /* for ossl_assert() */ #define HTTP_PREFIX "HTTP/" #define HTTP_VERSION_PATT "1." /* allow 1.x */
diff --git a/crypto/params_from_text.c b/crypto/params_from_text.c index 889b654..84851ed 100644 --- a/crypto/params_from_text.c +++ b/crypto/params_from_text.c
@@ -8,7 +8,7 @@ * https://www.openssl.org/source/license.html */ -#include "internal/cryptlib.h" /* for HAS_PREFIX */ +#include "internal/common.h" /* for HAS_PREFIX */ #include <openssl/ebcdic.h> #include <openssl/err.h> #include <openssl/params.h>
diff --git a/crypto/punycode.c b/crypto/punycode.c index 4c534db..f6d7ff7 100644 --- a/crypto/punycode.c +++ b/crypto/punycode.c
@@ -11,7 +11,7 @@ #include <stdio.h> #include <openssl/e_os2.h> #include "crypto/punycode.h" -#include "internal/cryptlib.h" /* for HAS_PREFIX */ +#include "internal/common.h" /* for HAS_PREFIX */ static const unsigned int base = 36; static const unsigned int tmin = 1;
diff --git a/engines/e_loader_attic.c b/engines/e_loader_attic.c index e5557df..59f19d3 100644 --- a/engines/e_loader_attic.c +++ b/engines/e_loader_attic.c
@@ -940,7 +940,6 @@ return 1; } -/* This function has quite some overlap with providers/implementations/storemgmt/file_store.c */ static OSSL_STORE_LOADER_CTX *file_open_ex (const OSSL_STORE_LOADER *loader, const char *uri, OSSL_LIB_CTX *libctx, const char *propq,
diff --git a/engines/e_ossltest.c b/engines/e_ossltest.c index 5b25a0e..19dda64 100644 --- a/engines/e_ossltest.c +++ b/engines/e_ossltest.c
@@ -27,7 +27,7 @@ #include <stdio.h> #include <string.h> -#include "internal/cryptlib.h" +#include "internal/common.h" /* for CHECK_AND_SKIP_CASE_PREFIX */ #include <openssl/engine.h> #include <openssl/sha.h>
diff --git a/include/internal/common.h b/include/internal/common.h new file mode 100644 index 0000000..44224f3 --- /dev/null +++ b/include/internal/common.h
@@ -0,0 +1,115 @@ +/* + * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved. + * + * Licensed under the Apache License 2.0 (the "License"). You may not use + * this file except in compliance with the License. You can obtain a copy + * in the file LICENSE in the source distribution or at + * https://www.openssl.org/source/license.html + */ + +#ifndef OSSL_INTERNAL_COMMON_H +# define OSSL_INTERNAL_COMMON_H +# pragma once + +# include <stdlib.h> +# include <string.h> +# include "../../e_os.h" /* To get strncasecmp() on Windows */ + +# include "internal/nelem.h" + +#ifdef NDEBUG +# define ossl_assert(x) ((x) != 0) +#else +__owur static ossl_inline int ossl_assert_int(int expr, const char *exprstr, + const char *file, int line) +{ + if (!expr) + OPENSSL_die(exprstr, file, line); + + return expr; +} + +# define ossl_assert(x) ossl_assert_int((x) != 0, "Assertion failed: "#x, \ + __FILE__, __LINE__) + +#endif + +/* Check if |pre|, which must be a string literal, is a prefix of |str| */ +#define HAS_PREFIX(str, pre) (strncmp(str, pre "", sizeof(pre) - 1) == 0) +/* As before, and if check succeeds, advance |str| past the prefix |pre| */ +#define CHECK_AND_SKIP_PREFIX(str, pre) \ + (HAS_PREFIX(str, pre) ? ((str) += sizeof(pre) - 1, 1) : 0) +/* Check if the string literal |p| is a case-insensitive prefix of |s| */ +#define HAS_CASE_PREFIX(s, p) (strncasecmp(s, p "", sizeof(p) - 1) == 0) +/* As before, and if check succeeds, advance |str| past the prefix |pre| */ +#define CHECK_AND_SKIP_CASE_PREFIX(str, pre) \ + (HAS_CASE_PREFIX(str, pre) ? ((str) += sizeof(pre) - 1, 1) : 0) +/* Check if the string literal |suffix| is a case-insensitive suffix of |str| */ +#define HAS_CASE_SUFFIX(str, suffix) (strlen(str) < sizeof(suffix) - 1 ? 0 : \ + strcasecmp(str + strlen(str) - sizeof(suffix) + 1, suffix "") == 0) + +/* + * Use this inside a union with the field that needs to be aligned to a + * reasonable boundary for the platform. The most pessimistic alignment + * of the listed types will be used by the compiler. + */ +# define OSSL_UNION_ALIGN \ + double align; \ + ossl_uintmax_t align_int; \ + void *align_ptr + +# define OPENSSL_CONF "openssl.cnf" + +# ifndef OPENSSL_SYS_VMS +# define X509_CERT_AREA OPENSSLDIR +# define X509_CERT_DIR OPENSSLDIR "/certs" +# define X509_CERT_FILE OPENSSLDIR "/cert.pem" +# define X509_PRIVATE_DIR OPENSSLDIR "/private" +# define CTLOG_FILE OPENSSLDIR "/ct_log_list.cnf" +# else +# define X509_CERT_AREA "OSSL$DATAROOT:[000000]" +# define X509_CERT_DIR "OSSL$DATAROOT:[CERTS]" +# define X509_CERT_FILE "OSSL$DATAROOT:[000000]cert.pem" +# define X509_PRIVATE_DIR "OSSL$DATAROOT:[PRIVATE]" +# define CTLOG_FILE "OSSL$DATAROOT:[000000]ct_log_list.cnf" +# endif + +# define X509_CERT_DIR_EVP "SSL_CERT_DIR" +# define X509_CERT_FILE_EVP "SSL_CERT_FILE" +# define CTLOG_FILE_EVP "CTLOG_FILE" + +/* size of string representations */ +# define DECIMAL_SIZE(type) ((sizeof(type)*8+2)/3+1) +# define HEX_SIZE(type) (sizeof(type)*2) + +static ossl_inline int ossl_ends_with_dirsep(const char *path) +{ + if (*path != '\0') + path += strlen(path) - 1; +# if defined __VMS + if (*path == ']' || *path == '>' || *path == ':') + return 1; +# elif defined _WIN32 + if (*path == '\\') + return 1; +# endif + return *path == '/'; +} + +static ossl_inline int ossl_is_absolute_path(const char *path) +{ +# if defined __VMS + if (strchr(path, ':') != NULL + || ((path[0] == '[' || path[0] == '<') + && path[1] != '.' && path[1] != '-' + && path[1] != ']' && path[1] != '>')) + return 1; +# elif defined _WIN32 + if (path[0] == '\\' + || (path[0] != '\0' && path[1] == ':')) + return 1; +# endif + return path[0] == '/'; +} + +#endif
diff --git a/include/internal/cryptlib.h b/include/internal/cryptlib.h index 00d156f..c017d06 100644 --- a/include/internal/cryptlib.h +++ b/include/internal/cryptlib.h
@@ -11,10 +11,6 @@ # define OSSL_INTERNAL_CRYPTLIB_H # pragma once -# include <stdlib.h> -# include <string.h> -# include "../../e_os.h" /* To get strncasecmp() on Windows */ - # ifdef OPENSSL_USE_APPLINK # define BIO_FLAGS_UPLINK_INTERNAL 0x8000 # include "ms/uplink.h" @@ -22,54 +18,13 @@ # define BIO_FLAGS_UPLINK_INTERNAL 0 # endif +# include "internal/common.h" + # include <openssl/crypto.h> # include <openssl/buffer.h> # include <openssl/bio.h> # include <openssl/asn1.h> # include <openssl/err.h> -# include "internal/nelem.h" - -#ifdef NDEBUG -# define ossl_assert(x) ((x) != 0) -#else -__owur static ossl_inline int ossl_assert_int(int expr, const char *exprstr, - const char *file, int line) -{ - if (!expr) - OPENSSL_die(exprstr, file, line); - - return expr; -} - -# define ossl_assert(x) ossl_assert_int((x) != 0, "Assertion failed: "#x, \ - __FILE__, __LINE__) - -#endif - -/* Check if |pre|, which must be a string literal, is a prefix of |str| */ -#define HAS_PREFIX(str, pre) (strncmp(str, pre "", sizeof(pre) - 1) == 0) -/* As before, and if check succeeds, advance |str| past the prefix |pre| */ -#define CHECK_AND_SKIP_PREFIX(str, pre) \ - (HAS_PREFIX(str, pre) ? ((str) += sizeof(pre) - 1, 1) : 0) -/* Check if the string literal |p| is a case-insensitive prefix of |s| */ -#define HAS_CASE_PREFIX(s, p) (strncasecmp(s, p "", sizeof(p) - 1) == 0) -/* As before, and if check succeeds, advance |str| past the prefix |pre| */ -#define CHECK_AND_SKIP_CASE_PREFIX(str, pre) \ - (HAS_CASE_PREFIX(str, pre) ? ((str) += sizeof(pre) - 1, 1) : 0) -/* Check if the string literal |suffix| is a case-insensitive suffix of |str| */ -#define HAS_CASE_SUFFIX(str, suffix) (strlen(str) < sizeof(suffix) - 1 ? 0 : \ - strcasecmp(str + strlen(str) - sizeof(suffix) + 1, suffix "") == 0) - - -/* - * Use this inside a union with the field that needs to be aligned to a - * reasonable boundary for the platform. The most pessimistic alignment - * of the listed types will be used by the compiler. - */ -# define OSSL_UNION_ALIGN \ - double align; \ - ossl_uintmax_t align_int; \ - void *align_ptr typedef struct ex_callback_st EX_CALLBACK; DEFINE_STACK_OF(EX_CALLBACK) @@ -77,30 +32,6 @@ typedef struct mem_st MEM; DEFINE_LHASH_OF(MEM); -# define OPENSSL_CONF "openssl.cnf" - -# ifndef OPENSSL_SYS_VMS -# define X509_CERT_AREA OPENSSLDIR -# define X509_CERT_DIR OPENSSLDIR "/certs" -# define X509_CERT_FILE OPENSSLDIR "/cert.pem" -# define X509_PRIVATE_DIR OPENSSLDIR "/private" -# define CTLOG_FILE OPENSSLDIR "/ct_log_list.cnf" -# else -# define X509_CERT_AREA "OSSL$DATAROOT:[000000]" -# define X509_CERT_DIR "OSSL$DATAROOT:[CERTS]" -# define X509_CERT_FILE "OSSL$DATAROOT:[000000]cert.pem" -# define X509_PRIVATE_DIR "OSSL$DATAROOT:[PRIVATE]" -# define CTLOG_FILE "OSSL$DATAROOT:[000000]ct_log_list.cnf" -# endif - -# define X509_CERT_DIR_EVP "SSL_CERT_DIR" -# define X509_CERT_FILE_EVP "SSL_CERT_FILE" -# define CTLOG_FILE_EVP "CTLOG_FILE" - -/* size of string representations */ -# define DECIMAL_SIZE(type) ((sizeof(type)*8+2)/3+1) -# define HEX_SIZE(type) (sizeof(type)*2) - void OPENSSL_cpuid_setup(void); #if defined(__i386) || defined(__i386__) || defined(_M_IX86) || \ defined(__x86_64) || defined(__x86_64__) || \ @@ -244,34 +175,4 @@ unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen, const char sep); -static ossl_inline int ossl_ends_with_dirsep(const char *path) -{ - if (*path != '\0') - path += strlen(path) - 1; -# if defined __VMS - if (*path == ']' || *path == '>' || *path == ':') - return 1; -# elif defined _WIN32 - if (*path == '\\') - return 1; -# endif - return *path == '/'; -} - -static ossl_inline int ossl_is_absolute_path(const char *path) -{ -# if defined __VMS - if (strchr(path, ':') != NULL - || ((path[0] == '[' || path[0] == '<') - && path[1] != '.' && path[1] != '-' - && path[1] != ']' && path[1] != '>')) - return 1; -# elif defined _WIN32 - if (path[0] == '\\' - || (path[0] != '\0' && path[1] == ':')) - return 1; -# endif - return path[0] == '/'; -} - #endif
diff --git a/providers/implementations/storemgmt/file_store.c b/providers/implementations/storemgmt/file_store.c index 59d4e08..340b01b 100644 --- a/providers/implementations/storemgmt/file_store.c +++ b/providers/implementations/storemgmt/file_store.c
@@ -169,7 +169,6 @@ return NULL; } -/* This function has quite some overlap with engines/e_loader_attic.c */ static void *file_open_dir(const char *path, const char *uri, void *provctx) { struct file_ctx_st *ctx;
diff --git a/ssl/ssl_local.h b/ssl/ssl_local.h index 6835bfe..9b88140 100644 --- a/ssl/ssl_local.h +++ b/ssl/ssl_local.h
@@ -16,7 +16,7 @@ # include <stdlib.h> # include <time.h> # include <errno.h> -# include "internal/cryptlib.h" /* for HAS_PREFIX */ +# include "internal/common.h" /* for HAS_PREFIX */ # include <openssl/buffer.h> # include <openssl/comp.h>
diff --git a/test/testutil.h b/test/testutil.h index d60f002..52fb17c 100644 --- a/test/testutil.h +++ b/test/testutil.h
@@ -11,7 +11,7 @@ # define OSSL_TESTUTIL_H # include <stdarg.h> -# include "internal/cryptlib.h" /* for HAS_PREFIX */ +# include "internal/common.h" /* for HAS_PREFIX */ # include <openssl/provider.h> # include <openssl/err.h>