1f89bf02255092b1dab1295577ef260bbbb34537
[openssl.git] / crypto / x509 / x509_vfy.h
1 /* crypto/x509/x509_vfy.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
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.
8  * 
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).
15  * 
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.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
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)"
40  * 
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
51  * SUCH DAMAGE.
52  * 
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.]
57  */
58
59 #ifndef HEADER_X509_H
60 #include <openssl/x509.h>
61 /* openssl/x509.h ends up #include-ing this file at about the only
62  * appropriate moment. */
63 #endif
64
65 #ifndef HEADER_X509_VFY_H
66 #define HEADER_X509_VFY_H
67
68 #ifdef  __cplusplus
69 extern "C" {
70 #endif
71
72 #include <openssl/bio.h>
73 #include <openssl/crypto.h>
74
75 /* Outer object */
76 typedef struct x509_hash_dir_st
77         {
78         int num_dirs;
79         char **dirs;
80         int *dirs_type;
81         int num_dirs_alloced;
82         } X509_HASH_DIR_CTX;
83
84 typedef struct x509_file_st
85         {
86         int num_paths;  /* number of paths to files or directories */
87         int num_alloced;
88         char **paths;   /* the list of paths or directories */
89         int *path_type;
90         } X509_CERT_FILE_CTX;
91
92 /*******************************/
93 /*
94 SSL_CTX -> X509_STORE    
95                 -> X509_LOOKUP
96                         ->X509_LOOKUP_METHOD
97                 -> X509_LOOKUP
98                         ->X509_LOOKUP_METHOD
99  
100 SSL     -> X509_STORE_CTX
101                 ->X509_STORE    
102
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
107 certificate chain.
108 */
109
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
115
116 typedef struct x509_object_st
117         {
118         /* one of the above types */
119         int type;
120         union   {
121                 char *ptr;
122                 X509 *x509;
123                 X509_CRL *crl;
124                 EVP_PKEY *pkey;
125                 } data;
126         } X509_OBJECT;
127
128 typedef struct x509_lookup_st X509_LOOKUP;
129
130 /* This is a static that defines the function interface */
131 typedef struct x509_lookup_method_st
132         {
133         const char *name;
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,char *argc,long argl,char **ret);
139         int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
140                               X509_OBJECT *ret);
141         int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
142                                     ASN1_INTEGER *serial,X509_OBJECT *ret);
143         int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
144                                   unsigned char *bytes,int len,
145                                   X509_OBJECT *ret);
146         int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
147                             X509_OBJECT *ret);
148         } X509_LOOKUP_METHOD;
149
150 typedef struct x509_store_state_st X509_STORE_CTX;
151
152 /* This is used to hold everything.  It is used for all certificate
153  * validation.  Once we have a certificate chain, the 'verify'
154  * function is then called to actually check the cert chain. */
155 typedef struct x509_store_st
156         {
157         /* The following is a cache of trusted certs */
158         int cache;      /* if true, stash any hits */
159 #ifdef HEADER_LHASH_H
160         LHASH *certs;   /* cached certs; */ 
161 #else
162         char *certs;
163 #endif
164
165         /* These are external lookup methods */
166         STACK *get_cert_methods;/* X509_LOOKUP */
167         int (*verify)(X509_STORE_CTX *ctx);     /* called to verify a certificate */
168         int (*verify_cb)(int ok,X509_STORE_CTX *ctx);   /* error callback */
169
170         CRYPTO_EX_DATA ex_data;
171         int references;
172         int depth;              /* how deep to look (still unused -- X509_STORE_CTX's depth is used) */
173         }  X509_STORE;
174
175 #define X509_STORE_set_depth(ctx,d)       ((ctx)->depth=(d))
176
177 #define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
178 #define X509_STORE_set_verify_func(ctx,func)    ((ctx)->verify=(func))
179
180 /* This is the functions plus an instance of the local variables. */
181 struct x509_lookup_st
182         {
183         int init;                       /* have we been started */
184         int skip;                       /* don't use us. */
185         X509_LOOKUP_METHOD *method;     /* the functions */
186         char *method_data;              /* method data */
187
188         X509_STORE *store_ctx;  /* who owns us */
189         };
190
191 /* This is a temporary used when processing cert chains.  Since the
192  * gathering of the cert chain can take some time (and have to be
193  * 'retried', this needs to be kept and passed around. */
194 struct x509_store_state_st      /* X509_STORE_CTX */
195         {
196         X509_STORE *ctx;
197         int current_method;     /* used when looking up certs */
198
199         /* The following are set by the caller */
200         X509 *cert;             /* The cert to check */
201         STACK_OF(X509) *untrusted;      /* chain of X509s - untrusted - passed in */
202
203         /* The following is built up */
204         int depth;              /* how far to go looking up certs */
205         int valid;              /* if 0, rebuild chain */
206         int last_untrusted;     /* index of last untrusted cert */
207         STACK *chain;           /* chain of X509s - built up and trusted */
208
209         /* When something goes wrong, this is why */
210         int error_depth;
211         int error;
212         X509 *current_cert;
213
214         CRYPTO_EX_DATA ex_data;
215         };
216
217 #define X509_STORE_CTX_set_depth(ctx,d)       ((ctx)->depth=(d))
218
219 #define X509_STORE_CTX_set_app_data(ctx,data) \
220         X509_STORE_CTX_set_ex_data(ctx,0,data)
221 #define X509_STORE_CTX_get_app_data(ctx) \
222         X509_STORE_CTX_get_ex_data(ctx,0)
223
224 #define X509_L_FILE_LOAD        1
225 #define X509_L_ADD_DIR          2
226
227 #define X509_LOOKUP_load_file(x,name,type) \
228                 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
229
230 #define X509_LOOKUP_add_dir(x,name,type) \
231                 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
232
233 #define         X509_V_OK                                       0
234
235 #define         X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT            2
236 #define         X509_V_ERR_UNABLE_TO_GET_CRL                    3
237 #define         X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE     4
238 #define         X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE      5
239 #define         X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY   6
240 #define         X509_V_ERR_CERT_SIGNATURE_FAILURE               7
241 #define         X509_V_ERR_CRL_SIGNATURE_FAILURE                8
242 #define         X509_V_ERR_CERT_NOT_YET_VALID                   9       
243 #define         X509_V_ERR_CERT_HAS_EXPIRED                     10
244 #define         X509_V_ERR_CRL_NOT_YET_VALID                    11
245 #define         X509_V_ERR_CRL_HAS_EXPIRED                      12
246 #define         X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD       13
247 #define         X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD        14
248 #define         X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD       15
249 #define         X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD       16
250 #define         X509_V_ERR_OUT_OF_MEM                           17
251 #define         X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT          18
252 #define         X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN            19
253 #define         X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY    20
254 #define         X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE      21
255 #define         X509_V_ERR_CERT_CHAIN_TOO_LONG                  22
256 #define         X509_V_ERR_CERT_REVOKED                         23
257
258 /* The application is not happy */
259 #define         X509_V_ERR_APPLICATION_VERIFICATION             50
260
261 #ifdef HEADER_LHASH_H
262 X509_OBJECT *X509_OBJECT_retrieve_by_subject(LHASH *h,int type,X509_NAME *name);
263 #endif
264 void X509_OBJECT_up_ref_count(X509_OBJECT *a);
265 void X509_OBJECT_free_contents(X509_OBJECT *a);
266 X509_STORE *X509_STORE_new(void );
267 void X509_STORE_free(X509_STORE *v);
268
269 void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
270                          X509 *x509, STACK_OF(X509) *chain);
271 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
272
273 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
274
275 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
276 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
277
278 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
279 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
280
281 int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
282         X509_OBJECT *ret);
283
284 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx,int cmd,char *argc,long argl,char **ret);
285
286 #ifndef NO_STDIO
287 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
288 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
289 #endif
290
291
292 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
293 void X509_LOOKUP_free(X509_LOOKUP *ctx);
294 int X509_LOOKUP_init(X509_LOOKUP *ctx);
295 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
296         X509_OBJECT *ret);
297 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
298         ASN1_INTEGER *serial, X509_OBJECT *ret);
299 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
300         unsigned char *bytes, int len, X509_OBJECT *ret);
301 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
302         int len, X509_OBJECT *ret);
303 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
304
305 #ifndef NO_STDIO
306 int     X509_STORE_load_locations (X509_STORE *ctx,
307                 char *file, char *dir);
308 int     X509_STORE_set_default_paths(X509_STORE *ctx);
309 #endif
310
311 int X509_STORE_CTX_get_ex_new_index(long argl, char *argp, int (*new_func)(),
312         int (*dup_func)(), void (*free_func)());
313 int     X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data);
314 void *  X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
315 int     X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
316 void    X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
317 int     X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
318 X509 *  X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
319 STACK * X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
320 void    X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
321 void    X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk);
322
323 #ifdef  __cplusplus
324 }
325 #endif
326 #endif
327