src/Module/OAuth/Token.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2024, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module\OAuth;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\Core\System;
  26 use Friendica\Database\DBA;
  27 use Friendica\DI;
  28 use Friendica\Model\User;
  29 use Friendica\Module\BaseApi;
  30 use Friendica\Module\Special\HTTPException;
  31 use Friendica\Security\OAuth;
  32 use Friendica\Util\DateTimeFormat;
  33 use GuzzleHttp\Psr7\Uri;
  34 use Psr\Http\Message\ResponseInterface;
  35
  36 /**
  37  * @see https://docs.joinmastodon.org/methods/oauth/#token
  38  * @see https://aaronparecki.com/oauth-2-simplified/
  39  */
  40 class Token extends BaseApi
  41 {
  42         public function run(HTTPException $httpException, array $request = [], bool $scopecheck = true): ResponseInterface
  43         {
  44                 return parent::run($httpException, $request, false);
  45         }
  46
  47         protected function post(array $request = [])
  48         {
  49                 $request = $this->getRequest([
  50                         'client_id'     => '', // Client ID, obtained during app registration
  51                         'client_secret' => '', // Client secret, obtained during app registration
  52                         'redirect_uri'  => '', // Set a URI to redirect the user to. If this parameter is set to "urn:ietf:wg:oauth:2.0:oob" then the token will be shown instead. Must match one of the redirect URIs declared during app registration.
  53                         'scope'         => 'read', // List of requested OAuth scopes, separated by spaces. Must be a subset of scopes declared during app registration. If not provided, defaults to "read".
  54                         'code'          => '', // A user authorization code, obtained via /oauth/authorize
  55                         'grant_type'    => '', // Set equal to "authorization_code" if code is provided in order to gain user-level access. Otherwise, set equal to "client_credentials" to obtain app-level access only.
  56                 ], $request);
  57
  58                 // AndStatus transmits the client data in the AUTHORIZATION header field, see https://github.com/andstatus/andstatus/issues/530
  59                 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
  60                 if (empty($authorization)) {
  61                         // workaround for HTTP-auth in CGI mode
  62                         $authorization = $_SERVER['REDIRECT_REMOTE_USER'] ?? '';
  63                 }
  64
  65                 if ((empty($request['client_id']) || empty($request['client_secret'])) && substr($authorization, 0, 6) == 'Basic ') {
  66                         // Per RFC2617, usernames can't contain a colon but password can,
  67                         // so we cut on the first colon to obtain the username and the password
  68                         // @see https://www.rfc-editor.org/rfc/rfc2617#section-2
  69                         $datapair = explode(':', base64_decode(trim(substr($authorization, 6))), 2);
  70                         if (count($datapair) == 2) {
  71                                 $request['client_id']     = $datapair[0];
  72                                 $request['client_secret'] = $datapair[1];
  73                         }
  74                 }
  75
  76                 if (empty($request['client_id']) || empty($request['client_secret'])) {
  77                         $this->logger->warning('Incomplete request data', ['request' => $request]);
  78                         $this->logAndJsonError(401, $this->errorFactory->Unauthorized('invalid_client', $this->t('Incomplete request data')));;
  79                 }
  80
  81                 $application = OAuth::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
  82                 if (empty($application)) {
  83                         $this->logAndJsonError(401, $this->errorFactory->Unauthorized('invalid_client', $this->t('Invalid data or unknown client')));
  84                 }
  85
  86                 if ($request['grant_type'] == 'client_credentials') {
  87                         // the "client_credentials" are used as a token for the application itself.
  88                         // see https://aaronparecki.com/oauth-2-simplified/#client-credentials
  89                         $token = OAuth::createTokenForUser($application, 0, '');
  90                         $me = null;
  91                 } elseif ($request['grant_type'] == 'authorization_code') {
  92                         // For security reasons only allow freshly created tokens
  93                         $redirect_uri = strtok($request['redirect_uri'],'?');
  94                         $condition = [
  95                                 "`redirect_uri` LIKE ? AND `id` = ? AND `code` = ? AND `created_at` > ?",
  96                                 $redirect_uri, $application['id'], $request['code'], DateTimeFormat::utc('now - 5 minutes')
  97                         ];
  98
  99                         $token = DBA::selectFirst('application-view', ['access_token', 'created_at', 'uid'], $condition);
 100                         if (!DBA::isResult($token)) {
 101                                 $this->logger->notice('Token not found or outdated', $condition);
 102                                 $this->logAndJsonError(401, $this->errorFactory->Unauthorized());
 103                         }
 104                         $owner = User::getOwnerDataById($token['uid']);
 105                         $me = $owner['url'];
 106                 } else {
 107                         Logger::warning('Unsupported or missing grant type', ['request' => $_REQUEST]);
 108                         $this->logAndJsonError(422, $this->errorFactory->UnprocessableEntity($this->t('Unsupported or missing grant type')));
 109                 }
 110
 111                 $object = new \Friendica\Object\Api\Mastodon\Token($token['access_token'], 'Bearer', $application['scopes'], $token['created_at'], $me);
 112
 113                 $this->jsonExit($object->toArray());
 114         }
 115 }