Debian Codegraph @

upstream/debian-unstable/man3/SSL_get_peer_cert_chain.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 "SSL_GET_PEER_CERT_CHAIN 3SSL"
58 .TH SSL_GET_PEER_CERT_CHAIN 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 SSL_get_peer_cert_chain, SSL_get0_verified_chain \- get the X509 certificate
65 chain of the peer
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ssl.h>
70 \&
71 \& STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
72 \& STACK_OF(X509) *SSL_get0_verified_chain(const SSL *ssl);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBSSL_get_peer_cert_chain()\fR returns a pointer to STACK_OF(X509) certificates
77 forming the certificate chain sent by the peer. If called on the client side,
78 the stack also contains the peer's certificate; if called on the server
79 side, the peer's certificate must be obtained separately using
80 \&\fBSSL_get_peer_certificate\fR\|(3).
81 If the peer did not present a certificate, NULL is returned.
82 .PP
83 NB: \fBSSL_get_peer_cert_chain()\fR returns the peer chain as sent by the peer: it
84 only consists of certificates the peer has sent (in the order the peer
85 has sent them) it is \fBnot\fR a verified chain.
86 .PP
87 \&\fBSSL_get0_verified_chain()\fR returns the \fBverified\fR certificate chain
88 of the peer including the peer's end entity certificate. It must be called
89 after a session has been successfully established. If peer verification was
90 not successful (as indicated by \fBSSL_get_verify_result()\fR not returning
91 X509_V_OK) the chain may be incomplete or invalid.
92 .SH NOTES
93 .IX Header "NOTES"
94 If the session is resumed peers do not send certificates so a NULL pointer
95 is returned by these functions. Applications can call \fBSSL_session_reused()\fR
96 to determine whether a session is resumed.
97 .PP
98 The reference count of each certificate in the returned STACK_OF(X509) object
99 is not incremented and the returned stack may be invalidated by renegotiation.
100 If applications wish to use any certificates in the returned chain
101 indefinitely they must increase the reference counts using \fBX509_up_ref()\fR or
102 obtain a copy of the whole chain with \fBX509_chain_up_ref()\fR.
103 .SH "RETURN VALUES"
104 .IX Header "RETURN VALUES"
105 The following return values can occur:
106 .IP NULL 4
107 .IX Item "NULL"
108 No certificate was presented by the peer or no connection was established
109 or the certificate chain is no longer available when a session is reused.
110 .IP "Pointer to a STACK_OF(X509)" 4
111 .IX Item "Pointer to a STACK_OF(X509)"
112 The return value points to the certificate chain presented by the peer.
113 .SH "SEE ALSO"
114 .IX Header "SEE ALSO"
115 \&\fBssl\fR\|(7), \fBSSL_get_peer_certificate\fR\|(3), \fBX509_up_ref\fR\|(3),
116 \&\fBX509_chain_up_ref\fR\|(3)
117 .SH COPYRIGHT
118 .IX Header "COPYRIGHT"
119 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
120 .PP
121 Licensed under the Apache License 2.0 (the "License"). You may not use
122 this file except in compliance with the License. You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 <https://www.openssl.org/source/license.html>.