DEV Community: Wendel Lopes

Laravel and JWT Authentication with custom model

Wendel Lopes — Sun, 17 Jul 2022 18:19:48 +0000

Before we start, this is the first article i write in english, so apologize for any mistakes.

In this article, i will show you how to implement JWT authentication (using tymon/jwt-auth package) in a Laravel api, using a different model than the default (Users). At the end, a link to the repository will be available with the content of this article.

Portuguese version: https://dev.to/wenlopes/laravel-8-e-autenticacao-jwt-tymon-jwt-auth-com-model-customizada-2l7k

So let's go!

Installation

Run this command to install the package

composer require tymon/jwt-auth

Publish the lib config file in your config folder, with the command

php artisan vendor:publish - provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

Finally, let's generate the JWT secret, running the command (This command will add JWT_SECRET env in your .env file)

php artisan jwt:secret

If you have questions about this step, this is the official link to package documentation

Model configuration

Now it's time to change our default model. For our example, let's use a Model called Employee.

For this, we gonna make a migration to create a table in our database, with same name of the Model.

php artisan make:migration create_employee_table --create=employee

Our employee migration will have the same user migration structure that comes with the Laravel installation, but it difference will be a new column called "job_title".
Feel free to add new columns, but keep the "email" and "password" columns.

Schema::create('employee', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('email')->unique();
    $table->string('password');
    $table->string('job_title');
    $table->timestamps();
});

Remove user migration and run

php artisan migrate

Create the Employee model

php artisan make:model Employee

Important: In Employee model, you may need to add the $table variable, because when we create a test user in database (a little later in this article), Laravel will try to find the table name in plural, and it will cause error. If you already created the table in plural (employees), ignore this step.

protected $table = 'employee';

The next step is to implement JWTSubject and extends Authenticatable class (Laravel) in our Model Employee. Finally, this will be our model content.

Very well, its time to configure our authentication provider. For that, you must access the config/auth.php file and add the 'employess' index in 'providers' array, containing the driver (for this example, we are using Eloquent) and its Model (employee)

Now let's set the "api" guard as our application default. In the same file, access the "defaults" array and set the default guard to "api"

We have finished our provider configuration and this should be the final content of config/auth.php.

Creating Controller and Route

It's time to create an auth controller to test our implementation

Create an controller called AuthController, with same content of this link (official documentation from the package) and create a route in your routes/api.php file

use App\Http\Controllers\AuthController;

Route::post('auth/login', [AuthController::class, 'login'])->name('auth.login');

To test our endpoint, lets create an employee in our database and use this data to authenticate

In the DatabaseSeeder file, insert this content in the run method

\App\Models\Employee::create([
    'name' => 'Usuário de teste',
    'email' => 'usuario@teste.com.br',
    'password' => bcrypt( 'senha123' ),
    'job_title' => 'Gerente administrativo'
]);

And run this command:

php artisan db:seed

Finally, use an API client (Postman, Insomnia...) and consume the api/auth/login login route, passing the email and password defined in the seeder. If everything work's fine, the result will be something like this:

So it's done! Your authentication with an custom model is working.

You can find the repository with this implementation through this link. In the repository, i'm using Docker as infra, with Nginx, Mysql and Laravel in version 8. Also, i implemented the pattern Strategy to return failed authentication messages and expired token response (in this case, a new valid token is returned).

So, that's all. If you have any questions, please comment and i will respond. Thank's for your attention.

Laravel 8 e Autenticação JWT (tymon/jwt-auth) com Model customizada

Wendel Lopes — Fri, 14 May 2021 23:16:02 +0000

Nesse artigo vou mostrar como implementar autenticação JWT (utilizando o pacote tymon/jwt-auth) em uma API com Laravel 8, utilizando uma Model diferente da padrão (Users). Ao final do texto, vou disponibilizar o link para o repositório contendo a implementação dos passos deste artigo :)

Então vamos lá!

Instalação

Execute o comando para instalar o pacote

composer require tymon/jwt-auth

Publique o arquivo de configuração da biblioteca para sua pasta config, com o comando

php artisan vendor:publish - provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

Por fim, vamos gerar o JWT secret, utilizando o comando

php artisan jwt:secret

