com.atlassian.plugins.authentication.sso.web.saml.provider

Interface SamlProvider

All Known Implementing Classes:

OneloginJavaSamlProvider

public interface SamlProvider

Allows interacting with the saml provider library.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SamlProvider.ServiceProviderInfo Basic information about service provider.

Method Summary

Modifier and Type	Method and Description
SamlRequest	createSamlSingleSignOnRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SamlProvider.ServiceProviderInfo serviceProviderInfo, boolean forceAuth, SamlConfig samlConfig) Prepares a SAML AuthnRequest
SamlResponse	extractSamlResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SamlProvider.ServiceProviderInfo serviceProviderInfo, SamlConfig samlConfig, SamlRequest samlRequest) Validates the SAML assertions provided in the request, and either returns a parsed response or throws
List<String>	getIssuers(javax.servlet.http.HttpServletRequest request) Parses response (does not authenticate or validate) and returns issuers in SAMLResponse query parameter

Method Detail

createSamlSingleSignOnRequest

SamlRequest createSamlSingleSignOnRequest(@Nonnull
                                          javax.servlet.http.HttpServletRequest request,
                                          @Nonnull
                                          javax.servlet.http.HttpServletResponse response,
                                          @Nonnull
                                          SamlProvider.ServiceProviderInfo serviceProviderInfo,
                                          boolean forceAuth,
                                          SamlConfig samlConfig)

Prepares a SAML AuthnRequest

Parameters:

forceAuth - if set to true, Identity Provider should explicitly ask user for credentials

samlConfig - the SAML IdP to whom the AuthnRequest will be prepared

Returns:

a representation of the SAML request

extractSamlResponse

SamlResponse extractSamlResponse(@Nonnull
                                 javax.servlet.http.HttpServletRequest request,
                                 @Nonnull
                                 javax.servlet.http.HttpServletResponse response,
                                 @Nonnull
                                 SamlProvider.ServiceProviderInfo serviceProviderInfo,
                                 @Nonnull
                                 SamlConfig samlConfig,
                                 @Nullable
                                 SamlRequest samlRequest)
                          throws InvalidSamlResponse

Validates the SAML assertions provided in the request, and either returns a parsed response or throws

Parameters:

samlRequest - the AuthnRequest data that this request is a response to, null for IDP initiated authentication

Returns:

a parsed, valid SAML response

Throws:

InvalidSamlResponse - if the assertions can't be verified, are invalid, or the request doesn't contain assertions

getIssuers

List<String> getIssuers(javax.servlet.http.HttpServletRequest request)

Parses response (does not authenticate or validate) and returns issuers in SAMLResponse query parameter

Returns:

list of issuers