socks

Class SocksSocket

java.lang.Object

java.net.Socket

socks.SocksSocket

All Implemented Interfaces:

Closeable, AutoCloseable

public class SocksSocket
extends Socket

SocksSocket tryies to look very similar to normal Socket, while allowing connections through the SOCKS4 or 5 proxy. To use this class you will have to identify proxy you need to use, Proxy class allows you to set default proxy, which will be used by all Socks aware sockets. You can also create either Socks4Proxy or Socks5Proxy, and use them by passing to the appropriate constructors.

Using Socks package can be as easy as that:

     import Socks.*;
     ....

     try{
        //Specify SOCKS5 proxy
        Proxy.setDefaultProxy("socks-proxy",1080);

        //OR you still use SOCKS4
        //Code below uses SOCKS4 proxy
        //Proxy.setDefaultProxy("socks-proxy",1080,userName);

        Socket s = SocksSocket("some.host.of.mine",13);
        readTimeFromSock(s);
     }catch(SocksException sock_ex){
        //Usually it will turn in more or less meaningfull message
        System.err.println("SocksException:"+sock_ex);
     }

 

However if the need exist for more control, like resolving addresses remotely, or using some non-trivial authentication schemes, it can be done.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	localHost
protected InetAddress	localIP
protected int	localPort
protected Proxy	proxy
protected String	remoteHost
protected InetAddress	remoteIP
protected int	remotePort

Constructor Summary

Constructors

Modifier	Constructor and Description
	SocksSocket(InetAddress ip, int port) Tryies to connect to given ip and port using default proxy.
protected	SocksSocket(InetAddress ip, int port, Proxy proxy)
	SocksSocket(Proxy p, InetAddress ip, int port) Connects to given ip and port using given Proxy server.
	SocksSocket(Proxy p, String host, int port) Connects to host port using given proxy server.
	SocksSocket(String host, int port) Tryies to connect to given host and port using default proxy.
protected	SocksSocket(String host, int port, Proxy proxy) These 2 constructors are used by the SocksServerSocket.

Method Summary

Modifier and Type	Method and Description
void	close() Same as Socket
String	getHost() Returns remote host name, it is usefull in cases when addresses are resolved by proxy, and we can't create InetAddress object.
InetAddress	getInetAddress() Get remote host as InetAddress object, might return null if addresses are resolved by proxy, and it is not possible to resolve it locally
InputStream	getInputStream() Same as Socket
InetAddress	getLocalAddress() Get address assigned by proxy to make a remote connection, it might be different from the host specified for the proxy.
String	getLocalHost() Get name of the host, proxy has assigned to make a remote connection for this socket.
int	getLocalPort() Get the port assigned by the proxy for the socket, not the port on locall machine as in Socket.
OutputStream	getOutputStream() Same as Socket
int	getPort() Same as Socket
int	getSoLinger(int timeout) Same as socket.
int	getSoTimeout(int timeout) Same as socket.
boolean	getTcpNoDelay() Same as socket.
void	setSoLinger(boolean on, int val) Same as socket.
void	setSoTimeout(int timeout) Same as socket.
void	setTcpNoDelay(boolean on) Same as socket.
String	toString() Get string representation of the socket.

Methods inherited from class java.net.Socket

bind, connect, connect, getChannel, getKeepAlive, getLocalSocketAddress, getOOBInline, getReceiveBufferSize, getRemoteSocketAddress, getReuseAddress, getSendBufferSize, getSoLinger, getSoTimeout, getTrafficClass, isBound, isClosed, isConnected, isInputShutdown, isOutputShutdown, sendUrgentData, setKeepAlive, setOOBInline, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSocketImplFactory, setTrafficClass, shutdownInput, shutdownOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

proxy

protected Proxy proxy

localHost

protected String localHost

remoteHost

protected String remoteHost

localIP

protected InetAddress localIP

remoteIP

protected InetAddress remoteIP

localPort

protected int localPort

remotePort

protected int remotePort

Constructor Detail

SocksSocket

public SocksSocket(String host,
                   int port)
            throws SocksException,
                   UnknownHostException

Tryies to connect to given host and port using default proxy. If no default proxy speciefied it throws SocksException with error code SOCKS_NO_PROXY.

Parameters:

host - Machine to connect to.

port - Port to which to connect.

Throws:

SocksException

UnknownHostException

See Also:

SocksSocket(Proxy,String,int), Socks5Proxy.resolveAddrLocally

SocksSocket

