blob: ac6f25085b6f7b900eebcbb85ff3ce2c58d10d78 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* ====================================================================
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
Adam Langleyeb7d2ed2014-07-30 16:02:14 -070056
57/* This file should be the first included by all BoringSSL headers. */
58
Brian Smith054e6822015-03-27 21:12:01 -100059#include <stddef.h>
Adam Langley95c29f32014-06-20 12:00:00 -070060#include <stdint.h>
Adam Langley95c29f32014-06-20 12:00:00 -070061#include <sys/types.h>
62
David Benjamine593fed2016-02-25 11:39:59 -050063#include <openssl/opensslconf.h>
Piotr Sikora987b8f12014-07-14 19:21:44 -070064
Steven Valdez9980ce12016-04-14 16:35:26 -040065#if defined(BORINGSSL_PREFIX)
66#include <boringssl_prefix_symbols.h>
67#endif
68
Adam Langleyb2cb0ec2014-09-02 14:28:49 -070069#if defined(__cplusplus)
70extern "C" {
71#endif
72
73
Adam Langley95c29f32014-06-20 12:00:00 -070074#if defined(__x86_64) || defined(_M_AMD64) || defined(_M_X64)
75#define OPENSSL_64_BIT
76#define OPENSSL_X86_64
77#elif defined(__x86) || defined(__i386) || defined(__i386__) || defined(_M_IX86)
78#define OPENSSL_32_BIT
79#define OPENSSL_X86
80#elif defined(__aarch64__)
81#define OPENSSL_64_BIT
82#define OPENSSL_AARCH64
83#elif defined(__arm) || defined(__arm__) || defined(_M_ARM)
84#define OPENSSL_32_BIT
85#define OPENSSL_ARM
Adam Langleycc7e11f2015-06-15 17:15:46 -070086#elif defined(__PPC64__) || defined(__powerpc64__)
Adam Langley3e652652015-01-09 15:44:37 -080087#define OPENSSL_64_BIT
Adam Langleyc11e13a2015-03-20 16:46:23 -070088#elif defined(__mips__) && !defined(__LP64__)
Adam Langley09020c22014-07-10 09:14:56 -070089#define OPENSSL_32_BIT
90#define OPENSSL_MIPS
Adam Langleyc11e13a2015-03-20 16:46:23 -070091#elif defined(__mips__) && defined(__LP64__)
92#define OPENSSL_64_BIT
93#define OPENSSL_MIPS64
Adam Langley0113a4f2014-07-10 17:07:14 -070094#elif defined(__pnacl__)
95#define OPENSSL_32_BIT
96#define OPENSSL_PNACL
Radu Margarint17b6a7f2016-07-21 15:46:57 -070097#elif defined(__myriad2__)
98#define OPENSSL_32_BIT
Adam Langley95c29f32014-06-20 12:00:00 -070099#else
100#error "Unknown target CPU"
101#endif
102
Adam Langley30eda1d2014-06-24 11:15:12 -0700103#if defined(__APPLE__)
104#define OPENSSL_APPLE
105#endif
106
Brian Smith8a36e532015-07-31 16:11:31 -0400107#if defined(_WIN32)
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700108#define OPENSSL_WINDOWS
109#endif
110
Adam Langley65a7e942015-05-07 18:28:27 -0700111#if defined(TRUSTY)
112#define OPENSSL_TRUSTY
113#define OPENSSL_NO_THREADS
114#endif
115
Adam Langley95c29f32014-06-20 12:00:00 -0700116#define OPENSSL_IS_BORINGSSL
David Benjamin232127d2015-11-19 18:03:32 -0500117#define BORINGSSL_201512
David Benjaminfb8e6782016-03-11 14:39:46 -0500118#define BORINGSSL_201603
Adam Langley95c29f32014-06-20 12:00:00 -0700119#define OPENSSL_VERSION_NUMBER 0x10002000
Matt Braithwaite6454a4c2015-07-31 15:57:07 -0700120#define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
Adam Langley95c29f32014-06-20 12:00:00 -0700121
David Benjamin9d908ba2016-05-05 18:54:33 -0400122/* BORINGSSL_API_VERSION is a positive integer that increments as BoringSSL
123 * changes over time. The value itself is not meaningful. It will be incremented
124 * whenever is convenient to coordinate an API change with consumers. This will
125 * not denote any special point in development.
126 *
127 * A consumer may use this symbol in the preprocessor to temporarily build
128 * against multiple revisions of BoringSSL at the same time. It is not
129 * recommended to do so for longer than is necessary. */
David Benjamind3440b42016-07-14 14:52:41 -0400130#define BORINGSSL_API_VERSION 2
David Benjamin9d908ba2016-05-05 18:54:33 -0400131
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700132#if defined(BORINGSSL_SHARED_LIBRARY)
Adam Langley95c29f32014-06-20 12:00:00 -0700133
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700134#if defined(OPENSSL_WINDOWS)
135
136#if defined(BORINGSSL_IMPLEMENTATION)
137#define OPENSSL_EXPORT __declspec(dllexport)
138#else
139#define OPENSSL_EXPORT __declspec(dllimport)
140#endif
141
142#else /* defined(OPENSSL_WINDOWS) */
143
144#if defined(BORINGSSL_IMPLEMENTATION)
145#define OPENSSL_EXPORT __attribute__((visibility("default")))
146#else
147#define OPENSSL_EXPORT
148#endif
149
150#endif /* defined(OPENSSL_WINDOWS) */
151
152#else /* defined(BORINGSSL_SHARED_LIBRARY) */
153
154#define OPENSSL_EXPORT
155
156#endif /* defined(BORINGSSL_SHARED_LIBRARY) */
Adam Langley95c29f32014-06-20 12:00:00 -0700157
Brian Smith061332f2016-01-17 09:30:42 -1000158
159#if defined(__GNUC__)
160#define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check) \
David Benjamin4b7b0482016-03-30 00:42:17 -0400161 __attribute__((__format__(__printf__, string_index, first_to_check)))
Brian Smith061332f2016-01-17 09:30:42 -1000162#else
163#define OPENSSL_PRINTF_FORMAT_FUNC(string_index, first_to_check)
164#endif
165
David Benjamina353cdb2016-06-09 16:48:33 -0400166/* OPENSSL_MSVC_PRAGMA emits a pragma on MSVC and nothing on other compilers. */
167#if defined(_MSC_VER)
168#define OPENSSL_MSVC_PRAGMA(arg) __pragma(arg)
169#else
170#define OPENSSL_MSVC_PRAGMA(arg)
171#endif
172
Brian Smith061332f2016-01-17 09:30:42 -1000173
David Benjaminf0df86a2015-04-20 11:32:12 -0400174/* CRYPTO_THREADID is a dummy value. */
175typedef int CRYPTO_THREADID;
176
Adam Langley95c29f32014-06-20 12:00:00 -0700177typedef int ASN1_BOOLEAN;
178typedef int ASN1_NULL;
179typedef struct ASN1_ITEM_st ASN1_ITEM;
180typedef struct asn1_object_st ASN1_OBJECT;
181typedef struct asn1_pctx_st ASN1_PCTX;
182typedef struct asn1_string_st ASN1_BIT_STRING;
183typedef struct asn1_string_st ASN1_BMPSTRING;
184typedef struct asn1_string_st ASN1_ENUMERATED;
185typedef struct asn1_string_st ASN1_GENERALIZEDTIME;
186typedef struct asn1_string_st ASN1_GENERALSTRING;
187typedef struct asn1_string_st ASN1_IA5STRING;
188typedef struct asn1_string_st ASN1_INTEGER;
189typedef struct asn1_string_st ASN1_OCTET_STRING;
190typedef struct asn1_string_st ASN1_PRINTABLESTRING;
191typedef struct asn1_string_st ASN1_STRING;
192typedef struct asn1_string_st ASN1_T61STRING;
193typedef struct asn1_string_st ASN1_TIME;
194typedef struct asn1_string_st ASN1_UNIVERSALSTRING;
195typedef struct asn1_string_st ASN1_UTCTIME;
196typedef struct asn1_string_st ASN1_UTF8STRING;
197typedef struct asn1_string_st ASN1_VISIBLESTRING;
198
199typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID;
200typedef struct DIST_POINT_st DIST_POINT;
201typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT;
202typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS;
Matt Braithwaite16f774f2015-08-03 14:14:14 -0700203typedef struct Netscape_certificate_sequence NETSCAPE_CERT_SEQUENCE;
204typedef struct Netscape_spkac_st NETSCAPE_SPKAC;
205typedef struct Netscape_spki_st NETSCAPE_SPKI;
206typedef struct PBE2PARAM_st PBE2PARAM;
207typedef struct PBEPARAM_st PBEPARAM;
208typedef struct PBKDF2PARAM_st PBKDF2PARAM;
Adam Langleyff452c12016-03-08 14:17:02 -0800209typedef struct RIPEMD160state_st RIPEMD160_CTX;
Adam Langley95c29f32014-06-20 12:00:00 -0700210typedef struct X509_POLICY_CACHE_st X509_POLICY_CACHE;
211typedef struct X509_POLICY_LEVEL_st X509_POLICY_LEVEL;
212typedef struct X509_POLICY_NODE_st X509_POLICY_NODE;
213typedef struct X509_POLICY_TREE_st X509_POLICY_TREE;
214typedef struct X509_algor_st X509_ALGOR;
Matt Braithwaite16f774f2015-08-03 14:14:14 -0700215typedef struct X509_crl_info_st X509_CRL_INFO;
Adam Langley95c29f32014-06-20 12:00:00 -0700216typedef struct X509_crl_st X509_CRL;
Matt Braithwaite16f774f2015-08-03 14:14:14 -0700217typedef struct X509_extension_st X509_EXTENSION;
218typedef struct X509_info_st X509_INFO;
219typedef struct X509_name_entry_st X509_NAME_ENTRY;
220typedef struct X509_name_st X509_NAME;
221typedef struct X509_objects_st X509_OBJECTS;
Adam Langley95c29f32014-06-20 12:00:00 -0700222typedef struct X509_pubkey_st X509_PUBKEY;
Matt Braithwaite16f774f2015-08-03 14:14:14 -0700223typedef struct X509_req_info_st X509_REQ_INFO;
224typedef struct X509_req_st X509_REQ;
225typedef struct X509_sig_st X509_SIG;
226typedef struct X509_val_st X509_VAL;
Adam Langley95c29f32014-06-20 12:00:00 -0700227typedef struct bignum_ctx BN_CTX;
228typedef struct bignum_st BIGNUM;
229typedef struct bio_method_st BIO_METHOD;
230typedef struct bio_st BIO;
231typedef struct bn_gencb_st BN_GENCB;
232typedef struct bn_mont_ctx_st BN_MONT_CTX;
233typedef struct buf_mem_st BUF_MEM;
234typedef struct cbb_st CBB;
235typedef struct cbs_st CBS;
Adam Langley0d107e12015-05-05 16:36:32 -0700236typedef struct cmac_ctx_st CMAC_CTX;
Adam Langley95c29f32014-06-20 12:00:00 -0700237typedef struct conf_st CONF;
Brian Smith054e6822015-03-27 21:12:01 -1000238typedef struct conf_value_st CONF_VALUE;
Adam Langley95c29f32014-06-20 12:00:00 -0700239typedef struct dh_st DH;
Adam Langley95c29f32014-06-20 12:00:00 -0700240typedef struct dsa_st DSA;
241typedef struct ec_key_st EC_KEY;
242typedef struct ecdsa_method_st ECDSA_METHOD;
243typedef struct ecdsa_sig_st ECDSA_SIG;
244typedef struct engine_st ENGINE;
245typedef struct env_md_ctx_st EVP_MD_CTX;
246typedef struct env_md_st EVP_MD;
Adam Langleyfd772a52014-06-20 12:00:00 -0700247typedef struct evp_aead_st EVP_AEAD;
Adam Langley95c29f32014-06-20 12:00:00 -0700248typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX;
249typedef struct evp_cipher_st EVP_CIPHER;
David Benjamin97a33932015-09-19 15:17:34 -0400250typedef struct evp_encode_ctx_st EVP_ENCODE_CTX;
Adam Langley95c29f32014-06-20 12:00:00 -0700251typedef struct evp_pkey_asn1_method_st EVP_PKEY_ASN1_METHOD;
252typedef struct evp_pkey_ctx_st EVP_PKEY_CTX;
253typedef struct evp_pkey_method_st EVP_PKEY_METHOD;
254typedef struct evp_pkey_st EVP_PKEY;
255typedef struct hmac_ctx_st HMAC_CTX;
Adam Langleyc9eb7ea2014-08-22 11:06:14 -0700256typedef struct md4_state_st MD4_CTX;
Adam Langley95c29f32014-06-20 12:00:00 -0700257typedef struct md5_state_st MD5_CTX;
Matt Braithwaite045a0ff2016-04-18 11:30:19 -0700258typedef struct newhope_poly_st NEWHOPE_POLY;
Adam Langley5127db32014-09-19 10:49:56 -0700259typedef struct pkcs12_st PKCS12;
Matt Braithwaite16f774f2015-08-03 14:14:14 -0700260typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO;
261typedef struct private_key_st X509_PKEY;
Adam Langley95c29f32014-06-20 12:00:00 -0700262typedef struct rand_meth_st RAND_METHOD;
Adam Langley3f92d212015-02-20 15:32:52 -0800263typedef struct rc4_key_st RC4_KEY;
Adam Langley95c29f32014-06-20 12:00:00 -0700264typedef struct rsa_meth_st RSA_METHOD;
265typedef struct rsa_st RSA;
266typedef struct sha256_state_st SHA256_CTX;
267typedef struct sha512_state_st SHA512_CTX;
268typedef struct sha_state_st SHA_CTX;
Arnar Birgissonf27459e2016-02-09 18:09:00 -0800269typedef struct spake2_ctx_st SPAKE2_CTX;
David Benjamincfd65b62015-09-14 01:54:44 -0400270typedef struct srtp_protection_profile_st SRTP_PROTECTION_PROFILE;
David Benjamin79c117a2015-09-13 13:53:19 -0400271typedef struct ssl_cipher_st SSL_CIPHER;
Adam Langley95c29f32014-06-20 12:00:00 -0700272typedef struct ssl_ctx_st SSL_CTX;
Adam Langley09505632015-07-30 18:10:13 -0700273typedef struct ssl_custom_extension SSL_CUSTOM_EXTENSION;
David Benjamin79c117a2015-09-13 13:53:19 -0400274typedef struct ssl_method_st SSL_METHOD;
David Benjamina6b8cdf2015-09-13 14:07:33 -0400275typedef struct ssl_session_st SSL_SESSION;
Adam Langley95c29f32014-06-20 12:00:00 -0700276typedef struct ssl_st SSL;
277typedef struct st_ERR_FNS ERR_FNS;
278typedef struct v3_ext_ctx X509V3_CTX;
Matt Braithwaite16f774f2015-08-03 14:14:14 -0700279typedef struct x509_attributes_st X509_ATTRIBUTE;
280typedef struct x509_cert_aux_st X509_CERT_AUX;
281typedef struct x509_cert_pair_st X509_CERT_PAIR;
282typedef struct x509_cinf_st X509_CINF;
Adam Langley95c29f32014-06-20 12:00:00 -0700283typedef struct x509_crl_method_st X509_CRL_METHOD;
284typedef struct x509_revoked_st X509_REVOKED;
285typedef struct x509_st X509;
286typedef struct x509_store_ctx_st X509_STORE_CTX;
287typedef struct x509_store_st X509_STORE;
Matt Braithwaite16f774f2015-08-03 14:14:14 -0700288typedef struct x509_trust_st X509_TRUST;
289
Adam Langley95c29f32014-06-20 12:00:00 -0700290typedef void *OPENSSL_BLOCK;
291
292
Adam Langleyb2cb0ec2014-09-02 14:28:49 -0700293#if defined(__cplusplus)
294} /* extern C */
295#endif
296
Adam Langley95c29f32014-06-20 12:00:00 -0700297#endif /* OPENSSL_HEADER_BASE_H */