IMSGlobal\LTI\OAuth\OAuthRequest Class Reference

Class to represent an OAuth Request. More...

Collaboration diagram for IMSGlobal\LTI\OAuth\OAuthRequest:

Public Member Functions
	__construct ($http_method, $http_url, $parameters=null)
	set_parameter ($name, $value, $allow_duplicates=true)
	get_parameter ($name)
	get_parameters ()
	unset_parameter ($name)
	get_signable_parameters ()
	The request parameters, sorted and concatenated into a normalized string. More...
	get_signature_base_string ()
	Returns the base string of this request. More...
	get_normalized_http_method ()
	just uppercases the http method More...
	get_normalized_http_url ()
	parses the url and rebuilds it to be scheme://host/path More...
	to_url ()
	builds a url usable for a GET request More...
	to_postdata ()
	builds the data one would send in a POST request More...
	to_header ($realm=null)
	builds the Authorization: header More...
	__toString ()
	sign_request ($signature_method, $consumer, $token)
	build_signature ($signature_method, $consumer, $token)

Static Public Member Functions
static	from_request ($http_method=null, $http_url=null, $parameters=null)
	attempt to build up a request from what was passed to the server More...
static	from_consumer_and_token ($consumer, $token, $http_method, $http_url, $parameters=null)
	pretty much a helper function to set up the request More...

Data Fields
	$base_string

Static Public Attributes
static	$version = '1.0'
static	$POST_INPUT = 'php://input'

Protected Attributes
	$parameters
	$http_method
	$http_url

Static Private Member Functions
static	generate_timestamp ()
	util function: current timestamp More...
static	generate_nonce ()
	util function: current nonce More...

Detailed Description

Class to represent an OAuth Request.

Copyright

Andy Smith

Version

2008-08-04 https://opensource.org/licenses/MIT The MIT License

Definition at line 12 of file OAuthRequest.php.

Constructor & Destructor Documentation

__construct()

IMSGlobal\LTI\OAuth\OAuthRequest::__construct	(		$http_method,
			$http_url,
			$parameters = null
	)

Definition at line 22 of file OAuthRequest.php.

References IMSGlobal\LTI\OAuth\OAuthRequest\$http_method, IMSGlobal\LTI\OAuth\OAuthRequest\$http_url, IMSGlobal\LTI\OAuth\OAuthRequest\$parameters, and IMSGlobal\LTI\OAuth\OAuthUtil\parse_parameters().

                                                                      {

        $parameters = ($parameters) ? $parameters : array();
        $parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
        $this->parameters = $parameters;
        $this->http_method = $http_method;
        $this->http_url = $http_url;

    }

Here is the call graph for this function:

Member Function Documentation

__toString()

IMSGlobal\LTI\OAuth\OAuthRequest::__toString

(

)

Definition at line 251 of file OAuthRequest.php.

References IMSGlobal\LTI\OAuth\OAuthRequest\to_url().

                                 {
        return $this->to_url();
    }

Here is the call graph for this function:

build_signature()

IMSGlobal\LTI\OAuth\OAuthRequest::build_signature	(		$signature_method,
			$consumer,
			$token
	)

Definition at line 268 of file OAuthRequest.php.

References PHPMailer\PHPMailer\$token.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\sign_request().

                                                                          {
        $signature = $signature_method->build_signature($this, $consumer, $token);
        return $signature;
    }

Here is the caller graph for this function:

from_consumer_and_token()

static IMSGlobal\LTI\OAuth\OAuthRequest::from_consumer_and_token (   $consumer,   $token,   $http_method,   $http_url,   $parameters = null  )

static

pretty much a helper function to set up the request

Definition at line 87 of file OAuthRequest.php.

References IMSGlobal\LTI\OAuth\OAuthRequest\$http_method, IMSGlobal\LTI\OAuth\OAuthRequest\$http_url, IMSGlobal\LTI\OAuth\OAuthRequest\$parameters, PHPMailer\PHPMailer\$token, IMSGlobal\LTI\OAuth\OAuthRequest\$version, IMSGlobal\LTI\OAuth\OAuthRequest\generate_nonce(), and IMSGlobal\LTI\OAuth\OAuthRequest\generate_timestamp().

