38 lines
1.5 KiB
PHP
38 lines
1.5 KiB
PHP
<?php
|
|
|
|
namespace OAuth2\OpenID\Storage;
|
|
|
|
use OAuth2\Storage\AuthorizationCodeInterface as BaseAuthorizationCodeInterface;
|
|
/**
|
|
* Implement this interface to specify where the OAuth2 Server
|
|
* should get/save authorization codes for the "Authorization Code"
|
|
* grant type
|
|
*
|
|
* @author Brent Shaffer <bshafs at gmail dot com>
|
|
*/
|
|
interface AuthorizationCodeInterface extends BaseAuthorizationCodeInterface
|
|
{
|
|
/**
|
|
* Take the provided authorization code values and store them somewhere.
|
|
*
|
|
* This function should be the storage counterpart to getAuthCode().
|
|
*
|
|
* If storage fails for some reason, we're not currently checking for
|
|
* any sort of success/failure, so you should bail out of the script
|
|
* and provide a descriptive fail message.
|
|
*
|
|
* Required for OAuth2::GRANT_TYPE_AUTH_CODE.
|
|
*
|
|
* @param $code authorization code to be stored.
|
|
* @param $client_id client identifier to be stored.
|
|
* @param $user_id user identifier to be stored.
|
|
* @param string $redirect_uri redirect URI(s) to be stored in a space-separated string.
|
|
* @param int $expires expiration to be stored as a Unix timestamp.
|
|
* @param string $scope OPTIONAL scopes to be stored in space-separated string.
|
|
* @param string $id_token OPTIONAL the OpenID Connect id_token.
|
|
*
|
|
* @ingroup oauth2_section_4
|
|
*/
|
|
public function setAuthorizationCode($code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null);
|
|
}
|