LinkedIn.php 3.49 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\authclient\clients;

use yii\authclient\OAuth2;
use yii\web\HttpException;
use Yii;

/**
 * LinkedIn allows authentication via LinkedIn OAuth.
Carsten Brandt committed
16 17
 *
 * In order to use linkedIn OAuth you must register your application at <https://www.linkedin.com/secure/developer>.
18
 *
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
 * Example application configuration:
 *
 * ~~~
 * 'components' => [
 *     'authClientCollection' => [
 *         'class' => 'yii\authclient\Collection',
 *         'clients' => [
 *             'linkedin' => [
 *                 'class' => 'yii\authclient\clients\LinkedIn',
 *                 'clientId' => 'linkedin_client_id',
 *                 'clientSecret' => 'linkedin_client_secret',
 *             ],
 *         ],
 *     ]
 *     ...
 * ]
 * ~~~
 *
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
 * @see http://developer.linkedin.com/documents/authentication
 * @see https://www.linkedin.com/secure/developer
 * @see http://developer.linkedin.com/apis
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class LinkedIn extends OAuth2
{
	/**
	 * @inheritdoc
	 */
	public $authUrl = 'https://www.linkedin.com/uas/oauth2/authorization';
	/**
	 * @inheritdoc
	 */
	public $tokenUrl = 'https://www.linkedin.com/uas/oauth2/accessToken';
	/**
	 * @inheritdoc
	 */
	public $apiBaseUrl = 'https://api.linkedin.com/v1';

	/**
	 * @inheritdoc
	 */
	public function init()
	{
		parent::init();
		if ($this->scope === null) {
			$this->scope = implode(' ', [
				'r_basicprofile',
				'r_emailaddress',
			]);
		}
	}

	/**
	 * @inheritdoc
	 */
	protected function defaultNormalizeUserAttributeMap()
	{
		return [
			'email' => 'email-address',
			'first_name' => 'first-name',
			'last_name' => 'last-name',
		];
	}

	/**
	 * @inheritdoc
	 */
	protected function initUserAttributes()
	{
		$attributeNames = [
			'id',
			'email-address',
			'first-name',
			'last-name',
			'public-profile-url',
		];
		return $this->api('people/~:(' . implode(',', $attributeNames) . ')', 'GET');
	}

	/**
	 * @inheritdoc
	 */
	public function buildAuthUrl(array $params = [])
	{
		$authState = $this->generateAuthState();
		$this->setState('authState', $authState);
		$params['state'] = $authState;
		return parent::buildAuthUrl($params);
	}

	/**
	 * @inheritdoc
	 */
	public function fetchAccessToken($authCode, array $params = [])
	{
		$authState = $this->getState('authState');
		if (!isset($_REQUEST['state']) || empty($authState) || strcmp($_REQUEST['state'], $authState) !== 0) {
			throw new HttpException(400, 'Invalid auth state parameter.');
		} else {
			$this->removeState('authState');
		}
		return parent::fetchAccessToken($authCode, $params);
	}

	/**
	 * @inheritdoc
	 */
	protected function apiInternal($accessToken, $url, $method, array $params)
	{
		$params['oauth2_access_token'] = $accessToken->getToken();
		return $this->sendRequest($method, $url, $params);
	}

	/**
	 * @inheritdoc
	 */
	protected function defaultReturnUrl()
	{
		$params = $_GET;
		unset($params['code']);
		unset($params['state']);
		return Yii::$app->getUrlManager()->createAbsoluteUrl(Yii::$app->controller->getRoute(), $params);
	}

	/**
	 * Generates the auth state value.
	 * @return string auth state value.
	 */
	protected function generateAuthState() {
		return sha1(uniqid(get_class($this), true));
	}
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167

	/**
	 * @inheritdoc
	 */
	protected function defaultName()
	{
		return 'linkedin';
	}

	/**
	 * @inheritdoc
	 */
	protected function defaultTitle()
	{
		return 'LinkedIn';
	}
168
}