Crypto

继承: RefCounted < Object

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

描述

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

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

var crypto = Crypto.new()

# 生成新的RSA密钥。
var key = crypto.generate_rsa(4096)

# 使用给定的密钥生成新的自签名证书。
var 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(trusted: PackedByteArray, received: PackedByteArray)

PackedByteArray

decrypt(key: CryptoKey, ciphertext: PackedByteArray)

PackedByteArray

encrypt(key: CryptoKey, plaintext: PackedByteArray)

PackedByteArray

generate_random_bytes(size: int)

CryptoKey

generate_rsa(size: int)

X509Certificate

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

PackedByteArray

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

PackedByteArray

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

bool

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


方法说明

bool constant_time_compare(trusted: PackedByteArray, received: PackedByteArray) 🔗

比较两个PackedByteArray的相等性而不泄露计时信息以防止计时攻击。

有关更多信息,请参阅这篇博客文章


PackedByteArray decrypt(key: CryptoKey, ciphertext: PackedByteArray) 🔗

使用提供的私有ciphertext解密给定的key

注意:接受密文的最大大小受密钥大小的限制。


PackedByteArray encrypt(key: CryptoKey, plaintext: PackedByteArray) 🔗

使用提供的公共plaintext加密给定的key

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


PackedByteArray generate_random_bytes(size: int) 🔗

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


CryptoKey generate_rsa(size: int) 🔗

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


X509Certificate generate_self_signed_certificate(key: CryptoKey, issuer_name: String = "CN=myserver,O=myorganisation,C=IT", not_before: String = "20140101000000", not_after: String = "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(hash_type: HashType, key: PackedByteArray, msg: PackedByteArray) 🔗

使用key生成msgHMAC摘要。hash_type参数是用于内部和外部散列的散列算法。

目前,仅支持HashingContext.HASH_SHA256HashingContext.HASH_SHA1


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

使用提供的私有keyhash_type类型的给定hash进行签名。


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

验证给定的signature对于hash的类型hash_type是否与提供的公共key相匹配。