org.keycloak.authentication.requiredactions.ConsoleUpdatePassword クラス

org.keycloak.authentication.requiredactions.ConsoleUpdatePassword の継承関係図

org.keycloak.authentication.requiredactions.ConsoleUpdatePassword 連携図

公開メンバ関数
void	requiredActionChallenge (RequiredActionContext context)
void	processAction (RequiredActionContext context)
void	evaluateTriggers (RequiredActionContext context)
void	close ()
RequiredActionProvider	create (KeycloakSession session)
RequiredActionProvider	createDisplay (KeycloakSession session, String displayType)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
String	getDisplayText ()
String	getId ()
boolean	isOneTimeAction ()
default int	order ()

静的公開変数類
static final ConsoleUpdatePassword	SINGLETON = new ConsoleUpdatePassword()
static final String	PASSWORD_NEW = "password-new"
static final String	PASSWORD_CONFIRM = "password-confirm"

限定公開メンバ関数
ConsoleDisplayMode	challenge (RequiredActionContext context)

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

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

challenge()

ConsoleDisplayMode org.keycloak.authentication.requiredactions.ConsoleUpdatePassword.challenge ( RequiredActionContext  context )

inlineprotected

                                                                           {
        return ConsoleDisplayMode.challenge(context)
                .header()
                .param(PASSWORD_NEW)
                .label("console-new-password")
                .mask(true)
                .param(PASSWORD_CONFIRM)
                .label("console-confirm-password")
                .mask(true)
                .challenge();
    }

close()

void org.keycloak.authentication.requiredactions.UpdatePassword.close ( )

inlineinherited

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

                        {

    }

create()

RequiredActionProvider org.keycloak.authentication.requiredactions.UpdatePassword.create ( KeycloakSession  session )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                                  {
        return this;
    }

createDisplay()

RequiredActionProvider org.keycloak.authentication.requiredactions.UpdatePassword.createDisplay ( KeycloakSession  session, String  displayType  )

inlineinherited

org.keycloak.authentication.DisplayTypeRequiredActionFactoryを実装しています。

                                                                                             {
        if (displayType == null) return this;
        if (!OAuth2Constants.DISPLAY_CONSOLE.equalsIgnoreCase(displayType)) return null;
        return ConsoleUpdatePassword.SINGLETON;
    }

evaluateTriggers()

void org.keycloak.authentication.requiredactions.UpdatePassword.evaluateTriggers ( RequiredActionContext  context )

inlineinherited

org.keycloak.authentication.RequiredActionProviderを実装しています。

                                                                {
        int daysToExpirePassword = context.getRealm().getPasswordPolicy().getDaysToExpirePassword();
        if(daysToExpirePassword != -1) {
            PasswordCredentialProvider passwordProvider = (PasswordCredentialProvider)context.getSession().getProvider(CredentialProvider.class, PasswordCredentialProviderFactory.PROVIDER_ID);
            CredentialModel password = passwordProvider.getPassword(context.getRealm(), context.getUser());
            if (password != null) {
                if(password.getCreatedDate() == null) {
                    context.getUser().addRequiredAction(UserModel.RequiredAction.UPDATE_PASSWORD);
                    logger.debug("User is required to update password");
                } else {
                    long timeElapsed = Time.toMillis(Time.currentTime()) - password.getCreatedDate();
                    long timeToExpire = TimeUnit.DAYS.toMillis(daysToExpirePassword);

                    if(timeElapsed > timeToExpire) {
                        context.getUser().addRequiredAction(UserModel.RequiredAction.UPDATE_PASSWORD);
                        logger.debug("User is required to update password");
                    }
                }
            }
        }
    }

getDisplayText()

String org.keycloak.authentication.requiredactions.UpdatePassword.getDisplayText ( )

inlineinherited

org.keycloak.authentication.RequiredActionFactoryを実装しています。

                                   {
        return "Update Password";
    }

getId()

String org.keycloak.authentication.requiredactions.UpdatePassword.getId ( )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                          {
        return UserModel.RequiredAction.UPDATE_PASSWORD.name();
    }

init()

void org.keycloak.authentication.requiredactions.UpdatePassword.init ( Config.Scope  config )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                          {

    }

isOneTimeAction()

boolean org.keycloak.authentication.requiredactions.UpdatePassword.isOneTimeAction ( )

inlineinherited

org.keycloak.authentication.RequiredActionFactoryを実装しています。

                                     {
        return true;
    }

order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                        {
        return 0;
    }

postInit()

void org.keycloak.authentication.requiredactions.UpdatePassword.postInit ( KeycloakSessionFactory  factory )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                         {

    }

processAction()

void org.keycloak.authentication.requiredactions.ConsoleUpdatePassword.processAction ( RequiredActionContext  context )

inline

org.keycloak.authentication.RequiredActionProviderを実装しています。

                                                             {
        EventBuilder event = context.getEvent();
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        event.event(EventType.UPDATE_PASSWORD);
        String passwordNew = formData.getFirst(PASSWORD_NEW);
        String passwordConfirm = formData.getFirst(PASSWORD_CONFIRM);

        EventBuilder errorEvent = event.clone().event(EventType.UPDATE_PASSWORD_ERROR)
                .client(context.getAuthenticationSession().getClient())
                .user(context.getAuthenticationSession().getAuthenticatedUser());

        if (Validation.isBlank(passwordNew)) {
            context.challenge(challenge(context).message(Messages.MISSING_PASSWORD));
            errorEvent.error(Errors.PASSWORD_MISSING);
            return;
        } else if (!passwordNew.equals(passwordConfirm)) {
            context.challenge(challenge(context).message(Messages.NOTMATCH_PASSWORD));
            errorEvent.error(Errors.PASSWORD_CONFIRM_ERROR);
            return;
        }

        try {
            context.getSession().userCredentialManager().updateCredential(context.getRealm(), context.getUser(), UserCredentialModel.password(passwordNew, false));
            context.success();
        } catch (ModelException me) {
            errorEvent.detail(Details.REASON, me.getMessage()).error(Errors.PASSWORD_REJECTED);
            context.challenge(challenge(context).text(me.getMessage()));
            return;
        } catch (Exception ape) {
            errorEvent.detail(Details.REASON, ape.getMessage()).error(Errors.PASSWORD_REJECTED);
            context.challenge(challenge(context).text(ape.getMessage()));
            return;
        }
    }

requiredActionChallenge()

void org.keycloak.authentication.requiredactions.ConsoleUpdatePassword.requiredActionChallenge ( RequiredActionContext  context )

inline

org.keycloak.authentication.RequiredActionProviderを実装しています。

                                                                       {
        context.challenge(
                challenge(context).message("console-update-password"));
    }

メンバ詳解

logger

final Logger org.keycloak.authentication.requiredactions.ConsoleUpdatePassword.logger = Logger.getLogger(ConsoleUpdatePassword.class)

staticprivate

PASSWORD_CONFIRM

final String org.keycloak.authentication.requiredactions.ConsoleUpdatePassword.PASSWORD_CONFIRM = "password-confirm"

static

PASSWORD_NEW

final String org.keycloak.authentication.requiredactions.ConsoleUpdatePassword.PASSWORD_NEW = "password-new"

static

SINGLETON

final ConsoleUpdatePassword org.keycloak.authentication.requiredactions.ConsoleUpdatePassword.SINGLETON = new ConsoleUpdatePassword()

static

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/requiredactions/ConsoleUpdatePassword.java