src/Module/OAuth/Authorize.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, 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\DI;
  26 use Friendica\Module\BaseApi;
  27 use Friendica\Security\OAuth;
  28
  29 /**
  30  * @see https://docs.joinmastodon.org/spec/oauth/
  31  * @see https://aaronparecki.com/oauth-2-simplified/
  32  */
  33 class Authorize extends BaseApi
  34 {
  35         private static $oauth_code = '';
  36
  37         /**
  38          * @param array $parameters
  39          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  40          */
  41         public static function rawContent(array $parameters = [])
  42         {
  43                 $request = self::getRequest([
  44                         'force_login'   => '', // Forces the user to re-login, which is necessary for authorizing with multiple accounts from the same instance.
  45                         'response_type' => '', // Should be set equal to "code".
  46                         'client_id'     => '', // Client ID, obtained during app registration.
  47                         'client_secret' => '', // Isn't normally provided. We will use it if present.
  48                         '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 authorization code will be shown instead. Must match one of the redirect URIs declared during app registration.
  49                         'scope'         => 'read', // List of requested OAuth scopes, separated by spaces (or by pluses, if using query parameters). Must be a subset of scopes declared during app registration. If not provided, defaults to "read".
  50                         'state'         => '',
  51                 ]);
  52
  53                 if ($request['response_type'] != 'code') {
  54                         Logger::warning('Unsupported or missing response type', ['request' => $_REQUEST]);
  55                         DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing response type'));
  56                 }
  57
  58                 if (empty($request['client_id']) || empty($request['redirect_uri'])) {
  59                         Logger::warning('Incomplete request data', ['request' => $_REQUEST]);
  60                         DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Incomplete request data'));
  61                 }
  62
  63                 $application = OAuth::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
  64                 if (empty($application)) {
  65                         DI::mstdnError()->UnprocessableEntity();
  66                 }
  67
  68                 // @todo Compare the application scope and requested scope
  69
  70                 $redirect_request = $_REQUEST;
  71                 unset($redirect_request['pagename']);
  72                 $redirect = 'oauth/authorize?' . http_build_query($redirect_request);
  73
  74                 $uid = local_user();
  75                 if (empty($uid)) {
  76                         Logger::info('Redirect to login');
  77                         DI::app()->redirect('login?return_path=' . urlencode($redirect));
  78                 } else {
  79                         Logger::info('Already logged in user', ['uid' => $uid]);
  80                 }
  81
  82                 if (!OAuth::existsTokenForUser($application, $uid) && !DI::session()->get('oauth_acknowledge')) {
  83                         Logger::info('Redirect to acknowledge');
  84                         DI::app()->redirect('oauth/acknowledge?' . http_build_query(['return_path' => $redirect, 'application' => $application['name']]));
  85                 }
  86
  87                 DI::session()->remove('oauth_acknowledge');
  88
  89                 $token = OAuth::createTokenForUser($application, $uid, $request['scope']);
  90                 if (!$token) {
  91                         DI::mstdnError()->UnprocessableEntity();
  92                 }
  93
  94                 if ($application['redirect_uri'] != 'urn:ietf:wg:oauth:2.0:oob') {
  95                         DI::app()->redirect($application['redirect_uri'] . (strpos($application['redirect_uri'], '?') ? '&' : '?') . http_build_query(['code' => $token['code'], 'state' => $request['state']]));
  96                 }
  97
  98                 self::$oauth_code = $token['code'];
  99         }
 100
 101         public static function content(array $parameters = [])
 102         {
 103                 if (empty(self::$oauth_code)) {
 104                         return '';
 105                 }
 106
 107                 return DI::l10n()->t('Please copy the following authentication code into your application and close this window: %s', self::$oauth_code);
 108         }
 109 }