Класс Bitrix24Signer

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

Открытые члены
	__construct ()
	sign ($value, $salt=null)
	unsign ($signedValue, $salt=null)
Открытые члены унаследованные от Signer
	__construct (SigningAlgorithm $algorithm=null)
	setKey ($value)
	getSeparator ()
	setSeparator ($value)
	getSignature ($value, $salt=null)
	validate ($value, $signature, $salt=null)
	pack (array $values)
	unpack ($value, $limit=2)

Защищенные члены
	encodeSignature ($value)
	decodeSignature ($value)
Защищенные члены унаследованные от Signer
	verifySignature ($value, $sig, $salt=null)
	getKey ($salt=null)
	getDefaultKey ()

Дополнительные унаследованные члены
Защищенные данные унаследованные от Signer
	$algorithm = null
	$separator = '.'
	$key = null

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

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

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

__construct()

__construct

(

)

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

Методы

decodeSignature()

decodeSignature ( $value )

protected

Return decoded signature

Аргументы

string

$value

Возвращает

string

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

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

encodeSignature()

encodeSignature ( $value )

protected

Return encoded signature

Аргументы

string

$value

Возвращает

mixed

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

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

sign()

sign	(		$value,
			$salt = null )

Signs message, returns string in format "{message}{separator}{signature}".

Simple example: // If salt needed $foo = (new Signer)->sign('test', 'my_salt');

// Otherwise $bar = (new Signer)->sign('test');

Аргументы

string	$value	Message for signing.
string | null	$salt	Salt, if needed.

Возвращает

string

Исключения

ArgumentTypeException

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

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

unsign()

unsign	(		$signedValue,
			$salt = null )

Checks message signature and return original message.

Simple example: $signer = new Signer;

// Sign message $signedValue = $signer->sign('test');

// Get original message with checking echo $signer->unsign($signedValue); // Output: 'test'

// Try to unsigning not signed value echo $signer->unsign('test'); //throw BadSignatureException with message 'Separator not found in value'

// Or with invalid sign echo $signer->unsign('test.invalid_sign');

// Or invalid salt //throw BadSignatureException with message 'Signature does not match' echo $signer->unsign($signedValue, 'invalid_salt');

Аргументы

string	$signedValue	Signed value, must be in format "{message}{separator}{signature}".
string | null	$salt	Salt, if used while signing.

Возвращает

string

Исключения

BadSignatureException
ArgumentTypeException

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

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

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/socialservices/lib/bitrix24signer.php