GH784: Better variable name
[openssl.git] / crypto / x509 / by_dir.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include <time.h>
60 #include <errno.h>
61
62 #include "internal/cryptlib.h"
63
64 #ifndef NO_SYS_TYPES_H
65 # include <sys/types.h>
66 #endif
67 #ifndef OPENSSL_NO_POSIX_IO
68 # include <sys/stat.h>
69 #endif
70
71
72 #include <openssl/lhash.h>
73 #include <openssl/x509.h>
74 #include "internal/x509_int.h"
75 #include "x509_lcl.h"
76
77 struct lookup_dir_hashes_st {
78     unsigned long hash;
79     int suffix;
80 };
81
82 struct lookup_dir_entry_st {
83     char *dir;
84     int dir_type;
85     STACK_OF(BY_DIR_HASH) *hashes;
86 };
87
88 typedef struct lookup_dir_st {
89     BUF_MEM *buffer;
90     STACK_OF(BY_DIR_ENTRY) *dirs;
91 } BY_DIR;
92
93 static int dir_ctrl(X509_LOOKUP *ctx, int cmd, const char *argp, long argl,
94                     char **ret);
95 static int new_dir(X509_LOOKUP *lu);
96 static void free_dir(X509_LOOKUP *lu);
97 static int add_cert_dir(BY_DIR *ctx, const char *dir, int type);
98 static int get_cert_by_subject(X509_LOOKUP *xl, int type, X509_NAME *name,
99                                X509_OBJECT *ret);
100 static X509_LOOKUP_METHOD x509_dir_lookup = {
101     "Load certs from files in a directory",
102     new_dir,                    /* new */
103     free_dir,                   /* free */
104     NULL,                       /* init */
105     NULL,                       /* shutdown */
106     dir_ctrl,                   /* ctrl */
107     get_cert_by_subject,        /* get_by_subject */
108     NULL,                       /* get_by_issuer_serial */
109     NULL,                       /* get_by_fingerprint */
110     NULL,                       /* get_by_alias */
111 };
112
113 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void)
114 {
115     return (&x509_dir_lookup);
116 }
117
118 static int dir_ctrl(X509_LOOKUP *ctx, int cmd, const char *argp, long argl,
119                     char **retp)
120 {
121     int ret = 0;
122     BY_DIR *ld;
123     char *dir = NULL;
124
125     ld = (BY_DIR *)ctx->method_data;
126
127     switch (cmd) {
128     case X509_L_ADD_DIR:
129         if (argl == X509_FILETYPE_DEFAULT) {
130             dir = (char *)getenv(X509_get_default_cert_dir_env());
131             if (dir)
132                 ret = add_cert_dir(ld, dir, X509_FILETYPE_PEM);
133             else
134                 ret = add_cert_dir(ld, X509_get_default_cert_dir(),
135                                    X509_FILETYPE_PEM);
136             if (!ret) {
137                 X509err(X509_F_DIR_CTRL, X509_R_LOADING_CERT_DIR);
138             }
139         } else
140             ret = add_cert_dir(ld, argp, (int)argl);
141         break;
142     }
143     return (ret);
144 }
145
146 static int new_dir(X509_LOOKUP *lu)
147 {
148     BY_DIR *a;
149
150     if ((a = OPENSSL_malloc(sizeof(*a))) == NULL)
151         return (0);
152     if ((a->buffer = BUF_MEM_new()) == NULL) {
153         OPENSSL_free(a);
154         return (0);
155     }
156     a->dirs = NULL;
157     lu->method_data = (char *)a;
158     return (1);
159 }
160
161 static void by_dir_hash_free(BY_DIR_HASH *hash)
162 {
163     OPENSSL_free(hash);
164 }
165
166 static int by_dir_hash_cmp(const BY_DIR_HASH *const *a,
167                            const BY_DIR_HASH *const *b)
168 {
169     if ((*a)->hash > (*b)->hash)
170         return 1;
171     if ((*a)->hash < (*b)->hash)
172         return -1;
173     return 0;
174 }
175
176 static void by_dir_entry_free(BY_DIR_ENTRY *ent)
177 {
178     OPENSSL_free(ent->dir);
179     sk_BY_DIR_HASH_pop_free(ent->hashes, by_dir_hash_free);
180     OPENSSL_free(ent);
181 }
182
183 static void free_dir(X509_LOOKUP *lu)
184 {
185     BY_DIR *a;
186
187     a = (BY_DIR *)lu->method_data;
188     sk_BY_DIR_ENTRY_pop_free(a->dirs, by_dir_entry_free);
189     BUF_MEM_free(a->buffer);
190     OPENSSL_free(a);
191 }
192
193 static int add_cert_dir(BY_DIR *ctx, const char *dir, int type)
194 {
195     int j, len;
196     const char *s, *ss, *p;
197
198     if (dir == NULL || !*dir) {
199         X509err(X509_F_ADD_CERT_DIR, X509_R_INVALID_DIRECTORY);
200         return 0;
201     }
202
203     s = dir;
204     p = s;
205     do {
206         if ((*p == LIST_SEPARATOR_CHAR) || (*p == '\0')) {
207             BY_DIR_ENTRY *ent;
208             ss = s;
209             s = p + 1;
210             len = (int)(p - ss);
211             if (len == 0)
212                 continue;
213             for (j = 0; j < sk_BY_DIR_ENTRY_num(ctx->dirs); j++) {
214                 ent = sk_BY_DIR_ENTRY_value(ctx->dirs, j);
215                 if (strlen(ent->dir) == (size_t)len &&
216                     strncmp(ent->dir, ss, (unsigned int)len) == 0)
217                     break;
218             }
219             if (j < sk_BY_DIR_ENTRY_num(ctx->dirs))
220                 continue;
221             if (ctx->dirs == NULL) {
222                 ctx->dirs = sk_BY_DIR_ENTRY_new_null();
223                 if (!ctx->dirs) {
224                     X509err(X509_F_ADD_CERT_DIR, ERR_R_MALLOC_FAILURE);
225                     return 0;
226                 }
227             }
228             ent = OPENSSL_malloc(sizeof(*ent));
229             if (ent == NULL)
230                 return 0;
231             ent->dir_type = type;
232             ent->hashes = sk_BY_DIR_HASH_new(by_dir_hash_cmp);
233             ent->dir = OPENSSL_malloc((unsigned int)len + 1);
234             if (ent->dir == NULL || ent->hashes == NULL) {
235                 by_dir_entry_free(ent);
236                 return 0;
237             }
238             strncpy(ent->dir, ss, (unsigned int)len);
239             ent->dir[len] = '\0';
240             if (!sk_BY_DIR_ENTRY_push(ctx->dirs, ent)) {
241                 by_dir_entry_free(ent);
242                 return 0;
243             }
244         }
245     } while (*p++ != '\0');
246     return 1;
247 }
248
249 static int get_cert_by_subject(X509_LOOKUP *xl, X509_LOOKUP_TYPE type,
250                                X509_NAME *name, X509_OBJECT *ret)
251 {
252     BY_DIR *ctx;
253     union {
254         X509 st_x509;
255         X509_CRL crl;
256     } data;
257     int ok = 0;
258     int i, j, k;
259     unsigned long h;
260     BUF_MEM *b = NULL;
261     X509_OBJECT stmp, *tmp;
262     const char *postfix = "";
263
264     if (name == NULL)
265         return (0);
266
267     stmp.type = type;
268     if (type == X509_LU_X509) {
269         data.st_x509.cert_info.subject = name;
270         stmp.data.x509 = &data.st_x509;
271         postfix = "";
272     } else if (type == X509_LU_CRL) {
273         data.crl.crl.issuer = name;
274         stmp.data.crl = &data.crl;
275         postfix = "r";
276     } else {
277         X509err(X509_F_GET_CERT_BY_SUBJECT, X509_R_WRONG_LOOKUP_TYPE);
278         goto finish;
279     }
280
281     if ((b = BUF_MEM_new()) == NULL) {
282         X509err(X509_F_GET_CERT_BY_SUBJECT, ERR_R_BUF_LIB);
283         goto finish;
284     }
285
286     ctx = (BY_DIR *)xl->method_data;
287
288     h = X509_NAME_hash(name);
289     for (i = 0; i < sk_BY_DIR_ENTRY_num(ctx->dirs); i++) {
290         BY_DIR_ENTRY *ent;
291         int idx;
292         BY_DIR_HASH htmp, *hent;
293         ent = sk_BY_DIR_ENTRY_value(ctx->dirs, i);
294         j = strlen(ent->dir) + 1 + 8 + 6 + 1 + 1;
295         if (!BUF_MEM_grow(b, j)) {
296             X509err(X509_F_GET_CERT_BY_SUBJECT, ERR_R_MALLOC_FAILURE);
297             goto finish;
298         }
299         if (type == X509_LU_CRL && ent->hashes) {
300             htmp.hash = h;
301             CRYPTO_r_lock(CRYPTO_LOCK_X509_STORE);
302             idx = sk_BY_DIR_HASH_find(ent->hashes, &htmp);
303             if (idx >= 0) {
304                 hent = sk_BY_DIR_HASH_value(ent->hashes, idx);
305                 k = hent->suffix;
306             } else {
307                 hent = NULL;
308                 k = 0;
309             }
310             CRYPTO_r_unlock(CRYPTO_LOCK_X509_STORE);
311         } else {
312             k = 0;
313             hent = NULL;
314         }
315         for (;;) {
316             char c = '/';
317 #ifdef OPENSSL_SYS_VMS
318             c = ent->dir[strlen(ent->dir) - 1];
319             if (c != ':' && c != '>' && c != ']') {
320                 /*
321                  * If no separator is present, we assume the directory
322                  * specifier is a logical name, and add a colon.  We really
323                  * should use better VMS routines for merging things like
324                  * this, but this will do for now... -- Richard Levitte
325                  */
326                 c = ':';
327             } else {
328                 c = '\0';
329             }
330 #endif
331             if (c == '\0') {
332                 /*
333                  * This is special.  When c == '\0', no directory separator
334                  * should be added.
335                  */
336                 BIO_snprintf(b->data, b->max,
337                              "%s%08lx.%s%d", ent->dir, h, postfix, k);
338             } else {
339                 BIO_snprintf(b->data, b->max,
340                              "%s%c%08lx.%s%d", ent->dir, c, h, postfix, k);
341             }
342 #ifndef OPENSSL_NO_POSIX_IO
343 # ifdef _WIN32
344 #  define stat _stat
345 # endif
346             {
347                 struct stat st;
348                 if (stat(b->data, &st) < 0)
349                     break;
350             }
351 #endif
352             /* found one. */
353             if (type == X509_LU_X509) {
354                 if ((X509_load_cert_file(xl, b->data, ent->dir_type)) == 0)
355                     break;
356             } else if (type == X509_LU_CRL) {
357                 if ((X509_load_crl_file(xl, b->data, ent->dir_type)) == 0)
358                     break;
359             }
360             /* else case will caught higher up */
361             k++;
362         }
363
364         /*
365          * we have added it to the cache so now pull it out again
366          */
367         CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
368         j = sk_X509_OBJECT_find(xl->store_ctx->objs, &stmp);
369         if (j != -1)
370             tmp = sk_X509_OBJECT_value(xl->store_ctx->objs, j);
371         else
372             tmp = NULL;
373         CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
374
375         /* If a CRL, update the last file suffix added for this */
376
377         if (type == X509_LU_CRL) {
378             CRYPTO_w_lock(CRYPTO_LOCK_X509_STORE);
379             /*
380              * Look for entry again in case another thread added an entry
381              * first.
382              */
383             if (!hent) {
384                 htmp.hash = h;
385                 idx = sk_BY_DIR_HASH_find(ent->hashes, &htmp);
386                 if (idx >= 0)
387                     hent = sk_BY_DIR_HASH_value(ent->hashes, idx);
388             }
389             if (!hent) {
390                 hent = OPENSSL_malloc(sizeof(*hent));
391                 if (hent == NULL) {
392                     CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
393                     X509err(X509_F_GET_CERT_BY_SUBJECT, ERR_R_MALLOC_FAILURE);
394                     ok = 0;
395                     goto finish;
396                 }
397                 hent->hash = h;
398                 hent->suffix = k;
399                 if (!sk_BY_DIR_HASH_push(ent->hashes, hent)) {
400                     CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
401                     OPENSSL_free(hent);
402                     ok = 0;
403                     goto finish;
404                 }
405             } else if (hent->suffix < k)
406                 hent->suffix = k;
407
408             CRYPTO_w_unlock(CRYPTO_LOCK_X509_STORE);
409
410         }
411
412         if (tmp != NULL) {
413             ok = 1;
414             ret->type = tmp->type;
415             memcpy(&ret->data, &tmp->data, sizeof(ret->data));
416             /*
417              * If we were going to up the reference count, we would need to
418              * do it on a perl 'type' basis
419              */
420         /*- CRYPTO_add(&tmp->data.x509->references,1,
421                     CRYPTO_LOCK_X509);*/
422             goto finish;
423         }
424     }
425  finish:
426     BUF_MEM_free(b);
427     return (ok);
428 }