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