$NetBSD: OSSL_STORE_LOADER.3,v 1.8 2024/09/08 13:08:27 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "OSSL_STORE_LOADER 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
OSSL_STORE_LOADER, OSSL_STORE_LOADER_fetch, OSSL_STORE_LOADER_up_ref, OSSL_STORE_LOADER_free, OSSL_STORE_LOADER_get0_provider, OSSL_STORE_LOADER_get0_properties, OSSL_STORE_LOADER_is_a, OSSL_STORE_LOADER_get0_description, OSSL_STORE_LOADER_do_all_provided, OSSL_STORE_LOADER_names_do_all, OSSL_STORE_LOADER_CTX, OSSL_STORE_LOADER_new, OSSL_STORE_LOADER_get0_engine, OSSL_STORE_LOADER_get0_scheme, OSSL_STORE_LOADER_set_open, OSSL_STORE_LOADER_set_open_ex, OSSL_STORE_LOADER_set_attach, OSSL_STORE_LOADER_set_ctrl, OSSL_STORE_LOADER_set_expect, OSSL_STORE_LOADER_set_find, OSSL_STORE_LOADER_set_load, OSSL_STORE_LOADER_set_eof, OSSL_STORE_LOADER_set_error, OSSL_STORE_LOADER_set_close, OSSL_STORE_register_loader, OSSL_STORE_unregister_loader, OSSL_STORE_open_fn, OSSL_STORE_open_ex_fn, OSSL_STORE_attach_fn, OSSL_STORE_ctrl_fn, OSSL_STORE_expect_fn, OSSL_STORE_find_fn, OSSL_STORE_load_fn, OSSL_STORE_eof_fn, OSSL_STORE_error_fn, OSSL_STORE_close_fn - Types and functions to manipulate, register and unregister STORE loaders for different URI schemes Header "SYNOPSIS" .Vb 1 #include <openssl/store.h> \& typedef struct ossl_store_loader_st OSSL_STORE_LOADER; \& OSSL_STORE_LOADER *OSSL_STORE_LOADER_fetch(OSSL_LIB_CTX *libctx, const char *scheme, const char *properties); int OSSL_STORE_LOADER_up_ref(OSSL_STORE_LOADER *loader); void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *loader); const OSSL_PROVIDER *OSSL_STORE_LOADER_get0_provider(const OSSL_STORE_LOADER * loader); const char *OSSL_STORE_LOADER_get0_properties(const OSSL_STORE_LOADER *loader); const char *OSSL_STORE_LOADER_get0_description(const OSSL_STORE_LOADER *loader); int OSSL_STORE_LOADER_is_a(const OSSL_STORE_LOADER *loader, const char *scheme); void OSSL_STORE_LOADER_do_all_provided(OSSL_LIB_CTX *libctx, void (*user_fn)(OSSL_STORE_LOADER *loader, void *arg), void *user_arg); int OSSL_STORE_LOADER_names_do_all(const OSSL_STORE_LOADER *loader, void (*fn)(const char *name, void *data), void *data); .Ve

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros\|(7):

.Vb 5 OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme); const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER *store_loader); const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER *store_loader); \& /* struct ossl_store_loader_ctx_st is defined differently by each loader */ typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX; \& typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)( const char *uri, const UI_METHOD *ui_method, void *ui_data); int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *store_loader, OSSL_STORE_open_fn store_open_function); typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_ex_fn)( const char *uri, const UI_METHOD *ui_method, void *ui_data); int OSSL_STORE_LOADER_set_open_ex (OSSL_STORE_LOADER *store_loader, OSSL_STORE_open_ex_fn store_open_ex_function); typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_attach_fn) (const OSSL_STORE_LOADER *loader, BIO *bio, OSSL_LIB_CTX *libctx, const char *propq, const UI_METHOD *ui_method, void *ui_data); int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER *loader, OSSL_STORE_attach_fn attach_function); typedef int (*OSSL_STORE_ctrl_fn)(OSSL_STORE_LOADER_CTX *ctx, int cmd, va_list args); int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *store_loader, OSSL_STORE_ctrl_fn store_ctrl_function); typedef int (*OSSL_STORE_expect_fn)(OSSL_STORE_LOADER_CTX *ctx, int expected); int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader, OSSL_STORE_expect_fn expect_function); typedef int (*OSSL_STORE_find_fn)(OSSL_STORE_LOADER_CTX *ctx, OSSL_STORE_SEARCH *criteria); int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER *loader, OSSL_STORE_find_fn find_function); typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)(OSSL_STORE_LOADER_CTX *ctx, UI_METHOD *ui_method, void *ui_data); int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *store_loader, OSSL_STORE_load_fn store_load_function); typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx); int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *store_loader, OSSL_STORE_eof_fn store_eof_function); typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx); int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *store_loader, OSSL_STORE_error_fn store_error_function); typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx); int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *store_loader, OSSL_STORE_close_fn store_close_function); \& int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader); OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme); .Ve

