Debian Codegraph @

upstream/debian-unstable/man3/SSL_get_verify_result.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_VERIFY_RESULT 3SSL"
58 .TH SSL_GET_VERIFY_RESULT 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_verify_result \- get result of peer certificate verification
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& long SSL_get_verify_result(const SSL *ssl);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBSSL_get_verify_result()\fR returns the result of the verification of the
75 X509 certificate presented by the peer, if any. \fIssl\fR \fBMUST NOT\fR be NULL.
76 .SH NOTES
77 .IX Header "NOTES"
78 \&\fBSSL_get_verify_result()\fR can only return one error code while the verification
79 of a certificate can fail because of many reasons at the same time. Only
80 the last verification error that occurred during the processing is available
81 from \fBSSL_get_verify_result()\fR.
82 .PP
83 Sometimes there can be a sequence of errors leading to the verification
84 failure as reported by \fBSSL_get_verify_result()\fR.
85 To get the errors, it is necessary to setup a verify callback via
86 \&\fBSSL_CTX_set_verify\fR\|(3) or \fBSSL_set_verify\fR\|(3) and retrieve the errors
87 from the error stack there, because once \fBSSL_connect\fR\|(3) returns,
88 these errors may no longer be available.
89 .PP
90 The verification result is part of the established session and is restored
91 when a session is reused.
92 .SH BUGS
93 .IX Header "BUGS"
94 If no peer certificate was presented, the returned result code is
95 X509_V_OK. This is because no verification error occurred, it does however
96 not indicate success. \fBSSL_get_verify_result()\fR is only useful in connection
97 with \fBSSL_get_peer_certificate\fR\|(3).
98 .SH "RETURN VALUES"
99 .IX Header "RETURN VALUES"
100 The following return values can currently occur:
101 .IP X509_V_OK 4
102 .IX Item "X509_V_OK"
103 The verification succeeded or no peer certificate was presented.
104 .IP "Any other value" 4
105 .IX Item "Any other value"
106 Documented in \fBopenssl\-verify\fR\|(1).
107 .SH "SEE ALSO"
108 .IX Header "SEE ALSO"
109 \&\fBssl\fR\|(7), \fBSSL_set_verify_result\fR\|(3),
110 \&\fBSSL_get_peer_certificate\fR\|(3),
111 \&\fBopenssl\-verify\fR\|(1)
112 .SH COPYRIGHT
113 .IX Header "COPYRIGHT"
114 Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved.
115 .PP
116 Licensed under the Apache License 2.0 (the "License"). You may not use
117 this file except in compliance with the License. You can obtain a copy
118 in the file LICENSE in the source distribution or at
119 <https://www.openssl.org/source/license.html>.