1/* 2 * Copyright 2015-2023 The OpenSSL Project Authors. All Rights Reserved. 3 * Copyright (c) 2013-2014 Timo Teräs <timo.teras@gmail.com> 4 * 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 9 */ 10 11#include "apps.h" 12#include "progs.h" 13 14#if defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) || \ 15 (defined(__VMS) && defined(__DECC) && __CRTL_VER >= 80300000) 16# include <unistd.h> 17# include <stdio.h> 18# include <limits.h> 19# include <errno.h> 20# include <string.h> 21# include <ctype.h> 22# include <sys/stat.h> 23 24/* 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. 29 */ 30# ifdef __VMS 31# pragma names save 32# pragma names as_is,shortened 33# endif 34 35# include "internal/o_dir.h" 36 37# ifdef __VMS 38# pragma names restore 39# endif 40 41# include <openssl/evp.h> 42# include <openssl/pem.h> 43# include <openssl/x509.h> 44 45# ifndef PATH_MAX 46# define PATH_MAX 4096 47# endif 48# ifndef NAME_MAX 49# define NAME_MAX 255 50# endif 51# define MAX_COLLISIONS 256 52 53# if defined(OPENSSL_SYS_VXWORKS) 54/* 55 * VxWorks has no symbolic links 56 */ 57 58# define lstat(path, buf) stat(path, buf) 59 60int symlink(const char *target, const char *linkpath) 61{ 62 errno = ENOSYS; 63 return -1; 64} 65 66ssize_t readlink(const char *pathname, char *buf, size_t bufsiz) 67{ 68 errno = ENOSYS; 69 return -1; 70} 71# endif 72 73typedef struct hentry_st { 74 struct hentry_st *next; 75 char *filename; 76 unsigned short old_id; 77 unsigned char need_symlink; 78 unsigned char digest[EVP_MAX_MD_SIZE]; 79} HENTRY; 80 81typedef struct bucket_st { 82 struct bucket_st *next; 83 HENTRY *first_entry, *last_entry; 84 unsigned int hash; 85 unsigned short type; 86 unsigned short num_needed; 87} BUCKET; 88 89enum Type { 90 /* Keep in sync with |suffixes|, below. */ 91 TYPE_CERT=0, TYPE_CRL=1 92}; 93 94enum Hash { 95 HASH_OLD, HASH_NEW, HASH_BOTH 96}; 97 98 99static int evpmdsize; 100static const EVP_MD *evpmd; 101static int remove_links = 1; 102static int verbose = 0; 103static BUCKET *hash_table[257]; 104 105static const char *suffixes[] = { "", "r" }; 106static const char *extensions[] = { "pem", "crt", "cer", "crl" }; 107 108 109static void bit_set(unsigned char *set, unsigned int bit) 110{ 111 set[bit >> 3] |= 1 << (bit & 0x7); 112} 113 114static int bit_isset(unsigned char *set, unsigned int bit) 115{ 116 return set[bit >> 3] & (1 << (bit & 0x7)); 117} 118 119 120/* 121 * Process an entry; return number of errors. 122 */ 123static 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) 126{ 127 static BUCKET nilbucket; 128 static HENTRY nilhentry; 129 BUCKET *bp; 130 HENTRY *ep, *found = NULL; 131 unsigned int ndx = (type + hash) % OSSL_NELEM(hash_table); 132 133 for (bp = hash_table[ndx]; bp; bp = bp->next) 134 if (bp->type == type && bp->hash == hash) 135 break; 136 if (bp == NULL) { 137 bp = app_malloc(sizeof(*bp), "hash bucket"); 138 *bp = nilbucket; 139 bp->next = hash_table[ndx]; 140 bp->type = type; 141 bp->hash = hash; 142 hash_table[ndx] = bp; 143 } 144 145 for (ep = bp->first_entry; ep; ep = ep->next) { 146 if (digest && memcmp(digest, ep->digest, evpmdsize) == 0) { 147 BIO_printf(bio_err, 148 "%s: warning: skipping duplicate %s in %s\n", 149 opt_getprog(), 150 type == TYPE_CERT ? "certificate" : "CRL", filename); 151 return 0; 152 } 153 if (strcmp(filename, ep->filename) == 0) { 154 found = ep; 155 if (digest == NULL) 156 break; 157 } 158 } 159 ep = found; 160 if (ep == NULL) { 161 if (bp->num_needed >= MAX_COLLISIONS) { 162 BIO_printf(bio_err, 163 "%s: error: hash table overflow for %s\n", 164 opt_getprog(), filename); 165 return 1; 166 } 167 ep = app_malloc(sizeof(*ep), "collision bucket"); 168 *ep = nilhentry; 169 ep->old_id = ~0; 170 ep->filename = OPENSSL_strdup(filename); 171 if (ep->filename == NULL) { 172 OPENSSL_free(ep); 173 ep = NULL; 174 BIO_printf(bio_err, "out of memory\n"); 175 return 1; 176 } 177 if (bp->last_entry) 178 bp->last_entry->next = ep; 179 if (bp->first_entry == NULL) 180 bp->first_entry = ep; 181 bp->last_entry = ep; 182 } 183 184 if (old_id < ep->old_id) 185 ep->old_id = old_id; 186 if (need_symlink && !ep->need_symlink) { 187 ep->need_symlink = 1; 188 bp->num_needed++; 189 memcpy(ep->digest, digest, evpmdsize); 190 } 191 return 0; 192} 193 194/* 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. 197 */ 198static int handle_symlink(const char *filename, const char *fullpath) 199{ 200 unsigned int hash = 0; 201 int i, type, id; 202 unsigned char ch; 203 char linktarget[PATH_MAX], *endptr; 204 ossl_ssize_t n; 205 206 for (i = 0; i < 8; i++) { 207 ch = filename[i]; 208 if (!isxdigit(ch)) 209 return -1; 210 hash <<= 4; 211 hash += OPENSSL_hexchar2int(ch); 212 } 213 if (filename[i++] != '.') 214 return -1; 215 for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--) { 216 const char *suffix = suffixes[type]; 217 if (OPENSSL_strncasecmp(suffix, &filename[i], strlen(suffix)) == 0) 218 break; 219 } 220 i += strlen(suffixes[type]); 221 222 id = strtoul(&filename[i], &endptr, 10); 223 if (*endptr != '\0') 224 return -1; 225 226 n = readlink(fullpath, linktarget, sizeof(linktarget)); 227 if (n < 0 || n >= (int)sizeof(linktarget)) 228 return -1; 229 linktarget[n] = 0; 230 231 return add_entry(type, hash, linktarget, NULL, 0, id); 232} 233 234/* 235 * process a file, return number of errors. 236 */ 237static int do_file(const char *filename, const char *fullpath, enum Hash h) 238{ 239 STACK_OF (X509_INFO) *inf = NULL; 240 X509_INFO *x; 241 const X509_NAME *name = NULL; 242 BIO *b; 243 const char *ext; 244 unsigned char digest[EVP_MAX_MD_SIZE]; 245 int type, errs = 0; 246 size_t i; 247 248 /* Does it end with a recognized extension? */ 249 if ((ext = strrchr(filename, '.')) == NULL) 250 goto end; 251 for (i = 0; i < OSSL_NELEM(extensions); i++) { 252 if (OPENSSL_strcasecmp(extensions[i], ext + 1) == 0) 253 break; 254 } 255 if (i >= OSSL_NELEM(extensions)) 256 goto end; 257 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); 262 errs++; 263 goto end; 264 } 265 inf = PEM_X509_INFO_read_bio(b, NULL, NULL, NULL); 266 BIO_free(b); 267 if (inf == NULL) 268 goto end; 269 270 if (sk_X509_INFO_num(inf) != 1) { 271 BIO_printf(bio_err, 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. */ 276 goto end; 277 } 278 x = sk_X509_INFO_value(inf, 0); 279 if (x->x509 != NULL) { 280 type = TYPE_CERT; 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"); 284 ++errs; 285 goto end; 286 } 287 } else if (x->crl != NULL) { 288 type = TYPE_CRL; 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"); 292 ++errs; 293 goto end; 294 } 295 } else { 296 ++errs; 297 goto end; 298 } 299 if (name != NULL) { 300 if (h == HASH_NEW || h == HASH_BOTH) { 301 int ok; 302 unsigned long hash_value = 303 X509_NAME_hash_ex(name, 304 app_get0_libctx(), app_get0_propq(), &ok); 305 306 if (ok) { 307 errs += add_entry(type, hash_value, filename, digest, 1, ~0); 308 } else { 309 BIO_printf(bio_err, "%s: error calculating SHA1 hash value\n", 310 opt_getprog()); 311 errs++; 312 } 313 } 314 if ((h == HASH_OLD) || (h == HASH_BOTH)) 315 errs += add_entry(type, X509_NAME_hash_old(name), 316 filename, digest, 1, ~0); 317 } 318 319end: 320 sk_X509_INFO_pop_free(inf, X509_INFO_free); 321 return errs; 322} 323 324static void str_free(char *s) 325{ 326 OPENSSL_free(s); 327} 328 329static int ends_with_dirsep(const char *path) 330{ 331 if (*path != '\0') 332 path += strlen(path) - 1; 333# if defined __VMS 334 if (*path == ']' || *path == '>' || *path == ':') 335 return 1; 336# elif defined _WIN32 337 if (*path == '\\') 338 return 1; 339# endif 340 return *path == '/'; 341} 342 343static int sk_strcmp(const char * const *a, const char * const *b) 344{ 345 return strcmp(*a, *b); 346} 347 348/* 349 * Process a directory; return number of errors found. 350 */ 351static int do_dir(const char *dirname, enum Hash h) 352{ 353 BUCKET *bp, *nextbp; 354 HENTRY *ep, *nextep; 355 OPENSSL_DIR_CTX *d = NULL; 356 struct stat st; 357 unsigned char idmask[MAX_COLLISIONS / 8]; 358 int n, numfiles, nextid, buflen, errs = 0; 359 size_t i; 360 const char *pathsep; 361 const char *filename; 362 char *buf, *copy = NULL; 363 STACK_OF(OPENSSL_STRING) *files = NULL; 364 365 if (app_access(dirname, W_OK) < 0) { 366 BIO_printf(bio_err, "Skipping %s, can't write\n", dirname); 367 return 1; 368 } 369 buflen = strlen(dirname); 370 pathsep = (buflen && !ends_with_dirsep(dirname)) ? "/": ""; 371 buflen += NAME_MAX + 1 + 1; 372 buf = app_malloc(buflen, "filename buffer"); 373 374 if (verbose) 375 BIO_printf(bio_out, "Doing %s\n", dirname); 376 377 if ((files = sk_OPENSSL_STRING_new(sk_strcmp)) == NULL) { 378 BIO_printf(bio_err, "Skipping %s, out of memory\n", dirname); 379 errs = 1; 380 goto err; 381 } 382 while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) { 383 if ((copy = OPENSSL_strdup(filename)) == NULL 384 || sk_OPENSSL_STRING_push(files, copy) == 0) { 385 OPENSSL_free(copy); 386 BIO_puts(bio_err, "out of memory\n"); 387 errs = 1; 388 goto err; 389 } 390 } 391 OPENSSL_DIR_end(&d); 392 sk_OPENSSL_STRING_sort(files); 393 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) 399 continue; 400 if (lstat(buf, &st) < 0) 401 continue; 402 if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0) 403 continue; 404 errs += do_file(filename, buf, h); 405 } 406 407 for (i = 0; i < OSSL_NELEM(hash_table); i++) { 408 for (bp = hash_table[i]; bp; bp = nextbp) { 409 nextbp = bp->next; 410 nextid = 0; 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); 415 416 for (ep = bp->first_entry; ep; ep = nextep) { 417 nextep = ep->next; 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); 422 if (verbose) 423 BIO_printf(bio_out, "link %s -> %s\n", 424 ep->filename, buf); 425 } else if (ep->need_symlink) { 426 /* New link needed (it may replace something) */ 427 while (bit_isset(idmask, nextid)) 428 nextid++; 429 430 BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d", 431 dirname, pathsep, &n, bp->hash, 432 suffixes[bp->type], nextid); 433 if (verbose) 434 BIO_printf(bio_out, "link %s -> %s\n", 435 ep->filename, &buf[n]); 436 if (unlink(buf) < 0 && errno != ENOENT) { 437 BIO_printf(bio_err, 438 "%s: Can't unlink %s, %s\n", 439 opt_getprog(), buf, strerror(errno)); 440 errs++; 441 } 442 if (symlink(ep->filename, buf) < 0) { 443 BIO_printf(bio_err, 444 "%s: Can't symlink %s, %s\n", 445 opt_getprog(), ep->filename, 446 strerror(errno)); 447 errs++; 448 } 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); 455 if (verbose) 456 BIO_printf(bio_out, "unlink %s\n", 457 &buf[n]); 458 if (unlink(buf) < 0 && errno != ENOENT) { 459 BIO_printf(bio_err, 460 "%s: Can't unlink %s, %s\n", 461 opt_getprog(), buf, strerror(errno)); 462 errs++; 463 } 464 } 465 OPENSSL_free(ep->filename); 466 OPENSSL_free(ep); 467 } 468 OPENSSL_free(bp); 469 } 470 hash_table[i] = NULL; 471 } 472 473 err: 474 sk_OPENSSL_STRING_pop_free(files, str_free); 475 OPENSSL_free(buf); 476 return errs; 477} 478 479typedef enum OPTION_choice { 480 OPT_COMMON, 481 OPT_COMPAT, OPT_OLD, OPT_N, OPT_VERBOSE, 482 OPT_PROV_ENUM 483} OPTION_CHOICE; 484 485const OPTIONS rehash_options[] = { 486 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [directory...]\n"}, 487 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"}, 494 495 OPT_SECTION("Output"), 496 {"v", OPT_VERBOSE, '-', "Verbose output"}, 497 498 OPT_PROV_OPTIONS, 499 500 OPT_PARAMETERS(), 501 {"directory", 0, 0, "One or more directories to process (optional)"}, 502 {NULL} 503}; 504 505 506int rehash_main(int argc, char **argv) 507{ 508 const char *env, *prog; 509 char *e, *m; 510 int errs = 0; 511 OPTION_CHOICE o; 512 enum Hash h = HASH_NEW; 513 514 prog = opt_init(argc, argv, rehash_options); 515 while ((o = opt_next()) != OPT_EOF) { 516 switch (o) { 517 case OPT_EOF: 518 case OPT_ERR: 519 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog); 520 goto end; 521 case OPT_HELP: 522 opt_help(rehash_options); 523 goto end; 524 case OPT_COMPAT: 525 h = HASH_BOTH; 526 break; 527 case OPT_OLD: 528 h = HASH_OLD; 529 break; 530 case OPT_N: 531 remove_links = 0; 532 break; 533 case OPT_VERBOSE: 534 verbose = 1; 535 break; 536 case OPT_PROV_CASES: 537 if (!opt_provider(o)) 538 goto end; 539 break; 540 } 541 } 542 543 /* Optional arguments are directories to scan. */ 544 argc = opt_num_rest(); 545 argv = opt_rest(); 546 547 evpmd = EVP_sha1(); 548 evpmdsize = EVP_MD_get_size(evpmd); 549 550 if (*argv != NULL) { 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); 558 OPENSSL_free(m); 559 } else { 560 errs += do_dir(X509_get_default_cert_dir(), h); 561 } 562 563 end: 564 return errs; 565} 566 567#else 568const OPTIONS rehash_options[] = { 569 {NULL} 570}; 571 572int rehash_main(int argc, char **argv) 573{ 574 BIO_printf(bio_err, "Not available; use c_rehash script\n"); 575 return 1; 576} 577 578#endif /* defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) */ 579