1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "OSSL_STORE 7"
136 .TH OSSL_STORE 7 "2021-08-24" "1.1.1l" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 ossl_store \- Store retrieval functions
144 .IX Header "SYNOPSIS"
145 #include <openssl/store.h>
147 .IX Header "DESCRIPTION"
149 .IX Subsection "General"
150 A \s-1STORE\s0 is a layer of functionality to retrieve a number of supported
151 objects from a repository of any kind, addressable as a filename or
154 The functionality supports the pattern \*(L"open a channel to the
155 repository\*(R", \*(L"loop and retrieve one object at a time\*(R", and \*(L"finish up
156 by closing the channel\*(R".
158 The retrieved objects are returned as a wrapper type \fB\s-1OSSL_STORE_INFO\s0\fR,
159 from which an OpenSSL type can be retrieved.
160 .SS "\s-1URI\s0 schemes and loaders"
161 .IX Subsection "URI schemes and loaders"
162 Support for a \s-1URI\s0 scheme is called a \s-1STORE\s0 \*(L"loader\*(R", and can be added
163 dynamically from the calling application or from a loadable engine.
165 Support for the 'file' scheme is built into \f(CW\*(C`libcrypto\*(C'\fR.
166 See \fBossl_store\-file\fR\|(7) for more information.
167 .SS "\s-1UI_METHOD\s0 and pass phrases"
168 .IX Subsection "UI_METHOD and pass phrases"
169 The \fB\s-1OSS_STORE\s0\fR \s-1API\s0 does nothing to enforce any specific format or
170 encoding on the pass phrase that the \fB\s-1UI_METHOD\s0\fR provides. However,
171 the pass phrase is expected to be \s-1UTF\-8\s0 encoded. The result of any
172 other encoding is undefined.
174 .IX Header "EXAMPLES"
176 .IX Subsection "A generic call"
178 \& OSSL_STORE_CTX *ctx = OSSL_STORE_open("file:/foo/bar/data.pem");
181 \& * OSSL_STORE_eof() simulates file semantics for any repository to signal
182 \& * that no more data can be expected
184 \& while (!OSSL_STORE_eof(ctx)) {
185 \& OSSL_STORE_INFO *info = OSSL_STORE_load(ctx);
188 \& * Do whatever is necessary with the OSSL_STORE_INFO,
189 \& * here just one example
191 \& switch (OSSL_STORE_INFO_get_type(info)) {
192 \& case OSSL_STORE_INFO_X509:
193 \& /* Print the X.509 certificate text */
194 \& X509_print_fp(stdout, OSSL_STORE_INFO_get0_CERT(info));
195 \& /* Print the X.509 certificate PEM output */
196 \& PEM_write_X509(stdout, OSSL_STORE_INFO_get0_CERT(info));
201 \& OSSL_STORE_close(ctx);
204 .IX Header "SEE ALSO"
205 \&\s-1\fBOSSL_STORE_INFO\s0\fR\|(3), \s-1\fBOSSL_STORE_LOADER\s0\fR\|(3),
206 \&\fBOSSL_STORE_open\fR\|(3), \fBOSSL_STORE_expect\fR\|(3),
207 \&\s-1\fBOSSL_STORE_SEARCH\s0\fR\|(3)
209 .IX Header "COPYRIGHT"
210 Copyright 2016\-2020 The OpenSSL Project Authors. All Rights Reserved.
212 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
213 this file except in compliance with the License. You can obtain a copy
214 in the file \s-1LICENSE\s0 in the source distribution or at
215 <https://www.openssl.org/source/license.html>.