(PECL rnp >= 0.1.1)
rnp_op_encrypt — 加密訊息
ffi
由 rnp_ffi_create 回傳的 FFI 物件。
message
要加密的訊息。
recipient_keys_fp
包含收件人金鑰指紋的陣列。至少必須有一個金鑰。
options
包含選項的關聯式陣列。
鍵值 | 資料類型 | 說明 |
---|---|---|
"compression_alg" |
字串 | 壓縮演算法。必須同時設定 "compression_alg" 和 "compression_level" 才能啟用資料壓縮。 |
"compression_level" |
整數 | 壓縮等級,0-9。0 表示停用壓縮。 |
"armor" |
布林值 | 啟用 ASCII-armored 輸出。預設為停用。 |
"add_signature" |
布林值 | 加密的訊息也會被簽署。 |
"hash" |
字串 | 設定簽章計算期間使用的雜湊演算法。「add_signature」選項應設定為 true |
"creation_time" |
整數 | 設定簽章建立時間,以自 1970 年 1 月 1 日 UTC 以來的秒數表示。預設使用目前時間。 |
"expiration_time" |
整數 | 設定簽章到期時間,以自建立時間以來的秒數表示。值 0 表示簽章永不過期(預設值)。 |
"password" |
字串 | 新增用於加密資料的密碼。 |
"cipher" |
字串 | 設定對稱加密演算法。可能的值為 "IDEA"、"TRIPLEDES"、"CAST5"、"BLOWFISH"、"AES128"、"AES192"、"AES256"、"TWOFISH"、"CAMELLIA128"、"CAMELLIA192"、"CAMELLIA256"、"SM4"。 |
"aead" |
字串 | 設定 AEAD 模式演算法。可能的值為 "None"(停用 AEAD)、"EAX"、"OCB"。 |
"aead_bits" |
整數 | 透過區塊大小位元數設定 AEAD 模式的區塊長度。必須介於 0 到 56 之間。 |
"flags" |
整數 | 設定額外的加密旗標。支援的旗標:RNP_ENCRYPT_NOWRAP - 不要將資料包裝在文字資料封包中。這允許加密已簽署的資料。 |
"file_name" |
字串 | 設定要加密資料的內部儲存檔名。特殊值 _CONSOLE 可用於將訊息標記為「僅供您閱覽」,即不應儲存於任何地方,而僅顯示給接收者。預設值為空字串。 |
"file_mtime" |
整數 | 設定輸入檔案的修改日期,以自 1970 年 1 月 1 日 UTC 以來的秒數表示。 |
成功時回傳加密資料,失敗時回傳 false
。