Home | History | Annotate | Download | only in x509
      1 /* crypto/x509/by_dir.c */
      2 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com)
      3  * All rights reserved.
      4  *
      5  * This package is an SSL implementation written
      6  * by Eric Young (eay (at) 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 (at) 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 (at) 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 (at) 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 #include <string.h>
     59 #include <sys/stat.h>
     60 #include <sys/types.h>
     61 
     62 #include <openssl/buf.h>
     63 #include <openssl/err.h>
     64 #include <openssl/mem.h>
     65 #include <openssl/thread.h>
     66 #include <openssl/x509.h>
     67 
     68 #include "../internal.h"
     69 
     70 typedef struct lookup_dir_hashes_st {
     71     unsigned long hash;
     72     int suffix;
     73 } BY_DIR_HASH;
     74 
     75 typedef struct lookup_dir_entry_st {
     76     char *dir;
     77     int dir_type;
     78     STACK_OF(BY_DIR_HASH) *hashes;
     79 } BY_DIR_ENTRY;
     80 
     81 typedef struct lookup_dir_st {
     82     BUF_MEM *buffer;
     83     STACK_OF(BY_DIR_ENTRY) *dirs;
     84 } BY_DIR;
     85 
     86 DEFINE_STACK_OF(BY_DIR_HASH)
     87 DEFINE_STACK_OF(BY_DIR_ENTRY)
     88 
     89 static int dir_ctrl(X509_LOOKUP *ctx, int cmd, const char *argp, long argl,
     90                     char **ret);
     91 static int new_dir(X509_LOOKUP *lu);
     92 static void free_dir(X509_LOOKUP *lu);
     93 static int add_cert_dir(BY_DIR *ctx, const char *dir, int type);
     94 static int get_cert_by_subject(X509_LOOKUP *xl, int type, X509_NAME *name,
     95                                X509_OBJECT *ret);
     96 static X509_LOOKUP_METHOD x509_dir_lookup = {
     97     "Load certs from files in a directory",
     98     new_dir,                    /* new */
     99     free_dir,                   /* free */
    100     NULL,                       /* init */
    101     NULL,                       /* shutdown */
    102     dir_ctrl,                   /* ctrl */
    103     get_cert_by_subject,        /* get_by_subject */
    104     NULL,                       /* get_by_issuer_serial */
    105     NULL,                       /* get_by_fingerprint */
    106     NULL,                       /* get_by_alias */
    107 };
    108 
    109 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void)
    110 {
    111     return (&x509_dir_lookup);
    112 }
    113 
    114 static int dir_ctrl(X509_LOOKUP *ctx, int cmd, const char *argp, long argl,
    115                     char **retp)
    116 {
    117     int ret = 0;
    118     BY_DIR *ld;
    119     char *dir = NULL;
    120 
    121     ld = (BY_DIR *)ctx->method_data;
    122 
    123     switch (cmd) {
    124     case X509_L_ADD_DIR:
    125         if (argl == X509_FILETYPE_DEFAULT) {
    126             dir = (char *)getenv(X509_get_default_cert_dir_env());
    127             if (dir)
    128                 ret = add_cert_dir(ld, dir, X509_FILETYPE_PEM);
    129             else
    130                 ret = add_cert_dir(ld, X509_get_default_cert_dir(),
    131                                    X509_FILETYPE_PEM);
    132             if (!ret) {
    133                 OPENSSL_PUT_ERROR(X509, X509_R_LOADING_CERT_DIR);
    134             }
    135         } else
    136             ret = add_cert_dir(ld, argp, (int)argl);
    137         break;
    138     }
    139     return (ret);
    140 }
    141 
    142 static int new_dir(X509_LOOKUP *lu)
    143 {
    144     BY_DIR *a;
    145 
    146     if ((a = (BY_DIR *)OPENSSL_malloc(sizeof(BY_DIR))) == NULL)
    147         return (0);
    148     if ((a->buffer = BUF_MEM_new()) == NULL) {
    149         OPENSSL_free(a);
    150         return (0);
    151     }
    152     a->dirs = NULL;
    153     lu->method_data = (char *)a;
    154     return (1);
    155 }
    156 
    157 static void by_dir_hash_free(BY_DIR_HASH *hash)
    158 {
    159     OPENSSL_free(hash);
    160 }
    161 
    162 static int by_dir_hash_cmp(const BY_DIR_HASH **a, const BY_DIR_HASH **b)
    163 {
    164     if ((*a)->hash > (*b)->hash)
    165         return 1;
    166     if ((*a)->hash < (*b)->hash)
    167         return -1;
    168     return 0;
    169 }
    170 
    171 static void by_dir_entry_free(BY_DIR_ENTRY *ent)
    172 {
    173     if (ent->dir)
    174         OPENSSL_free(ent->dir);
    175     if (ent->hashes)
    176         sk_BY_DIR_HASH_pop_free(ent->hashes, by_dir_hash_free);
    177     OPENSSL_free(ent);
    178 }
    179 
    180 static void free_dir(X509_LOOKUP *lu)
    181 {
    182     BY_DIR *a;
    183 
    184     a = (BY_DIR *)lu->method_data;
    185     if (a->dirs != NULL)
    186         sk_BY_DIR_ENTRY_pop_free(a->dirs, by_dir_entry_free);
    187     if (a->buffer != NULL)
    188         BUF_MEM_free(a->buffer);
    189     OPENSSL_free(a);
    190 }
    191 
    192 static int add_cert_dir(BY_DIR *ctx, const char *dir, int type)
    193 {
    194     size_t j, len;
    195     const char *s, *ss, *p;
    196 
    197     if (dir == NULL || !*dir) {
    198         OPENSSL_PUT_ERROR(X509, X509_R_INVALID_DIRECTORY);
    199         return 0;
    200     }
    201 
    202     s = dir;
    203     p = s;
    204     do {
    205         if ((*p == ':') || (*p == '\0')) {
    206             BY_DIR_ENTRY *ent;
    207             ss = s;
    208             s = p + 1;
    209             len = p - ss;
    210             if (len == 0)
    211                 continue;
    212             for (j = 0; j < sk_BY_DIR_ENTRY_num(ctx->dirs); j++) {
    213                 ent = sk_BY_DIR_ENTRY_value(ctx->dirs, j);
    214                 if (strlen(ent->dir) == len &&
    215                     strncmp(ent->dir, ss, len) == 0)
    216                     break;
    217             }
    218             if (j < sk_BY_DIR_ENTRY_num(ctx->dirs))
    219                 continue;
    220             if (ctx->dirs == NULL) {
    221                 ctx->dirs = sk_BY_DIR_ENTRY_new_null();
    222                 if (!ctx->dirs) {
    223                     OPENSSL_PUT_ERROR(X509, ERR_R_MALLOC_FAILURE);
    224                     return 0;
    225                 }
    226             }
    227             ent = OPENSSL_malloc(sizeof(BY_DIR_ENTRY));
    228             if (!ent)
    229                 return 0;
    230             ent->dir_type = type;
    231             ent->hashes = sk_BY_DIR_HASH_new(by_dir_hash_cmp);
    232             ent->dir = OPENSSL_malloc(len + 1);
    233             if (!ent->dir || !ent->hashes) {
    234                 by_dir_entry_free(ent);
    235                 return 0;
    236             }
    237             BUF_strlcpy(ent->dir, ss, len + 1);
    238             if (!sk_BY_DIR_ENTRY_push(ctx->dirs, ent)) {
    239                 by_dir_entry_free(ent);
    240                 return 0;
    241             }
    242         }
    243     } while (*p++ != '\0');
    244     return 1;
    245 }
    246 
    247 /*
    248  * g_ent_hashes_lock protects the |hashes| member of all |BY_DIR_ENTRY|
    249  * objects.
    250  */
    251 static struct CRYPTO_STATIC_MUTEX g_ent_hashes_lock =
    252     CRYPTO_STATIC_MUTEX_INIT;
    253 
    254 static int get_cert_by_subject(X509_LOOKUP *xl, int type, X509_NAME *name,
    255                                X509_OBJECT *ret)
    256 {
    257     BY_DIR *ctx;
    258     union {
    259         struct {
    260             X509 st_x509;
    261             X509_CINF st_x509_cinf;
    262         } x509;
    263         struct {
    264             X509_CRL st_crl;
    265             X509_CRL_INFO st_crl_info;
    266         } crl;
    267     } data;
    268     int ok = 0;
    269     size_t i;
    270     int j, k;
    271     unsigned long h;
    272     unsigned long hash_array[2];
    273     int hash_index;
    274     BUF_MEM *b = NULL;
    275     X509_OBJECT stmp, *tmp;
    276     const char *postfix = "";
    277 
    278     if (name == NULL)
    279         return (0);
    280 
    281     stmp.type = type;
    282     if (type == X509_LU_X509) {
    283         data.x509.st_x509.cert_info = &data.x509.st_x509_cinf;
    284         data.x509.st_x509_cinf.subject = name;
    285         stmp.data.x509 = &data.x509.st_x509;
    286         postfix = "";
    287     } else if (type == X509_LU_CRL) {
    288         data.crl.st_crl.crl = &data.crl.st_crl_info;
    289         data.crl.st_crl_info.issuer = name;
    290         stmp.data.crl = &data.crl.st_crl;
    291         postfix = "r";
    292     } else {
    293         OPENSSL_PUT_ERROR(X509, X509_R_WRONG_LOOKUP_TYPE);
    294         goto finish;
    295     }
    296 
    297     if ((b = BUF_MEM_new()) == NULL) {
    298         OPENSSL_PUT_ERROR(X509, ERR_R_BUF_LIB);
    299         goto finish;
    300     }
    301 
    302     ctx = (BY_DIR *)xl->method_data;
    303 
    304     hash_array[0] = X509_NAME_hash(name);
    305     hash_array[1] = X509_NAME_hash_old(name);
    306     for (hash_index = 0; hash_index < 2; ++hash_index) {
    307         h = hash_array[hash_index];
    308         for (i = 0; i < sk_BY_DIR_ENTRY_num(ctx->dirs); i++) {
    309             BY_DIR_ENTRY *ent;
    310             size_t idx;
    311             BY_DIR_HASH htmp, *hent;
    312             ent = sk_BY_DIR_ENTRY_value(ctx->dirs, i);
    313             j = strlen(ent->dir) + 1 + 8 + 6 + 1 + 1;
    314             if (!BUF_MEM_grow(b, j)) {
    315                 OPENSSL_PUT_ERROR(X509, ERR_R_MALLOC_FAILURE);
    316                 goto finish;
    317             }
    318             if (type == X509_LU_CRL && ent->hashes) {
    319                 htmp.hash = h;
    320                 CRYPTO_STATIC_MUTEX_lock_read(&g_ent_hashes_lock);
    321                 if (sk_BY_DIR_HASH_find(ent->hashes, &idx, &htmp)) {
    322                     hent = sk_BY_DIR_HASH_value(ent->hashes, idx);
    323                     k = hent->suffix;
    324                 } else {
    325                     hent = NULL;
    326                     k = 0;
    327                 }
    328                 CRYPTO_STATIC_MUTEX_unlock_read(&g_ent_hashes_lock);
    329             } else {
    330                 k = 0;
    331                 hent = NULL;
    332             }
    333             for (;;) {
    334                 char c = '/';
    335 #ifdef OPENSSL_SYS_VMS
    336                 c = ent->dir[strlen(ent->dir) - 1];
    337                 if (c != ':' && c != '>' && c != ']') {
    338                     /*
    339                      * If no separator is present, we assume the directory
    340                      * specifier is a logical name, and add a colon.  We
    341                      * really should use better VMS routines for merging
    342                      * things like this, but this will do for now... --
    343                      * Richard Levitte
    344                      */
    345                     c = ':';
    346                 } else {
    347                     c = '\0';
    348                 }
    349 #endif
    350                 if (c == '\0') {
    351                     /*
    352                      * This is special.  When c == '\0', no directory
    353                      * separator should be added.
    354                      */
    355                     BIO_snprintf(b->data, b->max,
    356                                  "%s%08lx.%s%d", ent->dir, h, postfix, k);
    357                 } else {
    358                     BIO_snprintf(b->data, b->max,
    359                                  "%s%c%08lx.%s%d", ent->dir, c, h,
    360                                  postfix, k);
    361                 }
    362 #ifndef OPENSSL_NO_POSIX_IO
    363 # if defined(_WIN32) && !defined(stat)
    364 #  define stat _stat
    365 # endif
    366                 {
    367                     struct stat st;
    368                     if (stat(b->data, &st) < 0)
    369                         break;
    370                 }
    371 #endif
    372                 /* found one. */
    373                 if (type == X509_LU_X509) {
    374                     if ((X509_load_cert_file(xl, b->data,
    375                                              ent->dir_type)) == 0)
    376                         break;
    377                 } else if (type == X509_LU_CRL) {
    378                     if ((X509_load_crl_file(xl, b->data, ent->dir_type)) == 0)
    379                         break;
    380                 }
    381                 /* else case will caught higher up */
    382                 k++;
    383             }
    384 
    385             /*
    386              * we have added it to the cache so now pull it out again
    387              */
    388             CRYPTO_MUTEX_lock_write(&xl->store_ctx->objs_lock);
    389             tmp = NULL;
    390             if (sk_X509_OBJECT_find(xl->store_ctx->objs, &idx, &stmp)) {
    391                 tmp = sk_X509_OBJECT_value(xl->store_ctx->objs, idx);
    392             }
    393             CRYPTO_MUTEX_unlock_write(&xl->store_ctx->objs_lock);
    394 
    395             /*
    396              * If a CRL, update the last file suffix added for this
    397              */
    398 
    399             if (type == X509_LU_CRL) {
    400                 CRYPTO_STATIC_MUTEX_lock_write(&g_ent_hashes_lock);
    401                 /*
    402                  * Look for entry again in case another thread added an entry
    403                  * first.
    404                  */
    405                 if (!hent) {
    406                     htmp.hash = h;
    407                     if (sk_BY_DIR_HASH_find(ent->hashes, &idx, &htmp))
    408                         hent = sk_BY_DIR_HASH_value(ent->hashes, idx);
    409                 }
    410                 if (!hent) {
    411                     hent = OPENSSL_malloc(sizeof(BY_DIR_HASH));
    412                     if (hent == NULL) {
    413                         CRYPTO_STATIC_MUTEX_unlock_write(&g_ent_hashes_lock);
    414                         ok = 0;
    415                         goto finish;
    416                     }
    417                     hent->hash = h;
    418                     hent->suffix = k;
    419                     if (!sk_BY_DIR_HASH_push(ent->hashes, hent)) {
    420                         CRYPTO_STATIC_MUTEX_unlock_write(&g_ent_hashes_lock);
    421                         OPENSSL_free(hent);
    422                         ok = 0;
    423                         goto finish;
    424                     }
    425                 } else if (hent->suffix < k)
    426                     hent->suffix = k;
    427 
    428                 CRYPTO_STATIC_MUTEX_unlock_write(&g_ent_hashes_lock);
    429             }
    430 
    431             if (tmp != NULL) {
    432                 ok = 1;
    433                 ret->type = tmp->type;
    434                 OPENSSL_memcpy(&ret->data, &tmp->data, sizeof(ret->data));
    435                 /*
    436                  * If we were going to up the reference count, we would need
    437                  * to do it on a perl 'type' basis
    438                  */
    439                 /*
    440                  * CRYPTO_add(&tmp->data.x509->references,1,
    441                  * CRYPTO_LOCK_X509);
    442                  */
    443                 goto finish;
    444             }
    445         }
    446     }
    447  finish:
    448     if (b != NULL)
    449         BUF_MEM_free(b);
    450     return (ok);
    451 }
    452