Класс HmacAlgorithm

Граф наследования:HmacAlgorithm:

Открытые члены
	__construct ($hashAlgorithm=null)
	setHashAlgorithm ($hashAlgorithm)
	getHashAlgorithm ()
	getSignature ($value, $key)
	verify ($value, $key, $sig)

Защищенные члены
	compareStrings ($expected, $actual)

Защищенные данные
	$hashAlgorithm = 'sha256'

Подробное описание

См. определение в файле hmacalgorithm.php строка 12

Конструктор(ы)

__construct()

__construct

(

$hashAlgorithm = null

)

Creates signing algorithm based on HMAC.

Начиная с

16.0.0

Аргументы

string | null

$hashAlgorithm

Hashing algorithm (optional). See registered algorithms in hash_algos().

См. определение в файле hmacalgorithm.php строка 26

Методы

compareStrings()

compareStrings ( $expected, $actual )

protected

A timing safe comparison method.

C function memcmp() internally used by PHP, exits as soon as a difference is found in the two buffers. That makes possible of leaking timing information useful to an attacker attempting to iteratively guess the unknown string (e.g. password).

Аргументы

string	$expected	Expected string (e.g. generated signature).
string	$actual	Actual string (e.g. signature received from user).

Исключения

Bitrix\Main\ArgumentTypeException

Возвращает

bool

См. определение в файле hmacalgorithm.php строка 99

getHashAlgorithm()

getHashAlgorithm

(

)

Return currently used hashing algorithm

Возвращает

string

См. определение в файле hmacalgorithm.php строка 53

getSignature()

getSignature	(		$value,
			$key )

Return message signature

Аргументы

string	$value	Message.
string	$key	Secret password for HMAC.

Возвращает

string

Переопределяет метод предка SigningAlgorithm.

См. определение в файле hmacalgorithm.php строка 65

setHashAlgorithm()

setHashAlgorithm

(

$hashAlgorithm

)

Set hashing algorithm for using in HMAC

Аргументы

string

$hashAlgorithm

Hashing algorithm. See registered algorithms in hash_algos().

Возвращает

$this

Исключения

Bitrix\Main\ArgumentOutOfRangeException

См. определение в файле hmacalgorithm.php строка 39

verify()

verify	(		$value,
			$key,
			$sig )

Verify message signature

Аргументы

string	$value	Message.
string	$key	Secret password used while signing.
string	$sig	Message signature password for HMAC.

Возвращает

bool

Переопределяет метод предка SigningAlgorithm.

См. определение в файле hmacalgorithm.php строка 78

Данные класса

$hashAlgorithm

$hashAlgorithm = 'sha256'

protected

См. определение в файле hmacalgorithm.php строка 17