diff --git a/.gitignore b/.gitignore index 5622fb2..6e9af97 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ *.swp composer.phar composer.lock +/nbproject/private/ +/vendor/ \ No newline at end of file diff --git a/README.md b/README.md index 7f23264..106c4a0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ #OAuth 1 PHP Library Based on [Andy Smith's](http://term.ie/) [basic php library](http://oauth.googlecode.com/svn/code/php/) for OAuth. + +Actually forked from [EHER's version](https://github.com/EHER/OAuth). + +Tweaked to pass PSR-2. \ No newline at end of file diff --git a/composer.json b/composer.json index b1c313f..dd0b366 100644 --- a/composer.json +++ b/composer.json @@ -1,12 +1,34 @@ { - "name": "Eher/OAuth", + "name": "GaryJones/OAuth", + "description": "Based on Andy Smith's basic PHP library for OAuth 1.0a", "type": "library", + "keywords": ["oauth"], + "homepage": "https://github.com/GaryJones/OAuth", + "license": "BSD-3-Clause", + "authors": [ + { + "name": "Gary Jones", + "email": "gary@garyjones.co.uk", + "role": "developer" + }, + { + "name": "Alexandre Eher", + "role": "Composer packager" + }, + { + "name": "Andy Smith", + "role": "original author" + } + ], "require": { "php": ">=5.3.0" }, + "require-dev": { + "squizlabs/php_codesniffer": "*" + }, "autoload": { "psr-0": { - "Eher\\OAuth": "src" + "GaryJones\\OAuth": "src" } } } diff --git a/nbproject/project.properties b/nbproject/project.properties new file mode 100644 index 0000000..9c9db0f --- /dev/null +++ b/nbproject/project.properties @@ -0,0 +1,24 @@ +auxiliary.org-netbeans-modules-editor-indent.CodeStyle.project.expand-tabs=false +auxiliary.org-netbeans-modules-editor-indent.CodeStyle.project.indent-shift-width=4 +auxiliary.org-netbeans-modules-editor-indent.CodeStyle.project.spaces-per-tab=4 +auxiliary.org-netbeans-modules-editor-indent.CodeStyle.project.tab-size=4 +auxiliary.org-netbeans-modules-editor-indent.CodeStyle.project.text-limit-width=80 +auxiliary.org-netbeans-modules-editor-indent.CodeStyle.project.text-line-wrap=none +auxiliary.org-netbeans-modules-editor-indent.CodeStyle.usedProfile=project +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.blankLinesBeforeNamespace=0 +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.classDeclBracePlacement=NEW_LINE +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.continuationIndentSize=4 +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.expand-tabs=true +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.indent-shift-width=4 +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.methodDeclBracePlacement=NEW_LINE +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.spaces-per-tab=4 +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.tab-size=4 +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.text-limit-width=120 +auxiliary.org-netbeans-modules-editor-indent.text.x-php5.CodeStyle.project.text-line-wrap=none +include.path=${php.global.include.path} +php.version=PHP_53 +source.encoding=UTF-8 +src.dir=. +tags.asp=false +tags.short=true +web.root=. diff --git a/nbproject/project.xml b/nbproject/project.xml new file mode 100644 index 0000000..0dd3e3f --- /dev/null +++ b/nbproject/project.xml @@ -0,0 +1,9 @@ + + + org.netbeans.modules.php.project + + + OAuth + + + diff --git a/src/Eher/OAuth/Consumer.php b/src/Eher/OAuth/Consumer.php deleted file mode 100644 index 8258ba8..0000000 --- a/src/Eher/OAuth/Consumer.php +++ /dev/null @@ -1,19 +0,0 @@ -key = $key; - $this->secret = $secret; - $this->callback_url = $callback_url; - } - - function __toString() { - return "OAuthConsumer[key=$this->key,secret=$this->secret]"; - } -} - diff --git a/src/Eher/OAuth/HmacSha1.php b/src/Eher/OAuth/HmacSha1.php deleted file mode 100644 index be7da63..0000000 --- a/src/Eher/OAuth/HmacSha1.php +++ /dev/null @@ -1,31 +0,0 @@ -get_signature_base_string(); - $request->base_string = $base_string; - - $key_parts = array( - $consumer->secret, - ($token) ? $token->secret : "" - ); - - $key_parts = Util::urlencode_rfc3986($key_parts); - $key = implode('&', $key_parts); - - return base64_encode(hash_hmac('sha1', $base_string, $key, true)); - } -} diff --git a/src/Eher/OAuth/OAuthDataStore.php b/src/Eher/OAuth/OAuthDataStore.php deleted file mode 100644 index 8ad2f30..0000000 --- a/src/Eher/OAuth/OAuthDataStore.php +++ /dev/null @@ -1,30 +0,0 @@ -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/Eher/OAuth/PlainText.php b/src/Eher/OAuth/PlainText.php deleted file mode 100644 index f834807..0000000 --- a/src/Eher/OAuth/PlainText.php +++ /dev/null @@ -1,36 +0,0 @@ -secret, - ($token) ? $token->secret : "" - ); - - $key_parts = Util::urlencode_rfc3986($key_parts); - $key = implode('&', $key_parts); - $request->base_string = $key; - - return $key; - } -} diff --git a/src/Eher/OAuth/Request.php b/src/Eher/OAuth/Request.php deleted file mode 100644 index afb2b20..0000000 --- a/src/Eher/OAuth/Request.php +++ /dev/null @@ -1,264 +0,0 @@ -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['HTTP_HOST'] . - ':' . - $_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 = Util::get_headers(); - - // Parse the query-string to find GET parameters - $parameters = Util::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 = Util::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 = Util::split_header( - $request_headers['Authorization'] - ); - $parameters = array_merge($parameters, $header_parameters); - } - - } - - return new Request($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" => Request::$version, - "oauth_nonce" => Request::generate_nonce(), - "oauth_timestamp" => Request::generate_timestamp(), - "oauth_consumer_key" => $consumer->key); - if ($token) - $defaults['oauth_token'] = $token->key; - - $parameters = array_merge($defaults, $parameters); - - return new Request($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 Util::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 = Util::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'])) ? $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 Util::build_http_query($this->parameters); - } - - /** - * builds the Authorization: header - */ - public function to_header($realm=null) { - $first = true; - if($realm) { - $out = 'Authorization: OAuth realm="' . Util::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 .= Util::urlencode_rfc3986($k) . - '="' . - Util::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/Eher/OAuth/RsaSha1.php b/src/Eher/OAuth/RsaSha1.php deleted file mode 100644 index a749ce3..0000000 --- a/src/Eher/OAuth/RsaSha1.php +++ /dev/null @@ -1,70 +0,0 @@ -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/Eher/OAuth/SignatureMethod.php b/src/Eher/OAuth/SignatureMethod.php deleted file mode 100644 index bad2b9f..0000000 --- a/src/Eher/OAuth/SignatureMethod.php +++ /dev/null @@ -1,40 +0,0 @@ -build_signature($request, $consumer, $token); - return $built == $signature; - } -} diff --git a/src/Eher/OAuth/Token.php b/src/Eher/OAuth/Token.php deleted file mode 100644 index e1d9f65..0000000 --- a/src/Eher/OAuth/Token.php +++ /dev/null @@ -1,34 +0,0 @@ -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=" . - Util::urlencode_rfc3986($this->key) . - "&oauth_token_secret=" . - Util::urlencode_rfc3986($this->secret); - } - - function __toString() { - return $this->to_string(); - } -} - diff --git a/src/Eher/OAuth/Util.php b/src/Eher/OAuth/Util.php deleted file mode 100644 index 1feee44..0000000 --- a/src/Eher/OAuth/Util.php +++ /dev/null @@ -1,155 +0,0 @@ - $h) { - $params[$h] = Util::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 = Util::urldecode_rfc3986($split[0]); - $value = isset($split[1]) ? Util::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 = Util::urlencode_rfc3986(array_keys($params)); - $values = Util::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/GaryJones/OAuth/Consumer.php b/src/GaryJones/OAuth/Consumer.php new file mode 100644 index 0000000..19a30d0 --- /dev/null +++ b/src/GaryJones/OAuth/Consumer.php @@ -0,0 +1,20 @@ +key = $key; + $this->secret = $secret; + $this->callback_url = $callback_url; + } + + public function __toString() + { + return "OAuthConsumer[key=$this->key,secret=$this->secret]"; + } +} diff --git a/src/GaryJones/OAuth/HmacSha1.php b/src/GaryJones/OAuth/HmacSha1.php new file mode 100644 index 0000000..47b21b8 --- /dev/null +++ b/src/GaryJones/OAuth/HmacSha1.php @@ -0,0 +1,33 @@ +getSignatureBaseString(); + $request->base_string = $base_string; + + $key_parts = array( + $consumer->secret, + ($token) ? $token->secret : "" + ); + + $key_parts = Util::urlencodeRfc3986($key_parts); + $key = implode('&', $key_parts); + + return base64_encode(hash_hmac('sha1', $base_string, $key, true)); + } +} diff --git a/src/GaryJones/OAuth/OAuthDataStore.php b/src/GaryJones/OAuth/OAuthDataStore.php new file mode 100644 index 0000000..3cbaafc --- /dev/null +++ b/src/GaryJones/OAuth/OAuthDataStore.php @@ -0,0 +1,49 @@ +parameters = array_merge(Util::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $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 fromRequest($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['HTTP_HOST'] . + ':' . + $_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 = Util::get_headers(); + + // Parse the query-string to find GET parameters + $parameters = Util::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 = Util::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 = Util::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 fromConsumerAndToken($consumer, $token, $http_method, $http_url, $parameters = null) + { + $parameters = ($parameters) ? $parameters : array(); + $defaults = array("oauth_version" => Request::$version, + "oauth_nonce" => Request::generate_nonce(), + "oauth_timestamp" => Request::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 setParameter($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 getParameter($name) + { + return isset($this->parameters[$name]) ? $this->parameters[$name] : null; + } + + public function getParameters() + { + return $this->parameters; + } + + public function unsetParameter($name) + { + unset($this->parameters[$name]); + } + + /** + * The request parameters, sorted and concatenated into a normalized string. + * @return string + */ + public function getSignableParameters() + { + // 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 Util::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 getSignatureBaseString() + { + $parts = array( + $this->getNormalizedHttpMethod(), + $this->getNormalizedHttpUrl(), + $this->getSignableParameters() + ); + + $encoded_parts = Util::urlencode_rfc3986($parts); + + return implode('&', $encoded_parts); + } + + /** + * Just uppercases the http method + */ + public function getNormalizedHttpMethod() + { + return strtoupper($this->http_method); + } + + /** + * parses the url and rebuilds it to be + * scheme://host/path + */ + public function getNormalizedHttpUrl() + { + $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'])) ? $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 toUrl() + { + $post_data = $this->toPostdata(); + $out = $this->getNormalizedHttpUrl(); + if ($post_data) { + $out .= '?' . $post_data; + } + return $out; + } + + /** + * builds the data one would send in a POST request + */ + public function toPostdata() + { + return Util::build_http_query($this->parameters); + } + + /** + * builds the Authorization: header + */ + public function toHeader($realm = null) + { + $first = true; + if ($realm) { + $out = 'Authorization: OAuth realm="' . Util::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 .= Util::urlencode_rfc3986($k) . + '="' . + Util::urlencode_rfc3986($v) . + '"'; + $first = false; + } + return $out; + } + + public function __toString() + { + return $this->toUrl(); + } + + public function signRequest($signature_method, $consumer, $token) + { + $this->setParameter('oauth_signature_method', $signature_method->getName(), false); + $signature = $this->buildSignature($signature_method, $consumer, $token); + $this->setParameter('oauth_signature', $signature, false); + } + + public function buildSignature($signature_method, $consumer, $token) + { + $signature = $signature_method->buildSignature($this, $consumer, $token); + return $signature; + } + + /** + * util function: current timestamp + */ + private static function generateTimestamp() + { + return time(); + } + + /** + * util function: current nonce + */ + private static function generateNonce() + { + $mt = microtime(); + $rand = mt_rand(); + + return md5($mt . $rand); // md5s look nicer than numbers + } +} diff --git a/src/GaryJones/OAuth/OAuthServer.php b/src/GaryJones/OAuth/OAuthServer.php new file mode 100644 index 0000000..326d668 --- /dev/null +++ b/src/GaryJones/OAuth/OAuthServer.php @@ -0,0 +1,207 @@ +data_store = $data_store; + } + + public function addSignatureMethod($signature_method) + { + $this->signature_methods[$signature_method->getName()] = + $signature_method; + } + + // high level functions + + /** + * process a request_token request + * returns the request token on success + */ + public function fetchRequestToken(&$request) + { + $this->getVersion($request); + + $consumer = $this->getConsumer($request); + + // no token required for the initial token request + $token = null; + + $this->checkSignature($request, $consumer, $token); + + // Rev A change + $callback = $request->getParameter('oauth_callback'); + $new_token = $this->data_store->newRequestToken($consumer, $callback); + + return $new_token; + } + + /** + * process an access_token request + * returns the access token on success + */ + public function fetchAccessToken(&$request) + { + $this->getVersion($request); + + $consumer = $this->getConsumer($request); + + // requires authorized request token + $token = $this->getToken($request, $consumer, 'request'); + + $this->checkSignature($request, $consumer, $token); + + // Rev A change + $verifier = $request->getParameter('oauth_verifier'); + $new_token = $this->data_store->newAccessToken($token, $consumer, $verifier); + + return $new_token; + } + + /** + * verify an api call, checks all the parameters + */ + public function verifyRequest(&$request) + { + $this->getVersion($request); + $consumer = $this->getConsumer($request); + $token = $this->getToken($request, $consumer, 'access'); + $this->checkSignature($request, $consumer, $token); + return array($consumer, $token); + } + + // Internals from here + /** + * version 1 + */ + private function getVersion(&$request) + { + $version = $request->getParameter('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 getSignatureMethod($request) + { + $signature_method = $request instanceof OAuthRequest ? $request->getParameter('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 getConsumer($request) + { + $consumer_key = $request instanceof OAuthRequest ? $request->getParameter('oauth_consumer_key') : null; + + if (!$consumer_key) { + throw new OAuthException('Invalid consumer key'); + } + + $consumer = $this->data_store->lookupClient($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 getToken($request, $consumer, $token_type = 'access') + { + $token_field = $request instanceof OAuthRequest ? $request->getParameter('oauth_token') : null; + + $token = $this->data_store->lookupToken($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 checkSignature($request, $consumer, $token) + { + // this should probably be in a different method + $timestamp = $request instanceof OAuthRequest ? $request->getParameter('oauth_timestamp') : null; + $nonce = $request instanceof OAuthRequest ? $request->getParameter('oauth_nonce') : null; + + $this->checkTimestamp($timestamp); + $this->checkNonce($consumer, $token, $nonce, $timestamp); + + $signature_method = $this->getSignatureMethod($request); + + $signature = $request->getParameter('oauth_signature'); + $valid_sig = $signature_method->checkSignature($request, $consumer, $token, $signature); + + if (!$valid_sig) { + throw new OAuthException('Invalid signature'); + } + } + + /** + * check that the timestamp is new enough + */ + private function checkTimestamp($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 checkNonce($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->lookupNonce($consumer, $token, $nonce, $timestamp); + if ($found) { + throw new OAuthException('Nonce already used: ' . $nonce); + } + } +} diff --git a/src/GaryJones/OAuth/PlainText.php b/src/GaryJones/OAuth/PlainText.php new file mode 100644 index 0000000..ceb8be3 --- /dev/null +++ b/src/GaryJones/OAuth/PlainText.php @@ -0,0 +1,38 @@ +secret, + ($token) ? $token->secret : '' + ); + + $key_parts = Util::urlencodeRfc3986($key_parts); + $key = implode('&', $key_parts); + $request->base_string = $key; + + return $key; + } +} diff --git a/src/GaryJones/OAuth/RsaSha1.php b/src/GaryJones/OAuth/RsaSha1.php new file mode 100644 index 0000000..7153413 --- /dev/null +++ b/src/GaryJones/OAuth/RsaSha1.php @@ -0,0 +1,73 @@ +getSignatureBaseString(); + $request->base_string = $base_string; + + // Fetch the private key cert based on the request + $cert = $this->fetchPrivateCert($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 checkSignature($request, $consumer, $token, $signature) + { + $decoded_sig = base64_decode($signature); + + $base_string = $request->getSignatureBaseString(); + + // Fetch the public key cert based on the request + $cert = $this->fetchPublicCert($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/GaryJones/OAuth/SignatureMethod.php b/src/GaryJones/OAuth/SignatureMethod.php new file mode 100644 index 0000000..8ef4522 --- /dev/null +++ b/src/GaryJones/OAuth/SignatureMethod.php @@ -0,0 +1,41 @@ +buildSignature($request, $consumer, $token); + return $built == $signature; + } +} diff --git a/src/GaryJones/OAuth/Token.php b/src/GaryJones/OAuth/Token.php new file mode 100644 index 0000000..9540d82 --- /dev/null +++ b/src/GaryJones/OAuth/Token.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 + */ + public function toString() + { + return "oauth_token=" . + Util::urlencodeRfc3986($this->key) . + "&oauth_token_secret=" . + Util::urlencodeRfc3986($this->secret); + } + + public function __toString() + { + return $this->toString(); + } +} diff --git a/src/GaryJones/OAuth/Util.php b/src/GaryJones/OAuth/Util.php new file mode 100644 index 0000000..c032eeb --- /dev/null +++ b/src/GaryJones/OAuth/Util.php @@ -0,0 +1,154 @@ + $h) { + $params[$h] = Util::urldecodeRfc3986(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 getHeaders() + { + 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 parseParameters($input) + { + if (!isset($input) || !$input) { + return array(); + } + + $pairs = explode('&', $input); + + $parsed_parameters = array(); + foreach ($pairs as $pair) { + $split = explode('=', $pair, 2); + $parameter = Util::urldecodeRfc3986($split[0]); + $value = isset($split[1]) ? Util::urldecodeRfc3986($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 buildHttpQuery($params) + { + if (!$params) { + return ''; + } + + // Urlencode both keys and values + $keys = Util::urlencodeRfc3986(array_keys($params)); + $values = Util::urlencodeRfc3986(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); + } +}