Inheritance diagram for sspmod_oauth_OAuthStore:

Collaboration diagram for sspmod_oauth_OAuthStore:

Public Member Functions
	__construct ()

	authorize ($requestTokenKey, $data)
	Attach the data to the token, and establish the Callback URL and verifier. More...

	isAuthorized ($requestToken, $verifier='')
	Perform lookup whether a given token exists in the list of authorized tokens; if a verifier is passed as well, the verifier must match the verifier that was registered with the token Note that an accessToken should never be stored with a verifier. More...

	getAuthorizedData ($token, $verifier='')

	moveAuthorizedData ($requestToken, $verifier, $accessTokenKey)

	lookup_consumer ($consumer_key)

	lookup_token ($consumer, $tokenType='default', $token)

	lookup_nonce ($consumer, $token, $nonce, $timestamp)

	new_request_token ($consumer, $callback=null, $version=null)

	new_access_token ($requestToken, $consumer, $verifier=null)

	lookup_consumer_by_requestToken ($requestTokenKey)
	Return OAuthConsumer-instance that a given requestToken was issued to. More...

Public Member Functions inherited from OAuthDataStore
	lookup_consumer ($consumer_key)

	lookup_token ($consumer, $token_type, $token)

	lookup_nonce ($consumer, $token, $nonce, $timestamp)

	new_request_token ($consumer, $callback=null)

	new_access_token ($token, $consumer, $verifier=null)

Protected Attributes
	$_store_tables

Private Attributes
	$store

	$config

	$defaultversion = '1.0'

Detailed Description

Definition at line 14 of file OAuthStore.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_oauth_OAuthStore::__construct ( )

Definition at line 29 of file OAuthStore.php.

References SimpleSAML_Configuration\getOptionalConfig().

                            {
                 $this->store = new sspmod_core_Storage_SQLPermanentStorage('oauth');
                 $this->config = SimpleSAML_Configuration::getOptionalConfig('module_oauth.php');
     }

Here is the call graph for this function:

Member Function Documentation

◆ authorize()

sspmod_oauth_OAuthStore::authorize	(	$requestTokenKey,
		$data
	)

Attach the data to the token, and establish the Callback URL and verifier.

Parameters

$requestTokenKey	RequestToken that was authorized
$data	Data that is authorized and to be attached to the requestToken

Returns: array(string:url, string:verifier) ; empty verifier for 1.0-response

Definition at line 41 of file OAuthStore.php.

References $data, $defaultversion, $url, $version, array, SimpleSAML\Utils\Random\generateID(), and lookup_consumer().

                                                            {
                 $url = null;
                 $verifier = '';
                 $version = $this->defaultversion;
                 
                 // See whether to remember values from the original requestToken request:
                 $request_attributes = $this->store->get('requesttorequest', $requestTokenKey, '');      // must be there ..
                 if ($request_attributes['value']) {
                         // establish version to work with
                         $v = $request_attributes['value']['version'];
                         if ($v) $version = $v; 
                         
                         // establish callback to use
                         if ($request_attributes['value']['callback']) {
                                 $url = $request_attributes['value']['callback'];
                         }
                 }
                 
                 
                 // Is there a callback registered? This is leading, even over a supplied oauth_callback-parameter
                 $oConsumer = $this->lookup_consumer($request_attributes['value']['consumerKey']);
                 
                 if ($oConsumer && ($oConsumer->callback_url)) $url = $oConsumer->callback_url;
                 
                 $verifier = SimpleSAML\Utils\Random::generateID();
                 $url = \SimpleSAML\Utils\HTTP::addURLParameters($url, array("oauth_verifier"=>$verifier));
                 
                 $this->store->set('authorized', $requestTokenKey, $verifier, $data, $this->config->getValue('requestTokenDuration', 60*30) );
                 
                 return array($url, $verifier);
         }

Here is the call graph for this function:

◆ getAuthorizedData()

sspmod_oauth_OAuthStore::getAuthorizedData	(	$token,
		$verifier = `''`
	)

Definition at line 86 of file OAuthStore.php.

References $data, and SimpleSAML\Logger\info().

