| // Copyright 2014 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef NET_SSL_OPENSSL_SSL_UTIL_H_ |
| #define NET_SSL_OPENSSL_SSL_UTIL_H_ |
| |
| #include <stdint.h> |
| |
| #include "net/base/net_export.h" |
| #include "net/cert/x509_certificate.h" |
| #include "net/log/net_log_event_type.h" |
| #include "third_party/boringssl/src/include/openssl/base.h" |
| |
| namespace crypto { |
| class OpenSSLErrStackTracer; |
| } |
| |
| namespace base { |
| class Location; |
| } |
| |
| namespace net { |
| |
| class NetLogWithSource; |
| |
| // Puts a net error, |err|, on the error stack in OpenSSL. The file and line are |
| // extracted from |posted_from|. The function code of the error is left as 0. |
| void OpenSSLPutNetError(const base::Location& posted_from, int err); |
| |
| // Utility to construct the appropriate set & clear masks for use the OpenSSL |
| // options and mode configuration functions. (SSL_set_options etc) |
| struct SslSetClearMask { |
| SslSetClearMask(); |
| void ConfigureFlag(long flag, bool state); |
| |
| long set_mask; |
| long clear_mask; |
| }; |
| |
| // Converts an OpenSSL error code into a net error code, walking the OpenSSL |
| // error stack if needed. |
| // |
| // Note that |tracer| is not currently used in the implementation, but is passed |
| // in anyway as this ensures the caller will clear any residual codes left on |
| // the error stack. |
| NET_EXPORT_PRIVATE int MapOpenSSLError( |
| int err, |
| const crypto::OpenSSLErrStackTracer& tracer); |
| |
| // Helper struct to store information about an OpenSSL error stack entry. |
| struct OpenSSLErrorInfo { |
| OpenSSLErrorInfo() : error_code(0), file(nullptr), line(0) {} |
| |
| uint32_t error_code; |
| const char* file; |
| int line; |
| }; |
| |
| // Converts an OpenSSL error code into a net error code, walking the OpenSSL |
| // error stack if needed. If a value on the stack is used, the error code and |
| // associated information are returned in |*out_error_info|. Otherwise its |
| // fields are set to 0 and NULL. This function will never return OK, so |
| // SSL_ERROR_ZERO_RETURN must be handled externally. |
| // |
| // Note that |tracer| is not currently used in the implementation, but is passed |
| // in anyway as this ensures the caller will clear any residual codes left on |
| // the error stack. |
| int MapOpenSSLErrorWithDetails(int err, |
| const crypto::OpenSSLErrStackTracer& tracer, |
| OpenSSLErrorInfo* out_error_info); |
| |
| // Logs an OpenSSL error to the NetLog. |
| void NetLogOpenSSLError(const NetLogWithSource& net_log, |
| NetLogEventType type, |
| int net_error, |
| int ssl_error, |
| const OpenSSLErrorInfo& error_info); |
| |
| // Returns the net SSL version number (see ssl_connection_status_flags.h) for |
| // this SSL connection. |
| int GetNetSSLVersion(SSL* ssl); |
| |
| // Configures |ssl| to send the specified certificate and either |pkey| or |
| // |custom_key|. This is a wrapper over |SSL_set_chain_and_key|. |
| bool SetSSLChainAndKey(SSL* ssl, |
| X509Certificate* cert, |
| EVP_PKEY* pkey, |
| const SSL_PRIVATE_KEY_METHOD* custom_key); |
| |
| } // namespace net |
| |
| #endif // NET_SSL_OPENSSL_SSL_UTIL_H_ |