sspmod_oauth_Consumer Class Reference

Collaboration diagram for sspmod_oauth_Consumer:

Public Member Functions
	__construct ($key, $secret)
	getRequestToken ($url, $parameters=NULL)
	getAuthorizeRequest ($url, $requestToken, $redirect=TRUE, $callback=NULL)
	getAccessToken ($url, $requestToken, $parameters=NULL)
	postRequest ($url, $accessToken, $parameters)
	getUserInfo ($url, $accessToken, $opts=NULL)

Static Public Member Functions
static	dummy ()
static	getOAuthError ($hrh)
static	getContentType ($hrh)
static	getHTTP ($url, $context='')

Private Attributes
	$consumer
	$signer

Detailed Description

Definition at line 11 of file Consumer.php.

Constructor & Destructor Documentation

__construct()

sspmod_oauth_Consumer::__construct	(		$key,
			$secret
	)

Definition at line 16 of file Consumer.php.

References $key, and $secret.

                                                   {
                $this->consumer = new OAuthConsumer($key, $secret, NULL);
                $this->signer = new OAuthSignatureMethod_HMAC_SHA1();
        }

Member Function Documentation

dummy()

static sspmod_oauth_Consumer::dummy ( )

static

Definition at line 22 of file Consumer.php.

{}

getAccessToken()

sspmod_oauth_Consumer::getAccessToken	(		$url,
			$requestToken,
			$parameters = NULL
	)

Definition at line 102 of file Consumer.php.

References $accessToken, $requestToken, $url, SimpleSAML\Logger\debug(), and OAuthRequest\from_consumer_and_token().

                                                                                {

                $acc_req = OAuthRequest::from_consumer_and_token($this->consumer, $requestToken, "GET", $url, $parameters);
                $acc_req->sign_request($this->signer, $this->consumer, $requestToken);
                
                $response_acc = file_get_contents($acc_req->to_url());
                if ($response_acc === FALSE) {
                        throw new Exception('Error contacting request_token endpoint on the OAuth Provider');
                }

                SimpleSAML\Logger::debug('oauth: Reponse to get access token: '. $response_acc);
                
                parse_str($response_acc, $accessResponseParsed);
                
                if(array_key_exists('error', $accessResponseParsed))
                        throw new Exception('Error getting request token: ' . $accessResponseParsed['error']);
                
                $accessToken = $accessResponseParsed['oauth_token'];
                $accessTokenSecret = $accessResponseParsed['oauth_token_secret'];

                return new OAuthToken($accessToken, $accessTokenSecret);
        }

Here is the call graph for this function:

getAuthorizeRequest()

sspmod_oauth_Consumer::getAuthorizeRequest	(		$url,
			$requestToken,
			$redirect = TRUE,
			$callback = NULL
	)

Definition at line 89 of file Consumer.php.

References $params, $requestToken, $url, array, exit, and SimpleSAML\Utils\HTTP\redirectTrustedURL().

                                                                                                     {
                $params = array('oauth_token' => $requestToken->key);
                if ($callback) {
                        $params['oauth_callback'] = $callback;
                }
                $authorizeURL = \SimpleSAML\Utils\HTTP::addURLParameters($url, $params);
                if ($redirect) {
                        \SimpleSAML\Utils\HTTP::redirectTrustedURL($authorizeURL);
                        exit;
                }       
                return $authorizeURL;
        }

Here is the call graph for this function:

getContentType()

static sspmod_oauth_Consumer::getContentType (   $hrh )

static

Definition at line 34 of file Consumer.php.

References $h.

                                                    {
                foreach($hrh AS $h) {
                        if (preg_match('|Content-Type:\s([^;]*)|i', $h, $matches)) {
                                return $matches[1];
                        }
                }
                return null;
        }

getHTTP()

static sspmod_oauth_Consumer::getHTTP (   $url,   $context = ''  )

static

Definition at line 52 of file Consumer.php.

