crypto/x509/x509_lu.c

   1 /* crypto/x509/x509_lu.c */
   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 #include <stdio.h>
  60 #include "cryptlib.h"
  61 #include <openssl/lhash.h>
  62 #include <openssl/x509.h>
  63
  64 static STACK_OF(CRYPTO_EX_DATA_FUNCS) *x509_store_meth=NULL;
  65
  66 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method)
  67         {
  68         X509_LOOKUP *ret;
  69
  70         ret=(X509_LOOKUP *)OPENSSL_malloc(sizeof(X509_LOOKUP));
  71         if (ret == NULL) return NULL;
  72
  73         ret->init=0;
  74         ret->skip=0;
  75         ret->method=method;
  76         ret->method_data=NULL;
  77         ret->store_ctx=NULL;
  78         if ((method->new_item != NULL) && !method->new_item(ret))
  79                 {
  80                 OPENSSL_free(ret);
  81                 return NULL;
  82                 }
  83         return ret;
  84         }
  85
  86 void X509_LOOKUP_free(X509_LOOKUP *ctx)
  87         {
  88         if (ctx == NULL) return;
  89         if (    (ctx->method != NULL) &&
  90                 (ctx->method->free != NULL))
  91                 ctx->method->free(ctx);
  92         OPENSSL_free(ctx);
  93         }
  94
  95 int X509_LOOKUP_init(X509_LOOKUP *ctx)
  96         {
  97         if (ctx->method == NULL) return 0;
  98         if (ctx->method->init != NULL)
  99                 return ctx->method->init(ctx);
 100         else
 101                 return 1;
 102         }
 103
 104 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx)
 105         {
 106         if (ctx->method == NULL) return 0;
 107         if (ctx->method->shutdown != NULL)
 108                 return ctx->method->shutdown(ctx);
 109         else
 110                 return 1;
 111         }
 112
 113 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, long argl,
 114              char **ret)
 115         {
 116         if (ctx->method == NULL) return -1;
 117         if (ctx->method->ctrl != NULL)
 118                 return ctx->method->ctrl(ctx,cmd,argc,argl,ret);
 119         else
 120                 return 1;
 121         }
 122
 123 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
 124              X509_OBJECT *ret)
 125         {
 126         if ((ctx->method == NULL) || (ctx->method->get_by_subject == NULL))
 127                 return X509_LU_FAIL;
 128         if (ctx->skip) return 0;
 129         return ctx->method->get_by_subject(ctx,type,name,ret);
 130         }
 131
 132 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
 133              ASN1_INTEGER *serial, X509_OBJECT *ret)
 134         {
 135         if ((ctx->method == NULL) ||
 136                 (ctx->method->get_by_issuer_serial == NULL))
 137                 return X509_LU_FAIL;
 138         return ctx->method->get_by_issuer_serial(ctx,type,name,serial,ret);
 139         }
 140
 141 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
 142              unsigned char *bytes, int len, X509_OBJECT *ret)
 143         {
 144         if ((ctx->method == NULL) || (ctx->method->get_by_fingerprint == NULL))
 145                 return X509_LU_FAIL;
 146         return ctx->method->get_by_fingerprint(ctx,type,bytes,len,ret);
 147         }
 148
 149 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str, int len,
 150              X509_OBJECT *ret)
 151         {
 152         if ((ctx->method == NULL) || (ctx->method->get_by_alias == NULL))
 153                 return X509_LU_FAIL;
 154         return ctx->method->get_by_alias(ctx,type,str,len,ret);
 155         }
 156
 157
 158 static int x509_object_cmp(const X509_OBJECT * const *a, const X509_OBJECT * const *b)
 159         {
 160         int ret;
 161
 162         ret=((*a)->type - (*b)->type);
 163         if (ret) return ret;
 164         switch ((*a)->type)
 165                 {
 166         case X509_LU_X509:
 167                 ret=X509_subject_name_cmp((*a)->data.x509,(*b)->data.x509);
 168                 break;
 169         case X509_LU_CRL:
 170                 ret=X509_CRL_cmp((*a)->data.crl,(*b)->data.crl);
 171                 break;
 172         default:
 173                 /* abort(); */
 174                 return 0;
 175                 }
 176         return ret;
 177         }
 178
 179 X509_STORE *X509_STORE_new(void)
 180         {
 181         X509_STORE *ret;
 182
 183         if ((ret=(X509_STORE *)OPENSSL_malloc(sizeof(X509_STORE))) == NULL)
 184                 return NULL;
 185         ret->objs = sk_X509_OBJECT_new(x509_object_cmp);
 186         ret->cache=1;
 187         ret->get_cert_methods=sk_X509_LOOKUP_new_null();
 188         ret->verify=0;
 189         ret->verify_cb=0;
 190
 191         ret->purpose = 0;
 192         ret->trust = 0;
 193
 194         ret->flags = 0;
 195
 196         ret->get_issuer = 0;
 197         ret->check_issued = 0;
 198         ret->check_revocation = 0;
 199         ret->get_crl = 0;
 200         ret->check_crl = 0;
 201         ret->cert_crl = 0;
 202         ret->cleanup = 0;
 203
 204         memset(&ret->ex_data,0,sizeof(CRYPTO_EX_DATA));
 205         ret->references=1;
 206         ret->depth=0;
 207         return ret;
 208         }
 209
 210 static void cleanup(X509_OBJECT *a)
 211         {
 212         if (a->type == X509_LU_X509)
 213                 {
 214                 X509_free(a->data.x509);
 215                 }
 216         else if (a->type == X509_LU_CRL)
 217                 {
 218                 X509_CRL_free(a->data.crl);
 219                 }
 220         else
 221                 {
 222                 /* abort(); */
 223                 }
 224
 225         OPENSSL_free(a);
 226         }
 227
 228 void X509_STORE_free(X509_STORE *vfy)
 229         {
 230         int i;
 231         STACK_OF(X509_LOOKUP) *sk;
 232         X509_LOOKUP *lu;
 233
 234         if (vfy == NULL)
 235             return;
 236
 237         sk=vfy->get_cert_methods;
 238         for (i=0; i<sk_X509_LOOKUP_num(sk); i++)
 239                 {
 240                 lu=sk_X509_LOOKUP_value(sk,i);
 241                 X509_LOOKUP_shutdown(lu);
 242                 X509_LOOKUP_free(lu);
 243                 }
 244         sk_X509_LOOKUP_free(sk);
 245         sk_X509_OBJECT_pop_free(vfy->objs, cleanup);
 246
 247         CRYPTO_free_ex_data(x509_store_meth,vfy,&vfy->ex_data);
 248         OPENSSL_free(vfy);
 249         }
 250
 251 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m)
 252         {
 253         int i;
 254         STACK_OF(X509_LOOKUP) *sk;
 255         X509_LOOKUP *lu;
 256
 257         sk=v->get_cert_methods;
 258         for (i=0; i<sk_X509_LOOKUP_num(sk); i++)
 259                 {
 260                 lu=sk_X509_LOOKUP_value(sk,i);
 261                 if (m == lu->method)
 262                         {
 263                         return lu;
 264                         }
 265                 }
 266         /* a new one */
 267         lu=X509_LOOKUP_new(m);
 268         if (lu == NULL)
 269                 return NULL;
 270         else
 271                 {
 272                 lu->store_ctx=v;
 273                 if (sk_X509_LOOKUP_push(v->get_cert_methods,lu))
 274                         return lu;
 275                 else
 276                         {
 277                         X509_LOOKUP_free(lu);
 278                         return NULL;
 279                         }
 280                 }
 281         }
 282
 283 int X509_STORE_get_by_subject(X509_STORE_CTX *vs, int type, X509_NAME *name,
 284              X509_OBJECT *ret)
 285         {
 286         X509_STORE *ctx=vs->ctx;
 287         X509_LOOKUP *lu;
 288         X509_OBJECT stmp,*tmp;
 289         int i,j;
 290
 291         tmp=X509_OBJECT_retrieve_by_subject(ctx->objs,type,name);
 292
 293         if (tmp == NULL)
 294                 {
 295                 for (i=vs->current_method; i<sk_X509_LOOKUP_num(ctx->get_cert_methods); i++)
 296                         {
 297                         lu=sk_X509_LOOKUP_value(ctx->get_cert_methods,i);
 298                         j=X509_LOOKUP_by_subject(lu,type,name,&stmp);
 299                         if (j < 0)
 300                                 {
 301                                 vs->current_method=j;
 302                                 return j;
 303                                 }
 304                         else if (j)
 305                                 {
 306                                 tmp= &stmp;
 307                                 break;
 308                                 }
 309                         }
 310                 vs->current_method=0;
 311                 if (tmp == NULL)
 312                         return 0;
 313                 }
 314
 315 /*      if (ret->data.ptr != NULL)
 316                 X509_OBJECT_free_contents(ret); */
 317
 318         ret->type=tmp->type;
 319         ret->data.ptr=tmp->data.ptr;
 320
 321         X509_OBJECT_up_ref_count(ret);
 322
 323         return 1;
 324         }
 325
 326 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x)
 327         {
 328         X509_OBJECT *obj;
 329         int ret=1;
 330
 331         if (x == NULL) return 0;
 332         obj=(X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
 333         if (obj == NULL)
 334                 {
 335                 X509err(X509_F_X509_STORE_ADD_CERT,ERR_R_MALLOC_FAILURE);
 336                 return 0;
 337                 }
 338         obj->type=X509_LU_X509;
 339         obj->data.x509=x;
 340
 341         CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
 342
 343         X509_OBJECT_up_ref_count(obj);
 344
 345
 346         if (X509_OBJECT_retrieve_match(ctx->objs, obj))
 347                 {
 348                 X509_OBJECT_free_contents(obj);
 349                 OPENSSL_free(obj);
 350                 X509err(X509_F_X509_STORE_ADD_CERT,X509_R_CERT_ALREADY_IN_HASH_TABLE);
 351                 ret=0;
 352                 }
 353         else sk_X509_OBJECT_push(ctx->objs, obj);
 354
 355         CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
 356
 357         return ret;
 358         }
 359
 360 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x)
 361         {
 362         X509_OBJECT *obj;
 363         int ret=1;
 364
 365         if (x == NULL) return 0;
 366         obj=(X509_OBJECT *)OPENSSL_malloc(sizeof(X509_OBJECT));
 367         if (obj == NULL)
 368                 {
 369                 X509err(X509_F_X509_STORE_ADD_CRL,ERR_R_MALLOC_FAILURE);
 370                 return 0;
 371                 }
 372         obj->type=X509_LU_CRL;
 373         obj->data.crl=x;
 374
 375         CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
 376
 377         X509_OBJECT_up_ref_count(obj);
 378
 379         if (X509_OBJECT_retrieve_match(ctx->objs, obj))
 380                 {
 381                 X509_OBJECT_free_contents(obj);
 382                 OPENSSL_free(obj);
 383                 X509err(X509_F_X509_STORE_ADD_CRL,X509_R_CERT_ALREADY_IN_HASH_TABLE);
 384                 ret=0;
 385                 }
 386         else sk_X509_OBJECT_push(ctx->objs, obj);
 387
 388         CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
 389
 390         return ret;
 391         }
 392
 393 void X509_OBJECT_up_ref_count(X509_OBJECT *a)
 394         {
 395         switch (a->type)
 396                 {
 397         case X509_LU_X509:
 398                 CRYPTO_add(&a->data.x509->references,1,CRYPTO_LOCK_X509);
 399                 break;
 400         case X509_LU_CRL:
 401                 CRYPTO_add(&a->data.crl->references,1,CRYPTO_LOCK_X509_CRL);
 402                 break;
 403                 }
 404         }
 405
 406 void X509_OBJECT_free_contents(X509_OBJECT *a)
 407         {
 408         switch (a->type)
 409                 {
 410         case X509_LU_X509:
 411                 X509_free(a->data.x509);
 412                 break;
 413         case X509_LU_CRL:
 414                 X509_CRL_free(a->data.crl);
 415                 break;
 416                 }
 417         }
 418
 419 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type,
 420              X509_NAME *name)
 421         {
 422         X509_OBJECT stmp;
 423         X509 x509_s;
 424         X509_CINF cinf_s;
 425         X509_CRL crl_s;
 426         X509_CRL_INFO crl_info_s;
 427
 428         stmp.type=type;
 429         switch (type)
 430                 {
 431         case X509_LU_X509:
 432                 stmp.data.x509= &x509_s;
 433                 x509_s.cert_info= &cinf_s;
 434                 cinf_s.subject=name;
 435                 break;
 436         case X509_LU_CRL:
 437                 stmp.data.crl= &crl_s;
 438                 crl_s.crl= &crl_info_s;
 439                 crl_info_s.issuer=name;
 440                 break;
 441         default:
 442                 /* abort(); */
 443                 return -1;
 444                 }
 445
 446         return sk_X509_OBJECT_find(h,&stmp);
 447         }
 448
 449 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h, int type,
 450              X509_NAME *name)
 451 {
 452         int idx;
 453         idx = X509_OBJECT_idx_by_subject(h, type, name);
 454         if (idx==-1) return NULL;
 455         return sk_X509_OBJECT_value(h, idx);
 456 }
 457
 458 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x)
 459 {
 460         int idx, i;
 461         X509_OBJECT *obj;
 462         idx = sk_X509_OBJECT_find(h, x);
 463         if (idx == -1) return NULL;
 464         if (x->type != X509_LU_X509) return sk_X509_OBJECT_value(h, idx);
 465         for (i = idx; i < sk_X509_OBJECT_num(h); i++)
 466                 {
 467                 obj = sk_X509_OBJECT_value(h, i);
 468                 if (x509_object_cmp((const X509_OBJECT **)&obj, (const X509_OBJECT **)&x))
 469                         return NULL;
 470                 if ((x->type != X509_LU_X509) || !X509_cmp(obj->data.x509, x->data.x509))
 471                         return obj;
 472                 }
 473         return NULL;
 474 }
 475
 476
 477 /* Try to get issuer certificate from store. Due to limitations
 478  * of the API this can only retrieve a single certificate matching
 479  * a given subject name. However it will fill the cache with all
 480  * matching certificates, so we can examine the cache for all
 481  * matches.
 482  *
 483  * Return values are:
 484  *  1 lookup successful.
 485  *  0 certificate not found.
 486  * -1 some other error.
 487  */
 488
 489
 490 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x)
 491 {
 492         X509_NAME *xn;
 493         X509_OBJECT obj, *pobj;
 494         int i, ok, idx;
 495         xn=X509_get_issuer_name(x);
 496         ok=X509_STORE_get_by_subject(ctx,X509_LU_X509,xn,&obj);
 497         if (ok != X509_LU_X509)
 498                 {
 499                 if (ok == X509_LU_RETRY)
 500                         {
 501                         X509_OBJECT_free_contents(&obj);
 502                         X509err(X509_F_X509_VERIFY_CERT,X509_R_SHOULD_RETRY);
 503                         return -1;
 504                         }
 505                 else if (ok != X509_LU_FAIL)
 506                         {
 507                         X509_OBJECT_free_contents(&obj);
 508                         /* not good :-(, break anyway */
 509                         return -1;
 510                         }
 511                 return 0;
 512                 }
 513         /* If certificate matches all OK */
 514         if (ctx->check_issued(ctx, x, obj.data.x509))
 515                 {
 516                 *issuer = obj.data.x509;
 517                 return 1;
 518                 }
 519         X509_OBJECT_free_contents(&obj);
 520         /* Else find index of first matching cert */
 521         idx = X509_OBJECT_idx_by_subject(ctx->ctx->objs, X509_LU_X509, xn);
 522         /* This shouldn't normally happen since we already have one match */
 523         if (idx == -1) return 0;
 524
 525         /* Look through all matching certificates for a suitable issuer */
 526         for (i = idx; i < sk_X509_OBJECT_num(ctx->ctx->objs); i++)
 527                 {
 528                 pobj = sk_X509_OBJECT_value(ctx->ctx->objs, i);
 529                 /* See if we've ran out of matches */
 530                 if (pobj->type != X509_LU_X509) return 0;
 531                 if (X509_NAME_cmp(xn, X509_get_subject_name(pobj->data.x509))) return 0;
 532                 if (ctx->check_issued(ctx, x, pobj->data.x509))
 533                         {
 534                         *issuer = pobj->data.x509;
 535                         X509_OBJECT_up_ref_count(pobj);
 536                         return 1;
 537                         }
 538                 }
 539         return 0;
 540 }
 541
 542 void X509_STORE_set_flags(X509_STORE *ctx, long flags)
 543         {
 544         ctx->flags |= flags;
 545         }
 546
 547 IMPLEMENT_STACK_OF(X509_LOOKUP)
 548 IMPLEMENT_STACK_OF(X509_OBJECT)