ZNC  trunk
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Types | Static Protected Member Functions | Protected Attributes | List of all members
CIncomingConnection Class Reference

#include <Listener.h>

+ Inheritance diagram for CIncomingConnection:
+ Collaboration diagram for CIncomingConnection:

Public Types

enum  ETConn { OUTBOUND = 0, LISTENER = 1, INBOUND = 2 }
 
enum  EFRead {
  READ_EOF = 0, READ_ERR = -1, READ_EAGAIN = -2, READ_CONNREFUSED = -3,
  READ_TIMEDOUT = -4
}
 
enum  EFSelect { SEL_OK = 0, SEL_TIMEOUT = -1, SEL_EAGAIN = -2, SEL_ERR = -3 }
 
enum  ESSLMethod {
  TLS = 0, SSL23 = TLS, SSL2 = 2, SSL3 = 3,
  TLS1 = 4, TLS11 = 5, TLS12 = 6
}
 
enum  EDisableProtocol {
  EDP_None = 0, EDP_SSLv2 = 1, EDP_SSLv3 = 2, EDP_TLSv1 = 4,
  EDP_TLSv1_1 = 8, EDP_TLSv1_2 = 16, EDP_SSL = (EDP_SSLv2|EDP_SSLv3)
}
 
enum  ECONState {
  CST_START = 0, CST_DNS = CST_START, CST_BINDVHOST = 1, CST_DESTDNS = 2,
  CST_CONNECT = 3, CST_CONNECTSSL = 4, CST_OK = 5
}
 
enum  ECloseType { CLT_DONT = 0, CLT_NOW = 1, CLT_AFTERWRITE = 2, CLT_DEREFERENCE = 3 }
 
enum  { TMO_READ = 1, TMO_WRITE = 2, TMO_ACCEPT = 4, TMO_ALL = TMO_READ|TMO_WRITE|TMO_ACCEPT }
 this timeout isn't just connection timeout, but also timeout on NOT recieving data, to disable this set it to 0 then the normal TCP timeout will apply (basically TCP will kill a dead connection) Set the timeout, set to 0 to never timeout More...
 
enum  EDNSLType { DNS_VHOST, DNS_DEST }
 

Public Member Functions

 CIncomingConnection (const CString &sHostname, unsigned short uPort, CListener::EAcceptType eAcceptType, const CString &sURIPrefix)
 
virtual ~CIncomingConnection ()
 
void ReadLine (const CString &sData) override
 
void ReachedMaxBuffer () override
 This WARNING event is called when your buffer for readline exceeds the warning threshold and triggers this event. More...
 
int ConvertAddress (const struct sockaddr_storage *pAddr, socklen_t iAddrLen, CString &sIP, u_short *piPort) const override
 
virtual int ConvertAddress (const struct sockaddr_storage *pAddr, socklen_t iAddrLen, CS_STRING &sIP, uint16_t *piPort) const
 retrieve name info (numeric only) for a given sockaddr_storage More...
 
int VerifyPeerCertificate (int iPreVerify, X509_STORE_CTX *pStoreCTX) override
 this is hooked in via SSL_set_verify, and be default it just returns 1 meaning success More...
 
void SSLHandShakeFinished () override
 called once the SSL handshake is complete, this is triggered via SSL_CB_HANDSHAKE_DONE in SSL_set_info_callback() More...
 
bool SNIConfigureClient (CString &sHostname) override
 
virtual bool SNIConfigureClient (CS_STRING &sHostname)
 called to configure the SNI client More...
 
void SetHostToVerifySSL (const CString &sHost)
 
CString GetSSLPeerFingerprint () const
 
void SetSSLTrustedPeerFingerprints (const SCString &ssFPs)
 
void SetTrustAllCerts (bool bTrustAll)
 
bool GetTrustAllCerts () const
 
void SetTrustPKI (bool bTrustPKI)
 
bool GetTrustPKI () const
 
void SetEncoding (const CString &)
 
void SetEncoding (const CS_STRING &sEncoding)
 
virtual CString GetRemoteIP () const
 
virtual CsockGetSockObj (const CS_STRING &sHostname, uint16_t iPort)
 override this for accept sockets More...
 
virtual void Dereference ()
 in the event you pass this class to Copy(), you MUST call this function or on the original Csock other wise bad side effects will happen (double deletes, weird sock closures, etc) if you call this function and have not handled the internal pointers, other bad things can happend (memory leaks, fd leaks, etc) the whole point of this function is to allow this class to go away without shutting down More...
 
virtual void Copy (const Csock &cCopy)
 use this to copy a sock from one to the other, override it if you have special needs in the event of a copy More...
 
Csockoperator<< (const CS_STRING &s)
 
Csockoperator<< (std::ostream &(*io)(std::ostream &))
 
Csockoperator<< (int32_t i)
 
Csockoperator<< (uint32_t i)
 
Csockoperator<< (int64_t i)
 
Csockoperator<< (uint64_t i)
 
Csockoperator<< (float i)
 
Csockoperator<< (double i)
 
virtual bool Connect ()
 Create the connection, this is used by the socket manager, and shouldn't be called directly by the user. More...
 
virtual bool ConnectUnix (const CS_STRING &sPath)
 Connect to a UNIX socket. More...
 
virtual bool ListenUnix (const CS_STRING &sBindFile, int iMaxConns=SOMAXCONN, uint32_t iTimeout=0)
 Listens for connections on an UNIX socket. More...
 
virtual bool Listen (uint16_t iPort, int iMaxConns=SOMAXCONN, const CS_STRING &sBindHost="", uint32_t iTimeout=0, bool bDetach=false)
 Listens for connections. More...
 
virtual cs_sock_t Accept (CS_STRING &sHost, uint16_t &iRPort)
 Accept an inbound connection, this is used internally. More...
 
virtual bool AcceptSSL ()
 Accept an inbound SSL connection, this is used internally and called after Accept. More...
 
virtual bool SSLClientSetup ()
 This sets up the SSL Client, this is used internally. More...
 
