mirror of
https://we.phorge.it/source/phorge.git
synced 2024-11-15 03:12:41 +01:00
8756d82cf6
Summary: I'm pretty sure that `@group` annotations are useless now... see D9855. Also fixed various other minor issues. Test Plan: Eye-ball it. Reviewers: #blessed_reviewers, epriestley, chad Reviewed By: #blessed_reviewers, epriestley Subscribers: epriestley, Korvin, hach-que Differential Revision: https://secure.phabricator.com/D9859
262 lines
7.6 KiB
PHP
262 lines
7.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Implements core OAuth 2.0 Server logic.
|
|
*
|
|
* This class should be used behind business logic that parses input to
|
|
* determine pertinent @{class:PhabricatorUser} $user,
|
|
* @{class:PhabricatorOAuthServerClient} $client(s),
|
|
* @{class:PhabricatorOAuthServerAuthorizationCode} $code(s), and.
|
|
* @{class:PhabricatorOAuthServerAccessToken} $token(s).
|
|
*
|
|
* For an OAuth 2.0 server, there are two main steps:
|
|
*
|
|
* 1) Authorization - the user authorizes a given client to access the data
|
|
* the OAuth 2.0 server protects. Once this is achieved / if it has
|
|
* been achived already, the OAuth server sends the client an authorization
|
|
* code.
|
|
* 2) Access Token - the client should send the authorization code received in
|
|
* step 1 along with its id and secret to the OAuth server to receive an
|
|
* access token. This access token can later be used to access Phabricator
|
|
* data on behalf of the user.
|
|
*
|
|
* @task auth Authorizing @{class:PhabricatorOAuthServerClient}s and
|
|
* generating @{class:PhabricatorOAuthServerAuthorizationCode}s
|
|
* @task token Validating @{class:PhabricatorOAuthServerAuthorizationCode}s
|
|
* and generating @{class:PhabricatorOAuthServerAccessToken}s
|
|
* @task internal Internals
|
|
*/
|
|
final class PhabricatorOAuthServer {
|
|
|
|
const AUTHORIZATION_CODE_TIMEOUT = 300;
|
|
const ACCESS_TOKEN_TIMEOUT = 3600;
|
|
|
|
private $user;
|
|
private $client;
|
|
|
|
private function getUser() {
|
|
if (!$this->user) {
|
|
throw new Exception('You must setUser before you can getUser!');
|
|
}
|
|
return $this->user;
|
|
}
|
|
|
|
public function setUser(PhabricatorUser $user) {
|
|
$this->user = $user;
|
|
return $this;
|
|
}
|
|
|
|
private function getClient() {
|
|
if (!$this->client) {
|
|
throw new Exception('You must setClient before you can getClient!');
|
|
}
|
|
return $this->client;
|
|
}
|
|
|
|
public function setClient(PhabricatorOAuthServerClient $client) {
|
|
$this->client = $client;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @task auth
|
|
* @return tuple <bool hasAuthorized, ClientAuthorization or null>
|
|
*/
|
|
public function userHasAuthorizedClient(array $scope) {
|
|
|
|
$authorization = id(new PhabricatorOAuthClientAuthorization())->
|
|
loadOneWhere('userPHID = %s AND clientPHID = %s',
|
|
$this->getUser()->getPHID(),
|
|
$this->getClient()->getPHID());
|
|
if (empty($authorization)) {
|
|
return array(false, null);
|
|
}
|
|
|
|
if ($scope) {
|
|
$missing_scope = array_diff_key($scope,
|
|
$authorization->getScope());
|
|
} else {
|
|
$missing_scope = false;
|
|
}
|
|
|
|
if ($missing_scope) {
|
|
return array(false, $authorization);
|
|
}
|
|
|
|
return array(true, $authorization);
|
|
}
|
|
|
|
/**
|
|
* @task auth
|
|
*/
|
|
public function authorizeClient(array $scope) {
|
|
$authorization = new PhabricatorOAuthClientAuthorization();
|
|
$authorization->setUserPHID($this->getUser()->getPHID());
|
|
$authorization->setClientPHID($this->getClient()->getPHID());
|
|
$authorization->setScope($scope);
|
|
$authorization->save();
|
|
|
|
return $authorization;
|
|
}
|
|
|
|
/**
|
|
* @task auth
|
|
*/
|
|
public function generateAuthorizationCode(PhutilURI $redirect_uri) {
|
|
|
|
$code = Filesystem::readRandomCharacters(32);
|
|
$client = $this->getClient();
|
|
|
|
$authorization_code = new PhabricatorOAuthServerAuthorizationCode();
|
|
$authorization_code->setCode($code);
|
|
$authorization_code->setClientPHID($client->getPHID());
|
|
$authorization_code->setClientSecret($client->getSecret());
|
|
$authorization_code->setUserPHID($this->getUser()->getPHID());
|
|
$authorization_code->setRedirectURI((string) $redirect_uri);
|
|
$authorization_code->save();
|
|
|
|
return $authorization_code;
|
|
}
|
|
|
|
/**
|
|
* @task token
|
|
*/
|
|
public function generateAccessToken() {
|
|
|
|
$token = Filesystem::readRandomCharacters(32);
|
|
|
|
$access_token = new PhabricatorOAuthServerAccessToken();
|
|
$access_token->setToken($token);
|
|
$access_token->setUserPHID($this->getUser()->getPHID());
|
|
$access_token->setClientPHID($this->getClient()->getPHID());
|
|
$access_token->save();
|
|
|
|
return $access_token;
|
|
}
|
|
|
|
/**
|
|
* @task token
|
|
*/
|
|
public function validateAuthorizationCode(
|
|
PhabricatorOAuthServerAuthorizationCode $test_code,
|
|
PhabricatorOAuthServerAuthorizationCode $valid_code) {
|
|
|
|
// check that all the meta data matches
|
|
if ($test_code->getClientPHID() != $valid_code->getClientPHID()) {
|
|
return false;
|
|
}
|
|
if ($test_code->getClientSecret() != $valid_code->getClientSecret()) {
|
|
return false;
|
|
}
|
|
|
|
// check that the authorization code hasn't timed out
|
|
$created_time = $test_code->getDateCreated();
|
|
$must_be_used_by = $created_time + self::AUTHORIZATION_CODE_TIMEOUT;
|
|
return (time() < $must_be_used_by);
|
|
}
|
|
|
|
/**
|
|
* @task token
|
|
*/
|
|
public function validateAccessToken(
|
|
PhabricatorOAuthServerAccessToken $token,
|
|
$required_scope) {
|
|
|
|
$created_time = $token->getDateCreated();
|
|
$must_be_used_by = $created_time + self::ACCESS_TOKEN_TIMEOUT;
|
|
$expired = time() > $must_be_used_by;
|
|
$authorization = id(new PhabricatorOAuthClientAuthorization())
|
|
->loadOneWhere(
|
|
'userPHID = %s AND clientPHID = %s',
|
|
$token->getUserPHID(),
|
|
$token->getClientPHID());
|
|
|
|
if (!$authorization) {
|
|
return false;
|
|
}
|
|
$token_scope = $authorization->getScope();
|
|
if (!isset($token_scope[$required_scope])) {
|
|
return false;
|
|
}
|
|
|
|
$valid = true;
|
|
if ($expired) {
|
|
$valid = false;
|
|
// check if the scope includes "offline_access", which makes the
|
|
// token valid despite being expired
|
|
if (isset(
|
|
$token_scope[PhabricatorOAuthServerScope::SCOPE_OFFLINE_ACCESS])) {
|
|
$valid = true;
|
|
}
|
|
}
|
|
|
|
return $valid;
|
|
}
|
|
|
|
/**
|
|
* See http://tools.ietf.org/html/draft-ietf-oauth-v2-23#section-3.1.2
|
|
* for details on what makes a given redirect URI "valid".
|
|
*/
|
|
public function validateRedirectURI(PhutilURI $uri) {
|
|
if (!PhabricatorEnv::isValidRemoteWebResource($uri)) {
|
|
return false;
|
|
}
|
|
|
|
if ($uri->getFragment()) {
|
|
return false;
|
|
}
|
|
|
|
if (!$uri->getDomain()) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* If there's a URI specified in an OAuth request, it must be validated in
|
|
* its own right. Further, it must have the same domain and (at least) the
|
|
* same query parameters as the primary URI.
|
|
*/
|
|
public function validateSecondaryRedirectURI(
|
|
PhutilURI $secondary_uri,
|
|
PhutilURI $primary_uri) {
|
|
|
|
// The secondary URI must be valid.
|
|
if (!$this->validateRedirectURI($secondary_uri)) {
|
|
return false;
|
|
}
|
|
|
|
// Both URIs must point at the same domain.
|
|
if ($secondary_uri->getDomain() != $primary_uri->getDomain()) {
|
|
return false;
|
|
}
|
|
|
|
// Any query parameters present in the first URI must be exactly present
|
|
// in the second URI.
|
|
$need_params = $primary_uri->getQueryParams();
|
|
$have_params = $secondary_uri->getQueryParams();
|
|
|
|
foreach ($need_params as $key => $value) {
|
|
if (!array_key_exists($key, $have_params)) {
|
|
return false;
|
|
}
|
|
if ((string)$have_params[$key] != (string)$value) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// If the first URI is HTTPS, the second URI must also be HTTPS. This
|
|
// defuses an attack where a third party with control over the network
|
|
// tricks you into using HTTP to authenticate over a link which is supposed
|
|
// to be HTTPS only and sniffs all your token cookies.
|
|
if (strtolower($primary_uri->getProtocol()) == 'https') {
|
|
if (strtolower($secondary_uri->getProtocol()) != 'https') {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
}
|