NetBurner 3.5.0
PDF Version
 
Socks.h File Reference

NetBurner SOCKS5 API. More...

#include <predef.h>
#include <tcp.h>
#include <nbstring.h>

Go to the source code of this file.

Macros

#define SOCKS_SUCCESS   (0)
 The connection was successful.
 
#define SOCKS_ERR_TIMEOUT   (-500)
 The connection timed out.
 
#define SOCKS_BAD_ADR_TYPE   (-501)
 Address type specified does not match the address provided.
 
#define SOCKS_CONN_ABORTED   (-502)
 The other side aborted the connection.
 
#define SOCKS_BAD_AUTH_TYPE   (-503)
 The server doesn't support the requested authorization types.
 
#define SOCKS_BAD_UN_PW   (-504)
 The server did not approve the username and password provided.
 
#define SOCKS_UN_TOO_LONG   (-505)
 The specified username is too long.
 
#define SOCKS_PW_TOO_LONG   (-506)
 The specified password is too long.
 
#define SOCKS_BAD_REPLY   (-507)
 The server reply was not successful.
 
#define SOCKS_BAD_DOMAIN   (-508)
 Unable to resolve domain name passed.
 
#define SOCKS_CMD_NOT_SUPPORTED   (-509)
 The requested command aren't supported.
 
#define SOCKS_BAD_PARAM   (-510)
 The passed in parameters are not valid.
 
#define SOCKS_MAX_UNAME_SIZE   255
 Max character length for usernames. Defined in RFC 1929.
 
#define SOCKS_MAX_PASSWD_SIZE   255
 Max character length for passwords. Defined in RFC 1929.
 

Enumerations

enum  SocksAuthType : unsigned char { eSocksAuthTypeGssApi = 0x01 , eSocksAuthTypeUnPw = 0x02 , eSocksAuthTypeNoAuth = 0x04 }
 SOCKS Autherization Types. More...
 
enum  SocksClientCmd : unsigned char { eSocksClientCmdConnect = 1 , eSocksClientCmdBind = 2 , eSocksClientCmdUdpAssoc = 3 }
 SOCKS Client Commands. More...
 
enum  SocksAdrType : unsigned char { eSocksAdrTypeNone = 0x00 , eSocksAdrTypeIpv4 = 0x01 , eSocksAdrTypeDomain = 0x03 , eSocksAdrTypeIpv6 = 0x04 }
 SOCKS Address Types. More...
 

Functions

bool AuthWithGssApi ()
 A weak function that should be overriden by the developer in order to support GSSAPI authorization.
 
void SetSocksProxySettings (SocksProxy *socksProxy)
 Set the system level SOCKS proxy settings object to the one that is passed in. If this object is set and is marked as enabled, calls to CoreConnect() (made from connect(), DoGet(), etc), will all initially connect to the proxy server using the SOCKS5 protocol.
 
SocksProxy * GetSocksProxySettings ()
 Get a pointer to the currnetly set Socks proxy settings object.
 

Detailed Description

NetBurner SOCKS5 API.