-
Notifications
You must be signed in to change notification settings - Fork 35
icms_core_Password
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!
Class to encrypt User Passwords.
- Class name: icms_core_Password
- Namespace:
private mixed $pass
- Visibility: private
private mixed $salt
- Visibility: private
private mixed $mainSalt
- Visibility: private
private mixed $uname
- Visibility: private
mixed icms_core_Password::__construct()
Constructor for the Password class
- Visibility: public
object icms_core_Password::getInstance()
Access the only instance of this class
- Visibility: public
- This method is static.
string icms_core_Password::createCryptoKey(string slength)
This Function creates a unique Crypto Generated Key for use with password encryptions This functions falls back to standard function createSalt() if PHP < 5.3
- Visibility: public
- slength string - <p>The length of the key to produce</p>
string icms_core_Password::createSalt(string slength)
This Function creates a unique random Salt Key for use with password encryptions It can also be used to generate a random AlphaNumeric key sequence of any given length.
- Visibility: public
- This method is static.
- slength string - <p>The length of the key to produce</p>
bool icms_core_Password::passExpired(string uname)
This Public Function checks whether a users password has been expired
- Visibility: public
- uname string - <p>The username of the account to be checked</p>
bool icms_core_Password::_passExpired(string uname)
This Private Function checks whether a users password has been expired
- Visibility: private
- uname string - <p>The username of the account to be checked</p>
string icms_core_Password::getUserSalt(string uname)
This Public Function returns the User Salt key belonging to username.
- Visibility: public
- uname string - <p>Username to find User Salt key for.</p>
string icms_core_Password::_getUserSalt(string uname)
This Private Function returns the User Salt key belonging to username.
- Visibility: private
- uname string - <p>Username to find User Salt key for.</p>
string icms_core_Password::getUserEncType(string uname)
This Public Function returns the User Encryption Type belonging to username.
- Visibility: public
- uname string - <p>Username to find Encryption Type for.</p>
string icms_core_Password::_getUserEncType(string uname)
This Private Function returns the User Encryption Type belonging to username.
- Visibility: private
- uname string - <p>Username to find Enc_type for.</p>
\Hash icms_core_Password::encryptPass(string pass)
This Public Function is used to Encrypt User Passwords
- Visibility: public
- pass string - <p>plaintext password to be encrypted</p>
\Hash icms_core_Password::_encryptPassword(string pass, string salt, int enc_type, int iterations)
This Private Function is used to Encrypt User Passwords
- Visibility: private
- pass string - <p>plaintext password to be encrypted</p>
- salt string - <p>unique user salt key used in encryption process</p>
- enc_type int - <p>encryption type to use.</p>
- iterations int - <p>Number of times to rehash(stretch).</p>
\Hash icms_core_Password::_rehash(string hash, int iterations, int enc_type)
This Private Function rehashes (stretches) the Password Hash
- Visibility: private
- hash string - <p>hash to be re-hashed (stretched)</p>
- iterations int - <p>Number of times to re-hash</p>
- enc_type int - <p>encryption type to use</p>
mixed icms_core_Password::verifyPass(string pass, string uname)
This Public Function verifies if the users password is correct.
- Visibility: public
- pass string - <p>Password to verify.</p>
- uname string - <p>Username to verify.</p>
mixed icms_core_Password::_verifyPassword(string pass, string uname)
This Private Function verifies if the password is correct
- Visibility: private
- pass string - <p>Password to be verified</p>
- uname string - <p>Username of password to be verified</p>
string icms_core_Password::_getUserHash(string uname)
This Private Function returns the User Password Hash belonging to username.
- Visibility: private
- uname string - <p>Username to find hash for.</p>
\Hash icms_core_Password::_encryptPass(string pass, string salt, int enc_type)
This Private Function is used to Encrypt User Passwords
- Visibility: private
- pass string - <p>plaintext password to be encrypted</p>
- salt string - <p>unique user salt key used in encryption process</p>
- enc_type int - <p>encryption type to use (this is required & only used when passwords are expired)</p>