Beschreibung

password_hash(#[\SensitiveParameter] string $password, string|int|null $algo, array $options = []): string

password_hash() erstellt einen neuen Passwort-Hash und benutzt dabei einen starken Einweg-Hashing-Algorithmus.

Die folgenden Algorithmen werden zur Zeit unterstützt:

PASSWORD_DEFAULT - Verwendet den bcrypt-Algorithmus (Standard in PHP 5.5.0). Es ist zu beachten, dass sich diese Konstante mit der Zeit ändern wird, wenn stärkere Algorithmen in PHP implementiert werden. Aus diesem Grund kann sich die Länge des zurückgegebenen Strings mit der Zeit ändern. Es wird deshalb empfohlen das Ergebnis in einem Datenbankfeld zu speichern, das mehr als 60 Bytes speichern kann (255 Bytes wären eine gute Wahl).
PASSWORD_BCRYPT - Verwendet den bcrypt-Algorithmus zum Erstellen des Hashes. Dieser erstellt einen crypt()-kompatiblen Hash und benutzt die $2y$ -Kennung.
PASSWORD_ARGON2I - Verwendet den Argon2i-Algorithmus zur Erstellung des Hashes. Dieser Algorithmus ist nur verfügbar, wenn PHP mit Argon2-Unterstützung kompiliert wurde.
PASSWORD_ARGON2ID - Verwendet den Argon2id-Algorithmus zur Erstellung des Hashes. Dieser Algorithmus ist nur verfügbar, wenn PHP mit Argon2-Unterstützung kompiliert wurde.

Unterstützte Optionen für PASSWORD_BCRYPT:

salt (string) - um manuell ein Salt anzugeben, das beim Hashing des Passworts verwendet wird. Es ist zu beachten, dass diese Option die automatische Generierung des Salt verhindert.

Wenn diese Option nicht angegeben wird, erzeugt die Funktion password_hash() für jedes gehashte Passwort ein zufälliges Salt. Dies ist die vorgesehene Funktionsweise.

Warnung
Die salt-Option wird missbilligt. Es wird nun empfohlen, einfach das Salt zu verwenden, das standardmäßig erzeugt wird. Ab PHP 8.0.0 wird ein explizit angegebenes Salt ignoriert.
cost (int) - bezeichnet die algorithmischen Kosten, die verwendet werden sollen. Beispiele für diesen Wert finden Sie finden Sie auf der Seite crypt().

Wenn diese Option nicht angegeben wird, wird ein Standardwert von 12 verwendet. Dies ist eine gute Basis für die Kosten, sollte aber der verwendeten Hardware entsprechend angepasst werden.

Unterstützte Optionen für PASSWORD_ARGON2I und PASSWORD_ARGON2ID:

memory_cost (int) - Maximaler Speicher (in Kibibytes), der zum Berechnen des Argon2-Hashes verwendet werden darf. Der Standardwert ist PASSWORD_ARGON2_DEFAULT_MEMORY_COST.
time_cost (int) - Maximale Zeit, die die das Berechnen des Argon2-Hashes dauern darf. Der Standardwert ist PASSWORD_ARGON2_DEFAULT_TIME_COST.
threads (int) - Anzahl der zu verwendenden Threads zum Berechnen des Argon2-Hashes. Der Standardwert ist PASSWORD_ARGON2_DEFAULT_THREADS.

Warnung
Nur verfügbar, wenn PHP libargon2 verwendet, nicht für libsodium-Implementierungen.

Parameter-Liste

password: Das Passwort des Benutzers.

Achtung
Die Verwendung von PASSWORD_BCRYPT als Algorithmus führt dazu, dass der Parameter password auf eine Höchstlänge von 72 Bytes gekürzt wird.
algo: Eine Konstante für den Passwort-Algorithmus, die den Algorithmus zum hashen des Passwortes angibt.
options: Ein assoziatives Array mit Optionen. Siehe auch Konstanten für Passwort-Algorithmen für Informationen zu den von den jeweiligen Algorithmen unterstützten Optionen.

Rückgabewerte

Gibt den Passwort-Hash zurück.

Der verwendete Algorithmus, der Aufwand und das Salt werden als Teil des Hashes zurückgegeben. Daher sind alle Informationen, die benötigt werden, um den Hash zu verifizieren, darin enthalten. Dies erlaubt es der Funktion password_verify() den Hash zu überprüfen, ohne dass eine separate Speicherung für das Salt oder die Algorithmus-Informationen erforderlich ist.

Changelog

Version Beschreibung

8.4.0 Der Standardwert der Option cost des PASSWORD_BCRYPT-Algorithmus wurde von 10 auf 12 erhöht.

8.3.0 password_hash() setzt nun die zugrundeliegende Random\RandomException als Exception::$previous-Exception, wenn aufgrund eines Fehlers bei der Erzeugung des Salt ein ValueError ausgelöst wird.

8.0.0 password_hash() gibt im Fehlerfall nicht mehr false zurück; stattdessens wird ein ValueError ausgelöst, wenn der Passwort-Hashing-Algorithmus ungültig ist, oder ein Error, wenn das Passwort-Hashing aufgrund eines unbekannten Fehlers fehlschlug.

8.0.0 Der Parameter algo ist jetzt nullable (akzeptiert den NULL-Wert).

7.4.0 Der Parameter algo erwartet nun einen String, akzeptiert aber aus Gründen der Abwärtskompatibilität noch immer Integer.

7.4.0 Die Sodium-Erweiterung bietet eine alternative Implementierung für Argon2-Passwörter.

7.3.0 Mit PASSWORD_ARGON2ID wurde die Unterstützung für Argon2id-Passwörter hinzugefügt.

7.2.0 Mit PASSWORD_ARGON2I wurde die Unterstützung für Argon2i-Passwörter hinzugefügt.

Version	Beschreibung
8.4.0	Der Standardwert der Option `cost` des `PASSWORD_BCRYPT`-Algorithmus wurde von `10` auf `12` erhöht.
8.3.0	password_hash() setzt nun die zugrundeliegende Random\RandomException als Exception::$previous-Exception, wenn aufgrund eines Fehlers bei der Erzeugung des Salt ein ValueError ausgelöst wird.
8.0.0	password_hash() gibt im Fehlerfall nicht mehr `false` zurück; stattdessens wird ein ValueError ausgelöst, wenn der Passwort-Hashing-Algorithmus ungültig ist, oder ein Error, wenn das Passwort-Hashing aufgrund eines unbekannten Fehlers fehlschlug.
8.0.0	Der Parameter `algo` ist jetzt nullable (akzeptiert den NULL-Wert).
7.4.0	Der Parameter `algo` erwartet nun einen String, akzeptiert aber aus Gründen der Abwärtskompatibilität noch immer Integer.
7.4.0	Die Sodium-Erweiterung bietet eine alternative Implementierung für Argon2-Passwörter.
7.3.0	Mit `PASSWORD_ARGON2ID` wurde die Unterstützung für Argon2id-Passwörter hinzugefügt.
7.2.0	Mit `PASSWORD_ARGON2I` wurde die Unterstützung für Argon2i-Passwörter hinzugefügt.

Beispiele

Beispiel #1 password_hash()-Beispiel

<?php
echo password_hash("rasmuslerdorf", PASSWORD_DEFAULT);
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

$2y$12$4Umg0rCJwMswRw/l.SwHvuQV01coP0eWmGzd61QH2RvAOMANUBGC.

Beispiel #2 password_hash()-Beispiel mit manuell festgelegten Kosten

<?php
$optionen = [
    // Erhöhen der bcrypt-Kosten von 12 auf 13.
    'cost' => 13,
];
echo password_hash("rasmuslerdorf", PASSWORD_BCRYPT, $optionen);
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

$2y$13$xeDfQumlmdm0Sco.4qmH1OGfUUmOcuRmfae0dPJhjX1Bq0yYhqbNi

Beispiel #3 password_hash()-Beispiel für die Suche nach angemessenen Kosten

Mit diesem Code wird ein Benchmarking des Rechners durchgeführt, um festzustellen, wie hoch die Kosten sein dürfen, ohne die Benutzerfreundlichkeit zu beeinträchtigen. Es wird empfohlen, die höchsten Kosten festzulegen, die andere Operationen, die der Rechner ausführen soll, nicht verlangsamen. 11 ist ein guter Richtwert, mehr ist besser, wenn der Rechner schnell genug ist. Der nachstehende Code zielt auf eine Ausführungszeit von ≤ 350 Millisekunden ab, was für Systeme, die interaktive Anmeldungen verarbeiten, eine angemessene Verzögerung darstellt.

<?php
$zeitZiel = 0.350; // 350 Millisekunden

$kosten = 11;
do {
    $kosten++;
    $start = microtime(true);
    password_hash("test", PASSWORD_BCRYPT, ["cost" => $kosten]);
    $ende = microtime(true);
} while (($ende - $start) < $zeitZiel);

echo "Ermittelte angemessene Kosten: " . $kosten - 1;
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

Ermittelte angemessene Kosten: 13

Beispiel #4 password_hash()-Beispiel, das Argon2i verwendet

<?php
echo 'Argon2i-Hash: ' . password_hash('rasmuslerdorf', PASSWORD_ARGON2I);
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

Argon2i-Hash: $argon2i$v=19$m=1024,t=2,p=2$YzJBSzV4TUhkMzc3d3laeg$zqU/1IN0/AogfP4cmSJI1vc8lpXRW9/S0sYY2i2jHT0

Anmerkungen

Achtung

Es wird dringend empfohlen, kein explizites Salt für diese Funktion anzugeben. Wenn kein Salt angegeben wird, wird automatisch ein sicheres Salt erstellt.

Wie oben erwähnt, erzeugt die Angabe der Option salt in PHP 7.0.0 eine Missbilligungs-Warnung. Die Unterstützung für die manuelle Angabe eines Salzes wurde in PHP 8.0.0 entfernt.

Hinweis:
Es wird empfohlen, diese Funktion auf dem verwendeten Rechner zu testen und den Kostenparameter so einzustellen, dass die Ausführung der Funktion bei interaktiven Anmeldungen weniger als 350 Millisekunden dauert. Das Skript im obigen Beispiel hilft bei der Auswahl eines geeigneten bcrypt-Kostenwerts für den jeweiligen Rechner.

Hinweis: Aktualisierungen der unterstützten Algorithmen durch diese Funktion (oder Änderungen am Standardalgorithmus) müssen den folgenden Regeln folgen:

Jeder neue Algorithmus muss für mindestens 1 Vollversion im Core von PHP sein, bevor er zum Standard wird. Wenn also z. B. ein neuer Algorithmus in 7.5.5 hinzugefügt wird, wäre er erst in 7.7 als Standard geeignet (da 7.6 die erste Vollversion wäre). Wenn aber ein anderer Algorithmus in 7.6.0 hinzugefügt würde, wäre auch dieser für die Standardeinstellung in 7.7.0 freigegeben.

Die Voreinstellung sollte sich nur bei einer Vollversion (7.3.0, 8.0.0, etc) ändern und nicht bei einer Korrekturversion. Die einzige Ausnahme hiervon ist in einem Notfall, wenn eine kritische Sicherheitslücke in der aktuellen Voreinstellung gefunden wurde.

Siehe auch

password_verify() - Überprüft, ob ein Passwort und ein Hash zusammenpassen
password_needs_rehash() - Überprüft, ob der übergebene Hash mit den übergebenen Optionen übereinstimmt
crypt() - Einweg-String-Hashing
sodium_crypto_pwhash_str() - Get an ASCII-encoded hash