com.goldencode.p2j.security

Interface SsoAuthenticator

All Known Implementing Classes:

SampleSsoAuthenticator

public interface SsoAuthenticator

Base interface for the SSO authentication hooks

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SsoAuthenticator.LicensingData Wrapper class for all properties that can be used for enforcing licensing policy.
static class	SsoAuthenticator.Result Wrapper class for all properties needed by the FWD framework to respond to the auth / spawn request

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FWD_SDK_LOGIN_PARAM_PASS The form parameter name for the password, when the FWD SDK script is used on the login page.
static java.lang.String	FWD_SDK_LOGIN_PARAM_USER The form parameter name for the user, when the FWD SDK script is used on the login page.

Method Summary

Modifier and Type	Method and Description
default SsoAuthenticator.Result	authenticate(javax.servlet.http.Cookie[] cookies, SsoAuthenticator.LicensingData licensingData) Auto-login interface.
SsoAuthenticator.Result	authenticate(java.util.Map<java.lang.String,java.lang.String[]> paramMap, javax.servlet.http.Cookie[] cookies, SsoAuthenticator.LicensingData licensingData) Validates the POST request data against an authentication provider (DB, 3rd party directory, custom auth server, etc) and returns a container with all details needed by the FWD framework to respond to the auth request and eventually spawn a new client with the specified authorization.
default java.lang.String	getAuthCookieName() Returns the name of the cookie used for auto-login.
java.lang.String	getLoginPage(java.lang.String loadedTemplate) Receives as an argument the html template loaded from the standard location in the custom package or null if no resource present.
default void	initialize() The method is called on server startup with the server context, after the default database connections are initialized, and can be used to read configurations from directory.
javax.servlet.http.Cookie	logout(javax.servlet.http.Cookie[] cookies) Invalidates the web session associated with the authentication cookie by communicating with the auth server or updating the DB and returns a cookie with the same name, but invalid value.
void	setOption(java.lang.String option) Provides options configured in directory under config/auth-mode/ssopluginoption.
default void	terminate() The method is called on server termination.

Field Detail

FWD_SDK_LOGIN_PARAM_USER

static final java.lang.String FWD_SDK_LOGIN_PARAM_USER

The form parameter name for the user, when the FWD SDK script is used on the login page.

See Also:

Constant Field Values

FWD_SDK_LOGIN_PARAM_PASS

static final java.lang.String FWD_SDK_LOGIN_PARAM_PASS

The form parameter name for the password, when the FWD SDK script is used on the login page.

See Also:

Constant Field Values

Method Detail

setOption

void setOption(java.lang.String option)

Provides options configured in directory under config/auth-mode/ssopluginoption. Plain text that can contain any number of configs to be parsed by the custom implementation of the authenticator. The method is called right after the current object is instantiated, before any authentication takes place.

Parameters:

option - Plain text that can contain any number of configs.

initialize

default void initialize()

The method is called on server startup with the server context, after the default database connections are initialized, and can be used to read configurations from directory.

terminate

default void terminate()

The method is called on server termination.

getLoginPage

java.lang.String getLoginPage(java.lang.String loadedTemplate)

Receives as an argument the html template loaded from the standard location in the custom package or null if no resource present.

Parameters:

loadedTemplate - The html template loaded from the standard location in the custom root package or null.

Returns:

The inflated template ready to be served as login page or null.

getAuthCookieName

default java.lang.String getAuthCookieName()

Returns the name of the cookie used for auto-login. Enables the framework to do validation of the cookies present in the request and determine if auto-login is possible. If null is returned, that indicates the auto-login function is disabled.

Returns:

The name of the cookie used for auto-login.

authenticate

default SsoAuthenticator.Result authenticate(javax.servlet.http.Cookie[] cookies,
                                             SsoAuthenticator.LicensingData licensingData)

Auto-login interface. Searches for a recognizable cookie to validate the session against an authentication provider (DB, 3rd party directory, custom auth server, etc) and returns a container with all details needed by the FWD framework to respond to the auth request and eventually spawn a new client with the specified authorization. On failure, authenticate(Map, Cookie[], LicensingData) will be later called by the login page on form submission.

Parameters:

cookies - All cookies coming with the HTTP request for authentication.

licensingData - Data that can be used for enforcing licensing policy.

Returns:

A container with all details needed by the FWD framework to spawn a new client.

authenticate

SsoAuthenticator.Result authenticate(java.util.Map<java.lang.String,java.lang.String[]> paramMap,
                                     javax.servlet.http.Cookie[] cookies,
                                     SsoAuthenticator.LicensingData licensingData)

Validates the POST request data against an authentication provider (DB, 3rd party directory, custom auth server, etc) and returns a container with all details needed by the FWD framework to respond to the auth request and eventually spawn a new client with the specified authorization. If the FWD SDK script is used on the login page, the parameters map contains FWD_SDK_LOGIN_PARAM_USER and FWD_SDK_LOGIN_PARAM_PASS.

Parameters:

paramMap - A map of all query / form params.

cookies - All cookies coming with the HTTP request.

licensingData - Data that can be used for enforcing licensing policy.

Returns:

A container with all details needed by the FWD framework to spawn a new client.

logout

javax.servlet.http.Cookie logout(javax.servlet.http.Cookie[] cookies)

Invalidates the web session associated with the authentication cookie by communicating with the auth server or updating the DB and returns a cookie with the same name, but invalid value.

Parameters:

cookies - The cookie to be returned to the browser and used in the next auth requests.

Returns:

null if the web session / cookie invalidation failed, otherwise an authentication Cookie with invalid value.