virtual bool SSLServerSetup ()
 This sets up the SSL Server, this is used internally. More...
 
virtual bool ConnectSSL ()
 Create the SSL connection. More...
 
bool StartTLS ()
 start a TLS connection on an existing plain connection More...
 
virtual bool Write (const char *data, size_t len)
 Write data to the socket. More...
 
virtual bool Write (const CS_STRING &sData)
 Write a text string to the socket. More...
 
virtual cs_ssize_t Read (char *data, size_t len)
 Read from the socket Just pass in a pointer, big enough to hold len bytes. More...
 
CS_STRING GetLocalIP () const
 
virtual bool IsConnected () const
 Tells you if the socket is connected. More...
 
virtual void SetIsConnected (bool b)
 Sets the sock, telling it its connected (internal use only) More...
 
cs_sock_tGetRSock ()
 returns a reference to the sock More...
 
const cs_sock_tGetRSock () const
 
void SetRSock (cs_sock_t iSock)
 
cs_sock_tGetWSock ()
 
const cs_sock_tGetWSock () const
 
void SetWSock (cs_sock_t iSock)
 
void SetSock (cs_sock_t iSock)
 
cs_sock_tGetSock ()
 
const cs_sock_tGetSock () const
 
void CallSockError (int iErrno, const CS_STRING &sDescription="")
 calls SockError, if sDescription is not set, then strerror is used to pull out a default description More...
 
virtual void ResetTimer ()
 resets the time counter, this is virtual in the event you need an event on the timer being Reset More...
 
void PauseRead ()
 will pause/unpause reading on this socket More...
 
void UnPauseRead ()
 
bool IsReadPaused () const
 
void SetTimeout (int iTimeout, uint32_t iTimeoutType=TMO_ALL)
 Currently this uses the same value for all timeouts, and iTimeoutType merely states which event will be checked for timeouts. More...
 
void SetTimeoutType (uint32_t iTimeoutType)
 
int GetTimeout () const
 
uint32_t GetTimeoutType () const
 
virtual bool CheckTimeout (time_t iNow)
 returns true if the socket has timed out More...
 
virtual void PushBuff (const char *data, size_t len, bool bStartAtZero=false)
 pushes data up on the buffer, if a line is ready it calls the ReadLine event More...
 
CS_STRINGGetInternalReadBuffer ()
 This gives access to the internal read buffer, if your not going to use ReadLine(), then you may want to clear this out (if its binary data and not many '\n') More...
 
CS_STRINGGetInternalWriteBuffer ()
 This gives access to the internal write buffer. More...
 
void SetMaxBufferThreshold (uint32_t iThreshold)
 sets the max buffered threshold when EnableReadLine() is enabled More...
 
uint32_t GetMaxBufferThreshold () const
 
int GetType () const
 Returns the connection type from enum eConnType. More...
 
void SetType (int iType)
 
const CS_STRINGGetSockName () const
 Returns a reference to the socket name. More...
 
void SetSockName (const CS_STRING &sName)
 
const CS_STRINGGetHostName () const
 Returns a reference to the host name. More...
 
void SetHostName (const CS_STRING &sHostname)
 
uint64_t GetStartTime () const
 Gets the starting time of this socket. More...
 
void ResetStartTime ()
 Resets the start time. More...
 
uint64_t GetBytesRead () const
 Gets the amount of data read during the existence of the socket. More...
 
void ResetBytesRead ()
 
uint64_t GetBytesWritten () const
 Gets the amount of data written during the existence of the socket. More...
 
void ResetBytesWritten ()
 
double GetAvgRead (uint64_t iSample=1000) const
 Get Avg Read Speed in sample milliseconds (default is 1000 milliseconds or 1 second) More...
 
double GetAvgWrite (uint64_t iSample=1000) const
 Get Avg Write Speed in sample milliseconds (default is 1000 milliseconds or 1 second) More...
 
uint16_t GetRemotePort () const
 Returns the remote port. More...
 
uint16_t GetLocalPort () const
 Returns the local port. More...
 
uint16_t GetPort () const
 Returns the port. More...
 
void SetPort (uint16_t iPort)
 
void Close (ECloseType eCloseType=CLT_NOW)
 just mark us as closed, the parent can pick it up More...
 
ECloseType GetCloseType () const
 returns int of type to close More...
 
bool IsClosed () const
 
void NonBlockingIO ()
 Use this to change your fd's to blocking or none blocking. More...
 
bool GetSSL () const
 Return true if this socket is using ssl. Note this does not mean the SSL state is finished, but simply that its configured to use ssl. More...
 
void SetSSL (bool b)
 
void DisableSSLProtocols (u_int uDisableOpts)
 bitwise setter, More...
 
void DisableSSLCompression ()
 allow disabling compression More...
 
void FollowSSLCipherServerPreference ()
 select the ciphers in server-preferred order More...
 
void SetCipher (const CS_STRING &sCipher)
 Set the cipher type ( openssl cipher [to see ciphers available] ) More...
 
const CS_STRINGGetCipher () const
 
void SetDHParamLocation (const CS_STRING &sDHParamFile)
 Set the pem file location. More...
 
const CS_STRINGGetDHParamLocation () const
 
void SetKeyLocation (const CS_STRING &sKeyFile)
 
const CS_STRINGGetKeyLocation () const
 
void SetPemLocation (const CS_STRING &sPemFile)
 
const CS_STRINGGetPemLocation () const
 
void SetPemPass (const CS_STRING &sPassword)
 
const CS_STRINGGetPemPass () const
 
void SetSSLMethod (int iMethod)
 Set the SSL method type. More...
 
int GetSSLMethod () const
 
void SetSSLObject (SSL *ssl, bool bDeleteExisting=false)
 
SSL * GetSSLObject () const
 
void SetCTXObject (SSL_CTX *sslCtx, bool bDeleteExisting=false)
 
SSL_SESSION * GetSSLSession () const
 
void SetCertVerifyCB (FPCertVerifyCB pFP)
 setting this to NULL will allow the default openssl verification process kick in More...
 
