-
Notifications
You must be signed in to change notification settings - Fork 83
/
Copy pathtwofactor_gauthenticator.php
588 lines (479 loc) · 24.4 KB
/
twofactor_gauthenticator.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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
<?php
/**
* Two-factor Google Authenticator for RoundCube
*
* This RoundCube plugin adds the 2-step verification(OTP) to the login proccess
*
* @version 2.0.0
* @author Alexandre Espinosa <[email protected]>
*
* Some ideas and code: Ricardo Signes <[email protected]>, Ricardo Iván Vieitez Parra (https://github.com/corrideat), Justin Buchanan (https://github.com/jusbuc2k)
* , https://github.com/pokrface, Peter Tobias, Víctor R. Rodríguez Domínguez (https://github.com/vrdominguez), etc.
* Date: 2013-11-30
*/
require_once 'PHPGangsta/GoogleAuthenticator.php';
require_once 'CIDR.php';
class twofactor_gauthenticator extends rcube_plugin
{
private $_number_recovery_codes = 4;
// relative to $config['log_dir']
private $_logs_file = 'log_errors_2FA.txt';
public function init()
{
$rcmail = rcmail::get_instance();
// Completely block AJAX requests for unauthenticated users (by Stephen K. Gielda <[email protected]>)
if (!$rcmail->user->ID && !isset($_SESSION['twofactor_gauthenticator_login']) && isset($_REQUEST['_remote'])) {
// Direct JSON response to prevent leakage
header('Content-Type: application/json');
echo json_encode(array(
'error' => 'Session expired or invalid',
'redirect' => '?_task=login&_err=session'
));
exit;
}
// Block data access via AJAX for partially authenticated users who have 2FA enabled (by Stephen K. Gielda <[email protected]>)
if (isset($_SESSION['twofactor_gauthenticator_login'])
&& (!isset($_SESSION['twofactor_gauthenticator_2FA_login']) || $_SESSION['twofactor_gauthenticator_2FA_login'] < $_SESSION['twofactor_gauthenticator_login'])
&& isset($_REQUEST['_remote']) && $rcmail->action !== 'plugin.twofactor_gauthenticator-checkcode' && $rcmail->task !== 'login') {
// Get user's 2FA config
$user_prefs = $rcmail->user->get_prefs();
$tfa_config = isset($user_prefs['twofactor_gauthenticator']) ? $user_prefs['twofactor_gauthenticator'] : null;
// Only block if 2FA is enabled for this user
if ($tfa_config && isset($tfa_config['activate']) && $tfa_config['activate']) {
// Direct JSON response to prevent leakage
header('Content-Type: application/json');
echo json_encode(array(
'error' => '2FA authentication required',
'redirect' => '?_task=login&_err=session'
));
exit;
}
}
// hooks
$this->add_hook('login_after', array($this, 'login_after'));
$this->add_hook('send_page', array($this, 'check_2FAlogin'));
$this->add_hook('render_page', array($this, 'popup_msg_enrollment'));
$this->load_config();
$allowedPlugin = $this->__pluginAllowedByConfig();
// skipping all logic and plugin not appears
if (!$allowedPlugin) {
return false;
}
$this->add_texts('localization/', true);
// check code with ajax
$this->register_action('plugin.twofactor_gauthenticator-checkcode', array($this, 'checkCode'));
// config
$this->register_action('twofactor_gauthenticator', array($this, 'twofactor_gauthenticator_init'));
$this->register_action('plugin.twofactor_gauthenticator-save', array($this, 'twofactor_gauthenticator_save'));
$this->include_script('twofactor_gauthenticator.js');
$this->include_script('qrcode.min.js');
// settings we will export to the form javascript
//$this_output = $this->api->output;
//if ($this_output) {
// $this->api->output->set_env('allow_save_device_30days',$rcmail->config->get('allow_save_device_30days',true));
// $this->api->output->set_env('twofactor_formfield_as_password',$rcmail->config->get('twofactor_formfield_as_password',false));
//}
}
// check if user are valid from config.inc.php or true (by default) if config.inc.php not exists
public function __pluginAllowedByConfig()
{
$rcmail = rcmail::get_instance();
$this->load_config();
// users allowed to use plugin (not showed for others!).
// -- From config.inc.php file.
// -- You can use regexp: admin.*@domain.com
$users = $rcmail->config->get('users_allowed_2FA');
if (is_array($users)) { // exists "users" from config.inc.php
foreach ($users as $u) {
if (isset($rcmail->user->data['username'])) {
preg_match("/$u/", $rcmail->user->data['username'], $matches);
if (isset($matches[0])) {
return true;
}
}
}
// not allowed for all, except explicit
return false;
}
// by default, all users have plugin activated
return true;
}
// Use the form login, but removing inputs with jquery and action (see twofactor_gauthenticator_form.js)
public function login_after($args)
{
$_SESSION['twofactor_gauthenticator_login'] = time();
$rcmail = rcmail::get_instance();
$config_2FA = self::__get2FAconfig();
if (!($config_2FA['activate'] ?? false)) {
if ($rcmail->config->get('force_enrollment_users')) {
$this->__goingRoundcubeTask('settings', 'plugin.twofactor_gauthenticator');
}
return;
}
if ($this->__cookie($set = false) || !$this->__pluginAllowedByConfig()) {
$_SESSION['twofactor_gauthenticator_login'] -= 1; // so that we may use ge to check for valid session
$this->__goingRoundcubeTask('mail');
return;
}
$rcmail->output->set_pagetitle($this->gettext('twofactor_gauthenticator'));
$rcmail->output->set_env('allow_save_device_30days', $rcmail->config->get('allow_save_device_30days', true));
$rcmail->output->set_env('twofactor_formfield_as_password', $rcmail->config->get('twofactor_formfield_as_password', false));
$this->add_texts('localization', true);
$this->include_script('twofactor_gauthenticator_form.js');
$rcmail->output->send('login');
}
// capture webpage if someone try to use ?_task=mail|addressbook|settings|... and check auth code
public function check_2FAlogin($p)
{
$rcmail = rcmail::get_instance();
$config_2FA = self::__get2FAconfig();
if ($config_2FA['activate'] ?? false) {
// with IP allowed, we don't need to check anything
if ($rcmail->config->get('whitelist')) {
foreach ($rcmail->config->get('whitelist') as $ip_to_check) {
if (isset($_SERVER['HTTP_CLIENT_IP']) && array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
$realip = $_SERVER['HTTP_CLIENT_IP'];
} elseif (isset($_SERVER['HTTP_X_FORWARDED_FOR']) && array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
$realips = explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);
$realips = array_map('trim', $realips);
$realip = $realips[0];
} else {
$realip = $_SERVER['REMOTE_ADDR'] ?? '0.0.0.0';
}
if (CIDR::match($realip, $ip_to_check)) {
if (isset($_SESSION['twofactor_gauthenticator_login'])) {
if ($rcmail->task === 'login') {
$this->__goingRoundcubeTask('mail');
}
return $p;
}
}
}
}
$code = rcube_utils::get_input_value('_code_2FA', rcube_utils::INPUT_POST);
$remember = rcube_utils::get_input_value('_remember_2FA', rcube_utils::INPUT_POST);
if ($code) {
if (self::__checkCode($code) || self::__isRecoveryCode($code)) {
if (self::__isRecoveryCode($code)) {
self::__consumeRecoveryCode($code);
}
if (rcube_utils::get_input_value('_remember_2FA', rcube_utils::INPUT_POST) === 'yes') {
$this->__cookie($set = true);
}
$this->__goingRoundcubeTask('mail');
} else {
if ($rcmail->config->get('enable_fail_logs')) {
$this->__logError();
}
$this->__exitSession();
}
}
// we're into some task but marked with login...
elseif ($rcmail->task !== 'login' && ! $_SESSION['twofactor_gauthenticator_2FA_login'] >= $_SESSION['twofactor_gauthenticator_login']) {
$this->__exitSession();
}
} elseif ($rcmail->config->get('force_enrollment_users') && ($rcmail->task !== 'settings' || $rcmail->action !== 'plugin.twofactor_gauthenticator')) {
if ($rcmail->task !== 'login') { // resolve some redirection loop with logout
$this->__goingRoundcubeTask('settings', 'plugin.twofactor_gauthenticator');
}
}
return $p;
}
// ripped from new_user_dialog plugin
public function popup_msg_enrollment()
{
$rcmail = rcmail::get_instance();
$config_2FA = self::__get2FAconfig();
if (!($config_2FA['activate'] ?? false)
&& $rcmail->config->get('force_enrollment_users') && $rcmail->task == 'settings' && $rcmail->action == 'plugin.twofactor_gauthenticator') {
// add overlay input box to html page
$rcmail->output->add_footer(html::tag(
'form',
array(
'id' => 'enrollment_dialog',
'method' => 'post'),
html::tag('h3', null, $this->gettext('enrollment_dialog_title')) .
$this->gettext('enrollment_dialog_msg')
));
$rcmail->output->add_script(
"$('#enrollment_dialog').show().dialog({ modal:true, resizable:false, closeOnEscape: true, width:420 });",
'docready'
);
}
}
// show config
public function twofactor_gauthenticator_init()
{
$rcmail = rcmail::get_instance();
$this->add_texts('localization/', true);
$this->register_handler('plugin.body', array($this, 'twofactor_gauthenticator_form'));
$rcmail->output->set_pagetitle($this->gettext('twofactor_gauthenticator'));
$rcmail->output->send('plugin');
}
// save config
public function twofactor_gauthenticator_save()
{
$rcmail = rcmail::get_instance();
// Verify user is authenticated before allowing changes (by Stephen K. Gielda <[email protected]>)
if (!$rcmail->user->ID) {
header('Location: ?_task=login');
exit;
}
// 2022-04-03: Corrected security incidente reported by [email protected]
// "2FA in twofactor_gauthenticator can be bypassed allowing an attacker to disable 2FA or change the TOTP secret."
//
// Solution: if user don't have session created by any rendered page, we kick out
$config_2FA = self::__get2FAconfig();
if (!$_SESSION['twofactor_gauthenticator_2FA_login'] && $config_2FA['activate']) {
$this->__exitSession();
}
$this->add_texts('localization/', true);
$this->register_handler('plugin.body', array($this, 'twofactor_gauthenticator_form'));
$rcmail->output->set_pagetitle($this->gettext('twofactor_gauthenticator'));
// POST variables
$activate = rcube_utils::get_input_value('2FA_activate', rcube_utils::INPUT_POST);
$secret = rcube_utils::get_input_value('2FA_secret', rcube_utils::INPUT_POST);
$recovery_codes = rcube_utils::get_input_value('2FA_recovery_codes', rcube_utils::INPUT_POST);
// remove recovery codes without value
$recovery_codes = array_values(array_diff($recovery_codes, array('')));
$data = self::__get2FAconfig();
$data['secret'] = $secret;
$data['activate'] = $activate ? true : false;
$data['recovery_codes'] = $recovery_codes;
self::__set2FAconfig($data);
// if we can't save time into SESSION, the plugin logouts
$_SESSION['twofactor_gauthenticator_2FA_login'] = time();
$rcmail->output->show_message($this->gettext('successfully_saved'), 'confirmation');
$rcmail->overwrite_action('plugin.twofactor_gauthenticator');
$rcmail->output->send('plugin');
}
// form config
public function twofactor_gauthenticator_form()
{
$rcmail = rcmail::get_instance();
$this->add_texts('localization/', true);
$rcmail->output->set_env('product_name', $rcmail->config->get('product_name'));
$data = self::__get2FAconfig();
// Fields will be positioned inside of a table
$table = new html_table(array('cols' => 2));
// Activate/deactivate
$field_id = '2FA_activate';
$checkbox_activate = new html_checkbox(array('name' => $field_id, 'id' => $field_id, 'type' => 'checkbox'));
$table->add('title', html::label($field_id, rcube::Q($this->gettext('activate'))));
$checked = $data['activate'] ? null : 1; // :-?
$table->add(null, $checkbox_activate->show($checked));
// secret
$field_id = '2FA_secret';
$input_descsecret = new html_inputfield(array('name' => $field_id, 'id' => $field_id, 'size' => 60, 'type' => 'password', 'value' => $data['secret'], 'autocomplete' => 'new-password'));
$table->add('title', html::label($field_id, rcube::Q($this->gettext('secret'))));
$html_secret = $input_descsecret->show();
if ($data['secret']) {
$html_secret .= ' <input type="button" class="button mainaction" id="2FA_change_secret" value="'.$this->gettext('show_secret').'">';
} else {
$html_secret .= ' <input type="button" class="button mainaction" id="2FA_create_secret" disabled="disabled" value="'.$this->gettext('create_secret').'">';
}
$table->add(null, $html_secret);
// recovery codes
$table->add('title', $this->gettext('recovery_codes'));
$html_recovery_codes = '';
$i = 0;
for ($i = 0; $i < $this->_number_recovery_codes; $i++) {
$value = isset($data['recovery_codes'][$i]) ? $data['recovery_codes'][$i] : '';
$html_recovery_codes .= ' <input type="password" name="2FA_recovery_codes[]" value="'.$value.'" maxlength="10"> ';
}
if ($data['secret']) {
$html_recovery_codes .= '<input type="button" class="button mainaction" id="2FA_show_recovery_codes" value="'.$this->gettext('show_recovery_codes').'">';
} else {
$html_recovery_codes .= '<input type="button" class="button mainaction" id="2FA_show_recovery_codes" disabled="disabled" value="'.$this->gettext('show_recovery_codes').'">';
}
$table->add(null, $html_recovery_codes);
// qr-code
if ($data['secret']) {
$table->add('title', $this->gettext('qr_code'));
$table->add(null, '<input type="button" class="button mainaction" id="2FA_change_qr_code" value="'.$this->gettext('show_qr_code').'">
<div id="2FA_qr_code" style="display: none; margin-top: 10px;"></div>');
// new JS qr-code, without call to Google
$this->include_script('2FA_qr_code.js');
}
// infor
$table->add(null, '<td><br>'.$this->gettext('msg_infor').'</td>');
// button to setup all fields if doesn't exists secret
$html_setup_all_fields = '';
if (!$data['secret']) {
$html_setup_all_fields = '<input type="button" class="button mainaction" id="2FA_setup_fields" value="'.$this->gettext('setup_all_fields').'">';
}
$html_check_code = '<br /><br /><input type="button" class="button mainaction" id="2FA_check_code" value="'.$this->gettext('check_code').'"> <input type="text" id="2FA_code_to_check" maxlength="10">';
$html_help_code = '<br /><br /> ⓘ '.$this->gettext('msg_help');
// Build the table with the divs around it
$out = html::div(
array('class' => 'settingsbox'),
html::tag('h3', array('id' => 'prefs-title', 'class' => ''), $this->gettext('twofactor_gauthenticator') . ' - ' . $rcmail->user->data['username']) .
html::div(
array('class' => 'boxcontent'),
$table->show() .
html::p(
null,
$rcmail->output->button(array(
'command' => 'plugin.twofactor_gauthenticator-save',
'type' => 'input',
'class' => 'button mainaction',
'label' => 'save'
))
// button show/hide secret
//.'<input type="button" class="button mainaction" id="2FA_change_secret" value="'.$this->gettext('show_secret').'">'
// button to setup all fields
.$html_setup_all_fields
.$html_check_code
.$html_help_code
)
)
);
// Construct the form
$rcmail->output->add_gui_object('twofactor_gauthenticatorform', 'twofactor_gauthenticator-form');
$out = $rcmail->output->form_tag(array(
'id' => 'twofactor_gauthenticator-form',
'name' => 'twofactor_gauthenticator-form',
'method' => 'post',
'action' => './?_task=settings&_action=plugin.twofactor_gauthenticator-save',
), $out);
$out = "<div class='formcontainer'><div class='formcontent'>".$out."</div></div>";
return $out;
}
// used with ajax
public function checkCode()
{
$code = rcube_utils::get_input_value('code', rcube_utils::INPUT_GET);
//$secret = rcube_utils::get_input_value('secret', rcube_utils::INPUT_GET);
$secret = rcube_utils::get_input_value('secret', rcube_utils::INPUT_GET);
if (self::__checkCode($code, $secret)) {
echo $this->gettext('code_ok');
} else {
echo $this->gettext('code_ko');
}
exit;
}
//------------- private methods
// redirect to some RC task and remove 'login' user pref
private function __goingRoundcubeTask($task = 'mail', $action = null)
{
$_SESSION['twofactor_gauthenticator_2FA_login'] = time();
header('Location: ?_task='.$task . ($action ? '&_action='.$action : ''));
exit;
}
private function __exitSession()
{
unset($_SESSION['twofactor_gauthenticator_login']);
unset($_SESSION['twofactor_gauthenticator_2FA_login']);
$rcmail = rcmail::get_instance();
header('Location: ?_task=logout&_token='.$rcmail->get_request_token());
exit;
}
private function __get2FAconfig()
{
$rcmail = rcmail::get_instance();
$user = $rcmail->user;
$arr_prefs = $user->get_prefs();
return $arr_prefs['twofactor_gauthenticator'] ?? null;
}
// we can set array to NULL to remove
private function __set2FAconfig($data)
{
$rcmail = rcmail::get_instance();
$user = $rcmail->user;
$arr_prefs = $user->get_prefs();
$arr_prefs['twofactor_gauthenticator'] = $data;
return $user->save_prefs($arr_prefs);
}
private function __isRecoveryCode($code)
{
$prefs = self::__get2FAconfig();
return in_array($code, $prefs['recovery_codes']);
}
private function __consumeRecoveryCode($code)
{
$prefs = self::__get2FAconfig();
$prefs['recovery_codes'] = array_values(array_diff($prefs['recovery_codes'], array($code)));
self::__set2FAconfig($prefs);
}
// GoogleAuthenticator class methods (see PHPGangsta/GoogleAuthenticator.php for more infor)
// returns string
private function __createSecret()
{
$ga = new PHPGangsta_GoogleAuthenticator();
return $ga->createSecret();
}
// returns string
private function __getSecret()
{
$prefs = self::__get2FAconfig();
return $prefs['secret'];
}
// Commented. If you have problems with qr-code.js, you can uncomment and use this
//
// // returns string (url to img)
// private function __getQRCodeGoogle()
// {
// $rcmail = rcmail::get_instance();
// $ga = new PHPGangsta_GoogleAuthenticator();
// return $ga->getQRCodeGoogleUrl($rcmail->user->data['username'], self::__getSecret(), 'RoundCube2FA');
// }
// returns boolean
private function __checkCode($code, $secret = null)
{
$ga = new PHPGangsta_GoogleAuthenticator();
return $ga->verifyCode(($secret ? $secret : self::__getSecret()), $code, 2); // 2 = 2*30sec clock tolerance
}
// remember option by https://github.com/corrideat/
private function __cookie($set = true)
{
$rcmail = rcmail::get_instance();
$user_agent = hash_hmac('md5', filter_input(INPUT_SERVER, 'USER_AGENT') ?: "\0\0\0\0\0", $rcmail->config->get('des_key'));
$key = hash_hmac('sha256', implode("\2\1\2", array($rcmail->user->data['username'], $this->__getSecret())), $rcmail->config->get('des_key'), true);
$iv = hash_hmac('md5', implode("\3\2\3", array($rcmail->user->data['username'], $this->__getSecret())), $rcmail->config->get('des_key'), true);
$name = hash_hmac('md5', $rcmail->user->data['username'], $rcmail->config->get('des_key'));
if ($set) {
$expires = time() + 2592000; // 30 days from now
$rand = mt_rand();
$signature = hash_hmac('sha512', implode("\1\0\1", array($rcmail->user->data['username'], $this->__getSecret(), $user_agent, $rand, $expires)), $rcmail->config->get('des_key'), true);
$plain_content = sprintf("%d:%d:%s", $expires, $rand, $signature);
$encrypted_content = openssl_encrypt($plain_content, 'aes-256-cbc', $key, OPENSSL_RAW_DATA, $iv);
if ($encrypted_content !== false) {
$b64_encrypted_content = strtr(base64_encode($encrypted_content), '+/=', '-_,');
rcube_utils::setcookie($name, $b64_encrypted_content, $expires);
return true;
}
return false;
} else {
$b64_encrypted_content = filter_input(INPUT_COOKIE, $name, FILTER_VALIDATE_REGEXP, array('options' => array('regexp' => '/[a-zA-Z0-9_-]+,{0,3}/')));
if (is_string($b64_encrypted_content) && !empty($b64_encrypted_content) && strlen($b64_encrypted_content) % 4 === 0) {
$encrypted_content = base64_decode(strtr($b64_encrypted_content, '-_,', '+/='), true);
if ($encrypted_content !== false) {
$plain_content = openssl_decrypt($encrypted_content, 'aes-256-cbc', $key, OPENSSL_RAW_DATA, $iv);
if ($plain_content !== false) {
$now = time();
list($expires, $rand, $signature) = explode(':', $plain_content, 3);
if ($expires > $now && ($expires - $now) <= 2592000) {
$signature_verification = hash_hmac('sha512', implode("\1\0\1", array($rcmail->user->data['username'], $this->__getSecret(), $user_agent, $rand, $expires)), $rcmail->config->get('des_key'), true);
// constant time
$cmp = strlen($signature) ^ strlen($signature_verification);
$signature = $signature ^ $signature_verification;
for ($i = 0; $i < strlen($signature); $i++) {
$cmp += ord($signature [$i]);
}
return ($cmp === 0);
}
}
}
}
return false;
}
}
// END remember
// log error into $_logs_file directory
private function __logError()
{
$rcmail = rcmail::get_instance();
$_log_dir = $rcmail->config->get('log_dir');
file_put_contents($_log_dir.'/'.$this->_logs_file, date("Y-m-d H:i:s")."|".$_SERVER['HTTP_X_FORWARDED_FOR']."|".$_SERVER['REMOTE_ADDR']."\n", FILE_APPEND);
}
}