Referenced by IMSGlobal\LTI\ToolProvider\ToolConsumer\addSignature(), IMSGlobal\LTI\ToolProvider\ResourceLink\doLTI11Service(), and IMSGlobal\LTI\ToolProvider\ToolConsumer\signParameters().

                                                                                                                   {

        $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);

    }

Here is the call graph for this function:

Here is the caller graph for this function:

from_request()

static IMSGlobal\LTI\OAuth\OAuthRequest::from_request (   $http_method = null,   $http_url = null,   $parameters = null  )

static

attempt to build up a request from what was passed to the server

Definition at line 36 of file OAuthRequest.php.

References $_SERVER, IMSGlobal\LTI\OAuth\OAuthRequest\$http_method, IMSGlobal\LTI\OAuth\OAuthRequest\$http_url, IMSGlobal\LTI\OAuth\OAuthRequest\$parameters, IMSGlobal\LTI\OAuth\OAuthUtil\get_headers(), IMSGlobal\LTI\OAuth\OAuthUtil\parse_parameters(), and IMSGlobal\LTI\OAuth\OAuthUtil\split_header().

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate().

                                                                                                   {

      $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
          if (isset($_SERVER['QUERY_STRING'])) {
              $parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);
          } else {
              $parameters = array();
          }

          // 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

generate_nonce()

static IMSGlobal\LTI\OAuth\OAuthRequest::generate_nonce ( )

staticprivate

util function: current nonce

Definition at line 283 of file OAuthRequest.php.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token().

                                             {
        $mt = microtime();
        $rand = mt_rand();

        return md5($mt . $rand); // md5s look nicer than numbers
    }

Here is the caller graph for this function:

generate_timestamp()

static IMSGlobal\LTI\OAuth\OAuthRequest::generate_timestamp ( )

staticprivate

util function: current timestamp

Definition at line 276 of file OAuthRequest.php.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token().

                                                 {
        return time();
    }

Here is the caller graph for this function:

get_normalized_http_method()

IMSGlobal\LTI\OAuth\OAuthRequest::get_normalized_http_method

(

)

just uppercases the http method

Definition at line 173 of file OAuthRequest.php.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\get_signature_base_string().

                                                 {
        return strtoupper($this->http_method);
    }

Here is the caller graph for this function:

get_normalized_http_url()

IMSGlobal\LTI\OAuth\OAuthRequest::get_normalized_http_url

(

)

parses the url and rebuilds it to be scheme://host/path

Definition at line 181 of file OAuthRequest.php.

References $path.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\get_signature_base_string(), and IMSGlobal\LTI\OAuth\OAuthRequest\to_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";

    }

Here is the caller graph for this function:

get_parameter()

IMSGlobal\LTI\OAuth\OAuthRequest::get_parameter

(

$name

)

Definition at line 119 of file OAuthRequest.php.

References $name.

                                         {
        return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
    }

get_parameters()

IMSGlobal\LTI\OAuth\OAuthRequest::get_parameters

(

)

Definition at line 123 of file OAuthRequest.php.

References IMSGlobal\LTI\OAuth\OAuthRequest\$parameters.

                                     {
        return $this->parameters;
    }

get_signable_parameters()

IMSGlobal\LTI\OAuth\OAuthRequest::get_signable_parameters

(

)

The request parameters, sorted and concatenated into a normalized string.

Returns

string

Definition at line 135 of file OAuthRequest.php.

References IMSGlobal\LTI\OAuth\OAuthRequest\$parameters, PHPMailer\PHPMailer\$params, and IMSGlobal\LTI\OAuth\OAuthUtil\build_http_query().

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\get_signature_base_string().

                                              {

        // 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);

    }

Here is the call graph for this function:

Here is the caller graph for this function:

get_signature_base_string()

IMSGlobal\LTI\OAuth\OAuthRequest::get_signature_base_string

(

)

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 &.

Definition at line 157 of file OAuthRequest.php.

References IMSGlobal\LTI\OAuth\OAuthRequest\get_normalized_http_method(), IMSGlobal\LTI\OAuth\OAuthRequest\get_normalized_http_url(), IMSGlobal\LTI\OAuth\OAuthRequest\get_signable_parameters(), and IMSGlobal\LTI\OAuth\OAuthUtil\urlencode_rfc3986().

                                                {
        $parts = array(
            $this->get_normalized_http_method(),
            $this->get_normalized_http_url(),
            $this->get_signable_parameters()
        );

        $parts = OAuthUtil::urlencode_rfc3986($parts);

        return implode('&', $parts);

    }

