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\Module\BaseApi;
29 use Friendica\Module\Special\HTTPException;
30 use Friendica\Security\OAuth;
31 use Friendica\Util\DateTimeFormat;
32 use Psr\Http\Message\ResponseInterface;
35 * @see https://docs.joinmastodon.org/methods/oauth/#token
36 * @see https://aaronparecki.com/oauth-2-simplified/
38 class Token extends BaseApi
40 public function run(HTTPException $httpException, array $request = [], bool $scopecheck = true): ResponseInterface
42 return parent::run($httpException, $request, false);
45 protected function post(array $request = [])
47 $request = $this->getRequest([
48 'client_id' => '', // Client ID, obtained during app registration
49 'client_secret' => '', // Client secret, obtained during app registration
50 '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.
51 '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".
52 'code' => '', // A user authorization code, obtained via /oauth/authorize
53 '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 // AndStatus transmits the client data in the AUTHORIZATION header field, see https://github.com/andstatus/andstatus/issues/530
57 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
58 if (empty($authorization)) {
59 // workaround for HTTP-auth in CGI mode
60 $authorization = $_SERVER['REDIRECT_REMOTE_USER'] ?? '';
63 if ((empty($request['client_id']) || empty($request['client_secret'])) && substr($authorization, 0, 6) == 'Basic ') {
64 // Per RFC2617, usernames can't contain a colon but password can,
65 // so we cut on the first colon to obtain the username and the password
66 // @see https://www.rfc-editor.org/rfc/rfc2617#section-2
67 $datapair = explode(':', base64_decode(trim(substr($authorization, 6))), 2);
68 if (count($datapair) == 2) {
69 $request['client_id'] = $datapair[0];
70 $request['client_secret'] = $datapair[1];
74 if (empty($request['client_id']) || empty($request['client_secret'])) {
75 Logger::warning('Incomplete request data', ['request' => $request]);
76 DI::mstdnError()->Unauthorized('invalid_client', DI::l10n()->t('Incomplete request data'));
79 $application = OAuth::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
80 if (empty($application)) {
81 DI::mstdnError()->Unauthorized('invalid_client', DI::l10n()->t('Invalid data or unknown client'));
84 if ($request['grant_type'] == 'client_credentials') {
85 // the "client_credentials" are used as a token for the application itself.
86 // see https://aaronparecki.com/oauth-2-simplified/#client-credentials
87 $token = OAuth::createTokenForUser($application, 0, '');
88 } elseif ($request['grant_type'] == 'authorization_code') {
89 // For security reasons only allow freshly created tokens
90 $condition = ["`redirect_uri` = ? AND `id` = ? AND `code` = ? AND `created_at` > ?",
91 $request['redirect_uri'], $application['id'], $request['code'], DateTimeFormat::utc('now - 5 minutes')];
93 $token = DBA::selectFirst('application-view', ['access_token', 'created_at'], $condition);
94 if (!DBA::isResult($token)) {
95 Logger::notice('Token not found or outdated', $condition);
96 DI::mstdnError()->Unauthorized();
99 Logger::warning('Unsupported or missing grant type', ['request' => $_REQUEST]);
100 DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing grant type'));
103 $object = new \Friendica\Object\Api\Mastodon\Token($token['access_token'], 'Bearer', $application['scopes'], $token['created_at']);
105 System::jsonExit($object->toArray());