Auth.php 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. <?php
  2. /**
  3. * This class handles all authentication process.
  4. */
  5. class FreshRSS_Auth {
  6. /**
  7. * Determines if user is connected.
  8. */
  9. private static $login_ok = false;
  10. /**
  11. * This method initializes authentication system.
  12. */
  13. public static function init() {
  14. self::$login_ok = Minz_Session::param('loginOk', false);
  15. $current_user = Minz_Session::param('currentUser', '');
  16. if ($current_user === '') {
  17. $conf = Minz_Configuration::get('system');
  18. $current_user = $conf->default_user;
  19. Minz_Session::_param('currentUser', $current_user);
  20. }
  21. if (self::$login_ok) {
  22. self::giveAccess();
  23. } elseif (self::accessControl()) {
  24. self::giveAccess();
  25. FreshRSS_UserDAO::touch($current_user);
  26. } else {
  27. // Be sure all accesses are removed!
  28. self::removeAccess();
  29. }
  30. }
  31. /**
  32. * This method checks if user is allowed to connect.
  33. *
  34. * Required session parameters are also set in this method (such as
  35. * currentUser).
  36. *
  37. * @return boolean true if user can be connected, false else.
  38. */
  39. private static function accessControl() {
  40. $conf = Minz_Configuration::get('system');
  41. $auth_type = $conf->auth_type;
  42. switch ($auth_type) {
  43. case 'form':
  44. $credentials = FreshRSS_FormAuth::getCredentialsFromCookie();
  45. $current_user = '';
  46. if (isset($credentials[1])) {
  47. $current_user = trim($credentials[0]);
  48. Minz_Session::_param('currentUser', $current_user);
  49. Minz_Session::_param('passwordHash', trim($credentials[1]));
  50. }
  51. return $current_user != '';
  52. case 'http_auth':
  53. $current_user = httpAuthUser();
  54. $login_ok = $current_user != '';
  55. if ($login_ok) {
  56. Minz_Session::_param('currentUser', $current_user);
  57. }
  58. return $login_ok;
  59. case 'none':
  60. return true;
  61. default:
  62. // TODO load extension
  63. return false;
  64. }
  65. }
  66. /**
  67. * Gives access to the current user.
  68. */
  69. public static function giveAccess() {
  70. $current_user = Minz_Session::param('currentUser');
  71. $user_conf = get_user_configuration($current_user);
  72. $system_conf = Minz_Configuration::get('system');
  73. switch ($system_conf->auth_type) {
  74. case 'form':
  75. self::$login_ok = Minz_Session::param('passwordHash') === $user_conf->passwordHash;
  76. break;
  77. case 'http_auth':
  78. self::$login_ok = strcasecmp($current_user, httpAuthUser()) === 0;
  79. break;
  80. case 'none':
  81. self::$login_ok = true;
  82. break;
  83. default:
  84. // TODO: extensions
  85. self::$login_ok = false;
  86. }
  87. Minz_Session::_param('loginOk', self::$login_ok);
  88. }
  89. /**
  90. * Returns if current user has access to the given scope.
  91. *
  92. * @param string $scope general (default) or admin
  93. * @return boolean true if user has corresponding access, false else.
  94. */
  95. public static function hasAccess($scope = 'general') {
  96. $conf = Minz_Configuration::get('system');
  97. $default_user = $conf->default_user;
  98. $ok = self::$login_ok;
  99. switch ($scope) {
  100. case 'general':
  101. break;
  102. case 'admin':
  103. $ok &= Minz_Session::param('currentUser') === $default_user;
  104. break;
  105. default:
  106. $ok = false;
  107. }
  108. return $ok;
  109. }
  110. /**
  111. * Removes all accesses for the current user.
  112. */
  113. public static function removeAccess() {
  114. Minz_Session::_param('loginOk');
  115. self::$login_ok = false;
  116. $conf = Minz_Configuration::get('system');
  117. Minz_Session::_param('currentUser', $conf->default_user);
  118. Minz_Session::_param('csrf');
  119. switch ($conf->auth_type) {
  120. case 'form':
  121. Minz_Session::_param('passwordHash');
  122. FreshRSS_FormAuth::deleteCookie();
  123. break;
  124. case 'http_auth':
  125. case 'none':
  126. // Nothing to do...
  127. break;
  128. default:
  129. // TODO: extensions
  130. }
  131. }
  132. /**
  133. * Return if authentication is enabled on this instance of FRSS.
  134. */
  135. public static function accessNeedsLogin() {
  136. $conf = Minz_Configuration::get('system');
  137. $auth_type = $conf->auth_type;
  138. return $auth_type !== 'none';
  139. }
  140. /**
  141. * Return if authentication requires a PHP action.
  142. */
  143. public static function accessNeedsAction() {
  144. $conf = Minz_Configuration::get('system');
  145. $auth_type = $conf->auth_type;
  146. return $auth_type === 'form';
  147. }
  148. public static function csrfToken() {
  149. $csrf = Minz_Session::param('csrf');
  150. if ($csrf == '') {
  151. $salt = FreshRSS_Context::$system_conf->salt;
  152. $csrf = sha1($salt . uniqid(mt_rand(), true));
  153. Minz_Session::_param('csrf', $csrf);
  154. }
  155. return $csrf;
  156. }
  157. public static function isCsrfOk($token = null) {
  158. $csrf = Minz_Session::param('csrf');
  159. if ($csrf == '') {
  160. return true; //Not logged in yet
  161. }
  162. if ($token === null) {
  163. $token = Minz_Request::fetchPOST('_csrf');
  164. }
  165. return $token === $csrf;
  166. }
  167. }
  168. class FreshRSS_FormAuth {
  169. public static function checkCredentials($username, $hash, $nonce, $challenge) {
  170. if (!ctype_alnum($username) ||
  171. !ctype_graph($challenge) ||
  172. !ctype_alnum($nonce)) {
  173. Minz_Log::debug('Invalid credential parameters:' .
  174. ' user=' . $username .
  175. ' challenge=' . $challenge .
  176. ' nonce=' . $nonce);
  177. return false;
  178. }
  179. if (!function_exists('password_verify')) {
  180. include_once(LIB_PATH . '/password_compat.php');
  181. }
  182. return password_verify($nonce . $hash, $challenge);
  183. }
  184. public static function getCredentialsFromCookie() {
  185. $token = Minz_Session::getLongTermCookie('FreshRSS_login');
  186. if (!ctype_alnum($token)) {
  187. return array();
  188. }
  189. $token_file = DATA_PATH . '/tokens/' . $token . '.txt';
  190. $mtime = @filemtime($token_file);
  191. if ($mtime + 2629744 < time()) {
  192. // Token has expired (> 1 month) or does not exist.
  193. // TODO: 1 month -> use a configuration instead
  194. @unlink($token_file);
  195. return array();
  196. }
  197. $credentials = @file_get_contents($token_file);
  198. return $credentials === false ? array() : explode("\t", $credentials, 2);
  199. }
  200. public static function makeCookie($username, $password_hash) {
  201. do {
  202. $conf = Minz_Configuration::get('system');
  203. $token = sha1($conf->salt . $username . uniqid(mt_rand(), true));
  204. $token_file = DATA_PATH . '/tokens/' . $token . '.txt';
  205. } while (file_exists($token_file));
  206. if (@file_put_contents($token_file, $username . "\t" . $password_hash) === false) {
  207. return false;
  208. }
  209. $expire = time() + 2629744; //1 month //TODO: Use a configuration instead
  210. Minz_Session::setLongTermCookie('FreshRSS_login', $token, $expire);
  211. return $token;
  212. }
  213. public static function deleteCookie() {
  214. $token = Minz_Session::getLongTermCookie('FreshRSS_login');
  215. Minz_Session::deleteLongTermCookie('FreshRSS_login');
  216. if (ctype_alnum($token)) {
  217. @unlink(DATA_PATH . '/tokens/' . $token . '.txt');
  218. }
  219. if (rand(0, 10) === 1) {
  220. self::purgeTokens();
  221. }
  222. }
  223. public static function purgeTokens() {
  224. $oldest = time() - 2629744; // 1 month // TODO: Use a configuration instead
  225. foreach (new DirectoryIterator(DATA_PATH . '/tokens/') as $file_info) {
  226. // $extension = $file_info->getExtension(); doesn't work in PHP < 5.3.7
  227. $extension = pathinfo($file_info->getFilename(), PATHINFO_EXTENSION);
  228. if ($extension === 'txt' && $file_info->getMTime() < $oldest) {
  229. @unlink($file_info->getPathname());
  230. }
  231. }
  232. }
  233. }