EditBean

java.lang.Object

net.i2p.i2ptunnel.web.IndexBean

net.i2p.i2ptunnel.web.EditBean

public class EditBeanextends IndexBean

Web interface bean for editing and configuring I2P tunnel settings.

Warning - This class is not part of the i2ptunnel API, it has been moved from the jar to the war. Usage by classes outside of i2ptunnel.war is deprecated.

Field Summary
Fields inherited from class IndexBean
_context, _group, _helper, _log, NOT_RUNNING, RUNNING, STANDBY, STARTING
Modifier and Type
Field
Description
protected final I2PAppContext
_context
App context, for properties, randomness and key generation.
protected final TunnelControllerGroup
_group
The configured tunnels, null if the group is not initialized.
protected final GeneralHelper
_helper
Reads tunnel properties, shared with subclasses.
protected final Log
_log
Log for this bean.
static final int
NOT_RUNNING
Tunnel status: not running.
static final int
RUNNING
Tunnel status: running.
static final int
STANDBY
Tunnel status: standby.
static final int
STARTING
Tunnel status: starting.
Constructor Summary
Constructors
Constructor
Description
EditBean()
Constructs the edit-page bean.
Method Summary
Modifier and Type
Method
Description
boolean
canChangeEncType(int tunnel)
Returns whether the tunnel encryption type can be changed.
boolean
canChangePort(int tunnel)
Returns whether the tunnel port setting can be changed.
boolean
canChangeSigType(int tunnel)
Returns whether the tunnel signature type can be changed.
String
getAccessList(int tunnel)
The access list for the tunnel.
String
getAccessMode(int tunnel)
The access mode for the tunnel.
boolean
getAllowAccept(int tunnel)
Returns whether Accept header passthrough is allowed.
boolean
getAllowInternalSSL(int tunnel)
Returns whether internal SSL connections are allowed.
boolean
getAllowReferer(int tunnel)
Returns whether Referer header passthrough is allowed.
boolean
getAllowUserAgent(int tunnel)
Returns whether User-Agent header passthrough is allowed.
String
getAltPrivateKeyFile(int tunnel)
The alternate private key file for the tunnel.
String
getBlindedPassword(int tunnel)
Configured blinded password used to authenticate to the tunnel peer.
int
getCert(int tunnel)
The certificate for the tunnel.
List<String>
getClientAuths(int tunnel, boolean isDH)
List of b64 name : b64key Pubkeys for DH, privkeys for PSK.
boolean
getClose(int tunnel)
Whether the tunnel should close on idle.
int
getCloseTime(int tunnel)
The close time in minutes for the tunnel.
String
getCustomOptions(int tunnel)
The custom options string for the tunnel.
boolean
getDCC(int tunnel)
Whether DCC is enabled for the tunnel.
boolean
getDelayOpen(int tunnel)
Whether the tunnel open should be delayed.
int
getEffort(int tunnel)
The encryption effort for the tunnel.
boolean
getEncrypt(int tunnel)
Whether encryption is enabled for the tunnel.
String
getEncryptKey(int tunnel)
The encryption key for the tunnel.
String
getEncryptMode(int tunnel)
Configured encryption mode for the tunnel, as a numeric string.
String
getFilterDefinition(int tunnel)
Configured peer filter definition for the tunnel.
String
getI2CPHost(int tunnel)
The I2CP host for the tunnel.
String
getI2CPPort(int tunnel)
The I2CP port for the tunnel.
String
getJumpList(int tunnel)
The jump list for the tunnel.
String
getKey1(int tunnel)
Returns the encrypted inbound random key, hidden in forms.
String
getKey2(int tunnel)
The encrypted outbound random key.
String
getKey3(int tunnel)
The encrypted lease set signing private key.
String
getKey4(int tunnel)
The encrypted lease set private key.
int
getLimitDay(int tunnel)
The per-day limit for the tunnel.
int
getLimitHour(int tunnel)
The per-hour limit for the tunnel.
int
getLimitMinute(int tunnel)
The per-minute limit for the tunnel.
int
getMaxStreams(int tunnel)
The maximum number of streams for the tunnel.
boolean
getMultihome(int tunnel)
Whether multihoming is enabled.
boolean
getNewDest(int tunnel)
Whether a new destination should be created.
boolean
getOutproxyAuth(int tunnel)
Whether outproxy authentication is enabled.
String
getOutproxyPassword(int tunnel)
The outproxy password.
String
getOutproxyType(int tunnel)
The outproxy type.
String
getOutproxyUsername(int tunnel)
The outproxy username.
boolean
getPersistentClientKey(int tunnel)
Whether the client key should be persistent.
int
getPostBanTime(int tunnel)
The POST ban time for the tunnel.
int
getPostCheckTime(int tunnel)
The POST check time for the tunnel.
int
getPostMax(int tunnel)
POST limits.
int
getPostTotalBanTime(int tunnel)
The POST total ban time for the tunnel.
int
getPostTotalMax(int tunnel)
The POST total max for the tunnel.
String
getPrivateKeyFile(int tunnel)
The private key file for the tunnel.
boolean
getProxyAuth(int tunnel)
Whether proxy authentication is enabled.
String
getQuantityOptions(int tunnel, int mode)
The quantity options for the tunnel, as HTML.
boolean
getReduce(int tunnel)
Whether the tunnel should reduce on idle.
int
getReduceCount(int tunnel)
The reduce count for the tunnel.
int
getReduceTime(int tunnel)
The reduce time in minutes for the tunnel.
int
getShutdownDelayMax(int tunnel)
The maximum shutdown delay in seconds for server tunnels.
int
getShutdownDelayMin(int tunnel)
The minimum shutdown delay in seconds for server tunnels.
String
getSigner(int tunnel)
The signer for the tunnel.
SigningPrivateKey
getSigningPrivateKey(int tunnel)
The signing private key for the tunnel.
int
getSigType(int tunnel, String newTunnelType)
Configured signature type for the tunnel's destination.
String
getSslProxies(int tunnel)
The SSL proxies string.
int
getStartupDelayMax(int tunnel)
The maximum startup delay in seconds for server tunnels.
int
getStartupDelayMin(int tunnel)
The minimum startup delay in seconds for server tunnels.
String
getTargetHost(int tunnel)
The target host for the tunnel.
String
getTargetPort(int tunnel)
The target port for the tunnel, or empty string if none.
int
getTotalDay(int tunnel)
The per-day total for the tunnel.
int
getTotalHour(int tunnel)
The per-hour total for the tunnel.
int
getTotalMinute(int tunnel)
The per-minute total for the tunnel.
int
getTunnelBackupQuantity(int tunnel, int defaultBackupQuantity)
Gets the backup tunnel quantity for inbound or both in/out.
int
getTunnelBackupQuantityOut(int tunnel, int defaultBackupQuantity)
Configured number of backup outbound tunnels.
int
getTunnelDepth(int tunnel, int defaultLength)
Gets the tunnel depth (number of hops) for inbound tunnels.
int
getTunnelDepthOut(int tunnel, int defaultLength)
Configured hop count for the tunnel's outbound (client-side) tunnels.
int
getTunnelQuantity(int tunnel, int defaultQuantity)
Gets the tunnel quantity for inbound or both in/out.
int
getTunnelQuantityOut(int tunnel, int defaultQuantity)
Configured number of primary outbound tunnels.
int
getTunnelVariance(int tunnel, int defaultVariance)
Gets the tunnel variance for inbound or both in/out.
int
getTunnelVarianceOut(int tunnel, int defaultVariance)
Configured length variance allowed for outbound tunnels.
boolean
getUniqueLocal(int tunnel)
Whether unique local addresses should be used.
boolean
getUseOutproxyPlugin(int tunnel)
Whether the outproxy plugin should be used.
String
getUserAgents(int tunnel)
The user agents string.
boolean
hasEncType(int tunnel, int encType)
Returns whether the tunnel supports the specified encryption type.
Set<String>
interfaceSet()
The set of network interfaces.
boolean
isAdvanced()
Whether advanced mode is enabled.
boolean
isInteractive(int tunnel)
Whether the tunnel is interactive (requires immediate response).
boolean
isRouterContext()
Whether running in router context.
boolean
isSigTypeAvailable(int code)
Returns whether the given signature type is available.
boolean
shouldDelay(int tunnel)
Whether the tunnel connection should be delayed until the first client connects.
boolean
startAutomatically(int tunnel)
Whether the tunnel is configured to start when the router starts.
static boolean
staticIsClient(int tunnel)
Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side.
String
unlessAdvanced(String s)
The translated string wrapped in parentheses, or empty in advanced mode.
Methods inherited from class IndexBean
_t, encrypt, getAltDestHashBase32, getAltDestination, getAltDestinationBase64, getClientDestination, getClientInterface, getClientPort, getClientPort2, getController, getControllerNumbers, getDestHashBase32, getDestination, getDestinationBase64, getEncryptedBase32, getInternalType, getIsOfflineKeys, getIsUsingOutproxyPlugin, getLastMessageID, getMessages, getNextNonce, getNextNonce, getRemainingStartupDelay, getServerTarget, getSharedClient, getSpoofedHost, getTheme, getThemeName, getTunnelCount, getTunnelDescription, getTunnelName, getTunnelStatus, getTunnelType, getType, getTypeName, haveNonce, haveNonce, isClient, isClient, isInitialized, isRejectInproxy, isRejectReferer, isRejectUserAgents, isServer, isServerTargetLinkValid, isSharedClient, isSSLEnabled, isValidIRCServer, ngettext, setAccessList, setAccessMode, setAction, setAddClient, setAllowAccept, setAllowInternalSSL, setAllowReferer, setAllowUserAgent, setAltPrivKeyFile, setCert, setClientHost, setclientKey, setClientport, setClose, setCloseTime, setConnectDelay, setDCC, setDelayOpen, setEncrypt, setEncryptKey, setEncryptMode, setEncType, setFilterDefinition, setJumpList, setKey1, setKey2, setKey3, setKey4, setLimitDay, setLimitHour, setLimitMinute, setMaxStreams, setMsgid, setMultihome, setNewClientKey, setNewDest, setNofilter_blindedPassword, setNofilter_clientName, setNofilter_customOptions, setNofilter_description, setNofilter_name, setNofilter_newClientName, setNofilter_outproxyPassword, setNofilter_proxyPassword, setNonce, setOutproxyAuth, setOutproxyType, setOutproxyUsername, setPort, setPostBanTime, setPostCheckTime, setPostMax, setPostTotalBanTime, setPostTotalMax, setPrivKeyFile, setProfile, setProxyAuth, setProxyList, setProxyUsername, setReachableBy, setReduce, setReduceCount, setReduceTime, setRejectInproxy, setRejectReferer, setRejectUserAgents, setRemoveConfirm, setRevokeClient, setSession, setShared, setShared, setShutdownDelayMax, setShutdownDelayMin, setSigner, setSigType, setSpoofedHost, setSslProxies, setStartOnLoad, setStartupDelayMax, setStartupDelayMin, setTargetDestination, setTargetHost, setTargetPort, setTotalDay, setTotalHour, setTotalMinute, setTunnel, setTunnelBackupQuantity, setTunnelBackupQuantityOut, setTunnelDepth, setTunnelDepthOut, setTunnelQuantity, setTunnelQuantityOut, setTunnelVariance, setTunnelVarianceOut, setType, setUniqueLocal, setUseOutproxyPlugin, setUserAgents, setUseSSL, storeMethod, useSoraFont
Modifier and Type
Method
Description
protected String
_t(String key)
Translate a string.
protected String
encrypt(int tunnel, String k, String v)
Encrypt a property using an in-memory key, for interaction with the UI only, using ChaCha20.
String
getAltDestHashBase32(int tunnel)
Works even if tunnel is not running.
protected Destination
getAltDestination(int tunnel)
Works even if tunnel is not running.
String
getAltDestinationBase64(int tunnel)
Works even if tunnel is not running.
String
getClientDestination(int tunnel)
The destination Base64 for the specified client tunnel.
String
getClientInterface(int tunnel)
The interface the specified client tunnel is configured to listen on.
String
getClientPort(int tunnel)
No validation.
String
getClientPort2(int tunnel)
Returns error message if blank or invalid.
protected TunnelController
getController(int tunnel)
The controller for the given tunnel index.
List<Integer>
getControllerNumbers(boolean isClient)
Return tunnel numbers of clients or servers only, sorted by tunnel name.
String
getDestHashBase32(int tunnel)
Works even if tunnel is not running.
protected Destination
getDestination(int tunnel)
Works even if tunnel is not running.
String
getDestinationBase64(int tunnel)
Works even if tunnel is not running.
String
getEncryptedBase32(int tunnel)
Works even if tunnel is not running.
String
getInternalType(int tunnel)
The internal type string for the specified tunnel.
boolean
getIsOfflineKeys(int tunnel)
Works even if tunnel is not running.
boolean
getIsUsingOutproxyPlugin(int tunnel)
For index.jsp.
int
getLastMessageID()
The last stored message ID.
String
getMessages()
Executes any action requested (start/stop/etc) and dump out the messages.
static String
getNextNonce()
Get the next nonce from the queue.
static String
getNextNonce(HttpSession session)
Session-bound nonce generation - replaces static nonce when session available.
int
getRemainingStartupDelay(int tunnel)
The remaining startup delay for the specified tunnel.
String
getServerTarget(int tunnel)
Get the server target.
String
getSharedClient(int tunnel)
Get the shared client for a tunnel.
String
getSpoofedHost(int tunnel)
Get the spoofed host for a tunnel.
String
getTheme()
Get the theme path.
String
getThemeName()
Get the theme name.
int
getTunnelCount()
Get the number of tunnels.
String
getTunnelDescription(int tunnel)
The description for the specified tunnel, HTML-escaped.
String
getTunnelName(int tunnel)
Get the tunnel name.
int
getTunnelStatus(int tunnel)
The current status of the specified tunnel.
String
getTunnelType(int tunnel)
Get the tunnel type.
(package private) String
getType()
The tunnel type.
String
getTypeName(String internalType)
Get the display name for an internal type.
static boolean
haveNonce(String nonce)
Whether we know this nonce.
static boolean
haveNonce(String nonce, HttpSession session)
Session-bound nonce validation.
boolean
isClient(int tunnelNum)
Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side.
static boolean
isClient(String type)
Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side.
boolean
isInitialized()
Check if the tunnel group is initialized.
boolean
isRejectInproxy(int tunnel)
Are requests carrying inproxy forwarding headers rejected?
boolean
isRejectReferer(int tunnel)
Are requests carrying a Referer header rejected?
boolean
isRejectUserAgents(int tunnel)
Are blacklisted User-Agents rejected?
boolean
isServer(int tunnel)
Is this a server tunnel?
boolean
isServerTargetLinkValid(int tunnel)
Call this to see if it is ok to linkify IndexBean.getServerTarget(int).
boolean
isSharedClient(int tunnel)
Check if the tunnel is a shared client.
boolean
isSSLEnabled(int tunnel)
Is SSL enabled for the server tunnel?
boolean
isValidIRCServer(int tunnel)
Is this an IRC server? Call to establish if we should provide irc:// link on index page.
protected String
ngettext(String s, String p, int n)
translate (ngettext).
void
setAccessList(String val)
Comma-separated list of destinations to whitelist or blacklist.
void
setAccessMode(String val)
Set the access mode, 0 for none, 1 for whitelist, 2 for blacklist.
void
setAction(String action)
Set the action to process.
void
setAddClient(String val)
Generate an extra per-client key, as for encrypt modes 6-9.
void
setAllowAccept(String val)
Allow the Accept header to pass through the HTTP client.
void
setAllowInternalSSL(String val)
Allow SSL connections through the HTTP client.
void
setAllowReferer(String val)
Allow the Referer header to pass through the HTTP client.
void
setAllowUserAgent(String val)
Allow the User-Agent header to pass through the HTTP client.
void
setAltPrivKeyFile(String file)
What filename is this server tunnel's alternate private keys stored in.
void
setCert(String val)
Set the certificate type, from the form selection.
void
setClientHost(String host)
I2CP host the router is on, ignored when in router context.
void
setclientKey(String[] s)
Set client keys for access control (multiple entries in form).
void
setClientport(String port)
I2CP port the router is on, ignored when in router context.
void
setClose(String val)
Close connections when idle.
void
setCloseTime(String val)
Idle time in minutes before closing connections.
void
setConnectDelay(String val)
Delay the connection to the target until the first client connects.
void
setDCC(String val)
Allow DCC in IRC clients.
void
setDelayOpen(String val)
Delay opening to the target until the first client connects.
void
setEncrypt(String val)
Encrypt the lease set.
void
setEncryptKey(String val)
Key for encrypting the lease set.
void
setEncryptMode(String val)
Set the LeaseSet encryption mode.
void
setEncType(String s)
Adds to existing, comma separated.
void
setFilterDefinition(String val)
Set the filter definition.
void
setJumpList(String val)
Comma-separated list of HTTP outproxy jump servers.
void
setKey1(String s)
Random keys, hidden in forms.
void
setKey2(String s)
Random outbound key, hidden in forms.
void
setKey3(String s)
Lease set signing private key, hidden in forms.
void
setKey4(String s)
Lease set private key, hidden in forms.
void
setLimitDay(String s)
Maximum total number of connections per day.
void
setLimitHour(String s)
Maximum total number of connections per hour.
void
setLimitMinute(String s)
Maximum total number of connections per minute.
void
setMaxStreams(String s)
Maximum number of concurrent streams.
void
setMsgid(String id)
Set the message ID for clearing messages.
void
setMultihome(String val)
Bundle reply info for multihoming.
void
setNewClientKey(String s)
Add a key for per-client LeaseSet encryption.
void
setNewDest(String val)
Control how ephemeral the destination is.
void
setNofilter_blindedPassword(String s)
Set the blinded password for hidden encrypted LeaseSets.
void
setNofilter_clientName(String[] s)
Set client names for access control (multiple entries in form).
void
setNofilter_customOptions(String customOptions)
What I2P session overrides should be used.
void
setNofilter_description(String description)
One line host description.
void
setNofilter_name(String name)
Short name of the tunnel.
void
setNofilter_newClientName(String s)
Add a client for per-client LeaseSet encryption.
void
setNofilter_outproxyPassword(String s)
Password for outproxy authentication.
void
setNofilter_proxyPassword(String s)
Password for client proxy authentication.
void
setNonce(String nonce)
Set the current nonce.
void
setOutproxyAuth(String s)
Require authentication for the outproxies.
void
setOutproxyType(String s)
Set the type of the outproxy.
void
setOutproxyUsername(String s)
Username for outproxy authentication.
void
setPort(String port)
What port should this client/httpclient/ircclient listen on.
void
setPostBanTime(String s)
How long to ban a client that exceeds the POST limits, in minutes.
void
setPostCheckTime(String s)
How often the total POST limit is checked, in minutes.
void
setPostMax(String s)
Maximum number of POST or PUT requests per check window, per peer.
void
setPostTotalBanTime(String s)
How long to ban a client that exceeds the total POST limit, in minutes.
void
setPostTotalMax(String s)
Maximum total number of POST or PUT requests in the check interval.
void
setPrivKeyFile(String file)
What filename is this server tunnel's private keys stored in.
void
setProfile(String profile)
Set the streaming profile.
void
setProxyAuth(String s)
Set the proxy authentication type.
void
setProxyList(String proxyList)
What HTTP outproxies should be used (httpclient specific).
void
setProxyUsername(String s)
Username for client proxy authentication.
void
setReachableBy(String reachableBy)
What interface should this client/httpclient/ircclient listen on.
void
setReduce(String val)
Reduce the number of connections when idle.
void
setReduceCount(String val)
Number of connections to reduce to when idle.
void
setReduceTime(String val)
Idle time in minutes before reducing connections.
void
setRejectInproxy(String val)
Reject requests carrying inproxy forwarding headers.
void
setRejectReferer(String val)
Reject requests carrying a Referer header.
void
setRejectUserAgents(String val)
Reject requests whose User-Agent matches the blocklist.
void
setRemoveConfirm(String val)
If called with any value (and the form submitted with action=Remove), we really do want to stop and remove the tunnel.
void
setRevokeClient(String[] s)
Revoke access for specified clients (multiple entries in form, values are integers).
void
setSession(HttpSession session)
For session-bound nonce generation and validation.
void
setShared(boolean val)
Share the private key with other client tunnels.
void
setShared(String val)
Share the private key with other client tunnels.
void
setShutdownDelayMax(String val)
The maximum shutdown delay in seconds for server tunnels.
void
setShutdownDelayMin(String val)
The minimum shutdown delay in seconds for server tunnels.
void
setSigner(String val)
Set the certificate signer.
void
setSigType(String val)
Set the destination signature type, and rewrite the certificate to match.
void
setSpoofedHost(String host)
What host does this http server tunnel spoof.
void
setSslProxies(String s)
Comma-separated list of SSL-capable outproxies.
void
setStartOnLoad(String val)
If called with any value, we want this tunnel to start whenever it is loaded (aka right now and whenever the router is started up).
void
setStartupDelayMax(String val)
The maximum startup delay in seconds for server tunnels.
void
setStartupDelayMin(String val)
The minimum startup delay in seconds for server tunnels.
void
setTargetDestination(String dest)
What peer does this client tunnel point at.
void
setTargetHost(String host)
What host does this server tunnel point at.
void
setTargetPort(String port)
What port does this server tunnel point at.
void
setTotalDay(String s)
Maximum total number of connections per day, enforced by the total limit.
void
setTotalHour(String s)
Maximum total number of connections per hour, enforced by the total limit.
void
setTotalMinute(String s)
Maximum total number of connections per minute, enforced by the total limit.
void
setTunnel(String tunnel)
Set the tunnel number.
void
setTunnelBackupQuantity(String tunnelBackupQuantity)
How many tunnels to hold in reserve to guard against failures In or both in/out.
void
setTunnelBackupQuantityOut(String tunnelBackupQuantity)
How many outbound tunnels to hold in reserve to guard against failures.
void
setTunnelDepth(String tunnelDepth)
How many hops to use for inbound tunnels In or both in/out.
void
setTunnelDepthOut(String tunnelDepth)
How many hops to use for outbound tunnels.
void
setTunnelQuantity(String tunnelQuantity)
How many parallel inbound tunnels to use In or both in/out.
void
setTunnelQuantityOut(String tunnelQuantity)
How many parallel outbound tunnels to use.
void
setTunnelVariance(String tunnelVariance)
How much randomisation to apply to the depth of tunnels In or both in/out.
void
setTunnelVarianceOut(String tunnelVariance)
How much randomisation to apply to the depth of outbound tunnels.
void
setType(String type)
What type of tunnel (httpclient, ircclient, client, or server).
void
setUniqueLocal(String val)
Assign unique local hostnames for destination lookup.
void
setUseOutproxyPlugin(String val)
Use the outproxy plugin for HTTP requests.
void
setUserAgents(String agents)
Set the User-Agent blocklist.
void
setUseSSL(String val)
Use SSL on the server port.
void
storeMethod(String method)
Store request method for P-R-G pattern.
boolean
useSoraFont()
Check if the Sora font is enabled.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- EditBean
  public EditBean()
  Constructs the edit-page bean.
