base.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627
  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. #ifndef OPENSSL_HEADER_BASE_H
  53. #define OPENSSL_HEADER_BASE_H
  54. // This file should be the first included by all BoringSSL headers.
  55. #include <stddef.h>
  56. #include <stdint.h>
  57. #include <sys/types.h>
  58. #if defined(__MINGW32__)
  59. // stdio.h is needed on MinGW for __MINGW_PRINTF_FORMAT.
  60. #include <stdio.h>
  61. #endif
  62. #if defined(__APPLE__)
  63. #include <TargetConditionals.h>
  64. #endif
  65. // Include a BoringSSL-only header so consumers including this header without
  66. // setting up include paths do not accidentally pick up the system
  67. // opensslconf.h.
  68. #include <openssl/is_boringssl.h>
  69. #include <openssl/opensslconf.h>
  70. #if defined(BORINGSSL_PREFIX)
  71. #include <boringssl_prefix_symbols.h>
  72. #endif
  73. #if defined(__cplusplus)
  74. extern "C" {
  75. #endif
  76. #if defined(__x86_64) || defined(_M_AMD64) || defined(_M_X64)
  77. #define OPENSSL_64_BIT
  78. #define OPENSSL_X86_64
  79. #elif defined(__x86) || defined(__i386) || defined(__i386__) || defined(_M_IX86)
  80. #define OPENSSL_32_BIT
  81. #define OPENSSL_X86
  82. #elif defined(__AARCH64EL__) || defined(_M_ARM64)
  83. #define OPENSSL_64_BIT
  84. #define OPENSSL_AARCH64
  85. #elif defined(__ARMEL__) || defined(_M_ARM)
  86. #define OPENSSL_32_BIT
  87. #define OPENSSL_ARM
  88. #elif (defined(__PPC64__) || defined(__powerpc64__)) && defined(_LITTLE_ENDIAN)
  89. #define OPENSSL_64_BIT
  90. #define OPENSSL_PPC64LE
  91. #elif defined(__MIPSEL__) && !defined(__LP64__)
  92. #define OPENSSL_32_BIT
  93. #define OPENSSL_MIPS
  94. #elif defined(__MIPSEL__) && defined(__LP64__)
  95. #define OPENSSL_64_BIT
  96. #define OPENSSL_MIPS64
  97. #elif defined(__riscv) && __SIZEOF_POINTER__ == 8
  98. #define OPENSSL_64_BIT
  99. #elif defined(__riscv) && __SIZEOF_POINTER__ == 4
  100. #define OPENSSL_32_BIT
  101. #elif defined(__pnacl__)
  102. #define OPENSSL_32_BIT
  103. #define OPENSSL_PNACL
  104. #elif defined(__wasm__)
  105. #define OPENSSL_32_BIT
  106. #elif defined(__asmjs__)
  107. #define OPENSSL_32_BIT
  108. #elif defined(__myriad2__)
  109. #define OPENSSL_32_BIT
  110. #else
  111. // Note BoringSSL only supports standard 32-bit and 64-bit two's-complement,
  112. // little-endian architectures. Functions will not produce the correct answer
  113. // on other systems. Run the crypto_test binary, notably
  114. // crypto/compiler_test.cc, before adding a new architecture.
  115. #error "Unknown target CPU"
  116. #endif
  117. #if defined(__APPLE__)
  118. #define OPENSSL_APPLE
  119. // Note |TARGET_OS_MAC| is set for all Apple OS variants. |TARGET_OS_OSX|
  120. // targets macOS specifically.
  121. #if defined(TARGET_OS_OSX) && TARGET_OS_OSX
  122. #define OPENSSL_MACOS
  123. #endif
  124. #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
  125. #define OPENSSL_IOS
  126. #endif
  127. #endif
  128. #if defined(_WIN32)
  129. #define OPENSSL_WINDOWS
  130. #endif
  131. // Trusty isn't Linux but currently defines __linux__. As a workaround, we
  132. // exclude it here.
  133. // TODO(b/169780122): Remove this workaround once Trusty no longer defines it.
  134. #if defined(__linux__) && !defined(__TRUSTY__)
  135. #define OPENSSL_LINUX
  136. #endif
  137. #if defined(__Fuchsia__)
  138. #define OPENSSL_FUCHSIA
  139. #endif
  140. #if defined(__TRUSTY__)
  141. #define OPENSSL_TRUSTY
  142. #define OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED
  143. #endif
  144. #if defined(__ANDROID_API__)
  145. #define OPENSSL_ANDROID
  146. #endif
  147. #if defined(__FreeBSD__)
  148. #define OPENSSL_FREEBSD
  149. #endif
  150. // BoringSSL requires platform's locking APIs to make internal global state
  151. // thread-safe, including the PRNG. On some single-threaded embedded platforms,
  152. // locking APIs may not exist, so this dependency may be disabled with the
  153. // following build flag.
  154. //
  155. // IMPORTANT: Doing so means the consumer promises the library will never be
  156. // used in any multi-threaded context. It causes BoringSSL to be globally
  157. // thread-unsafe. Setting it inappropriately will subtly and unpredictably
  158. // corrupt memory and leak secret keys.
  159. //
  160. // Do not set this flag on any platform where threads are possible. BoringSSL
  161. // maintainers will not provide support for any consumers that do so. Changes
  162. // which break such unsupported configurations will not be reverted.
  163. //#if !defined(OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED)
  164. //#define OPENSSL_THREADS
  165. //#endif
  166. #define OPENSSL_IS_BORINGSSL
  167. #define OPENSSL_VERSION_NUMBER 0x1010107f
  168. #define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
  169. // BORINGSSL_API_VERSION is a positive integer that increments as BoringSSL
  170. // changes over time. The value itself is not meaningful. It will be incremented
  171. // whenever is convenient to coordinate an API change with consumers. This will
  172. // not denote any special point in development.
  173. //
  174. // A consumer may use this symbol in the preprocessor to temporarily build
  175. // against multiple revisions of BoringSSL at the same time. It is not
  176. // recommended to do so for longer than is necessary.
  177. #define BORINGSSL_API_VERSION 17
  178. #if defined(BORINGSSL_SHARED_LIBRARY)
  179. #if defined(OPENSSL_WINDOWS)
  180. #if defined(BORINGSSL_IMPLEMENTATION)
  181. #define OPENSSL_EXPORT __declspec(dllexport)
  182. #else
  183. #define OPENSSL_EXPORT __declspec(dllimport)
  184. #endif
  185. #else // defined(OPENSSL_WINDOWS)
  186. #if defined(BORINGSSL_IMPLEMENTATION)
  187. #define OPENSSL_EXPORT __attribute__((visibility("default")))
  188. #else
  189. #define OPENSSL_EXPORT
  190. #endif
  191. #endif // defined(OPENSSL_WINDOWS)
  192. #else // defined(BORINGSSL_SHARED_LIBRARY)
  193. #define OPENSSL_EXPORT
  194. #endif // defined(BORINGSSL_SHARED_LIBRARY)
  195. #if defined(__GNUC__) || defined(__clang__)
  196. // MinGW has two different printf implementations. Ensure the format macro
  197. // matches the selected implementation. See
  198. // https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/.
  199. #if defined(__MINGW_PRINTF_FORMAT)
  200. #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
  201. __attribute__( \
  202. (__format__(__MINGW_PRINTF_FORMAT, string_index, first_to_check)))
  203. #else
  204. #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
  205. __attribute__((__format__(__printf__, string_index, first_to_check)))
  206. #endif
  207. #else
  208. #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check)
  209. #endif
  210. // OPENSSL_MSVC_PRAGMA emits a pragma on MSVC and nothing on other compilers.
  211. #if defined(_MSC_VER)
  212. #define OPENSSL_MSVC_PRAGMA(arg) __pragma(arg)
  213. #else
  214. #define OPENSSL_MSVC_PRAGMA(arg)
  215. #endif
  216. #if defined(__GNUC__) || defined(__clang__)
  217. #define OPENSSL_UNUSED __attribute__((unused))
  218. #else
  219. #define OPENSSL_UNUSED
  220. #endif
  221. // C and C++ handle inline functions differently. In C++, an inline function is
  222. // defined in just the header file, potentially emitted in multiple compilation
  223. // units (in cases the compiler did not inline), but each copy must be identical
  224. // to satsify ODR. In C, a non-static inline must be manually emitted in exactly
  225. // one compilation unit with a separate extern inline declaration.
  226. //
  227. // In both languages, exported inline functions referencing file-local symbols
  228. // are problematic. C forbids this altogether (though GCC and Clang seem not to
  229. // enforce it). It works in C++, but ODR requires the definitions be identical,
  230. // including all names in the definitions resolving to the "same entity". In
  231. // practice, this is unlikely to be a problem, but an inline function that
  232. // returns a pointer to a file-local symbol
  233. // could compile oddly.
  234. //
  235. // Historically, we used static inline in headers. However, to satisfy ODR, use
  236. // plain inline in C++, to allow inline consumer functions to call our header
  237. // functions. Plain inline would also work better with C99 inline, but that is
  238. // not used much in practice, extern inline is tedious, and there are conflicts
  239. // with the old gnu89 model:
  240. // https://stackoverflow.com/questions/216510/extern-inline
  241. #if defined(__cplusplus)
  242. #define OPENSSL_INLINE inline
  243. #else
  244. // Add OPENSSL_UNUSED so that, should an inline function be emitted via macro
  245. // (e.g. a |STACK_OF(T)| implementation) in a source file without tripping
  246. // clang's -Wunused-function.
  247. #define OPENSSL_INLINE static inline OPENSSL_UNUSED
  248. #endif
  249. #if defined(BORINGSSL_UNSAFE_FUZZER_MODE) && \
  250. !defined(BORINGSSL_UNSAFE_DETERMINISTIC_MODE)
  251. #define BORINGSSL_UNSAFE_DETERMINISTIC_MODE
  252. #endif
  253. #if defined(__has_feature)
  254. #if __has_feature(address_sanitizer)
  255. #define OPENSSL_ASAN
  256. #endif
  257. #if __has_feature(thread_sanitizer)
  258. #define OPENSSL_TSAN
  259. #endif
  260. #if __has_feature(memory_sanitizer)
  261. #define OPENSSL_MSAN
  262. #define OPENSSL_ASM_INCOMPATIBLE
  263. #endif
  264. #endif
  265. #if defined(OPENSSL_ASM_INCOMPATIBLE)
  266. #undef OPENSSL_ASM_INCOMPATIBLE
  267. #if !defined(OPENSSL_NO_ASM)
  268. #define OPENSSL_NO_ASM
  269. #endif
  270. #endif // OPENSSL_ASM_INCOMPATIBLE
  271. #if defined(__cplusplus)
  272. // enums can be predeclared, but only in C++ and only if given an explicit type.
  273. // C doesn't support setting an explicit type for enums thus a #define is used
  274. // to do this only for C++. However, the ABI type between C and C++ need to have
  275. // equal sizes, which is confirmed in a unittest.
  276. #define BORINGSSL_ENUM_INT : int
  277. enum ssl_early_data_reason_t BORINGSSL_ENUM_INT;
  278. enum ssl_encryption_level_t BORINGSSL_ENUM_INT;
  279. enum ssl_private_key_result_t BORINGSSL_ENUM_INT;
  280. enum ssl_renegotiate_mode_t BORINGSSL_ENUM_INT;
  281. enum ssl_select_cert_result_t BORINGSSL_ENUM_INT;
  282. enum ssl_select_cert_result_t BORINGSSL_ENUM_INT;
  283. enum ssl_ticket_aead_result_t BORINGSSL_ENUM_INT;
  284. enum ssl_verify_result_t BORINGSSL_ENUM_INT;
  285. #else
  286. #define BORINGSSL_ENUM_INT
  287. #endif
  288. // CRYPTO_THREADID is a dummy value.
  289. typedef int CRYPTO_THREADID;
  290. // An |ASN1_NULL| is an opaque type. asn1.h represents the ASN.1 NULL value as
  291. // an opaque, non-NULL |ASN1_NULL*| pointer.
  292. typedef struct asn1_null_st ASN1_NULL;
  293. typedef int ASN1_BOOLEAN;
  294. typedef struct ASN1_ITEM_st ASN1_ITEM;
  295. typedef struct asn1_object_st ASN1_OBJECT;
  296. typedef struct asn1_pctx_st ASN1_PCTX;
  297. typedef struct asn1_string_st ASN1_BIT_STRING;
  298. typedef struct asn1_string_st ASN1_BMPSTRING;
  299. typedef struct asn1_string_st ASN1_ENUMERATED;
  300. typedef struct asn1_string_st ASN1_GENERALIZEDTIME;
  301. typedef struct asn1_string_st ASN1_GENERALSTRING;
  302. typedef struct asn1_string_st ASN1_IA5STRING;
  303. typedef struct asn1_string_st ASN1_INTEGER;
  304. typedef struct asn1_string_st ASN1_OCTET_STRING;
  305. typedef struct asn1_string_st ASN1_PRINTABLESTRING;
  306. typedef struct asn1_string_st ASN1_STRING;
  307. typedef struct asn1_string_st ASN1_T61STRING;
  308. typedef struct asn1_string_st ASN1_TIME;
  309. typedef struct asn1_string_st ASN1_UNIVERSALSTRING;
  310. typedef struct asn1_string_st ASN1_UTCTIME;
  311. typedef struct asn1_string_st ASN1_UTF8STRING;
  312. typedef struct asn1_string_st ASN1_VISIBLESTRING;
  313. typedef struct asn1_type_st ASN1_TYPE;
  314. typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID;
  315. typedef struct BASIC_CONSTRAINTS_st BASIC_CONSTRAINTS;
  316. typedef struct DIST_POINT_st DIST_POINT;
  317. typedef struct DSA_SIG_st DSA_SIG;
  318. typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT;
  319. typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS;
  320. typedef struct Netscape_spkac_st NETSCAPE_SPKAC;
  321. typedef struct Netscape_spki_st NETSCAPE_SPKI;
  322. typedef struct RIPEMD160state_st RIPEMD160_CTX;
  323. typedef struct X509_POLICY_CACHE_st X509_POLICY_CACHE;
  324. typedef struct X509_POLICY_LEVEL_st X509_POLICY_LEVEL;
  325. typedef struct X509_POLICY_NODE_st X509_POLICY_NODE;
  326. typedef struct X509_POLICY_TREE_st X509_POLICY_TREE;
  327. typedef struct X509_VERIFY_PARAM_st X509_VERIFY_PARAM;
  328. typedef struct X509_algor_st X509_ALGOR;
  329. typedef struct X509_crl_st X509_CRL;
  330. typedef struct X509_extension_st X509_EXTENSION;
  331. typedef struct X509_info_st X509_INFO;
  332. typedef struct X509_name_entry_st X509_NAME_ENTRY;
  333. typedef struct X509_name_st X509_NAME;
  334. typedef struct X509_pubkey_st X509_PUBKEY;
  335. typedef struct X509_req_st X509_REQ;
  336. typedef struct X509_sig_st X509_SIG;
  337. typedef struct bignum_ctx BN_CTX;
  338. typedef struct bignum_st BIGNUM;
  339. typedef struct bio_method_st BIO_METHOD;
  340. typedef struct bio_st BIO;
  341. typedef struct blake2b_state_st BLAKE2B_CTX;
  342. typedef struct bn_gencb_st BN_GENCB;
  343. typedef struct bn_mont_ctx_st BN_MONT_CTX;
  344. typedef struct buf_mem_st BUF_MEM;
  345. typedef struct cbb_st CBB;
  346. typedef struct cbs_st CBS;
  347. typedef struct cmac_ctx_st CMAC_CTX;
  348. typedef struct conf_st CONF;
  349. typedef struct conf_value_st CONF_VALUE;
  350. typedef struct crypto_buffer_pool_st CRYPTO_BUFFER_POOL;
  351. typedef struct crypto_buffer_st CRYPTO_BUFFER;
  352. typedef struct ctr_drbg_state_st CTR_DRBG_STATE;
  353. typedef struct dh_st DH;
  354. typedef struct dsa_st DSA;
  355. typedef struct ec_group_st EC_GROUP;
  356. typedef struct ec_key_st EC_KEY;
  357. typedef struct ec_point_st EC_POINT;
  358. typedef struct ecdsa_method_st ECDSA_METHOD;
  359. typedef struct ecdsa_sig_st ECDSA_SIG;
  360. typedef struct engine_st ENGINE;
  361. typedef struct env_md_ctx_st EVP_MD_CTX;
  362. typedef struct env_md_st EVP_MD;
  363. typedef struct evp_aead_st EVP_AEAD;
  364. typedef struct evp_aead_ctx_st EVP_AEAD_CTX;
  365. typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX;
  366. typedef struct evp_cipher_st EVP_CIPHER;
  367. typedef struct evp_encode_ctx_st EVP_ENCODE_CTX;
  368. typedef struct evp_hpke_aead_st EVP_HPKE_AEAD;
  369. typedef struct evp_hpke_ctx_st EVP_HPKE_CTX;
  370. typedef struct evp_hpke_kdf_st EVP_HPKE_KDF;
  371. typedef struct evp_hpke_kem_st EVP_HPKE_KEM;
  372. typedef struct evp_hpke_key_st EVP_HPKE_KEY;
  373. typedef struct evp_pkey_asn1_method_st EVP_PKEY_ASN1_METHOD;
  374. typedef struct evp_pkey_ctx_st EVP_PKEY_CTX;
  375. typedef struct evp_pkey_method_st EVP_PKEY_METHOD;
  376. typedef struct evp_pkey_st EVP_PKEY;
  377. typedef struct hmac_ctx_st HMAC_CTX;
  378. typedef struct md4_state_st MD4_CTX;
  379. typedef struct md5_state_st MD5_CTX;
  380. typedef struct ossl_init_settings_st OPENSSL_INIT_SETTINGS;
  381. typedef struct pkcs12_st PKCS12;
  382. typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO;
  383. typedef struct private_key_st X509_PKEY;
  384. typedef struct rand_meth_st RAND_METHOD;
  385. typedef struct rc4_key_st RC4_KEY;
  386. typedef struct rsa_meth_st RSA_METHOD;
  387. typedef struct rsa_pss_params_st RSA_PSS_PARAMS;
  388. typedef struct rsa_st RSA;
  389. typedef struct sha256_state_st SHA256_CTX;
  390. typedef struct sha512_state_st SHA512_CTX;
  391. typedef struct sha_state_st SHA_CTX;
  392. typedef struct spake2_ctx_st SPAKE2_CTX;
  393. typedef struct srtp_protection_profile_st SRTP_PROTECTION_PROFILE;
  394. typedef struct ssl_cipher_st SSL_CIPHER;
  395. typedef struct ssl_ctx_st SSL_CTX;
  396. typedef struct ssl_early_callback_ctx SSL_CLIENT_HELLO;
  397. typedef struct ssl_ech_keys_st SSL_ECH_KEYS;
  398. typedef struct ssl_method_st SSL_METHOD;
  399. typedef struct ssl_private_key_method_st SSL_PRIVATE_KEY_METHOD;
  400. typedef struct ssl_quic_method_st SSL_QUIC_METHOD;
  401. typedef struct ssl_session_st SSL_SESSION;
  402. typedef struct ssl_st SSL;
  403. typedef struct ssl_ticket_aead_method_st SSL_TICKET_AEAD_METHOD;
  404. typedef struct st_ERR_FNS ERR_FNS;
  405. typedef struct trust_token_st TRUST_TOKEN;
  406. typedef struct trust_token_client_st TRUST_TOKEN_CLIENT;
  407. typedef struct trust_token_issuer_st TRUST_TOKEN_ISSUER;
  408. typedef struct trust_token_method_st TRUST_TOKEN_METHOD;
  409. typedef struct v3_ext_ctx X509V3_CTX;
  410. typedef struct x509_attributes_st X509_ATTRIBUTE;
  411. typedef struct x509_lookup_st X509_LOOKUP;
  412. typedef struct x509_lookup_method_st X509_LOOKUP_METHOD;
  413. typedef struct x509_object_st X509_OBJECT;
  414. typedef struct x509_revoked_st X509_REVOKED;
  415. typedef struct x509_st X509;
  416. typedef struct x509_store_ctx_st X509_STORE_CTX;
  417. typedef struct x509_store_st X509_STORE;
  418. typedef struct x509_trust_st X509_TRUST;
  419. typedef void *OPENSSL_BLOCK;
  420. #if defined(__cplusplus)
  421. } // extern C
  422. #elif !defined(BORINGSSL_NO_CXX)
  423. #define BORINGSSL_NO_CXX
  424. #endif
  425. #if defined(BORINGSSL_PREFIX)
  426. #define BSSL_NAMESPACE_BEGIN \
  427. namespace bssl { \
  428. inline namespace BORINGSSL_PREFIX {
  429. #define BSSL_NAMESPACE_END \
  430. } \
  431. }
  432. #else
  433. #define BSSL_NAMESPACE_BEGIN namespace bssl {
  434. #define BSSL_NAMESPACE_END }
  435. #endif
  436. // MSVC doesn't set __cplusplus to 201103 to indicate C++11 support (see
  437. // https://connect.microsoft.com/VisualStudio/feedback/details/763051/a-value-of-predefined-macro-cplusplus-is-still-199711l)
  438. // so MSVC is just assumed to support C++11.
  439. #if !defined(BORINGSSL_NO_CXX) && __cplusplus < 201103L && !defined(_MSC_VER)
  440. #define BORINGSSL_NO_CXX
  441. #endif
  442. #if !defined(BORINGSSL_NO_CXX)
  443. extern "C++" {
  444. #include <memory>
  445. // STLPort, used by some Android consumers, not have std::unique_ptr.
  446. #if defined(_STLPORT_VERSION)
  447. #define BORINGSSL_NO_CXX
  448. #endif
  449. } // extern C++
  450. #endif // !BORINGSSL_NO_CXX
  451. #if defined(BORINGSSL_NO_CXX)
  452. #define BORINGSSL_MAKE_DELETER(type, deleter)
  453. #define BORINGSSL_MAKE_UP_REF(type, up_ref_func)
  454. #else
  455. extern "C++" {
  456. BSSL_NAMESPACE_BEGIN
  457. namespace internal {
  458. // The Enable parameter is ignored and only exists so specializations can use
  459. // SFINAE.
  460. template <typename T, typename Enable = void>
  461. struct DeleterImpl {};
  462. template <typename T>
  463. struct Deleter {
  464. void operator()(T *ptr) {
  465. // Rather than specialize Deleter for each type, we specialize
  466. // DeleterImpl. This allows bssl::UniquePtr<T> to be used while only
  467. // including base.h as long as the destructor is not emitted. This matches
  468. // std::unique_ptr's behavior on forward-declared types.
  469. //
  470. // DeleterImpl itself is specialized in the corresponding module's header
  471. // and must be included to release an object. If not included, the compiler
  472. // will error that DeleterImpl<T> does not have a method Free.
  473. DeleterImpl<T>::Free(ptr);
  474. }
  475. };
  476. template <typename T, typename CleanupRet, void (*init)(T *),
  477. CleanupRet (*cleanup)(T *)>
  478. class StackAllocated {
  479. public:
  480. StackAllocated() { init(&ctx_); }
  481. ~StackAllocated() { cleanup(&ctx_); }
  482. StackAllocated(const StackAllocated &) = delete;
  483. StackAllocated& operator=(const StackAllocated &) = delete;
  484. T *get() { return &ctx_; }
  485. const T *get() const { return &ctx_; }
  486. T *operator->() { return &ctx_; }
  487. const T *operator->() const { return &ctx_; }
  488. void Reset() {
  489. cleanup(&ctx_);
  490. init(&ctx_);
  491. }
  492. private:
  493. T ctx_;
  494. };
  495. template <typename T, typename CleanupRet, void (*init)(T *),
  496. CleanupRet (*cleanup)(T *), void (*move)(T *, T *)>
  497. class StackAllocatedMovable {
  498. public:
  499. StackAllocatedMovable() { init(&ctx_); }
  500. ~StackAllocatedMovable() { cleanup(&ctx_); }
  501. StackAllocatedMovable(StackAllocatedMovable &&other) {
  502. init(&ctx_);
  503. move(&ctx_, &other.ctx_);
  504. }
  505. StackAllocatedMovable &operator=(StackAllocatedMovable &&other) {
  506. move(&ctx_, &other.ctx_);
  507. return *this;
  508. }
  509. T *get() { return &ctx_; }
  510. const T *get() const { return &ctx_; }
  511. T *operator->() { return &ctx_; }
  512. const T *operator->() const { return &ctx_; }
  513. void Reset() {
  514. cleanup(&ctx_);
  515. init(&ctx_);
  516. }
  517. private:
  518. T ctx_;
  519. };
  520. } // namespace internal
  521. #define BORINGSSL_MAKE_DELETER(type, deleter) \
  522. namespace internal { \
  523. template <> \
  524. struct DeleterImpl<type> { \
  525. static void Free(type *ptr) { deleter(ptr); } \
  526. }; \
  527. }
  528. // Holds ownership of heap-allocated BoringSSL structures. Sample usage:
  529. // bssl::UniquePtr<RSA> rsa(RSA_new());
  530. // bssl::UniquePtr<BIO> bio(BIO_new(BIO_s_mem()));
  531. template <typename T>
  532. using UniquePtr = std::unique_ptr<T, internal::Deleter<T>>;
  533. #define BORINGSSL_MAKE_UP_REF(type, up_ref_func) \
  534. inline UniquePtr<type> UpRef(type *v) { \
  535. if (v != nullptr) { \
  536. up_ref_func(v); \
  537. } \
  538. return UniquePtr<type>(v); \
  539. } \
  540. \
  541. inline UniquePtr<type> UpRef(const UniquePtr<type> &ptr) { \
  542. return UpRef(ptr.get()); \
  543. }
  544. BSSL_NAMESPACE_END
  545. } // extern C++
  546. #endif // !BORINGSSL_NO_CXX
  547. #endif // OPENSSL_HEADER_BASE_H