Method Details

• getTunnel

  public I2PTunnel getTunnel()

  The I2PTunnel

  for advanced plugin usage.

  Returns:

  the I2PTunnel client built around this controller, which holds the I2CP session and runs the tunnel on startTunnel()

• createPrivateKey

  private boolean createPrivateKey()

  Create a new private key, if no filename is specified or creation fails.

  Returns:

  true if the key file already existed or a new one was written

• createAltPrivateKey

  private boolean createAltPrivateKey()

  Creates alternate Destination with the same encryption keys as the primary Destination, but a different signing key.

  Must have already called createPrivateKey() successfully. Does nothing unless option OPT_ALT_PKF is set with the privkey file name. Does nothing if the file already exists.

  Returns:

  true if the alternate key file already existed or a new one was written, false if the option or signature type disallows it

• startTunnelBackground

  public void startTunnelBackground()

  Starts the tunnel in a background thread.

  This method spawns a new thread to start the tunnel, allowing the calling thread to return immediately. The tunnel state transitions to STARTING, and the actual startup is performed in the background thread.

  See Also:

  • startTunnel()

• startTunnel

  public void startTunnel()

  Start up the tunnel (if it isn't already running).

• doStartTunnel

  private void doStartTunnel()

  Configures and controls a single tunnel.

  Contains persistent configuration (loaded/saved from config file) and runtime state. Used to start, stop, and monitor individual tunnels. Generally one TunnelController per user-configured tunnel, though some (e.g. shared clients) may have multiple.

  Bundled under TunnelControllerGroup for storage/loading from single config file. Used by plugins to create tunnels - maintain public methods as stable API.

• startHttpClient

  private void startHttpClient()

  Starts an http proxy client tunnel.

• startConnectClient

  private void startConnectClient()

  Starts a connect client tunnel.

• startIrcClient

  private void startIrcClient()

  Starts an IRC client tunnel.

• startSocksClient

  private void startSocksClient()

  Starts a SOCKS proxy client tunnel.

• startSocksIRCClient

  private void startSocksIRCClient()

  Starts a combined SOCKS and IRC client tunnel.

• startStreamrClient

  private void startStreamrClient()

  Starts a streaming client tunnel.

• startStreamrServer

  private void startStreamrServer()

  Streamr server is a UDP client, use the targetPort field for listenPort.

• acquire

  private void acquire()

  Note the fact that we are using some sessions, so that they don't get closed by some other tunnels.

• release

  private void release(Collection<I2PSession> sessions)

  Note the fact that we are no longer using some sessions, and if no other tunnels are using them, close them.

  Parameters:

  sessions - the sessions to release, empty for none

• getAllSessions

  private Collection<I2PSession> getAllSessions()

  Get all the sessions we may be using.

  Returns:

  a copy, non-null

• startClient

  private void startClient()

  Starts a generic client tunnel.

• startServer

  private void startServer()

  Starts a generic server tunnel.

• startHttpServer

  private void startHttpServer()

  Starts an http server tunnel.

• startHttpBidirServer

  private void startHttpBidirServer()

  Starts a bidirectional http server tunnel.

• startIrcServer

  private void startIrcServer()

  Starts an IRC server tunnel.

• setListenOn

  private void setListenOn()

  Sets the local address the tunnel listens on.

• getClientOptionProps

  public Properties getClientOptionProps()

  These are the ones stored with a prefix of "option." Defaults in config properties are not honored.

  Returns:

  keys with the "option." prefix stripped, non-null Much better than getClientOptions()

• setSessionOptions

  private void setSessionOptions()

  Applies the session-level options to the tunnel.

• setI2CPOptions

  private void setI2CPOptions()

  Applies the I2CP options from the config to the tunnel.

• stopTunnel

  public void stopTunnel()

  May be restarted with restartTunnel() or startTunnel() later. This may not release all resources. In particular, the I2PSocketManager remains and it may have timer threads that continue running.

• getStartupDelayMin

  public int getStartupDelayMin()

  When combined with a greater startupDelayMax, the tunnel will start with a random delay between min and max seconds.

  Returns:

  the minimum startup delay in seconds for server tunnels.

• getStartupDelayMax

  public int getStartupDelayMax()

  When combined with a positive startupDelayMin less than this value, the tunnel will start with a random delay between min and max seconds.

  Returns:

  the maximum startup delay in seconds for server tunnels.

• getShutdownDelayMin

  public int getShutdownDelayMin()

  When combined with a greater shutdownDelayMax, the tunnel will stop with a random delay between min and max seconds during router shutdown.

  Returns:

  the minimum shutdown delay in seconds for server tunnels.

• getShutdownDelayMax

  public int getShutdownDelayMax()

  When combined with a positive shutdownDelayMin less than this value, the tunnel will stop with a random delay between min and max seconds during router shutdown.

  Returns:

  the maximum shutdown delay in seconds for server tunnels.

• getDelay

  private int getDelay(String key, int def)

  Read a delay option, clamped to non-negative.

  Parameters:

  key - the config key

  def - the default when unset or unparsable

  Returns:

  the delay in seconds

• getRemainingStartupDelay

  public int getRemainingStartupDelay()

  Get the remaining startup delay time for tunnels with delayed startup.

  Returns:

  remaining delay in seconds, or 0 if not in delayed startup state or delay has passed

• setStartupDelayEndTime

  void setStartupDelayEndTime(long delayMs)

  Set the startup delay end time. Called by TunnelControllerGroup when setting up delayed startup.

  Parameters:

  delayMs - the delay in milliseconds

• destroyTunnel

  public void destroyTunnel()

  May NOT be restarted with restartTunnel() or startTunnel() later. This should release all resources.

• restartTunnel

  public void restartTunnel()

  Stops and restarts the tunnel.

  This method stops the tunnel if running, waits briefly, then starts the tunnel again. The restart is performed synchronously, blocking until complete.

  See Also:

  • startTunnel()
  • stopTunnel()

• setConfig

  public void setConfig(Properties config, String prefix)

  Update the options on an existing session.

  Parameters:

  config - key=value mapping for all tunnels; only the entries whose key starts with prefix are taken

  prefix - tunnel's key prefix, stripped from the keys it matched; an empty prefix takes config as-is

• filterProperties

  private static Properties filterProperties(Properties config, String prefix)

  Copy the properties with the given prefix stripped, or return the given properties unchanged if the prefix is empty.

  Parameters:

  config - the incoming properties

  prefix - the key prefix to strip

  Returns:

  the filtered properties

• setServerDefaults

  private void setServerDefaults(String type)

  Apply the default options for web server tunnels, including gzip and bundle-reply handling.

  Parameters:

  type - the tunnel type

• setIrcDefaults

  private void setIrcDefaults(String type)

  Apply the default session tags, enctype, and priority for IRC and streaming tunnels.

  Parameters:

  type - the tunnel type

• setSignatureDefault

  private void setSignatureDefault(String type)

  Apply the default signature type for tunnels that support it, mirroring EditBean.getSigType(int, String) and GeneralHelper.getSigType(int, String) .

  Parameters:

  type - the tunnel type

• setConnectionLimitsDefaults

  private void setConnectionLimitsDefaults(String type)

  Apply the default connection and post limits, plus the filter definition and profile, for server tunnels.

  Parameters:

  type - the tunnel type

• setClientDefaults

  private void setClientDefaults(String type)

  Apply the default encryption type for HTTP proxy and shared client tunnels.

  Parameters:

  type - the tunnel type

• configChanged

  private static boolean configChanged(Properties p1, Properties p2, String p)

  Is property p different in p1 and p2?

  Parameters:

  p1 - the old properties

  p2 - the new properties

  p - the property key to compare

  Returns:

  true if the value changed or was newly set

• getConfig

  public Properties getConfig(String prefix)

  The tunnel config, with each key prefixed, or a copy if the prefix is empty.

  Parameters:

  prefix - prepended to every key; an empty prefix copies the keys as-is

  Returns:

  a new Properties, never the live config

• getConfigFile

  public File getConfigFile()

  The config file as passed into the constructor via the "configFile" property, or as set later.

  Returns:

  the config file, or null

• setConfigFile

  public void setConfigFile(File file)

  Set the config file. Only do this if previously null.

  Parameters:

  file - where this tunnel's config was loaded from, for saving later

• getType

  public String getType()

  Returns the tunnel's type as configured.

  Returns:

  the type name from the config

• getName

  public String getName()

  Returns the tunnel's display name.

  Returns:

  the name from the config

• getDescription

  public String getDescription()

  Returns the tunnel's description.

  Returns:

  the free-text description from the config

• getI2CPHost

  public String getI2CPHost()

  The I2CP host the router is on.

  Returns:

  the I2CP host

• getI2CPPort

  public String getI2CPPort()

  The I2CP port the router is on.

  Returns:

  the I2CP port

• getFilter

  public String getFilter()

  Absolute path to filter definition file.

  Returns:

  the configured filter definition path, or null if no filter is set

• isClient

  public boolean isClient()

  Whether this tunnel is a client type in the UI and I2P side.

  Returns:

  true if this tunnel is a client type

• isClient

  public static boolean isClient(String type)

  Whether the given type is a client type in the UI and I2P side. Note that a streamr client is a UI and I2P client but a server on the localhost side. Note that a streamr server is a UI and I2P server but a client on the localhost side.

  Parameters:

  type - one of the TYPE_ values, or null when unset

  Returns:

  false if type == null

• getListenOnInterface

  public String getListenOnInterface()

  The interface the tunnel listens on.

  Returns:

  the listen interface

• getTargetHost

  public String getTargetHost()

  The hostname or IP address of the target.

  Returns:

  the target host

• getTargetPort

  public String getTargetPort()

  The port number of the target.

  Returns:

  the target port

• getSpoofedHost

  public String getSpoofedHost()

  The hostname sent in the HTTP Host header when spoofing is enabled.

  Returns:

  the spoofed host

• getPrivKeyFile

  public String getPrivKeyFile()

  Probably not absolute. May be null. getPrivateKeyFile() recommended.

  Returns:

  the priv key file

• getListenPort

  public String getListenPort()

  The port the tunnel listens on.

  Returns:

  the listen port

• getTargetDestination

  public String getTargetDestination()

  The base64-encoded target destination.

  Returns:

  the target destination

• getProxyList

  public String getProxyList()

  The comma-separated list of proxies for the tunnel.

  Returns:

  the proxy list

• getSharedClient

  public String getSharedClient()

  Whether this tunnel shares its tunnels with other client tunnels.

  Returns:

  "true" or "false" as a string, never null; server types always report "false" and a client with the property unset reports "true"

• getStartOnLoad

  public boolean getStartOnLoad()

  Whether this tunnel is configured to start when the router starts. Defaults to true when unset.

  Returns:

  true if this tunnel starts on router startup

• getPersistentClientKey

  public boolean getPersistentClientKey()

  Whether a persistent client key is used.

  Returns:

  true if persistent client key is enabled

• getPrivateKeyFile

  public File getPrivateKeyFile()

  Does not necessarily exist.

  Returns:

  absolute path or null if unset

• getAlternatePrivateKeyFile

  public File getAlternatePrivateKeyFile()

  Does not necessarily exist.

  Returns:

  absolute path or null if unset

• filenameToFile

  static File filenameToFile(String f)

  Does not necessarily exist.

  Parameters:

  f - relative or absolute path, may be null

  Returns:

  absolute path or null

• getMyDestination

  public String getMyDestination()

  Get my destination as a Base64 string.

  Returns:

  Base64 or null

• getMyDestHashBase32

  public String getMyDestHashBase32()

  Get my destination's base32 address.

  Returns:

  "{52 chars}.b32.i2p" or null

• getDestination

  public Destination getDestination()

  Get the destination from the first session that has one.

  Returns:

  Destination or null

• getIsOfflineKeys

  public boolean getIsOfflineKeys()

  Check whether the primary session uses offline keys.

  Returns:

  true if the primary session has offline keys

• getIsOfflineKeysAnySession

  private boolean getIsOfflineKeysAnySession()

  Check whether any session or subsession uses offline keys.

  Returns:

  true if ANY session or subsession has offline keys

• getIsRunning

  public boolean getIsRunning()

  Checks if the tunnel is currently running.

  Returns:

  true if the tunnel state is RUNNING

• getIsStarting

  public boolean getIsStarting()

  Checks if the tunnel is starting or starting on load.

  Returns:

  true if the tunnel is in the process of starting

• getState

  public TunnelController.TunnelState getState()

  The current state of this tunnel.

  Returns:

  the current TunnelState

• getIsStandby

  public boolean getIsStandby()

  Checks if the tunnel is in standby mode.

  A tunnel is in standby when it is running but has no open sessions.

  Returns:

  true if the tunnel is running but has no active sessions

• changeState

  public void changeState(TunnelController.TunnelState state)

  Changes the tunnel state and notifies any waiting threads.

  Parameters:

  state - the new value for getState()

• log

  public void log(String s)

  Logs a message unless suppressed, keeping only the most recent 10.

  Specified by:

  log in interface Logging

  Parameters:

  s - the message to log

• suppressLog

  public void suppressLog()

  Suppress log messages during tunnel restart.

• restoreLog

  public void restoreLog()

  Restore log messages after restart.

• clearMessages

  public List<String> clearMessages()

  Pull off any messages that the I2PTunnel has produced.

  Returns:

  list of messages pulled off (each is a String, earliest first)

• toString

  public String toString()

  Overrides:

  toString in class Object