Add -h and -help for c_rehash script and app
[openssl.git] / apps / rehash.c
index 323fd15f562c2636735d186317732a121abe7b7f..4e10ded7903e50534ae7b7174b8a0faeaba6d47c 100644 (file)
@@ -1,66 +1,22 @@
 /*
- * C implementation based on the original Perl and shell versions
+ * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
  *
- * Copyright (c) 2013-2014 Timo Teräs <timo.teras@iki.fi>
- * All rights reserved.
+ * Licensed under the OpenSSL license (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
  */
-/* ====================================================================
- * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- *
- * 3. All advertising materials mentioning features or use of this
- *    software must display the following acknowledgment:
- *    "This product includes software developed by the OpenSSL Project
- *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
- *
- * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
- *    endorse or promote products derived from this software without
- *    prior written permission. For written permission, please contact
- *    licensing@OpenSSL.org.
- *
- * 5. Products derived from this software may not be called "OpenSSL"
- *    nor may "OpenSSL" appear in their names without prior written
- *    permission of the OpenSSL Project.
- *
- * 6. Redistributions of any form whatsoever must retain the following
- *    acknowledgment:
- *    "This product includes software developed by the OpenSSL Project
- *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
- *
- * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
- * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- * ====================================================================
- *
- * This product includes cryptographic software written by Eric Young
- * (eay@cryptsoft.com).  This product includes software written by Tim
- * Hudson (tjh@cryptsoft.com).
+
+/*
+ * C implementation based on the original Perl and shell versions
  *
+ * Copyright (c) 2013-2014 Timo Teräs <timo.teras@iki.fi>
  */
 
 #include "apps.h"
 
-#ifdef unix
+#if defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) || \
+    (defined(__VMS) && defined(__DECC) && __CTRL_VER >= 80300000)
 # include <unistd.h>
 # include <stdio.h>
 # include <limits.h>
 # include <openssl/x509.h>
 
 
+# ifndef PATH_MAX
+#  define PATH_MAX 4096
+# endif
+# ifndef NAME_MAX
+#  define NAME_MAX 255
+# endif
 # define MAX_COLLISIONS  256
 
 typedef struct hentry_st {
@@ -124,7 +86,10 @@ static int bit_isset(unsigned char *set, unsigned int bit)
 }
 
 
