2 * Copyright 2015-2023 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2013-2014 Timo Teräs <timo.teras@gmail.com>
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
14 #if defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) || \
15 (defined(__VMS) && defined(__DECC) && __CRTL_VER >= 80300000)
22 # include <sys/stat.h>
25 * Make sure that the processing of symbol names is treated the same as when
26 * libcrypto is built. This is done automatically for public headers (see
27 * include/openssl/__DECC_INCLUDE_PROLOGUE.H and __DECC_INCLUDE_EPILOGUE.H),
28 * but not for internal headers.
32 # pragma names as_is,shortened
35 # include "internal/o_dir.h"
38 # pragma names restore
41 # include <openssl/evp.h>
42 # include <openssl/pem.h>
43 # include <openssl/x509.h>
46 # define PATH_MAX 4096
51 # define MAX_COLLISIONS 256
53 # if defined(OPENSSL_SYS_VXWORKS)
55 * VxWorks has no symbolic links
58 # define lstat(path, buf) stat(path, buf)
60 int symlink(const char *target, const char *linkpath)
66 ssize_t readlink(const char *pathname, char *buf, size_t bufsiz)
73 typedef struct hentry_st {
74 struct hentry_st *next;
76 unsigned short old_id;
77 unsigned char need_symlink;
78 unsigned char digest[EVP_MAX_MD_SIZE];
81 typedef struct bucket_st {
82 struct bucket_st *next;
83 HENTRY *first_entry, *last_entry;
86 unsigned short num_needed;
90 /* Keep in sync with |suffixes|, below. */
91 TYPE_CERT=0, TYPE_CRL=1
95 HASH_OLD, HASH_NEW, HASH_BOTH
100 static const EVP_MD *evpmd;
101 static int remove_links = 1;
102 static int verbose = 0;
103 static BUCKET *hash_table[257];
105 static const char *suffixes[] = { "", "r" };
106 static const char *extensions[] = { "pem", "crt", "cer", "crl" };
109 static void bit_set(unsigned char *set, unsigned int bit)
111 set[bit >> 3] |= 1 << (bit & 0x7);
114 static int bit_isset(unsigned char *set, unsigned int bit)
116 return set[bit >> 3] & (1 << (bit & 0x7));
121 * Process an entry; return number of errors.
123 static int add_entry(enum Type type, unsigned int hash, const char *filename,
124 const unsigned char *digest, int need_symlink,
125 unsigned short old_id)
127 static BUCKET nilbucket;
128 static HENTRY nilhentry;
130 HENTRY *ep, *found = NULL;
131 unsigned int ndx = (type + hash) % OSSL_NELEM(hash_table);
133 for (bp = hash_table[ndx]; bp; bp = bp->next)
134 if (bp->type == type && bp->hash == hash)
137 bp = app_malloc(sizeof(*bp), "hash bucket");
139 bp->next = hash_table[ndx];
142 hash_table[ndx] = bp;
145 for (ep = bp->first_entry; ep; ep = ep->next) {
146 if (digest && memcmp(digest, ep->digest, evpmdsize) == 0) {
148 "%s: warning: skipping duplicate %s in %s\n",
150 type == TYPE_CERT ? "certificate" : "CRL", filename);
153 if (strcmp(filename, ep->filename) == 0) {
161 if (bp->num_needed >= MAX_COLLISIONS) {
163 "%s: error: hash table overflow for %s\n",
164 opt_getprog(), filename);
167 ep = app_malloc(sizeof(*ep), "collision bucket");
170 ep->filename = OPENSSL_strdup(filename);
171 if (ep->filename == NULL) {
174 BIO_printf(bio_err, "out of memory\n");
178 bp->last_entry->next = ep;
179 if (bp->first_entry == NULL)
180 bp->first_entry = ep;
184 if (old_id < ep->old_id)
186 if (need_symlink && !ep->need_symlink) {
187 ep->need_symlink = 1;
189 memcpy(ep->digest, digest, evpmdsize);
195 * Check if a symlink goes to the right spot; return 0 if okay.
196 * This can be -1 if bad filename, or an error count.
198 static int handle_symlink(const char *filename, const char *fullpath)
200 unsigned int hash = 0;
203 char linktarget[PATH_MAX], *endptr;
206 for (i = 0; i < 8; i++) {
211 hash += OPENSSL_hexchar2int(ch);
213 if (filename[i++] != '.')
215 for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--)
216 if (OPENSSL_strncasecmp(&filename[i],
217 suffixes[type], strlen(suffixes[type])) == 0)
220 i += strlen(suffixes[type]);
222 id = strtoul(&filename[i], &endptr, 10);
226 n = readlink(fullpath, linktarget, sizeof(linktarget));
227 if (n < 0 || n >= (int)sizeof(linktarget))
231 return add_entry(type, hash, linktarget, NULL, 0, id);
235 * process a file, return number of errors.
237 static int do_file(const char *filename, const char *fullpath, enum Hash h)
239 STACK_OF (X509_INFO) *inf = NULL;
241 const X509_NAME *name = NULL;
244 unsigned char digest[EVP_MAX_MD_SIZE];
248 /* Does it end with a recognized extension? */
249 if ((ext = strrchr(filename, '.')) == NULL)
251 for (i = 0; i < OSSL_NELEM(extensions); i++) {
252 if (OPENSSL_strcasecmp(extensions[i], ext + 1) == 0)
255 if (i >= OSSL_NELEM(extensions))
258 /* Does it have X.509 data in it? */
259 if ((b = BIO_new_file(fullpath, "r")) == NULL) {
260 BIO_printf(bio_err, "%s: error: skipping %s, cannot open file\n",
261 opt_getprog(), filename);
265 inf = PEM_X509_INFO_read_bio(b, NULL, NULL, NULL);
270 if (sk_X509_INFO_num(inf) != 1) {
272 "%s: warning: skipping %s,"
273 "it does not contain exactly one certificate or CRL\n",
274 opt_getprog(), filename);
275 /* This is not an error. */
278 x = sk_X509_INFO_value(inf, 0);
279 if (x->x509 != NULL) {
281 name = X509_get_subject_name(x->x509);
282 if (!X509_digest(x->x509, evpmd, digest, NULL)) {
283 BIO_printf(bio_err, "out of memory\n");
287 } else if (x->crl != NULL) {
289 name = X509_CRL_get_issuer(x->crl);
290 if (!X509_CRL_digest(x->crl, evpmd, digest, NULL)) {
291 BIO_printf(bio_err, "out of memory\n");
300 if (h == HASH_NEW || h == HASH_BOTH) {
302 unsigned long hash_value =
303 X509_NAME_hash_ex(name,
304 app_get0_libctx(), app_get0_propq(), &ok);
307 errs += add_entry(type, hash_value, filename, digest, 1, ~0);
309 BIO_printf(bio_err, "%s: error calculating SHA1 hash value\n",
314 if ((h == HASH_OLD) || (h == HASH_BOTH))
315 errs += add_entry(type, X509_NAME_hash_old(name),
316 filename, digest, 1, ~0);
320 sk_X509_INFO_pop_free(inf, X509_INFO_free);
324 static void str_free(char *s)
329 static int ends_with_dirsep(const char *path)
332 path += strlen(path) - 1;
334 if (*path == ']' || *path == '>' || *path == ':')
336 # elif defined _WIN32
343 static int sk_strcmp(const char * const *a, const char * const *b)
345 return strcmp(*a, *b);
349 * Process a directory; return number of errors found.
351 static int do_dir(const char *dirname, enum Hash h)
355 OPENSSL_DIR_CTX *d = NULL;
357 unsigned char idmask[MAX_COLLISIONS / 8];
358 int n, numfiles, nextid, buflen, errs = 0;
361 const char *filename;
362 char *buf, *copy = NULL;
363 STACK_OF(OPENSSL_STRING) *files = NULL;
365 if (app_access(dirname, W_OK) < 0) {
366 BIO_printf(bio_err, "Skipping %s, can't write\n", dirname);
369 buflen = strlen(dirname);
370 pathsep = (buflen && !ends_with_dirsep(dirname)) ? "/": "";
371 buflen += NAME_MAX + 1 + 1;
372 buf = app_malloc(buflen, "filename buffer");
375 BIO_printf(bio_out, "Doing %s\n", dirname);
377 if ((files = sk_OPENSSL_STRING_new(sk_strcmp)) == NULL) {
378 BIO_printf(bio_err, "Skipping %s, out of memory\n", dirname);
382 while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) {
383 if ((copy = OPENSSL_strdup(filename)) == NULL
384 || sk_OPENSSL_STRING_push(files, copy) == 0) {
386 BIO_puts(bio_err, "out of memory\n");
392 sk_OPENSSL_STRING_sort(files);
394 numfiles = sk_OPENSSL_STRING_num(files);
395 for (n = 0; n < numfiles; ++n) {
396 filename = sk_OPENSSL_STRING_value(files, n);
397 if (BIO_snprintf(buf, buflen, "%s%s%s",
398 dirname, pathsep, filename) >= buflen)
400 if (lstat(buf, &st) < 0)
402 if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0)
404 errs += do_file(filename, buf, h);
407 for (i = 0; i < OSSL_NELEM(hash_table); i++) {
408 for (bp = hash_table[i]; bp; bp = nextbp) {
411 memset(idmask, 0, (bp->num_needed + 7) / 8);
412 for (ep = bp->first_entry; ep; ep = ep->next)
413 if (ep->old_id < bp->num_needed)
414 bit_set(idmask, ep->old_id);
416 for (ep = bp->first_entry; ep; ep = nextep) {
418 if (ep->old_id < bp->num_needed) {
419 /* Link exists, and is used as-is */
420 BIO_snprintf(buf, buflen, "%08x.%s%d", bp->hash,
421 suffixes[bp->type], ep->old_id);
423 BIO_printf(bio_out, "link %s -> %s\n",
425 } else if (ep->need_symlink) {
426 /* New link needed (it may replace something) */
427 while (bit_isset(idmask, nextid))
430 BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d",
431 dirname, pathsep, &n, bp->hash,
432 suffixes[bp->type], nextid);
434 BIO_printf(bio_out, "link %s -> %s\n",
435 ep->filename, &buf[n]);
436 if (unlink(buf) < 0 && errno != ENOENT) {
438 "%s: Can't unlink %s, %s\n",
439 opt_getprog(), buf, strerror(errno));
442 if (symlink(ep->filename, buf) < 0) {
444 "%s: Can't symlink %s, %s\n",
445 opt_getprog(), ep->filename,
449 bit_set(idmask, nextid);
450 } else if (remove_links) {
451 /* Link to be deleted */
452 BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d",
453 dirname, pathsep, &n, bp->hash,
454 suffixes[bp->type], ep->old_id);
456 BIO_printf(bio_out, "unlink %s\n",
458 if (unlink(buf) < 0 && errno != ENOENT) {
460 "%s: Can't unlink %s, %s\n",
461 opt_getprog(), buf, strerror(errno));
465 OPENSSL_free(ep->filename);
470 hash_table[i] = NULL;
474 sk_OPENSSL_STRING_pop_free(files, str_free);
479 typedef enum OPTION_choice {
481 OPT_COMPAT, OPT_OLD, OPT_N, OPT_VERBOSE,
485 const OPTIONS rehash_options[] = {
486 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [directory...]\n"},
488 OPT_SECTION("General"),
489 {"help", OPT_HELP, '-', "Display this summary"},
490 {"h", OPT_HELP, '-', "Display this summary"},
491 {"compat", OPT_COMPAT, '-', "Create both new- and old-style hash links"},
492 {"old", OPT_OLD, '-', "Use old-style hash to generate links"},
493 {"n", OPT_N, '-', "Do not remove existing links"},
495 OPT_SECTION("Output"),
496 {"v", OPT_VERBOSE, '-', "Verbose output"},
501 {"directory", 0, 0, "One or more directories to process (optional)"},
506 int rehash_main(int argc, char **argv)
508 const char *env, *prog;
512 enum Hash h = HASH_NEW;
514 prog = opt_init(argc, argv, rehash_options);
515 while ((o = opt_next()) != OPT_EOF) {
519 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
522 opt_help(rehash_options);
537 if (!opt_provider(o))
543 /* Optional arguments are directories to scan. */
544 argc = opt_num_rest();
548 evpmdsize = EVP_MD_get_size(evpmd);
551 while (*argv != NULL)
552 errs += do_dir(*argv++, h);
553 } else if ((env = getenv(X509_get_default_cert_dir_env())) != NULL) {
554 char lsc[2] = { LIST_SEPARATOR_CHAR, '\0' };
555 m = OPENSSL_strdup(env);
556 for (e = strtok(m, lsc); e != NULL; e = strtok(NULL, lsc))
557 errs += do_dir(e, h);
560 errs += do_dir(X509_get_default_cert_dir(), h);
568 const OPTIONS rehash_options[] = {
572 int rehash_main(int argc, char **argv)
574 BIO_printf(bio_err, "Not available; use c_rehash script\n");
578 #endif /* defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) */