Package org.springframework.security.saml2.provider.service.authentication

Class Saml2AssertionAuthentication

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.saml2.provider.service.authentication.Saml2Authentication

org.springframework.security.saml2.provider.service.authentication.Saml2AssertionAuthentication

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class Saml2AssertionAuthentication
extends Saml2Authentication

An authentication based off of a SAML 2.0 Assertion

Since:

7.0

See Also:

• Saml2ResponseAssertionAccessor
• Saml2ResponseAssertion
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Saml2AssertionAuthentication.Builder<B extends Saml2AssertionAuthentication.Builder<B>>	A builder of Saml2AssertionAuthentication instances

Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
	Saml2AssertionAuthentication(Object principal, Saml2ResponseAssertionAccessor assertion, Collection<? extends GrantedAuthority> authorities, String relyingPartyRegistrationId)
protected	Saml2AssertionAuthentication(Saml2AssertionAuthentication.Builder<?> builder)
	Saml2AssertionAuthentication(Saml2ResponseAssertionAccessor assertion, Collection<? extends GrantedAuthority> authorities, String relyingPartyRegistrationId)

Method Summary

Modifier and Type	Method	Description
Saml2ResponseAssertionAccessor	getCredentials()	The credentials that prove the principal is correct.
String	getRelyingPartyRegistrationId()
Saml2AssertionAuthentication.Builder<?>	toBuilder()	Return an Authentication.Builder based on this instance.

Methods inherited from class org.springframework.security.saml2.provider.service.authentication.Saml2Authentication

getPrincipal, getSaml2Response

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Details

Saml2AssertionAuthentication

public Saml2AssertionAuthentication(Saml2ResponseAssertionAccessor assertion,
 Collection<? extends GrantedAuthority> authorities,
 String relyingPartyRegistrationId)

Saml2AssertionAuthentication

public Saml2AssertionAuthentication(Object principal,
 Saml2ResponseAssertionAccessor assertion,
 Collection<? extends GrantedAuthority> authorities,
 String relyingPartyRegistrationId)

Saml2AssertionAuthentication

protected Saml2AssertionAuthentication(Saml2AssertionAuthentication.Builder<?> builder)

Method Details

getCredentials

public Saml2ResponseAssertionAccessor getCredentials()

Description copied from interface: Authentication

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.

Specified by:

getCredentials in interface Authentication

Overrides:

getCredentials in class Saml2Authentication

Returns:

the credentials that prove the identity of the Principal

getRelyingPartyRegistrationId

public String getRelyingPartyRegistrationId()

toBuilder

public Saml2AssertionAuthentication.Builder<?> toBuilder()

Description copied from interface: Authentication

Return an Authentication.Builder based on this instance. By default, returns a builder that builds a SimpleAuthentication.

Although a default method, all Authentication implementations should implement this. The reason is to ensure that the Authentication type is preserved when Authentication.Builder.build() is invoked. This is especially important in the event that your authentication implementation contains custom fields.

This isn't strictly necessary since it is recommended that applications code to the Authentication interface and that custom information is often contained in the Authentication.getPrincipal() value.

Returns:

an Authentication.Builder for building a new Authentication based on this instance