Package org.springframework.security.openid

Class OpenIDAuthenticationProvider

java.lang.Object
org.springframework.security.openid.OpenIDAuthenticationProvider
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean, AuthenticationProvider
@Deprecated public class OpenIDAuthenticationProvider extends Object implements AuthenticationProvider, org.springframework.beans.factory.InitializingBean
Deprecated.
The OpenID 1.0 and 2.0 protocols have been deprecated and users are encouraged to migrate to OpenID Connect, which is supported by spring-security-oauth2.
Finalises the OpenID authentication by obtaining local authorities for the authenticated user.

The authorities are obtained by calling the configured UserDetailsService. The UserDetails it returns must, at minimum, contain the username and GrantedAuthority objects applicable to the authenticated user. Note that by default, Spring Security ignores the password and enabled/disabled status of the UserDetails because this is authentication-related and should have been enforced by another provider server.

The UserDetails returned by implementations is stored in the generated Authentication token, so additional properties such as email addresses, telephone numbers etc can easily be stored.

  • Constructor Details

    • OpenIDAuthenticationProvider

      public OpenIDAuthenticationProvider()
      Deprecated.

  • Method Details

    • afterPropertiesSet

      public void afterPropertiesSet()
      Deprecated.
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

    • authenticate

      public Authentication authenticate(Authentication authentication) throws AuthenticationException
      Deprecated.
      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.

    • createSuccessfulAuthentication

      protected Authentication createSuccessfulAuthentication(UserDetails userDetails, OpenIDAuthenticationToken auth)
      Deprecated.
      Handles the creation of the final Authentication object which will be returned by the provider.

      The default implementation just creates a new OpenIDAuthenticationToken from the original, but with the UserDetails as the principal and including the authorities loaded by the UserDetailsService.

      Parameters:
      userDetails - the loaded UserDetails object
      auth - the token passed to the authenticate method, containing
      Returns:
      the token which will represent the authenticated user.

    • setUserDetailsService

      public void setUserDetailsService(UserDetailsService userDetailsService)
      Deprecated.
      Used to load the UserDetails for the authenticated OpenID user.

    • setAuthenticationUserDetailsService

      public void setAuthenticationUserDetailsService(AuthenticationUserDetailsService<OpenIDAuthenticationToken> userDetailsService)
      Deprecated.
      Used to load the UserDetails for the authenticated OpenID user.

    • supports

      public boolean supports(Class<?> authentication)
      Deprecated.
      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 instance of the Authentication class. 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 the ProviderManager.

      Specified by:
      supports in interface AuthenticationProvider
      Returns:
      true if the implementation can more closely evaluate the Authentication class presented

    • setAuthoritiesMapper

      public void setAuthoritiesMapper(GrantedAuthoritiesMapper authoritiesMapper)
      Deprecated.