Package org.keycloak.policy

Class DenylistPasswordPolicyProviderFactory.FileBasedPasswordDenylist

java.lang.Object

org.keycloak.policy.DenylistPasswordPolicyProviderFactory.FileBasedPasswordDenylist

All Implemented Interfaces:

DenylistPasswordPolicyProviderFactory.PasswordDenylist

Enclosing class:

DenylistPasswordPolicyProviderFactory

public static class DenylistPasswordPolicyProviderFactory.FileBasedPasswordDenylist
extends Object
implements DenylistPasswordPolicyProviderFactory.PasswordDenylist

A DenylistPasswordPolicyProviderFactory.FileBasedPasswordDenylist uses password-denylist files to construct a DenylistPasswordPolicyProviderFactory.PasswordDenylist.

This implementation uses a dynamically sized BloomFilter with a provided default false positive probability.

See Also:

• BloomFilter

Constructor Summary

Constructors

Constructor	Description
FileBasedPasswordDenylist(Path denylistBasePath, String name, double falsePositiveProbability, long checkIntervalMillis)

Method Summary

Modifier and Type	Method	Description
boolean	contains(String password)	Checks whether a given password is contained in this DenylistPasswordPolicyProviderFactory.PasswordDenylist.
double	getFalsePositiveProbability()
String	getName()
protected void	insertPasswordsInto(com.google.common.hash.BloomFilter<String> filter)

Methods inherited from class java.lang.Object

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

Constructor Details

FileBasedPasswordDenylist

public FileBasedPasswordDenylist(Path denylistBasePath,
 String name,
 double falsePositiveProbability,
 long checkIntervalMillis)

Method Details

getName

public String getName()

Specified by:

getName in interface DenylistPasswordPolicyProviderFactory.PasswordDenylist

Returns:

the logical name of the DenylistPasswordPolicyProviderFactory.PasswordDenylist

getFalsePositiveProbability

public double getFalsePositiveProbability()

contains

public boolean contains(String password)

Description copied from interface: DenylistPasswordPolicyProviderFactory.PasswordDenylist

Checks whether a given password is contained in this DenylistPasswordPolicyProviderFactory.PasswordDenylist.

Specified by:

contains in interface DenylistPasswordPolicyProviderFactory.PasswordDenylist

Returns:

insertPasswordsInto

protected void insertPasswordsInto(com.google.common.hash.BloomFilter<String> filter)
                            throws IOException

Throws:

IOException