// KaiRo.at authentication utilities PHP class
// This class contains helper functions for the authentication system.
//
- // function __construct()
+ // function __construct($settings, $db)
// CONSTRUCTOR
+ // Settings are an associative array with a numeric pwd_cost field and an array pwd_nonces field.
+ // The DB is a PDO object.
+ //
+ // public $db
+ // A PDO database object for interaction.
+ //
+ // public $running_on_localhost
+ // A boolean telling if the system is running on localhost (where https is not required).
+ //
+ // public $client_reg_email_whitelist
+ // An array of emails that are whitelisted for registering clients.
//
// private $pwd_cost
// The cost parameter for use with PHP password_hash function.
//
// private $pwd_nonces
// The array of nonces to use for "peppering" passwords. For new hashes, the last one of those will be used.
+ // Generate a nonce with this command: |openssl rand -base64 48|
+ //
+ // function log($code, $additional_info)
+ // Log an entry for admin purposes, with a code and some additional info.
+ //
+ // function checkForSecureConnection()
+ // Check is the connection is secure and return an array of error messages (empty if it's secure).
+ //
+ // function initSession()
+ // Initialize a session. Returns an associative array of all the DB fields of the session.
+ //
+ // function getDomainBaseURL()
+ // Get the base URL of the current domain, e.g. 'https://example.com'.
//
// function checkPasswordConstraints($new_password, $user_email)
// Check password constraints and return an array of error messages (empty if all constraints are met).
// function createVerificationCode()
// Return a random acount/email verification code.
//
+ // function createClientSecret()
+ // Return a random client secret.
+ //
// function createTimeCode($session, [$offset], [$validity_minutes])
// Return a time-based code based on the key and ID of the given session.
// An offset can be given to create a specific code for verification, otherwise and offset will be generated.
//
// function pwdNeedsRehash($user)
// Return true if the pwdhash field of the user uses an outdated standard and needs to be rehashed.
+ //
+ // function appendLoginForm($dom_element, $session, $user)
+ // append a login form for the given session to the given DOM element, possibly prefilling the email from the given user info array.
- function __construct($settings) {
+ function __construct($settings, $db) {
// *** constructor ***
- if (array_key_exists('pwd_nonces', $settings)) {
- $this->pwd_nonces = $settings['pwd_nonces'];
- }
+ $this->db = $db;
+ $this->db->exec("SET time_zone='+00:00';"); // Execute directly on PDO object, set session to UTC to make our gmdate() values match correctly.
+ $this->running_on_localhost = preg_match('/^((.+\.)?localhost|127\.0\.0\.\d+)$/', $_SERVER['SERVER_NAME']);
if (array_key_exists('pwd_cost', $settings)) {
$this->pwd_cost = $settings['pwd_cost'];
}
+ if (array_key_exists('pwd_nonces', $settings)) {
+ $this->pwd_nonces = $settings['pwd_nonces'];
+ }
}
+ public $db = null;
+ public $running_on_localhost = false;
+ public $client_reg_email_whitelist = array('kairo@kairo.at', 'com@kairo.at');
private $pwd_cost = 10;
private $pwd_nonces = array();
+ function log($code, $info) {
+ $result = $this->db->prepare('INSERT INTO `auth_log` (`code`, `info`, `ip_addr`) VALUES (:code, :info, :ipaddr);');
+ if (!$result->execute(array(':code' => $code, ':info' => $info, ':ipaddr' => $_SERVER['REMOTE_ADDR']))) {
+ // print($result->errorInfo()[2]);
+ }
+ }
+
+ function checkForSecureConnection() {
+ $errors = array();
+ if (($_SERVER['SERVER_PORT'] != 443) && !$this->running_on_localhost) {
+ $errors[] = _('You are not accessing this site on a secure connection, so authentication doesn\'t work.');
+ }
+ return $errors;
+ }
+
+ function sendSecurityHeaders() {
+ // Send various headers that we want to have for security resons, mostly as recommended by https://observatory.mozilla.org/
+
+ // CSP - see https://wiki.mozilla.org/Security/Guidelines/Web_Security#Content_Security_Policy
+ // Disable unsafe inline/eval, only allow loading of resources (images, fonts, scripts, etc.) from ourselves; also disable framing.
+ header('Content-Security-Policy: default-src \'none\';img-src \'self\'; script-src \'self\'; style-src \'self\'; frame-ancestors \'none\'');
+
+ // X-Content-Type-Options - see https://wiki.mozilla.org/Security/Guidelines/Web_Security#X-Content-Type-Options
+ // Prevent browsers from incorrectly detecting non-scripts as scripts
+ header('X-Content-Type-Options: nosniff');
+
+ // X-Frame-Options (for older browsers) - see https://wiki.mozilla.org/Security/Guidelines/Web_Security#X-Frame-Options
+ // Block site from being framed
+ header('X-Frame-Options: DENY');
+
+ // X-XSS-Protection (for older browsers) - see https://wiki.mozilla.org/Security/Guidelines/Web_Security#X-XSS-Protection
+ // Block pages from loading when they detect reflected XSS attacks
+ header('X-XSS-Protection: 1; mode=block');
+ }
+
+ function initSession() {
+ $session = null;
+ if (strlen(@$_COOKIE['sessionkey'])) {
+ // Fetch the session - or at least try to.
+ $result = $this->db->prepare('SELECT * FROM `auth_sessions` WHERE `sesskey` = :sesskey AND `time_expire` > :expire;');
+ $result->execute(array(':sesskey' => $_COOKIE['sessionkey'], ':expire' => gmdate('Y-m-d H:i:s')));
+ $row = $result->fetch(PDO::FETCH_ASSOC);
+ if ($row) {
+ $session = $row;
+ }
+ }
+ if (is_null($session)) {
+ // Create new session and set cookie.
+ $sesskey = $this->createSessionKey();
+ setcookie('sessionkey', $sesskey, 0, "", "", !$this->running_on_localhost, true); // Last two params are secure and httponly, secure is not set on localhost.
+ $result = $this->db->prepare('INSERT INTO `auth_sessions` (`sesskey`, `time_expire`) VALUES (:sesskey, :expire);');
+ $result->execute(array(':sesskey' => $sesskey, ':expire' => gmdate('Y-m-d H:i:s', strtotime('+5 minutes'))));
+ // After insert, actually fetch the session row from the DB so we have all values.
+ $result = $this->db->prepare('SELECT * FROM auth_sessions WHERE `sesskey` = :sesskey AND `time_expire` > :expire;');
+ $result->execute(array(':sesskey' => $sesskey, ':expire' => gmdate('Y-m-d H:i:s')));
+ $row = $result->fetch(PDO::FETCH_ASSOC);
+ if ($row) {
+ $session = $row;
+ }
+ else {
+ $this->log('session_create_failure', 'key: '.$sesskey);
+ }
+ }
+ return $session;
+ }
+
+ function getDomainBaseURL() {
+ return ($this->running_on_localhost?'http':'https').'://'.$_SERVER['SERVER_NAME'];
+ }
+
function checkPasswordConstraints($new_password, $user_email) {
$errors = array();
if ($new_password != trim($new_password)) {
return bin2hex(openssl_random_pseudo_bytes(512 / 8)); // Get 512 bits of randomness (128 byte hex string).
}
+ function createClientSecret() {
+ return bin2hex(openssl_random_pseudo_bytes(160 / 8)); // Get 160 bits of randomness (40 byte hex string).
+ }
+
function createTimeCode($session, $offset = null, $validity_minutes = 10) {
// Matches TOTP algorithms, see https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm
$valid_seconds = intval($validity_minutes) * 60;
}
function pwdVerify($password_to_verify, $userdata) {
- if (preg_match('/^(\d+)\|/', $userdata['pwdhash'], $regs)) {
+ $pwdhash = $userdata['pwdhash'];
+ if (preg_match('/^(\d+)\|(.+)$/', $userdata['pwdhash'], $regs)) {
$password_to_verify .= $this->pwd_nonces[$regs[1]];
+ $pwdhash = $regs[2];
}
- return password_verify($password_to_verify, $userdata['pwdhash']);
+ return password_verify($password_to_verify, $pwdhash);
}
function pwdNeedsRehash($userdata) {
return true;
}
}
+
+ function appendLoginForm($dom_element, $session, $user) {
+ $form = $dom_element->appendForm('./', 'POST', 'loginform');
+ $form->setAttribute('id', 'loginform');
+ $form->setAttribute('class', 'loginarea hidden');
+ $ulist = $form->appendElement('ul');
+ $ulist->setAttribute('class', 'flat login');
+ $litem = $ulist->appendElement('li');
+ $inptxt = $litem->appendInputEmail('email', 30, 20, 'login_email', (intval(@$user['id'])?$user['email']:''));
+ $inptxt->setAttribute('autocomplete', 'email');
+ $inptxt->setAttribute('required', '');
+ $inptxt->setAttribute('placeholder', _('Email'));
+ $inptxt->setAttribute('class', 'login');
+ $litem = $ulist->appendElement('li');
+ $inptxt = $litem->appendInputPassword('pwd', 20, 20, 'login_pwd', '');
+ $inptxt->setAttribute('required', '');
+ $inptxt->setAttribute('placeholder', _('Password'));
+ $inptxt->setAttribute('class', 'login');
+ $litem = $ulist->appendElement('li');
+ $litem->appendLink('./?reset', _('Forgot password?'));
+ $litem = $ulist->appendElement('li');
+ $cbox = $litem->appendInputCheckbox('remember', 'login_remember', 'true', false);
+ $cbox->setAttribute('class', 'logincheck');
+ $label = $litem->appendLabel('login_remember', _('Remember me'));
+ $label->setAttribute('id', 'rememprompt');
+ $label->setAttribute('class', 'loginprompt');
+ $litem = $ulist->appendElement('li');
+ $litem->appendInputHidden('tcode', $this->createTimeCode($session));
+ $submit = $litem->appendInputSubmit(_('Log in / Register'));
+ $submit->setAttribute('class', 'loginbutton');
+ }
}
?>