Debian Codegraph @

upstream/debian-unstable/man3/SSL_get_peer_certificate.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_CERTIFICATE 3SSL"
58 .TH SSL_GET_PEER_CERTIFICATE 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_certificate,
65 SSL_get0_peer_certificate,
66 SSL_get1_peer_certificate \- get the X509 certificate of the peer
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/ssl.h>
71 \&
72 \& X509 *SSL_get0_peer_certificate(const SSL *ssl);
73 \& X509 *SSL_get1_peer_certificate(const SSL *ssl);
74 .Ve
75 .PP
76 The following function has been deprecated since OpenSSL 3.0,
77 and can be hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable
78 version value, see \fBopenssl_user_macros\fR\|(7):
79 .PP
80 .Vb 1
81 \& X509 *SSL_get_peer_certificate(const SSL *ssl);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 These functions return a pointer to the X509 certificate the
86 peer presented. If the peer did not present a certificate, NULL is returned.
87 .SH NOTES
88 .IX Header "NOTES"
89 Due to the protocol definition, a TLS/SSL server will always send a
90 certificate, if present. A client will only send a certificate when
91 explicitly requested to do so by the server (see
92 \&\fBSSL_CTX_set_verify\fR\|(3)). If an anonymous cipher
93 is used, no certificates are sent.
94 .PP
95 That a certificate is returned does not indicate information about the
96 verification state, use \fBSSL_get_verify_result\fR\|(3)
97 to check the verification state.
98 .PP
99 The reference count of the X509 object returned by \fBSSL_get1_peer_certificate()\fR
100 is incremented by one, so that it will not be destroyed when the session
101 containing the peer certificate is freed. The X509 object must be explicitly
102 freed using \fBX509_free()\fR.
103 .PP
104 The reference count of the X509 object returned by \fBSSL_get0_peer_certificate()\fR
105 is not incremented, and must not be freed.
106 .PP
107 \&\fBSSL_get_peer_certificate()\fR is an alias of \fBSSL_get1_peer_certificate()\fR.
108 .SH "RETURN VALUES"
109 .IX Header "RETURN VALUES"
110 The following return values can occur:
111 .IP NULL 4
112 .IX Item "NULL"
113 No certificate was presented by the peer or no connection was established.
114 .IP "Pointer to an X509 certificate" 4
115 .IX Item "Pointer to an X509 certificate"
116 The return value points to the certificate presented by the peer.
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 \&\fBssl\fR\|(7), \fBSSL_get_verify_result\fR\|(3),
120 \&\fBSSL_CTX_set_verify\fR\|(3)
121 .SH HISTORY
122 .IX Header "HISTORY"
123 \&\fBSSL_get0_peer_certificate()\fR and \fBSSL_get1_peer_certificate()\fR were added in 3.0.0.
124 \&\fBSSL_get_peer_certificate()\fR was deprecated in 3.0.0.
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
128 .PP
129 Licensed under the Apache License 2.0 (the "License"). You may not use
130 this file except in compliance with the License. You can obtain a copy
131 in the file LICENSE in the source distribution or at
132 <https://www.openssl.org/source/license.html>.