I2PSOCKSTunnel

net.i2p.i2ptunnel.socks.I2PSOCKSTunnel

All Implemented Interfaces:: Runnable, EventDispatcher

Direct Known Subclasses:: I2PSOCKSIRCTunnel

public class I2PSOCKSTunnelextends I2PTunnelClientBase

SOCKS proxy server that routes TCP connections through I2P network.

This class implements a SOCKS4a/5 proxy server that accepts local SOCKS connections and forwards them to I2P destinations or configured outproxies. It supports both I2P destination routing (for .i2p addresses) and outproxy routing for clearnet access, with authentication and port-specific proxy configuration.

The tunnel provides dynamic destination resolution, connection management, and serves as a flexible proxy solution for applications that support SOCKS protocol, enabling seamless I2P integration for various clients.

Field Summary
Modifier and Type
Field
Description
static final String
AUTH_REALM
The HTTP auth realm presented to clients that authenticate.
static final String
DEFAULT
The key used for the default (first) proxy.
protected static final int
INITIAL_SO_TIMEOUT
This is a standard soTimeout, not a total timeout.
static final String
PROP_OUTPROXY_TYPE
The property naming the outproxy type ("none", "HTTP", "SOCKS", "SOCKS4a").
static final String
PROP_PROXY_DEFAULT
The full property name of the default proxy.
static final String
PROP_PROXY_PREFIX
Prefix of the per-port proxy property names.
private final HashMap<String, List<String>>
proxies
Proxy settings by port, with a "default" entry for the rest
Fields inherited from class I2PTunnelClientBase
_clientId, _context, _executor, _log, _ownDest, DEFAULT_MAX_CONNECTIONS, DEFAULT_SOCKET_OPEN_TIMEOUT, dest, l, listenerReady, mySockets, PROP_MAX_CONNECTIONS, PROP_USE_SSL, sockLock, sockMgr, ss
Modifier and Type
Field
Description
protected long
_clientId
This client's ID.
protected final I2PAppContext
_context
The application context.
protected ThreadPoolExecutor
_executor
Thread pool executor.
protected final Log
_log
The logger.
protected boolean
_ownDest
Whether we own our destination.
static final int
DEFAULT_MAX_CONNECTIONS
Default cap on concurrently handled client connections.
static final long
DEFAULT_SOCKET_OPEN_TIMEOUT
Default socket open timeout in ms, after which I2PTunnelClientBase.close(boolean) will proceed even with active sockets.
protected Destination
dest
The destination.
protected final Logging
l
The logging instance.
protected boolean
listenerReady
Protected for I2Ping since 0.9.11.
protected final List<I2PSocket>
mySockets
List of active sockets.
static final String
PROP_MAX_CONNECTIONS
Property name: max concurrently active client connections handled by one client tunnel.
static final String
PROP_USE_SSL
Property turning on SSL between the proxy and the client.
protected final Object
sockLock
Guards sockMgr and mySockets.
protected I2PSocketManager
sockMgr
The socket manager.
protected ServerSocket
ss
Server socket.
Fields inherited from class I2PTunnelTask
open, tunnel
Modifier and Type
Field
Description
protected boolean
open
True while the tunnel is running and accepting connections.
I2PTunnel
tunnel
The I2PTunnel this task runs inside.
Constructor Summary
Constructors
Constructor
Description
I2PSOCKSTunnel(int localPort, Logging l, boolean ownDest, EventDispatcher notifyThis, I2PTunnel tunnel, String pkf)
Create a SOCKS proxy on the given local port.
Method Summary
Modifier and Type
Method
Description
I2PSocketOptions
buildOptions(Properties overrides)
Build socket options from the tunnel config merged with overrides.
protected void
clientConnectionRun(Socket s)
Manage a connection in a separate thread.
List<String>
getDefaultProxies()
Get the default proxy list.
List<String>
getProxies(int port)
Gets the proxy list for a specific port.
HashMap<String, List<String>>
getProxyMap()
Gets the proxy map for all configured ports.
void
optionsUpdated(I2PTunnel tunnel)
Update the outproxy list then call super.
private void
parseOptions()
Reads the proxy settings out of the tunnel's options.
Methods inherited from class I2PTunnelClientBase
buildSocketManager, buildSocketManager, buildSocketManager, buildSocketManager, close, closeSocket, createI2PSocket, createI2PSocket, createI2PSocket, destroy, getDefaultOptions, getDefaultOptions, getListenHost, getLocalPort, getSocketManager, getSocketManager, getSocketOpenTimeout, manageConnection, poolIsDefinitivelyDown, poolState, run, startRunning, verifySocketManager, writeShedResponse
Modifier and Type
Method
Description
protected I2PSocketManager
buildSocketManager()
For NON-SHARED clients (ownDest = true).
protected static I2PSocketManager
buildSocketManager(I2PTunnel tunnel)
Create a disconnected socket manager for the tunnel, with no private key file.
protected static I2PSocketManager
buildSocketManager(I2PTunnel tunnel, String pkf)
Create a disconnected socket manager for the tunnel, loading the persistent client dest from pkf if it is non-null.
protected static I2PSocketManager
buildSocketManager(I2PTunnel tunnel, String pkf, Logging log)
Create a disconnected socket manager for the tunnel, loading the persistent client dest from pkf if it is non-null, and logging any key file error to log.
boolean
close(boolean forced)
Note that the tunnel can be reopened after this by calling startRunning().
static void
closeSocket(Socket s)
Close a socket silently.
I2PSocket
createI2PSocket(Destination dest)
Create a new I2PSocket towards to the specified destination, adding it to the list of connections actually managed by this tunnel.
I2PSocket
createI2PSocket(Destination dest, int port)
Create a new I2PSocket towards to the specified destination, adding it to the list of connections actually managed by this tunnel.
I2PSocket
createI2PSocket(Destination dest, I2PSocketOptions opt)
Create a new I2PSocket towards to the specified destination, adding it to the list of connections actually managed by this tunnel.
boolean
destroy()
Note that the tunnel cannot be reopened after this by calling startRunning(), as it will destroy the underlying socket manager.
protected I2PSocketOptions
getDefaultOptions()
Create the default options (using the default timeout, etc).
protected I2PSocketOptions
getDefaultOptions(Properties overrides)
Create the default options (using the default timeout, etc).
protected final InetAddress
getListenHost(Logging l)
Get the listen host address.
final int
getLocalPort()
Get the local port.
I2PSocketManager
getSocketManager()
Returns the I2PSocketManager for this task.
protected static I2PSocketManager
getSocketManager(I2PTunnel tunnel, String pkf)
This is ONLY for shared clients.
long
getSocketOpenTimeout()
Returns the socket open timeout in ms; close() will proceed after this even with active sockets.
protected void
manageConnection(Socket s)
Manage the connection just opened on the specified socket.
protected boolean
poolIsDefinitivelyDown()
And none are being built, so further connect retries cannot succeed.
protected int
poolState()
Router-context only, best-effort check of the client outbound tunnel pool.
void
run()
Non-final since 0.9.11.
void
startRunning()
Actually open the local socket and start working on incoming connections.
protected void
verifySocketManager()
Create the manager if it doesn't exist, AND connect it to the router and build tunnels.
protected void
writeShedResponse(Socket s)
Best-effort shed response on the browser-facing socket, then close it.
Methods inherited from class I2PTunnelTask
connected, disconnected, errorOccurred, getBooleanOption, getId, getTunnel, isOpen, reportAbuse, routerDisconnected, setId, setName, setTunnel, toString
Modifier and Type
Method
Description
void
connected(I2PSession session)
For tasks that don't call I2PTunnel.addSession(I2PSession) directly.
void
disconnected(I2PSession session)
Called when a session is disconnected.
void
errorOccurred(I2PSession session, String message, Throwable error)
Does nothing here.
protected boolean
getBooleanOption(String opt, boolean dflt)
Read a boolean client option from the tunnel's properties.
int
getId()
The id of the client list entry for this task.
I2PTunnel
getTunnel()
The I2PTunnel this task runs inside.
boolean
isOpen()
Whether the tunnel is running and accepting connections.
void
reportAbuse(I2PSession session, int severity)
Does nothing here.
protected void
routerDisconnected()
Tell the tunnel that the router connection has dropped.
void
setId(int id)
Record the client list entry id for this task.
protected void
setName(String name)
Record the display name for this task.
void
setTunnel(I2PTunnel pTunnel)
Rebind this task to a different tunnel.
String
toString()
The display name given to this task when it was constructed.
Methods inherited from class EventDispatcherImpl
attachEventDispatcher, detachEventDispatcher, getEventDispatcher, getEvents, getEventValue, ignoreEvents, notifyEvent, unIgnoreEvents, waitEventValue
Modifier and Type
Method
Description
void
attachEventDispatcher(EventDispatcher ev)
Attach an EventDispatcher object to the events dispatching chain.
void
detachEventDispatcher(EventDispatcher ev)
Detach the specified EventDispatcher object from the events dispatching chain.
EventDispatcher
getEventDispatcher()
Object to be used to deliver events (usually this, but YMMV).
Set<String>
getEvents()
Retrieve the names of all the events that have been received.
Object
getEventValue(String name)
Retrieve the value currently associated with the specified event value.
void
ignoreEvents()
Ignore further event notifications.
void
notifyEvent(String eventName, Object args)
Deliver an event.
void
unIgnoreEvents()
Almost like the method above :-).
Object
waitEventValue(String name)
Wait until the given event has received a value.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- INITIAL_SO_TIMEOUT
  protected static final int INITIAL_SO_TIMEOUT
  This is a standard soTimeout, not a total timeout. We have no slowloris protection on the client side. See I2PTunnelHTTPServer or SAM's ReadLine if we need that.
  See Also:
  Constant Field Values
