jorgemudry/laravel-remote-token-auth

This package provides a hassle-free way to incorporate authentication in your application by integrating with an external api.

0.5.1 2023-03-13 00:54 UTC

Requires

• php: ^8.0
• guzzlehttp/guzzle: ^7.5
• illuminate/support: ^8.0|^9.0|^10.0

Requires (Dev)

• laravel/pint: ^1.5|^1.6
• orchestra/testbench: ^6.0|^7.0|^8.0
• pestphp/pest: ^1.22
• pestphp/pest-plugin-laravel: ^1.4
• pestphp/pest-plugin-mock: ^1.0
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.0

MIT

• Jorge Mudry

• api
• auth
• laravel
• token
• stateless
• external

README

This package provides a hassle-free way to incorporate authentication in your application by integrating with an external service.

It enables the validation of tokens to verify the authenticity of users, ensuring that only valid users gain access to your system.

With this package, you can focus on developing your application's core functionalities while the authentication process is handled seamlessly.

It simplifies the integration process, allowing you to obtain a valid user in no time.

Requirements

• Laravel 8.x or higher
• PHP 8.0 or higher

Installation

You can install the package via composer:

composer require jorgemudry/laravel-remote-token-auth

The package will automatically register its service provider.

You can publish the config file with:

php artisan vendor:publish --provider="JorgeMudry\LaravelRemoteTokenAuth\Providers\LaravelRemoteTokenAuthServiceProvider"

Usage

To require authentication for a specific route, simply add the auth middleware and specify the rta guard. This will ensure that only authenticated users with a valid token can access the route.

Route::get('/users', function (Request $request) {
    return $request->user();
})->middleware('auth:rta');

Advanced Usage

Custom Adapter Implementation

To create a custom implementation of the class that calls the external API to validate the token, simply implement the AdapterInterface interface on your class. Then, bind the interface to your implementation in the register method of the AuthServiceProvider.

This will allow you to use your own implementation of the class for token validation.

<?php

namespace App\Adapters;

use JorgeMudry\LaravelRemoteTokenAuth\Contracts\AdapterInterface;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Http\Request;

class MyAdapter implements AdapterInterface
{
    public function authorize(Request $request): Authenticatable
    {
        // your custom implementation logic
    }
}

<?php

namespace App\Providers;

use App\Adapters\MyAdapter;
use JorgeMudry\LaravelRemoteTokenAuth\Contracts\AdapterInterface;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The model to policy mappings for the application.
     *
     * @var array<class-string, class-string>
     */
    protected $policies = [
        // 'App\Models\Model' => 'App\Policies\ModelPolicy',
    ];

    /**
     * Register any authentication / authorization services.
     */
    public function boot(): void
    {
    }

    /**
     * Register any application services.
     */
    public function register(): void
    {
        $this->app->bind(AdapterInterface::class, MyAdapter::class);
    }
}

Using Your Own Authenticated User Class

If you want to use your own class as the logged-in user, you can easily replace the default class with your own. To do this, your custom class must accept an array as a constructor argument and implement the Illuminate\Contracts\Auth\Authenticatable interface (an easy way to this is to extends from the Illuminate\Auth\GenericUser class).

To use your custom class, you will need to update the configuration file to point to your class instead of the default one. This way, when a user logs in, your custom class will be used to represent the user in the application.

<?php

namespace App\Auth;

use Illuminate\Auth\GenericUser;

class AuthenticatedUser extends GenericUser
{
    /**
     * Create a new generic User object.
     *
     * @param  array<string, mixed>  $attributes
     * @return void
     */
    public function __construct(array $attributes)
    {
        parent::__construct($attributes);
    }
}

<?php

declare(strict_types=1);

use App\Auth\AuthenticatedUser;

return [
    'endpoint' => 'https://remote-token-validation.service/token',
    'response' => [
        'user_path' => 'data',
        'user_class' => AuthenticatedUser::class,
    ]
];

Testing

To run the package's test suite, run the following command:

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

If you would like to contribute to the package, please see CONTRIBUTING for information on how to get started.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Jorge Mudry
• All Contributors

License

The MIT License (MIT). Please see License File for more information.