apps/rehash.c

   1 /*
   2  * C implementation based on the original Perl and shell versions
   3  *
   4  * Copyright (c) 2013-2014 Timo Teräs <timo.teras@iki.fi>
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include "apps.h"
  61
  62 #if defined(unix) || defined(__APPLE__)
  63 # include <unistd.h>
  64 # include <stdio.h>
  65 # include <limits.h>
  66 # include <errno.h>
  67 # include <string.h>
  68 # include <ctype.h>
  69 # include <sys/stat.h>
  70
  71 # include "internal/o_dir.h"
  72 # include <openssl/evp.h>
  73 # include <openssl/pem.h>
  74 # include <openssl/x509.h>
  75
  76
  77 # define MAX_COLLISIONS  256
  78
  79 typedef struct hentry_st {
  80     struct hentry_st *next;
  81     char *filename;
  82     unsigned short old_id;
  83     unsigned char need_symlink;
  84     unsigned char digest[EVP_MAX_MD_SIZE];
  85 } HENTRY;
  86
  87 typedef struct bucket_st {
  88     struct bucket_st *next;
  89     HENTRY *first_entry, *last_entry;
  90     unsigned int hash;
  91     unsigned short type;
  92     unsigned short num_needed;
  93 } BUCKET;
  94
  95 enum Type {
  96     /* Keep in sync with |suffixes|, below. */
  97     TYPE_CERT=0, TYPE_CRL=1
  98 };
  99
 100 enum Hash {
 101     HASH_OLD, HASH_NEW, HASH_BOTH
 102 };
 103
 104
 105 static int evpmdsize;
 106 static const EVP_MD *evpmd;
 107 static int remove_links = 1;
 108 static int verbose = 0;
 109 static BUCKET *hash_table[257];
 110
 111 static const char *suffixes[] = { "", "r" };
 112 static const char *extensions[] = { "pem", "crt", "cer", "crl" };
 113
 114
 115 static void bit_set(unsigned char *set, unsigned int bit)
 116 {
 117     set[bit >> 3] |= 1 << (bit & 0x7);
 118 }
 119
 120 static int bit_isset(unsigned char *set, unsigned int bit)
 121 {
 122     return set[bit >> 3] & (1 << (bit & 0x7));
 123 }
 124
 125
 126 /*
 127  * Process an entry; return number of errors.
 128  */
 129 static int add_entry(enum Type type, unsigned int hash, const char *filename,
 130                       const unsigned char *digest, int need_symlink,
 131                       unsigned short old_id)
 132 {
 133     static BUCKET nilbucket;
 134     static HENTRY nilhentry;
 135     BUCKET *bp;
 136     HENTRY *ep, *found = NULL;
 137     unsigned int ndx = (type + hash) % OSSL_NELEM(hash_table);
 138
 139     for (bp = hash_table[ndx]; bp; bp = bp->next)
 140         if (bp->type == type && bp->hash == hash)
 141             break;
 142     if (bp == NULL) {
 143         bp = app_malloc(sizeof(*bp), "hash bucket");
 144         *bp = nilbucket;
 145         bp->next = hash_table[ndx];
 146         bp->type = type;
 147         bp->hash = hash;
 148         hash_table[ndx] = bp;
 149     }
 150
 151     for (ep = bp->first_entry; ep; ep = ep->next) {
 152         if (digest && memcmp(digest, ep->digest, evpmdsize) == 0) {
 153             BIO_printf(bio_err,
 154                        "%s: skipping duplicate certificate in %s\n",
 155                        opt_getprog(), filename);
 156             return 1;
 157         }
 158         if (strcmp(filename, ep->filename) == 0) {
 159             found = ep;
 160             if (digest == NULL)
 161                 break;
 162         }
 163     }
 164     ep = found;
 165     if (ep == NULL) {
 166         if (bp->num_needed >= MAX_COLLISIONS) {
 167             BIO_printf(bio_err,
 168                        "%s: hash table overflow for %s\n",
 169                        opt_getprog(), filename);
 170             return 1;
 171         }
 172         ep = app_malloc(sizeof(*ep), "collision bucket");
 173         *ep = nilhentry;
 174         ep->old_id = ~0;
 175         ep->filename = BUF_strdup(filename);
 176         if (bp->last_entry)
 177             bp->last_entry->next = ep;
 178         if (bp->first_entry == NULL)
 179             bp->first_entry = ep;
 180         bp->last_entry = ep;
 181     }
 182
 183     if (old_id < ep->old_id)
 184         ep->old_id = old_id;
 185     if (need_symlink && !ep->need_symlink) {
 186         ep->need_symlink = 1;
 187         bp->num_needed++;
 188         memcpy(ep->digest, digest, evpmdsize);
 189     }
 190     return 0;
 191 }
 192
 193 /*
 194  * Check if a symlink goes to the right spot; return 0 if okay.
 195  * This can be -1 if bad filename, or an error count.
 196  */
 197 static int handle_symlink(const char *filename, const char *fullpath)
 198 {
 199     unsigned int hash = 0;
 200     int i, type, id;
 201     unsigned char ch;
 202     char linktarget[NAME_MAX], *endptr;
 203     ssize_t n;
 204
 205     for (i = 0; i < 8; i++) {
 206         ch = filename[i];
 207         if (!isxdigit(ch))
 208             return -1;
 209         hash <<= 4;
 210         hash += app_hex(ch);
 211     }
 212     if (filename[i++] != '.')
 213         return -1;
 214     for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--)
 215         if (strcasecmp(suffixes[type], &filename[i]) == 0)
 216             break;
 217     i += strlen(suffixes[type]);
 218
 219     id = strtoul(&filename[i], &endptr, 10);
 220     if (*endptr != '\0')
 221         return -1;
 222
 223     n = readlink(fullpath, linktarget, sizeof(linktarget));
 224     if (n < 0 || n >= (int)sizeof(linktarget))
 225         return -1;
 226     linktarget[n] = 0;
 227
 228     return add_entry(type, hash, linktarget, NULL, 0, id);
 229 }
 230
 231 /*
 232  * process a file, return number of errors.
 233  */
 234 static int do_file(const char *filename, const char *fullpath, enum Hash h)
 235 {
 236     STACK_OF (X509_INFO) *inf = NULL;
 237     X509_INFO *x;
 238     X509_NAME *name = NULL;
 239     BIO *b;
 240     const char *ext;
 241     unsigned char digest[EVP_MAX_MD_SIZE];
 242     int i, type, errs = 0;
 243
 244     /* Does it end with a recognized extension? */
 245     if ((ext = strrchr(filename, '.')) == NULL)
 246         goto end;
 247     for (i = 0; i < (int)OSSL_NELEM(extensions); i++) {
 248         if (strcasecmp(extensions[i], ext + 1) == 0)
 249             break;
 250     }
 251     if (i >= (int)OSSL_NELEM(extensions))
 252         goto end;
 253
 254     /* Does it have X.509 data in it? */
 255     if ((b = BIO_new_file(fullpath, "r")) == NULL) {
 256         BIO_printf(bio_err, "%s: skipping %s, cannot open file\n",
 257                    opt_getprog(), filename);
 258         errs++;
 259         goto end;
 260     }
 261     inf = PEM_X509_INFO_read_bio(b, NULL, NULL, NULL);
 262     BIO_free(b);
 263     if (inf == NULL)
 264         goto end;
 265
 266     if (sk_X509_INFO_num(inf) != 1) {
 267         BIO_printf(bio_err,
 268                    "%s: skipping %s,"
 269                    "it does not contain exactly one certificate or CRL\n",
 270                    opt_getprog(), filename);
 271         /* This is not an error. */
 272         goto end;
 273     }
 274     x = sk_X509_INFO_value(inf, 0);
 275     if (x->x509) {
 276         type = TYPE_CERT;
 277         name = X509_get_subject_name(x->x509);
 278         X509_digest(x->x509, evpmd, digest, NULL);
 279     } else if (x->crl) {
 280         type = TYPE_CRL;
 281         name = X509_CRL_get_issuer(x->crl);
 282         X509_CRL_digest(x->crl, evpmd, digest, NULL);
 283     }
 284     if (name) {
 285         if ((h == HASH_NEW) || (h == HASH_BOTH))
 286             errs += add_entry(type, X509_NAME_hash(name), filename, digest, 1, ~0);
 287         if ((h == HASH_OLD) || (h == HASH_BOTH))
 288             errs += add_entry(type, X509_NAME_hash_old(name), filename, digest, 1, ~0);
 289     }
 290
 291 end:
 292     sk_X509_INFO_pop_free(inf, X509_INFO_free);
 293     return errs;
 294 }
 295
 296 /*
 297  * Process a directory; return number of errors found.
 298  */
 299 static int do_dir(const char *dirname, enum Hash h)
 300 {
 301     BUCKET *bp, *nextbp;
 302     HENTRY *ep, *nextep;
 303     OPENSSL_DIR_CTX *d = NULL;
 304     struct stat st;
 305     unsigned char idmask[MAX_COLLISIONS / 8];
 306     int i, n, nextid, buflen, errs = 0;
 307     const char *pathsep;
 308     const char *filename;
 309     char *buf;
 310
 311     buflen = strlen(dirname);
 312     pathsep = (buflen && dirname[buflen - 1] == '/') ? "" : "/";
 313     buflen += NAME_MAX + 2;
 314     buf = app_malloc(buflen, "filename buffer");
 315
 316     if (verbose)
 317         BIO_printf(bio_out, "Doing %s\n", dirname);
 318
 319     while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) {
 320         if (snprintf(buf, buflen, "%s%s%s",
 321                     dirname, pathsep, filename) >= buflen)
 322             continue;
 323         if (lstat(buf, &st) < 0)
 324             continue;
 325         if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0)
 326             continue;
 327         errs += do_file(filename, buf, h);
 328     }
 329     OPENSSL_DIR_end(&d);
 330
 331     for (i = 0; i < (int)OSSL_NELEM(hash_table); i++) {
 332         for (bp = hash_table[i]; bp; bp = nextbp) {
 333             nextbp = bp->next;
 334             nextid = 0;
 335             memset(idmask, 0, (bp->num_needed + 7) / 8);
 336             for (ep = bp->first_entry; ep; ep = ep->next)
 337                 if (ep->old_id < bp->num_needed)
 338                     bit_set(idmask, ep->old_id);
 339
 340             for (ep = bp->first_entry; ep; ep = nextep) {
 341                 nextep = ep->next;
 342                 if (ep->old_id < bp->num_needed) {
 343                     /* Link exists, and is used as-is */
 344                     snprintf(buf, buflen, "%08x.%s%d", bp->hash,
 345                              suffixes[bp->type], ep->old_id);
 346                     if (verbose)
 347                         BIO_printf(bio_out, "link %s -> %s\n",
 348                                    ep->filename, buf);
 349                 } else if (ep->need_symlink) {
 350                     /* New link needed (it may replace something) */
 351                     while (bit_isset(idmask, nextid))
 352                         nextid++;
 353
 354                     snprintf(buf, buflen, "%s%s%n%08x.%s%d",
 355                              dirname, pathsep, &n, bp->hash,
 356                              suffixes[bp->type], nextid);
 357                     if (verbose)
 358                         BIO_printf(bio_out, "link %s -> %s\n",
 359                                    ep->filename, &buf[n]);
 360                     if (unlink(buf) < 0 && errno != ENOENT) {
 361                         BIO_printf(bio_err,
 362                                    "%s: Can't unlink %s, %s\n",
 363                                    opt_getprog(), buf, strerror(errno));
 364                         errs++;
 365                     }
 366                     if (symlink(ep->filename, buf) < 0) {
 367                         BIO_printf(bio_err,
 368                                    "%s: Can't symlink %s, %s\n",
 369                                    opt_getprog(), ep->filename,
 370                                    strerror(errno));
 371                         errs++;
 372                     }
 373                 } else if (remove_links) {
 374                     /* Link to be deleted */
 375                     snprintf(buf, buflen, "%s%s%n%08x.%s%d",
 376                              dirname, pathsep, &n, bp->hash,
 377                              suffixes[bp->type], ep->old_id);
 378                     if (verbose)
 379                         BIO_printf(bio_out, "unlink %s\n",
 380                                    &buf[n]);
 381                     if (unlink(buf) < 0 && errno != ENOENT) {
 382                         BIO_printf(bio_err,
 383                                    "%s: Can't unlink %s, %s\n",
 384                                    opt_getprog(), buf, strerror(errno));
 385                         errs++;
 386                     }
 387                 }
 388                 OPENSSL_free(ep->filename);
 389                 OPENSSL_free(ep);
 390             }
 391             OPENSSL_free(bp);
 392         }
 393         hash_table[i] = NULL;
 394     }
 395
 396     OPENSSL_free(buf);
 397     return errs;
 398 }
 399
 400 typedef enum OPTION_choice {
 401     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
 402     OPT_COMPAT, OPT_OLD, OPT_N, OPT_VERBOSE
 403 } OPTION_CHOICE;
 404
 405 OPTIONS rehash_options[] = {
 406     {OPT_HELP_STR, 1, '-', "Usage: %s [options] [cert-directory...]\n"},
 407     {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
 408     {"help", OPT_HELP, '-', "Display this summary"},
 409     {"compat", OPT_COMPAT, '-', "Create both new- and old-style hash links"},
 410     {"old", OPT_OLD, '-', "Use old-style hash to generate links"},
 411     {"n", OPT_N, '-', "Do not remove existing links"},
 412     {"v", OPT_VERBOSE, '-', "Verbose output"},
 413     {NULL}
 414 };
 415
 416
 417 int rehash_main(int argc, char **argv)
 418 {
 419     const char *env, *prog;
 420     char *e, *m;
 421     int errs = 0;
 422     OPTION_CHOICE o;
 423     enum Hash h = HASH_NEW;
 424
 425     prog = opt_init(argc, argv, rehash_options);
 426     while ((o = opt_next()) != OPT_EOF) {
 427         switch (o) {
 428         case OPT_EOF:
 429         case OPT_ERR:
 430             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 431             goto end;
 432         case OPT_HELP:
 433             opt_help(rehash_options);
 434             goto end;
 435         case OPT_COMPAT:
 436             h = HASH_BOTH;
 437             break;
 438         case OPT_OLD:
 439             h = HASH_OLD;
 440             break;
 441         case OPT_N:
 442             remove_links = 0;
 443             break;
 444         case OPT_VERBOSE:
 445             verbose = 1;
 446             break;
 447         }
 448     }
 449     argc = opt_num_rest();
 450     argv = opt_rest();
 451
 452     evpmd = EVP_sha1();
 453     evpmdsize = EVP_MD_size(evpmd);
 454
 455     if (*argv) {
 456         while (*argv)
 457             errs += do_dir(*argv++, h);
 458     } else if ((env = getenv("SSL_CERT_DIR")) != NULL) {
 459         m = BUF_strdup(env);
 460         for (e = strtok(m, ":"); e != NULL; e = strtok(NULL, ":"))
 461             errs += do_dir(e, h);
 462         OPENSSL_free(m);
 463     } else {
 464         errs += do_dir("/etc/ssl/certs", h);
 465     }
 466
 467  end:
 468     return errs;
 469 }
 470
 471 #else
 472 OPTIONS rehash_options[] = {
 473     {NULL}
 474 };
 475
 476 int rehash_main(int argc, char **argv)
 477 {
 478     BIO_printf(bio_err, "Not available; use c_rehash script\n");
 479     return (1);
 480 }
 481
 482 #endif /* defined(unix) || defined(__APPLE__) */