sodium_crypto_secretbox — Шифрует общим ключом с проверкой подлинности

Назначение sodium_crypto_secretbox

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

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

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

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

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

Сигнатура sodium_crypto_secretbox

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

Параметры sodium_crypto_secretbox

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

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

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

Результат sodium_crypto_secretbox

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

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

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

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

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

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

Сначала запишите точную сигнатуру string sodium_crypto_secretbox(#[\SensitiveParameter] string $message, string $nonce, #[\SensitiveParameter] string $key) и фактические типы переданных значений. Затем подтвердите загрузку расширения «Sodium» в той же среде, где выполняется sodium_crypto_secretbox. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для sodium_crypto_secretbox базовый ориентир: шифрует общим ключом с проверкой подлинности; обязательные $message, $nonce, $key; результат string. Сопоставление с опубликованными соседями: sodium_crypto_secretbox_open: расшифровывает общим ключом с проверкой подлинности; вход — обязательные $ciphertext, $nonce, $key; результат — string|false. sodium_crypto_secretbox_keygen: создаёт случайный ключ для sodium_crypto_secretbox; вход — аргументов нет; результат — string. random_bytes: генерирует криптографически безопасные случайные байты; вход — обязательные $length; результат — string. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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