Debian Codegraph @

upstream/debian-unstable/man3/X509_check_ca.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "X509_CHECK_CA 3SSL"
58 .TH X509_CHECK_CA 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 X509_check_ca \- check if given certificate is CA certificate
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/x509v3.h>
69 \&
70 \& int X509_check_ca(X509 *cert);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 This function checks if given certificate is CA certificate (can be used
75 to sign other certificates). The certificate must be a complete certificate
76 otherwise an error is returned.
77 .SH "RETURN VALUES"
78 .IX Header "RETURN VALUES"
79 Function return 0, if it is not CA certificate, 1 if it is proper X509v3
80 CA certificate with \fBbasicConstraints\fR extension CA:TRUE,
81 3, if it is self-signed X509 v1 certificate, 4, if it is certificate with
82 \&\fBkeyUsage\fR extension with bit \fBkeyCertSign\fR set, but without
83 \&\fBbasicConstraints\fR, and 5 if it has outdated Netscape Certificate Type
84 extension telling that it is CA certificate.
85 .PP
86 This function will also return 0 on error.
87 .PP
88 Actually, any nonzero value means that this certificate could have been
89 used to sign other certificates.
90 .SH "SEE ALSO"
91 .IX Header "SEE ALSO"
92 \&\fBX509_verify_cert\fR\|(3),
93 \&\fBX509_check_issued\fR\|(3),
94 \&\fBX509_check_purpose\fR\|(3)
95 .SH COPYRIGHT
96 .IX Header "COPYRIGHT"
97 Copyright 2015\-2021 The OpenSSL Project Authors. All Rights Reserved.
98 .PP
99 Licensed under the Apache License 2.0 (the "License"). You may not use
100 this file except in compliance with the License. You can obtain a copy
101 in the file LICENSE in the source distribution or at
102 <https://www.openssl.org/source/license.html>.