#include <SocketReader.h>

Inheritance diagram for core::socket::stream::tls::SocketReader:

Collaboration diagram for core::socket::stream::tls::SocketReader:

Protected Member Functions
virtual bool	doSSLHandshake (const std::function< void()> &onSuccess, const std::function< void()> &onTimeout, const std::function< void(int)> &onStatus)=0

Protected Member Functions inherited from core::socket::stream::SocketReader
	SocketReader (const std::string &instanceName, const std::function< void(int)> &onStatus, const utils::Timeval &timeout, std::size_t blockSize, const utils::Timeval &terminateTimeout)

void	setBlockSize (std::size_t readBlockSize)

std::size_t	readFromPeer (char *chunk, std::size_t chunkLen)

void	shutdownRead ()

Protected Member Functions inherited from core::eventreceiver::ReadEventReceiver
	ReadEventReceiver (const std::string &name, const utils::Timeval &timeout)

virtual void	readTimeout ()

Protected Member Functions inherited from core::DescriptorEventReceiver
bool	enable (int fd)

void	disable ()

void	suspend ()

void	resume ()

Protected Member Functions inherited from core::Observer
void	observed ()

void	unObserved ()

virtual void	unobservedEvent ()=0

	Observer ()=default

	Observer (Observer &)=delete

	Observer (Observer &&)=delete

virtual	~Observer ()

Protected Member Functions inherited from core::EventReceiver
virtual	~EventReceiver ()=default

	EventReceiver (const std::string &name)

	EventReceiver (EventReceiver &)=delete

	EventReceiver (EventReceiver &&)=delete

EventReceiver &	operator= (EventReceiver &)=delete

EventReceiver &	operator= (EventReceiver &&)=delete

virtual void	destruct ()

void	span ()

void	relax ()

const std::string &	getName () const

Protected Attributes
SSL *	ssl = nullptr

bool	closeNotifyIsEOF = true

Protected Attributes inherited from core::socket::stream::SocketReader
utils::Timeval	terminateTimeout

Private Types
using	Super = core::socket::stream::SocketReader

Private Member Functions
ssize_t	read (char *chunk, std::size_t chunkLen) override

virtual void	onReadShutdown ()=0

Additional Inherited Members
Public Member Functions inherited from core::socket::stream::SocketReader
	SocketReader ()=delete

Public Member Functions inherited from core::DescriptorEventReceiver
	DescriptorEventReceiver (const std::string &name, DescriptorEventPublisher &descriptorEventPublisher, const utils::Timeval &timeout=TIMEOUT::DISABLE)

int	getRegisteredFd () const

bool	isEnabled () const

bool	isSuspended () const

void	setTimeout (const utils::Timeval &timeout)

utils::Timeval	getTimeout (const utils::Timeval &currentTime) const

void	checkTimeout (const utils::Timeval &currentTime)

Public Member Functions inherited from core::EventReceiver
	EventReceiver (const std::string &name)

	EventReceiver (EventReceiver &)=delete

	EventReceiver (EventReceiver &&)=delete

EventReceiver &	operator= (EventReceiver &)=delete

EventReceiver &	operator= (EventReceiver &&)=delete

virtual void	destruct ()

void	span ()

void	relax ()

const std::string &	getName () const

Static Public Member Functions inherited from core::EventReceiver
static void	atNextTick (const std::function< void(void)> &callBack)

Static Protected Member Functions inherited from core::EventReceiver
static void	atNextTick (const std::function< void(void)> &callBack)

Detailed Description

Definition at line 36 of file SocketReader.h.

Member Typedef Documentation

◆ Super

using core::socket::stream::tls::SocketReader::Super = core::socket::stream::SocketReader

private

Definition at line 38 of file SocketReader.h.

Member Function Documentation

◆ doSSLHandshake()

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

protectedpure virtual

◆ onReadShutdown()

