Laravel Passport通过访问令牌获取客户端ID

时间:2017-05-23 21:09:22

标签: php laravel laravel-5 laravel-passport

我正在编写一个小sms网关,供几个项目使用,

我实施了laravel护照认证(client credentials grant token

然后我将CheckClientCredentials添加到a​​pi中间件组:

protected $middlewareGroups = [
    'web' => [
       ...
    ],

    'api' => [
        'throttle:60,1',
        'bindings',
        \Laravel\Passport\Http\Middleware\CheckClientCredentials::class
    ],
];

逻辑工作正常,现在在我的控制器中我需要让客户端与有效令牌相关联。

routes.php文件

Route::post('/sms', function(Request $request) {
    // save the sms along with the client id and send it

    $client_id = ''; // get the client id somehow

    sendSms($request->text, $request->to, $client_id);
});

出于明显的安全原因,我永远不能使用消费者请求发送客户端ID,例如$client_id = $request->client_id;

9 个答案:

答案 0 :(得分:9)

有一种棘手的方法。 您可以在中间件CheckClientCredentials中修改句柄方法,只需添加此行即可。

        $request["oauth_client_id"] = $psr->getAttribute('oauth_client_id');

然后你可以在控制器的功能中获得client_id:

public function info(\Illuminate\Http\Request $request)
{
    var_dump($request->oauth_client_id);
}

答案 1 :(得分:5)

我用它来访问经过身份验证的客户端应用程序...

$bearerToken = $request->bearerToken();
$tokenId = (new \Lcobucci\JWT\Parser())->parse($bearerToken)->getHeader('jti');
$client = \Laravel\Passport\Token::find($tokenId)->client;

$client_id = $client->id;
$client_secret = $client->secret;

Source

答案 2 :(得分:3)

所以,没有答案......

我能够通过使用自己的API来解决问题,最后我想出了更简单的身份验证流程,客户端需要发送他们的身份证和身份证明。对于每个请求都是秘密,然后我使用发送的凭据使用我自己的/oauth/token路由,其灵感来自 Esben Petersen blog post

生成访问令牌后,我会将其附加到正在处理的Symfony\Request实例的标头中。

我的最终输出是这样的:

<?php

namespace App\Http\Middleware;

use Request;

use Closure;

class AddAccessTokenHeader
{
    /**
     * Octipus\ApiConsumer
     * @var ApiConsumer
     */
    private $apiConsumer;


    function __construct() {
        $this->apiConsumer  = app()->make('apiconsumer');
    }

    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $response = $this->apiConsumer->post('/oauth/token', $request->input(), [
            'content-type' => 'application/json'
        ]);


        if (!$response->isSuccessful()) {
            return response($response->getContent(), 401)
                    ->header('content-type', 'application/json');
        }

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

        $request->headers->add([
            'Authorization'     => 'Bearer ' . $response['access_token'],
            'X-Requested-With'  => 'XMLHttpRequest'
        ]);

        return $next($request);

    }
}

我将上述中间件与Passport的CheckClientCredentials结合使用。

protected $middlewareGroups = [
    'web' => [
        ...
    ],

    'api' => [
        'throttle:60,1',
        'bindings',
        \App\Http\Middleware\AddAccessTokenHeader::class,
        \Laravel\Passport\Http\Middleware\CheckClientCredentials::class
    ],
];

通过这种方式,我能够确保$request->input('client_id')是可靠的,不能伪造。

答案 3 :(得分:3)

OAuth令牌和客户端信息存储为Laravel \ Passport \ HasApiTokens特征中的受保护变量(您添加到用户模型中)。

只需在用户模型中添加一个getter方法即可公开OAuth信息:

public function get_oauth_client(){
  return $this->accessToken->client;
}

这将返回oauth_clients表的Eloquent模型

答案 4 :(得分:2)

但是答案很晚,我在提取JTI标头时遇到了一些错误 在Laravel 6.x中使用,因为JTI不再位于标头中,而不再位于有效负载/声明中。 (使用客户赠款)

