Inheritance diagram for sspmod_authmyspace_Auth_Source_MySpace:

Collaboration diagram for sspmod_authmyspace_Auth_Source_MySpace:

Public Member Functions
	__construct ($info, $config)
	Constructor for this authentication source. More...

	authenticate (&$state)
	Log-in using MySpace 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 = 'authmyspace:init'
	The string used to identify our states. More...

const	AUTHID = 'authmyspace:AuthId'
	The key of the AuthId field in the state. More...

Private Attributes
	$key

	$secret

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 MySpace.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_authmyspace_Auth_Source_MySpace::__construct	(	$info,
		$config
	)

Constructor for this authentication source.

Parameters

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

Definition at line 33 of file MySpace.php.

                                                    {
                assert('is_array($info)');
                assert('is_array($config)');
 
                // Call the parent constructor first, as required by the interface
                parent::__construct($info, $config);
 
                if (!array_key_exists('key', $config))
                        throw new Exception('MySpace authentication source is not properly configured: missing [key]');
 
                $this->key = $config['key'];
 
                if (!array_key_exists('secret', $config))
                        throw new Exception('MySpace authentication source is not properly configured: missing [secret]');
 
                $this->secret = $config['secret'];
        }

References $config, and $info.

Member Function Documentation

◆ authenticate()

sspmod_authmyspace_Auth_Source_MySpace::authenticate ( & $state )

Log-in using MySpace platform.

Parameters

array &$state Information about the current authentication.

Reimplemented from SimpleSAML_Auth_Source.

Definition at line 57 of file MySpace.php.

                                              {
                assert('is_array($state)');
 
                // We are going to need the authId in order to retrieve this authentication source later
                $state[self::AUTHID] = $this->authId;
 
                $consumer = new sspmod_oauth_Consumer($this->key, $this->secret);
 
                // Get the request token
                $requestToken = $consumer->getRequestToken('http://api.myspace.com/request_token');
                SimpleSAML\Logger::debug("Got a request token from the OAuth service provider [" .
                        $requestToken->key . "] with the secret [" . $requestToken->secret . "]");
 
                $state['authmyspace:requestToken'] = $requestToken;
 
                $stateID = SimpleSAML_Auth_State::saveState($state, self::STAGE_INIT);
                SimpleSAML\Logger::debug('authmyspace auth state id = ' . $stateID);
 
                // Authorize the request token
                $consumer->getAuthorizeRequest('http://api.myspace.com/authorize', $requestToken, TRUE, SimpleSAML\Module::getModuleUrl('authmyspace') . '/linkback.php?stateid=' . $stateID);
 
        }

References SimpleSAML_Auth_Source\$authId, $consumer, $requestToken, $state, AUTHID, SimpleSAML\Logger\debug(), and SimpleSAML_Auth_State\saveState().

Here is the call graph for this function:

◆ finalStep()

sspmod_authmyspace_Auth_Source_MySpace::finalStep ( & $state )

Definition at line 82 of file MySpace.php.

                                           {
 
                $requestToken = $state['authmyspace:requestToken'];
 
                $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('http://api.myspace.com/access_token', $requestToken);
                SimpleSAML\Logger::debug("Got an access token from the OAuth service provider [" .
                        $accessToken->key . "] with the secret [" . $accessToken->secret . "]");
 
                // People API -  http://developerwiki.myspace.com/index.php?title=People_API
                $userdata = $consumer->getUserInfo('http://api.myspace.com/1.0/people/@me/@self?fields=@all', $accessToken);
 
                $attributes = array();
 
                if (is_array($userdata['person'])) {
                        foreach($userdata['person'] AS $key => $value) {
                                if (is_string($value) || is_int($value))
                                        $attributes['myspace.' . $key] = array((string)$value);
 
                                if (is_array($value)) {
                                        foreach($value AS $key2 => $value2) {
                                                if (is_string($value2) || is_int($value2))
                                                        $attributes['myspace.' . $key . '.' . $key2] = array((string)$value2);
                                        }
                                }
                        }
 
                        if (array_key_exists('id', $userdata['person']) ) {
 
                                // person-id in the format of myspace.com.person.1234567890
                                if (preg_match('/(\d+)$/',$userdata['person']['id'],$matches)) {
                                        $attributes['myspace_targetedID'] = array('http://myspace.com!' . $matches[1]);
                                        $attributes['myspace_uid'] = array($matches[1]);
                                        $attributes['myspace_user'] = array($matches[1] . '@myspace.com');
                                }
                        }
 
                        // profileUrl in the format http://www.myspace.com/username
                        if (array_key_exists('profileUrl', $userdata['person']) ) {
                                if (preg_match('@/([^/]+)$@',$userdata['person']['profileUrl'],$matches)) {
                                        $attributes['myspace_username'] = array($matches[1]);
                                        $attributes['myspace_user'] = array($matches[1] . '@myspace.com');
                                }
                        }
                }
 
                SimpleSAML\Logger::debug('MySpace Returned Attributes: '. implode(", ",array_keys($attributes)));
 
                $state['Attributes'] = $attributes;
        }

References $accessToken, $attributes, $consumer, $key, $requestToken, $state, $userdata, and SimpleSAML\Logger\debug().

Here is the call graph for this function:

Field Documentation

◆ $key

sspmod_authmyspace_Auth_Source_MySpace::$key

private

Definition at line 23 of file MySpace.php.

Referenced by finalStep().

◆ $secret

sspmod_authmyspace_Auth_Source_MySpace::$secret

private

Definition at line 24 of file MySpace.php.

◆ AUTHID

const sspmod_authmyspace_Auth_Source_MySpace::AUTHID = 'authmyspace:AuthId'

The key of the AuthId field in the state.

Definition at line 21 of file MySpace.php.

Referenced by authenticate().

◆ STAGE_INIT

const sspmod_authmyspace_Auth_Source_MySpace::STAGE_INIT = 'authmyspace:init'

The string used to identify our states.

Definition at line 16 of file MySpace.php.

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/authmyspace/lib/Auth/Source/MySpace.php

Public Member Functions

Data Fields

Private Attributes

Additional Inherited Members