password_hash

(PHP 5 >= 5.5.0, PHP 7)

password_hashTworzy hash hasła

Opis

password_hash ( string $hasło , integer $algorytm [, array $opcje ] ) : string

password_hash() tworzy hash hasła używając silnego, jednokierunkowego algorytmu. password_hash() jest kompatybilny z crypt(). Dzięki temu hashe utworzone przez crypt() mogą być użyte z password_hash().

Następujące algorytmy są obecnie wspierane:

  • PASSWORD_DEFAULT - Używa algorytmu bcrypt (domyślny od PHP 5.5.0). Zwróć uwagę, że ta stała jest zaprojektowana, aby być zmieniona po czasie, gdy pojawią się nowe, silniejsze algorytmy. Z tego powodu długość wyjścia przy użyciu tej stałej może zmienić się z czasem. Dlatego jest zalecane, aby trzymać wynik w kolumnie bazy danych, która może pomieścić więcej niż 60 znaków (255 znaków powinno być dobrym wyborem).
  • PASSWORD_BCRYPT - Używa algorytmu CRYPT_BLOWFISH do stworzenia hasha. To ustawienie zwróci hash kompatybilny z crypt() używając identyfikatora "$2y$". Rezultatem tej funkcji będzie zawsze 60-znakowy ciąg, lub FALSE w przypadku niepowodzenia.

    Wspierane opcje

    • salt - pozwala na ręczne podanie soli przy generowaniu hasła. Zwróć uwagę, że to ustawienie zapobiegnie automatycznemu wygenerowaniu soli.

      Jeżeli pomięto, losowa sól zostanie wygenerowa przez password_hash() dla każdego hasła. Jest to zalecany tryb postępowania.

    • cost - oznacza koszt algorytmu, który może zostać użyty. Przykładowe wartości można znaleźć na stronie funkcji crypt().

      Domyślną wartością jest 10. Stanowi ona optymalny balans pomiędzy siłą hashowania i czasem, ale możesz rozważyć jej zwiększenie, zależnie od sprzętu, którym dysponujesz.

Parametry

hasło

Hasło użytkownika.

Uwaga

Użycie stałej PASSWORD_BCRYPT dla parametru algorytm spowoduje, że parametr algo zostanie obcięty do maksymalnie 72 znaków.

algorytm

Stała algorytmu hasła wyznaczająca algorytm stosowany przy generowaniu skrótu hasła.

options

Tablica asocjacyjna zawierająca opcje. Zobacz stałe algorytmów haseł, aby poznać opcje wspierane przez każdy z algorytmów.

Jeżeli pominięte, zostanie wygenerowana losowa sól i zostanie użyty domyślny koszt.

Zwracane wartości

Zwraca zahashowane hasło lub FALSE w przypadku niepowodzenia.

Użyty algorytm, koszt oraz sól są zwracane jako część hasha. Dzięki temu wszystkie informacje potrzebne do zweryfikowania hasha są zawarte w nim samym. Pozwala to na użycie funkcji password_verify() bez konieczności trzymania soli lub informacji o algorytmie osobno.

Przykłady

Przykład #1 Przykład użycia password_hash()

<?php
/**
 * Chcemy po prostu hahashować nasze hasło przy użyciu domyślnego algorytmu
 * Obecnie jest to BCRYPT i zwróci 60-znakowy hash.
 *
 * Pamiętaj że domyślny algorytm może z czasem ulec zmianie, więc przygotuj się
 * zwiększając ilość znaków w bazie danych na więcej niż 60 (255 będzie dobrym wyborem)
 */
echo password_hash("rasmuslerdorf"PASSWORD_DEFAULT)."\n";
?>

Powyższy przykład wyświetli coś podobnego do:

$2y$10$.vGA1O9wmRjrwAVXD98HNOgsNpDczlqm3Jq7KnEd1rVAGv3Fykk1a

Przykład #2 Ręczne ustawianie kosztu

<?php
/**
 * W tym wypadku chcemy zwiększyć domyślny koszt dla BCRYPT do 12.
 * Zauważ także, że przełączyliśmy się na BCRYPT, który zawsze zwróci
 * 60 znaków
 */
$options = [
    
'cost' => 12,
];
echo 
password_hash("rasmuslerdorf"PASSWORD_BCRYPT$options)."\n";
?>

