org.overlord.commons.auth.filters

Class SamlBearerTokenAuthFilter

java.lang.Object

org.overlord.commons.auth.filters.SamlBearerTokenAuthFilter

All Implemented Interfaces:

javax.servlet.Filter

public abstract class SamlBearerTokenAuthFilter
extends Object
implements javax.servlet.Filter

A filter that supports both BASIC authentication and custom SAML Bearer Token authentication.

Author:

eric.wittmann@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SamlBearerTokenAuthFilter.Creds Models inbound basic auth credentials (user/password).

Constructor Summary

Constructors

Constructor and Description
SamlBearerTokenAuthFilter() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Set<String>	defaultAllowedIssuers()
protected String	defaultKeyAlias()
protected String	defaultKeyPassword()
protected String	defaultKeystorePassword()
protected String	defaultKeystorePath()
protected String	defaultRealm()
protected boolean	defaultSignatureRequired()
void	destroy()
protected abstract SimplePrincipal	doBasicLogin(String username, String password, javax.servlet.http.HttpServletRequest request) Fall back to standard basic authentication.
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
protected void	doFilterChain(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain, SimplePrincipal principal) Further process the filter chain.
protected SimplePrincipal	doSamlLogin(String assertionData, javax.servlet.http.HttpServletRequest request) Handles SAML Bearer token authentication.
void	init(javax.servlet.FilterConfig config)
protected SimplePrincipal	login(SamlBearerTokenAuthFilter.Creds credentials, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Validates the basic authentication credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

SamlBearerTokenAuthFilter

public SamlBearerTokenAuthFilter()

Constructor.

Method Detail

init

public void init(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

See Also:

Filter.init(javax.servlet.FilterConfig)

defaultKeystorePassword

protected String defaultKeystorePassword()

Returns:

the default keystore password

defaultKeyAlias

protected String defaultKeyAlias()

Returns:

the default key alias

defaultKeyPassword

protected String defaultKeyPassword()

Returns:

the default key password

defaultKeystorePath

protected String defaultKeystorePath()

Returns:

the default value of keystorePath

defaultSignatureRequired

protected boolean defaultSignatureRequired()

Returns:

the default value of signatureRequired

defaultAllowedIssuers

protected Set<String> defaultAllowedIssuers()

Returns:

the default set of allowed issuers

defaultRealm

protected String defaultRealm()

Returns:

the default realm

doFilter

public void doFilter(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

See Also:

Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)

doFilterChain

protected void doFilterChain(javax.servlet.ServletRequest request,
                 javax.servlet.ServletResponse response,
                 javax.servlet.FilterChain chain,
                 SimplePrincipal principal)
                      throws IOException,
                             javax.servlet.ServletException

Further process the filter chain.

Parameters:

request -

response -

chain -

principal -

Throws:

IOException

javax.servlet.ServletException

login

protected SimplePrincipal login(SamlBearerTokenAuthFilter.Creds credentials,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
                         throws IOException

Validates the basic authentication credentials.

Parameters:

credentials -

request -

response -

Throws:

IOException

doSamlLogin

protected SimplePrincipal doSamlLogin(String assertionData,
                          javax.servlet.http.HttpServletRequest request)
                               throws IOException

Handles SAML Bearer token authentication. Assumes the password is an encoded SAML assertion.

Parameters:

assertionData -

request -

Throws:

IOException

doBasicLogin

protected abstract SimplePrincipal doBasicLogin(String username,
                           String password,
                           javax.servlet.http.HttpServletRequest request)
                                         throws IOException

Fall back to standard basic authentication. Subclasses must implement this method.

Parameters:

username -

password -

request -

Throws:

IOException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

See Also:

Filter.destroy()