Banlist (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.router.Banlist

```
public class Banlist
extends Object
```
Manages router banlist entries with configurable expiration times and transport-specific bans. Provides methods to add, remove, and query ban status for routers based on various criteria including permanent bans, temporary bans, and transport-specific restrictions.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class Banlist.Entry
Entry representing a banned peer with expiration and reason information

Nested Classes
Modifier and Type	Class and Description
`static class`	`Banlist.Entry` Entry representing a banned peer with expiration and reason information

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`BANLIST_DURATION_BAD_PACKETS` Ban duration for repeat bad packet offenders.
`static long`	`BANLIST_DURATION_FOREVER` Permanent ban duration (will be rounded down to 180 days on console).
`static long`	`BANLIST_DURATION_MAX` Maximum ban duration for transient bans.
`static long`	`BANLIST_DURATION_MS` Default ban duration for transient bans.
`static long`	`BANLIST_DURATION_NO_NETWORK` Buggy i2pd fork
`static long`	`BANLIST_DURATION_PARTIAL` Default ban duration for transport-specific bans.
`static long`	`BANLIST_DURATION_PRIVATE` Ban duration for private IP addresses.
`static Hash`	`HASH_ZERORI` hash of 387 zeros

Constructor Summary
Constructors
Constructor and Description
Banlist(RouterContext context)
Constructor.

Constructors
Constructor and Description
`Banlist(RouterContext context)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`badPacket(Hash hash, String version)` Record a bad packet from a peer identified by its Router hash.
`void`	`badPacket(String ip, String version)` Record a bad packet from an IP.
`boolean`	`banlistRouter(Hash peer)` Ban a router with default duration.
`boolean`	`banlistRouter(Hash peer, String reason)` Ban a router with default duration.
`boolean`	`banlistRouter(Hash peer, String reason, String transport)` Ban a router on a specific transport.
`boolean`	`banlistRouter(Hash peer, String reason, String transport, boolean forever)` Ban a router with configurable duration and transport.
`boolean`	`banlistRouter(Hash peer, String reason, String reasonCode, String transport, long expireOn)` Ban a router with a specified expiration time.
`boolean`	`banlistRouter(String reasonCode, Hash peer, String reason)` Ban a router with default duration.
`boolean`	`banlistRouterForever(Hash peer, String reason)` Permanently ban a router.
`boolean`	`banlistRouterForever(Hash peer, String reason, String reasonCode)` Permanently ban a router.
`void`	`clearSessionBans()` Clear all session-based bans.
`void`	`corruptConnection(Hash hash, String version)` Record a corrupt connection from a peer identified by its Router hash.
`void`	`corruptConnection(String ip, String version)` Record a corrupt connection (EOF/no data during establishment) from an IP.
`long`	`getBadPacketDuration()` Get the current bad packet ban duration in ms.
`String`	`getCustomCapabilityBans()` Get custom capability ban pattern.
`Map<Hash,Banlist.Entry>`	`getEntries()` Get the banlist entries.
`int`	`getMaxOffenses()` Get the current max offenses setting.
`long`	`getOffenseWindow()` Get the current offense window setting in ms.
`int`	`getRouterCount()` Get the number of currently banlisted routers.
`long`	`getStartupGrace()` Get the current startup grace period in ms.
`boolean`	`isBadPacketBanEnabled()` Check if bad packet auto-ban is enabled.
`boolean`	`isBanlisted(Hash peer)` Check if a router is banlisted.
`boolean`	`isBanlisted(Hash peer, String transport)` Check if a router is banlisted on a specific transport.
`boolean`	`isBanlistedForever(Hash peer)` Check if a router is permanently banlisted.
`boolean`	`isBanlistedHostile(Hash peer)` Check if a router is banlisted with a hostile duration (at least 1 hour).
`boolean`	`isBlocklistEnabled()` Check if IP blocklist is enabled.
`boolean`	`isCorruptConnectionBanEnabled()` Check if corrupt connection auto-ban is enabled.
`boolean`	`isCountryBanEnabled()` Check if country-based bans are enabled.
`boolean`	`isLuBanEnabled()` Check if LU router bans are enabled.
`boolean`	`isPortHoppingBanEnabled()` Check if port hopping auto-ban is enabled.
`boolean`	`isTorBlocklistEnabled()` Check if Tor exit node blocklist is enabled.
`boolean`	`isXgBanEnabled()` Check if XG router bans are enabled.
`void`	`portHopping(Hash hash)` Record a port hopping attempt from a peer identified by its Router hash.
`void`	`portHopping(String ip)` Record a port hopping attempt from an IP.
`void`	`reloadConfig()` Reload configuration from properties.
`String`	`shouldBanlistByCapability(String capabilities)` Check if router capabilities match any of the custom ban patterns.
`boolean`	`shouldPurgeExistingRouters()` Check if a retroactive NetDb purge sweep is needed.
`void`	`unbanlistRouter(Hash peer)` Remove a router from the banlist.
`void`	`unbanlistRouter(Hash peer, String transport)` Remove a router from the banlist for a specific transport.

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

- Field Detail
  - BANLIST_DURATION_BAD_PACKETS
```
public static final long BANLIST_DURATION_BAD_PACKETS
```
    Ban duration for repeat bad packet offenders.
    See Also:
    Constant Field Values
  - BANLIST_DURATION_FOREVER
```
public static final long BANLIST_DURATION_FOREVER
```
    Permanent ban duration (will be rounded down to 180 days on console).
    See Also:
    Constant Field Values
  - BANLIST_DURATION_MAX
```
public static final long BANLIST_DURATION_MAX
```
    Maximum ban duration for transient bans.
    See Also:
    Constant Field Values
  - BANLIST_DURATION_MS
```
public static final long BANLIST_DURATION_MS
```
    Default ban duration for transient bans.
    See Also:
    Constant Field Values
  - BANLIST_DURATION_NO_NETWORK
```
public static final long BANLIST_DURATION_NO_NETWORK
```
    Buggy i2pd fork
    See Also:
    Constant Field Values
  - BANLIST_DURATION_PARTIAL
```
public static final long BANLIST_DURATION_PARTIAL
```
    Default ban duration for transport-specific bans.
    See Also:
    Constant Field Values
  - BANLIST_DURATION_PRIVATE
```
public static final long BANLIST_DURATION_PRIVATE
```
    Ban duration for private IP addresses.
    See Also:
    Constant Field Values
  - HASH_ZERORI
```
public static final Hash HASH_ZERORI
```
    hash of 387 zeros
- Constructor Detail
  - Banlist
```
public Banlist(RouterContext context)
```
    Constructor.
    Parameters:
    context - the router context
- Method Detail
  - badPacket
```
public void badPacket(Hash hash,
                      String version)
```
    Record a bad packet from a peer identified by its Router hash. Looks up the RouterInfo from the local netdb to extract the peer's IP address, caps, and version for threshold tracking and full-context BanLogger output. Silently returns if the RouterInfo is not in the netdb or has no reachable address.
    Prefer this overload when a Router hash is available at the call site; otherwise use badPacket(String, String) for IP-only tracking.
    Parameters:
    hash - Router hash (non-null, must exist in local netdb)
    version - router version info (may be null, falls back to RouterInfo version)
  - badPacket
```
public void badPacket(String ip,
                      String version)
```
    Record a bad packet from an IP. If threshold exceeded, ban the IP.
    Parameters:
    ip - IP address (format: "1.2.3.4" or "1.2.3.4:port")
    version - router version info (may be null)
  - banlistRouter
```
public boolean banlistRouter(Hash peer)
```
    Ban a router with default duration.
    Parameters:
    peer - the router hash to ban
    Returns:
    true if it WAS previously on the list
  - banlistRouter
```
public boolean banlistRouter(Hash peer,
                             String reason)
```
    Ban a router with default duration.
    Parameters:
    peer - the router hash to ban
    reason - the reason
    Returns:
    true if it WAS previously on the list
  - banlistRouter
```
public boolean banlistRouter(Hash peer,
                             String reason,
                             String transport)
```
    Ban a router on a specific transport.
    Parameters:
    peer - the router hash to ban
    reason - the reason
    transport - the transport
    Returns:
    true if it WAS previously on the list
  - banlistRouter
```
public boolean banlistRouter(Hash peer,
                             String reason,
                             String transport,
                             boolean forever)
```
    Ban a router with configurable duration and transport.
    Parameters:
    peer - the router hash to ban
    reason - the reason
    transport - the transport
    forever - if true, ban permanently
    Returns:
    true if it WAS previously on the list
  - banlistRouter
```
public boolean banlistRouter(Hash peer,
                             String reason,
                             String reasonCode,
                             String transport,
                             long expireOn)
```
    Ban a router with a specified expiration time.
    Parameters:
    peer - the router hash to ban
    reason - the reason
    reasonCode - separate code so cause can contain {0} for translation (may be null)
    transport - the transport
    expireOn - absolute time when the ban expires, not a duration
    Returns:
    true if it WAS previously on the list
    Throws:
    IllegalArgumentException - if expireOn is before the earliest valid time
  - banlistRouter
```
public boolean banlistRouter(String reasonCode,
                             Hash peer,
                             String reason)
```
    Ban a router with default duration.
    Parameters:
    reasonCode - separate code so cause can contain {0} for translation
    peer - the router hash to ban
    reason - the reason
    Returns:
    true if it WAS previously on the list
  - banlistRouterForever
```
public boolean banlistRouterForever(Hash peer,
                                    String reason)
```
    Permanently ban a router.
    Parameters:
    peer - the router hash to ban
    reason - the reason
    Returns:
    true if it WAS previously on the list
  - banlistRouterForever
```
public boolean banlistRouterForever(Hash peer,
                                    String reason,
                                    String reasonCode)
```
    Permanently ban a router.
    Parameters:
    peer - the router hash to ban
    reason - the reason
    reasonCode - separate code so cause can contain {0} for translation
    Returns:
    true if it WAS previously on the list
  - clearSessionBans
```
public void clearSessionBans()
```
    Clear all session-based bans.
  - corruptConnection
```
public void corruptConnection(Hash hash,
                              String version)
```
    Record a corrupt connection from a peer identified by its Router hash. Looks up the RouterInfo from the local netdb to extract the peer's IP address, caps, and version for threshold tracking and full-context BanLogger output. Silently returns if the RouterInfo is not in the netdb or has no reachable address.
    Prefer this overload when a Router hash is available at the call site; otherwise use corruptConnection(String, String) for IP-only tracking.
    Parameters:
    hash - Router hash (non-null, must exist in local netdb)
    version - router version info (may be null, falls back to RouterInfo version)
  - corruptConnection
```
public void corruptConnection(String ip,
                              String version)
```
    Record a corrupt connection (EOF/no data during establishment) from an IP. If threshold exceeded, ban the IP.
    Parameters:
    ip - IP address (format: "1.2.3.4" or "1.2.3.4:port")
    version - router version info (may be null)
  - getBadPacketDuration
```
public long getBadPacketDuration()
```
    Get the current bad packet ban duration in ms.
    Returns:
    the bad packet ban duration in milliseconds
  - getCustomCapabilityBans
```
public String getCustomCapabilityBans()
```
    Get custom capability ban pattern. Format: string of capability letters (e.g., "DG", "UX")
    Returns:
    the custom capability ban pattern, or empty string if none
  - getEntries
```
public Map<Hash,Banlist.Entry> getEntries()
```
    Get the banlist entries. For BanlistRenderer in router console. Note - may contain expired entries.
    Returns:
    an unmodifiable map of router hashes to banlist entries
  - getMaxOffenses
```
public int getMaxOffenses()
```
    Get the current max offenses setting.
    Returns:
    the maximum offenses before auto-ban
  - getOffenseWindow
```
public long getOffenseWindow()
```
    Get the current offense window setting in ms.
    Returns:
    the offense window in milliseconds
  - getRouterCount
```
public int getRouterCount()
```
    Get the number of currently banlisted routers.
    Returns:
    the number of currently banlisted routers
  - getStartupGrace
```
public long getStartupGrace()
```
    Get the current startup grace period in ms.
    Returns:
    the startup grace period in milliseconds
  - isBadPacketBanEnabled
```
public boolean isBadPacketBanEnabled()
```
    Check if bad packet auto-ban is enabled.
    Returns:
    true if bad packet auto-ban is enabled
  - isBanlisted
```
public boolean isBanlisted(Hash peer)
```
    Check if a router is banlisted.
    Parameters:
    peer - the router hash to check
    Returns:
    true if the router is banlisted on any transport
  - isBanlisted
```
public boolean isBanlisted(Hash peer,
                           String transport)
```
    Check if a router is banlisted on a specific transport.
    Parameters:
    peer - the router hash to check
    transport - the transport
    Returns:
    true if the router is banlisted on the specified transport
  - isBanlistedForever
```
public boolean isBanlistedForever(Hash peer)
```
    Check if a router is permanently banlisted.
    Parameters:
    peer - the router hash to check
    Returns:
    true if the router is permanently banlisted
  - isBanlistedHostile
```
public boolean isBanlistedHostile(Hash peer)
```
    Check if a router is banlisted with a hostile duration (at least 1 hour).
    Parameters:
    peer - the router hash to check
    Returns:
    true if the router is banlisted with hostile duration
  - isBlocklistEnabled
```
public boolean isBlocklistEnabled()
```
    Check if IP blocklist is enabled.
    Returns:
    true if IP blocklist is enabled
  - isCorruptConnectionBanEnabled
```
public boolean isCorruptConnectionBanEnabled()
```
    Check if corrupt connection auto-ban is enabled.
    Returns:
    true if corrupt connection auto-ban is enabled
  - isCountryBanEnabled
```
public boolean isCountryBanEnabled()
```
    Check if country-based bans are enabled.
    Returns:
    true if country-based bans are enabled
  - isLuBanEnabled
```
public boolean isLuBanEnabled()
```
    Check if LU router bans are enabled. LU = low bandwidth tier (L) + unreachable/firewalled (U)
    Returns:
    true if LU router bans are enabled
  - isPortHoppingBanEnabled
```
public boolean isPortHoppingBanEnabled()
```
    Check if port hopping auto-ban is enabled.
    Returns:
    true if port hopping auto-ban is enabled
  - isTorBlocklistEnabled
```
public boolean isTorBlocklistEnabled()
```
    Check if Tor exit node blocklist is enabled.
    Returns:
    true if Tor exit node blocklist is enabled
  - isXgBanEnabled
```
public boolean isXgBanEnabled()
```
    Check if XG router bans are enabled. XG = unlimited bandwidth (X), no transit tunnels (G) - often botnet indicators
    Returns:
    true if XG router bans are enabled
  - portHopping
```
public void portHopping(Hash hash)
```
    Record a port hopping attempt from a peer identified by its Router hash. Looks up the RouterInfo from the local netdb to extract the peer's IP address, caps, and version for threshold tracking and full-context BanLogger output. Silently returns if the RouterInfo is not in the netdb or has no reachable address.
    Prefer this overload when a Router hash is available at the call site; otherwise use portHopping(String) for IP-only tracking.
    Parameters:
    hash - Router hash (non-null, must exist in local netdb)
  - portHopping
```
public void portHopping(String ip)
```
    Record a port hopping attempt from an IP. If threshold exceeded, ban the IP.
    Parameters:
    ip - IP address (format: "1.2.3.4")
  - reloadConfig
```
public void reloadConfig()
```
    Reload configuration from properties. Called when settings are changed in the console.
  - shouldBanlistByCapability
```
public String shouldBanlistByCapability(String capabilities)
```
    Check if router capabilities match any of the custom ban patterns.
    Parameters:
    capabilities - router capabilities string (e.g., "XfP")
    Returns:
    the matched pattern (e.g., "G") or null if no match
  - shouldPurgeExistingRouters
```
public boolean shouldPurgeExistingRouters()
```
    Check if a retroactive NetDb purge sweep is needed. True if LU/XG bans or custom capability bans are enabled.
    Returns:
    true if existing routers should be purged
  - unbanlistRouter
```
public void unbanlistRouter(Hash peer)
```
    Remove a router from the banlist.
    Parameters:
    peer - the router hash to remove from banlist
  - unbanlistRouter
```
public void unbanlistRouter(Hash peer,
                            String transport)
```
    Remove a router from the banlist for a specific transport.
    Parameters:
    peer - the router hash to remove from banlist
    transport - the transport

Class Banlist

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BANLIST_DURATION_BAD_PACKETS

BANLIST_DURATION_FOREVER

BANLIST_DURATION_MAX

BANLIST_DURATION_MS

BANLIST_DURATION_NO_NETWORK

BANLIST_DURATION_PARTIAL

BANLIST_DURATION_PRIVATE

HASH_ZERORI

Constructor Detail

Banlist

Method Detail

badPacket

badPacket

banlistRouter

banlistRouter

banlistRouter

banlistRouter

banlistRouter

banlistRouter

banlistRouterForever

banlistRouterForever

clearSessionBans

corruptConnection

corruptConnection

getBadPacketDuration

getCustomCapabilityBans

getEntries

getMaxOffenses

getOffenseWindow

getRouterCount

getStartupGrace

isBadPacketBanEnabled

isBanlisted

isBanlisted

isBanlistedForever

isBanlistedHostile

isBlocklistEnabled

isCorruptConnectionBanEnabled

isCountryBanEnabled

isLuBanEnabled

isPortHoppingBanEnabled

isTorBlocklistEnabled

isXgBanEnabled

portHopping

portHopping

reloadConfig

shouldBanlistByCapability

shouldPurgeExistingRouters

unbanlistRouter

unbanlistRouter