1 /* crypto/x509/x509_vfy.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
60 #include <openssl/x509.h>
61 /* openssl/x509.h ends up #include-ing this file at about the only
62 * appropriate moment. */
65 #ifndef HEADER_X509_VFY_H
66 #define HEADER_X509_VFY_H
69 #include <openssl/lhash.h>
71 #include <openssl/bio.h>
72 #include <openssl/crypto.h>
79 typedef struct x509_hash_dir_st
87 typedef struct x509_file_st
89 int num_paths; /* number of paths to files or directories */
91 char **paths; /* the list of paths or directories */
95 /*******************************/
103 SSL -> X509_STORE_CTX
106 The X509_STORE holds the tables etc for verification stuff.
107 A X509_STORE_CTX is used while validating a single certificate.
108 The X509_STORE has X509_LOOKUPs for looking up certs.
109 The X509_STORE then calls a function to actually verify the
113 #define X509_LU_RETRY -1
114 #define X509_LU_FAIL 0
115 #define X509_LU_X509 1
116 #define X509_LU_CRL 2
117 #define X509_LU_PKEY 3
119 typedef struct x509_object_st
121 /* one of the above types */
131 typedef struct x509_lookup_st X509_LOOKUP;
133 DECLARE_STACK_OF(X509_LOOKUP)
134 /* This block of defines is updated by a perl script, please do not touch! */
135 #ifndef DEBUG_SAFESTACK
136 #define sk_X509_LOOKUP_new(a) sk_new((int (*) \
137 (const char * const *, const char * const *))(a))
138 #define sk_X509_LOOKUP_new_null() sk_new_null()
139 #define sk_X509_LOOKUP_free(a) sk_free(a)
140 #define sk_X509_LOOKUP_num(a) sk_num(a)
141 #define sk_X509_LOOKUP_value(a,b) ((X509_LOOKUP *) \
143 #define sk_X509_LOOKUP_set(a,b,c) ((X509_LOOKUP *) \
144 sk_set((a),(b),(char *)(c)))
145 #define sk_X509_LOOKUP_zero(a) sk_zero(a)
146 #define sk_X509_LOOKUP_push(a,b) sk_push((a),(char *)(b))
147 #define sk_X509_LOOKUP_unshift(a,b) sk_unshift((a),(b))
148 #define sk_X509_LOOKUP_find(a,b) sk_find((a), (char *)(b))
149 #define sk_X509_LOOKUP_delete(a,b) ((X509_LOOKUP *) \
151 #define sk_X509_LOOKUP_delete_ptr(a,b) ((X509_LOOKUP *) \
152 sk_delete_ptr((a),(char *)(b)))
153 #define sk_X509_LOOKUP_insert(a,b,c) sk_insert((a),(char *)(b),(c))
154 #define sk_X509_LOOKUP_set_cmp_func(a,b) ((int (*) \
155 (const X509_LOOKUP * const *,const X509_LOOKUP * const *)) \
156 sk_set_cmp_func((a),(int (*) \
157 (const char * const *, const char * const *))(b)))
158 #define sk_X509_LOOKUP_dup(a) sk_dup(a)
159 #define sk_X509_LOOKUP_pop_free(a,b) sk_pop_free((a),(void (*)(void *))(b))
160 #define sk_X509_LOOKUP_shift(a) ((X509_LOOKUP *)sk_shift(a))
161 #define sk_X509_LOOKUP_pop(a) ((X509_LOOKUP *)sk_pop(a))
162 #define sk_X509_LOOKUP_sort(a) sk_sort(a)
163 #endif /* !DEBUG_SAFESTACK */
164 /* End of perl script block, you may now edit :-) */
166 /* This is a static that defines the function interface */
167 typedef struct x509_lookup_method_st
170 int (*new_item)(X509_LOOKUP *ctx);
171 void (*free)(X509_LOOKUP *ctx);
172 int (*init)(X509_LOOKUP *ctx);
173 int (*shutdown)(X509_LOOKUP *ctx);
174 int (*ctrl)(X509_LOOKUP *ctx,int cmd,const char *argc,long argl,
176 int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
178 int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
179 ASN1_INTEGER *serial,X509_OBJECT *ret);
180 int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
181 unsigned char *bytes,int len,
183 int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
185 } X509_LOOKUP_METHOD;
187 typedef struct x509_store_state_st X509_STORE_CTX;
189 /* This is used to hold everything. It is used for all certificate
190 * validation. Once we have a certificate chain, the 'verify'
191 * function is then called to actually check the cert chain. */
192 typedef struct x509_store_st
194 /* The following is a cache of trusted certs */
195 int cache; /* if true, stash any hits */
197 LHASH *certs; /* cached certs; */
202 /* These are external lookup methods */
203 STACK_OF(X509_LOOKUP) *get_cert_methods;
204 int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */
205 int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */
207 CRYPTO_EX_DATA ex_data;
209 int depth; /* how deep to look (still unused -- X509_STORE_CTX's depth is used) */
212 #define X509_STORE_set_depth(ctx,d) ((ctx)->depth=(d))
214 #define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
215 #define X509_STORE_set_verify_func(ctx,func) ((ctx)->verify=(func))
217 /* This is the functions plus an instance of the local variables. */
218 struct x509_lookup_st
220 int init; /* have we been started */
221 int skip; /* don't use us. */
222 X509_LOOKUP_METHOD *method; /* the functions */
223 char *method_data; /* method data */
225 X509_STORE *store_ctx; /* who owns us */
228 /* This is a temporary used when processing cert chains. Since the
229 * gathering of the cert chain can take some time (and have to be
230 * 'retried', this needs to be kept and passed around. */
231 struct x509_store_state_st /* X509_STORE_CTX */
234 int current_method; /* used when looking up certs */
236 /* The following are set by the caller */
237 X509 *cert; /* The cert to check */
238 STACK_OF(X509) *untrusted; /* chain of X509s - untrusted - passed in */
239 int purpose; /* purpose to check untrusted certificates */
240 int trust; /* trust setting to check */
242 /* The following is built up */
243 int depth; /* how far to go looking up certs */
244 int valid; /* if 0, rebuild chain */
245 int last_untrusted; /* index of last untrusted cert */
246 STACK_OF(X509) *chain; /* chain of X509s - built up and trusted */
248 /* When something goes wrong, this is why */
253 CRYPTO_EX_DATA ex_data;
256 #define X509_STORE_CTX_set_depth(ctx,d) ((ctx)->depth=(d))
258 #define X509_STORE_CTX_set_app_data(ctx,data) \
259 X509_STORE_CTX_set_ex_data(ctx,0,data)
260 #define X509_STORE_CTX_get_app_data(ctx) \
261 X509_STORE_CTX_get_ex_data(ctx,0)
263 #define X509_L_FILE_LOAD 1
264 #define X509_L_ADD_DIR 2
266 #define X509_LOOKUP_load_file(x,name,type) \
267 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
269 #define X509_LOOKUP_add_dir(x,name,type) \
270 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
273 /* illegal error (for uninitialized values, to avoid X509_V_OK): 1 */
275 #define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT 2
276 #define X509_V_ERR_UNABLE_TO_GET_CRL 3
277 #define X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE 4
278 #define X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE 5
279 #define X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY 6
280 #define X509_V_ERR_CERT_SIGNATURE_FAILURE 7
281 #define X509_V_ERR_CRL_SIGNATURE_FAILURE 8
282 #define X509_V_ERR_CERT_NOT_YET_VALID 9
283 #define X509_V_ERR_CERT_HAS_EXPIRED 10
284 #define X509_V_ERR_CRL_NOT_YET_VALID 11
285 #define X509_V_ERR_CRL_HAS_EXPIRED 12
286 #define X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD 13
287 #define X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD 14
288 #define X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD 15
289 #define X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD 16
290 #define X509_V_ERR_OUT_OF_MEM 17
291 #define X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT 18
292 #define X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN 19
293 #define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY 20
294 #define X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE 21
295 #define X509_V_ERR_CERT_CHAIN_TOO_LONG 22
296 #define X509_V_ERR_CERT_REVOKED 23
297 #define X509_V_ERR_INVALID_CA 24
298 #define X509_V_ERR_PATH_LENGTH_EXCEEDED 25
299 #define X509_V_ERR_INVALID_PURPOSE 26
300 #define X509_V_ERR_CERT_UNTRUSTED 27
301 #define X509_V_ERR_CERT_REJECTED 28
303 /* The application is not happy */
304 #define X509_V_ERR_APPLICATION_VERIFICATION 50
306 /* These functions are being redefined in another directory,
307 and clash when the linker is case-insensitive, so let's
308 hide them a little, by giving them an extra 'o' at the
309 beginning of the name... */
311 #undef X509v3_cleanup_extensions
312 #define X509v3_cleanup_extensions oX509v3_cleanup_extensions
313 #undef X509v3_add_extension
314 #define X509v3_add_extension oX509v3_add_extension
315 #undef X509v3_add_netscape_extensions
316 #define X509v3_add_netscape_extensions oX509v3_add_netscape_extensions
317 #undef X509v3_add_standard_extensions
318 #define X509v3_add_standard_extensions oX509v3_add_standard_extensions
322 X509_OBJECT *X509_OBJECT_retrieve_by_subject(LHASH *h,int type,X509_NAME *name);
324 void X509_OBJECT_up_ref_count(X509_OBJECT *a);
325 void X509_OBJECT_free_contents(X509_OBJECT *a);
326 X509_STORE *X509_STORE_new(void );
327 void X509_STORE_free(X509_STORE *v);
329 X509_STORE_CTX *X509_STORE_CTX_new(void);
330 void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
331 void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
332 X509 *x509, STACK_OF(X509) *chain);
333 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
335 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
337 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
338 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
340 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
341 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
343 int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
346 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
347 long argl, char **ret);
350 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
351 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
352 int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type);
356 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
357 void X509_LOOKUP_free(X509_LOOKUP *ctx);
358 int X509_LOOKUP_init(X509_LOOKUP *ctx);
359 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
361 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
362 ASN1_INTEGER *serial, X509_OBJECT *ret);
363 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
364 unsigned char *bytes, int len, X509_OBJECT *ret);
365 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
366 int len, X509_OBJECT *ret);
367 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
370 int X509_STORE_load_locations (X509_STORE *ctx,
371 const char *file, const char *dir);
372 int X509_STORE_set_default_paths(X509_STORE *ctx);
375 int X509_STORE_CTX_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
376 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
377 int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data);
378 void * X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
379 int X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
380 void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
381 int X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
382 X509 * X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
383 STACK_OF(X509) *X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
384 STACK_OF(X509) *X509_STORE_CTX_get1_chain(X509_STORE_CTX *ctx);
385 void X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
386 void X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk);
387 int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
388 int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
389 int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
390 int purpose, int trust);