From 797f653f84146c7db62f8a43b200275854758b74 Mon Sep 17 00:00:00 2001 From: Chris Pittman Date: Fri, 6 Sep 2019 03:39:34 -0500 Subject: [PATCH] Update to use official IMSGlobal libs --- .gitignore | 3 +- composer.json | 8 +- src/LTIUtils.php | 15 +- src/OAuthConsumer.php | 26 --- src/OAuthDataStore.php | 38 ---- src/OAuthException.php | 14 -- src/OAuthRequest.php | 268 ------------------------- src/OAuthServer.php | 203 ------------------- src/OAuthSignatureMethod.php | 24 --- src/OAuthSignatureMethodHMACSHA1.php | 33 --- src/OAuthSignatureMethod_PLAINTEXT.php | 36 ---- src/OAuthSignatureMethod_RSA_SHA1.php | 75 ------- src/OAuthToken.php | 42 ---- src/OAuthUtil.php | 147 -------------- src/TrivialOAuthDataStore.php | 4 + 15 files changed, 21 insertions(+), 915 deletions(-) delete mode 100644 src/OAuthConsumer.php delete mode 100644 src/OAuthDataStore.php delete mode 100644 src/OAuthException.php delete mode 100644 src/OAuthRequest.php delete mode 100644 src/OAuthServer.php delete mode 100644 src/OAuthSignatureMethod.php delete mode 100644 src/OAuthSignatureMethodHMACSHA1.php delete mode 100644 src/OAuthSignatureMethod_PLAINTEXT.php delete mode 100644 src/OAuthSignatureMethod_RSA_SHA1.php delete mode 100644 src/OAuthToken.php delete mode 100644 src/OAuthUtil.php diff --git a/.gitignore b/.gitignore index 723ef36..331c58f 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -.idea \ No newline at end of file +.idea +vendor \ No newline at end of file diff --git a/composer.json b/composer.json index d5e9719..ccfc215 100644 --- a/composer.json +++ b/composer.json @@ -7,8 +7,10 @@ "psr-4": {"Chrispittman\\Lti1\\": "src/"} }, "require": { - "php": ">5.4.0", + "php": ">5.6.0", + "imsglobal/lti": "^3.0.2", "ext-xml":"*", - "ext-curl":"*" + "ext-curl":"*", + "ext-dom": "*" } -} \ No newline at end of file +} diff --git a/src/LTIUtils.php b/src/LTIUtils.php index 36bd1a0..7e1590a 100644 --- a/src/LTIUtils.php +++ b/src/LTIUtils.php @@ -6,6 +6,11 @@ use DOMException; use Exception; +use IMSGlobal\LTI\OAuth\OAuthConsumer; +use IMSGlobal\LTI\OAuth\OAuthServer; +use IMSGlobal\LTI\OAuth\OAuthRequest; +use IMSGlobal\LTI\OAuth\OAuthSignatureMethod_HMAC_SHA1; + class LTIUtils { // // LAUNCH FUNCTIONS @@ -22,7 +27,7 @@ public function validate_oauth_signature($oauth_consumer_key, $shared_secret, $r $server = new OAuthServer($store); - $method = new OAuthSignatureMethodHMACSHA1(); + $method = new OAuthSignatureMethod_HMAC_SHA1(); $server->add_signature_method($method); $request = OAuthRequest::from_request("POST", $request_url); @@ -75,7 +80,7 @@ public function update_outcome($oauth_consumer_key, $shared_secret, $lti_sourced $hash = base64_encode(sha1($xmlRequest, TRUE)); $params = array('oauth_body_hash'=>$hash); - $hmac_method = new OAuthSignatureMethodHMACSHA1(); + $hmac_method = new OAuthSignatureMethod_HMAC_SHA1(); $consumer = new OAuthConsumer($oauth_consumer_key, $shared_secret, NULL); $req = OAuthRequest::from_consumer_and_token($consumer, NULL, 'POST', $lis_outcome_service_url, $params); @@ -83,14 +88,14 @@ public function update_outcome($oauth_consumer_key, $shared_secret, $lti_sourced $header = $req->to_header(); $header .= "\nContent-type: application/xml"; - $ext_response = LTIUtils::do_post_request($lis_outcome_service_url, $xmlRequest, $header); + $ext_response = $this->do_post_request($lis_outcome_service_url, $xmlRequest, $header); try { $ext_doc = new DOMDocument(); set_error_handler(array($this,'HandleXmlError')); $ext_doc->loadXML($ext_response); restore_error_handler(); - $ext_nodes = LTIUtils::domnode_to_array($ext_doc->documentElement); + $ext_nodes = $this->domnode_to_array($ext_doc->documentElement); if (!isset($ext_nodes['imsx_POXHeader']['imsx_POXResponseHeaderInfo']['imsx_statusInfo']['imsx_codeMajor'])) { throw new Exception("No imsx_codeMajor from outcome service for ".$lti_sourced_id); } @@ -137,7 +142,7 @@ public function delete_outcome($oauth_consumer_key, $shared_secret, $lti_sourced $hash = base64_encode(sha1($xmlRequest, TRUE)); $params = array('oauth_body_hash'=>$hash); - $hmac_method = new OAuthSignatureMethodHMACSHA1(); + $hmac_method = new OAuthSignatureMethod_HMAC_SHA1(); $consumer = new OAuthConsumer($oauth_consumer_key, $shared_secret, NULL); $req = OAuthRequest::from_consumer_and_token($consumer, NULL, 'POST', $lis_outcome_service_url, $params); diff --git a/src/OAuthConsumer.php b/src/OAuthConsumer.php deleted file mode 100644 index 1b65ed7..0000000 --- a/src/OAuthConsumer.php +++ /dev/null @@ -1,26 +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/OAuthDataStore.php b/src/OAuthDataStore.php deleted file mode 100644 index 85dfb49..0000000 --- a/src/OAuthDataStore.php +++ /dev/null @@ -1,38 +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'; - $host = $_SERVER['HTTP_HOST']; - if (strpos($host,':')!=-1) { - $host = explode(':',$host)[0]; - } - @$http_url or $http_url = $scheme . - '://' . $host . - ':' . - $_SERVER['SERVER_PORT'] . - $_SERVER['REQUEST_URI']; - @$http_method or $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" - && @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 (@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 or $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); - - $port = @$parts['port']; - $scheme = $parts['scheme']; - $host = $parts['host']; - $path = @$parts['path']; - - $port or $port = ($scheme == 'https') ? '443' : '80'; - - 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() { - $out ='Authorization: OAuth realm=""'; - $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 .= ',' . - OAuthUtil::urlencode_rfc3986($k) . - '="' . - OAuthUtil::urlencode_rfc3986($v) . - '"'; - } - return $out; - } - - public function __toString() { - return $this->to_url(); - } - - - public function sign_request(OAuthSignatureMethod $signature_method, OAuthConsumer $consumer, OAuthToken $token=null) { - $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(OAuthSignatureMethod $signature_method, OAuthConsumer $consumer, OAuthToken $token=null) { - $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/OAuthServer.php b/src/OAuthServer.php deleted file mode 100644 index 8fb3d84..0000000 --- a/src/OAuthServer.php +++ /dev/null @@ -1,203 +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); - - $new_token = $this->data_store->new_request_token($consumer); - - 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); - - $new_token = $this->data_store->new_access_token($token, $consumer); - - 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) { - $version = 1.0; - } - if ($version && $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->get_parameter("oauth_signature_method"); - if (!$signature_method) { - $signature_method = "PLAINTEXT"; - } - 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->get_parameter("oauth_consumer_key"); - 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->get_parameter('oauth_token'); - $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->get_parameter('oauth_timestamp'); - $nonce = @$request->get_parameter('oauth_nonce'); - - $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) { - // verify that timestamp is recentish - $now = time(); - if ($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) { - // 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/OAuthSignatureMethod.php b/src/OAuthSignatureMethod.php deleted file mode 100644 index a8948e4..0000000 --- a/src/OAuthSignatureMethod.php +++ /dev/null @@ -1,24 +0,0 @@ -build_signature($request, $consumer, $token); - return $built == $signature; - } - - abstract public function get_name(); - abstract public function build_signature(OAuthRequest $request, OAuthConsumer $consumer, OAuthToken $token=null); -} - - - diff --git a/src/OAuthSignatureMethodHMACSHA1.php b/src/OAuthSignatureMethodHMACSHA1.php deleted file mode 100644 index 5917355..0000000 --- a/src/OAuthSignatureMethodHMACSHA1.php +++ /dev/null @@ -1,33 +0,0 @@ -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/OAuthSignatureMethod_PLAINTEXT.php b/src/OAuthSignatureMethod_PLAINTEXT.php deleted file mode 100644 index 13bd21c..0000000 --- a/src/OAuthSignatureMethod_PLAINTEXT.php +++ /dev/null @@ -1,36 +0,0 @@ -secret) - ); - - if ($token) { - array_push($sig, OAuthUtil::urlencode_rfc3986($token->secret)); - } else { - array_push($sig, ''); - } - - $raw = implode("&", $sig); - // for debug purposes - $request->base_string = $raw; - - return OAuthUtil::urlencode_rfc3986($raw); - } -} diff --git a/src/OAuthSignatureMethod_RSA_SHA1.php b/src/OAuthSignatureMethod_RSA_SHA1.php deleted file mode 100644 index df7a87d..0000000 --- a/src/OAuthSignatureMethod_RSA_SHA1.php +++ /dev/null @@ -1,75 +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(OAuthRequest &$request, OAuthConsumer $consumer, OAuthToken $token=null, $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/OAuthToken.php b/src/OAuthToken.php deleted file mode 100644 index 0604c71..0000000 --- a/src/OAuthToken.php +++ /dev/null @@ -1,42 +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=" . - OAuthUtil::urlencode_rfc3986($this->key) . - "&oauth_token_secret=" . - OAuthUtil::urlencode_rfc3986($this->secret); - } - - function __toString() { - return $this->to_string(); - } -} diff --git a/src/OAuthUtil.php b/src/OAuthUtil.php deleted file mode 100644 index 761861c..0000000 --- a/src/OAuthUtil.php +++ /dev/null @@ -1,147 +0,0 @@ - 0) { - $match = $matches[0]; - $header_name = $matches[2][0]; - $header_content = (isset($matches[5])) ? $matches[5][0] : $matches[4][0]; - if (preg_match('/^oauth_/', $header_name) || !$only_allow_oauth_parameters) { - $params[$header_name] = OAuthUtil::urldecode_rfc3986($header_content); - } - $offset = $match[1] + strlen($match[0]); - } - - 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 - return apache_request_headers(); - } - // otherwise we don't have apache and are just going to have to hope - // that $_SERVER actually contains what we need - $out = array(); - 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) - natsort($value); - 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/TrivialOAuthDataStore.php b/src/TrivialOAuthDataStore.php index 38d7023..3fb7b88 100644 --- a/src/TrivialOAuthDataStore.php +++ b/src/TrivialOAuthDataStore.php @@ -2,6 +2,10 @@ namespace Chrispittman\Lti1; +use IMSGlobal\LTI\OAuth\OAuthConsumer; +use IMSGlobal\LTI\OAuth\OAuthDataStore; +use IMSGlobal\LTI\OAuth\OAuthToken; + /** * A Trivial memory-based store - no support for tokens */