Method Details
- staticIsClient
  public static boolean staticIsClient(int tunnel)
  Is it a client or server 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:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if the tunnel is a client type
- getTargetHost
  public String getTargetHost(int tunnel)
  The target host for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the target host for the tunnel
- getTargetPort
  public String getTargetPort(int tunnel)
  The target port for the tunnel, or empty string if none.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the target port, or "" if none
- getPrivateKeyFile
  public String getPrivateKeyFile(int tunnel)
  The private key file for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the private key file
- getAltPrivateKeyFile
  public String getAltPrivateKeyFile(int tunnel)
  The alternate private key file for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  path or ""
- getSigningPrivateKey
  public SigningPrivateKey getSigningPrivateKey(int tunnel)
  The signing private key for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  key or null
- startAutomatically
  public boolean startAutomatically(int tunnel)
  Whether the tunnel is configured to start when the router starts.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if the tunnel starts automatically
- getStartupDelayMin
  public int getStartupDelayMin(int tunnel)
  The minimum startup delay in seconds for server tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  the minimum startup delay in seconds
- getStartupDelayMax
  public int getStartupDelayMax(int tunnel)
  The maximum startup delay in seconds for server tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  the maximum startup delay in seconds
- getShutdownDelayMin
  public int getShutdownDelayMin(int tunnel)
  The minimum shutdown delay in seconds for server tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  the minimum shutdown delay in seconds
