Access to advanced cryptographic functionalities.
The Crypto class allows you to access some more advanced cryptographic functionalities in Godot.
For now, this includes generating cryptographically secure random bytes, RSA keys and self-signed X509 certificates generation, asymmetric key encryption/decryption, and signing/verification.
extends Node var crypto = Crypto.new() var key = CryptoKey.new() var cert = X509Certificate.new() func _ready(): # Generate new RSA key. key = crypto.generate_rsa(4096) # Generate new self-signed certificate with the given key. cert = crypto.generate_self_signed_certificate(key, "CN=mydomain.com,O=My Game Company,C=IT") # Save key and certificate in the user folder. key.save("user://generated.key") cert.save("user://generated.crt") # Encryption var data = "Some data" var encrypted = crypto.encrypt(key, data.to_utf8()) # Decryption var decrypted = crypto.decrypt(key, encrypted) # Signing var signature = crypto.sign(HashingContext.HASH_SHA256, data.sha256_buffer(), key) # Verifying var verified = crypto.verify(HashingContext.HASH_SHA256, data.sha256_buffer(), signature, key) # Checks assert(verified) assert(data.to_utf8() == decrypted)
Note: Not available in HTML5 exports.
Compares two PoolByteArrays for equality without leaking timing information in order to prevent timing attacks.
See this blog post for more information.
Decrypt the given
ciphertext with the provided private
Note: The maximum size of accepted ciphertext is limited by the key size.
Encrypt the given
plaintext with the provided public
Note: The maximum size of accepted plaintext is limited by the key size.
Generates a PoolByteArray of cryptographically secure random bytes with given
Generates a self-signed X509Certificate from the given CryptoKey and
issuer_name. The certificate validity will be defined by
not_after (first valid date and last valid date). The
issuer_name must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in).
A small example to generate an RSA key and a X509 self-signed certificate.
var crypto = Crypto.new() # Generate 4096 bits RSA key. var key = crypto.generate_rsa(4096) # Generate self-signed certificate using the given key. var cert = crypto.generate_self_signed_certificate(key, "CN=example.com,O=A Game Company,C=IT")
Generates an HMAC digest of
hash_type parameter is the hashing algorithm that is used for the inner and outer hashes.
Sign a given
hash of type
hash_type with the provided private
Verify that a given
hash of type
hash_type against the provided public