Document X509_verify_ex() and X509_REQ_verify_ex()
[openssl.git] / doc / man3 / X509v3_cache_extensions.pod
1 =pod
2
3 =head1 NAME
4
5 X509v3_cache_extensions
6 - process any extensions in an X509 object
7
8 =head1 SYNOPSIS
9
10  #include <openssl/x509v3.h>
11
12  int X509v3_cache_extensions(X509 *x, OPENSSL_CTX *libctx, const char *propq);
13
14 =head1 DESCRIPTION
15
16 This function processes any X509v3 extensions that might be present in an X509
17 object and caches the result of that processing. Many OpenSSL functions that use
18 an X509 object will cause extensions to be processed and cached implicitly. If
19 this is done implicitly then the default library context and property query
20 string will be used. In some cases it may be desirable to use some other library
21 context and property query string. If so then an application can call
22 X509v3_cache_extensions() explicitly. This should be done before any function
23 that needs to use those extensions is called - otherwise calling
24 X509v3_cache_extensions() will have no effect. Typically this means calling this
25 soon after creation of the X509 object. The X509 object to be processed is
26 given in I<x> and the library context and property query string to use are given
27 in I<libctx> and I<propq>.
28
29 =head1 RETURN VALUES
30
31 This function returns 0 if the extensions are invalid or an error occurred.
32 Otherwise it returns 1.
33
34 =head1 COPYRIGHT
35
36 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
37
38 Licensed under the Apache License 2.0 (the "License").  You may not use
39 this file except in compliance with the License.  You can obtain a copy
40 in the file LICENSE in the source distribution or at
41 L<https://www.openssl.org/source/license.html>.
42
43 =cut