doc/man3/OSSL_STORE_open.pod

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