Powyższy przykład wyświetli coś podobnego do:

$2y$12$QjSH496pcT5CEbzjD/vtVeH03tfHKFy36d4J0Ltp3lRtee9HDxY3K

Przykład #3 Ręczne ustawianie soli

<?php
/**
 * Zauważ, że sól tutaj jest generowana losowo.
 * Nigdy nie używaj soli statycznej lub takiej, która nie jest generowana losowo
 *
 * W większości wypadków zalecane jest zostawienie generowania soli funkcji password_hash
 */
$options = [
    
'cost' => 11,
    
'salt' => mcrypt_create_iv(22MCRYPT_DEV_URANDOM),
];
echo 
password_hash("rasmuslerdorf"PASSWORD_BCRYPT$options)."\n";
?>

Powyższy przykład wyświetli coś podobnego do:

$2y$11$q5MkhSBtlsJcNEVsYh64a.aCluzHnGog7TQAKVmQwO9C8xb.t89F.

Przykład #4 Znajdowanie optymalnego kosztu

<?php
/**
 * Ten kod przetestuje Twój serwer, aby ustalić na jak duży koszt możesz sobie
 * pozwolić. Najlepszy koszt to najwyższy na który możesz sobie pozwolić bez
 * zbyt dużego zwalniania Twojego serwera. 10 jest dobrym punktem wyjścia.
 */
$timeTarget 0.2

$cost 9;
do {
    
$cost++;
    
$start microtime(true);
    
password_hash("test"PASSWORD_BCRYPT, ["cost" => $cost]);
    
$end microtime(true);
} while ((
$end $start) < $timeTarget);

echo 
"Zalecany koszt znaleziony: " $cost "\n";
?>

Powyższy przykład wyświetli coś podobnego do:

Zalecany koszt znaleziony: 11

Notatki

Uwaga

Jest wysoce zalecane, aby nie generować soli dla tej funkcji samodzielnie. Sól zostanie dla Ciebie stworzona automatycznie, jeżeli nie podasz żadnej.

Informacja:

Jest zalecane aby przetestować tę funkcję na swoim serwerze i dostosować koszt, tak aby wykonanie funkcji zajmowało około 0,1 do 0,5 sekundy. Skrypt powyżej pozwoli Ci wybrać odpowiednią wartość dla Twojego sprzętu.

Informacja: Aktualizacje algorytmów dla tej funkcji (lub zmiana domyślnego) muszą odbywać się według następujących zasad:

  • Algorytm musi być obecny w rdzeniu PHP przynajmniej od jednego pełnego wydania, aby stać się domyślnym. Więc jeżeli przykładowo nowy algorytm został dodany w wersji 5.5.5, nie powinien być domyślnym do wersji 5.7 (wersja 5.6 stanowi pierwsze pełne wydanie). Jeżeli jednak inny algorytm został dodany w 5.6.0 będzie mógł zostać domyślnym od wersji 5.7.0.
  • Domyślny algorytm powinien zmieniać się jedynie w pełnych wydaniach (5.6.0, 6.0.0 itd). Jedynym wyjątkiem od tej reguły jest sytuacja, gdy zostanie znaleziona krytyczna luka bezpieczeństwa w obecnym algorytmie.

Zobacz też:

add a note add a note

User Contributed Notes 12 notes

up
166
martinstoeckli
8 years ago
There is a compatibility pack available for PHP versions 5.3.7 and later, so you don't have to wait on version 5.5 for using this function. It comes in form of a single php file:
https://github.com/ircmaxell/password_compat
up
74
phpnetcomment201908 at lucb1e dot com
2 years ago
Since 2017, NIST recommends using a secret input when hashing memorized secrets such as passwords. By mixing in a secret input (commonly called a "pepper"), one prevents an attacker from brute-forcing the password hashes altogether, even if they have the hash and salt. For example, an SQL injection typically affects only the database, not files on disk, so a pepper stored in a config file would still be out of reach for the attacker. A pepper must be randomly generated once and can be the same for all users. Many password leaks could have been made completely useless if site owners had done this.

