#include <SocketConnection.h>

Inheritance diagram for core::socket::stream::tls::SocketConnection< PhysicalSocketT >:

Collaboration diagram for core::socket::stream::tls::SocketConnection< PhysicalSocketT >:

Public Types
using	SocketAddress = typename Super::SocketAddress

Public Member Functions
	SocketConnection (const std::string &instanceName, PhysicalSocket &&physicalSocket, const std::function< void(SocketConnection *)> &onDisconnect, const std::string &configuredServer, const SocketAddress &localAddress, const SocketAddress &remoteAddress, const utils::Timeval &readTimeout, const utils::Timeval &writeTimeout, std::size_t readBlockSize, std::size_t writeBlockSize, const utils::Timeval &terminateTimeout)

SSL *	getSSL () const

Private Types
using	Super

using	PhysicalSocket = PhysicalSocketT

using	SocketReader = typename Super::SocketReader

using	SocketWriter = typename Super::SocketWriter

Private Member Functions
SSL *	startSSL (int fd, SSL_CTX *ctx, const utils::Timeval &sslInitTimeout, const utils::Timeval &sslShutdownTimeout, bool closeNotifyIsEOF)

void	stopSSL ()

bool	doSSLHandshake (const std::function< void()> &onSuccess, const std::function< void()> &onTimeout, const std::function< void(int)> &onStatus) final

void	doSSLShutdown ()

void	onReadShutdown () final

void	doWriteShutdown (const std::function< void()> &onShutdown) final

Private Attributes
SSL *	ssl = nullptr

utils::Timeval	sslInitTimeout

utils::Timeval	sslShutdownTimeout

Friends
template<typename PhysicalSocket , typename Config >
class	SocketAcceptor

template<typename PhysicalSocket , typename Config >
class	SocketConnector

Detailed Description

template<typename PhysicalSocketT>
class core::socket::stream::tls::SocketConnection< PhysicalSocketT >

Definition at line 27 of file SocketAcceptor.h.

Member Typedef Documentation

◆ PhysicalSocket

template<typename PhysicalSocketT >

using core::socket::stream::tls::SocketConnection< PhysicalSocketT >::PhysicalSocket = PhysicalSocketT

private

Definition at line 48 of file SocketConnection.h.

◆ SocketAddress

template<typename PhysicalSocketT >

using core::socket::stream::tls::SocketConnection< PhysicalSocketT >::SocketAddress = typename Super::SocketAddress

Definition at line 53 of file SocketConnection.h.

◆ SocketReader

template<typename PhysicalSocketT >

using core::socket::stream::tls::SocketConnection< PhysicalSocketT >::SocketReader = typename Super::SocketReader

private

Definition at line 49 of file SocketConnection.h.

◆ SocketWriter

template<typename PhysicalSocketT >

using core::socket::stream::tls::SocketConnection< PhysicalSocketT >::SocketWriter = typename Super::SocketWriter

private

Definition at line 50 of file SocketConnection.h.

◆ Super

template<typename PhysicalSocketT >

using core::socket::stream::tls::SocketConnection< PhysicalSocketT >::Super

private

Initial value:

core::socket::stream::

SocketConnectionT<PhysicalSocketT, core::socket::stream::tls::SocketReader, core::socket::stream::tls::SocketWriter>

Definition at line 45 of file SocketConnection.h.

Constructor & Destructor Documentation

◆ SocketConnection()

template<typename PhysicalSocket >

core::socket::stream::tls::SocketConnection< PhysicalSocket >::SocketConnection	(	const std::string &	instanceName,
		PhysicalSocket &&	physicalSocket,
		const std::function< void(SocketConnection< PhysicalSocketT > *)> &	onDisconnect,
		const std::string &	configuredServer,
		const SocketAddress &	localAddress,
		const SocketAddress &	remoteAddress,
		const utils::Timeval &	readTimeout,
		const utils::Timeval &	writeTimeout,
		std::size_t	readBlockSize,
		std::size_t	writeBlockSize,
		const utils::Timeval &	terminateTimeout )

