El proceso de registro con Spring Security

Este artículo es parte de una serie: • Tutorial de registro de seguridad de Spring

• El proceso de registro con Spring Security (artículo actual) • Registro: active una nueva cuenta por correo electrónico

• Registro de seguridad de Spring: reenviar el correo electrónico de verificación

• Registro con Spring Security - Codificación de contraseña

• La API de registro se vuelve RESTful

• Spring Security: restablezca su contraseña

• Registro: seguridad y reglas de la contraseña

• Actualización de su contraseña

1. Información general

En este artículo, implementaremos un proceso de registro básico con Spring Security. Esto se basa en conceptos explorados en el artículo anterior, donde analizamos el inicio de sesión.

El objetivo aquí es agregar un proceso de registro completo que permita a un usuario registrarse, validar y conservar los datos del usuario.

2. La página de registro

Primero, implementemos una página de registro simple que muestre los siguientes campos :

  • nombre ( nombre y apellido)
  • correo electrónico
  • contraseña (y campo de confirmación de contraseña)

El siguiente ejemplo muestra una página simple registration.html :

Ejemplo 2.1.

form

first

Validation error

last

Validation error

email

Validation error

password

Validation error

confirm submit login

3. El objeto DTO de usuario

Necesitamos un objeto de transferencia de datos para enviar toda la información de registro a nuestro backend de Spring. El objeto DTO debe tener toda la información que necesitaremos más adelante cuando creamos y completamos nuestro objeto Usuario :

public class UserDto { @NotNull @NotEmpty private String firstName; @NotNull @NotEmpty private String lastName; @NotNull @NotEmpty private String password; private String matchingPassword; @NotNull @NotEmpty private String email; // standard getters and setters }

Observe que usamos anotaciones estándar javax.validation en los campos del objeto DTO. Más adelante, también implementaremos nuestras propias anotaciones de validación personalizadas para validar el formato de la dirección de correo electrónico, así como para la confirmación de la contraseña. (ver sección 5)

4. El controlador de registro

Una de Inscripción enlace en el inicio de sesión página llevará al usuario al registro de la página. Este back-end para esa página reside en el controlador de registro y se asigna a "/ usuario / registro" :

Ejemplo 4.1. - El método showRegistration

@GetMapping("/user/registration") public String showRegistrationForm(WebRequest request, Model model) { UserDto userDto = new UserDto(); model.addAttribute("user", userDto); return "registration"; }

Cuando el controlador recibe la solicitud "/ usuario / registro" , crea el nuevo objeto UserDto que respaldará el formulario de registro , lo vinculará y lo devolverá, bastante sencillo.

5. Validación de datos de registro

A continuación, veamos las validaciones que realizará el controlador al registrar una nueva cuenta:

