check_chain_extensions(): Add check that on empty Subject the SAN must be marked...
[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
236 /* Certificate verify flags */
237 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
238 #  define X509_V_FLAG_CB_ISSUER_CHECK             0x0   /* Deprecated */
239 # endif
240 /* Use check time instead of current time */
241 # define X509_V_FLAG_USE_CHECK_TIME              0x2
242 /* Lookup CRLs */
243 # define X509_V_FLAG_CRL_CHECK                   0x4
244 /* Lookup CRLs for whole chain */
245 # define X509_V_FLAG_CRL_CHECK_ALL               0x8
246 /* Ignore unhandled critical extensions */
247 # define X509_V_FLAG_IGNORE_CRITICAL             0x10
248 /* Disable workarounds for broken certificates */
249 # define X509_V_FLAG_X509_STRICT                 0x20
250 /* Enable proxy certificate validation */
251 # define X509_V_FLAG_ALLOW_PROXY_CERTS           0x40
252 /* Enable policy checking */
253 # define X509_V_FLAG_POLICY_CHECK                0x80
254 /* Policy variable require-explicit-policy */
255 # define X509_V_FLAG_EXPLICIT_POLICY             0x100
256 /* Policy variable inhibit-any-policy */
257 # define X509_V_FLAG_INHIBIT_ANY                 0x200
258 /* Policy variable inhibit-policy-mapping */
259 # define X509_V_FLAG_INHIBIT_MAP                 0x400
260 /* Notify callback that policy is OK */
261 # define X509_V_FLAG_NOTIFY_POLICY               0x800
262 /* Extended CRL features such as indirect CRLs, alternate CRL signing keys */
263 # define X509_V_FLAG_EXTENDED_CRL_SUPPORT        0x1000
264 /* Delta CRL support */
265 # define X509_V_FLAG_USE_DELTAS                  0x2000
266 /* Check self-signed CA signature */
267 # define X509_V_FLAG_CHECK_SS_SIGNATURE          0x4000
268 /* Use trusted store first */
269 # define X509_V_FLAG_TRUSTED_FIRST               0x8000
270 /* Suite B 128 bit only mode: not normally used */
271 # define X509_V_FLAG_SUITEB_128_LOS_ONLY         0x10000
272 /* Suite B 192 bit only mode */
273 # define X509_V_FLAG_SUITEB_192_LOS              0x20000
274 /* Suite B 128 bit mode allowing 192 bit algorithms */
275 # define X509_V_FLAG_SUITEB_128_LOS              0x30000
276 /* Allow partial chains if at least one certificate is in trusted store */
277 # define X509_V_FLAG_PARTIAL_CHAIN               0x80000
278 /*
279  * If the initial chain is not trusted, do not attempt to build an alternative
280  * chain. Alternate chain checking was introduced in 1.1.0. Setting this flag
281  * will force the behaviour to match that of previous versions.
282  */
283 # define X509_V_FLAG_NO_ALT_CHAINS               0x100000
284 /* Do not check certificate/CRL validity against current time */
285 # define X509_V_FLAG_NO_CHECK_TIME               0x200000
286
287 # define X509_VP_FLAG_DEFAULT                    0x1
288 # define X509_VP_FLAG_OVERWRITE                  0x2
289 # define X509_VP_FLAG_RESET_FLAGS                0x4
290 # define X509_VP_FLAG_LOCKED                     0x8
291 # define X509_VP_FLAG_ONCE                       0x10
292
293 /* Internal use: mask of policy related options */
294 # define X509_V_FLAG_POLICY_MASK (X509_V_FLAG_POLICY_CHECK \
295                                 | X509_V_FLAG_EXPLICIT_POLICY \
296                                 | X509_V_FLAG_INHIBIT_ANY \
297                                 | X509_V_FLAG_INHIBIT_MAP)
298
299 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, X509_LOOKUP_TYPE type,
300                                const X509_NAME *name);
301 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,
302                                              X509_LOOKUP_TYPE type,
303                                              const X509_NAME *name);
304 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h,
305                                         X509_OBJECT *x);
306 int X509_OBJECT_up_ref_count(X509_OBJECT *a);
307 X509_OBJECT *X509_OBJECT_new(void);
308 void X509_OBJECT_free(X509_OBJECT *a);
309 X509_LOOKUP_TYPE X509_OBJECT_get_type(const X509_OBJECT *a);
310 X509 *X509_OBJECT_get0_X509(const X509_OBJECT *a);
311 int X509_OBJECT_set1_X509(X509_OBJECT *a, X509 *obj);
312 X509_CRL *X509_OBJECT_get0_X509_CRL(const X509_OBJECT *a);
313 int X509_OBJECT_set1_X509_CRL(X509_OBJECT *a, X509_CRL *obj);
314 X509_STORE *X509_STORE_new(void);
315 void X509_STORE_free(X509_STORE *v);
316 int X509_STORE_lock(X509_STORE *ctx);
317 int X509_STORE_unlock(X509_STORE *ctx);
318 int X509_STORE_up_ref(X509_STORE *v);
319 STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(const X509_STORE *v);
320 STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *st);
321 STACK_OF(X509) *X509_STORE_CTX_get1_certs(X509_STORE_CTX *st,
322                                           const X509_NAME *nm);
323 STACK_OF(X509_CRL) *X509_STORE_CTX_get1_crls(const X509_STORE_CTX *st,
324                                              const X509_NAME *nm);
325 int X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags);
326 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose);
327 int X509_STORE_set_trust(X509_STORE *ctx, int trust);
328 int X509_STORE_set1_param(X509_STORE *ctx, const X509_VERIFY_PARAM *pm);
329 X509_VERIFY_PARAM *X509_STORE_get0_param(const X509_STORE *ctx);
330
331 void X509_STORE_set_verify(X509_STORE *ctx, X509_STORE_CTX_verify_fn verify);
332 #define X509_STORE_set_verify_func(ctx, func) \
333             X509_STORE_set_verify((ctx),(func))
334 void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx,
335                                X509_STORE_CTX_verify_fn verify);
336 X509_STORE_CTX_verify_fn X509_STORE_get_verify(const X509_STORE *ctx);
337 void X509_STORE_set_verify_cb(X509_STORE *ctx,
338                               X509_STORE_CTX_verify_cb verify_cb);
339 # define X509_STORE_set_verify_cb_func(ctx,func) \
340             X509_STORE_set_verify_cb((ctx),(func))
341 X509_STORE_CTX_verify_cb X509_STORE_get_verify_cb(const X509_STORE *ctx);
342 void X509_STORE_set_get_issuer(X509_STORE *ctx,
343                                X509_STORE_CTX_get_issuer_fn get_issuer);
344 X509_STORE_CTX_get_issuer_fn X509_STORE_get_get_issuer(const X509_STORE *ctx);
345 void X509_STORE_set_check_issued(X509_STORE *ctx,
346                                  X509_STORE_CTX_check_issued_fn check_issued);
347 X509_STORE_CTX_check_issued_fn X509_STORE_get_check_issued(const X509_STORE *ctx);
348 void X509_STORE_set_check_revocation(X509_STORE *ctx,
349                                      X509_STORE_CTX_check_revocation_fn check_revocation);
350 X509_STORE_CTX_check_revocation_fn
351     X509_STORE_get_check_revocation(const X509_STORE *ctx);
352 void X509_STORE_set_get_crl(X509_STORE *ctx,
353                             X509_STORE_CTX_get_crl_fn get_crl);
354 X509_STORE_CTX_get_crl_fn X509_STORE_get_get_crl(const X509_STORE *ctx);
355 void X509_STORE_set_check_crl(X509_STORE *ctx,
356                               X509_STORE_CTX_check_crl_fn check_crl);
357 X509_STORE_CTX_check_crl_fn X509_STORE_get_check_crl(const X509_STORE *ctx);
358 void X509_STORE_set_cert_crl(X509_STORE *ctx,
359                              X509_STORE_CTX_cert_crl_fn cert_crl);
360 X509_STORE_CTX_cert_crl_fn X509_STORE_get_cert_crl(const X509_STORE *ctx);
361 void X509_STORE_set_check_policy(X509_STORE *ctx,
362                                  X509_STORE_CTX_check_policy_fn check_policy);
363 X509_STORE_CTX_check_policy_fn X509_STORE_get_check_policy(const X509_STORE *ctx);
364 void X509_STORE_set_lookup_certs(X509_STORE *ctx,
365                                  X509_STORE_CTX_lookup_certs_fn lookup_certs);
366 X509_STORE_CTX_lookup_certs_fn X509_STORE_get_lookup_certs(const X509_STORE *ctx);
367 void X509_STORE_set_lookup_crls(X509_STORE *ctx,
368                                 X509_STORE_CTX_lookup_crls_fn lookup_crls);
369 #define X509_STORE_set_lookup_crls_cb(ctx, func) \
370     X509_STORE_set_lookup_crls((ctx), (func))
371 X509_STORE_CTX_lookup_crls_fn X509_STORE_get_lookup_crls(const X509_STORE *ctx);
372 void X509_STORE_set_cleanup(X509_STORE *ctx,
373                             X509_STORE_CTX_cleanup_fn cleanup);
374 X509_STORE_CTX_cleanup_fn X509_STORE_get_cleanup(const X509_STORE *ctx);
375
376 #define X509_STORE_get_ex_new_index(l, p, newf, dupf, freef) \
377     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_X509_STORE, l, p, newf, dupf, freef)
378 int X509_STORE_set_ex_data(X509_STORE *ctx, int idx, void *data);
379 void *X509_STORE_get_ex_data(const X509_STORE *ctx, int idx);
380
381 X509_STORE_CTX *X509_STORE_CTX_new_with_libctx(OPENSSL_CTX *libctx,
382                                                const char *propq);
383 X509_STORE_CTX *X509_STORE_CTX_new(void);
384
385 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
386
387 void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
388 int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
389                         X509 *x509, STACK_OF(X509) *chain);
390 void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
391 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
392
393 X509_STORE *X509_STORE_CTX_get0_store(const X509_STORE_CTX *ctx);
394 X509 *X509_STORE_CTX_get0_cert(const X509_STORE_CTX *ctx);
395 STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(const X509_STORE_CTX *ctx);
396 void X509_STORE_CTX_set0_untrusted(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
397 void X509_STORE_CTX_set_verify_cb(X509_STORE_CTX *ctx,
398                                   X509_STORE_CTX_verify_cb verify);
399 X509_STORE_CTX_verify_cb X509_STORE_CTX_get_verify_cb(const X509_STORE_CTX *ctx);
400 X509_STORE_CTX_verify_fn X509_STORE_CTX_get_verify(const X509_STORE_CTX *ctx);
401 X509_STORE_CTX_get_issuer_fn X509_STORE_CTX_get_get_issuer(const X509_STORE_CTX *ctx);
402 X509_STORE_CTX_check_issued_fn X509_STORE_CTX_get_check_issued(const X509_STORE_CTX *ctx);
403 X509_STORE_CTX_check_revocation_fn X509_STORE_CTX_get_check_revocation(const X509_STORE_CTX *ctx);
404 X509_STORE_CTX_get_crl_fn X509_STORE_CTX_get_get_crl(const X509_STORE_CTX *ctx);
405 X509_STORE_CTX_check_crl_fn X509_STORE_CTX_get_check_crl(const X509_STORE_CTX *ctx);
406 X509_STORE_CTX_cert_crl_fn X509_STORE_CTX_get_cert_crl(const X509_STORE_CTX *ctx);
407 X509_STORE_CTX_check_policy_fn X509_STORE_CTX_get_check_policy(const X509_STORE_CTX *ctx);
408 X509_STORE_CTX_lookup_certs_fn X509_STORE_CTX_get_lookup_certs(const X509_STORE_CTX *ctx);
409 X509_STORE_CTX_lookup_crls_fn X509_STORE_CTX_get_lookup_crls(const X509_STORE_CTX *ctx);
410 X509_STORE_CTX_cleanup_fn X509_STORE_CTX_get_cleanup(const X509_STORE_CTX *ctx);
411
412 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
413 # define X509_STORE_CTX_get_chain X509_STORE_CTX_get0_chain
414 # define X509_STORE_CTX_set_chain X509_STORE_CTX_set0_untrusted
415 # define X509_STORE_CTX_trusted_stack X509_STORE_CTX_set0_trusted_stack
416 # define X509_STORE_get_by_subject X509_STORE_CTX_get_by_subject
417 # define X509_STORE_get1_certs X509_STORE_CTX_get1_certs
418 # define X509_STORE_get1_crls X509_STORE_CTX_get1_crls
419 /* the following macro is misspelled; use X509_STORE_get1_certs instead */
420 # define X509_STORE_get1_cert X509_STORE_CTX_get1_certs
421 /* the following macro is misspelled; use X509_STORE_get1_crls instead */
422 # define X509_STORE_get1_crl X509_STORE_CTX_get1_crls
423 #endif
424
425 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
426 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
427 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
428 X509_LOOKUP_METHOD *X509_LOOKUP_store(void);
429
430 typedef int (*X509_LOOKUP_ctrl_fn)(X509_LOOKUP *ctx, int cmd, const char *argc,
431                                    long argl, char **ret);
432 typedef int (*X509_LOOKUP_ctrl_with_libctx_fn)(
433     X509_LOOKUP *ctx, int cmd, const char *argc, long argl, char **ret,
434     OPENSSL_CTX *libctx, const char *propq);
435
436 typedef int (*X509_LOOKUP_get_by_subject_fn)(X509_LOOKUP *ctx,
437                                              X509_LOOKUP_TYPE type,
438                                              const X509_NAME *name,
439                                              X509_OBJECT *ret);
440 typedef int (*X509_LOOKUP_get_by_subject_with_libctx_fn)(X509_LOOKUP *ctx,
441                                                          X509_LOOKUP_TYPE type,
442                                                          const X509_NAME *name,
443                                                          X509_OBJECT *ret,
444                                                          OPENSSL_CTX *libctx,
445                                                          const char *propq);
446 typedef int (*X509_LOOKUP_get_by_issuer_serial_fn)(X509_LOOKUP *ctx,
447                                                    X509_LOOKUP_TYPE type,
448                                                    const X509_NAME *name,
449                                                    const ASN1_INTEGER *serial,
450                                                    X509_OBJECT *ret);
451 typedef int (*X509_LOOKUP_get_by_fingerprint_fn)(X509_LOOKUP *ctx,
452                                                  X509_LOOKUP_TYPE type,
453                                                  const unsigned char* bytes,
454                                                  int len,
455                                                  X509_OBJECT *ret);
456 typedef int (*X509_LOOKUP_get_by_alias_fn)(X509_LOOKUP *ctx,
457                                            X509_LOOKUP_TYPE type,
458                                            const char *str,
459                                            int len,
460                                            X509_OBJECT *ret);
461
462 X509_LOOKUP_METHOD *X509_LOOKUP_meth_new(const char *name);
463 void X509_LOOKUP_meth_free(X509_LOOKUP_METHOD *method);
464
465 int X509_LOOKUP_meth_set_new_item(X509_LOOKUP_METHOD *method,
466                                   int (*new_item) (X509_LOOKUP *ctx));
467 int (*X509_LOOKUP_meth_get_new_item(const X509_LOOKUP_METHOD* method))
468     (X509_LOOKUP *ctx);
469
470 int X509_LOOKUP_meth_set_free(X509_LOOKUP_METHOD *method,
471                               void (*free_fn) (X509_LOOKUP *ctx));
472 void (*X509_LOOKUP_meth_get_free(const X509_LOOKUP_METHOD* method))
473     (X509_LOOKUP *ctx);
474
475 int X509_LOOKUP_meth_set_init(X509_LOOKUP_METHOD *method,
476                               int (*init) (X509_LOOKUP *ctx));
477 int (*X509_LOOKUP_meth_get_init(const X509_LOOKUP_METHOD* method))
478     (X509_LOOKUP *ctx);
479
480 int X509_LOOKUP_meth_set_shutdown(X509_LOOKUP_METHOD *method,
481                                   int (*shutdown) (X509_LOOKUP *ctx));
482 int (*X509_LOOKUP_meth_get_shutdown(const X509_LOOKUP_METHOD* method))
483     (X509_LOOKUP *ctx);
484
485 int X509_LOOKUP_meth_set_ctrl(X509_LOOKUP_METHOD *method,
486                               X509_LOOKUP_ctrl_fn ctrl_fn);
487 X509_LOOKUP_ctrl_fn X509_LOOKUP_meth_get_ctrl(const X509_LOOKUP_METHOD *method);
488
489 int X509_LOOKUP_meth_set_get_by_subject(X509_LOOKUP_METHOD *method,
490                                         X509_LOOKUP_get_by_subject_fn fn);
491 X509_LOOKUP_get_by_subject_fn X509_LOOKUP_meth_get_get_by_subject(
492     const X509_LOOKUP_METHOD *method);
493
494 int X509_LOOKUP_meth_set_get_by_issuer_serial(X509_LOOKUP_METHOD *method,
495     X509_LOOKUP_get_by_issuer_serial_fn fn);
496 X509_LOOKUP_get_by_issuer_serial_fn X509_LOOKUP_meth_get_get_by_issuer_serial(
497     const X509_LOOKUP_METHOD *method);
498
499 int X509_LOOKUP_meth_set_get_by_fingerprint(X509_LOOKUP_METHOD *method,
500     X509_LOOKUP_get_by_fingerprint_fn fn);
501 X509_LOOKUP_get_by_fingerprint_fn X509_LOOKUP_meth_get_get_by_fingerprint(
502     const X509_LOOKUP_METHOD *method);
503
504 int X509_LOOKUP_meth_set_get_by_alias(X509_LOOKUP_METHOD *method,
505                                       X509_LOOKUP_get_by_alias_fn fn);
506 X509_LOOKUP_get_by_alias_fn X509_LOOKUP_meth_get_get_by_alias(
507     const X509_LOOKUP_METHOD *method);
508
509
510 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
511 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
512
513 int X509_STORE_CTX_get_by_subject(const X509_STORE_CTX *vs,
514                                   X509_LOOKUP_TYPE type,
515                                   const X509_NAME *name, X509_OBJECT *ret);
516 X509_OBJECT *X509_STORE_CTX_get_obj_by_subject(X509_STORE_CTX *vs,
517                                                X509_LOOKUP_TYPE type,
518                                                const X509_NAME *name);
519
520 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
521                      long argl, char **ret);
522 int X509_LOOKUP_ctrl_with_libctx(X509_LOOKUP *ctx, int cmd, const char *argc,
523                                  long argl, char **ret,
524                                  OPENSSL_CTX *libctx, const char *propq);
525
526 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
527 int X509_load_cert_file_with_libctx(X509_LOOKUP *ctx, const char *file, int type,
528                                     OPENSSL_CTX *libctx, const char *propq);
529 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
530 int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type);
531 int X509_load_cert_crl_file_with_libctx(X509_LOOKUP *ctx, const char *file,
532                                         int type, OPENSSL_CTX *libctx,
533                                         const char *propq);
534
535 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
536 void X509_LOOKUP_free(X509_LOOKUP *ctx);
537 int X509_LOOKUP_init(X509_LOOKUP *ctx);
538 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
539                            const X509_NAME *name, X509_OBJECT *ret);
540 int X509_LOOKUP_by_subject_with_libctx(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
541                                        const X509_NAME *name, X509_OBJECT *ret,
542                                        OPENSSL_CTX *libctx, const char *propq);
543 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
544                                  const X509_NAME *name,
545                                  const ASN1_INTEGER *serial,
546                                  X509_OBJECT *ret);
547 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
548                                const unsigned char *bytes, int len,
549                                X509_OBJECT *ret);
550 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
551                          const char *str, int len, X509_OBJECT *ret);
552 int X509_LOOKUP_set_method_data(X509_LOOKUP *ctx, void *data);
553 void *X509_LOOKUP_get_method_data(const X509_LOOKUP *ctx);
554 X509_STORE *X509_LOOKUP_get_store(const X509_LOOKUP *ctx);
555 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
556
557 int X509_STORE_load_file(X509_STORE *ctx, const char *file);
558 int X509_STORE_load_path(X509_STORE *ctx, const char *path);
559 int X509_STORE_load_store(X509_STORE *ctx, const char *store);
560 int X509_STORE_load_locations(X509_STORE *ctx,
561                                                const char *file,
562                                                const char *dir);
563 int X509_STORE_set_default_paths(X509_STORE *ctx);
564
565 int X509_STORE_load_file_with_libctx(X509_STORE *ctx, const char *file,
566                                      OPENSSL_CTX *libctx, const char *propq);
567 int X509_STORE_load_store_with_libctx(X509_STORE *ctx, const char *store,
568                                       OPENSSL_CTX *libctx, const char *propq);
569 int X509_STORE_load_locations_with_libctx(X509_STORE *ctx,
570                                           const char *file, const char *dir,
571                                           OPENSSL_CTX *libctx, const char *propq);
572 int X509_STORE_set_default_paths_with_libctx(X509_STORE *ctx,
573                                              OPENSSL_CTX *libctx,
574                                              const char *propq);
575
576 #define X509_STORE_CTX_get_ex_new_index(l, p, newf, dupf, freef) \
577     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_X509_STORE_CTX, l, p, newf, dupf, freef)
578 int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx, int idx, void *data);
579 void *X509_STORE_CTX_get_ex_data(const X509_STORE_CTX *ctx, int idx);
580 int X509_STORE_CTX_get_error(const X509_STORE_CTX *ctx);
581 void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx, int s);
582 int X509_STORE_CTX_get_error_depth(const X509_STORE_CTX *ctx);
583 void X509_STORE_CTX_set_error_depth(X509_STORE_CTX *ctx, int depth);
584 X509 *X509_STORE_CTX_get_current_cert(const X509_STORE_CTX *ctx);
585 void X509_STORE_CTX_set_current_cert(X509_STORE_CTX *ctx, X509 *x);
586 X509 *X509_STORE_CTX_get0_current_issuer(const X509_STORE_CTX *ctx);
587 X509_CRL *X509_STORE_CTX_get0_current_crl(const X509_STORE_CTX *ctx);
588 X509_STORE_CTX *X509_STORE_CTX_get0_parent_ctx(const X509_STORE_CTX *ctx);
589 STACK_OF(X509) *X509_STORE_CTX_get0_chain(const X509_STORE_CTX *ctx);
590 STACK_OF(X509) *X509_STORE_CTX_get1_chain(const X509_STORE_CTX *ctx);
591 void X509_STORE_CTX_set_cert(X509_STORE_CTX *c, X509 *x);
592 void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *c, STACK_OF(X509) *sk);
593 void X509_STORE_CTX_set0_crls(X509_STORE_CTX *c, STACK_OF(X509_CRL) *sk);
594 int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
595 int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
596 int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
597                                    int purpose, int trust);
598 void X509_STORE_CTX_set_flags(X509_STORE_CTX *ctx, unsigned long flags);
599 void X509_STORE_CTX_set_time(X509_STORE_CTX *ctx, unsigned long flags,
600                              time_t t);
601
602 X509_POLICY_TREE *X509_STORE_CTX_get0_policy_tree(const X509_STORE_CTX *ctx);
603 int X509_STORE_CTX_get_explicit_policy(const X509_STORE_CTX *ctx);
604 int X509_STORE_CTX_get_num_untrusted(const X509_STORE_CTX *ctx);
605
606 X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(const X509_STORE_CTX *ctx);
607 void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
608 int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
609
610 /*
611  * Bridge opacity barrier between libcrypt and libssl, also needed to support
612  * offline testing in test/danetest.c
613  */
614 void X509_STORE_CTX_set0_dane(X509_STORE_CTX *ctx, SSL_DANE *dane);
615 #define DANE_FLAG_NO_DANE_EE_NAMECHECKS (1L << 0)
616
617 /* X509_VERIFY_PARAM functions */
618
619 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void);
620 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param);
621 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *to,
622                               const X509_VERIFY_PARAM *from);
623 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
624                            const X509_VERIFY_PARAM *from);
625 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name);
626 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param,
627                                 unsigned long flags);
628 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
629                                   unsigned long flags);
630 unsigned long X509_VERIFY_PARAM_get_flags(const X509_VERIFY_PARAM *param);
631 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose);
632 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust);
633 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth);
634 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level);
635 time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM *param);
636 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t);
637 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
638                                   ASN1_OBJECT *policy);
639 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
640                                     STACK_OF(ASN1_OBJECT) *policies);
641
642 int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM *param,
643                                     uint32_t flags);
644 uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM *param);
645
646 char *X509_VERIFY_PARAM_get0_host(X509_VERIFY_PARAM *param, int idx);
647 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
648                                 const char *name, size_t namelen);
649 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
650                                 const char *name, size_t namelen);
651 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
652                                      unsigned int flags);
653 unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param);
654 char *X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM *param);
655 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *, X509_VERIFY_PARAM *);
656 char *X509_VERIFY_PARAM_get0_email(X509_VERIFY_PARAM *param);
657 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
658                                  const char *email, size_t emaillen);
659 char *X509_VERIFY_PARAM_get1_ip_asc(X509_VERIFY_PARAM *param);
660 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
661                               const unsigned char *ip, size_t iplen);
662 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param,
663                                   const char *ipasc);
664
665 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param);
666 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param);
667 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param);
668
669 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param);
670 int X509_VERIFY_PARAM_get_count(void);
671 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id);
672 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name);
673 void X509_VERIFY_PARAM_table_cleanup(void);
674
675 /* Non positive return values are errors */
676 #define X509_PCY_TREE_FAILURE  -2 /* Failure to satisfy explicit policy */
677 #define X509_PCY_TREE_INVALID  -1 /* Inconsistent or invalid extensions */
678 #define X509_PCY_TREE_INTERNAL  0 /* Internal error, most likely malloc */
679
680 /*
681  * Positive return values form a bit mask, all but the first are internal to
682  * the library and don't appear in results from X509_policy_check().
683  */
684 #define X509_PCY_TREE_VALID     1 /* The policy tree is valid */
685 #define X509_PCY_TREE_EMPTY     2 /* The policy tree is empty */
686 #define X509_PCY_TREE_EXPLICIT  4 /* Explicit policy required */
687
688 int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy,
689                       STACK_OF(X509) *certs,
690                       STACK_OF(ASN1_OBJECT) *policy_oids, unsigned int flags);
691
692 void X509_policy_tree_free(X509_POLICY_TREE *tree);
693
694 int X509_policy_tree_level_count(const X509_POLICY_TREE *tree);
695 X509_POLICY_LEVEL *X509_policy_tree_get0_level(const X509_POLICY_TREE *tree,
696                                                int i);
697
698 STACK_OF(X509_POLICY_NODE)
699     *X509_policy_tree_get0_policies(const X509_POLICY_TREE *tree);
700
701 STACK_OF(X509_POLICY_NODE)
702     *X509_policy_tree_get0_user_policies(const X509_POLICY_TREE *tree);
703
704 int X509_policy_level_node_count(X509_POLICY_LEVEL *level);
705
706 X509_POLICY_NODE *X509_policy_level_get0_node(const X509_POLICY_LEVEL *level,
707                                               int i);
708
709 const ASN1_OBJECT *X509_policy_node_get0_policy(const X509_POLICY_NODE *node);
710
711 STACK_OF(POLICYQUALINFO)
712     *X509_policy_node_get0_qualifiers(const X509_POLICY_NODE *node);
713 const X509_POLICY_NODE
714     *X509_policy_node_get0_parent(const X509_POLICY_NODE *node);
715
716 #ifdef  __cplusplus
717 }
718 #endif
719 #endif