Definition at line 39 of file SocketConnection.hpp.

        : Super(
              instanceName,
              std::move(physicalSocket),
              [onDisconnect, this]() {
                  onDisconnect(this);
              },
              configuredServer,
              localAddress,
              remoteAddress,
              readTimeout,
              writeTimeout,
              readBlockSize,
              writeBlockSize,
              terminateTimeout) {
    }

References core::socket::stream::tls::SocketConnection< PhysicalSocketT >::SocketConnection().

Referenced by core::socket::stream::tls::SocketConnection< PhysicalSocketT >::SocketConnection().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ doSSLHandshake()

template<typename PhysicalSocket >

bool core::socket::stream::tls::SocketConnection< PhysicalSocket >::doSSLHandshake	(	const std::function< void()> &	onSuccess,
		const std::function< void()> &	onTimeout,
		const std::function< void(int)> &	onStatus )

finalprivate

Definition at line 109 of file SocketConnection.hpp.

                                                                                                  {
        if (ssl != nullptr) {
            if (!SocketReader::isSuspended()) {
                SocketReader::suspend();
            }
            if (!SocketWriter::isSuspended()) {
                SocketWriter::suspend();
            }
 
            TLSHandshake::doHandshake(
                Super::getConnectionName(),
                ssl,
                [onSuccess, this]() { // onSuccess
                    SocketReader::span();
                    onSuccess();
                },
                [onTimeout]() { // onTimeout
                    onTimeout();
                },
                [onStatus](int sslErr) { // onStatus
                    onStatus(sslErr);
                },
                sslInitTimeout);
        }
 
        return ssl != nullptr;
    }

References core::socket::stream::tls::SocketConnection< PhysicalSocketT >::ssl.

◆ doSSLShutdown()

template<typename PhysicalSocket >

void core::socket::stream::tls::SocketConnection< PhysicalSocket >::doSSLShutdown ( )

private

Definition at line 140 of file SocketConnection.hpp.

                                                         {
        bool resumeSocketReader = false;
        bool resumeSocketWriter = false;
 
        if (!SocketReader::isSuspended()) {
            SocketReader::suspend();
            resumeSocketReader = true;
        }
 
        if (!SocketWriter::isSuspended()) {
            SocketWriter::suspend();
            resumeSocketWriter = true;
        }
 
        TLSShutdown::doShutdown(
            Super::getConnectionName(),
            ssl,
            [this, resumeSocketReader, resumeSocketWriter]() { // onSuccess
                if (resumeSocketReader) {
                    SocketReader::resume();
                }
                if (resumeSocketWriter) {
                    SocketWriter::resume();
                }
                if (SSL_get_shutdown(ssl) == (SSL_SENT_SHUTDOWN | SSL_RECEIVED_SHUTDOWN)) {
                    LOG(DEBUG) << Super::getConnectionName() << " SSL/TLS: Close_notify received and sent";
                } else {
                    LOG(DEBUG) << Super::getConnectionName() << " SSL/TLS: Close_notify sent";
 
                    if (SSL_get_shutdown(ssl) == SSL_SENT_SHUTDOWN && SocketWriter::closeNotifyIsEOF) {
                        LOG(TRACE) << Super::getConnectionName() << " SSL/TLS: Close_notify is EOF: setting sslShutdownTimeout to "
                                   << sslShutdownTimeout << " sec";
                        Super::setTimeout(sslShutdownTimeout);
                    }
                }
            },
            [this, resumeSocketReader, resumeSocketWriter]() { // onTimeout
                if (resumeSocketReader) {
                    SocketReader::resume();
                }
                if (resumeSocketWriter) {
                    SocketWriter::resume();
                }
                LOG(ERROR) << Super::getConnectionName() << " SSL/TLS: Shutdown handshake timed out";
                Super::doWriteShutdown([this]() {
                    SocketConnection::close();
                });
            },
            [this, resumeSocketReader, resumeSocketWriter](int sslErr) { // onStatus
                if (resumeSocketReader) {
                    SocketReader::resume();
                }
                if (resumeSocketWriter) {
                    SocketWriter::resume();
                }
                ssl_log(Super::getConnectionName() + " SSL/TLS: Shutdown handshake failed", sslErr);
                Super::doWriteShutdown([this]() {
                    SocketConnection::close();
                });
            },
            sslShutdownTimeout);
    }

