2019-09-30 22:03:55 +13:00
|
|
|
<?php
|
|
|
|
|
2020-03-25 06:56:32 +13:00
|
|
|
namespace Appwrite\Auth\OAuth2;
|
2019-09-30 22:03:55 +13:00
|
|
|
|
2020-03-25 06:56:32 +13:00
|
|
|
use Appwrite\Auth\OAuth2;
|
2019-09-30 22:03:55 +13:00
|
|
|
|
2020-06-25 09:05:16 +12:00
|
|
|
// Reference Material
|
2019-10-05 04:06:13 +13:00
|
|
|
// https://docs.gitlab.com/ee/api/oauth2.html
|
|
|
|
|
2020-02-17 00:41:03 +13:00
|
|
|
class Gitlab extends OAuth2
|
2019-09-30 22:03:55 +13:00
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var array
|
|
|
|
*/
|
2022-05-13 03:56:20 +12:00
|
|
|
protected array $user = [];
|
|
|
|
|
2022-02-01 23:42:11 +13:00
|
|
|
/**
|
|
|
|
* @var array
|
|
|
|
*/
|
2022-05-13 03:56:20 +12:00
|
|
|
protected array $tokens = [];
|
2019-09-30 22:03:55 +13:00
|
|
|
|
2020-01-19 04:08:46 +13:00
|
|
|
/**
|
|
|
|
* @var array
|
|
|
|
*/
|
2022-05-13 03:56:20 +12:00
|
|
|
protected array $scopes = [
|
2020-01-19 09:12:41 +13:00
|
|
|
'read_user'
|
|
|
|
];
|
2020-01-19 04:08:46 +13:00
|
|
|
|
2019-09-30 22:03:55 +13:00
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getName(): string
|
|
|
|
{
|
|
|
|
return 'gitlab';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getLoginURL(): string
|
|
|
|
{
|
2022-06-10 22:03:30 +12:00
|
|
|
return $this->getEndpoint() . '/oauth/authorize?' . \http_build_query([
|
2020-01-19 04:08:46 +13:00
|
|
|
'client_id' => $this->appID,
|
|
|
|
'redirect_uri' => $this->callback,
|
2020-06-20 23:05:43 +12:00
|
|
|
'scope' => \implode(' ', $this->getScopes()),
|
|
|
|
'state' => \json_encode($this->state),
|
2020-01-19 04:08:46 +13:00
|
|
|
'response_type' => 'code'
|
|
|
|
]);
|
2019-09-30 22:03:55 +13:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $code
|
|
|
|
*
|
2022-02-01 09:20:17 +13:00
|
|
|
* @return array
|
2019-09-30 22:03:55 +13:00
|
|
|
*/
|
2022-02-02 05:47:19 +13:00
|
|
|
protected function getTokens(string $code): array
|
2019-09-30 22:03:55 +13:00
|
|
|
{
|
2022-05-13 03:56:20 +12:00
|
|
|
if (empty($this->tokens)) {
|
2022-02-01 23:42:11 +13:00
|
|
|
$this->tokens = \json_decode($this->request(
|
|
|
|
'POST',
|
2022-06-10 22:03:30 +12:00
|
|
|
$this->getEndpoint() . '/oauth/token?' . \http_build_query([
|
2022-02-01 23:42:11 +13:00
|
|
|
'code' => $code,
|
|
|
|
'client_id' => $this->appID,
|
2022-06-11 00:05:16 +12:00
|
|
|
'client_secret' => $this->getAppSecret()['clientSecret'],
|
2022-02-01 23:42:11 +13:00
|
|
|
'redirect_uri' => $this->callback,
|
|
|
|
'grant_type' => 'authorization_code'
|
|
|
|
])
|
|
|
|
), true);
|
|
|
|
}
|
2019-09-30 22:03:55 +13:00
|
|
|
|
2022-02-01 23:42:11 +13:00
|
|
|
return $this->tokens;
|
2019-09-30 22:03:55 +13:00
|
|
|
}
|
|
|
|
|
2022-02-02 04:54:20 +13:00
|
|
|
/**
|
|
|
|
* @param string $refreshToken
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
2022-05-13 03:56:20 +12:00
|
|
|
public function refreshTokens(string $refreshToken): array
|
2022-02-02 04:54:20 +13:00
|
|
|
{
|
2022-02-02 06:13:54 +13:00
|
|
|
$this->tokens = \json_decode($this->request(
|
|
|
|
'POST',
|
2022-06-10 22:03:30 +12:00
|
|
|
$this->getEndpoint() . '/oauth/token?' . \http_build_query([
|
2022-02-02 06:13:54 +13:00
|
|
|
'refresh_token' => $refreshToken,
|
|
|
|
'client_id' => $this->appID,
|
2022-06-11 00:05:16 +12:00
|
|
|
'client_secret' => $this->getAppSecret()['clientSecret'],
|
2022-02-02 06:13:54 +13:00
|
|
|
'grant_type' => 'refresh_token'
|
|
|
|
])
|
|
|
|
), true);
|
2022-02-02 04:54:20 +13:00
|
|
|
|
2022-05-13 03:56:20 +12:00
|
|
|
if (empty($this->tokens['refresh_token'])) {
|
2022-02-04 05:05:06 +13:00
|
|
|
$this->tokens['refresh_token'] = $refreshToken;
|
|
|
|
}
|
|
|
|
|
2022-02-02 04:54:20 +13:00
|
|
|
return $this->tokens;
|
|
|
|
}
|
|
|
|
|
2019-09-30 22:03:55 +13:00
|
|
|
/**
|
|
|
|
* @param string $accessToken
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getUserID(string $accessToken): string
|
|
|
|
{
|
|
|
|
$user = $this->getUser($accessToken);
|
|
|
|
|
|
|
|
if (isset($user['id'])) {
|
|
|
|
return $user['id'];
|
|
|
|
}
|
|
|
|
|
|
|
|
return '';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $accessToken
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getUserEmail(string $accessToken): string
|
|
|
|
{
|
|
|
|
$user = $this->getUser($accessToken);
|
|
|
|
|
2022-05-13 03:56:20 +12:00
|
|
|
return $user['email'] ?? '';
|
2019-09-30 22:03:55 +13:00
|
|
|
}
|
|
|
|
|
2022-04-28 07:08:32 +12:00
|
|
|
/**
|
2022-04-28 07:14:09 +12:00
|
|
|
* Check if the OAuth email is verified
|
2022-05-24 02:54:50 +12:00
|
|
|
*
|
2022-05-06 04:17:29 +12:00
|
|
|
* @link https://docs.gitlab.com/ee/api/users.html#list-current-user-for-normal-users
|
2022-05-24 02:54:50 +12:00
|
|
|
*
|
2022-05-13 03:56:20 +12:00
|
|
|
* @param string $accessToken
|
2022-05-24 02:54:50 +12:00
|
|
|
*
|
2022-04-28 07:08:32 +12:00
|
|
|
* @return bool
|
|
|
|
*/
|
2022-04-28 08:27:21 +12:00
|
|
|
public function isEmailVerified(string $accessToken): bool
|
2022-04-28 07:08:32 +12:00
|
|
|
{
|
2022-05-06 04:17:29 +12:00
|
|
|
$user = $this->getUser($accessToken);
|
|
|
|
|
2022-05-13 03:56:20 +12:00
|
|
|
if ($user['confirmed_at'] ?? false) {
|
2022-05-06 04:17:29 +12:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2022-04-28 07:08:32 +12:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2019-09-30 22:03:55 +13:00
|
|
|
/**
|
|
|
|
* @param string $accessToken
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getUserName(string $accessToken): string
|
|
|
|
{
|
|
|
|
$user = $this->getUser($accessToken);
|
|
|
|
|
2022-05-13 03:56:20 +12:00
|
|
|
return $user['name'] ?? '';
|
2019-09-30 22:03:55 +13:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $accessToken
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
protected function getUser(string $accessToken): array
|
|
|
|
{
|
|
|
|
if (empty($this->user)) {
|
2022-06-10 22:03:30 +12:00
|
|
|
$user = $this->request('GET', $this->getEndpoint() . '/api/v4/user?access_token=' . \urlencode($accessToken));
|
2020-06-20 23:05:43 +12:00
|
|
|
$this->user = \json_decode($user, true);
|
2019-09-30 22:03:55 +13:00
|
|
|
}
|
2019-10-01 17:34:01 +13:00
|
|
|
|
2019-09-30 22:03:55 +13:00
|
|
|
return $this->user;
|
|
|
|
}
|
2022-06-10 22:03:30 +12:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Decode the JSON stored in appSecret
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
protected function getAppSecret(): array
|
|
|
|
{
|
|
|
|
try {
|
|
|
|
$secret = \json_decode($this->appSecret, true, 512, JSON_THROW_ON_ERROR);
|
|
|
|
} catch (\Throwable $th) {
|
|
|
|
throw new \Exception('Invalid secret');
|
|
|
|
}
|
|
|
|
return $secret;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Extracts the Tenant Id from the JSON stored in appSecret. Defaults to 'common' as a fallback
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
protected function getEndpoint(): string
|
|
|
|
{
|
2022-06-11 00:41:31 +12:00
|
|
|
$defaultEndpoint = 'https://gitlab.com';
|
2022-06-10 22:03:30 +12:00
|
|
|
$secret = $this->getAppSecret();
|
2022-06-11 00:41:31 +12:00
|
|
|
$endpoint = $secret['endpoint'] ?? $defaultEndpoint;
|
|
|
|
return empty($endpoint) ? $defaultEndpoint : $endpoint;
|
2022-06-10 22:03:30 +12:00
|
|
|
}
|
2019-09-30 22:03:55 +13:00
|
|
|
}
|