2019-08-22 14:49:30 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 13:40:34 +01:00
<class name= "Crypto" inherits= "Reference" version= "3.3" >
2019-08-22 14:49:30 +02:00
<brief_description >
2019-09-23 18:16:41 +02:00
Access to advanced cryptographic functionalities.
2019-08-22 14:49:30 +02:00
</brief_description>
<description >
2019-09-23 18:16:41 +02:00
The Crypto class allows you to access some more advanced cryptographic functionalities in Godot.
2020-06-18 12:39:56 +02:00
For now, this includes generating cryptographically secure random bytes, RSA keys and self-signed X509 certificates generation, asymmetric key encryption/decryption, and signing/verification.
2019-09-23 18:16:41 +02:00
[codeblock]
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")
2020-06-18 12:39:56 +02:00
# 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)
2019-09-23 18:16:41 +02:00
[/codeblock]
2020-01-14 13:54:31 +01:00
[b]Note:[/b] Not available in HTML5 exports.
2019-08-22 14:49:30 +02:00
</description>
<tutorials >
</tutorials>
<methods >
2020-06-18 12:39:56 +02:00
<method name= "decrypt" >
<return type= "PoolByteArray" >
</return>
<argument index= "0" name= "key" type= "CryptoKey" >
</argument>
<argument index= "1" name= "ciphertext" type= "PoolByteArray" >
</argument>
<description >
Decrypt the given [code]ciphertext[/code] with the provided private [code]key[/code].
[b]Note[/b]: The maximum size of accepted ciphertext is limited by the key size.
</description>
</method>
<method name= "encrypt" >
<return type= "PoolByteArray" >
</return>
<argument index= "0" name= "key" type= "CryptoKey" >
</argument>
<argument index= "1" name= "plaintext" type= "PoolByteArray" >
</argument>
<description >
Encrypt the given [code]plaintext[/code] with the provided public [code]key[/code].
[b]Note[/b]: The maximum size of accepted plaintext is limited by the key size.
</description>
</method>
2019-08-22 14:49:30 +02:00
<method name= "generate_random_bytes" >
<return type= "PoolByteArray" >
</return>
<argument index= "0" name= "size" type= "int" >
</argument>
<description >
2019-09-23 18:16:41 +02:00
Generates a [PoolByteArray] of cryptographically secure random bytes with given [code]size[/code].
2019-08-22 14:49:30 +02:00
</description>
</method>
<method name= "generate_rsa" >
<return type= "CryptoKey" >
</return>
<argument index= "0" name= "size" type= "int" >
</argument>
<description >
2019-09-27 22:16:32 +02:00
Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream].
2019-08-22 14:49:30 +02:00
</description>
</method>
<method name= "generate_self_signed_certificate" >
<return type= "X509Certificate" >
</return>
<argument index= "0" name= "key" type= "CryptoKey" >
</argument>
<argument index= "1" name= "issuer_name" type= "String" default= ""CN=myserver,O=myorganisation,C=IT"" >
</argument>
<argument index= "2" name= "not_before" type= "String" default= ""20140101000000"" >
</argument>
<argument index= "3" name= "not_after" type= "String" default= ""20340101000000"" >
</argument>
<description >
2019-09-23 18:16:41 +02:00
Generates a self-signed [X509Certificate] from the given [CryptoKey] and [code]issuer_name[/code]. The certificate validity will be defined by [code]not_before[/code] and [code]not_after[/code] (first valid date and last valid date). The [code]issuer_name[/code] 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.
[codeblock]
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")
[/codeblock]
2019-08-22 14:49:30 +02:00
</description>
</method>
2020-06-18 12:39:56 +02:00
<method name= "sign" >
<return type= "PoolByteArray" >
</return>
<argument index= "0" name= "hash_type" type= "int" enum= "HashingContext.HashType" >
</argument>
<argument index= "1" name= "hash" type= "PoolByteArray" >
</argument>
<argument index= "2" name= "key" type= "CryptoKey" >
</argument>
<description >
Sign a given [code]hash[/code] of type [code]hash_type[/code] with the provided private [code]key[/code].
</description>
</method>
<method name= "verify" >
<return type= "bool" >
</return>
<argument index= "0" name= "hash_type" type= "int" enum= "HashingContext.HashType" >
</argument>
<argument index= "1" name= "hash" type= "PoolByteArray" >
</argument>
<argument index= "2" name= "signature" type= "PoolByteArray" >
</argument>
<argument index= "3" name= "key" type= "CryptoKey" >
</argument>
<description >
Verify that a given [code]signature[/code] for [code]hash[/code] of type [code]hash_type[/code] against the provided public [code]key[/code].
</description>
</method>
2019-08-22 14:49:30 +02:00
</methods>
<constants >
</constants>
</class>