secure/lib/libcrypto/man/OSSL_STORE_open.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "OSSL_STORE_OPEN 3"
 132 .TH OSSL_STORE_OPEN 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/store.h>
 143 \&
 144 \& typedef struct ossl_store_ctx_st OSSL_STORE_CTX;
 145 \&
 146 \& typedef OSSL_STORE_INFO *(*OSSL_STORE_post_process_info_fn)(OSSL_STORE_INFO *,
 147 \&                                                             void *);
 148 \&
 149 \& OSSL_STORE_CTX *OSSL_STORE_open(const char *uri, const UI_METHOD *ui_method,
 150 \&                                 void *ui_data,
 151 \&                                 OSSL_STORE_post_process_info_fn post_process,
 152 \&                                 void *post_process_data);
 153 \& int OSSL_STORE_ctrl(OSSL_STORE_CTX *ctx, int cmd, ... /* args */);
 154 \& OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx);
 155 \& int OSSL_STORE_eof(OSSL_STORE_CTX *ctx);
 156 \& int OSSL_STORE_error(OSSL_STORE_CTX *ctx);
 157 \& int OSSL_STORE_close(OSSL_STORE_CTX *ctx);
 158 .Ve
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 These functions help the application to fetch supported objects (see
 162 \&\*(L"\s-1SUPPORTED OBJECTS\*(R"\s0 in \s-1\fIOSSL_STORE_INFO\s0\fR\|(3) for information on which those are)
 163 from a given \s-1URI\s0 (see \*(L"\s-1SUPPORTED SCHEMES\*(R"\s0 for more information on
 164 the supported \s-1URI\s0 schemes).
 165 The general method to do so is to \*(L"open\*(R" the \s-1URI\s0 using \fIOSSL_STORE_open()\fR,
 166 read each available and supported object using \fIOSSL_STORE_load()\fR as long as
 167 \&\fIOSSL_STORE_eof()\fR hasn't been reached, and finish it off with \fIOSSL_STORE_close()\fR.
 168 .PP
 169 The retrieved information is stored in a \fB\s-1OSSL_STORE_INFO\s0\fR, which is further
 170 described in \s-1\fIOSSL_STORE_INFO\s0\fR\|(3).
 171 .SS "Types"
 172 .IX Subsection "Types"
 173 \&\fB\s-1OSSL_STORE_CTX\s0\fR is a context variable that holds all the internal
 174 information for \fIOSSL_STORE_open()\fR, \fIOSSL_STORE_load()\fR, \fIOSSL_STORE_eof()\fR and
 175 \&\fIOSSL_STORE_close()\fR to work together.
 176 .SS "Functions"
 177 .IX Subsection "Functions"
 178 \&\fIOSSL_STORE_open()\fR takes a uri or path \fBuri\fR, password \s-1UI\s0 method
 179 \&\fBui_method\fR with associated data \fBui_data\fR, and post processing
 180 callback \fBpost_process\fR with associated data \fBpost_process_data\fR,
 181 opens a channel to the data located at that \s-1URI\s0 and returns a
 182 \&\fB\s-1OSSL_STORE_CTX\s0\fR with all necessary internal information.
 183 The given \fBui_method\fR and \fBui_data_data\fR will be reused by all
 184 functions that use \fB\s-1OSSL_STORE_CTX\s0\fR when interaction is needed.
 185 The given \fBpost_process\fR and \fBpost_process_data\fR will be reused by
 186 \&\fIOSSL_STORE_load()\fR to manipulate or drop the value to be returned.
 187 The \fBpost_process\fR function drops values by returning \fB\s-1NULL\s0\fR, which
 188 will cause \fIOSSL_STORE_load()\fR to start its process over with loading
 189 the next object, until \fBpost_process\fR returns something other than
 190 \&\fB\s-1NULL\s0\fR, or the end of data is reached as indicated by \fIOSSL_STORE_eof()\fR.
 191 .PP
 192 \&\fIOSSL_STORE_ctrl()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, and command number \fBcmd\fR and
 193 more arguments not specified here.
 194 The available loader specific command numbers and arguments they each
 195 take depends on the loader that's used and is documented together with
 196 that loader.
 197 .PP
 198 There are also global controls available:
 199 .IP "\fB\s-1OSSL_STORE_C_USE_SECMEM\s0\fR" 4
 200 .IX Item "OSSL_STORE_C_USE_SECMEM"
 201 Controls if the loader should attempt to use secure memory for any
 202 allocated \fB\s-1OSSL_STORE_INFO\s0\fR and its contents.
 203 This control expects one argument, a pointer to an \fBint\fR that is expected to
 204 have the value 1 (yes) or 0 (no).
 205 Any other value is an error.
 206 .PP
 207 \&\fIOSSL_STORE_load()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, tries to load the next available
 208 object and return it wrapped with  \fB\s-1OSSL_STORE_INFO\s0\fR.
 209 .PP
 210 \&\fIOSSL_STORE_eof()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR and checks if we've reached the end
 211 of data.
 212 .PP
 213 \&\fIOSSL_STORE_error()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR and checks if an error occurred in
 214 the last \fIOSSL_STORE_load()\fR call.
 215 Note that it may still be meaningful to try and load more objects, unless
 216 \&\fIOSSL_STORE_eof()\fR shows that the end of data has been reached.
 217 .PP
 218 \&\fIOSSL_STORE_close()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, closes the channel that was opened
 219 by \fIOSSL_STORE_open()\fR and frees all other information that was stored in the
 220 \&\fB\s-1OSSL_STORE_CTX\s0\fR, as well as the \fB\s-1OSSL_STORE_CTX\s0\fR itself.
 221 .SH "SUPPORTED SCHEMES"
 222 .IX Header "SUPPORTED SCHEMES"
 223 The basic supported scheme is \fBfile:\fR.
 224 Any other scheme can be added dynamically, using
 225 \&\fIOSSL_STORE_register_loader()\fR.
 226 .SH "NOTES"
 227 .IX Header "NOTES"
 228 A string without a scheme prefix (that is, a non-URI string) is
 229 implicitly interpreted as using the \fIfile:\fR scheme.
 230 .PP
 231 There are some tools that can be used together with
 232 \&\fIOSSL_STORE_open()\fR to determine if any failure is caused by an unparsable
 233 \&\s-1URI,\s0 or if it's a different error (such as memory allocation
 234 failures); if the \s-1URI\s0 was parsable but the scheme unregistered, the
 235 top error will have the reason \f(CW\*(C`OSSL_STORE_R_UNREGISTERED_SCHEME\*(C'\fR.
 236 .PP
 237 These functions make no direct assumption regarding the pass phrase received
 238 from the password callback.
 239 The loaders may make assumptions, however.
 240 For example, the \fBfile:\fR scheme loader inherits the assumptions made by
 241 OpenSSL functionality that handles the different file types; this is mostly
 242 relevant for PKCS#12 objects.
 243 See \fIpassphrase\-encoding\fR\|(7) for further information.
 244 .SH "RETURN VALUES"
 245 .IX Header "RETURN VALUES"
 246 \&\fIOSSL_STORE_open()\fR returns a pointer to a \fB\s-1OSSL_STORE_CTX\s0\fR on success, or
 247 \&\fB\s-1NULL\s0\fR on failure.
 248 .PP
 249 \&\fIOSSL_STORE_load()\fR returns a pointer to a \fB\s-1OSSL_STORE_INFO\s0\fR on success, or
 250 \&\fB\s-1NULL\s0\fR on error or when end of data is reached.
 251 Use \fIOSSL_STORE_error()\fR and \fIOSSL_STORE_eof()\fR to determine the meaning of a
 252 returned \fB\s-1NULL\s0\fR.
 253 .PP
 254 \&\fIOSSL_STORE_eof()\fR returns 1 if the end of data has been reached, otherwise
 255 0.
 256 .PP
 257 \&\fIOSSL_STORE_error()\fR returns 1 if an error occurred in an \fIOSSL_STORE_load()\fR call,
 258 otherwise 0.
 259 .PP
 260 \&\fIOSSL_STORE_ctrl()\fR and \fIOSSL_STORE_close()\fR returns 1 on success, or 0 on failure.
 261 .SH "SEE ALSO"
 262 .IX Header "SEE ALSO"
 263 \&\fIossl_store\fR\|(7), \s-1\fIOSSL_STORE_INFO\s0\fR\|(3), \fIOSSL_STORE_register_loader\fR\|(3),
 264 \&\fIpassphrase\-encoding\fR\|(7)
 265 .SH "HISTORY"
 266 .IX Header "HISTORY"
 267 \&\s-1\fIOSSL_STORE_CTX\s0()\fR, \fIOSSL_STORE_post_process_info_fn()\fR, \fIOSSL_STORE_open()\fR,
 268 \&\fIOSSL_STORE_ctrl()\fR, \fIOSSL_STORE_load()\fR, \fIOSSL_STORE_eof()\fR and \fIOSSL_STORE_close()\fR
 269 were added to OpenSSL 1.1.1.
 270 .SH "COPYRIGHT"
 271 .IX Header "COPYRIGHT"
 272 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
 273 .PP
 274 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 275 this file except in compliance with the License.  You can obtain a copy
 276 in the file \s-1LICENSE\s0 in the source distribution or at
 277 <https://www.openssl.org/source/license.html>.