Since there is no pepper parameter for password_hash (even though Argon2 has a "secret" parameter, PHP does not allow to set it), the correct way to mix in a pepper is to use hash_hmac(). The "add note" rules of php.net say I can't link external sites, so I can't back any of this up with a link to NIST, Wikipedia, posts from the security stackexchange site that explain the reasoning, or anything... You'll have to verify this manually. The code:

// config.conf
pepper=c1isvFdxMDdmjOlvxpecFw

<?php
// register.php
$pepper = getConfigVariable("pepper");
$pwd = $_POST['password'];
$pwd_peppered = hash_hmac("sha256", $pwd, $pepper);
$pwd_hashed = password_hash($pwd_peppered, PASSWORD_ARGON2ID);
add_user_to_database($username, $pwd_hashed);
?>

<?php
// login.php
$pepper = getConfigVariable("pepper");
$pwd = $_POST['password'];
$pwd_peppered = hash_hmac("sha256", $pwd, $pepper);
$pwd_hashed = get_pwd_from_db($username);
if (
password_verify($pwd_peppered, $pwd_hashed)) {
    echo
"Password matches.";
}
else {
    echo
"Password incorrect.";
}
?>

Note that this code contains a timing attack that leaks whether the username exists. But my note was over the length limit so I had to cut this paragraph out.

