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

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

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

公開メンバ関数
void	evaluateTriggers (RequiredActionContext context)
void	requiredActionChallenge (RequiredActionContext context)
void	processAction (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 ()

非公開メンバ関数
String	getMode (RequiredActionContext context)

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

close()

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

inline

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

                        {

    }

create()

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

inline

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

                                                                  {
        return this;
    }

createDisplay()

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

inline

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

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

evaluateTriggers()

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

inline

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

                                                                {
    }

getDisplayText()

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

inline

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

                                   {
        return "Configure OTP";
    }

getId()

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

inline

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

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

getMode()

String org.keycloak.authentication.requiredactions.UpdateTotp.getMode ( RequiredActionContext  context )

inlineprivate

                                                          {
        return context.getUriInfo().getQueryParameters().getFirst("mode");
    }

init()

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

inline

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

                                          {

    }

isOneTimeAction()

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

inline

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.UpdateTotp.postInit ( KeycloakSessionFactory  factory )

inline

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

                                                         {

    }

processAction()

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

inline

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

                                                             {
        EventBuilder event = context.getEvent();
        event.event(EventType.UPDATE_TOTP);
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        String totp = formData.getFirst("totp");
        String totpSecret = formData.getFirst("totpSecret");

        if (Validation.isBlank(totp)) {
            Response challenge = context.form()
                    .setAttribute("mode", getMode(context))
                    .setError(Messages.MISSING_TOTP)
                    .createResponse(UserModel.RequiredAction.CONFIGURE_TOTP);
            context.challenge(challenge);
            return;
        } else if (!CredentialValidation.validOTP(context.getRealm(), totp, totpSecret)) {
            Response challenge = context.form()
                    .setAttribute("mode", getMode(context))
                    .setError(Messages.INVALID_TOTP)
                    .createResponse(UserModel.RequiredAction.CONFIGURE_TOTP);
            context.challenge(challenge);
            return;
        }

        UserCredentialModel credentials = new UserCredentialModel();
        credentials.setType(context.getRealm().getOTPPolicy().getType());
        credentials.setValue(totpSecret);
        context.getSession().userCredentialManager().updateCredential(context.getRealm(), context.getUser(), credentials);


        // if type is HOTP, to update counter we execute validation based on supplied token
        UserCredentialModel cred = new UserCredentialModel();
        cred.setType(context.getRealm().getOTPPolicy().getType());
        cred.setValue(totp);
        context.getSession().userCredentialManager().isValid(context.getRealm(), context.getUser(), cred);

        context.success();
    }

requiredActionChallenge()

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

inline

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

                                                                       {
        Response challenge = context.form()
                .setAttribute("mode", getMode(context))
                .createResponse(UserModel.RequiredAction.CONFIGURE_TOTP);
        context.challenge(challenge);
    }

---

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

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