- proxies
  private final HashMap<String, List<String>> proxies
  Proxy settings by port, with a "default" entry for the rest
- AUTH_REALM
  public static final String AUTH_REALM
  The HTTP auth realm presented to clients that authenticate.
  See Also:
  Constant Field Values
- PROP_OUTPROXY_TYPE
  public static final String PROP_OUTPROXY_TYPE
  The property naming the outproxy type ("none", "HTTP", "SOCKS", "SOCKS4a").
  See Also:
  Constant Field Values
- PROP_PROXY_PREFIX
  public static final String PROP_PROXY_PREFIX
  Prefix of the per-port proxy property names.
  See Also:
  Constant Field Values
- DEFAULT
  public static final String DEFAULT
  The key used for the default (first) proxy.
  See Also:
  Constant Field Values
- PROP_PROXY_DEFAULT
  public static final String PROP_PROXY_DEFAULT
  The full property name of the default proxy.
  See Also:
  Constant Field Values
Constructor Details
- I2PSOCKSTunnel
  public I2PSOCKSTunnel(int localPort, Logging l, boolean ownDest, EventDispatcher notifyThis, I2PTunnel tunnel, String pkf)
  Create a SOCKS proxy on the given local port.
  Since 0.9.20 this is fast, and does NOT connect the manager to the router, or open the local socket. You MUST call startRunning() for that.
  Parameters:
  localPort - the local port to listen on
  l - the logging instance
  ownDest - whether to use own destination
  notifyThis - the event dispatcher for notifications
  tunnel - the I2P tunnel
  pkf - private key file name or null for transient key