Here is the call graph for this function:

set_parameter()

IMSGlobal\LTI\OAuth\OAuthRequest::set_parameter	(		$name,
			$value,
			$allow_duplicates = true
	)

Definition at line 103 of file OAuthRequest.php.

References $name.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\sign_request().

                                                                           {

      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;
      }
    }

Here is the caller graph for this function:

sign_request()

IMSGlobal\LTI\OAuth\OAuthRequest::sign_request	(		$signature_method,
			$consumer,
			$token
	)

Definition at line 256 of file OAuthRequest.php.

References PHPMailer\PHPMailer\$token, IMSGlobal\LTI\OAuth\OAuthRequest\build_signature(), and IMSGlobal\LTI\OAuth\OAuthRequest\set_parameter().

                                                                       {

        $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);

    }

Here is the call graph for this function:

to_header()

IMSGlobal\LTI\OAuth\OAuthRequest::to_header

(

$realm = null

)

builds the Authorization: header

Definition at line 224 of file OAuthRequest.php.

References $out, $total, and IMSGlobal\LTI\OAuth\OAuthUtil\urlencode_rfc3986().

                                             {

        $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;

    }

Here is the call graph for this function:

to_postdata()

IMSGlobal\LTI\OAuth\OAuthRequest::to_postdata

(

)

builds the data one would send in a POST request

Definition at line 217 of file OAuthRequest.php.

References IMSGlobal\LTI\OAuth\OAuthUtil\build_http_query().

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\to_url().

                                  {
        return OAuthUtil::build_http_query($this->parameters);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

to_url()

IMSGlobal\LTI\OAuth\OAuthRequest::to_url

(

)

builds a url usable for a GET request

Definition at line 202 of file OAuthRequest.php.

References $out, IMSGlobal\LTI\OAuth\OAuthRequest\get_normalized_http_url(), and IMSGlobal\LTI\OAuth\OAuthRequest\to_postdata().

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\__toString().

                             {

        $post_data = $this->to_postdata();
        $out = $this->get_normalized_http_url();
        if ($post_data) {
            $out .= '?'.$post_data;
        }

        return $out;

    }

Here is the call graph for this function:

Here is the caller graph for this function:

unset_parameter()

IMSGlobal\LTI\OAuth\OAuthRequest::unset_parameter

(

$name

)

Definition at line 127 of file OAuthRequest.php.

References $name.

                                           {
        unset($this->parameters[$name]);
    }

Field Documentation

$base_string

IMSGlobal\LTI\OAuth\OAuthRequest::$base_string

Definition at line 18 of file OAuthRequest.php.

$http_method

IMSGlobal\LTI\OAuth\OAuthRequest::$http_method

protected

Definition at line 15 of file OAuthRequest.php.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\__construct(), IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token(), and IMSGlobal\LTI\OAuth\OAuthRequest\from_request().

$http_url

IMSGlobal\LTI\OAuth\OAuthRequest::$http_url

protected

Definition at line 16 of file OAuthRequest.php.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\__construct(), IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token(), and IMSGlobal\LTI\OAuth\OAuthRequest\from_request().

$parameters

IMSGlobal\LTI\OAuth\OAuthRequest::$parameters

protected

Definition at line 14 of file OAuthRequest.php.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\__construct(), IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token(), IMSGlobal\LTI\OAuth\OAuthRequest\from_request(), IMSGlobal\LTI\OAuth\OAuthRequest\get_parameters(), and IMSGlobal\LTI\OAuth\OAuthRequest\get_signable_parameters().

$POST_INPUT

IMSGlobal\LTI\OAuth\OAuthRequest::$POST_INPUT = 'php://input'

static

Definition at line 20 of file OAuthRequest.php.

$version

IMSGlobal\LTI\OAuth\OAuthRequest::$version = '1.0'

static

Definition at line 19 of file OAuthRequest.php.

Referenced by IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/imsglobal/lti/src/OAuth/OAuthRequest.php