fucksocks.client

Interface SocksProxy

All Known Implementing Classes:

Socks5, SSLSocks5

public interface SocksProxy

The interface SocksProxy define a SOCKS proxy. it's will be used by SocksSocket or Socks5DatagramSocket

Version:

1.0

Author:

Youchao Feng

date

Mar 18, 2015 3:29:18 PM

Field Summary

Fields

Modifier and Type	Field and Description
static int	SOCKS_DEFAULT_PORT Default SOCKS server port.

Method Summary

Methods

Modifier and Type	Method and Description
Socket	accept() When binded server has income connection, this method will read second response message from SOCKS server.
void	buildConnection() Connect SOCKS server using SOCKS protocol.
SocksProxy	copy() This method can create a same SocksProxy instance.
SocksProxy	copyWithoutChainProxy() Copy the SocksProxy.
Socket	createProxySocket() Creates a unconnected socket.
Socket	createProxySocket(InetAddress address, int port) Creates a proxy socket.
List<SocksMethod>	getAcceptableMethods() Gets clent's acceptable methods.
SocksProxy	getChainProxy() Returns the chain proxy.
Credentials	getCredentials() Gets credentials from the SocksProxy.
InetAddress	getInetAddress() Get SOCKS server's address as IPv4 or IPv6.
InputStream	getInputStream() Gets InputStream from the socket that connected SOCKS server.
OutputStream	getOutputStream() Gets OutputStream from the socket that connected SOCKS server.
int	getPort() Get SOCKS Server port.
Socket	getProxySocket() Get the socket which connect SOCKS server.
SocksMethodRequestor	getSocksMethodRequestor() Gets SocksMethodRequestor.
int	getSocksVersion() Gets version of SOCKS protocol.
CommandReplyMesasge	requestBind(InetAddress inetAddress, int port) This method will send a BIND command to SOKCS server.
CommandReplyMesasge	requestBind(String host, int port) This method will send a BIND command to SOKCS server.
CommandReplyMesasge	requestConnect(InetAddress address, int port) This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.
CommandReplyMesasge	requestConnect(SocketAddress address) This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.
CommandReplyMesasge	requestConnect(String host, int port) This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.
CommandReplyMesasge	requestUdpAssociat(InetAddress address, int port) This method will send a UDP ASSOCIAT command to SOCKS server and ask SOCKS server to establish a relay server.
CommandReplyMesasge	requestUdpAssociat(String host, int port) This method will send a UDP ASSOCIAT command to SOCKS server and ask SOCKS server to establish a relay server.
SocksProxy	setAcceptableMethods(List<SocksMethod> methods) Sets client's acceptable methods.
SocksProxy	setChainProxy(SocksProxy chainProxy) Returns the instance of SocksProxy.
SocksProxy	setCredentials(Credentials credentials) Sets credentials.
SocksProxy	setHost(String host) Set SOCKS server's host.
SocksProxy	setPort(int port) Set SOCKS server port.
SocksProxy	setProxySocket(Socket socket) Set a unconnected socket which will be used to connect SOCKS server.
SocksProxy	setSocksMethodRequestor(SocksMethodRequestor requestor) Sets SocksMethodRequestor.

Field Detail

SOCKS_DEFAULT_PORT

static final int SOCKS_DEFAULT_PORT

Default SOCKS server port.

See Also:

Constant Field Values

Method Detail

getProxySocket

Socket getProxySocket()

Get the socket which connect SOCKS server.

Returns:

java.net.Socket.

getPort

int getPort()

Get SOCKS Server port.

Returns:

server port.

setPort

SocksProxy setPort(int port)

Set SOCKS server port.

Parameters:

port - SOCKS server's port.

Returns:

instance of SocksProxy.

getInetAddress

InetAddress getInetAddress()

Get SOCKS server's address as IPv4 or IPv6.

Returns:

server's IP address.

setHost

SocksProxy setHost(String host)
                   throws UnknownHostException

Set SOCKS server's host.

Parameters:

host - SOCKS server's host.

Returns:

instance of SocksProxy.

Throws:

UnknownHostException - if host can't resolve to InetAddress

setProxySocket

SocksProxy setProxySocket(Socket socket)

Set a unconnected socket which will be used to connect SOCKS server.

Parameters:

socket - a unconnected socket.

Returns:

instance of SocksProxy.

buildConnection

void buildConnection()
                     throws IOException,
                            SocksException

Connect SOCKS server using SOCKS protocol.

This method will ask SOCKS server to select a method from the methods listed by client. If SOCKS server need authentication, it will do authentication. If SOCKS server select 0xFF,It means that none of the methods listed by the client are acceptable and this method should throw SocksException.

Throws:

IOException - if any IO error occurs.

SocksException - if any error about SOCKS protocol occurs.

requestConnect

CommandReplyMesasge requestConnect(String host,
                                 int port)
                                   throws SocksException,
                                          IOException

This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.

Parameters:

host - Remote server's host.

port - Remote server's port.

Returns:

The message that reply by SOCKS server.

Throws:

SocksException - If any error about SOCKS protocol occurs.

IOException - if any I/O error occurs.

requestConnect

CommandReplyMesasge requestConnect(InetAddress address,
                                 int port)
                                   throws SocksException,
                                          IOException

This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.

Parameters:

address - Remote server's address as java.net.InetAddress instance.

port - Remote server's port.

Returns:

The message that reply by SOCKS server.

Throws:

