123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201 |
- /* Copyright (c) 2014, Google Inc.
- *
- * Permission to use, copy, modify, and/or distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
- * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
- * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */
- #ifndef OPENSSL_HEADER_CRYPTO_H
- #define OPENSSL_HEADER_CRYPTO_H
- #include <openssl/base.h>
- #include <openssl/sha.h>
- // Upstream OpenSSL defines |OPENSSL_malloc|, etc., in crypto.h rather than
- // mem.h.
- #include <openssl/mem.h>
- // Upstream OpenSSL defines |CRYPTO_LOCK|, etc., in crypto.h rather than
- // thread.h.
- //#include <openssl/thread.h>
- #if defined(__cplusplus)
- extern "C" {
- #endif
- // crypto.h contains functions for initializing the crypto library.
- // CRYPTO_library_init initializes the crypto library. It must be called if the
- // library is built with BORINGSSL_NO_STATIC_INITIALIZER. Otherwise, it does
- // nothing and a static initializer is used instead. It is safe to call this
- // function multiple times and concurrently from multiple threads.
- //
- // On some ARM configurations, this function may require filesystem access and
- // should be called before entering a sandbox.
- OPENSSL_EXPORT void CRYPTO_library_init(void);
- // CRYPTO_is_confidential_build returns one if the linked version of BoringSSL
- // has been built with the BORINGSSL_CONFIDENTIAL define and zero otherwise.
- //
- // This is used by some consumers to identify whether they are using an
- // internal version of BoringSSL.
- OPENSSL_EXPORT int CRYPTO_is_confidential_build(void);
- // CRYPTO_has_asm returns one unless BoringSSL was built with OPENSSL_NO_ASM,
- // in which case it returns zero.
- OPENSSL_EXPORT int CRYPTO_has_asm(void);
- // BORINGSSL_self_test triggers the FIPS KAT-based self tests. It returns one on
- // success and zero on error.
- OPENSSL_EXPORT int BORINGSSL_self_test(void);
- // BORINGSSL_integrity_test triggers the module's integrity test where the code
- // and data of the module is matched against a hash injected at build time. It
- // returns one on success or zero if there's a mismatch. This function only
- // exists if the module was built in FIPS mode without ASAN.
- OPENSSL_EXPORT int BORINGSSL_integrity_test(void);
- // CRYPTO_pre_sandbox_init initializes the crypto library, pre-acquiring some
- // unusual resources to aid running in sandboxed environments. It is safe to
- // call this function multiple times and concurrently from multiple threads.
- //
- // For more details on using BoringSSL in a sandboxed environment, see
- // SANDBOXING.md in the source tree.
- OPENSSL_EXPORT void CRYPTO_pre_sandbox_init(void);
- #if defined(OPENSSL_ARM) && defined(OPENSSL_LINUX) && \
- !defined(OPENSSL_STATIC_ARMCAP)
- // CRYPTO_has_broken_NEON returns one if the current CPU is known to have a
- // broken NEON unit. See https://crbug.com/341598.
- OPENSSL_EXPORT int CRYPTO_has_broken_NEON(void);
- // CRYPTO_needs_hwcap2_workaround returns one if the ARMv8 AArch32 AT_HWCAP2
- // workaround was needed. See https://crbug.com/boringssl/46.
- OPENSSL_EXPORT int CRYPTO_needs_hwcap2_workaround(void);
- #endif // OPENSSL_ARM && OPENSSL_LINUX && !OPENSSL_STATIC_ARMCAP
- // FIPS monitoring
- // FIPS_mode returns zero unless BoringSSL is built with BORINGSSL_FIPS, in
- // which case it returns one.
- OPENSSL_EXPORT int FIPS_mode(void);
- // fips_counter_t denotes specific APIs/algorithms. A counter is maintained for
- // each in FIPS mode so that tests can be written to assert that the expected,
- // FIPS functions are being called by a certain peice of code.
- enum fips_counter_t {
- fips_counter_evp_aes_128_gcm = 0,
- fips_counter_evp_aes_256_gcm = 1,
- fips_counter_evp_aes_128_ctr = 2,
- fips_counter_evp_aes_256_ctr = 3,
- fips_counter_max = 3,
- };
- // FIPS_read_counter returns a counter of the number of times the specific
- // function denoted by |counter| has been used. This always returns zero unless
- // BoringSSL was built with BORINGSSL_FIPS_COUNTERS defined.
- OPENSSL_EXPORT size_t FIPS_read_counter(enum fips_counter_t counter);
- // Deprecated functions.
- // OPENSSL_VERSION_TEXT contains a string the identifies the version of
- // “OpenSSL”. node.js requires a version number in this text.
- #define OPENSSL_VERSION_TEXT "OpenSSL 1.1.1 (compatible; BoringSSL)"
- #define OPENSSL_VERSION 0
- #define OPENSSL_CFLAGS 1
- #define OPENSSL_BUILT_ON 2
- #define OPENSSL_PLATFORM 3
- #define OPENSSL_DIR 4
- // OpenSSL_version is a compatibility function that returns the string
- // "BoringSSL" if |which| is |OPENSSL_VERSION| and placeholder strings
- // otherwise.
- OPENSSL_EXPORT const char *OpenSSL_version(int which);
- #define SSLEAY_VERSION OPENSSL_VERSION
- #define SSLEAY_CFLAGS OPENSSL_CFLAGS
- #define SSLEAY_BUILT_ON OPENSSL_BUILT_ON
- #define SSLEAY_PLATFORM OPENSSL_PLATFORM
- #define SSLEAY_DIR OPENSSL_DIR
- // SSLeay_version calls |OpenSSL_version|.
- OPENSSL_EXPORT const char *SSLeay_version(int which);
- // SSLeay is a compatibility function that returns OPENSSL_VERSION_NUMBER from
- // base.h.
- OPENSSL_EXPORT unsigned long SSLeay(void);
- // OpenSSL_version_num is a compatibility function that returns
- // OPENSSL_VERSION_NUMBER from base.h.
- OPENSSL_EXPORT unsigned long OpenSSL_version_num(void);
- // CRYPTO_malloc_init returns one.
- OPENSSL_EXPORT int CRYPTO_malloc_init(void);
- // OPENSSL_malloc_init returns one.
- OPENSSL_EXPORT int OPENSSL_malloc_init(void);
- // ENGINE_load_builtin_engines does nothing.
- OPENSSL_EXPORT void ENGINE_load_builtin_engines(void);
- // ENGINE_register_all_complete returns one.
- OPENSSL_EXPORT int ENGINE_register_all_complete(void);
- // OPENSSL_load_builtin_modules does nothing.
- OPENSSL_EXPORT void OPENSSL_load_builtin_modules(void);
- #define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0
- #define OPENSSL_INIT_LOAD_CRYPTO_STRINGS 0
- #define OPENSSL_INIT_ADD_ALL_CIPHERS 0
- #define OPENSSL_INIT_ADD_ALL_DIGESTS 0
- #define OPENSSL_INIT_NO_ADD_ALL_CIPHERS 0
- #define OPENSSL_INIT_NO_ADD_ALL_DIGESTS 0
- #define OPENSSL_INIT_LOAD_CONFIG 0
- #define OPENSSL_INIT_NO_LOAD_CONFIG 0
- // OPENSSL_init_crypto calls |CRYPTO_library_init| and returns one.
- OPENSSL_EXPORT int OPENSSL_init_crypto(uint64_t opts,
- const OPENSSL_INIT_SETTINGS *settings);
- // OPENSSL_cleanup does nothing.
- OPENSSL_EXPORT void OPENSSL_cleanup(void);
- // FIPS_mode_set returns one if |on| matches whether BoringSSL was built with
- // |BORINGSSL_FIPS| and zero otherwise.
- OPENSSL_EXPORT int FIPS_mode_set(int on);
- // FIPS_module_name returns the name of the FIPS module.
- OPENSSL_EXPORT const char *FIPS_module_name(void);
- // FIPS_version returns the version of the FIPS module, or zero if the build
- // isn't exactly at a verified version. The version, expressed in base 10, will
- // be a date in the form yyyymmddXX where XX is often "00", but can be
- // incremented if multiple versions are defined on a single day.
- //
- // (This format exceeds a |uint32_t| in the year 4294.)
- OPENSSL_EXPORT uint32_t FIPS_version(void);
- // FIPS_query_algorithm_status returns one if |algorithm| is FIPS validated in
- // the current BoringSSL and zero otherwise.
- OPENSSL_EXPORT int FIPS_query_algorithm_status(const char *algorithm);
- #if defined(__cplusplus)
- } // extern C
- #endif
- #endif // OPENSSL_HEADER_CRYPTO_H
|