Tutoriel pour apprendre à créer une application Laravel

l'authentification

Maurice Chavelli

Ce tutoriel a pour objectif de vous apprendre à gérer l'authentification au sein d'une application Laravel. C'est un cours qui fait partie d'une série de tutoriels pour vous apprendre à créer une application Laravel.

Commentez

- Titre : Tutoriel pour apprendre à créer une application Laravel

- Auteur : Maurice Chavelli

- Parution : 19 octobre 2017

- Licence : Copyright ® 2017 Laravel. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Introduction

- II. Les routes

- III. La validation

- IV. Les contrôleurs

- IV-A. AuthController

- IV-A-1. postLogin

- IV-A-2. postRegister

- IV-B. PasswordController

- IV-B-1. postEmail

- IV-B-2. postReset

- V. Les vues

- V-A. Le login

- V-B. L'inscription

- V-C. L'oubli du mot de passe

- V-D. Le nouveau mot de passe

- V-E. L'email

I - Introduction

Laravel 5 arrive avec une infrastructure pour l'authentification. On trouve dans l'installation de base deux contrôleurs :

Et deux middlewares (logiciels médiateurs) :

Et c'est tout ! Il faut donc créer tout le reste.

II - Les routes

Avec Laravel 5.2 on peut obtenir toutes les routes de l'authentification avec php artisan make:auth, mais on peut aussi les écrire, ce que j'ai préféré faire :

1. // Authentication routes...

2. Route::get('auth/login', 'Auth\AuthController@getLogin');

3. Route::post('auth/login', 'Auth\AuthController@postLogin');

4. Route::get('auth/logout', 'Auth\AuthController@getLogout');

5. Route::get('auth/confirm/{token}', 'Auth\AuthController@getConfirm');

7. // Renvoyer des routes...

8. Route::get('auth/resend', 'Auth\AuthController@getResend');

10. // Routes d'inscription...

11. Route::get('auth/register', 'Auth\AuthController@getRegister');

12. Route::post('auth/register', 'Auth\AuthController@postRegister');

14. // Routes de mot de passe réinitialisé...

15. Route::get('password/email', 'Auth\PasswordController@getEmail');

16. Route::post('password/email', 'Auth\PasswordController@postEmail');

18. // Routes de réinitialisation de mot de passe ...

19. Route::get('password/reset/{token}', 'Auth\PasswordController@getReset');

20. Route::post('password/reset', 'Auth\PasswordController@postReset');

Notez que la route pour la confirmation de l'email est forcément à créer.

III - La validation

Comme j'ai dû surcharger les méthodes correspondantes des contrôleurs, j'ai créé des requêtes de formulaires :

Ces requêtes ne présentent aucune difficulté ou particularité, je vous laisse donc les consulter si besoin.

IV - Les contrôleurs

IV-A - AuthController

Lorsque l'on regarde ce contrôleur dans l'installation de base on n'y trouve pas grand-chose :

1. <?php

3. namespace App\Http\Controllers\Auth;

5. use App\User;

6. use Validator;

7. use App\Http\Controllers\Controller;

8. use Illuminate\Foundation\Auth\ThrottlesLogins;

9. use Illuminate\Foundation\Auth\AuthenticatesAndRegistersUsers;

11. class AuthController extends Controller

12. {

13. /*

14. |--------------------------------------------------------------------------

15. | Contrôleur d'inscription et de connexion

16. |--------------------------------------------------------------------------

17. |

18. | Ce contrôleur gère l'enregistrement des nouveaux utilisateurs, ainsi que

19. |l'authentification des utilisateurs existants. Par défaut, ce contrôleur

20. |utilise un trait simple pour ajouter ces comportements. Pourquoi ne pas

21. |l'explorer?

22. |

23. |

24. |

25. */

27. use AuthenticatesAndRegistersUsers, ThrottlesLogins;

29. /**

30. *

31. *Créer une nouvelle instance de contrôleur d'authentification.

32. *

33. * @return void

34. */

35. public function __construct()

36. {

37. $this->middleware('guest', ['except' => 'getLogout']);

38. }

40. /**

41. * Obtenir un validateur pour une demande d'inscription entrante.

42. *

43. * @param  array  $data

44. * @return \Illuminate\Contracts\Validation\Validator

45. */

46. protected function validator(array $data)

47. {

48. return Validator::make($data, [

49. 'name' => 'required|max:255',

50. 'email' => 'required|email|max:255|unique:users',

51. 'password' => 'required|confirmed|min:6',

52. ]);

53. }

55. /**

56. * Créer une nouvelle instance d'utilisateur après une inscription valide.

57. *

58. * @param  array  $data

59. * @return User

60. */

61. protected function create(array $data)

62. {

63. return User::create([

64. 'name' => $data['name'],

65. 'email' => $data['email'],

66. 'password' => bcrypt($data['password']),

67. ]);

68. }

69. }

