Skip to content

Commit 90a8760

Browse files
committed
Add explanatory note to docstring for pw_hash
mention the meaning of the first two characters as a strength parameter
1 parent 5376514 commit 90a8760

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

lib/puppet/parser/functions/pw_hash.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
|bcrypt-x |2x |bug compatible |
2626
|bcrypt-y |2y |historic alias for 2b|
2727
28-
The third argument to this function is the salt to use.
28+
The third argument to this function is the salt to use. For bcrypt-type hashes,
29+
the first two characters of the salt represent a strength parameter, with a value
30+
between 4 and 31 inclusive.
2931
3032
@return [String]
3133
Provides a crypt hash usable on most POSIX systems.

0 commit comments

Comments
 (0)