Шифровальщик

класс Encrypter реализует Encrypter, StringEncrypter (Просмотреть исходный код)

Свойства

protected string	$key	Ключ шифрования.
protected array	$previousKeys	Предыдущие/устаревшие ключи шифрования.
protected string	$cipher	Алгоритм, используемый для шифрования.

Методы

void

__construct(string $key, string $cipher = 'aes-128-cbc')

Создать новый экземпляр шифровальщика.

static bool

supported(string $key, string $cipher)

Определить, является ли данная комбинация ключа и шифра валидной.

static string

generateKey(string $cipher)

Создать новый ключ шифрования для данного шифра.

string

encrypt(mixed $value, bool $serialize = true)

Зашифровать заданное значение.

string

encryptString(string $value)

Зашифровать строку без сериализации.

mixed

decrypt(string $payload, bool $unserialize = true)

Расшифровать заданное значение.

string

decryptString(string $payload)

Расшифровать заданную строку без десериализации.

string

hash(string $iv, mixed $value, string $key)

Создать MAC для данного значения.

array

getJsonPayload(string $payload)

Получить массив JSON из заданного payload.

bool

validPayload(mixed $payload)

Проверить, является ли payload шифрования валидным.

bool

validMac(array $payload)

Определить, является ли MAC для данного payload валидным для основного ключа.

bool

validMacForKey(array $payload, string $key)

Определить, является ли MAC валидным для данного payload и ключа.

void

ensureTagIsValid(string $tag)

Убедиться, что заданный тег является валидным тегом для выбранного шифра.

bool

shouldValidateMac()

Определить, нужно ли проверять MAC при расшифровке.

string

getKey()

Получить ключ шифрования, который в данный момент используется шифровальщиком.

array

getAllKeys()

Получить текущий ключ шифрования и все предыдущие ключи шифрования.

array

getPreviousKeys()

Получить предыдущие ключи шифрования.

$this

previousKeys(array $keys)

Установить предыдущие/устаревшие ключи шифрования, которые должны быть использованы, если расшифровка завершится неудачно.

Детали

void __construct(string $key, string $cipher = 'aes-128-cbc')

Создать новый экземпляр шифровальщика.

Параметры

string	$key
string	$cipher

Возвращаемое значение

void

Исключения

RuntimeException

static bool supported(string $key, string $cipher)

Определить, является ли данная комбинация ключа и шифра валидной.

Параметры

string	$key
string	$cipher

Возвращаемое значение

bool

static string generateKey(string $cipher)

Создать новый ключ шифрования для данного шифра.

Параметры

string

$cipher

Возвращаемое значение

string

string encrypt(mixed $value, bool $serialize = true)

Зашифровать заданное значение.

Параметры

mixed	$value
bool	$serialize

Возвращаемое значение

string

Исключения

EncryptException

string encryptString(string $value)

Зашифровать строку без сериализации.

Параметры

string

$value

Возвращаемое значение

string

Исключения

EncryptException

mixed decrypt(string $payload, bool $unserialize = true)

Расшифровать заданное значение.

Параметры

string	$payload
bool	$unserialize

Возвращаемое значение

mixed

Исключения

DecryptException

string decryptString(string $payload)

Расшифровать заданную строку без десериализации.

Параметры

string

$payload

Возвращаемое значение

string

Исключения

DecryptException

protected string hash(string $iv, mixed $value, string $key)

Создать MAC для данного значения.

Параметры

string	$iv
mixed	$value
string	$key

Возвращаемое значение

string

protected array getJsonPayload(string $payload)

Получить массив JSON из заданного payload.

Параметры

string

$payload

Возвращаемое значение

array

Исключения

DecryptException

protected bool validPayload(mixed $payload)

Проверить, является ли запрос шифрования валидным.

Parameters

mixed

$payload

Return Value

bool

protected bool validMac(array $payload)

Определить, является ли MAC для заданного запроса валидным для первичного ключа.

Parameters

array

$payload

Return Value

bool

protected bool validMacForKey(array $payload, string $key)

Определить, является ли MAC валидным для данного запроса и ключа.

Parameters

array	$payload
string	$key

Return Value

bool

protected void ensureTagIsValid(string $tag)

Убедиться, что заданный тег является валидным тегом, учитывая выбранный шифр.

Parameters

string

$tag

Return Value

void

protected bool shouldValidateMac()

Определить, нужно ли валидировать MAC при дешифровании.

Return Value

bool

string getKey()

Получить ключ шифрования, который в данный момент используется шифровальщиком.

Return Value

string

array getAllKeys()

Получить текущий ключ шифрования и все предыдущие ключи шифрования.

Return Value

array

array getPreviousKeys()

Получить предыдущие ключи шифрования.

Return Value

array

$this previousKeys(array $keys)

Установить предыдущие/устаревшие ключи шифрования, которые следует использовать, если дешифрование завершается с ошибкой.

Parameters

array

$keys

Return Value

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Encryption/Encrypter.html