En fait juste un constructeur, un validateur et du code pour la création d'un utilisateur. L'essentiel du traitement est effectué dans le trait (similaire à une classe) AuthenticatesAndRegistersUsers. Comme ce trait est dans le core il est évidemment déconseillé d'aller modifier son code. Il est prévu quelques fonctionnalités concernant les URL, mais au-delà de ces possibilités, la seule solution pour adapter le code consiste à surcharger des méthodes du trait.

IV-A-1 - postLogin

J'ai choisi de surcharger cette méthode pour plusieurs raisons :

- j'ai donné la possibilité de se connecter à partir du pseudo ou de l'email ;

- je voulais vérifier que l'utilisateur avait confirmé son adresse email ;

- je voulais gérer facilement la redirection et le message d'erreur.

Ce qui donne finalement ce code :

1. public function postLogin(

2. LoginRequest $request,

3. Guard $auth)

4. {

5. $logValue = $request->input('log');

7. $logAccess = filter_var($logValue, FILTER_VALIDATE_EMAIL) ? 'email' : 'username';

9. $throttles = in_array(

10. ThrottlesLogins::class, class_uses_recursive(get_class($this))

11. );

13. if ($throttles && $this->hasTooManyLoginAttempts($request)) {

14. return redirect('/auth/login')

15. ->with('error', trans('front/login.maxattempt'))

16. ->withInput($request->only('log'));

17. }

19. $credentials = [

20. $logAccess  => $logValue,

21. 'password'  => $request->input('password')

22. ];

24. if(!$auth->validate($credentials)) {

25. if ($throttles) {

26. $this->incrementLoginAttempts($request);

27. }

29. return redirect('/auth/login')

30. ->with('error', trans('front/login.credentials'))

31. ->withInput($request->only('log'));

32. }

34. $user = $auth->getLastAttempted();

36. if($user->confirmed) {

37. if ($throttles) {

38. $this->clearLoginAttempts($request);

39. }

41. $auth->login($user, $request->has('memory'));

43. if($request->session()->has('user_id'))    {

44. $request->session()->forget('user_id');

45. }

47. return redirect('/');

48. }

50. $request->session()->put('user_id', $user->id);

52. return redirect('/auth/login')->with('error', trans('front/verify.again'));

53. }

La principale particularité réside dans la double possibilité de connexion. Pour distinguer les deux je me suis fondé sur le type d'information.

IV-A-2 - postRegister

J'ai surchargé cette méthode pour utiliser une requête de formulaire, créer un code de confirmation pour l'adresse email, flasher un message pour l'utilisateur :

1. public function postRegister(

2. RegisterRequest $request,

3. UserRepository $user_gestion)

4. {

5. $user = $user_gestion->store(

6. $request->all(),

7. $confirmation_code = str_random(30)

8. );

10. $this->dispatch(new SendMail($user));

12. return redirect('/')->with('ok', trans('front/verify.message'));

13. }

IV-B - PasswordController

Ce contrôleur est très maigre dans l'installation de base :

1. <?php

3. namespace App\Http\Controllers\Auth;

5. use App\Http\Controllers\Controller;

6. use Illuminate\Foundation\Auth\ResetsPasswords;

8. class PasswordController extends Controller

9. {

10. /*

11. |--------------------------------------------------------------------------

12. | Contrôleur de réinitialisation de mot de passe

13. |--------------------------------------------------------------------------

14. |

15. | Ce contrôleur est responsable du traitement des demandes de

16. |réinitialisation de mot de passe et utilise un trait simple pour inclure

17. |ce comportement. Vous êtes libre d'explorer ce trait et d'ignorer les

18. |méthodes que vous souhaitez modifier.    |

19. */

21. use ResetsPasswords;

23. /**

24. * Créer une nouvelle instance de contrôleur de mot de passe.

25. *

26. * @return void

27. */

28. public function __construct()

29. {

30. $this->middleware('guest');

31. }

32. }

L'essentiel du code est également dans un trait : ResetsPasswords. Le raisonnement est encore le même qu'avec le précédent contrôleur.

Pour ce contrôleur j'ai donc surchargé les principales méthodes.

IV-B-1 - postEmail

Là, je devais gérer le contenu de l'email selon la langue, pour y parvenir je suis passé par un composeur de vues. D'autre part, j'ai utilisé une requête de formulaire pour la validation :

1. public function postEmail(

2. EmailPasswordLinkRequest $request,

3. Factory $view)

