sspmod_authlinkedin_Auth_Source_LinkedIn Class Reference

Inheritance diagram for sspmod_authlinkedin_Auth_Source_LinkedIn:

Collaboration diagram for sspmod_authlinkedin_Auth_Source_LinkedIn:

Public Member Functions
	__construct ($info, $config)
	Constructor for this authentication source. More...
	authenticate (&$state)
	Log-in using LinkedIn platform Documentation at: http://developer.linkedin.com/docs/DOC-1008. 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 = 'authlinkedin:init'
	The string used to identify our states. More...
const	AUTHID = 'authlinkedin:AuthId'
	The key of the AuthId field in the state. More...

Protected Member Functions
	flatten ($array, $prefix='')
	takes an associative array, traverses it and returns the keys concatenated with a dot 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...

Private Attributes
	$key
	$secret
	$attributes

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

Constructor & Destructor Documentation

__construct()

sspmod_authlinkedin_Auth_Source_LinkedIn::__construct	(		$info,
			$config
	)

Constructor for this authentication source.

Parameters

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

Definition at line 35 of file LinkedIn.php.

References $config, and $info.

    {
        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('LinkedIn authentication source is not properly configured: missing [key]');

        $this->key = $config['key'];

        if (!array_key_exists('secret', $config))
            throw new Exception('LinkedIn authentication source is not properly configured: missing [secret]');

        $this->secret = $config['secret'];

        if (array_key_exists('attributes', $config)) {
            $this->attributes = $config['attributes'];
        } else {
            // Default values if the attributes are not set in config (ref https://developer.linkedin.com/docs/fields)
            $this->attributes = 'id,first-name,last-name,headline,summary,specialties,picture-url,email-address';
        }
    }

Member Function Documentation

authenticate()

sspmod_authlinkedin_Auth_Source_LinkedIn::authenticate

(

&

$state

)

Log-in using LinkedIn platform Documentation at: http://developer.linkedin.com/docs/DOC-1008.

Parameters

array

&$state

Information about the current authentication.

Definition at line 68 of file LinkedIn.php.

References SimpleSAML_Auth_Source\$authId, $state, SimpleSAML\Logger\debug(), SimpleSAML_Auth_State\getStateId(), 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::getStateId($state);
        SimpleSAML\Logger::debug('authlinkedin auth state id = ' . $stateID);

        $consumer = new sspmod_oauth_Consumer($this->key, $this->secret);

        // Get the request token
        $requestToken = $consumer->getRequestToken(
            'https://api.linkedin.com/uas/oauth/requestToken',
            array('oauth_callback' => SimpleSAML\Module::getModuleUrl('authlinkedin') . '/linkback.php?stateid=' . $stateID)
        );

        SimpleSAML\Logger::debug(
            "Got a request token from the OAuth service provider [" .
            $requestToken->key . "] with the secret [" . $requestToken->secret . "]"
        );

        $state['authlinkedin:requestToken'] = $requestToken;

        // Update the state
        SimpleSAML_Auth_State::saveState($state, self::STAGE_INIT);

        // Authorize the request token
        $consumer->getAuthorizeRequest('https://www.linkedin.com/uas/oauth/authenticate', $requestToken);
    }

Here is the call graph for this function:

finalStep()

sspmod_authlinkedin_Auth_Source_LinkedIn::finalStep

(

&

$state

)

Definition at line 101 of file LinkedIn.php.

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

    {
        $requestToken = $state['authlinkedin: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 (via GET method)
        $accessToken = $consumer->getAccessToken(
            'https://api.linkedin.com/uas/oauth/accessToken', $requestToken,
            array('oauth_verifier' => $state['authlinkedin:oauth_verifier'])
        );

        SimpleSAML\Logger::debug(
            "Got an access token from the OAuth service provider [" .
            $accessToken->key . "] with the secret [" . $accessToken->secret . "]"
        );

        $userdata = $consumer->getUserInfo(
            'https://api.linkedin.com/v1/people/~:(' . $this->attributes . ')',
            $accessToken, 
            array('http' => array('header' => 'x-li-format: json'))
        );

        $attributes = $this->flatten($userdata, 'linkedin.');

        // TODO: pass accessToken: key, secret + expiry as attributes?

        if (array_key_exists('id', $userdata)) {
            $attributes['linkedin_targetedID'] = array('http://linkedin.com!' . $userdata['id']);
            $attributes['linkedin_user'] = array($userdata['id'] . '@linkedin.com');
        }

        SimpleSAML\Logger::debug('LinkedIn Returned Attributes: '. implode(", ",array_keys($attributes)));

        $state['Attributes'] = $attributes;
    }

Here is the call graph for this function:

flatten()

sspmod_authlinkedin_Auth_Source_LinkedIn::flatten (   $array,   $prefix = ''  )

protected

takes an associative array, traverses it and returns the keys concatenated with a dot

e.g.:

[ 'linkedin' => [ 'location' => [ 'id' => '123456' 'country' => [ 'code' => 'de' ] ] ]

become:

[ 'linkedin.location.id' => [0 => '123456'], 'linkedin.location.country.code' => [0 => 'de'] ]

Parameters

array	$array
string	$prefix

Returns

array the array with the new concatenated keys

Definition at line 170 of file LinkedIn.php.

References $key, and $result.

Referenced by finalStep().

    {
        $result = array();
        foreach ($array as $key => $value) {
            if (is_array($value)) {
                $result = $result + $this->flatten($value, $prefix . $key . '.');
            } else {
                $result[$prefix . $key] = array($value);
            }
        }
        return $result;
    }

Here is the caller graph for this function:

Field Documentation

$attributes

sspmod_authlinkedin_Auth_Source_LinkedIn::$attributes

private

Definition at line 26 of file LinkedIn.php.

Referenced by finalStep().

$key

sspmod_authlinkedin_Auth_Source_LinkedIn::$key

private

Definition at line 24 of file LinkedIn.php.

Referenced by flatten().

$secret

sspmod_authlinkedin_Auth_Source_LinkedIn::$secret

private

Definition at line 25 of file LinkedIn.php.

AUTHID

const sspmod_authlinkedin_Auth_Source_LinkedIn::AUTHID = 'authlinkedin:AuthId'

The key of the AuthId field in the state.

Definition at line 22 of file LinkedIn.php.

STAGE_INIT

const sspmod_authlinkedin_Auth_Source_LinkedIn::STAGE_INIT = 'authlinkedin:init'

The string used to identify our states.

Definition at line 17 of file LinkedIn.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/authlinkedin/lib/Auth/Source/LinkedIn.php