dolibarr 25.0.0-alpha
security2.lib.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2008-2011 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2008-2017 Regis Houssin <regis.houssin@inodbox.com>
4 * Copyright (C) 2024-2026 MDW <mdeweerd@users.noreply.github.com>
5 * Copyright (C) 2024-2026 Frédéric France <frederic.france@free.fr>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 * or see https://www.gnu.org/
20 */
21
37function dol_getwebuser($mode)
38{
39 $t = '?';
40 if ($mode == 'user') {
41 $t = getenv('APACHE_RUN_USER'); // $_ENV['APACHE_RUN_USER'] is empty
42 }
43 if ($mode == 'group') {
44 $t = getenv('APACHE_RUN_GROUP');
45 }
46 return $t;
47}
48
59function checkLoginPassEntity($usertotest, $passwordtotest, $entitytotest, $authmode, $context = '')
60{
61 global $conf, $langs;
62
63 // Check parameters
64 if ($entitytotest == '') {
65 $entitytotest = 1;
66 }
67
68 dol_syslog("checkLoginPassEntity usertotest=".$usertotest." entitytotest=".$entitytotest." authmode=".implode(',', $authmode));
69 $login = '';
70
71 // Validation of login/pass/entity with standard modules
72 if (empty($login)) {
73 $test = true;
74 foreach ($authmode as $mode) {
75 if ($test && $mode && !$login) {
76 // Validation of login/pass/entity for mode $mode
77 $mode = trim($mode);
78 $authfile = 'functions_'.$mode.'.php';
79 $fullauthfile = '';
80
81 $dirlogin = array_merge(array("/core/login"), (array) $conf->modules_parts['login']);
82 foreach ($dirlogin as $reldir) {
83 $dir = dol_buildpath($reldir, 0);
84 $newdir = dol_osencode($dir);
85
86 // Check if file found (do not use dol_is_file to avoid loading files.lib.php)
87 $tmpnewauthfile = $newdir.(preg_match('/\/$/', $newdir) ? '' : '/').$authfile;
88 if (is_file($tmpnewauthfile)) {
89 $fullauthfile = $tmpnewauthfile;
90 }
91 }
92
93 $result = false;
94 if ($fullauthfile) {
95 $result = include_once $fullauthfile;
96 }
97 if ($fullauthfile && $result) {
98 // Call function to check user/password
99 $function = 'check_user_password_'.$mode;
100 $login = call_user_func($function, $usertotest, $passwordtotest, $entitytotest, $context);
101 if ($login && $login != '--bad-login-validity--') {
102 // Login is successful with this method
103 $test = false; // To stop once at first login success
104 $conf->authmode = $mode; // This properties is defined only when logged to say what mode was successfully used
105 /*$dol_tz = GETPOST('tz');
106 $dol_dst = GETPOST('dst');
107 $dol_screenwidth = GETPOST('screenwidth');
108 $dol_screenheight = GETPOST('screenheight');*/
109 }
110 } else {
111 dol_syslog("Authentication KO - failed to load file '".$authfile."'", LOG_ERR);
112 sleep(1);
113 // Load translation files required by the page
114 $langs->loadLangs(array('other', 'main', 'errors'));
115
116 $_SESSION["dol_loginmesg"] = (empty($_SESSION["dol_loginmesg"]) ? '' : $_SESSION["dol_loginmesg"].', ').$langs->transnoentitiesnoconv("ErrorFailedToLoadLoginFileForMode", $mode);
117 }
118 }
119 }
120 }
121
122 return $login;
123}
124
125
126if (!function_exists('dol_loginfunction')) {
136 function dol_loginfunction($langs, $conf, $mysoc)
137 {
138 global $dolibarr_main_demo, $dolibarr_main_force_https;
139 global $db, $hookmanager;
140
141 $langs->loadLangs(array("main", "other", "help", "admin"));
142
143 // Instantiate hooks of thirdparty module only if not already define
144 $hookmanager->initHooks(array('mainloginpage'));
145
146 $main_authentication = $conf->file->main_authentication;
147
148 $session_name = session_name(); // Get current session name
149
150 $dol_url_root = DOL_URL_ROOT;
151
152 // Title
153 $appli = constant('DOL_APPLICATION_TITLE');
154 $title = $appli.(getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER') ? '' : ' '.constant('DOL_VERSION'));
155
156 $customapplication = getDolGlobalString('MAIN_APPLICATION_TITLE');
157 if ($customapplication) {
158 if (preg_match('/^\+/', $customapplication)) {
159 $title .= $customapplication;
160 } else {
161 $title = $customapplication;
162 }
163 }
164 $titletruedolibarrversion = constant('DOL_VERSION'); // $title used by login template after the @ to inform of true Dolibarr version
165
166 // Note: $conf->css looks like '/theme/eldy/style.css.php'
167 /*
168 $conf->css = "/theme/".(GETPOST('theme','aZ09')?GETPOST('theme','aZ09'):$conf->theme)."/style.css.php";
169 $themepath=dol_buildpath($conf->css,1);
170 if (!empty($conf->modules_parts['theme'])) // Using this feature slow down application
171 {
172 foreach($conf->modules_parts['theme'] as $reldir)
173 {
174 if (file_exists(dol_buildpath($reldir.$conf->css, 0)))
175 {
176 $themepath=dol_buildpath($reldir.$conf->css, 1);
177 break;
178 }
179 }
180 }
181 $conf_css = $themepath."?lang=".$langs->defaultlang;
182 */
183
184 // Select templates dir
185 $template_dir = '';
186 if (!empty($conf->modules_parts['tpl'])) { // Using this feature slow down application
187 $dirtpls = array_merge($conf->modules_parts['tpl'], array('/core/tpl/'));
188 foreach ($dirtpls as $reldir) {
189 $tmp = dol_buildpath($reldir.'login.tpl.php');
190 if (file_exists($tmp)) {
191 $template_dir = preg_replace('/login\.tpl\.php$/', '', $tmp);
192 break;
193 }
194 }
195 } else {
196 $template_dir = DOL_DOCUMENT_ROOT."/core/tpl/";
197 }
198
199 // Set cookie for timeout management. We set it as a cookie so we will be able to use it to set timeout on next page before the session start
200 // and the conf file is loaded.
201 $prefix = dol_getprefix('');
202 $sessiontimeout = 'DOLSESSTIMEOUT_'.$prefix;
203
204 if (getDolGlobalString('MAIN_SESSION_TIMEOUT')) {
205 dolSetCookie($sessiontimeout, getDolGlobalString('MAIN_SESSION_TIMEOUT'), 0);
206 }
207
208 if (GETPOST('urlfrom', 'alpha')) {
209 $_SESSION["urlfrom"] = GETPOST('urlfrom', 'alpha');
210 } else {
211 unset($_SESSION["urlfrom"]);
212 }
213
214 if (!GETPOST("username", 'alpha')) {
215 $focus_element = 'username';
216 } else {
217 $focus_element = 'password';
218 }
219
220 $demologin = '';
221 $demopassword = '';
222 if (!empty($dolibarr_main_demo)) {
223 $tab = explode(',', $dolibarr_main_demo);
224 $demologin = $tab[0];
225 $demopassword = $tab[1];
226 }
227
228 // Execute hook getLoginPageOptions (for table)
229 $parameters = array('entity' => GETPOSTINT('entity'), 'switchentity' => GETPOSTINT('switchentity'));
230 $reshook = $hookmanager->executeHooks('getLoginPageOptions', $parameters); // Note that $action and $object may have been modified by some hooks.
231 $morelogincontent = $hookmanager->resPrint;
232
233 // Execute hook getLoginPageExtraOptions (eg for js)
234 $parameters = array('entity' => GETPOSTINT('entity'), 'switchentity' => GETPOSTINT('switchentity'));
235 $reshook = $hookmanager->executeHooks('getLoginPageExtraOptions', $parameters); // Note that $action and $object may have been modified by some hooks.
236 $moreloginextracontent = $hookmanager->resPrint;
237
238 //Redirect after connection
239 $parameters = array('entity' => GETPOSTINT('entity'), 'switchentity' => GETPOSTINT('switchentity'));
240 $reshook = $hookmanager->executeHooks('redirectAfterConnection', $parameters); // Note that $action and $object may have been modified by some hooks.
241 $php_self = $hookmanager->resPrint;
242
243 // Login
244 $login = (!empty($hookmanager->resArray['username']) ? $hookmanager->resArray['username'] : (GETPOST("username", "alpha") ? GETPOST("username", "alpha") : $demologin));
245 $password = $demopassword;
246
247 // Show logo (search in order: small company logo, large company logo, theme logo, common logo)
248 $width = 0;
249 $urllogo = DOL_URL_ROOT.'/theme/common/login_logo.png';
250
251 if (!empty($mysoc->logo_small) && is_readable($conf->mycompany->dir_output.'/logos/thumbs/'.$mysoc->logo_small)) {
252 $urllogo = DOL_URL_ROOT.'/viewimage.php?cache=1&amp;modulepart=mycompany&amp;file='.urlencode('logos/thumbs/'.$mysoc->logo_small);
253 } elseif (!empty($mysoc->logo) && is_readable($conf->mycompany->dir_output.'/logos/'.$mysoc->logo)) {
254 $urllogo = DOL_URL_ROOT.'/viewimage.php?cache=1&amp;modulepart=mycompany&amp;file='.urlencode('logos/'.$mysoc->logo);
255 $width = 128;
256 } elseif (!empty($mysoc->logo_squarred_small) && is_readable($conf->mycompany->dir_output.'/logos/thumbs/'.$mysoc->logo_squarred_small)) {
257 $urllogo = DOL_URL_ROOT.'/viewimage.php?cache=1&amp;modulepart=mycompany&amp;file='.urlencode('logos/thumbs/'.$mysoc->logo_squarred_small);
258 } elseif (is_readable(DOL_DOCUMENT_ROOT.'/theme/dolibarr_logo.svg')) {
259 $urllogo = DOL_URL_ROOT.'/theme/dolibarr_logo.svg';
260 }
261
262 // Security graphical code
263 $captcha = '';
264 if (getDolGlobalString('MAIN_SECURITY_ENABLECAPTCHA')) {
265 $captcha = getDolGlobalString('MAIN_SECURITY_ENABLECAPTCHA_HANDLER', 'standard');
266 }
267
268 // Extra link
269 $forgetpasslink = 0;
270 $helpcenterlink = 0;
271 if (!getDolGlobalString('MAIN_SECURITY_DISABLEFORGETPASSLINK') || getDolGlobalString('MAIN_HELPCENTER_LINKTOUSE')) {
272 if (!getDolGlobalString('MAIN_SECURITY_DISABLEFORGETPASSLINK')) {
273 $forgetpasslink = 1;
274 }
275
276 if (getDolGlobalString('MAIN_HELPCENTER_LINKTOUSE')) {
277 $helpcenterlink = 1;
278 }
279 }
280
281 // Home message
282 $main_home = '';
283 if (getDolGlobalString('MAIN_HOME')) {
284 $substitutionarray = getCommonSubstitutionArray($langs);
285 complete_substitutions_array($substitutionarray, $langs);
286 $texttoshow = make_substitutions(getDolGlobalString('MAIN_HOME'), $substitutionarray, $langs);
287
288 $main_home = dol_htmlcleanlastbr($texttoshow);
289 }
290
291 // Google AD
292 $main_google_ad_client = ((getDolGlobalString('MAIN_GOOGLE_AD_CLIENT') && getDolGlobalString('MAIN_GOOGLE_AD_SLOT')) ? 1 : 0);
293
294 // Set jquery theme
295 $dol_loginmesg = (!empty($_SESSION["dol_loginmesg"]) ? $_SESSION["dol_loginmesg"] : '');
296
297 $favicon = DOL_URL_ROOT.'/theme/dolibarr_256x256_color.png';
298 if (!empty($mysoc->logo_squarred_mini)) {
299 $favicon = DOL_URL_ROOT.'/viewimage.php?cache=1&modulepart=mycompany&file='.urlencode('logos/thumbs/'.$mysoc->logo_squarred_mini);
300 }
301 if (getDolGlobalString('MAIN_FAVICON_URL')) {
302 $favicon = getDolGlobalString('MAIN_FAVICON_URL');
303 }
304
305 $jquerytheme = 'base';
306 if (getDolGlobalString('MAIN_USE_JQUERY_THEME')) {
307 $jquerytheme = getDolGlobalString('MAIN_USE_JQUERY_THEME');
308 }
309
310 // Set dol_hide_topmenu, dol_hide_leftmenu, dol_optimize_smallscreen, dol_no_mouse_hover
311 $dol_hide_topmenu = GETPOSTINT('dol_hide_topmenu');
312 $dol_hide_leftmenu = GETPOSTINT('dol_hide_leftmenu');
313 $dol_optimize_smallscreen = GETPOSTINT('dol_optimize_smallscreen');
314 $dol_no_mouse_hover = GETPOSTINT('dol_no_mouse_hover');
315 $dol_use_jmobile = GETPOSTINT('dol_use_jmobile');
316
317 // Include login page template
318 include $template_dir.'login.tpl.php';
319
320 // Global html output events ($mesgs, $errors, $warnings)
322
323 $_SESSION["dol_loginmesg"] = '';
324 }
325}
326
335function makesalt($type = CRYPT_SALT_LENGTH)
336{
337 dol_syslog("makesalt type=".$type);
338 switch ($type) {
339 case 12: // 8 + 4
340 $saltlen = 8;
341 $saltprefix = '$1$';
342 $saltsuffix = '$';
343 break;
344 case 8: // 8 (For compatibility, do not use this)
345 $saltlen = 8;
346 $saltprefix = '$1$';
347 $saltsuffix = '$';
348 break;
349 case 2: // 2
350 default: // by default, fall back on Standard DES (should work everywhere)
351 $saltlen = 2;
352 $saltprefix = '';
353 $saltsuffix = '';
354 break;
355 }
356 $salt = '';
357 while (dol_strlen($salt) < $saltlen) {
358 $salt .= chr(mt_rand(64, 126));
359 }
360
361 $result = $saltprefix.$salt.$saltsuffix;
362 dol_syslog("makesalt return=".$result);
363 return $result;
364}
365
372function encodedecode_dbpassconf($level = 0)
373{
374 dol_syslog("encodedecode_dbpassconf level=".$level, LOG_DEBUG);
375 $config = '';
376 $passwd = '';
377 $passwd_crypted = '';
378
379 if ($fp = fopen(DOL_DOCUMENT_ROOT.'/conf/conf.php', 'r')) {
380 while (!feof($fp)) {
381 $buffer = fgets($fp, 4096);
382
383 $lineofpass = 0;
384
385 $reg = array();
386 $mode = '';
387 if (preg_match('/^[^#]*dolibarr_main_db_encrypted_pass[\s]*=[\s]*(.*)/i', $buffer, $reg)) { // Old way to save encrypted value
388 $val = trim($reg[1]); // This also remove CR/LF
389 $val = preg_replace('/^["\']/', '', $val);
390 $val = preg_replace('/["\'][\s;]*$/', '', $val);
391 if (!empty($val)) {
392 $passwd_crypted = $val;
393 // method dol_encode/dol_decode
394 $val = dol_decode($val);
395 //$val = dolEncrypt($val);
396 $passwd = $val;
397 $lineofpass = 1;
398 }
399 } elseif (preg_match('/^[^#]*dolibarr_main_db_pass[\s]*=[\s]*(.*)/i', $buffer, $reg)) {
400 $val = trim($reg[1]); // This also remove CR/LF
401 $val = preg_replace('/^["\']/', '', $val);
402 $val = preg_replace('/["\'][\s;]*$/', '', $val);
403 if (preg_match('/crypted:/i', $buffer)) {
404 // method dol_encode/dol_decode
405 $mode = 'crypted:';
406 $val = preg_replace('/crypted:/i', '', $val);
407 $passwd_crypted = $val;
408 $val = dol_decode($val);
409 $passwd = $val;
410 } elseif (preg_match('/^dolcrypt:([^:]+):(.*)$/i', $val, $reg)) {
411 // method dolEncrypt/dolDecrypt
412 $mode = 'dolcrypt:';
413 //$val = preg_replace('/dolcrypt:/i', '', $val);
414 $passwd_crypted = $reg[1].':'.$reg[2];
415 $val = dolDecrypt($val);
416 $passwd = $val;
417 } else {
418 $passwd = $val;
419 /* old method
420 $mode = 'crypted:';
421 $val = dol_encode($val);
422 */
423 $mode = 'dolcrypt:';
424 $passwd_crypted = preg_replace('/^dolcrypt:/', '', dolEncrypt($val));
425 }
426 $lineofpass = 1;
427 }
428
429 // Output line
430 if ($lineofpass) {
431 // Add value at end of file
432 if ($level == 0) {
433 $config .= '$dolibarr_main_db_pass=\''.$passwd.'\';'."\n";
434 }
435 if ($level == 1) {
436 $config .= '$dolibarr_main_db_pass=\''.$mode.$passwd_crypted.'\';'."\n";
437 }
438
439 //print 'passwd = '.$passwd.' - passwd_crypted = '.$passwd_crypted;
440 //exit;
441 } else {
442 $config .= $buffer;
443 }
444 }
445 fclose($fp);
446
447 // Write new conf file
448 $file = DOL_DOCUMENT_ROOT.'/conf/conf.php';
449 if ($fp = @fopen($file, 'w')) {
450 fwrite($fp, $config);
451 fflush($fp);
452 fclose($fp);
453 clearstatcache();
454
455 // It's config file, so we set read permission for creator only.
456 // Should set permission to web user and groups for users used by batch
457 //dolChmod($file, '0600');
458
459 return 1;
460 } else {
461 dol_syslog("encodedecode_dbpassconf Failed to open conf.php file for writing", LOG_WARNING);
462 return -1;
463 }
464 } else {
465 dol_syslog("encodedecode_dbpassconf Failed to read conf.php", LOG_ERR);
466 return -2;
467 }
468}
469
482{
483 global $conf;
484
485 return empty($conf->file->restrict_password_generation_none) ? 0 : 1;
486}
487
498{
499 return isPasswordGenerationNoneForbidden() ? 10 : 1;
500}
501
512function getRandomPassword($generic = false, $replaceambiguouschars = null, $length = 32)
513{
514 global $db, $conf, $langs, $user;
515
516 $generated_password = '';
517
518 if ($generic) {
519 $lowercase = "qwertyuiopasdfghjklzxcvbnm";
520 $uppercase = "ASDFGHJKLZXCVBNMQWERTYUIOP";
521 $numbers = "1234567890";
522 $randomCode = "";
523 $nbofchar = round($length / 3);
524 $nbofcharlast = ($length - 2 * $nbofchar);
525 //var_dump($nbofchar.'-'.$nbofcharlast);
526 if (function_exists('random_int')) { // Cryptographic random
527 $max = strlen($lowercase) - 1;
528 for ($x = 0; $x < $nbofchar; $x++) {
529 $tmp = random_int(0, $max);
530 $randomCode .= $lowercase[$tmp];
531 }
532 $max = strlen($uppercase) - 1;
533 for ($x = 0; $x < $nbofchar; $x++) {
534 $tmp = random_int(0, $max);
535 $randomCode .= $uppercase[$tmp];
536 }
537 $max = strlen($numbers) - 1;
538 for ($x = 0; $x < $nbofcharlast; $x++) {
539 $tmp = random_int(0, $max);
540 $randomCode .= $numbers[$tmp];
541 }
542 } else {
543 // Old platform, non cryptographic random
544 $max = strlen($lowercase) - 1;
545 for ($x = 0; $x < $nbofchar; $x++) {
546 $tmp = mt_rand(0, $max);
547 $randomCode .= $lowercase[$tmp];
548 }
549 $max = strlen($uppercase) - 1;
550 for ($x = 0; $x < $nbofchar; $x++) {
551 $tmp = mt_rand(0, $max);
552 $randomCode .= $uppercase[$tmp];
553 }
554 $max = strlen($numbers) - 1;
555 for ($x = 0; $x < $nbofcharlast; $x++) {
556 $tmp = mt_rand(0, $max);
557 $randomCode .= $numbers[$tmp];
558 }
559 }
560
561 // Use the Fisher-Yate to shake (this replace str_shuffle)
562 $passwordArray = str_split($randomCode);
563 for ($i = count($passwordArray) - 1; $i > 0; $i--) {
564 $j = random_int(0, $i);
565 $tmp = $passwordArray[$i];
566 $passwordArray[$i] = $passwordArray[$j];
567 $passwordArray[$j] = $tmp;
568 }
569 $generated_password = implode('', $passwordArray);
570 } elseif (getDolGlobalString('USER_PASSWORD_GENERATED')) {
571 require_once DOL_DOCUMENT_ROOT."/core/modules/security/generate/modules_genpassword.php";
572 $genhandler = ModeleGenPassword::loadAndInstantiate(getDolGlobalString('USER_PASSWORD_GENERATED'), $db, $conf, $langs, $user);
573 if (!$genhandler) {
574 // Configured generator class could not be resolved (e.g. the module that provided it
575 // was disabled/removed after being selected) — fall back to the always-available
576 // 'standard' generator rather than silently generating and persisting an empty password.
577 dol_syslog("getRandomPassword: generator class for USER_PASSWORD_GENERATED='".getDolGlobalString('USER_PASSWORD_GENERATED')."' not found, falling back to standard", LOG_WARNING);
578 $genhandler = ModeleGenPassword::loadAndInstantiate('standard', $db, $conf, $langs, $user);
579 }
580 if ($genhandler) {
581 '@phan-var-force ModeleGenPassword $genhandler';
582 $generated_password = $genhandler->getNewGeneratedPassword();
583 unset($genhandler);
584 }
585 }
586
587 // Do we have to discard some alphabetic characters ? (usually $replaceambiguouschars is empty)
588 if (is_array($replaceambiguouschars) && count($replaceambiguouschars) > 0) {
589 $numbers = "ABCDEF";
590 $max = strlen($numbers) - 1;
591 if (function_exists('random_int')) { // Cryptographic random
592 $tmp = random_int(0, $max);
593 $generated_password = str_replace($replaceambiguouschars, $numbers[$tmp], $generated_password);
594 } else {
595 $tmp = mt_rand(0, $max);
596 $generated_password = str_replace($replaceambiguouschars, $numbers[$tmp], $generated_password);
597 }
598 }
599
600 return $generated_password;
601}
602
612function dolJSToSetRandomPassword($htmlname, $htmlnameofbutton = 'generate_token', $generic = 1)
613{
614 global $conf;
615
616 $out = '';
617
618 if (!empty($conf->use_javascript_ajax)) {
619 $out .= "\n".'<!-- Js code to suggest a security key -->';
620 $out .= '<script nonce="'.getNonce().'" type="text/javascript">';
621 $out .= 'jQuery(document).ready(function () {
622 jQuery(\'#'.dol_escape_js($htmlnameofbutton).'\').click(function() {
623 var currenttoken = jQuery("meta[name=anti-csrf-currenttoken]").attr("content");
624 console.log(\'dolJSToSetRandomPassword: We click on the button '.dol_escape_js($htmlnameofbutton).' to suggest a key. anti-csrf-currenttoken is \'+currenttoken+\'. We will fill '.dol_escape_js($htmlname).'\');
625 jQuery.get( "'.DOL_URL_ROOT.'/core/ajax/security.php", {
626 action: \'getrandompassword\',
627 generic: '.($generic ? '1' : '0').',
628 token: currenttoken
629 },
630 function(result) {
631 if (jQuery(\'input#'.dol_escape_js($htmlname).'\').attr("type") == "password") {
632 jQuery(\'input#'.dol_escape_js($htmlname).'\').attr("type", "text");
633 }
634 jQuery(\'#'.dol_escape_js($htmlname).'\').val(result);
635 });
636 });
637 });'."\n";
638 $out .= '</script>';
639 }
640
641 return $out;
642}
643
651function showEyeForField($htmlname, $htmlnameofinput)
652{
653 return '<!-- code to manage the eye hide/show -->
654<span id="'.$htmlname.'" tabindex="-1"><span class="fa fa-eye"></span></span>
655<script nonce="'.getNonce().'">
656 $(document).ready(function () {
657 $(\'#'.$htmlname.'\').on(\'click\', function (e) {
658 e.preventDefault();
659 if (event.detail === 0) return false; // Ignore keyboard "clicks"
660 console.log("We click on '.$htmlname.'");
661 const $passwordInput = $(\'#'.$htmlnameofinput.'\');
662
663 if ($passwordInput.is(\'[type=password]\')) {
664 $passwordInput.attr(\'type\', \'text\');
665 jQuery(\'#'.$htmlname.' .fa-eye\').attr(\'class\', \'fa fa-eye-slash\');
666 } else {
667 $passwordInput.attr(\'type\', \'password\');
668 jQuery(\'#'.$htmlname.' .fa-eye-slash\').attr(\'class\', \'fa fa-eye\');
669 }
670
671 return false; // This prevents the click from reloading the page
672 });
673 });
674</script>';
675}
676
684function dolTotpNewSecret($nbbytes = 20)
685{
686 return dolTotpBase32Encode(random_bytes($nbbytes));
687}
688
696{
697 $alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
698 $bits = '';
699 $out = '';
700 $nboctets = strlen($bin); // Byte length of a binary string, dol_strlen() would count UTF-8 chars
701 for ($i = 0; $i < $nboctets; $i++) {
702 $bits .= str_pad(decbin(ord($bin[$i])), 8, '0', STR_PAD_LEFT);
703 }
704 foreach (str_split($bits, 5) as $chunk) {
705 $out .= $alphabet[bindec(str_pad($chunk, 5, '0', STR_PAD_RIGHT))];
706 }
707 return $out;
708}
709
716function dolTotpBase32Decode($base32)
717{
718 $alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
719 $clean = preg_replace('/[^A-Z2-7]/', '', dol_strtoupper($base32));
720 $bits = '';
721 $out = '';
722 $nbchars = dol_strlen($clean);
723 for ($i = 0; $i < $nbchars; $i++) {
724 $bits .= str_pad(decbin((int) strpos($alphabet, $clean[$i])), 5, '0', STR_PAD_LEFT);
725 }
726 foreach (str_split($bits, 8) as $chunk) {
727 if (dol_strlen($chunk) == 8) {
728 $out .= chr(bindec($chunk));
729 }
730 }
731 return $out;
732}
733
743function dolTotpGetCode($base32secret, $timestep, $digits = 6, $algo = 'sha1')
744{
745 $hash = hash_hmac($algo, pack('J', $timestep), dolTotpBase32Decode($base32secret), true);
746 $offset = ord($hash[strlen($hash) - 1]) & 0x0F; // Dynamic truncation of the RFC 4226, on the bytes of the hash
747 $value = unpack('N', substr($hash, $offset, 4))[1] & 0x7FFFFFFF;
748 return str_pad((string) ($value % (10 ** $digits)), $digits, '0', STR_PAD_LEFT);
749}
750
763function dolTotpCheckCode($base32secret, $code, $timestamp = 0, $period = 30, $digits = 6, $drift = 1)
764{
765 if (!is_string($code) && !is_int($code)) { // An array posted as totpcode[] must be refused, not cast
766 return 0;
767 }
768 $code = preg_replace('/[^0-9]/', '', (string) $code);
769 if (dol_strlen($code) != $digits || empty($base32secret)) {
770 return 0;
771 }
772 if (empty($timestamp)) {
773 $timestamp = dol_now();
774 }
775 $currentstep = (int) floor($timestamp / $period);
776 for ($i = -$drift; $i <= $drift; $i++) {
777 if (hash_equals(dolTotpGetCode($base32secret, $currentstep + $i, $digits), $code)) {
778 return $currentstep + $i;
779 }
780 }
781 return 0;
782}
783
794function dolTotpGetUri($login, $base32secret, $issuer = '', $digits = 6, $period = 30)
795{
796 global $mysoc;
797
798 if (empty($issuer)) {
799 $issuer = (empty($mysoc->name) ? 'Dolibarr' : $mysoc->name);
800 }
801 $label = rawurlencode($issuer).':'.rawurlencode($login);
802 $params = 'secret='.rawurlencode($base32secret).'&issuer='.rawurlencode($issuer).'&algorithm=SHA1&digits='.((int) $digits).'&period='.((int) $period);
803
804 return 'otpauth://totp/'.$label.'?'.$params;
805}
806
815function dolTotpGetEnrollment($db, $fk_user)
816{
817 $sql = "SELECT rowid, tokenstring, state, datec, lastaccess FROM ".$db->prefix()."oauth_token";
818 $sql .= " WHERE service = 'dolibarr_totp' AND fk_user = ".((int) $fk_user);
819
820 $resql = $db->query($sql);
821 if (!$resql) {
822 dol_syslog("dolTotpGetEnrollment ".$db->lasterror(), LOG_ERR);
823 return -1;
824 }
825 $num = $db->num_rows($resql);
826 $obj = ($num > 0 ? $db->fetch_object($resql) : null);
827 $db->free($resql);
828 if ($num == 0) {
829 return null;
830 }
831 if (empty($obj)) { // A row exists but can't be fetched: not the same as no row
832 dol_syslog("dolTotpGetEnrollment: row of user ".((int) $fk_user)." can't be fetched", LOG_ERR);
833 return -1;
834 }
835
836 $data = json_decode((string) $obj->tokenstring, true);
837 if (!is_array($data) || empty($data['secret'])) {
838 dol_syslog("dolTotpGetEnrollment: unreadable tokenstring for user ".((int) $fk_user), LOG_ERR);
839 return -1;
840 }
841
842 return array('rowid' => (int) $obj->rowid, 'secret' => dolDecrypt($data['secret']), 'laststep' => (int) $obj->state, 'datec' => $db->jdate($obj->datec), 'lastaccess' => $db->jdate($obj->lastaccess));
843}
844
855function dolTotpSaveEnrollment($db, $fk_user, $secret, $laststep, $entity = 1)
856{
857 $encryptedsecret = dolEncrypt($secret);
858 if (strpos($encryptedsecret, 'dolcrypt:') !== 0) { // dolEncrypt() returns the clear value when there is no key or no openssl: we refuse to store a secret in clear
859 dol_syslog("dolTotpSaveEnrollment: the instance has no encryption key or no openssl, the secret would be stored in clear", LOG_ERR);
860 return -2;
861 }
862 $tokenstring = json_encode(array('secret' => $encryptedsecret));
863 $now = dol_now();
864
865 $sql = "INSERT INTO ".$db->prefix()."oauth_token(service, tokenstring, state, fk_user, entity, datec, lastaccess)";
866 $sql .= " VALUES ('dolibarr_totp', '".$db->escape($tokenstring)."', '".$db->escape(dolTotpFormatStep($laststep))."', ".((int) $fk_user).", ".((int) $entity).", '".$db->idate($now)."', '".$db->idate($now)."')";
867
868 if (!$db->query($sql)) {
869 dol_syslog("dolTotpSaveEnrollment ".$db->lasterror(), LOG_ERR);
870 return -1;
871 }
872
873 return 1;
874}
875
885function dolTotpSetLastStep($db, $rowid, $laststep)
886{
887 $newstate = dolTotpFormatStep($laststep);
888
889 $sql = "UPDATE ".$db->prefix()."oauth_token SET state = '".$db->escape($newstate)."', lastaccess = '".$db->idate(dol_now())."'";
890 $sql .= " WHERE rowid = ".((int) $rowid)." AND (state IS NULL OR state = '' OR state < '".$db->escape($newstate)."')";
891
892 $resql = $db->query($sql);
893 if (!$resql) {
894 dol_syslog("dolTotpSetLastStep ".$db->lasterror(), LOG_ERR);
895 return -1;
896 }
897 if ($db->affected_rows($resql) < 1) {
898 return 0;
899 }
900
901 return 1;
902}
903
910function dolTotpFormatStep($timestep)
911{
912 return str_pad((string) ((int) $timestep), 12, '0', STR_PAD_LEFT);
913}
914
922function dolTotpDeleteEnrollment($db, $fk_user)
923{
924 $sql = "DELETE FROM ".$db->prefix()."oauth_token WHERE service = 'dolibarr_totp' AND fk_user = ".((int) $fk_user);
925
926 if (!$db->query($sql)) {
927 dol_syslog("dolTotpDeleteEnrollment ".$db->lasterror(), LOG_ERR);
928 return -1;
929 }
930
931 return 1;
932}
933
944function dolTotpStartSecondFactor($db, $login, $entity)
945{
946 global $conf, $langs;
947
948 $tmpuser = new User($db);
949 if ($tmpuser->fetch(0, $login, '', 0, ($entity > 0 ? $entity : -1)) <= 0) { // Just validated but not loadable: we fail closed rather than skip the second factor
950 $langs->loadLangs(array('main', 'errors'));
951 $_SESSION["dol_loginmesg"] = $langs->transnoentitiesnoconv("ErrorCantLoadUserFromDolibarrDatabase", $login);
952 return '';
953 }
954 $enrollment = dolTotpGetEnrollment($db, $tmpuser->id);
955 if ($enrollment === null) {
956 return $login; // No 2FA for this user, the password is enough
957 }
958 if (!is_array($enrollment)) { // An enrollment exists but can't be read: we fail closed, an admin has to remove it from the user card
959 $langs->load("users");
960 $_SESSION["dol_loginmesg"] = $langs->transnoentitiesnoconv("TOTPUnreadableEnrollment");
961 return '';
962 }
963
964 if (session_status() === PHP_SESSION_ACTIVE && !session_regenerate_id(true)) { // The password is verified: a fresh session id, so an id fixed before the login is worth nothing
965 dol_syslog("dolTotpStartSecondFactor: session id could not be regenerated", LOG_WARNING);
966 }
967 // The entity and the authentication mode are the ones the password was checked with: the second step restores them and ignores what is posted then
968 $_SESSION['dol_totp_pending'] = array('login' => $login, 'entity' => (int) $entity, 'authmode' => (empty($conf->authmode) ? '' : $conf->authmode), 'tries' => 0, 'expire' => dol_now() + 300);
969 dol_syslog("Password accepted for ".$login.", now waiting for the two-factor authentication code", LOG_NOTICE);
970
971 return '';
972}
973
983{
984 global $conf, $langs;
985
986 $langs->load("users");
987
988 $pending = empty($_SESSION['dol_totp_pending']) ? array() : $_SESSION['dol_totp_pending'];
989 if (empty($pending['login']) || $pending['expire'] < dol_now()) {
990 unset($_SESSION['dol_totp_pending']);
991 $_SESSION["dol_loginmesg"] = $langs->transnoentitiesnoconv("TOTPLoginExpired");
992 return '';
993 }
994
995 // Same rule as the password check of check_user_password_dolibarr(): past the quota of failed authentications for this IP, no code is checked.
996 // Without it, a login mode that has no quota of its own, like ldap, would let an attacker who knows the password try codes without limit.
997 $nbfailedauth = dolTotpGetNbFailedAuthFromIp($db);
998 if ($nbfailedauth < 0 || $nbfailedauth > getDolGlobalInt("MAIN_SECURITY_MAX_NUMBER_FAILED_AUTH", 100)) { // A quota that can't be counted is treated as exceeded
999 unset($_SESSION['dol_totp_pending']);
1000 dol_syslog("Two-factor authentication code refused for ".$pending['login'].": too many failed authentications from ".getUserRemoteIP(), LOG_WARNING);
1001 $_SESSION["dol_loginmesg"] = $langs->transnoentitiesnoconv("TOTPBadCode");
1002 return '';
1003 }
1004
1005 $tmpuser = new User($db);
1006 if ($tmpuser->fetch(0, $pending['login'], '', 0, ($pending['entity'] > 0 ? $pending['entity'] : -1)) <= 0) {
1007 unset($_SESSION['dol_totp_pending']);
1008 return '';
1009 }
1010 $enrollment = dolTotpGetEnrollment($db, $tmpuser->id);
1011 if (!is_array($enrollment)) { // Removed meanwhile, or unreadable: refused either way
1012 unset($_SESSION['dol_totp_pending']);
1013 return '';
1014 }
1015
1016 $laststep = dolTotpCheckCode($enrollment['secret'], GETPOST('totpcode', 'alphanohtml', 2)); // Read from POST only, so a code never ends up in an access log
1017 if ($laststep <= 0 || $laststep <= $enrollment['laststep']) { // A code already accepted once is refused, so a captured code can't be played again
1018 $pending['tries'] = (empty($pending['tries']) ? 0 : (int) $pending['tries']) + 1;
1019 if ($pending['tries'] >= 3) {
1020 unset($_SESSION['dol_totp_pending']); // Too many wrong codes, the password has to be entered again
1021 } else {
1022 $_SESSION['dol_totp_pending'] = $pending;
1023 }
1024 dol_syslog("Two-factor authentication code refused for ".$pending['login'], LOG_WARNING);
1025 $_SESSION["dol_loginmesg"] = $langs->transnoentitiesnoconv("TOTPBadCode");
1026 return '';
1027 }
1028
1029 unset($_SESSION['dol_totp_pending']);
1030 if (dolTotpSetLastStep($db, $enrollment['rowid'], $laststep) <= 0) { // Not stored, or already stored by a concurrent request: the code would stay replayable, so we fail closed
1031 dol_syslog("Two-factor authentication code refused for ".$pending['login'].", its time step could not be recorded", LOG_WARNING);
1032 $_SESSION["dol_loginmesg"] = $langs->transnoentitiesnoconv("TOTPBadCode");
1033 return '';
1034 }
1035 $conf->authmode = $pending['authmode']; // Same value checkLoginPassEntity() set on the first step
1036 if (session_status() === PHP_SESSION_ACTIVE && !session_regenerate_id(true)) { // Fully authenticated: a fresh session id again
1037 dol_syslog("dolTotpCheckPendingLogin: session id could not be regenerated", LOG_WARNING);
1038 }
1039
1040 return $pending['login'];
1041}
1042
1051{
1052 $sql = "SELECT COUNT(e.rowid) as nbevent";
1053 $sql .= " FROM ".$db->prefix()."events as e";
1054 $sql .= " WHERE e.type = 'USER_LOGIN_FAILED'";
1055 $sql .= " AND e.ip = '".$db->escape(getUserRemoteIP())."'";
1056 $sql .= " AND e.dateevent > '".$db->idate(dol_now() - 24 * 3600)."'";
1057
1058 $resql = $db->query($sql);
1059 if (!$resql) {
1060 dol_syslog("dolTotpGetNbFailedAuthFromIp ".$db->lasterror(), LOG_ERR);
1061 return -1;
1062 }
1063 $obj = $db->fetch_object($resql);
1064 $db->free($resql);
1065
1066 return (empty($obj) ? 0 : (int) $obj->nbevent);
1067}
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
static loadAndInstantiate($id, $db, $conf, $langs, $user)
Locate, load and instantiate a password generator/validator model by its id (the value stored in USER...
Class to manage Dolibarr users.
$context
@method int call_trigger(string $triggerName, ?User $user)
Definition command.php:209
global $mysoc
dol_now($mode='gmt')
Return date for now.
dol_strlen($string, $stringencoding='UTF-8', $binarycount=0)
Make a strlen call.
dol_osencode($str)
Return a string encoded into OS filesystem encoding.
dolSetCookie(string $cookiename, string $cookievalue, int $expire=-1)
Set a cookie.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
dol_escape_js($stringtoescape, $mode=0, $noescapebackslashn=0)
Returns text escaped for inclusion into JavaScript code.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0, $nodefault=0)
Return value of a param into GET or POST supervariable.
dol_htmlcleanlastbr($stringtodecode)
This function remove all ending and br at end.
dol_strtoupper($string, $encoding="UTF-8")
Convert a string to upper.
complete_substitutions_array(&$substitutionarray, $outputlangs, $object=null, $parameters=null, $callfunc="completesubstitutionarray")
Complete the $substitutionarray with more entries coming from external module that had set the "subst...
make_substitutions($text, $substitutionarray, $outputlangs=null, $converttextinhtmlifnecessary=0)
Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newva...
GETPOSTINT($paramname, $method=0, $nodefault=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
getUserRemoteIP($trusted=0)
Return the real IP of remote user.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
dol_htmloutput_events($disabledoutputofmessages=0)
Print formatted messages to output (Used to show messages on html output).
conf($dolibarr_main_document_root, $realpathconf=null)
Load conf file (file must exists)
Definition inc.php:431
dolTotpSaveEnrollment($db, $fk_user, $secret, $laststep, $entity=1)
Save a TOTP enrollment confirmed by a valid code.
dolTotpCheckPendingLogin($db)
Check the code of the second step of a two-factor authentication.
dolTotpBase32Decode($base32)
Decode a base32 string (alphabet of the RFC 4648).
dolJSToSetRandomPassword($htmlname, $htmlnameofbutton='generate_token', $generic=1)
Output javascript to autoset a generated password using default module into a HTML element.
dolTotpNewSecret($nbbytes=20)
Generate a new secret for a TOTP enrollment (RFC 6238), in the base32 form expected by the authentica...
dolTotpDeleteEnrollment($db, $fk_user)
Delete the TOTP enrollment of a user, who then logs in with the password only again.
dolTotpSetLastStep($db, $rowid, $laststep)
Store the time step of the last code accepted, so the same code can't be played twice.
dolTotpGetUri($login, $base32secret, $issuer='', $digits=6, $period=30)
Build the otpauth:// URI of an enrollment, to be shown as a QR code to the user.
dolTotpFormatStep($timestep)
Format a time step for the 'state' field, at a fixed width so the string comparison done in SQL is a ...
dol_getwebuser($mode)
Return user/group account of web server.
dolTotpGetNbFailedAuthFromIp($db)
Count the failed authentications recorded for the IP of the current request over the last 24 hours.
getPasswordPatternMinLength()
Return the lowest value allowed for the minimum length (first field of USER_PASSWORD_PATTERN) of the ...
encodedecode_dbpassconf($level=0)
Encode or decode database password in config file.
checkLoginPassEntity($usertotest, $passwordtotest, $entitytotest, $authmode, $context='')
Return a login if login/pass was successful.
dolTotpCheckCode($base32secret, $code, $timestamp=0, $period=30, $digits=6, $drift=1)
Check a code sent by a user against a secret, accepting a drift of some periods to tolerate a clock o...
dolTotpBase32Encode($bin)
Encode a binary string into base32 (alphabet of the RFC 4648, no padding).
isPasswordGenerationNoneForbidden()
Return if the 'none' password generation model (the one that applies no rule at all) is forbidden on ...
dolTotpStartSecondFactor($db, $login, $entity)
Start the second step of a two-factor authentication, just after a password has been validated.
getRandomPassword($generic=false, $replaceambiguouschars=null, $length=32)
Return a generated password using default module.
dolTotpGetEnrollment($db, $fk_user)
Load the TOTP enrollment of a user.
if(!function_exists( 'dol_loginfunction')) makesalt($type=CRYPT_SALT_LENGTH)
Initialise the salt for the crypt function.
dolTotpGetCode($base32secret, $timestep, $digits=6, $algo='sha1')
Compute the TOTP code (RFC 6238) of a secret for one time step.
dol_decode($chain, $key='1')
Decode a base 64 encoded + specific delta change.
dolDecrypt($chain, $key='', $patterntotest='')
Decode a string with a symmetric encryption.
dolEncrypt($chain, $key='', $ciphering='', $forceseed='', $obfuscationmode='dolcrypt')
Encode a string with a symmetric encryption.