4. {

5. $view->composer('emails.auth.password', function($view) {

6. $view->with([

7. 'title'   => trans('front/password.email-title'),

8. 'intro'   => trans('front/password.email-intro'),

9. 'link'    => trans('front/password.email-link'),

10. 'expire'  => trans('front/password.email-expire'),

11. 'minutes' => trans('front/password.minutes'),

12. ]);

13. });

15. $response = Password::sendResetLink($request->only('email'), function (Message $message) {

16. $message->subject(trans('front/password.reset'));

17. });

19. switch ($response) {

20. case Password::RESET_LINK_SENT:

21. return redirect()->back()->with('status', trans($response));

23. case Password::INVALID_USER:

24. return redirect()->back()->with('error', trans($response));

25. }

26. }

IV-B-2 - postReset

Ici ma seule justification est d'utiliser une requête de formulaire.

1. public function postReset(ResetPasswordRequest $request)

2. {

3. $credentials = $request->only(

4. 'email', 'password', 'password_confirmation', 'token'

5. );

7. $response = Password::reset($credentials, function($user, $password) {

8. $this->resetPassword($user, $password);

9. });

11. switch ($response) {

12. case Password::PASSWORD_RESET:

13. return redirect()->to('/')->with('ok', trans('passwords.reset'));

15. default:

16. return redirect()->back()

17. ->with('error', trans($response))

18. ->withInput($request->only('email'));

19. }

20. }

V - Les vues

C'est au niveau des vues qu'a porté le plus gros des adaptations pour obtenir un visuel bien intégré au site.

V-A - Le login

Voici le visuel :

On trouve un champ de saisie pour le pseudo ou l'email (au choix) et un autre pour le mot de passe. Il est prévu aussi une case à cocher pour la création d'un cookie pour mémoriser la connexion. D'autre part, un lien est prévu pour l'oubli du mot de passe. Dans la partie inférieure on propose une inscription.

Le code de la vue (login.blade.php) est optimisé grâce à des méthodes ajoutées au FormBuilder (je détaillerai cet aspect dans un article ultérieur) :

1. @extends('front.template')

3. @section('main')

4. <div class="row">

5. <div class="box">

6. <div class="col-lg-12">

7. @if(session()->has('error'))

8. @include('partials/error', ['type' => 'danger', 'message' => session('error')])

9. @endif

10. <hr>

11. <h2 class="intro-text text-center">{{ trans('front/login.connection') }}</h2>

12. <hr>

13. <p>{{ trans('front/login.text') }}</p>

15. {!! Form::open(['url' => 'auth/login', 'method' => 'post', 'role' => 'form']) !!}

17. <div class="row">

19. {!! Form::control('text', 6, 'log', $errors, trans('front/login.log')) !!}

20. {!! Form::control('password', 6, 'password', $errors, trans('front/login.password')) !!}

21. {!! Form::submit(trans('front/form.send'), ['col-lg-12']) !!}

22. {!! Form::check('memory', trans('front/login.remind')) !!}

23. {!! Form::text('address', '', ['class' => 'hpet']) !!}

24. <div class="col-lg-12">

25. {!! link_to('password/email', trans('front/login.forget')) !!}

26. </div>

28. </div>

30. {!! Form::close() !!}

32. <div class="text-center">

33. <hr>

34. <h2 class="intro-text text-center">{{ trans('front/login.register') }}</h2>

35. <hr>

36. <p>{{ trans('front/login.register-info') }}</p>

37. {!! link_to('auth/register', trans('front/login.registering'), ['class' => 'btn btn-default']) !!}

38. </div>

40. </div>

41. </div>

42. </div>

43. @stop

V-B - L'inscription

Voici le visuel :

Les champs de saisie sont prévus pour :

- le pseudo ;

- l'email ;

- le mot de passe ;

- la confirmation du mot de passe.

J'ai aussi prévu des bulles d'information pour faciliter la saisie :

Ici aussi le code du formulaire est simplifié avec les méthodes ajoutées (register.blade.php) :

1. @extends('front.template')

3. @section('main')

4. <div class="row">

5. <div class="box">

6. <div class="col-lg-12">

7. <hr>

8. <h2 class="intro-text text-center">{{ trans('front/register.title') }}</h2>

9. <hr>

10. <p>{{ trans('front/register.infos') }}</p>

12. {!! Form::open(['url' => 'auth/register', 'method' => 'post', 'role' => 'form']) !!}

14. <div class="row">

15. {!! Form::control('text', 6, 'username', $errors, trans('front/register.pseudo'), null, [trans('front/register.warning'), trans('front/register.warning-name')]) !!}

16. {!! Form::control('email', 6, 'email', $errors, trans('front/register.email')) !!}

17. </div>

