Socks5 (fucksocks 1.0.0 API)

java.lang.Object
- fucksocks.client.Socks5

All Implemented Interfaces:

SocksProxy

Direct Known Subclasses:

SSLSocks5
```
public class Socks5
extends Object
implements SocksProxy
```
The class Socks5 has implements SOCKS5 protocol.

Version:

1.0

Author:

Youchao Feng

See Also:
SOCKS Protocol Version 5
date

Mar 16, 2015 4:57:32 PM

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`AUTHENTICATION_SUCCEEDED` Authentication succeeded code.
`protected static org.slf4j.Logger`	`logger` Logger.
`static int`	`REP_ADDRESS_TYPE_NOT_SUPPORTED`
`static int`	`REP_COMMAND_NOT_SUPPORTED`
`static int`	`REP_CONNECTION_NOT_ALLOWED_BY_RULESET`
`static int`	`REP_CONNECTION_REFUSED`
`static int`	`REP_GENERAL_SOCKS_SERVER_FAILURE`
`static int`	`REP_HOST_UNREACHABLE`
`static int`	`REP_NETWORK_UNREACHABLE`
`static int`	`REP_SUCCEEDED`
`static int`	`REP_TTL_EXPIRED`
`static byte`	`RESERVED` Reserved field.
`static byte`	`SOCKS_VERSION` Version of SOCKS protocol.

Fields inherited from interface fucksocks.client.SocksProxy
SOCKS_DEFAULT_PORT

Constructor Summary

Constructors
Constructor and Description
`Socks5(InetAddress inetAddress, int port)` Constructs a Socks5 instance.
`Socks5(SocketAddress socketAddress)` Constructs a Socks5 instance with a java.net.SocketAddress instance.
`Socks5(SocketAddress socketAddress, String username, String password)` Constructs a Socks5 instance.
`Socks5(SocksProxy chainProxy, SocketAddress socketAddress)`
`Socks5(String host, int port)` Constructs a Socks5 instance.
`Socks5(String host, int port, Credentials credentials)` Constructs a Socks instance.

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.
`boolean`	`isAlwaysResolveAddressLocally()`
`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.
`Socks5`	`setAcceptableMethods(List<SocksMethod> acceptableMethods)` Sets client's acceptable methods.
`Socks5`	`setAlwaysResolveAddressLocally(boolean alwaysResolveAddressLocally)`
`SocksProxy`	`setChainProxy(SocksProxy chainProxy)` Returns the instance of `SocksProxy`.
`Socks5`	`setCredentials(Credentials credentials)` Sets credentials.
`Socks5`	`setHost(String host)` Set SOCKS server's host.
`Socks5`	`setInetAddress(InetAddress inetAddress)` Sets SOCKS5 proxy server's IP address.
`Socks5`	`setPort(int port)` Set SOCKS server port.
`Socks5`	`setProxySocket(Socket proxySocket)` Set a unconnected socket which will be used to connect SOCKS server.
`Socks5`	`setSocksMethodRequestor(SocksMethodRequestor requestor)` Sets `SocksMethodRequestor`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - logger
```
protected static final org.slf4j.Logger logger
```
    Logger.
  - SOCKS_VERSION
```
public static final byte SOCKS_VERSION
```
    Version of SOCKS protocol.
    
    See Also:
    Constant Field Values
  - RESERVED
```
public static final byte RESERVED
```
    Reserved field.
    
    See Also:
    Constant Field Values
  - REP_SUCCEEDED
```
public static final int REP_SUCCEEDED
```
    See Also:
    Constant Field Values
  - REP_GENERAL_SOCKS_SERVER_FAILURE
```
public static final int REP_GENERAL_SOCKS_SERVER_FAILURE
```
    See Also:
    Constant Field Values
  - REP_CONNECTION_NOT_ALLOWED_BY_RULESET
```
public static final int REP_CONNECTION_NOT_ALLOWED_BY_RULESET
```
    See Also:
    Constant Field Values
  - REP_NETWORK_UNREACHABLE
```
public static final int REP_NETWORK_UNREACHABLE
```
    See Also:
    Constant Field Values
  - REP_HOST_UNREACHABLE
```
public static final int REP_HOST_UNREACHABLE
```
    See Also:
    Constant Field Values
  - REP_CONNECTION_REFUSED
```
public static final int REP_CONNECTION_REFUSED
```
    See Also:
    Constant Field Values
  - REP_TTL_EXPIRED
```
public static final int REP_TTL_EXPIRED
```
    See Also:
    Constant Field Values
  - REP_COMMAND_NOT_SUPPORTED
```
public static final int REP_COMMAND_NOT_SUPPORTED
```
    See Also:
    Constant Field Values
  - REP_ADDRESS_TYPE_NOT_SUPPORTED
```
public static final int REP_ADDRESS_TYPE_NOT_SUPPORTED
```
    See Also:
    Constant Field Values
  - AUTHENTICATION_SUCCEEDED
```
public static final byte AUTHENTICATION_SUCCEEDED
```
    Authentication succeeded code.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Socks5
```
public Socks5(SocketAddress socketAddress,
      String username,
      String password)
