org.codice.ddf.security.handler.saml

Class SAMLAssertionHandler

java.lang.Object

org.codice.ddf.security.handler.saml.SAMLAssertionHandler

All Implemented Interfaces:

AuthenticationHandler

public class SAMLAssertionHandler
extends Object
implements AuthenticationHandler

Checks for a SAML assertion that has been returned to us in the ddf security cookie. If it exists, it is retrieved and converted into a SecurityToken.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TYPE SAML type to use when configuring context policy.

Constructor Summary

Constructors

Constructor and Description
SAMLAssertionHandler()

Method Summary

Modifier and Type	Method and Description
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) Determine if all the required information exists in the request to generate a token and move on to perform authentication and/or authorization for the requested context.
HandlerResult	handleError(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain chain) If an error occured during the processing of the request, this method will get called.
void	setSessionFactory(SessionFactory sessionFactory)

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

SAML type to use when configuring context policy.

See Also:

Constant Field Values

Constructor Detail

SAMLAssertionHandler

public SAMLAssertionHandler()

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)

Description copied from interface: AuthenticationHandler

Determine if all the required information exists in the request to generate a token and move on to perform authentication and/or authorization for the requested context. If 'resolve' is set to false and the required information is missing, do not attempt to obtain it and return a status of NO_ACTION. If 'resolve' is set to true and the required information is missing, do whatever it takes to obtain it (redirects, apply your own filters, etc.) and return a status of REDIRECTED. In any case, if the required credentials are present (including the successful conclusion of any redirects, etc.) place the credentials into the HandlerResult and return a status of COMPLETED.

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 containing a status and the credentials to be placed into the http request

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

handleError

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

If an error occured during the processing of the request, this method will get called. Since SAML handling is typically processed first, then we can assume that there was an error with the presented SAML assertion - either it was invalid, or the reference didn't match a cached assertion, etc. In order not to get stuck in a processing loop, we will return a 401 status code.

Specified by:

handleError in interface AuthenticationHandler

Parameters:

servletRequest - http servlet request

servletResponse - http servlet response

chain - rest of the request chain to be invoked after security handling

Returns:

result containing the potential credentials and status

Throws:

javax.servlet.ServletException