Oauth
OAuth
在"客戶端"與"服務提供商"之間,設置了一個授權層(authorization layer)
。"客戶端"不能直接登錄"服務提供商",只能登錄授權層,以此將用戶與客戶端區分開來。"客戶端"登錄授權層所用的令牌(token)
,與用戶的密碼不同。用戶可以在登錄的時候,指定授權層令牌的權限范圍和有效期。
需要用戶自行補充oauth的認證流程,方便自己更加快速的接入。
安裝
請在EasySwoole
根目錄下執行以下命令
composer require easyswoole/o-auth
詳情
根據Oauth
協議,分別有如下調用方法。
-
getAuthUrl()
獲取授權地址 -
getAccessToken($storeState = null, $state = null, $code = null)
獲取AccessToken(只返回access_token) -
getAccessTokenResult()
執行getAccessToken
方法后,此方法獲取原結果 -
getUserInfo(string $accessToken)
獲取用戶信息 -
validateAccessToken(string $accessToken)
驗證token是否有效 -
refreshToken(string $refreshToken = null)
刷新token 返回bool
-
getRefreshTokenResult()
執行refreshToken
方法后,此方法獲取原結果
示例代碼
微信
class WeiXin extends \EasySwoole\Http\AbstractInterface\Controller
{
public function index()
{
$config = new \EasySwoole\OAuth\WeiXin\Config();
$config->setAppId('appid');
$config->setState('easyswoole');
$config->setRedirectUri('redirect_uri');
$oauth = new \EasySwoole\OAuth\WeiXin\OAuth($config);
$url = $oauth->getAuthUrl();
return $this->response()->redirect($url);
}
public function callback()
{
$params = $this->request()->getQueryParams();
$config = new \EasySwoole\OAuth\WeiXin\Config();
$config->setAppId('appid');
$config->setSecret('secret');
$config->setOpenIdMode(\EasySwoole\OAuth\WeiXin\Config::OPEN_ID); // 可設置UNION_ID 默認為OPEN_ID
$oauth = new \EasySwoole\OAuth\WeiXin\OAuth($config);
$accessToken = $oauth->getAccessToken('easyswoole', $params['state'], $params['code']);
$refreshToken = $oauth->getAccessTokenResult()['refresh_token'];
$userInfo = $oauth->getUserInfo($accessToken);
var_dump($userInfo);
if (!$oauth->validateAccessToken($accessToken)) echo 'access_token 驗證失敗!' . PHP_EOL;
if (!$oauth->refreshToken($refreshToken)) echo 'access_token 續期失敗!' . PHP_EOL;
}
}
class QQ extends \EasySwoole\Http\AbstractInterface\Controller
{
public function index()
{
$config = new \EasySwoole\OAuth\QQ\Config();
$config->setAppId('appid');
$config->setState('easyswoole');
$config->setRedirectUri('redirect_uri');
$oauth = new \EasySwoole\OAuth\QQ\OAuth($config);
$url = $oauth->getAuthUrl();
return $this->response()->redirect($url);
}
public function callback()
{
$params = $this->request()->getQueryParams();
$config = new \EasySwoole\OAuth\QQ\Config();
$config->setAppId('appid');
$config->setAppKey('appkey');
$config->setRedirectUri('redirect_uri');
$config->setOpenIdMode(\EasySwoole\OAuth\QQ\Config::OPEN_ID); // 可設置UNION_ID 默認為OPEN_ID
$oauth = new \EasySwoole\OAuth\QQ\OAuth($config);
$accessToken = $oauth->getAccessToken('easyswoole', $params['state'], $params['code']);
$refreshToken = $oauth->getAccessTokenResult()['refresh_token'];
$userInfo = $oauth->getUserInfo($accessToken);
var_dump($userInfo);
if (!$oauth->validateAccessToken($accessToken)) echo 'access_token 驗證失敗!' . PHP_EOL;
if (!$oauth->refreshToken($refreshToken)) echo 'access_token 續期失敗!' . PHP_EOL;
}
}
微博
class Weibo extends \EasySwoole\Http\AbstractInterface\Controller
{
public function index()
{
$config = new \EasySwoole\OAuth\Weibo\Config();
$config->setClientId('clientid');
$config->setState('easyswoole');
$config->setRedirectUri('redirect_uri');
$oauth = new \EasySwoole\OAuth\Weibo\OAuth($config);
$url = $oauth->getAuthUrl();
return $this->response()->redirect($url);
}
public function callback()
{
$params = $this->request()->getQueryParams();
$config = new \EasySwoole\OAuth\Weibo\Config();
$config->setClientId('clientid');
$config->setClientSecret('secret');
$config->setRedirectUri('redirect_uri');
$oauth = new \EasySwoole\OAuth\Weibo\OAuth($config);
$accessToken = $oauth->getAccessToken('easyswoole', $params['state'], $params['code']);
$userInfo = $oauth->getUserInfo($accessToken);
var_dump($userInfo);
if (!$oauth->validateAccessToken($accessToken)) echo 'access_token 驗證失敗!' . PHP_EOL;
}
}
支付寶
class AliPay extends \EasySwoole\Http\AbstractInterface\Controller
{
public function index()
{
$config = new \EasySwoole\OAuth\AliPay\Config();
$config->setState('easyswoole');
$config->setAppId('appid');
$config->setRedirectUri('redirect_uri');
// 使用沙箱環境測試開發的時候 把OAuth的源碼文件里面的 API_DOMAIN 和 AUTH_DOMAIN 進行修改
$oauth = new \EasySwoole\OAuth\AliPay\OAuth($config);
$url = $oauth->getAuthUrl();
return $this->response()->redirect($url);
}
public function callback()
{
$params = $this->request()->getQueryParams();
$config = new \EasySwoole\OAuth\AliPay\Config();
$config->setAppId('appid');
// $config->setAppPrivateKey('私鑰');
$config->setAppPrivateKeyFile('私鑰文件'); // 私鑰文件(非遠程) 此方法與上個方法二選一
$oauth = new \EasySwoole\OAuth\AliPay\OAuth($config);
$accessToken = $oauth->getAccessToken('easyswoole', $params['state'], $params['auth_code']);
$refreshToken = $oauth->getAccessTokenResult()['alipay_system_oauth_token_response']['refresh_token'];
$userInfo = $oauth->getUserInfo($accessToken);
var_dump($userInfo);
if (!$oauth->validateAccessToken($accessToken)) echo 'access_token 驗證失敗!' . PHP_EOL;
var_dump($oauth->getAccessTokenResult());
if (!$oauth->refreshToken($refreshToken)) echo 'access_token 續期失敗!' . PHP_EOL;
var_dump($oauth->getRefreshTokenResult());
}
}
Github
class Github extends \EasySwoole\Http\AbstractInterface\Controller
{
public function index()
{
$config = new \EasySwoole\OAuth\Github\Config();
$config->setClientId('clientid');
$config->setRedirectUri('redirect_uri');
$config->setState('easyswoole');
$oauth = new \EasySwoole\OAuth\Github\OAuth($config);
$this->response()->redirect($oauth->getAuthUrl());
}
public function callback()
{
$params = $this->request()->getQueryParams();
$config = new \EasySwoole\OAuth\Github\Config();
$config->setClientId('clientid');
$config->setClientSecret('secret');
$config->setRedirectUri('redirect_uri');
$oauth = new \EasySwoole\OAuth\Github\OAuth($config);
$accessToken = $oauth->getAccessToken('easyswoole', $params['state'], $params['code']);
$userInfo = $oauth->getUserInfo($accessToken);
var_dump($userInfo);
if (!$oauth->validateAccessToken($accessToken)) echo 'access_token 驗證失敗!' . PHP_EOL;
}
}
Gitee
class Gitee extends \EasySwoole\Http\AbstractInterface\Controller
{
public function index()
{
$config = new \EasySwoole\OAuth\Gitee\Config();
$config->setState('easyswoole');
$config->setClientId('clientid');
$config->setRedirectUri('redirect_uri');
$oauth = new \EasySwoole\OAuth\Gitee\OAuth($config);
$this->response()->redirect($oauth->getAuthUrl());
}
public function callback()
{
$params = $this->request()->getQueryParams();
$config = new \EasySwoole\OAuth\Gitee\Config();
$config->setClientId('client_id');
$config->setClientSecret('secret');
$config->setRedirectUri('redirect_uri');
$oauth = new \EasySwoole\OAuth\Gitee\OAuth($config);
$accessToken = $oauth->getAccessToken('easyswoole', $params['state'], $params['code']);
$userInfo = $oauth->getUserInfo($accessToken);
var_dump($userInfo);
if (!$oauth->validateAccessToken($accessToken)) echo 'access_token 驗證失敗!' . PHP_EOL;
var_dump($oauth->getAccessTokenResult());
}
}