```
    Constructs a Socks5 instance.
    
    Parameters:
    socketAddress - SOCKS5 server's address.
    username - Username of the authentication.
    password - Password of the authentication.
  - Socks5
```
public Socks5(String host,
      int port)
       throws UnknownHostException
```
    Constructs a Socks5 instance.
    
    Parameters:
    host - SOCKS5's server host.
    port - SOCKS5's server port.
    
    Throws:
    
    UnknownHostException - If the host can't be resolved.
  - Socks5
```
public Socks5(InetAddress inetAddress,
      int port)
```
    Constructs a Socks5 instance.
    
    Parameters:
    inetAddress - SOCKS5 server's address.
    port - SOCKS5 server's port.
  - Socks5
```
public Socks5(SocketAddress socketAddress)
```
    Constructs a Socks5 instance with a java.net.SocketAddress instance.
    
    Parameters:
    socketAddress - SOCKS5 server's address.
  - Socks5
```
public Socks5(SocksProxy chainProxy,
      SocketAddress socketAddress)
```
  - Socks5
```
public Socks5(String host,
      int port,
      Credentials credentials)
       throws UnknownHostException
```
    Constructs a Socks instance.
    
    Parameters:
    host - SOCKS5 server's host.
    port - SOCKS5 server's port.
    credentials - credentials.
    
    Throws:
    
    UnknownHostException - If the host can't be resolved.
- Method Detail
  - buildConnection
```
public void buildConnection()
                     throws SocksException,
                            IOException
```
    Description copied from interface: SocksProxy
    
    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.
    
    Specified by:
    
    buildConnection in interface SocksProxy
    
    Throws:
    
    SocksException - if any error about SOCKS protocol occurs.
    
    IOException - if any IO error occurs.
  - requestConnect
```
public CommandReplyMesasge requestConnect(String host,
                                 int port)
                                   throws SocksException,
                                          IOException
```
    Description copied from interface: SocksProxy
    
    This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.
    
    Specified by:
    
    requestConnect in interface SocksProxy
    
    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
```
public CommandReplyMesasge requestConnect(InetAddress address,
                                 int port)
                                   throws SocksException,
                                          IOException
```
    Description copied from interface: SocksProxy
    
    This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.
    
    Specified by:
    
    requestConnect in interface SocksProxy
    
    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
```
public CommandReplyMesasge requestConnect(SocketAddress address)
                                   throws SocksException,
                                          IOException
```
    Description copied from interface: SocksProxy
    
    This method will send a CONNECT command to SOCKS server and ask SOCKS server to connect remote server.
    
    Specified by:
    
    requestConnect in interface SocksProxy
    
    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
```
public CommandReplyMesasge requestBind(String host,
                              int port)
                                throws SocksException,
                                       IOException
```
    Description copied from interface: SocksProxy
    
    This method will send a BIND command to SOKCS server.
    
    Specified by:
    
    requestBind in interface SocksProxy
    
    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
```
public CommandReplyMesasge requestBind(InetAddress inetAddress,
                              int port)
                                throws SocksException,
                                       IOException
```
    Description copied from interface: SocksProxy
    
    This method will send a BIND command to SOKCS server.
    
    Specified by:
    
    requestBind in interface SocksProxy
    
    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
```
public Socket accept()
              throws SocksException,
                     IOException
```
    Description copied from interface: SocksProxy
    
    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.
    
    Specified by:
    
    accept in interface SocksProxy
    
    Returns:
    Socket that connect the remote host.
    
    Throws:
    
    SocksException - If any error about SOCKS protocol occurs.
    
    IOException - If any I/O error occurs.
  - requestUdpAssociat
```
public CommandReplyMesasge requestUdpAssociat(String host,
                                     int port)
                                       throws SocksException,
                                              IOException
```
    Description copied from interface: SocksProxy
    
    This method will send a UDP ASSOCIAT command to SOCKS server and ask SOCKS server to establish a relay server.
    
    Specified by:
    
    requestUdpAssociat in interface SocksProxy
    
    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
```
public CommandReplyMesasge requestUdpAssociat(InetAddress address,
                                     int port)
                                       throws SocksException,
                                              IOException
