Skip to content

chore: check algorithm available by using password_algos() #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rancoud merged 1 commit into from
Oct 25, 2026
Merged

chore: check algorithm available by using password_algos() #331

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 51 additions & 7 deletions src/Crypt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,11 @@ public static function verify(#[\SensitiveParameter] string $password, string $h
return \password_verify($password, $hash);
}

/** Checks whether the hash needs to be rehash to match the selected algorithm and options. */
/**
* Checks whether the hash needs to be rehash to match the selected algorithm and options.
*
* @throws CryptException
*/
public static function needsRehash(string $hash): bool
{
static::chooseAlgo();
Expand Down Expand Up @@ -274,49 +278,89 @@ public static function getCharactersForRandomString(): string

// region Set specific algorithm

/** Sets the algorithm to `argon2id`. */
/**
* Sets the algorithm to `argon2id`.
*
* @throws CryptException
*/
public static function useArgon2id(): void
{
static::assertAlgoAvailable(static::$algoArgon2id);

static::$algoFixed = true;

static::$algoCurrent = static::$algoArgon2id;
}

/** Sets the algorithm to `argon2i`. */
/**
* Sets the algorithm to `argon2i`.
*
* @throws CryptException
*/
public static function useArgon2i(): void
{
static::assertAlgoAvailable(static::$algoArgon2i);

static::$algoFixed = true;

static::$algoCurrent = static::$algoArgon2i;
}

/** Sets the algorithm to `2y` (bcrypt). */
/**
* Sets the algorithm to `2y` (bcrypt).
*
* @throws CryptException
*/
public static function useBcrypt(): void
{
static::assertAlgoAvailable(static::$algoBcrypt);

static::$algoFixed = true;

static::$algoCurrent = static::$algoBcrypt;
}

/**
* Assert an algorithm is available by reading \password_algos().
*
* @throws CryptException
*/
protected static function assertAlgoAvailable(string $algo): void
{
if (!\in_array($algo, \password_algos(), true)) {
// @codeCoverageIgnoreStart
/* Need to build a specific version of PHP with nothing.
*/
throw new CryptException(\sprintf('Password hashing algorithm is not available: %s', $algo));
// @codeCoverageIgnoreEnd
}
}

/**
* Selects an algorithm if not defined by the user, in the following
* order: `argon2id` or `argon2i` or `2y` (bcrypt).
*
* @codeCoverageIgnore
* This function is ignore because it depends on how PHP has been built.
*
* @throws CryptException
*/
protected static function chooseAlgo(): void
{
if (static::$algoFixed) {
return;
}

if (\defined('PASSWORD_ARGON2ID')) {
$algorithms = \password_algos();

if (\in_array(static::$algoArgon2id, $algorithms, true)) {
static::$algoCurrent = static::$algoArgon2id;
} elseif (\defined('PASSWORD_ARGON2I')) {
} elseif (\in_array(static::$algoArgon2i, $algorithms, true)) {
static::$algoCurrent = static::$algoArgon2i;
} else {
} elseif (\in_array(static::$algoBcrypt, $algorithms, true)) {
static::$algoCurrent = static::$algoBcrypt;
} else {
throw new CryptException('No supported password hashing algorithm available');
}
}

Expand Down