Referenced by core::socket::stream::tls::SocketConnection< PhysicalSocketT >::doWriteShutdown(), and core::socket::stream::tls::SocketConnection< PhysicalSocketT >::onReadShutdown().

Here is the caller graph for this function:

◆ doWriteShutdown()

template<typename PhysicalSocket >

void core::socket::stream::tls::SocketConnection< PhysicalSocket >::doWriteShutdown ( const std::function< void()> & onShutdown )

finalprivate

Definition at line 224 of file SocketConnection.hpp.

                                                                                                {
        if ((SSL_get_shutdown(ssl) & SSL_SENT_SHUTDOWN) == 0) {
            LOG(DEBUG) << Super::getConnectionName() << " SSL/TLS: Send close_notify";
 
            doSSLShutdown();
        } else {
            Super::doWriteShutdown(onShutdown);
        }
    }

References core::socket::stream::tls::SocketConnection< PhysicalSocketT >::doSSLShutdown(), and core::socket::stream::tls::SocketConnection< PhysicalSocketT >::ssl.

Here is the call graph for this function:

◆ getSSL()

template<typename PhysicalSocket >

SSL * core::socket::stream::tls::SocketConnection< PhysicalSocket >::getSSL ( ) const

Definition at line 67 of file SocketConnection.hpp.

                                                        {
        return ssl;
    }

References core::socket::stream::tls::SocketConnection< PhysicalSocketT >::ssl.

◆ onReadShutdown()

template<typename PhysicalSocket >

void core::socket::stream::tls::SocketConnection< PhysicalSocket >::onReadShutdown ( )

finalprivate

Definition at line 204 of file SocketConnection.hpp.

                                                          {
        if ((SSL_get_shutdown(ssl) & SSL_RECEIVED_SHUTDOWN) != 0) {
            if ((SSL_get_shutdown(ssl) & SSL_SENT_SHUTDOWN) != 0) {
                LOG(DEBUG) << Super::getConnectionName() << " SSL/TLS: Close_notify sent and received";
 
                SocketWriter::shutdownInProgress = false;
            } else {
                LOG(DEBUG) << Super::getConnectionName() << " SSL/TLS: Close_notify received";
 
                doSSLShutdown();
            }
        } else {
            LOG(ERROR) << Super::getConnectionName() << " SSL/TLS: Unexpected EOF error";
 
            SocketWriter::shutdownInProgress = false;
            SSL_set_shutdown(ssl, SSL_SENT_SHUTDOWN | SSL_RECEIVED_SHUTDOWN);
        }
    }

References core::socket::stream::tls::SocketConnection< PhysicalSocketT >::doSSLShutdown(), and core::socket::stream::tls::SocketConnection< PhysicalSocketT >::ssl.

Here is the call graph for this function:

◆ startSSL()

template<typename PhysicalSocket >

SSL * core::socket::stream::tls::SocketConnection< PhysicalSocket >::startSSL	(	int	fd,
		SSL_CTX *	ctx,
		const utils::Timeval &	sslInitTimeout,
		const utils::Timeval &	sslShutdownTimeout,
		bool	closeNotifyIsEOF )

private