local.ERROR: Requested header is not configured {"exception":"[object] (OutOfBoundsException(code: 0): Requested header is not configured at /..somewhere/vendor/lcobucci/jwt/src/Token.php:112)

此外,对我来说,将其添加到中间件中不是一种选择。当我需要在应用程序中的多个位置上使用它时。

因此,我扩展了原始的Laravel Passport客户端(oauth_clients)模型。 并检查标题和有效负载。允许传递请求或使用 请求外观,如果未传递任何请求。

<?php

namespace App\Models;

use Illuminate\Support\Facades\Request as RequestFacade;
use Illuminate\Http\Request;
use Laravel\Passport\Client;
use Laravel\Passport\Token;
use Lcobucci\JWT\Parser;

class OAuthClient extends Client
{
    public static function findByRequest(?Request $request = null) : ?OAuthClient
    {
        $bearerToken = $request !== null ? $request->bearerToken() : RequestFacade::bearerToken();

        $parsedJwt = (new Parser())->parse($bearerToken);

        if ($parsedJwt->hasHeader('jti')) {
            $tokenId = $parsedJwt->getHeader('jti');
        } elseif ($parsedJwt->hasClaim('jti')) {
            $tokenId = $parsedJwt->getClaim('jti');
        } else {
            Log::error('Invalid JWT token, Unable to find JTI header');
            return null;
        }

        $clientId = Token::find($tokenId)->client->id;

        return (new static)->findOrFail($clientId);
    }
}

现在您可以像这样在laravel应用程序中的任何位置使用它:

如果有$ request对象可用(例如,从控制器中获取)

$client = OAuthClient::findByRequest($request);

或者即使请求无法通过某种方式获得,您也可以不使用它,就像这样:

$client = OAuthClient::findByRequest();

希望这对今天面临此问题的任何人都有用。

答案 5 :(得分:2)

正如我所看到的,上面的答案很旧,最重要的是它不适用于 laravel 8 和 php 8,所以我找到了一种获取客户端的方法访问令牌的 id(当前请求)

答案基本上是制作一个中间件,并将其添加到您想要获取客户端 ID 的所有路由中。

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Nyholm\Psr7\Factory\Psr17Factory;
use Laravel\Passport\TokenRepository;
use League\OAuth2\Server\ResourceServer;
use Illuminate\Auth\AuthenticationException;
use League\OAuth2\Server\Exception\OAuthServerException;
use Symfony\Bridge\PsrHttpMessage\Factory\PsrHttpFactory;

class SetPassportClient
{

    /**
     * The Resource Server instance.
     *
     * @var \League\OAuth2\Server\ResourceServer
     */
    protected $server;

    /**
     * Token Repository.
     *
     * @var \Laravel\Passport\TokenRepository
     */
    protected $repository;

    /**
     * Create a new middleware instance.
     *
     * @param  \League\OAuth2\Server\ResourceServer  $server
     * @param  \Laravel\Passport\TokenRepository  $repository
     * @return void
     */
    public function __construct(ResourceServer $server, TokenRepository $repository)
    {
        $this->server = $server;
        $this->repository = $repository;
    }

    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle(Request $request, Closure $next)
    {
        $psr = (new PsrHttpFactory(
            new Psr17Factory,
            new Psr17Factory,
            new Psr17Factory,
            new Psr17Factory
        ))->createRequest($request);

        try {
            $psr = $this->server->validateAuthenticatedRequest($psr);
        } catch (OAuthServerException $e) {
            throw new AuthenticationException;
        }
        
        $token = $this->repository->find($psr->getAttribute('oauth_access_token_id'));

        if (!$token)
            abort(401);

        $request->merge(['passportClientId' => $token->client_id]);

        return $next($request);
    }
}

将中间件添加到 app\Http\Kernel.php

protected $routeMiddleware = [
    .
    .
    'passport.client.set' => \App\Http\Middleware\SetPassportClient::class
];

最后在路由中添加中间件

Route::middleware(['client', 'passport.client.set'])->get('/test-client-id', function (Request $request){
 dd($request->passportClientId); // this the client id
});

抱歉回答太长,但我希望所有人都清楚。

所有代码的灵感都来自 laravel CheckCredentials.php

答案 6 :(得分:1)

我挖掘了CheckClientCredentials类,并从令牌中提取了获取client_id所需的内容。 aud声明是存储client_id的地方。

<?php
    Route::middleware('client')->group(function() {
        Route::get('/client-id', function (Request $request) {
            $jwt = trim(preg_replace('/^(?:\s+)?Bearer\s/', '', $request->header('authorization')));
            $token = (new \Lcobucci\JWT\Parser())->parse($jwt);

            return ['client_id' => $token->getClaim('aud')];
        });
    });

很少有地方可以重构这些内容以便轻松访问,但这取决于您的应用程序

答案 7 :(得分:1)

在最新的实现中,您可以使用:

    use Laravel\Passport\Token;
    use Lcobucci\JWT\Configuration;
    
    $bearerToken = request()->bearerToken();
    $tokenId = Configuration::forUnsecuredSigner()->parser()->parse($bearerToken)->claims()->get('jti');
    $client = Token::find($tokenId)->client;

按照此处的建议:https://github.com/laravel/passport/issues/124#issuecomment-784731969

答案 8 :(得分:0)

public function handle($request, Closure $next, $scope)
{
    if (!empty($scope)) {
        $psr      = (new DiactorosFactory)->createRequest($request);
        $psr      = $this->server->validateAuthenticatedRequest($psr);
        $clientId = $psr->getAttribute('oauth_client_id');
        $request['oauth_client_id'] = intval($clientId);
       }

    return $next($request);
}

将上面的内容放到您的中间件文件中,然后您可以通过request()->oauth_client_id

访问client_id