Fix grammar in certificates.txt
[openssl.git] / include / openssl / types.h
1 /*
2  * Copyright 2001-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef OPENSSL_TYPES_H
11 # define OPENSSL_TYPES_H
12
13 #include <limits.h>
14
15 #ifdef  __cplusplus
16 extern "C" {
17 #endif
18
19 # include <openssl/e_os2.h>
20 # include <openssl/safestack.h>
21 # include <openssl/macros.h>
22
23 typedef struct ossl_provider_st OSSL_PROVIDER; /* Provider Object */
24
25 # ifdef NO_ASN1_TYPEDEFS
26 #  define ASN1_INTEGER            ASN1_STRING
27 #  define ASN1_ENUMERATED         ASN1_STRING
28 #  define ASN1_BIT_STRING         ASN1_STRING
29 #  define ASN1_OCTET_STRING       ASN1_STRING
30 #  define ASN1_PRINTABLESTRING    ASN1_STRING
31 #  define ASN1_T61STRING          ASN1_STRING
32 #  define ASN1_IA5STRING          ASN1_STRING
33 #  define ASN1_UTCTIME            ASN1_STRING
34 #  define ASN1_GENERALIZEDTIME    ASN1_STRING
35 #  define ASN1_TIME               ASN1_STRING
36 #  define ASN1_GENERALSTRING      ASN1_STRING
37 #  define ASN1_UNIVERSALSTRING    ASN1_STRING
38 #  define ASN1_BMPSTRING          ASN1_STRING
39 #  define ASN1_VISIBLESTRING      ASN1_STRING
40 #  define ASN1_UTF8STRING         ASN1_STRING
41 #  define ASN1_BOOLEAN            int
42 #  define ASN1_NULL               int
43 # else
44 typedef struct asn1_string_st ASN1_INTEGER;
45 typedef struct asn1_string_st ASN1_ENUMERATED;
46 typedef struct asn1_string_st ASN1_BIT_STRING;
47 typedef struct asn1_string_st ASN1_OCTET_STRING;
48 typedef struct asn1_string_st ASN1_PRINTABLESTRING;
49 typedef struct asn1_string_st ASN1_T61STRING;
50 typedef struct asn1_string_st ASN1_IA5STRING;
51 typedef struct asn1_string_st ASN1_GENERALSTRING;
52 typedef struct asn1_string_st ASN1_UNIVERSALSTRING;
53 typedef struct asn1_string_st ASN1_BMPSTRING;
54 typedef struct asn1_string_st ASN1_UTCTIME;
55 typedef struct asn1_string_st ASN1_TIME;
56 typedef struct asn1_string_st ASN1_GENERALIZEDTIME;
57 typedef struct asn1_string_st ASN1_VISIBLESTRING;
58 typedef struct asn1_string_st ASN1_UTF8STRING;
59 typedef struct asn1_string_st ASN1_STRING;
60 typedef int ASN1_BOOLEAN;
61 typedef int ASN1_NULL;
62 # endif
63
64 typedef struct asn1_type_st ASN1_TYPE;
65 typedef struct asn1_object_st ASN1_OBJECT;
66 typedef struct asn1_string_table_st ASN1_STRING_TABLE;
67
68 typedef struct ASN1_ITEM_st ASN1_ITEM;
69 typedef struct asn1_pctx_st ASN1_PCTX;
70 typedef struct asn1_sctx_st ASN1_SCTX;
71
72 # ifdef _WIN32
73 #  undef X509_NAME
74 #  undef X509_EXTENSIONS
75 #  undef PKCS7_ISSUER_AND_SERIAL
76 #  undef PKCS7_SIGNER_INFO
77 #  undef OCSP_REQUEST
78 #  undef OCSP_RESPONSE
79 # endif
80
81 # ifdef BIGNUM
82 #  undef BIGNUM
83 # endif
84
85 typedef struct bio_st BIO;
86 typedef struct bignum_st BIGNUM;
87 typedef struct bignum_ctx BN_CTX;
88 typedef struct bn_blinding_st BN_BLINDING;
89 typedef struct bn_mont_ctx_st BN_MONT_CTX;
90 typedef struct bn_recp_ctx_st BN_RECP_CTX;
91 typedef struct bn_gencb_st BN_GENCB;
92
93 typedef struct buf_mem_st BUF_MEM;
94
95 STACK_OF(BIGNUM);
96 STACK_OF(BIGNUM_const);
97
98 typedef struct err_state_st ERR_STATE;
99
100 typedef struct evp_cipher_st EVP_CIPHER;
101 typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX;
102 typedef struct evp_md_st EVP_MD;
103 typedef struct evp_md_ctx_st EVP_MD_CTX;
104 typedef struct evp_mac_st EVP_MAC;
105 typedef struct evp_mac_ctx_st EVP_MAC_CTX;
106 typedef struct evp_pkey_st EVP_PKEY;
107
108 typedef struct evp_pkey_asn1_method_st EVP_PKEY_ASN1_METHOD;
109
110 typedef struct evp_pkey_method_st EVP_PKEY_METHOD;
111 typedef struct evp_pkey_ctx_st EVP_PKEY_CTX;
112
113 typedef struct evp_keymgmt_st EVP_KEYMGMT;
114
115 typedef struct evp_kdf_st EVP_KDF;
116 typedef struct evp_kdf_ctx_st EVP_KDF_CTX;
117
118 typedef struct evp_rand_st EVP_RAND;
119 typedef struct evp_rand_ctx_st EVP_RAND_CTX;
120
121 typedef struct evp_keyexch_st EVP_KEYEXCH;
122
123 typedef struct evp_signature_st EVP_SIGNATURE;
124
125 typedef struct evp_asym_cipher_st EVP_ASYM_CIPHER;
126
127 typedef struct evp_kem_st EVP_KEM;
128
129 typedef struct evp_Encode_Ctx_st EVP_ENCODE_CTX;
130
131 typedef struct hmac_ctx_st HMAC_CTX;
132
133 typedef struct dh_st DH;
134 typedef struct dh_method DH_METHOD;
135
136 # ifndef OPENSSL_NO_DEPRECATED_3_0
137 typedef struct dsa_st DSA;
138 typedef struct dsa_method DSA_METHOD;
139 # endif
140
141 # ifndef OPENSSL_NO_DEPRECATED_3_0
142 typedef struct rsa_st RSA;
143 typedef struct rsa_meth_st RSA_METHOD;
144 # endif
145 typedef struct rsa_pss_params_st RSA_PSS_PARAMS;
146
147 typedef struct ec_key_st EC_KEY;
148 typedef struct ec_key_method_st EC_KEY_METHOD;
149
150 typedef struct rand_meth_st RAND_METHOD;
151 typedef struct rand_drbg_st RAND_DRBG;
152
153 typedef struct ssl_dane_st SSL_DANE;
154 typedef struct x509_st X509;
155 typedef struct X509_algor_st X509_ALGOR;
156 typedef struct X509_crl_st X509_CRL;
157 typedef struct x509_crl_method_st X509_CRL_METHOD;
158 typedef struct x509_revoked_st X509_REVOKED;
159 typedef struct X509_name_st X509_NAME;
160 typedef struct X509_pubkey_st X509_PUBKEY;
161 typedef struct x509_store_st X509_STORE;
162 typedef struct x509_store_ctx_st X509_STORE_CTX;
163
164 typedef struct x509_object_st X509_OBJECT;
165 typedef struct x509_lookup_st X509_LOOKUP;
166 typedef struct x509_lookup_method_st X509_LOOKUP_METHOD;
167 typedef struct X509_VERIFY_PARAM_st X509_VERIFY_PARAM;
168
169 typedef struct x509_sig_info_st X509_SIG_INFO;
170
171 typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO;
172
173 typedef struct v3_ext_ctx X509V3_CTX;
174 typedef struct conf_st CONF;
175 typedef struct ossl_init_settings_st OPENSSL_INIT_SETTINGS;
176
177 typedef struct ui_st UI;
178 typedef struct ui_method_st UI_METHOD;
179
180 typedef struct engine_st ENGINE;
181 typedef struct ssl_st SSL;
182 typedef struct ssl_ctx_st SSL_CTX;
183
184 typedef struct comp_ctx_st COMP_CTX;
185 typedef struct comp_method_st COMP_METHOD;
186
187 typedef struct X509_POLICY_NODE_st X509_POLICY_NODE;
188 typedef struct X509_POLICY_LEVEL_st X509_POLICY_LEVEL;
189 typedef struct X509_POLICY_TREE_st X509_POLICY_TREE;
190 typedef struct X509_POLICY_CACHE_st X509_POLICY_CACHE;
191
192 typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID;
193 typedef struct DIST_POINT_st DIST_POINT;
194 typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT;
195 typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS;
196
197 typedef struct crypto_ex_data_st CRYPTO_EX_DATA;
198
199 typedef struct ossl_http_req_ctx_st OCSP_REQ_CTX; /* backward compatibility */
200 typedef struct ocsp_response_st OCSP_RESPONSE;
201 typedef struct ocsp_responder_id_st OCSP_RESPID;
202
203 typedef struct sct_st SCT;
204 typedef struct sct_ctx_st SCT_CTX;
205 typedef struct ctlog_st CTLOG;
206 typedef struct ctlog_store_st CTLOG_STORE;
207 typedef struct ct_policy_eval_ctx_st CT_POLICY_EVAL_CTX;
208
209 typedef struct ossl_store_info_st OSSL_STORE_INFO;
210 typedef struct ossl_store_search_st OSSL_STORE_SEARCH;
211
212 typedef struct ossl_lib_ctx_st OSSL_LIB_CTX;
213
214 typedef struct ossl_dispatch_st OSSL_DISPATCH;
215 typedef struct ossl_item_st OSSL_ITEM;
216 typedef struct ossl_algorithm_st OSSL_ALGORITHM;
217 typedef struct ossl_param_st OSSL_PARAM;
218 typedef struct ossl_param_bld_st OSSL_PARAM_BLD;
219
220 typedef int pem_password_cb (char *buf, int size, int rwflag, void *userdata);
221
222 typedef struct ossl_encoder_st OSSL_ENCODER;
223 typedef struct ossl_encoder_ctx_st OSSL_ENCODER_CTX;
224 typedef struct ossl_decoder_st OSSL_DECODER;
225 typedef struct ossl_decoder_ctx_st OSSL_DECODER_CTX;
226
227 typedef struct ossl_self_test_st OSSL_SELF_TEST;
228
229 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
230     defined(INTMAX_MAX) && defined(UINTMAX_MAX)
231 typedef intmax_t ossl_intmax_t;
232 typedef uintmax_t ossl_uintmax_t;
233 #else
234 /*
235  * Not long long, because the C-library can only be expected to provide
236  * strtoll(), strtoull() at the same time as intmax_t and strtoimax(),
237  * strtoumax().  Since we use these for parsing arguments, we need the
238  * conversion functions, not just the sizes.
239  */
240 typedef long ossl_intmax_t;
241 typedef unsigned long ossl_uintmax_t;
242 #endif
243
244 #ifdef  __cplusplus
245 }
246 #endif
247
248 #endif /* OPENSSL_TYPES_H */