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

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

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

公開メンバ関数
void	evaluateTriggers (RequiredActionContext context)
void	requiredActionChallenge (RequiredActionContext context)
void	processAction (RequiredActionContext context)
void	close ()

静的公開変数類
static final ConsoleVerifyEmail	SINGLETON = new ConsoleVerifyEmail()
static String	EMAIL_CODE ="email_code"

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

非公開メンバ関数
Response	sendVerifyEmail (RequiredActionContext context) throws UriBuilderException, IllegalArgumentException

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

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

challenge()

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

inlineprotected

                                                                          {
        return ConsoleDisplayMode.challenge(context)
                .header()
                .param(EMAIL_CODE)
                .label("console-email-code")
                .challenge();
    }

close()

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

inline

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

                        {

    }

evaluateTriggers()

void org.keycloak.authentication.requiredactions.ConsoleVerifyEmail.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");
        }
    }

processAction()

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

inline

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

                                                             {
        EventBuilder event = context.getEvent().clone().event(EventType.VERIFY_EMAIL).detail(Details.EMAIL, context.getUser().getEmail());
        String code = context.getAuthenticationSession().getAuthNote(Constants.VERIFY_EMAIL_CODE);
        if (code == null) {
            requiredActionChallenge(context);
            return;
        }

        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        String emailCode = formData.getFirst(EMAIL_CODE);

        if (!code.equals(emailCode)) {
            context.challenge(
                    challenge(context).message(Messages.INVALID_CODE)
            );
            event.error(Errors.INVALID_CODE);
            return;
        }
        event.success();
        context.success();
    }

requiredActionChallenge()

void org.keycloak.authentication.requiredactions.ConsoleVerifyEmail.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;
        }

        Response challenge = sendVerifyEmail(context);
        context.challenge(challenge);
    }

sendVerifyEmail()

Response org.keycloak.authentication.requiredactions.ConsoleVerifyEmail.sendVerifyEmail ( RequiredActionContext  context ) throws UriBuilderException, IllegalArgumentException

inlineprivate

                                                                                                                          {
        KeycloakSession session = context.getSession();
        UserModel user = context.getUser();
        AuthenticationSessionModel authSession = context.getAuthenticationSession();
        EventBuilder event = context.getEvent().clone().event(EventType.SEND_VERIFY_EMAIL).detail(Details.EMAIL, user.getEmail());
        String code = RandomString.randomCode(8);
        authSession.setAuthNote(Constants.VERIFY_EMAIL_CODE, code);
        RealmModel realm = session.getContext().getRealm();

        Map<String, Object> attributes = new HashMap<>();
        attributes.put("code", code);

        try {
            session
              .getProvider(EmailTemplateProvider.class)
              .setAuthenticationSession(authSession)
              .setRealm(realm)
              .setUser(user)
              .send("emailVerificationSubject", "email-verification-with-code.ftl", attributes);
            event.success();
        } catch (EmailException e) {
            logger.error("Failed to send verification email", e);
            event.error(Errors.EMAIL_SEND_FAILED);
        }

        return challenge(context).text(context.form().getMessage("console-verify-email", user.getEmail()));
    }

メンバ詳解

EMAIL_CODE

String org.keycloak.authentication.requiredactions.ConsoleVerifyEmail.EMAIL_CODE ="email_code"

static

logger

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

staticprivate

SINGLETON

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

static

---

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

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