\OAuth2\StorageClientCredentialsInterface

Implement this interface to specify how the OAuth2 Server should verify client credentials

Summary

Methods
Constants
getClientDetails()
getClientScope()
checkRestrictedGrantType()
checkClientCredentials()
isPublicClient()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getClientDetails()

getClientDetails(  $client_id) : array

Get client details corresponding client_id.

OAuth says we should store request URIs for each registered client. Implement this function to grab the stored URI for a given client id.

Parameters

$client_id

Client identifier to be check with.

Returns

array —

Client details. The only mandatory key in the array is "redirect_uri". This function MUST return FALSE if the given client does not exist or is invalid. "redirect_uri" can be space-delimited to allow for multiple valid uris. return array( "redirect_uri" => REDIRECT_URI, // REQUIRED redirect_uri registered for the client "client_id" => CLIENT_ID, // OPTIONAL the client id "grant_types" => GRANT_TYPES, // OPTIONAL an array of restricted grant types "user_id" => USER_ID, // OPTIONAL the user identifier associated with this client "scope" => SCOPE, // OPTIONAL the scopes allowed for this client );

getClientScope()

getClientScope(  $client_id) : STRING

Get the scope associated with this client

Parameters

$client_id

Returns

STRING —

the space-delineated scope list for the specified client_id

checkRestrictedGrantType()

checkRestrictedGrantType(  $client_id,   $grant_type) : TRUE

Check restricted grant types of corresponding client identifier.

If you want to restrict clients to certain grant types, override this function.

Parameters

$client_id

Client identifier to be check with.

$grant_type

Grant type to be check with

Returns

TRUE —

if the grant type is supported by this client identifier, and FALSE if it isn't.

checkClientCredentials()

checkClientCredentials(  $client_id,   $client_secret = null) : TRUE

Make sure that the client credentials is valid.

Parameters

$client_id

Client identifier to be check with.

$client_secret

(optional) If a secret is required, check that they've given the right one.

Returns

TRUE —

if the client credentials are valid, and MUST return FALSE if it isn't.

isPublicClient()

isPublicClient(  $client_id) : TRUE

Determine if the client is a "public" client, and therefore does not require passing credentials for certain grant types

Parameters

$client_id

Client identifier to be check with.

Returns

TRUE —

if the client is public, and FALSE if it isn't.