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

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

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

公開メンバ関数
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 ()
default boolean	isOneTimeAction ()
default int	order ()

非公開メンバ関数
Response	sendVerifyEmail (KeycloakSession session, LoginFormsProvider forms, UserModel user, AuthenticationSessionModel authSession, EventBuilder event) throws UriBuilderException, IllegalArgumentException

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

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

close()

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

inline

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

                        {

    }

create()

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

inline

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

                                                                  {
        return this;
    }

createDisplay()

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

inline

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

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

evaluateTriggers()

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

inline

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

                                                                {
        if (context.getRealm().isVerifyEmail() && !context.getUser().isEmailVerified()) {
            context.getUser().addRequiredAction(UserModel.RequiredAction.VERIFY_EMAIL);
            logger.debug("User is required to verify email");
        }
    }

getDisplayText()

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

inline

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

                                   {
        return "Verify Email";
    }

getId()

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

inline

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

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

init()

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

inline

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

                                          {

    }

isOneTimeAction()

default boolean org.keycloak.authentication.RequiredActionFactory.isOneTimeAction ( )

inlineinherited

Flag indicating whether the execution of the required action by the same circumstances (e.g. by one and the same action token) should only be permitted once.

戻り値

org.keycloak.authentication.requiredactions.UpdatePassword, org.keycloak.authentication.requiredactions.UpdateTotpで実装されています。

                                      {
        return false;
    }

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

inline

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

                                                         {

    }

processAction()

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

inline

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

                                                             {
        logger.debugf("Re-sending email requested for user: %s", context.getUser().getUsername());

        // This will allow user to re-send email again
        context.getAuthenticationSession().removeAuthNote(Constants.VERIFY_EMAIL_KEY);

        requiredActionChallenge(context);
    }

requiredActionChallenge()

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

inline

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

                                                                       {
        AuthenticationSessionModel authSession = context.getAuthenticationSession();

        if (context.getUser().isEmailVerified()) {
            context.success();
            authSession.removeAuthNote(Constants.VERIFY_EMAIL_KEY);
            return;
        }

        String email = context.getUser().getEmail();
        if (Validation.isBlank(email)) {
            context.ignore();
            return;
        }

        LoginFormsProvider loginFormsProvider = context.form();
        Response challenge;

        // Do not allow resending e-mail by simple page refresh, i.e. when e-mail sent, it should be resent properly via email-verification endpoint
        if (! Objects.equals(authSession.getAuthNote(Constants.VERIFY_EMAIL_KEY), email)) {
            authSession.setAuthNote(Constants.VERIFY_EMAIL_KEY, email);
            EventBuilder event = context.getEvent().clone().event(EventType.SEND_VERIFY_EMAIL).detail(Details.EMAIL, email);
            challenge = sendVerifyEmail(context.getSession(), loginFormsProvider, context.getUser(), context.getAuthenticationSession(), event);
        } else {
            challenge = loginFormsProvider.createResponse(UserModel.RequiredAction.VERIFY_EMAIL);
        }

        context.challenge(challenge);
    }

sendVerifyEmail()

Response org.keycloak.authentication.requiredactions.VerifyEmail.sendVerifyEmail ( KeycloakSession  session, LoginFormsProvider  forms, UserModel  user, AuthenticationSessionModel  authSession, EventBuilder  event  ) throws UriBuilderException, IllegalArgumentException

inlineprivate

                                                                                                                                                                                                                         {
        RealmModel realm = session.getContext().getRealm();
        UriInfo uriInfo = session.getContext().getUri();

        int validityInSecs = realm.getActionTokenGeneratedByUserLifespan(VerifyEmailActionToken.TOKEN_TYPE);
        int absoluteExpirationInSecs = Time.currentTime() + validityInSecs;

        String authSessionEncodedId = AuthenticationSessionCompoundId.fromAuthSession(authSession).getEncodedId();
        VerifyEmailActionToken token = new VerifyEmailActionToken(user.getId(), absoluteExpirationInSecs, authSessionEncodedId, user.getEmail(), authSession.getClient().getClientId());
        UriBuilder builder = Urls.actionTokenBuilder(uriInfo.getBaseUri(), token.serialize(session, realm, uriInfo),
                authSession.getClient().getClientId(), authSession.getTabId());
        String link = builder.build(realm.getName()).toString();
        long expirationInMinutes = TimeUnit.SECONDS.toMinutes(validityInSecs);

        try {
            session
              .getProvider(EmailTemplateProvider.class)
              .setAuthenticationSession(authSession)
              .setRealm(realm)
              .setUser(user)
              .sendVerifyEmail(link, expirationInMinutes);
            event.success();
        } catch (EmailException e) {
            logger.error("Failed to send verification email", e);
            event.error(Errors.EMAIL_SEND_FAILED);
        }

        return forms.createResponse(UserModel.RequiredAction.VERIFY_EMAIL);
    }

メンバ詳解

logger

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

staticprivate

---

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

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