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

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

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

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

静的公開変数類
static final String	PROVIDER_ID = "auth-script-based"

静的変数
static final AuthenticationExecutionModel.Requirement []	REQUIREMENT_CHOICES
static final ScriptBasedAuthenticator	SINGLETON = new ScriptBasedAuthenticator()

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

詳解

An AuthenticatorFactory for ScriptBasedAuthenticators.

著者

Thomas Darimont

関数詳解

close()

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

inline

                        {
        //NOOP
    }

create()

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

inline

                                                         {

        /*
         would be great to have the actual authenticatorId here in order to initialize the authenticator in the ctor with
         the appropriate config from session.getContext().getRealm().getAuthenticatorConfigById(authenticatorId);

         This would help to avoid potentially re-evaluating the provide script multiple times per authenticator execution.
        */
        return SINGLETON;
    }

getConfigProperties()

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

inline

                                                              {

        ProviderConfigProperty name = new ProviderConfigProperty();
        name.setType(STRING_TYPE);
        name.setName(SCRIPT_NAME);
        name.setLabel("Script Name");
        name.setHelpText("The name of the script used to authenticate.");

        ProviderConfigProperty description = new ProviderConfigProperty();
        description.setType(STRING_TYPE);
        description.setName(SCRIPT_DESCRIPTION);
        description.setLabel("Script Description");
        description.setHelpText("The description of the script used to authenticate.");

        ProviderConfigProperty script = new ProviderConfigProperty();
        script.setType(SCRIPT_TYPE);
        script.setName(SCRIPT_CODE);
        script.setLabel("Script Source");

        String scriptTemplate = "//enter your script code here";
        try {
            scriptTemplate = StreamUtil.readString(getClass().getResourceAsStream("/scripts/authenticator-template.js"));
        } catch (IOException ioe) {
            LOGGER.warn(ioe);
        }
        script.setDefaultValue(scriptTemplate);
        script.setHelpText("The script used to authenticate. Scripts must at least define a function with the name 'authenticate(context)' that accepts a context (AuthenticationFlowContext) parameter.\n" +
                "This authenticator exposes the following additional variables: 'script', 'realm', 'user', 'session', 'authenticationSession', 'httpRequest', 'LOG'");

        return asList(name, description, script);
    }

getDisplayType()

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

inline

                                   {
        return "Script";
    }

getHelpText()

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

inline

                                {
        return "Script based authentication. Allows to define custom authentication logic via JavaScript.";
    }

getId()

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

inline

                          {
        return PROVIDER_ID;
    }

getReferenceCategory()

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

inline

                                         {
        return "script";
    }

getRequirementChoices()

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

inline

                                                                              {
        return REQUIREMENT_CHOICES;
    }

init()

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

inline

                                          {
        //NOOP
    }

isConfigurable()

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

inline

                                    {
        return true;
    }

isSupported()

boolean org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory.isSupported ( )

inline

                                 {
        return Profile.isFeatureEnabled(Profile.Feature.SCRIPTS);
    }

isUserSetupAllowed()

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

inline

                                        {
        return true;
    }

postInit()

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

inline

                                                         {
        //NOOP
    }

メンバ詳解

LOGGER

final Logger org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory.LOGGER = Logger.getLogger(ScriptBasedAuthenticatorFactory.class)

staticprivate

PROVIDER_ID

final String org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory.PROVIDER_ID = "auth-script-based"

static

REQUIREMENT_CHOICES

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

staticpackage

初期値:

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

SINGLETON

final ScriptBasedAuthenticator org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticatorFactory.SINGLETON = new ScriptBasedAuthenticator()

staticpackage

---

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

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