sspmod_authtwitter_Auth_Source_Twitter Class Reference

Inheritance diagram for sspmod_authtwitter_Auth_Source_Twitter:

Collaboration diagram for sspmod_authtwitter_Auth_Source_Twitter:

Public Member Functions
	__construct ($info, $config)
	Constructor for this authentication source. More...
	authenticate (&$state)
	Log-in using Twitter platform. More...
	finalStep (&$state)
Public Member Functions inherited from SimpleSAML_Auth_Source
	__construct ($info, &$config)
	Constructor for an authentication source. More...
	getAuthId ()
	Retrieve the ID of this authentication source. More...
	authenticate (&$state)
	Process a request. More...
	reauthenticate (array &$state)
	Reauthenticate an user. More...
	initLogin ($return, $errorURL=null, array $params=array())
	Start authentication. More...
	logout (&$state)
	Log out from this authentication source. More...

Data Fields
const	STAGE_INIT = 'twitter:init'
	The string used to identify our states. More...
const	AUTHID = 'twitter:AuthId'
	The key of the AuthId field in the state. More...

Private Attributes
	$key
	$secret
	$force_login
	$include_email

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML_Auth_Source
static	getSourcesOfType ($type)
	Get sources of a specific type. More...
static	completeAuth (&$state)
	Complete authentication. More...
static	loginCompleted ($state)
	Called when a login operation has finished. More...
static	completeLogout (&$state)
	Complete logout. More...
static	getById ($authId, $type=null)
	Retrieve authentication source. More...
static	logoutCallback ($state)
	Called when the authentication source receives an external logout request. More...
static	getSources ()
	Retrieve list of authentication sources. More...
Protected Member Functions inherited from SimpleSAML_Auth_Source
	addLogoutCallback ($assoc, $state)
	Add a logout callback association. More...
	callLogoutCallback ($assoc)
	Call a logout callback based on association. More...
Static Protected Member Functions inherited from SimpleSAML_Auth_Source
static	validateSource ($source, $id)
	Make sure that the first element of an auth source is its identifier. More...
Protected Attributes inherited from SimpleSAML_Auth_Source
	$authId

Detailed Description

Definition at line 11 of file Twitter.php.

Constructor & Destructor Documentation

__construct()

sspmod_authtwitter_Auth_Source_Twitter::__construct	(		$info,
			$config
	)

Constructor for this authentication source.

Parameters

array	$info	Information about this authentication source.
array	$config	Configuration.

Definition at line 49 of file Twitter.php.

References $config, $info, and SimpleSAML_Configuration\loadFromArray().

    {
                assert(is_array($info));
                assert(is_array($config));

                // Call the parent constructor first, as required by the interface
                parent::__construct($info, $config);

                $configObject = SimpleSAML_Configuration::loadFromArray($config, 'authsources[' . var_export($this->authId, true) . ']');

                $this->key = $configObject->getString('key');
                $this->secret = $configObject->getString('secret');
                $this->force_login = $configObject->getBoolean('force_login', false);
                $this->include_email = $configObject->getBoolean('include_email', false);
        }

Here is the call graph for this function:

Member Function Documentation

authenticate()

sspmod_authtwitter_Auth_Source_Twitter::authenticate

(

&

$state

)

Log-in using Twitter platform.

Parameters

array

&$state

Information about the current authentication.

Definition at line 71 of file Twitter.php.

References SimpleSAML_Auth_Source\$authId, $state, $url, SimpleSAML\Logger\debug(), SimpleSAML\Module\getModuleURL(), and SimpleSAML_Auth_State\saveState().

    {
                assert(is_array($state));

                // We are going to need the authId in order to retrieve this authentication source later
                $state[self::AUTHID] = $this->authId;
                
                $stateID = SimpleSAML_Auth_State::saveState($state, self::STAGE_INIT);
                
                $consumer = new sspmod_oauth_Consumer($this->key, $this->secret);
                // Get the request token
                $linkback = SimpleSAML\Module::getModuleURL('authtwitter/linkback.php', array('AuthState' => $stateID));
                $requestToken = $consumer->getRequestToken('https://api.twitter.com/oauth/request_token', array('oauth_callback' => $linkback));
                SimpleSAML\Logger::debug("Got a request token from the OAuth service provider [" .
                        $requestToken->key . "] with the secret [" . $requestToken->secret . "]");

                $state['authtwitter:authdata:requestToken'] = $requestToken;
                SimpleSAML_Auth_State::saveState($state, self::STAGE_INIT);

                // Authorize the request token
                $url = 'https://api.twitter.com/oauth/authenticate';
                if ($this->force_login) {
                        $url = \SimpleSAML\Utils\HTTP::addURLParameters($url, array('force_login' => 'true'));
                }
                $consumer->getAuthorizeRequest($url, $requestToken);
        }

