com.atlassian.jira.web.component.admin.websudo

Class WebSudoIPAllowListManager

java.lang.Object

com.atlassian.jira.web.component.admin.websudo.WebSudoIPAllowListManager

public class WebSudoIPAllowListManager
extends Object

This class is used to check if the user's IP address is in the allowlist when user is trying to login for websudo. It uses Atlassian IP for matching the IP address.

Supports matching against IPv4 and IPv6 addresses, and subnets in both wildcard (IPv4 only) and CIDR notation. Examples of valid patterns:

 192.168.1.1
 192.168.1.0/24
 192.168.1.*
 0:0:0:1::1
 0:0:0:1::/64
 

Since:

9.15

Field Summary

Fields

Modifier and Type	Field and Description
static String	REMOTE_IP_HEADER_PROPERTY
static String	WEBSUDO_ALLOWLIST_CIDR_PROPERTY
static String	WEBSUDO_ALLOWLIST_IP_PROPERTY
static String	X_FORWARDED_FOR_HEADER

Constructor Summary

Constructors

Constructor and Description
WebSudoIPAllowListManager(ApplicationProperties applicationProperties)

Method Summary

Modifier and Type	Method and Description
IPAllowListValidationResult	isAllowed(javax.servlet.http.HttpServletRequest request) Check if the user's IP address is in the allowlist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WEBSUDO_ALLOWLIST_IP_PROPERTY

public static final String WEBSUDO_ALLOWLIST_IP_PROPERTY

See Also:

Constant Field Values

WEBSUDO_ALLOWLIST_CIDR_PROPERTY

public static final String WEBSUDO_ALLOWLIST_CIDR_PROPERTY

See Also:

Constant Field Values

REMOTE_IP_HEADER_PROPERTY

public static final String REMOTE_IP_HEADER_PROPERTY

See Also:

Constant Field Values

X_FORWARDED_FOR_HEADER

public static final String X_FORWARDED_FOR_HEADER

See Also:

Constant Field Values

Constructor Detail

WebSudoIPAllowListManager

public WebSudoIPAllowListManager(ApplicationProperties applicationProperties)

Method Detail

isAllowed

public IPAllowListValidationResult isAllowed(javax.servlet.http.HttpServletRequest request)

Check if the user's IP address is in the allowlist.

Parameters:

request - the request

Returns:

instance of IPAllowListValidationResult as validation result which returns true in IPAllowListValidationResult.isAllowed() if the user's IP address is in the allowlist, otherwise false along with the IP address for validation and the header from which the IP address is read