org.codice.ddf.security.idp.client

Class IdpHandler

java.lang.Object

org.codice.ddf.security.idp.client.IdpHandler

All Implemented Interfaces:

AuthenticationHandler

public class IdpHandler
extends Object
implements AuthenticationHandler

Handler for SAML 2.0 IdP based authentication. Unauthenticated clients will be redirected to the configured IdP for authentication.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TYPE IdP type to use when configuring context policy.
static String	ECP_NS
static String	ECP_RELAY_STATE
static String	ECP_REQUEST
static String	HTTP_SCHEMAS_XMLSOAP_ORG_SOAP_ACTOR_NEXT
static String	PAOS
static String	PAOS_MIME
static String	PAOS_NS
static String	PAOS_REQUEST
static String	PAOS_RESPONSE
static String	SAML_REQUEST
String	soapfaultMessageTemplate
String	soapMessageTemplate
static String	SOURCE
static String	TLS_SERVER_END_POINT
static String	UNABLE_TO_ENCODE_SAML_AUTHN_REQUEST
static String	UNABLE_TO_SIGN_SAML_AUTHN_REQUEST

Constructor Summary

Constructors

Constructor and Description
IdpHandler(SimpleSign simpleSign, IdpMetadata metadata, RelayStates<String> relayStates)

Method Summary

Modifier and Type	Method and Description
List<String>	getAuthContextClasses()
String	getAuthenticationType() Authentication type String used to match this handler with the auth types configured for a specific context.
HandlerResult	getNormalizedToken(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain, boolean resolve) Handler implementing SAML 2.0 IdP authentication.
HandlerResult	handleError(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain chain) Called when downstream authentication fails.
void	setAuthContextClasses(List<String> authContextClasses)
void	setSessionFactory(SessionFactory sessionFactory)
void	setUserAgentCheck(boolean userAgentCheck)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AUTH_TYPE

public static final String AUTH_TYPE

IdP type to use when configuring context policy.

See Also:

Constant Field Values

SOURCE

public static final String SOURCE

See Also:

Constant Field Values

UNABLE_TO_ENCODE_SAML_AUTHN_REQUEST

public static final String UNABLE_TO_ENCODE_SAML_AUTHN_REQUEST

See Also:

Constant Field Values

UNABLE_TO_SIGN_SAML_AUTHN_REQUEST

public static final String UNABLE_TO_SIGN_SAML_AUTHN_REQUEST

See Also:

Constant Field Values

PAOS

public static final String PAOS

See Also:

Constant Field Values

PAOS_MIME

public static final String PAOS_MIME

See Also:

Constant Field Values

PAOS_NS

public static final String PAOS_NS

See Also:

Constant Field Values

ECP_NS

public static final String ECP_NS

See Also:

Constant Field Values

SAML_REQUEST

public static final String SAML_REQUEST

See Also:

Constant Field Values

PAOS_REQUEST

public static final String PAOS_REQUEST

See Also:

Constant Field Values

PAOS_RESPONSE

public static final String PAOS_RESPONSE

See Also:

Constant Field Values

ECP_REQUEST

public static final String ECP_REQUEST

See Also:

Constant Field Values

ECP_RELAY_STATE

public static final String ECP_RELAY_STATE

See Also:

Constant Field Values

HTTP_SCHEMAS_XMLSOAP_ORG_SOAP_ACTOR_NEXT

public static final String HTTP_SCHEMAS_XMLSOAP_ORG_SOAP_ACTOR_NEXT

See Also:

Constant Field Values

TLS_SERVER_END_POINT

public static final String TLS_SERVER_END_POINT

See Also:

Constant Field Values

soapMessageTemplate

public final String soapMessageTemplate

soapfaultMessageTemplate

public final String soapfaultMessageTemplate

Constructor Detail

IdpHandler

public IdpHandler(SimpleSign simpleSign,
                  IdpMetadata metadata,
                  RelayStates<String> relayStates)
           throws IOException

Throws:

IOException

Method Detail

getAuthenticationType

public String getAuthenticationType()

Description copied from interface: AuthenticationHandler

Authentication type String used to match this handler with the auth types configured for a specific context.

Specified by:

getAuthenticationType in interface AuthenticationHandler

Returns:

String representing the authentication type

getNormalizedToken

public HandlerResult getNormalizedToken(javax.servlet.ServletRequest request,
                                        javax.servlet.ServletResponse response,
                                        javax.servlet.FilterChain chain,
                                        boolean resolve)
                                 throws javax.servlet.ServletException

Handler implementing SAML 2.0 IdP authentication. Supports HTTP-Redirect and HTTP-POST bindings.

Specified by:

getNormalizedToken in interface AuthenticationHandler

Parameters:

request - http request to obtain attributes from and to pass into any local filter chains required

response - http response to return http responses or redirects

chain - original filter chain (should not be called from your handler)

resolve - flag with true implying that credentials should be obtained, false implying return if no credentials are found.

Returns:

result of handling this request - status and optional tokens

Throws:

javax.servlet.ServletException

handleError

public HandlerResult handleError(javax.servlet.ServletRequest servletRequest,
                                 javax.servlet.ServletResponse servletResponse,
                                 javax.servlet.FilterChain chain)
                          throws javax.servlet.ServletException

Description copied from interface: AuthenticationHandler

Called when downstream authentication fails. Should attempt to re-acquire credentials if appropriate. Returns a status indicating if appropriate action has been taken.

Specified by:

handleError in interface AuthenticationHandler

Parameters:

servletRequest - htt http response to return http responses or redirects

Returns:

result containing a status indicating if further action is necessary

Throws:

javax.servlet.ServletException

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

setUserAgentCheck

public void setUserAgentCheck(boolean userAgentCheck)

getAuthContextClasses

public List<String> getAuthContextClasses()

setAuthContextClasses

public void setAuthContextClasses(List<String> authContextClasses)