authController.php 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * This controller handles action about authentication.
  5. */
  6. class FreshRSS_auth_Controller extends FreshRSS_ActionController {
  7. /**
  8. * This action handles authentication management page.
  9. *
  10. * Parameters are:
  11. * - token (default: current token)
  12. * - anon_access (default: false)
  13. * - anon_refresh (default: false)
  14. * - auth_type (default: none)
  15. * - api_enabled (default: false)
  16. */
  17. public function indexAction(): void {
  18. if (!FreshRSS_Auth::hasAccess('admin')) {
  19. Minz_Error::error(403);
  20. }
  21. if (FreshRSS_Auth::requestReauth()) {
  22. return;
  23. }
  24. FreshRSS_View::prependTitle(_t('admin.auth.title') . ' · ');
  25. if (Minz_Request::isPost()) {
  26. $ok = true;
  27. $anon = Minz_Request::paramBoolean('anon_access');
  28. $anon_refresh = Minz_Request::paramBoolean('anon_refresh');
  29. $auth_type = Minz_Request::paramString('auth_type') ?: 'form';
  30. $api_enabled = Minz_Request::paramBoolean('api_enabled');
  31. if ($anon !== FreshRSS_Context::systemConf()->allow_anonymous ||
  32. $auth_type !== FreshRSS_Context::systemConf()->auth_type ||
  33. $anon_refresh !== FreshRSS_Context::systemConf()->allow_anonymous_refresh ||
  34. $api_enabled !== FreshRSS_Context::systemConf()->api_enabled) {
  35. if (in_array($auth_type, ['form', 'http_auth', 'none'], true)) {
  36. FreshRSS_Context::systemConf()->auth_type = $auth_type;
  37. } else {
  38. FreshRSS_Context::systemConf()->auth_type = 'form';
  39. }
  40. FreshRSS_Context::systemConf()->allow_anonymous = $anon;
  41. FreshRSS_Context::systemConf()->allow_anonymous_refresh = $anon_refresh;
  42. FreshRSS_Context::systemConf()->api_enabled = $api_enabled;
  43. $ok &= FreshRSS_Context::systemConf()->save();
  44. }
  45. invalidateHttpCache();
  46. if ($ok) {
  47. Minz_Request::good(
  48. _t('feedback.conf.updated'),
  49. [ 'c' => 'auth', 'a' => 'index' ],
  50. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  51. );
  52. } else {
  53. Minz_Request::bad(_t('feedback.conf.error'), [ 'c' => 'auth', 'a' => 'index' ]);
  54. }
  55. }
  56. }
  57. /**
  58. * This action handles the login page.
  59. *
  60. * It forwards to the correct login page (form) or main page if
  61. * the user is already connected.
  62. */
  63. public function loginAction(): void {
  64. if (FreshRSS_Auth::hasAccess()) {
  65. Minz_Request::forward(['c' => 'index', 'a' => 'index'], true);
  66. }
  67. $auth_type = FreshRSS_Context::systemConf()->auth_type;
  68. FreshRSS_Context::initUser(Minz_User::INTERNAL_USER, false);
  69. match ($auth_type) {
  70. 'form' => Minz_Request::forward(['c' => 'auth', 'a' => 'formLogin']),
  71. 'http_auth' => Minz_Error::error(403, [
  72. 'error' => [
  73. _t('feedback.access.denied'),
  74. ' [HTTP Remote-User=' . htmlspecialchars(FreshRSS_http_Util::httpAuthUser(onlyTrusted: false), ENT_NOQUOTES, 'UTF-8') .
  75. ' ; Remote IP address=' . Minz_Request::connectionRemoteAddress() . ']'
  76. ]
  77. ], false),
  78. 'none' => Minz_Error::error(404), // It should not happen!
  79. default => Minz_Error::error(404), // TODO load plugin instead
  80. };
  81. }
  82. /**
  83. * Redirect back to the login form, while replying to the login request with an HTTP error status code (403, 500),
  84. * e.g. for fail2ban, which a normal HTTP redirection (3xx) cannot do.
  85. * The HTML redirection (POST->GET) also prevents browsers from offering to resubmit the password when reloading the page.
  86. */
  87. private static function loginFailed(int $httpCode, string $notification): void {
  88. $redirect = [
  89. 'c' => 'auth',
  90. 'a' => 'login',
  91. 'params' => ['original_request' => Minz_Request::paramString('original_request')],
  92. ];
  93. if (Minz_Request::is('auth', 'reauth')) {
  94. $redirect = [
  95. 'c' => 'auth',
  96. 'a' => 'reauth',
  97. 'params' => ['r' => Minz_Request::paramString('original_request')],
  98. ];
  99. }
  100. Minz_Request::setBadNotification($notification);
  101. Minz_Request::forward($redirect, redirect: true, httpCode: $httpCode);
  102. }
  103. /**
  104. * This action handles form login page.
  105. *
  106. * If this action is reached through a POST request, username and password
  107. * are compared against the bcrypt password hash stored in the user configuration file
  108. * to authenticate the current user.
  109. *
  110. * Parameters are:
  111. * - username (default: '')
  112. * - passwordPlain (default: '')
  113. * - keep_logged_in (default: false)
  114. *
  115. * @throws Exception
  116. */
  117. public function formLoginAction(): void {
  118. invalidateHttpCache();
  119. FreshRSS_View::prependTitle(_t('gen.auth.login') . ' · ');
  120. $this->view->auth_autofills = FreshRSS_FormAuth::getAutofilledFields();
  121. $limits = FreshRSS_Context::systemConf()->limits;
  122. $this->view->cookie_days = (int)round($limits['cookie_duration'] / 86400, 1);
  123. if (Minz_Request::isPost()) {
  124. $username = Minz_Request::paramString('username');
  125. $passwordPlain = Minz_Request::paramString('passwordPlain', plaintext: true, trim: false);
  126. $ip_address = Minz_Request::connectionRemoteAddress();
  127. if (!Minz_Session::paramBoolean('sessionOk')) {
  128. Minz_Log::warning("Invalid session during login for user={$username}, ip_address={$ip_address}");
  129. self::loginFailed(403, _t('install.session.nok'));
  130. return;
  131. }
  132. usleep(random_int(100, 10000)); // Primitive mitigation of timing attacks, in μs
  133. FreshRSS_Context::initUser($username);
  134. if (!FreshRSS_Context::hasUserConf()) {
  135. self::loginFailed(403, _t('feedback.auth.login.invalid'));
  136. return;
  137. }
  138. if (!FreshRSS_Context::userConf()->enabled || FreshRSS_Context::userConf()->passwordHash == '') {
  139. usleep(random_int(100, 5000)); // Primitive mitigation of timing attacks, in μs
  140. self::loginFailed(403, _t('feedback.auth.login.invalid'));
  141. return;
  142. }
  143. $ok = FreshRSS_FormAuth::checkCredentials(
  144. $username, FreshRSS_Context::userConf()->passwordHash, $passwordPlain
  145. );
  146. if ($ok) {
  147. try {
  148. Minz_Session::regenerateID('FreshRSS');
  149. } catch (RuntimeException $e) {
  150. Minz_Log::error("Session could not be regenerated during login for user={$username}, ip_address={$ip_address}: {$e->getMessage()}");
  151. self::loginFailed(500, _t('install.session.nok'));
  152. return;
  153. }
  154. // Set session parameters to give access to the user.
  155. Minz_Session::_params([
  156. Minz_User::CURRENT_USER => $username,
  157. 'passwordHash' => FreshRSS_Context::userConf()->passwordHash,
  158. 'csrf' => false,
  159. ]);
  160. FreshRSS_Auth::giveAccess();
  161. // Set cookie parameter if needed.
  162. if (Minz_Request::paramBoolean('keep_logged_in')) {
  163. FreshRSS_FormAuth::makeCookie($username, FreshRSS_Context::userConf()->passwordHash);
  164. } else {
  165. FreshRSS_FormAuth::deleteCookie();
  166. }
  167. Minz_Translate::init(FreshRSS_Context::userConf()->language);
  168. FreshRSS_UserDAO::touch();
  169. // All is good, go back to the original request or the index.
  170. $url = Minz_Url::unserialize(Minz_Request::paramString('original_request'));
  171. if (empty($url)) {
  172. $url = [ 'c' => 'index', 'a' => 'index' ];
  173. }
  174. Minz_Request::good(
  175. _t('feedback.auth.login.success'),
  176. $url,
  177. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  178. );
  179. } else {
  180. Minz_Log::warning("Password mismatch for user={$username}, ip_address={$ip_address}");
  181. self::loginFailed(403, _t('feedback.auth.login.invalid'));
  182. return;
  183. }
  184. } else {
  185. Minz_Session::deleteLegacyCookie('FreshRSS'); // Delete legacy cookie (before 1.29.0)
  186. Minz_Session::_param('sessionOk', true); // To be checked in the POST login request.
  187. }
  188. }
  189. public function reauthAction(): void {
  190. if (!FreshRSS_Auth::hasAccess()) {
  191. Minz_Error::error(403);
  192. return;
  193. }
  194. /** @var array{c?: string, a?: string, params?: array<string, mixed>} $redirect */
  195. $redirect = Minz_Url::unserialize(Minz_Request::paramString('r'));
  196. if (!FreshRSS_Auth::needsReauth()) {
  197. Minz_Request::forward($redirect, true);
  198. return;
  199. }
  200. if (Minz_Request::isPost()) {
  201. $username = Minz_User::name() ?? '';
  202. $passwordPlain = Minz_Request::paramString('passwordPlain', plaintext: true, trim: false);
  203. if (!FreshRSS_FormAuth::checkCredentials(
  204. $username, FreshRSS_Context::userConf()->passwordHash, $passwordPlain
  205. )) {
  206. self::loginFailed(403, _t('feedback.auth.login.invalid'));
  207. return;
  208. } else {
  209. try {
  210. Minz_Session::regenerateID('FreshRSS');
  211. Minz_Session::_param('lastReauth', time());
  212. Minz_Request::forward($redirect, redirect: true);
  213. return;
  214. } catch (RuntimeException $e) {
  215. Minz_Log::error("Session could not be regenerated during reauthentication! {$e->getMessage()}");
  216. Minz_Session::_param('lastReauth', 0);
  217. self::loginFailed(500, _t('install.session.nok'));
  218. return;
  219. }
  220. }
  221. }
  222. FreshRSS_View::prependTitle(_t('gen.auth.reauth.title') . ' · ');
  223. $this->view->auth_autofills = FreshRSS_FormAuth::getAutofilledFields();
  224. }
  225. /**
  226. * This action removes all accesses of the current user.
  227. */
  228. public function logoutAction(): void {
  229. if (Minz_Request::isPost()) {
  230. invalidateHttpCache();
  231. FreshRSS_Auth::removeAccess();
  232. Minz_Session::_param('csrf', false);
  233. try {
  234. Minz_Session::regenerateID('FreshRSS');
  235. } catch (RuntimeException $e) {
  236. Minz_Log::error('Session could not be regenerated during logout! ' . $e->getMessage());
  237. }
  238. Minz_Request::good(
  239. _t('feedback.auth.logout.success'),
  240. [ 'c' => 'index', 'a' => 'index' ],
  241. showNotification: FreshRSS_Context::userConf()->good_notification_timeout > 0
  242. );
  243. } else {
  244. Minz_Error::error(403);
  245. }
  246. }
  247. /**
  248. * This action gives possibility to a user to create an account.
  249. *
  250. * The user is redirected to the home when logged in.
  251. *
  252. * A 403 is sent if max number of registrations is reached.
  253. */
  254. public function registerAction(): void {
  255. if (FreshRSS_Auth::hasAccess()) {
  256. Minz_Request::forward(['c' => 'index', 'a' => 'index'], true);
  257. }
  258. if (FreshRSS_user_Controller::max_registrations_reached()) {
  259. Minz_Error::error(403);
  260. }
  261. $this->view->show_tos_checkbox = file_exists(TOS_FILENAME);
  262. $this->view->show_email_field = FreshRSS_Context::systemConf()->force_email_validation;
  263. $this->view->preferred_language = Minz_Translate::getLanguage(null, Minz_Request::getPreferredLanguages(), FreshRSS_Context::systemConf()->language);
  264. $this->view->auth_autofills = FreshRSS_FormAuth::getAutofilledFields();
  265. FreshRSS_View::prependTitle(_t('gen.auth.registration.title') . ' · ');
  266. }
  267. public static function getLogoutUrl(): string {
  268. if (($_SERVER['AUTH_TYPE'] ?? '') === 'openid-connect') {
  269. $url_string = urlencode(Minz_Request::guessBaseUrl());
  270. return './oidc/?logout=' . $url_string . '/';
  271. # The trailing slash is necessary so that we don’t redirect to http://.
  272. # https://bz.apache.org/bugzilla/show_bug.cgi?id=61355#c13
  273. } else {
  274. return _url('auth', 'logout');
  275. }
  276. }
  277. }