src/Module/OAuth/Token.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\Core\System;
  26 use Friendica\Database\DBA;
  27 use Friendica\DI;
  28 use Friendica\Module\BaseApi;
  29 use Friendica\Security\OAuth;
  30
  31 /**
  32  * @see https://docs.joinmastodon.org/spec/oauth/
  33  * @see https://aaronparecki.com/oauth-2-simplified/
  34  */
  35 class Token extends BaseApi
  36 {
  37         public static function post(array $parameters = [])
  38         {
  39                 $request = self::getRequest([
  40                         'client_id'     => '', // Client ID, obtained during app registration
  41                         'client_secret' => '', // Client secret, obtained during app registration
  42                         '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.
  43                         '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".
  44                         'code'          => '', // A user authorization code, obtained via /oauth/authorize
  45                         '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.
  46                 ]);
  47
  48                 // AndStatus transmits the client data in the AUTHORIZATION header field, see https://github.com/andstatus/andstatus/issues/530
  49                 if (empty($request['client_id']) && !empty($_SERVER['HTTP_AUTHORIZATION']) && (substr($_SERVER['HTTP_AUTHORIZATION'], 0, 6) == 'Basic ')) {
  50                         $datapair = explode(':', base64_decode(trim(substr($_SERVER['HTTP_AUTHORIZATION'], 6))));
  51                         if (count($datapair) == 2) {
  52                                 $request['client_id']     = $datapair[0];
  53                                 $request['client_secret'] = $datapair[1];
  54                         }
  55                 }
  56
  57                 if (empty($request['client_id']) || empty($request['client_secret'])) {
  58                         Logger::warning('Incomplete request data', ['request' => $_REQUEST]);
  59                         DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Incomplete request data'));
  60                 }
  61
  62                 $application = OAuth::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
  63                 if (empty($application)) {
  64                         DI::mstdnError()->UnprocessableEntity();
  65                 }
  66
  67                 if ($request['grant_type'] == 'client_credentials') {
  68                         // the "client_credentials" are used as a token for the application itself.
  69                         // see https://aaronparecki.com/oauth-2-simplified/#client-credentials
  70                         $token = OAuth::createTokenForUser($application, 0, '');
  71                 } elseif ($request['grant_type'] == 'authorization_code') {
  72                         // For security reasons only allow freshly created tokens
  73                         $condition = ["`redirect_uri` = ? AND `id` = ? AND `code` = ? AND `created_at` > UTC_TIMESTAMP() - INTERVAL ? MINUTE",
  74                                 $request['redirect_uri'], $application['id'], $request['code'], 5];
  75
  76                         $token = DBA::selectFirst('application-view', ['access_token', 'created_at'], $condition);
  77                         if (!DBA::isResult($token)) {
  78                                 Logger::warning('Token not found or outdated', $condition);
  79                                 DI::mstdnError()->Unauthorized();
  80                         }
  81                 } else {
  82                         Logger::warning('Unsupported or missing grant type', ['request' => $_REQUEST]);
  83                         DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing grant type'));
  84                 }
  85
  86                 $object = new \Friendica\Object\Api\Mastodon\Token($token['access_token'], 'Bearer', $application['scopes'], $token['created_at']);
  87
  88                 System::jsonExit($object->toArray());
  89         }
  90 }