Header "DESCRIPTION" \fBOSSL_STORE_LOADER is a method for OSSL_STORE loaders, which implement \fBOSSL_STORE_open(), OSSL_STORE_open_ex(), OSSL_STORE_load(), \fBOSSL_STORE_eof(), OSSL_STORE_error() and OSSL_STORE_close() for specific storage schemes.

\fBOSSL_STORE_LOADER_fetch() looks for an implementation for a storage \fIscheme within the providers that has been loaded into the OSSL_LIB_CTX given by libctx, and with the properties given by properties.

\fBOSSL_STORE_LOADER_up_ref() increments the reference count for the given \fIloader.

\fBOSSL_STORE_LOADER_free() decrements the reference count for the given \fIloader, and when the count reaches zero, frees it. If the argument is NULL, nothing is done.

\fBOSSL_STORE_LOADER_get0_provider() returns the provider of the given \fIloader.

\fBOSSL_STORE_LOADER_get0_properties() returns the property definition associated with the given loader.

\fBOSSL_STORE_LOADER_is_a() checks if loader is an implementation of an algorithm that's identifiable with scheme.

\fBOSSL_STORE_LOADER_get0_description() returns a description of the loader, meant for display and human consumption. The description is at the discretion of the \fIloader implementation.

\fBOSSL_STORE_LOADER_do_all_provided() traverses all store implementations by all activated providers in the library context libctx, and for each of the implementations, calls user_fn with the implementation method and \fIuser_arg as arguments.

\fBOSSL_STORE_LOADER_names_do_all() traverses all names for the given \fIloader, and calls fn with each name and data.

Subsection "Legacy Types and Functions (deprecated)" These functions help applications and engines to create loaders for schemes they support. These are all deprecated and discouraged in favour of provider implementations, see provider-storemgmt\|(7).