References $error, $response, and $url.

                                                            {
                $response = @file_get_contents($url);
                
                if ($response === FALSE) {
                        $statuscode = 'unknown';
                        if (preg_match('/^HTTP.*\s([0-9]{3})/', $http_response_header[0], $matches)) $statuscode = $matches[1];
                        
                        $error = $context . ' [statuscode: ' . $statuscode . ']: ';
                        $contenttype = self::getContentType($http_response_header);
                        $oautherror = self::getOAuthError($http_response_header);
                        
                        if (!empty($oautherror)) $error .= $oautherror;

                        throw new Exception($error . ':' . $url);
                } 
                // Fall back to return response, if could not reckognize HTTP header. Should not happen.
                return $response;
        }

getOAuthError()

static sspmod_oauth_Consumer::getOAuthError (   $hrh )

static

Definition at line 25 of file Consumer.php.

References $h.

                                                   {
                foreach($hrh AS $h) {
                        if (preg_match('|OAuth-Error:\s([^;]*)|i', $h, $matches)) {
                                return $matches[1];
                        }
                }
                return null;
        }

getRequestToken()

sspmod_oauth_Consumer::getRequestToken	(		$url,
			$parameters = NULL
	)

Definition at line 71 of file Consumer.php.

References $requestToken, $url, and OAuthRequest\from_consumer_and_token().

                                                                  {
                $req_req = OAuthRequest::from_consumer_and_token($this->consumer, NULL, "GET", $url, $parameters);
                $req_req->sign_request($this->signer, $this->consumer, NULL);

                $response_req = self::getHTTP($req_req->to_url(), 
                        'Contacting request_token endpoint on the OAuth Provider');

                parse_str($response_req, $responseParsed);
                
                if(array_key_exists('error', $responseParsed))
                        throw new Exception('Error getting request token: ' . $responseParsed['error']);
                        
                $requestToken = $responseParsed['oauth_token'];
                $requestTokenSecret = $responseParsed['oauth_token_secret'];
                
                return new OAuthToken($requestToken, $requestTokenSecret);
        }

Here is the call graph for this function:

getUserInfo()

sspmod_oauth_Consumer::getUserInfo	(		$url,
			$accessToken,
			$opts = NULL
	)

Definition at line 150 of file Consumer.php.

References $accessToken, $data, $url, and OAuthRequest\from_consumer_and_token().

                                                                      {
                
                $data_req = OAuthRequest::from_consumer_and_token($this->consumer, $accessToken, "GET", $url, NULL);
                $data_req->sign_request($this->signer, $this->consumer, $accessToken);

                if (is_array($opts)) {
                        $opts = stream_context_create($opts);
                }
                $data = file_get_contents($data_req->to_url(), FALSE, $opts);

                $dataDecoded = json_decode($data, TRUE);
                return $dataDecoded;
        }

Here is the call graph for this function:

postRequest()

sspmod_oauth_Consumer::postRequest	(		$url,
			$accessToken,
			$parameters
	)

Definition at line 125 of file Consumer.php.

References $accessToken, $response, $url, array, and OAuthRequest\from_consumer_and_token().

                                                                     {
                $data_req = OAuthRequest::from_consumer_and_token($this->consumer, $accessToken, "POST", $url, $parameters);
                $data_req->sign_request($this->signer, $this->consumer, $accessToken);
                $postdata = $data_req->to_postdata();

                $opts = array(
                        'ssl' => array(
                                'verify_peer' => FALSE,
                                'capture_peer_cert' => TRUE,
                                'capture_peer_chain' => TRUE,
                        ),
                        'http' => array(
                                'method' => 'POST',
                                'content' => $postdata,
                                'header' => 'Content-Type: application/x-www-form-urlencoded',
                        ),
                );
                $context = stream_context_create($opts);
                $response = file_get_contents($url, FALSE, $context);
                if ($response === FALSE) {
                        throw new SimpleSAML_Error_Exception('Failed to push definition file to ' . $url);
                }
                return $response;
        }

Here is the call graph for this function:

Field Documentation

$consumer

sspmod_oauth_Consumer::$consumer

private

Definition at line 13 of file Consumer.php.

$signer

sspmod_oauth_Consumer::$signer

private

Definition at line 14 of file Consumer.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/oauth/lib/Consumer.php