03b40f2043aaf2ace45d565c78ed5f263ff7ec9b
[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_VFY_H
60 #define HEADER_X509_VFY_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 #include "bio.h"
67 #include "crypto.h"
68
69 /* Outer object */
70 typedef struct x509_hash_dir_st
71         {
72         int num_dirs;
73         char **dirs;
74         int *dirs_type;
75         int num_dirs_alloced;
76         } X509_HASH_DIR_CTX;
77
78 typedef struct x509_file_st
79         {
80         int num_paths;  /* number of paths to files or directories */
81         int num_alloced;
82         char **paths;   /* the list of paths or directories */
83         int *path_type;
84         } X509_CERT_FILE_CTX;
85
86 /*******************************/
87 /*
88 SSL_CTX -> X509_STORE    
89                 -> X509_LOOKUP
90                         ->X509_LOOKUP_METHOD
91                 -> X509_LOOKUP
92                         ->X509_LOOKUP_METHOD
93  
94 SSL     -> X509_STORE_CTX
95                 ->X509_STORE    
96
97 The X509_STORE holds the tables etc for verification stuff.
98 A X509_STORE_CTX is used while validating a single certificate.
99 The X509_STORE has X509_LOOKUPs for looking up certs.
100 The X509_STORE then calls a function to actually verify the
101 certificate chain.
102 */
103
104 #define X509_LU_RETRY           -1
105 #define X509_LU_FAIL            0
106 #define X509_LU_X509            1
107 #define X509_LU_CRL             2
108 #define X509_LU_PKEY            3
109
110 typedef struct x509_object_st
111         {
112         /* one of the above types */
113         int type;
114         union   {
115                 char *ptr;
116                 X509 *x509;
117                 X509_CRL *crl;
118                 EVP_PKEY *pkey;
119                 } data;
120         } X509_OBJECT;
121
122 typedef struct x509_lookup_st X509_LOOKUP;
123
124 /* This is a static that defines the function interface */
125 typedef struct x509_lookup_method_st
126         {
127         char *name;
128         int (*new_item)(X509_LOOKUP *ctx);
129         void (*free)(X509_LOOKUP *ctx);
130         int (*init)(X509_LOOKUP *ctx);
131         int (*shutdown)(X509_LOOKUP *ctx);
132         int (*ctrl)(X509_LOOKUP *ctx,int cmd,char *argc,long argl,char **ret);
133         int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
134                               X509_OBJECT *ret);
135         int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
136                                     ASN1_INTEGER *serial,X509_OBJECT *ret);
137         int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
138                                   unsigned char *bytes,int len,
139                                   X509_OBJECT *ret);
140         int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
141                             X509_OBJECT *ret);
142         } X509_LOOKUP_METHOD;
143
144 typedef struct x509_store_state_st X509_STORE_CTX;
145
146 /* This is used to hold everything.  It is used for all certificate
147  * validation.  Once we have a certificate chain, the 'verify'
148  * function is then called to actually check the cert chain. */
149 typedef struct x509_store_st
150         {
151         /* The following is a cache of trusted certs */
152         int cache;      /* if true, stash any hits */
153 #ifdef HEADER_LHASH_H
154         LHASH *certs;   /* cached certs; */ 
155 #else
156         char *certs;
157 #endif
158
159         /* These are external lookup methods */
160         STACK *get_cert_methods;/* X509_LOOKUP */
161         int (*verify)(X509_STORE_CTX *ctx);     /* called to verify a certificate */
162         int (*verify_cb)(int ok,X509_STORE_CTX *ctx);   /* error callback */
163
164         CRYPTO_EX_DATA ex_data;
165         int references;
166         int depth;              /* how deep to look (still unused) */
167         }  X509_STORE;
168
169 #define X509_STORE_set_depth(ctx,d)       ((ctx)->depth=(d))
170
171 #define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
172 #define X509_STORE_set_verify_func(ctx,func)    ((ctx)->verify=(func))
173
174 /* This is the functions plus an instance of the local variables. */
175 struct x509_lookup_st
176         {
177         int init;                       /* have we been started */
178         int skip;                       /* don't use us. */
179         X509_LOOKUP_METHOD *method;     /* the functions */
180         char *method_data;              /* method data */
181
182         X509_STORE *store_ctx;  /* who owns us */
183         };
184
185 /* This is a temporary used when processing cert chains.  Since the
186  * gathering of the cert chain can take some time (and have to be
187  * 'retried', this needs to be kept and passed around. */
188 struct x509_store_state_st
189         {
190         X509_STORE *ctx;
191         int current_method;     /* used when looking up certs */
192
193         /* The following are set by the caller */
194         X509 *cert;             /* The cert to check */
195         STACK *untrusted;       /* chain of X509s - untrusted - passed in */
196
197         /* The following is built up */
198         int depth;              /* how far to go looking up certs */
199         int valid;              /* if 0, rebuild chain */
200         int last_untrusted;     /* index of last untrusted cert */
201         STACK *chain;           /* chain of X509s - built up and trusted */
202
203         /* When something goes wrong, this is why */
204         int error_depth;
205         int error;
206         X509 *current_cert;
207
208         CRYPTO_EX_DATA ex_data;
209         };
210
211 #define X509_STORE_CTX_set_app_data(ctx,data) \
212         X509_STORE_CTX_set_ex_data(ctx,0,data)
213 #define X509_STORE_CTX_get_app_data(ctx) \
214         X509_STORE_CTX_get_ex_data(ctx,0)
215
216 #define X509_L_FILE_LOAD        1
217 #define X509_L_ADD_DIR          2
218
219 X509_LOOKUP_METHOD *X509_LOOKUP_file();
220 #define X509_LOOKUP_load_file(x,name,type) \
221                 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
222
223 X509_LOOKUP_METHOD *X509_LOOKUP_dir();
224 #define X509_LOOKUP_add_dir(x,name,type) \
225                 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
226
227 #define         X509_V_OK                                       0
228
229 #define         X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT            2
230 #define         X509_V_ERR_UNABLE_TO_GET_CRL                    3
231 #define         X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE     4
232 #define         X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE      5
233 #define         X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY   6
234 #define         X509_V_ERR_CERT_SIGNATURE_FAILURE               7
235 #define         X509_V_ERR_CRL_SIGNATURE_FAILURE                8
236 #define         X509_V_ERR_CERT_NOT_YET_VALID                   9       
237 #define         X509_V_ERR_CERT_HAS_EXPIRED                     10
238 #define         X509_V_ERR_CRL_NOT_YET_VALID                    11
239 #define         X509_V_ERR_CRL_HAS_EXPIRED                      12
240 #define         X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD       13
241 #define         X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD        14
242 #define         X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD       15
243 #define         X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD       16
244 #define         X509_V_ERR_OUT_OF_MEM                           17
245 #define         X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT          18
246 #define         X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN            19
247 #define         X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY    20
248 #define         X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE      21
249 #define         X509_V_ERR_CERT_CHAIN_TOO_LONG                  22
250 #define         X509_V_ERR_CERT_REVOKED                         23
251
252 /* The application is not happy */
253 #define         X509_V_ERR_APPLICATION_VERIFICATION             50
254
255 #ifndef NOPROTO
256 #ifdef HEADER_LHASH_H
257 X509_OBJECT *X509_OBJECT_retrieve_by_subject(LHASH *h,int type,X509_NAME *name);
258 #endif
259 void X509_OBJECT_up_ref_count(X509_OBJECT *a);
260 void X509_OBJECT_free_contents(X509_OBJECT *a);
261 X509_STORE *X509_STORE_new(void );
262 void X509_STORE_free(X509_STORE *v);
263
264 void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
265         X509 *x509, STACK *chain);
266 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
267
268 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
269
270 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
271 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
272
273 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
274 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
275
276 int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
277         X509_OBJECT *ret);
278
279 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx,int cmd,char *argc,long argl,char **ret);
280
281 #ifndef NO_STDIO
282 int X509_load_cert_file(X509_LOOKUP *ctx, char *file, int type);
283 int X509_load_crl_file(X509_LOOKUP *ctx, char *file, int type);
284 #endif
285
286 void X509v3_cleanup_extensions(void );
287 int X509v3_add_extension(X509_EXTENSION_METHOD *x);
288 int X509v3_add_netscape_extensions(void );
289 int X509v3_add_standard_extensions(void );
290
291 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
292 void X509_LOOKUP_free(X509_LOOKUP *ctx);
293 int X509_LOOKUP_init(X509_LOOKUP *ctx);
294 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
295         X509_OBJECT *ret);
296 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
297         ASN1_INTEGER *serial, X509_OBJECT *ret);
298 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
299         unsigned char *bytes, int len, X509_OBJECT *ret);
300 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
301         int len, X509_OBJECT *ret);
302 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
303
304 #ifndef NO_STDIO
305 int     X509_STORE_load_locations (X509_STORE *ctx,
306                 char *file, char *dir);
307 int     X509_STORE_set_default_paths(X509_STORE *ctx);
308 #endif
309
310 int X509_STORE_CTX_get_ex_new_index(long argl, char *argp, int (*new_func)(),
311         int (*dup_func)(), void (*free_func)());
312 int     X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,char *data);
313 char *  X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
314 int     X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
315 void    X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
316 int     X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
317 X509 *  X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
318 STACK * X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
319 void    X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
320 void    X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK /* X509 */ *sk);
321
322 #else
323
324 #ifdef HEADER_LHASH_H
325 X509_OBJECT *X509_OBJECT_retrieve_by_subject();
326 #endif
327 void X509_OBJECT_up_ref_count();
328 void X509_OBJECT_free_contents();
329 X509_STORE *X509_STORE_new();
330 void X509_STORE_free();
331
332 void X509_STORE_CTX_init();
333 void X509_STORE_CTX_cleanup();
334
335 X509_LOOKUP *X509_STORE_add_lookup();
336
337 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir();
338 X509_LOOKUP_METHOD *X509_LOOKUP_file();
339
340 int X509_STORE_add_cert();
341 int X509_STORE_add_crl();
342
343 int X509_STORE_get_by_subject();
344
345 int X509_LOOKUP_ctrl();
346
347 #ifndef NO_STDIO
348 int X509_load_cert_file();
349 int X509_load_crl_file();
350 #endif
351
352 void X509v3_cleanup_extensions();
353 int X509v3_add_extension();
354 int X509v3_add_netscape_extensions();
355 int X509v3_add_standard_extensions();
356
357 X509_LOOKUP *X509_LOOKUP_new();
358 void X509_LOOKUP_free();
359 int X509_LOOKUP_init();
360 int X509_LOOKUP_by_subject();
361 int X509_LOOKUP_by_issuer_serial();
362 int X509_LOOKUP_by_fingerprint();
363 int X509_LOOKUP_by_alias();
364 int X509_LOOKUP_shutdown();
365
366 #ifndef NO_STDIO
367 int     X509_STORE_load_locations ();
368 int     X509_STORE_set_default_paths();
369 #endif
370
371 int X509_STORE_CTX_get_ex_new_index();
372 int     X509_STORE_CTX_set_ex_data();
373 char *  X509_STORE_CTX_get_ex_data();
374 int     X509_STORE_CTX_get_error();
375 void    X509_STORE_CTX_set_error();
376 int     X509_STORE_CTX_get_error_depth();
377 X509 *  X509_STORE_CTX_get_current_cert();
378 STACK * X509_STORE_CTX_get_chain();
379 void    X509_STORE_CTX_set_cert();
380 void    X509_STORE_CTX_set_chain();
381
382 #endif
383
384 #ifdef  __cplusplus
385 }
386 #endif
387 #endif
388