public SocksSocket(Proxy p,
                   String host,
                   int port)
            throws SocksException,
                   UnknownHostException

Connects to host port using given proxy server.

Parameters:

p - Proxy to use.

host - Machine to connect to.

port - Port to which to connect.

Throws:

UnknownHostException - If one of the following happens:

1. Proxy settings say that address should be resolved locally, but this fails.
2. Proxy settings say that the host should be contacted directly but host name can't be resolved.

SocksException - If one of the following happens:

• Proxy is is null.
• Proxy settings say that the host should be contacted directly but this fails.
• Socks Server can't be contacted.
• Authentication fails.
• Connection is not allowed by the SOCKS proxy.
• SOCKS proxy can't establish the connection.
• Any IO error occured.
• Any protocol error occured.

IOexception - if anything is wrong with I/O.

See Also:

Socks5Proxy.resolveAddrLocally

SocksSocket

public SocksSocket(InetAddress ip,
                   int port)
            throws SocksException

Tryies to connect to given ip and port using default proxy. If no default proxy speciefied it throws SocksException with error code SOCKS_NO_PROXY.

Parameters:

ip - Machine to connect to.

port - Port to which to connect.

Throws:

SocksException

See Also:

SocksSocket(Proxy,String,int)

SocksSocket

public SocksSocket(Proxy p,
                   InetAddress ip,
                   int port)
            throws SocksException

Connects to given ip and port using given Proxy server.

Parameters:

p - Proxy to use.

ip - Machine to connect to.

port - Port to which to connect.

Throws:

SocksException

SocksSocket

protected SocksSocket(String host,
                      int port,
                      Proxy proxy)

These 2 constructors are used by the SocksServerSocket. This socket simply overrides remoteHost, remotePort

SocksSocket

protected SocksSocket(InetAddress ip,
                      int port,
                      Proxy proxy)

Method Detail

close

public void close()
           throws IOException

Same as Socket

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class Socket

Throws:

IOException

getInputStream

public InputStream getInputStream()

Same as Socket

Overrides:

getInputStream in class Socket

getOutputStream

public OutputStream getOutputStream()

Same as Socket

Overrides:

getOutputStream in class Socket

getPort

public int getPort()

Same as Socket

Overrides:

getPort in class Socket

getHost

public String getHost()

Returns remote host name, it is usefull in cases when addresses are resolved by proxy, and we can't create InetAddress object.

Returns:

The name of the host this socket is connected to.

getInetAddress

public InetAddress getInetAddress()

Get remote host as InetAddress object, might return null if addresses are resolved by proxy, and it is not possible to resolve it locally

Overrides:

getInetAddress in class Socket

Returns:

Ip address of the host this socket is connected to, or null if address was returned by the proxy as DOMAINNAME and can't be resolved locally.

getLocalPort

public int getLocalPort()

Get the port assigned by the proxy for the socket, not the port on locall machine as in Socket.

Overrides:

getLocalPort in class Socket

Returns:

Port of the socket used on the proxy server.

getLocalAddress

public InetAddress getLocalAddress()

Get address assigned by proxy to make a remote connection, it might be different from the host specified for the proxy. Can return null if socks server returned this address as hostname and it can't be resolved locally, use getLocalHost() then.

Overrides:

getLocalAddress in class Socket

Returns:

Address proxy is using to make a connection.

getLocalHost

public String getLocalHost()

Get name of the host, proxy has assigned to make a remote connection for this socket. This method is usefull when proxy have returned address as hostname, and we can't resolve it on this machine.

Returns:

The name of the host proxy is using to make a connection.

setSoLinger

public void setSoLinger(boolean on,
                        int val)
                 throws SocketException

Same as socket.

Overrides:

setSoLinger in class Socket

Throws:

SocketException

getSoLinger

public int getSoLinger(int timeout)
                throws SocketException

Same as socket.

Throws:

SocketException

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Same as socket.

Overrides:

setSoTimeout in class Socket

Throws:

SocketException

getSoTimeout

public int getSoTimeout(int timeout)
                 throws SocketException

Same as socket.

Throws:

SocketException

setTcpNoDelay

public void setTcpNoDelay(boolean on)
                   throws SocketException

Same as socket.

Overrides:

setTcpNoDelay in class Socket

Throws:

SocketException

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws SocketException

Same as socket.

Overrides:

getTcpNoDelay in class Socket

Throws:

SocketException

toString

public String toString()

Get string representation of the socket.

Overrides:

toString in class Socket