dchapkine/guzzle-http-signature

There is no license information available for the latest version (dev-master) of this package.

Guzzle plugin to sign HTTP requests using hmac ... Or, in another words, it is a PHP 5.3+ port of https://github.com/joyent/node-http-signature library (the request signing part only)

dev-master 2012-11-24 07:01 UTC

Requires

• guzzle/guzzle: *

Unknown License

• Dmitri Chapkine

README

Guzzle Http Signature Plugin is a PHP 5.3 port of node-http-signature module. It allows you to easily sign http headers using signature authentication scheme.

Note that It only implements the client part (signature creation), and DOES NOT implement the server part (signature parser & validation).

Please read http_signing.md for more information. about the "signature authentication scheme" used here.

Supported algorithms

Curently, only 'hmac-sha1', 'hmac-sha256', 'hmac-sha512' algorithms are supported.

Getting started (via Composer)

The recommended way to install guzzle-http-signature is through Composer.

1. Add following dependencies in your project's composer.json file, then install it using php composer.phar install cmd:

   {
   	"require": {
   		"guzzle/guzzle": "2.*",
   		"dchapkine/guzzle-http-signature": "dev-master"
   	}
   }

2. Use it

   <?php
   
   require_once 'vendor/autoload.php';
   
   use Guzzle\Http\Client;
   use Guzzle\Http\Exception\ClientErrorResponseException;
   use Guzzle\Http\Exception\BadResponseException;
   use GuzzleHttpSignature\HttpSignaturePlugin;
   use Guzzle\Http\Exception\CurlException;
   
   
   
   //
   // request config
   //
   $requestUrl = 'https://api.domain.tld/jobs/44';
   $requestMethod = 'POST';
   $requestData = array("some" => array("custom" => array("data")));
   $requestHeaders = array('content-md5' => md5(http_build_query($requestData)));
   
   
   //
   // signature config
   //
   $keyId = "Test";			// your key id
   $key = "secret";			// your private key
   $algorithm = "hmac-sha512";	// algorithm: hmac-sha1, hmac-sha256, hmac-sha512
   $headersToSign = array(		// headers we want to include into signature
   	"date",
   	"content-md5"
   );
   
   
   //
   // sending request
   //
   try
   {
   	$plugin = new HttpSignaturePlugin(array(
   		'keyId' => $keyId,
   		'key' => $key,
   		'algorithm' => $algorithm,
   		'headers' => $headersToSign
   	));
   	
   	$client = new Client();
   	$client->addSubscriber($plugin);
   	$req = $client->createRequest($requestMethod, $requestUrl, $requestHeaders, $requestData);
   	$response = $req->send();
   }
   catch (ClientErrorResponseException $e)
   // guzzle throws ClientErrorResponseException when error http codes are sent (401, 500, ...)
   {
   	$response = $e->getResponse();
   }
   catch (CurlException $e)
   // the api provider is probably down or there is an issue with connection
   {
   	$msg = $e->getMessage();
   }
   
   
   //
   // print response
   //
   header('Content-Type: text');
   if (isset($response))
   	echo "\n" . $response->getStatusCode() . "\n" . $response->getBody(true) . "\n";
   else
   	echo $msg."\n";
   

Links

@see https://github.com/joyent/node-http-signature/blob/master/http_signing.md

@see http://joyent.com/blog/a-bit-more-about-the-new-joyent-cloud-api/