doc/man3/X509_LOOKUP.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_LOOKUP, X509_LOOKUP_TYPE,
   6 X509_LOOKUP_new, X509_LOOKUP_free, X509_LOOKUP_init,
   7 X509_LOOKUP_shutdown,
   8 X509_LOOKUP_set_method_data, X509_LOOKUP_get_method_data,
   9 X509_LOOKUP_ctrl_with_libctx, X509_LOOKUP_ctrl,
  10 X509_LOOKUP_load_file_with_libctx, X509_LOOKUP_load_file,
  11 X509_LOOKUP_add_dir,
  12 X509_LOOKUP_add_store_with_libctx, X509_LOOKUP_add_store,
  13 X509_LOOKUP_load_store_with_libctx, X509_LOOKUP_load_store,
  14 X509_LOOKUP_get_store,
  15 X509_LOOKUP_by_subject_with_libctx, X509_LOOKUP_by_subject,
  16 X509_LOOKUP_by_issuer_serial, X509_LOOKUP_by_fingerprint,
  17 X509_LOOKUP_by_alias
  18 - OpenSSL certificate lookup mechanisms
  19
  20 =head1 SYNOPSIS
  21
  22  #include <openssl/x509_vfy.h>
  23
  24  typedef x509_lookup_st X509_LOOKUP;
  25
  26  typedef enum X509_LOOKUP_TYPE;
  27
  28  X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
  29  int X509_LOOKUP_init(X509_LOOKUP *ctx);
  30  int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
  31  void X509_LOOKUP_free(X509_LOOKUP *ctx);
  32
  33  int X509_LOOKUP_set_method_data(X509_LOOKUP *ctx, void *data);
  34  void *X509_LOOKUP_get_method_data(const X509_LOOKUP *ctx);
  35
  36  int X509_LOOKUP_ctrl_with_libctx(X509_LOOKUP *ctx, int cmd, const char *argc,
  37                                   long argl, char **ret, OPENSSL_CTX *libctx,
  38                                   const char *propq);
  39  int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
  40                       long argl, char **ret);
  41  int X509_LOOKUP_load_file_with_libctx(X509_LOOKUP *ctx, char *name, long type,
  42                                        OPENSSL_CTX *libctx, const char *propq);
  43  int X509_LOOKUP_load_file(X509_LOOKUP *ctx, char *name, long type);
  44  int X509_LOOKUP_load_file_with_libctx(X509_LOOKUP *ctx, char *name, long type,
  45                                        OPENSSL_CTX *libctx, const char *propq);
  46  int X509_LOOKUP_add_dir(X509_LOOKUP *ctx, char *name, long type);
  47  int X509_LOOKUP_add_store_with_libctx(X509_LOOKUP *ctx, char *uri,
  48                                        OPENSSL_CTX *libctx, const char *propq);
  49  int X509_LOOKUP_add_store(X509_LOOKUP *ctx, char *uri);
  50  int X509_LOOKUP_load_store_with_libctx(X509_LOOKUP *ctx, char *uri,
  51                                         OPENSSL_CTX *libctx, const char *propq);
  52  int X509_LOOKUP_load_store(X509_LOOKUP *ctx, char *uri);
  53
  54  X509_STORE *X509_LOOKUP_get_store(const X509_LOOKUP *ctx);
  55
  56  int X509_LOOKUP_by_subject_with_libctx(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  57                                         const X509_NAME *name, X509_OBJECT *ret,
  58                                         OPENSSL_CTX *libctx, const char *propq);
  59  int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  60                             const X509_NAME *name, X509_OBJECT *ret);
  61  int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  62                                   const X509_NAME *name,
  63                                   const ASN1_INTEGER *serial, X509_OBJECT *ret);
  64  int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  65                                 const unsigned char *bytes, int len,
  66                                 X509_OBJECT *ret);
  67  int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type,
  68                           const char *str, int len, X509_OBJECT *ret);
  69
  70 =head1 DESCRIPTION
  71
  72 The B<X509_LOOKUP> structure holds the information needed to look up
  73 certificates and CRLs according to an associated L<X509_LOOKUP_METHOD(3)>.
  74 Multiple B<X509_LOOKUP> instances can be added to an L<X509_STORE(3)>
  75 to enable lookup in that store.
  76
  77 X509_LOOKUP_new() creates a new B<X509_LOOKUP> using the given lookup
  78 I<method>.
  79 It can also be created by calling L<X509_STORE_add_lookup(3)>, which
  80 will associate a B<X509_STORE> with the lookup mechanism.
  81
  82 X509_LOOKUP_init() initializes the internal state and resources as
  83 needed by the given B<X509_LOOKUP> to do its work.
  84
  85 X509_LOOKUP_shutdown() tears down the internal state and resources of
  86 the given B<X509_LOOKUP>.
  87
  88 X509_LOOKUP_free() destructs the given B<X509_LOOKUP>.
  89
  90 X509_LOOKUP_set_method_data() and X509_LOOKUP_get_method_data()
  91 associates and retrieves a pointer to application data to and from the
  92 given B<X509_LOOKUP>, respectively.
  93
  94 X509_LOOKUP_ctrl_with_libctx() is used to set or get additional data to or from
  95 a B<X509_LOOKUP> structure or its associated L<X509_LOOKUP_METHOD(3)>.
  96 The arguments of the control command are passed via I<argc> and I<argl>,
  97 its return value via I<*ret>. The library context I<libctx> and property
  98 query <propq> are used when fetching algorithms from providers.
  99 The meaning of the arguments depends on the I<cmd> number of the
 100 control command. In general, this function is not called directly, but
 101 wrapped by a macro call, see below.
 102 The control I<cmd>s known to OpenSSL are discussed in more depth
 103 in L</Control Commands>.
 104
 105 X509_LOOKUP_ctrl() is similar to X509_LOOKUP_ctrl_with_libctx() but
 106 uses NULL for the library context I<libctx> and property query <propq>.
 107
 108 X509_LOOKUP_load_file_with_libctx() passes a filename to be loaded immediately
 109 into the associated B<X509_STORE>. The library context I<libctx> and property
 110 query <propq> are used when fetching algorithms from providers.
 111 I<type> indicates what type of object is expected.
 112 This can only be used with a lookup using the implementation
 113 L<X509_LOOKUP_file(3)>.
 114
 115 X509_LOOKUP_load_file() is similar to X509_LOOKUP_load_file_with_libctx() but
 116 uses NULL for the library context I<libctx> and property query <propq>.
 117
 118 X509_LOOKUP_add_dir() passes a directory specification from which
 119 certificates and CRLs are loaded on demand into the associated
 120 B<X509_STORE>.
 121 I<type> indicates what type of object is expected.
 122 This can only be used with a lookup using the implementation
 123 L<X509_LOOKUP_hash_dir(3)>.
 124
 125 X509_LOOKUP_add_store_with_libctx() passes a URI for a directory-like structure
 126 from which containers with certificates and CRLs are loaded on demand
 127 into the associated B<X509_STORE>. The library context I<libctx> and property
 128 query <propq> are used when fetching algorithms from providers.
 129
 130 X509_LOOKUP_add_store() is similar to X509_LOOKUP_add_store_with_libctx() but
 131 uses NULL for the library context I<libctx> and property query <propq>.
 132
 133 X509_LOOKUP_load_store_with_libctx() passes a URI for a single container from
 134 which certificates and CRLs are immediately loaded into the associated
 135 B<X509_STORE>. The library context I<libctx> and property query <propq> are used
 136 when fetching algorithms from providers.
 137 These functions can only be used with a lookup using the
 138 implementation L<X509_LOOKUP_store(3)>.
 139
 140 X509_LOOKUP_load_store() is similar to X509_LOOKUP_load_store_with_libctx() but
 141 uses NULL for the library context I<libctx> and property query <propq>.
 142
 143 X509_LOOKUP_load_file_with_libctx(), X509_LOOKUP_load_file(),
 144 X509_LOOKUP_add_dir(),
 145 X509_LOOKUP_add_store_with_libctx() X509_LOOKUP_add_store(),
 146 X509_LOOKUP_load_store_with_libctx() and X509_LOOKUP_load_store() are
 147 implemented as macros that use X509_LOOKUP_ctrl().
 148
 149 X509_LOOKUP_by_subject_with_libctx(), X509_LOOKUP_by_subject(),
 150 X509_LOOKUP_by_issuer_serial(), X509_LOOKUP_by_fingerprint(), and
 151 X509_LOOKUP_by_alias() look up certificates and CRLs in the L<X509_STORE(3)>
 152 associated with the B<X509_LOOKUP> using different criteria, where the looked up
 153 object is stored in I<ret>.
 154 Some of the underlying B<X509_LOOKUP_METHOD>s will also cache objects
 155 matching the criteria in the associated B<X509_STORE>, which makes it
 156 possible to handle cases where the criteria have more than one hit.
 157
 158 =head2 Control Commands
 159
 160 The B<X509_LOOKUP_METHOD>s built into OpenSSL recognize the following
 161 X509_LOOKUP_ctrl() I<cmd>s:
 162
 163 =over 4
 164
 165 =item B<X509_L_FILE_LOAD>
 166
 167 This is the command that X509_LOOKUP_load_file_with_libctx() and
 168 X509_LOOKUP_load_file() use.
 169 The filename is passed in I<argc>, and the type in I<argl>.
 170
 171 =item B<X509_L_ADD_DIR>
 172
 173 This is the command that X509_LOOKUP_add_dir() uses.
 174 The directory specification is passed in I<argc>, and the type in
 175 I<argl>.
 176
 177 =item B<X509_L_ADD_STORE>
 178
 179 This is the command that X509_LOOKUP_add_store_with_libctx() and
 180 X509_LOOKUP_add_store() use.
 181 The URI is passed in I<argc>.
 182
 183 =item B<X509_L_LOAD_STORE>
 184
 185 This is the command that X509_LOOKUP_load_store_with_libctx() and
 186 X509_LOOKUP_load_store() use.
 187 The URI is passed in I<argc>.
 188
 189 =back
 190
 191 =head1 RETURN VALUES
 192
 193 X509_LOOKUP_new() returns a B<X509_LOOKUP> pointer when successful,
 194 or NULL on error.
 195
 196 X509_LOOKUP_init() and X509_LOOKUP_shutdown() return 1 on success, or
 197 0 on error.
 198
 199 X509_LOOKUP_ctrl() returns -1 if the B<X509_LOOKUP> doesn't have an
 200 associated B<X509_LOOKUP_METHOD>, or 1 if the X<509_LOOKUP_METHOD>
 201 doesn't have a control function.
 202 Otherwise, it returns what the control function in the
 203 B<X509_LOOKUP_METHOD> returns, which is usually 1 on success and 0 in
 204 error.
 205
 206 X509_LOOKUP_get_store() returns a B<X509_STORE> pointer if there is
 207 one, otherwise NULL.
 208
 209 X509_LOOKUP_by_subject_with_libctx(), X509_LOOKUP_by_subject(),
 210 X509_LOOKUP_by_issuer_serial(), X509_LOOKUP_by_fingerprint(), and
 211 X509_LOOKUP_by_alias() all return 0 if there is no B<X509_LOOKUP_METHOD> or that
 212 method doesn't implement the corresponding function.
 213 Otherwise, it returns what the corresponding function in the
 214 B<X509_LOOKUP_METHOD> returns, which is usually 1 on success and 0 in
 215 error.
 216
 217 =head1 SEE ALSO
 218
 219 L<X509_LOOKUP_METHOD(3)>, L<X509_STORE(3)>
 220
 221 =head1 HISTORY
 222
 223 The functions X509_LOOKUP_by_subject_with_libctx() and
 224 X509_LOOKUP_ctrl_with_libctx() were added in OpenSSL 3.0.
 225
 226 The macros X509_LOOKUP_load_file_with_libctx(),
 227 X509_LOOKUP_load_store_with_libctx() and 509_LOOKUP_add_store_with_libctx() were
 228 added in OpenSSL 3.0.
 229
 230 =head1 COPYRIGHT
 231
 232 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
 233
 234 Licensed under the Apache License 2.0 (the "License").  You may not use
 235 this file except in compliance with the License.  You can obtain a copy
 236 in the file LICENSE in the source distribution or at
 237 L<https://www.openssl.org/source/license.html>.
 238
 239 =cut