kamermans / guzzle4-oauth2-subscriber
v1.0
2017-04-14 04:26 UTC
Requires
- php: >=5.4.0
- ext-json: *
- guzzlehttp/guzzle: >=4.0 <6.0
This package is auto-updated.
Last update: 2022-02-01 12:38:04 UTC
README
为 Guzzle 4.x 和 5.x 提供 OAuth2 订阅者。
署名
此插件基于 Bojan Zivanovic 和 Damien Tournoud 的 Guzzle 3.x OAuth2 插件,该插件位于 CommerceGuys guzzle-oauth2-plugin 存储库。
我最初是那个项目的分支,但由于代码大部分已更改,我需要将版本重置为 < 1.0,所以我迁移到了一个新的存储库。
功能
- 通过支持的一种授权类型(代码、客户端凭证、用户凭证、刷新令牌)获取访问令牌。或者您也可以自己设置访问令牌。
- 支持刷新令牌(存储并使用它们获取新的访问令牌)。
- 处理令牌过期(获取新的令牌并重试失败的请求)。
- 允许通过回调存储和查找访问令牌
用法
此插件扩展 Guzzle,透明地添加认证到发出的请求,并在访问令牌不再有效时可选地尝试重新授权。
有几个可用的授权类型,如 PasswordCredentials
、ClientCredentials
和 AuthorizationCode
。
访问令牌方法
如果您已经有一个访问令牌,您可以使用它来对服务进行身份验证,但请注意访问令牌是有期限的,获取新的访问令牌的过程也包含在这个库中(例如,通过使用 PasswordCredentials
方法)。
以下是使用现有访问令牌进行请求的方法,因此不需要重新授权客户端
use kamermans\GuzzleOAuth2\OAuth2Subscriber; // Setup OAuth $oauth = new OAuth2Subscriber(); // Manually specify access_token. When it expires, you will get an exception $oauth->getTokenData()->accessToken = 'somelongtoken'; $client = new GuzzleHttp\Client(); // Attach OAuth subscriber to the Guzzle client and all URLs will be authenticated $client->getEmitter()->attach($oauth); $response = $client->get('http://somehost/some_secure_url'); echo "Status: ".$response->getStatusCode()."\n";
客户端凭证方法
客户端凭证通常用于服务器到服务器的身份验证。使用此授权类型,客户端代表自己请求授权,因此只有两方参与。至少需要一个 client_id
和 client_secret
,尽管许多服务需要 scope
和其他参数。
以下是客户端凭证方法的示例
use kamermans\GuzzleOAuth2\GrantType\ClientCredentials; use kamermans\GuzzleOAuth2\OAuth2Subscriber; // Authorization client - this is used to request OAuth access tokens $reauth_client = new GuzzleHttp\Client([ // URL for access_token request 'base_url' => 'http://some_host/access_token_request_url', ]); $reauth_config = [ "client_id" => "your client id", "client_secret" => "your client secret", "scope" => "your scope(s)", // optional "state" => time(), // optional ]; $grant_type = new ClientCredentials($reauth_client, $reauth_config); $oauth = new OAuth2Subscriber($grant_type); // This is the normal Guzzle client that you use in your application $client = new GuzzleHttp\Client(); $client->getEmitter()->attach($oauth); $response = $client->get('http://somehost/some_secure_url'); echo "Status: ".$response->getStatusCode()."\n";