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) && __CTRL_VER >= 80300000)
26 # include <sys/stat.h>
28 # include "internal/o_dir.h"
29 # include <openssl/evp.h>
30 # include <openssl/pem.h>
31 # include <openssl/x509.h>
35 # define PATH_MAX 4096
40 # define MAX_COLLISIONS 256
42 typedef struct hentry_st {
43 struct hentry_st *next;
45 unsigned short old_id;
46 unsigned char need_symlink;
47 unsigned char digest[EVP_MAX_MD_SIZE];
50 typedef struct bucket_st {
51 struct bucket_st *next;
52 HENTRY *first_entry, *last_entry;
55 unsigned short num_needed;
59 /* Keep in sync with |suffixes|, below. */
60 TYPE_CERT=0, TYPE_CRL=1
64 HASH_OLD, HASH_NEW, HASH_BOTH
69 static const EVP_MD *evpmd;
70 static int remove_links = 1;
71 static int verbose = 0;
72 static BUCKET *hash_table[257];
74 static const char *suffixes[] = { "", "r" };
75 static const char *extensions[] = { "pem", "crt", "cer", "crl" };
78 static void bit_set(unsigned char *set, unsigned int bit)
80 set[bit >> 3] |= 1 << (bit & 0x7);
83 static int bit_isset(unsigned char *set, unsigned int bit)
85 return set[bit >> 3] & (1 << (bit & 0x7));
90 * Process an entry; return number of errors.
92 static int add_entry(enum Type type, unsigned int hash, const char *filename,
93 const unsigned char *digest, int need_symlink,
94 unsigned short old_id)
96 static BUCKET nilbucket;
97 static HENTRY nilhentry;
99 HENTRY *ep, *found = NULL;
100 unsigned int ndx = (type + hash) % OSSL_NELEM(hash_table);
102 for (bp = hash_table[ndx]; bp; bp = bp->next)
103 if (bp->type == type && bp->hash == hash)
106 bp = app_malloc(sizeof(*bp), "hash bucket");
108 bp->next = hash_table[ndx];
111 hash_table[ndx] = bp;
114 for (ep = bp->first_entry; ep; ep = ep->next) {
115 if (digest && memcmp(digest, ep->digest, evpmdsize) == 0) {
117 "%s: skipping duplicate %s in %s\n", opt_getprog(),
118 type == TYPE_CERT ? "certificate" : "CRL", filename);
121 if (strcmp(filename, ep->filename) == 0) {
129 if (bp->num_needed >= MAX_COLLISIONS) {
131 "%s: hash table overflow for %s\n",
132 opt_getprog(), filename);
135 ep = app_malloc(sizeof(*ep), "collision bucket");
138 ep->filename = OPENSSL_strdup(filename);
140 bp->last_entry->next = ep;
141 if (bp->first_entry == NULL)
142 bp->first_entry = ep;
146 if (old_id < ep->old_id)
148 if (need_symlink && !ep->need_symlink) {
149 ep->need_symlink = 1;
151 memcpy(ep->digest, digest, evpmdsize);
157 * Check if a symlink goes to the right spot; return 0 if okay.
158 * This can be -1 if bad filename, or an error count.
160 static int handle_symlink(const char *filename, const char *fullpath)
162 unsigned int hash = 0;
165 char linktarget[PATH_MAX], *endptr;
168 for (i = 0; i < 8; i++) {
173 hash += OPENSSL_hexchar2int(ch);
175 if (filename[i++] != '.')
177 for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--) {
178 const char *suffix = suffixes[type];
179 if (strncasecmp(suffix, &filename[i], strlen(suffix)) == 0)
182 i += strlen(suffixes[type]);
184 id = strtoul(&filename[i], &endptr, 10);
188 n = readlink(fullpath, linktarget, sizeof(linktarget));
189 if (n < 0 || n >= (int)sizeof(linktarget))
193 return add_entry(type, hash, linktarget, NULL, 0, id);
197 * process a file, return number of errors.
199 static int do_file(const char *filename, const char *fullpath, enum Hash h)
201 STACK_OF (X509_INFO) *inf = NULL;
203 X509_NAME *name = NULL;
206 unsigned char digest[EVP_MAX_MD_SIZE];
210 /* Does it end with a recognized extension? */
211 if ((ext = strrchr(filename, '.')) == NULL)
213 for (i = 0; i < OSSL_NELEM(extensions); i++) {
214 if (strcasecmp(extensions[i], ext + 1) == 0)
217 if (i >= OSSL_NELEM(extensions))
220 /* Does it have X.509 data in it? */
221 if ((b = BIO_new_file(fullpath, "r")) == NULL) {
222 BIO_printf(bio_err, "%s: skipping %s, cannot open file\n",
223 opt_getprog(), filename);
227 inf = PEM_X509_INFO_read_bio(b, NULL, NULL, NULL);
232 if (sk_X509_INFO_num(inf) != 1) {
235 "it does not contain exactly one certificate or CRL\n",
236 opt_getprog(), filename);
237 /* This is not an error. */
240 x = sk_X509_INFO_value(inf, 0);
243 name = X509_get_subject_name(x->x509);
244 X509_digest(x->x509, evpmd, digest, NULL);
247 name = X509_CRL_get_issuer(x->crl);
248 X509_CRL_digest(x->crl, evpmd, digest, NULL);
254 if ((h == HASH_NEW) || (h == HASH_BOTH))
255 errs += add_entry(type, X509_NAME_hash(name), filename, digest, 1, ~0);
256 if ((h == HASH_OLD) || (h == HASH_BOTH))
257 errs += add_entry(type, X509_NAME_hash_old(name), filename, digest, 1, ~0);
261 sk_X509_INFO_pop_free(inf, X509_INFO_free);
265 static void str_free(char *s)
271 * Process a directory; return number of errors found.
273 static int do_dir(const char *dirname, enum Hash h)
277 OPENSSL_DIR_CTX *d = NULL;
279 unsigned char idmask[MAX_COLLISIONS / 8];
280 int n, numfiles, nextid, buflen, errs = 0;
283 const char *filename;
285 STACK_OF(OPENSSL_STRING) *files = NULL;
287 if (app_access(dirname, W_OK) < 0) {
288 BIO_printf(bio_err, "Skipping %s, can't write\n", dirname);
291 buflen = strlen(dirname);
292 pathsep = (buflen && dirname[buflen - 1] == '/') ? "" : "/";
293 buflen += NAME_MAX + 1 + 1;
294 buf = app_malloc(buflen, "filename buffer");
297 BIO_printf(bio_out, "Doing %s\n", dirname);
299 if ((files = sk_OPENSSL_STRING_new_null()) == NULL) {
300 BIO_printf(bio_err, "Skipping %s, out of memory\n", dirname);
303 while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) {
304 if ((copy = strdup(filename)) == NULL
305 || sk_OPENSSL_STRING_push(files, copy) == 0) {
306 BIO_puts(bio_err, "out of memory\n");
311 sk_OPENSSL_STRING_sort(files);
313 numfiles = sk_OPENSSL_STRING_num(files);
314 for (n = 0; n < numfiles; ++n) {
315 filename = sk_OPENSSL_STRING_value(files, n);
316 if (snprintf(buf, buflen, "%s%s%s",
317 dirname, pathsep, filename) >= buflen)
319 if (lstat(buf, &st) < 0)
321 if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0)
323 errs += do_file(filename, buf, h);
325 sk_OPENSSL_STRING_pop_free(files, str_free);
327 for (i = 0; i < OSSL_NELEM(hash_table); i++) {
328 for (bp = hash_table[i]; bp; bp = nextbp) {
331 memset(idmask, 0, (bp->num_needed + 7) / 8);
332 for (ep = bp->first_entry; ep; ep = ep->next)
333 if (ep->old_id < bp->num_needed)
334 bit_set(idmask, ep->old_id);
336 for (ep = bp->first_entry; ep; ep = nextep) {
338 if (ep->old_id < bp->num_needed) {
339 /* Link exists, and is used as-is */
340 snprintf(buf, buflen, "%08x.%s%d", bp->hash,
341 suffixes[bp->type], ep->old_id);
343 BIO_printf(bio_out, "link %s -> %s\n",
345 } else if (ep->need_symlink) {
346 /* New link needed (it may replace something) */
347 while (bit_isset(idmask, nextid))
350 snprintf(buf, buflen, "%s%s%n%08x.%s%d",
351 dirname, pathsep, &n, bp->hash,
352 suffixes[bp->type], nextid);
354 BIO_printf(bio_out, "link %s -> %s\n",
355 ep->filename, &buf[n]);
356 if (unlink(buf) < 0 && errno != ENOENT) {
358 "%s: Can't unlink %s, %s\n",
359 opt_getprog(), buf, strerror(errno));
362 if (symlink(ep->filename, buf) < 0) {
364 "%s: Can't symlink %s, %s\n",
365 opt_getprog(), ep->filename,
369 bit_set(idmask, nextid);
370 } else if (remove_links) {
371 /* Link to be deleted */
372 snprintf(buf, buflen, "%s%s%n%08x.%s%d",
373 dirname, pathsep, &n, bp->hash,
374 suffixes[bp->type], ep->old_id);
376 BIO_printf(bio_out, "unlink %s\n",
378 if (unlink(buf) < 0 && errno != ENOENT) {
380 "%s: Can't unlink %s, %s\n",
381 opt_getprog(), buf, strerror(errno));
385 OPENSSL_free(ep->filename);
390 hash_table[i] = NULL;
397 typedef enum OPTION_choice {
398 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
399 OPT_COMPAT, OPT_OLD, OPT_N, OPT_VERBOSE
402 OPTIONS rehash_options[] = {
403 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [cert-directory...]\n"},
404 {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
405 {"help", OPT_HELP, '-', "Display this summary"},
406 {"compat", OPT_COMPAT, '-', "Create both new- and old-style hash links"},
407 {"old", OPT_OLD, '-', "Use old-style hash to generate links"},
408 {"n", OPT_N, '-', "Do not remove existing links"},
409 {"v", OPT_VERBOSE, '-', "Verbose output"},
414 int rehash_main(int argc, char **argv)
416 const char *env, *prog;
420 enum Hash h = HASH_NEW;
422 prog = opt_init(argc, argv, rehash_options);
423 while ((o = opt_next()) != OPT_EOF) {
427 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
430 opt_help(rehash_options);
446 argc = opt_num_rest();
450 evpmdsize = EVP_MD_size(evpmd);
454 errs += do_dir(*argv++, h);
455 } else if ((env = getenv("SSL_CERT_DIR")) != NULL) {
456 m = OPENSSL_strdup(env);
457 for (e = strtok(m, ":"); e != NULL; e = strtok(NULL, ":"))
458 errs += do_dir(e, h);
461 errs += do_dir("/etc/ssl/certs", h);
469 OPTIONS rehash_options[] = {
473 int rehash_main(int argc, char **argv)
475 BIO_printf(bio_err, "Not available; use c_rehash script\n");
479 #endif /* defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) */