Der Registrierungsprozess mit Spring Security

Dieser Artikel ist Teil einer Reihe: • Spring Security Registration Tutorial

• Der Registrierungsprozess mit Spring Security (aktueller Artikel) • Registrierung - Aktivieren Sie ein neues Konto per E-Mail

• Spring Security Registration - Bestätigungs-E-Mail erneut senden

• Registrierung bei Spring Security - Passwortkodierung

• Die Registrierungs-API wird RESTful

• Spring Security - Setzen Sie Ihr Passwort zurück

• Registrierung - Passwortstärke und Regeln

• Aktualisieren Sie Ihr Passwort

1. Übersicht

In diesem Artikel implementieren wir einen grundlegenden Registrierungsprozess bei Spring Security. Dies baut auf den Konzepten auf, die im vorherigen Artikel untersucht wurden, in dem wir uns mit der Anmeldung befasst haben.

Ziel ist es, einen vollständigen Registrierungsprozess hinzuzufügen , mit dem sich ein Benutzer anmelden, Benutzerdaten validieren und beibehalten kann.

2. Die Registrierungsseite

Lassen Sie uns zunächst eine einfache Registrierungsseite implementieren, auf der die folgenden Felder angezeigt werden :

  • Name (Vor- und Nachname)
  • Email
  • Passwort (und Passwortbestätigungsfeld)

Das folgende Beispiel zeigt eine einfache registration.html Seite:

Beispiel 2.1.

form

first

Validation error

last

Validation error

email

Validation error

password

Validation error

confirm submit login

3. Das Benutzer-DTO-Objekt

Wir benötigen ein Datenübertragungsobjekt , um alle Registrierungsinformationen an unser Spring-Backend zu senden. Das DTO- Objekt sollte alle Informationen enthalten, die wir später beim Erstellen und Auffüllen unseres Benutzerobjekts benötigen :

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 }

Beachten Sie, dass wir Standardanmerkungen für javax.validation für die Felder des DTO-Objekts verwendet haben. Später werden wir auch unsere eigenen benutzerdefinierten Validierungsanmerkungen implementieren , um das Format der E-Mail-Adresse sowie die Kennwortbestätigung zu validieren. (siehe Abschnitt 5)

4. Der Registrierungscontroller

Ein Anmeldelink auf der Anmeldeseite führt den Benutzer zur Registrierungsseite . Dieses Backend für diese Seite befindet sich im Registrierungscontroller und ist "/ user / register" zugeordnet :

Beispiel 4.1. - Die showRegistration- Methode

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

Wenn der Controller die Anforderung "/ user / register " erhält , erstellt er das neue UserDto- Objekt, das das Registrierungsformular unterstützt , bindet und zurückgibt - ziemlich einfach.

5. Validierung der Registrierungsdaten

Weiter - Schauen wir uns die Überprüfungen an, die der Controller bei der Registrierung eines neuen Kontos durchführt:

  1. Alle erforderlichen Felder sind ausgefüllt (keine leeren oder Nullfelder)
  2. Die E-Mail-Adresse ist gültig (wohlgeformt)
  3. Das Passwortbestätigungsfeld stimmt mit dem Passwortfeld überein
  4. Das Konto existiert noch nicht

5.1. Die integrierte Validierung

Für die einfachen Überprüfungen verwenden wir die sofort einsatzbereiten Bean-Validierungsanmerkungen für das DTO-Objekt - Anmerkungen wie @NotNull , @NotEmpty usw.

Um den Validierungsprozess auszulösen, kommentieren wir das Objekt in der Controller-Ebene einfach mit der Annotation @Valid :

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

5.2. Benutzerdefinierte Validierung zur Überprüfung der E-Mail-Gültigkeit

Weiter - Lassen Sie uns die E-Mail-Adresse überprüfen und sicherstellen, dass sie gut geformt ist. Wir werden dafür einen benutzerdefinierten Validator sowie eine benutzerdefinierte Validierungsanmerkung erstellen - nennen wir das @ValidEmail .

Eine kurze Randnotiz hier: Wir rollen unsere eigene benutzerdefinierte Annotation anstelle von Hibernates @Email, da Hibernate das alte Intranet - Adressformat [E-Mail-geschützt] als gültig ansieht (siehe Stackoverflow-Artikel), was nicht gut ist.

Hier ist die Anmerkung zur E-Mail-Validierung und der benutzerdefinierte Validator:

Beispiel 5.2.1. - Die benutzerdefinierte Anmerkung für die E-Mail-Validierung

@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 {}; }

Beachten Sie, dass wir die Annotation auf FELDEbene definiert haben - da sie dort konzeptionell gilt.

Beispiel 5.2.2. - Das benutzerdefinierte EmailValidato 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(); } }

Verwenden wir jetzt die neue Anmerkung in unserer UserDto- Implementierung:

@ValidEmail @NotNull @NotEmpty private String email;

5.3. Verwenden der benutzerdefinierten Validierung zur Kennwortbestätigung

Wir benötigen außerdem eine benutzerdefinierte Anmerkung und einen Validator, um sicherzustellen, dass die Felder password und matchPassword übereinstimmen:

Beispiel 5.3.1. - Die benutzerdefinierte Anmerkung zum Überprüfen der Kennwortbestätigung

@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