bool HasWriteBuffer () const
 Get the send buffer. More...
 
void ClearWriteBuffer ()
 
bool SslIsEstablished () const
 is SSL_accept finished ? is the ssl properly finished (from write no error) More...
 
bool ConnectInetd (bool bIsSSL=false, const CS_STRING &sHostname="")
 Use this to bind this socket to inetd. More...
 
bool ConnectFD (int iReadFD, int iWriteFD, const CS_STRING &sName, bool bIsSSL=false, ETConn eDirection=INBOUND)
 Tie this guy to an existing real file descriptor. More...
 
X509 * GetX509 () const
 Get the peer's X509 cert. More...
 
CS_STRING GetPeerPubKey () const
 Returns the peer's public key. More...
 
long GetPeerFingerprint (CS_STRING &sFP) const
 Returns the peer's certificate finger print. More...
 
uint32_t GetRequireClientCertFlags () const
 
void SetRequiresClientCert (bool bRequiresCert)
 legacy, deprecated More...
 
void SetRequireClientCertFlags (uint32_t iRequireClientCertFlags)
 bitwise flags, 0 means don't require cert, SSL_VERIFY_PEER verifies peers, SSL_VERIFY_FAIL_IF_NO_PEER_CERT will cause the connection to fail if no cert More...
 
virtual void SetParentSockName (const CS_STRING &sParentName)
 Set The INBOUND Parent sockname. More...
 
const CS_STRINGGetParentSockName () const
 
virtual void SetRate (uint32_t iBytes, uint64_t iMilliseconds)
 sets the rate at which we can send data More...
 
uint32_t GetRateBytes () const
 
uint64_t GetRateTime () const
 
virtual void Connected ()
 Connected event. More...
 
virtual void Disconnected ()
 Disconnected event. More...
 
virtual void Timeout ()
 Sock Timed out event. More...
 
virtual void ReadData (const char *data, size_t len)
 Ready to read data event. More...
 
virtual void ReadLine (const CS_STRING &sLine)
 Ready to Read a full line event. More...
 
void EnableReadLine ()
 set the value of m_bEnableReadLine to true, we don't want to store a buffer for ReadLine, unless we want it More...
 
void DisableReadLine ()
 
bool HasReadLine () const
 returns the value of m_bEnableReadLine, if ReadLine is enabled More...
 
virtual void SockError (int iErrno, const CS_STRING &sDescription)
 A sock error occured event. More...
 
virtual bool ConnectionFrom (const CS_STRING &sHost, uint16_t iPort)
 Incoming Connection Event return false and the connection will fail default returns true. More...
 
virtual void Listening (const CS_STRING &sBindIP, uint16_t uPort)
 called when type is LISTENER and the listening port is up and running More...
 
virtual void ConnectionRefused ()
 Connection Refused Event. More...
 
virtual void ReadPaused ()
 This gets called every iteration of CSocketManager::Select() if the socket is ReadPaused. More...
 
virtual void SSLFinishSetup (SSL *pSSL)
 Gets called immediatly after the m_ssl member is setup and initialized, useful if you need to assign anything to this ssl session via SSL_set_ex_data. More...
 
virtual bool SNIConfigureServer (const CS_STRING &sHostname, CS_STRING &sPemFile, CS_STRING &sPemPass)
 gets called when a SNI request is sent, and used to configure a SNI session More...
 
SSL_CTX * SetupServerCTX ()
 creates a new SSL_CTX based on the setup of this sock More...
 
time_t GetTimeSinceLastDataTransaction (time_t iNow=0) const
 return how long it has been (in seconds) since the last read or successful write More...
 
time_t GetLastCheckTimeout () const
 
time_t GetNextCheckTimeout (time_t iNow=0) const
 Returns the time when CheckTimeout() should be called next. More...
 
virtual int GetPending () const
 return the data imediatly ready for read More...
 
ECONState GetConState () const
 returns the current connection state More...
 
void SetConState (ECONState eState)
 sets the connection state to eState More...
 
bool CreateSocksFD ()
 grabs fd's for the sockets More...
 
void CloseSocksFD ()
 puts the socks back to the state they were prior to calling CreateSocksFD More...
 
const CS_STRINGGetBindHost () const
 
void SetBindHost (const CS_STRING &sBindHost)
 
int DNSLookup (EDNSLType eDNSLType)
 dns lookup More...
 
bool SetupVHost ()
 this is only used on outbound connections, listeners bind in a different spot More...
 
bool GetIPv6 () const
 
void SetIPv6 (bool b)
 
void SetAFRequire (CSSockAddr::EAFRequire iAFRequire)
 
bool AllowWrite (uint64_t &iNOW) const
 returns true if this socket can write its data, primarily used with rate shaping, initialize iNOW to 0 and it sets it on the first call More...
 
void SetSkipConnect (bool b)
 
virtual int GetAddrInfo (const CS_STRING &sHostname, CSSockAddr &csSockAddr)
 override this call with your own DNS lookup method if you have one. More...
 
int GetMaxConns () const
 returns the number of max pending connections when type is LISTENER More...
 
CS_STRING GetEncoding () const
 
virtual void IcuExtToUCallback (UConverterToUnicodeArgs *toArgs, const char *codeUnits, int32_t length, UConverterCallbackReason reason, UErrorCode *err)
 
virtual void IcuExtFromUCallback (UConverterFromUnicodeArgs *fromArgs, const UChar *codeUnits, int32_t length, UChar32 codePoint, UConverterCallbackReason reason, UErrorCode *err)
 
void CleanupCrons ()
 
void CleanupFDMonitors ()
 
const std::vector< CCron * > & GetCrons () const
 returns a const reference to the crons associated to this socket More...
 
virtual void Cron ()
 This has a garbage collecter, and is used internall to call the jobs. More...
 
virtual void AddCron (CCron *pcCron)
 insert a newly created cron More...
 
