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