com.haulmont.cuba.security.app

Interface BruteForceProtectionAPI

All Known Implementing Classes:

BruteForceProtectionBean

public interface BruteForceProtectionAPI

Class is responsible for the brute-force protection on user login

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
int	getBruteForceBlockIntervalSec() Returns a time interval for which a user is blocked after the number of allowed login attempts is exceeded
java.util.Set<java.lang.String>	getLockedUsersInfo() Returns an information about the locked users
boolean	isBruteForceProtectionEnabled()
int	loginAttemptsLeft(java.lang.String login, java.lang.String ipAddress) Returns a number of login attempts left for the specified pair of login and IP-address
int	registerUnsuccessfulLogin(java.lang.String login, java.lang.String ipAddress) Registers unsuccessful login attempt
void	unlockUser(java.lang.String login, java.lang.String ipAddress) Unlocks the blocked user

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

loginAttemptsLeft

int loginAttemptsLeft(java.lang.String login,
                      java.lang.String ipAddress)

Returns a number of login attempts left for the specified pair of login and IP-address

Parameters:

login - user login

ipAddress - user IP-address

Returns:

number of login attempts left

registerUnsuccessfulLogin

int registerUnsuccessfulLogin(java.lang.String login,
                              java.lang.String ipAddress)

Registers unsuccessful login attempt

Returns:

a number of login attempts left for the specified pair of login and IP-address

isBruteForceProtectionEnabled

boolean isBruteForceProtectionEnabled()

Returns:

true if brute-force protection is enabled in application settings

getBruteForceBlockIntervalSec

int getBruteForceBlockIntervalSec()

Returns a time interval for which a user is blocked after the number of allowed login attempts is exceeded

getLockedUsersInfo

java.util.Set<java.lang.String> getLockedUsersInfo()

Returns an information about the locked users

Returns:

a set of strings. Each string consists of two parts (login and IP-adress) separated by the '|' symbol

unlockUser

void unlockUser(java.lang.String login,
                java.lang.String ipAddress)

Unlocks the blocked user

Parameters:

login - user login

ipAddress - user IP-address