virtual void DelCron (const CS_STRING &sName, bool bDeleteAll=true, bool bCaseSensitive=true)
 deletes a cron by name More...
 
virtual void DelCron (uint32_t iPos)
 delete cron by idx More...
 
virtual void DelCronByAddr (CCron *pcCron)
 delete cron by address More...
 
void CheckFDs (const std::map< cs_sock_t, short > &miiReadyFds)
 
void AssignFDs (std::map< cs_sock_t, short > &miiReadyFds, struct timeval *tvtimeout)
 
void MonitorFD (CSMonitorFD *pMonitorFD)
 add an FD set to monitor More...
 

Protected Types

enum  { errnoBadSSLCert = 12569 }
 

Static Protected Member Functions

static CString t_s (const CString &sEnglish, const CString &sContext="")
 
static CInlineFormatMessage t_f (const CString &sEnglish, const CString &sContext="")
 
static CInlineFormatMessage t_p (const CString &sEnglish, const CString &sEnglishes, int iNum, const CString &sContext="")
 
static CDelayedTranslation t_d (const CString &sEnglish, const CString &sContext="")
 

Protected Attributes

std::vector< CCron * > m_vcCrons
 
std::vector< CSMonitorFD * > m_vcMonitorFD
 

Member Enumeration Documentation

anonymous enum
protectedinherited
Enumerator
errnoBadSSLCert 
anonymous enum
inherited

this timeout isn't just connection timeout, but also timeout on NOT recieving data, to disable this set it to 0 then the normal TCP timeout will apply (basically TCP will kill a dead connection) Set the timeout, set to 0 to never timeout

Enumerator
TMO_READ 
TMO_WRITE 
TMO_ACCEPT 
TMO_ALL 
enum Csock::ECloseType
inherited
Enumerator
CLT_DONT 

don't close DER

CLT_NOW 

close immediatly

CLT_AFTERWRITE 

close after finishing writing the buffer

CLT_DEREFERENCE 

used after copy in Csock::Dereference() to cleanup a sock thats being shutdown

enum Csock::ECONState
inherited
Enumerator
CST_START 
CST_DNS 
CST_BINDVHOST 
CST_DESTDNS 
CST_CONNECT 
CST_CONNECTSSL 
CST_OK 
enum Csock::EDisableProtocol
inherited
Enumerator
EDP_None 

disable nothing

EDP_SSLv2 

disable SSL version 2

EDP_SSLv3 

disable SSL version 3

EDP_TLSv1 

disable TLS version 1

EDP_TLSv1_1 

disable TLS version 1.1

EDP_TLSv1_2 

disable TLS version 1.2

EDP_SSL 
enum Csock::EDNSLType
inherited
Enumerator
DNS_VHOST 

this lookup is for the vhost bind

DNS_DEST 

this lookup is for the destination address

enum Csock::EFRead
inherited
Enumerator
READ_EOF 

End Of File, done reading.

READ_ERR 

Error on the socket, socket closed, done reading.

READ_EAGAIN 

Try to get data again.

READ_CONNREFUSED 

Connection Refused.

READ_TIMEDOUT 

Connection timed out.

enum Csock::EFSelect
inherited
Enumerator
SEL_OK 

Select passed ok.

SEL_TIMEOUT 

Select timed out.

SEL_EAGAIN 

Select wants you to try again.

SEL_ERR 

Select recieved an error.

enum Csock::ESSLMethod
inherited
Enumerator
TLS 
SSL23 
SSL2 
SSL3 
TLS1 
TLS11 
TLS12 
enum Csock::ETConn
inherited
Enumerator
OUTBOUND 

outbound connection

LISTENER 

a socket accepting connections

INBOUND 

an inbound connection, passed from LISTENER

Constructor & Destructor Documentation

CIncomingConnection::CIncomingConnection ( const CString sHostname,
unsigned short  uPort,
CListener::EAcceptType  eAcceptType,
const CString sURIPrefix 
)
virtual CIncomingConnection::~CIncomingConnection ( )
inlinevirtual

Member Function Documentation

virtual cs_sock_t Csock::Accept ( CS_STRING sHost,
uint16_t &  iRPort 
)
virtualinherited

Accept an inbound connection, this is used internally.

virtual bool Csock::AcceptSSL ( )
virtualinherited

Accept an inbound SSL connection, this is used internally and called after Accept.

virtual void CSockCommon::AddCron ( CCron pcCron)
virtualinherited

insert a newly created cron

bool Csock::AllowWrite ( uint64_t &  iNOW) const
inherited

returns true if this socket can write its data, primarily used with rate shaping, initialize iNOW to 0 and it sets it on the first call

void CSockCommon::AssignFDs ( std::map< cs_sock_t, short > &  miiReadyFds,
struct timeval *  tvtimeout 
)
inherited
void Csock::CallSockError ( int  iErrno,
const CS_STRING sDescription = "" 
)
inherited

calls SockError, if sDescription is not set, then strerror is used to pull out a default description

Parameters
iErrnothe errno to send
sDescriptionthe description of the error that occurred
void CSockCommon::CheckFDs ( const std::map< cs_sock_t, short > &  miiReadyFds)
inherited
virtual bool Csock::CheckTimeout ( time_t  iNow)
virtualinherited

returns true if the socket has timed out

void CSockCommon::CleanupCrons ( )
inherited
void CSockCommon::CleanupFDMonitors ( )
inherited
void Csock::ClearWriteBuffer ( )
inherited
void Csock::Close ( ECloseType  eCloseType = CLT_NOW)
inherited

just mark us as closed, the parent can pick it up

Referenced by CExecSock::Kill().

void Csock::CloseSocksFD ( )
inherited

puts the socks back to the state they were prior to calling CreateSocksFD

virtual bool Csock::Connect ( )
virtualinherited

Create the connection, this is used by the socket manager, and shouldn't be called directly by the user.

Returns
true on success
virtual void Csock::Connected ( )
inlinevirtualinherited

Connected event.

Reimplemented in CClient, CIRCSock, and CHTTPSock.

