Package org.keycloak.policy

Class BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist

java.lang.Object

org.keycloak.policy.BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist

All Implemented Interfaces:

BlacklistPasswordPolicyProviderFactory.PasswordBlacklist

Enclosing class:

BlacklistPasswordPolicyProviderFactory

public static class BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist
extends Object
implements BlacklistPasswordPolicyProviderFactory.PasswordBlacklist

A BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist uses password-blacklist files as to construct a BlacklistPasswordPolicyProviderFactory.PasswordBlacklist.

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

See Also:

• BloomFilter

Constructor Summary

Constructors

Constructor	Description
FileBasedPasswordBlacklist(Path blacklistBasePath, String name)	Creates a new BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist with BlacklistPasswordPolicyProviderFactory.DEFAULT_FALSE_POSITIVE_PROBABILITY.
FileBasedPasswordBlacklist(Path blacklistBasePath, String name, double falsePositiveProbability)

Method Summary

Modifier and Type	Method	Description
boolean	contains(String password)	Checks whether a given password is contained in this BlacklistPasswordPolicyProviderFactory.PasswordBlacklist.
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

FileBasedPasswordBlacklist

public FileBasedPasswordBlacklist(Path blacklistBasePath,
 String name)

Creates a new BlacklistPasswordPolicyProviderFactory.FileBasedPasswordBlacklist with BlacklistPasswordPolicyProviderFactory.DEFAULT_FALSE_POSITIVE_PROBABILITY.

Parameters:

blacklistBasePath - folder containing the blacklists

name - name of blacklist file

FileBasedPasswordBlacklist

public FileBasedPasswordBlacklist(Path blacklistBasePath,
 String name,
 double falsePositiveProbability)

Method Details

getName

public String getName()

Specified by:

getName in interface BlacklistPasswordPolicyProviderFactory.PasswordBlacklist

Returns:

the logical name of the BlacklistPasswordPolicyProviderFactory.PasswordBlacklist

getFalsePositiveProbability

public double getFalsePositiveProbability()

contains

public boolean contains(String password)

Description copied from interface: BlacklistPasswordPolicyProviderFactory.PasswordBlacklist

Checks whether a given password is contained in this BlacklistPasswordPolicyProviderFactory.PasswordBlacklist.

Specified by:

contains in interface BlacklistPasswordPolicyProviderFactory.PasswordBlacklist

Returns:

insertPasswordsInto

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

Throws:

IOException