- getShutdownDelayMax
  public int getShutdownDelayMax(int tunnel)
  The maximum shutdown delay in seconds for server tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  the maximum shutdown delay in seconds
- shouldDelay
  public boolean shouldDelay(int tunnel)
  Whether the tunnel connection should be delayed until the first client connects.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if the connection is delayed
- isInteractive
  public boolean isInteractive(int tunnel)
  Whether the tunnel is interactive (requires immediate response).
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if the tunnel is interactive
- getTunnelDepth
  public int getTunnelDepth(int tunnel, int defaultLength)
  Gets the tunnel depth (number of hops) for inbound tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  defaultLength - the default depth if not configured
  Returns:
  the tunnel depth, or -1 for default
- getTunnelQuantity
  public int getTunnelQuantity(int tunnel, int defaultQuantity)
  Gets the tunnel quantity for inbound or both in/out.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  defaultQuantity - the default quantity if not configured
  Returns:
  the tunnel quantity
- getTunnelBackupQuantity
  public int getTunnelBackupQuantity(int tunnel, int defaultBackupQuantity)
  Gets the backup tunnel quantity for inbound or both in/out.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  defaultBackupQuantity - the default backup quantity if not configured
  Returns:
  the backup tunnel quantity
- getTunnelVariance
  public int getTunnelVariance(int tunnel, int defaultVariance)
  Gets the tunnel variance for inbound or both in/out.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  defaultVariance - the default variance if not configured
  Returns:
  the tunnel variance
