org.keycloak.policy.BlacklistPasswordPolicyProvider クラス

org.keycloak.policy.BlacklistPasswordPolicyProvider の継承関係図

org.keycloak.policy.BlacklistPasswordPolicyProvider 連携図

公開メンバ関数
	BlacklistPasswordPolicyProvider (KeycloakContext context, BlacklistPasswordPolicyProviderFactory factory)
PolicyError	validate (String username, String password)
PolicyError	validate (RealmModel realm, UserModel user, String password)
Object	parseConfig (String blacklistName)
void	close ()
default Integer	parseInteger (String value, Integer defaultValue)

公開変数類
String	STRING_CONFIG_TYPE = "String"
String	INT_CONFIG_TYPE = "int"

静的公開変数類
static final String	ERROR_MESSAGE = "invalidPasswordBlacklistedMessage"

非公開変数類
final KeycloakContext	context
final BlacklistPasswordPolicyProviderFactory	factory

詳解

Checks a password against a configured password blacklist.

著者

Thomas Darimont

構築子と解体子

BlacklistPasswordPolicyProvider()

org.keycloak.policy.BlacklistPasswordPolicyProvider.BlacklistPasswordPolicyProvider ( KeycloakContext  context, BlacklistPasswordPolicyProviderFactory  factory  )

inline

                                                                                                                  {
    this.context = context;
    this.factory = factory;
  }

関数詳解

close()

void org.keycloak.policy.BlacklistPasswordPolicyProvider.close ( )

inline

org.keycloak.provider.Providerを実装しています。

                      {
    //noop
  }

parseConfig()

Object org.keycloak.policy.BlacklistPasswordPolicyProvider.parseConfig ( String  blacklistName )

inline

org.keycloak.policy.PasswordPolicyProviderを実装しています。

                                                  {

    if (blacklistName == null) {
      return null;
    }

    return factory.resolvePasswordBlacklist(blacklistName);
  }

parseInteger()

default Integer org.keycloak.policy.PasswordPolicyProvider.parseInteger ( String  value, Integer  defaultValue  )

inlineinherited

                                                                     {
        try {
            return value != null ? Integer.parseInt(value) : defaultValue;
        } catch (NumberFormatException e) {
            throw new PasswordPolicyConfigException("Not a valid number");
        }
    }

validate() [1/2]

PolicyError org.keycloak.policy.BlacklistPasswordPolicyProvider.validate ( String  username, String  password  )

inline

Checks whether the provided password is contained in the configured blacklist.

引数

username
password

戻り値

{ null} if the password is not blacklisted otherwise a PolicyError

org.keycloak.policy.PasswordPolicyProviderを実装しています。

                                                                {

    Object policyConfig = context.getRealm().getPasswordPolicy().getPolicyConfig(BlacklistPasswordPolicyProviderFactory.ID);
    if (policyConfig == null) {
      return null;
    }

    if (!(policyConfig instanceof PasswordBlacklist)) {
      return null;
    }

    PasswordBlacklist blacklist = (FileBasedPasswordBlacklist) policyConfig;

    if (!blacklist.contains(password)) {
      return null;
    }

    return new PolicyError(ERROR_MESSAGE);
  }

validate() [2/2]

PolicyError org.keycloak.policy.BlacklistPasswordPolicyProvider.validate ( RealmModel  realm, UserModel  user, String  password  )

inline

org.keycloak.policy.PasswordPolicyProviderを実装しています。

                                                                                 {
    return validate(user.getUsername(), password);
  }

メンバ詳解

context

final KeycloakContext org.keycloak.policy.BlacklistPasswordPolicyProvider.context

private

ERROR_MESSAGE

final String org.keycloak.policy.BlacklistPasswordPolicyProvider.ERROR_MESSAGE = "invalidPasswordBlacklistedMessage"

static

factory

final BlacklistPasswordPolicyProviderFactory org.keycloak.policy.BlacklistPasswordPolicyProvider.factory

private

INT_CONFIG_TYPE

String org.keycloak.policy.PasswordPolicyProvider.INT_CONFIG_TYPE = "int"

inherited

STRING_CONFIG_TYPE

String org.keycloak.policy.PasswordPolicyProvider.STRING_CONFIG_TYPE = "String"

inherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/policy/BlacklistPasswordPolicyProvider.java