:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Crypto.xml. .. _class_Crypto: Crypto ====== **Inherits:** :ref:`Reference` **<** :ref:`Object` Access to advanced cryptographic functionalities. Description ----------- 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. Methods ------- +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`constant_time_compare` **(** :ref:`PoolByteArray` trusted, :ref:`PoolByteArray` received **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`decrypt` **(** :ref:`CryptoKey` key, :ref:`PoolByteArray` ciphertext **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`encrypt` **(** :ref:`CryptoKey` key, :ref:`PoolByteArray` plaintext **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`generate_random_bytes` **(** :ref:`int` size **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CryptoKey` | :ref:`generate_rsa` **(** :ref:`int` size **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`X509Certificate` | :ref:`generate_self_signed_certificate` **(** :ref:`CryptoKey` key, :ref:`String` issuer_name="CN=myserver,O=myorganisation,C=IT", :ref:`String` not_before="20140101000000", :ref:`String` not_after="20340101000000" **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`hmac_digest` **(** :ref:`HashType` hash_type, :ref:`PoolByteArray` key, :ref:`PoolByteArray` msg **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`sign` **(** :ref:`HashType` hash_type, :ref:`PoolByteArray` hash, :ref:`CryptoKey` key **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`verify` **(** :ref:`HashType` hash_type, :ref:`PoolByteArray` hash, :ref:`PoolByteArray` signature, :ref:`CryptoKey` key **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_Crypto_method_constant_time_compare: - :ref:`bool` **constant_time_compare** **(** :ref:`PoolByteArray` trusted, :ref:`PoolByteArray` received **)** Compares two :ref:`PoolByteArray`\ s for equality without leaking timing information in order to prevent timing attacks. See `this blog post `__ for more information. ---- .. _class_Crypto_method_decrypt: - :ref:`PoolByteArray` **decrypt** **(** :ref:`CryptoKey` key, :ref:`PoolByteArray` ciphertext **)** Decrypt the given ``ciphertext`` with the provided private ``key``. \ **Note:** The maximum size of accepted ciphertext is limited by the key size. ---- .. _class_Crypto_method_encrypt: - :ref:`PoolByteArray` **encrypt** **(** :ref:`CryptoKey` key, :ref:`PoolByteArray` plaintext **)** Encrypt the given ``plaintext`` with the provided public ``key``. \ **Note:** The maximum size of accepted plaintext is limited by the key size. ---- .. _class_Crypto_method_generate_random_bytes: - :ref:`PoolByteArray` **generate_random_bytes** **(** :ref:`int` size **)** Generates a :ref:`PoolByteArray` of cryptographically secure random bytes with given ``size``. ---- .. _class_Crypto_method_generate_rsa: - :ref:`CryptoKey` **generate_rsa** **(** :ref:`int` size **)** Generates an RSA :ref:`CryptoKey` that can be used for creating self-signed certificates and passed to :ref:`StreamPeerSSL.accept_stream`. ---- .. _class_Crypto_method_generate_self_signed_certificate: - :ref:`X509Certificate` **generate_self_signed_certificate** **(** :ref:`CryptoKey` key, :ref:`String` issuer_name="CN=myserver,O=myorganisation,C=IT", :ref:`String` not_before="20140101000000", :ref:`String` not_after="20340101000000" **)** Generates a self-signed :ref:`X509Certificate` from the given :ref:`CryptoKey` and ``issuer_name``. The certificate validity will be defined by ``not_before`` and ``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") ---- .. _class_Crypto_method_hmac_digest: - :ref:`PoolByteArray` **hmac_digest** **(** :ref:`HashType` hash_type, :ref:`PoolByteArray` key, :ref:`PoolByteArray` msg **)** Generates an `HMAC `__ digest of ``msg`` using ``key``. The ``hash_type`` parameter is the hashing algorithm that is used for the inner and outer hashes. Currently, only :ref:`HashingContext.HASH_SHA256` and :ref:`HashingContext.HASH_SHA1` are supported. ---- .. _class_Crypto_method_sign: - :ref:`PoolByteArray` **sign** **(** :ref:`HashType` hash_type, :ref:`PoolByteArray` hash, :ref:`CryptoKey` key **)** Sign a given ``hash`` of type ``hash_type`` with the provided private ``key``. ---- .. _class_Crypto_method_verify: - :ref:`bool` **verify** **(** :ref:`HashType` hash_type, :ref:`PoolByteArray` hash, :ref:`PoolByteArray` signature, :ref:`CryptoKey` key **)** Verify that a given ``signature`` for ``hash`` of type ``hash_type`` against the provided public ``key``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`