-/******************************************************************************
- * Icinga 2 *
- * Copyright (C) 2012-2018 Icinga Development Team (https://www.icinga.com/) *
- * *
- * This program is free software; you can redistribute it and/or *
- * modify it under the terms of the GNU General Public License *
- * as published by the Free Software Foundation; either version 2 *
- * of the License, or (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the Free Software Foundation *
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
- ******************************************************************************/
+/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
#include "base/tlsstream.hpp"
#include "base/utility.hpp"
#include "base/exception.hpp"
#include "base/logger.hpp"
+#include "base/configuration.hpp"
+#include "base/convert.hpp"
+#include <boost/asio/ssl/context.hpp>
#include <iostream>
#ifndef _WIN32
# include <poll.h>
#endif /* _WIN32 */
+#define TLS_TIMEOUT_SECONDS 10
+
using namespace icinga;
-int I2_EXPORT TlsStream::m_SSLIndex;
-bool I2_EXPORT TlsStream::m_SSLIndexInitialized = false;
+int TlsStream::m_SSLIndex;
+bool TlsStream::m_SSLIndexInitialized = false;
/**
* Constructor for the TlsStream class.
* @param sslContext The SSL context for the client.
*/
TlsStream::TlsStream(const Socket::Ptr& socket, const String& hostname, ConnectionRole role, const std::shared_ptr<SSL_CTX>& sslContext)
- : SocketEvents(socket, this), m_Eof(false), m_HandshakeOK(false), m_VerifyOK(true), m_ErrorCode(0),
+ : TlsStream(socket, hostname, role, sslContext.get())
+{
+}
+
+/**
+ * Constructor for the TlsStream class.
+ *
+ * @param role The role of the client.
+ * @param sslContext The SSL context for the client.
+ */
+TlsStream::TlsStream(const Socket::Ptr& socket, const String& hostname, ConnectionRole role, const std::shared_ptr<boost::asio::ssl::context>& sslContext)
+ : TlsStream(socket, hostname, role, sslContext->native_handle())
+{
+}
+
+/**
+ * Constructor for the TlsStream class.
+ *
+ * @param role The role of the client.
+ * @param sslContext The SSL context for the client.
+ */
+TlsStream::TlsStream(const Socket::Ptr& socket, const String& hostname, ConnectionRole role, SSL_CTX* sslContext)
+ : SocketEvents(socket), m_Eof(false), m_HandshakeOK(false), m_VerifyOK(true), m_ErrorCode(0),
m_ErrorOccurred(false), m_Socket(socket), m_Role(role), m_SendQ(new FIFO()), m_RecvQ(new FIFO()),
m_CurrentAction(TlsActionNone), m_Retry(false), m_Shutdown(false)
{
std::ostringstream msgbuf;
char errbuf[120];
- m_SSL = std::shared_ptr<SSL>(SSL_new(sslContext.get()), SSL_free);
+ m_SSL = std::shared_ptr<SSL>(SSL_new(sslContext), SSL_free);
if (!m_SSL) {
msgbuf << "SSL_new() failed with code " << ERR_peek_error() << ", \"" << ERR_error_string(ERR_peek_error(), errbuf) << "\"";
}
}
-TlsStream::~TlsStream(void)
+TlsStream::~TlsStream()
{
CloseInternal(true);
}
int TlsStream::ValidateCertificate(int preverify_ok, X509_STORE_CTX *ctx)
{
- SSL *ssl = static_cast<SSL *>(X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
- TlsStream *stream = static_cast<TlsStream *>(SSL_get_ex_data(ssl, m_SSLIndex));
+ auto *ssl = static_cast<SSL *>(X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
+ auto *stream = static_cast<TlsStream *>(SSL_get_ex_data(ssl, m_SSLIndex));
if (!preverify_ok) {
stream->m_VerifyOK = false;
return 1;
}
-bool TlsStream::IsVerifyOK(void) const
+bool TlsStream::IsVerifyOK() const
{
return m_VerifyOK;
}
-String TlsStream::GetVerifyError(void) const
+String TlsStream::GetVerifyError() const
{
return m_VerifyError;
}
*
* @returns The X509 certificate.
*/
-std::shared_ptr<X509> TlsStream::GetClientCertificate(void) const
+std::shared_ptr<X509> TlsStream::GetClientCertificate() const
{
boost::mutex::scoped_lock lock(m_Mutex);
return std::shared_ptr<X509>(SSL_get_certificate(m_SSL.get()), &Utility::NullDeleter);
*
* @returns The X509 certificate.
*/
-std::shared_ptr<X509> TlsStream::GetPeerCertificate(void) const
+std::shared_ptr<X509> TlsStream::GetPeerCertificate() const
{
boost::mutex::scoped_lock lock(m_Mutex);
return std::shared_ptr<X509>(SSL_get_peer_certificate(m_SSL.get()), X509_free);
m_CurrentAction = TlsActionWrite;
else {
ChangeEvents(POLLIN);
+
return;
}
}
*/
ERR_clear_error();
+ size_t readTotal = 0;
+
switch (m_CurrentAction) {
case TlsActionRead:
do {
if (rc > 0) {
m_RecvQ->Write(buffer, rc);
success = true;
+
+ readTotal += rc;
}
- } while (rc > 0);
+
+#ifdef I2_DEBUG /* I2_DEBUG */
+ Log(LogDebug, "TlsStream")
+ << "Read bytes: " << rc << " Total read bytes: " << readTotal;
+#endif /* I2_DEBUG */
+ /* Limit read size. We cannot do this check inside the while loop
+ * since below should solely check whether OpenSSL has more data
+ * or not. */
+ if (readTotal >= 64 * 1024) {
+#ifdef I2_DEBUG /* I2_DEBUG */
+ Log(LogWarning, "TlsStream")
+ << "Maximum read bytes exceeded: " << readTotal;
+#endif /* I2_DEBUG */
+ break;
+ }
+
+ /* Use OpenSSL's state machine here to determine whether we need
+ * to read more data. SSL_has_pending() is available with 1.1.0.
+ */
+ } while (SSL_pending(m_SSL.get()));
if (success)
m_CV.notify_all();
}
}
-void TlsStream::HandleError(void) const
+void TlsStream::HandleError() const
{
if (m_ErrorOccurred) {
BOOST_THROW_EXCEPTION(openssl_error()
}
}
-void TlsStream::Handshake(void)
+void TlsStream::Handshake()
{
boost::mutex::scoped_lock lock(m_Mutex);
m_CurrentAction = TlsActionHandshake;
ChangeEvents(POLLOUT);
- while (!m_HandshakeOK && !m_ErrorOccurred && !m_Eof)
- m_CV.wait(lock);
+ boost::system_time const timeout = boost::get_system_time() + boost::posix_time::milliseconds(long(Configuration::TlsHandshakeTimeout * 1000));
+
+ while (!m_HandshakeOK && !m_ErrorOccurred && !m_Eof && timeout > boost::get_system_time())
+ m_CV.timed_wait(lock, timeout);
+
+ if (timeout < boost::get_system_time())
+ BOOST_THROW_EXCEPTION(std::runtime_error("Timeout was reached (" + Convert::ToString(Configuration::TlsHandshakeTimeout) + ") during TLS handshake."));
if (m_Eof)
BOOST_THROW_EXCEPTION(std::runtime_error("Socket was closed during TLS handshake."));
ChangeEvents(POLLIN|POLLOUT);
}
-void TlsStream::Shutdown(void)
+void TlsStream::Shutdown()
{
m_Shutdown = true;
ChangeEvents(POLLOUT);
/**
* Closes the stream.
*/
-void TlsStream::Close(void)
+void TlsStream::Close()
{
CloseInternal(false);
}
if (!m_SSL)
return;
- (void)SSL_shutdown(m_SSL.get());
+ /* https://www.openssl.org/docs/manmaster/man3/SSL_shutdown.html
+ *
+ * It is recommended to do a bidirectional shutdown by checking
+ * the return value of SSL_shutdown() and call it again until
+ * it returns 1 or a fatal error. A maximum of 2x pending + 2x data
+ * is recommended.
+ */
+ int rc = 0;
+
+ for (int i = 0; i < 4; i++) {
+ if ((rc = SSL_shutdown(m_SSL.get())))
+ break;
+ }
+
m_SSL.reset();
m_Socket->Close();
m_CV.notify_all();
}
-bool TlsStream::IsEof(void) const
+bool TlsStream::IsEof() const
{
- return m_Eof;
+ return m_Eof && m_RecvQ->GetAvailableBytes() < 1u;
}
-bool TlsStream::SupportsWaiting(void) const
+bool TlsStream::SupportsWaiting() const
{
return true;
}
-bool TlsStream::IsDataAvailable(void) const
+bool TlsStream::IsDataAvailable() const
{
boost::mutex::scoped_lock lock(m_Mutex);
return m_RecvQ->GetAvailableBytes() > 0;
}
-Socket::Ptr TlsStream::GetSocket(void) const
+Socket::Ptr TlsStream::GetSocket() const
{
return m_Socket;
}
projects / icinga2 / blobdiff