user.php 33 KB

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