\fBOSSL_STORE_LOADER_CTX is a type template, to be defined by each loader using \*(C`struct ossl_store_loader_ctx_st { ... }\*(C'.

\fBOSSL_STORE_open_fn, OSSL_STORE_open_ex_fn, \fBOSSL_STORE_ctrl_fn, OSSL_STORE_expect_fn, OSSL_STORE_find_fn, \fBOSSL_STORE_load_fn, OSSL_STORE_eof_fn, and OSSL_STORE_close_fn are the function pointer types used within a STORE loader. The functions pointed at define the functionality of the given loader.

Item "OSSL_STORE_open_fn and OSSL_STORE_open_ex_fn" \fBOSSL_STORE_open_ex_fn takes a URI and is expected to interpret it in the best manner possible according to the scheme the loader implements. It also takes a UI_METHOD and associated data, to be used any time something needs to be prompted for, as well as a library context libctx with an associated property query propq, to be used when fetching necessary algorithms to perform the loads. Furthermore, this function is expected to initialize what needs to be initialized, to create a private data store (OSSL_STORE_LOADER_CTX, see above), and to return it. If something goes wrong, this function is expected to return NULL. .Sp \fBOSSL_STORE_open_fn does the same thing as \fBOSSL_STORE_open_ex_fn but uses NULL for the library context libctx and property query propq. Item "OSSL_STORE_attach_fn" This function takes a BIO, otherwise works like \fBOSSL_STORE_open_ex_fn. Item "OSSL_STORE_ctrl_fn" This function takes a OSSL_STORE_LOADER_CTX pointer, a command number \fIcmd and a va_list args and is used to manipulate loader specific parameters. .Sp Loader specific command numbers must begin at OSSL_STORE_C_CUSTOM_START. Any number below that is reserved for future globally known command numbers. .Sp This function is expected to return 1 on success, 0 on error. Item "OSSL_STORE_expect_fn" This function takes a OSSL_STORE_LOADER_CTX pointer and a OSSL_STORE_INFO identity expected, and is used to tell the loader what object type is expected. \fIexpected may be zero to signify that no specific object type is expected. .Sp This function is expected to return 1 on success, 0 on error. Item "OSSL_STORE_find_fn" This function takes a OSSL_STORE_LOADER_CTX pointer and a \fBOSSL_STORE_SEARCH search criterion, and is used to tell the loader what to search for. .Sp When called with the loader context being NULL, this function is expected to return 1 if the loader supports the criterion, otherwise 0. .Sp When called with the loader context being something other than NULL, this function is expected to return 1 on success, 0 on error. Item "OSSL_STORE_load_fn" This function takes a OSSL_STORE_LOADER_CTX pointer and a UI_METHOD with associated data. It's expected to load the next available data, mold it into a data structure that can be wrapped in a OSSL_STORE_INFO using one of the \fBOSSL_STORE_INFO\|(3) functions. If no more data is available or an error occurs, this function is expected to return NULL. The OSSL_STORE_eof_fn and OSSL_STORE_error_fn functions must indicate if it was in fact the end of data or if an error occurred. .Sp Note that this function retrieves one data item only. Item "OSSL_STORE_eof_fn" This function takes a OSSL_STORE_LOADER_CTX pointer and is expected to return 1 to indicate that the end of available data has been reached. It is otherwise expected to return 0. Item "OSSL_STORE_error_fn" This function takes a OSSL_STORE_LOADER_CTX pointer and is expected to return 1 to indicate that an error occurred in a previous call to the \fBOSSL_STORE_load_fn function. It is otherwise expected to return 0. Item "OSSL_STORE_close_fn" This function takes a OSSL_STORE_LOADER_CTX pointer and is expected to close or shut down what needs to be closed, and finally free the contents of the OSSL_STORE_LOADER_CTX pointer. It returns 1 on success and 0 on error.

\fBOSSL_STORE_LOADER_new() creates a new OSSL_STORE_LOADER. It takes an ENGINE e and a string scheme. \fIscheme must always be set. Both e and scheme are used as is and must therefore be alive as long as the created loader is.

\fBOSSL_STORE_LOADER_get0_engine() returns the engine of the store_loader. \fBOSSL_STORE_LOADER_get0_scheme() returns the scheme of the store_loader.

\fBOSSL_STORE_LOADER_set_open() sets the opener function for the \fIstore_loader.

\fBOSSL_STORE_LOADER_set_open_ex() sets the opener with library context function for the store_loader.

\fBOSSL_STORE_LOADER_set_attach() sets the attacher function for the \fIstore_loader.

\fBOSSL_STORE_LOADER_set_ctrl() sets the control function for the \fIstore_loader.

\fBOSSL_STORE_LOADER_set_expect() sets the expect function for the \fIstore_loader.

\fBOSSL_STORE_LOADER_set_load() sets the loader function for the \fIstore_loader.

\fBOSSL_STORE_LOADER_set_eof() sets the end of file checker function for the \fIstore_loader.

\fBOSSL_STORE_LOADER_set_close() sets the closing function for the \fIstore_loader.

\fBOSSL_STORE_LOADER_free() frees the given store_loader. If the argument is NULL, nothing is done.

\fBOSSL_STORE_register_loader() register the given store_loader and thereby makes it available for use with OSSL_STORE_open(), \fBOSSL_STORE_open_ex(), OSSL_STORE_load(), OSSL_STORE_eof() and OSSL_STORE_close().

\fBOSSL_STORE_unregister_loader() unregister the store loader for the given \fIscheme.

Header "RETURN VALUES" \fBOSSL_STORE_LOADER_fetch() returns a pointer to an OSSL_STORE_LOADER object, or NULL on error.

\fBOSSL_STORE_LOADER_up_ref() returns 1 on success, or 0 on error.

\fBOSSL_STORE_LOADER_names_do_all() returns 1 if the callback was called for all names. A return value of 0 means that the callback was not called for any names.

\fBOSSL_STORE_LOADER_free() doesn't return any value.

\fBOSSL_STORE_LOADER_get0_provider() returns a pointer to a provider object, or NULL on error.

\fBOSSL_STORE_LOADER_get0_properties() returns a pointer to a property definition string, or NULL on error.

\fBOSSL_STORE_LOADER_is_a() returns 1 if loader was identifiable, otherwise 0.

\fBOSSL_STORE_LOADER_get0_description() returns a pointer to a description, or NULL if there isn't one.

The functions with the types OSSL_STORE_open_fn, \fBOSSL_STORE_open_ex_fn, OSSL_STORE_ctrl_fn, \fBOSSL_STORE_expect_fn, OSSL_STORE_load_fn, OSSL_STORE_eof_fn and OSSL_STORE_close_fn have the same return values as OSSL_STORE_open(), \fBOSSL_STORE_open_ex(), OSSL_STORE_ctrl(), OSSL_STORE_expect(), \fBOSSL_STORE_load(), OSSL_STORE_eof() and OSSL_STORE_close(), respectively.

\fBOSSL_STORE_LOADER_new() returns a pointer to a OSSL_STORE_LOADER on success, or NULL on failure.

\fBOSSL_STORE_LOADER_set_open(), OSSL_STORE_LOADER_set_open_ex(), \fBOSSL_STORE_LOADER_set_ctrl(), OSSL_STORE_LOADER_set_load(), \fBOSSL_STORE_LOADER_set_eof() and OSSL_STORE_LOADER_set_close() return 1 on success, or 0 on failure.

\fBOSSL_STORE_register_loader() returns 1 on success, or 0 on failure.

\fBOSSL_STORE_unregister_loader() returns the unregistered loader on success, or NULL on failure.

Header "SEE ALSO" \fBossl_store\|(7), OSSL_STORE_open\|(3), OSSL_LIB_CTX\|(3), \fBprovider-storemgmt\|(7) Header "HISTORY" \fBOSSL_STORE_LOADER_fetch(), OSSL_STORE_LOADER_up_ref(), \fBOSSL_STORE_LOADER_get0_provider(), OSSL_STORE_LOADER_get0_properties(), \fBOSSL_STORE_LOADER_get0_description(), OSSL_STORE_LOADER_is_a(), \fBOSSL_STORE_LOADER_do_all_provided() and OSSL_STORE_LOADER_names_do_all() were added in OpenSSL 3.0.

\fBOSSL_STORE_LOADER and OSSL_STORE_LOADER_free() were added in OpenSSL 1.1.1.

\fBOSSL_STORE_LOADER_set_open_ex() and OSSL_STORE_open_ex_fn() were added in OpenSSL 3.0, and are deprecated.

\fBOSSL_STORE_LOADER_CTX, OSSL_STORE_LOADER_new(), \fBOSSL_STORE_LOADER_set0_scheme(), OSSL_STORE_LOADER_get0_scheme(), \fBOSSL_STORE_LOADER_get0_engine(), OSSL_STORE_LOADER_set_expect(), \fBOSSL_STORE_LOADER_set_find(), OSSL_STORE_LOADER_set_attach(), \fBOSSL_STORE_LOADER_set_open_ex(), OSSL_STORE_LOADER_set_open(), \fBOSSL_STORE_LOADER_set_ctrl(), \fBOSSL_STORE_LOADER_set_load(), OSSL_STORE_LOADER_set_eof(), \fBOSSL_STORE_LOADER_set_close(), \fBOSSL_STORE_register_loader(), OSSL_STORE_LOADER_set_error(), \fBOSSL_STORE_unregister_loader(), OSSL_STORE_open_fn(), OSSL_STORE_ctrl_fn(), \fBOSSL_STORE_load_fn(), OSSL_STORE_eof_fn() and OSSL_STORE_close_fn() were added in OpenSSL 1.1.1, and became deprecated in OpenSSL 3.0.

Header "COPYRIGHT" Copyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.