Definition at line 72 of file SocketConnection.hpp.

                                                                                                                                 {
        this->sslInitTimeout = sslInitTimeout;
        this->sslShutdownTimeout = sslShutdownTimeout;
        if (ctx != nullptr) {
            ssl = SSL_new(ctx);
 
            if (ssl != nullptr) {
                SSL_set_ex_data(ssl, 0, const_cast<std::string*>(&Super::getConnectionName()));
 
                if (SSL_set_fd(ssl, fd) == 1) {
                    SocketReader::ssl = ssl;
                    SocketWriter::ssl = ssl;
                    SocketReader::closeNotifyIsEOF = closeNotifyIsEOF;
                    SocketWriter::closeNotifyIsEOF = closeNotifyIsEOF;
                } else {
                    SSL_free(ssl);
                    ssl = nullptr;
                }
            }
        }
 
        return ssl;
    }

References core::socket::stream::tls::SocketConnection< PhysicalSocketT >::ssl.

◆ stopSSL()

template<typename PhysicalSocket >

void core::socket::stream::tls::SocketConnection< PhysicalSocket >::stopSSL ( )

private

Definition at line 98 of file SocketConnection.hpp.

                                                   {
        if (ssl != nullptr) {
            SSL_free(ssl);
 
            ssl = nullptr;
            SocketReader::ssl = nullptr;
            SocketWriter::ssl = nullptr;
        }
    }

References core::socket::stream::tls::SocketConnection< PhysicalSocketT >::ssl.

Friends And Related Symbol Documentation

◆ SocketAcceptor

template<typename PhysicalSocketT >

template<typename PhysicalSocket , typename Config >

friend class SocketAcceptor

friend

Definition at line 91 of file SocketConnection.h.

◆ SocketConnector

template<typename PhysicalSocketT >

template<typename PhysicalSocket , typename Config >

friend class SocketConnector

friend

Definition at line 94 of file SocketConnection.h.

Member Data Documentation

◆ ssl

template<typename PhysicalSocketT >

SSL* core::socket::stream::tls::SocketConnection< PhysicalSocketT >::ssl = nullptr

private

Definition at line 85 of file SocketConnection.h.

Referenced by core::socket::stream::tls::SocketConnection< PhysicalSocketT >::doSSLHandshake(), core::socket::stream::tls::SocketConnection< PhysicalSocketT >::doWriteShutdown(), core::socket::stream::tls::SocketConnection< PhysicalSocketT >::getSSL(), core::socket::stream::tls::SocketConnection< PhysicalSocketT >::onReadShutdown(), core::socket::stream::tls::SocketConnection< PhysicalSocketT >::startSSL(), and core::socket::stream::tls::SocketConnection< PhysicalSocketT >::stopSSL().

◆ sslInitTimeout

template<typename PhysicalSocketT >

utils::Timeval core::socket::stream::tls::SocketConnection< PhysicalSocketT >::sslInitTimeout

private

Definition at line 87 of file SocketConnection.h.

◆ sslShutdownTimeout

template<typename PhysicalSocketT >

utils::Timeval core::socket::stream::tls::SocketConnection< PhysicalSocketT >::sslShutdownTimeout

private

Definition at line 88 of file SocketConnection.h.

The documentation for this class was generated from the following files:

core/socket/stream/tls/SocketConnection.h
core/socket/stream/tls/SocketConnector.h
core/socket/stream/tls/SocketAcceptor.h
core/socket/stream/tls/SocketConnection.hpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ PhysicalSocket

◆ SocketAddress

◆ SocketReader

◆ SocketWriter

◆ Super

Constructor & Destructor Documentation

◆ SocketConnection()

Member Function Documentation

◆ doSSLHandshake()

◆ doSSLShutdown()

◆ doWriteShutdown()

◆ getSSL()

◆ onReadShutdown()

◆ startSSL()

◆ stopSSL()

Friends And Related Symbol Documentation

◆ SocketAcceptor

◆ SocketConnector

Member Data Documentation

◆ ssl

◆ sslInitTimeout

◆ sslShutdownTimeout