  1. Todos los campos obligatorios están llenos (no hay campos vacíos o nulos)
  2. La dirección de correo electrónico es válida (bien formada)
  3. El campo de confirmación de contraseña coincide con el campo de contraseña
  4. La cuenta aún no existe

5.1. La validación incorporada

Para las comprobaciones simples, usaremos las anotaciones de validación del bean listas para usar en el objeto DTO - anotaciones como @NotNull , @NotEmpty , etc.

Para desencadenar el proceso de validación, simplemente anotaremos el objeto en la capa del controlador con la anotación @Valid :

public ModelAndView registerUserAccount( @ModelAttribute("user") @Valid UserDto userDto, HttpServletRequest request, Errors errors) { ... }

5.2. Validación personalizada para verificar la validez del correo electrónico

A continuación, validemos la dirección de correo electrónico y asegurémonos de que esté bien formada. Vamos a crear un validador personalizado para eso, así como una anotación de validación personalizada , llamémoslo @ValidEmail .

Una nota al margen rápida aquí: estamos lanzando nuestra propia anotación personalizada en lugar del @Email de Hibernate porque Hibernate considera que el antiguo formato de direcciones de intranet: [correo electrónico protegido] es válido (consulte el artículo de Stackoverflow), lo cual no es bueno.

Aquí está la anotación de validación de correo electrónico y el validador personalizado:

Ejemplo 5.2.1. - La anotación personalizada para la validación de correo electrónico

@Target({TYPE, FIELD, ANNOTATION_TYPE}) @Retention(RUNTIME) @Constraint(validatedBy = EmailValidator.class) @Documented public @interface ValidEmail { String message() default "Invalid email"; Class[] groups() default {}; Class[] payload() default {}; }

Tenga en cuenta que hemos definido la anotación a nivel de CAMPO , ya que ahí es donde se aplica conceptualmente.

Ejemplo 5.2.2. - El correo electrónico personalizado Validato r:

public class EmailValidator implements ConstraintValidator { private Pattern pattern; private Matcher matcher; private static final String EMAIL_PATTERN = "^[_A-Za-z0-9-+]+ (.[_A-Za-z0-9-]+)*@" + "[A-Za-z0-9-]+(.[A-Za-z0-9]+)* (.[A-Za-z]{2,})$"; @Override public void initialize(ValidEmail constraintAnnotation) { } @Override public boolean isValid(String email, ConstraintValidatorContext context){ return (validateEmail(email)); } private boolean validateEmail(String email) { pattern = Pattern.compile(EMAIL_PATTERN); matcher = pattern.matcher(email); return matcher.matches(); } }

Usemos ahora la nueva anotación en nuestra implementación de UserDto :

@ValidEmail @NotNull @NotEmpty private String email;

5.3. Uso de la validación personalizada para la confirmación de la contraseña

También necesitamos una anotación y un validador personalizados para asegurarnos de que la contraseña y los campos de contraseña coincidentes coincidan:

Ejemplo 5.3.1. - La anotación personalizada para validar la confirmación de la contraseña

@Target({TYPE,ANNOTATION_TYPE}) @Retention(RUNTIME) @Constraint(validatedBy = PasswordMatchesValidator.class) @Documented public @interface PasswordMatches { String message() default "Passwords don't match"; Class[] groups() default {}; Class[] payload() default {}; }

Notice that the @Target annotation indicates that this is a TYPE level annotation. This is because we need the entire UserDto object to perform the validation.

The custom validator that will be called by this annotation is shown below:

Example 5.3.2. The PasswordMatchesValidator Custom Validator

public class PasswordMatchesValidator implements ConstraintValidator { @Override public void initialize(PasswordMatches constraintAnnotation) { } @Override public boolean isValid(Object obj, ConstraintValidatorContext context){ UserDto user = (UserDto) obj; return user.getPassword().equals(user.getMatchingPassword()); } }

Now, the @PasswordMatches annotation should be applied to our UserDto object:

@PasswordMatches public class UserDto { ... }

All custom validations are of course evaluated along with all standard annotations when the entire validation process runs.

5.4. Check That the Account Doesn't Already Exist

The fourth check we'll implement is verifying that the email account doesn't already exist in the database.

This is performed after the form has been validated and it's done with the help of the UserService implementation.

Example 5.4.1. – The Controller's createUserAccount Method Calls the UserService Object

@PostMapping("/user/registration") public ModelAndView registerUserAccount (@ModelAttribute("user") @Valid UserDto userDto, HttpServletRequest request, Errors errors) { try { User registered = userService.registerNewUserAccount(userDto); } catch (UserAlreadyExistException uaeEx) { mav.addObject("message", "An account for that username/email already exists."); return mav; } // rest of the implementation } 

Example 5.4.2. – UserService Checks for Duplicate Emails

@Service public class UserService implements IUserService { @Autowired private UserRepository repository; @Transactional @Override public User registerNewUserAccount(UserDto userDto) throws UserAlreadyExistException { if (emailExist(userDto.getEmail())) { throw new UserAlreadyExistException( "There is an account with that email address: " + userDto.getEmail()); } ... // the rest of the registration operation } private boolean emailExist(String email) { return userRepository.findByEmail(email) != null; } }

The UserService relies on the UserRepository class to check if a user with a given email address already exists in the database.

Now – the actual implementation of the UserRepository in the persistence layer isn't relevant for the current article. One quick way is, of course, to use Spring Data to generate the repository layer.

6. Persisting Data and Finishing-Up Form Processing

Finally – let's implement the registration logic in our controller layer:

Example 6.1.1. – The RegisterAccount Method in the Controller

@PostMapping("/user/registration") public ModelAndView registerUserAccount( @ModelAttribute("user") @Valid UserDto userDto, HttpServletRequest request, Errors errors) { try { User registered = userService.registerNewUserAccount(userDto); } catch (UserAlreadyExistException uaeEx) { mav.addObject("message", "An account for that username/email already exists."); return mav; } return new ModelAndView("successRegister", "user", userDto); } 

Things to notice in the code above:

  1. The controller is returning a ModelAndView object which is the convenient class for sending model data (user) tied to the view.
  2. The controller will redirect to the registration form if there are any errors set at validation time.

7.The UserService – Register Operation

Let's finish the implementation of the registration operation in the UserService:

Example 7.1. The IUserService Interface

public interface IUserService { User registerNewUserAccount(UserDto userDto) throws UserAlreadyExistException; }

Example 7.2. – The UserService Class

@Service public class UserService implements IUserService { @Autowired private UserRepository repository; @Transactional @Override public User registerNewUserAccount(UserDto userDto) throws UserAlreadyExistException { if (emailExists(userDto.getEmail())) { throw new UserAlreadyExistException( "There is an account with that email address: + userDto.getEmail()); } User user = new User(); user.setFirstName(userDto.getFirstName()); user.setLastName(userDto.getLastName()); user.setPassword(userDto.getPassword()); user.setEmail(userDto.getEmail()); user.setRoles(Arrays.asList("ROLE_USER")); return repository.save(user); } private boolean emailExists(String email) { return userRepository.findByEmail(email) != null; } }

8. Loading User Details for Security Login

In our previous article, login was using hard coded credentials. Let's change that and use the newly registered user information and credentials. We'll implement a custom UserDetailsService to check the credentials for login from the persistence layer.

8.1. The Custom UserDetailsService

Let's start with the custom user details service implementation:

@Service @Transactional public class MyUserDetailsService implements UserDetailsService { @Autowired private UserRepository userRepository; // public UserDetails loadUserByUsername(String email) throws UsernameNotFoundException { User user = userRepository.findByEmail(email); if (user == null) { throw new UsernameNotFoundException( "No user found with username: "+ email); } boolean enabled = true; boolean accountNonExpired = true; boolean credentialsNonExpired = true; boolean accountNonLocked = true; return new org.springframework.security.core.userdetails.User (user.getEmail(), user.getPassword().toLowerCase(), enabled, accountNonExpired, credentialsNonExpired, accountNonLocked, getAuthorities(user.getRoles())); } private static List getAuthorities (List roles) { List authorities = new ArrayList(); for (String role : roles) { authorities.add(new SimpleGrantedAuthority(role)); } return authorities; } }

8.2. Enable the New Authentication Provider

To enable the new user service in the Spring Security configuration – we simply need to add a reference to the UserDetailsService inside the authentication-manager element and add the UserDetailsService bean:

Example 8.2.- The Authentication Manager and the UserDetailsService

Or, via Java configuration:

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

9. Conclusion

And we're done – a complete and almost production ready registration process implemented with Spring Security and Spring MVC. Next, we're going to discuss the process of activating the newly registered account by verifying the email of the new user.

The implementation of this Spring Security REST Tutorial can be found in the GitHub project – this is an Eclipse based project, so it should be easy to import and run as it is.

Next » Registration – Activate a New Account by Email « Previous Spring Security Registration Tutorial