Package org.codice.ddf.security.idp.client

Class IdpHandler

java.lang.Object

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

All Implemented Interfaces:

org.codice.ddf.security.handler.api.AuthenticationHandler

public class IdpHandler
extends Object
implements org.codice.ddf.security.handler.api.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	Description
static final String	AUTH_TYPE	IdP type to use when configuring context policy.
static final String	ECP_NS
static final String	ECP_RELAY_STATE
static final String	ECP_REQUEST
static final String	HTTP_SCHEMAS_XMLSOAP_ORG_SOAP_ACTOR_NEXT
static final String	HTTPS
static final String	PAOS
static final String	PAOS_MIME
static final String	PAOS_NS
static final String	PAOS_REQUEST
static final String	PAOS_RESPONSE
static final String	SAML_REQUEST
final String	soapfaultMessageTemplate
final String	soapMessageTemplate
static final String	SOURCE
static final String	TLS_SERVER_END_POINT
static final String	UNABLE_TO_ENCODE_SAML_AUTHN_REQUEST
static final String	UNABLE_TO_SIGN_SAML_AUTHN_REQUEST

Constructor Summary

Constructors

Constructor	Description
IdpHandler(ddf.security.samlp.impl.SimpleSign simpleSign, IdpMetadata metadata, ddf.security.samlp.impl.RelayStates<String> relayStates)

Method Summary

Modifier and Type	Method	Description
List<String>	getAuthContextClasses()
String	getAuthenticationType()
org.codice.ddf.security.handler.api.HandlerResult	getNormalizedToken(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, org.codice.ddf.platform.filter.SecurityFilterChain chain, boolean resolve)	Handler implementing SAML 2.0 IdP authentication.
org.codice.ddf.security.handler.api.HandlerResult	handleError(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, org.codice.ddf.platform.filter.SecurityFilterChain chain)
void	setAuthContextClasses(List<String> authContextClasses)
void	setSamlSecurity(org.codice.ddf.security.jaxrs.SamlSecurity samlSecurity)
void	setSecurityLogger(ddf.security.audit.SecurityLogger securityLogger)
void	setUserAgentCheck(boolean userAgentCheck)

Methods inherited from class java.lang.Object

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

Field Details

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

HTTPS

public static final String HTTPS

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 Details

IdpHandler

public IdpHandler(ddf.security.samlp.impl.SimpleSign simpleSign,
 IdpMetadata metadata,
 ddf.security.samlp.impl.RelayStates<String> relayStates)
           throws IOException

Throws:

IOException

Method Details

getAuthenticationType

public String getAuthenticationType()

Specified by:

getAuthenticationType in interface org.codice.ddf.security.handler.api.AuthenticationHandler

getNormalizedToken

public org.codice.ddf.security.handler.api.HandlerResult getNormalizedToken(javax.servlet.ServletRequest request,
 javax.servlet.ServletResponse response,
 org.codice.ddf.platform.filter.SecurityFilterChain chain,
 boolean resolve)
                                                                     throws org.codice.ddf.platform.filter.AuthenticationFailureException

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

Specified by:

getNormalizedToken in interface org.codice.ddf.security.handler.api.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:

org.codice.ddf.platform.filter.AuthenticationFailureException

handleError

public org.codice.ddf.security.handler.api.HandlerResult handleError(javax.servlet.ServletRequest servletRequest,
 javax.servlet.ServletResponse servletResponse,
 org.codice.ddf.platform.filter.SecurityFilterChain chain)
                                                              throws org.codice.ddf.platform.filter.AuthenticationFailureException

Specified by:

handleError in interface org.codice.ddf.security.handler.api.AuthenticationHandler

Throws:

org.codice.ddf.platform.filter.AuthenticationFailureException

setUserAgentCheck

public void setUserAgentCheck(boolean userAgentCheck)

getAuthContextClasses

public List<String> getAuthContextClasses()

setAuthContextClasses

public void setAuthContextClasses(List<String> authContextClasses)

setSamlSecurity

public void setSamlSecurity(org.codice.ddf.security.jaxrs.SamlSecurity samlSecurity)

setSecurityLogger

public void setSecurityLogger(ddf.security.audit.SecurityLogger securityLogger)