This repository has been archived on 2024-06-26. You can view files and clone it, but cannot push or open issues or pull requests.
sakura/app/Controllers/AuthController.php

640 lines
21 KiB
PHP
Raw Normal View History

2016-02-27 16:46:16 +00:00
<?php
/**
* Holds the auth controllers.
*
* @package Sakura
*/
namespace Sakura\Controllers;
2016-03-17 19:09:00 +00:00
use Sakura\ActionCode;
2016-03-31 20:03:25 +00:00
use Sakura\ActiveUser;
2016-02-27 16:46:16 +00:00
use Sakura\Config;
use Sakura\DB;
use Sakura\Net;
use Sakura\Perms\Site;
use Sakura\Router;
use Sakura\Session;
use Sakura\Template;
use Sakura\User;
/**
* Authentication controllers.
*
* @package Sakura
* @author Julian van de Groep <me@flash.moe>
*/
class AuthController extends Controller
{
2016-03-27 21:18:57 +00:00
/**
* Touch the login rate limit.
*
* @param $user int The ID of the user that attempted to log in.
* @param $sucess bool Whether the login attempt was successful.
*/
protected function touchRateLimit($user, $success = false)
2016-02-27 16:46:16 +00:00
{
DB::table('login_attempts')
->insert([
2016-03-27 21:18:57 +00:00
'attempt_success' => $success ? 1 : 0,
2016-02-27 16:46:16 +00:00
'attempt_timestamp' => time(),
2016-03-27 21:18:57 +00:00
'attempt_ip' => Net::pton(Net::ip()),
2016-02-27 16:46:16 +00:00
'user_id' => $user,
]);
}
2016-03-27 21:18:57 +00:00
/**
* End the current session.
*
* @return string
*/
2016-02-27 16:46:16 +00:00
public function logout()
{
2016-03-31 20:03:25 +00:00
if (!ActiveUser::$session->validate()
|| !isset($_REQUEST['s'])
|| $_REQUEST['s'] != session_id()) {
2016-02-27 16:46:16 +00:00
$message = 'Something happened! This probably happened because you went here without being logged in.';
$redirect = (isset($_REQUEST['redirect']) ? $_REQUEST['redirect'] : Router::route('main.index'));
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-27 16:46:16 +00:00
return Template::render('global/information');
}
// Destroy the active session
2016-03-31 20:03:25 +00:00
ActiveUser::$session->destroy();
2016-02-27 16:46:16 +00:00
// Return true indicating a successful logout
$message = 'Goodbye!';
$redirect = Router::route('auth.login');
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-27 16:46:16 +00:00
return Template::render('global/information');
}
2016-03-27 21:18:57 +00:00
/**
* Get the login page.
*
* @return string
*/
2016-02-27 16:46:16 +00:00
public function loginGet()
{
return Template::render('auth/login');
2016-02-27 16:46:16 +00:00
}
2016-03-27 21:18:57 +00:00
/**
* Do a login attempt.
*
* @return string
*/
2016-02-27 16:46:16 +00:00
public function loginPost()
{
// Preliminarily set login to failed
$redirect = Router::route('auth.login');
// Get request variables
2016-08-01 21:09:27 +00:00
$username = $_REQUEST['username'] ?? null;
$password = $_REQUEST['password'] ?? null;
2016-02-27 16:46:16 +00:00
$remember = isset($_REQUEST['remember']);
// Check if we haven't hit the rate limit
$rates = DB::table('login_attempts')
2016-03-27 21:18:57 +00:00
->where('attempt_ip', Net::pton(Net::ip()))
2016-02-27 16:46:16 +00:00
->where('attempt_timestamp', '>', time() - 1800)
->where('attempt_success', '0')
->count();
if ($rates > 4) {
$message = 'Your have hit the login rate limit, try again later.';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
2016-02-27 16:46:16 +00:00
return Template::render('global/information');
}
// Get account data
2016-04-01 21:44:31 +00:00
$user = User::construct(clean_string($username, true, true));
2016-02-27 16:46:16 +00:00
// Check if the user that's trying to log in actually exists
if ($user->id === 0) {
$this->touchRateLimit($user->id);
$message = 'The user you tried to log into does not exist.';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
2016-02-27 16:46:16 +00:00
return Template::render('global/information');
}
2016-08-01 21:09:27 +00:00
if ($user->passwordExpired()) {
$message = 'Your password expired.';
$redirect = Router::route('auth.resetpassword');
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
2016-02-27 16:46:16 +00:00
2016-08-01 21:09:27 +00:00
if (!$user->verifyPassword($password)) {
$this->touchRateLimit($user->id);
$message = 'The password you entered was invalid.';
Template::vars(compact('message', 'redirect'));
return Template::render('global/information');
2016-02-27 16:46:16 +00:00
}
// Check if the user has the required privs to log in
if ($user->permission(Site::DEACTIVATED)) {
$this->touchRateLimit($user->id);
2016-04-03 21:29:46 +00:00
$message = 'Your account is deactivated, activate it first!';
$redirect = Router::route('auth.reactivate');
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
2016-02-27 16:46:16 +00:00
return Template::render('global/information');
}
// Create a new session
$session = new Session($user->id);
// Generate a session key
$sessionKey = $session->create($remember);
2016-07-26 17:29:53 +00:00
$cookiePrefix = config('cookie.prefix');
2016-02-27 16:46:16 +00:00
// User ID cookie
setcookie(
2016-07-26 17:29:53 +00:00
"{$cookiePrefix}id",
2016-02-27 16:46:16 +00:00
$user->id,
2016-07-26 17:29:53 +00:00
time() + 604800
2016-02-27 16:46:16 +00:00
);
// Session ID cookie
setcookie(
2016-07-26 17:29:53 +00:00
"{$cookiePrefix}session",
2016-02-27 16:46:16 +00:00
$sessionKey,
2016-07-26 17:29:53 +00:00
time() + 604800
2016-02-27 16:46:16 +00:00
);
2016-03-27 21:18:57 +00:00
$this->touchRateLimit($user->id, true);
2016-02-27 16:46:16 +00:00
2016-03-17 19:09:00 +00:00
$redirect = $user->lastOnline
? (isset($_REQUEST['redirect'])
? $_REQUEST['redirect']
2016-07-31 01:32:37 +00:00
: route('main.index'))
: route('info.welcome');
2016-03-17 19:09:00 +00:00
2016-02-27 16:46:16 +00:00
$message = 'Welcome' . ($user->lastOnline ? ' back' : '') . '!';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-27 16:46:16 +00:00
return Template::render('global/information');
}
2016-02-28 17:45:25 +00:00
2016-03-27 21:18:57 +00:00
/**
* Get the registration page.
*
* @return string
*/
2016-02-28 17:45:25 +00:00
public function registerGet()
{
// Attempt to check if a user has already registered from the current IP
$getUserIP = DB::table('users')
2016-03-27 21:18:57 +00:00
->where('register_ip', Net::pton(Net::ip()))
->orWhere('last_ip', Net::pton(Net::ip()))
2016-02-28 17:45:25 +00:00
->get();
2016-03-24 18:28:32 +00:00
if ($getUserIP) {
Template::vars([
'haltRegistration' => count($getUserIP) > 1,
'haltName' => $getUserIP[array_rand($getUserIP)]->username,
]);
}
2016-02-28 17:45:25 +00:00
return Template::render('auth/register');
2016-02-28 17:45:25 +00:00
}
2016-03-27 21:18:57 +00:00
/**
* Do a registration attempt.
*
* @return string
*/
2016-02-28 17:45:25 +00:00
public function registerPost()
{
2016-03-17 19:09:00 +00:00
// Preliminarily set registration to failed
2016-02-28 17:45:25 +00:00
$redirect = Router::route('auth.register');
// Check if authentication is disallowed
2016-07-26 17:29:53 +00:00
if (config('user.disable_registration')) {
2016-02-28 17:45:25 +00:00
$message = 'Registration is disabled for security checkups! Try again later.';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Check if authentication is disallowed
if (!isset($_POST['session']) || $_POST['session'] != session_id()) {
$message = "Your session expired, refreshing the page will most likely fix this!";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Grab forms
$username = isset($_POST['username']) ? $_POST['username'] : null;
$password = isset($_POST['password']) ? $_POST['password'] : null;
$email = isset($_POST['email']) ? $_POST['email'] : null;
// Append username and email to the redirection url
$redirect .= "?username={$username}&email={$email}";
// Attempt to get account data
2016-04-01 21:44:31 +00:00
$user = User::construct(clean_string($username, true, true));
2016-02-28 17:45:25 +00:00
// Check if the username already exists
if ($user && $user->id !== 0) {
2016-04-01 21:44:31 +00:00
$message = "{$user->username} is already a member here!"
. " If this is you please use the password reset form instead of making a new account.";
2016-02-28 17:45:25 +00:00
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Username too short
2016-07-26 17:29:53 +00:00
if (strlen($username) < config('user.name_min')) {
2016-02-28 17:45:25 +00:00
$message = 'Your name must be at least 3 characters long.';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Username too long
2016-07-26 17:29:53 +00:00
if (strlen($username) > config('user.name_max')) {
2016-02-28 17:45:25 +00:00
$message = 'Your name can\'t be longer than 16 characters.';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Check if the given email address is formatted properly
if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
$message = 'Your e-mail address is formatted incorrectly.';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Check the MX record of the email
2016-04-01 21:44:31 +00:00
if (!check_mx_record($email)) {
2016-02-28 17:45:25 +00:00
$message = 'No valid MX-Record found on the e-mail address you supplied.';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Check if the e-mail has already been used
$emailCheck = DB::table('users')
->where('email', $email)
->count();
if ($emailCheck) {
$message = 'Someone already registered using this email!';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Check password entropy
2016-07-26 17:29:53 +00:00
if (password_entropy($password) < config('user.pass_min_entropy')) {
2016-02-28 17:45:25 +00:00
$message = 'Your password is too weak, try adding some special characters.';
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
// Set a few variables
2016-07-26 17:29:53 +00:00
$requireActive = config('user.require_activation');
$ranks = $requireActive ? [config('rank.inactive')] : [config('rank.regular')];
2016-02-28 17:45:25 +00:00
// Create the user
$user = User::create($username, $password, $email, $ranks);
// Check if we require e-mail activation
if ($requireActive) {
// Send activation e-mail to user
2016-04-01 21:44:31 +00:00
$this->sendActivationMail($user);
2016-02-28 17:45:25 +00:00
}
// Return true with a specific message if needed
$redirect = Router::route('auth.login');
$message = $requireActive
2016-03-17 19:09:00 +00:00
? 'Your registration went through! An activation e-mail has been sent.'
2016-07-26 17:29:53 +00:00
: 'Your registration went through! Welcome to ' . config('general.name') . '!';
2016-02-28 17:45:25 +00:00
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-02-28 17:45:25 +00:00
return Template::render('global/information');
}
2016-03-17 19:09:00 +00:00
2016-03-27 21:18:57 +00:00
/**
* Do a activation attempt.
*
* @return string
*/
2016-03-17 19:09:00 +00:00
public function activate()
{
// Preliminarily set activation to failed
$redirect = Router::route('main.index');
// Attempt to get the required GET parameters
$userId = isset($_GET['u']) ? $_GET['u'] : 0;
$key = isset($_GET['k']) ? $_GET['k'] : "";
// Attempt to create a user object
$user = User::construct($userId);
// Quit if the user ID is 0
if ($user->id === 0) {
$message = "This user does not exist! Contact us if you think this isn't right.";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-17 19:09:00 +00:00
return Template::render('global/information');
}
// Check if the user is already active
if (!$user->permission(Site::DEACTIVATED)) {
$message = "Your account is already activated! Why are you here?";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-17 19:09:00 +00:00
return Template::render('global/information');
}
// Validate the activation key
$action = ActionCode::validate('ACTIVATE', $key, $user->id);
if (!$action) {
$message = "Invalid activation code! Contact us if you think this isn't right.";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-17 19:09:00 +00:00
return Template::render('global/information');
}
// Get the ids for deactivated and default user ranks
2016-07-26 17:29:53 +00:00
$rankDefault = config('rank.regular');
$rankDeactive = config('rank.inactive');
2016-03-17 19:09:00 +00:00
// Add normal user, remove deactivated and set normal as default
$user->addRanks([$rankDefault]);
$user->setMainRank($rankDefault);
$user->removeRanks([$rankDeactive]);
$redirect = Router::route('auth.login');
2016-07-26 17:29:53 +00:00
$message = "Your account is activated, welcome to " . config('general.name') . "!";
2016-03-17 19:09:00 +00:00
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-17 19:09:00 +00:00
return Template::render('global/information');
}
2016-03-27 21:18:57 +00:00
/**
* Get the reactivation request form.
*
* @return string
*/
2016-03-17 19:09:00 +00:00
public function reactivateGet()
{
return Template::render('auth/reactivate');
2016-03-17 19:09:00 +00:00
}
2016-03-19 15:29:47 +00:00
2016-03-27 21:18:57 +00:00
/**
* Do a reactivation preparation attempt.
*
* @return string
*/
2016-03-19 15:29:47 +00:00
public function reactivatePost()
{
// Preliminarily set registration to failed
$redirect = Router::route('auth.reactivate');
// Validate session
if (!isset($_POST['session']) || $_POST['session'] != session_id()) {
$message = "Your session expired, refreshing the page will most likely fix this!";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
// Grab forms
2016-04-01 21:44:31 +00:00
$username = isset($_POST['username']) ? clean_string($_POST['username'], true) : null;
$email = isset($_POST['email']) ? clean_string($_POST['email'], true) : null;
2016-03-19 15:29:47 +00:00
// Do database request
$getUser = DB::table('users')
->where('username_clean', $username)
->where('email', $email)
->get(['user_id']);
// Check if user exists
if (!$getUser) {
$message = "User not found! Double check your username and e-mail address!";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
// Create user object
$user = User::construct($getUser[0]->user_id);
// Check if a user is activated
if (!$user->permission(Site::DEACTIVATED)) {
$message = "Your account is already activated! Why are you here?";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
// Send activation e-mail to user
2016-04-01 21:44:31 +00:00
$this->sendActivationMail($user);
2016-03-19 15:29:47 +00:00
$redirect = Router::route('auth.login');
$message = "Sent the e-mail! Make sure to check your spam folder as well!";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
2016-03-27 21:18:57 +00:00
/**
* Get the password reset forum.
*
* @return string
*/
2016-03-19 15:29:47 +00:00
public function resetPasswordGet()
{
return Template::render('auth/resetpassword');
2016-03-19 15:29:47 +00:00
}
2016-03-27 21:18:57 +00:00
/**
* Do a password reset attempt.
*
* @return string
*/
2016-03-19 15:29:47 +00:00
public function resetPasswordPost()
{
// Preliminarily set action to failed
$redirect = Router::route('main.index');
// Validate session
if (!isset($_POST['session']) || $_POST['session'] != session_id()) {
$message = "Your session expired, refreshing the page will most likely fix this!";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
// Attempt to get the various required GET parameters
$userId = isset($_POST['user']) ? $_POST['user'] : 0;
$key = isset($_POST['key']) ? $_POST['key'] : "";
$password = isset($_POST['password']) ? $_POST['password'] : "";
2016-04-01 21:44:31 +00:00
$userName = isset($_POST['username']) ? clean_string($_POST['username'], true) : "";
$email = isset($_POST['email']) ? clean_string($_POST['email'], true) : null;
2016-03-19 15:29:47 +00:00
// Create user object
$user = User::construct($userId ? $userId : $userName);
// Quit if the user ID is 0
if ($user->id === 0 || ($email !== null ? $email !== $user->email : false)) {
$message = "This user does not exist! Contact us if you think this isn't right.";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
// Check if the user is active
if ($user->permission(Site::DEACTIVATED)) {
$message = "Your account is deactivated, go activate it first...";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
if ($key && $password) {
// Check password entropy
2016-07-26 17:29:53 +00:00
if (password_entropy($password) < config('user.pass_min_entropy')) {
2016-03-19 15:29:47 +00:00
$message = "Your password doesn't meet the strength requirements!";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
// Validate the activation key
$action = ActionCode::validate('LOST_PASS', $key, $user->id);
if (!$action) {
$message = "Invalid verification code! Contact us if you think this isn't right.";
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
2016-08-01 21:09:27 +00:00
$user->setPassword($password);
2016-03-19 15:29:47 +00:00
$message = "Changed your password! You may now log in.";
$redirect = Router::route('auth.login');
} else {
2016-04-01 21:44:31 +00:00
// Send the e-mail
$this->sendPasswordMail($user);
2016-03-19 15:29:47 +00:00
$message = "Sent the e-mail, keep an eye on your spam folder as well!";
$redirect = Router::route('main.index');
}
2016-04-03 21:29:46 +00:00
Template::vars(compact('message', 'redirect'));
2016-03-19 15:29:47 +00:00
return Template::render('global/information');
}
2016-04-01 21:44:31 +00:00
/**
* Send the activation e-mail
*
* @param User $user
*/
private function sendActivationMail($user)
{
// Generate activation key
$activate = ActionCode::generate('ACTIVATE', $user->id);
2016-07-26 17:29:53 +00:00
$siteName = config('general.name');
$baseUrl = "http://{$_SERVER['HTTP_HOST']}";
2016-04-01 21:44:31 +00:00
$activateLink = Router::route('auth.activate') . "?u={$user->id}&k={$activate}";
$profileLink = Router::route('user.profile', $user->id);
2016-07-26 17:29:53 +00:00
$signature = config('mail.signature');
2016-04-01 21:44:31 +00:00
// Build the e-mail
$message = "Welcome to {$siteName}!\r\n\r\n"
. "Please keep this e-mail for your records. Your account intormation is as follows:\r\n\r\n"
. "----------------------------\r\n\r\n"
. "Username: {$user->username}\r\n\r\n"
. "Your profile: {$baseUrl}{$profileLink}\r\n\r\n"
. "----------------------------\r\n\r\n"
. "Please visit the following link in order to activate your account:\r\n\r\n"
. "{$baseUrl}{$activateLink}\r\n\r\n"
. "Your password has been securely stored in our database and cannot be retrieved. "
. "In the event that it is forgotten,"
. " you will be able to reset it using the email address associated with your account.\r\n\r\n"
. "Thank you for registering.\r\n\r\n"
. "--\r\n\r\nThanks\r\n\r\n{$signature}";
// Send the message
send_mail([$user->email => $user->username], "{$siteName} activation mail", $message);
}
/**
* Send the activation e-mail
*
* @param User $user
*/
private function sendPasswordMail($user)
{
// Generate the verification key
$verk = ActionCode::generate('LOST_PASS', $user->id);
2016-07-26 17:29:53 +00:00
$siteName = config('general.name');
$baseUrl = "http://{$_SERVER['HTTP_HOST']}";
2016-04-01 21:44:31 +00:00
$reactivateLink = Router::route('auth.resetpassword') . "?u={$user->id}&k={$verk}";
2016-07-26 17:29:53 +00:00
$signature = config('mail.signature');
2016-04-01 21:44:31 +00:00
// Build the e-mail
$message = "Hello {$user->username},\r\n\r\n"
. "You are receiving this notification because you have (or someone pretending to be you has)"
. " requested a password reset link to be sent for your account on \"{$siteName}\"."
. " If you did not request this notification then please ignore it,"
. " if you keep receiving it please contact the site administrator.\r\n\r\n"
. "To use this password reset key you need to go to a special page."
. " To do this click the link provided below.\r\n\r\n"
. "{$baseUrl}{$reactivateLink}\r\n\r\n"
. "If successful you should be able to change your password here.\r\n\r\n"
. "You can of course change this password yourself via the settings page."
. " If you have any difficulties please contact the site administrator.\r\n\r\n"
. "--\r\n\r\nThanks\r\n\r\n{$signature}";
// Send the message
send_mail([$user->email => $user->username], "{$siteName} password restoration", $message);
}
2016-02-27 16:46:16 +00:00
}