diff options
Diffstat (limited to 'doc/man3/X509_LOOKUP.pod')
| -rw-r--r-- | doc/man3/X509_LOOKUP.pod | 77 |
1 files changed, 38 insertions, 39 deletions
diff --git a/doc/man3/X509_LOOKUP.pod b/doc/man3/X509_LOOKUP.pod index a89b94aa48..6f464a1e0a 100644 --- a/doc/man3/X509_LOOKUP.pod +++ b/doc/man3/X509_LOOKUP.pod @@ -6,13 +6,13 @@ X509_LOOKUP, X509_LOOKUP_TYPE, X509_LOOKUP_new, X509_LOOKUP_free, X509_LOOKUP_init, X509_LOOKUP_shutdown, X509_LOOKUP_set_method_data, X509_LOOKUP_get_method_data, -X509_LOOKUP_ctrl_with_libctx, X509_LOOKUP_ctrl, -X509_LOOKUP_load_file_with_libctx, X509_LOOKUP_load_file, +X509_LOOKUP_ctrl_ex, X509_LOOKUP_ctrl, +X509_LOOKUP_load_file_ex, X509_LOOKUP_load_file, X509_LOOKUP_add_dir, -X509_LOOKUP_add_store_with_libctx, X509_LOOKUP_add_store, -X509_LOOKUP_load_store_with_libctx, X509_LOOKUP_load_store, +X509_LOOKUP_add_store_ex, X509_LOOKUP_add_store, +X509_LOOKUP_load_store_ex, X509_LOOKUP_load_store, X509_LOOKUP_get_store, -X509_LOOKUP_by_subject_with_libctx, X509_LOOKUP_by_subject, +X509_LOOKUP_by_subject_ex, X509_LOOKUP_by_subject, X509_LOOKUP_by_issuer_serial, X509_LOOKUP_by_fingerprint, X509_LOOKUP_by_alias - OpenSSL certificate lookup mechanisms @@ -33,29 +33,28 @@ X509_LOOKUP_by_alias int X509_LOOKUP_set_method_data(X509_LOOKUP *ctx, void *data); void *X509_LOOKUP_get_method_data(const X509_LOOKUP *ctx); - int X509_LOOKUP_ctrl_with_libctx(X509_LOOKUP *ctx, int cmd, const char *argc, - long argl, char **ret, OPENSSL_CTX *libctx, - const char *propq); + int X509_LOOKUP_ctrl_ex(X509_LOOKUP *ctx, int cmd, const char *argc, long argl, + char **ret, OPENSSL_CTX *libctx, const char *propq); int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, long argl, char **ret); - int X509_LOOKUP_load_file_with_libctx(X509_LOOKUP *ctx, char *name, long type, - OPENSSL_CTX *libctx, const char *propq); + int X509_LOOKUP_load_file_ex(X509_LOOKUP *ctx, char *name, long type, + OPENSSL_CTX *libctx, const char *propq); int X509_LOOKUP_load_file(X509_LOOKUP *ctx, char *name, long type); - int X509_LOOKUP_load_file_with_libctx(X509_LOOKUP *ctx, char *name, long type, - OPENSSL_CTX *libctx, const char *propq); + int X509_LOOKUP_load_file_ex(X509_LOOKUP *ctx, char *name, long type, + OPENSSL_CTX *libctx, const char *propq); int X509_LOOKUP_add_dir(X509_LOOKUP *ctx, char *name, long type); - int X509_LOOKUP_add_store_with_libctx(X509_LOOKUP *ctx, char *uri, - OPENSSL_CTX *libctx, const char *propq); + int X509_LOOKUP_add_store_ex(X509_LOOKUP *ctx, char *uri, OPENSSL_CTX *libctx, + const char *propq); int X509_LOOKUP_add_store(X509_LOOKUP *ctx, char *uri); - int X509_LOOKUP_load_store_with_libctx(X509_LOOKUP *ctx, char *uri, - OPENSSL_CTX *libctx, const char *propq); + int X509_LOOKUP_load_store_ex(X509_LOOKUP *ctx, char *uri, OPENSSL_CTX *libctx, + const char *propq); int X509_LOOKUP_load_store(X509_LOOKUP *ctx, char *uri); X509_STORE *X509_LOOKUP_get_store(const X509_LOOKUP *ctx); - int X509_LOOKUP_by_subject_with_libctx(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type, - const X509_NAME *name, X509_OBJECT *ret, - OPENSSL_CTX *libctx, const char *propq); + int X509_LOOKUP_by_subject_ex(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type, + const X509_NAME *name, X509_OBJECT *ret, + OPENSSL_CTX *libctx, const char *propq); int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type, const X509_NAME *name, X509_OBJECT *ret); int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type, @@ -91,7 +90,7 @@ X509_LOOKUP_set_method_data() and X509_LOOKUP_get_method_data() associates and retrieves a pointer to application data to and from the given B<X509_LOOKUP>, respectively. -X509_LOOKUP_ctrl_with_libctx() is used to set or get additional data to or from +X509_LOOKUP_ctrl_ex() is used to set or get additional data to or from a B<X509_LOOKUP> structure or its associated L<X509_LOOKUP_METHOD(3)>. The arguments of the control command are passed via I<argc> and I<argl>, its return value via I<*ret>. The library context I<libctx> and property @@ -102,17 +101,17 @@ wrapped by a macro call, see below. The control I<cmd>s known to OpenSSL are discussed in more depth in L</Control Commands>. -X509_LOOKUP_ctrl() is similar to X509_LOOKUP_ctrl_with_libctx() but +X509_LOOKUP_ctrl() is similar to X509_LOOKUP_ctrl_ex() but uses NULL for the library context I<libctx> and property query <propq>. -X509_LOOKUP_load_file_with_libctx() passes a filename to be loaded immediately +X509_LOOKUP_load_file_ex() passes a filename to be loaded immediately into the associated B<X509_STORE>. The library context I<libctx> and property query <propq> are used when fetching algorithms from providers. I<type> indicates what type of object is expected. This can only be used with a lookup using the implementation L<X509_LOOKUP_file(3)>. -X509_LOOKUP_load_file() is similar to X509_LOOKUP_load_file_with_libctx() but +X509_LOOKUP_load_file() is similar to X509_LOOKUP_load_file_ex() but uses NULL for the library context I<libctx> and property query <propq>. X509_LOOKUP_add_dir() passes a directory specification from which @@ -122,31 +121,31 @@ I<type> indicates what type of object is expected. This can only be used with a lookup using the implementation L<X509_LOOKUP_hash_dir(3)>. -X509_LOOKUP_add_store_with_libctx() passes a URI for a directory-like structure +X509_LOOKUP_add_store_ex() passes a URI for a directory-like structure from which containers with certificates and CRLs are loaded on demand into the associated B<X509_STORE>. The library context I<libctx> and property query <propq> are used when fetching algorithms from providers. -X509_LOOKUP_add_store() is similar to X509_LOOKUP_add_store_with_libctx() but +X509_LOOKUP_add_store() is similar to X509_LOOKUP_add_store_ex() but uses NULL for the library context I<libctx> and property query <propq>. -X509_LOOKUP_load_store_with_libctx() passes a URI for a single container from +X509_LOOKUP_load_store_ex() passes a URI for a single container from which certificates and CRLs are immediately loaded into the associated B<X509_STORE>. The library context I<libctx> and property query <propq> are used when fetching algorithms from providers. These functions can only be used with a lookup using the implementation L<X509_LOOKUP_store(3)>. -X509_LOOKUP_load_store() is similar to X509_LOOKUP_load_store_with_libctx() but +X509_LOOKUP_load_store() is similar to X509_LOOKUP_load_store_ex() but uses NULL for the library context I<libctx> and property query <propq>. -X509_LOOKUP_load_file_with_libctx(), X509_LOOKUP_load_file(), +X509_LOOKUP_load_file_ex(), X509_LOOKUP_load_file(), X509_LOOKUP_add_dir(), -X509_LOOKUP_add_store_with_libctx() X509_LOOKUP_add_store(), -X509_LOOKUP_load_store_with_libctx() and X509_LOOKUP_load_store() are +X509_LOOKUP_add_store_ex() X509_LOOKUP_add_store(), +X509_LOOKUP_load_store_ex() and X509_LOOKUP_load_store() are implemented as macros that use X509_LOOKUP_ctrl(). -X509_LOOKUP_by_subject_with_libctx(), X509_LOOKUP_by_subject(), +X509_LOOKUP_by_subject_ex(), X509_LOOKUP_by_subject(), X509_LOOKUP_by_issuer_serial(), X509_LOOKUP_by_fingerprint(), and X509_LOOKUP_by_alias() look up certificates and CRLs in the L<X509_STORE(3)> associated with the B<X509_LOOKUP> using different criteria, where the looked up @@ -164,7 +163,7 @@ X509_LOOKUP_ctrl() I<cmd>s: =item B<X509_L_FILE_LOAD> -This is the command that X509_LOOKUP_load_file_with_libctx() and +This is the command that X509_LOOKUP_load_file_ex() and X509_LOOKUP_load_file() use. The filename is passed in I<argc>, and the type in I<argl>. @@ -176,13 +175,13 @@ I<argl>. =item B<X509_L_ADD_STORE> -This is the command that X509_LOOKUP_add_store_with_libctx() and +This is the command that X509_LOOKUP_add_store_ex() and X509_LOOKUP_add_store() use. The URI is passed in I<argc>. =item B<X509_L_LOAD_STORE> -This is the command that X509_LOOKUP_load_store_with_libctx() and +This is the command that X509_LOOKUP_load_store_ex() and X509_LOOKUP_load_store() use. The URI is passed in I<argc>. @@ -206,7 +205,7 @@ error. X509_LOOKUP_get_store() returns a B<X509_STORE> pointer if there is one, otherwise NULL. -X509_LOOKUP_by_subject_with_libctx(), X509_LOOKUP_by_subject(), +X509_LOOKUP_by_subject_ex(), X509_LOOKUP_by_subject(), X509_LOOKUP_by_issuer_serial(), X509_LOOKUP_by_fingerprint(), and X509_LOOKUP_by_alias() all return 0 if there is no B<X509_LOOKUP_METHOD> or that method doesn't implement the corresponding function. @@ -220,11 +219,11 @@ L<X509_LOOKUP_METHOD(3)>, L<X509_STORE(3)> =head1 HISTORY -The functions X509_LOOKUP_by_subject_with_libctx() and -X509_LOOKUP_ctrl_with_libctx() were added in OpenSSL 3.0. +The functions X509_LOOKUP_by_subject_ex() and +X509_LOOKUP_ctrl_ex() were added in OpenSSL 3.0. -The macros X509_LOOKUP_load_file_with_libctx(), -X509_LOOKUP_load_store_with_libctx() and 509_LOOKUP_add_store_with_libctx() were +The macros X509_LOOKUP_load_file_ex(), +X509_LOOKUP_load_store_with_libctx() and 509_LOOKUP_add_store_ex() were added in OpenSSL 3.0. =head1 COPYRIGHT |