I2PTunnelHTTPServer (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.util.EventDispatcherImpl
- - net.i2p.i2ptunnel.I2PTunnelTask
  - - net.i2p.i2ptunnel.I2PTunnelServer
    - - net.i2p.i2ptunnel.I2PTunnelHTTPServer

All Implemented Interfaces:
Runnable, EventDispatcher
Direct Known Subclasses:
I2PTunnelHTTPBidirServer
```
public class I2PTunnelHTTPServer
extends I2PTunnelServer
```
HTTP server tunnel that filters headers and provides compression.
Extends I2PTunnelServer to filter HTTP headers from client to server, replacing the Host header with configured value. Compresses HTTP message body and sets Content-Encoding: x-i2p-gzip when browser requests Accept-Encoding: x-i2p-gzip.
Features include POST/PUT rate limiting, referer and user-agent rejection, inproxy detection, HTTP blocklist support, keepalive management, and response header security filtering.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static int`	`CONN_CLOSE` Connection: close or unknown value
`(package private) static int`	`CONN_KEEPALIVE` Connection: keep-alive
`(package private) static int`	`CONN_NONE` Connection header absent
`(package private) static int`	`CONN_UPGRADE` Connection: upgrade (websocket)
`static int`	`DEFAULT_POST_BAN_TIME` Post throttle window (seconds).
`static int`	`DEFAULT_POST_MAX` Default max posts per window.
`static int`	`DEFAULT_POST_TOTAL_BAN_TIME` Default total ban time for excessive posts.
`static int`	`DEFAULT_POST_TOTAL_MAX` Default max total posts before ban.
`static int`	`DEFAULT_POST_WINDOW` Default post rate-limit window (seconds).
`(package private) static String`	`ERR_FORBIDDEN` 403 Forbidden error response
`(package private) static String`	`ERR_NOT_FOUND` 404 Not Found error response
`protected static String`	`ERR_REQUEST_TIMEOUT` HTTP 408 Request Timeout error response.
`static String`	`OPT_ADD_RESPONSE_HEADER_ALLOW` Config key to add Allow response header.
`static String`	`OPT_ADD_RESPONSE_HEADER_CACHE_CONTROL` Config key to add Cache-Control response header.
`static String`	`OPT_ADD_RESPONSE_HEADER_NOSNIFF` Config key to add X-Content-Type-Options: nosniff.
`static String`	`OPT_ADD_RESPONSE_HEADER_REFERRER_POLICY` Config key to add Referrer-Policy response header.
`static String`	`OPT_KEEPALIVE` Config key to enable keepalive.
`static String`	`OPT_POST_BAN_TIME` Config key for post ban time.
`static String`	`OPT_POST_MAX` Config key for max posts.
`static String`	`OPT_POST_TOTAL_BAN_TIME` Config key for post total ban time.
`static String`	`OPT_POST_TOTAL_MAX` Config key for max total posts.
`static String`	`OPT_POST_WINDOW` Config key for post check time window.
`static String`	`OPT_REJECT_INPROXY` Config key to reject requests from inproxy.
`static String`	`OPT_REJECT_REFERER` Config key to reject requests with Referer header.
`static String`	`OPT_REJECT_USER_AGENTS` Config key to reject specific User-Agents.
`static String`	`OPT_USER_AGENTS` Config key for User-Agent reject list.

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelServer
_clientExecutor, _log, bidir, i2pss, l, localPort, PROP_ALT_PKF, PROP_UNIQUE_LOCAL, PROP_USE_SSL, readTimeout, remoteHost, remotePort, serverId, slock, sockMgr, sslLock, task

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelTask
open, tunnel

Constructor Summary

Constructors
Constructor and Description
`I2PTunnelHTTPServer(InetAddress host, int port, File privkey, String privkeyname, String spoofHost, Logging l, EventDispatcher notifyThis, I2PTunnel tunnel)` Create an HTTP tunnel server from a private key file.
`I2PTunnelHTTPServer(InetAddress host, int port, InputStream privData, String privkeyname, String spoofHost, Logging l, EventDispatcher notifyThis, I2PTunnel tunnel)` Create an HTTP tunnel server from a private key stream.
`I2PTunnelHTTPServer(InetAddress host, int port, String privData, String spoofHost, Logging l, EventDispatcher notifyThis, I2PTunnel tunnel)` Create an HTTP tunnel server with a private key string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) static void`	`addEntry(Map<String,List<String>> headers, String key, String value)` Add an entry to the multimap.
`protected void`	`blockingHandle(I2PSocket socket)` Called by the thread pool of I2PSocket handlers.
`boolean`	`close(boolean forced)` Close the tunnel and stop the POST throttler.
`(package private) static int`	`getConnectionType(Map<String,List<String>> headers)` Classify the request's Connection header value.
`(package private) static boolean`	`hasGzipEncoding(String enc)` Whether the Accept-Encoding value includes x-i2p-gzip.
`(package private) static boolean`	`isGzipAllowed(Properties opts)` Whether the tunnel allows gzip responses, from the tunnel options.
`(package private) boolean`	`isInproxyRejection(Map<String,List<String>> headers, I2PSocket socket, String peerB32, Properties opts)` Reject requests that contain forwarded-for headers (inproxy detection).
`(package private) static boolean`	`isKeepAliveRequest(String cmd)` Whether the request can keep the connection alive: GET or HEAD with HTTP/1.1.
`(package private) boolean`	`isPostThrottled(StringBuilder command, Hash peerHash, I2PSocket socket, String peerB32)` Check POST/PUT throttling for this peer.
`(package private) boolean`	`isRefererRejection(Map<String,List<String>> headers, I2PSocket socket, String peerB32, Properties opts)` Reject requests with absolute Referer URIs.
`(package private) boolean`	`isUserAgentRejection(Map<String,List<String>> headers, I2PSocket socket, String peerB32, Properties opts)` Reject requests with blacklisted User-Agent strings.
`void`	`optionsUpdated(I2PTunnel tunnel)` Called when tunnel options are updated.
`static Map<String,List<String>>`	`readHeaders(I2PSocket socket, InputStream in, StringBuilder command, Set<String> skipHeaders, I2PAppContext ctx, long initialTimeout)` From I2P to server: socket non-null, in null.
`static Map<String,List<String>>`	`readHeaders(I2PSocket socket, InputStream in, StringBuilder command, String[] skipHeaders, I2PAppContext ctx, long initialTimeout)` Read headers from the input stream, using an array of skip headers.
`(package private) static Map<String,List<String>>`	`readRequestHeaders(I2PSocket socket, StringBuilder command, int requestCount, String peerB32, I2PAppContext ctx, Log log)` Read the request headers, handling the specific errors that can occur by sending the appropriate error response to the client.
`(package private) static void`	`setEntry(Map<String,List<String>> headers, String key, String value)` Remove the other matching entries and set this entry as the only one.
`void`	`startRunning()` Start the tunnel and initialize timing and throttling.

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelServer
destroy, getReadTimeout, getSocket, getSocket, getSocketManager, getSocketString, run, setReadTimeout

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelTask
connected, disconnected, errorOccurred, getBooleanOption, getId, getTunnel, isOpen, reportAbuse, routerDisconnected, setId, setName, setTunnel, toString

Methods inherited from class net.i2p.util.EventDispatcherImpl
attachEventDispatcher, detachEventDispatcher, getEventDispatcher, getEvents, getEventValue, ignoreEvents, notifyEvent, unIgnoreEvents, waitEventValue

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

- Field Detail
  - CONN_CLOSE
```
static final int CONN_CLOSE
```
    Connection: close or unknown value
    See Also:
    Constant Field Values
  - CONN_KEEPALIVE
```
static final int CONN_KEEPALIVE
```
    Connection: keep-alive
    See Also:
    Constant Field Values
  - CONN_NONE
```
static final int CONN_NONE
```
    Connection header absent
    See Also:
    Constant Field Values
  - CONN_UPGRADE
```
static final int CONN_UPGRADE
```
    Connection: upgrade (websocket)
    See Also:
    Constant Field Values
  - DEFAULT_POST_BAN_TIME
```
public static final int DEFAULT_POST_BAN_TIME
```
    Post throttle window (seconds).
    See Also:
    Constant Field Values
  - DEFAULT_POST_MAX
```
public static final int DEFAULT_POST_MAX
```
    Default max posts per window.
    See Also:
    Constant Field Values
  - DEFAULT_POST_TOTAL_BAN_TIME
```
public static final int DEFAULT_POST_TOTAL_BAN_TIME
```
    Default total ban time for excessive posts.
    See Also:
    Constant Field Values
  - DEFAULT_POST_TOTAL_MAX
```
public static final int DEFAULT_POST_TOTAL_MAX
```
    Default max total posts before ban.
    See Also:
    Constant Field Values
  - DEFAULT_POST_WINDOW
```
public static final int DEFAULT_POST_WINDOW
```
    Default post rate-limit window (seconds).
    See Also:
    Constant Field Values
  - ERR_FORBIDDEN
```
static final String ERR_FORBIDDEN
```
    403 Forbidden error response
    See Also:
    Constant Field Values
  - ERR_NOT_FOUND
```
static final String ERR_NOT_FOUND
```
    404 Not Found error response
    See Also:
    Constant Field Values
  - ERR_REQUEST_TIMEOUT
```
protected static final String ERR_REQUEST_TIMEOUT
```
    HTTP 408 Request Timeout error response. Includes a meta refresh to retry after 5 seconds.
    See Also:
    Constant Field Values
  - OPT_ADD_RESPONSE_HEADER_ALLOW
```
public static final String OPT_ADD_RESPONSE_HEADER_ALLOW
```
    Config key to add Allow response header.
    See Also:
    Constant Field Values
  - OPT_ADD_RESPONSE_HEADER_CACHE_CONTROL
```
public static final String OPT_ADD_RESPONSE_HEADER_CACHE_CONTROL
```
    Config key to add Cache-Control response header.
    See Also:
    Constant Field Values
  - OPT_ADD_RESPONSE_HEADER_NOSNIFF
```
public static final String OPT_ADD_RESPONSE_HEADER_NOSNIFF
```
    Config key to add X-Content-Type-Options: nosniff.
    See Also:
    Constant Field Values
  - OPT_ADD_RESPONSE_HEADER_REFERRER_POLICY
```
public static final String OPT_ADD_RESPONSE_HEADER_REFERRER_POLICY
```
    Config key to add Referrer-Policy response header.
    See Also:
    Constant Field Values
  - OPT_KEEPALIVE
```
public static final String OPT_KEEPALIVE
```
    Config key to enable keepalive.
    See Also:
    Constant Field Values
  - OPT_POST_BAN_TIME
```
public static final String OPT_POST_BAN_TIME
```
    Config key for post ban time.
    See Also:
    Constant Field Values
  - OPT_POST_MAX
```
public static final String OPT_POST_MAX
```
    Config key for max posts.
    See Also:
    Constant Field Values
  - OPT_POST_TOTAL_BAN_TIME
```
public static final String OPT_POST_TOTAL_BAN_TIME
```
    Config key for post total ban time.
    See Also:
    Constant Field Values
  - OPT_POST_TOTAL_MAX
```
public static final String OPT_POST_TOTAL_MAX
```
    Config key for max total posts.
    See Also:
    Constant Field Values
  - OPT_POST_WINDOW
```
public static final String OPT_POST_WINDOW
```
    Config key for post check time window.
    See Also:
    Constant Field Values
  - OPT_REJECT_INPROXY
```
public static final String OPT_REJECT_INPROXY
```
    Config key to reject requests from inproxy.
    See Also:
    Constant Field Values
  - OPT_REJECT_REFERER
```
public static final String OPT_REJECT_REFERER
```
    Config key to reject requests with Referer header.
    See Also:
    Constant Field Values
  - OPT_REJECT_USER_AGENTS
```
public static final String OPT_REJECT_USER_AGENTS
```
    Config key to reject specific User-Agents.
    See Also:
    Constant Field Values
  - OPT_USER_AGENTS
```
public static final String OPT_USER_AGENTS
```
    Config key for User-Agent reject list.
    See Also:
    Constant Field Values
- Constructor Detail
  - I2PTunnelHTTPServer
```
public I2PTunnelHTTPServer(InetAddress host,
                           int port,
                           File privkey,
                           String privkeyname,
                           String spoofHost,
                           Logging l,
                           EventDispatcher notifyThis,
                           I2PTunnel tunnel)
```
    Create an HTTP tunnel server from a private key file.
    Parameters:
    host - the local address to bind to
    port - the local port
    privkey - the private key file
    privkeyname - the name for the private key
    spoofHost - the hostname to spoof in the Host header, or null
    l - the logging instance
    notifyThis - the event dispatcher for notifications
    tunnel - the parent tunnel configuration
  - I2PTunnelHTTPServer
```
public I2PTunnelHTTPServer(InetAddress host,
                           int port,
                           InputStream privData,
                           String privkeyname,
                           String spoofHost,
                           Logging l,
                           EventDispatcher notifyThis,
                           I2PTunnel tunnel)
```
    Create an HTTP tunnel server from a private key stream.
    Parameters:
    host - the local address to bind to
    port - the local port
    privData - the input stream containing the private key data
    privkeyname - the name for the private key
    spoofHost - the hostname to spoof in the Host header, or null
    l - the logging instance
    notifyThis - the event dispatcher for notifications
    tunnel - the parent tunnel configuration
  - I2PTunnelHTTPServer
```
public I2PTunnelHTTPServer(InetAddress host,
                           int port,
                           String privData,
                           String spoofHost,
                           Logging l,
                           EventDispatcher notifyThis,
                           I2PTunnel tunnel)
```
    Create an HTTP tunnel server with a private key string.
    Parameters:
    host - the local address to bind to
    port - the local port
    privData - the private key data as a Base64 string
    spoofHost - the hostname to spoof in the Host header, or null
    l - the logging instance
    notifyThis - the event dispatcher for notifications
    tunnel - the parent tunnel configuration
- Method Detail
  - addEntry
```
static void addEntry(Map<String,List<String>> headers,
                     String key,
                     String value)
```
    Add an entry to the multimap. If the key already exists, appends the value to the existing list.
    Parameters:
    headers - the header multimap to modify
    key - the header name
    value - the header value to add
  - blockingHandle
```
protected void blockingHandle(I2PSocket socket)
```
    Called by the thread pool of I2PSocket handlers. Handles a single client connection through the HTTP proxy lifecycle: read headers, validate, apply spoofing, compress, and forward.
    Overrides:
    blockingHandle in class I2PTunnelServer
    Parameters:
    socket - the incoming I2P socket from the client
    See Also:
    I2PTunnelServer.getSocket(Hash, int), I2PTunnelRunner
  - close
```
public boolean close(boolean forced)
```
    Close the tunnel and stop the POST throttler.
    Overrides:
    close in class I2PTunnelServer
    Parameters:
    forced - true to force close
    Returns:
    true if closed successfully
  - getConnectionType
```
static int getConnectionType(Map<String,List<String>> headers)
```
    Classify the request's Connection header value.
    Parameters:
    headers - request headers
    Returns:
    CONN_NONE, CONN_KEEPALIVE, CONN_UPGRADE, or CONN_CLOSE
  - hasGzipEncoding
```
static boolean hasGzipEncoding(String enc)
```
    Whether the Accept-Encoding value includes x-i2p-gzip.
    Parameters:
    enc - an Accept-Encoding header value, or null
    Returns:
    true if it includes x-i2p-gzip
  - isGzipAllowed
```
static boolean isGzipAllowed(Properties opts)
```
    Whether the tunnel allows gzip responses, from the tunnel options.
    Parameters:
    opts - the client options
    Returns:
    true unless PROP_TUN_GZIP is set to false
  - isInproxyRejection
```
boolean isInproxyRejection(Map<String,List<String>> headers,
                           I2PSocket socket,
                           String peerB32,
                           Properties opts)
```
    Reject requests that contain forwarded-for headers (inproxy detection).
    Parameters:
    headers - the request headers
    socket - the incoming I2P socket
    peerB32 - the peer's base32 address for logging
    opts - the tunnel client options
    Returns:
    true if the request was rejected and the socket closed
  - isKeepAliveRequest
```
static boolean isKeepAliveRequest(String cmd)
```
    Whether the request can keep the connection alive: GET or HEAD with HTTP/1.1.
    Parameters:
    cmd - the trimmed request line
    Returns:
    true if keepalive may continue
  - isPostThrottled
```
boolean isPostThrottled(StringBuilder command,
                        Hash peerHash,
                        I2PSocket socket,
                        String peerB32)
```
    Check POST/PUT throttling for this peer.
    Parameters:
    command - the request command string (first line)
    peerHash - the peer's hash for throttling lookup
    socket - the incoming I2P socket
    peerB32 - the peer's base32 address for logging
    Returns:
    true if the request was throttled and the socket closed
  - isRefererRejection
```
boolean isRefererRejection(Map<String,List<String>> headers,
                           I2PSocket socket,
                           String peerB32,
                           Properties opts)
```
    Reject requests with absolute Referer URIs.
    Parameters:
    headers - the request headers
    socket - the incoming I2P socket
    peerB32 - the peer's base32 address for logging
    opts - the tunnel client options
    Returns:
    true if the request was rejected and the socket closed
  - isUserAgentRejection
```
boolean isUserAgentRejection(Map<String,List<String>> headers,
                             I2PSocket socket,
                             String peerB32,
                             Properties opts)
```
    Reject requests with blacklisted User-Agent strings.
    Parameters:
    headers - the request headers
    socket - the incoming I2P socket
    peerB32 - the peer's base32 address for logging
    opts - the tunnel client options
    Returns:
    true if the request was rejected and the socket closed
  - optionsUpdated
```
public void optionsUpdated(I2PTunnel tunnel)
```
    Called when tunnel options are updated. Re-initializes the POST throttler and updates the spoofed host.
    Overrides:
    optionsUpdated in class I2PTunnelServer
    Parameters:
    tunnel - the tunnel
  - readHeaders
```
public static Map<String,List<String>> readHeaders(I2PSocket socket,
                                                   InputStream in,
                                                   StringBuilder command,
                                                   Set<String> skipHeaders,
                                                   I2PAppContext ctx,
                                                   long initialTimeout)
                                            throws IOException
```
    From I2P to server: socket non-null, in null. From server to I2P: socket null, in non-null. Note: This does not handle RFC 2616 header line splitting, which is obsoleted in RFC 7230.
    Parameters:
    socket - if null, use in as InputStream
    in - if null, use socket.getInputStream() as InputStream
    command - out parameter, first line
    skipHeaders - MUST be lower case
    Returns:
    the parsed header multimap
    Throws:
    SocketTimeoutException - if timeout is reached before newline
    EOFException - if EOF is reached before newline
    LineTooLongException - if one header too long, or too many headers, or total size too big
    RequestTooLongException - if too long
    BadRequestException - on bad headers
    IOException - on other errors in the underlying stream
  - readHeaders
```
public static Map<String,List<String>> readHeaders(I2PSocket socket,
                                                   InputStream in,
                                                   StringBuilder command,
                                                   String[] skipHeaders,
                                                   I2PAppContext ctx,
                                                   long initialTimeout)
                                            throws IOException
```
    Read headers from the input stream, using an array of skip headers.
    Parameters:
    socket - if non-null, read from socket; otherwise read from in
    in - if non-null and socket is null, read from this stream
    command - output buffer for the first request line
    skipHeaders - array of lower-case header names to filter out
    ctx - I2P app context for clock and timeout
    initialTimeout - timeout for the first line read
    Returns:
    the parsed header multimap
    Throws:
    IOException - on I/O errors
  - readRequestHeaders
```
static Map<String,List<String>> readRequestHeaders(I2PSocket socket,
                                                   StringBuilder command,
                                                   int requestCount,
                                                   String peerB32,
                                                   I2PAppContext ctx,
                                                   Log log)
                                            throws IOException
```
    Read the request headers, handling the specific errors that can occur by sending the appropriate error response to the client. The 5 error handlers share this shape: send error, log, close, return null.
    Parameters:
    socket - the client socket
    command - buffer for the request line
    requestCount - the number of requests already handled on this connection (0 = first)
    peerB32 - the client's base32 for logging
    ctx - the I2P app context
    log - the logging instance
    Returns:
    the parsed headers, or null if the request failed and the client was notified
    Throws:
    IOException - on other I/O errors, propagated to the caller
  - setEntry
```
static void setEntry(Map<String,List<String>> headers,
                     String key,
                     String value)
```
    Remove the other matching entries and set this entry as the only one.
    Parameters:
    headers - the header multimap to modify
    key - the header name
    value - the header value to set (replaces all existing values for this key)
  - startRunning
```
public void startRunning()
```
    Start the tunnel and initialize timing and throttling.
    Overrides:
    startRunning in class I2PTunnelServer

Class I2PTunnelHTTPServer

Field Summary

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelServer

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelTask

Constructor Summary

Method Summary

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelServer

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelTask

Methods inherited from class net.i2p.util.EventDispatcherImpl

Methods inherited from class java.lang.Object

Field Detail

CONN_CLOSE

CONN_KEEPALIVE

CONN_NONE

CONN_UPGRADE

DEFAULT_POST_BAN_TIME

DEFAULT_POST_MAX

DEFAULT_POST_TOTAL_BAN_TIME

DEFAULT_POST_TOTAL_MAX

DEFAULT_POST_WINDOW

ERR_FORBIDDEN

ERR_NOT_FOUND

ERR_REQUEST_TIMEOUT

OPT_ADD_RESPONSE_HEADER_ALLOW

OPT_ADD_RESPONSE_HEADER_CACHE_CONTROL

OPT_ADD_RESPONSE_HEADER_NOSNIFF

OPT_ADD_RESPONSE_HEADER_REFERRER_POLICY

OPT_KEEPALIVE

OPT_POST_BAN_TIME

OPT_POST_MAX

OPT_POST_TOTAL_BAN_TIME

OPT_POST_TOTAL_MAX

OPT_POST_WINDOW

OPT_REJECT_INPROXY

OPT_REJECT_REFERER

OPT_REJECT_USER_AGENTS

OPT_USER_AGENTS

Constructor Detail

I2PTunnelHTTPServer

I2PTunnelHTTPServer

I2PTunnelHTTPServer

Method Detail

addEntry

blockingHandle

close

getConnectionType

hasGzipEncoding

isGzipAllowed

isInproxyRejection

isKeepAliveRequest

isPostThrottled

isRefererRejection

isUserAgentRejection

optionsUpdated

readHeaders

readHeaders

readRequestHeaders

setEntry

startRunning