doc/man3/OSSL_STORE_open.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_STORE_CTX, OSSL_STORE_post_process_info_fn,
   6 OSSL_STORE_open, OSSL_STORE_open_ex,
   7 OSSL_STORE_ctrl, OSSL_STORE_load, OSSL_STORE_eof,
   8 OSSL_STORE_error, OSSL_STORE_close
   9 - Types and functions to read objects from a URI
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/store.h>
  14
  15  typedef struct ossl_store_ctx_st OSSL_STORE_CTX;
  16
  17  typedef OSSL_STORE_INFO *(*OSSL_STORE_post_process_info_fn)(OSSL_STORE_INFO *,
  18                                                              void *);
  19
  20  OSSL_STORE_CTX *OSSL_STORE_open(const char *uri, const UI_METHOD *ui_method,
  21                                  void *ui_data,
  22                                  OSSL_STORE_post_process_info_fn post_process,
  23                                  void *post_process_data);
  24  OSSL_STORE_CTX *
  25  OSSL_STORE_open_ex(const char *uri, OSSL_LIB_CTX *libctx, const char *propq,
  26                     const UI_METHOD *ui_method, void *ui_data,
  27                     OSSL_STORE_post_process_info_fn post_process,
  28                     void *post_process_data);
  29
  30  OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx);
  31  int OSSL_STORE_eof(OSSL_STORE_CTX *ctx);
  32  int OSSL_STORE_error(OSSL_STORE_CTX *ctx);
  33  int OSSL_STORE_close(OSSL_STORE_CTX *ctx);
  34
  35 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  36 B<OPENSSL_API_COMPAT> with a suitable version value, see
  37 L<openssl_user_macros(7)>:
  38
  39  int OSSL_STORE_ctrl(OSSL_STORE_CTX *ctx, int cmd, ... /* args */);
  40
  41 =head1 DESCRIPTION
  42
  43 These functions help the application to fetch supported objects (see
  44 L<OSSL_STORE_INFO(3)/SUPPORTED OBJECTS> for information on which those are)
  45 from a given URI.
  46 The general method to do so is to "open" the URI using OSSL_STORE_open(),
  47 read each available and supported object using OSSL_STORE_load() as long as
  48 OSSL_STORE_eof() hasn't been reached, and finish it off with OSSL_STORE_close().
  49
  50 The retrieved information is stored in a B<OSSL_STORE_INFO>, which is further
  51 described in L<OSSL_STORE_INFO(3)>.
  52
  53 =head2 Types
  54
  55 B<OSSL_STORE_CTX> is a context variable that holds all the internal
  56 information for OSSL_STORE_open(), OSSL_STORE_open_ex(),
  57 OSSL_STORE_load(), OSSL_STORE_eof() and OSSL_STORE_close() to work
  58 together.
  59
  60 =head2 Functions
  61
  62 OSSL_STORE_open_ex() takes a uri or path I<uri>, password UI method
  63 I<ui_method> with associated data I<ui_data>, and post processing
  64 callback I<post_process> with associated data I<post_process_data>,
  65 a library context I<libctx> with an associated property query I<propq>,
  66 and opens a channel to the data located at the URI and returns a
  67 B<OSSL_STORE_CTX> with all necessary internal information.
  68 The given I<ui_method> and I<ui_data> will be reused by all
  69 functions that use B<OSSL_STORE_CTX> when interaction is needed,
  70 for instance to provide a password.
  71 The given I<post_process> and I<post_process_data> will be reused by
  72 OSSL_STORE_load() to manipulate or drop the value to be returned.
  73 The I<post_process> function drops values by returning NULL, which
  74 will cause OSSL_STORE_load() to start its process over with loading
  75 the next object, until I<post_process> returns something other than
  76 NULL, or the end of data is reached as indicated by OSSL_STORE_eof().
  77
  78 OSSL_STORE_open() is similar to OSSL_STORE_open_ex() but uses NULL for
  79 the library context I<libctx> and property query I<propq>.
  80
  81 OSSL_STORE_ctrl() takes a B<OSSL_STORE_CTX>, and command number I<cmd> and
  82 more arguments not specified here.
  83 The available loader specific command numbers and arguments they each
  84 take depends on the loader that's used and is documented together with
  85 that loader.
  86
  87 There are also global controls available:
  88
  89 =over 4
  90
  91 =item B<OSSL_STORE_C_USE_SECMEM>
  92
  93 Controls if the loader should attempt to use secure memory for any
  94 allocated B<OSSL_STORE_INFO> and its contents.
  95 This control expects one argument, a pointer to an I<int> that is expected to
  96 have the value 1 (yes) or 0 (no).
  97 Any other value is an error.
  98
  99 =back
 100
 101 OSSL_STORE_load() takes a B<OSSL_STORE_CTX> and tries to load the next
 102 available object and return it wrapped with B<OSSL_STORE_INFO>.
 103
 104 OSSL_STORE_eof() takes a B<OSSL_STORE_CTX> and checks if we've reached the end
 105 of data.
 106
 107 OSSL_STORE_error() takes a B<OSSL_STORE_CTX> and checks if an error occurred in
 108 the last OSSL_STORE_load() call.
 109 Note that it may still be meaningful to try and load more objects, unless
 110 OSSL_STORE_eof() shows that the end of data has been reached.
 111
 112 OSSL_STORE_close() takes a B<OSSL_STORE_CTX>, closes the channel that was opened
 113 by OSSL_STORE_open() and frees all other information that was stored in the
 114 B<OSSL_STORE_CTX>, as well as the B<OSSL_STORE_CTX> itself.
 115 If I<ctx> is NULL it does nothing.
 116
 117 =head1 NOTES
 118
 119 A string without a scheme prefix (that is, a non-URI string) is
 120 implicitly interpreted as using the F<file:> scheme.
 121
 122 There are some tools that can be used together with
 123 OSSL_STORE_open() to determine if any failure is caused by an unparsable
 124 URI, or if it's a different error (such as memory allocation
 125 failures); if the URI was parsable but the scheme unregistered, the
 126 top error will have the reason C<OSSL_STORE_R_UNREGISTERED_SCHEME>.
 127
 128 These functions make no direct assumption regarding the pass phrase received
 129 from the password callback.
 130 The loaders may make assumptions, however.
 131 For example, the B<file:> scheme loader inherits the assumptions made by
 132 OpenSSL functionality that handles the different file types; this is mostly
 133 relevant for PKCS#12 objects.
 134 See L<passphrase-encoding(7)> for further information.
 135
 136 =head1 RETURN VALUES
 137
 138 OSSL_STORE_open() returns a pointer to a B<OSSL_STORE_CTX> on success, or
 139 NULL on failure.
 140
 141 OSSL_STORE_load() returns a pointer to a B<OSSL_STORE_INFO> on success, or NULL
 142 on error or when end of data is reached.
 143 Use OSSL_STORE_error() and OSSL_STORE_eof() to determine the meaning of a
 144 returned NULL.
 145
 146 OSSL_STORE_eof() returns 1 if the end of data has been reached, otherwise
 147 0.
 148
 149 OSSL_STORE_error() returns 1 if an error occurred in an OSSL_STORE_load() call,
 150 otherwise 0.
 151
 152 OSSL_STORE_ctrl() and OSSL_STORE_close() returns 1 on success, or 0 on failure.
 153
 154 =head1 SEE ALSO
 155
 156 L<ossl_store(7)>, L<OSSL_STORE_INFO(3)>, L<OSSL_STORE_register_loader(3)>,
 157 L<passphrase-encoding(7)>
 158
 159 =head1 HISTORY
 160
 161 OSSL_STORE_open_ex() was added in OpenSSL 3.0.
 162
 163 B<OSSL_STORE_CTX>, OSSL_STORE_post_process_info_fn(), OSSL_STORE_open(),
 164 OSSL_STORE_ctrl(), OSSL_STORE_load(), OSSL_STORE_eof() and OSSL_STORE_close()
 165 were added in OpenSSL 1.1.1.
 166
 167 Handling of NULL I<ctx> argument for OSSL_STORE_close()
 168 was introduced in OpenSSL 1.1.1h.
 169
 170 OSSL_STORE_open_ex() was added in OpenSSL 3.0.
 171
 172 OSSL_STORE_ctrl() and OSSL_STORE_vctrl() were deprecated in OpenSSL 3.0.
 173
 174 =head1 COPYRIGHT
 175
 176 Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
 177
 178 Licensed under the Apache License 2.0 (the "License").  You may not use
 179 this file except in compliance with the License.  You can obtain a copy
 180 in the file LICENSE in the source distribution or at
 181 L<https://www.openssl.org/source/license.html>.
 182
 183 =cut