|
dolibarr 25.0.0-alpha
|
Set of function used for dolibarr security (not common functions). More...
Go to the source code of this file.
Functions | |
| dol_getwebuser ($mode) | |
| Return user/group account of web server. | |
| checkLoginPassEntity ($usertotest, $passwordtotest, $entitytotest, $authmode, $context='') | |
| Return a login if login/pass was successful. | |
| if(!function_exists( 'dol_loginfunction')) | makesalt ($type=CRYPT_SALT_LENGTH) |
| Initialise the salt for the crypt function. | |
| encodedecode_dbpassconf ($level=0) | |
| Encode or decode database password in config file. | |
| isPasswordGenerationNoneForbidden () | |
| Return if the 'none' password generation model (the one that applies no rule at all) is forbidden on this installation. | |
| getPasswordPatternMinLength () | |
| Return the lowest value allowed for the minimum length (first field of USER_PASSWORD_PATTERN) of the 'Perso' password generation model. | |
| getRandomPassword ($generic=false, $replaceambiguouschars=null, $length=32) | |
| Return a generated password using default module. | |
| dolJSToSetRandomPassword ($htmlname, $htmlnameofbutton='generate_token', $generic=1) | |
| Output javascript to autoset a generated password using default module into a HTML element. | |
| showEyeForField ($htmlname, $htmlnameofinput) | |
| Output the eye picto to show/hide a password HTML field. | |
| dolTotpNewSecret ($nbbytes=20) | |
| Generate a new secret for a TOTP enrollment (RFC 6238), in the base32 form expected by the authenticator applications. | |
| dolTotpBase32Encode ($bin) | |
| Encode a binary string into base32 (alphabet of the RFC 4648, no padding). | |
| dolTotpBase32Decode ($base32) | |
| Decode a base32 string (alphabet of the RFC 4648). | |
| dolTotpGetCode ($base32secret, $timestep, $digits=6, $algo='sha1') | |
| Compute the TOTP code (RFC 6238) of a secret for one time step. | |
| 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 offset. | |
| 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. | |
| dolTotpGetEnrollment ($db, $fk_user) | |
| Load the TOTP enrollment of a user. | |
| dolTotpSaveEnrollment ($db, $fk_user, $secret, $laststep, $entity=1) | |
| Save a TOTP enrollment confirmed by a valid code. | |
| dolTotpSetLastStep ($db, $rowid, $laststep) | |
| Store the time step of the last code accepted, so the same code can't be played twice. | |
| dolTotpFormatStep ($timestep) | |
| Format a time step for the 'state' field, at a fixed width so the string comparison done in SQL is a numeric one. | |
| dolTotpDeleteEnrollment ($db, $fk_user) | |
| Delete the TOTP enrollment of a user, who then logs in with the password only again. | |
| dolTotpStartSecondFactor ($db, $login, $entity) | |
| Start the second step of a two-factor authentication, just after a password has been validated. | |
| dolTotpCheckPendingLogin ($db) | |
| Check the code of the second step of a two-factor authentication. | |
| dolTotpGetNbFailedAuthFromIp ($db) | |
| Count the failed authentications recorded for the IP of the current request over the last 24 hours. | |
Set of function used for dolibarr security (not common functions).
Warning, this file must not depends on other library files, except function.lib.php because it is used at low code level.
Definition in file security2.lib.php.
| checkLoginPassEntity | ( | $usertotest, | |
| $passwordtotest, | |||
| $entitytotest, | |||
| $authmode, | |||
| $context = '' ) |
Return a login if login/pass was successful.
| string | $usertotest | Login value to test |
| string | $passwordtotest | Password value to test |
| int | string | $entitytotest | Instance of data we must check |
| string[] | $authmode | Array list of selected authentication mode array('http', 'dolibarr', 'xxx'...) |
| 'api'|'dav'|'ws'|'' | $context Context checkLoginPassEntity was created for ('api', 'dav', 'ws', '') |
Show Dolibarr default login page. Part of this code is also duplicated into main.inc.php\top_htmlhead
| Translate | $langs | Lang object (must be initialized by a new). |
| Conf | $conf | Conf object |
| Societe | $mysoc | Company object |
Definition at line 59 of file security2.lib.php.
References $conf, $context, dol_buildpath(), dol_osencode(), and dol_syslog().
Referenced by check_authentication(), and Login\index().
| dol_getwebuser | ( | $mode | ) |
Return user/group account of web server.
| string | $mode | 'user' or 'group' |
Definition at line 37 of file security2.lib.php.
| dolJSToSetRandomPassword | ( | $htmlname, | |
| $htmlnameofbutton = 'generate_token', | |||
| $generic = 1 ) |
Output javascript to autoset a generated password using default module into a HTML element.
| string | $htmlname | HTML name of element to insert key into |
| string | $htmlnameofbutton | HTML name of button |
| int | $generic | 1=Return a generic pass, 0=Return a pass following setup rules |
Definition at line 612 of file security2.lib.php.
References $conf, and dol_escape_js().
Referenced by FormSetupItem\generateInputFieldSecureKey().
| dolTotpBase32Decode | ( | $base32 | ) |
Decode a base32 string (alphabet of the RFC 4648).
The chars out of the alphabet, like the spaces of a key typed by hand, are ignored.
| string | $base32 | Base32 string |
Definition at line 716 of file security2.lib.php.
References dol_strlen(), and dol_strtoupper().
Referenced by dolTotpGetCode().
| dolTotpBase32Encode | ( | $bin | ) |
Encode a binary string into base32 (alphabet of the RFC 4648, no padding).
| string | $bin | Binary string |
Definition at line 695 of file security2.lib.php.
Referenced by dolTotpNewSecret().
| 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 offset.
| string | $base32secret | Secret in base32 |
| string | $code | Code sent by the user |
| int | $timestamp | Timestamp to check at (0 = now) |
| int | $period | Duration of a time step, in seconds |
| int | $digits | Number of digits of the code |
| int | $drift | Number of periods accepted before and after the current one |
Definition at line 763 of file security2.lib.php.
References dol_now(), dol_strlen(), and dolTotpGetCode().
Referenced by dolTotpCheckPendingLogin().
| dolTotpCheckPendingLogin | ( | $db | ) |
Check the code of the second step of a two-factor authentication.
The login is read from the session and never from the request, so the first step can't be skipped by posting a code alone.
Definition at line 982 of file security2.lib.php.
References $conf, dol_now(), dol_syslog(), dolTotpCheckCode(), dolTotpGetEnrollment(), dolTotpGetNbFailedAuthFromIp(), dolTotpSetLastStep(), getDolGlobalInt(), GETPOST(), and getUserRemoteIP().
| dolTotpDeleteEnrollment | ( | $db, | |
| $fk_user ) |
Delete the TOTP enrollment of a user, who then logs in with the password only again.
Definition at line 922 of file security2.lib.php.
References dol_syslog().
| dolTotpFormatStep | ( | $timestep | ) |
Format a time step for the 'state' field, at a fixed width so the string comparison done in SQL is a numeric one.
| int | $timestep | Time step |
Definition at line 910 of file security2.lib.php.
Referenced by dolTotpSaveEnrollment(), and dolTotpSetLastStep().
| dolTotpGetCode | ( | $base32secret, | |
| $timestep, | |||
| $digits = 6, | |||
| $algo = 'sha1' ) |
Compute the TOTP code (RFC 6238) of a secret for one time step.
| string | $base32secret | Secret in base32 |
| int | $timestep | Time step, that is the timestamp divided by the period |
| int | $digits | Number of digits of the code |
| string | $algo | Hash algorithm ('sha1', 'sha256' or 'sha512') |
Definition at line 743 of file security2.lib.php.
References dolTotpBase32Decode().
Referenced by dolTotpCheckCode().
| dolTotpGetEnrollment | ( | $db, | |
| $fk_user ) |
Load the TOTP enrollment of a user.
The row is written into llx_oauth_token only once the enrollment has been confirmed by a valid code, so its presence means the 2FA is active for this user.
Definition at line 815 of file security2.lib.php.
References dol_syslog(), and dolDecrypt().
Referenced by check_authentication(), dolTotpCheckPendingLogin(), dolTotpStartSecondFactor(), and Login\index().
| dolTotpGetNbFailedAuthFromIp | ( | $db | ) |
Count the failed authentications recorded for the IP of the current request over the last 24 hours.
This is the count check_user_password_dolibarr() does before testing a password; it needs MAIN_LOGEVENTS_USER_LOGIN_FAILED to be enabled, like it.
Definition at line 1050 of file security2.lib.php.
References dol_now(), dol_syslog(), and getUserRemoteIP().
Referenced by dolTotpCheckPendingLogin().
| 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.
| string | $login | Login of the user, shown as the account name in the application |
| string | $base32secret | Secret in base32 |
| string | $issuer | Name of the issuer shown in the application ('' = name of the company) |
| int | $digits | Number of digits of the code |
| int | $period | Duration of a time step, in seconds |
Definition at line 794 of file security2.lib.php.
References $mysoc.
| dolTotpNewSecret | ( | $nbbytes = 20 | ) |
Generate a new secret for a TOTP enrollment (RFC 6238), in the base32 form expected by the authenticator applications.
| int | $nbbytes | Length of the secret in bytes (20 = 160 bits, the recommendation of the RFC 4226) |
Definition at line 684 of file security2.lib.php.
References dolTotpBase32Encode().
| dolTotpSaveEnrollment | ( | $db, | |
| $fk_user, | |||
| $secret, | |||
| $laststep, | |||
| $entity = 1 ) |
Save a TOTP enrollment confirmed by a valid code.
The secret is encrypted at rest and written only once, the accepted time step goes into the 'state' field.
| DoliDB | $db | Database handler |
| int | $fk_user | Id of the user |
| string | $secret | Secret in base32 |
| int | $laststep | Time step of the code that confirmed the enrollment |
| int | $entity | Entity of the user |
Definition at line 855 of file security2.lib.php.
References dol_now(), dol_syslog(), dolEncrypt(), and dolTotpFormatStep().
| dolTotpSetLastStep | ( | $db, | |
| $rowid, | |||
| $laststep ) |
Store the time step of the last code accepted, so the same code can't be played twice.
The update is conditional: when two requests carry the same code at the same time, only the first one gets its row updated and the second one is refused.
| DoliDB | $db | Database handler |
| int | $rowid | Id of the row of the enrollment |
| int | $laststep | Time step just accepted |
Definition at line 885 of file security2.lib.php.
References dol_now(), dol_syslog(), and dolTotpFormatStep().
Referenced by dolTotpCheckPendingLogin().
| dolTotpStartSecondFactor | ( | $db, | |
| $login, | |||
| $entity ) |
Start the second step of a two-factor authentication, just after a password has been validated.
The session is not opened here: we only remember that the first step succeeded, so a code can be asked for in the next request.
| DoliDB | $db | Database handler |
| string | $login | Login validated by the first step |
| int | $entity | Entity the login was tested on |
Definition at line 944 of file security2.lib.php.
References $conf, dol_now(), dol_syslog(), and dolTotpGetEnrollment().
| encodedecode_dbpassconf | ( | $level = 0 | ) |
Encode or decode database password in config file.
| int | $level | Encode level: 0 no encoding, 1 encoding |
Definition at line 372 of file security2.lib.php.
References conf(), dol_decode(), dol_syslog(), dolDecrypt(), and dolEncrypt().
| getPasswordPatternMinLength | ( | ) |
Return the lowest value allowed for the minimum length (first field of USER_PASSWORD_PATTERN) of the 'Perso' password generation model.
When the 'none' model is forbidden on this installation (see isPasswordGenerationNoneForbidden()), the Perso model must not be tuned down to a weak value either, so a floor of 10 characters is enforced in the admin screen, when saving the pattern, and at generation/validation time.
Definition at line 497 of file security2.lib.php.
References isPasswordGenerationNoneForbidden().
Referenced by modGeneratePassPerso\__construct().
| getRandomPassword | ( | $generic = false, | |
| $replaceambiguouschars = null, | |||
| $length = 32 ) |
Return a generated password using default module.
| bool | $generic | true=Create a generic key (32 chars/numbers), false=Create a password using the configured password generation module. |
| ?array<string> | $replaceambiguouschars Discard ambiguous characters. For example: array('I'). | |
| int | $length | Length of random string (Used only if $generic is true) |
Definition at line 512 of file security2.lib.php.
References $conf, dol_syslog(), getDolGlobalString(), and ModeleGenPassword\loadAndInstantiate().
Referenced by modEventOrganization\__construct(), modPropale\__construct(), addFileIntoDatabaseIndex(), ActionsAdherentCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), CommonObject\getLastMainDocLink(), CommonObject\indexFile(), openid_connect_create_user(), Documents\post(), Adherent\setPassword(), and User\setPassword().
| isPasswordGenerationNoneForbidden | ( | ) |
Return if the 'none' password generation model (the one that applies no rule at all) is forbidden on this installation.
It is locked by the conf.php variable $dolibarr_main_restrict_password_generation_none (exposed as $conf->file->restrict_password_generation_none), which can only be changed by editing the config file on the server. When forbidden, the model is hidden from the admin screen, cannot be selected, and any value already set to 'none' falls back to the 'standard' model at generation/validation time.
Definition at line 481 of file security2.lib.php.
References $conf.
Referenced by getPasswordPatternMinLength(), modGeneratePassNone\isEnabled(), and ModeleGenPassword\loadAndInstantiate().
| if(!function_exists('dol_loginfunction')) makesalt | ( | $type = CRYPT_SALT_LENGTH | ) |
Initialise the salt for the crypt function.
| int | $type | 2 =>Return a salt for DES encryption 12=>Return a salt for MD5 encryption Undefined=>Return a salt for default encryption |
Definition at line 335 of file security2.lib.php.
References dol_strlen(), and dol_syslog().
Referenced by MailmanSpip\add_to_spip().
| showEyeForField | ( | $htmlname, | |
| $htmlnameofinput ) |
Output the eye picto to show/hide a password HTML field.
| string | $htmlname | HTML name of element to insert key into |
| string | $htmlnameofinput | HTML id of input field |
Definition at line 651 of file security2.lib.php.