3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Module\OAuth;
24 use Friendica\Core\Logger;
25 use Friendica\Core\System;
26 use Friendica\Database\DBA;
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 Psr\Http\Message\ResponseInterface;
36 * @see https://docs.joinmastodon.org/methods/oauth/#token
37 * @see https://aaronparecki.com/oauth-2-simplified/
39 class Token extends BaseApi
41 public function run(HTTPException $httpException, array $request = [], bool $scopecheck = true): ResponseInterface
43 return parent::run($httpException, $request, false);
46 protected function post(array $request = [])
48 $request = $this->getRequest([
49 'client_id' => '', // Client ID, obtained during app registration
50 'client_secret' => '', // Client secret, obtained during app registration
51 '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.
52 '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".
53 'code' => '', // A user authorization code, obtained via /oauth/authorize
54 '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.
57 // AndStatus transmits the client data in the AUTHORIZATION header field, see https://github.com/andstatus/andstatus/issues/530
58 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
59 if (empty($authorization)) {
60 // workaround for HTTP-auth in CGI mode
61 $authorization = $_SERVER['REDIRECT_REMOTE_USER'] ?? '';
64 if ((empty($request['client_id']) || empty($request['client_secret'])) && substr($authorization, 0, 6) == 'Basic ') {
65 // Per RFC2617, usernames can't contain a colon but password can,
66 // so we cut on the first colon to obtain the username and the password
67 // @see https://www.rfc-editor.org/rfc/rfc2617#section-2
68 $datapair = explode(':', base64_decode(trim(substr($authorization, 6))), 2);
69 if (count($datapair) == 2) {
70 $request['client_id'] = $datapair[0];
71 $request['client_secret'] = $datapair[1];
75 if (empty($request['client_id']) || empty($request['client_secret'])) {
76 Logger::warning('Incomplete request data', ['request' => $request]);
77 DI::mstdnError()->Unauthorized('invalid_client', DI::l10n()->t('Incomplete request data'));
80 $application = OAuth::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
81 if (empty($application)) {
82 DI::mstdnError()->Unauthorized('invalid_client', DI::l10n()->t('Invalid data or unknown client'));
85 if ($request['grant_type'] == 'client_credentials') {
86 // the "client_credentials" are used as a token for the application itself.
87 // see https://aaronparecki.com/oauth-2-simplified/#client-credentials
88 $token = OAuth::createTokenForUser($application, 0, '');
90 } elseif ($request['grant_type'] == 'authorization_code') {
91 // For security reasons only allow freshly created tokens
92 $condition = ["`redirect_uri` = ? AND `id` = ? AND `code` = ? AND `created_at` > ?",
93 $request['redirect_uri'], $application['id'], $request['code'], DateTimeFormat::utc('now - 5 minutes')];
95 $token = DBA::selectFirst('application-view', ['access_token', 'created_at', 'uid'], $condition);
96 if (!DBA::isResult($token)) {
97 Logger::notice('Token not found or outdated', $condition);
98 DI::mstdnError()->Unauthorized();
100 $owner = User::getOwnerDataById($token['uid']);
103 Logger::warning('Unsupported or missing grant type', ['request' => $_REQUEST]);
104 DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing grant type'));
107 $object = new \Friendica\Object\Api\Mastodon\Token($token['access_token'], 'Bearer', $application['scopes'], $token['created_at'], $me);
109 System::jsonExit($object->toArray());