Класс Security
Библиотека безопасности содержит служебные методы, связанные с безопасностью
Краткое описание свойств
- Реализация криптографии для использования.
object - Соль HMAC для использования в алгоритмах шифрования и дешифрования.
string -
stringМетод хэширования по умолчанию. Если параметр
$typeдляSecurity::hash()не указан, используется это значение. По умолчанию "sha1".
Краткое описание методов
- Проверка ключа шифрования на корректную длину.
- Сравнение, устойчивое к атакам на основе тайминга, отдающее предпочтение собственным реализациям PHP.
- Дешифрование значения с использованием AES-256.
- Шифрование значения с использованием AES-256.
- Получение реализации криптографии на основе загруженных расширений.
- Генерация хэша из строки с использованием указанного метода.
- Аналогично randomBytes(), но не криптографически безопасный.
- Получение случайных байтов из надёжного источника.
- Шифрование/дешифрование текста с помощью заданного ключа с использованием метода rijndael.
-
Получение или установка соли HMAC, используемой для алгоритмов шифрования/дешифрования.
-
Устанавливает метод хэширования по умолчанию для объекта Security. Это влияет на все объекты, использующие Security::hash().
Подробное описание методов
_checkKey()source protected static
_checkKey( string $key , string $method )
Проверка ключа шифрования на корректную длину.
Параметры
- string
$key - Ключ для проверки.
- string
$method - Метод, для которого проверяется ключ.
Исключения
InvalidArgumentExceptionПри некорректной длине ключа (не 256 бит/32 байта)
_constantEquals()source protected static
_constantEquals( string $hmac , string $compare )
Сравнение, устойчивое к атакам на основе тайминга, отдающее предпочтение собственным реализациям PHP.
Параметры
- string
$hmac - HMAC из шифрованного текста, который дешифруется.
- string
$compare - HMAC для сравнения.
Возвращает
booleanСм. также
https://github.com/resonantcore/php-future/decrypt()source public static
decrypt( string $cipher , string $key , string|null $hmacSalt null )
Дешифрование значения с использованием AES-256.
Параметры
- string
$cipher - Шифрованный текст для дешифрования.
- string
$key - Ключ длиной 256 бит/32 байта для использования в качестве шифровального ключа.
- string|null
$hmacSaltнеобязательный null - Соль для процесса HMAC. Оставить null для использования Security.salt.
Возвращает
stringДешифрованные данные. Любые заключительные нулевые байты будут удалены.
Исключения
InvalidArgumentExceptionПри некорректных данных или ключе.
encrypt()source public static
encrypt( string $plain , string $key , string|null $hmacSalt null )
Шифрование значения с использованием AES-256.
Примечание Нельзя правильно шифровать/дешифровать данные с заключительными нулевыми байтами. Любые заключительные нулевые байты будут удалены при дешифровании из-за того, как PHP дополняет сообщения нулями перед шифрованием.
Параметры
- string
$plain - Значение для шифрования.
- string
$key - Ключ длиной 256 бит/32 байта для использования в качестве шифровального ключа.
- string|null
$hmacSaltнеобязательный null - Соль для процесса HMAC. Оставить null для использования Security.salt.
Возвращает
stringЗашифрованные данные.
Исключения
InvalidArgumentExceptionПри некорректных данных или ключе.
engine()source public static
engine( object|null $instance null )
Получение реализации криптографии на основе загруженных расширений.
Вы можете использовать этот метод для принудительного выбора между реализациями mcrypt/openssl/custom.
Параметры
- object|null
$instanceнеобязательный null - Инстанс криптографического объекта для использования.
Возвращает
objectИнстанс криптографического объекта.
Исключения
InvalidArgumentExceptionКогда нет совместимого расширения криптографии.
hash()source public static
hash( string $string , string|null $type null , mixed $salt false )
Генерация хэша из строки с использованием указанного метода.
Параметры
- string
$string - Строка для хэширования
- string|null
$typeнеобязательный null Алгоритм хэширования (например, sha1, sha256 и т.д.). Может быть любым допустимым алгоритмом, включённым в список, возвращаемый hash_algos(). Если значение не передано, используется тип, указанный в
Security::$hashType.- mixed
$saltнеобязательный false Если true, автоматически добавляет соль приложения к $string (Security.salt).
Возвращает
stringХэш
Ссылка
http://book.cakephp.org/3.0/en/core-libraries/security.html#hashing-datainsecureRandomBytes()source public static
insecureRandomBytes( integer $length )
Аналогично randomBytes(), но не криптографически безопасный.
Параметры
- integer
$length - Количество байтов.
Возвращает
stringСлучайные байты в двоичном формате.
См. также
\Cake\Utility\Security::randomBytes()randomBytes()source public static
randomBytes( integer $length )
Получение случайных байтов из надёжного источника.
Этот метод будет использовать небезопасный источник и выведет предупреждение, если не сможет найти надёжный источник случайных данных.
Параметры
- integer
$length - Количество байтов.
Возвращает
stringСлучайные байты в двоичном формате.
rijndael()source public static
rijndael( string $text , string $key , string $operation )
Шифрование/дешифрование текста с помощью заданного ключа с использованием метода rijndael.
Параметры
- string
$text - Зашифрованная строка для дешифрования, обычная строка для шифрования
- string
$key - Ключ для использования в качестве ключа шифрования для зашифрованных данных.
- string
$operation - Операция, которая должна быть выполнена, шифрование или дешифрование
Возвращает
stringЗашифрованная/дешифрованная строка
Исключения
InvalidArgumentExceptionПри возникновении ошибок.
salt()source public static
salt( string|null $salt null )
Получение или установка соли HMAC, используемой для шифрования/дешифрования.
Параметры
- string|null
$saltнеобязательно null - Соль, используемая для шифрования. Если null, возвращает текущую соль.
Возвращает
stringТекущая настроенная соль
setHash()source public static
setHash( string $hash )
Устанавливает метод хэширования по умолчанию для объекта Security. Это влияет на все объекты, использующие Security::hash().
Параметры
- string
$hash - Метод для использования (sha1/sha256/md5 и т. д.).
См. также
\Cake\Utility\Security::hash()Подробное описание свойств
$hashTypesource
public static string
Метод хэширования по умолчанию. Если параметр $type для Security::hash() не указан, используется это значение. По умолчанию 'sha1'.
'sha1'
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.3/class-Cake.Utility.Security.html