- getTunnelDepthOut
  public int getTunnelDepthOut(int tunnel, int defaultLength)
  Configured hop count for the tunnel's outbound (client-side) tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  defaultLength - the default depth if not configured
  Returns:
  the outbound tunnel depth, or -1 for default
- getTunnelQuantityOut
  public int getTunnelQuantityOut(int tunnel, int defaultQuantity)
  Configured number of primary outbound tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  defaultQuantity - the default quantity if not configured
  Returns:
  the outbound tunnel quantity
- getTunnelBackupQuantityOut
  public int getTunnelBackupQuantityOut(int tunnel, int defaultBackupQuantity)
  Configured number of backup outbound tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  defaultBackupQuantity - the default backup quantity if not configured
  Returns:
  the outbound backup tunnel quantity
- getTunnelVarianceOut
  public int getTunnelVarianceOut(int tunnel, int defaultVariance)
  Configured length variance allowed for outbound tunnels.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  defaultVariance - the default variance if not configured
  Returns:
  the outbound tunnel variance
- getReduce
  public boolean getReduce(int tunnel)
  Whether the tunnel should reduce on idle.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if the tunnel should reduce on idle
- getReduceCount
  public int getReduceCount(int tunnel)
  The reduce count for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the reduce count for the tunnel
- getReduceTime
  public int getReduceTime(int tunnel)
  The reduce time in minutes for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the reduce time in minutes for the tunnel
