Commit | Line | Data |
---|---|---|
d46a42f1 RK |
1 | <?php |
2 | /* This Source Code Form is subject to the terms of the Mozilla Public | |
3 | * License, v. 2.0. If a copy of the MPL was not distributed with this file, | |
4 | * You can obtain one at http://mozilla.org/MPL/2.0/. */ | |
5 | ||
6 | class AuthUtils { | |
7 | // KaiRo.at authentication utilities PHP class | |
8 | // This class contains helper functions for the authentication system. | |
9 | // | |
558e9862 | 10 | // function __construct($settings, $db) |
ac442755 | 11 | // CONSTRUCTOR |
558e9862 RK |
12 | // Settings are an associative array with a numeric pwd_cost field and an array pwd_nonces field. |
13 | // The DB is a PDO object. | |
14 | // | |
15 | // public $db | |
16 | // A PDO database object for interaction. | |
be1082a6 | 17 | // |
77f0f9ff RK |
18 | // public $running_on_localhost |
19 | // A boolean telling if the system is running on localhost (where https is not required). | |
20 | // | |
ea0452ad RK |
21 | // public $client_reg_email_whitelist |
22 | // An array of emails that are whitelisted for registering clients. | |
23 | // | |
ac442755 RK |
24 | // private $pwd_cost |
25 | // The cost parameter for use with PHP password_hash function. | |
26 | // | |
27 | // private $pwd_nonces | |
28 | // The array of nonces to use for "peppering" passwords. For new hashes, the last one of those will be used. | |
087085d6 | 29 | // Generate a nonce with this command: |openssl rand -base64 48| |
ac442755 | 30 | // |
558e9862 RK |
31 | // function log($code, $additional_info) |
32 | // Log an entry for admin purposes, with a code and some additional info. | |
33 | // | |
77f0f9ff RK |
34 | // function checkForSecureConnection() |
35 | // Check is the connection is secure and return an array of error messages (empty if it's secure). | |
36 | // | |
4c6d8064 RK |
37 | // function initSession() |
38 | // Initialize a session. Returns an associative array of all the DB fields of the session. | |
39 | // | |
409b55f4 RK |
40 | // function getDomainBaseURL() |
41 | // Get the base URL of the current domain, e.g. 'https://example.com'. | |
42 | // | |
ac442755 | 43 | // function checkPasswordConstraints($new_password, $user_email) |
d46a42f1 RK |
44 | // Check password constraints and return an array of error messages (empty if all constraints are met). |
45 | // | |
ac442755 | 46 | // function createSessionKey() |
d46a42f1 RK |
47 | // Return a random session key. |
48 | // | |
ac442755 | 49 | // function createVerificationCode() |
d46a42f1 RK |
50 | // Return a random acount/email verification code. |
51 | // | |
ea0452ad RK |
52 | // function createClientSecret() |
53 | // Return a random client secret. | |
54 | // | |
ac442755 | 55 | // function createTimeCode($session, [$offset], [$validity_minutes]) |
d46a42f1 RK |
56 | // Return a time-based code based on the key and ID of the given session. |
57 | // An offset can be given to create a specific code for verification, otherwise and offset will be generated. | |
58 | // Also, an amount of minutes for the code to stay valid can be handed over, by default 10 minutes will be used. | |
59 | // | |
ac442755 | 60 | // function verifyTimeCode($timecode_to_verify, $session, [$validity_minutes]) |
d46a42f1 RK |
61 | // Verify a given time-based code and return true if it's valid or false if it's not. |
62 | // See createTimeCode() documentation for the session and validity paramerters. | |
be1082a6 | 63 | // |
ac442755 | 64 | // function pwdHash($new_password) |
be1082a6 RK |
65 | // Return a hash for the given password. |
66 | // | |
ac442755 | 67 | // function pwdVerify($password_to_verify, $user) |
be1082a6 RK |
68 | // Return true if the password verifies against the pwdhash field of the user, false if not. |
69 | // | |
ac442755 | 70 | // function pwdNeedsRehash($user) |
be1082a6 | 71 | // Return true if the pwdhash field of the user uses an outdated standard and needs to be rehashed. |
409b55f4 RK |
72 | // |
73 | // function appendLoginForm($dom_element, $session, $user) | |
74 | // append a login form for the given session to the given DOM element, possibly prefilling the email from the given user info array. | |
be1082a6 | 75 | |
558e9862 | 76 | function __construct($settings, $db) { |
ac442755 | 77 | // *** constructor *** |
558e9862 | 78 | $this->db = $db; |
4c6d8064 | 79 | $this->db->exec("SET time_zone='+00:00';"); // Execute directly on PDO object, set session to UTC to make our gmdate() values match correctly. |
77f0f9ff | 80 | $this->running_on_localhost = preg_match('/^((.+\.)?localhost|127\.0\.0\.\d+)$/', $_SERVER['SERVER_NAME']); |
ac442755 RK |
81 | if (array_key_exists('pwd_cost', $settings)) { |
82 | $this->pwd_cost = $settings['pwd_cost']; | |
83 | } | |
558e9862 RK |
84 | if (array_key_exists('pwd_nonces', $settings)) { |
85 | $this->pwd_nonces = $settings['pwd_nonces']; | |
86 | } | |
ac442755 RK |
87 | } |
88 | ||
558e9862 | 89 | public $db = null; |
77f0f9ff | 90 | public $running_on_localhost = false; |
ea0452ad | 91 | public $client_reg_email_whitelist = array('kairo@kairo.at', 'com@kairo.at'); |
ac442755 RK |
92 | private $pwd_cost = 10; |
93 | private $pwd_nonces = array(); | |
d46a42f1 | 94 | |
558e9862 RK |
95 | function log($code, $info) { |
96 | $result = $this->db->prepare('INSERT INTO `auth_log` (`code`, `info`, `ip_addr`) VALUES (:code, :info, :ipaddr);'); | |
97 | if (!$result->execute(array(':code' => $code, ':info' => $info, ':ipaddr' => $_SERVER['REMOTE_ADDR']))) { | |
98 | // print($result->errorInfo()[2]); | |
99 | } | |
100 | } | |
101 | ||
77f0f9ff RK |
102 | function checkForSecureConnection() { |
103 | $errors = array(); | |
104 | if (($_SERVER['SERVER_PORT'] != 443) && !$this->running_on_localhost) { | |
105 | $errors[] = _('You are not accessing this site on a secure connection, so authentication doesn\'t work.'); | |
106 | } | |
107 | return $errors; | |
108 | } | |
109 | ||
4c6d8064 RK |
110 | function initSession() { |
111 | $session = null; | |
112 | if (strlen(@$_COOKIE['sessionkey'])) { | |
113 | // Fetch the session - or at least try to. | |
114 | $result = $this->db->prepare('SELECT * FROM `auth_sessions` WHERE `sesskey` = :sesskey AND `time_expire` > :expire;'); | |
115 | $result->execute(array(':sesskey' => $_COOKIE['sessionkey'], ':expire' => gmdate('Y-m-d H:i:s'))); | |
116 | $row = $result->fetch(PDO::FETCH_ASSOC); | |
117 | if ($row) { | |
118 | $session = $row; | |
119 | } | |
120 | } | |
121 | if (is_null($session)) { | |
122 | // Create new session and set cookie. | |
123 | $sesskey = $this->createSessionKey(); | |
124 | setcookie('sessionkey', $sesskey, 0, "", "", !$this->running_on_localhost, true); // Last two params are secure and httponly, secure is not set on localhost. | |
125 | $result = $this->db->prepare('INSERT INTO `auth_sessions` (`sesskey`, `time_expire`) VALUES (:sesskey, :expire);'); | |
126 | $result->execute(array(':sesskey' => $sesskey, ':expire' => gmdate('Y-m-d H:i:s', strtotime('+5 minutes')))); | |
127 | // After insert, actually fetch the session row from the DB so we have all values. | |
128 | $result = $this->db->prepare('SELECT * FROM auth_sessions WHERE `sesskey` = :sesskey AND `time_expire` > :expire;'); | |
129 | $result->execute(array(':sesskey' => $sesskey, ':expire' => gmdate('Y-m-d H:i:s'))); | |
130 | $row = $result->fetch(PDO::FETCH_ASSOC); | |
131 | if ($row) { | |
132 | $session = $row; | |
133 | } | |
134 | else { | |
135 | $this->log('session_create_failure', 'key: '.$sesskey); | |
136 | } | |
137 | } | |
138 | return $session; | |
139 | } | |
140 | ||
409b55f4 RK |
141 | function getDomainBaseURL() { |
142 | return ($this->running_on_localhost?'http':'https').'://'.$_SERVER['SERVER_NAME']; | |
143 | } | |
144 | ||
ac442755 | 145 | function checkPasswordConstraints($new_password, $user_email) { |
d46a42f1 RK |
146 | $errors = array(); |
147 | if ($new_password != trim($new_password)) { | |
148 | $errors[] = _('Password must not start or end with a whitespace character like a space.'); | |
149 | } | |
150 | if (strlen($new_password) < 8) { $errors[] = sprintf(_('Password too short (min. %s characters).'), 8); } | |
151 | if (strlen($new_password) > 70) { $errors[] = sprintf(_('Password too long (max. %s characters).'), 70); } | |
152 | if ((strtolower($new_password) == strtolower($user_email)) || | |
153 | in_array(strtolower($new_password), preg_split("/[@\.]+/", strtolower($user_email)))) { | |
154 | $errors[] = _('The passwort can not be equal to your email or any part of it.'); | |
155 | } | |
156 | if ((strlen($new_password) < 15) && (preg_match('/^[a-zA-Z]+$/', $new_password))) { | |
157 | $errors[] = sprintf(_('Your password must use characters other than normal letters or contain least %s characters.'), 15); | |
158 | } | |
159 | if (preg_match('/^\d+$/', $new_password)) { | |
160 | $errors[] = sprintf(_('Your password cannot consist only of numbers.'), 15); | |
161 | } | |
162 | if (strlen(count_chars($new_password, 3)) < 5) { | |
163 | $errors[] = sprintf(_('Password does have to contain at least %s different characters.'), 5); | |
164 | } | |
165 | return $errors; | |
166 | } | |
167 | ||
ac442755 | 168 | function createSessionKey() { |
d46a42f1 RK |
169 | return bin2hex(openssl_random_pseudo_bytes(512 / 8)); // Get 512 bits of randomness (128 byte hex string). |
170 | } | |
171 | ||
ac442755 | 172 | function createVerificationCode() { |
d46a42f1 RK |
173 | return bin2hex(openssl_random_pseudo_bytes(512 / 8)); // Get 512 bits of randomness (128 byte hex string). |
174 | } | |
175 | ||
ea0452ad RK |
176 | function createClientSecret() { |
177 | return bin2hex(openssl_random_pseudo_bytes(160 / 8)); // Get 160 bits of randomness (40 byte hex string). | |
178 | } | |
179 | ||
ac442755 | 180 | function createTimeCode($session, $offset = null, $validity_minutes = 10) { |
d46a42f1 RK |
181 | // Matches TOTP algorithms, see https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm |
182 | $valid_seconds = intval($validity_minutes) * 60; | |
183 | if ($valid_seconds < 60) { $valid_seconds = 60; } | |
184 | $code_digits = 8; | |
185 | $time = time(); | |
186 | $rest = is_null($offset)?($time % $valid_seconds):intval($offset); // T0, will be sent as part of code to make it valid for the full duration. | |
187 | $counter = floor(($time - $rest) / $valid_seconds); | |
188 | $hmac = mhash(MHASH_SHA1, $counter, $session['id'].$session['sesskey']); | |
189 | $offset = hexdec(substr(bin2hex(substr($hmac, -1)), -1)); // Get the last 4 bits as a number. | |
190 | $totp = hexdec(bin2hex(substr($hmac, $offset, 4))) & 0x7FFFFFFF; // Take 4 bytes at the offset, discard highest bit. | |
191 | $totp_value = sprintf('%0'.$code_digits.'d', substr($totp, -$code_digits)); | |
192 | return $rest.'.'.$totp_value; | |
193 | } | |
194 | ||
ac442755 | 195 | function verifyTimeCode($timecode_to_verify, $session, $validity_minutes = 10) { |
d46a42f1 | 196 | if (preg_match('/^(\d+)\.\d+$/', $timecode_to_verify, $regs)) { |
ac442755 | 197 | return ($timecode_to_verify === $this->createTimeCode($session, $regs[1], $validity_minutes)); |
d46a42f1 RK |
198 | } |
199 | return false; | |
200 | } | |
be1082a6 | 201 | |
ac442755 RK |
202 | function pwdHash($new_password) { |
203 | $hash_prefix = ''; | |
204 | if (count($this->pwd_nonces)) { | |
205 | $new_password .= $this->pwd_nonces[count($this->pwd_nonces) - 1]; | |
206 | $hash_prefix = (count($this->pwd_nonces) - 1).'|'; | |
207 | } | |
208 | return $hash_prefix.password_hash($new_password, PASSWORD_DEFAULT, array('cost' => $this->pwd_cost)); | |
be1082a6 RK |
209 | } |
210 | ||
ac442755 | 211 | function pwdVerify($password_to_verify, $userdata) { |
087085d6 RK |
212 | $pwdhash = $userdata['pwdhash']; |
213 | if (preg_match('/^(\d+)\|(.+)$/', $userdata['pwdhash'], $regs)) { | |
ac442755 | 214 | $password_to_verify .= $this->pwd_nonces[$regs[1]]; |
087085d6 | 215 | $pwdhash = $regs[2]; |
ac442755 | 216 | } |
087085d6 | 217 | return password_verify($password_to_verify, $pwdhash); |
be1082a6 RK |
218 | } |
219 | ||
ac442755 RK |
220 | function pwdNeedsRehash($userdata) { |
221 | $nonceid = -1; | |
222 | $pwdhash = $userdata['pwdhash']; | |
223 | if (preg_match('/^(\d+)\|(.+)$/', $userdata['pwdhash'], $regs)) { | |
224 | $nonceid = $regs[1]; | |
225 | $pwdhash = $regs[2]; | |
226 | } | |
227 | if ($nonceid == count($this->pwd_nonces) - 1) { | |
228 | return password_needs_rehash($pwdhash, PASSWORD_DEFAULT, array('cost' => $this->pwd_cost)); | |
229 | } | |
230 | else { | |
231 | return true; | |
232 | } | |
be1082a6 | 233 | } |
409b55f4 RK |
234 | |
235 | function appendLoginForm($dom_element, $session, $user) { | |
236 | $form = $dom_element->appendForm('./', 'POST', 'loginform'); | |
237 | $form->setAttribute('id', 'loginform'); | |
238 | $form->setAttribute('class', 'loginarea hidden'); | |
239 | $ulist = $form->appendElement('ul'); | |
240 | $ulist->setAttribute('class', 'flat login'); | |
241 | $litem = $ulist->appendElement('li'); | |
242 | $inptxt = $litem->appendInputEmail('email', 30, 20, 'login_email', (intval(@$user['id'])?$user['email']:'')); | |
243 | $inptxt->setAttribute('autocomplete', 'email'); | |
244 | $inptxt->setAttribute('required', ''); | |
245 | $inptxt->setAttribute('placeholder', _('Email')); | |
246 | $inptxt->setAttribute('class', 'login'); | |
247 | $litem = $ulist->appendElement('li'); | |
248 | $inptxt = $litem->appendInputPassword('pwd', 20, 20, 'login_pwd', ''); | |
249 | $inptxt->setAttribute('required', ''); | |
250 | $inptxt->setAttribute('placeholder', _('Password')); | |
251 | $inptxt->setAttribute('class', 'login'); | |
252 | $litem = $ulist->appendElement('li'); | |
253 | $litem->appendLink('./?reset', _('Forgot password?')); | |
254 | $litem = $ulist->appendElement('li'); | |
255 | $cbox = $litem->appendInputCheckbox('remember', 'login_remember', 'true', false); | |
256 | $cbox->setAttribute('class', 'logincheck'); | |
257 | $label = $litem->appendLabel('login_remember', _('Remember me')); | |
258 | $label->setAttribute('id', 'rememprompt'); | |
259 | $label->setAttribute('class', 'loginprompt'); | |
260 | $litem = $ulist->appendElement('li'); | |
261 | $litem->appendInputHidden('tcode', $this->createTimeCode($session)); | |
262 | $submit = $litem->appendInputSubmit(_('Log in / Register')); | |
263 | $submit->setAttribute('class', 'loginbutton'); | |
264 | } | |
d46a42f1 RK |
265 | } |
266 | ?> |