2 * Copyright 2016-2018 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 "internal/asn1_int.h"
28 #include "internal/ctype.h"
29 #include "internal/o_dir.h"
30 #include "internal/cryptlib.h"
31 #include "internal/store_int.h"
32 #include "store_locl.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
);
433 for (i
= 0; i
< EVP_PKEY_asn1_get_count(); i
++) {
434 EVP_PKEY
*tmp_pkey
= NULL
;
435 const unsigned char *tmp_blob
= blob
;
437 ameth
= EVP_PKEY_asn1_get0(i
);
438 if (ameth
->pkey_flags
& ASN1_PKEY_ALIAS
)
441 tmp_pkey
= d2i_PrivateKey(ameth
->pkey_id
, NULL
, &tmp_blob
, len
);
442 if (tmp_pkey
!= NULL
) {
444 EVP_PKEY_free(tmp_pkey
);
451 if (*matchcount
> 1) {
460 store_info
= OSSL_STORE_INFO_new_PKEY(pkey
);
461 if (store_info
== NULL
)
467 static FILE_HANDLER PrivateKey_handler
= {
469 try_decode_PrivateKey
473 * Public key decoder. Only supports SubjectPublicKeyInfo formatted keys.
475 static OSSL_STORE_INFO
*try_decode_PUBKEY(const char *pem_name
,
476 const char *pem_header
,
477 const unsigned char *blob
,
478 size_t len
, void **pctx
,
480 const UI_METHOD
*ui_method
,
483 OSSL_STORE_INFO
*store_info
= NULL
;
484 EVP_PKEY
*pkey
= NULL
;
486 if (pem_name
!= NULL
) {
487 if (strcmp(pem_name
, PEM_STRING_PUBLIC
) != 0)
493 if ((pkey
= d2i_PUBKEY(NULL
, &blob
, len
)) != NULL
) {
495 store_info
= OSSL_STORE_INFO_new_PKEY(pkey
);
501 static FILE_HANDLER PUBKEY_handler
= {
507 * Key parameter decoder.
509 static OSSL_STORE_INFO
*try_decode_params(const char *pem_name
,
510 const char *pem_header
,
511 const unsigned char *blob
,
512 size_t len
, void **pctx
,
514 const UI_METHOD
*ui_method
,
517 OSSL_STORE_INFO
*store_info
= NULL
;
519 EVP_PKEY
*pkey
= NULL
;
520 const EVP_PKEY_ASN1_METHOD
*ameth
= NULL
;
523 if (pem_name
!= NULL
) {
524 if ((slen
= pem_check_suffix(pem_name
, "PARAMETERS")) == 0)
530 if ((pkey
= EVP_PKEY_new()) == NULL
) {
531 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS
, ERR_R_EVP_LIB
);
536 if (EVP_PKEY_set_type_str(pkey
, pem_name
, slen
)
537 && (ameth
= EVP_PKEY_get0_asn1(pkey
)) != NULL
538 && ameth
->param_decode
!= NULL
539 && ameth
->param_decode(pkey
, &blob
, len
))
543 EVP_PKEY
*tmp_pkey
= NULL
;
545 for (i
= 0; i
< EVP_PKEY_asn1_get_count(); i
++) {
546 const unsigned char *tmp_blob
= blob
;
548 if (tmp_pkey
== NULL
&& (tmp_pkey
= EVP_PKEY_new()) == NULL
) {
549 OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS
, ERR_R_EVP_LIB
);
553 ameth
= EVP_PKEY_asn1_get0(i
);
554 if (ameth
->pkey_flags
& ASN1_PKEY_ALIAS
)
557 if (EVP_PKEY_set_type(tmp_pkey
, ameth
->pkey_id
)
558 && (ameth
= EVP_PKEY_get0_asn1(tmp_pkey
)) != NULL
559 && ameth
->param_decode
!= NULL
560 && ameth
->param_decode(tmp_pkey
, &tmp_blob
, len
)) {
562 EVP_PKEY_free(tmp_pkey
);
570 EVP_PKEY_free(tmp_pkey
);
571 if (*matchcount
== 1) {
577 store_info
= OSSL_STORE_INFO_new_PARAMS(pkey
);
578 if (store_info
== NULL
)
584 static FILE_HANDLER params_handler
= {
590 * X.509 certificate decoder.
592 static OSSL_STORE_INFO
*try_decode_X509Certificate(const char *pem_name
,
593 const char *pem_header
,
594 const unsigned char *blob
,
595 size_t len
, void **pctx
,
597 const UI_METHOD
*ui_method
,
600 OSSL_STORE_INFO
*store_info
= NULL
;
604 * In most cases, we can try to interpret the serialized data as a trusted
605 * cert (X509 + X509_AUX) and fall back to reading it as a normal cert
606 * (just X509), but if the PEM name specifically declares it as a trusted
607 * cert, then no fallback should be engaged. |ignore_trusted| tells if
608 * the fallback can be used (1) or not (0).
610 int ignore_trusted
= 1;
612 if (pem_name
!= NULL
) {
613 if (strcmp(pem_name
, PEM_STRING_X509_TRUSTED
) == 0)
615 else if (strcmp(pem_name
, PEM_STRING_X509_OLD
) != 0
616 && strcmp(pem_name
, PEM_STRING_X509
) != 0)
622 if ((cert
= d2i_X509_AUX(NULL
, &blob
, len
)) != NULL
623 || (ignore_trusted
&& (cert
= d2i_X509(NULL
, &blob
, len
)) != NULL
)) {
625 store_info
= OSSL_STORE_INFO_new_CERT(cert
);
628 if (store_info
== NULL
)
634 static FILE_HANDLER X509Certificate_handler
= {
636 try_decode_X509Certificate
642 static OSSL_STORE_INFO
*try_decode_X509CRL(const char *pem_name
,
643 const char *pem_header
,
644 const unsigned char *blob
,
645 size_t len
, void **pctx
,
647 const UI_METHOD
*ui_method
,
650 OSSL_STORE_INFO
*store_info
= NULL
;
651 X509_CRL
*crl
= NULL
;
653 if (pem_name
!= NULL
) {
654 if (strcmp(pem_name
, PEM_STRING_X509_CRL
) != 0)
660 if ((crl
= d2i_X509_CRL(NULL
, &blob
, len
)) != NULL
) {
662 store_info
= OSSL_STORE_INFO_new_CRL(crl
);
665 if (store_info
== NULL
)
671 static FILE_HANDLER X509CRL_handler
= {
677 * To finish it all off, we collect all the handlers.
679 static const FILE_HANDLER
*file_handlers
[] = {
681 &PKCS8Encrypted_handler
,
682 &X509Certificate_handler
,
695 struct ossl_store_loader_ctx_st
{
702 #define FILE_FLAG_SECMEM (1<<0)
705 struct { /* Used with is_raw and is_pem */
709 * The following are used when the handler is marked as
712 const FILE_HANDLER
*last_handler
;
713 void *last_handler_ctx
;
715 struct { /* Used with is_dir */
716 OPENSSL_DIR_CTX
*ctx
;
721 * When a search expression is given, these are filled in.
722 * |search_name| contains the file basename to look for.
723 * The string is exactly 8 characters long.
728 * The directory reading utility we have combines opening with
729 * reading the first name. To make sure we can detect the end
730 * at the right time, we read early and cache the name.
732 const char *last_entry
;
737 /* Expected object type. May be unspecified */
741 static void OSSL_STORE_LOADER_CTX_free(OSSL_STORE_LOADER_CTX
*ctx
)
743 if (ctx
->type
== is_dir
) {
744 OPENSSL_free(ctx
->_
.dir
.uri
);
746 if (ctx
->_
.file
.last_handler
!= NULL
) {
747 ctx
->_
.file
.last_handler
->destroy_ctx(&ctx
->_
.file
.last_handler_ctx
);
748 ctx
->_
.file
.last_handler_ctx
= NULL
;
749 ctx
->_
.file
.last_handler
= NULL
;
755 static OSSL_STORE_LOADER_CTX
*file_open(const OSSL_STORE_LOADER
*loader
,
757 const UI_METHOD
*ui_method
,
760 OSSL_STORE_LOADER_CTX
*ctx
= NULL
;
764 unsigned int check_absolute
:1;
766 size_t path_data_n
= 0, i
;
770 * First step, just take the URI as is.
772 path_data
[path_data_n
].check_absolute
= 0;
773 path_data
[path_data_n
++].path
= uri
;
776 * Second step, if the URI appears to start with the 'file' scheme,
777 * extract the path and make that the second path to check.
778 * There's a special case if the URI also contains an authority, then
779 * the full URI shouldn't be used as a path anywhere.
781 if (strncasecmp(uri
, "file:", 5) == 0) {
782 const char *p
= &uri
[5];
784 if (strncmp(&uri
[5], "//", 2) == 0) {
785 path_data_n
--; /* Invalidate using the full URI */
786 if (strncasecmp(&uri
[7], "localhost/", 10) == 0) {
788 } else if (uri
[7] == '/') {
791 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN
,
792 OSSL_STORE_R_URI_AUTHORITY_UNSUPPORTED
);
797 path_data
[path_data_n
].check_absolute
= 1;
799 /* Windows file: URIs with a drive letter start with a / */
800 if (p
[0] == '/' && p
[2] == ':' && p
[3] == '/') {
801 char c
= ossl_tolower(p
[1]);
803 if (c
>= 'a' && c
<= 'z') {
805 /* We know it's absolute, so no need to check */
806 path_data
[path_data_n
].check_absolute
= 0;
810 path_data
[path_data_n
++].path
= p
;
814 for (i
= 0, path
= NULL
; path
== NULL
&& i
< path_data_n
; i
++) {
816 * If the scheme "file" was an explicit part of the URI, the path must
817 * be absolute. So says RFC 8089
819 if (path_data
[i
].check_absolute
&& path_data
[i
].path
[0] != '/') {
820 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN
,
821 OSSL_STORE_R_PATH_MUST_BE_ABSOLUTE
);
822 ERR_add_error_data(1, path_data
[i
].path
);
826 if (stat(path_data
[i
].path
, &st
) < 0) {
827 ERR_raise_data(ERR_LIB_SYS
, errno
,
831 path
= path_data
[i
].path
;
838 /* Successfully found a working path, clear possible collected errors */
841 ctx
= OPENSSL_zalloc(sizeof(*ctx
));
843 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN
, ERR_R_MALLOC_FAILURE
);
847 if (S_ISDIR(st
.st_mode
)) {
849 * Try to copy everything, even if we know that some of them must be
850 * NULL for the moment. This prevents errors in the future, when more
851 * components may be used.
853 ctx
->_
.dir
.uri
= OPENSSL_strdup(uri
);
856 if (ctx
->_
.dir
.uri
== NULL
)
859 ctx
->_
.dir
.last_entry
= OPENSSL_DIR_read(&ctx
->_
.dir
.ctx
, path
);
860 ctx
->_
.dir
.last_errno
= errno
;
861 if (ctx
->_
.dir
.last_entry
== NULL
) {
862 if (ctx
->_
.dir
.last_errno
!= 0) {
864 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN
, ERR_R_SYS_LIB
);
865 errno
= ctx
->_
.dir
.last_errno
;
866 if (openssl_strerror_r(errno
, errbuf
, sizeof(errbuf
)))
867 ERR_add_error_data(1, errbuf
);
870 ctx
->_
.dir
.end_reached
= 1;
874 char peekbuf
[4096] = { 0, };
876 if ((buff
= BIO_new(BIO_f_buffer())) == NULL
877 || (ctx
->_
.file
.file
= BIO_new_file(path
, "rb")) == NULL
) {
882 ctx
->_
.file
.file
= BIO_push(buff
, ctx
->_
.file
.file
);
883 if (BIO_buffer_peek(ctx
->_
.file
.file
, peekbuf
, sizeof(peekbuf
) - 1) > 0) {
884 peekbuf
[sizeof(peekbuf
) - 1] = '\0';
885 if (strstr(peekbuf
, "-----BEGIN ") != NULL
)
892 OSSL_STORE_LOADER_CTX_free(ctx
);
896 static int file_ctrl(OSSL_STORE_LOADER_CTX
*ctx
, int cmd
, va_list args
)
901 case OSSL_STORE_C_USE_SECMEM
:
903 int on
= *(va_arg(args
, int *));
907 ctx
->flags
&= ~FILE_FLAG_SECMEM
;
910 ctx
->flags
|= FILE_FLAG_SECMEM
;
913 OSSL_STOREerr(OSSL_STORE_F_FILE_CTRL
,
914 ERR_R_PASSED_INVALID_ARGUMENT
);
927 static int file_expect(OSSL_STORE_LOADER_CTX
*ctx
, int expected
)
929 ctx
->expected_type
= expected
;
933 static int file_find(OSSL_STORE_LOADER_CTX
*ctx
, OSSL_STORE_SEARCH
*search
)
936 * If ctx == NULL, the library is looking to know if this loader supports
937 * the given search type.
940 if (OSSL_STORE_SEARCH_get_type(search
) == OSSL_STORE_SEARCH_BY_NAME
) {
941 unsigned long hash
= 0;
946 if (ctx
->type
!= is_dir
) {
947 OSSL_STOREerr(OSSL_STORE_F_FILE_FIND
,
948 OSSL_STORE_R_SEARCH_ONLY_SUPPORTED_FOR_DIRECTORIES
);
952 hash
= X509_NAME_hash(OSSL_STORE_SEARCH_get0_name(search
));
953 BIO_snprintf(ctx
->_
.dir
.search_name
, sizeof(ctx
->_
.dir
.search_name
),
959 OSSL_STOREerr(OSSL_STORE_F_FILE_FIND
,
960 OSSL_STORE_R_UNSUPPORTED_SEARCH_TYPE
);
964 /* Internal function to decode an already opened PEM file */
965 OSSL_STORE_LOADER_CTX
*ossl_store_file_attach_pem_bio_int(BIO
*bp
)
967 OSSL_STORE_LOADER_CTX
*ctx
= OPENSSL_zalloc(sizeof(*ctx
));
970 OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_FILE_ATTACH_PEM_BIO_INT
,
971 ERR_R_MALLOC_FAILURE
);
975 ctx
->_
.file
.file
= bp
;
981 static OSSL_STORE_INFO
*file_load_try_decode(OSSL_STORE_LOADER_CTX
*ctx
,
982 const char *pem_name
,
983 const char *pem_header
,
984 unsigned char *data
, size_t len
,
985 const UI_METHOD
*ui_method
,
986 void *ui_data
, int *matchcount
)
988 OSSL_STORE_INFO
*result
= NULL
;
989 BUF_MEM
*new_mem
= NULL
;
990 char *new_pem_name
= NULL
;
996 void *handler_ctx
= NULL
;
997 const FILE_HANDLER
**matching_handlers
=
998 OPENSSL_zalloc(sizeof(*matching_handlers
)
999 * OSSL_NELEM(file_handlers
));
1001 if (matching_handlers
== NULL
) {
1002 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD_TRY_DECODE
,
1003 ERR_R_MALLOC_FAILURE
);
1008 for (i
= 0; i
< OSSL_NELEM(file_handlers
); i
++) {
1009 const FILE_HANDLER
*handler
= file_handlers
[i
];
1010 int try_matchcount
= 0;
1011 void *tmp_handler_ctx
= NULL
;
1012 OSSL_STORE_INFO
*tmp_result
=
1013 handler
->try_decode(pem_name
, pem_header
, data
, len
,
1014 &tmp_handler_ctx
, &try_matchcount
,
1015 ui_method
, ui_data
);
1017 if (try_matchcount
> 0) {
1019 matching_handlers
[*matchcount
] = handler
;
1022 handler
->destroy_ctx(&handler_ctx
);
1023 handler_ctx
= tmp_handler_ctx
;
1025 if ((*matchcount
+= try_matchcount
) > 1) {
1026 /* more than one match => ambiguous, kill any result */
1027 OSSL_STORE_INFO_free(result
);
1028 OSSL_STORE_INFO_free(tmp_result
);
1029 if (handler
->destroy_ctx
!= NULL
)
1030 handler
->destroy_ctx(&handler_ctx
);
1036 result
= tmp_result
;
1040 if (*matchcount
== 1 && matching_handlers
[0]->repeatable
) {
1041 ctx
->_
.file
.last_handler
= matching_handlers
[0];
1042 ctx
->_
.file
.last_handler_ctx
= handler_ctx
;
1045 OPENSSL_free(matching_handlers
);
1049 OPENSSL_free(new_pem_name
);
1050 BUF_MEM_free(new_mem
);
1053 && (t
= OSSL_STORE_INFO_get_type(result
)) == OSSL_STORE_INFO_EMBEDDED
) {
1054 pem_name
= new_pem_name
=
1055 ossl_store_info_get0_EMBEDDED_pem_name(result
);
1056 new_mem
= ossl_store_info_get0_EMBEDDED_buffer(result
);
1057 data
= (unsigned char *)new_mem
->data
;
1058 len
= new_mem
->length
;
1059 OPENSSL_free(result
);
1070 static OSSL_STORE_INFO
*file_load_try_repeat(OSSL_STORE_LOADER_CTX
*ctx
,
1071 const UI_METHOD
*ui_method
,
1074 OSSL_STORE_INFO
*result
= NULL
;
1075 int try_matchcount
= 0;
1077 if (ctx
->_
.file
.last_handler
!= NULL
) {
1079 ctx
->_
.file
.last_handler
->try_decode(NULL
, NULL
, NULL
, 0,
1080 &ctx
->_
.file
.last_handler_ctx
,
1082 ui_method
, ui_data
);
1084 if (result
== NULL
) {
1085 ctx
->_
.file
.last_handler
->destroy_ctx(&ctx
->_
.file
.last_handler_ctx
);
1086 ctx
->_
.file
.last_handler_ctx
= NULL
;
1087 ctx
->_
.file
.last_handler
= NULL
;
1093 static void pem_free_flag(void *pem_data
, int secure
, size_t num
)
1096 OPENSSL_secure_clear_free(pem_data
, num
);
1098 OPENSSL_free(pem_data
);
1100 static int file_read_pem(BIO
*bp
, char **pem_name
, char **pem_header
,
1101 unsigned char **data
, long *len
,
1102 const UI_METHOD
*ui_method
,
1103 void *ui_data
, int secure
)
1106 ? PEM_read_bio_ex(bp
, pem_name
, pem_header
, data
, len
,
1107 PEM_FLAG_SECURE
| PEM_FLAG_EAY_COMPATIBLE
)
1108 : PEM_read_bio(bp
, pem_name
, pem_header
, data
, len
);
1114 * 10 is the number of characters in "Proc-Type:", which
1115 * PEM_get_EVP_CIPHER_INFO() requires to be present.
1116 * If the PEM header has less characters than that, it's
1117 * not worth spending cycles on it.
1119 if (strlen(*pem_header
) > 10) {
1120 EVP_CIPHER_INFO cipher
;
1121 struct pem_pass_data pass_data
;
1123 if (!PEM_get_EVP_CIPHER_INFO(*pem_header
, &cipher
)
1124 || !file_fill_pem_pass_data(&pass_data
, "PEM", ui_method
, ui_data
)
1125 || !PEM_do_header(&cipher
, *data
, len
, file_get_pem_pass
,
1133 static int file_read_asn1(BIO
*bp
, unsigned char **data
, long *len
)
1135 BUF_MEM
*mem
= NULL
;
1137 if (asn1_d2i_read_bio(bp
, &mem
) < 0)
1140 *data
= (unsigned char *)mem
->data
;
1141 *len
= (long)mem
->length
;
1147 static int ends_with_dirsep(const char *uri
)
1150 uri
+= strlen(uri
) - 1;
1152 if (*uri
== ']' || *uri
== '>' || *uri
== ':')
1154 #elif defined _WIN32
1161 static int file_name_to_uri(OSSL_STORE_LOADER_CTX
*ctx
, const char *name
,
1164 assert(name
!= NULL
);
1165 assert(data
!= NULL
);
1167 const char *pathsep
= ends_with_dirsep(ctx
->_
.dir
.uri
) ? "" : "/";
1168 long calculated_length
= strlen(ctx
->_
.dir
.uri
) + strlen(pathsep
)
1169 + strlen(name
) + 1 /* \0 */;
1171 *data
= OPENSSL_zalloc(calculated_length
);
1172 if (*data
== NULL
) {
1173 OSSL_STOREerr(OSSL_STORE_F_FILE_NAME_TO_URI
, ERR_R_MALLOC_FAILURE
);
1177 OPENSSL_strlcat(*data
, ctx
->_
.dir
.uri
, calculated_length
);
1178 OPENSSL_strlcat(*data
, pathsep
, calculated_length
);
1179 OPENSSL_strlcat(*data
, name
, calculated_length
);
1184 static int file_name_check(OSSL_STORE_LOADER_CTX
*ctx
, const char *name
)
1186 const char *p
= NULL
;
1188 /* If there are no search criteria, all names are accepted */
1189 if (ctx
->_
.dir
.search_name
[0] == '\0')
1192 /* If the expected type isn't supported, no name is accepted */
1193 if (ctx
->expected_type
!= 0
1194 && ctx
->expected_type
!= OSSL_STORE_INFO_CERT
1195 && ctx
->expected_type
!= OSSL_STORE_INFO_CRL
)
1199 * First, check the basename
1201 if (strncasecmp(name
, ctx
->_
.dir
.search_name
,
1202 sizeof(ctx
->_
.dir
.search_name
) - 1) != 0
1203 || name
[sizeof(ctx
->_
.dir
.search_name
) - 1] != '.')
1205 p
= &name
[sizeof(ctx
->_
.dir
.search_name
)];
1208 * Then, if the expected type is a CRL, check that the extension starts
1213 if (ctx
->expected_type
!= 0
1214 && ctx
->expected_type
!= OSSL_STORE_INFO_CRL
)
1216 } else if (ctx
->expected_type
== OSSL_STORE_INFO_CRL
) {
1221 * Last, check that the rest of the extension is a decimal number, at
1222 * least one digit long.
1224 if (!ossl_isdigit(*p
))
1226 while (ossl_isdigit(*p
))
1231 * One extra step here, check for a possible generation number.
1234 for (p
++; *p
!= '\0'; p
++)
1235 if (!ossl_isdigit(*p
))
1240 * If we've reached the end of the string at this point, we've successfully
1241 * found a fitting file name.
1246 static int file_eof(OSSL_STORE_LOADER_CTX
*ctx
);
1247 static int file_error(OSSL_STORE_LOADER_CTX
*ctx
);
1248 static OSSL_STORE_INFO
*file_load(OSSL_STORE_LOADER_CTX
*ctx
,
1249 const UI_METHOD
*ui_method
, void *ui_data
)
1251 OSSL_STORE_INFO
*result
= NULL
;
1256 if (ctx
->type
== is_dir
) {
1258 char *newname
= NULL
;
1260 if (ctx
->_
.dir
.last_entry
== NULL
) {
1261 if (!ctx
->_
.dir
.end_reached
) {
1263 assert(ctx
->_
.dir
.last_errno
!= 0);
1264 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD
, ERR_R_SYS_LIB
);
1265 errno
= ctx
->_
.dir
.last_errno
;
1267 if (openssl_strerror_r(errno
, errbuf
, sizeof(errbuf
)))
1268 ERR_add_error_data(1, errbuf
);
1273 if (ctx
->_
.dir
.last_entry
[0] != '.'
1274 && file_name_check(ctx
, ctx
->_
.dir
.last_entry
)
1275 && !file_name_to_uri(ctx
, ctx
->_
.dir
.last_entry
, &newname
))
1279 * On the first call (with a NULL context), OPENSSL_DIR_read()
1280 * cares about the second argument. On the following calls, it
1281 * only cares that it isn't NULL. Therefore, we can safely give
1284 ctx
->_
.dir
.last_entry
= OPENSSL_DIR_read(&ctx
->_
.dir
.ctx
,
1286 ctx
->_
.dir
.last_errno
= errno
;
1287 if (ctx
->_
.dir
.last_entry
== NULL
&& ctx
->_
.dir
.last_errno
== 0)
1288 ctx
->_
.dir
.end_reached
= 1;
1291 && (result
= OSSL_STORE_INFO_new_NAME(newname
)) == NULL
) {
1292 OPENSSL_free(newname
);
1293 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD
, ERR_R_OSSL_STORE_LIB
);
1296 } while (result
== NULL
&& !file_eof(ctx
));
1298 int matchcount
= -1;
1301 result
= file_load_try_repeat(ctx
, ui_method
, ui_data
);
1309 char *pem_name
= NULL
; /* PEM record name */
1310 char *pem_header
= NULL
; /* PEM record header */
1311 unsigned char *data
= NULL
; /* DER encoded data */
1312 long len
= 0; /* DER encoded data length */
1315 if (ctx
->type
== is_pem
) {
1316 if (!file_read_pem(ctx
->_
.file
.file
, &pem_name
, &pem_header
,
1317 &data
, &len
, ui_method
, ui_data
,
1318 (ctx
->flags
& FILE_FLAG_SECMEM
) != 0)) {
1323 if (!file_read_asn1(ctx
->_
.file
.file
, &data
, &len
)) {
1329 result
= file_load_try_decode(ctx
, pem_name
, pem_header
, data
, len
,
1330 ui_method
, ui_data
, &matchcount
);
1336 * If a PEM name matches more than one handler, the handlers are
1339 if (!ossl_assert(pem_name
== NULL
|| matchcount
<= 1)) {
1344 if (matchcount
> 1) {
1345 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD
,
1346 OSSL_STORE_R_AMBIGUOUS_CONTENT_TYPE
);
1347 } else if (matchcount
== 1) {
1349 * If there are other errors on the stack, they already show
1350 * what the problem is.
1352 if (ERR_peek_error() == 0) {
1353 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD
,
1354 OSSL_STORE_R_UNSUPPORTED_CONTENT_TYPE
);
1355 if (pem_name
!= NULL
)
1356 ERR_add_error_data(3, "PEM type is '", pem_name
, "'");
1363 pem_free_flag(pem_name
, (ctx
->flags
& FILE_FLAG_SECMEM
) != 0, 0);
1364 pem_free_flag(pem_header
, (ctx
->flags
& FILE_FLAG_SECMEM
) != 0, 0);
1365 pem_free_flag(data
, (ctx
->flags
& FILE_FLAG_SECMEM
) != 0, len
);
1366 } while (matchcount
== 0 && !file_eof(ctx
) && !file_error(ctx
));
1368 /* We bail out on ambiguity */
1373 && ctx
->expected_type
!= 0
1374 && ctx
->expected_type
!= OSSL_STORE_INFO_get_type(result
)) {
1375 OSSL_STORE_INFO_free(result
);
1383 static int file_error(OSSL_STORE_LOADER_CTX
*ctx
)
1385 return ctx
->errcnt
> 0;
1388 static int file_eof(OSSL_STORE_LOADER_CTX
*ctx
)
1390 if (ctx
->type
== is_dir
)
1391 return ctx
->_
.dir
.end_reached
;
1393 if (ctx
->_
.file
.last_handler
!= NULL
1394 && !ctx
->_
.file
.last_handler
->eof(ctx
->_
.file
.last_handler_ctx
))
1396 return BIO_eof(ctx
->_
.file
.file
);
1399 static int file_close(OSSL_STORE_LOADER_CTX
*ctx
)
1401 if (ctx
->type
== is_dir
) {
1402 OPENSSL_DIR_end(&ctx
->_
.dir
.ctx
);
1404 BIO_free_all(ctx
->_
.file
.file
);
1406 OSSL_STORE_LOADER_CTX_free(ctx
);
1410 int ossl_store_file_detach_pem_bio_int(OSSL_STORE_LOADER_CTX
*ctx
)
1412 OSSL_STORE_LOADER_CTX_free(ctx
);
1416 static OSSL_STORE_LOADER file_loader
=
1430 static void store_file_loader_deinit(void)
1432 ossl_store_unregister_loader_int(file_loader
.scheme
);
1435 int ossl_store_file_loader_init(void)
1437 int ret
= ossl_store_register_loader_int(&file_loader
);
1439 OPENSSL_atexit(store_file_loader_deinit
);