1 /* Copyright (c) 2014, Google Inc. 2 * 3 * Permission to use, copy, modify, and/or distribute this software for any 4 * purpose with or without fee is hereby granted, provided that the above 5 * copyright notice and this permission notice appear in all copies. 6 * 7 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 8 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 9 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 10 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 11 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION 12 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 13 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ 14 15 #ifndef OPENSSL_HEADER_CRYPTO_H 16 #define OPENSSL_HEADER_CRYPTO_H 17 18 #include <openssl/base.h> 19 #include <openssl/sha.h> 20 21 // Upstream OpenSSL defines |OPENSSL_malloc|, etc., in crypto.h rather than 22 // mem.h. 23 #include <openssl/mem.h> 24 25 // Upstream OpenSSL defines |CRYPTO_LOCK|, etc., in crypto.h rather than 26 // thread.h. 27 #include <openssl/thread.h> 28 29 30 #if defined(__cplusplus) 31 extern "C" { 32 #endif 33 34 35 // crypto.h contains functions for initializing the crypto library. 36 37 38 // CRYPTO_library_init initializes the crypto library. It must be called if the 39 // library is built with BORINGSSL_NO_STATIC_INITIALIZER. Otherwise, it does 40 // nothing and a static initializer is used instead. It is safe to call this 41 // function multiple times and concurrently from multiple threads. 42 // 43 // On some ARM configurations, this function may require filesystem access and 44 // should be called before entering a sandbox. 45 OPENSSL_EXPORT void CRYPTO_library_init(void); 46 47 // CRYPTO_is_confidential_build returns one if the linked version of BoringSSL 48 // has been built with the BORINGSSL_CONFIDENTIAL define and zero otherwise. 49 // 50 // This is used by some consumers to identify whether they are using an 51 // internal version of BoringSSL. 52 OPENSSL_EXPORT int CRYPTO_is_confidential_build(void); 53 54 // CRYPTO_has_asm returns one unless BoringSSL was built with OPENSSL_NO_ASM, 55 // in which case it returns zero. 56 OPENSSL_EXPORT int CRYPTO_has_asm(void); 57 58 // BORINGSSL_self_test triggers the FIPS KAT-based self tests. It returns one on 59 // success and zero on error. 60 OPENSSL_EXPORT int BORINGSSL_self_test(void); 61 62 // BORINGSSL_integrity_test triggers the module's integrity test where the code 63 // and data of the module is matched against a hash injected at build time. It 64 // returns one on success or zero if there's a mismatch. This function only 65 // exists if the module was built in FIPS mode without ASAN. 66 OPENSSL_EXPORT int BORINGSSL_integrity_test(void); 67 68 // CRYPTO_pre_sandbox_init initializes the crypto library, pre-acquiring some 69 // unusual resources to aid running in sandboxed environments. It is safe to 70 // call this function multiple times and concurrently from multiple threads. 71 // 72 // For more details on using BoringSSL in a sandboxed environment, see 73 // SANDBOXING.md in the source tree. 74 OPENSSL_EXPORT void CRYPTO_pre_sandbox_init(void); 75 76 #if defined(OPENSSL_ARM) && defined(OPENSSL_LINUX) && \ 77 !defined(OPENSSL_STATIC_ARMCAP) 78 // CRYPTO_needs_hwcap2_workaround returns one if the ARMv8 AArch32 AT_HWCAP2 79 // workaround was needed. See https://crbug.com/boringssl/46. 80 OPENSSL_EXPORT int CRYPTO_needs_hwcap2_workaround(void); 81 #endif // OPENSSL_ARM && OPENSSL_LINUX && !OPENSSL_STATIC_ARMCAP 82 83 84 // FIPS monitoring 85 86 // FIPS_mode returns zero unless BoringSSL is built with BORINGSSL_FIPS, in 87 // which case it returns one. 88 OPENSSL_EXPORT int FIPS_mode(void); 89 90 // fips_counter_t denotes specific APIs/algorithms. A counter is maintained for 91 // each in FIPS mode so that tests can be written to assert that the expected, 92 // FIPS functions are being called by a certain peice of code. 93 enum fips_counter_t { 94 fips_counter_evp_aes_128_gcm = 0, 95 fips_counter_evp_aes_256_gcm = 1, 96 fips_counter_evp_aes_128_ctr = 2, 97 fips_counter_evp_aes_256_ctr = 3, 98 99 fips_counter_max = 3, 100 }; 101 102 // FIPS_read_counter returns a counter of the number of times the specific 103 // function denoted by |counter| has been used. This always returns zero unless 104 // BoringSSL was built with BORINGSSL_FIPS_COUNTERS defined. 105 OPENSSL_EXPORT size_t FIPS_read_counter(enum fips_counter_t counter); 106 107 108 // Deprecated functions. 109 110 // OPENSSL_VERSION_TEXT contains a string the identifies the version of 111 // “OpenSSL”. node.js requires a version number in this text. 112 #define OPENSSL_VERSION_TEXT "OpenSSL 1.1.1 (compatible; BoringSSL)" 113 114 #define OPENSSL_VERSION 0 115 #define OPENSSL_CFLAGS 1 116 #define OPENSSL_BUILT_ON 2 117 #define OPENSSL_PLATFORM 3 118 #define OPENSSL_DIR 4 119 120 // OpenSSL_version is a compatibility function that returns the string 121 // "BoringSSL" if |which| is |OPENSSL_VERSION| and placeholder strings 122 // otherwise. 123 OPENSSL_EXPORT const char *OpenSSL_version(int which); 124 125 #define SSLEAY_VERSION OPENSSL_VERSION 126 #define SSLEAY_CFLAGS OPENSSL_CFLAGS 127 #define SSLEAY_BUILT_ON OPENSSL_BUILT_ON 128 #define SSLEAY_PLATFORM OPENSSL_PLATFORM 129 #define SSLEAY_DIR OPENSSL_DIR 130 131 // SSLeay_version calls |OpenSSL_version|. 132 OPENSSL_EXPORT const char *SSLeay_version(int which); 133 134 // SSLeay is a compatibility function that returns OPENSSL_VERSION_NUMBER from 135 // base.h. 136 OPENSSL_EXPORT unsigned long SSLeay(void); 137 138 // OpenSSL_version_num is a compatibility function that returns 139 // OPENSSL_VERSION_NUMBER from base.h. 140 OPENSSL_EXPORT unsigned long OpenSSL_version_num(void); 141 142 // CRYPTO_malloc_init returns one. 143 OPENSSL_EXPORT int CRYPTO_malloc_init(void); 144 145 // OPENSSL_malloc_init returns one. 146 OPENSSL_EXPORT int OPENSSL_malloc_init(void); 147 148 // ENGINE_load_builtin_engines does nothing. 149 OPENSSL_EXPORT void ENGINE_load_builtin_engines(void); 150 151 // ENGINE_register_all_complete returns one. 152 OPENSSL_EXPORT int ENGINE_register_all_complete(void); 153 154 // OPENSSL_load_builtin_modules does nothing. 155 OPENSSL_EXPORT void OPENSSL_load_builtin_modules(void); 156 157 #define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0 158 #define OPENSSL_INIT_LOAD_CRYPTO_STRINGS 0 159 #define OPENSSL_INIT_ADD_ALL_CIPHERS 0 160 #define OPENSSL_INIT_ADD_ALL_DIGESTS 0 161 #define OPENSSL_INIT_NO_ADD_ALL_CIPHERS 0 162 #define OPENSSL_INIT_NO_ADD_ALL_DIGESTS 0 163 #define OPENSSL_INIT_LOAD_CONFIG 0 164 #define OPENSSL_INIT_NO_LOAD_CONFIG 0 165 #define OPENSSL_INIT_NO_ATEXIT 0 166 167 // OPENSSL_init_crypto calls |CRYPTO_library_init| and returns one. 168 OPENSSL_EXPORT int OPENSSL_init_crypto(uint64_t opts, 169 const OPENSSL_INIT_SETTINGS *settings); 170 171 // OPENSSL_cleanup does nothing. 172 OPENSSL_EXPORT void OPENSSL_cleanup(void); 173 174 // FIPS_mode_set returns one if |on| matches whether BoringSSL was built with 175 // |BORINGSSL_FIPS| and zero otherwise. 176 OPENSSL_EXPORT int FIPS_mode_set(int on); 177 178 // FIPS_module_name returns the name of the FIPS module. 179 OPENSSL_EXPORT const char *FIPS_module_name(void); 180 181 // FIPS_version returns the version of the FIPS module, or zero if the build 182 // isn't exactly at a verified version. The version, expressed in base 10, will 183 // be a date in the form yyyymmddXX where XX is often "00", but can be 184 // incremented if multiple versions are defined on a single day. 185 // 186 // (This format exceeds a |uint32_t| in the year 4294.) 187 OPENSSL_EXPORT uint32_t FIPS_version(void); 188 189 // FIPS_query_algorithm_status returns one if |algorithm| is FIPS validated in 190 // the current BoringSSL and zero otherwise. 191 OPENSSL_EXPORT int FIPS_query_algorithm_status(const char *algorithm); 192 193 #if defined(OPENSSL_ARM) && defined(OPENSSL_LINUX) && \ 194 !defined(OPENSSL_STATIC_ARMCAP) 195 // CRYPTO_has_broken_NEON returns zero. 196 OPENSSL_EXPORT int CRYPTO_has_broken_NEON(void); 197 #endif 198 199 200 #if defined(__cplusplus) 201 } // extern C 202 #endif 203 204 #endif // OPENSSL_HEADER_CRYPTO_H 205