sodium_crypto_pwhash_str — Получает ASCII-кодированный хеш

Назначение sodium_crypto_pwhash_str

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

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

Это процедурная функция раздела «Sodium». Её отличают имя sodium_crypto_pwhash_str, контракт «обязательные $password, $opslimit, $memlimit» и объявленный результат string; эти три признака нужно сверять вместе при выборе похожего API.

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

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

Сигнатура sodium_crypto_pwhash_str

Структурная запись: string sodium_crypto_pwhash_str(#[\SensitiveParameter] string $password, int $opslimit, int $memlimit). В ней 3 параметра: обязательные $password, $opslimit, $memlimit. Результат объявлен как string; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры sodium_crypto_pwhash_str

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

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

1) #[\SensitiveParameter] string $password — обязательный: не журналируйте исходное значение и проверьте отказ на неверных учётных данных. 2) int $opslimit — обязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. 3) int $memlimit — обязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры.

Результат sodium_crypto_pwhash_str

sodium_crypto_pwhash_str объявляет результат типа string. Результат sodium_crypto_pwhash_str имеет объявленный тип string. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

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

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

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

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

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

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

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

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

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

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

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

Для sodium_crypto_pwhash_str базовый ориентир: получает ascii-кодированный хеш; обязательные $password, $opslimit, $memlimit; результат string. Сопоставление с опубликованными соседями: sodium_crypto_pwhash_str_verify: проверяет соответствие пароля хешу; вход — обязательные $hash, $password; результат — bool. sodium_crypto_pwhash: получает ключ из пароля алгоритмом argon2; вход — обязательные $length, $password, $salt, $opslimit, $memlimit; необязательные $algo; результат — string. password_hash: создаёт хеш пароля; вход — обязательные $password, $algo; необязательные $options; результат — string. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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