summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_get_verify_result.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_verify_result.3')
-rw-r--r--src/lib/libssl/doc/SSL_get_verify_result.346
1 files changed, 46 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_get_verify_result.3 b/src/lib/libssl/doc/SSL_get_verify_result.3
new file mode 100644
index 0000000000..3409dc0698
--- /dev/null
+++ b/src/lib/libssl/doc/SSL_get_verify_result.3
@@ -0,0 +1,46 @@
1.Dd $Mdocdate: October 12 2014 $
2.Dt SSL_GET_VERIFY_RESULT 3
3.Os
4.Sh NAME
5.Nm SSL_get_verify_result
6.Nd get result of peer certificate verification
7.Sh SYNOPSIS
8.In openssl/ssl.h
9.Ft long
10.Fn SSL_get_verify_result "const SSL *ssl"
11.Sh DESCRIPTION
12.Fn SSL_get_verify_result
13returns the result of the verification of the X509 certificate presented by the
14peer, if any.
15.Sh NOTES
16.Fn SSL_get_verify_result
17can only return one error code while the verification of a certificate can fail
18because of many reasons at the same time.
19Only the last verification error that occurred during the processing is
20available from
21.Fn SSL_get_verify_result .
22.Pp
23The verification result is part of the established session and is restored when
24a session is reused.
25.Sh RETURN VALUES
26The following return values can currently occur:
27.Bl -tag -width Ds
28.It Dv X509_V_OK
29The verification succeeded or no peer certificate was presented.
30.It Any other value
31Documented in
32.Xr verify 1 .
33.El
34.Sh SEE ALSO
35.Xr verify 1 ,
36.Xr ssl 3 ,
37.Xr SSL_get_peer_certificate 3 ,
38.Xr SSL_set_verify_result 3
39.Sh BUGS
40If no peer certificate was presented, the returned result code is
41.Dv X509_V_OK .
42This is because no verification error occurred;
43however, it does not indicate success.
44.Fn SSL_get_verify_result
45is only useful in connection with
46.Xr SSL_get_peer_certificate 3 .