Update copyright year
[openssl.git] / doc / internal / man3 / x509v3_cache_extensions.pod
1 =pod
2
3 =head1 NAME
4
5 x509v3_cache_extensions
6 - cache info on various X.509v3 extensions and further derived certificate data
7
8 =head1 SYNOPSIS
9
10  #include <openssl/x509v3.h>
11
12  int x509v3_cache_extensions(X509 *x, OSSL_LIB_CTX *libctx, const char *propq);
13
14 =head1 DESCRIPTION
15
16 This function processes any X509v3 extensions present in an X509 object I<x>
17 and caches the result of that processing as well as further derived info,
18 for instance whether the certificate is self-issued or has version X.509v1.
19 It computes the SHA1 digest of the certificate using the default library context
20 and property query string and stores the result in x->sha1_hash,
21 or on failure sets B<EXFLAG_NO_FINGERPRINT> in x->flags.
22 It sets B<X509_SIG_INFO_VALID> in x->flags if x->siginf was filled successfully,
23 which may not be possible if a referenced algorithm is unknown or not available.
24 Many OpenSSL functions that use an X509 object call this function implicitly.
25
26 =head1 RETURN VALUES
27
28 This function returns 0 if the extensions or other portions of the certificate
29 are invalid or an error occurred.
30 Otherwise it returns 1.
31
32 =head1 COPYRIGHT
33
34 Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
35
36 Licensed under the Apache License 2.0 (the "License").  You may not use
37 this file except in compliance with the License.  You can obtain a copy
38 in the file LICENSE in the source distribution or at
39 L<https://www.openssl.org/source/license.html>.
40
41 =cut