Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Crypto

继承: RefCounted < Object

提供对高阶加密功能的访问。

描述

Crypto 类提供对高阶加密功能的访问。

目前,包括非对称密钥的加密/解密和签名/验证、生成加密安全随机字节、RSA 密钥、HMAC 摘要以及自签名的 X509Certificate

extends Node

var crypto = Crypto.new()
var key = CryptoKey.new()
var cert = X509Certificate.new()

func _ready():
    # 生成新的 RSA 密钥。
    key = crypto.generate_rsa(4096)
    # 使用给定的密钥生成新的自签名证书。
    cert = crypto.generate_self_signed_certificate(key, "CN=mydomain.com,O=My Game Company,C=IT")
    # 将密钥和证书保存在用户文件夹中。
    key.save("user://generated.key")
    cert.save("user://generated.crt")
    # 加密
    var data = "Some data"
    var encrypted = crypto.encrypt(key, data.to_utf8_buffer())
    # 解密
    var decrypted = crypto.decrypt(key, encrypted)
    # 签名
    var signature = crypto.sign(HashingContext.HASH_SHA256, data.sha256_buffer(), key)
    # 验证
    var verified = crypto.verify(HashingContext.HASH_SHA256, data.sha256_buffer(), signature, key)
    # 校验
    assert(verified)
    assert(data.to_utf8_buffer() == decrypted)

方法

bool

constant_time_compare ( PackedByteArray trusted, PackedByteArray received )

PackedByteArray

decrypt ( CryptoKey key, PackedByteArray ciphertext )

PackedByteArray

encrypt ( CryptoKey key, PackedByteArray plaintext )

PackedByteArray

generate_random_bytes ( int size )

CryptoKey

generate_rsa ( int size )

X509Certificate

generate_self_signed_certificate ( CryptoKey key, String issuer_name="CN=myserver,O=myorganisation,C=IT", String not_before="20140101000000", String not_after="20340101000000" )

PackedByteArray

hmac_digest ( HashType hash_type, PackedByteArray key, PackedByteArray msg )

PackedByteArray

sign ( HashType hash_type, PackedByteArray hash, CryptoKey key )

bool

verify ( HashType hash_type, PackedByteArray hash, PackedByteArray signature, CryptoKey key )


方法说明

bool constant_time_compare ( PackedByteArray trusted, PackedByteArray received )

比较两个 PackedByteArray 是否相等,不会泄漏时序信息,能够防止时序攻击。

详情见这篇博文


PackedByteArray decrypt ( CryptoKey key, PackedByteArray ciphertext )

用提供的私钥 key 解密给定的密文 ciphertext

注意:所接受的密文的最大尺寸受到密钥大小的限制。


PackedByteArray encrypt ( CryptoKey key, PackedByteArray plaintext )

用提供的公钥 key 加密给定的明文 plaintext

注意:所接受的明文的最大尺寸受到密钥大小的限制。


PackedByteArray generate_random_bytes ( int size )

生成具有给定大小 size 的加密安全随机字节的 PackedByteArray


CryptoKey generate_rsa ( int size )

生成可用于创建自签名证书并传递给 StreamPeerTLS.accept_stream 的 RSA CryptoKey


X509Certificate generate_self_signed_certificate ( CryptoKey key, String issuer_name="CN=myserver,O=myorganisation,C=IT", String not_before="20140101000000", String not_after="20340101000000" )

根据给定的 CryptoKeyissuer_name 生成自签名的 X509Certificate。证书有效性将由 not_beforenot_after(第一个有效日期和最后一个有效日期)定义。issuer_name 必须至少包含“CN=”(通用名称,即域名)、“O=”(组织,即你的公司名称)、“C=”(国家,即 2 个字母的该组织所在的国家/地区的 ISO-3166 代码)。

生成 RSA 密钥和 X509 自签名证书的小示例。

var crypto = Crypto.new()
# 生成 4096 比特 RSA 密钥。
var key = crypto.generate_rsa(4096)
# 使用给定的密钥生成自签名证书。
var cert = crypto.generate_self_signed_certificate(key, "CN=example.com,O=A Game Company,C=IT")

PackedByteArray hmac_digest ( HashType hash_type, PackedByteArray key, PackedByteArray msg )

使用密钥 key 生成 msgHMAC 摘要。hash_type 参数是用于内部和外部哈希的哈希算法。

目前仅支持 HashingContext.HASH_SHA256HashingContext.HASH_SHA1


PackedByteArray sign ( HashType hash_type, PackedByteArray hash, CryptoKey key )

使用提供的私钥 key 对类型为 hash_type 的给定 hash 进行签名。


bool verify ( HashType hash_type, PackedByteArray hash, PackedByteArray signature, CryptoKey key )

使用提供的公钥 key 验证类型为 hash_type 的给定签名 signature