1 /* ==================================================================== 2 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in 13 * the documentation and/or other materials provided with the 14 * distribution. 15 * 16 * 3. All advertising materials mentioning features or use of this 17 * software must display the following acknowledgment: 18 * "This product includes software developed by the OpenSSL Project 19 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 20 * 21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 22 * endorse or promote products derived from this software without 23 * prior written permission. For written permission, please contact 24 * openssl-core@openssl.org. 25 * 26 * 5. Products derived from this software may not be called "OpenSSL" 27 * nor may "OpenSSL" appear in their names without prior written 28 * permission of the OpenSSL Project. 29 * 30 * 6. Redistributions of any form whatsoever must retain the following 31 * acknowledgment: 32 * "This product includes software developed by the OpenSSL Project 33 * for use in the OpenSSL Toolkit (http://www.openssl.org/)" 34 * 35 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 36 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 41 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 42 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 44 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 45 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 46 * OF THE POSSIBILITY OF SUCH DAMAGE. 47 * ==================================================================== 48 * 49 * This product includes cryptographic software written by Eric Young 50 * (eay@cryptsoft.com). This product includes software written by Tim 51 * Hudson (tjh@cryptsoft.com). */ 52 53 #ifndef OPENSSL_HEADER_BASE_H 54 #define OPENSSL_HEADER_BASE_H 55 56 57 // This file should be the first included by all BoringSSL headers. 58 59 #include <stddef.h> 60 #include <stdint.h> 61 #include <sys/types.h> 62 63 #if defined(__MINGW32__) 64 // stdio.h is needed on MinGW for __MINGW_PRINTF_FORMAT. 65 #include <stdio.h> 66 #endif 67 68 #if defined(__APPLE__) 69 #include <TargetConditionals.h> 70 #endif 71 72 // Include a BoringSSL-only header so consumers including this header without 73 // setting up include paths do not accidentally pick up the system 74 // opensslconf.h. 75 #include <openssl/is_boringssl.h> 76 #include <openssl/opensslconf.h> 77 78 #if defined(BORINGSSL_PREFIX) 79 #include <boringssl_prefix_symbols.h> 80 #endif 81 82 #if defined(__cplusplus) 83 extern "C" { 84 #endif 85 86 87 #if defined(__x86_64) || defined(_M_AMD64) || defined(_M_X64) 88 #define OPENSSL_64_BIT 89 #define OPENSSL_X86_64 90 #elif defined(__x86) || defined(__i386) || defined(__i386__) || defined(_M_IX86) 91 #define OPENSSL_32_BIT 92 #define OPENSSL_X86 93 #elif defined(__AARCH64EL__) || defined(_M_ARM64) 94 #define OPENSSL_64_BIT 95 #define OPENSSL_AARCH64 96 #elif defined(__ARMEL__) || defined(_M_ARM) 97 #define OPENSSL_32_BIT 98 #define OPENSSL_ARM 99 #elif defined(__MIPSEL__) && !defined(__LP64__) 100 #define OPENSSL_32_BIT 101 #define OPENSSL_MIPS 102 #elif defined(__MIPSEL__) && defined(__LP64__) 103 #define OPENSSL_64_BIT 104 #define OPENSSL_MIPS64 105 #elif defined(__riscv) && __SIZEOF_POINTER__ == 8 106 #define OPENSSL_64_BIT 107 #define OPENSSL_RISCV64 108 #elif defined(__riscv) && __SIZEOF_POINTER__ == 4 109 #define OPENSSL_32_BIT 110 #elif defined(__pnacl__) 111 #define OPENSSL_32_BIT 112 #define OPENSSL_PNACL 113 #elif defined(__wasm__) 114 #define OPENSSL_32_BIT 115 #elif defined(__asmjs__) 116 #define OPENSSL_32_BIT 117 #elif defined(__myriad2__) 118 #define OPENSSL_32_BIT 119 #else 120 // Note BoringSSL only supports standard 32-bit and 64-bit two's-complement, 121 // little-endian architectures. Functions will not produce the correct answer 122 // on other systems. Run the crypto_test binary, notably 123 // crypto/compiler_test.cc, before adding a new architecture. 124 #error "Unknown target CPU" 125 #endif 126 127 #if defined(__APPLE__) 128 #define OPENSSL_APPLE 129 // Note |TARGET_OS_MAC| is set for all Apple OS variants. |TARGET_OS_OSX| 130 // targets macOS specifically. 131 #if defined(TARGET_OS_OSX) && TARGET_OS_OSX 132 #define OPENSSL_MACOS 133 #endif 134 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE 135 #define OPENSSL_IOS 136 #endif 137 #endif 138 139 #if defined(_WIN32) 140 #define OPENSSL_WINDOWS 141 #endif 142 143 // Trusty isn't Linux but currently defines __linux__. As a workaround, we 144 // exclude it here. 145 // TODO(b/169780122): Remove this workaround once Trusty no longer defines it. 146 #if defined(__linux__) && !defined(__TRUSTY__) 147 #define OPENSSL_LINUX 148 #endif 149 150 #if defined(__Fuchsia__) 151 #define OPENSSL_FUCHSIA 152 #endif 153 154 #if defined(__TRUSTY__) 155 #define OPENSSL_TRUSTY 156 #define OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED 157 #endif 158 159 #if defined(__ANDROID_API__) 160 #define OPENSSL_ANDROID 161 #endif 162 163 #if defined(__FreeBSD__) 164 #define OPENSSL_FREEBSD 165 #endif 166 167 // BoringSSL requires platform's locking APIs to make internal global state 168 // thread-safe, including the PRNG. On some single-threaded embedded platforms, 169 // locking APIs may not exist, so this dependency may be disabled with the 170 // following build flag. 171 // 172 // IMPORTANT: Doing so means the consumer promises the library will never be 173 // used in any multi-threaded context. It causes BoringSSL to be globally 174 // thread-unsafe. Setting it inappropriately will subtly and unpredictably 175 // corrupt memory and leak secret keys. 176 // 177 // Do not set this flag on any platform where threads are possible. BoringSSL 178 // maintainers will not provide support for any consumers that do so. Changes 179 // which break such unsupported configurations will not be reverted. 180 #if !defined(OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED) 181 #define OPENSSL_THREADS 182 #endif 183 184 #define OPENSSL_IS_BORINGSSL 185 #define OPENSSL_VERSION_NUMBER 0x1010107f 186 #define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER 187 188 // BORINGSSL_API_VERSION is a positive integer that increments as BoringSSL 189 // changes over time. The value itself is not meaningful. It will be incremented 190 // whenever is convenient to coordinate an API change with consumers. This will 191 // not denote any special point in development. 192 // 193 // A consumer may use this symbol in the preprocessor to temporarily build 194 // against multiple revisions of BoringSSL at the same time. It is not 195 // recommended to do so for longer than is necessary. 196 #define BORINGSSL_API_VERSION 19 197 198 #if defined(BORINGSSL_SHARED_LIBRARY) 199 200 #if defined(OPENSSL_WINDOWS) 201 202 #if defined(BORINGSSL_IMPLEMENTATION) 203 #define OPENSSL_EXPORT __declspec(dllexport) 204 #else 205 #define OPENSSL_EXPORT __declspec(dllimport) 206 #endif 207 208 #else // defined(OPENSSL_WINDOWS) 209 210 #if defined(BORINGSSL_IMPLEMENTATION) 211 #define OPENSSL_EXPORT __attribute__((visibility("default"))) 212 #else 213 #define OPENSSL_EXPORT 214 #endif 215 216 #endif // defined(OPENSSL_WINDOWS) 217 218 #else // defined(BORINGSSL_SHARED_LIBRARY) 219 220 #define OPENSSL_EXPORT 221 222 #endif // defined(BORINGSSL_SHARED_LIBRARY) 223 224 #if defined(_MSC_VER) 225 226 // OPENSSL_DEPRECATED is used to mark a function as deprecated. Use 227 // of any functions so marked in caller code will produce a warning. 228 // OPENSSL_BEGIN_ALLOW_DEPRECATED and OPENSSL_END_ALLOW_DEPRECATED 229 // can be used to suppress the warning in regions of caller code. 230 #define OPENSSL_DEPRECATED __declspec(deprecated) 231 #define OPENSSL_BEGIN_ALLOW_DEPRECATED \ 232 __pragma(warning(push)) __pragma(warning(disable : 4996)) 233 #define OPENSSL_END_ALLOW_DEPRECATED __pragma(warning(pop)) 234 235 #elif defined(__GNUC__) || defined(__clang__) 236 237 #define OPENSSL_DEPRECATED __attribute__((__deprecated__)) 238 #define OPENSSL_BEGIN_ALLOW_DEPRECATED \ 239 _Pragma("GCC diagnostic push") \ 240 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") 241 #define OPENSSL_END_ALLOW_DEPRECATED _Pragma("GCC diagnostic pop") 242 243 #else 244 245 #define OPENSSL_DEPRECATED 246 #define OPENSSL_BEGIN_ALLOW_DEPRECATED 247 #define OPENSSL_END_ALLOW_DEPRECATED 248 249 #endif 250 251 252 #if defined(__GNUC__) || defined(__clang__) 253 // MinGW has two different printf implementations. Ensure the format macro 254 // matches the selected implementation. See 255 // https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/. 256 #if defined(__MINGW_PRINTF_FORMAT) 257 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \ 258 __attribute__( \ 259 (__format__(__MINGW_PRINTF_FORMAT, string_index, first_to_check))) 260 #else 261 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \ 262 __attribute__((__format__(__printf__, string_index, first_to_check))) 263 #endif 264 #else 265 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) 266 #endif 267 268 // OPENSSL_MSVC_PRAGMA emits a pragma on MSVC and nothing on other compilers. 269 #if defined(_MSC_VER) 270 #define OPENSSL_MSVC_PRAGMA(arg) __pragma(arg) 271 #else 272 #define OPENSSL_MSVC_PRAGMA(arg) 273 #endif 274 275 #if defined(__GNUC__) || defined(__clang__) 276 #define OPENSSL_UNUSED __attribute__((unused)) 277 #else 278 #define OPENSSL_UNUSED 279 #endif 280 281 // C and C++ handle inline functions differently. In C++, an inline function is 282 // defined in just the header file, potentially emitted in multiple compilation 283 // units (in cases the compiler did not inline), but each copy must be identical 284 // to satsify ODR. In C, a non-static inline must be manually emitted in exactly 285 // one compilation unit with a separate extern inline declaration. 286 // 287 // In both languages, exported inline functions referencing file-local symbols 288 // are problematic. C forbids this altogether (though GCC and Clang seem not to 289 // enforce it). It works in C++, but ODR requires the definitions be identical, 290 // including all names in the definitions resolving to the "same entity". In 291 // practice, this is unlikely to be a problem, but an inline function that 292 // returns a pointer to a file-local symbol 293 // could compile oddly. 294 // 295 // Historically, we used static inline in headers. However, to satisfy ODR, use 296 // plain inline in C++, to allow inline consumer functions to call our header 297 // functions. Plain inline would also work better with C99 inline, but that is 298 // not used much in practice, extern inline is tedious, and there are conflicts 299 // with the old gnu89 model: 300 // https://stackoverflow.com/questions/216510/extern-inline 301 #if defined(__cplusplus) 302 #define OPENSSL_INLINE inline 303 #else 304 // Add OPENSSL_UNUSED so that, should an inline function be emitted via macro 305 // (e.g. a |STACK_OF(T)| implementation) in a source file without tripping 306 // clang's -Wunused-function. 307 #define OPENSSL_INLINE static inline OPENSSL_UNUSED 308 #endif 309 310 #if defined(BORINGSSL_UNSAFE_FUZZER_MODE) && \ 311 !defined(BORINGSSL_UNSAFE_DETERMINISTIC_MODE) 312 #define BORINGSSL_UNSAFE_DETERMINISTIC_MODE 313 #endif 314 315 #if defined(__has_feature) 316 #if __has_feature(address_sanitizer) 317 #define OPENSSL_ASAN 318 #endif 319 #if __has_feature(thread_sanitizer) 320 #define OPENSSL_TSAN 321 #endif 322 #if __has_feature(memory_sanitizer) 323 #define OPENSSL_MSAN 324 #define OPENSSL_ASM_INCOMPATIBLE 325 #endif 326 #endif 327 328 #if defined(OPENSSL_ASM_INCOMPATIBLE) 329 #undef OPENSSL_ASM_INCOMPATIBLE 330 #if !defined(OPENSSL_NO_ASM) 331 #define OPENSSL_NO_ASM 332 #endif 333 #endif // OPENSSL_ASM_INCOMPATIBLE 334 335 #if defined(__cplusplus) 336 // enums can be predeclared, but only in C++ and only if given an explicit type. 337 // C doesn't support setting an explicit type for enums thus a #define is used 338 // to do this only for C++. However, the ABI type between C and C++ need to have 339 // equal sizes, which is confirmed in a unittest. 340 #define BORINGSSL_ENUM_INT : int 341 enum ssl_early_data_reason_t BORINGSSL_ENUM_INT; 342 enum ssl_encryption_level_t BORINGSSL_ENUM_INT; 343 enum ssl_private_key_result_t BORINGSSL_ENUM_INT; 344 enum ssl_renegotiate_mode_t BORINGSSL_ENUM_INT; 345 enum ssl_select_cert_result_t BORINGSSL_ENUM_INT; 346 enum ssl_select_cert_result_t BORINGSSL_ENUM_INT; 347 enum ssl_ticket_aead_result_t BORINGSSL_ENUM_INT; 348 enum ssl_verify_result_t BORINGSSL_ENUM_INT; 349 #else 350 #define BORINGSSL_ENUM_INT 351 #endif 352 353 // ossl_ssize_t is a signed type which is large enough to fit the size of any 354 // valid memory allocation. We prefer using |size_t|, but sometimes we need a 355 // signed type for OpenSSL API compatibility. This type can be used in such 356 // cases to avoid overflow. 357 // 358 // Not all |size_t| values fit in |ossl_ssize_t|, but all |size_t| values that 359 // are sizes of or indices into C objects, can be converted without overflow. 360 typedef ptrdiff_t ossl_ssize_t; 361 362 // CBS_ASN1_TAG is the type used by |CBS| and |CBB| for ASN.1 tags. See that 363 // header for details. This type is defined in base.h as a forward declaration. 364 typedef uint32_t CBS_ASN1_TAG; 365 366 // CRYPTO_THREADID is a dummy value. 367 typedef int CRYPTO_THREADID; 368 369 // An |ASN1_NULL| is an opaque type. asn1.h represents the ASN.1 NULL value as 370 // an opaque, non-NULL |ASN1_NULL*| pointer. 371 typedef struct asn1_null_st ASN1_NULL; 372 373 typedef int ASN1_BOOLEAN; 374 typedef struct ASN1_ITEM_st ASN1_ITEM; 375 typedef struct asn1_object_st ASN1_OBJECT; 376 typedef struct asn1_pctx_st ASN1_PCTX; 377 typedef struct asn1_string_st ASN1_BIT_STRING; 378 typedef struct asn1_string_st ASN1_BMPSTRING; 379 typedef struct asn1_string_st ASN1_ENUMERATED; 380 typedef struct asn1_string_st ASN1_GENERALIZEDTIME; 381 typedef struct asn1_string_st ASN1_GENERALSTRING; 382 typedef struct asn1_string_st ASN1_IA5STRING; 383 typedef struct asn1_string_st ASN1_INTEGER; 384 typedef struct asn1_string_st ASN1_OCTET_STRING; 385 typedef struct asn1_string_st ASN1_PRINTABLESTRING; 386 typedef struct asn1_string_st ASN1_STRING; 387 typedef struct asn1_string_st ASN1_T61STRING; 388 typedef struct asn1_string_st ASN1_TIME; 389 typedef struct asn1_string_st ASN1_UNIVERSALSTRING; 390 typedef struct asn1_string_st ASN1_UTCTIME; 391 typedef struct asn1_string_st ASN1_UTF8STRING; 392 typedef struct asn1_string_st ASN1_VISIBLESTRING; 393 typedef struct asn1_type_st ASN1_TYPE; 394 typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID; 395 typedef struct BASIC_CONSTRAINTS_st BASIC_CONSTRAINTS; 396 typedef struct DIST_POINT_st DIST_POINT; 397 typedef struct DSA_SIG_st DSA_SIG; 398 typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT; 399 typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS; 400 typedef struct Netscape_spkac_st NETSCAPE_SPKAC; 401 typedef struct Netscape_spki_st NETSCAPE_SPKI; 402 typedef struct RIPEMD160state_st RIPEMD160_CTX; 403 typedef struct X509_VERIFY_PARAM_st X509_VERIFY_PARAM; 404 typedef struct X509_algor_st X509_ALGOR; 405 typedef struct X509_crl_st X509_CRL; 406 typedef struct X509_extension_st X509_EXTENSION; 407 typedef struct X509_info_st X509_INFO; 408 typedef struct X509_name_entry_st X509_NAME_ENTRY; 409 typedef struct X509_name_st X509_NAME; 410 typedef struct X509_pubkey_st X509_PUBKEY; 411 typedef struct X509_req_st X509_REQ; 412 typedef struct X509_sig_st X509_SIG; 413 typedef struct bignum_ctx BN_CTX; 414 typedef struct bignum_st BIGNUM; 415 typedef struct bio_method_st BIO_METHOD; 416 typedef struct bio_st BIO; 417 typedef struct blake2b_state_st BLAKE2B_CTX; 418 typedef struct bn_gencb_st BN_GENCB; 419 typedef struct bn_mont_ctx_st BN_MONT_CTX; 420 typedef struct buf_mem_st BUF_MEM; 421 typedef struct cbb_st CBB; 422 typedef struct cbs_st CBS; 423 typedef struct cmac_ctx_st CMAC_CTX; 424 typedef struct conf_st CONF; 425 typedef struct conf_value_st CONF_VALUE; 426 typedef struct crypto_buffer_pool_st CRYPTO_BUFFER_POOL; 427 typedef struct crypto_buffer_st CRYPTO_BUFFER; 428 typedef struct ctr_drbg_state_st CTR_DRBG_STATE; 429 typedef struct dh_st DH; 430 typedef struct dsa_st DSA; 431 typedef struct ec_group_st EC_GROUP; 432 typedef struct ec_key_st EC_KEY; 433 typedef struct ec_point_st EC_POINT; 434 typedef struct ecdsa_method_st ECDSA_METHOD; 435 typedef struct ecdsa_sig_st ECDSA_SIG; 436 typedef struct engine_st ENGINE; 437 typedef struct env_md_ctx_st EVP_MD_CTX; 438 typedef struct env_md_st EVP_MD; 439 typedef struct evp_aead_st EVP_AEAD; 440 typedef struct evp_aead_ctx_st EVP_AEAD_CTX; 441 typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX; 442 typedef struct evp_cipher_st EVP_CIPHER; 443 typedef struct evp_encode_ctx_st EVP_ENCODE_CTX; 444 typedef struct evp_hpke_aead_st EVP_HPKE_AEAD; 445 typedef struct evp_hpke_ctx_st EVP_HPKE_CTX; 446 typedef struct evp_hpke_kdf_st EVP_HPKE_KDF; 447 typedef struct evp_hpke_kem_st EVP_HPKE_KEM; 448 typedef struct evp_hpke_key_st EVP_HPKE_KEY; 449 typedef struct evp_pkey_ctx_st EVP_PKEY_CTX; 450 typedef struct evp_pkey_st EVP_PKEY; 451 typedef struct hmac_ctx_st HMAC_CTX; 452 typedef struct md4_state_st MD4_CTX; 453 typedef struct md5_state_st MD5_CTX; 454 typedef struct ossl_init_settings_st OPENSSL_INIT_SETTINGS; 455 typedef struct pkcs12_st PKCS12; 456 typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO; 457 typedef struct private_key_st X509_PKEY; 458 typedef struct rand_meth_st RAND_METHOD; 459 typedef struct rc4_key_st RC4_KEY; 460 typedef struct rsa_meth_st RSA_METHOD; 461 typedef struct rsa_pss_params_st RSA_PSS_PARAMS; 462 typedef struct rsa_st RSA; 463 typedef struct sha256_state_st SHA256_CTX; 464 typedef struct sha512_state_st SHA512_CTX; 465 typedef struct sha_state_st SHA_CTX; 466 typedef struct spake2_ctx_st SPAKE2_CTX; 467 typedef struct srtp_protection_profile_st SRTP_PROTECTION_PROFILE; 468 typedef struct ssl_cipher_st SSL_CIPHER; 469 typedef struct ssl_ctx_st SSL_CTX; 470 typedef struct ssl_early_callback_ctx SSL_CLIENT_HELLO; 471 typedef struct ssl_ech_keys_st SSL_ECH_KEYS; 472 typedef struct ssl_method_st SSL_METHOD; 473 typedef struct ssl_private_key_method_st SSL_PRIVATE_KEY_METHOD; 474 typedef struct ssl_quic_method_st SSL_QUIC_METHOD; 475 typedef struct ssl_session_st SSL_SESSION; 476 typedef struct ssl_st SSL; 477 typedef struct ssl_ticket_aead_method_st SSL_TICKET_AEAD_METHOD; 478 typedef struct st_ERR_FNS ERR_FNS; 479 typedef struct trust_token_st TRUST_TOKEN; 480 typedef struct trust_token_client_st TRUST_TOKEN_CLIENT; 481 typedef struct trust_token_issuer_st TRUST_TOKEN_ISSUER; 482 typedef struct trust_token_method_st TRUST_TOKEN_METHOD; 483 typedef struct v3_ext_ctx X509V3_CTX; 484 typedef struct x509_attributes_st X509_ATTRIBUTE; 485 typedef struct x509_lookup_st X509_LOOKUP; 486 typedef struct x509_lookup_method_st X509_LOOKUP_METHOD; 487 typedef struct x509_object_st X509_OBJECT; 488 typedef struct x509_revoked_st X509_REVOKED; 489 typedef struct x509_st X509; 490 typedef struct x509_store_ctx_st X509_STORE_CTX; 491 typedef struct x509_store_st X509_STORE; 492 typedef struct x509_trust_st X509_TRUST; 493 494 typedef void *OPENSSL_BLOCK; 495 496 497 #if defined(__cplusplus) 498 } // extern C 499 #elif !defined(BORINGSSL_NO_CXX) 500 #define BORINGSSL_NO_CXX 501 #endif 502 503 #if defined(BORINGSSL_PREFIX) 504 #define BSSL_NAMESPACE_BEGIN \ 505 namespace bssl { \ 506 inline namespace BORINGSSL_PREFIX { 507 #define BSSL_NAMESPACE_END \ 508 } \ 509 } 510 #else 511 #define BSSL_NAMESPACE_BEGIN namespace bssl { 512 #define BSSL_NAMESPACE_END } 513 #endif 514 515 // MSVC doesn't set __cplusplus to 201103 to indicate C++11 support (see 516 // https://connect.microsoft.com/VisualStudio/feedback/details/763051/a-value-of-predefined-macro-cplusplus-is-still-199711l) 517 // so MSVC is just assumed to support C++11. 518 #if !defined(BORINGSSL_NO_CXX) && __cplusplus < 201103L && !defined(_MSC_VER) 519 #define BORINGSSL_NO_CXX 520 #endif 521 522 #if !defined(BORINGSSL_NO_CXX) 523 524 extern "C++" { 525 526 #include <memory> 527 528 // STLPort, used by some Android consumers, not have std::unique_ptr. 529 #if defined(_STLPORT_VERSION) 530 #define BORINGSSL_NO_CXX 531 #endif 532 533 } // extern C++ 534 #endif // !BORINGSSL_NO_CXX 535 536 #if defined(BORINGSSL_NO_CXX) 537 538 #define BORINGSSL_MAKE_DELETER(type, deleter) 539 #define BORINGSSL_MAKE_UP_REF(type, up_ref_func) 540 541 #else 542 543 extern "C++" { 544 545 BSSL_NAMESPACE_BEGIN 546 547 namespace internal { 548 549 // The Enable parameter is ignored and only exists so specializations can use 550 // SFINAE. 551 template <typename T, typename Enable = void> 552 struct DeleterImpl {}; 553 554 struct Deleter { 555 template <typename T> operatorDeleter556 void operator()(T *ptr) { 557 // Rather than specialize Deleter for each type, we specialize 558 // DeleterImpl. This allows bssl::UniquePtr<T> to be used while only 559 // including base.h as long as the destructor is not emitted. This matches 560 // std::unique_ptr's behavior on forward-declared types. 561 // 562 // DeleterImpl itself is specialized in the corresponding module's header 563 // and must be included to release an object. If not included, the compiler 564 // will error that DeleterImpl<T> does not have a method Free. 565 DeleterImpl<T>::Free(ptr); 566 } 567 }; 568 569 template <typename T, typename CleanupRet, void (*init)(T *), 570 CleanupRet (*cleanup)(T *)> 571 class StackAllocated { 572 public: StackAllocated()573 StackAllocated() { init(&ctx_); } ~StackAllocated()574 ~StackAllocated() { cleanup(&ctx_); } 575 576 StackAllocated(const StackAllocated &) = delete; 577 StackAllocated& operator=(const StackAllocated &) = delete; 578 get()579 T *get() { return &ctx_; } get()580 const T *get() const { return &ctx_; } 581 582 T *operator->() { return &ctx_; } 583 const T *operator->() const { return &ctx_; } 584 Reset()585 void Reset() { 586 cleanup(&ctx_); 587 init(&ctx_); 588 } 589 590 private: 591 T ctx_; 592 }; 593 594 template <typename T, typename CleanupRet, void (*init)(T *), 595 CleanupRet (*cleanup)(T *), void (*move)(T *, T *)> 596 class StackAllocatedMovable { 597 public: StackAllocatedMovable()598 StackAllocatedMovable() { init(&ctx_); } ~StackAllocatedMovable()599 ~StackAllocatedMovable() { cleanup(&ctx_); } 600 StackAllocatedMovable(StackAllocatedMovable && other)601 StackAllocatedMovable(StackAllocatedMovable &&other) { 602 init(&ctx_); 603 move(&ctx_, &other.ctx_); 604 } 605 StackAllocatedMovable &operator=(StackAllocatedMovable &&other) { 606 move(&ctx_, &other.ctx_); 607 return *this; 608 } 609 get()610 T *get() { return &ctx_; } get()611 const T *get() const { return &ctx_; } 612 613 T *operator->() { return &ctx_; } 614 const T *operator->() const { return &ctx_; } 615 Reset()616 void Reset() { 617 cleanup(&ctx_); 618 init(&ctx_); 619 } 620 621 private: 622 T ctx_; 623 }; 624 625 } // namespace internal 626 627 #define BORINGSSL_MAKE_DELETER(type, deleter) \ 628 namespace internal { \ 629 template <> \ 630 struct DeleterImpl<type> { \ 631 static void Free(type *ptr) { deleter(ptr); } \ 632 }; \ 633 } 634 635 // Holds ownership of heap-allocated BoringSSL structures. Sample usage: 636 // bssl::UniquePtr<RSA> rsa(RSA_new()); 637 // bssl::UniquePtr<BIO> bio(BIO_new(BIO_s_mem())); 638 template <typename T> 639 using UniquePtr = std::unique_ptr<T, internal::Deleter>; 640 641 #define BORINGSSL_MAKE_UP_REF(type, up_ref_func) \ 642 inline UniquePtr<type> UpRef(type *v) { \ 643 if (v != nullptr) { \ 644 up_ref_func(v); \ 645 } \ 646 return UniquePtr<type>(v); \ 647 } \ 648 \ 649 inline UniquePtr<type> UpRef(const UniquePtr<type> &ptr) { \ 650 return UpRef(ptr.get()); \ 651 } 652 653 BSSL_NAMESPACE_END 654 655 } // extern C++ 656 657 #endif // !BORINGSSL_NO_CXX 658 659 #endif // OPENSSL_HEADER_BASE_H 660