Skip to content

Added ability to restrict scopes for a client #747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Added ability to restrict scopes for a client #747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64a3848
Add ability to restrict scopes for a client
robbytaylor Jun 24, 2018
b5e0039
Updated DocBlocks
robbytaylor Jun 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/Bridge/ScopeRepository.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,26 @@

namespace Laravel\Passport\Bridge;

use Laravel\Passport\ClientRepository;
use Laravel\Passport\Passport;
use League\OAuth2\Server\Entities\ClientEntityInterface;
use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;

class ScopeRepository implements ScopeRepositoryInterface
{
/**
* @var ClientRepository
*/
protected $clients;

/**
* @param ClientRepository $clients
*/
public function __construct(ClientRepository $clients)
{
$this->clients = $clients;
}

/**
* {@inheritdoc}
*/
Expand All @@ -31,8 +45,11 @@ public function finalizeScopes(
})->values()->all();
}

return collect($scopes)->filter(function ($scope) {
return Passport::hasScope($scope->getIdentifier());
$client = $this->clients->findActive($clientEntity->getIdentifier());

return collect($scopes)->filter(function ($scope) use($client) {
return Passport::hasScope($scope->getIdentifier())
&& $client->hasScope($scope->getIdentifier());
})->values()->all();
}
}
12 changes: 12 additions & 0 deletions src/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class Client extends Model
'personal_access_client' => 'bool',
'password_client' => 'bool',
'revoked' => 'bool',
'scopes' => 'array',
];

/**
Expand All @@ -51,6 +52,17 @@ public function authCodes()
return $this->hasMany(Passport::authCodeModel(), 'client_id');
}

/**
* Determine if the client has the given scope.
*
* @param string $id
* @return bool
*/
public function hasScope($id)
{
return ! is_array($this->scopes) || empty($this->scopes) || array_key_exists($id, $this->scopes);
}

/**
* Get all of the tokens that belong to the client.
*
Expand Down
37 changes: 35 additions & 2 deletions tests/BridgeScopeRepositoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
use Laravel\Passport\Bridge\Scope;
use Laravel\Passport\Bridge\Client;
use Laravel\Passport\Bridge\ScopeRepository;
use Laravel\Passport\Client as ClientModel;
use Laravel\Passport\ClientRepository;

class BridgeScopeRepositoryTest extends TestCase
{
Expand All @@ -14,7 +16,13 @@ public function test_invalid_scopes_are_removed()
'scope-1' => 'description',
]);

$repository = new ScopeRepository;
$client = Mockery::mock(ClientModel::class);
$client->shouldReceive('hasScope')->andReturn(true);

$clients = Mockery::mock(ClientRepository::class);
$clients->shouldReceive('findActive')->withAnyArgs()->andReturn($client);

$repository = new ScopeRepository($clients);

$scopes = $repository->finalizeScopes(
[$scope1 = new Scope('scope-1'), new Scope('scope-2')], 'client_credentials', new Client('id', 'name', 'http://localhost'), 1
Expand All @@ -29,12 +37,37 @@ public function test_superuser_scope_cant_be_applied_if_wrong_grant()
'scope-1' => 'description',
]);

$repository = new ScopeRepository;
$clients = Mockery::mock(ClientRepository::class);
$clients->shouldReceive('findActive')->withAnyArgs();

$repository = new ScopeRepository($clients);

$scopes = $repository->finalizeScopes(
[$scope1 = new Scope('*')], 'client_credentials', new Client('id', 'name', 'http://localhost'), 1
);

$this->assertEquals([], $scopes);
}

public function test_scopes_which_client_cant_issue_are_removed()
{
Passport::tokensCan([
'scope-1' => 'description',
'scope-2' => 'description',
]);

$client = Mockery::mock(ClientModel::class)->makePartial();
$client->scopes = ['scope-1'];

$clients = Mockery::mock(ClientRepository::class);
$clients->shouldReceive('findActive')->withAnyArgs()->andReturn($client);

$repository = new ScopeRepository($clients);

$scopes = $repository->finalizeScopes(
[$scope1 = new Scope('scope-1')], 'client_credentials', new Client('id', 'name', 'http://localhost'), 1
);

$this->assertEquals([], $scopes);
}
}