crypto/x509/by_dir.c

   1 /*
   2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include "e_os.h"
  11 #include "internal/cryptlib.h"
  12 #include <stdio.h>
  13 #include <time.h>
  14 #include <errno.h>
  15 #include <sys/types.h>
  16
  17 #ifndef OPENSSL_NO_POSIX_IO
  18 # include <sys/stat.h>
  19 #endif
  20
  21 #include <openssl/x509.h>
  22 #include "crypto/x509.h"
  23 #include "x509_local.h"
  24
  25 DEFINE_STACK_OF(X509_OBJECT)
  26
  27 struct lookup_dir_hashes_st {
  28     unsigned long hash;
  29     int suffix;
  30 };
  31
  32 struct lookup_dir_entry_st {
  33     char *dir;
  34     int dir_type;
  35     STACK_OF(BY_DIR_HASH) *hashes;
  36 };
  37
  38 typedef struct lookup_dir_st {
  39     BUF_MEM *buffer;
  40     STACK_OF(BY_DIR_ENTRY) *dirs;
  41     CRYPTO_RWLOCK *lock;
  42 } BY_DIR;
  43
  44 static int dir_ctrl(X509_LOOKUP *ctx, int cmd, const char *argp, long argl,
  45                     char **ret);
  46 static int new_dir(X509_LOOKUP *lu);
  47 static void free_dir(X509_LOOKUP *lu);
  48 static int add_cert_dir(BY_DIR *ctx, const char *dir, int type);
  49 static int get_cert_by_subject(X509_LOOKUP *xl, X509_LOOKUP_TYPE type,
  50                                const X509_NAME *name, X509_OBJECT *ret);
  51 static X509_LOOKUP_METHOD x509_dir_lookup = {
  52     "Load certs from files in a directory",
  53     new_dir,                    /* new_item */
  54     free_dir,                   /* free */
  55     NULL,                       /* init */
  56     NULL,                       /* shutdown */
  57     dir_ctrl,                   /* ctrl */
  58     get_cert_by_subject,        /* get_by_subject */
  59     NULL,                       /* get_by_issuer_serial */
  60     NULL,                       /* get_by_fingerprint */
  61     NULL,                       /* get_by_alias */
  62 };
  63
  64 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void)
  65 {
  66     return &x509_dir_lookup;
  67 }
  68
  69 static int dir_ctrl(X509_LOOKUP *ctx, int cmd, const char *argp, long argl,
  70                     char **retp)
  71 {
  72     int ret = 0;
  73     BY_DIR *ld = (BY_DIR *)ctx->method_data;
  74
  75     switch (cmd) {
  76     case X509_L_ADD_DIR:
  77         if (argl == X509_FILETYPE_DEFAULT) {
  78             const char *dir = ossl_safe_getenv(X509_get_default_cert_dir_env());
  79
  80             if (dir)
  81                 ret = add_cert_dir(ld, dir, X509_FILETYPE_PEM);
  82             else
  83                 ret = add_cert_dir(ld, X509_get_default_cert_dir(),
  84                                    X509_FILETYPE_PEM);
  85             if (!ret) {
  86                 X509err(X509_F_DIR_CTRL, X509_R_LOADING_CERT_DIR);
  87             }
  88         } else
  89             ret = add_cert_dir(ld, argp, (int)argl);
  90         break;
  91     }
  92     return ret;
  93 }
  94
  95 static int new_dir(X509_LOOKUP *lu)
  96 {
  97     BY_DIR *a = OPENSSL_malloc(sizeof(*a));
  98
  99     if (a == NULL) {
 100         X509err(X509_F_NEW_DIR, ERR_R_MALLOC_FAILURE);
 101         return 0;
 102     }
 103
 104     if ((a->buffer = BUF_MEM_new()) == NULL) {
 105         X509err(X509_F_NEW_DIR, ERR_R_MALLOC_FAILURE);
 106         goto err;
 107     }
 108     a->dirs = NULL;
 109     a->lock = CRYPTO_THREAD_lock_new();
 110     if (a->lock == NULL) {
 111         BUF_MEM_free(a->buffer);
 112         X509err(X509_F_NEW_DIR, ERR_R_MALLOC_FAILURE);
 113         goto err;
 114     }
 115     lu->method_data = a;
 116     return 1;
 117
 118  err:
 119     OPENSSL_free(a);
 120     return 0;
 121 }
 122
 123 static void by_dir_hash_free(BY_DIR_HASH *hash)
 124 {
 125     OPENSSL_free(hash);
 126 }
 127
 128 static int by_dir_hash_cmp(const BY_DIR_HASH *const *a,
 129                            const BY_DIR_HASH *const *b)
 130 {
 131     if ((*a)->hash > (*b)->hash)
 132         return 1;
 133     if ((*a)->hash < (*b)->hash)
 134         return -1;
 135     return 0;
 136 }
 137
 138 static void by_dir_entry_free(BY_DIR_ENTRY *ent)
 139 {
 140     OPENSSL_free(ent->dir);
 141     sk_BY_DIR_HASH_pop_free(ent->hashes, by_dir_hash_free);
 142     OPENSSL_free(ent);
 143 }
 144
 145 static void free_dir(X509_LOOKUP *lu)
 146 {
 147     BY_DIR *a = (BY_DIR *)lu->method_data;
 148
 149     sk_BY_DIR_ENTRY_pop_free(a->dirs, by_dir_entry_free);
 150     BUF_MEM_free(a->buffer);
 151     CRYPTO_THREAD_lock_free(a->lock);
 152     OPENSSL_free(a);
 153 }
 154
 155 static int add_cert_dir(BY_DIR *ctx, const char *dir, int type)
 156 {
 157     int j;
 158     size_t len;
 159     const char *s, *ss, *p;
 160
 161     if (dir == NULL || *dir == '\0') {
 162         X509err(X509_F_ADD_CERT_DIR, X509_R_INVALID_DIRECTORY);
 163         return 0;
 164     }
 165
 166     s = dir;
 167     p = s;
 168     do {
 169         if ((*p == LIST_SEPARATOR_CHAR) || (*p == '\0')) {
 170             BY_DIR_ENTRY *ent;
 171
 172             ss = s;
 173             s = p + 1;
 174             len = p - ss;
 175             if (len == 0)
 176                 continue;
 177             for (j = 0; j < sk_BY_DIR_ENTRY_num(ctx->dirs); j++) {
 178                 ent = sk_BY_DIR_ENTRY_value(ctx->dirs, j);
 179                 if (strlen(ent->dir) == len && strncmp(ent->dir, ss, len) == 0)
 180                     break;
 181             }
 182             if (j < sk_BY_DIR_ENTRY_num(ctx->dirs))
 183                 continue;
 184             if (ctx->dirs == NULL) {
 185                 ctx->dirs = sk_BY_DIR_ENTRY_new_null();
 186                 if (!ctx->dirs) {
 187                     X509err(X509_F_ADD_CERT_DIR, ERR_R_MALLOC_FAILURE);
 188                     return 0;
 189                 }
 190             }
 191             ent = OPENSSL_malloc(sizeof(*ent));
 192             if (ent == NULL) {
 193                 X509err(X509_F_ADD_CERT_DIR, ERR_R_MALLOC_FAILURE);
 194                 return 0;
 195             }
 196             ent->dir_type = type;
 197             ent->hashes = sk_BY_DIR_HASH_new(by_dir_hash_cmp);
 198             ent->dir = OPENSSL_strndup(ss, len);
 199             if (ent->dir == NULL || ent->hashes == NULL) {
 200                 by_dir_entry_free(ent);
 201                 return 0;
 202             }
 203             if (!sk_BY_DIR_ENTRY_push(ctx->dirs, ent)) {
 204                 by_dir_entry_free(ent);
 205                 X509err(X509_F_ADD_CERT_DIR, ERR_R_MALLOC_FAILURE);
 206                 return 0;
 207             }
 208         }
 209     } while (*p++ != '\0');
 210     return 1;
 211 }
 212
 213 static int get_cert_by_subject(X509_LOOKUP *xl, X509_LOOKUP_TYPE type,
 214                                const X509_NAME *name, X509_OBJECT *ret)
 215 {
 216     BY_DIR *ctx;
 217     union {
 218         X509 st_x509;
 219         X509_CRL crl;
 220     } data;
 221     int ok = 0;
 222     int i, j, k;
 223     unsigned long h;
 224     BUF_MEM *b = NULL;
 225     X509_OBJECT stmp, *tmp;
 226     const char *postfix = "";
 227
 228     if (name == NULL)
 229         return 0;
 230
 231     stmp.type = type;
 232     if (type == X509_LU_X509) {
 233         data.st_x509.cert_info.subject = (X509_NAME *)name; /* won't modify it */
 234         stmp.data.x509 = &data.st_x509;
 235         postfix = "";
 236     } else if (type == X509_LU_CRL) {
 237         data.crl.crl.issuer = (X509_NAME *)name; /* won't modify it */
 238         stmp.data.crl = &data.crl;
 239         postfix = "r";
 240     } else {
 241         X509err(X509_F_GET_CERT_BY_SUBJECT, X509_R_WRONG_LOOKUP_TYPE);
 242         goto finish;
 243     }
 244
 245     if ((b = BUF_MEM_new()) == NULL) {
 246         X509err(X509_F_GET_CERT_BY_SUBJECT, ERR_R_BUF_LIB);
 247         goto finish;
 248     }
 249
 250     ctx = (BY_DIR *)xl->method_data;
 251
 252     h = X509_NAME_hash(name);
 253     for (i = 0; i < sk_BY_DIR_ENTRY_num(ctx->dirs); i++) {
 254         BY_DIR_ENTRY *ent;
 255         int idx;
 256         BY_DIR_HASH htmp, *hent;
 257
 258         ent = sk_BY_DIR_ENTRY_value(ctx->dirs, i);
 259         j = strlen(ent->dir) + 1 + 8 + 6 + 1 + 1;
 260         if (!BUF_MEM_grow(b, j)) {
 261             X509err(X509_F_GET_CERT_BY_SUBJECT, ERR_R_MALLOC_FAILURE);
 262             goto finish;
 263         }
 264         if (type == X509_LU_CRL && ent->hashes) {
 265             htmp.hash = h;
 266             CRYPTO_THREAD_read_lock(ctx->lock);
 267             idx = sk_BY_DIR_HASH_find(ent->hashes, &htmp);
 268             if (idx >= 0) {
 269                 hent = sk_BY_DIR_HASH_value(ent->hashes, idx);
 270                 k = hent->suffix;
 271             } else {
 272                 hent = NULL;
 273                 k = 0;
 274             }
 275             CRYPTO_THREAD_unlock(ctx->lock);
 276         } else {
 277             k = 0;
 278             hent = NULL;
 279         }
 280         for (;;) {
 281             char c = '/';
 282 #ifdef OPENSSL_SYS_VMS
 283             c = ent->dir[strlen(ent->dir) - 1];
 284             if (c != ':' && c != '>' && c != ']') {
 285                 /*
 286                  * If no separator is present, we assume the directory
 287                  * specifier is a logical name, and add a colon.  We really
 288                  * should use better VMS routines for merging things like
 289                  * this, but this will do for now... -- Richard Levitte
 290                  */
 291                 c = ':';
 292             } else {
 293                 c = '\0';
 294             }
 295 #endif
 296             if (c == '\0') {
 297                 /*
 298                  * This is special.  When c == '\0', no directory separator
 299                  * should be added.
 300                  */
 301                 BIO_snprintf(b->data, b->max,
 302                              "%s%08lx.%s%d", ent->dir, h, postfix, k);
 303             } else {
 304                 BIO_snprintf(b->data, b->max,
 305                              "%s%c%08lx.%s%d", ent->dir, c, h, postfix, k);
 306             }
 307 #ifndef OPENSSL_NO_POSIX_IO
 308 # ifdef _WIN32
 309 #  define stat _stat
 310 # endif
 311             {
 312                 struct stat st;
 313                 if (stat(b->data, &st) < 0)
 314                     break;
 315             }
 316 #endif
 317             /* found one. */
 318             if (type == X509_LU_X509) {
 319                 if ((X509_load_cert_file(xl, b->data, ent->dir_type)) == 0)
 320                     break;
 321             } else if (type == X509_LU_CRL) {
 322                 if ((X509_load_crl_file(xl, b->data, ent->dir_type)) == 0)
 323                     break;
 324             }
 325             /* else case will caught higher up */
 326             k++;
 327         }
 328
 329         /*
 330          * we have added it to the cache so now pull it out again
 331          */
 332         X509_STORE_lock(xl->store_ctx);
 333         j = sk_X509_OBJECT_find(xl->store_ctx->objs, &stmp);
 334         tmp = sk_X509_OBJECT_value(xl->store_ctx->objs, j);
 335         X509_STORE_unlock(xl->store_ctx);
 336
 337         /* If a CRL, update the last file suffix added for this */
 338
 339         if (type == X509_LU_CRL) {
 340             CRYPTO_THREAD_write_lock(ctx->lock);
 341             /*
 342              * Look for entry again in case another thread added an entry
 343              * first.
 344              */
 345             if (hent == NULL) {
 346                 htmp.hash = h;
 347                 idx = sk_BY_DIR_HASH_find(ent->hashes, &htmp);
 348                 hent = sk_BY_DIR_HASH_value(ent->hashes, idx);
 349             }
 350             if (hent == NULL) {
 351                 hent = OPENSSL_malloc(sizeof(*hent));
 352                 if (hent == NULL) {
 353                     CRYPTO_THREAD_unlock(ctx->lock);
 354                     X509err(X509_F_GET_CERT_BY_SUBJECT, ERR_R_MALLOC_FAILURE);
 355                     ok = 0;
 356                     goto finish;
 357                 }
 358                 hent->hash = h;
 359                 hent->suffix = k;
 360                 if (!sk_BY_DIR_HASH_push(ent->hashes, hent)) {
 361                     CRYPTO_THREAD_unlock(ctx->lock);
 362                     OPENSSL_free(hent);
 363                     X509err(X509_F_GET_CERT_BY_SUBJECT, ERR_R_MALLOC_FAILURE);
 364                     ok = 0;
 365                     goto finish;
 366                 }
 367             } else if (hent->suffix < k) {
 368                 hent->suffix = k;
 369             }
 370
 371             CRYPTO_THREAD_unlock(ctx->lock);
 372
 373         }
 374
 375         if (tmp != NULL) {
 376             ok = 1;
 377             ret->type = tmp->type;
 378             memcpy(&ret->data, &tmp->data, sizeof(ret->data));
 379
 380             /*
 381              * Clear any errors that might have been raised processing empty
 382              * or malformed files.
 383              */
 384             ERR_clear_error();
 385
 386             goto finish;
 387         }
 388     }
 389  finish:
 390     BUF_MEM_free(b);
 391     return ok;
 392 }