Coverage Report

Created: 2025-06-13 06:58

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