e08075e85a5ca4ec622b66ac28db589874e8f77f
[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 #ifndef OPENSSL_NO_LHASH
69 #include <openssl/lhash.h>
70 #endif
71 #include <openssl/bio.h>
72 #include <openssl/crypto.h>
73 #include <openssl/symhacks.h>
74
75 #ifdef  __cplusplus
76 extern "C" {
77 #endif
78
79 /* Outer object */
80 typedef struct x509_hash_dir_st
81         {
82         int num_dirs;
83         char **dirs;
84         int *dirs_type;
85         int num_dirs_alloced;
86         } X509_HASH_DIR_CTX;
87
88 typedef struct x509_file_st
89         {
90         int num_paths;  /* number of paths to files or directories */
91         int num_alloced;
92         char **paths;   /* the list of paths or directories */
93         int *path_type;
94         } X509_CERT_FILE_CTX;
95
96 /*******************************/
97 /*
98 SSL_CTX -> X509_STORE    
99                 -> X509_LOOKUP
100                         ->X509_LOOKUP_METHOD
101                 -> X509_LOOKUP
102                         ->X509_LOOKUP_METHOD
103  
104 SSL     -> X509_STORE_CTX
105                 ->X509_STORE    
106
107 The X509_STORE holds the tables etc for verification stuff.
108 A X509_STORE_CTX is used while validating a single certificate.
109 The X509_STORE has X509_LOOKUPs for looking up certs.
110 The X509_STORE then calls a function to actually verify the
111 certificate chain.
112 */
113
114 #define X509_LU_RETRY           -1
115 #define X509_LU_FAIL            0
116 #define X509_LU_X509            1
117 #define X509_LU_CRL             2
118 #define X509_LU_PKEY            3
119
120 typedef struct x509_object_st
121         {
122         /* one of the above types */
123         int type;
124         union   {
125                 char *ptr;
126                 X509 *x509;
127                 X509_CRL *crl;
128                 EVP_PKEY *pkey;
129                 } data;
130         } X509_OBJECT;
131
132 typedef struct x509_lookup_st X509_LOOKUP;
133
134 DECLARE_STACK_OF(X509_LOOKUP)
135 DECLARE_STACK_OF(X509_OBJECT)
136
137 /* This is a static that defines the function interface */
138 typedef struct x509_lookup_method_st
139         {
140         const char *name;
141         int (*new_item)(X509_LOOKUP *ctx);
142         void (*free)(X509_LOOKUP *ctx);
143         int (*init)(X509_LOOKUP *ctx);
144         int (*shutdown)(X509_LOOKUP *ctx);
145         int (*ctrl)(X509_LOOKUP *ctx,int cmd,const char *argc,long argl,
146                         char **ret);
147         int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
148                               X509_OBJECT *ret);
149         int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
150                                     ASN1_INTEGER *serial,X509_OBJECT *ret);
151         int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
152                                   unsigned char *bytes,int len,
153                                   X509_OBJECT *ret);
154         int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
155                             X509_OBJECT *ret);
156         } X509_LOOKUP_METHOD;
157
158 typedef struct x509_store_ctx_st X509_STORE_CTX;
159
160 /* This is used to hold everything.  It is used for all certificate
161  * validation.  Once we have a certificate chain, the 'verify'
162  * function is then called to actually check the cert chain. */
163 typedef struct x509_store_st
164         {
165         /* The following is a cache of trusted certs */
166         int cache;      /* if true, stash any hits */
167         STACK_OF(X509_OBJECT) *objs;    /* Cache of all objects */
168
169         /* These are external lookup methods */
170         STACK_OF(X509_LOOKUP) *get_cert_methods;
171
172         /* The following fields are not used by X509_STORE but are
173          * inherited by X509_STORE_CTX when it is initialised.
174          */
175
176         unsigned long flags;    /* Various verify flags */
177         int purpose;
178         int trust;
179         /* Callbacks for various operations */
180         int (*verify)(X509_STORE_CTX *ctx);     /* called to verify a certificate */
181         int (*verify_cb)(int ok,X509_STORE_CTX *ctx);   /* error callback */
182         int (*get_issuer)(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); /* get issuers cert from ctx */
183         int (*check_issued)(X509_STORE_CTX *ctx, X509 *x, X509 *issuer); /* check issued */
184         int (*check_revocation)(X509_STORE_CTX *ctx); /* Check revocation status of chain */
185         int (*get_crl)(X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x); /* retrieve CRL */
186         int (*check_crl)(X509_STORE_CTX *ctx, X509_CRL *crl); /* Check CRL validity */
187         int (*cert_crl)(X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x); /* Check certificate against CRL */
188         int (*cleanup)(X509_STORE_CTX *ctx);
189
190         CRYPTO_EX_DATA ex_data;
191         int references;
192         int depth;              /* how deep to look (still unused -- X509_STORE_CTX's depth is used) */
193         }  X509_STORE;
194
195 #define X509_STORE_set_depth(ctx,d)       ((ctx)->depth=(d))
196
197 #define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
198 #define X509_STORE_set_verify_func(ctx,func)    ((ctx)->verify=(func))
199
200 /* This is the functions plus an instance of the local variables. */
201 struct x509_lookup_st
202         {
203         int init;                       /* have we been started */
204         int skip;                       /* don't use us. */
205         X509_LOOKUP_METHOD *method;     /* the functions */
206         char *method_data;              /* method data */
207
208         X509_STORE *store_ctx;  /* who owns us */
209         };
210
211 /* This is a used when verifying cert chains.  Since the
212  * gathering of the cert chain can take some time (and have to be
213  * 'retried', this needs to be kept and passed around. */
214 struct x509_store_ctx_st      /* X509_STORE_CTX */
215         {
216         X509_STORE *ctx;
217         int current_method;     /* used when looking up certs */
218
219         /* The following are set by the caller */
220         X509 *cert;             /* The cert to check */
221         STACK_OF(X509) *untrusted;      /* chain of X509s - untrusted - passed in */
222         int purpose;            /* purpose to check untrusted certificates */
223         int trust;              /* trust setting to check */
224         time_t  check_time;     /* time to make verify at */
225         unsigned long flags;    /* Various verify flags */
226         void *other_ctx;        /* Other info for use with get_issuer() */
227
228         /* Callbacks for various operations */
229         int (*verify)(X509_STORE_CTX *ctx);     /* called to verify a certificate */
230         int (*verify_cb)(int ok,X509_STORE_CTX *ctx);           /* error callback */
231         int (*get_issuer)(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); /* get issuers cert from ctx */
232         int (*check_issued)(X509_STORE_CTX *ctx, X509 *x, X509 *issuer); /* check issued */
233         int (*check_revocation)(X509_STORE_CTX *ctx); /* Check revocation status of chain */
234         int (*get_crl)(X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x); /* retrieve CRL */
235         int (*check_crl)(X509_STORE_CTX *ctx, X509_CRL *crl); /* Check CRL validity */
236         int (*cert_crl)(X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x); /* Check certificate against CRL */
237         int (*cleanup)(X509_STORE_CTX *ctx);
238
239         /* The following is built up */
240         int depth;              /* how far to go looking up certs */
241         int valid;              /* if 0, rebuild chain */
242         int last_untrusted;     /* index of last untrusted cert */
243         STACK_OF(X509) *chain;          /* chain of X509s - built up and trusted */
244
245         /* When something goes wrong, this is why */
246         int error_depth;
247         int error;
248         X509 *current_cert;
249         X509 *current_issuer;   /* cert currently being tested as valid issuer */
250         X509_CRL *current_crl;  /* current CRL */
251
252         CRYPTO_EX_DATA ex_data;
253         };
254
255 #define X509_STORE_CTX_set_depth(ctx,d)       ((ctx)->depth=(d))
256
257 #define X509_STORE_CTX_set_app_data(ctx,data) \
258         X509_STORE_CTX_set_ex_data(ctx,0,data)
259 #define X509_STORE_CTX_get_app_data(ctx) \
260         X509_STORE_CTX_get_ex_data(ctx,0)
261
262 #define X509_L_FILE_LOAD        1
263 #define X509_L_ADD_DIR          2
264
265 #define X509_LOOKUP_load_file(x,name,type) \
266                 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
267
268 #define X509_LOOKUP_add_dir(x,name,type) \
269                 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
270
271 #define         X509_V_OK                                       0
272 /* illegal error (for uninitialized values, to avoid X509_V_OK): 1 */
273
274 #define         X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT            2
275 #define         X509_V_ERR_UNABLE_TO_GET_CRL                    3
276 #define         X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE     4
277 #define         X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE      5
278 #define         X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY   6
279 #define         X509_V_ERR_CERT_SIGNATURE_FAILURE               7
280 #define         X509_V_ERR_CRL_SIGNATURE_FAILURE                8
281 #define         X509_V_ERR_CERT_NOT_YET_VALID                   9       
282 #define         X509_V_ERR_CERT_HAS_EXPIRED                     10
283 #define         X509_V_ERR_CRL_NOT_YET_VALID                    11
284 #define         X509_V_ERR_CRL_HAS_EXPIRED                      12
285 #define         X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD       13
286 #define         X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD        14
287 #define         X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD       15
288 #define         X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD       16
289 #define         X509_V_ERR_OUT_OF_MEM                           17
290 #define         X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT          18
291 #define         X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN            19
292 #define         X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY    20
293 #define         X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE      21
294 #define         X509_V_ERR_CERT_CHAIN_TOO_LONG                  22
295 #define         X509_V_ERR_CERT_REVOKED                         23
296 #define         X509_V_ERR_INVALID_CA                           24
297 #define         X509_V_ERR_PATH_LENGTH_EXCEEDED                 25
298 #define         X509_V_ERR_INVALID_PURPOSE                      26
299 #define         X509_V_ERR_CERT_UNTRUSTED                       27
300 #define         X509_V_ERR_CERT_REJECTED                        28
301 /* These are 'informational' when looking for issuer cert */
302 #define         X509_V_ERR_SUBJECT_ISSUER_MISMATCH              29
303 #define         X509_V_ERR_AKID_SKID_MISMATCH                   30
304 #define         X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH          31
305 #define         X509_V_ERR_KEYUSAGE_NO_CERTSIGN                 32
306
307 #define         X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER             33
308
309 /* The application is not happy */
310 #define         X509_V_ERR_APPLICATION_VERIFICATION             50
311
312 /* Certificate verify flags */
313
314 #define X509_V_FLAG_CB_ISSUER_CHECK             0x1     /* Send issuer+subject checks to verify_cb */
315 #define X509_V_FLAG_USE_CHECK_TIME              0x2     /* Use check time instead of current time */
316 #define X509_V_FLAG_CRL_CHECK                   0x4     /* Lookup CRLs */
317 #define X509_V_FLAG_CRL_CHECK_ALL               0x8     /* Lookup CRLs for whole chain */
318
319 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type,
320              X509_NAME *name);
321 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,int type,X509_NAME *name);
322 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x);
323 void X509_OBJECT_up_ref_count(X509_OBJECT *a);
324 void X509_OBJECT_free_contents(X509_OBJECT *a);
325 X509_STORE *X509_STORE_new(void );
326 void X509_STORE_free(X509_STORE *v);
327
328 void X509_STORE_set_flags(X509_STORE *ctx, long flags);
329 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose);
330 int X509_STORE_set_trust(X509_STORE *ctx, int trust);
331
332 X509_STORE_CTX *X509_STORE_CTX_new(void);
333
334 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
335
336 void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
337 void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
338                          X509 *x509, STACK_OF(X509) *chain);
339 void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
340 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
341
342 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
343
344 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
345 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
346
347 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
348 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
349
350 int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
351         X509_OBJECT *ret);
352
353 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
354         long argl, char **ret);
355
356 #ifndef OPENSSL_NO_STDIO
357 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
358 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
359 int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type);
360 #endif
361
362
363 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
364 void X509_LOOKUP_free(X509_LOOKUP *ctx);
365 int X509_LOOKUP_init(X509_LOOKUP *ctx);
366 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
367         X509_OBJECT *ret);
368 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
369         ASN1_INTEGER *serial, X509_OBJECT *ret);
370 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
371         unsigned char *bytes, int len, X509_OBJECT *ret);
372 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
373         int len, X509_OBJECT *ret);
374 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
375
376 #ifndef OPENSSL_NO_STDIO
377 int     X509_STORE_load_locations (X509_STORE *ctx,
378                 const char *file, const char *dir);
379 int     X509_STORE_set_default_paths(X509_STORE *ctx);
380 #endif
381
382 int X509_STORE_CTX_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
383         CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
384 int     X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data);
385 void *  X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
386 int     X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
387 void    X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
388 int     X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
389 X509 *  X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
390 STACK_OF(X509) *X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
391 STACK_OF(X509) *X509_STORE_CTX_get1_chain(X509_STORE_CTX *ctx);
392 void    X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
393 void    X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk);
394 int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
395 int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
396 int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
397                                 int purpose, int trust);
398 void X509_STORE_CTX_set_flags(X509_STORE_CTX *ctx, long flags);
399 void X509_STORE_CTX_set_time(X509_STORE_CTX *ctx, long flags, time_t t);
400
401 #ifdef  __cplusplus
402 }
403 #endif
404 #endif
405