- getCert
  public int getCert(int tunnel)
  The certificate for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the certificate for the tunnel
- getEffort
  public int getEffort(int tunnel)
  The encryption effort for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the encryption effort for the tunnel
- getSigner
  public String getSigner(int tunnel)
  The signer for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the signer for the tunnel
- getEncrypt
  public boolean getEncrypt(int tunnel)
  Whether encryption is enabled for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if encryption is enabled for the tunnel
- getEncryptMode
  public String getEncryptMode(int tunnel)
  Configured encryption mode for the tunnel, as a numeric string.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  the encryption mode as a string
- getBlindedPassword
  public String getBlindedPassword(int tunnel)
  Configured blinded password used to authenticate to the tunnel peer.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  the blinded password, or empty string if none
- getClientAuths
  public List<String> getClientAuths(int tunnel, boolean isDH)
  List of b64 name : b64key Pubkeys for DH, privkeys for PSK.
  Parameters:
  tunnel - index of the tunnel in the configured list
  isDH - true for DH, false for PSK
  Returns:
  non-null
- getSigType
  public int getSigType(int tunnel, String newTunnelType)
  Configured signature type for the tunnel's destination.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  newTunnelType - used if tunnel < 0
  Returns:
  the signature type code
- isSigTypeAvailable
  public boolean isSigTypeAvailable(int code)
  Returns whether the given signature type is available.
  Parameters:
  code - the signature type code
  Returns:
  true if available
