我们如何在Laravel中实现仅自定义API的自定义身份验证

问题描述 投票:0回答:1

这不是一个非常需要答案的问题,但是欢迎进一步的建议以及答案和建议。我想与世界分享我如何解决此问题,希望对其他人有帮助。

Laravel附带了一些预先设计的身份验证解决方案,您可以使用一些手工艺的命令来启动它们。这些包括:

  • 标准用户表认证
  • OAuth2(通过Laravel Passport软件包)
  • 基于社交媒体的身份验证(通过Laravel Socialite软件包)

[在所有这些有用的功能中,在当今的微服务时代,Laravel并没有为仅API身份验证提供开箱即用的引导程序。

几个月前我遇到了这个问题,我在Google和Stackoverflow上搜索了答案。我找到了有用的文章(在我的评论中进行了描述),这些文章有助于指明道路,但最后我不得不从第一条原则中学习如何做自己。

提供答案是希望对其他人和我自己有帮助,将来我必须再次做同样的事情。

假设和范围:

  • 您已经创建了自己的API,例如https://example.com/loginhttps://example.com/logout
  • 您正在运行一个需要身份验证的网站,但不需要通过模型和表格或社交媒体进行身份验证
  • 您的API管理与表的交互,包括用户登录/注销
php laravel api authentication
1个回答
0
投票

该解决方案涉及七个PHP文件

  • app / Http / Controllers / HomeController.php-主页控制器;经过身份验证的用户的目的地
  • app / Providers / ApiUserProvider.php-用于引导和注册登录用户的自定义提供程序,并实现Illuminate \ Contracts \ Auth \ UserProvider接口
  • app / CoreExtensions / SessionGuardExtended.php-用于登录用户并接收身份验证值并将其存储在会话数组中的自定义保护控制器;扩展类Illuminate \ Auth \ SessionGuard
  • app / ApiUser-如果您使用的是OAuth2(Laravel的Passport);公开OAuth access_token的自定义用户类;扩展Illuminate \ Auth \ GenericUser并实现接口Illuminate \ Contracts \ Auth \ Authenticatable
  • config / auth.php-指示Auth()外观返回自定义会话防护的auth配置
  • app / Providers / AuthServiceProvider.php-身份验证引导程序
  • app / Providers / AppServiceProvider.php-主应用程序引导程序

引用源研究/调查材料供您自己调查并了解其存在的背景。我没有声称自己是一个天才,他通过我自己的魔力从零开始创造了解决方案,但是,像所有创新者一样,我是在别人的努力下建立的。我文章的独特卖点是,我提供了完整的打包解决方案,而引用的资源则为整体答案的小众部分提供了解决方案。经过多次尝试和错误,他们一起帮助我形成了一个完整的解决方案。

未对以下内容进行任何代码修改,但包含这些内容是为了承认它们在此过程中所扮演的角色及其重要性:

  • 供应商/laravel/framework/src/Illuminate/Auth/AuthManager.php-主要授权工厂经理
  • Auth()门面-默认情况下返回收缩包装的Illuminate \ Auth \ SessionGuard类实例,除非通过config / auth.php文件指示进行其他操作-整个Laravel代码中普遍使用Auth()来检索会话守卫

代码

app / Http / Controllers / HomeController.php

<?php
namespace App\Http\Controllers;

use Illuminate\Http\Request;

/**
 * Handles and manages the home-page
 * 
 * @category controllers
 */
class HomeController extends Controller
{
    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');
    }

    public function index()
    {
        blah
    }

    ... other methods ... 

}

app / Providers / ApiUserProvider.php

来源:

<?php
namespace App\Providers;

use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Contracts\Auth\Authenticatable as UserContract;
use App\ApiUser;

/**
 * Delegates API user login and authentication
 * 
 * @category providers
 */
class ApiUserProvider implements UserProvider //ServiceProvider
{

    /**
     * Custom API Handler 
     * Used to request API and capture responses
     * 
     * @var \App\Custom\Api\Handler 
     */
    private $_oApiHandler = null;

    /**
     * POST request to API
     * 
     * @param string  $p_url      Endpoint URL
     * @param array   $p_arrParam Parameters
     * @param boolean $p_isOAuth2 Is OAuth2 authenticated request? [Optional, Default=True]
     * 
     * @return array
     */
    private function _post(string $p_url, array $p_arrParam, bool $p_isOAuth2=true)
    {
        if (!$this->_oApiHandler) {
            $this->_oApiHandler = new \Path\To\Your\Internal\Api\Handler();
        }
        $arrResponse = $this->_oApiHandler->post($p_url, $p_arrParam, $p_isOAuth2);
        return $arrResponse;
    }

    /**
     * GET request to API
     * 
     * @param string $p_url     Endpoint URL
     * @param array $p_arrParam Parameters [Optional, Default = array()]
     * 
     * @return array
     */
    private function _get(string $p_url, array $p_arrParam=[], bool $p_isOAuth2=true)
    {   
        if (!$this->_oApiHandler) {
            $this->_oApiHandler = new \Path\To\Your\Internal\Api\Handler();
        }
        $arrResponse = $this->_oApiHandler->get($p_url, $p_arrParam);
        return $arrResponse;
    }