Here is the call graph for this function:

finalStep()

sspmod_authtwitter_Auth_Source_Twitter::finalStep

(

&

$state

)

Definition at line 99 of file Twitter.php.

References $attributes, $key, $state, and SimpleSAML\Logger\debug().

    {
                $requestToken = $state['authtwitter:authdata:requestToken'];
                $parameters = array();

                if (!isset($_REQUEST['oauth_token'])) {
                        throw new SimpleSAML_Error_BadRequest("Missing oauth_token parameter.");
                }
                if ($requestToken->key !== (string)$_REQUEST['oauth_token']) {
                        throw new SimpleSAML_Error_BadRequest("Invalid oauth_token parameter.");
                }

                if (!isset($_REQUEST['oauth_verifier'])) {
                        throw new SimpleSAML_Error_BadRequest("Missing oauth_verifier parameter.");
                }
                $parameters['oauth_verifier'] = (string)$_REQUEST['oauth_verifier'];
                
                $consumer = new sspmod_oauth_Consumer($this->key, $this->secret);
                
                SimpleSAML\Logger::debug("oauth: Using this request token [" .
                        $requestToken->key . "] with the secret [" . $requestToken->secret . "]");

                // Replace the request token with an access token
                $accessToken = $consumer->getAccessToken('https://api.twitter.com/oauth/access_token', $requestToken, $parameters);
                SimpleSAML\Logger::debug("Got an access token from the OAuth service provider [" .
                        $accessToken->key . "] with the secret [" . $accessToken->secret . "]");

                $verify_credentials_url = 'https://api.twitter.com/1.1/account/verify_credentials.json';
                if ($this->include_email) {
                        $verify_credentials_url = $verify_credentials_url . '?include_email=true';
                }
                $userdata = $consumer->getUserInfo($verify_credentials_url, $accessToken);
                
                if (!isset($userdata['id_str']) || !isset($userdata['screen_name'])) {
                        throw new SimpleSAML_Error_AuthSource($this->authId, 'Authentication error: id_str and screen_name not set.');
                }

                $attributes = array();
                foreach ($userdata as $key => $value) {
                        if (is_string($value)) {
                                $attributes['twitter.' . $key] = array((string)$value);
            }
                }
                
                $attributes['twitter_at_screen_name'] = array('@' . $userdata['screen_name']);
                $attributes['twitter_screen_n_realm'] = array($userdata['screen_name'] . '@twitter.com');
                $attributes['twitter_targetedID'] = array('http://twitter.com!' . $userdata['id_str']);
                        
                $state['Attributes'] = $attributes;
        }

Here is the call graph for this function:

Field Documentation

$force_login

sspmod_authtwitter_Auth_Source_Twitter::$force_login

private

Definition at line 36 of file Twitter.php.

$include_email

sspmod_authtwitter_Auth_Source_Twitter::$include_email

private

Definition at line 41 of file Twitter.php.

$key

sspmod_authtwitter_Auth_Source_Twitter::$key

private

Definition at line 26 of file Twitter.php.

Referenced by finalStep().

$secret

sspmod_authtwitter_Auth_Source_Twitter::$secret

private

Definition at line 31 of file Twitter.php.

AUTHID

const sspmod_authtwitter_Auth_Source_Twitter::AUTHID = 'twitter:AuthId'

The key of the AuthId field in the state.

Definition at line 21 of file Twitter.php.

STAGE_INIT

const sspmod_authtwitter_Auth_Source_Twitter::STAGE_INIT = 'twitter:init'

The string used to identify our states.

Definition at line 16 of file Twitter.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/authtwitter/lib/Auth/Source/Twitter.php