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