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

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

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

公開メンバ関数
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 Long	getLastChangedTimestamp (KeycloakSession session, RealmModel realm, UserModel user)

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

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

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

action()

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

inline

                                                          {
        context.getUser().setEmailVerified(true);
        context.success();
    }

authenticate()

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

inline

                                                                {
        UserModel user = context.getUser();
        AuthenticationSessionModel authenticationSession = context.getAuthenticationSession();
        String username = authenticationSession.getAuthNote(AbstractUsernameFormAuthenticator.ATTEMPTED_USERNAME);

        // we don't want people guessing usernames, so if there was a problem obtaining the user, the user will be null.
        // just reset login for with a success message
        if (user == null) {
            context.forkWithSuccessMessage(new FormMessage(Messages.EMAIL_SENT));
            return;
        }

        String actionTokenUserId = authenticationSession.getAuthNote(DefaultActionTokenKey.ACTION_TOKEN_USER_ID);
        if (actionTokenUserId != null && Objects.equals(user.getId(), actionTokenUserId)) {
            logger.debugf("Forget-password triggered when reauthenticating user after authentication via action token. Skipping " + PROVIDER_ID + " screen and using user '%s' ", user.getUsername());
            context.success();
            return;
        }


        EventBuilder event = context.getEvent();
        // we don't want people guessing usernames, so if there is a problem, just continuously challenge
        if (user.getEmail() == null || user.getEmail().trim().length() == 0) {
            event.user(user)
                    .detail(Details.USERNAME, username)
                    .error(Errors.INVALID_EMAIL);

            context.forkWithSuccessMessage(new FormMessage(Messages.EMAIL_SENT));
            return;
        }

        int validityInSecs = context.getRealm().getActionTokenGeneratedByUserLifespan(ResetCredentialsActionToken.TOKEN_TYPE);
        int absoluteExpirationInSecs = Time.currentTime() + validityInSecs;

        // We send the secret in the email in a link as a query param.
        String authSessionEncodedId = AuthenticationSessionCompoundId.fromAuthSession(authenticationSession).getEncodedId();
        ResetCredentialsActionToken token = new ResetCredentialsActionToken(user.getId(), absoluteExpirationInSecs, authSessionEncodedId, authenticationSession.getClient().getClientId());
        String link = UriBuilder
          .fromUri(context.getActionTokenUrl(token.serialize(context.getSession(), context.getRealm(), context.getUriInfo())))
          .build()
          .toString();
        long expirationInMinutes = TimeUnit.SECONDS.toMinutes(validityInSecs);
        try {
            context.getSession().getProvider(EmailTemplateProvider.class).setRealm(context.getRealm()).setUser(user).setAuthenticationSession(authenticationSession).sendPasswordReset(link, expirationInMinutes);

            event.clone().event(EventType.SEND_RESET_PASSWORD)
                         .user(user)
                         .detail(Details.USERNAME, username)
                         .detail(Details.EMAIL, user.getEmail()).detail(Details.CODE_ID, authenticationSession.getParentSession().getId()).success();
            context.forkWithSuccessMessage(new FormMessage(Messages.EMAIL_SENT));
        } catch (EmailException e) {
            event.clone().event(EventType.SEND_RESET_PASSWORD)
                    .detail(Details.USERNAME, username)
                    .user(user)
                    .error(Errors.EMAIL_SEND_FAILED);
            ServicesLogger.LOGGER.failedToSendPwdResetEmail(e);
            Response challenge = context.form()
                    .setError(Messages.EMAIL_SENT_ERROR)
                    .createErrorPage(Response.Status.INTERNAL_SERVER_ERROR);
            context.failure(AuthenticationFlowError.INTERNAL_ERROR, challenge);
        }
    }

close()

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

inline

                        {

    }

configuredFor()

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

inline

                                                                                            {
        return true;
    }

create()

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

inline

                                                         {
        return this;
    }

getConfigProperties()

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

inline

                                                              {
        return null;
    }

getDisplayType()

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

inline

                                   {
        return "Send Reset Email";
    }

getHelpText()

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

inline

                                {
        return "Send email to user and wait for response.";
    }

getId()

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

inline

                          {
        return PROVIDER_ID;
    }

getLastChangedTimestamp()

static Long org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail.getLastChangedTimestamp ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inlinestatic

                                                                                                          {
        // TODO(hmlnarik): Make this more generic to support non-password credential types
        PasswordCredentialProvider passwordProvider = (PasswordCredentialProvider) session.getProvider(CredentialProvider.class, PasswordCredentialProviderFactory.PROVIDER_ID);
        CredentialModel password = passwordProvider.getPassword(realm, user);

        return password == null ? null : password.getCreatedDate();
    }

getReferenceCategory()

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

inline

                                         {
        return null;
    }

getRequirementChoices()

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

inline

                                                                              {
        return REQUIREMENT_CHOICES;
    }

init()

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

inline

                                          {

    }

isConfigurable()

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

inline

                                    {
        return false;
    }

isUserSetupAllowed()

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

inline

                                        {
        return false;
    }

postInit()

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

inline

                                                         {

    }

requiresUser()

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

inline

                                  {
        return false;
    }

setRequiredActions()

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

inline

                                                                                              {

    }

メンバ詳解

logger

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

staticprivate

PROVIDER_ID

final String org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail.PROVIDER_ID = "reset-credential-email"

static

REQUIREMENT_CHOICES

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

static

初期値:

= {
            AuthenticationExecutionModel.Requirement.REQUIRED
    }

---

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

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