dolibarr 19.0.3
security2.lib.php File Reference

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 successfull.
 
if(!function_exists( 'dol_loginfunction')) makesalt ($type=CRYPT_SALT_LENGTH)
 Fonction pour initialiser un salt pour la fonction crypt.
 
 encodedecode_dbpassconf ($level=0)
 Encode or decode database password in config file.
 
 getRandomPassword ($generic=false, $replaceambiguouschars=null, $length=32)
 Return a generated password using default module.
 
 dolJSToSetRandomPassword ($htmlname, $htmlnameofbutton='generate_token', $generic=1)
 Ouput javacript to autoset a generated password using default module into a HTML element.
 

Detailed Description

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.

Function Documentation

◆ checkLoginPassEntity()

checkLoginPassEntity ( $usertotest,
$passwordtotest,
$entitytotest,
$authmode,
$context = '' )

Return a login if login/pass was successfull.

Parameters
string$usertotestLogin value to test
string$passwordtotestPassword value to test
string$entitytotestInstance of data we must check
array$authmodeArray list of selected authentication mode array('http', 'dolibarr', 'xxx'...)
string$contextContext checkLoginPassEntity was created for ('api', 'dav', 'ws', '')
Returns
string Login or '' or '–bad-login-validity–'

Show Dolibarr default login page. Part of this code is also duplicated into main.inc.php\top_htmlhead

Parameters
Translate$langsLang object (must be initialized by a new).
Conf$confConf object
Societe$mysocCompany object
Returns
void

Definition at line 57 of file security2.lib.php.

References dol_buildpath(), dol_osencode(), and dol_syslog().

Referenced by check_authentication(), and Login\index().

◆ dol_getwebuser()

dol_getwebuser ( $mode)

Return user/group account of web server.

Parameters
string$mode'user' or 'group'
Returns
string Return user or group of web server

Definition at line 35 of file security2.lib.php.

◆ dolJSToSetRandomPassword()

dolJSToSetRandomPassword ( $htmlname,
$htmlnameofbutton = 'generate_token',
$generic = 1 )

Ouput javacript to autoset a generated password using default module into a HTML element.

Parameters
string$htmlnameHTML name of element to insert key into
string$htmlnameofbuttonHTML name of button
int$generic1=Return a generic pass, 0=Return a pass following setup rules
Returns
string HTML javascript code to set a password
See also
getRandomPassword()

Definition at line 573 of file security2.lib.php.

References dol_escape_js().

Referenced by FormSetupItem\generateInputFieldSecureKey().

◆ encodedecode_dbpassconf()

encodedecode_dbpassconf ( $level = 0)

Encode or decode database password in config file.

Parameters
int$levelEncode level: 0 no encoding, 1 encoding
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 382 of file security2.lib.php.

References conf(), dol_decode(), dol_encode(), dol_syslog(), and dolDecrypt().

◆ getRandomPassword()

getRandomPassword ( $generic = false,
$replaceambiguouschars = null,
$length = 32 )

Return a generated password using default module.

Parameters
boolean$generictrue=Create generic password (32 chars/numbers), false=Use the configured password generation module
array$replaceambiguouscharsDiscard ambigous characters. For example array('I').
int$lengthLength of random string (Used only if $generic is true)
Returns
string New value for password
See also
dol_hash(), dolJSToSetRandomPassword()

Definition at line 487 of file security2.lib.php.

References getDolGlobalString().

Referenced by addFileIntoDatabaseIndex(), ActionsAdherentCardCommon\assign_values(), ActionsContactCardCommon\assign_values(), CommonObject\getLastMainDocLink(), BlockedLog\getSignature(), CommonObject\indexFile(), Adherent\setPassword(), and User\setPassword().

◆ makesalt()

if(!function_exists('dol_loginfunction')) makesalt ( $type = CRYPT_SALT_LENGTH)

Fonction pour initialiser un salt pour la fonction crypt.

Parameters
int$type2=>renvoi un salt pour cryptage DES 12=>renvoi un salt pour cryptage MD5 non defini=>renvoi un salt pour cryptage par defaut
Returns
string Salt string

Definition at line 345 of file security2.lib.php.

References dol_strlen(), and dol_syslog().

Referenced by MailmanSpip\add_to_spip().