Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

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

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OSSL_STORE_OPEN 3ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
OSSL_STORE_CTX, OSSL_STORE_post_process_info_fn, OSSL_STORE_open, OSSL_STORE_open_ex, OSSL_STORE_ctrl, OSSL_STORE_load, OSSL_STORE_eof, OSSL_STORE_error, OSSL_STORE_close \- Types and functions to read objects from a URI Header "SYNOPSIS" .Vb 1 #include <openssl/store.h> \& typedef struct ossl_store_ctx_st OSSL_STORE_CTX; \& typedef OSSL_STORE_INFO *(*OSSL_STORE_post_process_info_fn)(OSSL_STORE_INFO *, void *); \& OSSL_STORE_CTX *OSSL_STORE_open(const char *uri, const UI_METHOD *ui_method, void *ui_data, OSSL_STORE_post_process_info_fn post_process, void *post_process_data); OSSL_STORE_CTX * OSSL_STORE_open_ex(const char *uri, OSSL_LIB_CTX *libctx, const char *propq, const UI_METHOD *ui_method, void *ui_data, const OSSL_PARAM params[], OSSL_STORE_post_process_info_fn post_process, void *post_process_data); \& OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx); int OSSL_STORE_eof(OSSL_STORE_CTX *ctx); int OSSL_STORE_error(OSSL_STORE_CTX *ctx); int OSSL_STORE_close(OSSL_STORE_CTX *ctx); .Ve

The following function has been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):

.Vb 1 int OSSL_STORE_ctrl(OSSL_STORE_CTX *ctx, int cmd, ... /* args */); .Ve