bool Csock::ConnectFD ( int  iReadFD,
int  iWriteFD,
const CS_STRING sName,
bool  bIsSSL = false,
ETConn  eDirection = INBOUND 
)
inherited

Tie this guy to an existing real file descriptor.

Referenced by CExecSock::Execute().

bool Csock::ConnectInetd ( bool  bIsSSL = false,
const CS_STRING sHostname = "" 
)
inherited

Use this to bind this socket to inetd.

virtual bool Csock::ConnectionFrom ( const CS_STRING sHost,
uint16_t  iPort 
)
inlinevirtualinherited

Incoming Connection Event return false and the connection will fail default returns true.

virtual void Csock::ConnectionRefused ( )
inlinevirtualinherited

Connection Refused Event.

Reimplemented in CClient, and CIRCSock.

virtual bool Csock::ConnectSSL ( )
virtualinherited

Create the SSL connection.

Returns
true on success

This is used by the socket manager, and shouldn't be called directly by the user.

virtual bool Csock::ConnectUnix ( const CS_STRING sPath)
virtualinherited

Connect to a UNIX socket.

Parameters
sPaththe path to the UNIX socket.
int CZNCSock::ConvertAddress ( const struct sockaddr_storage *  pAddr,
socklen_t  iAddrLen,
CString sIP,
u_short *  piPort 
) const
overrideinherited
virtual int Csock::ConvertAddress ( const struct sockaddr_storage *  pAddr,
socklen_t  iAddrLen,
CS_STRING sIP,
uint16_t *  piPort 
) const
virtualinherited

retrieve name info (numeric only) for a given sockaddr_storage

Parameters
pAddrthe sockaddr_storage
iAddrLenthe length
sIPfilled with the IP from getnameinfo
piPortif not null, filled with the port
Returns
0 on success.