Method Details
- clientConnectionRun
  protected void clientConnectionRun(Socket s)
  Description copied from class: I2PTunnelClientBase
  Manage a connection in a separate thread. This only works if you do not override I2PTunnelClientBase.manageConnection(Socket).
  This is run in a thread from an unlimited-size thread pool, so it may block or run indefinitely.
  Specified by:
  clientConnectionRun in class I2PTunnelClientBase
  Parameters:
  s - the socket to manage
- optionsUpdated
  public void optionsUpdated(I2PTunnel tunnel)
  Update the outproxy list then call super.
  Overrides:
  optionsUpdated in class I2PTunnelClientBase
  Parameters:
  tunnel - the tunnel whose client options were updated
- parseOptions
  private void parseOptions()
  Reads the proxy settings out of the tunnel's options.
- getProxyMap
  public HashMap<String, List<String>> getProxyMap()
  Gets the proxy map for all configured ports.
  Returns:
  a map of port strings to proxy lists
- getDefaultProxies
  public List<String> getDefaultProxies()
  Get the default proxy list.
  Returns:
  the default proxy list
- getProxies
  public List<String> getProxies(int port)
  Gets the proxy list for a specific port.
  If no proxies are configured for the port, returns the default proxies.
  Parameters:
  port - the local port to get proxies for
  Returns:
  the list of proxy destinations for the port, or default proxies
- buildOptions
  public I2PSocketOptions buildOptions(Properties overrides)
  Build socket options from the tunnel config merged with overrides.
  Parameters:
  overrides - properties to override the default options
  Returns:
  the built socket options

Field Summary

Fields inherited from class I2PTunnelClientBase

Fields inherited from class I2PTunnelTask

Constructor Summary

Method Summary

Methods inherited from class I2PTunnelClientBase

Methods inherited from class I2PTunnelTask

Methods inherited from class EventDispatcherImpl

Methods inherited from class Object

Field Details

INITIAL_SO_TIMEOUT

proxies

AUTH_REALM

PROP_OUTPROXY_TYPE

PROP_PROXY_PREFIX

DEFAULT

PROP_PROXY_DEFAULT

Constructor Details

Method Details

clientConnectionRun

optionsUpdated

parseOptions

getProxyMap

getDefaultProxies

getProxies

buildOptions