Also note that the pepper is useless if leaked or if it can be cracked. Consider how it might be exposed, for example different methods of passing it to a docker container. Against cracking, use a long randomly generated value (like in the example above), and change the pepper when you do a new install with a clean user database. Changing the pepper for an existing database is the same as changing other hashing parameters: you can either wrap the old value in a new one and layer the hashing (more complex), you compute the new password hash whenever someone logs in (leaving old users at risk, so this might be okay depending on what the reason is that you're upgrading).

Why does this work? Because an attacker does the following after stealing the database:

password_verify("a", $stolen_hash)
password_verify("b", $stolen_hash)
...
password_verify("z", $stolen_hash)
password_verify("aa", $stolen_hash)
etc.

(More realistically, they use a cracking dictionary, but in principle, the way to crack a password hash is by guessing. That's why we use special algorithms: they are slower, so each verify() operation will be slower, so they can try much fewer passwords per hour of cracking.)

Now what if you used that pepper? Now they need to do this:

password_verify(hmac_sha256("a", $secret), $stolen_hash)

Without that $secret (the pepper), they can't do this computation. They would have to do:

password_verify(hmac_sha256("a", "a"), $stolen_hash)
password_verify(hmac_sha256("a", "b"), $stolen_hash)
...
etc., until they found the correct pepper.

If your pepper contains 128 bits of entropy, and so long as hmac-sha256 remains secure (even MD5 is technically secure for use in hmac: only its collision resistance is broken, but of course nobody would use MD5 because more and more flaws are found), this would take more energy than the sun outputs. In other words, it's currently impossible to crack a pepper that strong, even given a known password and salt.
up
44
nicoSWD
8 years ago
I agree with martinstoeckli,

don't create your own salts unless you really know what you're doing.

By default, it'll use /dev/urandom to create the salt, which is based on noise from device drivers.

And on Windows, it uses CryptGenRandom().

Both have been around for many years, and are considered secure for cryptography (the former probably more than the latter, though).

Don't try to outsmart these defaults by creating something less secure. Anything that is based on rand(), mt_rand(), uniqid(), or variations of these is *not* good.
up
34
Cloxy
8 years ago
You can produce the same hash in php 5.3.7+ with crypt() function:

<?php

$salt
= mcrypt_create_iv(22, MCRYPT_DEV_URANDOM);
$salt = base64_encode($salt);
$salt = str_replace('+', '.', $salt);
$hash = crypt('rasmuslerdorf', '$2y$10$'.$salt.'$');

echo
$hash;

?>
up
18
Lyo Mi
5 years ago
Please note that password_hash will ***truncate*** the password at the first NULL-byte.

http://blog.ircmaxell.com/2015/03/security-issue-combining-bcrypt-with.html

If you use anything as an input that can generate NULL bytes (sha1 with raw as true, or if NULL bytes can naturally end up in people's passwords), you may make your application much less secure than what you might be expecting.

The password
$a = "\01234567";
is zero bytes long (an empty password) for bcrypt.

The workaround, of course, is to make sure you don't ever pass NULL-bytes to password_hash.
up
14
martinstoeckli
8 years ago
In most cases it is best to omit the salt parameter. Without this parameter, the function will generate a cryptographically safe salt, from the random source of the operating system.
up
10
Mike Robinson
7 years ago
For passwords, you generally want the hash calculation time to be between 250 and 500 ms (maybe more for administrator accounts). Since calculation time is dependent on the capabilities of the server, using the same cost parameter on two different servers may result in vastly different execution times. Here's a quick little function that will help you determine what cost parameter you should be using for your server to make sure you are within this range (note, I am providing a salt to eliminate any latency caused by creating a pseudorandom salt, but this should not be done when hashing passwords):

<?php
/**
* @Param int $min_ms Minimum amount of time in milliseconds that it should take
* to calculate the hashes
*/
function getOptimalBcryptCostParameter($min_ms = 250) {
    for (
$i = 4; $i < 31; $i++) {
       
$options = [ 'cost' => $i, 'salt' => 'usesomesillystringforsalt' ];
       
$time_start = microtime(true);
       
password_hash("rasmuslerdorf", PASSWORD_BCRYPT, $options);
       
$time_end = microtime(true);
        if ((
$time_end - $time_start) * 1000 > $min_ms) {
            return
$i;
        }
    }
}
echo
getOptimalBcryptCostParameter(); // prints 12 in my case
?>
up
0
ms1 at rdrecs dot com
2 years ago
Timing attacks simply put, are attacks that can calculate what characters of the password are due to speed of the execution.

More at...
https://paragonie.com/blog/2015/11/preventing-timing-attacks-on-string-comparison-with-double-hmac-strategy

I have added code to phpnetcomment201908 at lucb1e dot com's suggestion to make this possible "timing attack" more difficult using the code phpnetcomment201908 at lucb1e dot com posted.

$pph_strt = microtime(true);

//...
/*The code he posted for login.php*/
//...

$end = (microtime(true) - $pph_strt);

$wait = bcmul((1 - $end), 1000000);  // usleep(250000) 1/4 of a second

usleep ( $wait );

echo "<br>Execution time:".(microtime(true) - $pph_strt)."; ";

Note I suggest changing the wait time to suit your needs but make sure that it is more than than the highest execution time the script takes on your server.

Also, this is my workaround to obfuscate the execution time to nullify timing attacks. You can find an in-depth discussion and more from people far more equipped than I for cryptography at the link I posted. I do not believe this was there but there are others. It is where I found out what timing attacks were as I am new to this but would like solid security.
up
-2
Anonymous
1 year ago
To use argon, follow these steps:

```
git clone https://github.com/p-h-c/phc-winner-argon2
cd phc-winner-argon2 && make && make install
apt install libsodium-dev
cd ~/php-7.4.5 // Your php installation source code
./configure [YOUR_EXISTING_CONFIGURE_COMMANDS] --with-password-argon2 --with-sodium
```
up
-6
Anonymous
2 years ago
According to the draft specification, Argon2di is the recommended mode of operation:

> 9.4.  Recommendations
>
>   The Argon2id variant with t=1 and maximum available memory is
>   recommended as a default setting for all environments.  This setting
>   is secure against side-channel attacks and maximizes adversarial
>   costs on dedicated bruteforce hardware.

source: https://tools.ietf.org/html/draft-irtf-cfrg-argon2-06#section-9.4
up
-3
php dot net at marksim dot org
1 year ago
regarding the sentence "...database column that can expand beyond 60 characters (255 characters would be a good choice). "

Considering future hash length increase by factor *2 and considering databases to start counting with 1, a password length of 256 characters (not 255) would probably be the better choice :)
up
-13
hman
2 years ago
I believe a note should be added about the compatibility of crypt() and password_hash().

My tests showed that yes, password_verify can also take hashes generated by crypt - as well as those from password_hash. But vice versa this is not true...

You cannot put hashes generated by password_hash into crypt for comparing them themselves, when used as the salt for crypt, as was recommended years ago (compare user entry with user crypt(userentry,userentry). No big deal, but it means that password checking routines MUST immediately be rewritten to use password_hash...

You cannot start using password_hash for hash generation without also altering the password check routine!

So the word "compatible" should be, IMHO, ammended with a word of caution, hinting the reader, that compatibility here is a one-way street.
To Top