1. class
  2. phpbb
  3. \
  4. passwords
  5. \
  6. driver
  7. \
  8. bcrypt

bcrypt

class bcrypt extends base

Constants

PREFIX

Properties

protected config $config from  base
protected helper $helper from  base
protected string $name from  base
protected int $cost_factor

Methods

__construct(config $config, helper $helper, int $cost_factor = 10)

Constructor of passwords driver object

bool
is_supported()

Check if hash type is supported

from  base
bool
is_legacy()

Check if hash type is a legacy hash type

from  base
bool
needs_rehash(string $hash)

Check if password needs to be rehashed

string
get_settings_only(string $hash, bool $full = false)

Get only the settings of the specified hash

string
get_prefix()

Returns the hash prefix

bool|string
hash(string $password, $salt = '')

Hash the password

bool
check(string $password, string $hash, array $user_row = array())

Check the password against the supplied hash

string
get_random_salt()

Get a random salt value with a length of 22 characters

Details

at line 30
__construct(config $config, helper $helper, int $cost_factor = 10)

Constructor of passwords driver object

Parameters

config $config

phpBB config
helper $helper

Password driver helper
int $cost_factor

Hashing cost factor (optional)

in base at line 42
bool is_supported()

Check if hash type is supported

Return Value

bool

True if supported, false if not

in base at line 50
bool is_legacy()

Check if hash type is a legacy hash type

Return Value

bool

True if it's a legacy hash type, false if not

at line 49
bool needs_rehash(string $hash)

Check if password needs to be rehashed

Parameters

string $hash

Hash to check for rehash

Return Value

bool

True if password needs to be rehashed, false if not

at line 121
string get_settings_only(string $hash, bool $full = false)

Get only the settings of the specified hash

Parameters

string $hash

Password hash
bool $full

Return full settings or only settings related to the salt

Return Value

string

String containing the hash settings

at line 41
string get_prefix()

Returns the hash prefix

Return Value

string

Hash prefix

at line 61
bool|string hash(string $password, $salt = '')

Hash the password

Parameters

string $password

The password that should be hashed
$salt

Return Value

bool|string

Password hash or false if something went wrong during hashing

at line 93
bool check(string $password, string $hash, array $user_row = array())

Check the password against the supplied hash

Parameters

string $password

The password to check
string $hash

The password hash to check against
array $user_row

User's row in users table

Return Value

bool

True if password is correct, else false

at line 113
protected string get_random_salt()

Get a random salt value with a length of 22 characters

Return Value

string

Salt for password hashing