- canChangeSigType
  public boolean canChangeSigType(int tunnel)
  Returns whether the tunnel signature type can be changed. The type is fixed if the tunnel has an existing destination.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if the signature type can be changed
- canChangeEncType
  public boolean canChangeEncType(int tunnel)
  Returns whether the tunnel encryption type can be changed.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if the encryption type can be changed
- canChangePort
  public boolean canChangePort(int tunnel)
  Returns whether the tunnel port setting can be changed.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if the port can be changed
- hasEncType
  public boolean hasEncType(int tunnel, int encType)
  Returns whether the tunnel supports the specified encryption type.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  encType - the encryption type code
  Returns:
  true if the tunnel has the encryption type
- getKey1
  public String getKey1(int tunnel)
  Returns the encrypted inbound random key, hidden in forms.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  the encrypted inbound random key
- getKey2
  public String getKey2(int tunnel)
  The encrypted outbound random key.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the encrypted outbound random key
- getKey3
  public String getKey3(int tunnel)
  The encrypted lease set signing private key.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the encrypted lease set signing private key
- getKey4
  public String getKey4(int tunnel)
  The encrypted lease set private key.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the encrypted lease set private key
- getDCC
  public boolean getDCC(int tunnel)
  Whether DCC is enabled for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if DCC is enabled for the tunnel
