]>
Commit | Line | Data |
---|---|---|
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 | DEFINE_STACK_OF_STRING() | |
46 | ||
47 | # ifndef PATH_MAX | |
48 | # define PATH_MAX 4096 | |
49 | # endif | |
50 | # ifndef NAME_MAX | |
51 | # define NAME_MAX 255 | |
52 | # endif | |
53 | # define MAX_COLLISIONS 256 | |
54 | ||
55 | # if defined(OPENSSL_SYS_VXWORKS) | |
56 | /* | |
57 | * VxWorks has no symbolic links | |
58 | */ | |
59 | ||
60 | # define lstat(path, buf) stat(path, buf) | |
61 | ||
62 | int symlink(const char *target, const char *linkpath) | |
63 | { | |
64 | errno = ENOSYS; | |
65 | return -1; | |
66 | } | |
67 | ||
68 | ssize_t readlink(const char *pathname, char *buf, size_t bufsiz) | |
69 | { | |
70 | errno = ENOSYS; | |
71 | return -1; | |
72 | } | |
73 | # endif | |
74 | ||
75 | typedef struct hentry_st { | |
76 | struct hentry_st *next; | |
77 | char *filename; | |
78 | unsigned short old_id; | |
79 | unsigned char need_symlink; | |
80 | unsigned char digest[EVP_MAX_MD_SIZE]; | |
81 | } HENTRY; | |
82 | ||
83 | typedef struct bucket_st { | |
84 | struct bucket_st *next; | |
85 | HENTRY *first_entry, *last_entry; | |
86 | unsigned int hash; | |
87 | unsigned short type; | |
88 | unsigned short num_needed; | |
89 | } BUCKET; | |
90 | ||
91 | enum Type { | |
92 | /* Keep in sync with |suffixes|, below. */ | |
93 | TYPE_CERT=0, TYPE_CRL=1 | |
94 | }; | |
95 | ||
96 | enum Hash { | |
97 | HASH_OLD, HASH_NEW, HASH_BOTH | |
98 | }; | |
99 | ||
100 | ||
101 | static int evpmdsize; | |
102 | static const EVP_MD *evpmd; | |
103 | static int remove_links = 1; | |
104 | static int verbose = 0; | |
105 | static BUCKET *hash_table[257]; | |
106 | ||
107 | static const char *suffixes[] = { "", "r" }; | |
108 | static const char *extensions[] = { "pem", "crt", "cer", "crl" }; | |
109 | ||
110 | ||
111 | static void bit_set(unsigned char *set, unsigned int bit) | |
112 | { | |
113 | set[bit >> 3] |= 1 << (bit & 0x7); | |
114 | } | |
115 | ||
116 | static int bit_isset(unsigned char *set, unsigned int bit) | |
117 | { | |
118 | return set[bit >> 3] & (1 << (bit & 0x7)); | |
119 | } | |
120 | ||
121 | ||
122 | /* | |
123 | * Process an entry; return number of errors. | |
124 | */ | |
125 | static int add_entry(enum Type type, unsigned int hash, const char *filename, | |
126 | const unsigned char *digest, int need_symlink, | |
127 | unsigned short old_id) | |
128 | { | |
129 | static BUCKET nilbucket; | |
130 | static HENTRY nilhentry; | |
131 | BUCKET *bp; | |
132 | HENTRY *ep, *found = NULL; | |
133 | unsigned int ndx = (type + hash) % OSSL_NELEM(hash_table); | |
134 | ||
135 | for (bp = hash_table[ndx]; bp; bp = bp->next) | |
136 | if (bp->type == type && bp->hash == hash) | |
137 | break; | |
138 | if (bp == NULL) { | |
139 | bp = app_malloc(sizeof(*bp), "hash bucket"); | |
140 | *bp = nilbucket; | |
141 | bp->next = hash_table[ndx]; | |
142 | bp->type = type; | |
143 | bp->hash = hash; | |
144 | hash_table[ndx] = bp; | |
145 | } | |
146 | ||
147 | for (ep = bp->first_entry; ep; ep = ep->next) { | |
148 | if (digest && memcmp(digest, ep->digest, evpmdsize) == 0) { | |
149 | BIO_printf(bio_err, | |
150 | "%s: warning: skipping duplicate %s in %s\n", | |
151 | opt_getprog(), | |
152 | type == TYPE_CERT ? "certificate" : "CRL", filename); | |
153 | return 0; | |
154 | } | |
155 | if (strcmp(filename, ep->filename) == 0) { | |
156 | found = ep; | |
157 | if (digest == NULL) | |
158 | break; | |
159 | } | |
160 | } | |
161 | ep = found; | |
162 | if (ep == NULL) { | |
163 | if (bp->num_needed >= MAX_COLLISIONS) { | |
164 | BIO_printf(bio_err, | |
165 | "%s: error: hash table overflow for %s\n", | |
166 | opt_getprog(), filename); | |
167 | return 1; | |
168 | } | |
169 | ep = app_malloc(sizeof(*ep), "collision bucket"); | |
170 | *ep = nilhentry; | |
171 | ep->old_id = ~0; | |
172 | ep->filename = OPENSSL_strdup(filename); | |
173 | if (bp->last_entry) | |
174 | bp->last_entry->next = ep; | |
175 | if (bp->first_entry == NULL) | |
176 | bp->first_entry = ep; | |
177 | bp->last_entry = ep; | |
178 | } | |
179 | ||
180 | if (old_id < ep->old_id) | |
181 | ep->old_id = old_id; | |
182 | if (need_symlink && !ep->need_symlink) { | |
183 | ep->need_symlink = 1; | |
184 | bp->num_needed++; | |
185 | memcpy(ep->digest, digest, evpmdsize); | |
186 | } | |
187 | return 0; | |
188 | } | |
189 | ||
190 | /* | |
191 | * Check if a symlink goes to the right spot; return 0 if okay. | |
192 | * This can be -1 if bad filename, or an error count. | |
193 | */ | |
194 | static int handle_symlink(const char *filename, const char *fullpath) | |
195 | { | |
196 | unsigned int hash = 0; | |
197 | int i, type, id; | |
198 | unsigned char ch; | |
199 | char linktarget[PATH_MAX], *endptr; | |
200 | ossl_ssize_t n; | |
201 | ||
202 | for (i = 0; i < 8; i++) { | |
203 | ch = filename[i]; | |
204 | if (!isxdigit(ch)) | |
205 | return -1; | |
206 | hash <<= 4; | |
207 | hash += OPENSSL_hexchar2int(ch); | |
208 | } | |
209 | if (filename[i++] != '.') | |
210 | return -1; | |
211 | for (type = OSSL_NELEM(suffixes) - 1; type > 0; type--) { | |
212 | const char *suffix = suffixes[type]; | |
213 | if (strncasecmp(suffix, &filename[i], strlen(suffix)) == 0) | |
214 | break; | |
215 | } | |
216 | i += strlen(suffixes[type]); | |
217 | ||
218 | id = strtoul(&filename[i], &endptr, 10); | |
219 | if (*endptr != '\0') | |
220 | return -1; | |
221 | ||
222 | n = readlink(fullpath, linktarget, sizeof(linktarget)); | |
223 | if (n < 0 || n >= (int)sizeof(linktarget)) | |
224 | return -1; | |
225 | linktarget[n] = 0; | |
226 | ||
227 | return add_entry(type, hash, linktarget, NULL, 0, id); | |
228 | } | |
229 | ||
230 | /* | |
231 | * process a file, return number of errors. | |
232 | */ | |
233 | static int do_file(const char *filename, const char *fullpath, enum Hash h) | |
234 | { | |
235 | STACK_OF (X509_INFO) *inf = NULL; | |
236 | X509_INFO *x; | |
237 | const X509_NAME *name = NULL; | |
238 | BIO *b; | |
239 | const char *ext; | |
240 | unsigned char digest[EVP_MAX_MD_SIZE]; | |
241 | int type, errs = 0; | |
242 | size_t i; | |
243 | ||
244 | /* Does it end with a recognized extension? */ | |
245 | if ((ext = strrchr(filename, '.')) == NULL) | |
246 | goto end; | |
247 | for (i = 0; i < OSSL_NELEM(extensions); i++) { | |
248 | if (strcasecmp(extensions[i], ext + 1) == 0) | |
249 | break; | |
250 | } | |
251 | if (i >= 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: error: 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: warning: 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 != NULL) { | |
276 | type = TYPE_CERT; | |
277 | name = X509_get_subject_name(x->x509); | |
278 | if (!X509_digest(x->x509, evpmd, digest, NULL)) { | |
279 | BIO_printf(bio_err, "out of memory\n"); | |
280 | ++errs; | |
281 | goto end; | |
282 | } | |
283 | } else if (x->crl != NULL) { | |
284 | type = TYPE_CRL; | |
285 | name = X509_CRL_get_issuer(x->crl); | |
286 | if (!X509_CRL_digest(x->crl, evpmd, digest, NULL)) { | |
287 | BIO_printf(bio_err, "out of memory\n"); | |
288 | ++errs; | |
289 | goto end; | |
290 | } | |
291 | } else { | |
292 | ++errs; | |
293 | goto end; | |
294 | } | |
295 | if (name != NULL) { | |
296 | if ((h == HASH_NEW) || (h == HASH_BOTH)) | |
297 | errs += add_entry(type, X509_NAME_hash(name), filename, digest, 1, ~0); | |
298 | if ((h == HASH_OLD) || (h == HASH_BOTH)) | |
299 | errs += add_entry(type, X509_NAME_hash_old(name), filename, digest, 1, ~0); | |
300 | } | |
301 | ||
302 | end: | |
303 | sk_X509_INFO_pop_free(inf, X509_INFO_free); | |
304 | return errs; | |
305 | } | |
306 | ||
307 | static void str_free(char *s) | |
308 | { | |
309 | OPENSSL_free(s); | |
310 | } | |
311 | ||
312 | static int ends_with_dirsep(const char *path) | |
313 | { | |
314 | if (*path != '\0') | |
315 | path += strlen(path) - 1; | |
316 | # if defined __VMS | |
317 | if (*path == ']' || *path == '>' || *path == ':') | |
318 | return 1; | |
319 | # elif defined _WIN32 | |
320 | if (*path == '\\') | |
321 | return 1; | |
322 | # endif | |
323 | return *path == '/'; | |
324 | } | |
325 | ||
326 | /* | |
327 | * Process a directory; return number of errors found. | |
328 | */ | |
329 | static int do_dir(const char *dirname, enum Hash h) | |
330 | { | |
331 | BUCKET *bp, *nextbp; | |
332 | HENTRY *ep, *nextep; | |
333 | OPENSSL_DIR_CTX *d = NULL; | |
334 | struct stat st; | |
335 | unsigned char idmask[MAX_COLLISIONS / 8]; | |
336 | int n, numfiles, nextid, buflen, errs = 0; | |
337 | size_t i; | |
338 | const char *pathsep; | |
339 | const char *filename; | |
340 | char *buf, *copy = NULL; | |
341 | STACK_OF(OPENSSL_STRING) *files = NULL; | |
342 | ||
343 | if (app_access(dirname, W_OK) < 0) { | |
344 | BIO_printf(bio_err, "Skipping %s, can't write\n", dirname); | |
345 | return 1; | |
346 | } | |
347 | buflen = strlen(dirname); | |
348 | pathsep = (buflen && !ends_with_dirsep(dirname)) ? "/": ""; | |
349 | buflen += NAME_MAX + 1 + 1; | |
350 | buf = app_malloc(buflen, "filename buffer"); | |
351 | ||
352 | if (verbose) | |
353 | BIO_printf(bio_out, "Doing %s\n", dirname); | |
354 | ||
355 | if ((files = sk_OPENSSL_STRING_new_null()) == NULL) { | |
356 | BIO_printf(bio_err, "Skipping %s, out of memory\n", dirname); | |
357 | errs = 1; | |
358 | goto err; | |
359 | } | |
360 | while ((filename = OPENSSL_DIR_read(&d, dirname)) != NULL) { | |
361 | if ((copy = OPENSSL_strdup(filename)) == NULL | |
362 | || sk_OPENSSL_STRING_push(files, copy) == 0) { | |
363 | OPENSSL_free(copy); | |
364 | BIO_puts(bio_err, "out of memory\n"); | |
365 | errs = 1; | |
366 | goto err; | |
367 | } | |
368 | } | |
369 | OPENSSL_DIR_end(&d); | |
370 | sk_OPENSSL_STRING_sort(files); | |
371 | ||
372 | numfiles = sk_OPENSSL_STRING_num(files); | |
373 | for (n = 0; n < numfiles; ++n) { | |
374 | filename = sk_OPENSSL_STRING_value(files, n); | |
375 | if (BIO_snprintf(buf, buflen, "%s%s%s", | |
376 | dirname, pathsep, filename) >= buflen) | |
377 | continue; | |
378 | if (lstat(buf, &st) < 0) | |
379 | continue; | |
380 | if (S_ISLNK(st.st_mode) && handle_symlink(filename, buf) == 0) | |
381 | continue; | |
382 | errs += do_file(filename, buf, h); | |
383 | } | |
384 | ||
385 | for (i = 0; i < OSSL_NELEM(hash_table); i++) { | |
386 | for (bp = hash_table[i]; bp; bp = nextbp) { | |
387 | nextbp = bp->next; | |
388 | nextid = 0; | |
389 | memset(idmask, 0, (bp->num_needed + 7) / 8); | |
390 | for (ep = bp->first_entry; ep; ep = ep->next) | |
391 | if (ep->old_id < bp->num_needed) | |
392 | bit_set(idmask, ep->old_id); | |
393 | ||
394 | for (ep = bp->first_entry; ep; ep = nextep) { | |
395 | nextep = ep->next; | |
396 | if (ep->old_id < bp->num_needed) { | |
397 | /* Link exists, and is used as-is */ | |
398 | BIO_snprintf(buf, buflen, "%08x.%s%d", bp->hash, | |
399 | suffixes[bp->type], ep->old_id); | |
400 | if (verbose) | |
401 | BIO_printf(bio_out, "link %s -> %s\n", | |
402 | ep->filename, buf); | |
403 | } else if (ep->need_symlink) { | |
404 | /* New link needed (it may replace something) */ | |
405 | while (bit_isset(idmask, nextid)) | |
406 | nextid++; | |
407 | ||
408 | BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d", | |
409 | dirname, pathsep, &n, bp->hash, | |
410 | suffixes[bp->type], nextid); | |
411 | if (verbose) | |
412 | BIO_printf(bio_out, "link %s -> %s\n", | |
413 | ep->filename, &buf[n]); | |
414 | if (unlink(buf) < 0 && errno != ENOENT) { | |
415 | BIO_printf(bio_err, | |
416 | "%s: Can't unlink %s, %s\n", | |
417 | opt_getprog(), buf, strerror(errno)); | |
418 | errs++; | |
419 | } | |
420 | if (symlink(ep->filename, buf) < 0) { | |
421 | BIO_printf(bio_err, | |
422 | "%s: Can't symlink %s, %s\n", | |
423 | opt_getprog(), ep->filename, | |
424 | strerror(errno)); | |
425 | errs++; | |
426 | } | |
427 | bit_set(idmask, nextid); | |
428 | } else if (remove_links) { | |
429 | /* Link to be deleted */ | |
430 | BIO_snprintf(buf, buflen, "%s%s%n%08x.%s%d", | |
431 | dirname, pathsep, &n, bp->hash, | |
432 | suffixes[bp->type], ep->old_id); | |
433 | if (verbose) | |
434 | BIO_printf(bio_out, "unlink %s\n", | |
435 | &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 | } | |
443 | OPENSSL_free(ep->filename); | |
444 | OPENSSL_free(ep); | |
445 | } | |
446 | OPENSSL_free(bp); | |
447 | } | |
448 | hash_table[i] = NULL; | |
449 | } | |
450 | ||
451 | err: | |
452 | sk_OPENSSL_STRING_pop_free(files, str_free); | |
453 | OPENSSL_free(buf); | |
454 | return errs; | |
455 | } | |
456 | ||
457 | typedef enum OPTION_choice { | |
458 | OPT_ERR = -1, OPT_EOF = 0, OPT_HELP, | |
459 | OPT_COMPAT, OPT_OLD, OPT_N, OPT_VERBOSE, | |
460 | OPT_PROV_ENUM | |
461 | } OPTION_CHOICE; | |
462 | ||
463 | const OPTIONS rehash_options[] = { | |
464 | {OPT_HELP_STR, 1, '-', "Usage: %s [options] [directory...]\n"}, | |
465 | ||
466 | OPT_SECTION("General"), | |
467 | {"help", OPT_HELP, '-', "Display this summary"}, | |
468 | {"h", OPT_HELP, '-', "Display this summary"}, | |
469 | {"compat", OPT_COMPAT, '-', "Create both new- and old-style hash links"}, | |
470 | {"old", OPT_OLD, '-', "Use old-style hash to generate links"}, | |
471 | {"n", OPT_N, '-', "Do not remove existing links"}, | |
472 | ||
473 | OPT_SECTION("Output"), | |
474 | {"v", OPT_VERBOSE, '-', "Verbose output"}, | |
475 | ||
476 | OPT_PROV_OPTIONS, | |
477 | ||
478 | OPT_PARAMETERS(), | |
479 | {"directory", 0, 0, "One or more directories to process (optional)"}, | |
480 | {NULL} | |
481 | }; | |
482 | ||
483 | ||
484 | int rehash_main(int argc, char **argv) | |
485 | { | |
486 | const char *env, *prog; | |
487 | char *e, *m; | |
488 | int errs = 0; | |
489 | OPTION_CHOICE o; | |
490 | enum Hash h = HASH_NEW; | |
491 | ||
492 | prog = opt_init(argc, argv, rehash_options); | |
493 | while ((o = opt_next()) != OPT_EOF) { | |
494 | switch (o) { | |
495 | case OPT_EOF: | |
496 | case OPT_ERR: | |
497 | BIO_printf(bio_err, "%s: Use -help for summary.\n", prog); | |
498 | goto end; | |
499 | case OPT_HELP: | |
500 | opt_help(rehash_options); | |
501 | goto end; | |
502 | case OPT_COMPAT: | |
503 | h = HASH_BOTH; | |
504 | break; | |
505 | case OPT_OLD: | |
506 | h = HASH_OLD; | |
507 | break; | |
508 | case OPT_N: | |
509 | remove_links = 0; | |
510 | break; | |
511 | case OPT_VERBOSE: | |
512 | verbose = 1; | |
513 | break; | |
514 | case OPT_PROV_CASES: | |
515 | if (!opt_provider(o)) | |
516 | goto end; | |
517 | break; | |
518 | } | |
519 | } | |
520 | argc = opt_num_rest(); | |
521 | argv = opt_rest(); | |
522 | ||
523 | evpmd = EVP_sha1(); | |
524 | evpmdsize = EVP_MD_size(evpmd); | |
525 | ||
526 | if (*argv != NULL) { | |
527 | while (*argv != NULL) | |
528 | errs += do_dir(*argv++, h); | |
529 | } else if ((env = getenv(X509_get_default_cert_dir_env())) != NULL) { | |
530 | char lsc[2] = { LIST_SEPARATOR_CHAR, '\0' }; | |
531 | m = OPENSSL_strdup(env); | |
532 | for (e = strtok(m, lsc); e != NULL; e = strtok(NULL, lsc)) | |
533 | errs += do_dir(e, h); | |
534 | OPENSSL_free(m); | |
535 | } else { | |
536 | errs += do_dir(X509_get_default_cert_dir(), h); | |
537 | } | |
538 | ||
539 | end: | |
540 | return errs; | |
541 | } | |
542 | ||
543 | #else | |
544 | const OPTIONS rehash_options[] = { | |
545 | {NULL} | |
546 | }; | |
547 | ||
548 | int rehash_main(int argc, char **argv) | |
549 | { | |
550 | BIO_printf(bio_err, "Not available; use c_rehash script\n"); | |
551 | return 1; | |
552 | } | |
553 | ||
554 | #endif /* defined(OPENSSL_SYS_UNIX) || defined(__APPLE__) */ |