openssl_pkey_derive — Вычисляет общий секрет для открытого значения удалённого и локального ключа DH или ECDH

Назначение openssl_pkey_derive

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

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

Это процедурная функция раздела «OpenSSL». Её отличают имя openssl_pkey_derive, контракт «обязательные $public_key, $private_key; необязательные $key_length» и объявленный результат string|false; эти три признака нужно сверять вместе при выборе похожего API.

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

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

Сигнатура openssl_pkey_derive

Структурная запись: string|false openssl_pkey_derive(OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key, #[\SensitiveParameter] OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, int $key_length = 0). В ней 3 параметра: обязательные $public_key, $private_key; необязательные $key_length. Результат объявлен как string|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры openssl_pkey_derive

Порядок и роли аргументов по сигнатуре: 1. $public_key — OpenSSLAsymmetricKey|OpenSSLCertificate|array|string, обязателен; 2. $private_key — #[\SensitiveParameter] OpenSSLAsymmetricKey|OpenSSLCertificate|array|string, обязателен; 3. $key_length — int, необязателен, default 0.

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

1) OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key — обязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 2) #[\SensitiveParameter] OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key — обязательный: не журналируйте исходное значение и проверьте отказ на неверных учётных данных. 3) int $key_length — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры.

Результат openssl_pkey_derive

openssl_pkey_derive объявляет результат типа string|false. Контракт openssl_pkey_derive допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

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

Убедитесь, что раздел «OpenSSL» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key, #[\SensitiveParameter] OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key. Затем отдельно добавьте необязательные параметры int $key_length=0, чтобы увидеть влияние значений по умолчанию. Для профиля «безопасность» важно не записывать секреты и исходные ключи в журнал; негативный сценарий должен проверить неверный ключ, повреждённые данные и отказ операции.

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

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

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

Сначала запишите точную сигнатуру string|false openssl_pkey_derive(OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key, #[\SensitiveParameter] OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, int $key_length = 0) и фактические типы переданных значений. Затем подтвердите загрузку расширения «OpenSSL» в той же среде, где выполняется openssl_pkey_derive. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для openssl_pkey_derive предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

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

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

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

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

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

Для openssl_pkey_derive базовый ориентир: вычисляет общий секрет для открытого значения удалённого и локального ключа dh или ecdh; обязательные $public_key, $private_key; необязательные $key_length; результат string|false. Сопоставление с опубликованными соседями: openssl_dh_compute_key: вычисляет общий секретный ключ для значения удалённого открытого ключа dh и локального ключа dh; вход — обязательные $public_key, $private_key; результат — string|false. openssl_spki_export: экспортирует открытый ключ в формате pem из подписанного открытого ключа с вызовом; вход — обязательные $spki; результат — string|false. openssl_pbkdf2: генерирует строки pkcs5 v2 pbkdf2; вход — обязательные $password, $salt, $key_length, $iterations; необязательные $digest_algo; результат — string|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

В структурной истории исходной записи отмечены версии: 8.5.0. openssl_pkey_derive сверена по закреплённой ревизии php/doc-ru. В исходной записи присутствует признак устаревания: проверьте альтернативу перед новым использованием. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для openssl_pkey_derive.

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