- getEncryptKey
  public String getEncryptKey(int tunnel)
  The encryption key for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the encryption key for the tunnel
- getAccessMode
  public String getAccessMode(int tunnel)
  The access mode for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the access mode for the tunnel
- getAccessList
  public String getAccessList(int tunnel)
  The access list for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the access list for the tunnel
- getFilterDefinition
  public String getFilterDefinition(int tunnel)
  Configured peer filter definition for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  the filter definition, or empty string if none
- getJumpList
  public String getJumpList(int tunnel)
  The jump list for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the jump list for the tunnel
- getClose
  public boolean getClose(int tunnel)
  Whether the tunnel should close on idle.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if the tunnel should close on idle
- getCloseTime
  public int getCloseTime(int tunnel)
  The close time in minutes for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the close time in minutes for the tunnel
- getNewDest
  public boolean getNewDest(int tunnel)
  Whether a new destination should be created.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if a new destination should be created
- getPersistentClientKey
  public boolean getPersistentClientKey(int tunnel)
  Whether the client key should be persistent.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if the client key should be persistent
- getDelayOpen
  public boolean getDelayOpen(int tunnel)
  Whether the tunnel open should be delayed.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if the tunnel open should be delayed
- getAllowUserAgent
  public boolean getAllowUserAgent(int tunnel)
  Returns whether User-Agent header passthrough is allowed.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if User-Agent passthrough is allowed
- getAllowReferer
  public boolean getAllowReferer(int tunnel)
  Returns whether Referer header passthrough is allowed.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if Referer passthrough is allowed
- getAllowAccept
  public boolean getAllowAccept(int tunnel)
  Returns whether Accept header passthrough is allowed.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if Accept passthrough is allowed
- getAllowInternalSSL
  public boolean getAllowInternalSSL(int tunnel)
  Returns whether internal SSL connections are allowed.
  Parameters:
  tunnel - index of the tunnel in the configured list, or -1 for a new tunnel
  Returns:
  true if internal SSL is allowed
- getMultihome
  public boolean getMultihome(int tunnel)
  Whether multihoming is enabled.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if multihoming is enabled
- getUserAgents
  public String getUserAgents(int tunnel)
  The user agents string.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the user agents string
- getProxyAuth
  public boolean getProxyAuth(int tunnel)
  Whether proxy authentication is enabled.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if proxy authentication is enabled
- getOutproxyAuth
  public boolean getOutproxyAuth(int tunnel)
  Whether outproxy authentication is enabled.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if outproxy authentication is enabled
- getOutproxyUsername
  public String getOutproxyUsername(int tunnel)
  The outproxy username.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the username, or empty string if none
- getOutproxyPassword
  public String getOutproxyPassword(int tunnel)
  The outproxy password.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the password, or empty string if none
- getSslProxies
  public String getSslProxies(int tunnel)
  The SSL proxies string.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the SSL proxies string
