SOCKS

Topics
	SOCKS Error Codes

Macros
#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

#include< Socks.h>


The NetBurner SOCKS Library

Enumeration Type Documentation

SocksAdrType

enum SocksAdrType : unsigned char

#include <Socks.h>

SOCKS Address Types.

Enumerator
eSocksAdrTypeNone	None.
eSocksAdrTypeIpv4	IPv4.
eSocksAdrTypeDomain	Domain.
eSocksAdrTypeIpv6	IPv6.

SocksAuthType

enum SocksAuthType : unsigned char

#include <Socks.h>

SOCKS Autherization Types.

Enumerator
eSocksAuthTypeGssApi	GSS API.
eSocksAuthTypeUnPw	User name and password.
eSocksAuthTypeNoAuth	Not as defined in RFC so that it could be propery tested against when being set by user.

SocksClientCmd

enum SocksClientCmd : unsigned char

#include <Socks.h>

SOCKS Client Commands.

Enumerator
eSocksClientCmdConnect	Connect.
eSocksClientCmdBind	Not currently supported, see RFC 1928.
eSocksClientCmdUdpAssoc	Not currently supported, see RFC 1928.

Function Documentation

AuthWithGssApi()

bool AuthWithGssApi

(

)

#include <Socks.h>

A weak function that should be overriden by the developer in order to support GSSAPI authorization.

Return values

true	The GSSAPI authorization succeeded.
false	The GSSAPI authorization failed.

GetSocksProxySettings()

SocksProxy * GetSocksProxySettings

(

)

#include <Socks.h>

Get a pointer to the currnetly set Socks proxy settings object.

Returns

SocksProxy*

SetSocksProxySettings()

void SetSocksProxySettings

(

SocksProxy *

socksProxy

)

#include <Socks.h>

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.

Parameters

socksProxy

The proxy object that the system should reference.