check_chain_extensions(): Add check that CA cert includes key usage extension
[openssl.git] / include / openssl / x509_vfy.h
1 /*
2  * Copyright 1995-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_X509_VFY_H
11 # define OPENSSL_X509_VFY_H
12 # pragma once
13
14 # include <openssl/macros.h>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
16 #  define HEADER_X509_VFY_H
17 # endif
18
19 /*
20  * Protect against recursion, x509.h and x509_vfy.h each include the other.
21  */
22 # ifndef OPENSSL_X509_H
23 #  include <openssl/x509.h>
24 # endif
25
26 # include <openssl/opensslconf.h>
27 # include <openssl/lhash.h>
28 # include <openssl/bio.h>
29 # include <openssl/crypto.h>
30 # include <openssl/symhacks.h>
31
32 #ifdef  __cplusplus
33 extern "C" {
34 #endif
35
36 /*-
37 SSL_CTX -> X509_STORE
38                 -> X509_LOOKUP
39                         ->X509_LOOKUP_METHOD
40                 -> X509_LOOKUP
41                         ->X509_LOOKUP_METHOD
42
43 SSL     -> X509_STORE_CTX
44                 ->X509_STORE
45
46 The X509_STORE holds the tables etc for verification stuff.
47 A X509_STORE_CTX is used while validating a single certificate.
48 The X509_STORE has X509_LOOKUPs for looking up certs.
49 The X509_STORE then calls a function to actually verify the
50 certificate chain.
51 */
52
53 typedef enum {
54     X509_LU_NONE = 0,
55     X509_LU_X509, X509_LU_CRL
56 } X509_LOOKUP_TYPE;
57
58 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
59 #define X509_LU_RETRY   -1
60 #define X509_LU_FAIL    0
61 #endif
62
63 DEFINE_OR_DECLARE_STACK_OF(X509_LOOKUP)
64 DEFINE_OR_DECLARE_STACK_OF(X509_OBJECT)
65 DEFINE_OR_DECLARE_STACK_OF(X509_VERIFY_PARAM)
66
67 int X509_STORE_set_depth(X509_STORE *store, int depth);
68
69 typedef int (*X509_STORE_CTX_verify_cb)(int, X509_STORE_CTX *);
70 int X509_STORE_CTX_print_verify_cb(int ok, X509_STORE_CTX *ctx);
71 typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
72 typedef int (*X509_STORE_CTX_get_issuer_fn)(X509 **issuer,
73                                             X509_STORE_CTX *ctx, X509 *x);
74 typedef int (*X509_STORE_CTX_check_issued_fn)(X509_STORE_CTX *ctx,
75                                               X509 *x, X509 *issuer);
76 typedef int (*X509_STORE_CTX_check_revocation_fn)(X509_STORE_CTX *ctx);
77 typedef int (*X509_STORE_CTX_get_crl_fn)(X509_STORE_CTX *ctx,
78                                          X509_CRL **crl, X509 *x);
79 typedef int (*X509_STORE_CTX_check_crl_fn)(X509_STORE_CTX *ctx, X509_CRL *crl);
80 typedef int (*X509_STORE_CTX_cert_crl_fn)(X509_STORE_CTX *ctx,
81                                           X509_CRL *crl, X509 *x);
82 typedef int (*X509_STORE_CTX_check_policy_fn)(X509_STORE_CTX *ctx);
83 typedef STACK_OF(X509)
84     *(*X509_STORE_CTX_lookup_certs_fn)(X509_STORE_CTX *ctx,
85                                        const X509_NAME *nm);
86 typedef STACK_OF(X509_CRL)
87     *(*X509_STORE_CTX_lookup_crls_fn)(const X509_STORE_CTX *ctx,
88                                       const X509_NAME *nm);
89 typedef int (*X509_STORE_CTX_cleanup_fn)(X509_STORE_CTX *ctx);
90
91 void X509_STORE_CTX_set_depth(X509_STORE_CTX *ctx, int depth);
92
93 # define X509_STORE_CTX_set_app_data(ctx,data) \
94         X509_STORE_CTX_set_ex_data(ctx,0,data)
95 # define X509_STORE_CTX_get_app_data(ctx) \
96         X509_STORE_CTX_get_ex_data(ctx,0)
97
98 # define X509_L_FILE_LOAD        1
99 # define X509_L_ADD_DIR          2
100 # define X509_L_ADD_STORE        3
101 # define X509_L_LOAD_STORE       4
102
103 # define X509_LOOKUP_load_file(x,name,type) \
104                 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
105
106 # define X509_LOOKUP_add_dir(x,name,type) \
107                 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
108
109 # define X509_LOOKUP_add_store(x,name) \
110                 X509_LOOKUP_ctrl((x),X509_L_ADD_STORE,(name),0,NULL)
111
112 # define X509_LOOKUP_load_store(x,name) \
113                 X509_LOOKUP_ctrl((x),X509_L_LOAD_STORE,(name),0,NULL)
114
115 # define X509_LOOKUP_load_file_with_libctx(x, name, type, libctx, propq)       \
116 X509_LOOKUP_ctrl_with_libctx((x), X509_L_FILE_LOAD, (name), (long)(type), NULL,\
117                              (libctx), (propq))
118
119 # define X509_LOOKUP_load_store_with_libctx(x, name, libctx, propq)            \
120 X509_LOOKUP_ctrl_with_libctx((x), X509_L_LOAD_STORE, (name), 0, NULL,          \
121                              (libctx), (propq))
122
123 # define X509_LOOKUP_add_store_with_libctx(x, name, libctx, propq)             \
124 X509_LOOKUP_ctrl_with_libctx((x), X509_L_ADD_STORE, (name), 0, NULL,           \
125                              (libctx), (propq))
126
127 # define X509_V_OK                                       0
128 # define X509_V_ERR_UNSPECIFIED                          1
129 # define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT            2
130 # define X509_V_ERR_UNABLE_TO_GET_CRL                    3
131 # define X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE     4
132 # define X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE      5
133 # define X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY   6
134 # define X509_V_ERR_CERT_SIGNATURE_FAILURE               7
135 # define X509_V_ERR_CRL_SIGNATURE_FAILURE                8
136 # define X509_V_ERR_CERT_NOT_YET_VALID                   9
137 # define X509_V_ERR_CERT_HAS_EXPIRED                     10
138 # define X509_V_ERR_CRL_NOT_YET_VALID                    11
139 # define X509_V_ERR_CRL_HAS_EXPIRED                      12
140 # define X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD       13
141 # define X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD        14
142 # define X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD       15
143 # define X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD       16
144 # define X509_V_ERR_OUT_OF_MEM                           17
145 # define X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT          18
146 # define X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN            19
147 # define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY    20
148 # define X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE      21
149 # define X509_V_ERR_CERT_CHAIN_TOO_LONG                  22
150 # define X509_V_ERR_CERT_REVOKED                         23
151 # define X509_V_ERR_NO_ISSUER_PUBLIC_KEY                 24
152 # define X509_V_ERR_PATH_LENGTH_EXCEEDED                 25
153 # define X509_V_ERR_INVALID_PURPOSE                      26
154 # define X509_V_ERR_CERT_UNTRUSTED                       27
155 # define X509_V_ERR_CERT_REJECTED                        28
156
157 /* These are 'informational' when looking for issuer cert */
158 # define X509_V_ERR_SUBJECT_ISSUER_MISMATCH              29
159 # define X509_V_ERR_AKID_SKID_MISMATCH                   30
160 # define X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH          31
161 # define X509_V_ERR_KEYUSAGE_NO_CERTSIGN                 32
162 # define X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER             33
163 # define X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION         34
164 # define X509_V_ERR_KEYUSAGE_NO_CRL_SIGN                 35
165 # define X509_V_ERR_UNHANDLED_CRITICAL_CRL_EXTENSION     36
166 # define X509_V_ERR_INVALID_NON_CA                       37
167 # define X509_V_ERR_PROXY_PATH_LENGTH_EXCEEDED           38
168 # define X509_V_ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE        39
169 # define X509_V_ERR_PROXY_CERTIFICATES_NOT_ALLOWED       40
170 # define X509_V_ERR_INVALID_EXTENSION                    41
171 # define X509_V_ERR_INVALID_POLICY_EXTENSION             42
172 # define X509_V_ERR_NO_EXPLICIT_POLICY                   43
173 # define X509_V_ERR_DIFFERENT_CRL_SCOPE                  44
174 # define X509_V_ERR_UNSUPPORTED_EXTENSION_FEATURE        45
175 # define X509_V_ERR_UNNESTED_RESOURCE                    46
176 # define X509_V_ERR_PERMITTED_VIOLATION                  47
177 # define X509_V_ERR_EXCLUDED_VIOLATION                   48
178 # define X509_V_ERR_SUBTREE_MINMAX                       49
179 /* The application is not happy */
180 # define X509_V_ERR_APPLICATION_VERIFICATION             50
181 # define X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE          51
182 # define X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX        52
183 # define X509_V_ERR_UNSUPPORTED_NAME_SYNTAX              53
184 # define X509_V_ERR_CRL_PATH_VALIDATION_ERROR            54
185 /* Another issuer check debug option */
186 # define X509_V_ERR_PATH_LOOP                            55
187 /* Suite B mode algorithm violation */
188 # define X509_V_ERR_SUITE_B_INVALID_VERSION              56
189 # define X509_V_ERR_SUITE_B_INVALID_ALGORITHM            57
190 # define X509_V_ERR_SUITE_B_INVALID_CURVE                58
191 # define X509_V_ERR_SUITE_B_INVALID_SIGNATURE_ALGORITHM  59
192 # define X509_V_ERR_SUITE_B_LOS_NOT_ALLOWED              60
193 # define X509_V_ERR_SUITE_B_CANNOT_SIGN_P_384_WITH_P_256 61
194 /* Host, email and IP check errors */
195 # define X509_V_ERR_HOSTNAME_MISMATCH                    62
196 # define X509_V_ERR_EMAIL_MISMATCH                       63
197 # define X509_V_ERR_IP_ADDRESS_MISMATCH                  64
198 /* DANE TLSA errors */
199 # define X509_V_ERR_DANE_NO_MATCH                        65
200 /* security level errors */
201 # define X509_V_ERR_EE_KEY_TOO_SMALL                     66
202 # define X509_V_ERR_CA_KEY_TOO_SMALL                     67
203 # define X509_V_ERR_CA_MD_TOO_WEAK                       68
204 /* Caller error */
205 # define X509_V_ERR_INVALID_CALL                         69
206 /* Issuer lookup error */
207 # define X509_V_ERR_STORE_LOOKUP                         70
208 /* Certificate transparency */
209 # define X509_V_ERR_NO_VALID_SCTS                        71
210
211 # define X509_V_ERR_PROXY_SUBJECT_NAME_VIOLATION         72
212 /* OCSP status errors */
213 # define X509_V_ERR_OCSP_VERIFY_NEEDED                   73  /* Need OCSP verification */
214 # define X509_V_ERR_OCSP_VERIFY_FAILED                   74  /* Couldn't verify cert through OCSP */
215 # define X509_V_ERR_OCSP_CERT_UNKNOWN                    75  /* Certificate wasn't recognized by the OCSP responder */
216
217 # define X509_V_ERR_UNSUPPORTED_SIGNATURE_ALGORITHM      76
218 # define X509_V_ERR_SIGNATURE_ALGORITHM_MISMATCH         77
219
220 /* Errors in case a check in X509_V_FLAG_X509_STRICT mode fails */
221 # define X509_V_ERR_SIGNATURE_ALGORITHM_INCONSISTENCY    78
222 # define X509_V_ERR_INVALID_CA                           79
223 # define X509_V_ERR_PATHLEN_INVALID_FOR_NON_CA           80
224 # define X509_V_ERR_PATHLEN_WITHOUT_KU_KEY_CERT_SIGN     81
225 # define X509_V_ERR_KU_KEY_CERT_SIGN_INVALID_FOR_NON_CA  82
226 # define X509_V_ERR_ISSUER_NAME_EMPTY                    83
227 # define X509_V_ERR_SUBJECT_NAME_EMPTY                   84
228 # define X509_V_ERR_MISSING_AUTHORITY_KEY_IDENTIFIER     85
229 # define X509_V_ERR_MISSING_SUBJECT_KEY_IDENTIFIER       86
230 # define X509_V_ERR_EMPTY_SUBJECT_ALT_NAME               87
231 # define X509_V_ERR_EMPTY_SUBJECT_SAN_NOT_CRITICAL       88
232 # define X509_V_ERR_CA_BCONS_NOT_CRITICAL                89
233 # define X509_V_ERR_AUTHORITY_KEY_IDENTIFIER_CRITICAL    90
234 # define X509_V_ERR_SUBJECT_KEY_IDENTIFIER_CRITICAL      91
235 # define X509_V_ERR_CA_CERT_MISSING_KEY_USAGE            92
236
237 /* Certificate verify flags */
238 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
239 #  define X509_V_FLAG_CB_ISSUER_CHECK             0x0   /* Deprecated */
240 # endif
241 /* Use check time instead of current time */
242 # define X509_V_FLAG_USE_CHECK_TIME              0x2
243 /* Lookup CRLs */
244 # define X509_V_FLAG_CRL_CHECK                   0x4
245 /* Lookup CRLs for whole chain */
246 # define X509_V_FLAG_CRL_CHECK_ALL               0x8
247 /* Ignore unhandled critical extensions */
248 # define X509_V_FLAG_IGNORE_CRITICAL             0x10
249 /* Disable workarounds for broken certificates */
250 # define X509_V_FLAG_X509_STRICT                 0x20
251 /* Enable proxy certificate validation */
252 # define X509_V_FLAG_ALLOW_PROXY_CERTS           0x40
253 /* Enable policy checking */
254 # define X509_V_FLAG_POLICY_CHECK                0x80
255 /* Policy variable require-explicit-policy */
256 # define X509_V_FLAG_EXPLICIT_POLICY             0x100
257 /* Policy variable inhibit-any-policy */
258 # define X509_V_FLAG_INHIBIT_ANY                 0x200
259 /* Policy variable inhibit-policy-mapping */
260 # define X509_V_FLAG_INHIBIT_MAP                 0x400
261 /* Notify callback that policy is OK */
262 # define X509_V_FLAG_NOTIFY_POLICY               0x800
263 /* Extended CRL features such as indirect CRLs, alternate CRL signing keys */
264 # define X509_V_FLAG_EXTENDED_CRL_SUPPORT        0x1000
265 /* Delta CRL support */
266 # define X509_V_FLAG_USE_DELTAS                  0x2000
267 /* Check self-signed CA signature */
268 # define X509_V_FLAG_CHECK_SS_SIGNATURE          0x4000
269 /* Use trusted store first */
270 # define X509_V_FLAG_TRUSTED_FIRST               0x8000
271 /* Suite B 128 bit only mode: not normally used */
272 # define X509_V_FLAG_SUITEB_128_LOS_ONLY         0x10000
273 /* Suite B 192 bit only mode */
274 # define X509_V_FLAG_SUITEB_192_LOS              0x20000
275 /* Suite B 128 bit mode allowing 192 bit algorithms */
276 # define X509_V_FLAG_SUITEB_128_LOS              0x30000
277 /* Allow partial chains if at least one certificate is in trusted store */
278 # define X509_V_FLAG_PARTIAL_CHAIN               0x80000
279 /*
280  * If the initial chain is not trusted, do not attempt to build an alternative
281  * chain. Alternate chain checking was introduced in 1.1.0. Setting this flag
282  * will force the behaviour to match that of previous versions.
283  */
284 # define X509_V_FLAG_NO_ALT_CHAINS               0x100000
285 /* Do not check certificate/CRL validity against current time */
286 # define X509_V_FLAG_NO_CHECK_TIME               0x200000
287
288 # define X509_VP_FLAG_DEFAULT                    0x1
289 # define X509_VP_FLAG_OVERWRITE                  0x2
290 # define X509_VP_FLAG_RESET_FLAGS                0x4
291 # define X509_VP_FLAG_LOCKED                     0x8
292 # define X509_VP_FLAG_ONCE                       0x10
293
294 /* Internal use: mask of policy related options */
295 # define X509_V_FLAG_POLICY_MASK (X509_V_FLAG_POLICY_CHECK \
296                                 | X509_V_FLAG_EXPLICIT_POLICY \
297                                 | X509_V_FLAG_INHIBIT_ANY \
298                                 | X509_V_FLAG_INHIBIT_MAP)
299
300 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, X509_LOOKUP_TYPE type,
301                                const X509_NAME *name);
302 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,
303                                              X509_LOOKUP_TYPE type,
304                                              const X509_NAME *name);
305 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h,
306                                         X509_OBJECT *x);
307 int X509_OBJECT_up_ref_count(X509_OBJECT *a);
308 X509_OBJECT *X509_OBJECT_new(void);
309 void X509_OBJECT_free(X509_OBJECT *a);
310 X509_LOOKUP_TYPE X509_OBJECT_get_type(const X509_OBJECT *a);
311 X509 *X509_OBJECT_get0_X509(const X509_OBJECT *a);
312 int X509_OBJECT_set1_X509(X509_OBJECT *a, X509 *obj);
313 X509_CRL *X509_OBJECT_get0_X509_CRL(const X509_OBJECT *a);
314 int X509_OBJECT_set1_X509_CRL(X509_OBJECT *a, X509_CRL *obj);
315 X509_STORE *X509_STORE_new(void);
316 void X509_STORE_free(X509_STORE *v);
317 int X509_STORE_lock(X509_STORE *ctx);
318 int X509_STORE_unlock(X509_STORE *ctx);
319 int X509_STORE_up_ref(X509_STORE *v);
320 STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(const X509_STORE *v);
321 STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *st);
322 STACK_OF(X509) *X509_STORE_CTX_get1_certs(X509_STORE_CTX *st,
323                                           const X509_NAME *nm);
324 STACK_OF(X509_CRL) *X509_STORE_CTX_get1_crls(const X509_STORE_CTX *st,
325                                              const X509_NAME *nm);
326 int X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags);
327 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose);
328 int X509_STORE_set_trust(X509_STORE *ctx, int trust);
329 int X509_STORE_set1_param(X509_STORE *ctx, const X509_VERIFY_PARAM *pm);
330 X509_VERIFY_PARAM *X509_STORE_get0_param(const X509_STORE *ctx);
331
332 void X509_STORE_set_verify(X509_STORE *ctx, X509_STORE_CTX_verify_fn verify);
333 #define X509_STORE_set_verify_func(ctx, func) \
334             X509_STORE_set_verify((ctx),(func))
335 void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx,
336                                X509_STORE_CTX_verify_fn verify);
337 X509_STORE_CTX_verify_fn X509_STORE_get_verify(const X509_STORE *ctx);
338 void X509_STORE_set_verify_cb(X509_STORE *ctx,
339                               X509_STORE_CTX_verify_cb verify_cb);
340 # define X509_STORE_set_verify_cb_func(ctx,func) \
341             X509_STORE_set_verify_cb((ctx),(func))
342 X509_STORE_CTX_verify_cb X509_STORE_get_verify_cb(const X509_STORE *ctx);
343 void X509_STORE_set_get_issuer(X509_STORE *ctx,
344                                X509_STORE_CTX_get_issuer_fn get_issuer);
345 X509_STORE_CTX_get_issuer_fn X509_STORE_get_get_issuer(const X509_STORE *ctx);
346 void X509_STORE_set_check_issued(X509_STORE *ctx,
347                                  X509_STORE_CTX_check_issued_fn check_issued);
348 X509_STORE_CTX_check_issued_fn X509_STORE_get_check_issued(const X509_STORE *ctx);
349 void X509_STORE_set_check_revocation(X509_STORE *ctx,
350                                      X509_STORE_CTX_check_revocation_fn check_revocation);
351 X509_STORE_CTX_check_revocation_fn
352     X509_STORE_get_check_revocation(const X509_STORE *ctx);
353 void X509_STORE_set_get_crl(X509_STORE *ctx,
354                             X509_STORE_CTX_get_crl_fn get_crl);
355 X509_STORE_CTX_get_crl_fn X509_STORE_get_get_crl(const X509_STORE *ctx);
356 void X509_STORE_set_check_crl(X509_STORE *ctx,
357                               X509_STORE_CTX_check_crl_fn check_crl);
358 X509_STORE_CTX_check_crl_fn X509_STORE_get_check_crl(const X509_STORE *ctx);
359 void X509_STORE_set_cert_crl(X509_STORE *ctx,
360                              X509_STORE_CTX_cert_crl_fn cert_crl);
361 X509_STORE_CTX_cert_crl_fn X509_STORE_get_cert_crl(const X509_STORE *ctx);
362 void X509_STORE_set_check_policy(X509_STORE *ctx,
363                                  X509_STORE_CTX_check_policy_fn check_policy);
364 X509_STORE_CTX_check_policy_fn X509_STORE_get_check_policy(const X509_STORE *ctx);
365 void X509_STORE_set_lookup_certs(X509_STORE *ctx,
366                                  X509_STORE_CTX_lookup_certs_fn lookup_certs);
367 X509_STORE_CTX_lookup_certs_fn X509_STORE_get_lookup_certs(const X509_STORE *ctx);
368 void X509_STORE_set_lookup_crls(X509_STORE *ctx,
369                                 X509_STORE_CTX_lookup_crls_fn lookup_crls);
370 #define X509_STORE_set_lookup_crls_cb(ctx, func) \
371     X509_STORE_set_lookup_crls((ctx), (func))
372 X509_STORE_CTX_lookup_crls_fn X509_STORE_get_lookup_crls(const X509_STORE *ctx);
373 void X509_STORE_set_cleanup(X509_STORE *ctx,
374                             X509_STORE_CTX_cleanup_fn cleanup);
375 X509_STORE_CTX_cleanup_fn X509_STORE_get_cleanup(const X509_STORE *ctx);
376
377 #define X509_STORE_get_ex_new_index(l, p, newf, dupf, freef) \
378     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_X509_STORE, l, p, newf, dupf, freef)
379 int X509_STORE_set_ex_data(X509_STORE *ctx, int idx, void *data);
380 void *X509_STORE_get_ex_data(const X509_STORE *ctx, int idx);
381
382 X509_STORE_CTX *X509_STORE_CTX_new_with_libctx(OPENSSL_CTX *libctx,
383                                                const char *propq);
384 X509_STORE_CTX *X509_STORE_CTX_new(void);
385
386 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
387
388 void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
389 int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
390                         X509 *x509, STACK_OF(X509) *chain);
391 void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
392 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
393
394 X509_STORE *X509_STORE_CTX_get0_store(const X509_STORE_CTX *ctx);
395 X509 *X509_STORE_CTX_get0_cert(const X509_STORE_CTX *ctx);
396 STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(const X509_STORE_CTX *ctx);
397 void X509_STORE_CTX_set0_untrusted(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
398 void X509_STORE_CTX_set_verify_cb(X509_STORE_CTX *ctx,
399                                   X509_STORE_CTX_verify_cb verify);
400 X509_STORE_CTX_verify_cb X509_STORE_CTX_get_verify_cb(const X509_STORE_CTX *ctx);
401 X509_STORE_CTX_verify_fn X509_STORE_CTX_get_verify(const X509_STORE_CTX *ctx);
402 X509_STORE_CTX_get_issuer_fn X509_STORE_CTX_get_get_issuer(const X509_STORE_CTX *ctx);
403 X509_STORE_CTX_check_issued_fn X509_STORE_CTX_get_check_issued(const X509_STORE_CTX *ctx);
404 X509_STORE_CTX_check_revocation_fn X509_STORE_CTX_get_check_revocation(const X509_STORE_CTX *ctx);
405 X509_STORE_CTX_get_crl_fn X509_STORE_CTX_get_get_crl(const X509_STORE_CTX *ctx);
406 X509_STORE_CTX_check_crl_fn X509_STORE_CTX_get_check_crl(const X509_STORE_CTX *ctx);
407 X509_STORE_CTX_cert_crl_fn X509_STORE_CTX_get_cert_crl(const X509_STORE_CTX *ctx);
408 X509_STORE_CTX_check_policy_fn X509_STORE_CTX_get_check_policy(const X509_STORE_CTX *ctx);
409 X509_STORE_CTX_lookup_certs_fn X509_STORE_CTX_get_lookup_certs(const X509_STORE_CTX *ctx);
410 X509_STORE_CTX_lookup_crls_fn X509_STORE_CTX_get_lookup_crls(const X509_STORE_CTX *ctx);
411 X509_STORE_CTX_cleanup_fn X509_STORE_CTX_get_cleanup(const X509_STORE_CTX *ctx);
412
413 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
414 # define X509_STORE_CTX_get_chain X509_STORE_CTX_get0_chain
415 # define X509_STORE_CTX_set_chain X509_STORE_CTX_set0_untrusted
416 # define X509_STORE_CTX_trusted_stack X509_STORE_CTX_set0_trusted_stack
417 # define X509_STORE_get_by_subject X509_STORE_CTX_get_by_subject
418 # define X509_STORE_get1_certs X509_STORE_CTX_get1_certs
419 # define X509_STORE_get1_crls X509_STORE_CTX_get1_crls
420 /* the following macro is misspelled; use X509_STORE_get1_certs instead */
421 # define X509_STORE_get1_cert X509_STORE_CTX_get1_certs
422 /* the following macro is misspelled; use X509_STORE_get1_crls instead */
423 # define X509_STORE_get1_crl X509_STORE_CTX_get1_crls
424 #endif
425
426 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
427 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
428 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
429 X509_LOOKUP_METHOD *X509_LOOKUP_store(void);
430
431 typedef int (*X509_LOOKUP_ctrl_fn)(X509_LOOKUP *ctx, int cmd, const char *argc,
432                                    long argl, char **ret);
433 typedef int (*X509_LOOKUP_ctrl_with_libctx_fn)(
434     X509_LOOKUP *ctx, int cmd, const char *argc, long argl, char **ret,
435     OPENSSL_CTX *libctx, const char *propq);
436
437 typedef int (*X509_LOOKUP_get_by_subject_fn)(X509_LOOKUP *ctx,
438                                              X509_LOOKUP_TYPE type,
439                                              const X509_NAME *name,
440                                              X509_OBJECT *ret);
441 typedef int (*X509_LOOKUP_get_by_subject_with_libctx_fn)(X509_LOOKUP *ctx,
442                                                          X509_LOOKUP_TYPE type,
443                                                          const X509_NAME *name,
444                                                          X509_OBJECT *ret,
445                                                          OPENSSL_CTX *libctx,
446                                                          const char *propq);
447 typedef int (*X509_LOOKUP_get_by_issuer_serial_fn)(X509_LOOKUP *ctx,
448                                                    X509_LOOKUP_TYPE type,
449                                                    const X509_NAME *name,
450                                                    const ASN1_INTEGER *serial,
451                                                    X509_OBJECT *ret);
452 typedef int (*X509_LOOKUP_get_by_fingerprint_fn)(X509_LOOKUP *ctx,
453                                                  X509_LOOKUP_TYPE type,
454                                                  const unsigned char* bytes,
455                                                  int len,
456                                                  X509_OBJECT *ret);
457 typedef int (*X509_LOOKUP_get_by_alias_fn)(X509_LOOKUP *ctx,
458                                            X509_LOOKUP_TYPE type,
459                                            const char *str,
460                                            int len,
461                                            X509_OBJECT *ret);
462
463 X509_LOOKUP_METHOD *X509_LOOKUP_meth_new(const char *name);
464 void X509_LOOKUP_meth_free(X509_LOOKUP_METHOD *method);
465
466 int X509_LOOKUP_meth_set_new_item(X509_LOOKUP_METHOD *method,
467                                   int (*new_item) (X509_LOOKUP *ctx));
468 int (*X509_LOOKUP_meth_get_new_item(const X509_LOOKUP_METHOD* method))
469     (X509_LOOKUP *ctx);
470
471 int X509_LOOKUP_meth_set_free(X509_LOOKUP_METHOD *method,
472                               void (*free_fn) (X509_LOOKUP *ctx));
473 void (*X509_LOOKUP_meth_get_free(const X509_LOOKUP_METHOD* method))
474     (X509_LOOKUP *ctx);
475
476 int X509_LOOKUP_meth_set_init(X509_LOOKUP_METHOD *method,
477                               int (*init) (X509_LOOKUP *ctx));
478 int (*X509_LOOKUP_meth_get_init(const X509_LOOKUP_METHOD* method))
479     (X509_LOOKUP *ctx);
480
481 int X509_LOOKUP_meth_set_shutdown(X509_LOOKUP_METHOD *method,
482                                   int (*shutdown) (X509_LOOKUP *ctx));
483 int (*X509_LOOKUP_meth_get_shutdown(const X509_LOOKUP_METHOD* method))
484     (X509_LOOKUP *ctx);
485
486 int X509_LOOKUP_meth_set_ctrl(X509_LOOKUP_METHOD *method,
487                               X509_LOOKUP_ctrl_fn ctrl_fn);
488 X509_LOOKUP_ctrl_fn X509_LOOKUP_meth_get_ctrl(const X509_LOOKUP_METHOD *method);
489
490 int X509_LOOKUP_meth_set_get_by_subject(X509_LOOKUP_METHOD *method,
491                                         X509_LOOKUP_get_by_subject_fn fn);
492 X509_LOOKUP_get_by_subject_fn X509_LOOKUP_meth_get_get_by_subject(
493     const X509_LOOKUP_METHOD *method);
494
495 int X509_LOOKUP_meth_set_get_by_issuer_serial(X509_LOOKUP_METHOD *method,
496     X509_LOOKUP_get_by_issuer_serial_fn fn);
497 X509_LOOKUP_get_by_issuer_serial_fn X509_LOOKUP_meth_get_get_by_issuer_serial(
498     const X509_LOOKUP_METHOD *method);
499
500 int X509_LOOKUP_meth_set_get_by_fingerprint(X509_LOOKUP_METHOD *method,
501     X509_LOOKUP_get_by_fingerprint_fn fn);
502 X509_LOOKUP_get_by_fingerprint_fn X509_LOOKUP_meth_get_get_by_fingerprint(
503     const X509_LOOKUP_METHOD *method);
504
505 int X509_LOOKUP_meth_set_get_by_alias(X509_LOOKUP_METHOD *method,
506                                       X509_LOOKUP_get_by_alias_fn fn);
507 X509_LOOKUP_get_by_alias_fn X509_LOOKUP_meth_get_get_by_alias(
508     const X509_LOOKUP_METHOD *method);
509
510
511 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
512 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
513
514 int X509_STORE_CTX_get_by_subject(const X509_STORE_CTX *vs,
515                                   X509_LOOKUP_TYPE type,
516                                   const X509_NAME *name, X509_OBJECT *ret);
517 X509_OBJECT *X509_STORE_CTX_get_obj_by_subject(X509_STORE_CTX *vs,
518                                                X509_LOOKUP_TYPE type,
519                                                const X509_NAME *name);
520
521 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
522                      long argl, char **ret);
523 int X509_LOOKUP_ctrl_with_libctx(X509_LOOKUP *ctx, int cmd, const char *argc,
524                                  long argl, char **ret,
525                                  OPENSSL_CTX *libctx, const char *propq);
526
527 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
528 int X509_load_cert_file_with_libctx(X509_LOOKUP *ctx, const char *file, int type,
529                                     OPENSSL_CTX *libctx, const char *propq);
530 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
531 int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type);
532 int X509_load_cert_crl_file_with_libctx(X509_LOOKUP *ctx, const char *file,
533                                         int type, OPENSSL_CTX *libctx,
534                                         const char *propq);
535
536 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
537 void X509_LOOKUP_free(X509_LOOKUP *ctx);
538 int X509_LOOKUP_init(X509_LOOKUP *ctx);
539 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
540                            const X509_NAME *name, X509_OBJECT *ret);
541 int X509_LOOKUP_by_subject_with_libctx(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
542                                        const X509_NAME *name, X509_OBJECT *ret,
543                                        OPENSSL_CTX *libctx, const char *propq);
544 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
545                                  const X509_NAME *name,
546                                  const ASN1_INTEGER *serial,
547                                  X509_OBJECT *ret);
548 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
549                                const unsigned char *bytes, int len,
550                                X509_OBJECT *ret);
551 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
552                          const char *str, int len, X509_OBJECT *ret);
553 int X509_LOOKUP_set_method_data(X509_LOOKUP *ctx, void *data);
554 void *X509_LOOKUP_get_method_data(const X509_LOOKUP *ctx);
555 X509_STORE *X509_LOOKUP_get_store(const X509_LOOKUP *ctx);
556 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
557
558 int X509_STORE_load_file(X509_STORE *ctx, const char *file);
559 int X509_STORE_load_path(X509_STORE *ctx, const char *path);
560 int X509_STORE_load_store(X509_STORE *ctx, const char *store);
561 int X509_STORE_load_locations(X509_STORE *ctx,
562                                                const char *file,
563                                                const char *dir);
564 int X509_STORE_set_default_paths(X509_STORE *ctx);
565
566 int X509_STORE_load_file_with_libctx(X509_STORE *ctx, const char *file,
567                                      OPENSSL_CTX *libctx, const char *propq);
568 int X509_STORE_load_store_with_libctx(X509_STORE *ctx, const char *store,
569                                       OPENSSL_CTX *libctx, const char *propq);
570 int X509_STORE_load_locations_with_libctx(X509_STORE *ctx,
571                                           const char *file, const char *dir,
572                                           OPENSSL_CTX *libctx, const char *propq);
573 int X509_STORE_set_default_paths_with_libctx(X509_STORE *ctx,
574                                              OPENSSL_CTX *libctx,
575                                              const char *propq);
576
577 #define X509_STORE_CTX_get_ex_new_index(l, p, newf, dupf, freef) \
578     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_X509_STORE_CTX, l, p, newf, dupf, freef)
579 int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx, int idx, void *data);
580 void *X509_STORE_CTX_get_ex_data(const X509_STORE_CTX *ctx, int idx);
581 int X509_STORE_CTX_get_error(const X509_STORE_CTX *ctx);
582 void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx, int s);
583 int X509_STORE_CTX_get_error_depth(const X509_STORE_CTX *ctx);
584 void X509_STORE_CTX_set_error_depth(X509_STORE_CTX *ctx, int depth);
585 X509 *X509_STORE_CTX_get_current_cert(const X509_STORE_CTX *ctx);
586 void X509_STORE_CTX_set_current_cert(X509_STORE_CTX *ctx, X509 *x);
587 X509 *X509_STORE_CTX_get0_current_issuer(const X509_STORE_CTX *ctx);
588 X509_CRL *X509_STORE_CTX_get0_current_crl(const X509_STORE_CTX *ctx);
589 X509_STORE_CTX *X509_STORE_CTX_get0_parent_ctx(const X509_STORE_CTX *ctx);
590 STACK_OF(X509) *X509_STORE_CTX_get0_chain(const X509_STORE_CTX *ctx);
591 STACK_OF(X509) *X509_STORE_CTX_get1_chain(const X509_STORE_CTX *ctx);
592 void X509_STORE_CTX_set_cert(X509_STORE_CTX *c, X509 *x);
593 void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *c, STACK_OF(X509) *sk);
594 void X509_STORE_CTX_set0_crls(X509_STORE_CTX *c, STACK_OF(X509_CRL) *sk);
595 int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
596 int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
597 int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
598                                    int purpose, int trust);
599 void X509_STORE_CTX_set_flags(X509_STORE_CTX *ctx, unsigned long flags);
600 void X509_STORE_CTX_set_time(X509_STORE_CTX *ctx, unsigned long flags,
601                              time_t t);
602
603 X509_POLICY_TREE *X509_STORE_CTX_get0_policy_tree(const X509_STORE_CTX *ctx);
604 int X509_STORE_CTX_get_explicit_policy(const X509_STORE_CTX *ctx);
605 int X509_STORE_CTX_get_num_untrusted(const X509_STORE_CTX *ctx);
606
607 X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(const X509_STORE_CTX *ctx);
608 void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
609 int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
610
611 /*
612  * Bridge opacity barrier between libcrypt and libssl, also needed to support
613  * offline testing in test/danetest.c
614  */
615 void X509_STORE_CTX_set0_dane(X509_STORE_CTX *ctx, SSL_DANE *dane);
616 #define DANE_FLAG_NO_DANE_EE_NAMECHECKS (1L << 0)
617
618 /* X509_VERIFY_PARAM functions */
619
620 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void);
621 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param);
622 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *to,
623                               const X509_VERIFY_PARAM *from);
624 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
625                            const X509_VERIFY_PARAM *from);
626 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name);
627 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param,
628                                 unsigned long flags);
629 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
630                                   unsigned long flags);
631 unsigned long X509_VERIFY_PARAM_get_flags(const X509_VERIFY_PARAM *param);
632 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose);
633 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust);
634 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth);
635 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level);
636 time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM *param);
637 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t);
638 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
639                                   ASN1_OBJECT *policy);
640 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
641                                     STACK_OF(ASN1_OBJECT) *policies);
642
643 int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM *param,
644                                     uint32_t flags);
645 uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM *param);
646
647 char *X509_VERIFY_PARAM_get0_host(X509_VERIFY_PARAM *param, int idx);
648 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
649                                 const char *name, size_t namelen);
650 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
651                                 const char *name, size_t namelen);
652 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
653                                      unsigned int flags);
654 unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param);
655 char *X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM *param);
656 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *, X509_VERIFY_PARAM *);
657 char *X509_VERIFY_PARAM_get0_email(X509_VERIFY_PARAM *param);
658 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
659                                  const char *email, size_t emaillen);
660 char *X509_VERIFY_PARAM_get1_ip_asc(X509_VERIFY_PARAM *param);
661 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
662                               const unsigned char *ip, size_t iplen);
663 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param,
664                                   const char *ipasc);
665
666 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param);
667 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param);
668 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param);
669
670 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param);
671 int X509_VERIFY_PARAM_get_count(void);
672 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id);
673 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name);
674 void X509_VERIFY_PARAM_table_cleanup(void);
675
676 /* Non positive return values are errors */
677 #define X509_PCY_TREE_FAILURE  -2 /* Failure to satisfy explicit policy */
678 #define X509_PCY_TREE_INVALID  -1 /* Inconsistent or invalid extensions */
679 #define X509_PCY_TREE_INTERNAL  0 /* Internal error, most likely malloc */
680
681 /*
682  * Positive return values form a bit mask, all but the first are internal to
683  * the library and don't appear in results from X509_policy_check().
684  */
685 #define X509_PCY_TREE_VALID     1 /* The policy tree is valid */
686 #define X509_PCY_TREE_EMPTY     2 /* The policy tree is empty */
687 #define X509_PCY_TREE_EXPLICIT  4 /* Explicit policy required */
688
689 int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy,
690                       STACK_OF(X509) *certs,
691                       STACK_OF(ASN1_OBJECT) *policy_oids, unsigned int flags);
692
693 void X509_policy_tree_free(X509_POLICY_TREE *tree);
694
695 int X509_policy_tree_level_count(const X509_POLICY_TREE *tree);
696 X509_POLICY_LEVEL *X509_policy_tree_get0_level(const X509_POLICY_TREE *tree,
697                                                int i);
698
699 STACK_OF(X509_POLICY_NODE)
700     *X509_policy_tree_get0_policies(const X509_POLICY_TREE *tree);
701
702 STACK_OF(X509_POLICY_NODE)
703     *X509_policy_tree_get0_user_policies(const X509_POLICY_TREE *tree);
704
705 int X509_policy_level_node_count(X509_POLICY_LEVEL *level);
706
707 X509_POLICY_NODE *X509_policy_level_get0_node(const X509_POLICY_LEVEL *level,
708                                               int i);
709
710 const ASN1_OBJECT *X509_policy_node_get0_policy(const X509_POLICY_NODE *node);
711
712 STACK_OF(POLICYQUALINFO)
713     *X509_policy_node_get0_qualifiers(const X509_POLICY_NODE *node);
714 const X509_POLICY_NODE
715     *X509_policy_node_get0_parent(const X509_POLICY_NODE *node);
716
717 #ifdef  __cplusplus
718 }
719 #endif
720 #endif