virtual void core::socket::stream::tls::SocketReader::onReadShutdown ( )

privatepure virtual

◆ read()

ssize_t core::socket::stream::tls::SocketReader::read	(	char *	chunk,
		std::size_t	chunkLen )

overrideprivatevirtual

Reimplemented from core::socket::stream::SocketReader.

Definition at line 37 of file SocketReader.cpp.

                                                              {
        ssize_t ret = 0;
 
        if ((SSL_get_shutdown(ssl) & SSL_RECEIVED_SHUTDOWN) != 0) {
            ret = Super::read(chunk, chunkLen);
        } else {
            chunkLen = chunkLen > std::numeric_limits<int>::max() ? std::numeric_limits<int>::max() : chunkLen;
            ret = SSL_read(ssl, chunk, static_cast<int>(chunkLen));
 
            if (ret <= 0) {
                const int ssl_err = SSL_get_error(ssl, static_cast<int>(ret));
 
                switch (ssl_err) {
                    case SSL_ERROR_WANT_READ:
                        errno = EAGAIN;
                        ret = -1;
                        break;
                    case SSL_ERROR_WANT_WRITE:
                        LOG(TRACE) << getName() << " SSL/TLS: Start renegotiation on read";
                        doSSLHandshake(
                            [this]() {
                                LOG(DEBUG) << getName() << " SSL/TLS: Renegotiation on read success";
                            },
                            [this]() {
                                LOG(WARNING) << getName() << " SSL/TLS: Renegotiation on read timed out";
                            },
                            [this](int ssl_err) {
                                ssl_log(getName() + " SSL/TLS: Renegotiation on read", ssl_err);
                            });
                        errno = EAGAIN;
                        ret = -1;
                        break;
                    case SSL_ERROR_ZERO_RETURN: // received close_notify
                        LOG(DEBUG) << getName() << " SSL/TLS: Close_notify is" << (closeNotifyIsEOF ? " " : " not ") << "EOF";
                        onReadShutdown();
                        errno = closeNotifyIsEOF ? 0 : EAGAIN;
                        ret = closeNotifyIsEOF ? 0 : -1;
                        break;
                    case SSL_ERROR_SYSCALL: // When SSL_get_error(ssl, ret) returns SSL_ERROR_SYSCALL
                                            // and ret is 0, it indicates that the underlying TCP connection
                                            // was closed unexpectedly by the peer. This situation typically
                                            // happens when the peer closes (FIN) the connection without
                                            // sending a close_notify alert, which violates the SSL/TLS
                                            // protocol’s  graceful shutdown procedure.
                        // In case ret is -1 a real syscall error (RST = ECONNRESET)
                        {
                            const utils::PreserveErrno pe;
 
                            if (ret == 0) {
                                PLOG(DEBUG) << getName() << " SSL/TLS: EOF detected: Connection closed by peer.";
                            } else {
                                PLOG(WARNING) << getName() + " SSL/TLS: Syscall error on read";
                            }
                        }
                        ret = -1;
                        break;
                    case SSL_ERROR_SSL:
                        ssl_log(getName() + " SSL/TLS: Read failed", ssl_err);
                        onReadShutdown();
                        ret = -1;
                        break;
                    default:
                        ssl_log(getName() + " SSL/TLS: Unexpected error", ssl_err);
                        onReadShutdown();
                        errno = EIO;
                        ret = -1;
                        break;
                }
            }
        }
 
        return ret;
    }

Member Data Documentation

◆ closeNotifyIsEOF

bool core::socket::stream::tls::SocketReader::closeNotifyIsEOF = true

protected

Definition at line 52 of file SocketReader.h.

◆ ssl

SSL* core::socket::stream::tls::SocketReader::ssl = nullptr

protected

Definition at line 50 of file SocketReader.h.

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

core/socket/stream/tls/SocketReader.h
core/socket/stream/tls/SocketReader.cpp

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Additional Inherited Members