doc/man3/OSSL_STORE_INFO.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_STORE_INFO, OSSL_STORE_INFO_get_type, OSSL_STORE_INFO_get0_NAME,
   6 OSSL_STORE_INFO_get0_NAME_description, OSSL_STORE_INFO_get0_PARAMS,
   7 OSSL_STORE_INFO_get0_PKEY, OSSL_STORE_INFO_get0_CERT, OSSL_STORE_INFO_get0_CRL,
   8 OSSL_STORE_INFO_get1_NAME, OSSL_STORE_INFO_get1_NAME_description,
   9 OSSL_STORE_INFO_get1_PARAMS, OSSL_STORE_INFO_get1_PKEY,
  10 OSSL_STORE_INFO_get1_CERT,
  11 OSSL_STORE_INFO_get1_CRL, OSSL_STORE_INFO_type_string, OSSL_STORE_INFO_free,
  12 OSSL_STORE_INFO_new_NAME, OSSL_STORE_INFO_set0_NAME_description,
  13 OSSL_STORE_INFO_new_PARAMS, OSSL_STORE_INFO_new_PKEY, OSSL_STORE_INFO_new_CERT,
  14 OSSL_STORE_INFO_new_CRL - Functions to manipulate OSSL_STORE_INFO objects
  15
  16 =head1 SYNOPSIS
  17
  18  #include <openssl/store.h>
  19
  20  typedef struct ossl_store_info_st OSSL_STORE_INFO;
  21
  22  int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO *store_info);
  23  const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO *store_info);
  24  char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO *store_info);
  25  const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO
  26                                                    *store_info);
  27  char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO *store_info);
  28  EVP_PKEY *OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO *store_info);
  29  EVP_PKEY *OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO *store_info);
  30  EVP_PKEY *OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO *store_info);
  31  EVP_PKEY *OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO *store_info);
  32  X509 *OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO *store_info);
  33  X509 *OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO *store_info);
  34  X509_CRL *OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO *store_info);
  35  X509_CRL *OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO *store_info);
  36
  37  const char *OSSL_STORE_INFO_type_string(int type);
  38
  39  void OSSL_STORE_INFO_free(OSSL_STORE_INFO *store_info);
  40
  41  OSSL_STORE_INFO *OSSL_STORE_INFO_new_NAME(char *name);
  42  int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO *info, char *desc);
  43  OSSL_STORE_INFO *OSSL_STORE_INFO_new_PARAMS(DSA *dsa_params);
  44  OSSL_STORE_INFO *OSSL_STORE_INFO_new_PKEY(EVP_PKEY *pkey);
  45  OSSL_STORE_INFO *OSSL_STORE_INFO_new_CERT(X509 *x509);
  46  OSSL_STORE_INFO *OSSL_STORE_INFO_new_CRL(X509_CRL *crl);
  47
  48 =head1 DESCRIPTION
  49
  50 These functions are primarily useful for applications to retrieve
  51 supported objects from B<OSSL_STORE_INFO> objects and for scheme specific
  52 loaders to create B<OSSL_STORE_INFO> holders.
  53
  54 =head2 Types
  55
  56 B<OSSL_STORE_INFO> is an opaque type that's just an intermediary holder for
  57 the objects that have been retrieved by OSSL_STORE_load() and similar functions.
  58 Supported OpenSSL type object can be extracted using one of
  59 STORE_INFO_get0_<TYPE>() where <TYPE> can be NAME, PARAMS, PKEY, CERT, or CRL.
  60 The life time of this extracted object is as long as the life time of
  61 the B<OSSL_STORE_INFO> it was extracted from, so care should be taken not
  62 to free the latter too early.
  63 As an alternative, STORE_INFO_get1_<TYPE>() extracts a duplicate (or the
  64 same object with its reference count increased), which can be used
  65 after the containing B<OSSL_STORE_INFO> has been freed.
  66 The object returned by STORE_INFO_get1_<TYPE>() must be freed separately
  67 by the caller.
  68 See L</SUPPORTED OBJECTS> for more information on the types that are supported.
  69
  70 =head2 Functions
  71
  72 OSSL_STORE_INFO_get_type() takes a B<OSSL_STORE_INFO> and returns the STORE
  73 type number for the object inside.
  74
  75 STORE_INFO_get_type_string() takes a STORE type number and returns a
  76 short string describing it.
  77
  78 OSSL_STORE_INFO_get0_NAME(), OSSL_STORE_INFO_get0_NAME_description(),
  79 OSSL_STORE_INFO_get0_PARAMS(), OSSL_STORE_INFO_get0_PKEY(),
  80 OSSL_STORE_INFO_get0_CERT() and OSSL_STORE_INFO_get0_CRL() all take a
  81 B<OSSL_STORE_INFO> and return the held object of the appropriate OpenSSL
  82 type provided that's what's held.
  83
  84 OSSL_STORE_INFO_get1_NAME(), OSSL_STORE_INFO_get1_NAME_description(),
  85 OSSL_STORE_INFO_get1_PARAMS(), OSSL_STORE_INFO_get1_PKEY(),
  86 OSSL_STORE_INFO_get1_CERT() and OSSL_STORE_INFO_get1_CRL() all take a
  87 B<OSSL_STORE_INFO> and return a duplicate of the held object of the
  88 appropriate OpenSSL type provided that's what's held.
  89
  90 OSSL_STORE_INFO_free() frees a B<OSSL_STORE_INFO> and its contained type.
  91
  92 OSSL_STORE_INFO_new_NAME() , OSSL_STORE_INFO_new_PARAMS(),
  93 OSSL_STORE_INFO_new_PKEY(), OSSL_STORE_INFO_new_CERT() and
  94 OSSL_STORE_INFO_new_CRL() create a B<OSSL_STORE_INFO>
  95 object to hold the given input object.
  96 On success the input object is consumed.
  97
  98 Additionally, for B<OSSL_STORE_INFO_NAME>` objects,
  99 OSSL_STORE_INFO_set0_NAME_description() can be used to add an extra
 100 description.
 101 This description is meant to be human readable and should be used for
 102 information printout.
 103
 104 =head1 SUPPORTED OBJECTS
 105
 106 Currently supported object types are:
 107
 108 =over 4
 109
 110 =item OSSL_STORE_INFO_NAME
 111
 112 A name is exactly that, a name.
 113 It's like a name in a directory, but formatted as a complete URI.
 114 For example, the path in URI C<file:/foo/bar/> could include a file
 115 named C<cookie.pem>, and in that case, the returned B<OSSL_STORE_INFO_NAME>
 116 object would have the URI C<file:/foo/bar/cookie.pem>, which can be
 117 used by the application to get the objects in that file.
 118 This can be applied to all schemes that can somehow support a listing
 119 of object URIs.
 120
 121 For C<file:> URIs that are used without the explicit scheme, the
 122 returned name will be the path of each object, so if C</foo/bar> was
 123 given and that path has the file C<cookie.pem>, the name
 124 C</foo/bar/cookie.pem> will be returned.
 125
 126 The returned URI is considered canonical and must be unique and permanent
 127 for the storage where the object (or collection of objects) resides.
 128 Each loader is responsible for ensuring that it only returns canonical
 129 URIs.
 130 However, it's possible that certain schemes allow an object (or collection
 131 thereof) to be reached with alternative URIs; just because one URI is
 132 canonical doesn't mean that other variants can't be used.
 133
 134 At the discretion of the loader that was used to get these names, an
 135 extra description may be attached as well.
 136
 137 =item OSSL_STORE_INFO_PARAMS
 138
 139 Key parameters.
 140
 141 =item OSSL_STORE_INFO_PKEY
 142
 143 A private/public key of some sort.
 144
 145 =item OSSL_STORE_INFO_CERT
 146
 147 An X.509 certificate.
 148
 149 =item OSSL_STORE_INFO_CRL
 150
 151 A X.509 certificate revocation list.
 152
 153 =back
 154
 155 =head1 RETURN VALUES
 156
 157 OSSL_STORE_INFO_get_type() returns the STORE type number of the given
 158 B<OSSL_STORE_INFO>.
 159 There is no error value.
 160
 161 OSSL_STORE_INFO_get0_NAME(), OSSL_STORE_INFO_get0_NAME_description(),
 162 OSSL_STORE_INFO_get0_PARAMS(), OSSL_STORE_INFO_get0_PKEY(),
 163 OSSL_STORE_INFO_get0_CERT() and OSSL_STORE_INFO_get0_CRL() all return
 164 a pointer to the OpenSSL object on success, NULL otherwise.
 165
 166 OSSL_STORE_INFO_get1_NAME(), OSSL_STORE_INFO_get1_NAME_description(),
 167 OSSL_STORE_INFO_get1_PARAMS(), OSSL_STORE_INFO_get1_PKEY(),
 168 OSSL_STORE_INFO_get1_CERT() and OSSL_STORE_INFO_get1_CRL() all return
 169 a pointer to a duplicate of the OpenSSL object on success, NULL otherwise.
 170
 171 OSSL_STORE_INFO_type_string() returns a string on success, or B<NULL> on
 172 failure.
 173
 174 OSSL_STORE_INFO_new_NAME(), OSSL_STORE_INFO_new_PARAMS(),
 175 OSSL_STORE_INFO_new_PKEY(), OSSL_STORE_INFO_new_CERT() and
 176 OSSL_STORE_INFO_new_CRL() return a B<OSSL_STORE_INFO>
 177 pointer on success, or B<NULL> on failure.
 178
 179 OSSL_STORE_INFO_set0_NAME_description() returns 1 on success, or 0 on
 180 failure.
 181
 182 =head1 SEE ALSO
 183
 184 L<ossl_store(7)>, L<OSSL_STORE_open(3)>, L<OSSL_STORE_register_loader(3)>
 185
 186 =head1 HISTORY
 187
 188 The OSSL_STORE API was added in OpenSSL 1.1.1.
 189
 190 =head1 COPYRIGHT
 191
 192 Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
 193
 194 Licensed under the Apache License 2.0 (the "License").  You may not use
 195 this file except in compliance with the License.  You can obtain a copy
 196 in the file LICENSE in the source distribution or at
 197 L<https://www.openssl.org/source/license.html>.
 198
 199 =cut