18. <div class="row">

19. {!! Form::control('password', 6, 'password', $errors, trans('front/register.password'), null, [trans('front/register.warning'), trans('front/register.warning-password')]) !!}

20. {!! Form::control('password', 6, 'password_confirmation', $errors, trans('front/register.confirm-password')) !!}

21. </div>

22. {!! Form::text('address', '', ['class' => 'hpet']) !!}

24. <div class="row">

25. {!! Form::submit(trans('front/form.send'), ['col-lg-12']) !!}

26. </div>

28. {!! Form::close() !!}

30. </div>

31. </div>

32. </div>

33. @stop

35. @section('scripts')

37. <script>

38. $(function() { $('.badge').popover();    });

39. </script>

41. @stop

Lorsque quelqu'un s'inscrit il reçoit ce message :

En effet on lui a envoyé un email pour la confirmation de l'adresse :

Et quand on clique l'action est gérée par cette méthode du contrôleur :

1. public function getConfirm(

2. UserRepository $user_gestion,

3. $confirmation_code)

4. {

5. $user = $user_gestion->confirm($confirmation_code);

7. return redirect('/')->with('ok', trans('front/verify.success'));

8. }

Si la confirmation est bonne on obtient ce message :

V-C - L'oubli du mot de passe

Voici le visuel :

Un petit texte explicatif et un champ de saisie pour l'email. Le code est encore plus simple (password.blade.php) :

1. @extends('front.template')

3. @section('main')

4. <div class="row">

5. <div class="box">

6. <div class="col-lg-12">

7. @if(session()->has('status'))

8. @include('partials/error', ['type' => 'success', 'message' => session('status')])

9. @endif

10. @if(session()->has('error'))

11. @include('partials/error', ['type' => 'danger', 'message' => session('error')])

12. @endif

13. <hr>

14. <h2 class="intro-text text-center">{{ trans('front/password.title') }}</h2>

15. <hr>

16. <p>{{ trans('front/password.info') }}</p>

17. {!! Form::open(['url' => 'password/email', 'method' => 'post', 'role' => 'form']) !!}

19. <div class="row">

21. {!! Form::control('email', 6, 'email', $errors, trans('front/password.email')) !!}

22. {!! Form::submit(trans('front/form.send'), ['col-lg-12']) !!}

23. {!! Form::text('address', '', ['class' => 'hpet']) !!}

25. </div>

27. {!! Form::close() !!}

29. </div>

30. </div>

31. </div>

32. @stop

V-D - Le nouveau mot de passe

Voici le visuel :

Trois champs de saisie :

- l'email ;

- le mot de passe ;

- la confirmation du mot de passe.

Avec la même organisation du code (reset.blade.php) :

1. @extends('front.template')

3. @section('main')

4. <div class="row">

5. <div class="box">

6. <div class="col-lg-12">

7. @if(session()->has('error'))

8. @include('partials/error', ['type' => 'danger', 'message' => session('error')])

9. @endif

10. <hr>

11. <h2 class="intro-text text-center">{{ trans('front/password.title-reset') }}</h2>

12. <hr>

13. <p>{{ trans('front/password.reset-info') }}</p>

15. {!! Form::open(['url' => 'password/reset', 'method' => 'post', 'role' => 'form']) !!}

17. <div class="row">

19. {!! Form::hidden('token', $token) !!}

20. {!! Form::control('email', 6, 'email', $errors, trans('front/password.email')) !!}

21. {!! Form::control('password', 6, 'password', $errors, trans('front/password.password'), null, [trans('front/password.warning'), trans('front/password.warning-password')]) !!}

22. {!! Form::control('password', 6, 'password_confirmation', $errors, trans('front/password.confirm-password')) !!}

23. {!! Form::submit(trans('front/form.send'), ['col-lg-12']) !!}

25. </div>

27. {!! Form::close() !!}

29. </div>

30. </div>

31. </div>

32. @stop

34. @section('scripts')

36. <script>

37. $(function() { $('.badge').popover();   });

38. </script>

40. @stop

V-E - L'email

L'email reçu par l'utilisateur qui a oublié son mot de passe se présente ainsi :

Avec ce code (emails/auth/password.blade.php) :

1. <!DOCTYPE html>

2. <html lang="fr">

3. <head>

4. <meta charset="utf-8">

5. </head>

6. <body>

7. <h2>{{ $title }}</h2>

9. <div>

10. {!! $intro . link_to('password/reset/' . $token, $link) !!}.<br>

11. {{ $expire . config('auth.reminder.expire', 60) . $minutes}}.

12. </div>

13. </body>

14. </html>

On a ainsi fait le tour de tout ce qui concerne l'authentification pour cette application.