2 * Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
14 #include <openssl/bio.h>
15 #include <openssl/dsa.h> /* For d2i_DSAPrivateKey */
16 #include <openssl/err.h>
17 #include <openssl/evp.h>
18 #include <openssl/pem.h>
19 #include <openssl/pkcs12.h> /* For the PKCS8 stuff o.O */
20 #include <openssl/rsa.h> /* For d2i_RSAPrivateKey */
21 #include <openssl/safestack.h>
22 #include <openssl/store.h>
23 #include <openssl/ui.h>
24 #include <openssl/x509.h> /* For the PKCS8 stuff o.O */
25 #include "internal/asn1_int.h"
26 #include "internal/o_dir.h"
27 #include "internal/cryptlib.h"
28 #include "internal/store_int.h"
29 #include "store_locl.h"
42 static char *file_get_pass(const UI_METHOD *ui_method, char *pass,
43 size_t maxsize, const char *prompt_info, void *data)
49 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE);
53 if (ui_method != NULL)
54 UI_set_method(ui, ui_method);
55 UI_add_user_data(ui, data);
57 if ((prompt = UI_construct_prompt(ui, "pass phrase",
58 prompt_info)) == NULL) {
59 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE);
61 } else if (!UI_add_input_string(ui, prompt, UI_INPUT_FLAG_DEFAULT_PWD,
62 pass, 0, maxsize - 1)) {
63 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB);
66 switch (UI_process(ui)) {
68 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS,
69 OSSL_STORE_R_UI_PROCESS_INTERRUPTED_OR_CANCELLED);
73 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB);
86 struct pem_pass_data {
87 const UI_METHOD *ui_method;
89 const char *prompt_info;
92 static int file_fill_pem_pass_data(struct pem_pass_data *pass_data,
93 const char *prompt_info,
94 const UI_METHOD *ui_method, void *ui_data)
96 if (pass_data == NULL)
98 pass_data->ui_method = ui_method;
99 pass_data->data = ui_data;
100 pass_data->prompt_info = prompt_info;
104 /* This is used anywhere a pem_password_cb is needed */
105 static int file_get_pem_pass(char *buf, int num, int w, void *data)
107 struct pem_pass_data *pass_data = data;
108 char *pass = file_get_pass(pass_data->ui_method, buf, num,
109 pass_data->prompt_info, pass_data->data);
111 return pass == NULL ? 0 : strlen(pass);
115 * The file scheme decoders
116 * ------------------------
118 * Each possible data type has its own decoder, which either operates
119 * through a given PEM name, or attempts to decode to see if the blob
120 * it's given is decodable for its data type. The assumption is that
121 * only the correct data type will match the content.
125 * The try_decode function is called to check if the blob of data can
126 * be used by this handler, and if it can, decodes it into a supported
127 * OpenSSL type and returns a OSSL_STORE_INFO with the decoded data.
129 * pem_name: If this blob comes from a PEM file, this holds
130 * the PEM name. If it comes from another type of
131 * file, this is NULL.
132 * pem_header: If this blob comes from a PEM file, this holds
133 * the PEM headers. If it comes from another type of
134 * file, this is NULL.
135 * blob: The blob of data to match with what this handler
137 * len: The length of the blob.
138 * handler_ctx: For a handler marked repeatable, this pointer can
139 * be used to create a context for the handler. IT IS
140 * THE HANDLER'S RESPONSIBILITY TO CREATE AND DESTROY
141 * THIS CONTEXT APPROPRIATELY, i.e. create on first call
142 * and destroy when about to return NULL.
143 * matchcount: A pointer to an int to count matches for this data.
144 * Usually becomes 0 (no match) or 1 (match!), but may
145 * be higher in the (unlikely) event that the data matches
146 * more than one possibility. The int will always be
147 * zero when the function is called.
148 * ui_method: Application UI method for getting a password, pin
149 * or any other interactive data.
150 * ui_data: Application data to be passed to ui_method when
155 typedef OSSL_STORE_INFO *(*file_try_decode_fn)(const char *pem_name,
156 const char *pem_header,
157 const unsigned char *blob,
158 size_t len, void **handler_ctx,
160 const UI_METHOD *ui_method,
163 * The eof function should return 1 if there's no more data to be found
164 * with the handler_ctx, otherwise 0. This is only used when the handler is
167 typedef int (*file_eof_fn)(void *handler_ctx);
169 * The destroy_ctx function is used to destroy the handler_ctx that was
170 * intiated by a repeatable try_decode fuction. This is only used when
171 * the handler is marked repeatable.
173 typedef void (*file_destroy_ctx_fn)(void **handler_ctx);
175 typedef struct file_handler_st {
177 file_try_decode_fn try_decode;
179 file_destroy_ctx_fn destroy_ctx;
186 * PKCS#12 decoder. It operates by decoding all of the blob content,
187 * extracting all the interesting data from it and storing them internally,
188 * then serving them one piece at a time.
190 static OSSL_STORE_INFO *try_decode_PKCS12(const char *pem_name,
191 const char *pem_header,
192 const unsigned char *blob,
193 size_t len, void **pctx,
195 const UI_METHOD *ui_method,
198 OSSL_STORE_INFO *store_info = NULL;
199 STACK_OF(OSSL_STORE_INFO) *ctx = *pctx;
202 /* Initial parsing */
206 if (pem_name != NULL)
207 /* No match, there is no PEM PKCS12 tag */
210 if ((p12 = d2i_PKCS12(NULL, &blob, len)) != NULL) {
212 char tpass[PEM_BUFSIZE];
213 EVP_PKEY *pkey = NULL;
215 STACK_OF(X509) *chain = NULL;
219 if (PKCS12_verify_mac(p12, "", 0)
220 || PKCS12_verify_mac(p12, NULL, 0)) {
223 if ((pass = file_get_pass(ui_method, tpass, PEM_BUFSIZE,
224 "PKCS12 import password",
226 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12,
227 OSSL_STORE_R_PASSPHRASE_CALLBACK_ERROR);
230 if (!PKCS12_verify_mac(p12, pass, strlen(pass))) {
231 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12,
232 OSSL_STORE_R_ERROR_VERIFYING_PKCS12_MAC);
237 if (PKCS12_parse(p12, pass, &pkey, &cert, &chain)) {
238 OSSL_STORE_INFO *si_pkey = NULL;
239 OSSL_STORE_INFO *si_cert = NULL;
240 OSSL_STORE_INFO *si_ca = NULL;
242 if ((ctx = sk_OSSL_STORE_INFO_new_null()) != NULL
243 && (si_pkey = OSSL_STORE_INFO_new_PKEY(pkey)) != NULL
244 && sk_OSSL_STORE_INFO_push(ctx, si_pkey) != 0
245 && (si_cert = OSSL_STORE_INFO_new_CERT(cert)) != NULL
246 && sk_OSSL_STORE_INFO_push(ctx, si_cert) != 0) {
251 while(sk_X509_num(chain) > 0) {
252 X509 *ca = sk_X509_value(chain, 0);
254 if ((si_ca = OSSL_STORE_INFO_new_CERT(ca)) == NULL
255 || sk_OSSL_STORE_INFO_push(ctx, si_ca) == 0) {
260 (void)sk_X509_shift(chain);
264 OSSL_STORE_INFO_free(si_ca);
265 OSSL_STORE_INFO_free(si_cert);
266 OSSL_STORE_INFO_free(si_pkey);
267 sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free);
270 sk_X509_pop_free(chain, X509_free);
284 store_info = sk_OSSL_STORE_INFO_shift(ctx);
290 static int eof_PKCS12(void *ctx_)
292 STACK_OF(OSSL_STORE_INFO) *ctx = ctx_;
294 return ctx == NULL || sk_OSSL_STORE_INFO_num(ctx) == 0;
297 static void destroy_ctx_PKCS12(void **pctx)
299 STACK_OF(OSSL_STORE_INFO) *ctx = *pctx;
301 sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free);
305 static FILE_HANDLER PKCS12_handler = {
314 * Encrypted PKCS#8 decoder. It operates by just decrypting the given blob
315 * into a new blob, which is returned as an EMBEDDED STORE_INFO. The whole
316 * decoding process will then start over with the new blob.
318 static OSSL_STORE_INFO *try_decode_PKCS8Encrypted(const char *pem_name,
319 const char *pem_header,
320 const unsigned char *blob,
321 size_t len, void **pctx,
323 const UI_METHOD *ui_method,
327 char kbuf[PEM_BUFSIZE];
329 const X509_ALGOR *dalg = NULL;
330 const ASN1_OCTET_STRING *doct = NULL;
331 OSSL_STORE_INFO *store_info = NULL;
333 unsigned char *new_data = NULL;
336 if (pem_name != NULL) {
337 if (strcmp(pem_name, PEM_STRING_PKCS8) != 0)
342 if ((p8 = d2i_X509_SIG(NULL, &blob, len)) == NULL)
347 if ((mem = BUF_MEM_new()) == NULL) {
348 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
349 ERR_R_MALLOC_FAILURE);
353 if ((pass = file_get_pass(ui_method, kbuf, PEM_BUFSIZE,
354 "PKCS8 decrypt password", ui_data)) == NULL) {
355 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
356 OSSL_STORE_R_BAD_PASSWORD_READ);
360 X509_SIG_get0(p8, &dalg, &doct);
361 if (!PKCS12_pbe_crypt(dalg, pass, strlen(pass), doct->data, doct->length,
362 &new_data, &new_data_len, 0))
365 mem->data = (char *)new_data;
366 mem->max = mem->length = (size_t)new_data_len;
369 store_info = ossl_store_info_new_EMBEDDED(PEM_STRING_PKCS8INF, mem);
370 if (store_info == NULL) {
371 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
372 ERR_R_MALLOC_FAILURE);
383 static FILE_HANDLER PKCS8Encrypted_handler = {
385 try_decode_PKCS8Encrypted
389 * Private key decoder. Decodes all sorts of private keys, both PKCS#8
390 * encoded ones and old style PEM ones (with the key type is encoded into
393 int pem_check_suffix(const char *pem_str, const char *suffix);
394 static OSSL_STORE_INFO *try_decode_PrivateKey(const char *pem_name,
395 const char *pem_header,
396 const unsigned char *blob,
397 size_t len, void **pctx,
399 const UI_METHOD *ui_method,
402 OSSL_STORE_INFO *store_info = NULL;
403 EVP_PKEY *pkey = NULL;
404 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
406 if (pem_name != NULL) {
407 if (strcmp(pem_name, PEM_STRING_PKCS8INF) == 0) {
408 PKCS8_PRIV_KEY_INFO *p8inf =
409 d2i_PKCS8_PRIV_KEY_INFO(NULL, &blob, len);
413 pkey = EVP_PKCS82PKEY(p8inf);
414 PKCS8_PRIV_KEY_INFO_free(p8inf);
418 if ((slen = pem_check_suffix(pem_name, "PRIVATE KEY")) > 0
419 && (ameth = EVP_PKEY_asn1_find_str(NULL, pem_name,
422 pkey = d2i_PrivateKey(ameth->pkey_id, NULL, &blob, len);
428 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
429 EVP_PKEY *tmp_pkey = NULL;
430 const unsigned char *tmp_blob = blob;
432 ameth = EVP_PKEY_asn1_get0(i);
433 if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
436 tmp_pkey = d2i_PrivateKey(ameth->pkey_id, NULL, &tmp_blob, len);
437 if (tmp_pkey != NULL) {
439 EVP_PKEY_free(tmp_pkey);
446 if (*matchcount > 1) {
455 store_info = OSSL_STORE_INFO_new_PKEY(pkey);
456 if (store_info == NULL)
462 static FILE_HANDLER PrivateKey_handler = {
464 try_decode_PrivateKey
468 * Public key decoder. Only supports SubjectPublicKeyInfo formated keys.
470 static OSSL_STORE_INFO *try_decode_PUBKEY(const char *pem_name,
471 const char *pem_header,
472 const unsigned char *blob,
473 size_t len, void **pctx,
475 const UI_METHOD *ui_method,
478 OSSL_STORE_INFO *store_info = NULL;
479 EVP_PKEY *pkey = NULL;
481 if (pem_name != NULL) {
482 if (strcmp(pem_name, PEM_STRING_PUBLIC) != 0)
488 if ((pkey = d2i_PUBKEY(NULL, &blob, len)) != NULL) {
490 store_info = OSSL_STORE_INFO_new_PKEY(pkey);
496 static FILE_HANDLER PUBKEY_handler = {
502 * Key parameter decoder.
504 static OSSL_STORE_INFO *try_decode_params(const char *pem_name,
505 const char *pem_header,
506 const unsigned char *blob,
507 size_t len, void **pctx,
509 const UI_METHOD *ui_method,
512 OSSL_STORE_INFO *store_info = NULL;
514 EVP_PKEY *pkey = NULL;
515 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
518 if (pem_name != NULL) {
519 if ((slen = pem_check_suffix(pem_name, "PARAMETERS")) == 0)
525 if ((pkey = EVP_PKEY_new()) == NULL) {
526 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB);
531 if (EVP_PKEY_set_type_str(pkey, pem_name, slen)
532 && (ameth = EVP_PKEY_get0_asn1(pkey)) != NULL
533 && ameth->param_decode != NULL
534 && ameth->param_decode(pkey, &blob, len))
538 EVP_PKEY *tmp_pkey = NULL;
540 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
541 const unsigned char *tmp_blob = blob;
543 if (tmp_pkey == NULL && (tmp_pkey = EVP_PKEY_new()) == NULL) {
544 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB);
548 ameth = EVP_PKEY_asn1_get0(i);
549 if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
552 if (EVP_PKEY_set_type(tmp_pkey, ameth->pkey_id)
553 && (ameth = EVP_PKEY_get0_asn1(tmp_pkey)) != NULL
554 && ameth->param_decode != NULL
555 && ameth->param_decode(tmp_pkey, &tmp_blob, len)) {
557 EVP_PKEY_free(tmp_pkey);
565 EVP_PKEY_free(tmp_pkey);
566 if (*matchcount == 1) {
572 store_info = OSSL_STORE_INFO_new_PARAMS(pkey);
573 if (store_info == NULL)
579 static FILE_HANDLER params_handler = {
585 * X.509 certificate decoder.
587 static OSSL_STORE_INFO *try_decode_X509Certificate(const char *pem_name,
588 const char *pem_header,
589 const unsigned char *blob,
590 size_t len, void **pctx,
592 const UI_METHOD *ui_method,
595 OSSL_STORE_INFO *store_info = NULL;
599 * In most cases, we can try to interpret the serialized data as a trusted
600 * cert (X509 + X509_AUX) and fall back to reading it as a normal cert
601 * (just X509), but if the PEM name specifically declares it as a trusted
602 * cert, then no fallback should be engaged. |ignore_trusted| tells if
603 * the fallback can be used (1) or not (0).
605 int ignore_trusted = 1;
607 if (pem_name != NULL) {
608 if (strcmp(pem_name, PEM_STRING_X509_TRUSTED) == 0)
610 else if (strcmp(pem_name, PEM_STRING_X509_OLD) != 0
611 && strcmp(pem_name, PEM_STRING_X509) != 0)
617 if ((cert = d2i_X509_AUX(NULL, &blob, len)) != NULL
618 || (ignore_trusted && (cert = d2i_X509(NULL, &blob, len)) != NULL)) {
620 store_info = OSSL_STORE_INFO_new_CERT(cert);
623 if (store_info == NULL)
629 static FILE_HANDLER X509Certificate_handler = {
631 try_decode_X509Certificate
637 static OSSL_STORE_INFO *try_decode_X509CRL(const char *pem_name,
638 const char *pem_header,
639 const unsigned char *blob,
640 size_t len, void **pctx,
642 const UI_METHOD *ui_method,
645 OSSL_STORE_INFO *store_info = NULL;
646 X509_CRL *crl = NULL;
648 if (pem_name != NULL) {
649 if (strcmp(pem_name, PEM_STRING_X509_CRL) != 0)
655 if ((crl = d2i_X509_CRL(NULL, &blob, len)) != NULL) {
657 store_info = OSSL_STORE_INFO_new_CRL(crl);
660 if (store_info == NULL)
666 static FILE_HANDLER X509CRL_handler = {
672 * To finish it all off, we collect all the handlers.
674 static const FILE_HANDLER *file_handlers[] = {
676 &PKCS8Encrypted_handler,
677 &X509Certificate_handler,
690 struct ossl_store_loader_ctx_st {
697 #define FILE_FLAG_SECMEM (1<<0)
700 struct { /* Used with is_raw and is_pem */
704 * The following are used when the handler is marked as
707 const FILE_HANDLER *last_handler;
708 void *last_handler_ctx;
710 struct { /* Used with is_dir */
711 OPENSSL_DIR_CTX *ctx;
716 * The directory reading utility we have combines opening with
717 * reading the first name. To make sure we can detect the end
718 * at the right time, we read early and cache the name.
720 const char *last_entry;
726 static void OSSL_STORE_LOADER_CTX_free(OSSL_STORE_LOADER_CTX *ctx)
728 if (ctx->type == is_dir) {
729 OPENSSL_free(ctx->_.dir.uri);
731 if (ctx->_.file.last_handler != NULL) {
732 ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx);
733 ctx->_.file.last_handler_ctx = NULL;
734 ctx->_.file.last_handler = NULL;
740 static OSSL_STORE_LOADER_CTX *file_open(const OSSL_STORE_LOADER *loader,
742 const UI_METHOD *ui_method,
745 OSSL_STORE_LOADER_CTX *ctx = NULL;
749 unsigned int check_absolute:1;
751 size_t path_data_n = 0, i;
755 * First step, just take the URI as is.
757 path_data[path_data_n].check_absolute = 0;
758 path_data[path_data_n++].path = uri;
761 * Second step, if the URI appears to start with the 'file' scheme,
762 * extract the path and make that the second path to check.
763 * There's a special case if the URI also contains an authority, then
764 * the full URI shouldn't be used as a path anywhere.
766 if (strncasecmp(uri, "file:", 5) == 0) {
767 const char *p = &uri[5];
769 if (strncmp(&uri[5], "//", 2) == 0) {
770 path_data_n--; /* Invalidate using the full URI */
771 if (strncasecmp(&uri[7], "localhost/", 10) == 0) {
773 } else if (uri[7] == '/') {
776 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN,
777 OSSL_STORE_R_URI_AUTHORITY_UNSUPPORTED);
782 path_data[path_data_n].check_absolute = 1;
784 /* Windows file: URIs with a drive letter start with a / */
785 if (p[0] == '/' && p[2] == ':' && p[3] == '/') {
786 char c = tolower(p[1]);
788 if (c >= 'a' && c <= 'z') {
790 /* We know it's absolute, so no need to check */
791 path_data[path_data_n].check_absolute = 0;
795 path_data[path_data_n++].path = p;
799 for (i = 0, path = NULL; path == NULL && i < path_data_n; i++) {
801 * If the scheme "file" was an explicit part of the URI, the path must
802 * be absolute. So says RFC 8089
804 if (path_data[i].check_absolute && path_data[i].path[0] != '/') {
805 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN,
806 OSSL_STORE_R_PATH_MUST_BE_ABSOLUTE);
807 ERR_add_error_data(1, path_data[i].path);
811 if (stat(path_data[i].path, &st) < 0) {
812 SYSerr(SYS_F_STAT, errno);
813 ERR_add_error_data(1, path_data[i].path);
815 path = path_data[i].path;
822 /* Successfully found a working path, clear possible collected errors */
825 ctx = OPENSSL_zalloc(sizeof(*ctx));
827 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_MALLOC_FAILURE);
831 if ((st.st_mode & S_IFDIR) == S_IFDIR) {
833 * Try to copy everything, even if we know that some of them must be
834 * NULL for the moment. This prevents errors in the future, when more
835 * components may be used.
837 ctx->_.dir.uri = OPENSSL_strdup(uri);
840 if (ctx->_.dir.uri == NULL)
843 ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx, path);
844 ctx->_.dir.last_errno = errno;
845 if (ctx->_.dir.last_entry == NULL) {
846 if (ctx->_.dir.last_errno != 0) {
848 errno = ctx->_.dir.last_errno;
849 openssl_strerror_r(errno, errbuf, sizeof(errbuf));
850 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_SYS_LIB);
851 ERR_add_error_data(1, errbuf);
854 ctx->_.dir.end_reached = 1;
860 if ((buff = BIO_new(BIO_f_buffer())) == NULL
861 || (ctx->_.file.file = BIO_new_file(path, "rb")) == NULL) {
866 ctx->_.file.file = BIO_push(buff, ctx->_.file.file);
867 if (BIO_buffer_peek(ctx->_.file.file, peekbuf, sizeof(peekbuf)-1) > 0) {
868 peekbuf[sizeof(peekbuf)-1] = '\0';
869 if (strstr(peekbuf, "-----BEGIN ") != NULL)
876 OSSL_STORE_LOADER_CTX_free(ctx);
880 static int file_ctrl(OSSL_STORE_LOADER_CTX *ctx, int cmd, va_list args)
885 case OSSL_STORE_C_USE_SECMEM:
887 int on = *(va_arg(args, int *));
891 ctx->flags &= ~FILE_FLAG_SECMEM;
894 ctx->flags |= FILE_FLAG_SECMEM;
897 OSSL_STOREerr(OSSL_STORE_F_FILE_CTRL,
898 ERR_R_PASSED_INVALID_ARGUMENT);
911 /* Internal function to decode an already opened PEM file */
912 OSSL_STORE_LOADER_CTX *ossl_store_file_attach_pem_bio_int(BIO *bp)
914 OSSL_STORE_LOADER_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
917 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_FILE_ATTACH_PEM_BIO_INT,
918 ERR_R_MALLOC_FAILURE);
922 ctx->_.file.file = bp;
928 static OSSL_STORE_INFO *file_load_try_decode(OSSL_STORE_LOADER_CTX *ctx,
929 const char *pem_name,
930 const char *pem_header,
931 unsigned char *data, size_t len,
932 const UI_METHOD *ui_method,
933 void *ui_data, int *matchcount)
935 OSSL_STORE_INFO *result = NULL;
936 BUF_MEM *new_mem = NULL;
937 char *new_pem_name = NULL;
943 void *handler_ctx = NULL;
944 const FILE_HANDLER **matching_handlers =
945 OPENSSL_zalloc(sizeof(*matching_handlers)
946 * OSSL_NELEM(file_handlers));
948 if (matching_handlers == NULL) {
949 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD_TRY_DECODE,
950 ERR_R_MALLOC_FAILURE);
955 for (i = 0; i < OSSL_NELEM(file_handlers); i++) {
956 const FILE_HANDLER *handler = file_handlers[i];
957 int try_matchcount = 0;
958 void *tmp_handler_ctx = NULL;
959 OSSL_STORE_INFO *tmp_result =
960 handler->try_decode(pem_name, pem_header, data, len,
961 &tmp_handler_ctx, &try_matchcount,
964 if (try_matchcount > 0) {
965 if (matching_handlers)
966 matching_handlers[*matchcount] = handler;
969 handler->destroy_ctx(&handler_ctx);
970 handler_ctx = tmp_handler_ctx;
972 if ((*matchcount += try_matchcount) > 1) {
973 /* more than one match => ambiguous, kill any result */
974 OSSL_STORE_INFO_free(result);
975 OSSL_STORE_INFO_free(tmp_result);
976 if (handler->destroy_ctx != NULL)
977 handler->destroy_ctx(&handler_ctx);
987 if (*matchcount == 1 && matching_handlers[0]->repeatable) {
988 ctx->_.file.last_handler = matching_handlers[0];
989 ctx->_.file.last_handler_ctx = handler_ctx;
992 OPENSSL_free(matching_handlers);
996 OPENSSL_free(new_pem_name);
997 BUF_MEM_free(new_mem);
1000 && (t = OSSL_STORE_INFO_get_type(result)) == OSSL_STORE_INFO_EMBEDDED) {
1001 pem_name = new_pem_name =
1002 ossl_store_info_get0_EMBEDDED_pem_name(result);
1003 new_mem = ossl_store_info_get0_EMBEDDED_buffer(result);
1004 data = (unsigned char *)new_mem->data;
1005 len = new_mem->length;
1006 OPENSSL_free(result);
1017 static OSSL_STORE_INFO *file_load_try_repeat(OSSL_STORE_LOADER_CTX *ctx,
1018 const UI_METHOD *ui_method,
1021 OSSL_STORE_INFO *result = NULL;
1022 int try_matchcount = 0;
1024 if (ctx->_.file.last_handler != NULL) {
1026 ctx->_.file.last_handler->try_decode(NULL, NULL, NULL, 0,
1027 &ctx->_.file.last_handler_ctx,
1029 ui_method, ui_data);
1031 if (result == NULL) {
1032 ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx);
1033 ctx->_.file.last_handler_ctx = NULL;
1034 ctx->_.file.last_handler = NULL;
1040 static void pem_free_flag(void *pem_data, int secure)
1043 OPENSSL_secure_free(pem_data);
1045 OPENSSL_free(pem_data);
1047 static int file_read_pem(BIO *bp, char **pem_name, char **pem_header,
1048 unsigned char **data, long *len,
1049 const UI_METHOD *ui_method,
1050 void *ui_data, int secure)
1053 ? PEM_read_bio_ex(bp, pem_name, pem_header, data, len,
1054 PEM_FLAG_SECURE | PEM_FLAG_EAY_COMPATIBLE)
1055 : PEM_read_bio(bp, pem_name, pem_header, data, len);
1061 * 10 is the number of characters in "Proc-Type:", which
1062 * PEM_get_EVP_CIPHER_INFO() requires to be present.
1063 * If the PEM header has less characters than that, it's
1064 * not worth spending cycles on it.
1066 if (strlen(*pem_header) > 10) {
1067 EVP_CIPHER_INFO cipher;
1068 struct pem_pass_data pass_data;
1070 if (!PEM_get_EVP_CIPHER_INFO(*pem_header, &cipher)
1071 || !file_fill_pem_pass_data(&pass_data, "PEM", ui_method, ui_data)
1072 || !PEM_do_header(&cipher, *data, len, file_get_pem_pass,
1080 static int file_read_asn1(BIO *bp, unsigned char **data, long *len)
1082 BUF_MEM *mem = NULL;
1084 if (asn1_d2i_read_bio(bp, &mem) < 0)
1087 *data = (unsigned char *)mem->data;
1088 *len = (long)mem->length;
1094 static int ends_with_dirsep(const char *uri)
1097 uri += strlen(uri) - 1;
1099 if (*uri == ']' || *uri == '>' || *uri == ':')
1101 #elif defined _WIN32
1108 static int file_name_to_uri(OSSL_STORE_LOADER_CTX *ctx, const char *name,
1111 assert(name != NULL);
1112 assert(data != NULL);
1114 const char *pathsep = ends_with_dirsep(ctx->_.dir.uri) ? "" : "/";
1115 long calculated_length = strlen(ctx->_.dir.uri) + strlen(pathsep)
1116 + strlen(name) + 1 /* \0 */;
1118 *data = OPENSSL_zalloc(calculated_length);
1119 if (*data == NULL) {
1120 OSSL_STOREerr(OSSL_STORE_F_FILE_NAME_TO_URI, ERR_R_MALLOC_FAILURE);
1124 OPENSSL_strlcat(*data, ctx->_.dir.uri, calculated_length);
1125 OPENSSL_strlcat(*data, pathsep, calculated_length);
1126 OPENSSL_strlcat(*data, name, calculated_length);
1131 static int file_eof(OSSL_STORE_LOADER_CTX *ctx);
1132 static int file_error(OSSL_STORE_LOADER_CTX *ctx);
1133 static OSSL_STORE_INFO *file_load(OSSL_STORE_LOADER_CTX *ctx,
1134 const UI_METHOD *ui_method, void *ui_data)
1136 OSSL_STORE_INFO *result = NULL;
1141 if (ctx->type == is_dir) {
1143 char *newname = NULL;
1145 if (ctx->_.dir.last_entry == NULL) {
1146 if (!ctx->_.dir.end_reached) {
1148 assert(ctx->_.dir.last_errno != 0);
1149 errno = ctx->_.dir.last_errno;
1151 openssl_strerror_r(errno, errbuf, sizeof(errbuf));
1152 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, ERR_R_SYS_LIB);
1153 ERR_add_error_data(1, errbuf);
1158 if (ctx->_.dir.last_entry[0] != '.'
1159 && !file_name_to_uri(ctx, ctx->_.dir.last_entry, &newname))
1163 * On the first call (with a NULL context), OPENSSL_DIR_read()
1164 * cares about the second argument. On the following calls, it
1165 * only cares that it isn't NULL. Therefore, we can safely give
1168 ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx,
1170 ctx->_.dir.last_errno = errno;
1171 if (ctx->_.dir.last_entry == NULL && ctx->_.dir.last_errno == 0)
1172 ctx->_.dir.end_reached = 1;
1175 && (result = OSSL_STORE_INFO_new_NAME(newname)) == NULL) {
1176 OPENSSL_free(newname);
1177 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, ERR_R_OSSL_STORE_LIB);
1180 } while (result == NULL && !file_eof(ctx));
1182 int matchcount = -1;
1184 result = file_load_try_repeat(ctx, ui_method, ui_data);
1192 char *pem_name = NULL; /* PEM record name */
1193 char *pem_header = NULL; /* PEM record header */
1194 unsigned char *data = NULL; /* DER encoded data */
1195 long len = 0; /* DER encoded data length */
1198 if (ctx->type == is_pem) {
1199 if (!file_read_pem(ctx->_.file.file, &pem_name, &pem_header,
1200 &data, &len, ui_method, ui_data,
1201 (ctx->flags & FILE_FLAG_SECMEM) != 0)) {
1206 if (!file_read_asn1(ctx->_.file.file, &data, &len)) {
1212 result = file_load_try_decode(ctx, pem_name, pem_header, data, len,
1213 ui_method, ui_data, &matchcount);
1219 * If a PEM name matches more than one handler, the handlers are
1222 if (!ossl_assert(pem_name == NULL || matchcount <= 1)) {
1227 if (matchcount > 1) {
1228 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD,
1229 OSSL_STORE_R_AMBIGUOUS_CONTENT_TYPE);
1230 } else if (matchcount == 1) {
1232 * If there are other errors on the stack, they already show
1233 * what the problem is.
1235 if (ERR_peek_error() == 0) {
1236 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD,
1237 OSSL_STORE_R_UNSUPPORTED_CONTENT_TYPE);
1238 if (pem_name != NULL)
1239 ERR_add_error_data(3, "PEM type is '", pem_name, "'");
1246 pem_free_flag(pem_name, (ctx->flags & FILE_FLAG_SECMEM) != 0);
1247 pem_free_flag(pem_header, (ctx->flags & FILE_FLAG_SECMEM) != 0);
1248 pem_free_flag(data, (ctx->flags & FILE_FLAG_SECMEM) != 0);
1249 } while (matchcount == 0 && !file_eof(ctx) && !file_error(ctx));
1251 /* We bail out on ambiguity */
1259 static int file_error(OSSL_STORE_LOADER_CTX *ctx)
1261 return ctx->errcnt > 0;
1264 static int file_eof(OSSL_STORE_LOADER_CTX *ctx)
1266 if (ctx->type == is_dir)
1267 return ctx->_.dir.end_reached;
1269 if (ctx->_.file.last_handler != NULL
1270 && !ctx->_.file.last_handler->eof(ctx->_.file.last_handler_ctx))
1272 return BIO_eof(ctx->_.file.file);
1275 static int file_close(OSSL_STORE_LOADER_CTX *ctx)
1277 if (ctx->type == is_dir) {
1278 OPENSSL_DIR_end(&ctx->_.dir.ctx);
1280 BIO_free_all(ctx->_.file.file);
1282 OSSL_STORE_LOADER_CTX_free(ctx);
1286 int ossl_store_file_detach_pem_bio_int(OSSL_STORE_LOADER_CTX *ctx)
1288 OSSL_STORE_LOADER_CTX_free(ctx);
1292 static OSSL_STORE_LOADER file_loader =
1304 static void store_file_loader_deinit(void)
1306 ossl_store_unregister_loader_int(file_loader.scheme);
1309 int ossl_store_file_loader_init(void)
1311 int ret = ossl_store_register_loader_int(&file_loader);
1313 OPENSSL_atexit(store_file_loader_deinit);