SSL_get_verify_result.pod 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. =pod
  2. =head1 NAME
  3. SSL_get_verify_result - get result of peer certificate verification
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. long SSL_get_verify_result(const SSL *ssl);
  7. =head1 DESCRIPTION
  8. SSL_get_verify_result() returns the result of the verification of the
  9. X509 certificate presented by the peer, if any.
  10. =head1 NOTES
  11. SSL_get_verify_result() can only return one error code while the verification
  12. of a certificate can fail because of many reasons at the same time. Only
  13. the last verification error that occurred during the processing is available
  14. from SSL_get_verify_result().
  15. The verification result is part of the established session and is restored
  16. when a session is reused.
  17. =head1 BUGS
  18. If no peer certificate was presented, the returned result code is
  19. X509_V_OK. This is because no verification error occurred, it does however
  20. not indicate success. SSL_get_verify_result() is only useful in connection
  21. with L<SSL_get_peer_certificate(3)|SSL_get_peer_certificate(3)>.
  22. =head1 RETURN VALUES
  23. The following return values can currently occur:
  24. =over 4
  25. =item X509_V_OK
  26. The verification succeeded or no peer certificate was presented.
  27. =item Any other value
  28. Documented in L<verify(1)|verify(1)>.
  29. =back
  30. =head1 SEE ALSO
  31. L<ssl(3)|ssl(3)>, L<SSL_set_verify_result(3)|SSL_set_verify_result(3)>,
  32. L<SSL_get_peer_certificate(3)|SSL_get_peer_certificate(3)>,
  33. L<verify(1)|verify(1)>
  34. =cut