-static void add_entry(enum Type type, unsigned int hash, const char *filename,
+/*
+ * Process an entry; return number of errors.
+ */
+static int add_entry(enum Type type, unsigned int hash, const char *filename,
                       const unsigned char *digest, int need_symlink,
                       unsigned short old_id)
 {
@@ -149,9 +114,9 @@ static void add_entry(enum Type type, unsigned int hash, const char *filename,
     for (ep = bp->first_entry; ep; ep = ep->next) {
         if (digest && memcmp(digest, ep->digest, evpmdsize) == 0) {
             BIO_printf(bio_err,
-                       "%s: skipping duplicate certificate in %s\n",
-                       opt_getprog(), filename);
-            return;
+                       "%s: skipping duplicate %s in %s\n", opt_getprog(),
+                       type == TYPE_CERT ? "certificate" : "CRL", filename);
+            return 1;
         }
         if (strcmp(filename, ep->filename) == 0) {
             found = ep;
@@ -161,12 +126,16 @@ static void add_entry(enum Type type, unsigned int hash, const char *filename,
     }
     ep = found;
     if (ep == NULL) {
-        if (bp->num_needed >= MAX_COLLISIONS)
-            return;
+        if (bp->num_needed >= MAX_COLLISIONS) {
+            BIO_printf(bio_err,
+                       "%s: hash table overflow for %s\n",
+                       opt_getprog(), filename);
+            return 1;
+        }
         ep = app_malloc(sizeof(*ep), "collision bucket");
         *ep = nilhentry;
         ep->old_id = ~0;
-        ep->filename = BUF_strdup(filename);
+        ep->filename = OPENSSL_strdup(filename);
         if (bp->last_entry)
             bp->last_entry->next = ep;
         if (bp->first_entry == NULL)
@@ -181,28 +150,35 @@ static void add_entry(enum Type type, unsigned int hash, const char *filename,
         bp->num_needed++;
         memcpy(ep->digest, digest, evpmdsize);
     }
+    return 0;
 }
 
+/*
+ * Check if a symlink goes to the right spot; return 0 if okay.
+ * This can be -1 if bad filename, or an error count.
+ */
 static int handle_symlink(const char *filename, const char *fullpath)
 {
     unsigned int hash = 0;
     int i, type, id;
     unsigned char ch;
-    char linktarget[NAME_MAX], *endptr;
-    ssize_t n;
+    char linktarget[PATH_MAX], *endptr;
+    ossl_ssize_t n;
 
     for (i = 0; i < 8; i++) {
         ch = filename[i];
         if (!isxdigit(ch))
             return -1;
         hash <<= 4;
-        hash += app_hex(ch);
+        hash += OPENSSL_hexchar2int(ch);
     }
     if (filename[i++] != '.')
         return -1;
-    for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--)
-        if (strcasecmp(suffixes[type], &filename[i]) == 0)
+    for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--) {
+        const char *suffix = suffixes[type];
+        if (strncasecmp(suffix, &filename[i], strlen(suffix)) == 0)
             break;
+    }
     i += strlen(suffixes[type]);
 
     id = strtoul(&filename[i], &endptr, 10);
@@ -214,41 +190,51 @@ static int handle_symlink(const char *filename, const char *fullpath)
         return -1;
     linktarget[n] = 0;
 
-    add_entry(type, hash, linktarget, NULL, 0, id);
-    return 0;
+    return add_entry(type, hash, linktarget, NULL, 0, id);
 }
 
+/*
+ * process a file, return number of errors.
+ */
 static int do_file(const char *filename, const char *fullpath, enum Hash h)
 {
-    STACK_OF (X509_INFO) *inf;
+    STACK_OF (X509_INFO) *inf = NULL;
     X509_INFO *x;
     X509_NAME *name = NULL;
     BIO *b;
     const char *ext;
     unsigned char digest[EVP_MAX_MD_SIZE];
-    int i, type, ret = -1;
+    int type, errs = 0;
+    size_t i;
 
+    /* Does it end with a recognized extension? */
     if ((ext = strrchr(filename, '.')) == NULL)
-        return 0;
-    for (i = 0; i < (int)OSSL_NELEM(extensions); i++) {
+        goto end;
+    for (i = 0; i < OSSL_NELEM(extensions); i++) {
         if (strcasecmp(extensions[i], ext + 1) == 0)
             break;
     }
-    if (i >= (int)OSSL_NELEM(extensions))
-        return -1;
+    if (i >= OSSL_NELEM(extensions))
+        goto end;
 
-    if ((b = BIO_new_file(fullpath, "r")) == NULL)
-        return -1;
+    /* Does it have X.509 data in it? */
+    if ((b = BIO_new_file(fullpath, "r")) == NULL) {
+        BIO_printf(bio_err, "%s: skipping %s, cannot open file\n",
+                   opt_getprog(), filename);
+        errs++;
+        goto end;
+    }
     inf = PEM_X509_INFO_read_bio(b, NULL, NULL, NULL);
     BIO_free(b);
     if (inf == NULL)
-        return -1;
+        goto end;
 
     if (sk_X509_INFO_num(inf) != 1) {
         BIO_printf(bio_err,
                    "%s: skipping %s,"
                    "it does not contain exactly one certificate or CRL\n",
                    opt_getprog(), filename);
+        /* This is not an error. */
         goto end;
     }
     x = sk_X509_INFO_value(inf, 0);
@@ -260,19 +246,30 @@ static int do_file(const char *filename, const char *fullpath, enum Hash h)
         type = TYPE_CRL;
         name = X509_CRL_get_issuer(x->crl);
         X509_CRL_digest(x->crl, evpmd, digest, NULL);
+    } else {
+        ++errs;
+        goto end;
     }
     if (name) {
         if ((h == HASH_NEW) || (h == HASH_BOTH))
-            add_entry(type, X509_NAME_hash(name), filename, digest, 1, ~0);
+            errs += add_entry(type, X509_NAME_hash(name), filename, digest, 1, ~0);
         if ((h == HASH_OLD) || (h == HASH_BOTH))
-            add_entry(type, X509_NAME_hash_old(name), filename, digest, 1, ~0);
+            errs += add_entry(type, X509_NAME_hash_old(name), filename, digest, 1, ~0);
     }
 
 end:
     sk_X509_INFO_pop_free(inf, X509_INFO_free);
-    return ret;
+    return errs;
 }
 
+static void str_free(char *s)
+{
+    OPENSSL_free(s);
+}
+
+/*
+ * Process a directory; return number of errors found.
+ */
 static int do_dir(const char *dirname, enum Hash h)
 {
     BUCKET *bp, *nextbp;
@@ -280,20 +277,42 @@ static int do_dir(const char *dirname, enum Hash h)
     OPENSSL_DIR_CTX *d = NULL;
     struct stat st;
     unsigned char idmask[MAX_COLLISIONS / 8];
-    int i, n, nextid, buflen, ret = -1;
+    int n, numfiles, nextid, buflen, errs = 0;
+    size_t i;
     const char *pathsep;
     const char *filename;
-    char *buf;
+    char *buf, *copy;
+    STACK_OF(OPENSSL_STRING) *files = NULL;
 
+    if (app_access(dirname, W_OK) < 0) {
+        BIO_printf(bio_err, "Skipping %s, can't write\n", dirname);
+        return 1;
+    }
     buflen = strlen(dirname);
     pathsep = (buflen && dirname[buflen - 1] == '/') ? "" : "/";
-    buflen += NAME_MAX + 2;
+    buflen += NAME_MAX + 1 + 1;
     buf = app_malloc(buflen, "filename buffer");
 
     if (verbose)
         BIO_printf(bio_out, "Doing %s\n", dirname);
 
+    if ((files = sk_OPENSSL_STRING_new_null()) == NULL) {
+        BIO_printf(bio_err, "Skipping %s, out of memory\n", dirname);
+        exit(1);
+    }
     while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) {
+        if ((copy = strdup(filename)) == NULL
+                || sk_OPENSSL_STRING_push(files, copy) == 0) {
+            BIO_puts(bio_err, "out of memory\n");
+            exit(1);
+        }
+    }
+    OPENSSL_DIR_end(&d);
+    sk_OPENSSL_STRING_sort(files);
+
+    numfiles = sk_OPENSSL_STRING_num(files);
+    for (n = 0; n < numfiles; ++n) {
+        filename = sk_OPENSSL_STRING_value(files, n);
         if (snprintf(buf, buflen, "%s%s%s",
                     dirname, pathsep, filename) >= buflen)
             continue;
@@ -301,11 +320,11 @@ static int do_dir(const char *dirname, enum Hash h)
             continue;
         if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0)
             continue;
-        do_file(filename, buf, h);
+        errs += do_file(filename, buf, h);
     }
-    OPENSSL_DIR_end(&d);
+    sk_OPENSSL_STRING_pop_free(files, str_free);
 
-    for (i = 0; i < (int)OSSL_NELEM(hash_table); i++) {
+    for (i = 0; i < OSSL_NELEM(hash_table); i++) {
         for (bp = hash_table[i]; bp; bp = nextbp) {
             nextbp = bp->next;
             nextid = 0;
@@ -334,15 +353,20 @@ static int do_dir(const char *dirname, enum Hash h)
                     if (verbose)
                         BIO_printf(bio_out, "link %s -> %s\n",
                                    ep->filename, &buf[n]);
-                    if (unlink(buf) < 0 && errno != ENOENT)
+                    if (unlink(buf) < 0 && errno != ENOENT) {
                         BIO_printf(bio_err,
                                    "%s: Can't unlink %s, %s\n",
                                    opt_getprog(), buf, strerror(errno));
-                    if (symlink(ep->filename, buf) < 0)
+                        errs++;
+                    }
+                    if (symlink(ep->filename, buf) < 0) {
                         BIO_printf(bio_err,
                                    "%s: Can't symlink %s, %s\n",
                                    opt_getprog(), ep->filename,
                                    strerror(errno));
+                        errs++;
+                    }
+                    bit_set(idmask, nextid);
                 } else if (remove_links) {
                     /* Link to be deleted */
                     snprintf(buf, buflen, "%s%s%n%08x.%s%d",
@@ -351,10 +375,12 @@ static int do_dir(const char *dirname, enum Hash h)
                     if (verbose)
                         BIO_printf(bio_out, "unlink %s\n",
                                    &buf[n]);
-                    if (unlink(buf) < 0 && errno != ENOENT)
+                    if (unlink(buf) < 0 && errno != ENOENT) {
                         BIO_printf(bio_err,
                                    "%s: Can't unlink %s, %s\n",
                                    opt_getprog(), buf, strerror(errno));
+                        errs++;
+                    }
                 }
                 OPENSSL_free(ep->filename);
                 OPENSSL_free(ep);
@@ -363,10 +389,9 @@ static int do_dir(const char *dirname, enum Hash h)
         }
         hash_table[i] = NULL;
     }
-    ret = 0;
 
     OPENSSL_free(buf);
-    return ret;
+    return errs;
 }
 
 typedef enum OPTION_choice {
@@ -378,6 +403,7 @@ OPTIONS rehash_options[] = {
     {OPT_HELP_STR, 1, '-', "Usage: %s [options] [cert-directory...]\n"},
     {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
     {"help", OPT_HELP, '-', "Display this summary"},
+    {"h", OPT_HELP, '-', "Display this summary"},
     {"compat", OPT_COMPAT, '-', "Create both new- and old-style hash links"},
     {"old", OPT_OLD, '-', "Use old-style hash to generate links"},
     {"n", OPT_N, '-', "Do not remove existing links"},
@@ -390,7 +416,7 @@ int rehash_main(int argc, char **argv)
 {
     const char *env, *prog;
     char *e, *m;
-    int ret = 0;
+    int errs = 0;
     OPTION_CHOICE o;
     enum Hash h = HASH_NEW;
 
@@ -426,26 +452,29 @@ int rehash_main(int argc, char **argv)
 
     if (*argv) {
         while (*argv)
-            ret |= do_dir(*argv++, h);
+            errs += do_dir(*argv++, h);
     } else if ((env = getenv("SSL_CERT_DIR")) != NULL) {
-        m = BUF_strdup(env);
+        m = OPENSSL_strdup(env);
         for (e = strtok(m, ":"); e != NULL; e = strtok(NULL, ":"))
-            ret |= do_dir(e, h);
+            errs += do_dir(e, h);
         OPENSSL_free(m);
     } else {
-        ret |= do_dir("/etc/ssl/certs", h);
+        errs += do_dir("/etc/ssl/certs", h);
     }
 
  end:
-    return ret ? 2 : 0;
+    return errs;
 }
 
 #else
+OPTIONS rehash_options[] = {
+    {NULL}
+};
 
 int rehash_main(int argc, char **argv)
 {
-    BIO_print(bio_err, "Not available; use c_rehash script\n");
+    BIO_printf(bio_err, "Not available; use c_rehash script\n");
     return (1);
 }
 
-#endif
+#endif /* defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) */