3 * @copyright Copyright (C) 2010-2021, 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;
25 use Friendica\Core\Hook;
26 use Friendica\Core\Logger;
27 use Friendica\Core\Session;
28 use Friendica\Database\DBA;
30 use Friendica\Model\User;
31 use Friendica\Network\HTTPException\UnauthorizedException;
32 use Friendica\Util\DateTimeFormat;
35 * Authentification via the basic auth method
42 protected static $current_user_id = 0;
46 protected static $current_token = [];
49 * Get current user id, returns 0 if $login is set to false and not logged in.
50 * When $login is true, the execution will stop when not logged in.
52 * @param bool $login Perform a login request if "true"
56 public static function getCurrentUserID(bool $login)
58 if (empty(self::$current_user_id)) {
59 self::$current_user_id = self::getUserIdByAuth($login);
62 return (int)self::$current_user_id;
66 * Fetch a dummy application token
70 public static function getCurrentApplicationToken()
72 if (empty(self::getCurrentUserID(true))) {
76 if (!empty(self::$current_token)) {
77 return self::$current_token;
80 self::$current_token = [
81 'uid' => self::$current_user_id,
83 'name' => api_source(),
85 'created_at' => DBA::NULL_DATETIME,
91 return self::$current_token;
95 * Fetch the user id via the auth header information
97 * @param boolean $do_login Perform a login request if not logged in
99 * @return integer User ID
101 private static function getUserIdByAuth(bool $do_login = true):int
104 Session::set('allow_api', false);
105 self::$current_user_id = 0;
107 // workaround for HTTP-auth in CGI mode
108 if (!empty($_SERVER['REDIRECT_REMOTE_USER'])) {
109 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6));
110 if (strlen($userpass)) {
111 list($name, $password) = explode(':', $userpass);
112 $_SERVER['PHP_AUTH_USER'] = $name;
113 $_SERVER['PHP_AUTH_PW'] = $password;
117 $user = $_SERVER['PHP_AUTH_USER'] ?? '';
118 $password = $_SERVER['PHP_AUTH_PW'] ?? '';
120 // allow "user@server" login (but ignore 'server' part)
121 $at = strstr($user, "@", true);
126 // next code from mod/auth.php. needs better solution
130 'username' => trim($user),
131 'password' => trim($password),
132 'authenticated' => 0,
133 'user_record' => null,
137 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
138 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
139 * and later addons should not interfere with an earlier one that succeeded.
141 Hook::callAll('authenticate', $addon_auth);
143 if ($addon_auth['authenticated'] && !empty($addon_auth['user_record'])) {
144 $record = $addon_auth['user_record'];
147 $user_id = User::getIdFromPasswordAuthentication(trim($user), trim($password), true);
148 $record = DBA::selectFirst('user', [], ['uid' => $user_id]);
149 } catch (Exception $ex) {
154 if (empty($record)) {
158 Logger::debug('failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]);
159 header('WWW-Authenticate: Basic realm="Friendica"');
160 throw new UnauthorizedException("This API requires login");
163 // Don't refresh the login date more often than twice a day to spare database writes
164 $login_refresh = strcmp(DateTimeFormat::utc('now - 12 hours'), $record['login_date']) > 0;
166 DI::auth()->setForUser($a, $record, false, false, $login_refresh);
168 Session::set('allow_api', true);
170 Hook::callAll('logged_in', $a->user);
172 if (Session::get('allow_api')) {
173 self::$current_user_id = local_user();
175 self::$current_user_id = 0;
177 return self::$current_user_id;