3 * @copyright Copyright (C) 2010-2022, 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\Security;
24 use Friendica\Core\Logger;
25 use Friendica\Database\Database;
26 use Friendica\Database\DBA;
27 use Friendica\Module\BaseApi;
28 use Friendica\Util\DateTimeFormat;
38 protected static $current_user_id = 0;
42 protected static $current_token = [];
45 * Get current user id, returns 0 if not logged in
49 public static function getCurrentUserID()
51 if (empty(self::$current_user_id)) {
52 $token = self::getCurrentApplicationToken();
53 if (!empty($token['uid'])) {
54 self::$current_user_id = $token['uid'];
56 self::$current_user_id = 0;
60 return (int)self::$current_user_id;
64 * Get current application token
68 public static function getCurrentApplicationToken()
70 if (empty(self::$current_token)) {
71 self::$current_token = self::getTokenByBearer();
74 return self::$current_token;
78 * Get the user token via the Bearer token
80 * @return array User Token
82 private static function getTokenByBearer()
84 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
86 if (empty($authorization)) {
87 // workaround for HTTP-auth in CGI mode
88 $authorization = $_SERVER['REDIRECT_REMOTE_USER'] ?? '';
91 if (substr($authorization, 0, 7) != 'Bearer ') {
95 $condition = ['access_token' => trim(substr($authorization, 7))];
97 $token = DBA::selectFirst('application-view', ['uid', 'id', 'name', 'website', 'created_at', 'read', 'write', 'follow', 'push'], $condition);
98 if (!DBA::isResult($token)) {
99 Logger::warning('Token not found', $condition);
102 Logger::debug('Token found', $token);
107 * Get the application record via the provided request header fields
109 * @param string $client_id
110 * @param string $client_secret
111 * @param string $redirect_uri
112 * @return array application record
114 public static function getApplication(string $client_id, string $client_secret, string $redirect_uri)
116 $condition = ['client_id' => $client_id];
117 if (!empty($client_secret)) {
118 $condition['client_secret'] = $client_secret;
120 if (!empty($redirect_uri)) {
121 $condition['redirect_uri'] = $redirect_uri;
124 $application = DBA::selectFirst('application', [], $condition);
125 if (!DBA::isResult($application)) {
126 Logger::warning('Application not found', $condition);
133 * Check if an token for the application and user exists
135 * @param array $application
136 * @param integer $uid
139 public static function existsTokenForUser(array $application, int $uid)
141 return DBA::exists('application-token', ['application-id' => $application['id'], 'uid' => $uid]);
145 * Fetch the token for the given application and user
147 * @param array $application
148 * @param integer $uid
149 * @return array application record
151 public static function getTokenForUser(array $application, int $uid)
153 return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
157 * Create and fetch an token for the application and user
159 * @param array $application
160 * @param integer $uid
161 * @param string $scope
162 * @return array application record
164 public static function createTokenForUser(array $application, int $uid, string $scope)
166 $code = bin2hex(random_bytes(32));
167 $access_token = bin2hex(random_bytes(32));
170 'application-id' => $application['id'],
173 'access_token' => $access_token,
175 'read' => (stripos($scope, BaseApi::SCOPE_READ) !== false),
176 'write' => (stripos($scope, BaseApi::SCOPE_WRITE) !== false),
177 'follow' => (stripos($scope, BaseApi::SCOPE_FOLLOW) !== false),
178 'push' => (stripos($scope, BaseApi::SCOPE_PUSH) !== false),
179 'created_at' => DateTimeFormat::utcNow()];
181 foreach ([BaseApi::SCOPE_READ, BaseApi::SCOPE_WRITE, BaseApi::SCOPE_WRITE, BaseApi::SCOPE_PUSH] as $scope) {
182 if ($fields[$scope] && !$application[$scope]) {
183 Logger::warning('Requested token scope is not allowed for the application', ['token' => $fields, 'application' => $application]);
187 if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
191 return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);