2019-08-22 20:49:30 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "Crypto" inherits= "RefCounted" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2019-08-22 20:49:30 +08:00
<brief_description >
2023-04-28 07:35:33 +08:00
Provides access to advanced cryptographic functionalities.
2019-08-22 20:49:30 +08:00
</brief_description>
<description >
2023-04-28 07:35:33 +08:00
The Crypto class provides access to advanced cryptographic functionalities.
Currently, this includes asymmetric key encryption/decryption, signing/verification, and generating cryptographically secure random bytes, RSA keys, HMAC digests, and self-signed [X509Certificate]s.
2020-09-12 23:06:13 +08:00
[codeblocks]
[gdscript]
2019-09-24 00:16:41 +08:00
extends Node
2023-02-01 01:21:09 +08:00
2019-09-24 00:16:41 +08:00
var crypto = Crypto.new()
var key = CryptoKey.new()
var cert = X509Certificate.new()
2023-02-01 01:21:09 +08:00
2019-09-24 00:16:41 +08:00
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 18:39:56 +08:00
# Encryption
var data = "Some data"
2023-03-14 05:58:27 +08:00
var encrypted = crypto.encrypt(key, data.to_utf8_buffer())
2020-06-18 18:39:56 +08:00
# 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)
2023-03-14 05:58:27 +08:00
assert(data.to_utf8_buffer() == decrypted)
2020-09-12 23:06:13 +08:00
[/gdscript]
[csharp]
using Godot;
using System.Diagnostics;
2023-02-01 01:21:09 +08:00
public partial class MyNode : Node
2020-09-12 23:06:13 +08:00
{
2023-02-01 01:21:09 +08:00
private Crypto _crypto = new Crypto();
private CryptoKey _key = new CryptoKey();
private X509Certificate _cert = new X509Certificate();
2020-09-12 23:06:13 +08:00
public override void _Ready()
{
// Generate new RSA key.
2023-02-01 01:21:09 +08:00
_key = _crypto.GenerateRsa(4096);
2020-09-12 23:06:13 +08:00
// Generate new self-signed certificate with the given key.
2023-02-01 01:21:09 +08:00
_cert = _crypto.GenerateSelfSignedCertificate(_key, "CN=mydomain.com,O=My Game Company,C=IT");
2020-09-12 23:06:13 +08:00
// Save key and certificate in the user folder.
2023-02-01 01:21:09 +08:00
_key.Save("user://generated.key");
_cert.Save("user://generated.crt");
2020-09-12 23:06:13 +08:00
// Encryption
string data = "Some data";
2023-03-14 05:58:27 +08:00
byte[] encrypted = _crypto.Encrypt(_key, data.ToUtf8Buffer());
2020-09-12 23:06:13 +08:00
// Decryption
2023-02-01 01:21:09 +08:00
byte[] decrypted = _crypto.Decrypt(_key, encrypted);
2020-09-12 23:06:13 +08:00
// Signing
2023-02-01 01:21:09 +08:00
byte[] signature = _crypto.Sign(HashingContext.HashType.Sha256, Data.Sha256Buffer(), _key);
2020-09-12 23:06:13 +08:00
// Verifying
2023-02-01 01:21:09 +08:00
bool verified = _crypto.Verify(HashingContext.HashType.Sha256, Data.Sha256Buffer(), signature, _key);
2020-09-12 23:06:13 +08:00
// Checks
Debug.Assert(verified);
2023-03-14 05:58:27 +08:00
Debug.Assert(data.ToUtf8Buffer() == decrypted);
2020-09-12 23:06:13 +08:00
}
}
[/csharp]
[/codeblocks]
2019-08-22 20:49:30 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2020-11-14 20:42:47 +08:00
<method name= "constant_time_compare" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "trusted" type= "PackedByteArray" />
<param index= "1" name= "received" type= "PackedByteArray" />
2020-11-14 20:42:47 +08:00
<description >
Compares two [PackedByteArray]s for equality without leaking timing information in order to prevent timing attacks.
See [url=https://paragonie.com/blog/2015/11/preventing-timing-attacks-on-string-comparison-with-double-hmac-strategy]this blog post[/url] for more information.
</description>
</method>
2020-06-18 18:39:56 +08:00
<method name= "decrypt" >
2021-07-30 21:28:05 +08:00
<return type= "PackedByteArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "key" type= "CryptoKey" />
<param index= "1" name= "ciphertext" type= "PackedByteArray" />
2020-06-18 18:39:56 +08:00
<description >
2022-08-13 01:13:27 +08:00
Decrypt the given [param ciphertext] with the provided private [param key].
2021-10-05 20:24:34 +08:00
[b]Note:[/b] The maximum size of accepted ciphertext is limited by the key size.
2020-06-18 18:39:56 +08:00
</description>
</method>
<method name= "encrypt" >
2021-07-30 21:28:05 +08:00
<return type= "PackedByteArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "key" type= "CryptoKey" />
<param index= "1" name= "plaintext" type= "PackedByteArray" />
2020-06-18 18:39:56 +08:00
<description >
2022-08-13 01:13:27 +08:00
Encrypt the given [param plaintext] with the provided public [param key].
2021-10-05 20:24:34 +08:00
[b]Note:[/b] The maximum size of accepted plaintext is limited by the key size.
2020-06-18 18:39:56 +08:00
</description>
</method>
2019-08-22 20:49:30 +08:00
<method name= "generate_random_bytes" >
2021-07-30 21:28:05 +08:00
<return type= "PackedByteArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "size" type= "int" />
2019-08-22 20:49:30 +08:00
<description >
2022-08-13 01:13:27 +08:00
Generates a [PackedByteArray] of cryptographically secure random bytes with given [param size].
2019-08-22 20:49:30 +08:00
</description>
</method>
<method name= "generate_rsa" >
2021-07-30 21:28:05 +08:00
<return type= "CryptoKey" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "size" type= "int" />
2019-08-22 20:49:30 +08:00
<description >
2022-09-07 06:46:12 +08:00
Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerTLS.accept_stream].
2019-08-22 20:49:30 +08:00
</description>
</method>
<method name= "generate_self_signed_certificate" >
2021-07-30 21:28:05 +08:00
<return type= "X509Certificate" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "key" type= "CryptoKey" />
<param index= "1" name= "issuer_name" type= "String" default= ""CN=myserver,O=myorganisation,C=IT"" />
<param index= "2" name= "not_before" type= "String" default= ""20140101000000"" />
<param index= "3" name= "not_after" type= "String" default= ""20340101000000"" />
2019-08-22 20:49:30 +08:00
<description >
2022-08-13 01:13:27 +08:00
Generates a self-signed [X509Certificate] from the given [CryptoKey] and [param issuer_name]. The certificate validity will be defined by [param not_before] and [param not_after] (first valid date and last valid date). The [param 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).
2024-03-13 19:43:07 +08:00
A small example to generate an RSA key and an X509 self-signed certificate.
2020-09-12 23:06:13 +08:00
[codeblocks]
[gdscript]
2019-09-24 00:16:41 +08:00
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")
2020-09-12 23:06:13 +08:00
[/gdscript]
[csharp]
var crypto = new Crypto();
// Generate 4096 bits RSA key.
CryptoKey key = crypto.GenerateRsa(4096);
// Generate self-signed certificate using the given key.
X509Certificate cert = crypto.GenerateSelfSignedCertificate(key, "CN=mydomain.com,O=My Game Company,C=IT");
[/csharp]
[/codeblocks]
2019-08-22 20:49:30 +08:00
</description>
</method>
2020-11-14 20:42:47 +08:00
<method name= "hmac_digest" >
2021-07-30 21:28:05 +08:00
<return type= "PackedByteArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "hash_type" type= "int" enum= "HashingContext.HashType" />
<param index= "1" name= "key" type= "PackedByteArray" />
<param index= "2" name= "msg" type= "PackedByteArray" />
2020-11-14 20:42:47 +08:00
<description >
2022-08-13 01:13:27 +08:00
Generates an [url=https://en.wikipedia.org/wiki/HMAC]HMAC[/url] digest of [param msg] using [param key]. The [param hash_type] parameter is the hashing algorithm that is used for the inner and outer hashes.
2020-11-14 20:42:47 +08:00
Currently, only [constant HashingContext.HASH_SHA256] and [constant HashingContext.HASH_SHA1] are supported.
</description>
</method>
2020-06-18 18:39:56 +08:00
<method name= "sign" >
2021-07-30 21:28:05 +08:00
<return type= "PackedByteArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "hash_type" type= "int" enum= "HashingContext.HashType" />
<param index= "1" name= "hash" type= "PackedByteArray" />
<param index= "2" name= "key" type= "CryptoKey" />
2020-06-18 18:39:56 +08:00
<description >
2022-08-13 01:13:27 +08:00
Sign a given [param hash] of type [param hash_type] with the provided private [param key].
2020-06-18 18:39:56 +08:00
</description>
</method>
<method name= "verify" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "hash_type" type= "int" enum= "HashingContext.HashType" />
<param index= "1" name= "hash" type= "PackedByteArray" />
<param index= "2" name= "signature" type= "PackedByteArray" />
<param index= "3" name= "key" type= "CryptoKey" />
2020-06-18 18:39:56 +08:00
<description >
2022-08-13 01:13:27 +08:00
Verify that a given [param signature] for [param hash] of type [param hash_type] against the provided public [param key].
2020-06-18 18:39:56 +08:00
</description>
</method>
2019-08-22 20:49:30 +08:00
</methods>
</class>