2 * Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
16 #include <openssl/bio.h>
17 #include <openssl/dsa.h> /* For d2i_DSAPrivateKey */
18 #include <openssl/err.h>
19 #include <openssl/evp.h>
20 #include <openssl/pem.h>
21 #include <openssl/pkcs12.h> /* For the PKCS8 stuff o.O */
22 #include <openssl/rsa.h> /* For d2i_RSAPrivateKey */
23 #include <openssl/safestack.h>
24 #include <openssl/store.h>
25 #include <openssl/ui.h>
26 #include <openssl/x509.h> /* For the PKCS8 stuff o.O */
27 #include "crypto/asn1.h"
28 #include "crypto/ctype.h"
29 #include "internal/o_dir.h"
30 #include "internal/cryptlib.h"
31 #include "crypto/store.h"
32 #include "crypto/evp.h"
33 #include "store_local.h"
40 # define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
48 static char *file_get_pass(const UI_METHOD *ui_method, char *pass,
49 size_t maxsize, const char *prompt_info, void *data)
55 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE);
59 if (ui_method != NULL)
60 UI_set_method(ui, ui_method);
61 UI_add_user_data(ui, data);
63 if ((prompt = UI_construct_prompt(ui, "pass phrase",
64 prompt_info)) == NULL) {
65 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE);
67 } else if (!UI_add_input_string(ui, prompt, UI_INPUT_FLAG_DEFAULT_PWD,
68 pass, 0, maxsize - 1)) {
69 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB);
72 switch (UI_process(ui)) {
74 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS,
75 OSSL_STORE_R_UI_PROCESS_INTERRUPTED_OR_CANCELLED);
79 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB);
92 struct pem_pass_data {
93 const UI_METHOD *ui_method;
95 const char *prompt_info;
98 static int file_fill_pem_pass_data(struct pem_pass_data *pass_data,
99 const char *prompt_info,
100 const UI_METHOD *ui_method, void *ui_data)
102 if (pass_data == NULL)
104 pass_data->ui_method = ui_method;
105 pass_data->data = ui_data;
106 pass_data->prompt_info = prompt_info;
110 /* This is used anywhere a pem_password_cb is needed */
111 static int file_get_pem_pass(char *buf, int num, int w, void *data)
113 struct pem_pass_data *pass_data = data;
114 char *pass = file_get_pass(pass_data->ui_method, buf, num,
115 pass_data->prompt_info, pass_data->data);
117 return pass == NULL ? 0 : strlen(pass);
121 * The file scheme decoders
122 * ------------------------
124 * Each possible data type has its own decoder, which either operates
125 * through a given PEM name, or attempts to decode to see if the blob
126 * it's given is decodable for its data type. The assumption is that
127 * only the correct data type will match the content.
131 * The try_decode function is called to check if the blob of data can
132 * be used by this handler, and if it can, decodes it into a supported
133 * OpenSSL type and returns a OSSL_STORE_INFO with the decoded data.
135 * pem_name: If this blob comes from a PEM file, this holds
136 * the PEM name. If it comes from another type of
137 * file, this is NULL.
138 * pem_header: If this blob comes from a PEM file, this holds
139 * the PEM headers. If it comes from another type of
140 * file, this is NULL.
141 * blob: The blob of data to match with what this handler
143 * len: The length of the blob.
144 * handler_ctx: For a handler marked repeatable, this pointer can
145 * be used to create a context for the handler. IT IS
146 * THE HANDLER'S RESPONSIBILITY TO CREATE AND DESTROY
147 * THIS CONTEXT APPROPRIATELY, i.e. create on first call
148 * and destroy when about to return NULL.
149 * matchcount: A pointer to an int to count matches for this data.
150 * Usually becomes 0 (no match) or 1 (match!), but may
151 * be higher in the (unlikely) event that the data matches
152 * more than one possibility. The int will always be
153 * zero when the function is called.
154 * ui_method: Application UI method for getting a password, pin
155 * or any other interactive data.
156 * ui_data: Application data to be passed to ui_method when
158 * libctx: The library context to be used if applicable
159 * propq: The property query string for any algorithm fetches
163 typedef OSSL_STORE_INFO *(*file_try_decode_fn)(const char *pem_name,
164 const char *pem_header,
165 const unsigned char *blob,
166 size_t len, void **handler_ctx,
168 const UI_METHOD *ui_method,
173 * The eof function should return 1 if there's no more data to be found
174 * with the handler_ctx, otherwise 0. This is only used when the handler is
177 typedef int (*file_eof_fn)(void *handler_ctx);
179 * The destroy_ctx function is used to destroy the handler_ctx that was
180 * initiated by a repeatable try_decode function. This is only used when
181 * the handler is marked repeatable.
183 typedef void (*file_destroy_ctx_fn)(void **handler_ctx);
185 typedef struct file_handler_st {
187 file_try_decode_fn try_decode;
189 file_destroy_ctx_fn destroy_ctx;
196 * PKCS#12 decoder. It operates by decoding all of the blob content,
197 * extracting all the interesting data from it and storing them internally,
198 * then serving them one piece at a time.
200 static OSSL_STORE_INFO *try_decode_PKCS12(const char *pem_name,
201 const char *pem_header,
202 const unsigned char *blob,
203 size_t len, void **pctx,
205 const UI_METHOD *ui_method,
206 void *ui_data, OPENSSL_CTX *libctx,
209 OSSL_STORE_INFO *store_info = NULL;
210 STACK_OF(OSSL_STORE_INFO) *ctx = *pctx;
213 /* Initial parsing */
217 if (pem_name != NULL)
218 /* No match, there is no PEM PKCS12 tag */
221 if ((p12 = d2i_PKCS12(NULL, &blob, len)) != NULL) {
223 char tpass[PEM_BUFSIZE];
224 EVP_PKEY *pkey = NULL;
226 STACK_OF(X509) *chain = NULL;
230 if (PKCS12_verify_mac(p12, "", 0)
231 || PKCS12_verify_mac(p12, NULL, 0)) {
234 if ((pass = file_get_pass(ui_method, tpass, PEM_BUFSIZE,
235 "PKCS12 import password",
237 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12,
238 OSSL_STORE_R_PASSPHRASE_CALLBACK_ERROR);
241 if (!PKCS12_verify_mac(p12, pass, strlen(pass))) {
242 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12,
243 OSSL_STORE_R_ERROR_VERIFYING_PKCS12_MAC);
248 if (PKCS12_parse(p12, pass, &pkey, &cert, &chain)) {
249 OSSL_STORE_INFO *osi_pkey = NULL;
250 OSSL_STORE_INFO *osi_cert = NULL;
251 OSSL_STORE_INFO *osi_ca = NULL;
253 if ((ctx = sk_OSSL_STORE_INFO_new_null()) != NULL
254 && (osi_pkey = OSSL_STORE_INFO_new_PKEY(pkey)) != NULL
255 && sk_OSSL_STORE_INFO_push(ctx, osi_pkey) != 0
256 && (osi_cert = OSSL_STORE_INFO_new_CERT(cert)) != NULL
257 && sk_OSSL_STORE_INFO_push(ctx, osi_cert) != 0) {
262 while(sk_X509_num(chain) > 0) {
263 X509 *ca = sk_X509_value(chain, 0);
265 if ((osi_ca = OSSL_STORE_INFO_new_CERT(ca)) == NULL
266 || sk_OSSL_STORE_INFO_push(ctx, osi_ca) == 0) {
271 (void)sk_X509_shift(chain);
275 OSSL_STORE_INFO_free(osi_ca);
276 OSSL_STORE_INFO_free(osi_cert);
277 OSSL_STORE_INFO_free(osi_pkey);
278 sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free);
281 sk_X509_pop_free(chain, X509_free);
295 store_info = sk_OSSL_STORE_INFO_shift(ctx);
301 static int eof_PKCS12(void *ctx_)
303 STACK_OF(OSSL_STORE_INFO) *ctx = ctx_;
305 return ctx == NULL || sk_OSSL_STORE_INFO_num(ctx) == 0;
308 static void destroy_ctx_PKCS12(void **pctx)
310 STACK_OF(OSSL_STORE_INFO) *ctx = *pctx;
312 sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free);
316 static FILE_HANDLER PKCS12_handler = {
325 * Encrypted PKCS#8 decoder. It operates by just decrypting the given blob
326 * into a new blob, which is returned as an EMBEDDED STORE_INFO. The whole
327 * decoding process will then start over with the new blob.
329 static OSSL_STORE_INFO *try_decode_PKCS8Encrypted(const char *pem_name,
330 const char *pem_header,
331 const unsigned char *blob,
332 size_t len, void **pctx,
334 const UI_METHOD *ui_method,
340 char kbuf[PEM_BUFSIZE];
342 const X509_ALGOR *dalg = NULL;
343 const ASN1_OCTET_STRING *doct = NULL;
344 OSSL_STORE_INFO *store_info = NULL;
346 unsigned char *new_data = NULL;
349 if (pem_name != NULL) {
350 if (strcmp(pem_name, PEM_STRING_PKCS8) != 0)
355 if ((p8 = d2i_X509_SIG(NULL, &blob, len)) == NULL)
360 if ((mem = BUF_MEM_new()) == NULL) {
361 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
362 ERR_R_MALLOC_FAILURE);
366 if ((pass = file_get_pass(ui_method, kbuf, PEM_BUFSIZE,
367 "PKCS8 decrypt password", ui_data)) == NULL) {
368 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
369 OSSL_STORE_R_BAD_PASSWORD_READ);
373 X509_SIG_get0(p8, &dalg, &doct);
374 if (!PKCS12_pbe_crypt(dalg, pass, strlen(pass), doct->data, doct->length,
375 &new_data, &new_data_len, 0))
378 mem->data = (char *)new_data;
379 mem->max = mem->length = (size_t)new_data_len;
382 store_info = ossl_store_info_new_EMBEDDED(PEM_STRING_PKCS8INF, mem);
383 if (store_info == NULL) {
384 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
385 ERR_R_MALLOC_FAILURE);
396 static FILE_HANDLER PKCS8Encrypted_handler = {
398 try_decode_PKCS8Encrypted
402 * Private key decoder. Decodes all sorts of private keys, both PKCS#8
403 * encoded ones and old style PEM ones (with the key type is encoded into
406 int pem_check_suffix(const char *pem_str, const char *suffix);
407 static OSSL_STORE_INFO *try_decode_PrivateKey(const char *pem_name,
408 const char *pem_header,
409 const unsigned char *blob,
410 size_t len, void **pctx,
412 const UI_METHOD *ui_method,
413 void *ui_data, OPENSSL_CTX *libctx,
416 OSSL_STORE_INFO *store_info = NULL;
417 EVP_PKEY *pkey = NULL;
418 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
420 if (pem_name != NULL) {
421 if (strcmp(pem_name, PEM_STRING_PKCS8INF) == 0) {
422 PKCS8_PRIV_KEY_INFO *p8inf =
423 d2i_PKCS8_PRIV_KEY_INFO(NULL, &blob, len);
427 pkey = evp_pkcs82pkey_int(p8inf, libctx, propq);
428 PKCS8_PRIV_KEY_INFO_free(p8inf);
432 if ((slen = pem_check_suffix(pem_name, "PRIVATE KEY")) > 0
433 && (ameth = EVP_PKEY_asn1_find_str(NULL, pem_name,
436 pkey = d2i_PrivateKey_ex(ameth->pkey_id, NULL, &blob, len,
443 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
444 EVP_PKEY *tmp_pkey = NULL;
445 const unsigned char *tmp_blob = blob;
447 ameth = EVP_PKEY_asn1_get0(i);
448 if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
451 tmp_pkey = d2i_PrivateKey_ex(ameth->pkey_id, NULL, &tmp_blob, len,
453 if (tmp_pkey != NULL) {
455 EVP_PKEY_free(tmp_pkey);
462 if (*matchcount > 1) {
471 store_info = OSSL_STORE_INFO_new_PKEY(pkey);
472 if (store_info == NULL)
478 static FILE_HANDLER PrivateKey_handler = {
480 try_decode_PrivateKey
484 * Public key decoder. Only supports SubjectPublicKeyInfo formatted keys.
486 static OSSL_STORE_INFO *try_decode_PUBKEY(const char *pem_name,
487 const char *pem_header,
488 const unsigned char *blob,
489 size_t len, void **pctx,
491 const UI_METHOD *ui_method,
492 void *ui_data, OPENSSL_CTX *libctx,
495 OSSL_STORE_INFO *store_info = NULL;
496 EVP_PKEY *pkey = NULL;
498 if (pem_name != NULL) {
499 if (strcmp(pem_name, PEM_STRING_PUBLIC) != 0)
505 if ((pkey = d2i_PUBKEY(NULL, &blob, len)) != NULL) {
507 store_info = OSSL_STORE_INFO_new_PKEY(pkey);
513 static FILE_HANDLER PUBKEY_handler = {
519 * Key parameter decoder.
521 static OSSL_STORE_INFO *try_decode_params(const char *pem_name,
522 const char *pem_header,
523 const unsigned char *blob,
524 size_t len, void **pctx,
526 const UI_METHOD *ui_method,
527 void *ui_data, OPENSSL_CTX *libctx,
530 OSSL_STORE_INFO *store_info = NULL;
532 EVP_PKEY *pkey = NULL;
533 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
536 if (pem_name != NULL) {
537 if ((slen = pem_check_suffix(pem_name, "PARAMETERS")) == 0)
543 if ((pkey = EVP_PKEY_new()) == NULL) {
544 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB);
549 if (EVP_PKEY_set_type_str(pkey, pem_name, slen)
550 && (ameth = EVP_PKEY_get0_asn1(pkey)) != NULL
551 && ameth->param_decode != NULL
552 && ameth->param_decode(pkey, &blob, len))
556 EVP_PKEY *tmp_pkey = NULL;
558 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
559 const unsigned char *tmp_blob = blob;
561 if (tmp_pkey == NULL && (tmp_pkey = EVP_PKEY_new()) == NULL) {
562 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB);
566 ameth = EVP_PKEY_asn1_get0(i);
567 if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
570 if (EVP_PKEY_set_type(tmp_pkey, ameth->pkey_id)
571 && (ameth = EVP_PKEY_get0_asn1(tmp_pkey)) != NULL
572 && ameth->param_decode != NULL
573 && ameth->param_decode(tmp_pkey, &tmp_blob, len)) {
575 EVP_PKEY_free(tmp_pkey);
583 EVP_PKEY_free(tmp_pkey);
584 if (*matchcount == 1) {
590 store_info = OSSL_STORE_INFO_new_PARAMS(pkey);
591 if (store_info == NULL)
597 static FILE_HANDLER params_handler = {
603 * X.509 certificate decoder.
605 static OSSL_STORE_INFO *try_decode_X509Certificate(const char *pem_name,
606 const char *pem_header,
607 const unsigned char *blob,
608 size_t len, void **pctx,
610 const UI_METHOD *ui_method,
615 OSSL_STORE_INFO *store_info = NULL;
619 * In most cases, we can try to interpret the serialized data as a trusted
620 * cert (X509 + X509_AUX) and fall back to reading it as a normal cert
621 * (just X509), but if the PEM name specifically declares it as a trusted
622 * cert, then no fallback should be engaged. |ignore_trusted| tells if
623 * the fallback can be used (1) or not (0).
625 int ignore_trusted = 1;
627 if (pem_name != NULL) {
628 if (strcmp(pem_name, PEM_STRING_X509_TRUSTED) == 0)
630 else if (strcmp(pem_name, PEM_STRING_X509_OLD) != 0
631 && strcmp(pem_name, PEM_STRING_X509) != 0)
637 if ((cert = d2i_X509_AUX(NULL, &blob, len)) != NULL
638 || (ignore_trusted && (cert = d2i_X509(NULL, &blob, len)) != NULL)) {
640 store_info = OSSL_STORE_INFO_new_CERT(cert);
643 if (store_info == NULL)
649 static FILE_HANDLER X509Certificate_handler = {
651 try_decode_X509Certificate
657 static OSSL_STORE_INFO *try_decode_X509CRL(const char *pem_name,
658 const char *pem_header,
659 const unsigned char *blob,
660 size_t len, void **pctx,
662 const UI_METHOD *ui_method,
663 void *ui_data, OPENSSL_CTX *libctx,
666 OSSL_STORE_INFO *store_info = NULL;
667 X509_CRL *crl = NULL;
669 if (pem_name != NULL) {
670 if (strcmp(pem_name, PEM_STRING_X509_CRL) != 0)
676 if ((crl = d2i_X509_CRL(NULL, &blob, len)) != NULL) {
678 store_info = OSSL_STORE_INFO_new_CRL(crl);
681 if (store_info == NULL)
687 static FILE_HANDLER X509CRL_handler = {
693 * To finish it all off, we collect all the handlers.
695 static const FILE_HANDLER *file_handlers[] = {
697 &PKCS8Encrypted_handler,
698 &X509Certificate_handler,
711 struct ossl_store_loader_ctx_st {
718 #define FILE_FLAG_SECMEM (1<<0)
721 struct { /* Used with is_raw and is_pem */
725 * The following are used when the handler is marked as
728 const FILE_HANDLER *last_handler;
729 void *last_handler_ctx;
731 struct { /* Used with is_dir */
732 OPENSSL_DIR_CTX *ctx;
737 * When a search expression is given, these are filled in.
738 * |search_name| contains the file basename to look for.
739 * The string is exactly 8 characters long.
744 * The directory reading utility we have combines opening with
745 * reading the first name. To make sure we can detect the end
746 * at the right time, we read early and cache the name.
748 const char *last_entry;
753 /* Expected object type. May be unspecified */
760 static void OSSL_STORE_LOADER_CTX_free(OSSL_STORE_LOADER_CTX *ctx)
762 if (ctx->type == is_dir) {
763 OPENSSL_free(ctx->_.dir.uri);
765 if (ctx->_.file.last_handler != NULL) {
766 ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx);
767 ctx->_.file.last_handler_ctx = NULL;
768 ctx->_.file.last_handler = NULL;
771 OPENSSL_free(ctx->propq);
775 static OSSL_STORE_LOADER_CTX *file_open(const OSSL_STORE_LOADER *loader,
777 const UI_METHOD *ui_method,
780 OSSL_STORE_LOADER_CTX *ctx = NULL;
784 unsigned int check_absolute:1;
786 size_t path_data_n = 0, i;
790 * First step, just take the URI as is.
792 path_data[path_data_n].check_absolute = 0;
793 path_data[path_data_n++].path = uri;
796 * Second step, if the URI appears to start with the 'file' scheme,
797 * extract the path and make that the second path to check.
798 * There's a special case if the URI also contains an authority, then
799 * the full URI shouldn't be used as a path anywhere.
801 if (strncasecmp(uri, "file:", 5) == 0) {
802 const char *p = &uri[5];
804 if (strncmp(&uri[5], "//", 2) == 0) {
805 path_data_n--; /* Invalidate using the full URI */
806 if (strncasecmp(&uri[7], "localhost/", 10) == 0) {
808 } else if (uri[7] == '/') {
811 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN,
812 OSSL_STORE_R_URI_AUTHORITY_UNSUPPORTED);
817 path_data[path_data_n].check_absolute = 1;
819 /* Windows file: URIs with a drive letter start with a / */
820 if (p[0] == '/' && p[2] == ':' && p[3] == '/') {
821 char c = ossl_tolower(p[1]);
823 if (c >= 'a' && c <= 'z') {
825 /* We know it's absolute, so no need to check */
826 path_data[path_data_n].check_absolute = 0;
830 path_data[path_data_n++].path = p;
834 for (i = 0, path = NULL; path == NULL && i < path_data_n; i++) {
836 * If the scheme "file" was an explicit part of the URI, the path must
837 * be absolute. So says RFC 8089
839 if (path_data[i].check_absolute && path_data[i].path[0] != '/') {
840 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN,
841 OSSL_STORE_R_PATH_MUST_BE_ABSOLUTE);
842 ERR_add_error_data(1, path_data[i].path);
846 if (stat(path_data[i].path, &st) < 0) {
847 ERR_raise_data(ERR_LIB_SYS, errno,
851 path = path_data[i].path;
858 /* Successfully found a working path, clear possible collected errors */
861 ctx = OPENSSL_zalloc(sizeof(*ctx));
863 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_MALLOC_FAILURE);
867 if (S_ISDIR(st.st_mode)) {
869 * Try to copy everything, even if we know that some of them must be
870 * NULL for the moment. This prevents errors in the future, when more
871 * components may be used.
873 ctx->_.dir.uri = OPENSSL_strdup(uri);
876 if (ctx->_.dir.uri == NULL)
879 ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx, path);
880 ctx->_.dir.last_errno = errno;
881 if (ctx->_.dir.last_entry == NULL) {
882 if (ctx->_.dir.last_errno != 0) {
884 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_SYS_LIB);
885 errno = ctx->_.dir.last_errno;
886 if (openssl_strerror_r(errno, errbuf, sizeof(errbuf)))
887 ERR_add_error_data(1, errbuf);
890 ctx->_.dir.end_reached = 1;
894 char peekbuf[4096] = { 0, };
896 if ((buff = BIO_new(BIO_f_buffer())) == NULL
897 || (ctx->_.file.file = BIO_new_file(path, "rb")) == NULL) {
902 ctx->_.file.file = BIO_push(buff, ctx->_.file.file);
903 if (BIO_buffer_peek(ctx->_.file.file, peekbuf, sizeof(peekbuf) - 1) > 0) {
904 peekbuf[sizeof(peekbuf) - 1] = '\0';
905 if (strstr(peekbuf, "-----BEGIN ") != NULL)
912 OSSL_STORE_LOADER_CTX_free(ctx);
916 static int file_ctrl(OSSL_STORE_LOADER_CTX *ctx, int cmd, va_list args)
921 case OSSL_STORE_C_USE_SECMEM:
923 int on = *(va_arg(args, int *));
927 ctx->flags &= ~FILE_FLAG_SECMEM;
930 ctx->flags |= FILE_FLAG_SECMEM;
933 OSSL_STOREerr(OSSL_STORE_F_FILE_CTRL,
934 ERR_R_PASSED_INVALID_ARGUMENT);
947 static int file_expect(OSSL_STORE_LOADER_CTX *ctx, int expected)
949 ctx->expected_type = expected;
953 static int file_find(OSSL_STORE_LOADER_CTX *ctx,
954 const OSSL_STORE_SEARCH *search)
957 * If ctx == NULL, the library is looking to know if this loader supports
958 * the given search type.
961 if (OSSL_STORE_SEARCH_get_type(search) == OSSL_STORE_SEARCH_BY_NAME) {
962 unsigned long hash = 0;
967 if (ctx->type != is_dir) {
968 OSSL_STOREerr(OSSL_STORE_F_FILE_FIND,
969 OSSL_STORE_R_SEARCH_ONLY_SUPPORTED_FOR_DIRECTORIES);
973 hash = X509_NAME_hash(OSSL_STORE_SEARCH_get0_name(search));
974 BIO_snprintf(ctx->_.dir.search_name, sizeof(ctx->_.dir.search_name),
980 OSSL_STOREerr(OSSL_STORE_F_FILE_FIND,
981 OSSL_STORE_R_UNSUPPORTED_SEARCH_TYPE);
985 /* Internal function to decode an already opened PEM file */
986 OSSL_STORE_LOADER_CTX *ossl_store_file_attach_pem_bio_int(BIO *bp,
990 OSSL_STORE_LOADER_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
993 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_FILE_ATTACH_PEM_BIO_INT,
994 ERR_R_MALLOC_FAILURE);
998 ctx->_.file.file = bp;
1001 ctx->libctx = libctx;
1002 if (propq != NULL) {
1003 ctx->propq = OPENSSL_strdup(propq);
1004 if (ctx->propq == NULL) {
1005 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_FILE_ATTACH_PEM_BIO_INT,
1006 ERR_R_MALLOC_FAILURE);
1015 static OSSL_STORE_INFO *file_load_try_decode(OSSL_STORE_LOADER_CTX *ctx,
1016 const char *pem_name,
1017 const char *pem_header,
1018 unsigned char *data, size_t len,
1019 const UI_METHOD *ui_method,
1020 void *ui_data, int *matchcount)
1022 OSSL_STORE_INFO *result = NULL;
1023 BUF_MEM *new_mem = NULL;
1024 char *new_pem_name = NULL;
1030 void *handler_ctx = NULL;
1031 const FILE_HANDLER **matching_handlers =
1032 OPENSSL_zalloc(sizeof(*matching_handlers)
1033 * OSSL_NELEM(file_handlers));
1035 if (matching_handlers == NULL) {
1036 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD_TRY_DECODE,
1037 ERR_R_MALLOC_FAILURE);
1042 for (i = 0; i < OSSL_NELEM(file_handlers); i++) {
1043 const FILE_HANDLER *handler = file_handlers[i];
1044 int try_matchcount = 0;
1045 void *tmp_handler_ctx = NULL;
1046 OSSL_STORE_INFO *tmp_result =
1047 handler->try_decode(pem_name, pem_header, data, len,
1048 &tmp_handler_ctx, &try_matchcount,
1049 ui_method, ui_data, ctx->libctx, ctx->propq);
1051 if (try_matchcount > 0) {
1053 matching_handlers[*matchcount] = handler;
1056 handler->destroy_ctx(&handler_ctx);
1057 handler_ctx = tmp_handler_ctx;
1059 if ((*matchcount += try_matchcount) > 1) {
1060 /* more than one match => ambiguous, kill any result */
1061 OSSL_STORE_INFO_free(result);
1062 OSSL_STORE_INFO_free(tmp_result);
1063 if (handler->destroy_ctx != NULL)
1064 handler->destroy_ctx(&handler_ctx);
1070 result = tmp_result;
1074 if (*matchcount == 1 && matching_handlers[0]->repeatable) {
1075 ctx->_.file.last_handler = matching_handlers[0];
1076 ctx->_.file.last_handler_ctx = handler_ctx;
1079 OPENSSL_free(matching_handlers);
1083 OPENSSL_free(new_pem_name);
1084 BUF_MEM_free(new_mem);
1087 && (t = OSSL_STORE_INFO_get_type(result)) == OSSL_STORE_INFO_EMBEDDED) {
1088 pem_name = new_pem_name =
1089 ossl_store_info_get0_EMBEDDED_pem_name(result);
1090 new_mem = ossl_store_info_get0_EMBEDDED_buffer(result);
1091 data = (unsigned char *)new_mem->data;
1092 len = new_mem->length;
1093 OPENSSL_free(result);
1104 static OSSL_STORE_INFO *file_load_try_repeat(OSSL_STORE_LOADER_CTX *ctx,
1105 const UI_METHOD *ui_method,
1108 OSSL_STORE_INFO *result = NULL;
1109 int try_matchcount = 0;
1111 if (ctx->_.file.last_handler != NULL) {
1113 ctx->_.file.last_handler->try_decode(NULL, NULL, NULL, 0,
1114 &ctx->_.file.last_handler_ctx,
1117 ctx->libctx, ctx->propq);
1119 if (result == NULL) {
1120 ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx);
1121 ctx->_.file.last_handler_ctx = NULL;
1122 ctx->_.file.last_handler = NULL;
1128 static void pem_free_flag(void *pem_data, int secure, size_t num)
1131 OPENSSL_secure_clear_free(pem_data, num);
1133 OPENSSL_free(pem_data);
1135 static int file_read_pem(BIO *bp, char **pem_name, char **pem_header,
1136 unsigned char **data, long *len,
1137 const UI_METHOD *ui_method,
1138 void *ui_data, int secure)
1141 ? PEM_read_bio_ex(bp, pem_name, pem_header, data, len,
1142 PEM_FLAG_SECURE | PEM_FLAG_EAY_COMPATIBLE)
1143 : PEM_read_bio(bp, pem_name, pem_header, data, len);
1149 * 10 is the number of characters in "Proc-Type:", which
1150 * PEM_get_EVP_CIPHER_INFO() requires to be present.
1151 * If the PEM header has less characters than that, it's
1152 * not worth spending cycles on it.
1154 if (strlen(*pem_header) > 10) {
1155 EVP_CIPHER_INFO cipher;
1156 struct pem_pass_data pass_data;
1158 if (!PEM_get_EVP_CIPHER_INFO(*pem_header, &cipher)
1159 || !file_fill_pem_pass_data(&pass_data, "PEM", ui_method, ui_data)
1160 || !PEM_do_header(&cipher, *data, len, file_get_pem_pass,
1168 static int file_read_asn1(BIO *bp, unsigned char **data, long *len)
1170 BUF_MEM *mem = NULL;
1172 if (asn1_d2i_read_bio(bp, &mem) < 0)
1175 *data = (unsigned char *)mem->data;
1176 *len = (long)mem->length;
1182 static int ends_with_dirsep(const char *uri)
1185 uri += strlen(uri) - 1;
1187 if (*uri == ']' || *uri == '>' || *uri == ':')
1189 #elif defined _WIN32
1196 static int file_name_to_uri(OSSL_STORE_LOADER_CTX *ctx, const char *name,
1199 assert(name != NULL);
1200 assert(data != NULL);
1202 const char *pathsep = ends_with_dirsep(ctx->_.dir.uri) ? "" : "/";
1203 long calculated_length = strlen(ctx->_.dir.uri) + strlen(pathsep)
1204 + strlen(name) + 1 /* \0 */;
1206 *data = OPENSSL_zalloc(calculated_length);
1207 if (*data == NULL) {
1208 OSSL_STOREerr(OSSL_STORE_F_FILE_NAME_TO_URI, ERR_R_MALLOC_FAILURE);
1212 OPENSSL_strlcat(*data, ctx->_.dir.uri, calculated_length);
1213 OPENSSL_strlcat(*data, pathsep, calculated_length);
1214 OPENSSL_strlcat(*data, name, calculated_length);
1219 static int file_name_check(OSSL_STORE_LOADER_CTX *ctx, const char *name)
1221 const char *p = NULL;
1223 /* If there are no search criteria, all names are accepted */
1224 if (ctx->_.dir.search_name[0] == '\0')
1227 /* If the expected type isn't supported, no name is accepted */
1228 if (ctx->expected_type != 0
1229 && ctx->expected_type != OSSL_STORE_INFO_CERT
1230 && ctx->expected_type != OSSL_STORE_INFO_CRL)
1234 * First, check the basename
1236 if (strncasecmp(name, ctx->_.dir.search_name,
1237 sizeof(ctx->_.dir.search_name) - 1) != 0
1238 || name[sizeof(ctx->_.dir.search_name) - 1] != '.')
1240 p = &name[sizeof(ctx->_.dir.search_name)];
1243 * Then, if the expected type is a CRL, check that the extension starts
1248 if (ctx->expected_type != 0
1249 && ctx->expected_type != OSSL_STORE_INFO_CRL)
1251 } else if (ctx->expected_type == OSSL_STORE_INFO_CRL) {
1256 * Last, check that the rest of the extension is a decimal number, at
1257 * least one digit long.
1259 if (!ossl_isdigit(*p))
1261 while (ossl_isdigit(*p))
1266 * One extra step here, check for a possible generation number.
1269 for (p++; *p != '\0'; p++)
1270 if (!ossl_isdigit(*p))
1275 * If we've reached the end of the string at this point, we've successfully
1276 * found a fitting file name.
1281 static int file_eof(OSSL_STORE_LOADER_CTX *ctx);
1282 static int file_error(OSSL_STORE_LOADER_CTX *ctx);
1283 static OSSL_STORE_INFO *file_load(OSSL_STORE_LOADER_CTX *ctx,
1284 const UI_METHOD *ui_method, void *ui_data)
1286 OSSL_STORE_INFO *result = NULL;
1291 if (ctx->type == is_dir) {
1293 char *newname = NULL;
1295 if (ctx->_.dir.last_entry == NULL) {
1296 if (!ctx->_.dir.end_reached) {
1298 assert(ctx->_.dir.last_errno != 0);
1299 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, ERR_R_SYS_LIB);
1300 errno = ctx->_.dir.last_errno;
1302 if (openssl_strerror_r(errno, errbuf, sizeof(errbuf)))
1303 ERR_add_error_data(1, errbuf);
1308 if (ctx->_.dir.last_entry[0] != '.'
1309 && file_name_check(ctx, ctx->_.dir.last_entry)
1310 && !file_name_to_uri(ctx, ctx->_.dir.last_entry, &newname))
1314 * On the first call (with a NULL context), OPENSSL_DIR_read()
1315 * cares about the second argument. On the following calls, it
1316 * only cares that it isn't NULL. Therefore, we can safely give
1319 ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx,
1321 ctx->_.dir.last_errno = errno;
1322 if (ctx->_.dir.last_entry == NULL && ctx->_.dir.last_errno == 0)
1323 ctx->_.dir.end_reached = 1;
1326 && (result = OSSL_STORE_INFO_new_NAME(newname)) == NULL) {
1327 OPENSSL_free(newname);
1328 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, ERR_R_OSSL_STORE_LIB);
1331 } while (result == NULL && !file_eof(ctx));
1333 int matchcount = -1;
1336 result = file_load_try_repeat(ctx, ui_method, ui_data);
1344 char *pem_name = NULL; /* PEM record name */
1345 char *pem_header = NULL; /* PEM record header */
1346 unsigned char *data = NULL; /* DER encoded data */
1347 long len = 0; /* DER encoded data length */
1350 if (ctx->type == is_pem) {
1351 if (!file_read_pem(ctx->_.file.file, &pem_name, &pem_header,
1352 &data, &len, ui_method, ui_data,
1353 (ctx->flags & FILE_FLAG_SECMEM) != 0)) {
1358 if (!file_read_asn1(ctx->_.file.file, &data, &len)) {
1364 result = file_load_try_decode(ctx, pem_name, pem_header, data, len,
1365 ui_method, ui_data, &matchcount);
1371 * If a PEM name matches more than one handler, the handlers are
1374 if (!ossl_assert(pem_name == NULL || matchcount <= 1)) {
1379 if (matchcount > 1) {
1380 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD,
1381 OSSL_STORE_R_AMBIGUOUS_CONTENT_TYPE);
1382 } else if (matchcount == 1) {
1384 * If there are other errors on the stack, they already show
1385 * what the problem is.
1387 if (ERR_peek_error() == 0) {
1388 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD,
1389 OSSL_STORE_R_UNSUPPORTED_CONTENT_TYPE);
1390 if (pem_name != NULL)
1391 ERR_add_error_data(3, "PEM type is '", pem_name, "'");
1398 pem_free_flag(pem_name, (ctx->flags & FILE_FLAG_SECMEM) != 0, 0);
1399 pem_free_flag(pem_header, (ctx->flags & FILE_FLAG_SECMEM) != 0, 0);
1400 pem_free_flag(data, (ctx->flags & FILE_FLAG_SECMEM) != 0, len);
1401 } while (matchcount == 0 && !file_eof(ctx) && !file_error(ctx));
1403 /* We bail out on ambiguity */
1408 && ctx->expected_type != 0
1409 && ctx->expected_type != OSSL_STORE_INFO_get_type(result)) {
1410 OSSL_STORE_INFO_free(result);
1418 static int file_error(OSSL_STORE_LOADER_CTX *ctx)
1420 return ctx->errcnt > 0;
1423 static int file_eof(OSSL_STORE_LOADER_CTX *ctx)
1425 if (ctx->type == is_dir)
1426 return ctx->_.dir.end_reached;
1428 if (ctx->_.file.last_handler != NULL
1429 && !ctx->_.file.last_handler->eof(ctx->_.file.last_handler_ctx))
1431 return BIO_eof(ctx->_.file.file);
1434 static int file_close(OSSL_STORE_LOADER_CTX *ctx)
1436 if (ctx->type == is_dir) {
1437 OPENSSL_DIR_end(&ctx->_.dir.ctx);
1439 BIO_free_all(ctx->_.file.file);
1441 OSSL_STORE_LOADER_CTX_free(ctx);
1445 int ossl_store_file_detach_pem_bio_int(OSSL_STORE_LOADER_CTX *ctx)
1447 OSSL_STORE_LOADER_CTX_free(ctx);
1451 static OSSL_STORE_LOADER file_loader =
1465 static void store_file_loader_deinit(void)
1467 ossl_store_unregister_loader_int(file_loader.scheme);
1470 int ossl_store_file_loader_init(void)
1472 int ret = ossl_store_register_loader_int(&file_loader);
1474 OPENSSL_atexit(store_file_loader_deinit);