secure/lib/libcrypto/man/man3/OSSL_STORE_open.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  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<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  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
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  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.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  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
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  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'
 105 .\}
 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 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "OSSL_STORE_OPEN 3"
 136 .TH OSSL_STORE_OPEN 3 "2020-09-22" "1.1.1h" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 OSSL_STORE_CTX, OSSL_STORE_post_process_info_fn, OSSL_STORE_open, OSSL_STORE_ctrl, OSSL_STORE_load, OSSL_STORE_eof, OSSL_STORE_error, OSSL_STORE_close \- Types and functions to read objects from a URI
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/store.h>
 147 \&
 148 \& typedef struct ossl_store_ctx_st OSSL_STORE_CTX;
 149 \&
 150 \& typedef OSSL_STORE_INFO *(*OSSL_STORE_post_process_info_fn)(OSSL_STORE_INFO *,
 151 \&                                                             void *);
 152 \&
 153 \& OSSL_STORE_CTX *OSSL_STORE_open(const char *uri, const UI_METHOD *ui_method,
 154 \&                                 void *ui_data,
 155 \&                                 OSSL_STORE_post_process_info_fn post_process,
 156 \&                                 void *post_process_data);
 157 \& int OSSL_STORE_ctrl(OSSL_STORE_CTX *ctx, int cmd, ... /* args */);
 158 \& OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx);
 159 \& int OSSL_STORE_eof(OSSL_STORE_CTX *ctx);
 160 \& int OSSL_STORE_error(OSSL_STORE_CTX *ctx);
 161 \& int OSSL_STORE_close(OSSL_STORE_CTX *ctx);
 162 .Ve
 163 .SH "DESCRIPTION"
 164 .IX Header "DESCRIPTION"
 165 These functions help the application to fetch supported objects (see
 166 \&\*(L"\s-1SUPPORTED OBJECTS\*(R"\s0 in \s-1\fBOSSL_STORE_INFO\s0\fR\|(3) for information on which those are)
 167 from a given \s-1URI\s0 (see \*(L"\s-1SUPPORTED SCHEMES\*(R"\s0 for more information on
 168 the supported \s-1URI\s0 schemes).
 169 The general method to do so is to \*(L"open\*(R" the \s-1URI\s0 using \fBOSSL_STORE_open()\fR,
 170 read each available and supported object using \fBOSSL_STORE_load()\fR as long as
 171 \&\fBOSSL_STORE_eof()\fR hasn't been reached, and finish it off with \fBOSSL_STORE_close()\fR.
 172 .PP
 173 The retrieved information is stored in a \fB\s-1OSSL_STORE_INFO\s0\fR, which is further
 174 described in \s-1\fBOSSL_STORE_INFO\s0\fR\|(3).
 175 .SS "Types"
 176 .IX Subsection "Types"
 177 \&\fB\s-1OSSL_STORE_CTX\s0\fR is a context variable that holds all the internal
 178 information for \fBOSSL_STORE_open()\fR, \fBOSSL_STORE_load()\fR, \fBOSSL_STORE_eof()\fR and
 179 \&\fBOSSL_STORE_close()\fR to work together.
 180 .SS "Functions"
 181 .IX Subsection "Functions"
 182 \&\fBOSSL_STORE_open()\fR takes a uri or path \fIuri\fR, password \s-1UI\s0 method
 183 \&\fIui_method\fR with associated data \fIui_data\fR, and post processing
 184 callback \fIpost_process\fR with associated data \fIpost_process_data\fR,
 185 opens a channel to the data located at that \s-1URI\s0 and returns a
 186 \&\fB\s-1OSSL_STORE_CTX\s0\fR with all necessary internal information.
 187 The given \fIui_method\fR and \fIui_data\fR will be reused by all
 188 functions that use \fB\s-1OSSL_STORE_CTX\s0\fR when interaction is needed,
 189 for instance to provide a password.
 190 The given \fIpost_process\fR and \fIpost_process_data\fR will be reused by
 191 \&\fBOSSL_STORE_load()\fR to manipulate or drop the value to be returned.
 192 The \fIpost_process\fR function drops values by returning \s-1NULL,\s0 which
 193 will cause \fBOSSL_STORE_load()\fR to start its process over with loading
 194 the next object, until \fIpost_process\fR returns something other than
 195 \&\s-1NULL,\s0 or the end of data is reached as indicated by \fBOSSL_STORE_eof()\fR.
 196 .PP
 197 \&\fBOSSL_STORE_ctrl()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, and command number \fIcmd\fR and
 198 more arguments not specified here.
 199 The available loader specific command numbers and arguments they each
 200 take depends on the loader that's used and is documented together with
 201 that loader.
 202 .PP
 203 There are also global controls available:
 204 .IP "\fB\s-1OSSL_STORE_C_USE_SECMEM\s0\fR" 4
 205 .IX Item "OSSL_STORE_C_USE_SECMEM"
 206 Controls if the loader should attempt to use secure memory for any
 207 allocated \fB\s-1OSSL_STORE_INFO\s0\fR and its contents.
 208 This control expects one argument, a pointer to an \fBint\fR that is expected to
 209 have the value 1 (yes) or 0 (no).
 210 Any other value is an error.
 211 .PP
 212 \&\fBOSSL_STORE_load()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, tries to load the next available
 213 object and return it wrapped with  \fB\s-1OSSL_STORE_INFO\s0\fR.
 214 .PP
 215 \&\fBOSSL_STORE_eof()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR and checks if we've reached the end
 216 of data.
 217 .PP
 218 \&\fBOSSL_STORE_error()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR and checks if an error occurred in
 219 the last \fBOSSL_STORE_load()\fR call.
 220 Note that it may still be meaningful to try and load more objects, unless
 221 \&\fBOSSL_STORE_eof()\fR shows that the end of data has been reached.
 222 .PP
 223 \&\fBOSSL_STORE_close()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, closes the channel that was opened
 224 by \fBOSSL_STORE_open()\fR and frees all other information that was stored in the
 225 \&\fB\s-1OSSL_STORE_CTX\s0\fR, as well as the \fB\s-1OSSL_STORE_CTX\s0\fR itself.
 226 If \fIctx\fR is \s-1NULL\s0 it does nothing.
 227 .SH "SUPPORTED SCHEMES"
 228 .IX Header "SUPPORTED SCHEMES"
 229 The basic supported scheme is \fBfile:\fR.
 230 Any other scheme can be added dynamically, using
 231 \&\fBOSSL_STORE_register_loader()\fR.
 232 .SH "NOTES"
 233 .IX Header "NOTES"
 234 A string without a scheme prefix (that is, a non-URI string) is
 235 implicitly interpreted as using the \fIfile:\fR scheme.
 236 .PP
 237 There are some tools that can be used together with
 238 \&\fBOSSL_STORE_open()\fR to determine if any failure is caused by an unparsable
 239 \&\s-1URI,\s0 or if it's a different error (such as memory allocation
 240 failures); if the \s-1URI\s0 was parsable but the scheme unregistered, the
 241 top error will have the reason \f(CW\*(C`OSSL_STORE_R_UNREGISTERED_SCHEME\*(C'\fR.
 242 .PP
 243 These functions make no direct assumption regarding the pass phrase received
 244 from the password callback.
 245 The loaders may make assumptions, however.
 246 For example, the \fBfile:\fR scheme loader inherits the assumptions made by
 247 OpenSSL functionality that handles the different file types; this is mostly
 248 relevant for PKCS#12 objects.
 249 See \fBpassphrase\-encoding\fR\|(7) for further information.
 250 .SH "RETURN VALUES"
 251 .IX Header "RETURN VALUES"
 252 \&\fBOSSL_STORE_open()\fR returns a pointer to a \fB\s-1OSSL_STORE_CTX\s0\fR on success, or
 253 \&\s-1NULL\s0 on failure.
 254 .PP
 255 \&\fBOSSL_STORE_load()\fR returns a pointer to a \fB\s-1OSSL_STORE_INFO\s0\fR on success, or
 256 \&\s-1NULL\s0 on error or when end of data is reached.
 257 Use \fBOSSL_STORE_error()\fR and \fBOSSL_STORE_eof()\fR to determine the meaning of a
 258 returned \s-1NULL.\s0
 259 .PP
 260 \&\fBOSSL_STORE_eof()\fR returns 1 if the end of data has been reached, otherwise
 261 0.
 262 .PP
 263 \&\fBOSSL_STORE_error()\fR returns 1 if an error occurred in an \fBOSSL_STORE_load()\fR call,
 264 otherwise 0.
 265 .PP
 266 \&\fBOSSL_STORE_ctrl()\fR and \fBOSSL_STORE_close()\fR returns 1 on success, or 0 on failure.
 267 .SH "SEE ALSO"
 268 .IX Header "SEE ALSO"
 269 \&\fBossl_store\fR\|(7), \s-1\fBOSSL_STORE_INFO\s0\fR\|(3), \fBOSSL_STORE_register_loader\fR\|(3),
 270 \&\fBpassphrase\-encoding\fR\|(7)
 271 .SH "HISTORY"
 272 .IX Header "HISTORY"
 273 \&\s-1\fBOSSL_STORE_CTX\s0()\fR, \fBOSSL_STORE_post_process_info_fn()\fR, \fBOSSL_STORE_open()\fR,
 274 \&\fBOSSL_STORE_ctrl()\fR, \fBOSSL_STORE_load()\fR, \fBOSSL_STORE_eof()\fR and \fBOSSL_STORE_close()\fR
 275 were added in OpenSSL 1.1.1.
 276 .PP
 277 Handling of \s-1NULL\s0 \fIctx\fR argument for \fBOSSL_STORE_close()\fR
 278 was introduced in OpenSSL 1.1.1h.
 279 .SH "COPYRIGHT"
 280 .IX Header "COPYRIGHT"
 281 Copyright 2016\-2020 The OpenSSL Project Authors. All Rights Reserved.
 282 .PP
 283 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 284 this file except in compliance with the License.  You can obtain a copy
 285 in the file \s-1LICENSE\s0 in the source distribution or at
 286 <https://www.openssl.org/source/license.html>.