PasswordHash: Difference between revisions

Revision as of 21:40, 16 April 2017

This template is no longer in use as it results in poor readability. This function creates a new password hash using a specified hashing algorithm.

string passwordHash ( string password, string algorithm [, table options = {} ] )

password: The password to hash.
algorithm: The algorithm to use:
- bcrypt: use the bcrypt hashing algorithm

bcrypt:
- cost (int), default: 10. Visit this link to determine the number of rounds appropriate for your server.
- salt (string), default: automatically generate salt
  - an empty string will automatically generate a salt with the cost provided
  - if a string is provided, the given salt is used (do not do this!)

Returns the hash as a string if hashing was successful, false otherwise.

	Script Example Missing Function PasswordHash needs a script example, help out by writing one.
	Before submitting check out Editing Guidelines Script Examples.

-- TODO

@@ Line 19: / Line 19: @@
 ===Options for each hashing algorithm===
 * ''bcrypt'':
-** ''cost'' (int), default: 10
+** ''cost'' (int), default: 10.  Visit [http://security.stackexchange.com/questions/17207/recommended-of-rounds-for-bcrypt this link] to determine the number of rounds appropriate for your server.
 ** ''salt'' (string), default: automatically generate salt
 *** an empty string will automatically generate a salt with the ''cost'' provided