In the event you want to do additional work before or after getnameinfo is called, you can override this and do just that. One example is in the event that an ipv6 ip is a mapped ipv4 mapped, you can check like so.

  • if( pAddr->ss_family == AF_INET6 && IN6_IS_ADDR_V4MAPPED( &(((const struct sockaddr_in6 *)pAddr)->sin6_addr ) )
virtual void Csock::Copy ( const Csock cCopy)
virtualinherited

use this to copy a sock from one to the other, override it if you have special needs in the event of a copy

bool Csock::CreateSocksFD ( )
inherited

grabs fd's for the sockets

virtual void CSockCommon::Cron ( )
virtualinherited

This has a garbage collecter, and is used internall to call the jobs.

virtual void CSockCommon::DelCron ( const CS_STRING sName,
bool  bDeleteAll = true,
bool  bCaseSensitive = true 
)
virtualinherited

deletes a cron by name

Parameters
sNamethe name of the cron
bDeleteAlldelete all crons that match sName
bCaseSensitiveuse strcmp or strcasecmp
virtual void CSockCommon::DelCron ( uint32_t  iPos)
virtualinherited

delete cron by idx

virtual void CSockCommon::DelCronByAddr ( CCron pcCron)
virtualinherited

delete cron by address

virtual void Csock::Dereference ( )
virtualinherited

in the event you pass this class to Copy(), you MUST call this function or on the original Csock other wise bad side effects will happen (double deletes, weird sock closures, etc) if you call this function and have not handled the internal pointers, other bad things can happend (memory leaks, fd leaks, etc) the whole point of this function is to allow this class to go away without shutting down

void Csock::DisableReadLine ( )
inherited
void Csock::DisableSSLCompression ( )
inlineinherited

allow disabling compression

void Csock::DisableSSLProtocols ( u_int  uDisableOpts)
inlineinherited

bitwise setter,

See Also
EDisableProtocol
virtual void Csock::Disconnected ( )
inlinevirtualinherited

Disconnected event.

Reimplemented in CClient, and CIRCSock.

int Csock::DNSLookup ( EDNSLType  eDNSLType)
inherited

dns lookup

See Also
EDNSLType
Returns
0 for success, EAGAIN to check back again (same arguments as before), ETIMEDOUT on failure
void Csock::EnableReadLine ( )
inherited

set the value of m_bEnableReadLine to true, we don't want to store a buffer for ReadLine, unless we want it

void Csock::FollowSSLCipherServerPreference ( )
inlineinherited

select the ciphers in server-preferred order

virtual int Csock::GetAddrInfo ( const CS_STRING sHostname,
CSSockAddr csSockAddr 
)
virtualinherited

override this call with your own DNS lookup method if you have one.

By default this function is blocking

Parameters
sHostnamethe hostname to resolve
csSockAddrthe destination sock address info
See Also
CSSockAddr
Returns
0 on success, ETIMEDOUT if no lookup was found, EAGAIN if you should check again later for an answer
double Csock::GetAvgRead ( uint64_t  iSample = 1000) const
inherited

Get Avg Read Speed in sample milliseconds (default is 1000 milliseconds or 1 second)

double Csock::GetAvgWrite ( uint64_t  iSample = 1000) const
inherited

Get Avg Write Speed in sample milliseconds (default is 1000 milliseconds or 1 second)

const CS_STRING& Csock::GetBindHost ( ) const
inlineinherited
uint64_t Csock::GetBytesRead ( ) const
inherited

Gets the amount of data read during the existence of the socket.

uint64_t Csock::GetBytesWritten ( ) const
inherited

Gets the amount of data written during the existence of the socket.

const CS_STRING& Csock::GetCipher ( ) const
inherited
ECloseType Csock::GetCloseType ( ) const
inlineinherited

returns int of type to close

See Also
ECloseType
ECONState Csock::GetConState ( ) const
inlineinherited

returns the current connection state

const std::vector<CCron *>& CSockCommon::GetCrons ( ) const
inlineinherited

returns a const reference to the crons associated to this socket

const CS_STRING& Csock::GetDHParamLocation ( ) const
inherited
CS_STRING Csock::GetEncoding ( ) const
inlineinherited
const CS_STRING& Csock::GetHostName ( ) const
inherited

Returns a reference to the host name.

CS_STRING& Csock::GetInternalReadBuffer ( )
inherited

This gives access to the internal read buffer, if your not going to use ReadLine(), then you may want to clear this out (if its binary data and not many '\n')

CS_STRING& Csock::GetInternalWriteBuffer ( )
inherited

This gives access to the internal write buffer.

If you want to check if the send queue fills up, check here.

bool Csock::GetIPv6 ( ) const
inlineinherited
const CS_STRING& Csock::GetKeyLocation ( ) const
inherited
time_t Csock::GetLastCheckTimeout ( ) const
inlineinherited
CS_STRING Csock::GetLocalIP ( ) const
inherited
uint16_t Csock::GetLocalPort ( ) const
inherited

Returns the local port.

uint32_t Csock::GetMaxBufferThreshold ( ) const
inherited
int Csock::GetMaxConns ( ) const
inlineinherited

returns the number of max pending connections when type is LISTENER

time_t Csock::GetNextCheckTimeout ( time_t  iNow = 0) const
inherited

Returns the time when CheckTimeout() should be called next.

const CS_STRING& Csock::GetParentSockName ( ) const
inherited
long Csock::GetPeerFingerprint ( CS_STRING sFP) const
inherited

Returns the peer's certificate finger print.

CS_STRING Csock::GetPeerPubKey ( ) const
inherited

Returns the peer's public key.

const CS_STRING& Csock::GetPemLocation ( ) const
inherited
const CS_STRING& Csock::GetPemPass ( ) const
inherited
virtual int Csock::GetPending ( ) const
virtualinherited

return the data imediatly ready for read

uint16_t Csock::GetPort ( ) const
inherited

Returns the port.

uint32_t Csock::GetRateBytes ( ) const
inherited
uint64_t Csock::GetRateTime ( ) const
inherited
virtual CString CZNCSock::GetRemoteIP ( ) const
inlinevirtualinherited

Reimplemented in CHTTPSock.

References Csock::GetRemoteIP().

uint16_t Csock::GetRemotePort ( ) const
inherited

Returns the remote port.

uint32_t Csock::GetRequireClientCertFlags ( ) const
inherited
cs_sock_t& Csock::GetRSock ( )
inherited

returns a reference to the sock

Referenced by CExecSock::~CExecSock().

const cs_sock_t& Csock::GetRSock ( ) const
inherited
cs_sock_t& Csock::GetSock ( )
inherited
const cs_sock_t& Csock::GetSock ( ) const
inherited
const CS_STRING& Csock::GetSockName ( ) const
inherited

Returns a reference to the socket name.

virtual Csock* Csock::GetSockObj ( const CS_STRING sHostname,
uint16_t  iPort 
)
virtualinherited

override this for accept sockets

bool Csock::GetSSL ( ) const
inherited

Return true if this socket is using ssl. Note this does not mean the SSL state is finished, but simply that its configured to use ssl.

int Csock::GetSSLMethod ( ) const
inherited
SSL* Csock::GetSSLObject ( ) const
inherited
CString CZNCSock::GetSSLPeerFingerprint ( ) const
inherited
SSL_SESSION* Csock::GetSSLSession ( ) const
inherited
uint64_t Csock::GetStartTime ( ) const
inherited

Gets the starting time of this socket.

int Csock::GetTimeout ( ) const
inherited
uint32_t Csock::GetTimeoutType ( ) const
inherited
time_t Csock::GetTimeSinceLastDataTransaction ( time_t  iNow = 0) const
inherited

return how long it has been (in seconds) since the last read or successful write

bool CZNCSock::GetTrustAllCerts ( ) const
inlineinherited
bool CZNCSock::GetTrustPKI ( ) const
inlineinherited
int Csock::GetType ( ) const
inherited

Returns the connection type from enum eConnType.

cs_sock_t& Csock::GetWSock ( )
inherited

Referenced by CExecSock::~CExecSock().

const cs_sock_t& Csock::GetWSock ( ) const
inherited
X509* Csock::GetX509 ( ) const
inherited

Get the peer's X509 cert.

it is up to you, the caller to call X509_free() on this object

bool Csock::HasReadLine ( ) const
inlineinherited

returns the value of m_bEnableReadLine, if ReadLine is enabled

bool Csock::HasWriteBuffer ( ) const
inherited

Get the send buffer.

virtual void Csock::IcuExtFromUCallback ( UConverterFromUnicodeArgs *  fromArgs,
const UChar *  codeUnits,
int32_t  length,
UChar32  codePoint,
UConverterCallbackReason  reason,
UErrorCode *  err 
)
virtualinherited

Reimplemented in CIRCSocket.

virtual void Csock::IcuExtToUCallback ( UConverterToUnicodeArgs *  toArgs,
const char *  codeUnits,
int32_t  length,
UConverterCallbackReason  reason,
UErrorCode *  err 
)
virtualinherited

Reimplemented in CIRCSocket.

bool Csock::IsClosed ( ) const
inlineinherited
virtual bool Csock::IsConnected ( ) const
virtualinherited

Tells you if the socket is connected.

bool Csock::IsReadPaused ( ) const
inherited
virtual bool Csock::Listen ( uint16_t  iPort,
int  iMaxConns = SOMAXCONN,
const CS_STRING sBindHost = "",
uint32_t  iTimeout = 0,
bool  bDetach = false 
)
virtualinherited

Listens for connections.

Parameters
iPortthe port to listen on
iMaxConnsthe maximum amount of pending connections to allow
sBindHostthe vhost on which to listen
iTimeoutif no connections come in by this timeout, the listener is closed
bDetachdon't block waiting for port to come up, instead detach and return immediately
virtual void Csock::Listening ( const CS_STRING sBindIP,
uint16_t  uPort 
)
inlinevirtualinherited

called when type is LISTENER and the listening port is up and running

Parameters
sBindIPthe IP that is being bound to. Empty if no bind restriction
uPortthe listening port
virtual bool Csock::ListenUnix ( const CS_STRING sBindFile,
int  iMaxConns = SOMAXCONN,
uint32_t  iTimeout = 0 
)
virtualinherited

Listens for connections on an UNIX socket.

Parameters
sBindFilethe socket on which to listen
iMaxConnsthe maximum amount of pending connections to allow
iTimeoutif no connections come in by this timeout, the listener is closed
void CSockCommon::MonitorFD ( CSMonitorFD pMonitorFD)
inlineinherited

add an FD set to monitor

void Csock::NonBlockingIO ( )
inherited

Use this to change your fd's to blocking or none blocking.

Csock& Csock::operator<< ( const CS_STRING s)
inherited
Csock& Csock::operator<< ( std::ostream &(*)(std::ostream &)  io)
inherited
Csock& Csock::operator<< ( int32_t  i)
inherited
Csock& Csock::operator<< ( uint32_t  i)
inherited
Csock& Csock::operator<< ( int64_t  i)
inherited
Csock& Csock::operator<< ( uint64_t  i)
inherited
Csock& Csock::operator<< ( float  i)
inherited
Csock& Csock::operator<< ( double  i)
inherited
void Csock::PauseRead ( )
inherited

will pause/unpause reading on this socket

virtual void Csock::PushBuff ( const char *  data,
size_t  len,
bool  bStartAtZero = false 
)
virtualinherited

pushes data up on the buffer, if a line is ready it calls the ReadLine event

void CIncomingConnection::ReachedMaxBuffer ( )
overridevirtual

This WARNING event is called when your buffer for readline exceeds the warning threshold and triggers this event.

Either Override it and do nothing, or SetMaxBufferThreshold() This event will only get called if m_bEnableReadLine is enabled

Reimplemented from Csock.

virtual cs_ssize_t Csock::Read ( char *  data,
size_t  len 
)
virtualinherited

Read from the socket Just pass in a pointer, big enough to hold len bytes.

Parameters
datathe buffer to read into
lenthe size of the buffer
Returns
Returns READ_EOF for EOF Returns READ_ERR for ERROR Returns READ_EAGAIN for Try Again ( EAGAIN ) Returns READ_CONNREFUSED for connection refused Returns READ_TIMEDOUT for a connection that timed out at the TCP level Otherwise returns the bytes read into data
virtual void Csock::ReadData ( const char *  data,
size_t  len 
)
inlinevirtualinherited

Ready to read data event.

Reimplemented in CHTTPSock.

void CIncomingConnection::ReadLine ( const CString sData)
override
virtual void Csock::ReadLine ( const CS_STRING sLine)
inlinevirtualinherited

Ready to Read a full line event.

If encoding is provided, this is guaranteed to be UTF-8

virtual void Csock::ReadPaused ( )
inlinevirtualinherited

This gets called every iteration of CSocketManager::Select() if the socket is ReadPaused.

void Csock::ResetBytesRead ( )
inherited
void Csock::ResetBytesWritten ( )
inherited
void Csock::ResetStartTime ( )
inherited

Resets the start time.

virtual void Csock::ResetTimer ( )
virtualinherited

resets the time counter, this is virtual in the event you need an event on the timer being Reset

void Csock::SetAFRequire ( CSSockAddr::EAFRequire  iAFRequire)
inlineinherited
void Csock::SetBindHost ( const CS_STRING sBindHost)
inlineinherited
void Csock::SetCertVerifyCB ( FPCertVerifyCB  pFP)
inlineinherited

setting this to NULL will allow the default openssl verification process kick in

void Csock::SetCipher ( const CS_STRING sCipher)
inherited

Set the cipher type ( openssl cipher [to see ciphers available] )

void Csock::SetConState ( ECONState  eState)
inlineinherited

sets the connection state to eState

void Csock::SetCTXObject ( SSL_CTX *  sslCtx,
bool  bDeleteExisting = false 
)
inherited
void Csock::SetDHParamLocation ( const CS_STRING sDHParamFile)
inherited

Set the pem file location.

void CZNCSock::SetEncoding ( const CString )
inherited
void Csock::SetEncoding ( const CS_STRING sEncoding)
inherited
void Csock::SetHostName ( const CS_STRING sHostname)
inherited
void CZNCSock::SetHostToVerifySSL ( const CString sHost)
inlineinherited
void Csock::SetIPv6 ( bool  b)
inlineinherited
virtual void Csock::SetIsConnected ( bool  b)
virtualinherited

Sets the sock, telling it its connected (internal use only)

void Csock::SetKeyLocation ( const CS_STRING sKeyFile)
inherited
void Csock::SetMaxBufferThreshold ( uint32_t  iThreshold)
inherited

sets the max buffered threshold when EnableReadLine() is enabled

virtual void Csock::SetParentSockName ( const CS_STRING sParentName)
virtualinherited

Set The INBOUND Parent sockname.

void Csock::SetPemLocation ( const CS_STRING sPemFile)
inherited
void Csock::SetPemPass ( const CS_STRING sPassword)
inherited
void Csock::SetPort ( uint16_t  iPort)
inherited
virtual void Csock::SetRate ( uint32_t  iBytes,
uint64_t  iMilliseconds 
)
virtualinherited

sets the rate at which we can send data

Parameters
iBytesthe amount of bytes we can write
iMillisecondsthe amount of time we have to rate to iBytes
void Csock::SetRequireClientCertFlags ( uint32_t  iRequireClientCertFlags)
inlineinherited

bitwise flags, 0 means don't require cert, SSL_VERIFY_PEER verifies peers, SSL_VERIFY_FAIL_IF_NO_PEER_CERT will cause the connection to fail if no cert

void Csock::SetRequiresClientCert ( bool  bRequiresCert)
inherited

legacy, deprecated

See Also
SetRequireClientCertFlags
void Csock::SetRSock ( cs_sock_t  iSock)
inherited

Referenced by CExecSock::~CExecSock().

void Csock::SetSkipConnect ( bool  b)
inlineinherited
void Csock::SetSock ( cs_sock_t  iSock)
inherited
void Csock::SetSockName ( const CS_STRING sName)
inherited
void Csock::SetSSL ( bool  b)
inherited
void Csock::SetSSLMethod ( int  iMethod)
inherited

Set the SSL method type.

void Csock::SetSSLObject ( SSL *  ssl,
bool  bDeleteExisting = false 
)
inherited
void CZNCSock::SetSSLTrustedPeerFingerprints ( const SCString ssFPs)
inlineinherited
void Csock::SetTimeout ( int  iTimeout,
uint32_t  iTimeoutType = TMO_ALL 
)
inherited

Currently this uses the same value for all timeouts, and iTimeoutType merely states which event will be checked for timeouts.

void Csock::SetTimeoutType ( uint32_t  iTimeoutType)
inherited
void CZNCSock::SetTrustAllCerts ( bool  bTrustAll)
inlineinherited
void CZNCSock::SetTrustPKI ( bool  bTrustPKI)
inlineinherited
void Csock::SetType ( int  iType)
inherited
SSL_CTX* Csock::SetupServerCTX ( )
inherited

creates a new SSL_CTX based on the setup of this sock

bool Csock::SetupVHost ( )
inherited

this is only used on outbound connections, listeners bind in a different spot

void Csock::SetWSock ( cs_sock_t  iSock)
inherited

Referenced by CExecSock::~CExecSock().

bool CZNCSock::SNIConfigureClient ( CString sHostname)
overrideinherited
virtual bool Csock::SNIConfigureClient ( CS_STRING sHostname)
virtualinherited

called to configure the SNI client

Parameters
sHostname,thehostname to configure SNI with, you can fill this with GetHostname() if its a valid hostname and not an OP
Returns
returning true causes a call to configure SNI with the hostname returned
virtual bool Csock::SNIConfigureServer ( const CS_STRING sHostname,
CS_STRING sPemFile,
CS_STRING sPemPass 
)
inlinevirtualinherited

gets called when a SNI request is sent, and used to configure a SNI session

Parameters
sHostnamethe hostname sent from the client
sPemFilefill this with the location to the pemfile
sPemPassfill this with the pemfile password if there is one
Returns
return true to proceed with the SNI server configuration
virtual void Csock::SockError ( int  iErrno,
const CS_STRING sDescription 
)
inlinevirtualinherited

A sock error occured event.

virtual bool Csock::SSLClientSetup ( )
virtualinherited

This sets up the SSL Client, this is used internally.

virtual void Csock::SSLFinishSetup ( SSL *  pSSL)
inlinevirtualinherited

Gets called immediatly after the m_ssl member is setup and initialized, useful if you need to assign anything to this ssl session via SSL_set_ex_data.

void CZNCSock::SSLHandShakeFinished ( )
overridevirtualinherited

called once the SSL handshake is complete, this is triggered via SSL_CB_HANDSHAKE_DONE in SSL_set_info_callback()

This is a spot where you can look at the finished peer certifificate ... IE

X509 * pCert = GetX509();
char szName[256];
memset( szName, '\0', 256 );
X509_NAME_get_text_by_NID ( X509_get_subject_name( pCert ), NID_commonName, szName, 255 );
cerr << "Name! " << szName << endl;
X509_free( pCert );

Reimplemented from Csock.

bool Csock::SslIsEstablished ( ) const
inherited

is SSL_accept finished ? is the ssl properly finished (from write no error)

virtual bool Csock::SSLServerSetup ( )
virtualinherited

This sets up the SSL Server, this is used internally.

bool Csock::StartTLS ( )
inherited

start a TLS connection on an existing plain connection

static CDelayedTranslation CCoreTranslationMixin::t_d ( const CString sEnglish,
const CString sContext = "" 
)
staticprotectedinherited
static CInlineFormatMessage CCoreTranslationMixin::t_f ( const CString sEnglish,
const CString sContext = "" 
)
staticprotectedinherited
static CInlineFormatMessage CCoreTranslationMixin::t_p ( const CString sEnglish,
const CString sEnglishes,
int  iNum,
const CString sContext = "" 
)
staticprotectedinherited
static CString CCoreTranslationMixin::t_s ( const CString sEnglish,
const CString sContext = "" 
)
staticprotectedinherited
virtual void Csock::Timeout ( )
inlinevirtualinherited

Sock Timed out event.

Reimplemented in CClient, and CIRCSock.

void Csock::UnPauseRead ( )
inherited
int CZNCSock::VerifyPeerCertificate ( int  iPreVerify,
X509_STORE_CTX *  pStoreCTX 
)
overridevirtualinherited

this is hooked in via SSL_set_verify, and be default it just returns 1 meaning success

Parameters
iPreVerifythe pre-verification status as determined by openssl internally
pStoreCTXthe X509_STORE_CTX containing the certificate
Returns
1 to continue, 0 to abort

This may get called multiple times, for example with a chain certificate which is fairly typical with certificates from godaddy, freessl, etc. Additionally, openssl does not do any host verification, they leave that up to the you. One easy way to deal with this is to wait for SSLHandShakeFinished() and examine the peer certificate

See Also
SSLHandShakeFinished

Reimplemented from Csock.

virtual bool Csock::Write ( const char *  data,
size_t  len 
)
virtualinherited

Write data to the socket.

If not all of the data is sent, it will be stored on an internal buffer, and tried again with next call to Write if the socket is blocking, it will send everything, its ok to check ernno after this (nothing else is processed)

Parameters
datathe data to send
lenthe length of data
virtual bool Csock::Write ( const CS_STRING sData)
virtualinherited

Write a text string to the socket.

Encoding is used, if set

Parameters
sDatathe string to send; if encoding is provided, sData should be UTF-8 and will be encoded
See Also
Write( const char *, int )

Member Data Documentation

std::vector<CCron *> CSockCommon::m_vcCrons
protectedinherited
std::vector<CSMonitorFD *> CSockCommon::m_vcMonitorFD
protectedinherited

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