From a88c8ee41ca40c91b612cc87103a871bc640afc9 Mon Sep 17 00:00:00 2001 From: Dmitriy Akulov Date: Fri, 11 Jul 2014 03:04:09 +0300 Subject: [PATCH] Initial push --- .gitignore | 2 + LICENSE | 20 ++ README.md | 64 +++++ composer.json | 22 ++ src/MaxCDN.php | 116 ++++++++ src/MaxCDN/OAuth/OAuthConsumer.php | 21 ++ src/MaxCDN/OAuth/OAuthDataStore.php | 29 ++ src/MaxCDN/OAuth/OAuthException.php | 10 + src/MaxCDN/OAuth/OAuthRequest.php | 263 ++++++++++++++++++ src/MaxCDN/OAuth/OAuthServer.php | 226 +++++++++++++++ src/MaxCDN/OAuth/OAuthSignatureMethod.php | 56 ++++ .../OAuth/OAuthSignatureMethod_HMAC_SHA1.php | 31 +++ .../OAuth/OAuthSignatureMethod_PLAINTEXT.php | 37 +++ .../OAuth/OAuthSignatureMethod_RSA_SHA1.php | 70 +++++ src/MaxCDN/OAuth/OAuthToken.php | 36 +++ src/MaxCDN/OAuth/OAuthUtil.php | 154 ++++++++++ src/MaxCDN/RWSException.php | 18 ++ tests/README.md | 5 + tests/sampleclient.php | 11 + 19 files changed, 1191 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 composer.json create mode 100644 src/MaxCDN.php create mode 100644 src/MaxCDN/OAuth/OAuthConsumer.php create mode 100644 src/MaxCDN/OAuth/OAuthDataStore.php create mode 100644 src/MaxCDN/OAuth/OAuthException.php create mode 100644 src/MaxCDN/OAuth/OAuthRequest.php create mode 100644 src/MaxCDN/OAuth/OAuthServer.php create mode 100644 src/MaxCDN/OAuth/OAuthSignatureMethod.php create mode 100644 src/MaxCDN/OAuth/OAuthSignatureMethod_HMAC_SHA1.php create mode 100644 src/MaxCDN/OAuth/OAuthSignatureMethod_PLAINTEXT.php create mode 100644 src/MaxCDN/OAuth/OAuthSignatureMethod_RSA_SHA1.php create mode 100644 src/MaxCDN/OAuth/OAuthToken.php create mode 100644 src/MaxCDN/OAuth/OAuthUtil.php create mode 100644 src/MaxCDN/RWSException.php create mode 100644 tests/README.md create mode 100644 tests/sampleclient.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e01942f --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +composer.phar +vendor diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..01ddd0c --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2013 MaxCDN, LLC. + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0986d38 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# MaxCDN REST API PHP Client + +## Requirements +- PHP 5.3 or above +- PHP Curl Extension + +## Installation with Composer +Composer is the recommended way to utilize the MaxCDN RWS SDK PHP library. For more information on how to use Composer, see http://www.getcomposer.org . + +1. Add "MaxCDN/rws-sdk-php" as a dependency in your composer.json project file. + +```json +{ + "require": { + "MaxCDN/rws-sdk-php": "2.*" + } +} +``` + +2. Download and install Composer (if not already installed). + +```bash +curl -sS https://getcomposer.org/installer | php +``` + +3. Install your package dependencies. + +```bash +php composer.phar install -o +``` + +This will download the MaxCDN library and configure composer to use it. Composer will also build an autoloader for your use in the next step. + +4. Use Composer's autoloader. + +Composer prepares an autoload file which autoloads the RWS library for you on demand. To use it, provide the following at the top of your PHP source files: + +```php +require_once '/path/to/vendor/autoload.php'; +``` + +It is advised that you understand how to optimze Composer's usage in Production environments. For more information about Composer, visit http://getcomposer.org + +The libraries are located in the src/ directory. The classes are organized in a PSR-0 hierarchy. You can use any PSR-0 compliant autoloader for this library. Composer is the recommended method (see above). + +## Usage +```php +get('/account.json'); + +// delete a file from the cache +$params = array('file' => '/robots.txt'); +echo $api->delete('/zones/pull.json/6055/cache', $params); + +?> +``` + +## Methods + +It has support for `GET`, `POST`, `PUT` and `DELETE` OAuth signed requests. diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..90a9868 --- /dev/null +++ b/composer.json @@ -0,0 +1,22 @@ +{ + "name": "maxcdn/php-maxcdn", + "description": "PHP Wrapper for MaxCDN Remote Web Services", + "type": "library", + "license": "MIT", + "homepage": "http://docs.maxcdn.com", + "support": { + "email": "support@maxcdn.com", + "source": "http://www.github.com/MaxCDN/php-maxcdn" + }, + "require": { + "php": ">=5.3.0", + "ext-curl": "*" + }, + "autoload": { + "psr-0": { + "MaxCDN\\": "src/", + "": "src/" + } + } + +} diff --git a/src/MaxCDN.php b/src/MaxCDN.php new file mode 100644 index 0000000..73a88c4 --- /dev/null +++ b/src/MaxCDN.php @@ -0,0 +1,116 @@ +alias = $alias; + $this->key = $key; + $this->secret = $secret; + $this->consumer = new \MaxCDN\OAuth\OAuthConsumer($key, $secret, NULL); + + } + + private function execute($selected_call, $method_type, $params) { + // the endpoint for your request + $endpoint = "$this->MaxCDNrws_url/$this->alias$selected_call"; + + //parse endpoint before creating OAuth request + $parsed = parse_url($endpoint); + if (array_key_exists("parsed", $parsed)) + { + parse_str($parsed['query'], $params); + } + + //generate a request from your consumer + $req_req = \MaxCDN\OAuth\OAuthRequest::from_consumer_and_token($this->consumer, NULL, $method_type, $endpoint, $params); + + //sign your OAuth request using hmac_sha1 + $sig_method = new \MaxCDN\OAuth\OAuthSignatureMethod_HMAC_SHA1(); + $req_req->sign_request($sig_method, $this->consumer, NULL); + + // create curl resource + $ch = curl_init(); + + // set url + curl_setopt($ch, CURLOPT_URL, $req_req); + + //return the transfer as a string + curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); + curl_setopt($ch, CURLOPT_SSL_VERIFYPEER , FALSE); + + // set curl timeout + curl_setopt($ch, CURLOPT_TIMEOUT, 60); + + // set curl custom request type if not standard + if ($method_type != "GET" && $method_type != "POST") { + curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method_type); + } + + + if ($method_type == "POST" || $method_type == "PUT" || $method_type == "DELETE") { + $query_str = \MaxCDN\OAuth\OAuthUtil::build_http_query($params); + curl_setopt($ch, CURLOPT_HTTPHEADER, array('Expect:', 'Content-Length: ' . strlen($query_str))); + curl_setopt($ch, CURLOPT_POSTFIELDS, $query_str); + } + + // retrieve headers + curl_setopt($ch, CURLOPT_HEADER, 1); + curl_setopt($ch, CURLINFO_HEADER_OUT, 1); + + //set user agent + curl_setopt($ch, CURLOPT_USERAGENT, 'PHP MaxCDN API Client'); + + // make call + $result = curl_exec($ch); + $headers = curl_getinfo($ch); + $curl_error = curl_error($ch); + + // close curl resource to free up system resources + curl_close($ch); + + // $json_output contains the output string + $json_output = substr($result, $headers['header_size']); + + // catch errors + if(!empty($curl_error) || empty($json_output)) { + throw new \MaxCDN\RWSException("CURL ERROR: $curl_error, Output: $json_output", $headers['http_code'], null, $headers); + } + + return $json_output; + } + + public function get($selected_call, $params = array()){ + + return $this->execute($selected_call, 'GET', $params); + } + + public function post($selected_call, $params = array()){ + return $this->execute($selected_call, 'POST', $params); + } + + public function put($selected_call, $params = array()){ + return $this->execute($selected_call, 'PUT', $params); + } + + public function delete($selected_call, $params = array()){ + return $this->execute($selected_call, 'DELETE', $params); + } + + +} diff --git a/src/MaxCDN/OAuth/OAuthConsumer.php b/src/MaxCDN/OAuth/OAuthConsumer.php new file mode 100644 index 0000000..b016369 --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthConsumer.php @@ -0,0 +1,21 @@ +key = $key; + $this->secret = $secret; + $this->callback_url = $callback_url; + } + + function __toString() { + return "\\MaxCDN\\OAuth\\OAuthConsumer[key=$this->key,secret=$this->secret]"; + } +} + diff --git a/src/MaxCDN/OAuth/OAuthDataStore.php b/src/MaxCDN/OAuth/OAuthDataStore.php new file mode 100644 index 0000000..c3fb037 --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthDataStore.php @@ -0,0 +1,29 @@ +parameters = $parameters; + $this->http_method = $http_method; + $this->http_url = $http_url; + } + + + /** + * attempt to build up a request from what was passed to the server + */ + public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) { + $scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on") + ? 'http' + : 'https'; + $http_url = ($http_url) ? $http_url : $scheme . + '://' . $_SERVER['SERVER_NAME'] . + ':' . + $_SERVER['SERVER_PORT'] . + $_SERVER['REQUEST_URI']; + $http_method = ($http_method) ? $http_method : $_SERVER['REQUEST_METHOD']; + + // We weren't handed any parameters, so let's find the ones relevant to + // this request. + // If you run XML-RPC or similar you should use this to provide your own + // parsed parameter-list + if (!$parameters) { + // Find request headers + $request_headers = OAuthUtil::get_headers(); + + // Parse the query-string to find GET parameters + $parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']); + + // It's a POST request of the proper content-type, so parse POST + // parameters and add those overriding any duplicates from GET + if ($http_method == "POST" + && isset($request_headers['Content-Type']) + && strstr($request_headers['Content-Type'], + 'application/x-www-form-urlencoded') + ) { + $post_data = OAuthUtil::parse_parameters( + file_get_contents(self::$POST_INPUT) + ); + $parameters = array_merge($parameters, $post_data); + } + + // We have a Authorization-header with OAuth data. Parse the header + // and add those overriding any duplicates from GET or POST + if (isset($request_headers['Authorization']) && substr($request_headers['Authorization'], 0, 6) == 'OAuth ') { + $header_parameters = OAuthUtil::split_header( + $request_headers['Authorization'] + ); + $parameters = array_merge($parameters, $header_parameters); + } + + } + + return new OAuthRequest($http_method, $http_url, $parameters); + } + + /** + * pretty much a helper function to set up the request + */ + public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) { + $parameters = ($parameters) ? $parameters : array(); + $defaults = array("oauth_version" => OAuthRequest::$version, + "oauth_nonce" => OAuthRequest::generate_nonce(), + "oauth_timestamp" => OAuthRequest::generate_timestamp(), + "oauth_consumer_key" => $consumer->key); + if ($token) + $defaults['oauth_token'] = $token->key; + + $parameters = array_merge($defaults, $parameters); + + return new OAuthRequest($http_method, $http_url, $parameters); + } + + public function set_parameter($name, $value, $allow_duplicates = true) { + if ($allow_duplicates && isset($this->parameters[$name])) { + // We have already added parameter(s) with this name, so add to the list + if (is_scalar($this->parameters[$name])) { + // This is the first duplicate, so transform scalar (string) + // into an array so we can add the duplicates + $this->parameters[$name] = array($this->parameters[$name]); + } + + $this->parameters[$name][] = $value; + } else { + $this->parameters[$name] = $value; + } + } + + public function get_parameter($name) { + return isset($this->parameters[$name]) ? $this->parameters[$name] : null; + } + + public function get_parameters() { + return $this->parameters; + } + + public function unset_parameter($name) { + unset($this->parameters[$name]); + } + + /** + * The request parameters, sorted and concatenated into a normalized string. + * @return string + */ + public function get_signable_parameters() { + // Grab all parameters + $params = $this->parameters; + + // Remove oauth_signature if present + // Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.") + if (isset($params['oauth_signature'])) { + unset($params['oauth_signature']); + } + + return OAuthUtil::build_http_query($params); + } + + /** + * Returns the base string of this request + * + * The base string defined as the method, the url + * and the parameters (normalized), each urlencoded + * and the concated with &. + */ + public function get_signature_base_string() { + $parts = array( + $this->get_normalized_http_method(), + $this->get_normalized_http_url(), + $this->get_signable_parameters() + ); + + $parts = OAuthUtil::urlencode_rfc3986($parts); + + return implode('&', $parts); + } + + /** + * just uppercases the http method + */ + public function get_normalized_http_method() { + return strtoupper($this->http_method); + } + + /** + * parses the url and rebuilds it to be + * scheme://host/path + */ + public function get_normalized_http_url() { + $parts = parse_url($this->http_url); + + $scheme = (isset($parts['scheme'])) ? $parts['scheme'] : 'http'; + $port = (isset($parts['port'])) ? $parts['port'] : (($scheme == 'https') ? '443' : '80'); + $host = (isset($parts['host'])) ? strtolower($parts['host']) : ''; + $path = (isset($parts['path'])) ? $parts['path'] : ''; + + if (($scheme == 'https' && $port != '443') + || ($scheme == 'http' && $port != '80')) { + $host = "$host:$port"; + } + return "$scheme://$host$path"; + } + + /** + * builds a url usable for a GET request + */ + public function to_url() { + $post_data = $this->to_postdata(); + $out = $this->get_normalized_http_url(); + if ($post_data) { + $out .= '?'.$post_data; + } + return $out; + } + + /** + * builds the data one would send in a POST request + */ + public function to_postdata() { + return OAuthUtil::build_http_query($this->parameters); + } + + /** + * builds the Authorization: header + */ + public function to_header($realm=null) { + $first = true; + if($realm) { + $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"'; + $first = false; + } else + $out = 'Authorization: OAuth'; + + $total = array(); + foreach ($this->parameters as $k => $v) { + if (substr($k, 0, 5) != "oauth") continue; + if (is_array($v)) { + throw new OAuthException('Arrays not supported in headers'); + } + $out .= ($first) ? ' ' : ','; + $out .= OAuthUtil::urlencode_rfc3986($k) . + '="' . + OAuthUtil::urlencode_rfc3986($v) . + '"'; + $first = false; + } + return $out; + } + + public function __toString() { + return $this->to_url(); + } + + + public function sign_request($signature_method, $consumer, $token) { + $this->set_parameter( + "oauth_signature_method", + $signature_method->get_name(), + false + ); + $signature = $this->build_signature($signature_method, $consumer, $token); + $this->set_parameter("oauth_signature", $signature, false); + } + + public function build_signature($signature_method, $consumer, $token) { + $signature = $signature_method->build_signature($this, $consumer, $token); + return $signature; + } + + /** + * util function: current timestamp + */ + private static function generate_timestamp() { + return time(); + } + + /** + * util function: current nonce + */ + private static function generate_nonce() { + $mt = microtime(); + $rand = mt_rand(); + + return md5($mt . $rand); // md5s look nicer than numbers + } +} + diff --git a/src/MaxCDN/OAuth/OAuthServer.php b/src/MaxCDN/OAuth/OAuthServer.php new file mode 100644 index 0000000..9379c33 --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthServer.php @@ -0,0 +1,226 @@ +data_store = $data_store; + } + + public function add_signature_method($signature_method) { + $this->signature_methods[$signature_method->get_name()] = + $signature_method; + } + + // high level functions + + /** + * process a request_token request + * returns the request token on success + */ + public function fetch_request_token(&$request) { + $this->get_version($request); + + $consumer = $this->get_consumer($request); + + // no token required for the initial token request + $token = NULL; + + $this->check_signature($request, $consumer, $token); + + // Rev A change + $callback = $request->get_parameter('oauth_callback'); + $new_token = $this->data_store->new_request_token($consumer, $callback); + + return $new_token; + } + + /** + * process an access_token request + * returns the access token on success + */ + public function fetch_access_token(&$request) { + $this->get_version($request); + + $consumer = $this->get_consumer($request); + + // requires authorized request token + $token = $this->get_token($request, $consumer, "request"); + + $this->check_signature($request, $consumer, $token); + + // Rev A change + $verifier = $request->get_parameter('oauth_verifier'); + $new_token = $this->data_store->new_access_token($token, $consumer, $verifier); + + return $new_token; + } + + /** + * verify an api call, checks all the parameters + */ + public function verify_request(&$request) { + $this->get_version($request); + $consumer = $this->get_consumer($request); + $token = $this->get_token($request, $consumer, "access"); + $this->check_signature($request, $consumer, $token); + return array($consumer, $token); + } + + // Internals from here + /** + * version 1 + */ + private function get_version(&$request) { + $version = $request->get_parameter("oauth_version"); + if (!$version) { + // Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present. + // Chapter 7.0 ("Accessing Protected Ressources") + $version = '1.0'; + } + if ($version !== $this->version) { + throw new OAuthException("OAuth version '$version' not supported"); + } + return $version; + } + + /** + * figure out the signature with some defaults + */ + private function get_signature_method($request) { + $signature_method = $request instanceof OAuthRequest + ? $request->get_parameter("oauth_signature_method") + : NULL; + + if (!$signature_method) { + // According to chapter 7 ("Accessing Protected Ressources") the signature-method + // parameter is required, and we can't just fallback to PLAINTEXT + throw new OAuthException('No signature method parameter. This parameter is required'); + } + + if (!in_array($signature_method, + array_keys($this->signature_methods))) { + throw new OAuthException( + "Signature method '$signature_method' not supported " . + "try one of the following: " . + implode(", ", array_keys($this->signature_methods)) + ); + } + return $this->signature_methods[$signature_method]; + } + + /** + * try to find the consumer for the provided request's consumer key + */ + private function get_consumer($request) { + $consumer_key = $request instanceof OAuthRequest + ? $request->get_parameter("oauth_consumer_key") + : NULL; + + if (!$consumer_key) { + throw new OAuthException("Invalid consumer key"); + } + + $consumer = $this->data_store->lookup_consumer($consumer_key); + if (!$consumer) { + throw new OAuthException("Invalid consumer"); + } + + return $consumer; + } + + /** + * try to find the token for the provided request's token key + */ + private function get_token($request, $consumer, $token_type="access") { + $token_field = $request instanceof OAuthRequest + ? $request->get_parameter('oauth_token') + : NULL; + + $token = $this->data_store->lookup_token( + $consumer, $token_type, $token_field + ); + if (!$token) { + throw new OAuthException("Invalid $token_type token: $token_field"); + } + return $token; + } + + /** + * all-in-one function to check the signature on a request + * should guess the signature method appropriately + */ + private function check_signature($request, $consumer, $token) { + // this should probably be in a different method + $timestamp = $request instanceof OAuthRequest + ? $request->get_parameter('oauth_timestamp') + : NULL; + $nonce = $request instanceof OAuthRequest + ? $request->get_parameter('oauth_nonce') + : NULL; + + $this->check_timestamp($timestamp); + $this->check_nonce($consumer, $token, $nonce, $timestamp); + + $signature_method = $this->get_signature_method($request); + + $signature = $request->get_parameter('oauth_signature'); + $valid_sig = $signature_method->check_signature( + $request, + $consumer, + $token, + $signature + ); + + if (!$valid_sig) { + throw new OAuthException("Invalid signature"); + } + } + + /** + * check that the timestamp is new enough + */ + private function check_timestamp($timestamp) { + if( ! $timestamp ) + throw new OAuthException( + 'Missing timestamp parameter. The parameter is required' + ); + + // verify that timestamp is recentish + $now = time(); + if (abs($now - $timestamp) > $this->timestamp_threshold) { + throw new OAuthException( + "Expired timestamp, yours $timestamp, ours $now" + ); + } + } + + /** + * check that the nonce is not repeated + */ + private function check_nonce($consumer, $token, $nonce, $timestamp) { + if( ! $nonce ) + throw new OAuthException( + 'Missing nonce parameter. The parameter is required' + ); + + // verify that the nonce is uniqueish + $found = $this->data_store->lookup_nonce( + $consumer, + $token, + $nonce, + $timestamp + ); + if ($found) { + throw new OAuthException("Nonce already used: $nonce"); + } + } + +} + + diff --git a/src/MaxCDN/OAuth/OAuthSignatureMethod.php b/src/MaxCDN/OAuth/OAuthSignatureMethod.php new file mode 100644 index 0000000..da905ff --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthSignatureMethod.php @@ -0,0 +1,56 @@ +build_signature($request, $consumer, $token); + + // Check for zero length, although unlikely here + if (strlen($built) == 0 || strlen($signature) == 0) { + return false; + } + + if (strlen($built) != strlen($signature)) { + return false; + } + + // Avoid a timing leak with a (hopefully) time insensitive compare + $result = 0; + for ($i = 0; $i < strlen($signature); $i++) { + $result |= ord($built{$i}) ^ ord($signature{$i}); + } + + return $result == 0; + } +} + diff --git a/src/MaxCDN/OAuth/OAuthSignatureMethod_HMAC_SHA1.php b/src/MaxCDN/OAuth/OAuthSignatureMethod_HMAC_SHA1.php new file mode 100644 index 0000000..5f413cc --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthSignatureMethod_HMAC_SHA1.php @@ -0,0 +1,31 @@ +get_signature_base_string(); + $request->base_string = $base_string; + + $key_parts = array( + $consumer->secret, + ($token) ? $token->secret : "" + ); + + $key_parts = OAuthUtil::urlencode_rfc3986($key_parts); + $key = implode('&', $key_parts); + + return base64_encode(hash_hmac('sha1', $base_string, $key, true)); + } +} + diff --git a/src/MaxCDN/OAuth/OAuthSignatureMethod_PLAINTEXT.php b/src/MaxCDN/OAuth/OAuthSignatureMethod_PLAINTEXT.php new file mode 100644 index 0000000..41e1232 --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthSignatureMethod_PLAINTEXT.php @@ -0,0 +1,37 @@ +secret, + ($token) ? $token->secret : "" + ); + + $key_parts = OAuthUtil::urlencode_rfc3986($key_parts); + $key = implode('&', $key_parts); + $request->base_string = $key; + + return $key; + } +} + diff --git a/src/MaxCDN/OAuth/OAuthSignatureMethod_RSA_SHA1.php b/src/MaxCDN/OAuth/OAuthSignatureMethod_RSA_SHA1.php new file mode 100644 index 0000000..ddd7bf9 --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthSignatureMethod_RSA_SHA1.php @@ -0,0 +1,70 @@ +get_signature_base_string(); + $request->base_string = $base_string; + + // Fetch the private key cert based on the request + $cert = $this->fetch_private_cert($request); + + // Pull the private key ID from the certificate + $privatekeyid = openssl_get_privatekey($cert); + + // Sign using the key + $ok = openssl_sign($base_string, $signature, $privatekeyid); + + // Release the key resource + openssl_free_key($privatekeyid); + + return base64_encode($signature); + } + + public function check_signature($request, $consumer, $token, $signature) { + $decoded_sig = base64_decode($signature); + + $base_string = $request->get_signature_base_string(); + + // Fetch the public key cert based on the request + $cert = $this->fetch_public_cert($request); + + // Pull the public key ID from the certificate + $publickeyid = openssl_get_publickey($cert); + + // Check the computed signature against the one passed in the query + $ok = openssl_verify($base_string, $decoded_sig, $publickeyid); + + // Release the key resource + openssl_free_key($publickeyid); + + return $ok == 1; + } +} + diff --git a/src/MaxCDN/OAuth/OAuthToken.php b/src/MaxCDN/OAuth/OAuthToken.php new file mode 100644 index 0000000..4c852eb --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthToken.php @@ -0,0 +1,36 @@ +key = $key; + $this->secret = $secret; + } + + /** + * generates the basic string serialization of a token that a server + * would respond to request_token and access_token calls with + */ + function to_string() { + return "oauth_token=" . + OAuthUtil::urlencode_rfc3986($this->key) . + "&oauth_token_secret=" . + OAuthUtil::urlencode_rfc3986($this->secret); + } + + function __toString() { + return $this->to_string(); + } +} + diff --git a/src/MaxCDN/OAuth/OAuthUtil.php b/src/MaxCDN/OAuth/OAuthUtil.php new file mode 100644 index 0000000..ac0dff6 --- /dev/null +++ b/src/MaxCDN/OAuth/OAuthUtil.php @@ -0,0 +1,154 @@ + $h) { + $params[$h] = OAuthUtil::urldecode_rfc3986(empty($matches[3][$i]) ? $matches[4][$i] : $matches[3][$i]); + } + if (isset($params['realm'])) { + unset($params['realm']); + } + } + return $params; + } + + // helper to try to sort out headers for people who aren't running apache + public static function get_headers() { + if (function_exists('apache_request_headers')) { + // we need this to get the actual Authorization: header + // because apache tends to tell us it doesn't exist + $headers = apache_request_headers(); + + // sanitize the output of apache_request_headers because + // we always want the keys to be Cased-Like-This and arh() + // returns the headers in the same case as they are in the + // request + $out = array(); + foreach ($headers AS $key => $value) { + $key = str_replace( + " ", + "-", + ucwords(strtolower(str_replace("-", " ", $key))) + ); + $out[$key] = $value; + } + } else { + // otherwise we don't have apache and are just going to have to hope + // that $_SERVER actually contains what we need + $out = array(); + if( isset($_SERVER['CONTENT_TYPE']) ) + $out['Content-Type'] = $_SERVER['CONTENT_TYPE']; + if( isset($_ENV['CONTENT_TYPE']) ) + $out['Content-Type'] = $_ENV['CONTENT_TYPE']; + + foreach ($_SERVER as $key => $value) { + if (substr($key, 0, 5) == "HTTP_") { + // this is chaos, basically it is just there to capitalize the first + // letter of every word that is not an initial HTTP and strip HTTP + // code from przemek + $key = str_replace( + " ", + "-", + ucwords(strtolower(str_replace("_", " ", substr($key, 5)))) + ); + $out[$key] = $value; + } + } + } + return $out; + } + + // This function takes a input like a=b&a=c&d=e and returns the parsed + // parameters like this + // array('a' => array('b','c'), 'd' => 'e') + public static function parse_parameters( $input ) { + if (!isset($input) || !$input) return array(); + + $pairs = explode('&', $input); + + $parsed_parameters = array(); + foreach ($pairs as $pair) { + $split = explode('=', $pair, 2); + $parameter = OAuthUtil::urldecode_rfc3986($split[0]); + $value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : ''; + + if (isset($parsed_parameters[$parameter])) { + // We have already recieved parameter(s) with this name, so add to the list + // of parameters with this name + + if (is_scalar($parsed_parameters[$parameter])) { + // This is the first duplicate, so transform scalar (string) into an array + // so we can add the duplicates + $parsed_parameters[$parameter] = array($parsed_parameters[$parameter]); + } + + $parsed_parameters[$parameter][] = $value; + } else { + $parsed_parameters[$parameter] = $value; + } + } + return $parsed_parameters; + } + + public static function build_http_query($params) { + if (!$params) return ''; + + // Urlencode both keys and values + $keys = OAuthUtil::urlencode_rfc3986(array_keys($params)); + $values = OAuthUtil::urlencode_rfc3986(array_values($params)); + $params = array_combine($keys, $values); + + // Parameters are sorted by name, using lexicographical byte value ordering. + // Ref: Spec: 9.1.1 (1) + uksort($params, 'strcmp'); + + $pairs = array(); + foreach ($params as $parameter => $value) { + if (is_array($value)) { + // If two or more parameters share the same name, they are sorted by their value + // Ref: Spec: 9.1.1 (1) + // June 12th, 2010 - changed to sort because of issue 164 by hidetaka + sort($value, SORT_STRING); + foreach ($value as $duplicate_value) { + $pairs[] = $parameter . '=' . $duplicate_value; + } + } else { + $pairs[] = $parameter . '=' . $value; + } + } + // For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61) + // Each name-value pair is separated by an '&' character (ASCII code 38) + return implode('&', $pairs); + } +} + diff --git a/src/MaxCDN/RWSException.php b/src/MaxCDN/RWSException.php new file mode 100644 index 0000000..5c33064 --- /dev/null +++ b/src/MaxCDN/RWSException.php @@ -0,0 +1,18 @@ +curl_headers = $headers; + } + + public function getHeaders() { + return $this->curl_headers; + } + +} + diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..58814b6 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,5 @@ +# How to Test +==================================== +Included is a very simple sample API client. In order to use this you must execute composer from the root. + +Please see: http://http://getcomposer.org/ for more information. diff --git a/tests/sampleclient.php b/tests/sampleclient.php new file mode 100644 index 0000000..e4cb38f --- /dev/null +++ b/tests/sampleclient.php @@ -0,0 +1,11 @@ +get('/zones/pull.json'); +} catch(CurlException $e) { + print_r($e->getMessage()); + print_r($e->getHeaders()); +}