Header "DESCRIPTION" These functions help the application to fetch supported objects (see \*(L"\s-1SUPPORTED OBJECTS\*(R"\s0 in \s-1OSSL_STORE_INFO\s0\|(3) for information on which those are) from a given \s-1URI.\s0 The general method to do so is to \*(L"open\*(R" the \s-1URI\s0 using OSSL_STORE_open(), read each available and supported object using OSSL_STORE_load() as long as \fBOSSL_STORE_eof() hasn't been reached, and finish it off with OSSL_STORE_close().

The retrieved information is stored in a \s-1OSSL_STORE_INFO\s0, which is further described in \s-1OSSL_STORE_INFO\s0\|(3).

Subsection "Types" \fB\s-1OSSL_STORE_CTX\s0 is a context variable that holds all the internal information for OSSL_STORE_open(), OSSL_STORE_open_ex(), \fBOSSL_STORE_load(), OSSL_STORE_eof() and OSSL_STORE_close() to work together. Subsection "Functions" \fBOSSL_STORE_open_ex() takes a uri or path uri, password \s-1UI\s0 method \fIui_method with associated data ui_data, and post processing callback post_process with associated data post_process_data, a library context libctx with an associated property query propq, and opens a channel to the data located at the \s-1URI\s0 and returns a \fB\s-1OSSL_STORE_CTX\s0 with all necessary internal information. The given ui_method and ui_data will be reused by all functions that use \s-1OSSL_STORE_CTX\s0 when interaction is needed, for instance to provide a password. The auxiliary \s-1OSSL_PARAM\s0\|(3) parameters in params can be set to further modify the store operation. The given post_process and post_process_data will be reused by \fBOSSL_STORE_load() to manipulate or drop the value to be returned. The post_process function drops values by returning \s-1NULL,\s0 which will cause OSSL_STORE_load() to start its process over with loading the next object, until post_process returns something other than \s-1NULL,\s0 or the end of data is reached as indicated by OSSL_STORE_eof().

\fBOSSL_STORE_open() is similar to OSSL_STORE_open_ex() but uses \s-1NULL\s0 for the params, the library context libctx and property query propq.

\fBOSSL_STORE_ctrl() takes a \s-1OSSL_STORE_CTX\s0, and command number cmd and more arguments not specified here. The available loader specific command numbers and arguments they each take depends on the loader that's used and is documented together with that loader.

There are also global controls available:

Item "OSSL_STORE_C_USE_SECMEM" Controls if the loader should attempt to use secure memory for any allocated \s-1OSSL_STORE_INFO\s0 and its contents. This control expects one argument, a pointer to an int that is expected to have the value 1 (yes) or 0 (no). Any other value is an error.

\fBOSSL_STORE_load() takes a \s-1OSSL_STORE_CTX\s0 and tries to load the next available object and return it wrapped with \s-1OSSL_STORE_INFO\s0.

\fBOSSL_STORE_eof() takes a \s-1OSSL_STORE_CTX\s0 and checks if we've reached the end of data.

\fBOSSL_STORE_error() takes a \s-1OSSL_STORE_CTX\s0 and checks if an error occurred in the last OSSL_STORE_load() call. Note that it may still be meaningful to try and load more objects, unless \fBOSSL_STORE_eof() shows that the end of data has been reached.

\fBOSSL_STORE_close() takes a \s-1OSSL_STORE_CTX\s0, closes the channel that was opened by OSSL_STORE_open() and frees all other information that was stored in the \fB\s-1OSSL_STORE_CTX\s0, as well as the \s-1OSSL_STORE_CTX\s0 itself. If ctx is \s-1NULL\s0 it does nothing.

Header "NOTES" A string without a scheme prefix (that is, a non-URI string) is implicitly interpreted as using the file: scheme.

There are some tools that can be used together with \fBOSSL_STORE_open() to determine if any failure is caused by an unparsable \s-1URI,\s0 or if it's a different error (such as memory allocation failures); if the \s-1URI\s0 was parsable but the scheme unregistered, the top error will have the reason \*(C`OSSL_STORE_R_UNREGISTERED_SCHEME\*(C'.

These functions make no direct assumption regarding the pass phrase received from the password callback. The loaders may make assumptions, however. For example, the file: scheme loader inherits the assumptions made by OpenSSL functionality that handles the different file types; this is mostly relevant for PKCS#12 objects. See passphrase-encoding\|(7) for further information.

Header "RETURN VALUES" \fBOSSL_STORE_open() returns a pointer to a \s-1OSSL_STORE_CTX\s0 on success, or \s-1NULL\s0 on failure.

\fBOSSL_STORE_load() returns a pointer to a \s-1OSSL_STORE_INFO\s0 on success, or \s-1NULL\s0 on error or when end of data is reached. Use OSSL_STORE_error() and OSSL_STORE_eof() to determine the meaning of a returned \s-1NULL.\s0

\fBOSSL_STORE_eof() returns 1 if the end of data has been reached or an error occurred, 0 otherwise.

\fBOSSL_STORE_error() returns 1 if an error occurred in an OSSL_STORE_load() call, otherwise 0.

\fBOSSL_STORE_ctrl() and OSSL_STORE_close() returns 1 on success, or 0 on failure.

Header "SEE ALSO" \fBossl_store\|(7), \s-1OSSL_STORE_INFO\s0\|(3), OSSL_STORE_register_loader\|(3), \fBpassphrase-encoding\|(7) Header "HISTORY" \fBOSSL_STORE_open_ex() was added in OpenSSL 3.0.

\fB\s-1OSSL_STORE_CTX\s0, OSSL_STORE_post_process_info_fn(), OSSL_STORE_open(), \fBOSSL_STORE_ctrl(), OSSL_STORE_load(), OSSL_STORE_eof() and OSSL_STORE_close() were added in OpenSSL 1.1.1.

Handling of \s-1NULL\s0 ctx argument for OSSL_STORE_close() was introduced in OpenSSL 1.1.1h.

\fBOSSL_STORE_open_ex() was added in OpenSSL 3.0.

\fBOSSL_STORE_ctrl() and OSSL_STORE_vctrl() were deprecated in OpenSSL 3.0.

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

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