```
    Description copied from interface: SocksProxy
    
    This method will send a UDP ASSOCIAT command to SOCKS server and ask SOCKS server to establish a relay server.
    
    Specified by:
    
    requestUdpAssociat in interface SocksProxy
    
    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.
  - getPort
```
public int getPort()
```
    Description copied from interface: SocksProxy
    
    Get SOCKS Server port.
    
    Specified by:
    
    getPort in interface SocksProxy
    
    Returns:
    server port.
  - setPort
```
public Socks5 setPort(int port)
```
    Description copied from interface: SocksProxy
    
    Set SOCKS server port.
    
    Specified by:
    
    setPort in interface SocksProxy
    
    Parameters:
    port - SOCKS server's port.
    
    Returns:
    instance of SocksProxy.
  - getProxySocket
```
public Socket getProxySocket()
```
    Description copied from interface: SocksProxy
    
    Get the socket which connect SOCKS server.
    
    Specified by:
    
    getProxySocket in interface SocksProxy
    
    Returns:
    java.net.Socket.
  - setProxySocket
```
public Socks5 setProxySocket(Socket proxySocket)
```
    Description copied from interface: SocksProxy
    
    Set a unconnected socket which will be used to connect SOCKS server.
    
    Specified by:
    
    setProxySocket in interface SocksProxy
    
    Parameters:
    proxySocket - a unconnected socket.
    
    Returns:
    instance of SocksProxy.
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Description copied from interface: SocksProxy
    
    Gets InputStream from the socket that connected SOCKS server.
    
    Specified by:
    
    getInputStream in interface SocksProxy
    
    Returns:
    java.net.InputStream.
    
    Throws:
    
    IOException - if any I/O error occurs.
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    Description copied from interface: SocksProxy
    
    Gets OutputStream from the socket that connected SOCKS server.
    
    Specified by:
    
    getOutputStream in interface SocksProxy
    
    Returns:
    java.net.OutputStream.
    
    Throws:
    
    IOException - if any I/O error occurs.
  - setAcceptableMethods
```
public Socks5 setAcceptableMethods(List<SocksMethod> acceptableMethods)
```
    Description copied from interface: SocksProxy
    
    Sets client's acceptable methods.
    
    Specified by:
    
    setAcceptableMethods in interface SocksProxy
    
    Parameters:
    acceptableMethods - methods.
    
    Returns:
    instance of SocksProxy.
  - getAcceptableMethods
```
public List<SocksMethod> getAcceptableMethods()
```
    Description copied from interface: SocksProxy
    
    Gets clent's acceptable methods.
    
    Specified by:
    
    getAcceptableMethods in interface SocksProxy
    
    Returns:
    clent's acceptable methods.
  - setCredentials
```
public Socks5 setCredentials(Credentials credentials)
```
    Description copied from interface: SocksProxy
    
    Sets credentials.
    
    Specified by:
    
    setCredentials in interface SocksProxy
    
    Parameters:
    credentials - Credentials instance.
    
    Returns:
    instance of SocksProxy.
    See Also:
    UsernamePasswordCredentials, AnonymousCredentials
  - getCredentials
```
public Credentials getCredentials()
```
    Description copied from interface: SocksProxy
    
    Gets credentials from the SocksProxy.
    
    Specified by:
    
    getCredentials in interface SocksProxy
    
    Returns:
    Credentials instance.
  - setSocksMethodRequestor
```
public Socks5 setSocksMethodRequestor(SocksMethodRequestor requestor)
```
    Description copied from interface: SocksProxy
    
    Sets SocksMethodRequestor.
    
    Specified by:
    
    setSocksMethodRequestor in interface SocksProxy
    
    Parameters:
    requestor - SocksMethodRequestor
    
    Returns:
    instance of SocksProxy.
  - getSocksMethodRequestor
```
public SocksMethodRequestor getSocksMethodRequestor()
```
    Description copied from interface: SocksProxy
    
    Gets SocksMethodRequestor.
    
    Specified by:
    
    getSocksMethodRequestor in interface SocksProxy
    
    Returns:
    SocksMethodRequestor.
  - copy
```
public SocksProxy copy()
```
    Description copied from interface: SocksProxy
    
    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.
    
    Specified by:
    
    copy in interface SocksProxy
    
    Returns:
    The copy of this SocksProxy.
  - copyWithoutChainProxy
```
public SocksProxy copyWithoutChainProxy()
```
    Description copied from interface: SocksProxy
    
    Copy the SocksProxy. It will copy all properties of the SocksProxy but without chain proxy.
    
    Specified by:
    
    copyWithoutChainProxy in interface SocksProxy
    
    Returns:
    The copy of this SocksProxy but without chain proxy.
  - getSocksVersion
```
public int getSocksVersion()
```
    Description copied from interface: SocksProxy
    
    Gets version of SOCKS protocol.
    
    Specified by:
    
    getSocksVersion in interface SocksProxy
    
    Returns:
    Version of SOCKS protocol.
  - getChainProxy
```
public SocksProxy getChainProxy()
```
    Description copied from interface: SocksProxy
    
    Returns the chain proxy.
    
    Specified by:
    
    getChainProxy in interface SocksProxy
    
    Returns:
    the chain proxy.
  - setChainProxy
```
public SocksProxy setChainProxy(SocksProxy chainProxy)
```
    Description copied from interface: SocksProxy
    
    Returns the instance of SocksProxy.
    
    Specified by:
    
    setChainProxy in interface SocksProxy
    
    Parameters:
    chainProxy - chain proxy.
    
    Returns:
    the instance of SocksProxy.
  - setHost
```
public Socks5 setHost(String host)
               throws UnknownHostException
