user.php 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860
  1. <?php
  2. /**
  3. * A framework for simple user authentication.
  4. *
  5. * Users are recorded using {username, password, token} triplets.
  6. * Whenever a user logs in successfully, his or her database
  7. * entry is assigned a new random token, which is used in
  8. * salting subsequent password checks.
  9. */
  10. $databaseConfig = parse_ini_file('databaseLocation.ini.php', true);
  11. define('USER_HOME', $databaseConfig['databaseLocation'] . '/users/');
  12. define('DATABASE_LOCATION', $databaseConfig['databaseLocation'] . '/');
  13. if(!empty($databaseConfig['timezone'])) : define('TIMEZONE', $databaseConfig['timezone']); else : define('TIMEZONE', 'America/Los_Angeles'); endif;
  14. if(!empty($databaseConfig['titleLogo'])) : define('TITLELOGO', $databaseConfig['titleLogo']); else : define('TITLELOGO', ''); endif;
  15. if(!empty($databaseConfig['loadingIcon'])) : define('LOADINGICON', $databaseConfig['loadingIcon']); else : define('LOADINGICON', ''); endif;
  16. if(!empty($databaseConfig['multipleLogin'])) : define('MULTIPLELOGIN', $databaseConfig['multipleLogin']); else : define('MULTIPLELOGIN', 'false'); endif;
  17. if(!empty($databaseConfig['cookiePassword'])) : define('COOKIEPASSWORD', $databaseConfig['cookiePassword']); else : define('COOKIEPASSWORD', ''); endif;
  18. if(!empty($databaseConfig['registerPassword'])) : define('REGISTERPASSWORD', $databaseConfig['registerPassword']); else : define('REGISTERPASSWORD', ''); endif;
  19. define('FAIL_LOG', 'loginLog.json');
  20. date_default_timezone_set(TIMEZONE);
  21. class User
  22. {
  23. // =======================================================================
  24. // IMPORTANT VALUES THAT YOU *NEED* TO CHANGE FOR THIS TO BE SECURE
  25. // =======================================================================
  26. // Keeping this location on ./... means that it will be publically visible to all,
  27. // and you need to use htaccess rules or some such to ensure no one
  28. // grabs your user's data.
  29. //const USER_HOME = "../users/";
  30. // In order for users to be notified by email of certain things, set this to true.
  31. // Note that the server you run this on should have sendmail in order for
  32. // notification emails to work. Also note that password resetting doesn't work
  33. // unless mail notification is turned on.
  34. const use_mail = true;
  35. // This value should point to a directory that is not available to web users.
  36. // If your documents are in ./public_html, for instance., then put database
  37. // in something like ./database - that way, you don't have to rely on
  38. // htaccess rules or the likes, because it's simply impossible to get to the
  39. // database from a public, or private, URL.
  40. //
  41. // By default it's set to the stupidly dangerous and publically accessible same
  42. // base dir as your web page. So change it, because people are going to try
  43. // to download your database file. And succeed.
  44. //const DATABASE_LOCATION = "../";
  45. // if this is set to "true", registration failure due to known usernames is reported,
  46. // and login failures are explained as either the wrong username or the wrong password.
  47. // You really want to set this to 'false', but it's on true by default because goddamnit
  48. // I'm going to confront you with security issues right off the bat =)
  49. const unsafe_reporting = false;
  50. /**
  51. Think about security for a moment. On the one hand, you want your website
  52. to not reveal whether usernames are already taken, so when people log in
  53. you will want to say "username or password incorrect". However, you also want
  54. to be able to tell people that they can't register because the username they
  55. picked is already taken.
  56. Because these are mutually exclusive, you can't do both using this framework.
  57. You can either use unsafe reporting, where the system will will tell you that
  58. a username exists, both during registration and login, or you can use safe
  59. reporting, and then the system will reject registrations based on username
  60. similarity, not exact match. But then it also won't say which of the username
  61. or password in a login attempt was incorrect.
  62. **/
  63. // =======================================================================
  64. // You can modify the following values, but they're not security related
  65. // =======================================================================
  66. // rename this to whatever you like
  67. const DATABASE_NAME = "users";
  68. // this is the session timeout. If someone hasn't performed any page requests
  69. // in [timeout] seconds, they're considered logged out.
  70. const time_out = 604800;
  71. // You'll probably want to change this to something sensible. If your site is
  72. // www.sockmonkey.com, then you want this to be "sockmonkey.com"
  73. const DOMAIN_NAME = "Organizr";
  74. // This is going to be the "from" address
  75. const MAILER_NAME = "noreply@organizr";
  76. // if you want people to be able to reply to a real address, override
  77. // this variable to "yourmail@somedomain.ext" here.
  78. const MAILER_REPLYTO = "noreply@organizr";
  79. // =======================================================================
  80. // Don't modify any variables beyond this point =)
  81. // =======================================================================
  82. // this is the global error message. If anything goes wrong, this tells you why.
  83. var $error = "";
  84. // progress log
  85. var $info_log = array();
  86. // Information logging
  87. function info($string) { $this->info_log[] = $string; }
  88. // error log
  89. var $error_log = array();
  90. // Error logging
  91. function error($string) { $this->error_log[] = $string; }
  92. // all possible values for a hexadecimal number
  93. var $hex = "0123456789abcdef";
  94. // all possible values for an ascii password, skewed a bit so the number to letter ratio is closer to 1:1
  95. var $ascii = "0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6A7B8C9D0E1F2G3H4I5J6K7L8M9N0O1P2Q3R4S5T6U7V8W9X0Y1Z23456789";
  96. // the regular expression for email matching (see http://www.regular-expressions.info/email.html)
  97. const emailregexp = "/[a-z0-9!#$%&'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/";
  98. // the regular expression for SHA1 hash matching
  99. const sha1regexp = "/[0123456789abcdef]{40,40}/";
  100. // this will tell us whether the client that requested the page is authenticated or not.
  101. var $authenticated = false;
  102. // the guest user name
  103. const GUEST_USER = "guest user";
  104. // this will contain the user name for the user doing the page request
  105. var $username = User::GUEST_USER;
  106. // if this is a properly logged in user, this will contain the data directory location for this user
  107. var $userdir = false;
  108. // the user's email address, if logged in.
  109. var $email = "";
  110. // the user's role in the system
  111. var $role = "";
  112. // global database handle
  113. var $database = false;
  114. // class object constructor
  115. function __construct($registration_callback=false)
  116. {
  117. // session management comes first. Warnings are repressed with @ because it will warn if something else already called session_start()
  118. @session_start();
  119. if(!isset($_COOKIE['Organizr'])) {
  120. if (empty($_SESSION["username"]) || empty($_SESSION["token"])) $this->resetSession();
  121. }else{
  122. $_SESSION["username"] = $_COOKIE['OrganizrU'];
  123. }
  124. // file location for the user database
  125. $dbfile = DATABASE_LOCATION . User::DATABASE_NAME . ".db";
  126. // do we need to build a new database?
  127. $rebuild = false;
  128. if(!file_exists($dbfile)) { $rebuild = true;}
  129. // bind the database handler
  130. $this->database = new PDO("sqlite:" . $dbfile);
  131. // If we need to rebuild, the file will have been automatically made by the PDO call,
  132. // but we'll still need to define the user table before we can use the database.
  133. if($rebuild) { $this->rebuild_database($dbfile); }
  134. // finally, process the page request.
  135. $this->process($registration_callback);
  136. }
  137. // this function rebuilds the database if there is no database to work with yet
  138. function rebuild_database($dbfile)
  139. {
  140. $this->info("rebuilding database as ".$dbfile);
  141. $this->database->beginTransaction();
  142. $create = "CREATE TABLE users (username TEXT UNIQUE, password TEXT, email TEXT UNIQUE, token TEXT, role TEXT, active TEXT, last TEXT);";
  143. $this->database->exec($create);
  144. $this->database->commit();
  145. }
  146. // process a page request
  147. function process(&$registration_callback=false)
  148. {
  149. $this->database->beginTransaction();
  150. if(isset($_POST["op"]))
  151. {
  152. $operation = $_POST["op"];
  153. // logging in or out, and dropping your registration, may change authentication status
  154. if($operation == "login") { $this->authenticated = $this->login(); }
  155. // logout and unregister will unset authentication if successful
  156. elseif($operation == "logout") { $this->authenticated = !$this->logout(); }
  157. elseif($operation == "unregister") { $this->authenticated = !$this->unregister(); }
  158. // anything else won't change authentication status.
  159. elseif($operation == "register") { $this->register($registration_callback); }
  160. elseif($operation == "update") { $this->update(); }
  161. // we only allow password resetting if we can send notification mails
  162. elseif($operation == "reset" && User::use_mail) { $this->reset_password(); }
  163. }
  164. // if the previous operations didn't authorise the current user,
  165. // see if they're already marked as authorised in the database.
  166. if(!$this->authenticated) {
  167. $username = $_SESSION["username"];
  168. if($username != User::GUEST_USER) {
  169. $this->authenticated = $this->authenticate_user($username,"");
  170. if($this->authenticated) { $this->mark_user_active($username); }}}
  171. // at this point we can make some globals available.
  172. $this->username = $_SESSION["username"];
  173. $this->userdir = ($this->username !=User::GUEST_USER? USER_HOME . $this->username : false);
  174. $this->email = $this->get_user_email($this->username);
  175. $this->role = $this->get_user_role($this->username);
  176. // clear database
  177. $this->database->commit();
  178. $this->database = null;
  179. }
  180. // ---------------------
  181. // validation passthroughs
  182. // ---------------------
  183. /**
  184. * Called when the requested POST operation is "login"
  185. */
  186. function login()
  187. {
  188. // get relevant values
  189. $username = $_POST["username"];
  190. $sha1 = $_POST["sha1"];
  191. $rememberMe = $_POST["rememberMe"];
  192. // step 1: someone could have bypassed the javascript validation, so validate again.
  193. if(!$this->validate_user_name($username)) {
  194. $this->info("log in error: user name did not pass validation");
  195. return false; }
  196. if(preg_match(User::sha1regexp, $sha1)==0) {
  197. $this->info("log in error: password did not pass validation");
  198. return false; }
  199. // step 2: if validation passed, log the user in
  200. if($rememberMe == "true") {
  201. return $this->login_user($username, $sha1, true);
  202. }else{
  203. return $this->login_user($username, $sha1, false);
  204. }
  205. }
  206. /**
  207. * Called when the requested POST operation is "logout"
  208. */
  209. function logout()
  210. {
  211. // get relevant value
  212. $username = $_POST["username"];
  213. // step 1: validate the user name.
  214. if(!$this->validate_user_name($username)) {
  215. $this->info("log in error: user name did not pass validation");
  216. return false; }
  217. // step 2: if validation passed, log the user out
  218. return $this->logout_user($username);
  219. }
  220. /**
  221. * Users should always have the option to unregister
  222. */
  223. function unregister()
  224. {
  225. // get relevant value
  226. $username = $_POST["username"];
  227. // step 1: validate the user name.
  228. if(!$this->validate_user_name($username)) {
  229. $this->info("unregistration error: user name did not pass validation");
  230. return false; }
  231. // step 2: if validation passed, drop the user from the system
  232. return $this->unregister_user($username);
  233. }
  234. /**
  235. * Called when the requested POST operation is "register"
  236. */
  237. function register(&$registration_callback=false)
  238. {
  239. // get relevant values
  240. $username = $_POST["username"];
  241. $email = $_POST["email"];
  242. $sha1 = $_POST["sha1"];
  243. // step 1: someone could have bypassed the javascript validation, so validate again.
  244. if(!$this->validate_user_name($username)) {
  245. $this->info("registration error: user name did not pass validation");
  246. return false; }
  247. if(preg_match(User::emailregexp, $email)==0) {
  248. $this->info("registration error: email address did not pass validation");
  249. return false; }
  250. if(preg_match(User::sha1regexp, $sha1)==0) {
  251. $this->info("registration error: password did not pass validation");
  252. return false; }
  253. // step 2: if validation passed, register user
  254. $registered = $this->register_user($username, $email, $sha1, $registration_callback);
  255. if($registered && User::use_mail)
  256. {
  257. // send email notification
  258. $from = User::MAILER_NAME;
  259. $replyto = User::MAILER_REPLYTO;
  260. $domain_name = User::DOMAIN_NAME;
  261. $subject = User::DOMAIN_NAME . " registration";
  262. $body = <<<EOT
  263. Hi,
  264. this is an automated message to let you know that someone signed up at $domain_name with the user name "$username", using this email address as mailing address.
  265. Because of the way our user registration works, we have no idea which password was used to register this account (it gets one-way hashed by the browser before it is sent to our user registration system, so that we don't know your password either), so if you registered this account, hopefully you wrote your password down somewhere.
  266. However, if you ever forget your password, you can click the "I forgot my password" link in the log-in section for $domain_name and you will be sent an email containing a new, ridiculously long and complicated password that you can use to log in. You can change your password after logging in, but that's up to you. No one's going to guess it, or brute force it, but if other people can read your emails, it's generally a good idea to change passwords.
  267. If you were not the one to register this account, you can either contact us the normal way or —much easier— you can ask the system to reset the password for the account, after which you can simply log in with the temporary password and delete the account. That'll teach whoever pretended to be you not to mess with you!
  268. Of course, if you did register it yourself, welcome to $domain_name!
  269. - the $domain_name team
  270. EOT;
  271. $headers = "From: $from\r\n";
  272. $headers .= "Reply-To: $replyto\r\n";
  273. $headers .= "X-Mailer: PHP/" . phpversion();
  274. mail($email, $subject, $body, $headers);
  275. }
  276. return $registered;
  277. }
  278. /**
  279. * Called when the requested POST operation is "update"
  280. */
  281. function update()
  282. {
  283. // get relevant values
  284. $email = trim($_POST["email"]);
  285. $sha1 = trim($_POST["sha1"]);
  286. $role = trim($_POST["role"]);
  287. // step 1: someone could have bypassed the javascript validation, so validate again.
  288. if($email !="" && preg_match(User::emailregexp, $email)==0) {
  289. $this->info("registration error: email address did not pass validation");
  290. return false; }
  291. if($sha1 !="" && preg_match(User::sha1regexp, $sha1)==0) {
  292. $this->info("registration error: password did not pass validation");
  293. return false; }
  294. // step 2: if validation passed, update the user's information
  295. return $this->update_user($email, $sha1, $role);
  296. }
  297. /**
  298. * Reset a user's password
  299. */
  300. function reset_password()
  301. {
  302. // get the email for which we should reset
  303. $email = $_POST["email"];
  304. // step 1: someone could have bypassed the javascript validation, so validate again.
  305. if(preg_match(User::emailregexp, $email)==0) {
  306. $this->info("email address did not pass validation");
  307. return false; }
  308. // step 2: if validation passed, see if there is a matching user, and reset the password if there is
  309. $newpassword = $this->random_ascii_string(64);
  310. $sha1 = sha1($newpassword);
  311. $query = "SELECT username, token FROM users WHERE email = '$email'";
  312. $username = "";
  313. $token = "";
  314. foreach($this->database->query($query) as $data) { $username = $data["username"]; $token = $data["token"]; break; }
  315. // step 2a: if there was no user to reset a password for, stop.
  316. if($username == "" || $token == "") return false;
  317. // step 2b: if there was a user to reset a password for, reset it.
  318. $dbpassword = $this->token_hash_password($username, $sha1, $token);
  319. $update = "UPDATE users SET password = '$dbpassword' WHERE email= '$email'";
  320. $this->database->exec($update);
  321. $this->info("Email has been sent with new password");
  322. // step 3: notify the user of the new password
  323. $from = User::MAILER_NAME;
  324. $replyto = User::MAILER_REPLYTO;
  325. $domain_name = User::DOMAIN_NAME;
  326. $subject = User::DOMAIN_NAME . " password reset request";
  327. $body = <<<EOT
  328. Hi,
  329. this is an automated message to let you know that someone requested a password reset for the $domain_name user account with user name "$username", which is linked to this email address.
  330. We've reset the password to the following 64 character string, so make sure to copy/paste it without any leading or trailing spaces:
  331. $newpassword
  332. If you didn't even know this account existed, now is the time to log in and delete it. How dare people use your email address to register accounts! Of course, if you did register it yourself, but you didn't request the reset, some jerk is apparently reset-spamming. We hope he gets run over by a steam shovel driven by rabid ocelots or something.
  333. Then again, it's far more likely that you did register this account, and you simply forgot the password so you asked for the reset yourself, in which case: here's your new password, and thank you for your patronage at $domain_name!
  334. - the $domain_name team
  335. EOT;
  336. $headers = "From: $from\r\n";
  337. $headers .= "Reply-To: $replyto\r\n";
  338. $headers .= "X-Mailer: PHP/" . phpversion();
  339. mail($email, $subject, $body, $headers);
  340. }
  341. // ------------------
  342. // specific functions
  343. // ------------------
  344. // session management: set session values
  345. function setSession($username, $token)
  346. {
  347. $_SESSION["username"]=$username;
  348. $_SESSION["token"]=$token;
  349. }
  350. // session management: reset session values
  351. function resetSession()
  352. {
  353. $_SESSION["username"] = User::GUEST_USER;
  354. $_SESSION["token"] = -1;
  355. }
  356. /**
  357. * Validate a username. Empty usernames or names
  358. * that are modified by making them SQL safe are
  359. * considered not validated.
  360. */
  361. function validate_user_name($username)
  362. {
  363. $cleaned = $this->clean_SQLite_string($username);
  364. $validated = ($cleaned != "" && $cleaned==$username);
  365. if(!$validated) { $this->error = "user name did not pass validation."; $this->error("user name did not pass validation."); }
  366. return $validated;
  367. }
  368. /**
  369. * Clean strings for SQL insertion as string in SQLite (single quote enclosed).
  370. * Note that if the cleaning changes the string, this system won't insert.
  371. * The validate_user_name() function will flag this as a validation failure and
  372. * the database operation is never carried out.
  373. */
  374. function clean_SQLite_string($string)
  375. {
  376. $search = array("'", "\\", ";");
  377. $replace = array('', '', '');
  378. return trim(str_replace($search, $replace, $string));
  379. }
  380. /**
  381. * Verify that the given username is allowed
  382. * to perform the given operation.
  383. */
  384. function authenticate_user($username, $operation)
  385. {
  386. // actually logged in?
  387. if($this->is_user_active($username)===false) { return false; }
  388. // logged in, but do the tokens match?
  389. $token = $this->get_user_token($username);
  390. if(MULTIPLELOGIN == "false"){
  391. if(isset($_COOKIE["Organizr"])){
  392. if($_COOKIE["Organizr"] == $token){
  393. return true;
  394. }else{
  395. $this->error("cookie token mismatch for $username");
  396. unset($_COOKIE['Organizr']);
  397. setcookie('Organizr', '', time() - 3600, '/');
  398. unset($_COOKIE['OrganizrU']);
  399. setcookie('OrganizrU', '', time() - 3600, '/');
  400. unset($_COOKIE['cookiePassword']);
  401. setcookie("cookiePassword", '', time() - 3600, '/');
  402. return false;
  403. }
  404. }else{
  405. if($token != $_SESSION["token"]) {
  406. $this->error("token mismatch for $username");
  407. return false;
  408. }
  409. // active, using the correct token -> authenticated
  410. return true;
  411. }
  412. }else{
  413. return true;
  414. }
  415. }
  416. /**
  417. * Unicode friendly(ish) version of strtolower
  418. * see: http://ca3.php.net/manual/en/function.strtolower.php#91805
  419. */
  420. function strtolower_utf8($string)
  421. {
  422. $convert_to = array( "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u",
  423. "v", "w", "x", "y", "z", "à", "á", "â", "ã", "ä", "å", "æ", "ç", "è", "é", "ê", "ë", "ì", "í", "î", "ï",
  424. "ð", "ñ", "ò", "ó", "ô", "õ", "ö", "ø", "ù", "ú", "û", "ü", "ý", "а", "б", "в", "г", "д", "е", "ё", "ж",
  425. "з", "и", "й", "к", "л", "м", "н", "о", "п", "р", "с", "т", "у", "ф", "х", "ц", "ч", "ш", "щ", "ъ", "ы",
  426. "ь", "э", "ю", "я" );
  427. $convert_from = array( "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U",
  428. "V", "W", "X", "Y", "Z", "À", "Á", "Â", "Ã", "Ä", "Å", "Æ", "Ç", "È", "É", "Ê", "Ë", "Ì", "Í", "Î", "Ï",
  429. "Ð", "Ñ", "Ò", "Ó", "Ô", "Õ", "Ö", "Ø", "Ù", "Ú", "Û", "Ü", "Ý", "А", "Б", "В", "Г", "Д", "Е", "Ё", "Ж",
  430. "З", "И", "Й", "К", "Л", "М", "Н", "О", "П", "Р", "С", "Т", "У", "Ф", "Х", "Ц", "Ч", "Ш", "Щ", "Ъ", "Ъ",
  431. "Ь", "Э", "Ю", "Я" );
  432. return str_replace($convert_from, $convert_to, $string);
  433. }
  434. /**
  435. * This functions flattens user name strings for similarity comparison purposes
  436. */
  437. function homogenise_username($string)
  438. {
  439. // cut off trailing numbers
  440. $string = preg_replace("/\d+$/", '', $string);
  441. // and then replace non-terminal numbers with
  442. // their usual letter counterparts.
  443. $s = array("1","3","4","5","7","8","0");
  444. $r = array("i","e","a","s","t","ate","o");
  445. $string = str_replace($s, $r, $string);
  446. // finally, collapse case
  447. return $this->strtolower_utf8($string);
  448. }
  449. /**
  450. * We don't require assloads of personal information.
  451. * A username and a password are all we want. The rest
  452. * is profile information that can be set, but in no way
  453. * needs to be, in the user's profile section
  454. */
  455. function register_user($username, $email, $sha1, &$registration_callback = false)
  456. {
  457. $dbpassword = $this->token_hash_password($username, $sha1, "");
  458. if($dbpassword==$sha1) die("password hashing is not implemented.");
  459. $newRole = "admin";
  460. $queryAdmin = "SELECT username FROM users";
  461. foreach($this->database->query($queryAdmin) as $data) {
  462. $newRole = "user";
  463. }
  464. // Does user already exist? (see notes on safe reporting)
  465. if(User::unsafe_reporting) {
  466. $query = "SELECT username FROM users WHERE username LIKE '$username'";
  467. foreach($this->database->query($query) as $data) {
  468. $this->info("user account for $username not created.");
  469. $this->error = "this user name is already being used by someone else.";
  470. $this->error("this user name is already being used by someone else.");
  471. return false; }}
  472. else{ $query = "SELECT username FROM users";
  473. $usernames = array();
  474. foreach($this->database->query($query) as $data) { $usernames[] = $this->homogenise_username($data["username"]); }
  475. if(in_array($this->homogenise_username($username), $usernames)) {
  476. $this->info("user account for $username not created.");
  477. $this->error = "this user name is not allowed, because it is too similar to other user names.";
  478. $this->error("this user name is not allowed, because it is too similar to other user names.");
  479. return false; }}
  480. // Is email address already in use? (see notes on safe reporting)
  481. $query = "SELECT * FROM users WHERE email = '$email'";
  482. foreach($this->database->query($query) as $data) {
  483. $this->info("user account for $username not created.");
  484. $this->error = "this email address is already in use by someone else.";
  485. $this->error("this email address is already in use by someone else.");
  486. return false; }
  487. // This user can be registered
  488. $insert = "INSERT INTO users (username, email, password, token, role, active, last) ";
  489. $insert .= "VALUES ('$username', '$email', '$dbpassword', '', '$newRole', 'false', '') ";
  490. $this->database->exec($insert);
  491. $query = "SELECT * FROM users WHERE username = '$username'";
  492. foreach($this->database->query($query) as $data) {
  493. $this->info("created user account for $username");
  494. $this->update_user_token($username, $sha1, false);
  495. // make the user's data directory
  496. $dir = USER_HOME . $username;
  497. if(!mkdir($dir, 0760, true)) { $this->error("could not make user directory $dir"); return false; }
  498. $this->info("created user directory $dir");
  499. // if there is a callback, call it
  500. if($registration_callback !== false) { $registration_callback($username, $email, $dir); }
  501. return true; }
  502. $this->error = "unknown database error occured.";
  503. $this->error("unknown database error occured.");
  504. return false;
  505. }
  506. /**
  507. * Log a user in
  508. */
  509. function login_user($username, $sha1, $remember)
  510. {
  511. function buildLog($username, $authType){
  512. if(file_exists(FAIL_LOG)) {
  513. $getFailLog = str_replace("\r\ndate", "date", file_get_contents(FAIL_LOG));
  514. $gotFailLog = json_decode($getFailLog, true);
  515. }
  516. $failLogEntryFirst = array('logType' => 'login_log', 'auth' => array(array('date' => date("Y-m-d H:i:s"), 'username' => $username, 'ip' => $_SERVER['REMOTE_ADDR'], 'auth_type' => $authType)));
  517. $failLogEntry = array('date' => date("Y-m-d H:i:s"), 'username' => $username, 'ip' => $_SERVER['REMOTE_ADDR'], 'auth_type' => $authType);
  518. if(isset($gotFailLog)) {
  519. array_push($gotFailLog["auth"], $failLogEntry);
  520. $writeFailLog = str_replace("date", "\r\ndate", json_encode($gotFailLog));
  521. }else{
  522. $writeFailLog = str_replace("date", "\r\ndate", json_encode($failLogEntryFirst));
  523. }
  524. return $writeFailLog;
  525. }
  526. // transform sha1 into real password
  527. $dbpassword = $this->token_hash_password($username, $sha1, $this->get_user_token($username));
  528. if($dbpassword==$sha1) {
  529. $this->info("password hashing is not implemented.");
  530. return false; }
  531. // perform the authentication step
  532. $query = "SELECT password FROM users WHERE username = '$username'";
  533. foreach($this->database->query($query) as $data) {
  534. if($dbpassword==$data["password"]) {
  535. // authentication passed - 1) mark active and update token
  536. $this->mark_user_active($username);
  537. $this->setSession($username, $this->update_user_token($username, $sha1, false));
  538. // authentication passed - 2) signal authenticated
  539. if($remember == "true") {
  540. setcookie("Organizr", $this->get_user_token($username), time() + (86400 * 7), "/");
  541. setcookie("OrganizrU", $username, time() + (86400 * 7), "/");
  542. }
  543. $this->info("Welcome $username");
  544. file_put_contents(FAIL_LOG, buildLog($username, "good_auth"));
  545. chmod(FAIL_LOG, 0660);
  546. setcookie("cookiePassword", COOKIEPASSWORD, time() + (86400 * 7), "/");
  547. return true;
  548. }
  549. // authentication failed
  550. //$this->info("password mismatch for $username");
  551. file_put_contents(FAIL_LOG, buildLog($username, "bad_auth"));
  552. chmod(FAIL_LOG, 0660);
  553. if(User::unsafe_reporting) { $this->error = "incorrect password for $username."; $this->error("incorrect password for $username."); }
  554. else { $this->error = "the specified username/password combination is incorrect."; $this->error("the specified username/password combination is incorrect."); }
  555. return false; }
  556. // authentication could not take place
  557. //$this->info("there was no user $username in the database");
  558. file_put_contents(FAIL_LOG, buildLog($username, "bad_auth"));
  559. chmod(FAIL_LOG, 0660);
  560. if(User::unsafe_reporting) { $this->error = "user $username is unknown."; $this->error("user $username is unknown."); }
  561. else { $this->error = "you either did not correctly input your username, or password (... or both)."; $this->error("you either did not correctly input your username, or password (... or both)."); }
  562. return false;
  563. }
  564. /**
  565. * Update a user's information
  566. */
  567. function update_user($email, $sha1, $role)
  568. {
  569. $username = $_SESSION["username"];
  570. if($email !="") {
  571. $update = "UPDATE users SET email = '$email' WHERE username = '$username'";
  572. $this->database->exec($update); }
  573. if($role !="") {
  574. $update = "UPDATE users SET role = '$role' WHERE username = '$username'";
  575. $this->database->exec($update); }
  576. if($sha1 !="") {
  577. $dbpassword = $this->token_hash_password($username, $sha1, $this->get_user_token($username));
  578. $update = "UPDATE users SET password = '$dbpassword' WHERE username = '$username'";
  579. $this->database->exec($update); }
  580. $this->info("update the information for $username");
  581. }
  582. /**
  583. * Log a user out.
  584. */
  585. function logout_user($username)
  586. {
  587. $update = "UPDATE users SET active = 'false' WHERE username = '$username'";
  588. $this->database->exec($update);
  589. $this->resetSession();
  590. $this->info("logged $username out");
  591. unset($_COOKIE['Organizr']);
  592. setcookie('Organizr', '', time() - 3600, '/');
  593. unset($_COOKIE['OrganizrU']);
  594. setcookie('OrganizrU', '', time() - 3600, '/');
  595. unset($_COOKIE['cookiePassword']);
  596. setcookie("cookiePassword", '', time() - 3600, '/');
  597. return true;
  598. }
  599. /**
  600. * Drop a user from the system
  601. */
  602. function unregister_user($username)
  603. {
  604. $delete = "DELETE FROM users WHERE username = '$username'";
  605. $this->database->exec($delete);
  606. $this->info("removed $username from the Organizr");
  607. //$this->resetSession();
  608. $dir = USER_HOME . $username;
  609. if(!rmdir($dir)) { $this->error("could not delete user directory $dir"); }
  610. $this->info("deleted user directory $dir");
  611. return true;
  612. }
  613. /**
  614. * The incoming password will already be a sha1 print (40 bytes) long,
  615. * but for the database we want it to be hased as sha256 (using 64 bytes).
  616. */
  617. function token_hash_password($username, $sha1, $token)
  618. {
  619. return hash("sha256", $username . $sha1 . $token);
  620. }
  621. /**
  622. * Get a user's email address
  623. */
  624. function get_user_email($username)
  625. {
  626. if($username && $username !="" && $username !=User::GUEST_USER) {
  627. $query = "SELECT email FROM users WHERE username = '$username'";
  628. foreach($this->database->query($query) as $data) { return $data["email"]; }}
  629. return "";
  630. }
  631. /**
  632. * Get a user's role
  633. */
  634. function get_user_role($username)
  635. {
  636. if($username && $username !="" && $username !=User::GUEST_USER) {
  637. $query = "SELECT role FROM users WHERE username = '$username'";
  638. foreach($this->database->query($query) as $data) { return $data["role"]; }}
  639. return User::GUEST_USER;
  640. }
  641. /**
  642. * Get the user token
  643. */
  644. function get_user_token($username)
  645. {
  646. $query = "SELECT token FROM users WHERE username = '$username'";
  647. foreach($this->database->query($query) as $data) { return $data["token"]; }
  648. return false;
  649. }
  650. /**
  651. * Update the user's token and password upon successful login
  652. */
  653. function update_user_token($username, $sha1, $noMsg)
  654. {
  655. // update the user's token
  656. $token = $this->random_hex_string(32);
  657. $update = "UPDATE users SET token = '$token' WHERE username = '$username'";
  658. $this->database->exec($update);
  659. // update the user's password
  660. $newpassword = $this->token_hash_password($username, $sha1, $token);
  661. $update = "UPDATE users SET password = '$newpassword' WHERE username = '$username'";
  662. $this->database->exec($update);
  663. if($noMsg == "false"){
  664. $this->info("updated token and password for $username");
  665. }
  666. return $token;
  667. }
  668. /**
  669. * Mark a user as active.
  670. */
  671. function mark_user_active($username)
  672. {
  673. $update = "UPDATE users SET active = 'true', last = '" . time() . "' WHERE username = '$username'";
  674. $this->database->exec($update);
  675. //$this->info("$username has been marked currently active.");
  676. return true;
  677. }
  678. /**
  679. * Check if user can be considered active
  680. */
  681. function is_user_active($username)
  682. {
  683. $last = 0;
  684. $active = "false";
  685. $query = "SELECT last, active FROM users WHERE username = '$username'";
  686. foreach($this->database->query($query) as $data) {
  687. $last = intval($data["last"]);
  688. $active = $data["active"];
  689. break; }
  690. if($active=="true") {
  691. $diff = time() - $last;
  692. if($diff >= User::time_out) {
  693. $this->logout_user($username);
  694. $this->error("$username was active but timed out (timeout set at " . User::time_out . " seconds, difference was $diff seconds)");
  695. return false; }
  696. //$this->info("$username is active");
  697. return true; }
  698. $this->error("$username is not active");
  699. $this->resetSession();
  700. return false;
  701. }
  702. /**
  703. * Random hex string generator
  704. */
  705. function random_hex_string($len)
  706. {
  707. $string = "";
  708. $max = strlen($this->hex)-1;
  709. while($len-->0) { $string .= $this->hex[mt_rand(0, $max)]; }
  710. return $string;
  711. }
  712. /**
  713. * Random password string generator
  714. */
  715. function random_ascii_string($len)
  716. {
  717. $string = "";
  718. $max = strlen($this->ascii)-1;
  719. while($len-->0) { $string .= $this->ascii[mt_rand(0, $max)]; }
  720. return $string;
  721. }
  722. }
  723. ?>