    /**
     * Retrieve a user by the given credentials.
     *
     * @param array $p_arrCredentials
     * 
     * @return \Illuminate\Contracts\Auth\Authenticatable|null
     */
    public function retrieveByCredentials(array $p_arrCredentials)
    {
        $arrResponse = $this->_post('user/login', $p_arrCredentials, false);
        if ( $arrResponse['result'] ) {
            $arrPayload = array_merge(
                $arrResponse['data'],
                $p_arrCredentials
            );
            return $this->getApiUser($arrPayload);
        }
    }

    /**
     * Retrieve a user by their unique identifier.
     *
     * @param mixed $p_identifier
     * 
     * @return \Illuminate\Contracts\Auth\Authenticatable|null
     */
    public function retrieveById($p_identifier)
    {
        $arrResponse = $this->_get("user/id/{$p_identifier}");        
        if ( $arrResponse['result'] ) {
            return $this->getApiUser($arrResponse['data']);
        }
    }

    /**
     * Validate a user against the given credentials.
     *
     * @param \Illuminate\Contracts\Auth\Authenticatable $p_oUser
     * @param array                                      $p_arrCredentials
     * 
     * @return bool
     */
    public function validateCredentials(UserContract $p_oUser, array $p_arrCredentials)
    {
        return $p_oUser->getAuthPassword() == $p_arrCredentials['password'];
    }

    /**
     * Get the api user.
     *
     * @param mixed $p_user
     * 
     * @return \App\Auth\ApiUser|null
     */
    protected function getApiUser($p_user)
    {
        if ($p_user !== null) {
            return new ApiUser($p_user);
        }
        return null;
    }

    protected function getUserById($id)
    {
        $user = [];

        foreach ($this->getUsers() as $item) {
            if ($item['account_id'] == $id) {
                $user = $item;

                break;
            }
        }

        return $user ?: null;
    }

    protected function getUserByUsername($username)
    {
        $user = [];

        foreach ($this->getUsers() as $item) {
            if ($item['email_address'] == $username) {
                $user = $item;

                break;
            }
        }

        return $user ?: null;
    }


    /**
     * The methods below need to be defined because of the Authenticatable contract
     * but need no implementation for 'Auth::attempt' to work and can be implemented
     * if you need their functionality
     */
    public function retrieveByToken($identifier, $token) { }
    public function updateRememberToken(UserContract $user, $token) { }

}

app / CoreExtensions / SessionGuardExtended.php

来源:

<?php
namespace App\CoreExtensions;

use Illuminate\Auth\SessionGuard;
use Illuminate\Contracts\Auth\Authenticatable;

/**
 * Extended SessionGuard() functionality 
 * Provides added functionality to store the OAuth tokens in the session for later use
 * 
 * @category guards
 * 
 * @see https://stackoverflow.com/questions/36087061/extending-laravel-5-2-sessionguard
 */
class SessionGuardExtended extends SessionGuard
{

    /**
     * Log a user into the application.
     *
     * @param  \Illuminate\Contracts\Auth\Authenticatable  $p_oUser
     * @param  bool  $p_remember
     * @return void
     */
    public function login(Authenticatable $p_oUser, $p_remember = false)
    {

        parent::login($p_oUser, $p_remember);

        /**
         * Writing the OAuth tokens to the session
         */
        $key = 'authtokens';
        $this->session->put(
            $key, 
            [
                'access_token' => $p_oUser->getAccessToken(),
                'refresh_token' => $p_oUser->getRefreshToken(),
            ]
        );
    }

    /**
     * Log the user out of the application.
     *
     * @return void
     */
    public function logout()
    {
        parent::logout();

        /**
         * Deleting the OAuth tokens from the session
         */
        $this->session->forget('authtokens');        
    }

}

app / ApiUser

来源:

<?php
namespace App;

use Illuminate\Auth\GenericUser;
use Illuminate\Contracts\Auth\Authenticatable as UserContract;

class ApiUser extends GenericUser implements UserContract
{

    /**
     * Returns the OAuth access_token
     * 
     * @return mixed
     */
    public function getAccessToken()
    {
        return $this->attributes['access_token'];
    }


    public function getRefreshToken()
    {
        return $this->attributes['refresh_token'];
    }

}

app / Providers / AuthServiceProvider.php

<?php
namespace App\Providers;

