org.adeptnet.auth.saml

Class SAMLClient

java.lang.Object

org.adeptnet.auth.saml.SAMLClient

public class SAMLClient
extends Object

A SAMLClient acts as on behalf of a SAML Service Provider to generate requests and process responses. To integrate a service, one must generally do the following: 1. Change the login process to call generateAuthnRequest() to get a request and link, and then GET/POST that to the IdP login URL. 2. Create a new URL that acts as the AssertionConsumerService -- it will call validateResponse on the response body to verify the assertion; on success it will use the subject as the authenticated user for the web application. The specific changes needed to the application are outside the scope of this SDK.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SAML_RELAYSTATE
static String	SAML_RESPONSE
static String	SAML_SIGALG
static String	SAML_SIGNATURE

Constructor Summary

Constructors

Constructor and Description
SAMLClient(SAMLConfig config) Create a new SAMLClient, using the IdPConfig for endpoints and validation.

Method Summary

Modifier and Type	Method and Description
org.opensaml.saml2.core.AuthnRequest	createAuthnRequest(String requestId)
void	doSAMLRedirect(javax.servlet.http.HttpServletResponse response, String relayState)
String	generateAuthnRequest(String requestId) Create a new AuthnRequest suitable for sending to an HTTPRedirect binding endpoint on the IdP.
IdPConfig	getIdPConfig() Get the configured IdpConfig.
SPConfig	getSPConfig() Get the configured SPConfig.
AttributeSet	validateResponseGET(String queryString)
AttributeSet	validateResponsePOST(String _authnResponse) Check an authnResponse and return the subject if validation succeeds.

Methods inherited from class java.lang.Object

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

Field Detail

SAML_RESPONSE

public static final String SAML_RESPONSE

See Also:

Constant Field Values

SAML_RELAYSTATE

public static final String SAML_RELAYSTATE

See Also:

Constant Field Values

SAML_SIGALG

public static final String SAML_SIGALG

See Also:

Constant Field Values

SAML_SIGNATURE

public static final String SAML_SIGNATURE

See Also:

Constant Field Values

Constructor Detail

SAMLClient

public SAMLClient(SAMLConfig config)
           throws SAMLException

Create a new SAMLClient, using the IdPConfig for endpoints and validation.

Parameters:

config -

Throws:

SAMLException

Method Detail

getIdPConfig

public IdPConfig getIdPConfig()

Get the configured IdpConfig.

Returns:

the IdPConfig associated with this client

getSPConfig

public SPConfig getSPConfig()

Get the configured SPConfig.

Returns:

the SPConfig associated with this client

createAuthnRequest

public org.opensaml.saml2.core.AuthnRequest createAuthnRequest(String requestId)

generateAuthnRequest

public String generateAuthnRequest(String requestId)
                            throws SAMLException

Create a new AuthnRequest suitable for sending to an HTTPRedirect binding endpoint on the IdP. The SPConfig will be used to fill in the ACS and issuer, and the IdP will be used to set the destination.

Parameters:

requestId - random generated RequestId

Returns:

a deflated, base64-encoded AuthnRequest

Throws:

SAMLException

validateResponsePOST

public AttributeSet validateResponsePOST(String _authnResponse)
                                  throws SAMLException

Check an authnResponse and return the subject if validation succeeds. The NameID from the subject in the first valid assertion is returned along with the attributes.

Parameters:

_authnResponse - a base64-encoded AuthnResponse from the SP

Returns:

the authenticated subject/attributes as an AttributeSet

Throws:

SAMLException - if validation failed.

validateResponseGET

public AttributeSet validateResponseGET(String queryString)
                                 throws SAMLException

Throws:

SAMLException

doSAMLRedirect

public void doSAMLRedirect(javax.servlet.http.HttpServletResponse response,
                           String relayState)
                    throws SAMLException,
                           org.opensaml.ws.message.encoder.MessageEncodingException

Throws:

SAMLException

org.opensaml.ws.message.encoder.MessageEncodingException