sspmod_authfacebook_Auth_Source_Facebook Class Reference

Inheritance diagram for sspmod_authfacebook_Auth_Source_Facebook:

Collaboration diagram for sspmod_authfacebook_Auth_Source_Facebook:

Public Member Functions
	__construct ($info, $config)
	Constructor for this authentication source. More...
	authenticate (&$state)
	Log-in using Facebook 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 = 'facebook:init'
	The string used to identify our states. More...
const	AUTHID = 'facebook:AuthId'
	The key of the AuthId field in the state. More...

Private Attributes
	$api_key
	Facebook App ID or API Key. More...
	$secret
	Facebook App Secret. More...
	$req_perms
	Which additional data permissions to request from user. More...
	$user_fields
	A comma-separated list of user profile fields to request. More...

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 9 of file Facebook.php.

Constructor & Destructor Documentation

__construct()

sspmod_authfacebook_Auth_Source_Facebook::__construct	(		$info,
			$config
	)

Constructor for this authentication source.

Parameters

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

Definition at line 63 of file Facebook.php.

                                                    {
                assert('is_array($info)');
                assert('is_array($config)');
 
                // Call the parent constructor first, as required by the interface
                parent::__construct($info, $config);
 
                $cfgParse = SimpleSAML_Configuration::loadFromArray($config, 'authsources[' . var_export($this->authId, TRUE) . ']');
                
                $this->api_key = $cfgParse->getString('api_key');
                $this->secret = $cfgParse->getString('secret');
                $this->req_perms = $cfgParse->getString('req_perms', NULL);
                $this->user_fields = $cfgParse->getString('user_fields', NULL);
        }

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

Here is the call graph for this function:

Member Function Documentation

authenticate()

sspmod_authfacebook_Auth_Source_Facebook::authenticate

(

&

$state

)

Log-in using Facebook platform.

Parameters

array

&$state

Information about the current authentication.

Reimplemented from SimpleSAML_Auth_Source.

Definition at line 84 of file Facebook.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;
                SimpleSAML_Auth_State::saveState($state, self::STAGE_INIT);
                
                $facebook = new sspmod_authfacebook_Facebook(array('appId' => $this->api_key, 'secret' => $this->secret), $state);
                $facebook->destroySession();
 
                $linkback = SimpleSAML\Module::getModuleURL('authfacebook/linkback.php');
                $url = $facebook->getLoginUrl(array('redirect_uri' => $linkback, 'scope' => $this->req_perms));
                SimpleSAML_Auth_State::saveState($state, self::STAGE_INIT);
 
                \SimpleSAML\Utils\HTTP::redirectTrustedURL($url);
        }

References SimpleSAML_Auth_Source\$authId, $state, $url, AUTHID, SimpleSAML\Module\getModuleURL(), SimpleSAML\Utils\HTTP\redirectTrustedURL(), and SimpleSAML_Auth_State\saveState().

Here is the call graph for this function:

finalStep()

sspmod_authfacebook_Auth_Source_Facebook::finalStep

(

&

$state

)

Definition at line 102 of file Facebook.php.

                                           {
                assert('is_array($state)');
 
                $facebook = new sspmod_authfacebook_Facebook(array('appId' => $this->api_key, 'secret' => $this->secret), $state);
                $uid = $facebook->getUser();
 
                if (isset($uid) && $uid) {
                        try {
                                $info = $facebook->api("/" . $uid . ($this->user_fields ? "?fields=" . $this->user_fields : ""));
                        } catch (FacebookApiException $e) {
                                throw new SimpleSAML_Error_AuthSource($this->authId, 'Error getting user profile.', $e);
                        }
                }
 
                if (!isset($info)) {
                        throw new SimpleSAML_Error_AuthSource($this->authId, 'Error getting user profile.');
                }
                
                $attributes = array();
                foreach($info AS $key => $value) {
                        if (is_string($value) && !empty($value)) {
                                $attributes['facebook.' . $key] = array((string)$value);
                        }
                }
 
                if (array_key_exists('third_party_id', $info)) {
                        $attributes['facebook_user'] = array($info['third_party_id'] . '@facebook.com');
                } else {
                        $attributes['facebook_user'] = array($uid . '@facebook.com');
                }
 
                $attributes['facebook_targetedID'] = array('http://facebook.com!' . $uid);
                $attributes['facebook_cn'] = array($info['name']);
 
                SimpleSAML\Logger::debug('Facebook Returned Attributes: '. implode(", ", array_keys($attributes)));
 
                $state['Attributes'] = $attributes;
        
                $facebook->destroySession();
        }

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

Here is the call graph for this function:

Field Documentation

$api_key

sspmod_authfacebook_Auth_Source_Facebook::$api_key

private

Facebook App ID or API Key.

Definition at line 27 of file Facebook.php.

$req_perms

sspmod_authfacebook_Auth_Source_Facebook::$req_perms

private

Which additional data permissions to request from user.

Definition at line 39 of file Facebook.php.

$secret

sspmod_authfacebook_Auth_Source_Facebook::$secret

private

Facebook App Secret.

Definition at line 33 of file Facebook.php.

$user_fields

sspmod_authfacebook_Auth_Source_Facebook::$user_fields

private

A comma-separated list of user profile fields to request.

Note that some user fields require appropriate permissions. For example, to retrieve the user's primary email address, "email" must be specified in both the req_perms and the user_fields parameter.

When empty, only the app-specific user id and name will be returned.

See the Graph API specification for all available user fields: https://developers.facebook.com/docs/graph-api/reference/v2.6/user

Definition at line 54 of file Facebook.php.

AUTHID

const sspmod_authfacebook_Auth_Source_Facebook::AUTHID = 'facebook:AuthId'

The key of the AuthId field in the state.

Definition at line 21 of file Facebook.php.

Referenced by authenticate().

STAGE_INIT

const sspmod_authfacebook_Auth_Source_Facebook::STAGE_INIT = 'facebook:init'

The string used to identify our states.

Definition at line 15 of file Facebook.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/authfacebook/lib/Auth/Source/Facebook.php