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
72 #include <openssl/bio.h>
73 #include <openssl/crypto.h>
76 typedef struct x509_hash_dir_st
84 typedef struct x509_file_st
86 int num_paths; /* number of paths to files or directories */
88 char **paths; /* the list of paths or directories */
92 /*******************************/
100 SSL -> X509_STORE_CTX
103 The X509_STORE holds the tables etc for verification stuff.
104 A X509_STORE_CTX is used while validating a single certificate.
105 The X509_STORE has X509_LOOKUPs for looking up certs.
106 The X509_STORE then calls a function to actually verify the
110 #define X509_LU_RETRY -1
111 #define X509_LU_FAIL 0
112 #define X509_LU_X509 1
113 #define X509_LU_CRL 2
114 #define X509_LU_PKEY 3
116 typedef struct x509_object_st
118 /* one of the above types */
128 typedef struct x509_lookup_st X509_LOOKUP;
130 /* This is a static that defines the function interface */
131 typedef struct x509_lookup_method_st
134 int (*new_item)(X509_LOOKUP *ctx);
135 void (*free)(X509_LOOKUP *ctx);
136 int (*init)(X509_LOOKUP *ctx);
137 int (*shutdown)(X509_LOOKUP *ctx);
138 int (*ctrl)(X509_LOOKUP *ctx,int cmd,const char *argc,long argl,
140 int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
142 int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
143 ASN1_INTEGER *serial,X509_OBJECT *ret);
144 int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
145 unsigned char *bytes,int len,
147 int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
149 } X509_LOOKUP_METHOD;
151 typedef struct x509_store_state_st X509_STORE_CTX;
153 /* This is used to hold everything. It is used for all certificate
154 * validation. Once we have a certificate chain, the 'verify'
155 * function is then called to actually check the cert chain. */
156 typedef struct x509_store_st
158 /* The following is a cache of trusted certs */
159 int cache; /* if true, stash any hits */
160 #ifdef HEADER_LHASH_H
161 LHASH *certs; /* cached certs; */
166 /* These are external lookup methods */
167 STACK *get_cert_methods;/* X509_LOOKUP */
168 int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */
169 int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */
171 CRYPTO_EX_DATA ex_data;
173 int depth; /* how deep to look (still unused -- X509_STORE_CTX's depth is used) */
176 #define X509_STORE_set_depth(ctx,d) ((ctx)->depth=(d))
178 #define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
179 #define X509_STORE_set_verify_func(ctx,func) ((ctx)->verify=(func))
181 /* This is the functions plus an instance of the local variables. */
182 struct x509_lookup_st
184 int init; /* have we been started */
185 int skip; /* don't use us. */
186 X509_LOOKUP_METHOD *method; /* the functions */
187 char *method_data; /* method data */
189 X509_STORE *store_ctx; /* who owns us */
192 /* This is a temporary used when processing cert chains. Since the
193 * gathering of the cert chain can take some time (and have to be
194 * 'retried', this needs to be kept and passed around. */
195 struct x509_store_state_st /* X509_STORE_CTX */
198 int current_method; /* used when looking up certs */
200 /* The following are set by the caller */
201 X509 *cert; /* The cert to check */
202 STACK_OF(X509) *untrusted; /* chain of X509s - untrusted - passed in */
204 /* The following is built up */
205 int depth; /* how far to go looking up certs */
206 int valid; /* if 0, rebuild chain */
207 int last_untrusted; /* index of last untrusted cert */
208 STACK *chain; /* chain of X509s - built up and trusted */
210 /* When something goes wrong, this is why */
215 CRYPTO_EX_DATA ex_data;
218 #define X509_STORE_CTX_set_depth(ctx,d) ((ctx)->depth=(d))
220 #define X509_STORE_CTX_set_app_data(ctx,data) \
221 X509_STORE_CTX_set_ex_data(ctx,0,data)
222 #define X509_STORE_CTX_get_app_data(ctx) \
223 X509_STORE_CTX_get_ex_data(ctx,0)
225 #define X509_L_FILE_LOAD 1
226 #define X509_L_ADD_DIR 2
228 #define X509_LOOKUP_load_file(x,name,type) \
229 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
231 #define X509_LOOKUP_add_dir(x,name,type) \
232 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
236 #define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT 2
237 #define X509_V_ERR_UNABLE_TO_GET_CRL 3
238 #define X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE 4
239 #define X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE 5
240 #define X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY 6
241 #define X509_V_ERR_CERT_SIGNATURE_FAILURE 7
242 #define X509_V_ERR_CRL_SIGNATURE_FAILURE 8
243 #define X509_V_ERR_CERT_NOT_YET_VALID 9
244 #define X509_V_ERR_CERT_HAS_EXPIRED 10
245 #define X509_V_ERR_CRL_NOT_YET_VALID 11
246 #define X509_V_ERR_CRL_HAS_EXPIRED 12
247 #define X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD 13
248 #define X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD 14
249 #define X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD 15
250 #define X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD 16
251 #define X509_V_ERR_OUT_OF_MEM 17
252 #define X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT 18
253 #define X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN 19
254 #define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY 20
255 #define X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE 21
256 #define X509_V_ERR_CERT_CHAIN_TOO_LONG 22
257 #define X509_V_ERR_CERT_REVOKED 23
259 /* The application is not happy */
260 #define X509_V_ERR_APPLICATION_VERIFICATION 50
262 #ifdef HEADER_LHASH_H
263 X509_OBJECT *X509_OBJECT_retrieve_by_subject(LHASH *h,int type,X509_NAME *name);
265 void X509_OBJECT_up_ref_count(X509_OBJECT *a);
266 void X509_OBJECT_free_contents(X509_OBJECT *a);
267 X509_STORE *X509_STORE_new(void );
268 void X509_STORE_free(X509_STORE *v);
270 void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
271 X509 *x509, STACK_OF(X509) *chain);
272 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
274 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
276 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
277 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
279 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
280 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
282 int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
285 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
286 long argl, char **ret);
289 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
290 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
294 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
295 void X509_LOOKUP_free(X509_LOOKUP *ctx);
296 int X509_LOOKUP_init(X509_LOOKUP *ctx);
297 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
299 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
300 ASN1_INTEGER *serial, X509_OBJECT *ret);
301 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
302 unsigned char *bytes, int len, X509_OBJECT *ret);
303 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
304 int len, X509_OBJECT *ret);
305 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
308 int X509_STORE_load_locations (X509_STORE *ctx,
309 const char *file, const char *dir);
310 int X509_STORE_set_default_paths(X509_STORE *ctx);
313 int X509_STORE_CTX_get_ex_new_index(long argl, char *argp, int (*new_func)(),
314 int (*dup_func)(), void (*free_func)());
315 int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data);
316 void * X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
317 int X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
318 void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
319 int X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
320 X509 * X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
321 STACK * X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
322 void X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
323 void X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk);