Add X509_NAME_hash_ex() to be able to check if it failed due to unsupported SHA1
[openssl.git] / apps / rehash.c
1 /*
2  * Copyright 2015-2020 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
60 int symlink(const char *target, const char *linkpath)
61 {
62     errno = ENOSYS;
63     return -1;
64 }
65
66 ssize_t readlink(const char *pathname, char *buf, size_t bufsiz)
67 {
68     errno = ENOSYS;
69     return -1;
70 }
71 # endif
72
73 typedef 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
81 typedef 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
89 enum Type {
90     /* Keep in sync with |suffixes|, below. */
91     TYPE_CERT=0, TYPE_CRL=1
92 };
93
94 enum Hash {
95     HASH_OLD, HASH_NEW, HASH_BOTH
96 };
97
98
99 static int evpmdsize;
100 static const EVP_MD *evpmd;
101 static int remove_links = 1;
102 static int verbose = 0;
103 static BUCKET *hash_table[257];
104
105 static const char *suffixes[] = { "", "r" };
106 static const char *extensions[] = { "pem", "crt", "cer", "crl" };
107
108
109 static void bit_set(unsigned char *set, unsigned int bit)
110 {
111     set[bit >> 3] |= 1 << (bit & 0x7);
112 }
113
114 static 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  */
123 static 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 (bp->last_entry)
172             bp->last_entry->next = ep;
173         if (bp->first_entry == NULL)
174             bp->first_entry = ep;
175         bp->last_entry = ep;
176     }
177
178     if (old_id < ep->old_id)
179         ep->old_id = old_id;
180     if (need_symlink && !ep->need_symlink) {
181         ep->need_symlink = 1;
182         bp->num_needed++;
183         memcpy(ep->digest, digest, evpmdsize);
184     }
185     return 0;
186 }
187
188 /*
189  * Check if a symlink goes to the right spot; return 0 if okay.
190  * This can be -1 if bad filename, or an error count.
191  */
192 static int handle_symlink(const char *filename, const char *fullpath)
193 {
194     unsigned int hash = 0;
195     int i, type, id;
196     unsigned char ch;
197     char linktarget[PATH_MAX], *endptr;
198     ossl_ssize_t n;
199
200     for (i = 0; i < 8; i++) {
201         ch = filename[i];
202         if (!isxdigit(ch))
203             return -1;
204         hash <<= 4;
205         hash += OPENSSL_hexchar2int(ch);
206     }
207     if (filename[i++] != '.')
208         return -1;
209     for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--) {
210         const char *suffix = suffixes[type];
211         if (strncasecmp(suffix, &filename[i], strlen(suffix)) == 0)
212             break;
213     }
214     i += strlen(suffixes[type]);
215
216     id = strtoul(&filename[i], &endptr, 10);
217     if (*endptr != '\0')
218         return -1;
219
220     n = readlink(fullpath, linktarget, sizeof(linktarget));
221     if (n < 0 || n >= (int)sizeof(linktarget))
222         return -1;
223     linktarget[n] = 0;
224
225     return add_entry(type, hash, linktarget, NULL, 0, id);
226 }
227
228 /*
229  * process a file, return number of errors.
230  */
231 static int do_file(const char *filename, const char *fullpath, enum Hash h)
232 {
233     STACK_OF (X509_INFO) *inf = NULL;
234     X509_INFO *x;
235     const X509_NAME *name = NULL;
236     BIO *b;
237     const char *ext;
238     unsigned char digest[EVP_MAX_MD_SIZE];
239     int type, errs = 0;
240     size_t i;
241
242     /* Does it end with a recognized extension? */
243     if ((ext = strrchr(filename, '.')) == NULL)
244         goto end;
245     for (i = 0; i < OSSL_NELEM(extensions); i++) {
246         if (strcasecmp(extensions[i], ext + 1) == 0)
247             break;
248     }
249     if (i >= OSSL_NELEM(extensions))
250         goto end;
251
252     /* Does it have X.509 data in it? */
253     if ((b = BIO_new_file(fullpath, "r")) == NULL) {
254         BIO_printf(bio_err, "%s: error: skipping %s, cannot open file\n",
255                    opt_getprog(), filename);
256         errs++;
257         goto end;
258     }
259     inf = PEM_X509_INFO_read_bio(b, NULL, NULL, NULL);
260     BIO_free(b);
261     if (inf == NULL)
262         goto end;
263
264     if (sk_X509_INFO_num(inf) != 1) {
265         BIO_printf(bio_err,
266                    "%s: warning: skipping %s,"
267                    "it does not contain exactly one certificate or CRL\n",
268                    opt_getprog(), filename);
269         /* This is not an error. */
270         goto end;
271     }
272     x = sk_X509_INFO_value(inf, 0);
273     if (x->x509 != NULL) {
274         type = TYPE_CERT;
275         name = X509_get_subject_name(x->x509);
276         if (!X509_digest(x->x509, evpmd, digest, NULL)) {
277             BIO_printf(bio_err, "out of memory\n");
278             ++errs;
279             goto end;
280         }
281     } else if (x->crl != NULL) {
282         type = TYPE_CRL;
283         name = X509_CRL_get_issuer(x->crl);
284         if (!X509_CRL_digest(x->crl, evpmd, digest, NULL)) {
285             BIO_printf(bio_err, "out of memory\n");
286             ++errs;
287             goto end;
288         }
289     } else {
290         ++errs;
291         goto end;
292     }
293     if (name != NULL) {
294         if (h == HASH_NEW || h == HASH_BOTH) {
295             int ok;
296             unsigned long hash_value =
297                 X509_NAME_hash_ex(name,
298                                   app_get0_libctx(), app_get0_propq(), &ok);
299
300             if (ok) {
301                 errs += add_entry(type, hash_value, filename, digest, 1, ~0);
302             } else {
303                 BIO_printf(bio_err, "%s: error calculating SHA1 hash value\n",
304                            opt_getprog());
305                 errs++;
306             }
307         }
308         if ((h == HASH_OLD) || (h == HASH_BOTH))
309             errs += add_entry(type, X509_NAME_hash_old(name),
310                               filename, digest, 1, ~0);
311     }
312
313 end:
314     sk_X509_INFO_pop_free(inf, X509_INFO_free);
315     return errs;
316 }
317
318 static void str_free(char *s)
319 {
320     OPENSSL_free(s);
321 }
322
323 static int ends_with_dirsep(const char *path)
324 {
325     if (*path != '\0')
326         path += strlen(path) - 1;
327 # if defined __VMS
328     if (*path == ']' || *path == '>' || *path == ':')
329         return 1;
330 # elif defined _WIN32
331     if (*path == '\\')
332         return 1;
333 # endif
334     return *path == '/';
335 }
336
337 /*
338  * Process a directory; return number of errors found.
339  */
340 static int do_dir(const char *dirname, enum Hash h)
341 {
342     BUCKET *bp, *nextbp;
343     HENTRY *ep, *nextep;
344     OPENSSL_DIR_CTX *d = NULL;
345     struct stat st;
346     unsigned char idmask[MAX_COLLISIONS / 8];
347     int n, numfiles, nextid, buflen, errs = 0;
348     size_t i;
349     const char *pathsep;
350     const char *filename;
351     char *buf, *copy = NULL;
352     STACK_OF(OPENSSL_STRING) *files = NULL;
353
354     if (app_access(dirname, W_OK) < 0) {
355         BIO_printf(bio_err, "Skipping %s, can't write\n", dirname);
356         return 1;
357     }
358     buflen = strlen(dirname);
359     pathsep = (buflen && !ends_with_dirsep(dirname)) ? "/": "";
360     buflen += NAME_MAX + 1 + 1;
361     buf = app_malloc(buflen, "filename buffer");
362
363     if (verbose)
364         BIO_printf(bio_out, "Doing %s\n", dirname);
365
366     if ((files = sk_OPENSSL_STRING_new_null()) == NULL) {
367         BIO_printf(bio_err, "Skipping %s, out of memory\n", dirname);
368         errs = 1;
369         goto err;
370     }
371     while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) {
372         if ((copy = OPENSSL_strdup(filename)) == NULL
373                 || sk_OPENSSL_STRING_push(files, copy) == 0) {
374             OPENSSL_free(copy);
375             BIO_puts(bio_err, "out of memory\n");
376             errs = 1;
377             goto err;
378         }
379     }
380     OPENSSL_DIR_end(&d);
381     sk_OPENSSL_STRING_sort(files);
382
383     numfiles = sk_OPENSSL_STRING_num(files);
384     for (n = 0; n < numfiles; ++n) {
385         filename = sk_OPENSSL_STRING_value(files, n);
386         if (BIO_snprintf(buf, buflen, "%s%s%s",
387                          dirname, pathsep, filename) >= buflen)
388             continue;
389         if (lstat(buf, &st) < 0)
390             continue;
391         if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0)
392             continue;
393         errs += do_file(filename, buf, h);
394     }
395
396     for (i = 0; i < OSSL_NELEM(hash_table); i++) {
397         for (bp = hash_table[i]; bp; bp = nextbp) {
398             nextbp = bp->next;
399             nextid = 0;
400             memset(idmask, 0, (bp->num_needed + 7) / 8);
401             for (ep = bp->first_entry; ep; ep = ep->next)
402                 if (ep->old_id < bp->num_needed)
403                     bit_set(idmask, ep->old_id);
404
405             for (ep = bp->first_entry; ep; ep = nextep) {
406                 nextep = ep->next;
407                 if (ep->old_id < bp->num_needed) {
408                     /* Link exists, and is used as-is */
409                     BIO_snprintf(buf, buflen, "%08x.%s%d", bp->hash,
410                                  suffixes[bp->type], ep->old_id);
411                     if (verbose)
412                         BIO_printf(bio_out, "link %s -> %s\n",
413                                    ep->filename, buf);
414                 } else if (ep->need_symlink) {
415                     /* New link needed (it may replace something) */
416                     while (bit_isset(idmask, nextid))
417                         nextid++;
418
419                     BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d",
420                                  dirname, pathsep, &n, bp->hash,
421                                  suffixes[bp->type], nextid);
422                     if (verbose)
423                         BIO_printf(bio_out, "link %s -> %s\n",
424                                    ep->filename, &buf[n]);
425                     if (unlink(buf) < 0 && errno != ENOENT) {
426                         BIO_printf(bio_err,
427                                    "%s: Can't unlink %s, %s\n",
428                                    opt_getprog(), buf, strerror(errno));
429                         errs++;
430                     }
431                     if (symlink(ep->filename, buf) < 0) {
432                         BIO_printf(bio_err,
433                                    "%s: Can't symlink %s, %s\n",
434                                    opt_getprog(), ep->filename,
435                                    strerror(errno));
436                         errs++;
437                     }
438                     bit_set(idmask, nextid);
439                 } else if (remove_links) {
440                     /* Link to be deleted */
441                     BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d",
442                                  dirname, pathsep, &n, bp->hash,
443                                  suffixes[bp->type], ep->old_id);
444                     if (verbose)
445                         BIO_printf(bio_out, "unlink %s\n",
446                                    &buf[n]);
447                     if (unlink(buf) < 0 && errno != ENOENT) {
448                         BIO_printf(bio_err,
449                                    "%s: Can't unlink %s, %s\n",
450                                    opt_getprog(), buf, strerror(errno));
451                         errs++;
452                     }
453                 }
454                 OPENSSL_free(ep->filename);
455                 OPENSSL_free(ep);
456             }
457             OPENSSL_free(bp);
458         }
459         hash_table[i] = NULL;
460     }
461
462  err:
463     sk_OPENSSL_STRING_pop_free(files, str_free);
464     OPENSSL_free(buf);
465     return errs;
466 }
467
468 typedef enum OPTION_choice {
469     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
470     OPT_COMPAT, OPT_OLD, OPT_N, OPT_VERBOSE,
471     OPT_PROV_ENUM
472 } OPTION_CHOICE;
473
474 const OPTIONS rehash_options[] = {
475     {OPT_HELP_STR, 1, '-', "Usage: %s [options] [directory...]\n"},
476
477     OPT_SECTION("General"),
478     {"help", OPT_HELP, '-', "Display this summary"},
479     {"h", OPT_HELP, '-', "Display this summary"},
480     {"compat", OPT_COMPAT, '-', "Create both new- and old-style hash links"},
481     {"old", OPT_OLD, '-', "Use old-style hash to generate links"},
482     {"n", OPT_N, '-', "Do not remove existing links"},
483
484     OPT_SECTION("Output"),
485     {"v", OPT_VERBOSE, '-', "Verbose output"},
486
487     OPT_PROV_OPTIONS,
488
489     OPT_PARAMETERS(),
490     {"directory", 0, 0, "One or more directories to process (optional)"},
491     {NULL}
492 };
493
494
495 int rehash_main(int argc, char **argv)
496 {
497     const char *env, *prog;
498     char *e, *m;
499     int errs = 0;
500     OPTION_CHOICE o;
501     enum Hash h = HASH_NEW;
502
503     prog = opt_init(argc, argv, rehash_options);
504     while ((o = opt_next()) != OPT_EOF) {
505         switch (o) {
506         case OPT_EOF:
507         case OPT_ERR:
508             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
509             goto end;
510         case OPT_HELP:
511             opt_help(rehash_options);
512             goto end;
513         case OPT_COMPAT:
514             h = HASH_BOTH;
515             break;
516         case OPT_OLD:
517             h = HASH_OLD;
518             break;
519         case OPT_N:
520             remove_links = 0;
521             break;
522         case OPT_VERBOSE:
523             verbose = 1;
524             break;
525         case OPT_PROV_CASES:
526             if (!opt_provider(o))
527                 goto end;
528             break;
529         }
530     }
531
532     /* Optional arguments are directories to scan. */
533     argc = opt_num_rest();
534     argv = opt_rest();
535
536     evpmd = EVP_sha1();
537     evpmdsize = EVP_MD_size(evpmd);
538
539     if (*argv != NULL) {
540         while (*argv != NULL)
541             errs += do_dir(*argv++, h);
542     } else if ((env = getenv(X509_get_default_cert_dir_env())) != NULL) {
543         char lsc[2] = { LIST_SEPARATOR_CHAR, '\0' };
544         m = OPENSSL_strdup(env);
545         for (e = strtok(m, lsc); e != NULL; e = strtok(NULL, lsc))
546             errs += do_dir(e, h);
547         OPENSSL_free(m);
548     } else {
549         errs += do_dir(X509_get_default_cert_dir(), h);
550     }
551
552  end:
553     return errs;
554 }
555
556 #else
557 const OPTIONS rehash_options[] = {
558     {NULL}
559 };
560
561 int rehash_main(int argc, char **argv)
562 {
563     BIO_printf(bio_err, "Not available; use c_rehash script\n");
564     return 1;
565 }
566
567 #endif /* defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) */