]> git.mxchange.org Git - friendica.git/blob - src/Module/OAuth/Token.php
API: New classes for OAuth and basic auth
[friendica.git] / 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                         'grant_type'    => '',
41                         'code'          => '',
42                         'redirect_uri'  => '',
43                         'client_id'     => '',
44                         'client_secret' => '',
45                 ]);
46
47                 // AndStatus transmits the client data in the AUTHORIZATION header field, see https://github.com/andstatus/andstatus/issues/530
48                 if (empty($request['client_id']) && !empty($_SERVER['HTTP_AUTHORIZATION']) && (substr($_SERVER['HTTP_AUTHORIZATION'], 0, 6) == 'Basic ')) {
49                         $datapair = explode(':', base64_decode(trim(substr($_SERVER['HTTP_AUTHORIZATION'], 6))));
50                         if (count($datapair) == 2) {
51                                 $request['client_id']     = $datapair[0];
52                                 $request['client_secret'] = $datapair[1];
53                         }
54                 }
55
56                 if (empty($request['client_id']) || empty($request['client_secret'])) {
57                         Logger::warning('Incomplete request data', ['request' => $_REQUEST]);
58                         DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Incomplete request data'));
59                 }
60
61                 $application = OAuth::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
62                 if (empty($application)) {
63                         DI::mstdnError()->UnprocessableEntity();
64                 }
65
66                 if ($request['grant_type'] == 'client_credentials') {
67                         // the "client_credentials" are used as a token for the application itself.
68                         // see https://aaronparecki.com/oauth-2-simplified/#client-credentials
69                         $token = OAuth::createTokenForUser($application, 0, '');
70                 } elseif ($request['grant_type'] == 'authorization_code') {
71                         // For security reasons only allow freshly created tokens
72                         $condition = ["`redirect_uri` = ? AND `id` = ? AND `code` = ? AND `created_at` > UTC_TIMESTAMP() - INTERVAL ? MINUTE",
73                                 $request['redirect_uri'], $application['id'], $request['code'], 5];
74
75                         $token = DBA::selectFirst('application-view', ['access_token', 'created_at'], $condition);
76                         if (!DBA::isResult($token)) {
77                                 Logger::warning('Token not found or outdated', $condition);
78                                 DI::mstdnError()->Unauthorized();
79                         }
80                 } else {
81                         Logger::warning('Unsupported or missing grant type', ['request' => $_REQUEST]);
82                         DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing grant type'));
83                 }
84
85                 $object = new \Friendica\Object\Api\Mastodon\Token($token['access_token'], 'Bearer', $application['scopes'], $token['created_at']);
86
87                 System::jsonExit($object->toArray());
88         }
89 }