update password_compat to lastest 1.0.4, fix #5346

lib/password_compat/README.md

@@ -1,22 +1,23 @@
 password_compat
 ===============
 
-This library is intended to provide forward compatibility with the password_* functions being worked on for PHP 5.5.
+[![Build Status](https://travis-ci.org/ircmaxell/password_compat.png?branch=master)](https://travis-ci.org/ircmaxell/password_compat) [![Code Climate](https://codeclimate.com/github/ircmaxell/password_compat/badges/gpa.svg)](https://codeclimate.com/github/ircmaxell/password_compat)
+
+This library is intended to provide forward compatibility with the [password_*](http://php.net/password) functions that ship with PHP 5.5.
 
 See [the RFC](https://wiki.php.net/rfc/password_hash) for more detailed information.
 
-Status: BETA-1
 
 Requirements
 ============
 
-This library requires `PHP >= 5.3.7` OR a version that has the `$2y` fix backported into it (such as Debian provides).
+This library requires `PHP >= 5.3.7` OR a version that has the `$2y` fix backported into it (such as RedHat provides). Note that Debian's 5.3.3 version is **NOT** supported.
 
 The runtime checks have been removed due to this version issue. To see if password_compat is available for your system, run the included `version-test.php`. If it outputs "Pass", you can safely use the library. If not, you cannot. 
 
 If you attempt to use password-compat on an unsupported version, attempts to create or verify hashes will return `false`. You have been warned!
 
-The reason for this is that PHP prior to 5.3.7 contains a security issue with its BCRYPT implementation. Therefore, it's highly recommended that you upgrade to a newer version of PHP prior to using this layer.
+The reason for this is that PHP prior to 5.3.7 contains a [security issue with its BCRYPT implementation](http://php.net/security/crypt_blowfish.php). Therefore, it's highly recommended that you upgrade to a newer version of PHP prior to using this layer.
 
 Installation
 ============
@@ -31,44 +32,50 @@ Usage
 **Creating Password Hashes**
 
 To create a password hash from a password, simply use the `password_hash` function.
-
+````PHP
     $hash = password_hash($password, PASSWORD_BCRYPT);
-
+````
 Note that the algorithm that we chose is `PASSWORD_BCRYPT`. That's the current strongest algorithm supported. This is the `BCRYPT` crypt algorithm. It produces a 60 character hash as the result.
 
 `BCRYPT` also allows for you to define a `cost` parameter in the options array. This allows for you to change the CPU cost of the algorithm:
-
-    $hash = password_hash($password, PASSWORD_BCRYPT, ["cost" => 10]);
-
+````PHP
+    $hash = password_hash($password, PASSWORD_BCRYPT, array("cost" => 10));
+````
 That's the same as the default. The cost can range from `4` to `31`. I would suggest that you use the highest cost that you can, while keeping response time reasonable (I target between 0.1 and 0.5 seconds for a hash, depending on use-case).
 
 Another algorithm name is supported:
-
+````PHP
     PASSWORD_DEFAULT
-
-This will use the strongest algorithm available to PHP at the current time. Presently, this is the same as specifiying `PASSWORD_BCRYPT`. But in future versions of PHP, it may be updated to use a stronger algorithm if one is introduced. It can also be changed if a problem is identified with the BCRYPT algorithm. Note that if you use this option, you are **strongly** encouraged to store it in a `VARCHAR(255)` column to avoid truncation issues if a future algorithm increases the length of the generated hash.
+````
+This will use the strongest algorithm available to PHP at the current time. Presently, this is the same as specifying `PASSWORD_BCRYPT`. But in future versions of PHP, it may be updated to use a stronger algorithm if one is introduced. It can also be changed if a problem is identified with the BCRYPT algorithm. Note that if you use this option, you are **strongly** encouraged to store it in a `VARCHAR(255)` column to avoid truncation issues if a future algorithm increases the length of the generated hash.
 
 It is very important that you should check the return value of `password_hash` prior to storing it, because a `false` may be returned if it encountered an error.
 
 **Verifying Password Hashes**
 
 To verify a hash created by `password_hash`, simply call:
-
+````PHP
 	if (password_verify($password, $hash)) {
 		/* Valid */
 	} else {
 		/* Invalid */
 	}
-
+````
 That's all there is to it.
 
 **Rehashing Passwords**
 
 From time to time you may update your hashing parameters (algorithm, cost, etc). So a function to determine if rehashing is necessary is available:
-
+````PHP
     if (password_verify($password, $hash)) {
 		if (password_needs_rehash($hash, $algorithm, $options)) {
 			$hash = password_hash($password, $algorithm, $options);
 			/* Store new hash in db */
 		}
 	}
+````
+
+Security Vulnerabilities
+========================
+
+If you have found a security issue, please contact the author directly at [ircmaxell@php.net](mailto:ircmaxell@php.net).