Referenced by moveAuthorizedData().

                                                                   {
                 SimpleSAML\Logger::info('OAuth getAuthorizedData(' . $token . ')');
                 $data = $this->store->get('authorized', $token, $verifier);
                 return $data['value'];
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAuthorized()

sspmod_oauth_OAuthStore::isAuthorized	(	$requestToken,
		$verifier = `''`
	)

Perform lookup whether a given token exists in the list of authorized tokens; if a verifier is passed as well, the verifier must match the verifier that was registered with the token
Note that an accessToken should never be stored with a verifier.

Parameters

$requestToken
$verifier

Returns: unknown_type

Definition at line 81 of file OAuthStore.php.

References $requestToken, and SimpleSAML\Logger\info().

                                                                   {
                 SimpleSAML\Logger::info('OAuth isAuthorized(' . $requestToken . ')');
                 return $this->store->exists('authorized', $requestToken, $verifier);
         }

Here is the call graph for this function:

◆ lookup_consumer()

sspmod_oauth_OAuthStore::lookup_consumer ( $consumer_key )

Definition at line 106 of file OAuthStore.php.

References $consumer, and SimpleSAML\Logger\info().

Referenced by authorize().

                                                    {
                 SimpleSAML\Logger::info('OAuth lookup_consumer(' . $consumer_key . ')');
                 if (! $this->store->exists('consumers', $consumer_key, ''))  return NULL;
                 $consumer = $this->store->get('consumers', $consumer_key, '');
                 
                 $callback = NULL;
                 if ($consumer['value']['callback_url']) $callback = $consumer['value']['callback_url'];
 
                 if ($consumer['value']['RSAcertificate']) {
                         return new OAuthConsumer($consumer['value']['key'], $consumer['value']['RSAcertificate'], $callback);
                 } else {
                         return new OAuthConsumer($consumer['value']['key'], $consumer['value']['secret'], $callback);
                 }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookup_consumer_by_requestToken()

sspmod_oauth_OAuthStore::lookup_consumer_by_requestToken ( $requestTokenKey )

Return OAuthConsumer-instance that a given requestToken was issued to.

Parameters

$requestTokenKey

Returns: unknown_type

Definition at line 170 of file OAuthStore.php.

References $consumer, and SimpleSAML\Logger\info().

                                                                       {
                 SimpleSAML\Logger::info('OAuth lookup_consumer_by_requestToken(' . $requestTokenKey . ')');
                 if (! $this->store->exists('requesttorequest', $requestTokenKey, '')) return NULL;
                 
                 $request = $this->store->get('requesttorequest', $requestTokenKey, '');
                 $consumerKey = $request['value']['consumerKey'];
                 if (! $consumerKey) {
                         return NULL;
                 }
                 
                 $consumer = $this->store->get('consumers', $consumerKey['value'], '');
                 return $consumer['value'];
         }

Here is the call graph for this function:

◆ lookup_nonce()

sspmod_oauth_OAuthStore::lookup_nonce	(	$consumer,
		$token,
		$nonce,
		$timestamp
	)

Definition at line 128 of file OAuthStore.php.

References $consumer, and SimpleSAML\Logger\info().

                                                                  {
                 SimpleSAML\Logger::info('OAuth lookup_nonce(' . $consumer . ', ' . $token. ',' . $nonce . ')');
                 if ($this->store->exists('nonce', $nonce, $consumer->key))  return TRUE;
                 $this->store->set('nonce', $nonce, $consumer->key, TRUE, $this->config->getValue('nonceCache', 60*60*24*14));
                 return FALSE;
     }

Here is the call graph for this function:

◆ lookup_token()

sspmod_oauth_OAuthStore::lookup_token	(	$consumer,
		$tokenType = `'default'`,
		$token
	)

Definition at line 121 of file OAuthStore.php.

References $consumer, $data, and SimpleSAML\Logger\info().

                                                                      {
                 SimpleSAML\Logger::info('OAuth lookup_token(' . $consumer->key . ', ' . $tokenType. ',' . $token . ')');
                 $data = $this->store->get($tokenType, $token, $consumer->key);
                 if ($data == NULL) throw new Exception('Could not find token');
                 return $data['value'];
     }

Here is the call graph for this function:

◆ moveAuthorizedData()

sspmod_oauth_OAuthStore::moveAuthorizedData	(	$requestToken,
		$verifier,
		$accessTokenKey
	)

Definition at line 92 of file OAuthStore.php.

References $requestToken, getAuthorizedData(), and SimpleSAML\Logger\info().

                                                                                       {
                 SimpleSAML\Logger::info('OAuth moveAuthorizedData(' . $requestToken . ', ' . $accessTokenKey . ')');
 
                 // Retrieve authorizedData from authorized.requestToken (with provider verifier)
                 $authorizedData = $this->getAuthorizedData($requestToken, $verifier);
                 
                 // Remove the requesttoken+verifier from authorized store
                 $this->store->remove('authorized', $requestToken, $verifier);
                 
                 // Add accesstoken with authorizedData to authorized store (with empty verifier)
                 // accessTokenKey+consumer => accessToken is already registered in 'access'-table
                 $this->store->set('authorized', $accessTokenKey, '', $authorizedData, $this->config->getValue('accessTokenDuration', 60*60*24));
         }

Here is the call graph for this function:

◆ new_access_token()

sspmod_oauth_OAuthStore::new_access_token	(	$requestToken,
		$consumer,
		$verifier = `null`
	)

Definition at line 158 of file OAuthStore.php.

References $consumer, $requestToken, and SimpleSAML\Logger\info().

                                                                           {
                 SimpleSAML\Logger::info('OAuth new_access_token(' . $requestToken . ',' . $consumer . ')');
                 $accestoken = new OAuthToken(SimpleSAML\Utils\Random::generateID(), SimpleSAML\Utils\Random::generateID());
                 $this->store->set('access', $accestoken->key, $consumer->key, $accestoken, $this->config->getValue('accessTokenDuration', 60*60*24) );
         return $accestoken;
     }

Here is the call graph for this function:

◆ new_request_token()

sspmod_oauth_OAuthStore::new_request_token	(	$consumer,
		$callback = `null`,
		$version = `null`
	)

Definition at line 135 of file OAuthStore.php.

References $consumer, $version, array, and SimpleSAML\Logger\info().

                                                                              {
                 SimpleSAML\Logger::info('OAuth new_request_token(' . $consumer . ')');
                 
                 $lifetime = $this->config->getValue('requestTokenDuration', 60*30); 
                 
                 $token = new OAuthToken(SimpleSAML\Utils\Random::generateID(), SimpleSAML\Utils\Random::generateID());
                 $token->callback = $callback;   // OAuth1.0-RevA
                 $this->store->set('request', $token->key, $consumer->key, $token, $lifetime);
                 
                 // also store in requestToken->key => array('callback'=>CallbackURL, 'version'=>oauth_version
                 $request_attributes = array(
                                 'callback' => $callback, 
                                 'version' => ($version?$version:$this->defaultversion),
                                 'consumerKey' => $consumer->key,
                         );
                 $this->store->set('requesttorequest', $token->key, '', $request_attributes, $lifetime);
                 
                 // also store in requestToken->key => Consumer->key (enables consumer-lookup during reqToken-authorization stage)
                 $this->store->set('requesttoconsumer', $token->key, '', $consumer->key, $lifetime);
                 
         return $token;
     }

Here is the call graph for this function:

Field Documentation

◆ $_store_tables

sspmod_oauth_OAuthStore::$_store_tables

protected

Initial value:

= array(
                                        'consumers' => 'consumer = array with consumer attributes', 
                                        'nonce' => 'nonce+consumer_key = -boolean-',
                                        'requesttorequest' => 'requestToken.key = array(version,callback,consumerKey,)',
                                        'authorized' => 'requestToken.key, verifier = array(authenticated-user-attributes)',
                                        'access' => 'accessToken.key+consumerKey = accestoken',
                                        'request' => 'requestToken.key+consumerKey = requesttoken',
                                )

Definition at line 20 of file OAuthStore.php.

◆ $config

sspmod_oauth_OAuthStore::$config

private

Definition at line 17 of file OAuthStore.php.

◆ $defaultversion

sspmod_oauth_OAuthStore::$defaultversion = '1.0'

private

Definition at line 18 of file OAuthStore.php.

Referenced by authorize().

◆ $store

sspmod_oauth_OAuthStore::$store

private

Definition at line 16 of file OAuthStore.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/oauth/lib/OAuthStore.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ authorize()

◆ getAuthorizedData()

◆ isAuthorized()

◆ lookup_consumer()

◆ lookup_consumer_by_requestToken()

◆ lookup_nonce()

◆ lookup_token()

◆ moveAuthorizedData()

◆ new_access_token()

◆ new_request_token()

Field Documentation

◆ $_store_tables

◆ $config

◆ $defaultversion

◆ $store