org.keycloak.authentication.AbstractFormAuthenticator クラス

org.keycloak.authentication.AbstractFormAuthenticator の継承関係図

org.keycloak.authentication.AbstractFormAuthenticator 連携図

公開メンバ関数
void	close ()
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)

詳解

Abstract helper class that Authenticator implementations can leverage

著者

Bill Burke

バージョン

Revision

1

関数詳解

action()

void org.keycloak.authentication.Authenticator.action ( AuthenticationFlowContext  context )

inherited

Called from a form action invocation.

引数

context

org.keycloak.authentication.authenticators.x509.X509ClientCertificateAuthenticator, org.keycloak.authentication.authenticators.x509.ValidateX509CertificateUsername, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticator, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticator, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator, org.keycloak.authentication.authenticators.browser.CookieAuthenticator, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticator, org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticator, org.keycloak.authentication.authenticators.console.ConsoleOTPFormAuthenticator, org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateDirectGrantAuthenticator, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.authentication.authenticators.browser.UsernamePasswordForm, org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator, org.keycloak.authentication.authenticators.AttemptedAuthenticator (計22項目)で実装されています。

authenticate()

void org.keycloak.authentication.Authenticator.authenticate ( AuthenticationFlowContext  context )

inherited

Initial call for the authenticator. This method should check the current HTTP request to determine if the request satifies the Authenticator's requirements. If it doesn't, it should send back a challenge response by calling the AuthenticationFlowContext.challenge(Response). If this challenge is a authentication, the action URL of the form must point to

/realms/{realm}/login-actions/authenticate?code={session-code}&execution={executionId}

or

/realms/{realm}/login-actions/registration?code={session-code}&execution={executionId}

{session-code} pertains to the code generated from AuthenticationFlowContext.generateAccessCode(). The {executionId} pertains to the AuthenticationExecutionModel.getId() value obtained from AuthenticationFlowContext.getExecution().

The action URL will invoke the action() method described below.

引数

context

org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticator, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticator, org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticator, org.keycloak.authentication.authenticators.browser.UsernamePasswordForm, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.authenticators.console.ConsoleOTPFormAuthenticator, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.x509.X509ClientCertificateAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.authentication.authenticators.directgrant.ValidateUsername, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticator, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticator, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidateOTP, org.keycloak.authentication.authenticators.directgrant.ValidatePassword, org.keycloak.authentication.authenticators.x509.ValidateX509CertificateUsername, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticator, org.keycloak.authentication.authenticators.browser.CookieAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetPassword, org.keycloak.authentication.authenticators.resetcred.ResetOTP, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator, org.keycloak.authentication.authenticators.AttemptedAuthenticator (計24項目)で実装されています。

close()

void org.keycloak.authentication.AbstractFormAuthenticator.close ( )

inline

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

                        {

    }

configuredFor()

boolean org.keycloak.authentication.Authenticator.configuredFor ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inherited

Is this authenticator configured for this user.

引数

session
realm
user

戻り値

org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateAuthenticator, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticator, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticator, org.keycloak.authentication.authenticators.broker.IdpCreateUserIfUniqueAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.authenticators.broker.IdpReviewProfileAuthenticator, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticator, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator, org.keycloak.authentication.authenticators.broker.IdpEmailVerificationAuthenticator, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidateUsername, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticator, org.keycloak.authentication.authenticators.browser.UsernamePasswordForm, org.keycloak.authentication.authenticators.broker.IdpConfirmLinkAuthenticator, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidateOTP, org.keycloak.protocol.docker.DockerAuthenticator, org.keycloak.authentication.authenticators.browser.CookieAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidatePassword, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticator, org.keycloak.authentication.authenticators.broker.IdpAutoLinkAuthenticator, org.keycloak.authentication.authenticators.challenge.BasicAuthOTPAuthenticator, org.keycloak.authentication.authenticators.AttemptedAuthenticator (計26項目)で実装されています。

requiresUser()

boolean org.keycloak.authentication.Authenticator.requiresUser ( )

inherited

Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?

戻り値

org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateAuthenticator, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticator, org.keycloak.authentication.authenticators.broker.IdpCreateUserIfUniqueAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator, org.keycloak.authentication.authenticators.broker.IdpEmailVerificationAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidateUsername, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticator, org.keycloak.authentication.authenticators.broker.IdpConfirmLinkAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidateOTP, org.keycloak.authentication.authenticators.browser.UsernamePasswordForm, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidatePassword, org.keycloak.authentication.authenticators.broker.IdpAutoLinkAuthenticator, org.keycloak.authentication.authenticators.broker.IdpReviewProfileAuthenticator, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticator, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticator, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticator, org.keycloak.authentication.authenticators.browser.CookieAuthenticator, org.keycloak.authentication.authenticators.AttemptedAuthenticator (計24項目)で実装されています。

setRequiredActions()

void org.keycloak.authentication.Authenticator.setRequiredActions ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inherited

Set actions to configure authenticator

org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticator, org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateAuthenticator, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticator, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticator, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidateUsername, org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticator, org.keycloak.authentication.authenticators.browser.UsernamePasswordForm, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidateOTP, org.keycloak.authentication.authenticators.browser.CookieAuthenticator, org.keycloak.authentication.authenticators.directgrant.ValidatePassword, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticator, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.authentication.authenticators.AttemptedAuthenticator (計21項目)で実装されています。

---

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

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