org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory クラス

org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory の継承関係図

org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory 連携図

公開メンバ関数
Authenticator	create (KeycloakSession session)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
void	close ()
String	getId ()
String	getReferenceCategory ()
boolean	isConfigurable ()
boolean	isUserSetupAllowed ()
AuthenticationExecutionModel.Requirement []	getRequirementChoices ()
String	getDisplayType ()
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()

静的公開変数類
static final String	PROVIDER_ID = "auth-conditional-otp-form"
static final ConditionalOtpFormAuthenticator	SINGLETON = new ConditionalOtpFormAuthenticator()
static final AuthenticationExecutionModel.Requirement []	REQUIREMENT_CHOICES

詳解

An AuthenticatorFactory for ConditionalOtpFormAuthenticators.

著者

Thomas Darimont

関数詳解

close()

void org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.close ( )

inline

                        {
        //NOOP
    }

create()

Authenticator org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.create ( KeycloakSession  session )

inline

                                                         {
        return SINGLETON;
    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.getConfigProperties ( )

inline

                                                              {

        ProviderConfigProperty forceOtpUserAttribute = new ProviderConfigProperty();
        forceOtpUserAttribute.setType(STRING_TYPE);
        forceOtpUserAttribute.setName(OTP_CONTROL_USER_ATTRIBUTE);
        forceOtpUserAttribute.setLabel("OTP control User Attribute");
        forceOtpUserAttribute.setHelpText("The name of the user attribute to explicitly control OTP auth. " +
                "If attribute value is 'force' then OTP is always required. " +
                "If value is 'skip' the OTP auth is skipped. Otherwise this check is ignored.");

        ProviderConfigProperty skipOtpRole = new ProviderConfigProperty();
        skipOtpRole.setType(ROLE_TYPE);
        skipOtpRole.setName(SKIP_OTP_ROLE);
        skipOtpRole.setLabel("Skip OTP for Role");
        skipOtpRole.setHelpText("OTP is always skipped if user has the given Role.");

        ProviderConfigProperty forceOtpRole = new ProviderConfigProperty();
        forceOtpRole.setType(ROLE_TYPE);
        forceOtpRole.setName(FORCE_OTP_ROLE);
        forceOtpRole.setLabel("Force OTP for Role");
        forceOtpRole.setHelpText("OTP is always required if user has the given Role.");

        ProviderConfigProperty skipOtpForHttpHeader = new ProviderConfigProperty();
        skipOtpForHttpHeader.setType(STRING_TYPE);
        skipOtpForHttpHeader.setName(SKIP_OTP_FOR_HTTP_HEADER);
        skipOtpForHttpHeader.setLabel("Skip OTP for Header");
        skipOtpForHttpHeader.setHelpText("OTP is skipped if a HTTP request header does matches the given pattern." +
                "Can be used to specify trusted networks via: X-Forwarded-Host: (1.2.3.4|1.2.3.5)." +
                "In this case requests from 1.2.3.4 and 1.2.3.5 come from a trusted source.");
        skipOtpForHttpHeader.setDefaultValue("");

        ProviderConfigProperty forceOtpForHttpHeader = new ProviderConfigProperty();
        forceOtpForHttpHeader.setType(STRING_TYPE);
        forceOtpForHttpHeader.setName(FORCE_OTP_FOR_HTTP_HEADER);
        forceOtpForHttpHeader.setLabel("Force OTP for Header");
        forceOtpForHttpHeader.setHelpText("OTP required if a HTTP request header matches the given pattern.");
        forceOtpForHttpHeader.setDefaultValue("");

        ProviderConfigProperty defaultOutcome = new ProviderConfigProperty();
        defaultOutcome.setType(LIST_TYPE);
        defaultOutcome.setName(DEFAULT_OTP_OUTCOME);
        defaultOutcome.setLabel("Fallback OTP handling");
        defaultOutcome.setOptions(asList(SKIP, FORCE));
        defaultOutcome.setHelpText("What to do in case of every check abstains. Defaults to force OTP authentication.");

        return asList(forceOtpUserAttribute, skipOtpRole, forceOtpRole, skipOtpForHttpHeader, forceOtpForHttpHeader, defaultOutcome);
    }

getDisplayType()

String org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.getDisplayType ( )

inline

                                   {
        return "Conditional OTP Form";
    }

getHelpText()

String org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.getHelpText ( )

inline

                                {
        return "Validates a OTP on a separate OTP form. Only shown if required based on the configured conditions.";
    }

getId()

String org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.getId ( )

inline

                          {
        return PROVIDER_ID;
    }

getReferenceCategory()

String org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.getReferenceCategory ( )

inline

                                         {
        return UserCredentialModel.TOTP;
    }

getRequirementChoices()

AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.getRequirementChoices ( )

inline

                                                                              {
        return REQUIREMENT_CHOICES;
    }

init()

void org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.init ( Config.Scope  config )

inline

                                          {
        //NOOP
    }

isConfigurable()

boolean org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.isConfigurable ( )

inline

                                    {
        return true;
    }

isUserSetupAllowed()

boolean org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.isUserSetupAllowed ( )

inline

                                        {
        return true;
    }

postInit()

void org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.postInit ( KeycloakSessionFactory  factory )

inline

                                                         {
        //NOOP
    }

メンバ詳解

PROVIDER_ID

final String org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.PROVIDER_ID = "auth-conditional-otp-form"

static

REQUIREMENT_CHOICES

final AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.REQUIREMENT_CHOICES

static

初期値:

= {
            AuthenticationExecutionModel.Requirement.REQUIRED,
            AuthenticationExecutionModel.Requirement.OPTIONAL,
            AuthenticationExecutionModel.Requirement.DISABLED}

SINGLETON

final ConditionalOtpFormAuthenticator org.keycloak.authentication.authenticators.browser.ConditionalOtpFormAuthenticatorFactory.SINGLETON = new ConditionalOtpFormAuthenticator()

static

---

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

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