hash_equals — Сравнивает строки без риска атаки по времени

Назначение hash_equals

hash_equals: Сравнивает строки без риска атаки по времени. Справочная сущность относится к разделу «Хеширование». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается hash_equals

Это процедурная функция раздела «Хеширование». Её отличают имя hash_equals, контракт «обязательные $known_string, $user_string» и объявленный результат bool; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление hash_equals

Смысловое направление hash_equals — «операция equals». В прикладном коде свяжите вызов hash_equals с одним явно сформулированным результатом прикладного сценария. Контрольный набор для этой операции: проверьте штатное выполнение, граничное состояние и документированный отказ. Такой акцент отделяет hash_equals от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура hash_equals

Структурная запись: bool hash_equals(#[\SensitiveParameter] string $known_string, #[\SensitiveParameter] string $user_string). В ней 2 параметра: обязательные $known_string, $user_string. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры hash_equals

Порядок и роли аргументов по сигнатуре: 1. $known_string — #[\SensitiveParameter] string, обязателен; 2. $user_string — #[\SensitiveParameter] string, обязателен.

Контроль входных данных для hash_equals

1) #[\SensitiveParameter] string $known_string — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 2) #[\SensitiveParameter] string $user_string — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат hash_equals

hash_equals объявляет результат типа bool. hash_equals возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

Проверочный сценарий для hash_equals

Убедитесь, что раздел «Хеширование» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором #[\SensitiveParameter] string $known_string, #[\SensitiveParameter] string $user_string. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «безопасность» важно не записывать секреты и исходные ключи в журнал; негативный сценарий должен проверить неверный ключ, повреждённые данные и отказ операции.

Интеграция hash_equals в проект

Проверку доступности hash_equals и преобразование входных значений разместите у границы модуля «Хеширование». Для профиля «безопасность» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция hash_equals не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика hash_equals

Сначала запишите точную сигнатуру bool hash_equals(#[\SensitiveParameter] string $known_string, #[\SensitiveParameter] string $user_string) и фактические типы переданных значений. Затем подтвердите загрузку расширения «Хеширование» в той же среде, где выполняется hash_equals. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «безопасность» применяйте отдельный негативный тест: проверить неверный ключ, повреждённые данные и отказ операции. В production-коде важно не записывать секреты и исходные ключи в журнал. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать hash_equals

Выбор hash_equals оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «Хеширование»; 2) сигнатура содержит 2 аргумента: обязательных 2, необязательных 0; 3) вызывающему коду нужен результат bool и действие «операция equals». Для профиля «безопасность» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с hash_hmac: у него другое назначение, владелец или набор входных данных.

Сравнение hash_equals с соседними API

Для hash_equals базовый ориентир: сравнивает строки без риска атаки по времени; обязательные $known_string, $user_string; результат bool. Сопоставление с опубликованными соседями: hash_hmac: генерирует хеш-код на основе ключа через метод hmac; вход — обязательные $algo, $data, $key; необязательные $binary; результат — string. hash_update_file: добавляет данные из файла в активный контекст хеширования; вход — обязательные $context, $filename; необязательные $stream_context; результат — bool. HashContext::__serialize: сериализует объект hashcontext; вход — аргументов нет; результат — array. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

hash_equals сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для hash_equals.

Связанные материалы