Esse comando vai adicionar a variável JWT_SECRET no seu arquivo .env

Em caso de qualquer dúvida sobre o
processo de instalação, acesse o link oficial do pacote com instruções para a instalação.

Configuração da Model

Como dito anteriormente, vamos utilizar uma Model diferente da Users para armazenar os dados de usuários. Em nosso caso, vamos criar uma nova Model chamada Employee.

Para isso, vamos criar uma migration para criar uma tabela no nosso banco de dados com o mesmo nome da Model:

php artisan make:migration create_employee_table --create=employee

Nossa migration vai ter a mesma estrutura da migration de users que vem como padrão na instalação do Laravel, onde a única diferença será um campo a mais chamado "job_title". Fique a vontade para adicionar novas colunas, mas certifique-se que as colunas "email" e "password" serão criadas.

Schema::create('employee', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('email')->unique();
    $table->string('password');
    $table->string('job_title');
    $table->timestamps();
});

Remova a migration para criação da tabela de users e rode as migrations

php artisan migrate

Crie a Model Employee

php artisan make:model Employee

Obs: Adicione a variável $table na model, para passar o nome da tabela no singular, pois no momento de realizar a criação de usuário de teste (um pouco mais a frente nesse mesmo artigo), o Laravel vai por padrão tentar localizar a tabela no plural e vai ocasionar erro. Se você criou a tabela no plural (employees), pule o passo abaixo

protected $table = 'employee';

Após a criação de nossa Model, vamos implementar a classe JWTSubject, implementando seus métodos. Além disso, vamos extender a classe Authenticatable do Laravel. No final, esse será o conteúdo de nossa Model

Muito bem, agora que temos nossa Model devidamente criada e configurada, é hora de configurarmos nosso provider de autenticação. Para isso, acesse o arquivo config/auth.php e vamos adicionar o novo índice 'employess' no array 'providers', contendo o driver (em nosso caso, vamos utilizar o Eloquent) e a model desejada.

Em seguida, no mesmo arquivo, vamos acessar o array "guards" e no array "api", vamos setar o driver "jwt" e o provider "employees" que acabamos de criar.

Por fim, vamos setar o guard "api" como o padrão de nossa aplicação. No mesmo arquivo, acesse o array "defaults" e defina o guard padrão como "api"

Feito isso, concluímos a configuração do nosso provider e o conteúdo final do arquivo config/auth.php será esse

Criando o controller e rota

Muito bem, agora que criamos e configuramos nossa Model, vamos criar o controller de autenticação para testar nossa implementação.

Crie o controller AuthController, com o mesmo conteúdo apresentado nesse link do site oficial do pacote e em seguida, crie a rota para realizar o login no arquivo routes/api.php

Obs: Não se esqueça que a partir da versão 8 do Laravel, o controller deve ser importado no arquivo de rotas

use App\Http\Controllers\AuthController;

Route::post('auth/login', [AuthController::class, 'login'])->name('auth.login');

Para testar nosso endpoint, vamos criar um registro na tabela employee e utilizar os dados para autenticar.

No arquivo DatabaseSeeder , insira o seguinte conteúdo dentro do método run:

\App\Models\Employee::create([
    'name' => 'Usuário de teste',
    'email' => 'usuario@teste.com.br',
    'password' => bcrypt( 'senha123' ),
    'job_title' => 'Gerente administrativo'
]);

E na sequência execute o comando:

php artisan db:seed

Por fim, utilize seu API client de preferência e consuma a rota de login api/auth/login, informando o email e senha criado na seeder. Se tudo ocorreu bem, o resultado será como o abaixo:

E pronto, sua autenticação com model customizada está funcionando.

Como disse anteriormente, você pode baixar o projeto com essa implementação através do meu repositório no Github (link abaixo). Nesse repositório, estou utilizando Docker para infraestrutura, contendo Nginx, Mysql e o Laravel em sua versão 8. Além disso, implementei o pattern Strategy para retornar mensagens em casos de erro de autenticação e/ou token expirado, onde no segundo caso, um novo token atualizado é retornado (estou preparando um novo artigo para abordar esse tema :).

Clique aqui e acesse o repositório

Então é isso pessoal, em caso de dúvidas, deixe nos comentários. Obrigado e até a próxima