2 * Copyright 2016-2020 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
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 "store_local.h"
39 # define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
47 static char *file_get_pass(const UI_METHOD *ui_method, char *pass,
48 size_t maxsize, const char *prompt_info, void *data)
54 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE);
58 if (ui_method != NULL)
59 UI_set_method(ui, ui_method);
60 UI_add_user_data(ui, data);
62 if ((prompt = UI_construct_prompt(ui, "pass phrase",
63 prompt_info)) == NULL) {
64 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE);
66 } else if (!UI_add_input_string(ui, prompt, UI_INPUT_FLAG_DEFAULT_PWD,
67 pass, 0, maxsize - 1)) {
68 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB);
71 switch (UI_process(ui)) {
73 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS,
74 OSSL_STORE_R_UI_PROCESS_INTERRUPTED_OR_CANCELLED);
78 OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB);
91 struct pem_pass_data {
92 const UI_METHOD *ui_method;
94 const char *prompt_info;
97 static int file_fill_pem_pass_data(struct pem_pass_data *pass_data,
98 const char *prompt_info,
99 const UI_METHOD *ui_method, void *ui_data)
101 if (pass_data == NULL)
103 pass_data->ui_method = ui_method;
104 pass_data->data = ui_data;
105 pass_data->prompt_info = prompt_info;
109 /* This is used anywhere a pem_password_cb is needed */
110 static int file_get_pem_pass(char *buf, int num, int w, void *data)
112 struct pem_pass_data *pass_data = data;
113 char *pass = file_get_pass(pass_data->ui_method, buf, num,
114 pass_data->prompt_info, pass_data->data);
116 return pass == NULL ? 0 : strlen(pass);
120 * The file scheme decoders
121 * ------------------------
123 * Each possible data type has its own decoder, which either operates
124 * through a given PEM name, or attempts to decode to see if the blob
125 * it's given is decodable for its data type. The assumption is that
126 * only the correct data type will match the content.
130 * The try_decode function is called to check if the blob of data can
131 * be used by this handler, and if it can, decodes it into a supported
132 * OpenSSL type and returns a OSSL_STORE_INFO with the decoded data.
134 * pem_name: If this blob comes from a PEM file, this holds
135 * the PEM name. If it comes from another type of
136 * file, this is NULL.
137 * pem_header: If this blob comes from a PEM file, this holds
138 * the PEM headers. If it comes from another type of
139 * file, this is NULL.
140 * blob: The blob of data to match with what this handler
142 * len: The length of the blob.
143 * handler_ctx: For a handler marked repeatable, this pointer can
144 * be used to create a context for the handler. IT IS
145 * THE HANDLER'S RESPONSIBILITY TO CREATE AND DESTROY
146 * THIS CONTEXT APPROPRIATELY, i.e. create on first call
147 * and destroy when about to return NULL.
148 * matchcount: A pointer to an int to count matches for this data.
149 * Usually becomes 0 (no match) or 1 (match!), but may
150 * be higher in the (unlikely) event that the data matches
151 * more than one possibility. The int will always be
152 * zero when the function is called.
153 * ui_method: Application UI method for getting a password, pin
154 * or any other interactive data.
155 * ui_data: Application data to be passed to ui_method when
160 typedef OSSL_STORE_INFO *(*file_try_decode_fn)(const char *pem_name,
161 const char *pem_header,
162 const unsigned char *blob,
163 size_t len, void **handler_ctx,
165 const UI_METHOD *ui_method,
168 * The eof function should return 1 if there's no more data to be found
169 * with the handler_ctx, otherwise 0. This is only used when the handler is
172 typedef int (*file_eof_fn)(void *handler_ctx);
174 * The destroy_ctx function is used to destroy the handler_ctx that was
175 * initiated by a repeatable try_decode function. This is only used when
176 * the handler is marked repeatable.
178 typedef void (*file_destroy_ctx_fn)(void **handler_ctx);
180 typedef struct file_handler_st {
182 file_try_decode_fn try_decode;
184 file_destroy_ctx_fn destroy_ctx;
191 * PKCS#12 decoder. It operates by decoding all of the blob content,
192 * extracting all the interesting data from it and storing them internally,
193 * then serving them one piece at a time.
195 static OSSL_STORE_INFO *try_decode_PKCS12(const char *pem_name,
196 const char *pem_header,
197 const unsigned char *blob,
198 size_t len, void **pctx,
200 const UI_METHOD *ui_method,
203 OSSL_STORE_INFO *store_info = NULL;
204 STACK_OF(OSSL_STORE_INFO) *ctx = *pctx;
207 /* Initial parsing */
211 if (pem_name != NULL)
212 /* No match, there is no PEM PKCS12 tag */
215 if ((p12 = d2i_PKCS12(NULL, &blob, len)) != NULL) {
217 char tpass[PEM_BUFSIZE];
218 EVP_PKEY *pkey = NULL;
220 STACK_OF(X509) *chain = NULL;
224 if (PKCS12_verify_mac(p12, "", 0)
225 || PKCS12_verify_mac(p12, NULL, 0)) {
228 if ((pass = file_get_pass(ui_method, tpass, PEM_BUFSIZE,
229 "PKCS12 import password",
231 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12,
232 OSSL_STORE_R_PASSPHRASE_CALLBACK_ERROR);
235 if (!PKCS12_verify_mac(p12, pass, strlen(pass))) {
236 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12,
237 OSSL_STORE_R_ERROR_VERIFYING_PKCS12_MAC);
242 if (PKCS12_parse(p12, pass, &pkey, &cert, &chain)) {
243 OSSL_STORE_INFO *osi_pkey = NULL;
244 OSSL_STORE_INFO *osi_cert = NULL;
245 OSSL_STORE_INFO *osi_ca = NULL;
247 if ((ctx = sk_OSSL_STORE_INFO_new_null()) != NULL
248 && (osi_pkey = OSSL_STORE_INFO_new_PKEY(pkey)) != NULL
249 && sk_OSSL_STORE_INFO_push(ctx, osi_pkey) != 0
250 && (osi_cert = OSSL_STORE_INFO_new_CERT(cert)) != NULL
251 && sk_OSSL_STORE_INFO_push(ctx, osi_cert) != 0) {
256 while(sk_X509_num(chain) > 0) {
257 X509 *ca = sk_X509_value(chain, 0);
259 if ((osi_ca = OSSL_STORE_INFO_new_CERT(ca)) == NULL
260 || sk_OSSL_STORE_INFO_push(ctx, osi_ca) == 0) {
265 (void)sk_X509_shift(chain);
269 OSSL_STORE_INFO_free(osi_ca);
270 OSSL_STORE_INFO_free(osi_cert);
271 OSSL_STORE_INFO_free(osi_pkey);
272 sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free);
275 sk_X509_pop_free(chain, X509_free);
289 store_info = sk_OSSL_STORE_INFO_shift(ctx);
295 static int eof_PKCS12(void *ctx_)
297 STACK_OF(OSSL_STORE_INFO) *ctx = ctx_;
299 return ctx == NULL || sk_OSSL_STORE_INFO_num(ctx) == 0;
302 static void destroy_ctx_PKCS12(void **pctx)
304 STACK_OF(OSSL_STORE_INFO) *ctx = *pctx;
306 sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free);
310 static FILE_HANDLER PKCS12_handler = {
319 * Encrypted PKCS#8 decoder. It operates by just decrypting the given blob
320 * into a new blob, which is returned as an EMBEDDED STORE_INFO. The whole
321 * decoding process will then start over with the new blob.
323 static OSSL_STORE_INFO *try_decode_PKCS8Encrypted(const char *pem_name,
324 const char *pem_header,
325 const unsigned char *blob,
326 size_t len, void **pctx,
328 const UI_METHOD *ui_method,
332 char kbuf[PEM_BUFSIZE];
334 const X509_ALGOR *dalg = NULL;
335 const ASN1_OCTET_STRING *doct = NULL;
336 OSSL_STORE_INFO *store_info = NULL;
338 unsigned char *new_data = NULL;
341 if (pem_name != NULL) {
342 if (strcmp(pem_name, PEM_STRING_PKCS8) != 0)
347 if ((p8 = d2i_X509_SIG(NULL, &blob, len)) == NULL)
352 if ((mem = BUF_MEM_new()) == NULL) {
353 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
354 ERR_R_MALLOC_FAILURE);
358 if ((pass = file_get_pass(ui_method, kbuf, PEM_BUFSIZE,
359 "PKCS8 decrypt password", ui_data)) == NULL) {
360 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
361 OSSL_STORE_R_BAD_PASSWORD_READ);
365 X509_SIG_get0(p8, &dalg, &doct);
366 if (!PKCS12_pbe_crypt(dalg, pass, strlen(pass), doct->data, doct->length,
367 &new_data, &new_data_len, 0))
370 mem->data = (char *)new_data;
371 mem->max = mem->length = (size_t)new_data_len;
374 store_info = ossl_store_info_new_EMBEDDED(PEM_STRING_PKCS8INF, mem);
375 if (store_info == NULL) {
376 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
377 ERR_R_MALLOC_FAILURE);
388 static FILE_HANDLER PKCS8Encrypted_handler = {
390 try_decode_PKCS8Encrypted
394 * Private key decoder. Decodes all sorts of private keys, both PKCS#8
395 * encoded ones and old style PEM ones (with the key type is encoded into
398 int pem_check_suffix(const char *pem_str, const char *suffix);
399 static OSSL_STORE_INFO *try_decode_PrivateKey(const char *pem_name,
400 const char *pem_header,
401 const unsigned char *blob,
402 size_t len, void **pctx,
404 const UI_METHOD *ui_method,
407 OSSL_STORE_INFO *store_info = NULL;
408 EVP_PKEY *pkey = NULL;
409 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
411 if (pem_name != NULL) {
412 if (strcmp(pem_name, PEM_STRING_PKCS8INF) == 0) {
413 PKCS8_PRIV_KEY_INFO *p8inf =
414 d2i_PKCS8_PRIV_KEY_INFO(NULL, &blob, len);
418 pkey = EVP_PKCS82PKEY(p8inf);
419 PKCS8_PRIV_KEY_INFO_free(p8inf);
423 if ((slen = pem_check_suffix(pem_name, "PRIVATE KEY")) > 0
424 && (ameth = EVP_PKEY_asn1_find_str(NULL, pem_name,
427 pkey = d2i_PrivateKey(ameth->pkey_id, NULL, &blob, len);
432 #ifndef OPENSSL_NO_ENGINE
433 ENGINE *curengine = ENGINE_get_first();
435 while (curengine != NULL) {
436 ENGINE_PKEY_ASN1_METHS_PTR asn1meths =
437 ENGINE_get_pkey_asn1_meths(curengine);
439 if (asn1meths != NULL) {
440 const int *nids = NULL;
441 int nids_n = asn1meths(curengine, NULL, &nids, 0);
443 for (i = 0; i < nids_n; i++) {
444 EVP_PKEY_ASN1_METHOD *ameth2 = NULL;
445 EVP_PKEY *tmp_pkey = NULL;
446 const unsigned char *tmp_blob = blob;
448 if (!asn1meths(curengine, &ameth2, NULL, nids[i]))
451 || ameth2->pkey_flags & ASN1_PKEY_ALIAS)
454 tmp_pkey = d2i_PrivateKey(ameth2->pkey_id, NULL,
456 if (tmp_pkey != NULL) {
458 EVP_PKEY_free(tmp_pkey);
465 curengine = ENGINE_get_next(curengine);
469 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
470 EVP_PKEY *tmp_pkey = NULL;
471 const unsigned char *tmp_blob = blob;
473 ameth = EVP_PKEY_asn1_get0(i);
474 if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
477 tmp_pkey = d2i_PrivateKey(ameth->pkey_id, NULL, &tmp_blob, len);
478 if (tmp_pkey != NULL) {
480 EVP_PKEY_free(tmp_pkey);
487 if (*matchcount > 1) {
496 store_info = OSSL_STORE_INFO_new_PKEY(pkey);
497 if (store_info == NULL)
503 static FILE_HANDLER PrivateKey_handler = {
505 try_decode_PrivateKey
509 * Public key decoder. Only supports SubjectPublicKeyInfo formatted keys.
511 static OSSL_STORE_INFO *try_decode_PUBKEY(const char *pem_name,
512 const char *pem_header,
513 const unsigned char *blob,
514 size_t len, void **pctx,
516 const UI_METHOD *ui_method,
519 OSSL_STORE_INFO *store_info = NULL;
520 EVP_PKEY *pkey = NULL;
522 if (pem_name != NULL) {
523 if (strcmp(pem_name, PEM_STRING_PUBLIC) != 0)
529 if ((pkey = d2i_PUBKEY(NULL, &blob, len)) != NULL) {
531 store_info = OSSL_STORE_INFO_new_PKEY(pkey);
537 static FILE_HANDLER PUBKEY_handler = {
543 * Key parameter decoder.
545 static OSSL_STORE_INFO *try_decode_params(const char *pem_name,
546 const char *pem_header,
547 const unsigned char *blob,
548 size_t len, void **pctx,
550 const UI_METHOD *ui_method,
553 OSSL_STORE_INFO *store_info = NULL;
555 EVP_PKEY *pkey = NULL;
556 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
559 if (pem_name != NULL) {
560 if ((slen = pem_check_suffix(pem_name, "PARAMETERS")) == 0)
566 if ((pkey = EVP_PKEY_new()) == NULL) {
567 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB);
572 if (EVP_PKEY_set_type_str(pkey, pem_name, slen)
573 && (ameth = EVP_PKEY_get0_asn1(pkey)) != NULL
574 && ameth->param_decode != NULL
575 && ameth->param_decode(pkey, &blob, len))
579 EVP_PKEY *tmp_pkey = NULL;
581 for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
582 const unsigned char *tmp_blob = blob;
584 if (tmp_pkey == NULL && (tmp_pkey = EVP_PKEY_new()) == NULL) {
585 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB);
589 ameth = EVP_PKEY_asn1_get0(i);
590 if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
593 if (EVP_PKEY_set_type(tmp_pkey, ameth->pkey_id)
594 && (ameth = EVP_PKEY_get0_asn1(tmp_pkey)) != NULL
595 && ameth->param_decode != NULL
596 && ameth->param_decode(tmp_pkey, &tmp_blob, len)) {
598 EVP_PKEY_free(tmp_pkey);
606 EVP_PKEY_free(tmp_pkey);
607 if (*matchcount == 1) {
613 store_info = OSSL_STORE_INFO_new_PARAMS(pkey);
614 if (store_info == NULL)
620 static FILE_HANDLER params_handler = {
626 * X.509 certificate decoder.
628 static OSSL_STORE_INFO *try_decode_X509Certificate(const char *pem_name,
629 const char *pem_header,
630 const unsigned char *blob,
631 size_t len, void **pctx,
633 const UI_METHOD *ui_method,
636 OSSL_STORE_INFO *store_info = NULL;
640 * In most cases, we can try to interpret the serialized data as a trusted
641 * cert (X509 + X509_AUX) and fall back to reading it as a normal cert
642 * (just X509), but if the PEM name specifically declares it as a trusted
643 * cert, then no fallback should be engaged. |ignore_trusted| tells if
644 * the fallback can be used (1) or not (0).
646 int ignore_trusted = 1;
648 if (pem_name != NULL) {
649 if (strcmp(pem_name, PEM_STRING_X509_TRUSTED) == 0)
651 else if (strcmp(pem_name, PEM_STRING_X509_OLD) != 0
652 && strcmp(pem_name, PEM_STRING_X509) != 0)
658 if ((cert = d2i_X509_AUX(NULL, &blob, len)) != NULL
659 || (ignore_trusted && (cert = d2i_X509(NULL, &blob, len)) != NULL)) {
661 store_info = OSSL_STORE_INFO_new_CERT(cert);
664 if (store_info == NULL)
670 static FILE_HANDLER X509Certificate_handler = {
672 try_decode_X509Certificate
678 static OSSL_STORE_INFO *try_decode_X509CRL(const char *pem_name,
679 const char *pem_header,
680 const unsigned char *blob,
681 size_t len, void **pctx,
683 const UI_METHOD *ui_method,
686 OSSL_STORE_INFO *store_info = NULL;
687 X509_CRL *crl = NULL;
689 if (pem_name != NULL) {
690 if (strcmp(pem_name, PEM_STRING_X509_CRL) != 0)
696 if ((crl = d2i_X509_CRL(NULL, &blob, len)) != NULL) {
698 store_info = OSSL_STORE_INFO_new_CRL(crl);
701 if (store_info == NULL)
707 static FILE_HANDLER X509CRL_handler = {
713 * To finish it all off, we collect all the handlers.
715 static const FILE_HANDLER *file_handlers[] = {
717 &PKCS8Encrypted_handler,
718 &X509Certificate_handler,
731 struct ossl_store_loader_ctx_st {
738 #define FILE_FLAG_SECMEM (1<<0)
741 struct { /* Used with is_raw and is_pem */
745 * The following are used when the handler is marked as
748 const FILE_HANDLER *last_handler;
749 void *last_handler_ctx;
751 struct { /* Used with is_dir */
752 OPENSSL_DIR_CTX *ctx;
757 * When a search expression is given, these are filled in.
758 * |search_name| contains the file basename to look for.
759 * The string is exactly 8 characters long.
764 * The directory reading utility we have combines opening with
765 * reading the first name. To make sure we can detect the end
766 * at the right time, we read early and cache the name.
768 const char *last_entry;
773 /* Expected object type. May be unspecified */
777 static void OSSL_STORE_LOADER_CTX_free(OSSL_STORE_LOADER_CTX *ctx)
779 if (ctx->type == is_dir) {
780 OPENSSL_free(ctx->_.dir.uri);
782 if (ctx->_.file.last_handler != NULL) {
783 ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx);
784 ctx->_.file.last_handler_ctx = NULL;
785 ctx->_.file.last_handler = NULL;
791 static OSSL_STORE_LOADER_CTX *file_open(const OSSL_STORE_LOADER *loader,
793 const UI_METHOD *ui_method,
796 OSSL_STORE_LOADER_CTX *ctx = NULL;
800 unsigned int check_absolute:1;
802 size_t path_data_n = 0, i;
806 * First step, just take the URI as is.
808 path_data[path_data_n].check_absolute = 0;
809 path_data[path_data_n++].path = uri;
812 * Second step, if the URI appears to start with the 'file' scheme,
813 * extract the path and make that the second path to check.
814 * There's a special case if the URI also contains an authority, then
815 * the full URI shouldn't be used as a path anywhere.
817 if (strncasecmp(uri, "file:", 5) == 0) {
818 const char *p = &uri[5];
820 if (strncmp(&uri[5], "//", 2) == 0) {
821 path_data_n--; /* Invalidate using the full URI */
822 if (strncasecmp(&uri[7], "localhost/", 10) == 0) {
824 } else if (uri[7] == '/') {
827 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN,
828 OSSL_STORE_R_URI_AUTHORITY_UNSUPPORTED);
833 path_data[path_data_n].check_absolute = 1;
835 /* Windows file: URIs with a drive letter start with a / */
836 if (p[0] == '/' && p[2] == ':' && p[3] == '/') {
837 char c = ossl_tolower(p[1]);
839 if (c >= 'a' && c <= 'z') {
841 /* We know it's absolute, so no need to check */
842 path_data[path_data_n].check_absolute = 0;
846 path_data[path_data_n++].path = p;
850 for (i = 0, path = NULL; path == NULL && i < path_data_n; i++) {
852 * If the scheme "file" was an explicit part of the URI, the path must
853 * be absolute. So says RFC 8089
855 if (path_data[i].check_absolute && path_data[i].path[0] != '/') {
856 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN,
857 OSSL_STORE_R_PATH_MUST_BE_ABSOLUTE);
858 ERR_add_error_data(1, path_data[i].path);
862 if (stat(path_data[i].path, &st) < 0) {
863 SYSerr(SYS_F_STAT, errno);
864 ERR_add_error_data(1, path_data[i].path);
866 path = path_data[i].path;
873 /* Successfully found a working path, clear possible collected errors */
876 ctx = OPENSSL_zalloc(sizeof(*ctx));
878 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_MALLOC_FAILURE);
882 if (S_ISDIR(st.st_mode)) {
884 * Try to copy everything, even if we know that some of them must be
885 * NULL for the moment. This prevents errors in the future, when more
886 * components may be used.
888 ctx->_.dir.uri = OPENSSL_strdup(uri);
891 if (ctx->_.dir.uri == NULL)
894 ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx, path);
895 ctx->_.dir.last_errno = errno;
896 if (ctx->_.dir.last_entry == NULL) {
897 if (ctx->_.dir.last_errno != 0) {
899 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_SYS_LIB);
900 errno = ctx->_.dir.last_errno;
901 if (openssl_strerror_r(errno, errbuf, sizeof(errbuf)))
902 ERR_add_error_data(1, errbuf);
905 ctx->_.dir.end_reached = 1;
909 char peekbuf[4096] = { 0, };
911 if ((buff = BIO_new(BIO_f_buffer())) == NULL
912 || (ctx->_.file.file = BIO_new_file(path, "rb")) == NULL) {
917 ctx->_.file.file = BIO_push(buff, ctx->_.file.file);
918 if (BIO_buffer_peek(ctx->_.file.file, peekbuf, sizeof(peekbuf) - 1) > 0) {
919 peekbuf[sizeof(peekbuf) - 1] = '\0';
920 if (strstr(peekbuf, "-----BEGIN ") != NULL)
927 OSSL_STORE_LOADER_CTX_free(ctx);
931 static int file_ctrl(OSSL_STORE_LOADER_CTX *ctx, int cmd, va_list args)
936 case OSSL_STORE_C_USE_SECMEM:
938 int on = *(va_arg(args, int *));
942 ctx->flags &= ~FILE_FLAG_SECMEM;
945 ctx->flags |= FILE_FLAG_SECMEM;
948 OSSL_STOREerr(OSSL_STORE_F_FILE_CTRL,
949 ERR_R_PASSED_INVALID_ARGUMENT);
962 static int file_expect(OSSL_STORE_LOADER_CTX *ctx, int expected)
964 ctx->expected_type = expected;
968 static int file_find(OSSL_STORE_LOADER_CTX *ctx, OSSL_STORE_SEARCH *search)
971 * If ctx == NULL, the library is looking to know if this loader supports
972 * the given search type.
975 if (OSSL_STORE_SEARCH_get_type(search) == OSSL_STORE_SEARCH_BY_NAME) {
976 unsigned long hash = 0;
981 if (ctx->type != is_dir) {
982 OSSL_STOREerr(OSSL_STORE_F_FILE_FIND,
983 OSSL_STORE_R_SEARCH_ONLY_SUPPORTED_FOR_DIRECTORIES);
987 hash = X509_NAME_hash(OSSL_STORE_SEARCH_get0_name(search));
988 BIO_snprintf(ctx->_.dir.search_name, sizeof(ctx->_.dir.search_name),
994 OSSL_STOREerr(OSSL_STORE_F_FILE_FIND,
995 OSSL_STORE_R_UNSUPPORTED_SEARCH_TYPE);
999 /* Internal function to decode an already opened PEM file */
1000 OSSL_STORE_LOADER_CTX *ossl_store_file_attach_pem_bio_int(BIO *bp)
1002 OSSL_STORE_LOADER_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
1005 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_FILE_ATTACH_PEM_BIO_INT,
1006 ERR_R_MALLOC_FAILURE);
1010 ctx->_.file.file = bp;
1016 static OSSL_STORE_INFO *file_load_try_decode(OSSL_STORE_LOADER_CTX *ctx,
1017 const char *pem_name,
1018 const char *pem_header,
1019 unsigned char *data, size_t len,
1020 const UI_METHOD *ui_method,
1021 void *ui_data, int *matchcount)
1023 OSSL_STORE_INFO *result = NULL;
1024 BUF_MEM *new_mem = NULL;
1025 char *new_pem_name = NULL;
1031 void *handler_ctx = NULL;
1032 const FILE_HANDLER **matching_handlers =
1033 OPENSSL_zalloc(sizeof(*matching_handlers)
1034 * OSSL_NELEM(file_handlers));
1036 if (matching_handlers == NULL) {
1037 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD_TRY_DECODE,
1038 ERR_R_MALLOC_FAILURE);
1043 for (i = 0; i < OSSL_NELEM(file_handlers); i++) {
1044 const FILE_HANDLER *handler = file_handlers[i];
1045 int try_matchcount = 0;
1046 void *tmp_handler_ctx = NULL;
1047 OSSL_STORE_INFO *tmp_result =
1048 handler->try_decode(pem_name, pem_header, data, len,
1049 &tmp_handler_ctx, &try_matchcount,
1050 ui_method, ui_data);
1052 if (try_matchcount > 0) {
1054 matching_handlers[*matchcount] = handler;
1057 handler->destroy_ctx(&handler_ctx);
1058 handler_ctx = tmp_handler_ctx;
1060 if ((*matchcount += try_matchcount) > 1) {
1061 /* more than one match => ambiguous, kill any result */
1062 OSSL_STORE_INFO_free(result);
1063 OSSL_STORE_INFO_free(tmp_result);
1064 if (handler->destroy_ctx != NULL)
1065 handler->destroy_ctx(&handler_ctx);
1071 result = tmp_result;
1075 if (*matchcount == 1 && matching_handlers[0]->repeatable) {
1076 ctx->_.file.last_handler = matching_handlers[0];
1077 ctx->_.file.last_handler_ctx = handler_ctx;
1080 OPENSSL_free(matching_handlers);
1084 OPENSSL_free(new_pem_name);
1085 BUF_MEM_free(new_mem);
1088 && (t = OSSL_STORE_INFO_get_type(result)) == OSSL_STORE_INFO_EMBEDDED) {
1089 pem_name = new_pem_name =
1090 ossl_store_info_get0_EMBEDDED_pem_name(result);
1091 new_mem = ossl_store_info_get0_EMBEDDED_buffer(result);
1092 data = (unsigned char *)new_mem->data;
1093 len = new_mem->length;
1094 OPENSSL_free(result);
1105 static OSSL_STORE_INFO *file_load_try_repeat(OSSL_STORE_LOADER_CTX *ctx,
1106 const UI_METHOD *ui_method,
1109 OSSL_STORE_INFO *result = NULL;
1110 int try_matchcount = 0;
1112 if (ctx->_.file.last_handler != NULL) {
1114 ctx->_.file.last_handler->try_decode(NULL, NULL, NULL, 0,
1115 &ctx->_.file.last_handler_ctx,
1117 ui_method, ui_data);
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);