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.

    {
        $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 23 of file Consumer.php.

{}

getAccessToken()

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

Definition at line 113 of file Consumer.php.

References $url, SimpleSAML\Logger\debug(), SimpleSAML\Utils\HTTP\fetch(), 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);

        try {
            $response_acc = \SimpleSAML\Utils\HTTP::fetch($acc_req->to_url());
        } catch (\SimpleSAML_Error_Exception $e) {
            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 99 of file Consumer.php.

References PHPMailer\PHPMailer\$params, $url, 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 35 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 54 of file Consumer.php.

References $context, $response, $url, and SimpleSAML\Utils\HTTP\fetch().

    {
        try {
            $response = \SimpleSAML\Utils\HTTP::fetch($url);
        } catch (\SimpleSAML_Error_Exception $e) {
            $statuscode = 'unknown';
            if (preg_match('/^HTTP.*\s([0-9]{3})/', $http_response_header[0], $matches)) {
                $statuscode = $matches[1];
            }

            $error = $context . ' [statuscode: ' . $statuscode . ']: ';
            $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;
    }

Here is the call graph for this function:

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 77 of file Consumer.php.

References $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 165 of file Consumer.php.

References $data, $url, SimpleSAML\Utils\HTTP\fetch(), 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);

        $data = \SimpleSAML\Utils\HTTP::fetch($data_req->to_url(), $opts);

        return  json_decode($data, true);
    }

Here is the call graph for this function:

postRequest()

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

Definition at line 138 of file Consumer.php.

References $response, $url, SimpleSAML\Utils\HTTP\fetch(), 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',
            ),
        );

        try {
            $response = \SimpleSAML\Utils\HTTP::fetch($url, $opts);
        } catch (\SimpleSAML_Error_Exception $e) {
            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