Skip to content

clean up the code #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

clean up the code #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ad2512
clean up the code
Jul 1, 2025
7abdb3f
corrected the decision algorithm for log switch
Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
415 changes: 256 additions & 159 deletions Socket/SecureSocket.cpp
View file
Open in desktop

Large diffs are not rendered by default.

227 changes: 94 additions & 133 deletions Socket/SecureSocket.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
/*
* @file SecureSocket.h
* @brief Abstract class to perform OpenSSL API global operations
*
* @author Mohamed Amine Mzoughi <mohamed-amine.mzoughi@laposte.net>
* @date 2017-02-16
*/
/**
* @file SecureSocket.h
* @brief Abstract class to perform OpenSSL API global operations
*
* @author Mohamed Amine Mzoughi <mohamed-amine.mzoughi@laposte.net>
* @date 2017-02-16
*/

#ifdef OPENSSL
#ifndef INCLUDE_ASECURESOCKET_H_
#define INCLUDE_ASECURESOCKET_H_

#include <atomic>
#ifdef OPENSSL
#include <openssl/bio.h>
#include <openssl/ssl.h>
Expand All @@ -21,137 +22,97 @@
class ASecureSocket : public ASocket
{
public:
enum class OpenSSLProtocol
{
#ifndef LINUX
//SSL_V2, // deprecated
#endif
//SSL_V3, // deprecated
TLS_V1,
SSL_V23, /* There is no SSL protocol version named SSLv23. The SSLv23_method() API
and its variants choose SSLv2, SSLv3, or TLSv1 for compatibility with the peer. */
TLS // Standard Protocol as of 11/2018, OpenSSL will choose highest possible TLS standard between peers
};

struct SSLSocket
{
SSLSocket() :
m_SockFd(INVALID_SOCKET),
m_pSSL(nullptr),
m_pCTXSSL(nullptr),
m_pMTHDSSL(nullptr)
{
}

// copy constructor and assignment operator are disabled
SSLSocket(const SSLSocket&) = delete;
SSLSocket& operator=(const SSLSocket&) = delete;

// move constructor
SSLSocket(SSLSocket&& Sockother) :
m_SockFd(Sockother.m_SockFd),
m_pSSL(Sockother.m_pSSL),
m_pCTXSSL(Sockother.m_pCTXSSL),
m_pMTHDSSL(Sockother.m_pMTHDSSL)
{
Sockother.m_SockFd = INVALID_SOCKET;
Sockother.m_pSSL = nullptr;
Sockother.m_pCTXSSL = nullptr;
Sockother.m_pMTHDSSL = nullptr;
}

// move assignment operator
SSLSocket& operator=(SSLSocket&& Sockother)
{
if (this != &Sockother)
{
m_SockFd = Sockother.m_SockFd;
m_pSSL = Sockother.m_pSSL;
m_pCTXSSL = Sockother.m_pCTXSSL;
m_pMTHDSSL = Sockother.m_pMTHDSSL;

// reset Sockother
Sockother.m_SockFd = INVALID_SOCKET;
Sockother.m_pSSL = nullptr;
Sockother.m_pCTXSSL = nullptr;
Sockother.m_pMTHDSSL = nullptr;
}
return *this;
}

Socket m_SockFd;
SSL* m_pSSL;
SSL_CTX* m_pCTXSSL; // SSL Context Structure
SSL_METHOD* m_pMTHDSSL; // used to create an SSL_CTX
};

/* Please provide your logger thread-safe routine, otherwise, you can turn off
* error log messages printing by not using the flag ALL_FLAGS or ENABLE_LOG */
explicit ASecureSocket(const LogFnCallback& oLogger,
const OpenSSLProtocol eSSLVersion = OpenSSLProtocol::TLS,
const SettingsFlag eSettings = ALL_FLAGS);
virtual ~ASecureSocket() = 0;

/*
* For the SSL server:
* Server's own certificate (mandatory)
* CA certificate (optional)
*
* For the SSL client:
* CA certificate (mandatory)
* Client's own certificate (optional)
*/
inline const std::string& GetSSLCertAuth() { return m_strCAFile; }
inline void SetSSLCerthAuth(const std::string& strPath) { m_strCAFile = strPath; }

inline void SetSSLCertFile(const std::string& strPath) { m_strSSLCertFile = strPath; }
inline const std::string& GetSSLCertFile() const { return m_strSSLCertFile; }

inline void SetSSLKeyFile(const std::string& strPath) { m_strSSLKeyFile = strPath; }
inline const std::string& GetSSLKeyFile() const { return m_strSSLKeyFile; }

//void SetSSLKeyPassword(const std::string& strPwd) { m_strSSLKeyPwd = strPwd; }
//const std::string& GetSSLKeyPwd() const { return m_strSSLKeyPwd; }
enum class OpenSSLProtocol
{
#ifdef _WIN32
//SSL_V2, // deprecated
#endif
//SSL_V3, // deprecated
TLS_V1,
SSL_V23, /* There is no SSL protocol version named SSLv23. The SSLv23_method() API
and its variants choose SSLv2, SSLv3, or TLSv1 for compatibility with the peer. */
TLS // Standard Protocol as of 11/2018, OpenSSL will choose highest possible TLS standard between peers
};

struct SSLSocket
{
SSLSocket();
~SSLSocket();

// copy constructor and assignment operator are disabled
SSLSocket(const SSLSocket&) = delete;
SSLSocket& operator=(const SSLSocket&) = delete;

// move constructor
SSLSocket(SSLSocket&& Sockother);
// move assignment operator
SSLSocket& operator=(SSLSocket&& Sockother);

void Disconnect();

bool HasPending() const;
int PendingBytes() const;

Socket m_SockFd;
SSL* m_pSSL;
SSL_CTX* m_pCTXSSL; // SSL Context Structure
SSL_METHOD* m_pMTHDSSL; // used to create an SSL_CTX
};

/**
* Please provide your logger thread-safe routine, otherwise, you can turn off
* error log messages printing by not using the flag ALL_FLAGS or ENABLE_LOG
*/
explicit ASecureSocket(const LogFnCallback& oLogger,
const OpenSSLProtocol& eSSLVersion = OpenSSLProtocol::TLS,
const SettingsFlag& eSettings = ALL_FLAGS);
virtual ~ASecureSocket();

/**
* For the SSL server:
* Server's own certificate (mandatory)
* CA certificate (optional)
*
* For the SSL client:
* CA certificate (mandatory)
* Client's own certificate (optional)
*/
inline const std::string& GetSSLCertAuth() { return m_strCAFile; }
inline void SetSSLCerthAuth(const std::string& strPath) { m_strCAFile = strPath; }

inline void SetSSLCertFile(const std::string& strPath) { m_strSSLCertFile = strPath; }
inline const std::string& GetSSLCertFile() const { return m_strSSLCertFile; }

inline void SetSSLKeyFile(const std::string& strPath) { m_strSSLKeyFile = strPath; }
inline const std::string& GetSSLKeyFile() const { return m_strSSLKeyFile; }

//void SetSSLKeyPassword(const std::string& strPwd) { m_strSSLKeyPwd = strPwd; }
//const std::string& GetSSLKeyPwd() const { return m_strSSLKeyPwd; }

protected:
// object methods
void SetUpCtxClient(SSLSocket& Socket);
void SetUpCtxServer(SSLSocket& Socket);
//void SetUpCtxCombined(SSLSocket& Socket);

// class methods
static void ShutdownSSL(SSLSocket& SSLSocket);
static const char* GetSSLErrorString(int iErrorCode);
static int AlwaysTrueCallback(X509_STORE_CTX* pCTX, void* pArg);

// non-static/object members
OpenSSLProtocol m_eOpenSSLProtocol;
std::string m_strCAFile;
std::string m_strSSLCertFile;
std::string m_strSSLKeyFile;
//std::string m_strSSLKeyPwd;

private:
friend class SecureSocketGlobalInitializer;
class SecureSocketGlobalInitializer {
public:
static SecureSocketGlobalInitializer& instance();

SecureSocketGlobalInitializer(SecureSocketGlobalInitializer const&) = delete;
SecureSocketGlobalInitializer(SecureSocketGlobalInitializer&&) = delete;
// object methods
bool SetUpCtxClient(SSLSocket& Socket);
bool SetUpCtxServer(SSLSocket& Socket);
//void SetUpCtxCombined(SSLSocket& Socket);

SecureSocketGlobalInitializer& operator=(SecureSocketGlobalInitializer const&) = delete;
SecureSocketGlobalInitializer& operator=(SecureSocketGlobalInitializer&&) = delete;
// class methods
static void ShutdownSSL(SSLSocket& SSLSocket);
static const char* GetSSLErrorString(int iErrorCode);
static int AlwaysTrueCallback(X509_STORE_CTX* pCTX, void* pArg);

~SecureSocketGlobalInitializer();

private:
SecureSocketGlobalInitializer();
};
SecureSocketGlobalInitializer& m_globalInitializer;
private:
static void InitializeSSL();
static void DestroySSL();

static void InitializeSSL();
static void DestroySSL();
protected:
// non-static/object members
OpenSSLProtocol m_eOpenSSLProtocol;
std::string m_strCAFile;
std::string m_strSSLCertFile;
std::string m_strSSLKeyFile;
//std::string m_strSSLKeyPwd;

static std::atomic<int> s_iSecureSocketCount; // Count of the actual secure socket sessions
};

#endif
Expand Down
Loading