Signs HTTP requests using OAuth 1.0. Requests are signed using a consumer key, consumer secret, OAuth token, and OAuth secret.
This project can be installed using Composer. Add the following to your composer.json:
{
"require": {
"guzzlehttp/oauth-subscriber": "0.1.*"
}
}
Here's an example showing how to send an authenticated request to the Twitter REST API:
use GuzzleHttp\Client;
use GuzzleHttp\Subscriber\Oauth\Oauth1;
$client = new Client(['base_url' => 'https://api.twitter.com/1.1/']);
$oauth = new Oauth1([
'consumer_key' => 'my_key',
'consumer_secret' => 'my_secret',
'token' => 'my_token',
'token_secret' => 'my_token_secret'
]);
$client->getEmitter()->attach($oauth);
// Set the "auth" request option to "oauth" to sign using oauth
$res = $client->get('statuses/home_timeline.json', ['auth' => 'oauth']);
You can set the auth
request option to oauth
for all requests sent by
the client using the client's defaults
constructor option.
use GuzzleHttp\Client;
$client = new Client([
'base_url' => 'https://api.twitter.com/1.1/',
'defaults' => ['auth' => 'oauth']
]);
$client->getEmitter()->attach($oauth);
// Now you don't need to add the auth parameter
$res = $client->get('statuses/home_timeline.json');
Note
You can omit the token and token_secret options to use two-legged OAuth.
use GuzzleHttp\Subscriber\Oauth\Oauth1;
$oauth = new Oauth1([
'consumer_key' => 'my_key',
'consumer_secret' => 'my_secret',
'private_key_file' => 'my_path_to_private_key_file',
'private_key_passphrase' => 'my_passphrase',
'signature_method' => Oauth1::SIGNATURE_METHOD_RSA,
]);