50 lines
1.3 KiB
PHP
50 lines
1.3 KiB
PHP
<?php
|
|
|
|
namespace OAuth2\Storage;
|
|
|
|
/**
|
|
* Implement this interface to specify how the OAuth2 Server
|
|
* should verify client credentials
|
|
*
|
|
* @author Brent Shaffer <bshafs at gmail dot com>
|
|
*/
|
|
interface ClientCredentialsInterface extends ClientInterface
|
|
{
|
|
|
|
/**
|
|
* Make sure that the client credentials is valid.
|
|
*
|
|
* @param $client_id
|
|
* Client identifier to be check with.
|
|
* @param $client_secret
|
|
* (optional) If a secret is required, check that they've given the right one.
|
|
*
|
|
* @return
|
|
* TRUE if the client credentials are valid, and MUST return FALSE if it isn't.
|
|
* @endcode
|
|
*
|
|
* @see http://tools.ietf.org/html/rfc6749#section-3.1
|
|
*
|
|
* @ingroup oauth2_section_3
|
|
*/
|
|
public function checkClientCredentials($client_id, $client_secret = null);
|
|
|
|
/**
|
|
* Determine if the client is a "public" client, and therefore
|
|
* does not require passing credentials for certain grant types
|
|
*
|
|
* @param $client_id
|
|
* Client identifier to be check with.
|
|
*
|
|
* @return
|
|
* TRUE if the client is public, and FALSE if it isn't.
|
|
* @endcode
|
|
*
|
|
* @see http://tools.ietf.org/html/rfc6749#section-2.3
|
|
* @see https://github.com/bshaffer/oauth2-server-php/issues/257
|
|
*
|
|
* @ingroup oauth2_section_2
|
|
*/
|
|
public function isPublicClient($client_id);
|
|
}
|