- getUseOutproxyPlugin
  public boolean getUseOutproxyPlugin(int tunnel)
  Whether the outproxy plugin should be used.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if the outproxy plugin should be used
- getOutproxyType
  public String getOutproxyType(int tunnel)
  The outproxy type.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the proxy type as configured for the tunnel
- getLimitMinute
  public int getLimitMinute(int tunnel)
  The per-minute limit for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the per-minute limit for the tunnel
- getLimitHour
  public int getLimitHour(int tunnel)
  The per-hour limit for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the per-hour limit for the tunnel
- getLimitDay
  public int getLimitDay(int tunnel)
  The per-day limit for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the per-day limit for the tunnel
- getTotalMinute
  public int getTotalMinute(int tunnel)
  The per-minute total for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the per-minute total for the tunnel
- getTotalHour
  public int getTotalHour(int tunnel)
  The per-hour total for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the per-hour total for the tunnel
- getTotalDay
  public int getTotalDay(int tunnel)
  The per-day total for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the per-day total for the tunnel
- getMaxStreams
  public int getMaxStreams(int tunnel)
  The maximum number of streams for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the maximum number of streams for the tunnel
- getPostMax
  public int getPostMax(int tunnel)
  POST limits.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the post max
- getPostTotalMax
  public int getPostTotalMax(int tunnel)
  The POST total max for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the POST total max for the tunnel
- getPostCheckTime
  public int getPostCheckTime(int tunnel)
  The POST check time for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the POST check time for the tunnel
- getPostBanTime
  public int getPostBanTime(int tunnel)
  The POST ban time for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the POST ban time for the tunnel
- getPostTotalBanTime
  public int getPostTotalBanTime(int tunnel)
  The POST total ban time for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the POST total ban time for the tunnel
- getUniqueLocal
  public boolean getUniqueLocal(int tunnel)
  Whether unique local addresses should be used.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  true if unique local addresses should be used
- isRouterContext
  public boolean isRouterContext()
  Whether running in router context.
  Returns:
  true if running in router context
- interfaceSet
  public Set<String> interfaceSet()
  The set of network interfaces.
  Returns:
  the set of network interfaces
- isAdvanced
  public boolean isAdvanced()
  Whether advanced mode is enabled.
  Returns:
  true if advanced mode is enabled
- getI2CPHost
  public String getI2CPHost(int tunnel)
  The I2CP host for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the I2CP host for the tunnel
- getI2CPPort
  public String getI2CPPort(int tunnel)
  The I2CP port for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the I2CP port for the tunnel
- getCustomOptions
  public String getCustomOptions(int tunnel)
  The custom options string for the tunnel.
  Parameters:
  tunnel - index of the tunnel in the configured list
  Returns:
  the custom options string for the tunnel
- getQuantityOptions
  public String getQuantityOptions(int tunnel, int mode)
  The quantity options for the tunnel, as HTML.
  Parameters:
  tunnel - index of the tunnel in the configured list
  mode - 0=both, 1=in, 2=out
  Returns:
  the quantity options
- unlessAdvanced
  public String unlessAdvanced(String s)
  The translated string wrapped in parentheses, or empty in advanced mode.
  Parameters:
  s - the string to translate
  Returns:
  translated s or ""

Field Summary

Fields inherited from class IndexBean

Constructor Summary

Method Summary

Methods inherited from class IndexBean

Methods inherited from class Object

Constructor Details

Method Details

staticIsClient

getTargetHost

getTargetPort

getPrivateKeyFile

getAltPrivateKeyFile

getSigningPrivateKey

startAutomatically

getStartupDelayMin

getStartupDelayMax

getShutdownDelayMin

getShutdownDelayMax

shouldDelay

isInteractive

getTunnelDepth

getTunnelQuantity

getTunnelBackupQuantity

getTunnelVariance

getTunnelDepthOut

getTunnelQuantityOut

getTunnelBackupQuantityOut

getTunnelVarianceOut

getReduce

getReduceCount

getReduceTime

getCert

getEffort

getSigner

getEncrypt

getEncryptMode

getBlindedPassword

getClientAuths

getSigType

isSigTypeAvailable

canChangeSigType

canChangeEncType

canChangePort

hasEncType

getKey1

getKey2

getKey3

getKey4

getDCC

getEncryptKey

getAccessMode

getAccessList

getFilterDefinition

getJumpList

getClose

getCloseTime

getNewDest

getPersistentClientKey

getDelayOpen

getAllowUserAgent

getAllowReferer

getAllowAccept

getAllowInternalSSL

getMultihome

getUserAgents

getProxyAuth

getOutproxyAuth

getOutproxyUsername

getOutproxyPassword

getSslProxies

getUseOutproxyPlugin

getOutproxyType

getLimitMinute

getLimitHour

getLimitDay

getTotalMinute

getTotalHour

getTotalDay