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
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
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 3"
way too many mistakes in technical documents.
The retrieved information is stored in a \s-1OSSL_STORE_INFO\s0, which is further described in \s-1OSSL_STORE_INFO\s0\|(3).
\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:
\fBOSSL_STORE_load() takes a \s-1OSSL_STORE_CTX\s0, 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.
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.
\fBOSSL_STORE_load() returns a pointer to a \s-1OSSL_STORE_INFO\s0 on success, or \fB\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, otherwise 0.
\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.
Licensed under the OpenSSL license (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>.