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 10 notes

up
157
martinstoeckli
7 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
42
nicoSWD
6 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
33
Cloxy
6 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
15
Lyo Mi
4 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
9
Mike Robinson
5 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
12
martinstoeckli
7 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
0
Anonymous
1 year 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
-1
cottton
6 years ago
if you thought
"why is the salt included in the hash and is it save when i store it as it is in my db?"

Answer i found:
The salt just has to be unique. It not meant to be a secret.

As mentioned in notes and docu before: let password_hash() take care of the salt.

With the unique salt you force the attacker to crack the hash.
The hash is unique and cannot be found at rainbow tables.
up
-2
VladimirMozhenkov at yahoo dot com
4 years ago
Note that this function can return NULL. It does so if you provide an incorrect constant as an algorythm. I had the following:

    $password = password_hash($password1, PASSWORD_BDCRYPT, array( 'cost' => 10 ));

and i couldn't understand why i kept having NULL written in $password; it was a simple fact that the constant was PASSWORD_BCRYPT.
up
-10
anonymous
4 years ago
Pay close attention to the maximum allowed length of the password parameter!  If you exceed the maximum length, it will be truncated without warning.

If you prepend your own salt/pepper to the password, and that salt/pepper exceeds the maximum length, then this function will truncate the actual password.  That means password_verify() will return true with ANY password using the same salt/pepper.

It might be a good idea to append any salt/pepper to the end of the password instead.
To Top