CascadiaPHP 2024

rnp_op_encrypt

(PECL rnp >= 0.1.1)

rnp_op_encryptШифрует сообщение

Описание

rnp_op_encrypt(
    RnpFFI $ffi,
    string $message,
    array $recipient_keys_fp,
    array $options = ?
): string|false

Список параметров

ffi

Объект FFI, который возвращает функция rnp_ffi_create.

message

Сообщение, которое необходимо зашифровать.

recipient_keys_fp

Массив с отпечатками ключей получателя. Должен присутствовать хотя бы один ключ.

options

Ассоциативный массив с опциями.

Ключ Тип данных Описание
"compression_alg" string Алгоритм сжатия. Для включения сжатия данных должны быть заданы как "compression_alg", так и "compression_level".
"compression_level" integer Уровень сжатия, 0-9. 0 отключает сжатие.
"armor" boolean Включает ASCII-защищённый вывод. По умолчанию отключён.
"add_signature" boolean Зашифрованное сообщение будет также подписано.
"hash" string Устанавливает хеш-алгоритм, используемый при вычислении подписи. Опции "add_signature" должно быть установлено значение true.
"creation_time" integer Устанавливает время создания подписи в секундах с 1 января 1970 года по Гринвичу. По умолчанию используется текущее время.
"expiration_time" integer Устанавливает время истечения срока действия подписи в секундах с момента создания. Значение 0 используется для пометки подписи как не истекающей (значение по умолчанию).
"password" string Добавляет пароль, который используется для шифрования данных.
"cipher" string Устанавливает алгоритм симметричного шифрования. Возможные значения: "IDEA", "TRIPLEDES", "CAST5", "BLOWFISH", "AES128", "AES192", "AES256", "TWOFISH", "CAMELLIA128", "CAMELLIA192", "CAMELLIA256", "SM4".
"aead" string Устанавливает алгоритм режима AEAD. Возможные значения: "None" для отключения AEAD, "EAX", "OCB".
"aead_bits" integer Устанавливает длину ячейки для режима AEAD через количество битов размера ячейки. Должно быть от 0 до 56.
"flags" integer Устанавливает дополнительные флаги шифрования. Поддерживаемые флаги: RNP_ENCRYPT_NOWRAP - не заворачивать данные в литеральный пакет данных. Это позволит шифровать уже подписанные данные.
"file_name" string Устанавливает внутреннее имя файла для шифруемых данных. Специальное значение _CONSOLE может использоваться для пометки сообщения как "только для ваших глаз", т.е. оно не должно нигде храниться, а только отображаться получателю. По умолчанию используется пустая строка.
"file_mtime" integer Устанавливает дату модификации входного файла в секундах с 1 января 1970 года по Гринвичу.

Возвращаемые значения

Зашифрованные данные в случае успешного выполнения или false, если возникла ошибка.

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top