forked from Open-Web-Analytics/Open-Web-Analytics
-
Notifications
You must be signed in to change notification settings - Fork 0
/
owa_auth.php
453 lines (335 loc) · 10.6 KB
/
owa_auth.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
<?php
//
// Open Web Analytics - An Open Source Web Analytics Framework
//
// Copyright 2006 Peter Adams. All rights reserved.
//
// Licensed under GPL v2.0 http://www.gnu.org/copyleft/gpl.html
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// $Id$
//
require_once(OWA_BASE_CLASS_DIR.'sanitize.php');
/**
* User Authentication Object
*
* @author Peter Adams <[email protected]>
* @copyright Copyright © 2006 Peter Adams <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GPL v2.0
* @category owa
* @package owa
* @version $Revision$
* @since owa 1.0.0
*/
class owa_auth extends owa_base {
/**
* User object
*
* @var unknown_type
*/
var $u;
/**
* Array of permission roles that users can have
*
* @var array
*/
var $roles;
var $status_msg;
/**
* Login credentials
*
* @var array
*/
var $credentials = array();
/**
* Status of Authentication
*
* @var boolean
*/
var $auth_status = false;
var $_is_user = false;
var $_priviledge_level;
var $_is_priviledged = false;
var $params;
var $check_for_credentials = false;
/**
* Auth class Singleton
*
* @return owa_auth
*/
public static function get_instance($plugin = '') {
static $auth;
if (!$auth) {
$auth = new owa_auth();
}
return $auth;
}
/**
* Class Constructor
*
* @return owa_auth
*/
function __construct() {
// register auth cookies
owa_coreAPI::registerStateStore('u', time()+3600*24*365*10, '', '', 'cookie');
owa_coreAPI::registerStateStore('p', time()+3600*2, '', '', 'cookie');
parent::__construct();
$this->eq = owa_coreAPI::getEventDispatch();
}
/**
* Used by controllers to check if the user exists and if they are priviledged.
*
* @param string $necessary_role
*/
function authenticateUser() {
// check existing auth status first in case someone else took care of this already.
if (owa_coreAPI::getCurrentUser()->isAuthenticated()) {
$ret = true;
} elseif (owa_coreAPI::getRequestParam('apiKey')) {
// auth user by api key
$ret = $this->authByApiKey(owa_coreAPI::getRequestParam('apiKey'));
} elseif (owa_coreAPI::getRequestParam('pk') && owa_coreAPI::getStateParam('u')) {
// auth user by temporary passkey. used in forgot password situations
$ret = $this->authenticateUserByUrlPasskey(owa_coreAPI::getRequestParam('pk'));
} elseif (owa_coreAPI::getRequestParam('user_id') && owa_coreAPI::getRequestParam('password')) {
// auth user by login form input
$ret = $this->authByInput(owa_coreAPI::getRequestParam('user_id'), owa_coreAPI::getRequestParam('password'));
} elseif (owa_coreAPI::getStateParam('u') && owa_coreAPI::getStateParam('p')) {
// auth user by cookies
$ret = $this->authByCookies(owa_coreAPI::getStateParam('u'), owa_coreAPI::getStateParam('p'));
// bump expiration time
//owa_coreAPI::setState('p', '', owa_coreAPI::getStateParam('p'));
} else {
$ret = false;
owa_coreAPI::debug("Could not find any credentials to authenticate with.");
}
// filter results for modules can add their own auth logic.
$ret = $this->eq->filter('auth_status', $ret);
return array('auth_status' => $ret);
}
function authByApiKey( $key ) {
$key = owa_sanitize::cleanMd5( $key );
if ( $key ) {
// fetch user object from the db
$this->u = owa_coreAPI::entityFactory('base.user');
$this->u->load($key, 'api_key');
if ($this->u->get('user_id')) {
// get current user
$cu = owa_coreAPI::getCurrentUser();
// set as new current user in service layer
$cu->loadNewUserByObject($this->u);
$cu->setAuthStatus(true);
$this->_is_user = true;
return true;
} else {
return false;
}
} else {
return false;
}
}
function authByCookies($user_id, $password) {
// set credentials
$this->credentials['user_id'] = owa_sanitize::cleanUserId( $user_id );
$this->credentials['password'] = $password;
// lookup user if not already done.
if ($this->_is_user == false) {
// check to see if the current user has already been authenticated by something upstream
$cu = owa_coreAPI::getCurrentUser();
if (!$cu->isAuthenticated()) {
// check to see if they are a user.
$val = $this->isUser();
//print ("val: ". $val);
return $val;
}
} else {
return true;
}
}
function authByInput($user_id, $password) {
// set credentials
$this->credentials['user_id'] = owa_sanitize::cleanUserId( $user_id );
// must encrypt password to see if it matches whats in the db
$this->credentials['password'] = $this->generateAuthCredential( $this->credentials['user_id'], $this->encryptPassword( $password ) );
//owa_coreAPI::debug(print_r($this->credentials, true));
$ret = $this->isUser();
if ($ret === true) {
$this->saveCredentials();
}
return $ret;
}
/**
* Looks up user by temporary Passkey Column in db
*
* @param unknown_type $key
* @return unknown
*/
function authenticateUserTempPasskey( $key ) {
$key = owa_sanitize::cleanMd5( $key );
if ( $key ) {
$this->u = owa_coreAPI::entityFactory('base.user');
$this->u->getByColumn('temp_passkey', $key);
$id = $this->u->get('id');
if (!empty($id)) {
return true;
} else {
return false;
}
} else {
return false;
}
}
/**
* Authenticates user by a passkey
*
* @param unknown_type $key
* @return unknown
*/
function authenticateUserByUrlPasskey($user_id, $passkey) {
$passkey = owa_sanitize::cleanMd5( $passkey );
if ( $passkey ) {
// set credentials
$this->credentials['user_id'] = $user_id;
$this->credentials['passkey'] = $passkey;
// fetch user obj
$this->getUser();
// generate a new passkey from its components in the db
$key = $this->generateUrlPasskey($this->u->get('user_id'), $this->u->get('password'));
// see if it matches the key on the url
if ($key == $passkey) {
return true;
} else {
return false;
}
} else {
return false;
}
}
/**
* Sets a temporary Passkey for a user
*
* @param string $email_address
* @return boolean
*/
function setTempPasskey($email_address) {
$this->u = owa_coreAPI::entityFactory('base.user');
$this->u->getByColumn('email_address', $email_address);
$id = $u->get('id');
if (!empty($id)):
$this->eq->log(array('email_address' => $this->u->email_address), 'user.set_temp_passkey');
return true;
else:
return false;
endif;
}
function generateTempPasskey($seed) {
return md5($seed.time().rand());
}
function generateUrlPasskey($user_name, $password) {
return md5($user_name . $password);
}
/**
* Sets the initial Passkey for a new user
*
* @param string $user_id
* @return boolean
* @deprecated
*/
function setInitialPasskey($user_id) {
return $this->eq->log(array('user_id' => $user_id), 'user.set_initial_passkey');
}
/**
* Saves login credentails to persistant browser cookies
* TODO: refactor to use state facility
*/
function saveCredentials() {
$this->e->debug('saving user credentials to cookies');
setcookie($this->config['ns'].'u', $this->u->get('user_id'), time()+3600*24*365*10, '/', $this->config['cookie_domain']);
setcookie($this->config['ns'].'p', $this->generateAuthCredential( $this->credentials['user_id'], $this->u->get('password') ), time()+3600*24*2, '/', $this->config['cookie_domain']);
}
/**
* Removes credentials
* @return boolean
*/
function deleteCredentials() {
return owa_coreAPI::clearState('p');
}
/**
* Simple Password Encryption Scheme
*
* @param string $password
* @return string
*/
function encryptPassword($password) {
return owa_lib::encryptPassword($password);
}
function getUser() {
// fetch user object from the db
$this->u = owa_coreAPI::entityFactory('base.user');
$this->u->getByColumn('user_id', $this->credentials['user_id']);
}
/**
* Checks to see if the user credentials match a real user object in the DB
*
* @return boolean
*/
function isUser() {
// get current user
$cu = owa_coreAPI::getCurrentUser();
// fetches user object from DB
$this->getUser();
if ( $this->credentials['user_id'] === $this->u->get('user_id') ) {
//if ($this->credentials['password'] === $this->u->get('password')):
if ( $this->isValidAuthCredential( $this->credentials['user_id'], $this->credentials['password'] ) ) {
$this->_is_user = true;
// set as new current user in service layer
$cu->loadNewUserByObject( $this->u );
$cu->setAuthStatus(true);
return true;
} else {
$this->_is_user = false;
return false;
}
} else {
$this->_is_user = false;
return false;
}
}
function isValidAuthCredential( $user_id, $passed_credential ) {
$hash = '';
$hash = $this->reconstructAuthCredential( $user_id );
//print "hash: $hash ";
//print "passed credential: $passed_credential ";
if ( function_exists('hash_equals') ) {
return hash_equals( $hash, $passed_credential );
} else {
if ( $hash === $passed_credential ) {
return true;
}
}
}
function reconstructAuthCredential( $user_id ) {
$u = owa_coreAPI::entityFactory('base.user');
$u->getByColumn( 'user_id', $user_id );
$password = $u->get('password');
//print "password $password";
return $this->generateAuthCredential( $user_id, $password );
}
function generateAuthCredential($user_id, $password, $expiration = '', $scheme = 'auth') {
$frag = substr($password, 8, 4);
$key = owa_coreAPI::saltedHash( $user_id . $frag . $expiration, $scheme );
$algo = 'sha1';
if ( function_exists( 'hash' ) ) {
$algo = 'sha256';
}
$hash = owa_lib::hash( $algo, $user_id . $expiration, $key );
$credential = $hash; // could add other elements here.
return $credential;
}
}
?>