org.connectbot.simplesocks

Class Socks5Server

java.lang.Object

org.connectbot.simplesocks.Socks5Server

public class Socks5Server
extends java.lang.Object

A simple SOCKS5 server which does no authentication and only accepts CONNECT requests (i.e., no BIND).

Example usage:

     Socks5Server server = new Socks5Server(sockIn, sockOut);
     if (server.acceptAuthentication() && server.readRequest()) {
         server.sendReply(ResponseCode.SUCCESS);
     } else {
         /* handle failure */
     }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Socks5Server.Command Command that a client can request.
static class	Socks5Server.ResponseCode

Constructor Summary

Constructors

Constructor and Description
Socks5Server(java.io.InputStream in, java.io.OutputStream out)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptAuthentication() Begin the authentication with the client.
java.net.InetAddress	getAddress()
Socks5Server.Command	getCommand()
java.lang.String	getHostName()
int	getPort()
boolean	readRequest() Reads the type of request the client has made.
void	sendReply(Socks5Server.ResponseCode response) Send back to the client the given response.

Methods inherited from class java.lang.Object

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

Constructor Detail

Socks5Server

public Socks5Server(java.io.InputStream in,
            java.io.OutputStream out)

Method Detail

acceptAuthentication

public boolean acceptAuthentication()
                             throws java.io.IOException

Begin the authentication with the client. If the authentication succeeds, this will return true. Otherwise, the server must hang up on the client.

Returns:

true when authentication succeeds

Throws:

java.io.IOException - when the underlying stream has a problem

readRequest

public boolean readRequest()
                    throws java.io.IOException

Reads the type of request the client has made.

Returns:

true if the client request was valid

Throws:

java.io.IOException - when the underlying stream has a problem

See Also:

getCommand(), getAddress(), getPort()

sendReply

public void sendReply(Socks5Server.ResponseCode response)
               throws java.io.IOException

Send back to the client the given response. If the SUCCESS code is returned, the server must immediately connect the input and output streams to the requested socket. If any other code is returned, then the server must hang up on the client.

Parameters:

response - code to send back to the client

Throws:

java.io.IOException - when the underlying stream has a problem

getCommand

public Socks5Server.Command getCommand()

getAddress

public java.net.InetAddress getAddress()

getHostName

public java.lang.String getHostName()

getPort

public int getPort()