Spring Security Custom User Detail Service

Internal

• Spring Security Concepts

Overview

This approach is useful for the situation in which the user information should be part of the application's domain model.

Combining application authentication and authorization with domain model user information largely consists in the following steps:

• Declare a User entity that should implement the Spring UserDetails interface. Implementation of UserDetails provides essential user information to the framework, in a standard fashion (whether the account is enabled or not, authorities, etc.). Implementing UserInterface on a generic user domain model entity is the programmatic way of modifying the generic user entity to make it useful for authentication.
• Declare the corresponding repository interface:

public interface UserRepository extends CrudRepository<User, Long> {
    User findByUsername(String username);
}

• Implement a Spring @Service that implements UserDetailsService:

@Service
public class UserRepositoryUserDetailsService implements UserDetailsService {

  private UserRepository userRepository;

  @Autowired
  public UserRepositoryUserDetailsService(UserRepository userRepository) {
    this.userRepository = userRepository;
  }

  @Override
  public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
    User user = userRepository.findByUsername(username);
    if (user == null) {
      throw new UsernameNotFoundException("\"" + username + "\" not found");
    }
    return user;
  }
}

• Make Spring Security aware of the custom user details service:

@Configuration
@EnableWebSecurity
public class SecurityConfiguration extends WebSecurityConfigurerAdapter {

  @Autowired
  private UserDetailsService userDetailsService;

  @Override
  protected void configure(AuthenticationManagerBuilder auth) throws Exception {
    auth.userDetailsService(userDetailsService);
  }
}

• Configure a password encoder and configure the UserDetailsService with it, using the passwordEncoder() builder method.
• Provide a way to register users via a dedicated controller or similar.

Playground Example

Playground - Spring Security - User Detail Service