2 * Copyright 2020-2021 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
10 #include "e_os.h" /* To get strncasecmp() on Windows */
14 #include <ctype.h> /* isdigit */
17 #include <openssl/core_dispatch.h>
18 #include <openssl/core_names.h>
19 #include <openssl/core_object.h>
20 #include <openssl/bio.h>
21 #include <openssl/err.h>
22 #include <openssl/params.h>
23 #include <openssl/decoder.h>
24 #include <openssl/proverr.h>
25 #include <openssl/store.h> /* The OSSL_STORE_INFO type numbers */
26 #include "internal/cryptlib.h"
27 #include "internal/o_dir.h"
28 #include "crypto/decoder.h"
29 #include "prov/implementations.h"
31 #include "file_store_local.h"
33 DEFINE_STACK_OF(OSSL_STORE_INFO
)
40 # define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
43 static OSSL_FUNC_store_open_fn file_open
;
44 static OSSL_FUNC_store_attach_fn file_attach
;
45 static OSSL_FUNC_store_settable_ctx_params_fn file_settable_ctx_params
;
46 static OSSL_FUNC_store_set_ctx_params_fn file_set_ctx_params
;
47 static OSSL_FUNC_store_load_fn file_load
;
48 static OSSL_FUNC_store_eof_fn file_eof
;
49 static OSSL_FUNC_store_close_fn file_close
;
52 * This implementation makes full use of OSSL_DECODER, and then some.
53 * It uses its own internal decoder implementation that reads DER and
54 * passes that on to the data callback; this decoder is created with
55 * internal OpenSSL functions, thereby bypassing the need for a surrounding
56 * provider. This is ok, since this is a local decoder, not meant for
57 * public consumption. It also uses the libcrypto internal decoder
58 * setup function ossl_decoder_ctx_setup_for_pkey(), to allow the
59 * last resort decoder to be added first (and thereby be executed last).
60 * Finally, it sets up its own construct and cleanup functions.
62 * Essentially, that makes this implementation a kind of glorified decoder.
67 char *uri
; /* The URI we currently try to load */
69 IS_FILE
= 0, /* Read file and pass results */
70 IS_DIR
/* Pass directory entry names */
74 /* Used with |IS_FILE| */
78 OSSL_DECODER_CTX
*decoderctx
;
80 char *propq
; /* The properties we got as a parameter */
83 /* Used with |IS_DIR| */
89 * When a search expression is given, these are filled in.
90 * |search_name| contains the file basename to look for.
91 * The string is exactly 8 characters long.
96 * The directory reading utility we have combines opening with
97 * reading the first name. To make sure we can detect the end
98 * at the right time, we read early and cache the name.
100 const char *last_entry
;
105 /* Expected object type. May be unspecified */
109 static void free_file_ctx(struct file_ctx_st
*ctx
)
114 OPENSSL_free(ctx
->uri
);
115 if (ctx
->type
!= IS_DIR
) {
116 OSSL_DECODER_CTX_free(ctx
->_
.file
.decoderctx
);
117 OPENSSL_free(ctx
->_
.file
.propq
);
118 OPENSSL_free(ctx
->_
.file
.input_type
);
123 static struct file_ctx_st
*new_file_ctx(int type
, const char *uri
,
126 struct file_ctx_st
*ctx
= NULL
;
128 if ((ctx
= OPENSSL_zalloc(sizeof(*ctx
))) != NULL
129 && (uri
== NULL
|| (ctx
->uri
= OPENSSL_strdup(uri
)) != NULL
)) {
131 ctx
->provctx
= provctx
;
138 static OSSL_DECODER_CONSTRUCT file_load_construct
;
139 static OSSL_DECODER_CLEANUP file_load_cleanup
;
142 * Opening / attaching streams and directories
143 * -------------------------------------------
147 * Function to service both file_open() and file_attach()
151 static struct file_ctx_st
*file_open_stream(BIO
*source
, const char *uri
,
152 const char *input_type
,
155 struct file_ctx_st
*ctx
;
157 if ((ctx
= new_file_ctx(IS_FILE
, uri
, provctx
)) == NULL
158 || (input_type
!= NULL
159 && (ctx
->_
.file
.input_type
=
160 OPENSSL_strdup(input_type
)) == NULL
)) {
161 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
165 ctx
->_
.file
.file
= source
;
173 static void *file_open_dir(const char *path
, const char *uri
, void *provctx
)
175 struct file_ctx_st
*ctx
;
177 if ((ctx
= new_file_ctx(IS_DIR
, uri
, provctx
)) == NULL
) {
178 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
182 ctx
->_
.dir
.last_entry
= OPENSSL_DIR_read(&ctx
->_
.dir
.ctx
, path
);
183 ctx
->_
.dir
.last_errno
= errno
;
184 if (ctx
->_
.dir
.last_entry
== NULL
) {
185 if (ctx
->_
.dir
.last_errno
!= 0) {
186 ERR_raise_data(ERR_LIB_SYS
, ctx
->_
.dir
.last_errno
,
187 "Calling OPENSSL_DIR_read(\"%s\")", path
);
190 ctx
->_
.dir
.end_reached
= 1;
198 static void *file_open(void *provctx
, const char *uri
)
200 struct file_ctx_st
*ctx
= NULL
;
204 unsigned int check_absolute
:1;
206 size_t path_data_n
= 0, i
;
213 * First step, just take the URI as is.
215 path_data
[path_data_n
].check_absolute
= 0;
216 path_data
[path_data_n
++].path
= uri
;
219 * Second step, if the URI appears to start with the 'file' scheme,
220 * extract the path and make that the second path to check.
221 * There's a special case if the URI also contains an authority, then
222 * the full URI shouldn't be used as a path anywhere.
224 if (strncasecmp(uri
, "file:", 5) == 0) {
225 const char *p
= &uri
[5];
227 if (strncmp(&uri
[5], "//", 2) == 0) {
228 path_data_n
--; /* Invalidate using the full URI */
229 if (strncasecmp(&uri
[7], "localhost/", 10) == 0) {
231 } else if (uri
[7] == '/') {
234 ERR_clear_last_mark();
235 ERR_raise(ERR_LIB_PROV
, PROV_R_URI_AUTHORITY_UNSUPPORTED
);
240 path_data
[path_data_n
].check_absolute
= 1;
242 /* Windows file: URIs with a drive letter start with a / */
243 if (p
[0] == '/' && p
[2] == ':' && p
[3] == '/') {
244 char c
= tolower(p
[1]);
246 if (c
>= 'a' && c
<= 'z') {
248 /* We know it's absolute, so no need to check */
249 path_data
[path_data_n
].check_absolute
= 0;
253 path_data
[path_data_n
++].path
= p
;
257 for (i
= 0, path
= NULL
; path
== NULL
&& i
< path_data_n
; i
++) {
259 * If the scheme "file" was an explicit part of the URI, the path must
260 * be absolute. So says RFC 8089
262 if (path_data
[i
].check_absolute
&& path_data
[i
].path
[0] != '/') {
263 ERR_clear_last_mark();
264 ERR_raise_data(ERR_LIB_PROV
, PROV_R_PATH_MUST_BE_ABSOLUTE
,
265 "Given path=%s", path_data
[i
].path
);
269 if (stat(path_data
[i
].path
, &st
) < 0) {
270 ERR_raise_data(ERR_LIB_SYS
, errno
,
274 path
= path_data
[i
].path
;
278 ERR_clear_last_mark();
282 /* Successfully found a working path, clear possible collected errors */
285 if (S_ISDIR(st
.st_mode
))
286 ctx
= file_open_dir(path
, uri
, provctx
);
287 else if ((bio
= BIO_new_file(path
, "rb")) == NULL
288 || (ctx
= file_open_stream(bio
, uri
, NULL
, provctx
)) == NULL
)
294 void *file_attach(void *provctx
, OSSL_CORE_BIO
*cin
)
296 struct file_ctx_st
*ctx
;
297 BIO
*new_bio
= bio_new_from_core_bio(provctx
, cin
);
302 ctx
= file_open_stream(new_bio
, NULL
, NULL
, provctx
);
313 static const OSSL_PARAM
*file_settable_ctx_params(void *provctx
)
315 static const OSSL_PARAM known_settable_ctx_params
[] = {
316 OSSL_PARAM_utf8_string(OSSL_STORE_PARAM_PROPERTIES
, NULL
, 0),
317 OSSL_PARAM_int(OSSL_STORE_PARAM_EXPECT
, NULL
),
318 OSSL_PARAM_octet_string(OSSL_STORE_PARAM_SUBJECT
, NULL
, 0),
321 return known_settable_ctx_params
;
324 static int file_set_ctx_params(void *loaderctx
, const OSSL_PARAM params
[])
326 struct file_ctx_st
*ctx
= loaderctx
;
332 p
= OSSL_PARAM_locate_const(params
, OSSL_STORE_PARAM_PROPERTIES
);
334 OPENSSL_free(ctx
->_
.file
.propq
);
335 ctx
->_
.file
.propq
= NULL
;
336 if (!OSSL_PARAM_get_utf8_string(p
, &ctx
->_
.file
.propq
, 0))
339 p
= OSSL_PARAM_locate_const(params
, OSSL_STORE_PARAM_EXPECT
);
340 if (p
!= NULL
&& !OSSL_PARAM_get_int(p
, &ctx
->expected_type
))
342 p
= OSSL_PARAM_locate_const(params
, OSSL_STORE_PARAM_SUBJECT
);
344 const unsigned char *der
= NULL
;
346 X509_NAME
*x509_name
;
350 if (ctx
->type
!= IS_DIR
) {
351 ERR_raise(ERR_LIB_PROV
,
352 PROV_R_SEARCH_ONLY_SUPPORTED_FOR_DIRECTORIES
);
356 if (!OSSL_PARAM_get_octet_string_ptr(p
, (const void **)&der
, &der_len
)
357 || (x509_name
= d2i_X509_NAME(NULL
, &der
, der_len
)) == NULL
)
359 hash
= X509_NAME_hash_ex(x509_name
,
360 ossl_prov_ctx_get0_libctx(ctx
->provctx
), NULL
,
362 BIO_snprintf(ctx
->_
.dir
.search_name
, sizeof(ctx
->_
.dir
.search_name
),
364 X509_NAME_free(x509_name
);
372 * Loading an object from a stream
373 * -------------------------------
376 struct file_load_data_st
{
377 OSSL_CALLBACK
*object_cb
;
381 static int file_load_construct(OSSL_DECODER_INSTANCE
*decoder_inst
,
382 const OSSL_PARAM
*params
, void *construct_data
)
384 struct file_load_data_st
*data
= construct_data
;
387 * At some point, we may find it justifiable to recognise PKCS#12 and
388 * handle it specially here, making |file_load()| return pass its
389 * contents one piece at ta time, like |e_loader_attic.c| does.
391 * However, that currently means parsing them out, which converts the
392 * DER encoded PKCS#12 into a bunch of EVP_PKEYs and X509s, just to
393 * have to re-encode them into DER to create an object abstraction for
395 * It's much simpler (less churn) to pass on the object abstraction we
396 * get to the load_result callback and leave it to that one to do the
397 * work. If that's libcrypto code, we know that it has much better
398 * possibilities to handle the EVP_PKEYs and X509s without the extra
402 return data
->object_cb(params
, data
->object_cbarg
);
405 void file_load_cleanup(void *construct_data
)
410 static int file_setup_decoders(struct file_ctx_st
*ctx
)
412 EVP_PKEY
*dummy
; /* for ossl_decoder_ctx_setup_for_pkey() */
413 OSSL_LIB_CTX
*libctx
= ossl_prov_ctx_get0_libctx(ctx
->provctx
);
414 OSSL_DECODER
*to_obj
= NULL
; /* Last resort decoder */
415 OSSL_DECODER_INSTANCE
*to_obj_inst
= NULL
;
416 OSSL_DECODER_CLEANUP
*old_cleanup
= NULL
;
417 void *old_construct_data
= NULL
;
420 /* Setup for this session, so only if not already done */
421 if (ctx
->_
.file
.decoderctx
== NULL
) {
422 if ((ctx
->_
.file
.decoderctx
= OSSL_DECODER_CTX_new()) == NULL
) {
423 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
427 /* Make sure the input type is set */
428 if (!OSSL_DECODER_CTX_set_input_type(ctx
->_
.file
.decoderctx
,
429 ctx
->_
.file
.input_type
)) {
430 ERR_raise(ERR_LIB_PROV
, ERR_R_OSSL_DECODER_LIB
);
435 * Create the internal last resort decoder implementation together
436 * with a "decoder instance".
437 * The decoder doesn't need any identification or to be attached to
438 * any provider, since it's only used locally.
440 to_obj
= ossl_decoder_from_dispatch(0, &ossl_der_to_obj_algorithm
,
444 to_obj_inst
= ossl_decoder_instance_new(to_obj
, ctx
->provctx
);
445 if (to_obj_inst
== NULL
)
448 if (!ossl_decoder_ctx_add_decoder_inst(ctx
->_
.file
.decoderctx
,
450 ERR_raise(ERR_LIB_PROV
, ERR_R_OSSL_DECODER_LIB
);
455 * OSSL_DECODER_INSTANCE shouldn't be freed from this point on.
456 * That's going to happen whenever the OSSL_DECODER_CTX is freed.
461 * Add on the usual decoder context for keys, with a dummy object.
462 * Since we're setting up our own constructor, we don't need to care
465 if (!ossl_decoder_ctx_setup_for_pkey(ctx
->_
.file
.decoderctx
,
467 libctx
, ctx
->_
.file
.propq
)
468 || !OSSL_DECODER_CTX_add_extra(ctx
->_
.file
.decoderctx
,
469 libctx
, ctx
->_
.file
.propq
)) {
470 ERR_raise(ERR_LIB_PROV
, ERR_R_OSSL_DECODER_LIB
);
475 * Then we throw away the installed finalizer data, and install our
478 old_cleanup
= OSSL_DECODER_CTX_get_cleanup(ctx
->_
.file
.decoderctx
);
480 OSSL_DECODER_CTX_get_construct_data(ctx
->_
.file
.decoderctx
);
481 if (old_cleanup
!= NULL
)
482 old_cleanup(old_construct_data
);
487 if (!OSSL_DECODER_CTX_set_construct(ctx
->_
.file
.decoderctx
,
489 || !OSSL_DECODER_CTX_set_cleanup(ctx
->_
.file
.decoderctx
,
490 file_load_cleanup
)) {
491 ERR_raise(ERR_LIB_PROV
, ERR_R_OSSL_DECODER_LIB
);
498 OSSL_DECODER_free(to_obj
);
502 static int file_load_file(struct file_ctx_st
*ctx
,
503 OSSL_CALLBACK
*object_cb
, void *object_cbarg
,
504 OSSL_PASSPHRASE_CALLBACK
*pw_cb
, void *pw_cbarg
)
506 struct file_load_data_st data
;
508 /* Setup the decoders (one time shot per session */
510 if (!file_setup_decoders(ctx
))
513 /* Setup for this object */
515 data
.object_cb
= object_cb
;
516 data
.object_cbarg
= object_cbarg
;
517 OSSL_DECODER_CTX_set_construct_data(ctx
->_
.file
.decoderctx
, &data
);
518 OSSL_DECODER_CTX_set_passphrase_cb(ctx
->_
.file
.decoderctx
, pw_cb
, pw_cbarg
);
522 return OSSL_DECODER_from_bio(ctx
->_
.file
.decoderctx
, ctx
->_
.file
.file
);
526 * Loading a name object from a directory
527 * --------------------------------------
530 static char *file_name_to_uri(struct file_ctx_st
*ctx
, const char *name
)
534 assert(name
!= NULL
);
536 const char *pathsep
= ossl_ends_with_dirsep(ctx
->uri
) ? "" : "/";
537 long calculated_length
= strlen(ctx
->uri
) + strlen(pathsep
)
538 + strlen(name
) + 1 /* \0 */;
540 data
= OPENSSL_zalloc(calculated_length
);
542 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
546 OPENSSL_strlcat(data
, ctx
->uri
, calculated_length
);
547 OPENSSL_strlcat(data
, pathsep
, calculated_length
);
548 OPENSSL_strlcat(data
, name
, calculated_length
);
553 static int file_name_check(struct file_ctx_st
*ctx
, const char *name
)
555 const char *p
= NULL
;
557 /* If there are no search criteria, all names are accepted */
558 if (ctx
->_
.dir
.search_name
[0] == '\0')
561 /* If the expected type isn't supported, no name is accepted */
562 if (ctx
->expected_type
!= 0
563 && ctx
->expected_type
!= OSSL_STORE_INFO_CERT
564 && ctx
->expected_type
!= OSSL_STORE_INFO_CRL
)
568 * First, check the basename
570 if (strncasecmp(name
, ctx
->_
.dir
.search_name
,
571 sizeof(ctx
->_
.dir
.search_name
) - 1) != 0
572 || name
[sizeof(ctx
->_
.dir
.search_name
) - 1] != '.')
574 p
= &name
[sizeof(ctx
->_
.dir
.search_name
)];
577 * Then, if the expected type is a CRL, check that the extension starts
582 if (ctx
->expected_type
!= 0
583 && ctx
->expected_type
!= OSSL_STORE_INFO_CRL
)
585 } else if (ctx
->expected_type
== OSSL_STORE_INFO_CRL
) {
590 * Last, check that the rest of the extension is a decimal number, at
591 * least one digit long.
600 * One extra step here, check for a possible generation number.
603 for (p
++; *p
!= '\0'; p
++)
604 if (!ossl_isdigit(*p
))
609 * If we've reached the end of the string at this point, we've successfully
610 * found a fitting file name.
615 static int file_load_dir_entry(struct file_ctx_st
*ctx
,
616 OSSL_CALLBACK
*object_cb
, void *object_cbarg
,
617 OSSL_PASSPHRASE_CALLBACK
*pw_cb
, void *pw_cbarg
)
619 /* Prepare as much as possible in advance */
620 static const int object_type
= OSSL_OBJECT_NAME
;
621 OSSL_PARAM object
[] = {
622 OSSL_PARAM_int(OSSL_OBJECT_PARAM_TYPE
, (int *)&object_type
),
623 OSSL_PARAM_utf8_string(OSSL_OBJECT_PARAM_DATA
, NULL
, 0),
626 char *newname
= NULL
;
629 /* Loop until we get an error or until we have a suitable name */
631 if (ctx
->_
.dir
.last_entry
== NULL
) {
632 if (!ctx
->_
.dir
.end_reached
) {
633 assert(ctx
->_
.dir
.last_errno
!= 0);
634 ERR_raise(ERR_LIB_SYS
, ctx
->_
.dir
.last_errno
);
636 /* file_eof() will tell if EOF was reached */
640 /* flag acceptable names */
641 if (ctx
->_
.dir
.last_entry
[0] != '.'
642 && file_name_check(ctx
, ctx
->_
.dir
.last_entry
)) {
644 /* If we can't allocate the new name, we fail */
646 file_name_to_uri(ctx
, ctx
->_
.dir
.last_entry
)) == NULL
)
651 * On the first call (with a NULL context), OPENSSL_DIR_read()
652 * cares about the second argument. On the following calls, it
653 * only cares that it isn't NULL. Therefore, we can safely give
656 ctx
->_
.dir
.last_entry
= OPENSSL_DIR_read(&ctx
->_
.dir
.ctx
, ctx
->uri
);
657 ctx
->_
.dir
.last_errno
= errno
;
658 if (ctx
->_
.dir
.last_entry
== NULL
&& ctx
->_
.dir
.last_errno
== 0)
659 ctx
->_
.dir
.end_reached
= 1;
660 } while (newname
== NULL
);
662 object
[1].data
= newname
;
663 object
[1].data_size
= strlen(newname
);
664 ok
= object_cb(object
, object_cbarg
);
665 OPENSSL_free(newname
);
670 * Loading, local dispatcher
671 * -------------------------
674 static int file_load(void *loaderctx
,
675 OSSL_CALLBACK
*object_cb
, void *object_cbarg
,
676 OSSL_PASSPHRASE_CALLBACK
*pw_cb
, void *pw_cbarg
)
678 struct file_ctx_st
*ctx
= loaderctx
;
682 return file_load_file(ctx
, object_cb
, object_cbarg
, pw_cb
, pw_cbarg
);
685 file_load_dir_entry(ctx
, object_cb
, object_cbarg
, pw_cb
, pw_cbarg
);
690 /* ctx->type has an unexpected value */
696 * Eof detection and closing
697 * -------------------------
700 static int file_eof(void *loaderctx
)
702 struct file_ctx_st
*ctx
= loaderctx
;
706 return ctx
->_
.dir
.end_reached
;
709 * BIO_pending() checks any filter BIO.
710 * BIO_eof() checks the source BIO.
712 return !BIO_pending(ctx
->_
.file
.file
)
713 && BIO_eof(ctx
->_
.file
.file
);
716 /* ctx->type has an unexpected value */
721 static int file_close_dir(struct file_ctx_st
*ctx
)
723 if (ctx
->_
.dir
.ctx
!= NULL
)
724 OPENSSL_DIR_end(&ctx
->_
.dir
.ctx
);
729 static int file_close_stream(struct file_ctx_st
*ctx
)
732 * This frees either the provider BIO filter (for file_attach()) OR
733 * the allocated file BIO (for file_open()).
735 BIO_free(ctx
->_
.file
.file
);
736 ctx
->_
.file
.file
= NULL
;
742 static int file_close(void *loaderctx
)
744 struct file_ctx_st
*ctx
= loaderctx
;
748 return file_close_dir(ctx
);
750 return file_close_stream(ctx
);
753 /* ctx->type has an unexpected value */
758 const OSSL_DISPATCH ossl_file_store_functions
[] = {
759 { OSSL_FUNC_STORE_OPEN
, (void (*)(void))file_open
},
760 { OSSL_FUNC_STORE_ATTACH
, (void (*)(void))file_attach
},
761 { OSSL_FUNC_STORE_SETTABLE_CTX_PARAMS
,
762 (void (*)(void))file_settable_ctx_params
},
763 { OSSL_FUNC_STORE_SET_CTX_PARAMS
, (void (*)(void))file_set_ctx_params
},
764 { OSSL_FUNC_STORE_LOAD
, (void (*)(void))file_load
},
765 { OSSL_FUNC_STORE_EOF
, (void (*)(void))file_eof
},
766 { OSSL_FUNC_STORE_CLOSE
, (void (*)(void))file_close
},