Update copyright year
[openssl.git] / doc / man3 / X509_check_ca.pod
1 =pod
2
3 =head1 NAME
4
5 X509_check_ca - check if given certificate is CA certificate
6
7 =head1 SYNOPSIS
8
9  #include <openssl/x509v3.h>
10
11  int X509_check_ca(X509 *cert);
12
13 =head1 DESCRIPTION
14
15 This function checks if given certificate is CA certificate (can be used
16 to sign other certificates). The certificate must be a complete certificate
17 otherwise an error is returned.
18
19 =head1 RETURN VALUES
20
21 Function return 0, if it is not CA certificate, 1 if it is proper X509v3
22 CA certificate with B<basicConstraints> extension CA:TRUE,
23 3, if it is self-signed X509 v1 certificate, 4, if it is certificate with
24 B<keyUsage> extension with bit B<keyCertSign> set, but without
25 B<basicConstraints>, and 5 if it has outdated Netscape Certificate Type
26 extension telling that it is CA certificate.
27
28 This function will also return 0 on error.
29
30 Actually, any nonzero value means that this certificate could have been
31 used to sign other certificates.
32
33 =head1 SEE ALSO
34
35 L<X509_verify_cert(3)>,
36 L<X509_check_issued(3)>,
37 L<X509_check_purpose(3)>
38
39 =head1 COPYRIGHT
40
41 Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
42
43 Licensed under the Apache License 2.0 (the "License").  You may not use
44 this file except in compliance with the License.  You can obtain a copy
45 in the file LICENSE in the source distribution or at
46 L<https://www.openssl.org/source/license.html>.
47
48 =cut