```
    Description copied from interface: SocksProxy
    
    Set SOCKS server's host.
    
    Specified by:
    
    setHost in interface SocksProxy
    
    Parameters:
    host - SOCKS server's host.
    
    Returns:
    instance of SocksProxy.
    
    Throws:
    
    UnknownHostException - if host can't resolve to InetAddress
  - getInetAddress
```
public InetAddress getInetAddress()
```
    Description copied from interface: SocksProxy
    
    Get SOCKS server's address as IPv4 or IPv6.
    
    Specified by:
    
    getInetAddress in interface SocksProxy
    
    Returns:
    server's IP address.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - createProxySocket
```
public Socket createProxySocket(InetAddress address,
                       int port)
                         throws IOException
```
    Description copied from interface: SocksProxy
    
    Creates a proxy socket.
    
    Specified by:
    
    createProxySocket in interface SocksProxy
    
    Parameters:
    address - address.
    port - port.
    
    Returns:
    Socket instance.
    
    Throws:
    
    IOException - If an I\O error occurred.
  - createProxySocket
```
public Socket createProxySocket()
                         throws IOException
```
    Description copied from interface: SocksProxy
    
    Creates a unconnected socket.
    
    Specified by:
    
    createProxySocket in interface SocksProxy
    
    Throws:
    
    IOException
  - setInetAddress
```
public Socks5 setInetAddress(InetAddress inetAddress)
```
    Sets SOCKS5 proxy server's IP address.
    
    Parameters:
    inetAddress - IP address of SOCKS5 proxy server.
    
    Returns:
    The instance of Socks5.
  - isAlwaysResolveAddressLocally
```
public boolean isAlwaysResolveAddressLocally()
```
  - setAlwaysResolveAddressLocally
```
public Socks5 setAlwaysResolveAddressLocally(boolean alwaysResolveAddressLocally)
```

Class Socks5

Field Summary

Fields inherited from interface fucksocks.client.SocksProxy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

SOCKS_VERSION

RESERVED

REP_SUCCEEDED

REP_GENERAL_SOCKS_SERVER_FAILURE

REP_CONNECTION_NOT_ALLOWED_BY_RULESET

REP_NETWORK_UNREACHABLE

REP_HOST_UNREACHABLE

REP_CONNECTION_REFUSED

REP_TTL_EXPIRED

REP_COMMAND_NOT_SUPPORTED

REP_ADDRESS_TYPE_NOT_SUPPORTED

AUTHENTICATION_SUCCEEDED

Constructor Detail

Socks5

Socks5

Socks5

Socks5

Socks5

Socks5

Method Detail

buildConnection

requestConnect

requestConnect

requestConnect

requestBind

requestBind

accept

requestUdpAssociat

requestUdpAssociat

getPort

setPort

getProxySocket

setProxySocket

getInputStream

getOutputStream

setAcceptableMethods

getAcceptableMethods

setCredentials

getCredentials

setSocksMethodRequestor

getSocksMethodRequestor

copy

copyWithoutChainProxy

getSocksVersion

getChainProxy

setChainProxy

setHost

getInetAddress

toString

createProxySocket

createProxySocket

setInetAddress

isAlwaysResolveAddressLocally

setAlwaysResolveAddressLocally