legacy-libs/grpc-cloned/deps/grpc/third_party/boringssl/include/openssl/base.h

   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 // Include a BoringSSL-only header so consumers including this header without
  69 // setting up include paths do not accidentally pick up the system
  70 // opensslconf.h.
  71 #include <openssl/is_boringssl.h>
  72 #include <openssl/opensslconf.h>
  73
  74 #if defined(BORINGSSL_PREFIX)
  75 #include <boringssl_prefix_symbols.h>
  76 #endif
  77
  78 #if defined(__cplusplus)
  79 extern "C" {
  80 #endif
  81
  82
  83 #if defined(__x86_64) || defined(_M_AMD64) || defined(_M_X64)
  84 #define OPENSSL_64_BIT
  85 #define OPENSSL_X86_64
  86 #elif defined(__x86) || defined(__i386) || defined(__i386__) || defined(_M_IX86)
  87 #define OPENSSL_32_BIT
  88 #define OPENSSL_X86
  89 #elif defined(__aarch64__)
  90 #define OPENSSL_64_BIT
  91 #define OPENSSL_AARCH64
  92 #elif defined(__arm) || defined(__arm__) || defined(_M_ARM)
  93 #define OPENSSL_32_BIT
  94 #define OPENSSL_ARM
  95 #elif (defined(__PPC64__) || defined(__powerpc64__)) && defined(_LITTLE_ENDIAN)
  96 #define OPENSSL_64_BIT
  97 #define OPENSSL_PPC64LE
  98 #elif defined(__mips__) && !defined(__LP64__)
  99 #define OPENSSL_32_BIT
 100 #define OPENSSL_MIPS
 101 #elif defined(__mips__) && defined(__LP64__)
 102 #define OPENSSL_64_BIT
 103 #define OPENSSL_MIPS64
 104 #elif defined(__pnacl__)
 105 #define OPENSSL_32_BIT
 106 #define OPENSSL_PNACL
 107 #elif defined(__wasm__)
 108 #define OPENSSL_32_BIT
 109 #elif defined(__asmjs__)
 110 #define OPENSSL_32_BIT
 111 #elif defined(__myriad2__)
 112 #define OPENSSL_32_BIT
 113 #else
 114 // Note BoringSSL only supports standard 32-bit and 64-bit two's-complement,
 115 // little-endian architectures. Functions will not produce the correct answer
 116 // on other systems. Run the crypto_test binary, notably
 117 // crypto/compiler_test.cc, before adding a new architecture.
 118 #error "Unknown target CPU"
 119 #endif
 120
 121 #if defined(__APPLE__)
 122 #define OPENSSL_APPLE
 123 #endif
 124
 125 #if defined(_WIN32)
 126 #define OPENSSL_WINDOWS
 127 #endif
 128
 129 #if defined(__linux__)
 130 #define OPENSSL_LINUX
 131 #endif
 132
 133 #if defined(__Fuchsia__)
 134 #define OPENSSL_FUCHSIA
 135 #endif
 136
 137 #if defined(TRUSTY)
 138 #define OPENSSL_TRUSTY
 139 #define OPENSSL_NO_THREADS
 140 #endif
 141
 142 #if !defined(OPENSSL_NO_THREADS)
 143 #define OPENSSL_THREADS
 144 #endif
 145
 146 #define OPENSSL_IS_BORINGSSL
 147 #define OPENSSL_VERSION_NUMBER 0x1010007f
 148 #define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
 149
 150 // BORINGSSL_API_VERSION is a positive integer that increments as BoringSSL
 151 // changes over time. The value itself is not meaningful. It will be incremented
 152 // whenever is convenient to coordinate an API change with consumers. This will
 153 // not denote any special point in development.
 154 //
 155 // A consumer may use this symbol in the preprocessor to temporarily build
 156 // against multiple revisions of BoringSSL at the same time. It is not
 157 // recommended to do so for longer than is necessary.
 158 #define BORINGSSL_API_VERSION 7
 159
 160 #if defined(BORINGSSL_SHARED_LIBRARY)
 161
 162 #if defined(OPENSSL_WINDOWS)
 163
 164 #if defined(BORINGSSL_IMPLEMENTATION)
 165 #define OPENSSL_EXPORT __declspec(dllexport)
 166 #else
 167 #define OPENSSL_EXPORT __declspec(dllimport)
 168 #endif
 169
 170 #else  // defined(OPENSSL_WINDOWS)
 171
 172 #if defined(BORINGSSL_IMPLEMENTATION)
 173 #define OPENSSL_EXPORT __attribute__((visibility("default")))
 174 #else
 175 #define OPENSSL_EXPORT
 176 #endif
 177
 178 #endif  // defined(OPENSSL_WINDOWS)
 179
 180 #else  // defined(BORINGSSL_SHARED_LIBRARY)
 181
 182 #define OPENSSL_EXPORT
 183
 184 #endif  // defined(BORINGSSL_SHARED_LIBRARY)
 185
 186
 187 #if defined(__GNUC__) || defined(__clang__)
 188 // MinGW has two different printf implementations. Ensure the format macro
 189 // matches the selected implementation. See
 190 // https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/.
 191 #if defined(__MINGW_PRINTF_FORMAT)
 192 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
 193   __attribute__(                                                 \
 194       (__format__(__MINGW_PRINTF_FORMAT, string_index, first_to_check)))
 195 #else
 196 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
 197   __attribute__((__format__(__printf__, string_index, first_to_check)))
 198 #endif
 199 #else
 200 #define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check)
 201 #endif
 202
 203 // OPENSSL_MSVC_PRAGMA emits a pragma on MSVC and nothing on other compilers.
 204 #if defined(_MSC_VER)
 205 #define OPENSSL_MSVC_PRAGMA(arg) __pragma(arg)
 206 #else
 207 #define OPENSSL_MSVC_PRAGMA(arg)
 208 #endif
 209
 210 #if defined(__GNUC__) || defined(__clang__)
 211 #define OPENSSL_UNUSED __attribute__((unused))
 212 #else
 213 #define OPENSSL_UNUSED
 214 #endif
 215
 216 #if defined(BORINGSSL_UNSAFE_FUZZER_MODE) && \
 217     !defined(BORINGSSL_UNSAFE_DETERMINISTIC_MODE)
 218 #define BORINGSSL_UNSAFE_DETERMINISTIC_MODE
 219 #endif
 220
 221 #if defined(__has_feature)
 222 #if __has_feature(address_sanitizer)
 223 #define OPENSSL_ASAN
 224 #endif
 225 #if __has_feature(memory_sanitizer)
 226 #define OPENSSL_MSAN
 227 #endif
 228 #endif
 229
 230 // CRYPTO_THREADID is a dummy value.
 231 typedef int CRYPTO_THREADID;
 232
 233 typedef int ASN1_BOOLEAN;
 234 typedef int ASN1_NULL;
 235 typedef struct ASN1_ITEM_st ASN1_ITEM;
 236 typedef struct asn1_object_st ASN1_OBJECT;
 237 typedef struct asn1_pctx_st ASN1_PCTX;
 238 typedef struct asn1_string_st ASN1_BIT_STRING;
 239 typedef struct asn1_string_st ASN1_BMPSTRING;
 240 typedef struct asn1_string_st ASN1_ENUMERATED;
 241 typedef struct asn1_string_st ASN1_GENERALIZEDTIME;
 242 typedef struct asn1_string_st ASN1_GENERALSTRING;
 243 typedef struct asn1_string_st ASN1_IA5STRING;
 244 typedef struct asn1_string_st ASN1_INTEGER;
 245 typedef struct asn1_string_st ASN1_OCTET_STRING;
 246 typedef struct asn1_string_st ASN1_PRINTABLESTRING;
 247 typedef struct asn1_string_st ASN1_STRING;
 248 typedef struct asn1_string_st ASN1_T61STRING;
 249 typedef struct asn1_string_st ASN1_TIME;
 250 typedef struct asn1_string_st ASN1_UNIVERSALSTRING;
 251 typedef struct asn1_string_st ASN1_UTCTIME;
 252 typedef struct asn1_string_st ASN1_UTF8STRING;
 253 typedef struct asn1_string_st ASN1_VISIBLESTRING;
 254 typedef struct asn1_type_st ASN1_TYPE;
 255 typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID;
 256 typedef struct BASIC_CONSTRAINTS_st BASIC_CONSTRAINTS;
 257 typedef struct DIST_POINT_st DIST_POINT;
 258 typedef struct DSA_SIG_st DSA_SIG;
 259 typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT;
 260 typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS;
 261 typedef struct Netscape_spkac_st NETSCAPE_SPKAC;
 262 typedef struct Netscape_spki_st NETSCAPE_SPKI;
 263 typedef struct RIPEMD160state_st RIPEMD160_CTX;
 264 typedef struct X509_POLICY_CACHE_st X509_POLICY_CACHE;
 265 typedef struct X509_POLICY_LEVEL_st X509_POLICY_LEVEL;
 266 typedef struct X509_POLICY_NODE_st X509_POLICY_NODE;
 267 typedef struct X509_POLICY_TREE_st X509_POLICY_TREE;
 268 typedef struct X509_VERIFY_PARAM_st X509_VERIFY_PARAM;
 269 typedef struct X509_algor_st X509_ALGOR;
 270 typedef struct X509_crl_info_st X509_CRL_INFO;
 271 typedef struct X509_crl_st X509_CRL;
 272 typedef struct X509_extension_st X509_EXTENSION;
 273 typedef struct X509_info_st X509_INFO;
 274 typedef struct X509_name_entry_st X509_NAME_ENTRY;
 275 typedef struct X509_name_st X509_NAME;
 276 typedef struct X509_pubkey_st X509_PUBKEY;
 277 typedef struct X509_req_info_st X509_REQ_INFO;
 278 typedef struct X509_req_st X509_REQ;
 279 typedef struct X509_sig_st X509_SIG;
 280 typedef struct X509_val_st X509_VAL;
 281 typedef struct bignum_ctx BN_CTX;
 282 typedef struct bignum_st BIGNUM;
 283 typedef struct bio_method_st BIO_METHOD;
 284 typedef struct bio_st BIO;
 285 typedef struct bn_gencb_st BN_GENCB;
 286 typedef struct bn_mont_ctx_st BN_MONT_CTX;
 287 typedef struct buf_mem_st BUF_MEM;
 288 typedef struct cbb_st CBB;
 289 typedef struct cbs_st CBS;
 290 typedef struct cmac_ctx_st CMAC_CTX;
 291 typedef struct conf_st CONF;
 292 typedef struct conf_value_st CONF_VALUE;
 293 typedef struct crypto_buffer_pool_st CRYPTO_BUFFER_POOL;
 294 typedef struct crypto_buffer_st CRYPTO_BUFFER;
 295 typedef struct dh_st DH;
 296 typedef struct dsa_st DSA;
 297 typedef struct ec_group_st EC_GROUP;
 298 typedef struct ec_key_st EC_KEY;
 299 typedef struct ec_point_st EC_POINT;
 300 typedef struct ecdsa_method_st ECDSA_METHOD;
 301 typedef struct ecdsa_sig_st ECDSA_SIG;
 302 typedef struct engine_st ENGINE;
 303 typedef struct env_md_ctx_st EVP_MD_CTX;
 304 typedef struct env_md_st EVP_MD;
 305 typedef struct evp_aead_st EVP_AEAD;
 306 typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX;
 307 typedef struct evp_cipher_st EVP_CIPHER;
 308 typedef struct evp_encode_ctx_st EVP_ENCODE_CTX;
 309 typedef struct evp_pkey_asn1_method_st EVP_PKEY_ASN1_METHOD;
 310 typedef struct evp_pkey_ctx_st EVP_PKEY_CTX;
 311 typedef struct evp_pkey_method_st EVP_PKEY_METHOD;
 312 typedef struct evp_pkey_st EVP_PKEY;
 313 typedef struct hmac_ctx_st HMAC_CTX;
 314 typedef struct md4_state_st MD4_CTX;
 315 typedef struct md5_state_st MD5_CTX;
 316 typedef struct ossl_init_settings_st OPENSSL_INIT_SETTINGS;
 317 typedef struct pkcs12_st PKCS12;
 318 typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO;
 319 typedef struct private_key_st X509_PKEY;
 320 typedef struct rand_meth_st RAND_METHOD;
 321 typedef struct rc4_key_st RC4_KEY;
 322 typedef struct rsa_meth_st RSA_METHOD;
 323 typedef struct rsa_st RSA;
 324 typedef struct sha256_state_st SHA256_CTX;
 325 typedef struct sha512_state_st SHA512_CTX;
 326 typedef struct sha_state_st SHA_CTX;
 327 typedef struct spake2_ctx_st SPAKE2_CTX;
 328 typedef struct srtp_protection_profile_st SRTP_PROTECTION_PROFILE;
 329 typedef struct ssl_cipher_st SSL_CIPHER;
 330 typedef struct ssl_ctx_st SSL_CTX;
 331 typedef struct ssl_method_st SSL_METHOD;
 332 typedef struct ssl_private_key_method_st SSL_PRIVATE_KEY_METHOD;
 333 typedef struct ssl_session_st SSL_SESSION;
 334 typedef struct ssl_st SSL;
 335 typedef struct ssl_ticket_aead_method_st SSL_TICKET_AEAD_METHOD;
 336 typedef struct st_ERR_FNS ERR_FNS;
 337 typedef struct v3_ext_ctx X509V3_CTX;
 338 typedef struct x509_attributes_st X509_ATTRIBUTE;
 339 typedef struct x509_cert_aux_st X509_CERT_AUX;
 340 typedef struct x509_cinf_st X509_CINF;
 341 typedef struct x509_crl_method_st X509_CRL_METHOD;
 342 typedef struct x509_lookup_st X509_LOOKUP;
 343 typedef struct x509_revoked_st X509_REVOKED;
 344 typedef struct x509_st X509;
 345 typedef struct x509_store_ctx_st X509_STORE_CTX;
 346 typedef struct x509_store_st X509_STORE;
 347 typedef struct x509_trust_st X509_TRUST;
 348
 349 typedef void *OPENSSL_BLOCK;
 350
 351
 352 #if defined(__cplusplus)
 353 }  // extern C
 354 #elif !defined(BORINGSSL_NO_CXX)
 355 #define BORINGSSL_NO_CXX
 356 #endif
 357
 358 // MSVC doesn't set __cplusplus to 201103 to indicate C++11 support (see
 359 // https://connect.microsoft.com/VisualStudio/feedback/details/763051/a-value-of-predefined-macro-cplusplus-is-still-199711l)
 360 // so MSVC is just assumed to support C++11.
 361 #if !defined(BORINGSSL_NO_CXX) && __cplusplus < 201103L && !defined(_MSC_VER)
 362 #define BORINGSSL_NO_CXX
 363 #endif
 364
 365 #if !defined(BORINGSSL_NO_CXX)
 366 extern "C++" {
 367
 368 #include <memory>
 369
 370 // STLPort, used by some Android consumers, not have std::unique_ptr.
 371 #if defined(_STLPORT_VERSION)
 372 #define BORINGSSL_NO_CXX
 373 #endif
 374
 375 }  // extern C++
 376 #endif  // !BORINGSSL_NO_CXX
 377
 378 #if defined(BORINGSSL_NO_CXX)
 379
 380 #define BORINGSSL_MAKE_DELETER(type, deleter)
 381
 382 #else
 383
 384 extern "C++" {
 385
 386 namespace bssl {
 387
 388 namespace internal {
 389
 390 // The Enable parameter is ignored and only exists so specializations can use
 391 // SFINAE.
 392 template <typename T, typename Enable = void>
 393 struct DeleterImpl {};
 394
 395 template <typename T>
 396 struct Deleter {
 397   void operator()(T *ptr) {
 398     // Rather than specialize Deleter for each type, we specialize
 399     // DeleterImpl. This allows bssl::UniquePtr<T> to be used while only
 400     // including base.h as long as the destructor is not emitted. This matches
 401     // std::unique_ptr's behavior on forward-declared types.
 402     //
 403     // DeleterImpl itself is specialized in the corresponding module's header
 404     // and must be included to release an object. If not included, the compiler
 405     // will error that DeleterImpl<T> does not have a method Free.
 406     DeleterImpl<T>::Free(ptr);
 407   }
 408 };
 409
 410 template <typename T, typename CleanupRet, void (*init)(T *),
 411           CleanupRet (*cleanup)(T *)>
 412 class StackAllocated {
 413  public:
 414   StackAllocated() { init(&ctx_); }
 415   ~StackAllocated() { cleanup(&ctx_); }
 416
 417   StackAllocated(const StackAllocated<T, CleanupRet, init, cleanup> &) = delete;
 418   T& operator=(const StackAllocated<T, CleanupRet, init, cleanup> &) = delete;
 419
 420   T *get() { return &ctx_; }
 421   const T *get() const { return &ctx_; }
 422
 423   T *operator->() { return &ctx_; }
 424   const T *operator->() const { return &ctx_; }
 425
 426   void Reset() {
 427     cleanup(&ctx_);
 428     init(&ctx_);
 429   }
 430
 431  private:
 432   T ctx_;
 433 };
 434
 435 }  // namespace internal
 436
 437 #define BORINGSSL_MAKE_DELETER(type, deleter)     \
 438   namespace internal {                            \
 439   template <>                                     \
 440   struct DeleterImpl<type> {                      \
 441     static void Free(type *ptr) { deleter(ptr); } \
 442   };                                              \
 443   }
 444
 445 // Holds ownership of heap-allocated BoringSSL structures. Sample usage:
 446 //   bssl::UniquePtr<RSA> rsa(RSA_new());
 447 //   bssl::UniquePtr<BIO> bio(BIO_new(BIO_s_mem()));
 448 template <typename T>
 449 using UniquePtr = std::unique_ptr<T, internal::Deleter<T>>;
 450
 451 }  // namespace bssl
 452
 453 }  // extern C++
 454
 455 #endif  // !BORINGSSL_NO_CXX
 456
 457 #endif  // OPENSSL_HEADER_BASE_H