/* ====================================================================
|
* Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
|
*
|
* Redistribution and use in source and binary forms, with or without
|
* modification, are permitted provided that the following conditions
|
* are met:
|
*
|
* 1. Redistributions of source code must retain the above copyright
|
* notice, this list of conditions and the following disclaimer.
|
*
|
* 2. Redistributions in binary form must reproduce the above copyright
|
* notice, this list of conditions and the following disclaimer in
|
* the documentation and/or other materials provided with the
|
* distribution.
|
*
|
* 3. All advertising materials mentioning features or use of this
|
* software must display the following acknowledgment:
|
* "This product includes software developed by the OpenSSL Project
|
* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
|
*
|
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
|
* endorse or promote products derived from this software without
|
* prior written permission. For written permission, please contact
|
* openssl-core@openssl.org.
|
*
|
* 5. Products derived from this software may not be called "OpenSSL"
|
* nor may "OpenSSL" appear in their names without prior written
|
* permission of the OpenSSL Project.
|
*
|
* 6. Redistributions of any form whatsoever must retain the following
|
* acknowledgment:
|
* "This product includes software developed by the OpenSSL Project
|
* for use in the OpenSSL Toolkit (http://www.openssl.org/)"
|
*
|
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
|
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
* ====================================================================
|
*
|
* This product includes cryptographic software written by Eric Young
|
* (eay@cryptsoft.com). This product includes software written by Tim
|
* Hudson (tjh@cryptsoft.com). */
|
|
#ifndef OPENSSL_HEADER_BASE_H
|
#define OPENSSL_HEADER_BASE_H
|
|
|
// This file should be the first included by all BoringSSL headers.
|
|
#include <stddef.h>
|
#include <stdint.h>
|
#include <sys/types.h>
|
|
#if defined(__MINGW32__)
|
// stdio.h is needed on MinGW for __MINGW_PRINTF_FORMAT.
|
#include <stdio.h>
|
#endif
|
|
// Include a BoringSSL-only header so consumers including this header without
|
// setting up include paths do not accidentally pick up the system
|
// opensslconf.h.
|
#include <openssl/is_boringssl.h>
|
#include <openssl/opensslconf.h>
|
|
#if defined(BORINGSSL_PREFIX)
|
#include <boringssl_prefix_symbols.h>
|
#endif
|
|
#if defined(__cplusplus)
|
extern "C" {
|
#endif
|
|
|
#if defined(__x86_64) || defined(_M_AMD64) || defined(_M_X64)
|
#define OPENSSL_64_BIT
|
#define OPENSSL_X86_64
|
#elif defined(__x86) || defined(__i386) || defined(__i386__) || defined(_M_IX86)
|
#define OPENSSL_32_BIT
|
#define OPENSSL_X86
|
#elif defined(__aarch64__)
|
#define OPENSSL_64_BIT
|
#define OPENSSL_AARCH64
|
#elif defined(__arm) || defined(__arm__) || defined(_M_ARM)
|
#define OPENSSL_32_BIT
|
#define OPENSSL_ARM
|
#elif (defined(__PPC64__) || defined(__powerpc64__)) && defined(_LITTLE_ENDIAN)
|
#define OPENSSL_64_BIT
|
#define OPENSSL_PPC64LE
|
#elif defined(__mips__) && !defined(__LP64__)
|
#define OPENSSL_32_BIT
|
#define OPENSSL_MIPS
|
#elif defined(__mips__) && defined(__LP64__)
|
#define OPENSSL_64_BIT
|
#define OPENSSL_MIPS64
|
#elif defined(__pnacl__)
|
#define OPENSSL_32_BIT
|
#define OPENSSL_PNACL
|
#elif defined(__myriad2__)
|
#define OPENSSL_32_BIT
|
#else
|
// Note BoringSSL only supports standard 32-bit and 64-bit two's-complement,
|
// little-endian architectures. Functions will not produce the correct answer
|
// on other systems. Run the crypto_test binary, notably
|
// crypto/compiler_test.cc, before adding a new architecture.
|
#error "Unknown target CPU"
|
#endif
|
|
#if defined(__APPLE__)
|
#define OPENSSL_APPLE
|
#endif
|
|
#if defined(_WIN32)
|
#define OPENSSL_WINDOWS
|
#endif
|
|
#if defined(__linux__)
|
#define OPENSSL_LINUX
|
#endif
|
|
#if defined(__Fuchsia__)
|
#define OPENSSL_FUCHSIA
|
#endif
|
|
#if defined(TRUSTY)
|
#define OPENSSL_TRUSTY
|
#define OPENSSL_NO_THREADS
|
#endif
|
|
#if !defined(OPENSSL_NO_THREADS)
|
#define OPENSSL_THREADS
|
#endif
|
|
#define OPENSSL_IS_BORINGSSL
|
#define OPENSSL_VERSION_NUMBER 0x1010007f
|
#define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
|
|
// BORINGSSL_API_VERSION is a positive integer that increments as BoringSSL
|
// changes over time. The value itself is not meaningful. It will be incremented
|
// whenever is convenient to coordinate an API change with consumers. This will
|
// not denote any special point in development.
|
//
|
// A consumer may use this symbol in the preprocessor to temporarily build
|
// against multiple revisions of BoringSSL at the same time. It is not
|
// recommended to do so for longer than is necessary.
|
#define BORINGSSL_API_VERSION 4
|
|
#if defined(BORINGSSL_SHARED_LIBRARY)
|
|
#if defined(OPENSSL_WINDOWS)
|
|
#if defined(BORINGSSL_IMPLEMENTATION)
|
#define OPENSSL_EXPORT __declspec(dllexport)
|
#else
|
#define OPENSSL_EXPORT __declspec(dllimport)
|
#endif
|
|
#else // defined(OPENSSL_WINDOWS)
|
|
#if defined(BORINGSSL_IMPLEMENTATION)
|
#define OPENSSL_EXPORT __attribute__((visibility("default")))
|
#else
|
#define OPENSSL_EXPORT
|
#endif
|
|
#endif // defined(OPENSSL_WINDOWS)
|
|
#else // defined(BORINGSSL_SHARED_LIBRARY)
|
|
#define OPENSSL_EXPORT
|
|
#endif // defined(BORINGSSL_SHARED_LIBRARY)
|
|
|
#if defined(__GNUC__)
|
// MinGW has two different printf implementations. Ensure the format macro
|
// matches the selected implementation. See
|
// https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/.
|
#if defined(__MINGW_PRINTF_FORMAT)
|
#define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
|
__attribute__( \
|
(__format__(__MINGW_PRINTF_FORMAT, string_index, first_to_check)))
|
#else
|
#define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
|
__attribute__((__format__(__printf__, string_index, first_to_check)))
|
#endif
|
#else
|
#define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check)
|
#endif
|
|
// OPENSSL_MSVC_PRAGMA emits a pragma on MSVC and nothing on other compilers.
|
#if defined(_MSC_VER)
|
#define OPENSSL_MSVC_PRAGMA(arg) __pragma(arg)
|
#else
|
#define OPENSSL_MSVC_PRAGMA(arg)
|
#endif
|
|
#if defined(__GNUC__) || defined(__clang__)
|
#define OPENSSL_UNUSED __attribute__((unused))
|
#else
|
#define OPENSSL_UNUSED
|
#endif
|
|
#if defined(BORINGSSL_UNSAFE_FUZZER_MODE) && \
|
!defined(BORINGSSL_UNSAFE_DETERMINISTIC_MODE)
|
#define BORINGSSL_UNSAFE_DETERMINISTIC_MODE
|
#endif
|
|
#if defined(__has_feature)
|
#if __has_feature(address_sanitizer)
|
#define OPENSSL_ASAN
|
#endif
|
#if __has_feature(memory_sanitizer)
|
#define OPENSSL_MSAN
|
#endif
|
#endif
|
|
// Have a generic fall-through for different versions of C/C++.
|
#if defined(__cplusplus) && __cplusplus >= 201703L
|
#define OPENSSL_FALLTHROUGH [[fallthrough]]
|
#elif defined(__cplusplus) && __cplusplus >= 201103L && defined(__clang__)
|
#define OPENSSL_FALLTHROUGH [[clang::fallthrough]]
|
#elif defined(__cplusplus) && __cplusplus >= 201103L && __GNUC__ >= 7
|
#define OPENSSL_FALLTHROUGH [[gnu::fallthrough]]
|
#elif __GNUC__ >= 7 // gcc 7
|
#define OPENSSL_FALLTHROUGH __attribute__ ((fallthrough))
|
#else // C++11 on gcc 6, and all other cases
|
#define OPENSSL_FALLTHROUGH
|
#endif
|
|
// CRYPTO_THREADID is a dummy value.
|
typedef int CRYPTO_THREADID;
|
|
typedef int ASN1_BOOLEAN;
|
typedef int ASN1_NULL;
|
typedef struct ASN1_ITEM_st ASN1_ITEM;
|
typedef struct asn1_object_st ASN1_OBJECT;
|
typedef struct asn1_pctx_st ASN1_PCTX;
|
typedef struct asn1_string_st ASN1_BIT_STRING;
|
typedef struct asn1_string_st ASN1_BMPSTRING;
|
typedef struct asn1_string_st ASN1_ENUMERATED;
|
typedef struct asn1_string_st ASN1_GENERALIZEDTIME;
|
typedef struct asn1_string_st ASN1_GENERALSTRING;
|
typedef struct asn1_string_st ASN1_IA5STRING;
|
typedef struct asn1_string_st ASN1_INTEGER;
|
typedef struct asn1_string_st ASN1_OCTET_STRING;
|
typedef struct asn1_string_st ASN1_PRINTABLESTRING;
|
typedef struct asn1_string_st ASN1_STRING;
|
typedef struct asn1_string_st ASN1_T61STRING;
|
typedef struct asn1_string_st ASN1_TIME;
|
typedef struct asn1_string_st ASN1_UNIVERSALSTRING;
|
typedef struct asn1_string_st ASN1_UTCTIME;
|
typedef struct asn1_string_st ASN1_UTF8STRING;
|
typedef struct asn1_string_st ASN1_VISIBLESTRING;
|
typedef struct asn1_type_st ASN1_TYPE;
|
typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID;
|
typedef struct BASIC_CONSTRAINTS_st BASIC_CONSTRAINTS;
|
typedef struct DIST_POINT_st DIST_POINT;
|
typedef struct DSA_SIG_st DSA_SIG;
|
typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT;
|
typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS;
|
typedef struct Netscape_spkac_st NETSCAPE_SPKAC;
|
typedef struct Netscape_spki_st NETSCAPE_SPKI;
|
typedef struct RIPEMD160state_st RIPEMD160_CTX;
|
typedef struct X509_POLICY_CACHE_st X509_POLICY_CACHE;
|
typedef struct X509_POLICY_LEVEL_st X509_POLICY_LEVEL;
|
typedef struct X509_POLICY_NODE_st X509_POLICY_NODE;
|
typedef struct X509_POLICY_TREE_st X509_POLICY_TREE;
|
typedef struct X509_VERIFY_PARAM_st X509_VERIFY_PARAM;
|
typedef struct X509_algor_st X509_ALGOR;
|
typedef struct X509_crl_info_st X509_CRL_INFO;
|
typedef struct X509_crl_st X509_CRL;
|
typedef struct X509_extension_st X509_EXTENSION;
|
typedef struct X509_info_st X509_INFO;
|
typedef struct X509_name_entry_st X509_NAME_ENTRY;
|
typedef struct X509_name_st X509_NAME;
|
typedef struct X509_pubkey_st X509_PUBKEY;
|
typedef struct X509_req_info_st X509_REQ_INFO;
|
typedef struct X509_req_st X509_REQ;
|
typedef struct X509_sig_st X509_SIG;
|
typedef struct X509_val_st X509_VAL;
|
typedef struct bignum_ctx BN_CTX;
|
typedef struct bignum_st BIGNUM;
|
typedef struct bio_method_st BIO_METHOD;
|
typedef struct bio_st BIO;
|
typedef struct bn_gencb_st BN_GENCB;
|
typedef struct bn_mont_ctx_st BN_MONT_CTX;
|
typedef struct buf_mem_st BUF_MEM;
|
typedef struct cbb_st CBB;
|
typedef struct cbs_st CBS;
|
typedef struct cmac_ctx_st CMAC_CTX;
|
typedef struct conf_st CONF;
|
typedef struct conf_value_st CONF_VALUE;
|
typedef struct crypto_buffer_pool_st CRYPTO_BUFFER_POOL;
|
typedef struct crypto_buffer_st CRYPTO_BUFFER;
|
typedef struct dh_st DH;
|
typedef struct dsa_st DSA;
|
typedef struct ec_group_st EC_GROUP;
|
typedef struct ec_key_st EC_KEY;
|
typedef struct ec_point_st EC_POINT;
|
typedef struct ecdsa_method_st ECDSA_METHOD;
|
typedef struct ecdsa_sig_st ECDSA_SIG;
|
typedef struct engine_st ENGINE;
|
typedef struct env_md_ctx_st EVP_MD_CTX;
|
typedef struct env_md_st EVP_MD;
|
typedef struct evp_aead_st EVP_AEAD;
|
typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX;
|
typedef struct evp_cipher_st EVP_CIPHER;
|
typedef struct evp_encode_ctx_st EVP_ENCODE_CTX;
|
typedef struct evp_pkey_asn1_method_st EVP_PKEY_ASN1_METHOD;
|
typedef struct evp_pkey_ctx_st EVP_PKEY_CTX;
|
typedef struct evp_pkey_method_st EVP_PKEY_METHOD;
|
typedef struct evp_pkey_st EVP_PKEY;
|
typedef struct hmac_ctx_st HMAC_CTX;
|
typedef struct md4_state_st MD4_CTX;
|
typedef struct md5_state_st MD5_CTX;
|
typedef struct ossl_init_settings_st OPENSSL_INIT_SETTINGS;
|
typedef struct pkcs12_st PKCS12;
|
typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO;
|
typedef struct private_key_st X509_PKEY;
|
typedef struct rand_meth_st RAND_METHOD;
|
typedef struct rc4_key_st RC4_KEY;
|
typedef struct rsa_meth_st RSA_METHOD;
|
typedef struct rsa_st RSA;
|
typedef struct sha256_state_st SHA256_CTX;
|
typedef struct sha512_state_st SHA512_CTX;
|
typedef struct sha_state_st SHA_CTX;
|
typedef struct spake2_ctx_st SPAKE2_CTX;
|
typedef struct srtp_protection_profile_st SRTP_PROTECTION_PROFILE;
|
typedef struct ssl_cipher_st SSL_CIPHER;
|
typedef struct ssl_ctx_st SSL_CTX;
|
typedef struct ssl_method_st SSL_METHOD;
|
typedef struct ssl_private_key_method_st SSL_PRIVATE_KEY_METHOD;
|
typedef struct ssl_session_st SSL_SESSION;
|
typedef struct ssl_st SSL;
|
typedef struct ssl_ticket_aead_method_st SSL_TICKET_AEAD_METHOD;
|
typedef struct st_ERR_FNS ERR_FNS;
|
typedef struct v3_ext_ctx X509V3_CTX;
|
typedef struct x509_attributes_st X509_ATTRIBUTE;
|
typedef struct x509_cert_aux_st X509_CERT_AUX;
|
typedef struct x509_cinf_st X509_CINF;
|
typedef struct x509_crl_method_st X509_CRL_METHOD;
|
typedef struct x509_lookup_st X509_LOOKUP;
|
typedef struct x509_revoked_st X509_REVOKED;
|
typedef struct x509_st X509;
|
typedef struct x509_store_ctx_st X509_STORE_CTX;
|
typedef struct x509_store_st X509_STORE;
|
typedef struct x509_trust_st X509_TRUST;
|
|
typedef void *OPENSSL_BLOCK;
|
|
|
#if defined(__cplusplus)
|
} // extern C
|
#elif !defined(BORINGSSL_NO_CXX)
|
#define BORINGSSL_NO_CXX
|
#endif
|
|
// MSVC doesn't set __cplusplus to 201103 to indicate C++11 support (see
|
// https://connect.microsoft.com/VisualStudio/feedback/details/763051/a-value-of-predefined-macro-cplusplus-is-still-199711l)
|
// so MSVC is just assumed to support C++11.
|
#if !defined(BORINGSSL_NO_CXX) && __cplusplus < 201103L && !defined(_MSC_VER)
|
#define BORINGSSL_NO_CXX
|
#endif
|
|
#if !defined(BORINGSSL_NO_CXX)
|
extern "C++" {
|
|
#include <memory>
|
|
// STLPort, used by some Android consumers, not have std::unique_ptr.
|
#if defined(_STLPORT_VERSION)
|
#define BORINGSSL_NO_CXX
|
#endif
|
|
} // extern C++
|
#endif // !BORINGSSL_NO_CXX
|
|
#if defined(BORINGSSL_NO_CXX)
|
|
#define BORINGSSL_MAKE_DELETER(type, deleter)
|
|
#else
|
|
extern "C++" {
|
|
namespace bssl {
|
|
namespace internal {
|
|
// The Enable parameter is ignored and only exists so specializations can use
|
// SFINAE.
|
template <typename T, typename Enable = void>
|
struct DeleterImpl {};
|
|
template <typename T>
|
struct Deleter {
|
void operator()(T *ptr) {
|
// Rather than specialize Deleter for each type, we specialize
|
// DeleterImpl. This allows bssl::UniquePtr<T> to be used while only
|
// including base.h as long as the destructor is not emitted. This matches
|
// std::unique_ptr's behavior on forward-declared types.
|
//
|
// DeleterImpl itself is specialized in the corresponding module's header
|
// and must be included to release an object. If not included, the compiler
|
// will error that DeleterImpl<T> does not have a method Free.
|
DeleterImpl<T>::Free(ptr);
|
}
|
};
|
|
template <typename T, typename CleanupRet, void (*init)(T *),
|
CleanupRet (*cleanup)(T *)>
|
class StackAllocated {
|
public:
|
StackAllocated() { init(&ctx_); }
|
~StackAllocated() { cleanup(&ctx_); }
|
|
StackAllocated(const StackAllocated<T, CleanupRet, init, cleanup> &) = delete;
|
T& operator=(const StackAllocated<T, CleanupRet, init, cleanup> &) = delete;
|
|
T *get() { return &ctx_; }
|
const T *get() const { return &ctx_; }
|
|
T *operator->() { return &ctx_; }
|
const T *operator->() const { return &ctx_; }
|
|
void Reset() {
|
cleanup(&ctx_);
|
init(&ctx_);
|
}
|
|
private:
|
T ctx_;
|
};
|
|
} // namespace internal
|
|
#define BORINGSSL_MAKE_DELETER(type, deleter) \
|
namespace internal { \
|
template <> \
|
struct DeleterImpl<type> { \
|
static void Free(type *ptr) { deleter(ptr); } \
|
}; \
|
}
|
|
// Holds ownership of heap-allocated BoringSSL structures. Sample usage:
|
// bssl::UniquePtr<RSA> rsa(RSA_new());
|
// bssl::UniquePtr<BIO> bio(BIO_new(BIO_s_mem()));
|
template <typename T>
|
using UniquePtr = std::unique_ptr<T, internal::Deleter<T>>;
|
|
} // namespace bssl
|
|
} // extern C++
|
|
#endif // !BORINGSSL_NO_CXX
|
|
#endif // OPENSSL_HEADER_BASE_H
|
