org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser クラス

org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser の継承関係図

org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser 連携図

公開メンバ関数
void	authenticate (AuthenticationFlowContext context)
void	action (AuthenticationFlowContext context)
boolean	requiresUser ()
boolean	configuredFor (KeycloakSession session, RealmModel realm, UserModel user)
void	setRequiredActions (KeycloakSession session, RealmModel realm, UserModel user)
String	getDisplayType ()
String	getReferenceCategory ()
boolean	isConfigurable ()
AuthenticationExecutionModel.Requirement []	getRequirementChoices ()
boolean	isUserSetupAllowed ()
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
void	close ()
Authenticator	create (KeycloakSession session)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
String	getId ()

静的公開変数類
static final String	PROVIDER_ID = "reset-credentials-choose-user"
static final AuthenticationExecutionModel.Requirement []	REQUIREMENT_CHOICES

静的非公開変数類
static final Logger	logger = Logger.getLogger(ResetCredentialChooseUser.class)

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

action()

void org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.action ( AuthenticationFlowContext  context )

inline

                                                          {
        EventBuilder event = context.getEvent();
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        String username = formData.getFirst("username");
        if (username == null || username.isEmpty()) {
            event.error(Errors.USERNAME_MISSING);
            Response challenge = context.form()
                    .setError(Messages.MISSING_USERNAME)
                    .createPasswordReset();
            context.failureChallenge(AuthenticationFlowError.INVALID_USER, challenge);
            return;
        }

        username = username.trim();
        
        RealmModel realm = context.getRealm();
        UserModel user = context.getSession().users().getUserByUsername(username, realm);
        if (user == null && realm.isLoginWithEmailAllowed() && username.contains("@")) {
            user =  context.getSession().users().getUserByEmail(username, realm);
        }

        context.getAuthenticationSession().setAuthNote(AbstractUsernameFormAuthenticator.ATTEMPTED_USERNAME, username);

        // we don't want people guessing usernames, so if there is a problem, just continue, but don't set the user
        // a null user will notify further executions, that this was a failure.
        if (user == null) {
            event.clone()
                    .detail(Details.USERNAME, username)
                    .error(Errors.USER_NOT_FOUND);
        } else if (!user.isEnabled()) {
            event.clone()
                    .detail(Details.USERNAME, username)
                    .user(user).error(Errors.USER_DISABLED);
        } else {
            context.setUser(user);
        }

        context.success();
    }

authenticate()

void org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.authenticate ( AuthenticationFlowContext  context )

inline

                                                                {
        String existingUserId = context.getAuthenticationSession().getAuthNote(AbstractIdpAuthenticator.EXISTING_USER_INFO);
        if (existingUserId != null) {
            UserModel existingUser = AbstractIdpAuthenticator.getExistingUser(context.getSession(), context.getRealm(), context.getAuthenticationSession());

            logger.debugf("Forget-password triggered when reauthenticating user after first broker login. Skipping reset-credential-choose-user screen and using user '%s' ", existingUser.getUsername());
            context.setUser(existingUser);
            context.success();
            return;
        }

        String actionTokenUserId = context.getAuthenticationSession().getAuthNote(DefaultActionTokenKey.ACTION_TOKEN_USER_ID);
        if (actionTokenUserId != null) {
            UserModel existingUser = context.getSession().users().getUserById(actionTokenUserId, context.getRealm());

            // Action token logics handles checks for user ID validity and user being enabled

            logger.debugf("Forget-password triggered when reauthenticating user after authentication via action token. Skipping reset-credential-choose-user screen and using user '%s' ", existingUser.getUsername());
            context.setUser(existingUser);
            context.success();
            return;
        }

        Response challenge = context.form().createPasswordReset();
        context.challenge(challenge);
    }

close()

void org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.close ( )

inline

                        {

    }

configuredFor()

boolean org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.configuredFor ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inline

                                                                                            {
        return true;
    }

create()

Authenticator org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.create ( KeycloakSession  session )

inline

                                                         {
        return this;
    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.getConfigProperties ( )

inline

                                                              {
        return null;
    }

getDisplayType()

String org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.getDisplayType ( )

inline

                                   {
        return "Choose User";
    }

getHelpText()

String org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.getHelpText ( )

inline

                                {
        return "Choose a user to reset credentials for";
    }

getId()

String org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.getId ( )

inline

                          {
        return PROVIDER_ID;
    }

getReferenceCategory()

String org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.getReferenceCategory ( )

inline

                                         {
        return null;
    }

getRequirementChoices()

AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.getRequirementChoices ( )

inline

                                                                              {
        return REQUIREMENT_CHOICES;
    }

init()

void org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.init ( Config.Scope  config )

inline

                                          {

    }

isConfigurable()

boolean org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.isConfigurable ( )

inline

                                    {
        return false;
    }

isUserSetupAllowed()

boolean org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.isUserSetupAllowed ( )

inline

                                        {
        return false;
    }

postInit()

void org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.postInit ( KeycloakSessionFactory  factory )

inline

                                                         {

    }

requiresUser()

boolean org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.requiresUser ( )

inline

                                  {
        return false;
    }

setRequiredActions()

void org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.setRequiredActions ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inline

                                                                                              {

    }

メンバ詳解

logger

final Logger org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.logger = Logger.getLogger(ResetCredentialChooseUser.class)

staticprivate

PROVIDER_ID

final String org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.PROVIDER_ID = "reset-credentials-choose-user"

static

REQUIREMENT_CHOICES

final AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser.REQUIREMENT_CHOICES

static

初期値:

= {
            AuthenticationExecutionModel.Requirement.REQUIRED
    }

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/authentication/authenticators/resetcred/ResetCredentialChooseUser.java