use Illuminate\Support\Facades\Auth;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{

    /**
     * Register any authentication / authorization services.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        Auth::provider('frank_sinatra', function ($app, array $config) {
            // Return an instance of Illuminate\Contracts\Auth\UserProvider...

            return new ApiUserProvider();
        });

    }
}

app / Providers / AppServiceProvider.php

来源:

注意:

关于此PHP文件中的编码更改,存在一些细微的问题。如果您想了解更多,请查看vendor / laravel / framework / src / Illuminate / Auth / AuthManager.php,尤其是AuthManager :: resolve()。

  1. 对config / auth.php'会话'和'令牌'的引用由硬编码方法AuthManager :: createSessionDriver()和AuthManager :: createTokenDriver()提供(如果您知道在应用程序中扩展AuthManager.php的方法,请告诉我)
  2. AppServiceProvider.php进行了抢救!可以在AppServiceProvider :: boot()中注册自定义防护,并在执行默认代码之前对其进行拦截。
  3. 我对上面的第2点没问题,但是我们不能做些聪明的事情,例如从AppServiceProvider返回自定义会话防护名称或实例,在特殊的公共方法中使用setCookieJar(),setDispatcher(),setRequest()。在AuthManager.php中创建自定义会话防护之后,可以将AuthManager.php挂接到AppServiceProvider.php或由config / auth.php驱动执行吗?
  4. 没有Cookie或会话,不会通过重定向保留用户的身份。解决此问题的唯一方法是在当前解决方案的AppServiceProvider中包含setCookieJar(),setDispatcher()和setRequest()。
<?php
namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Auth;
use App\CoreExtensions\SessionGuardExtended;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        //
    }

    /**
     * Bootstrap any application services.
     * 
     * @see https://stackoverflow.com/questions/36087061/extending-laravel-5-2-sessionguard
     *
     * @return void
     */
    public function boot()
    {

        /**
         * Extending Illuminate\Auth\SessionGuard()
         * This is so we can store the OAuth tokens in the session
         */
        Auth::extend(
            'sessionExtended',
            function ($app) {

                $guard = new SessionGuardExtended(
                    'sessionExtended', 
                    new ApiUserProvider(), 
                    app()->make('session.store'),
                    request()
                );

                // When using the remember me functionality of the authentication services we
                // will need to be set the encryption instance of the guard, which allows
                // secure, encrypted cookie values to get generated for those cookies.
                if (method_exists($guard, 'setCookieJar')) {
                    $guard->setCookieJar($this->app['cookie']);
                }

                if (method_exists($guard, 'setDispatcher')) {
                    $guard->setDispatcher($this->app['events']);
                }

                if (method_exists($guard, 'setRequest')) {
                    $guard->setRequest($this->app->refresh('request', $guard, 'setRequest'));
                }

                return $guard;
            }
        );
    }
}

config / auth.php

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Authentication Defaults
    |--------------------------------------------------------------------------
    |
    | This option controls the default authentication "guard" and password
    | reset options for your application. You may change these defaults
    | as required, but they're a perfect start for most applications.
    |
    */

    'defaults' => [
        //'guard' => 'web', /** This refers to the settings under ['guards']['web'] */
        'guard' => 'webextended', /** This refers to the settings under ['guards']['webextended'] */
        'passwords' => 'users', /** This refers to the settings under ['passwords']['users'] */
    ],

    /*
    |--------------------------------------------------------------------------
    | Authentication Guards
    |--------------------------------------------------------------------------
    |
    | Next, you may define every authentication guard for your application.
    | Of course, a great default configuration has been defined for you
    | here which uses session storage and the Eloquent user provider.
    |
    | All authentication drivers have a user provider. This defines how the
    | users are actually retrieved out of your database or other storage
    | mechanisms used by this application to persist your user's data.
    |
    | Supported: "session", "token"
    |
    */

    'guards' => [
        'web' => [
            'driver' => 'session', /** This refers to Illuminate/Auth/SessionGuard */
            'provider' => 'users', /** This refers to the settings under ['providers']['users'] */
        ],

        'webextended' => [
            'driver' => 'sessionExtended', /** @see app/Providers/AppServiceProvider::boot() */
            'provider' => 'users', /** This refers to the settings under ['providers']['users'] */
        ],

        'api' => [
            'driver' => 'token', /** This refers to Illuminate/Auth/TokenGuard */
            'provider' => 'users',
            'hash' => false,
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | User Providers
    |--------------------------------------------------------------------------
    |
    | All authentication drivers have a user provider. This defines how the
    | users are actually retrieved out of your database or other storage
    | mechanisms used by this application to persist your user's data.
    |
    | If you have multiple user tables or models you may configure multiple
    | sources which represent each model / table. These sources may then
    | be assigned to any extra authentication guards you have defined.
    |
    | Supported: "database", "eloquent"
    |
    */

    'providers' => [
        'users' => [
            'driver' => 'frank_sinatra',  /** @see app/Providers/AuthServiceProvider::boot() */
            //'model' => App\User::class,
        ],

        // 'users' => [
        //     'driver' => 'database',
        //     'table' => 'users',
        // ],
    ],

    [
        blah
    ],

    [
        other settings
    ],

];

如何使用此解决方案

非常简单。整体方法没有变化。换句话说,我们使用Auth()门面。

使用自定义API /login?username=<username>&password=<password>登录时>

request()->flash();
$arrData = request()->all();

if ( Auth::attempt($arrData, true) ) {
    return redirect('home');
} else  {
    return back()->withErrors(
        [
            'username' => "Those credentials can't be found",
            'password' => "Those credentials can't be found",
        ]
    );
}

使用自定义API /logout注销时>

Auth::logout();
return redirect('home');
© www.soinside.com 2019 - 2024. All rights reserved.