/lib/Zend/Gdata/HttpClient.php
PHP | 240 lines | 74 code | 18 blank | 148 comment | 11 complexity | 4778b2abd38c286c2432a8e1bc49aa66 MD5 | raw file
Possible License(s): GPL-2.0
- <?php
- /**
- * Zend Framework
- *
- * LICENSE
- *
- * This source file is subject to the new BSD license that is bundled
- * with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://framework.zend.com/license/new-bsd
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@zend.com so we can send you a copy immediately.
- *
- * @category Zend
- * @package Zend_Gdata
- * @subpackage Gdata
- * @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
- * @license http://framework.zend.com/license/new-bsd New BSD License
- */
- /**
- * Zend_Http_Client
- */
- #require_once 'Zend/Http/Client.php';
- /**
- * Gdata Http Client object.
- *
- * Class to extend the generic Zend Http Client with the ability to perform
- * secure AuthSub requests
- *
- * @category Zend
- * @package Zend_Gdata
- * @subpackage Gdata
- * @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
- * @license http://framework.zend.com/license/new-bsd New BSD License
- */
- class Zend_Gdata_HttpClient extends Zend_Http_Client
- {
- /**
- * OpenSSL private key resource id
- * This key is used for AuthSub authentication. If this value is set,
- * it is assuemd that secure AuthSub is desired.
- *
- * @var resource
- */
- private $_authSubPrivateKeyId = null;
- /**
- * Token for AuthSub authentication.
- * If this token is set, AuthSub authentication is used.
- *
- * @var string
- */
- private $_authSubToken = null;
- /**
- * Token for ClientLogin authentication.
- * If only this token is set, ClientLogin authentication is used.
- *
- * @var string
- */
- private $_clientLoginToken = null;
- /**
- * Token for ClientLogin authentication.
- * If this token is set, and the AuthSub key is not set,
- * ClientLogin authentication is used
- *
- * @var string
- */
- private $_clientLoginKey = null;
- /**
- * Sets the PEM formatted private key, as read from a file.
- *
- * This method reads the file and then calls setAuthSubPrivateKey()
- * with the file contents.
- *
- * @param string $file The location of the file containing the PEM key
- * @param string $passphrase The optional private key passphrase
- * @param bool $useIncludePath Whether to search the include_path
- * for the file
- * @return void
- */
- public function setAuthSubPrivateKeyFile($file, $passphrase = null,
- $useIncludePath = false) {
- $fp = fopen($file, "r", $useIncludePath);
- $key = '';
- while (!feof($fp)) {
- $key .= fread($fp, 8192);
- }
- $this->setAuthSubPrivateKey($key, $passphrase);
- fclose($fp);
- }
- /**
- * Sets the PEM formatted private key to be used for secure AuthSub auth.
- *
- * In order to call this method, openssl must be enabled in your PHP
- * installation. Otherwise, a Zend_Gdata_App_InvalidArgumentException
- * will be thrown.
- *
- * @param string $key The private key
- * @param string $passphrase The optional private key passphrase
- * @throws Zend_Gdata_App_InvalidArgumentException
- * @return Zend_Gdata_HttpClient Provides a fluent interface
- */
- public function setAuthSubPrivateKey($key, $passphrase = null) {
- if ($key != null && !function_exists('openssl_pkey_get_private')) {
- #require_once 'Zend/Gdata/App/InvalidArgumentException.php';
- throw new Zend_Gdata_App_InvalidArgumentException(
- 'You cannot enable secure AuthSub if the openssl module ' .
- 'is not enabled in your PHP installation.');
- }
- $this->_authSubPrivateKeyId = openssl_pkey_get_private(
- $key, $passphrase);
- return $this;
- }
- /**
- * Gets the openssl private key id
- *
- * @return string The private key
- */
- public function getAuthSubPrivateKeyId() {
- return $this->_authSubPrivateKeyId;
- }
- /**
- * Gets the AuthSub token used for authentication
- *
- * @return string The token
- */
- public function getAuthSubToken() {
- return $this->_authSubToken;
- }
- /**
- * Sets the AuthSub token used for authentication
- *
- * @param string $token The token
- * @return Zend_Gdata_HttpClient Provides a fluent interface
- */
- public function setAuthSubToken($token) {
- $this->_authSubToken = $token;
- return $this;
- }
- /**
- * Gets the ClientLogin token used for authentication
- *
- * @return string The token
- */
- public function getClientLoginToken() {
- return $this->_clientLoginToken;
- }
- /**
- * Sets the ClientLogin token used for authentication
- *
- * @param string $token The token
- * @return Zend_Gdata_HttpClient Provides a fluent interface
- */
- public function setClientLoginToken($token) {
- $this->_clientLoginToken = $token;
- return $this;
- }
- /**
- * Filters the HTTP requests being sent to add the Authorization header.
- *
- * If both AuthSub and ClientLogin tokens are set,
- * AuthSub takes precedence. If an AuthSub key is set, then
- * secure AuthSub authentication is used, and the request is signed.
- * Requests must be signed only with the private key corresponding to the
- * public key registered with Google. If an AuthSub key is set, but
- * openssl support is not enabled in the PHP installation, an exception is
- * thrown.
- *
- * @param string $method The HTTP method
- * @param string $url The URL
- * @param array $headers An associate array of headers to be
- * sent with the request or null
- * @param string $body The body of the request or null
- * @param string $contentType The MIME content type of the body or null
- * @throws Zend_Gdata_App_Exception if there was a signing failure
- * @return array The processed values in an associative array,
- * using the same names as the params
- */
- public function filterHttpRequest($method, $url, $headers = array(), $body = null, $contentType = null) {
- if ($this->getAuthSubToken() != null) {
- // AuthSub authentication
- if ($this->getAuthSubPrivateKeyId() != null) {
- // secure AuthSub
- $time = time();
- $nonce = mt_rand(0, 999999999);
- $dataToSign = $method . ' ' . $url . ' ' . $time . ' ' . $nonce;
- // compute signature
- $pKeyId = $this->getAuthSubPrivateKeyId();
- $signSuccess = openssl_sign($dataToSign, $signature, $pKeyId,
- OPENSSL_ALGO_SHA1);
- if (!$signSuccess) {
- #require_once 'Zend/Gdata/App/Exception.php';
- throw new Zend_Gdata_App_Exception(
- 'openssl_signing failure - returned false');
- }
- // encode signature
- $encodedSignature = base64_encode($signature);
- // final header
- $headers['authorization'] = 'AuthSub token="' . $this->getAuthSubToken() . '" ' .
- 'data="' . $dataToSign . '" ' .
- 'sig="' . $encodedSignature . '" ' .
- 'sigalg="rsa-sha1"';
- } else {
- // AuthSub without secure tokens
- $headers['authorization'] = 'AuthSub token="' . $this->getAuthSubToken() . '"';
- }
- } elseif ($this->getClientLoginToken() != null) {
- $headers['authorization'] = 'GoogleLogin auth=' . $this->getClientLoginToken();
- }
- return array('method' => $method, 'url' => $url, 'body' => $body, 'headers' => $headers, 'contentType' => $contentType);
- }
- /**
- * Method for filtering the HTTP response, though no filtering is
- * currently done.
- *
- * @param Zend_Http_Response $response The response object to filter
- * @return Zend_Http_Response The filterd response object
- */
- public function filterHttpResponse($response) {
- return $response;
- }
- }