web-dev-qa-db-ja.com

トークン応答のカスタマイズLaravelパスポート

私は現在APIに取り組んでおり、レンガの壁にぶつかりました。 Passportを「パスワード」付与タイプで使用しています。

ユーザー情報をアクセストークンと共に返したいのですが、方法がわかりません。

これを得るために、実装、編集、または拡張できるクラスはどれですか。

これを返却してください:

{
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token": "lalalalalal",
    "refresh_token": "lalalallala",
    "user": {
        "username": "a username",
        "user_type": "admin"
    }
}

前もって感謝します。

17
Irvin Chan

これを行う方法の説明は、 BearerTokenResponse クラス(league/oauth2-serverパッケージの一部)に示唆されています。

Laravel 5.7。

1。 BearerTokenResponseクラスを拡張し、必要な追加のパラメーターを応答に追加します

_namespace App\Auth;

use League\OAuth2\Server\Entities\AccessTokenEntityInterface;

class BearerTokenResponse extends \League\OAuth2\Server\ResponseTypes\BearerTokenResponse
{
    /**
     * Add custom fields to your Bearer Token response here, then override
     * AuthorizationServer::getResponseType() to pull in your version of
     * this class rather than the default.
     *
     * @param AccessTokenEntityInterface $accessToken
     *
     * @return array
     */
    protected function getExtraParams(AccessTokenEntityInterface $accessToken): array
    {
        return [
            'user_id' => $this->accessToken->getUserIdentifier(),
        ];
    }
}
_

2。独自のPassportServiceProviderクラスを作成し、独自のBearerTokenResponseクラスを渡すためにmakeAuthorizationServer()メソッドをオーバーライドします。

_namespace App\Providers;

use App\Auth\BearerTokenResponse;
use Laravel\Passport\Bridge;
use League\OAuth2\Server\AuthorizationServer;

class PassportServiceProvider extends \Laravel\Passport\PassportServiceProvider
{
    /**
     * Make the authorization service instance.
     *
     * @return \League\OAuth2\Server\AuthorizationServer
     */
    public function makeAuthorizationServer()
    {
        return new AuthorizationServer(
            $this->app->make(Bridge\ClientRepository::class),
            $this->app->make(Bridge\AccessTokenRepository::class),
            $this->app->make(Bridge\ScopeRepository::class),
            $this->makeCryptKey('private'),
            app('encrypter')->getKey(),
            new BearerTokenResponse() // <-- The class you created above
        );
    }
}
_

3。 _config/app.php_のプロバイダー配列にプロバイダーを追加します。

_    /*
     * Application Service Providers...
     */
    App\Providers\PassportServiceProvider::class,
_

4。パスポートパッケージをlaravel auto-discovery in _composer.json_から除外する

これにより、デフォルトのPassportServiceProviderクラスのロードが停止します。

_    "extra": {
        "laravel": {
            "dont-discover": [
                "laravel/passport"
            ]
        }
    },
_

次に_composer install_を実行します。

13
escapisam

2つのステップ。

1ルートファイルに新しいルートを追加します。

// routes/api.php

Route::post('oauth/token', 'AuthController@auth');

これにより、トークンを取得するためのルートが/oauth/tokenから/api/oauth/tokenに変更されることに注意してください。

2コントローラーメソッドを追加します。

<?php
// app/Http/Controllers/AuthController.php

namespace App\Http\Controllers;

use App\User;
use Psr\Http\Message\ServerRequestInterface;
use \Laravel\Passport\Http\Controllers\AccessTokenController;

class AuthController extends AccessTokenController
{
    public function auth(ServerRequestInterface $request)
    {
            $tokenResponse = parent::issueToken($request);
            $token = $tokenResponse->getContent();

            // $tokenInfo will contain the usual Laravel Passort token response.
            $tokenInfo = json_decode($token, true);

            // Then we just add the user to the response before returning it.
            $username = $request->getParsedBody()['username'];
            $user = User::whereEmail($username)->first();
            $tokenInfo = collect($tokenInfo);
            $tokenInfo->put('user', $user);

            return $tokenInfo;
    }
}
4
Albert Cloete

ウェブからの別のより良い答え

カスタムLaravel Passport BearerTokenResponse

https://Gist.github.com/messi89/489473c053e3ea8d9e034b0032effb1d

2
cyberfly

私は パスポートを使用したマルチ認証 を使用しているため、以前の回答は役に立ちませんでした。

何時間も「グーグル」した後、私はこの答えを見つけました (after-)ミドルウェア

私のミドルウェアは基本的にPassport authの結果を取得し、内部にBearerがあるかどうかを確認し、コンテンツにデータを追加します。

<?php

namespace App\Http\Middleware;

use Closure;

class AppendTokenResponse
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {

        $response =  $next($request);

        $content = json_decode($response->content(), true);

        if (!empty($content['access_token'])) {

            $content['moredata'] = 'some data';

            $response->setContent($content);

        }

        return $response;
    }
}

新しいミドルウェアを$ routemiddlewareのApp/Http/Kernel.phpに配置します。

 /**
     * The application's route middleware.
     *
     * These middleware may be assigned to groups or used individually.
     *
     * @var array
     */
    protected $routeMiddleware = [
        'auth' => \App\Http\Middleware\Authenticate::class,
        'cors' => \App\Http\Middleware\Cors::class,
        'multiauth' => \SMartins\PassportMultiauth\Http\Middleware\MultiAuthenticate::class,
        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
        'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
        'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
        'can' => \Illuminate\Auth\Middleware\Authorize::class,
        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
        'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
        'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
        'oauth.providers' => \SMartins\PassportMultiauth\Http\Middleware\AddCustomProvider::class,
        'append_auth' =>\App\Http\Middleware\AppendTokenResponse::class,

    ];

次に、このミドルウェアをProviders/AuthServiceProvider.phpのPassport Routesに登録するだけです

Multiauthの場合:

Route::group(['middleware' => ['oauth.providers','append_auth']], function () {
    Passport::routes(function ($router) {
        return $router->forAccessTokens();
    });
});

私は通常のパスポートはテストされるべきではないと信じています:

Route::group(['middleware' => ['append_auth']], function () {
    Passport::routes();
});
0
Leo Nogueira

Passportトークンにカスタムクレームを追加するには、Passport 8とLaravel 6

https://Gist.github.com/onamfc/0422da15743918e653888441ba6226ca