Merge tls into master: bring in subscription ownership, keep all TLS/stability work
tls and master diverged from a July 2024 fork point and never reconciled - tls carries ~19 months of real socket/TLS stability fixes (uninitialized tlsInfo, TCPServer::connectionRequest() unconditionally initializing TLS, the WANT_READ write busy-spin, the console authentication fix from this session), while master independently picked up a Subscription/SubscriptionManager rework (MString-based ownership tracking: owner/ownership/selection/time fields and a working subscriptionOwner() method) that tls never had. Every file both branches touched was resolved by keeping tls's side entirely (Command.h, Socket.cpp, TCPServer.h, TCPSession.cpp/h, TCPSocket.h were pure reformatting on master's side, or an alternate/superseded fix for a bug tls already fixed a different way - e.g. master's TCPSession uuid/alias handling vs tls's existing uuid_unparse-based fix), with two deliberate exceptions: - TCPServer.cpp's constructor was missing the commands.add(subscriptions, "publish"/"subscribe"/"catalog"/...) wiring master had - without it, SubscriptionManager existed but was completely unreachable through the normal command dispatch. Restored on top of tls's TLS-aware constructor. - SubscriptionManager.cpp's "invite" command handler had a real incompatibility: master's version assigned into an `invitee` member typed as coreutils::MString via a stray `(coreutils::MString *)` cast that doesn't match the member's actual (non-pointer) type, and called session.server.getSessionByAlias() against a TCPServer reference - tls made TCPSession::server a pointer (part of removing the separate TCPSession2 class), so that call site no longer compiles as written. Took tls's cleaner local-variable version instead (functionally identical - looks up a session by alias and forwards an invite message) and removed the now-unused `invitee` member from SubscriptionManager.h. One additional compile fix needed after resolving conflicts: Subscription::subscriptionOwners is an MString (master's ownership design), but TCPSession::alias is void* (tls's identity mechanism, unchanged and depended on elsewhere) - MString has an implicit constructor from void* already used successfully elsewhere in this same file (the "publish" handler's Subscription constructor call), but operator== doesn't accept the same implicit conversion, so removeSessionSubscriptions()'s ownership check needed an explicit coreutils::MString(session.alias) construction to compile. Also drops output/main (a stray checked-in compiled binary, already removed on tls) and the doxygen docs/html output (already removed on tls, was carried on master since the fork). Verified: full ServerCore rebuild (./compile) succeeds with zero errors or warnings beyond the one compile fix documented above.
This commit is contained in:
commit
3609ed603e
2883 files changed
+5296
-84468
No files matched your search
@@ -0,0 +1,178 @@
|
||||
|
||||
#ifndef __TCPSocket_h__
|
||||
#define __TCPSocket_h__
|
||||
|
||||
#include "Socket.h"
|
||||
#include "TLS.h"
|
||||
#include "TLSInfo.h"
|
||||
#include "IPAddress.h"
|
||||
|
||||
namespace core {
|
||||
|
||||
///
|
||||
/// TCPSocket
|
||||
///
|
||||
/// Provides a network TCP socket.
|
||||
///
|
||||
/// For accessing TCP network functions use this object. The connection oriented nature of TCP
|
||||
/// provides a single client persistent connection with data error correction and a durable
|
||||
/// synchronous data connection.
|
||||
///
|
||||
|
||||
class TCPSocket : public Socket, public TLS {
|
||||
|
||||
public:
|
||||
|
||||
///
|
||||
///
|
||||
///
|
||||
|
||||
TCPSocket(EPoll &ePoll);
|
||||
|
||||
///
|
||||
///
|
||||
///
|
||||
|
||||
TCPSocket(EPoll &ePoll, std::string text);
|
||||
|
||||
///
|
||||
///
|
||||
///
|
||||
|
||||
TCPSocket(EPoll &ePoll, TLSInfo *tlsInfo, std::string text);
|
||||
|
||||
///
|
||||
///
|
||||
///
|
||||
|
||||
TCPSocket(EPoll &ePoll, SSL_CTX *ctx, std::string text);
|
||||
|
||||
///
|
||||
///
|
||||
///
|
||||
|
||||
virtual ~TCPSocket();
|
||||
|
||||
///
|
||||
///
|
||||
///
|
||||
|
||||
void connect(IPAddress &address);
|
||||
|
||||
IPAddress ipAddress;
|
||||
|
||||
///
|
||||
/// The output method is called by a socket session (TCPSession) and
|
||||
/// will output the detail information for the client socket. When extending
|
||||
/// TCPSocket or TCPSession you can override the method to add attributes
|
||||
/// to the list.
|
||||
///
|
||||
|
||||
virtual void output(std::stringstream &out);
|
||||
|
||||
///
|
||||
/// Override this method to receive data directly from the socket as data is
|
||||
/// received. If you need data split by line termination characters then
|
||||
/// override the onLineReceived method instead.
|
||||
///
|
||||
|
||||
virtual void onDataReceived(coreutils::ZString &data) override;
|
||||
|
||||
///
|
||||
/// Override the onLineReceived method to receive a string of characters that
|
||||
/// represents a single line of data terminated by a LF or CRLF. If onDataReceived
|
||||
/// was overriden this method will not be called unless the onDataReceived calls
|
||||
/// this method explicitly using the class and member name.
|
||||
///
|
||||
|
||||
virtual void onLineReceived(coreutils::ZString &line);
|
||||
|
||||
///
|
||||
/// Override the onBlockReceived method to receive a string of characters that
|
||||
/// represents a single block of data of length determined by the block length value. If
|
||||
/// onDataReceived was overriden this method will not be called unless the onDataReceived
|
||||
/// calls this method explicitly using the class and member name.
|
||||
///
|
||||
|
||||
virtual void onBlockReceived(coreutils::ZString &block);
|
||||
|
||||
///
|
||||
/// Use setBlockSize to set the amount of data that should be read at once from the
|
||||
/// session data buffer.
|
||||
/// If this value is set to 0 then the data will be retrieved
|
||||
///
|
||||
|
||||
void setBlockSize(int size = 0);
|
||||
|
||||
///
|
||||
/// Dispatches to TLS::receiveData (SSL_read) when this socket was constructed with a
|
||||
/// TLSInfo/SSL_CTX, otherwise falls back to Socket::receiveData (plain ::read). Needed
|
||||
/// because Socket and TLS both declare receiveData as unrelated sibling methods -
|
||||
/// Socket::receiveData is virtual but TLS::receiveData does not override it, so without
|
||||
/// this explicit override TLS::receiveData would never be reached and encrypted bytes
|
||||
/// would be handed to onDataReceived as if they were plaintext.
|
||||
///
|
||||
|
||||
virtual void receiveData(coreutils::ZString &buffer) override;
|
||||
|
||||
///
|
||||
/// Dispatches to TLS::sendData (SSL_write) when this socket was constructed with a
|
||||
/// TLSInfo/SSL_CTX, otherwise falls back to Socket::sendData (plain ::write). Mirrors
|
||||
/// the receiveData override above for the write path.
|
||||
///
|
||||
|
||||
virtual int sendData(const char *data, int length) override;
|
||||
|
||||
///
|
||||
/// Completes the TLS handshake (SSL_new/SSL_set_fd/SSL_accept) for
|
||||
/// THIS socket's own ctx/descriptor. registerSocket()/acceptSocket()
|
||||
/// are protected TLS members, reachable here via an ordinary
|
||||
/// same-class call - the point of exposing this as a public wrapper
|
||||
/// is so a sibling class (TCPServer, which does not inherit
|
||||
/// TCPSocket-the-session's-particular-instance and so cannot reach
|
||||
/// another object's protected members directly) can still trigger
|
||||
/// the handshake on a specific accepted session from
|
||||
/// TCPServer::connectionRequest(), rather than accidentally running
|
||||
/// it against the listening server socket itself (see that call
|
||||
/// site's own comment for the real, confirmed crash this replaces -
|
||||
/// SSL_read() on an accepted session's never-initialized ssl
|
||||
/// member).
|
||||
///
|
||||
|
||||
void performTLSHandshake();
|
||||
|
||||
protected:
|
||||
bool term = false;
|
||||
TLSInfo *tlsInfo;
|
||||
|
||||
private:
|
||||
char *lineBuffer = NULL;
|
||||
int lineBufferSize = 0;
|
||||
int lineLength = 0;
|
||||
int blockSize = 0;
|
||||
|
||||
// Socket's own `lock` (guards receiveData) and `outlock` (guards
|
||||
// writeSocket/the fifo) are two DIFFERENT mutexes - a thread
|
||||
// handling EPOLLIN and a different thread handling EPOLLWRNORM for
|
||||
// the SAME connection can therefore call SSL_read and SSL_write on
|
||||
// the SAME `ssl*` concurrently. OpenSSL does not support that: an
|
||||
// SSL object must not be used by more than one thread at a time
|
||||
// (even in 1.1.0+/3.x, which dropped the old app-supplied
|
||||
// CRYPTO_set_locking_callback global-locking API entirely - that
|
||||
// API never protected concurrent use of one SSL object anyway,
|
||||
// only OpenSSL's own internal global state). Confirmed live via
|
||||
// dmesg: "traps: apiserver[...] general protection fault ... in
|
||||
// libssl.so.3" during ordinary interactive use. ioLock serializes
|
||||
// just the raw SSL_read/SSL_write calls themselves (see
|
||||
// receiveData/sendData below) - deliberately NOT the surrounding
|
||||
// request-handling, which already nests `lock` before `outlock`
|
||||
// (receiveData's call chain reaches Socket::write(), which takes
|
||||
// outlock) - wrapping any larger scope in ioLock+lock+outlock
|
||||
// together risks recreating that same ordering as a new cycle.
|
||||
std::mutex ioLock;
|
||||
|
||||
};
|
||||
|
||||
}
|
||||
|
||||
#endif
|
||||
Reference in new issue
Block a user