OAuthRequest Class Reference

Collaboration diagram for 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

Definition at line 249 of file OAuth.php.

Constructor & Destructor Documentation

__construct()

OAuthRequest::__construct	(		$http_method,
			$http_url,
			$parameters = NULL
	)

Definition at line 258 of file OAuth.php.

References array, and 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()

OAuthRequest::__toString

(

)

Definition at line 471 of file OAuth.php.

                                 {
        return $this->to_url();
    }

build_signature()

OAuthRequest::build_signature	(		$signature_method,
			$consumer,
			$token
	)

Definition at line 486 of file OAuth.php.

References $consumer.

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

from_consumer_and_token()

static 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 322 of file OAuth.php.

References $consumer, $version, array, generate_nonce(), and generate_timestamp().

Referenced by sspmod_oauth_Consumer\getAccessToken(), sspmod_oauth_Consumer\getRequestToken(), sspmod_oauth_Consumer\getUserInfo(), and sspmod_oauth_Consumer\postRequest().

                                                                                                                 {
        $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 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 270 of file OAuth.php.

References $_SERVER, OAuthUtil\get_headers(), OAuthUtil\parse_parameters(), and OAuthUtil\split_header().

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

Here is the call graph for this function:

generate_nonce()

static OAuthRequest::generate_nonce ( )

staticprivate

util function: current nonce

Definition at line 501 of file OAuth.php.

Referenced by 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 OAuthRequest::generate_timestamp ( )

staticprivate

util function: current timestamp

Definition at line 494 of file OAuth.php.

References time.

Referenced by from_consumer_and_token().

                                                 {
        return time();
    }

Here is the caller graph for this function:

get_normalized_http_method()

OAuthRequest::get_normalized_http_method

(

)

just uppercases the http method

Definition at line 402 of file OAuth.php.

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

get_normalized_http_url()

OAuthRequest::get_normalized_http_url

(

)

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

Definition at line 410 of file OAuth.php.

References $path.

                                              {
        $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";
    }

get_parameter()

OAuthRequest::get_parameter

(

$name

)

Definition at line 351 of file OAuth.php.

References $name.

Referenced by OAuthServer\check_signature(), OAuthServer\get_consumer(), OAuthServer\get_signature_method(), and OAuthServer\get_token().

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

Here is the caller graph for this function:

get_parameters()

OAuthRequest::get_parameters

(

)

Definition at line 355 of file OAuth.php.

                                     {
        return $this->parameters;
    }

get_signable_parameters()

OAuthRequest::get_signable_parameters

(

)

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

Returns

string

Definition at line 367 of file OAuth.php.

References $params, and OAuthUtil\build_http_query().

                                              {
        // 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:

get_signature_base_string()

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 387 of file OAuth.php.

References array, and 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()

OAuthRequest::set_parameter	(		$name,
			$value,
			$allow_duplicates = true
	)

Definition at line 336 of file OAuth.php.

References $name, and array.

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

sign_request()

OAuthRequest::sign_request	(		$signature_method,
			$consumer,
			$token
	)

Definition at line 476 of file OAuth.php.

References $consumer.

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

to_header()

OAuthRequest::to_header

(

$realm = null

)

builds the Authorization: header

Definition at line 447 of file OAuth.php.

References $out, $total, array, and 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()

OAuthRequest::to_postdata

(

)

builds the data one would send in a POST request

Definition at line 440 of file OAuth.php.

References OAuthUtil\build_http_query().

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

Here is the call graph for this function:

to_url()

OAuthRequest::to_url

(

)

builds a url usable for a GET request

Definition at line 428 of file OAuth.php.

References $out.

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

unset_parameter()

OAuthRequest::unset_parameter

(

$name

)

Definition at line 359 of file OAuth.php.

References $name.

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

Field Documentation

$base_string

OAuthRequest::$base_string

Definition at line 254 of file OAuth.php.

$http_method

OAuthRequest::$http_method

protected

Definition at line 251 of file OAuth.php.

$http_url

OAuthRequest::$http_url

protected

Definition at line 252 of file OAuth.php.

$parameters

OAuthRequest::$parameters

protected

Definition at line 250 of file OAuth.php.

$POST_INPUT

OAuthRequest::$POST_INPUT = 'php://input'

static

Definition at line 256 of file OAuth.php.

$version

OAuthRequest::$version = '1.0'

static

Definition at line 255 of file OAuth.php.

Referenced by from_consumer_and_token().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/oauth/libextinc/OAuth.php