SocksException - If any error about SOCKS protocol occurs.

IOException - If any I/O error occurs.

requestConnect

CommandReplyMesasge requestConnect(SocketAddress address)
                                   throws SocksException,
                                          IOException

This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.

Parameters:

address - Remote server's address as java.net.SocketAddress instance.

Returns:

The message that reply by SOCKS server.

Throws:

SocksException - If any error about SOCKS protocol occurs.

IOException - If any I/O error occurs.

requestBind

CommandReplyMesasge requestBind(String host,
                              int port)
                                throws SocksException,
                                       IOException

This method will send a BIND command to SOKCS server.

Parameters:

host - Remote server's host.

port - Remote server's port.

Returns:

The message that reply by SOCKS server.

Throws:

SocksException - If any error about SOCKS protocol occurs.

IOException - If any I/O error occurs.

requestBind

CommandReplyMesasge requestBind(InetAddress inetAddress,
                              int port)
                                throws SocksException,
                                       IOException

This method will send a BIND command to SOKCS server.

Parameters:

inetAddress - Remote server's IP address.

port - Remote server's port.

Returns:

The message that reply by SOCKS server.

Throws:

SocksException - If any error about SOCKS protocol occurs.

IOException - If any I/O error occurs.

accept

Socket accept()
              throws SocksException,
                     IOException

When binded server has income connection, this method will read second response message from SOCKS server.
This method will be blocked if there is no income connection. When there is a income connection, this method will return a socket that looks like connect the remote host.

Returns:

Socket that connect the remote host.

Throws:

SocksException - If any error about SOCKS protocol occurs.

IOException - If any I/O error occurs.

requestUdpAssociat

CommandReplyMesasge requestUdpAssociat(String host,
                                     int port)
                                       throws SocksException,
                                              IOException

This method will send a UDP ASSOCIAT command to SOCKS server and ask SOCKS server to establish a relay server.

Parameters:

host - Remote UDP server's host.

port - Remote UDP server's port.

Returns:

The message that reply by SOCKS server.

Throws:

SocksException - If any error about SOCKS protocol occurs.

IOException - If any I/O error occurs.

requestUdpAssociat

CommandReplyMesasge requestUdpAssociat(InetAddress address,
                                     int port)
                                       throws SocksException,
                                              IOException

This method will send a UDP ASSOCIAT command to SOCKS server and ask SOCKS server to establish a relay server.

Parameters:

address - Remote UDP server's address.

port - Remote UDP server's port.

Returns:

The message that reply by SOCKS server.

Throws:

SocksException - If any error about SOCKS protocol occurs.

IOException - If any I/O error occurs.

getInputStream

InputStream getInputStream()
                           throws IOException

Gets InputStream from the socket that connected SOCKS server.

Returns:

java.net.InputStream.

Throws:

IOException - if any I/O error occurs.

getOutputStream

OutputStream getOutputStream()
                             throws IOException

Gets OutputStream from the socket that connected SOCKS server.

Returns:

java.net.OutputStream.

Throws:

IOException - if any I/O error occurs.

setCredentials

SocksProxy setCredentials(Credentials credentials)

Sets credentials.

Parameters:

credentials - Credentials instance.

Returns:

instance of SocksProxy.

See Also:

UsernamePasswordCredentials, AnonymousCredentials

getCredentials

Credentials getCredentials()

Gets credentials from the SocksProxy.

Returns:

Credentials instance.

setAcceptableMethods

SocksProxy setAcceptableMethods(List<SocksMethod> methods)

Sets client's acceptable methods.

Parameters:

methods - methods.

Returns:

instance of SocksProxy.

getAcceptableMethods

List<SocksMethod> getAcceptableMethods()

Gets clent's acceptable methods.

Returns:

clent's acceptable methods.

setSocksMethodRequestor

SocksProxy setSocksMethodRequestor(SocksMethodRequestor requestor)

Sets SocksMethodRequestor.

Parameters:

requestor - SocksMethodRequestor

Returns:

instance of SocksProxy.

getSocksMethodRequestor

SocksMethodRequestor getSocksMethodRequestor()

Gets SocksMethodRequestor.

Returns:

SocksMethodRequestor.

getSocksVersion

int getSocksVersion()

Gets version of SOCKS protocol.

Returns:

Version of SOCKS protocol.

copy

SocksProxy copy()

This method can create a same SocksProxy instance.

The new instance created by this method has the same properties with the original instance, but they have different socket instance. The new instance's socket is also unconnected.

Returns:

The copy of this SocksProxy.

copyWithoutChainProxy

SocksProxy copyWithoutChainProxy()

Copy the SocksProxy. It will copy all properties of the SocksProxy but without chain proxy.

Returns:

The copy of this SocksProxy but without chain proxy.

getChainProxy

SocksProxy getChainProxy()

Returns the chain proxy.

Returns:

the chain proxy.

setChainProxy

SocksProxy setChainProxy(SocksProxy chainProxy)

Returns the instance of SocksProxy.

Parameters:

chainProxy - chain proxy.

Returns:

the instance of SocksProxy.

createProxySocket

Socket createProxySocket(InetAddress address,
                       int port)
                         throws IOException

Creates a proxy socket.

Parameters:

address - address.

port - port.

Returns:

Socket instance.

Throws:

IOException - If an I\O error occurred.

createProxySocket

Socket createProxySocket()
                         throws IOException

Creates a unconnected socket.

Throws:

IOException