]> git.mxchange.org Git - friendica.git/blob - src/Module/OAuth/Token.php
head fixings
[friendica.git] / src / Module / OAuth / Token.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2022, 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 use Friendica\Util\DateTimeFormat;
31 use Psr\Http\Message\ResponseInterface;
32
33 /**
34  * @see https://docs.joinmastodon.org/spec/oauth/
35  * @see https://aaronparecki.com/oauth-2-simplified/
36  */
37 class Token extends BaseApi
38 {
39         public function run(array $request = [], bool $scopecheck = true): ResponseInterface
40         {
41                 return parent::run($request, false);
42         }
43
44         protected function post(array $request = [])
45         {
46                 $request = $this->getRequest([
47                         'client_id'     => '', // Client ID, obtained during app registration
48                         'client_secret' => '', // Client secret, obtained during app registration
49                         '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.
50                         '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".
51                         'code'          => '', // A user authorization code, obtained via /oauth/authorize
52                         '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.
53                 ], $request);
54
55                 // AndStatus transmits the client data in the AUTHORIZATION header field, see https://github.com/andstatus/andstatus/issues/530
56                 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
57                 if (empty($authorization)) {
58                         // workaround for HTTP-auth in CGI mode
59                         $authorization = $_SERVER['REDIRECT_REMOTE_USER'] ?? '';
60                 }
61
62                 if (empty($request['client_id']) && substr($authorization, 0, 6) == 'Basic ') {
63                         $datapair = explode(':', base64_decode(trim(substr($authorization, 6))));
64                         if (count($datapair) == 2) {
65                                 $request['client_id']     = $datapair[0];
66                                 $request['client_secret'] = $datapair[1];
67                         }
68                 }
69
70                 if (empty($request['client_id']) || empty($request['client_secret'])) {
71                         Logger::warning('Incomplete request data', ['request' => $_REQUEST]);
72                         DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Incomplete request data'));
73                 }
74
75                 $application = OAuth::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
76                 if (empty($application)) {
77                         DI::mstdnError()->UnprocessableEntity();
78                 }
79
80                 if ($request['grant_type'] == 'client_credentials') {
81                         // the "client_credentials" are used as a token for the application itself.
82                         // see https://aaronparecki.com/oauth-2-simplified/#client-credentials
83                         $token = OAuth::createTokenForUser($application, 0, '');
84                 } elseif ($request['grant_type'] == 'authorization_code') {
85                         // For security reasons only allow freshly created tokens
86                         $condition = ["`redirect_uri` = ? AND `id` = ? AND `code` = ? AND `created_at` > ?",
87                                 $request['redirect_uri'], $application['id'], $request['code'], DateTimeFormat::utc('now - 5 minutes')];
88
89                         $token = DBA::selectFirst('application-view', ['access_token', 'created_at'], $condition);
90                         if (!DBA::isResult($token)) {
91                                 Logger::warning('Token not found or outdated', $condition);
92                                 DI::mstdnError()->Unauthorized();
93                         }
94                 } else {
95                         Logger::warning('Unsupported or missing grant type', ['request' => $_REQUEST]);
96                         DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing grant type'));
97                 }
98
99                 $object = new \Friendica\Object\Api\Mastodon\Token($token['access_token'], 'Bearer', $application['scopes'], $token['created_at']);
100
101                 System::jsonExit($object->toArray());
102         }
103 }