SNode.C
Loading...
Searching...
No Matches
core::socket::stream::tls::SocketReader Class Referenceabstract

#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)
std::size_t getTotalRead () const
std::size_t getTotalProcessed () const
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
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 58 of file SocketReader.h.

Member Typedef Documentation

◆ Super

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

Definition at line 60 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

Implemented in core::socket::stream::tls::SocketConnection< PhysicalSocketT, ConfigT >.

Referenced by read().

Here is the caller graph for this function:

◆ onReadShutdown()

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

Implemented in core::socket::stream::tls::SocketConnection< PhysicalSocketT, ConfigT >.

Referenced by read().

Here is the caller graph for this function:

◆ 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 59 of file SocketReader.cpp.

59 {
60 ssize_t ret = 0;
61
62 if ((SSL_get_shutdown(ssl) & SSL_RECEIVED_SHUTDOWN) != 0) {
63 ret = Super::read(chunk, chunkLen);
64 } else {
65 chunkLen = chunkLen > std::numeric_limits<int>::max() ? std::numeric_limits<int>::max() : chunkLen;
66 ret = SSL_read(ssl, chunk, static_cast<int>(chunkLen));
67
68 if (ret <= 0) {
69 const int ssl_err = SSL_get_error(ssl, static_cast<int>(ret));
70
71 switch (ssl_err) {
72 case SSL_ERROR_WANT_READ:
73 errno = EAGAIN;
74 ret = -1;
75 break;
76 case SSL_ERROR_WANT_WRITE:
77 LOG(TRACE) << getName() << " SSL/TLS: Start renegotiation on read";
78 doSSLHandshake(
79 [this]() {
80 LOG(DEBUG) << getName() << " SSL/TLS: Renegotiation on read success";
81 },
82 [this]() {
83 LOG(WARNING) << getName() << " SSL/TLS: Renegotiation on read timed out";
84 },
85 [this](int ssl_err) {
86 ssl_log(getName() + " SSL/TLS: Renegotiation on read", ssl_err);
87 });
88 errno = EAGAIN;
89 ret = -1;
90 break;
91 case SSL_ERROR_ZERO_RETURN: // received close_notify
92 onReadShutdown();
93 errno = EAGAIN;
94 ret = -1;
95 break;
96 case SSL_ERROR_SYSCALL: // When SSL_get_error(ssl, ret) returns SSL_ERROR_SYSCALL
97 // and ret is 0, it indicates that the underlying TCP connection
98 // was closed unexpectedly by the peer. This situation typically
99 // happens when the peer closes (FIN) the connection without
100 // sending a close_notify alert, which violates the SSL/TLS
101 // protocol’s graceful shutdown procedure.
102 // In case ret is -1 a real syscall error (RST = ECONNRESET)
103 {
104 const utils::PreserveErrno pe;
105
106 if (ret == 0) {
107 PLOG(DEBUG) << getName() << " SSL/TLS: EOF detected: Connection closed by peer.";
108 } else {
109 PLOG(WARNING) << getName() + " SSL/TLS: Syscall error on read";
110 }
111 }
112 ret = -1;
113 break;
114 case SSL_ERROR_SSL:
115 ssl_log(getName() + " SSL/TLS: Read failed", ssl_err);
116 onReadShutdown();
117 ret = -1;
118 break;
119 default:
120 ssl_log(getName() + " SSL/TLS: Unexpected error", ssl_err);
121 onReadShutdown();
122 errno = EIO;
123 ret = -1;
124 break;
125 }
126 }
127 }
128
129 return ret;
130 }
core::EventReceiver::getName
const std::string & getName() const
Definition EventReceiver.cpp:87
core::socket::stream::SocketReader::read
virtual ssize_t read(char *chunk, std::size_t chunkLen)
Definition SocketReader.cpp:85
core::socket::stream::tls::SocketReader::doSSLHandshake
virtual bool doSSLHandshake(const std::function< void()> &onSuccess, const std::function< void()> &onTimeout, const std::function< void(int)> &onStatus)=0
core::socket::stream::tls::ssl_log
void ssl_log(const std::string &message, int sslErr)
Definition ssl_utils.cpp:316
core::ssl::SSL_read
int SSL_read(SSL *ssl, void *buf, int num)
Definition ssl.cpp:53

References doSSLHandshake(), core::EventReceiver::getName(), onReadShutdown(), core::socket::stream::SocketReader::read(), ssl, and core::socket::stream::tls::ssl_log().

Here is the call graph for this function:

Member Data Documentation

◆ ssl

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

Definition at line 72 of file SocketReader.h.

Referenced by read().

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