xref: /freebsd/secure/lib/libcrypto/man/man7/ossl_store.7 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
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 7ossl"
OSSL_STORE 7ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
ossl_store - Store retrieval functions
"SYNOPSIS"
Header "SYNOPSIS" #include <openssl/store.h>
"DESCRIPTION"
Header "DESCRIPTION"
"General"
Subsection "General" A \s-1STORE\s0 is a layer of functionality to retrieve a number of supported objects from a repository of any kind, addressable as a filename or as a \s-1URI.\s0

The functionality supports the pattern \*(L"open a channel to the repository\*(R", \*(L"loop and retrieve one object at a time\*(R", and \*(L"finish up by closing the channel\*(R".

The retrieved objects are returned as a wrapper type \s-1OSSL_STORE_INFO\s0, from which an OpenSSL type can be retrieved.

"\s-1URI\s0 schemes and loaders"
Subsection "URI schemes and loaders" Support for a \s-1URI\s0 scheme is called a \s-1STORE\s0 \*(L"loader\*(R", and can be added dynamically from the calling application or from a loadable engine.

Support for the 'file' scheme is built into \*(C`libcrypto\*(C'. See ossl_store-file\|(7) for more information.

"\s-1UI_METHOD\s0 and pass phrases"
Subsection "UI_METHOD and pass phrases" The \s-1OSS_STORE\s0 \s-1API\s0 does nothing to enforce any specific format or encoding on the pass phrase that the \s-1UI_METHOD\s0 provides. However, the pass phrase is expected to be \s-1UTF-8\s0 encoded. The result of any other encoding is undefined.
"EXAMPLES"
Header "EXAMPLES"
"A generic call"
Subsection "A generic call" .Vb 1 OSSL_STORE_CTX *ctx = OSSL_STORE_open("file:/foo/bar/data.pem"); \& /* * OSSL_STORE_eof() simulates file semantics for any repository to signal * that no more data can be expected */ while (!OSSL_STORE_eof(ctx)) { OSSL_STORE_INFO *info = OSSL_STORE_load(ctx); \& /* * Do whatever is necessary with the OSSL_STORE_INFO, * here just one example */ switch (OSSL_STORE_INFO_get_type(info)) { case OSSL_STORE_INFO_CERT: /* Print the X.509 certificate text */ X509_print_fp(stdout, OSSL_STORE_INFO_get0_CERT(info)); /* Print the X.509 certificate PEM output */ PEM_write_X509(stdout, OSSL_STORE_INFO_get0_CERT(info)); break; } } \& OSSL_STORE_close(ctx); .Ve
"SEE ALSO"
Header "SEE ALSO" \s-1OSSL_STORE_INFO\s0\|(3), \s-1OSSL_STORE_LOADER\s0\|(3), \fBOSSL_STORE_open\|(3), OSSL_STORE_expect\|(3), \s-1OSSL_STORE_SEARCH\s0\|(3)
"COPYRIGHT"
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>.