1 /* $MirOS: src/lib/libssl/src/crypto/x509/x509_vfy.h,v 1.2 2011/11/20 01:12:41 tg Exp $ */ 2 3 /* crypto/x509/x509_vfy.h */ 4 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 5 * All rights reserved. 6 * 7 * This package is an SSL implementation written 8 * by Eric Young (eay@cryptsoft.com). 9 * The implementation was written so as to conform with Netscapes SSL. 10 * 11 * This library is free for commercial and non-commercial use as long as 12 * the following conditions are aheared to. The following conditions 13 * apply to all code found in this distribution, be it the RC4, RSA, 14 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 15 * included with this distribution is covered by the same copyright terms 16 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 17 * 18 * Copyright remains Eric Young's, and as such any Copyright notices in 19 * the code are not to be removed. 20 * If this package is used in a product, Eric Young should be given attribution 21 * as the author of the parts of the library used. 22 * This can be in the form of a textual message at program startup or 23 * in documentation (online or textual) provided with the package. 24 * 25 * Redistribution and use in source and binary forms, with or without 26 * modification, are permitted provided that the following conditions 27 * are met: 28 * 1. Redistributions of source code must retain the copyright 29 * notice, this list of conditions and the following disclaimer. 30 * 2. Redistributions in binary form must reproduce the above copyright 31 * notice, this list of conditions and the following disclaimer in the 32 * documentation and/or other materials provided with the distribution. 33 * 3. All advertising materials mentioning features or use of this software 34 * must display the following acknowledgement: 35 * "This product includes cryptographic software written by 36 * Eric Young (eay@cryptsoft.com)" 37 * The word 'cryptographic' can be left out if the rouines from the library 38 * being used are not cryptographic related :-). 39 * 4. If you include any Windows specific code (or a derivative thereof) from 40 * the apps directory (application code) you must include an acknowledgement: 41 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 42 * 43 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 46 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 53 * SUCH DAMAGE. 54 * 55 * The licence and distribution terms for any publically available version or 56 * derivative of this code cannot be changed. i.e. this code cannot simply be 57 * copied and put under another distribution licence 58 * [including the GNU Public Licence.] 59 */ 60 61 #ifndef HEADER_X509_H 62 #include <openssl/x509.h> 63 /* openssl/x509.h ends up #include-ing this file at about the only 64 * appropriate moment. */ 65 #endif 66 67 #ifndef HEADER_X509_VFY_H 68 #define HEADER_X509_VFY_H 69 70 #ifndef OPENSSL_NO_LHASH 71 #include <openssl/lhash.h> 72 #endif 73 #include <openssl/bio.h> 74 #include <openssl/crypto.h> 75 #include <openssl/symhacks.h> 76 77 #ifdef __cplusplus 78 extern "C" { 79 #endif 80 81 /* Outer object */ 82 typedef struct x509_hash_dir_st 83 { 84 int num_dirs; 85 char **dirs; 86 int *dirs_type; 87 int num_dirs_alloced; 88 } X509_HASH_DIR_CTX; 89 90 typedef struct x509_file_st 91 { 92 int num_paths; /* number of paths to files or directories */ 93 int num_alloced; 94 char **paths; /* the list of paths or directories */ 95 int *path_type; 96 } X509_CERT_FILE_CTX; 97 98 /*******************************/ 99 /* 100 SSL_CTX -> X509_STORE 101 -> X509_LOOKUP 102 ->X509_LOOKUP_METHOD 103 -> X509_LOOKUP 104 ->X509_LOOKUP_METHOD 105 106 SSL -> X509_STORE_CTX 107 ->X509_STORE 108 109 The X509_STORE holds the tables etc for verification stuff. 110 A X509_STORE_CTX is used while validating a single certificate. 111 The X509_STORE has X509_LOOKUPs for looking up certs. 112 The X509_STORE then calls a function to actually verify the 113 certificate chain. 114 */ 115 116 #define X509_LU_RETRY -1 117 #define X509_LU_FAIL 0 118 #define X509_LU_X509 1 119 #define X509_LU_CRL 2 120 #define X509_LU_PKEY 3 121 122 typedef struct x509_object_st 123 { 124 /* one of the above types */ 125 int type; 126 union { 127 char *ptr; 128 X509 *x509; 129 X509_CRL *crl; 130 EVP_PKEY *pkey; 131 } data; 132 } X509_OBJECT; 133 134 typedef struct x509_lookup_st X509_LOOKUP; 135 136 DECLARE_STACK_OF(X509_LOOKUP) 137 DECLARE_STACK_OF(X509_OBJECT) 138 139 /* This is a static that defines the function interface */ 140 typedef struct x509_lookup_method_st 141 { 142 const char *name; 143 int (*new_item)(X509_LOOKUP *ctx); 144 void (*free)(X509_LOOKUP *ctx); 145 int (*init)(X509_LOOKUP *ctx); 146 int (*shutdown)(X509_LOOKUP *ctx); 147 int (*ctrl)(X509_LOOKUP *ctx,int cmd,const char *argc,long argl, 148 char **ret); 149 int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name, 150 X509_OBJECT *ret); 151 int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name, 152 ASN1_INTEGER *serial,X509_OBJECT *ret); 153 int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type, 154 unsigned char *bytes,int len, 155 X509_OBJECT *ret); 156 int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len, 157 X509_OBJECT *ret); 158 } X509_LOOKUP_METHOD; 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 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 } /* X509_LOOKUP */; 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 } /* X509_STORE_CTX */; 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 #define X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION 34 309 #define X509_V_ERR_KEYUSAGE_NO_CRL_SIGN 35 310 #define X509_V_ERR_UNHANDLED_CRITICAL_CRL_EXTENSION 36 311 #define X509_V_ERR_INVALID_NON_CA 37 312 #define X509_V_ERR_PROXY_PATH_LENGTH_EXCEEDED 38 313 #define X509_V_ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE 39 314 #define X509_V_ERR_PROXY_CERTIFICATES_NOT_ALLOWED 40 315 316 /* The application is not happy */ 317 #define X509_V_ERR_APPLICATION_VERIFICATION 50 318 319 #define X509_V_ERR_CERT_DISTRUSTED_BY_NAME 2046 320 #define X509_V_ERR_CERT_DISTRUSTED_BY_HASH 2047 321 322 /* Certificate verify flags */ 323 324 /* Send issuer+subject checks to verify_cb */ 325 #define X509_V_FLAG_CB_ISSUER_CHECK 0x1 326 /* Use check time instead of current time */ 327 #define X509_V_FLAG_USE_CHECK_TIME 0x2 328 /* Lookup CRLs */ 329 #define X509_V_FLAG_CRL_CHECK 0x4 330 /* Lookup CRLs for whole chain */ 331 #define X509_V_FLAG_CRL_CHECK_ALL 0x8 332 /* Ignore unhandled critical extensions */ 333 #define X509_V_FLAG_IGNORE_CRITICAL 0x10 334 /* Disable workarounds for broken certificates */ 335 #define X509_V_FLAG_X509_STRICT 0x20 336 /* Enable proxy certificate validation */ 337 #define X509_V_FLAG_ALLOW_PROXY_CERTS 0x40 338 339 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type, 340 X509_NAME *name); 341 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,int type,X509_NAME *name); 342 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x); 343 void X509_OBJECT_up_ref_count(X509_OBJECT *a); 344 void X509_OBJECT_free_contents(X509_OBJECT *a); 345 X509_STORE *X509_STORE_new(void ); 346 void X509_STORE_free(X509_STORE *v); 347 348 void X509_STORE_set_flags(X509_STORE *ctx, long flags); 349 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose); 350 int X509_STORE_set_trust(X509_STORE *ctx, int trust); 351 352 X509_STORE_CTX *X509_STORE_CTX_new(void); 353 354 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); 355 356 void X509_STORE_CTX_free(X509_STORE_CTX *ctx); 357 int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store, 358 X509 *x509, STACK_OF(X509) *chain); 359 void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk); 360 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx); 361 362 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m); 363 364 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void); 365 X509_LOOKUP_METHOD *X509_LOOKUP_file(void); 366 367 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x); 368 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x); 369 370 int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name, 371 X509_OBJECT *ret); 372 373 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, 374 long argl, char **ret); 375 376 #ifndef OPENSSL_NO_STDIO 377 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type); 378 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type); 379 int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type); 380 #endif 381 382 383 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method); 384 void X509_LOOKUP_free(X509_LOOKUP *ctx); 385 int X509_LOOKUP_init(X509_LOOKUP *ctx); 386 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name, 387 X509_OBJECT *ret); 388 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name, 389 ASN1_INTEGER *serial, X509_OBJECT *ret); 390 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type, 391 unsigned char *bytes, int len, X509_OBJECT *ret); 392 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str, 393 int len, X509_OBJECT *ret); 394 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx); 395 396 #ifndef OPENSSL_NO_STDIO 397 int X509_STORE_load_locations (X509_STORE *ctx, 398 const char *file, const char *dir); 399 int X509_STORE_set_default_paths(X509_STORE *ctx); 400 #endif 401 402 int X509_STORE_CTX_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 403 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 404 int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data); 405 void * X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx); 406 int X509_STORE_CTX_get_error(X509_STORE_CTX *ctx); 407 void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s); 408 int X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx); 409 X509 * X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx); 410 STACK_OF(X509) *X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx); 411 STACK_OF(X509) *X509_STORE_CTX_get1_chain(X509_STORE_CTX *ctx); 412 void X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x); 413 void X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk); 414 int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose); 415 int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust); 416 int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose, 417 int purpose, int trust); 418 void X509_STORE_CTX_set_flags(X509_STORE_CTX *ctx, long flags); 419 void X509_STORE_CTX_set_time(X509_STORE_CTX *ctx, long flags, time_t t); 420 void X509_STORE_CTX_set_verify_cb(X509_STORE_CTX *ctx, 421 int (*verify_cb)(int, X509_STORE_CTX *)); 422 423 #ifdef __cplusplus 424 } 425 #endif 426 #endif 427 428