Socks.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_SOCKS_H_
#define _NB_SOCKS_H_
 
#include <predef.h>
#include <tcp.h>
#include <nbstring.h>
 
struct socket_struct;
typedef socket_struct SOCKET;
typedef SOCKET *PSOCKET;
 
#define SOCKS_SUCCESS               (0)    
#define SOCKS_ERR_TIMEOUT           (-500) 
#define SOCKS_BAD_ADR_TYPE          (-501) 
#define SOCKS_CONN_ABORTED          (-502) 
#define SOCKS_BAD_AUTH_TYPE         (-503) 
#define SOCKS_BAD_UN_PW             (-504) 
#define SOCKS_UN_TOO_LONG           (-505) 
#define SOCKS_PW_TOO_LONG           (-506) 
#define SOCKS_BAD_REPLY             (-507) 
#define SOCKS_BAD_DOMAIN            (-508) 
#define SOCKS_CMD_NOT_SUPPORTED     (-509) 
#define SOCKS_BAD_PARAM             (-510) 
#define SOCKS_TIMEOUT (10 * TICKS_PER_SECOND)
#define SOCKS_MAX_UNAME_SIZE 255    
#define SOCKS_MAX_PASSWD_SIZE 255   
 
enum SocksAuthType : unsigned char  
{
    eSocksAuthTypeGssApi = 0x01, 
    eSocksAuthTypeUnPw   = 0x02, 
    eSocksAuthTypeNoAuth = 0x04, 
};
 
 
enum SocksClientCmd : unsigned char
{
    eSocksClientCmdConnect   = 1,  
    eSocksClientCmdBind      = 2,  
    eSocksClientCmdUdpAssoc  = 3   
};
 
enum SocksAdrType : unsigned char
{
    eSocksAdrTypeNone    = 0x00,    
    eSocksAdrTypeIpv4    = 0x01,    
    eSocksAdrTypeDomain  = 0x03,    
    eSocksAdrTypeIpv6    = 0x04     
};
 
 
// Currently not used in code, but defined for future use if needed. Correspond to values returned in
// SOCKS responses per RFC 1928.
enum SocksReply : unsigned char
{
    eSocksReplySuc          = 0,
    eSocksReplyGeneral      = 1,
    eSocksReplyRuleset      = 2,
    eSocksReplyNetwork      = 3,
    eSocksReplyHost         = 4,
    eSocksReplyConRef       = 5,
    eSocksReplyTtlExp       = 6,
    eSocksReplyCmdNotSup    = 7,
    eSocksReplyAdrNotSup    = 8,
};
 
class SocksProxy
{
    public:
        SocksProxy(){};
        SocksProxy( const NBString& adr, uint16_t port, SocksAdrType adrType, SocksAuthType authType, SocksClientCmd cmd, const char* username, const char* password, bool enable );
        SocksProxy( const NBString& adr, uint16_t port, SocksAdrType adrType, SocksAuthType authType, SocksClientCmd cmd, bool enable );
 
        void SetUsername( const NBString& username ){ m_username = username; }
        void SetPassword( const NBString& password ){ m_password = password; }
        void SetPort( uint16_t port ){ m_port = port; }
        void SetAddressType( SocksAdrType adrType ){ m_adrType = adrType; }
        void SetAddress( const NBString& adr ){ m_adr = adr; }
        void SetAuthType( SocksAuthType authType ){ m_authType = authType; }
        void SetClientCmd( SocksClientCmd cmd ){ m_cmd = cmd; }
        void SetEnabled(bool enable){ m_enable = enable; }
        
        NBString& GetUsername(){ return m_username; }
        NBString& GetPassword(){ return m_password; }
        uint16_t GetPort(){ return m_port; }
        SocksAdrType GetAddressType(){ return m_adrType; }
        NBString& GetAddress(){ return m_adr; }
        SocksAuthType GetAuthType(){ return m_authType; }
        SocksClientCmd GetClientCmd(){ return m_cmd; }
        bool IsEnabled(){ return m_enable; }
 
        void ClearProxyValues();
 
        int SocksConnect( PSOCKET socket, uint16_t localPort, uint32_t timeout, const IPADDR &ifip, int ifn );
 
        int SendAuthAndProcessReply( int tcpFd, const IPADDR& adr, int port );
 
    private:
 
        int SocksProcessReply( int tcpFd );
 
        int SendAuthMethod( int tcpFd );
 
        int AuthWithUsrNmPw( int tcpFd );
 
        NBString m_adr;
        NBString m_username;
        NBString m_password;
        uint16_t m_port             = 1080;
        SocksAdrType m_adrType      = eSocksAdrTypeNone;
        SocksAuthType m_authType    = eSocksAuthTypeNoAuth;
        SocksClientCmd m_cmd        = eSocksClientCmdConnect;
        bool m_enable               = false;
};
 
extern SocksProxy* gSocksProxy;
 
/*
 * @brief Try to initiate a SOCKS5 connection with an IP address.
 * 
 * @param auth The authorization type to use. No Authorization and plain text Username and Password are supported. The use of GSSAPI
 * needs to be implemented by the developer by overriding AuthWithGssApi().
 * @param cmd Which command to isssue. Currently only the Connect command is supported. See RFC 1928 for details on the other commands.
 * @param adrType Which address type to use. This function supports IPv4 and IPv6.
 * @param adr The host address to connect to.
 * @param timeout The timeout value for the connection.
 * @param username The username for the connection, if using the username and password authorization type. 
 * @param password The password for the connection, if using the username and password authorization type. 
 * @param socksPort The port to connect to. The default SOCKS port is 1080.
 *
 * @return int The FD of the connection if successful, or a TCP or SOCKS error code if unsuccessful.
 */
//int SocksConnect( PSOCKET socket, IPADDR adr, uint32_t timeout );
 
/*
 * @brief Try to initiate a SOCKS5 connection with a domain name or IP address.
 * 
 * @param auth The authorization type to use. No Authorization and plain text Username and Password are supported. The use of GSSAPI
 * needs to be implemented by the developer by overriding AuthWithGssApi().
 * @param cmd Which command to isssue. Currently only the Connect command is supported. See RFC 1928 for details on the other commands.
 * @param adrType Which address type to use. This function supports IPv4, IPv6, and domain names.
 * @param adr The host address or domain name to connect to.
 * @param timeout The timeout value for the connection.
 * @param username The username for the connection, if using the username and password authorization type. 
 * @param password The password for the connection, if using the username and password authorization type. 
 * @param socksPort The port to connect to. The default SOCKS port is 1080.
 *
 * @return int The FD of the connection if successful, or a TCP or SOCKS error code if unsuccessful.
 */
//int SocksConnect( PSOCKET socket, SocksAuthType auth, SocksClientCmd cmd, SocksAdrType adrType, const NBString& adr, uint32_t timeout, const NBString& username, const NBString& password, uint16_t socksPort = 1080  );
 
 
bool AuthWithGssApi();
 
void SetSocksProxySettings( SocksProxy* socksProxy );
 
SocksProxy* GetSocksProxySettings();
 
#endif /* _NB_SOCKS_H_ */