Package org.springframework.security.oauth2.server.authorization.authentication

Class X509ClientCertificateAuthenticationProvider

java.lang.Object

org.springframework.security.oauth2.server.authorization.authentication.X509ClientCertificateAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public final class X509ClientCertificateAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation used for OAuth 2.0 Client Authentication, which authenticates the client X509Certificate received when the tls_client_auth or self_signed_tls_client_auth authentication method is used.

Since:

7.0

See Also:

• AuthenticationProvider
• OAuth2ClientAuthenticationToken
• RegisteredClientRepository
• OAuth2AuthorizationService

Constructor Summary

Constructors

Constructor	Description
X509ClientCertificateAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService)	Constructs a X509ClientCertificateAuthenticationProvider using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Authentication	authenticate(Authentication authentication)	Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .
void	setCertificateVerifier(Consumer<OAuth2ClientAuthenticationContext> certificateVerifier)	Sets the Consumer providing access to the OAuth2ClientAuthenticationContext and is responsible for verifying the client X509Certificate associated in the OAuth2ClientAuthenticationToken.
boolean	supports(Class<?> authentication)	Returns true if this AuthenticationProvider supports the indicated Authentication object.

Methods inherited from class java.lang.Object

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

Constructor Details

X509ClientCertificateAuthenticationProvider

public X509ClientCertificateAuthenticationProvider(RegisteredClientRepository registeredClientRepository,
 OAuth2AuthorizationService authorizationService)

Constructs a X509ClientCertificateAuthenticationProvider using the provided parameters.

Parameters:

registeredClientRepository - the repository of registered clients

authorizationService - the authorization service

Method Details

authenticate

public Authentication authenticate(Authentication authentication)
                            throws AuthenticationException

Description copied from interface: AuthenticationProvider

Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

authentication - the authentication request object.

Returns:

a fully authenticated object including credentials. May return null if the AuthenticationProvider is unable to support authentication of the passed Authentication object. In such a case, the next AuthenticationProvider that supports the presented Authentication class will be tried.

Throws:

AuthenticationException - if authentication fails.

supports

public boolean supports(Class<?> authentication)

Description copied from interface: AuthenticationProvider

Returns true if this AuthenticationProvider supports the indicated Authentication object.

Returning true does not guarantee an AuthenticationProvider will be able to authenticate the presented Authentication object. It simply indicates it can support closer evaluation of it. An AuthenticationProvider can still return null from the AuthenticationProvider.authenticate(Authentication) method to indicate another AuthenticationProvider should be tried.

Selection of an AuthenticationProvider capable of performing authentication is conducted at runtime by the ProviderManager.

Specified by:

supports in interface AuthenticationProvider

Returns:

true if the implementation can more closely evaluate the Authentication class presented

setCertificateVerifier

public void setCertificateVerifier(Consumer<OAuth2ClientAuthenticationContext> certificateVerifier)

Sets the Consumer providing access to the OAuth2ClientAuthenticationContext and is responsible for verifying the client X509Certificate associated in the OAuth2ClientAuthenticationToken. The default implementation for the tls_client_auth authentication method verifies the expected subject distinguished name.

NOTE: If verification fails, an OAuth2AuthenticationException MUST be thrown.

Parameters:

certificateVerifier - the Consumer providing access to the OAuth2ClientAuthenticationContext and is responsible for verifying the client X509Certificate