apps/rehash.c

   1 /*
   2  * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   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
   8  */
   9
  10 /*
  11  * C implementation based on the original Perl and shell versions
  12  *
  13  * Copyright (c) 2013-2014 Timo Teräs <timo.teras@iki.fi>
  14  */
  15
  16 #include "apps.h"
  17
  18 #if defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) || \
  19     (defined(__VMS) && defined(__DECC) && __CRTL_VER >= 80300000)
  20 # include <unistd.h>
  21 # include <stdio.h>
  22 # include <limits.h>
  23 # include <errno.h>
  24 # include <string.h>
  25 # include <ctype.h>
  26 # include <sys/stat.h>
  27
  28 # include "internal/o_dir.h"
  29 # include <openssl/evp.h>
  30 # include <openssl/pem.h>
  31 # include <openssl/x509.h>
  32
  33
  34 # ifndef PATH_MAX
  35 #  define PATH_MAX 4096
  36 # endif
  37 # ifndef NAME_MAX
  38 #  define NAME_MAX 255
  39 # endif
  40 # define MAX_COLLISIONS  256
  41
  42 typedef struct hentry_st {
  43     struct hentry_st *next;
  44     char *filename;
  45     unsigned short old_id;
  46     unsigned char need_symlink;
  47     unsigned char digest[EVP_MAX_MD_SIZE];
  48 } HENTRY;
  49
  50 typedef struct bucket_st {
  51     struct bucket_st *next;
  52     HENTRY *first_entry, *last_entry;
  53     unsigned int hash;
  54     unsigned short type;
  55     unsigned short num_needed;
  56 } BUCKET;
  57
  58 enum Type {
  59     /* Keep in sync with |suffixes|, below. */
  60     TYPE_CERT=0, TYPE_CRL=1
  61 };
  62
  63 enum Hash {
  64     HASH_OLD, HASH_NEW, HASH_BOTH
  65 };
  66
  67
  68 static int evpmdsize;
  69 static const EVP_MD *evpmd;
  70 static int remove_links = 1;
  71 static int verbose = 0;
  72 static BUCKET *hash_table[257];
  73
  74 static const char *suffixes[] = { "", "r" };
  75 static const char *extensions[] = { "pem", "crt", "cer", "crl" };
  76
  77
  78 static void bit_set(unsigned char *set, unsigned int bit)
  79 {
  80     set[bit >> 3] |= 1 << (bit & 0x7);
  81 }
  82
  83 static int bit_isset(unsigned char *set, unsigned int bit)
  84 {
  85     return set[bit >> 3] & (1 << (bit & 0x7));
  86 }
  87
  88
  89 /*
  90  * Process an entry; return number of errors.
  91  */
  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)
  95 {
  96     static BUCKET nilbucket;
  97     static HENTRY nilhentry;
  98     BUCKET *bp;
  99     HENTRY *ep, *found = NULL;
 100     unsigned int ndx = (type + hash) % OSSL_NELEM(hash_table);
 101
 102     for (bp = hash_table[ndx]; bp; bp = bp->next)
 103         if (bp->type == type && bp->hash == hash)
 104             break;
 105     if (bp == NULL) {
 106         bp = app_malloc(sizeof(*bp), "hash bucket");
 107         *bp = nilbucket;
 108         bp->next = hash_table[ndx];
 109         bp->type = type;
 110         bp->hash = hash;
 111         hash_table[ndx] = bp;
 112     }
 113
 114     for (ep = bp->first_entry; ep; ep = ep->next) {
 115         if (digest && memcmp(digest, ep->digest, evpmdsize) == 0) {
 116             BIO_printf(bio_err,
 117                        "%s: skipping duplicate %s in %s\n", opt_getprog(),
 118                        type == TYPE_CERT ? "certificate" : "CRL", filename);
 119             return 1;
 120         }
 121         if (strcmp(filename, ep->filename) == 0) {
 122             found = ep;
 123             if (digest == NULL)
 124                 break;
 125         }
 126     }
 127     ep = found;
 128     if (ep == NULL) {
 129         if (bp->num_needed >= MAX_COLLISIONS) {
 130             BIO_printf(bio_err,
 131                        "%s: hash table overflow for %s\n",
 132                        opt_getprog(), filename);
 133             return 1;
 134         }
 135         ep = app_malloc(sizeof(*ep), "collision bucket");
 136         *ep = nilhentry;
 137         ep->old_id = ~0;
 138         ep->filename = OPENSSL_strdup(filename);
 139         if (bp->last_entry)
 140             bp->last_entry->next = ep;
 141         if (bp->first_entry == NULL)
 142             bp->first_entry = ep;
 143         bp->last_entry = ep;
 144     }
 145
 146     if (old_id < ep->old_id)
 147         ep->old_id = old_id;
 148     if (need_symlink && !ep->need_symlink) {
 149         ep->need_symlink = 1;
 150         bp->num_needed++;
 151         memcpy(ep->digest, digest, evpmdsize);
 152     }
 153     return 0;
 154 }
 155
 156 /*
 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.
 159  */
 160 static int handle_symlink(const char *filename, const char *fullpath)
 161 {
 162     unsigned int hash = 0;
 163     int i, type, id;
 164     unsigned char ch;
 165     char linktarget[PATH_MAX], *endptr;
 166     ossl_ssize_t n;
 167
 168     for (i = 0; i < 8; i++) {
 169         ch = filename[i];
 170         if (!isxdigit(ch))
 171             return -1;
 172         hash <<= 4;
 173         hash += OPENSSL_hexchar2int(ch);
 174     }
 175     if (filename[i++] != '.')
 176         return -1;
 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)
 180             break;
 181     }
 182     i += strlen(suffixes[type]);
 183
 184     id = strtoul(&filename[i], &endptr, 10);
 185     if (*endptr != '\0')
 186         return -1;
 187
 188     n = readlink(fullpath, linktarget, sizeof(linktarget));
 189     if (n < 0 || n >= (int)sizeof(linktarget))
 190         return -1;
 191     linktarget[n] = 0;
 192
 193     return add_entry(type, hash, linktarget, NULL, 0, id);
 194 }
 195
 196 /*
 197  * process a file, return number of errors.
 198  */
 199 static int do_file(const char *filename, const char *fullpath, enum Hash h)
 200 {
 201     STACK_OF (X509_INFO) *inf = NULL;
 202     X509_INFO *x;
 203     X509_NAME *name = NULL;
 204     BIO *b;
 205     const char *ext;
 206     unsigned char digest[EVP_MAX_MD_SIZE];
 207     int type, errs = 0;
 208     size_t i;
 209
 210     /* Does it end with a recognized extension? */
 211     if ((ext = strrchr(filename, '.')) == NULL)
 212         goto end;
 213     for (i = 0; i < OSSL_NELEM(extensions); i++) {
 214         if (strcasecmp(extensions[i], ext + 1) == 0)
 215             break;
 216     }
 217     if (i >= OSSL_NELEM(extensions))
 218         goto end;
 219
 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);
 224         errs++;
 225         goto end;
 226     }
 227     inf = PEM_X509_INFO_read_bio(b, NULL, NULL, NULL);
 228     BIO_free(b);
 229     if (inf == NULL)
 230         goto end;
 231
 232     if (sk_X509_INFO_num(inf) != 1) {
 233         BIO_printf(bio_err,
 234                    "%s: skipping %s,"
 235                    "it does not contain exactly one certificate or CRL\n",
 236                    opt_getprog(), filename);
 237         /* This is not an error. */
 238         goto end;
 239     }
 240     x = sk_X509_INFO_value(inf, 0);
 241     if (x->x509) {
 242         type = TYPE_CERT;
 243         name = X509_get_subject_name(x->x509);
 244         X509_digest(x->x509, evpmd, digest, NULL);
 245     } else if (x->crl) {
 246         type = TYPE_CRL;
 247         name = X509_CRL_get_issuer(x->crl);
 248         X509_CRL_digest(x->crl, evpmd, digest, NULL);
 249     } else {
 250         ++errs;
 251         goto end;
 252     }
 253     if (name) {
 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);
 258     }
 259
 260 end:
 261     sk_X509_INFO_pop_free(inf, X509_INFO_free);
 262     return errs;
 263 }
 264
 265 static void str_free(char *s)
 266 {
 267     OPENSSL_free(s);
 268 }
 269
 270 static int ends_with_dirsep(const char *path)
 271 {
 272     if (*path != '\0')
 273         path += strlen(path) - 1;
 274 # ifdef __VMS
 275     if (*path == ']' || *path == '>' || *path == ':')
 276         return 1;
 277 # elif _WIN32
 278     if (*path == '\\')
 279         return 1;
 280 # endif
 281     return *path == '/';
 282 }
 283
 284 /*
 285  * Process a directory; return number of errors found.
 286  */
 287 static int do_dir(const char *dirname, enum Hash h)
 288 {
 289     BUCKET *bp, *nextbp;
 290     HENTRY *ep, *nextep;
 291     OPENSSL_DIR_CTX *d = NULL;
 292     struct stat st;
 293     unsigned char idmask[MAX_COLLISIONS / 8];
 294     int n, numfiles, nextid, buflen, errs = 0;
 295     size_t i;
 296     const char *pathsep;
 297     const char *filename;
 298     char *buf, *copy;
 299     STACK_OF(OPENSSL_STRING) *files = NULL;
 300
 301     if (app_access(dirname, W_OK) < 0) {
 302         BIO_printf(bio_err, "Skipping %s, can't write\n", dirname);
 303         return 1;
 304     }
 305     buflen = strlen(dirname);
 306     pathsep = (buflen && !ends_with_dirsep(dirname)) ? "/": "";
 307     buflen += NAME_MAX + 1 + 1;
 308     buf = app_malloc(buflen, "filename buffer");
 309
 310     if (verbose)
 311         BIO_printf(bio_out, "Doing %s\n", dirname);
 312
 313     if ((files = sk_OPENSSL_STRING_new_null()) == NULL) {
 314         BIO_printf(bio_err, "Skipping %s, out of memory\n", dirname);
 315         exit(1);
 316     }
 317     while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) {
 318         if ((copy = strdup(filename)) == NULL
 319                 || sk_OPENSSL_STRING_push(files, copy) == 0) {
 320             BIO_puts(bio_err, "out of memory\n");
 321             exit(1);
 322         }
 323     }
 324     OPENSSL_DIR_end(&d);
 325     sk_OPENSSL_STRING_sort(files);
 326
 327     numfiles = sk_OPENSSL_STRING_num(files);
 328     for (n = 0; n < numfiles; ++n) {
 329         filename = sk_OPENSSL_STRING_value(files, n);
 330         if (snprintf(buf, buflen, "%s%s%s",
 331                     dirname, pathsep, filename) >= buflen)
 332             continue;
 333         if (lstat(buf, &st) < 0)
 334             continue;
 335         if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0)
 336             continue;
 337         errs += do_file(filename, buf, h);
 338     }
 339     sk_OPENSSL_STRING_pop_free(files, str_free);
 340
 341     for (i = 0; i < OSSL_NELEM(hash_table); i++) {
 342         for (bp = hash_table[i]; bp; bp = nextbp) {
 343             nextbp = bp->next;
 344             nextid = 0;
 345             memset(idmask, 0, (bp->num_needed + 7) / 8);
 346             for (ep = bp->first_entry; ep; ep = ep->next)
 347                 if (ep->old_id < bp->num_needed)
 348                     bit_set(idmask, ep->old_id);
 349
 350             for (ep = bp->first_entry; ep; ep = nextep) {
 351                 nextep = ep->next;
 352                 if (ep->old_id < bp->num_needed) {
 353                     /* Link exists, and is used as-is */
 354                     snprintf(buf, buflen, "%08x.%s%d", bp->hash,
 355                              suffixes[bp->type], ep->old_id);
 356                     if (verbose)
 357                         BIO_printf(bio_out, "link %s -> %s\n",
 358                                    ep->filename, buf);
 359                 } else if (ep->need_symlink) {
 360                     /* New link needed (it may replace something) */
 361                     while (bit_isset(idmask, nextid))
 362                         nextid++;
 363
 364                     snprintf(buf, buflen, "%s%s%n%08x.%s%d",
 365                              dirname, pathsep, &n, bp->hash,
 366                              suffixes[bp->type], nextid);
 367                     if (verbose)
 368                         BIO_printf(bio_out, "link %s -> %s\n",
 369                                    ep->filename, &buf[n]);
 370                     if (unlink(buf) < 0 && errno != ENOENT) {
 371                         BIO_printf(bio_err,
 372                                    "%s: Can't unlink %s, %s\n",
 373                                    opt_getprog(), buf, strerror(errno));
 374                         errs++;
 375                     }
 376                     if (symlink(ep->filename, buf) < 0) {
 377                         BIO_printf(bio_err,
 378                                    "%s: Can't symlink %s, %s\n",
 379                                    opt_getprog(), ep->filename,
 380                                    strerror(errno));
 381                         errs++;
 382                     }
 383                     bit_set(idmask, nextid);
 384                 } else if (remove_links) {
 385                     /* Link to be deleted */
 386                     snprintf(buf, buflen, "%s%s%n%08x.%s%d",
 387                              dirname, pathsep, &n, bp->hash,
 388                              suffixes[bp->type], ep->old_id);
 389                     if (verbose)
 390                         BIO_printf(bio_out, "unlink %s\n",
 391                                    &buf[n]);
 392                     if (unlink(buf) < 0 && errno != ENOENT) {
 393                         BIO_printf(bio_err,
 394                                    "%s: Can't unlink %s, %s\n",
 395                                    opt_getprog(), buf, strerror(errno));
 396                         errs++;
 397                     }
 398                 }
 399                 OPENSSL_free(ep->filename);
 400                 OPENSSL_free(ep);
 401             }
 402             OPENSSL_free(bp);
 403         }
 404         hash_table[i] = NULL;
 405     }
 406
 407     OPENSSL_free(buf);
 408     return errs;
 409 }
 410
 411 typedef enum OPTION_choice {
 412     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
 413     OPT_COMPAT, OPT_OLD, OPT_N, OPT_VERBOSE
 414 } OPTION_CHOICE;
 415
 416 const OPTIONS rehash_options[] = {
 417     {OPT_HELP_STR, 1, '-', "Usage: %s [options] [cert-directory...]\n"},
 418     {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
 419     {"help", OPT_HELP, '-', "Display this summary"},
 420     {"h", OPT_HELP, '-', "Display this summary"},
 421     {"compat", OPT_COMPAT, '-', "Create both new- and old-style hash links"},
 422     {"old", OPT_OLD, '-', "Use old-style hash to generate links"},
 423     {"n", OPT_N, '-', "Do not remove existing links"},
 424     {"v", OPT_VERBOSE, '-', "Verbose output"},
 425     {NULL}
 426 };
 427
 428
 429 int rehash_main(int argc, char **argv)
 430 {
 431     const char *env, *prog;
 432     char *e, *m;
 433     int errs = 0;
 434     OPTION_CHOICE o;
 435     enum Hash h = HASH_NEW;
 436
 437     prog = opt_init(argc, argv, rehash_options);
 438     while ((o = opt_next()) != OPT_EOF) {
 439         switch (o) {
 440         case OPT_EOF:
 441         case OPT_ERR:
 442             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 443             goto end;
 444         case OPT_HELP:
 445             opt_help(rehash_options);
 446             goto end;
 447         case OPT_COMPAT:
 448             h = HASH_BOTH;
 449             break;
 450         case OPT_OLD:
 451             h = HASH_OLD;
 452             break;
 453         case OPT_N:
 454             remove_links = 0;
 455             break;
 456         case OPT_VERBOSE:
 457             verbose = 1;
 458             break;
 459         }
 460     }
 461     argc = opt_num_rest();
 462     argv = opt_rest();
 463
 464     evpmd = EVP_sha1();
 465     evpmdsize = EVP_MD_size(evpmd);
 466
 467     if (*argv) {
 468         while (*argv)
 469             errs += do_dir(*argv++, h);
 470     } else if ((env = getenv("SSL_CERT_DIR")) != NULL) {
 471         m = OPENSSL_strdup(env);
 472         for (e = strtok(m, ":"); e != NULL; e = strtok(NULL, ":"))
 473             errs += do_dir(e, h);
 474         OPENSSL_free(m);
 475     } else {
 476         errs += do_dir("/etc/ssl/certs", h);
 477     }
 478
 479  end:
 480     return errs;
 481 }
 482
 483 #else
 484 const OPTIONS rehash_options[] = {
 485     {NULL}
 486 };
 487
 488 int rehash_main(int argc, char **argv)
 489 {
 490     BIO_printf(bio_err, "Not available; use c_rehash script\n");
 491     return (1);
 492 }
 493
 494 #endif /* defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) */