2 * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
11 * C implementation based on the original Perl and shell versions
13 * Copyright (c) 2013-2014 Timo Teräs <timo.teras@iki.fi>
18 #if defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) || \
19 (defined(__VMS) && defined(__DECC) && __CRTL_VER >= 80300000)
26 # include <sys/stat.h>
29 * Make sure that the processing of symbol names is treated the same as when
30 * libcrypto is built. This is done automatically for public headers (see
31 * include/openssl/__DECC_INCLUDE_PROLOGUE.H and __DECC_INCLUDE_EPILOGUE.H),
32 * but not for internal headers.
36 # pragma names as_is,shortened
39 # include "internal/o_dir.h"
42 # pragma names restore
45 # include <openssl/evp.h>
46 # include <openssl/pem.h>
47 # include <openssl/x509.h>
51 # define PATH_MAX 4096
56 # define MAX_COLLISIONS 256
58 typedef struct hentry_st {
59 struct hentry_st *next;
61 unsigned short old_id;
62 unsigned char need_symlink;
63 unsigned char digest[EVP_MAX_MD_SIZE];
66 typedef struct bucket_st {
67 struct bucket_st *next;
68 HENTRY *first_entry, *last_entry;
71 unsigned short num_needed;
75 /* Keep in sync with |suffixes|, below. */
76 TYPE_CERT=0, TYPE_CRL=1
80 HASH_OLD, HASH_NEW, HASH_BOTH
85 static const EVP_MD *evpmd;
86 static int remove_links = 1;
87 static int verbose = 0;
88 static BUCKET *hash_table[257];
90 static const char *suffixes[] = { "", "r" };
91 static const char *extensions[] = { "pem", "crt", "cer", "crl" };
94 static void bit_set(unsigned char *set, unsigned int bit)
96 set[bit >> 3] |= 1 << (bit & 0x7);
99 static int bit_isset(unsigned char *set, unsigned int bit)
101 return set[bit >> 3] & (1 << (bit & 0x7));
106 * Process an entry; return number of errors.
108 static int add_entry(enum Type type, unsigned int hash, const char *filename,
109 const unsigned char *digest, int need_symlink,
110 unsigned short old_id)
112 static BUCKET nilbucket;
113 static HENTRY nilhentry;
115 HENTRY *ep, *found = NULL;
116 unsigned int ndx = (type + hash) % OSSL_NELEM(hash_table);
118 for (bp = hash_table[ndx]; bp; bp = bp->next)
119 if (bp->type == type && bp->hash == hash)
122 bp = app_malloc(sizeof(*bp), "hash bucket");
124 bp->next = hash_table[ndx];
127 hash_table[ndx] = bp;
130 for (ep = bp->first_entry; ep; ep = ep->next) {
131 if (digest && memcmp(digest, ep->digest, evpmdsize) == 0) {
133 "%s: skipping duplicate %s in %s\n", opt_getprog(),
134 type == TYPE_CERT ? "certificate" : "CRL", filename);
137 if (strcmp(filename, ep->filename) == 0) {
145 if (bp->num_needed >= MAX_COLLISIONS) {
147 "%s: hash table overflow for %s\n",
148 opt_getprog(), filename);
151 ep = app_malloc(sizeof(*ep), "collision bucket");
154 ep->filename = OPENSSL_strdup(filename);
156 bp->last_entry->next = ep;
157 if (bp->first_entry == NULL)
158 bp->first_entry = ep;
162 if (old_id < ep->old_id)
164 if (need_symlink && !ep->need_symlink) {
165 ep->need_symlink = 1;
167 memcpy(ep->digest, digest, evpmdsize);
173 * Check if a symlink goes to the right spot; return 0 if okay.
174 * This can be -1 if bad filename, or an error count.
176 static int handle_symlink(const char *filename, const char *fullpath)
178 unsigned int hash = 0;
181 char linktarget[PATH_MAX], *endptr;
184 for (i = 0; i < 8; i++) {
189 hash += OPENSSL_hexchar2int(ch);
191 if (filename[i++] != '.')
193 for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--) {
194 const char *suffix = suffixes[type];
195 if (strncasecmp(suffix, &filename[i], strlen(suffix)) == 0)
198 i += strlen(suffixes[type]);
200 id = strtoul(&filename[i], &endptr, 10);
204 n = readlink(fullpath, linktarget, sizeof(linktarget));
205 if (n < 0 || n >= (int)sizeof(linktarget))
209 return add_entry(type, hash, linktarget, NULL, 0, id);
213 * process a file, return number of errors.
215 static int do_file(const char *filename, const char *fullpath, enum Hash h)
217 STACK_OF (X509_INFO) *inf = NULL;
219 X509_NAME *name = NULL;
222 unsigned char digest[EVP_MAX_MD_SIZE];
226 /* Does it end with a recognized extension? */
227 if ((ext = strrchr(filename, '.')) == NULL)
229 for (i = 0; i < OSSL_NELEM(extensions); i++) {
230 if (strcasecmp(extensions[i], ext + 1) == 0)
233 if (i >= OSSL_NELEM(extensions))
236 /* Does it have X.509 data in it? */
237 if ((b = BIO_new_file(fullpath, "r")) == NULL) {
238 BIO_printf(bio_err, "%s: skipping %s, cannot open file\n",
239 opt_getprog(), filename);
243 inf = PEM_X509_INFO_read_bio(b, NULL, NULL, NULL);
248 if (sk_X509_INFO_num(inf) != 1) {
251 "it does not contain exactly one certificate or CRL\n",
252 opt_getprog(), filename);
253 /* This is not an error. */
256 x = sk_X509_INFO_value(inf, 0);
259 name = X509_get_subject_name(x->x509);
260 X509_digest(x->x509, evpmd, digest, NULL);
263 name = X509_CRL_get_issuer(x->crl);
264 X509_CRL_digest(x->crl, evpmd, digest, NULL);
270 if ((h == HASH_NEW) || (h == HASH_BOTH))
271 errs += add_entry(type, X509_NAME_hash(name), filename, digest, 1, ~0);
272 if ((h == HASH_OLD) || (h == HASH_BOTH))
273 errs += add_entry(type, X509_NAME_hash_old(name), filename, digest, 1, ~0);
277 sk_X509_INFO_pop_free(inf, X509_INFO_free);
281 static void str_free(char *s)
286 static int ends_with_dirsep(const char *path)
289 path += strlen(path) - 1;
291 if (*path == ']' || *path == '>' || *path == ':')
293 # elif defined _WIN32
300 static int massage_filename(char *name)
303 char *p = strchr(name, ';');
307 for (q++; *q != '\0'; q++) {
319 * Process a directory; return number of errors found.
321 static int do_dir(const char *dirname, enum Hash h)
325 OPENSSL_DIR_CTX *d = NULL;
327 unsigned char idmask[MAX_COLLISIONS / 8];
328 int n, numfiles, nextid, buflen, errs = 0;
331 const char *filename;
333 STACK_OF(OPENSSL_STRING) *files = NULL;
335 if (app_access(dirname, W_OK) < 0) {
336 BIO_printf(bio_err, "Skipping %s, can't write\n", dirname);
339 buflen = strlen(dirname);
340 pathsep = (buflen && !ends_with_dirsep(dirname)) ? "/": "";
341 buflen += NAME_MAX + 1 + 1;
342 buf = app_malloc(buflen, "filename buffer");
345 BIO_printf(bio_out, "Doing %s\n", dirname);
347 if ((files = sk_OPENSSL_STRING_new_null()) == NULL) {
348 BIO_printf(bio_err, "Skipping %s, out of memory\n", dirname);
351 while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) {
352 if ((copy = strdup(filename)) == NULL
353 || !massage_filename(copy)
354 || sk_OPENSSL_STRING_push(files, copy) == 0) {
355 BIO_puts(bio_err, "out of memory\n");
360 sk_OPENSSL_STRING_sort(files);
362 numfiles = sk_OPENSSL_STRING_num(files);
363 for (n = 0; n < numfiles; ++n) {
364 filename = sk_OPENSSL_STRING_value(files, n);
365 if (BIO_snprintf(buf, buflen, "%s%s%s",
366 dirname, pathsep, filename) >= buflen)
368 if (lstat(buf, &st) < 0)
370 if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0)
372 errs += do_file(filename, buf, h);
374 sk_OPENSSL_STRING_pop_free(files, str_free);
376 for (i = 0; i < OSSL_NELEM(hash_table); i++) {
377 for (bp = hash_table[i]; bp; bp = nextbp) {
380 memset(idmask, 0, (bp->num_needed + 7) / 8);
381 for (ep = bp->first_entry; ep; ep = ep->next)
382 if (ep->old_id < bp->num_needed)
383 bit_set(idmask, ep->old_id);
385 for (ep = bp->first_entry; ep; ep = nextep) {
387 if (ep->old_id < bp->num_needed) {
388 /* Link exists, and is used as-is */
389 BIO_snprintf(buf, buflen, "%08x.%s%d", bp->hash,
390 suffixes[bp->type], ep->old_id);
392 BIO_printf(bio_out, "link %s -> %s\n",
394 } else if (ep->need_symlink) {
395 /* New link needed (it may replace something) */
396 while (bit_isset(idmask, nextid))
399 BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d",
400 dirname, pathsep, &n, bp->hash,
401 suffixes[bp->type], nextid);
403 BIO_printf(bio_out, "link %s -> %s\n",
404 ep->filename, &buf[n]);
405 if (unlink(buf) < 0 && errno != ENOENT) {
407 "%s: Can't unlink %s, %s\n",
408 opt_getprog(), buf, strerror(errno));
411 if (symlink(ep->filename, buf) < 0) {
413 "%s: Can't symlink %s, %s\n",
414 opt_getprog(), ep->filename,
418 bit_set(idmask, nextid);
419 } else if (remove_links) {
420 /* Link to be deleted */
421 BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d",
422 dirname, pathsep, &n, bp->hash,
423 suffixes[bp->type], ep->old_id);
425 BIO_printf(bio_out, "unlink %s\n",
427 if (unlink(buf) < 0 && errno != ENOENT) {
429 "%s: Can't unlink %s, %s\n",
430 opt_getprog(), buf, strerror(errno));
434 OPENSSL_free(ep->filename);
439 hash_table[i] = NULL;
446 typedef enum OPTION_choice {
447 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
448 OPT_COMPAT, OPT_OLD, OPT_N, OPT_VERBOSE
451 OPTIONS rehash_options[] = {
452 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [cert-directory...]\n"},
453 {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
454 {"help", OPT_HELP, '-', "Display this summary"},
455 {"h", OPT_HELP, '-', "Display this summary"},
456 {"compat", OPT_COMPAT, '-', "Create both new- and old-style hash links"},
457 {"old", OPT_OLD, '-', "Use old-style hash to generate links"},
458 {"n", OPT_N, '-', "Do not remove existing links"},
459 {"v", OPT_VERBOSE, '-', "Verbose output"},
464 int rehash_main(int argc, char **argv)
466 const char *env, *prog;
470 enum Hash h = HASH_NEW;
472 prog = opt_init(argc, argv, rehash_options);
473 while ((o = opt_next()) != OPT_EOF) {
477 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
480 opt_help(rehash_options);
496 argc = opt_num_rest();
500 evpmdsize = EVP_MD_size(evpmd);
504 errs += do_dir(*argv++, h);
505 } else if ((env = getenv("SSL_CERT_DIR")) != NULL) {
506 m = OPENSSL_strdup(env);
507 for (e = strtok(m, ":"); e != NULL; e = strtok(NULL, ":"))
508 errs += do_dir(e, h);
511 errs += do_dir("/etc/ssl/certs", h);
519 OPTIONS rehash_options[] = {
523 int rehash_main(int argc, char **argv)
525 BIO_printf(bio_err, "Not available; use c_rehash script\n");
529 #endif /* defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) */