PHP openssl_encrypt OpenSSL 函数



  • 定义和用法

    openssl_encrypt - 加密数据
  • 版本支持

    PHP4 PHP5 PHP7
    不支持 V5.3.0+支持 支持
    5.3.3 增加 iv 参数。
    5.4.0 raw_output 改到 options。
    7.1.0 增加了 tag、aad、tag_length 参数
  • 语法

    openssl_encrypt( string $data , string $method , string $key [, int $options = 0 [, string $iv = "" [, string &$tag = NULL [, string $aad = "" [, int $tag_length = 16 ]]]]] )
    
    openssl_encrypt() 以指定的方式和 key 加密数据,返回原始或 base64 编码后的字符串。
  • 参数

    参数 必需的 描述
    data 待加密的明文信息数据。
    method 密码学方式。openssl_get_cipher_methods() 可获取有效密码方式列表。
    key key
    option options 是以下标记的按位或: OPENSSL_RAW_DATAOPENSSL_ZERO_PADDING
    iv 非 NULL 的初始化向量。
    tag 使用 AEAD 密码模式(GCM 或 CCM)时传引用的验证标签。
    aad 附加的验证数据。
    tag_length 验证 tag 的长度。GCM 模式时,它的范围是 4 到 16。
  • 返回值

    成功时返回加密后的字符串, 或者在失败时返回 FALSE。
    method 传入未知算法时,产生 E_WARNING 级别的错误。 iv 传入空字符串时产生 E_WARNING 级别的错误。
  • 示例

    //$key should have been previously generated in a cryptographically safe way, like openssl_random_pseudo_bytes
    $plaintext = "message to be encrypted";
    $cipher = "aes-128-gcm";
    $key = 'mykey';
    if (in_array($cipher, openssl_get_cipher_methods()))
    {
            $ivlen = openssl_cipher_iv_length($cipher);
            $iv = openssl_random_pseudo_bytes($ivlen);
            $ciphertext = openssl_encrypt($plaintext, $cipher, $key, $options=0, $iv, $tag);
            //store $cipher, $iv, and $tag for decryption later
            $original_plaintext = openssl_decrypt($ciphertext, $cipher, $key, $options=0, $iv, $tag);
            echo $original_plaintext."\n";
    }
    
  • 相关页面

    openssl_decrypt() - 解密数据