openssl_pkcs7_encrypt — Шифрует сообщение по стандарту S/MIME

Назначение openssl_pkcs7_encrypt

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

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

Это процедурная функция раздела «OpenSSL». Её отличают имя openssl_pkcs7_encrypt, контракт «обязательные $input_filename, $output_filename, $certificate, $headers; необязательные $flags, $cipher_algo» и объявленный результат bool; эти три признака нужно сверять вместе при выборе похожего API.

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

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

Сигнатура openssl_pkcs7_encrypt

Структурная запись: bool openssl_pkcs7_encrypt(string $input_filename, string $output_filename, OpenSSLCertificate|array|string $certificate, array|null $headers, int $flags = 0, int $cipher_algo = OPENSSL_CIPHER_AES_128_CBC). В ней 6 параметров: обязательные $input_filename, $output_filename, $certificate, $headers; необязательные $flags, $cipher_algo. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры openssl_pkcs7_encrypt

Порядок и роли аргументов по сигнатуре: 1. $input_filename — string, обязателен; 2. $output_filename — string, обязателен; 3. $certificate — OpenSSLCertificate|array|string, обязателен; 4. $headers — array|null, обязателен; 5. $flags — int, необязателен, default 0; 6. $cipher_algo — int, необязателен, default OPENSSL_CIPHER_AES_128_CBC.

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

1) string $input_filename — обязательный: нормализуйте представление, проверьте допустимую схему или базовый каталог и отдельно испытайте отсутствующую цель. 2) string $output_filename — обязательный: нормализуйте представление, проверьте допустимую схему или базовый каталог и отдельно испытайте отсутствующую цель. 3) OpenSSLCertificate|array|string $certificate — обязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 4) array|null $headers — обязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 5) int $flags — необязательный: перечислите разрешённые значения и отдельно проверьте конфликтующую комбинацию. 6) int $cipher_algo — необязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки.

Результат openssl_pkcs7_encrypt

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

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

Убедитесь, что раздел «OpenSSL» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string $input_filename, string $output_filename, OpenSSLCertificate|array|string $certificate, array|null $headers. Затем отдельно добавьте необязательные параметры int $flags=0, int $cipher_algo=OPENSSL_CIPHER_AES_128_CBC, чтобы увидеть влияние значений по умолчанию. Для профиля «безопасность» важно не записывать секреты и исходные ключи в журнал; негативный сценарий должен проверить неверный ключ, повреждённые данные и отказ операции.

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

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

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

Сначала запишите точную сигнатуру bool openssl_pkcs7_encrypt(string $input_filename, string $output_filename, OpenSSLCertificate|array|string $certificate, array|null $headers, int $flags = 0, int $cipher_algo = OPENSSL_CIPHER_AES_128_CBC) и фактические типы переданных значений. Затем подтвердите загрузку расширения «OpenSSL» в той же среде, где выполняется openssl_pkcs7_encrypt. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для openssl_pkcs7_encrypt базовый ориентир: шифрует сообщение по стандарту s/mime; обязательные $input_filename, $output_filename, $certificate, $headers; необязательные $flags, $cipher_algo; результат bool. Сопоставление с опубликованными соседями: openssl_pkcs7_sign: подписывает сообщение s/mime; вход — обязательные $input_filename, $output_filename, $certificate, $private_key, $headers; необязательные $flags, $untrusted_certificates_filename; результат — bool. openssl_pkcs7_decrypt: расшифровывает s/mime-сообщение; вход — обязательные $input_filename, $output_filename, $certificate; необязательные $private_key; результат — bool. openssl_x509_export_to_file: экспортирует сертификат в файл; вход — обязательные $certificate, $output_filename; необязательные $no_text; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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