godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Doc] Update Crypto example

Browse Source 
- Removed redundant new() initializations
- removed _ready and node
- improved readability
This commit is contained in:
Carsten 2024-05-09 14:36:28 +02:00 committed by GitHub
parent c4279fe3e0
commit e119e48d4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 53 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
doc/classes/Crypto.xml
View File

@ -8,66 +8,67 @@
Currently, this includes asymmetric key encryption/decryption, signing/verification, and generating cryptographically secure random bytes, RSA keys, HMAC digests, and self-signed [X509Certificate]s. Currently, this includes asymmetric key encryption/decryption, signing/verification, and generating cryptographically secure random bytes, RSA keys, HMAC digests, and self-signed [X509Certificate]s.
[codeblocks] [codeblocks]
[gdscript] [gdscript]
extends Node
var crypto = Crypto.new() var crypto = Crypto.new()
var key = CryptoKey.new()
var cert = X509Certificate.new()
func _ready(): # Generate new RSA key.
# Generate new RSA key. var key = crypto.generate_rsa(4096)
key = crypto.generate_rsa(4096)
# Generate new self-signed certificate with the given key. # 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") var 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") # Save key and certificate in the user folder.
cert.save("user://generated.crt") key.save("user://generated.key")
# Encryption cert.save("user://generated.crt")
var data = "Some data"
var encrypted = crypto.encrypt(key, data.to_utf8_buffer()) # Encryption
# Decryption var data = "Some data"
var decrypted = crypto.decrypt(key, encrypted) var encrypted = crypto.encrypt(key, data.to_utf8_buffer())
# Signing
var signature = crypto.sign(HashingContext.HASH_SHA256, data.sha256_buffer(), key) # Decryption
# Verifying var decrypted = crypto.decrypt(key, encrypted)
var verified = crypto.verify(HashingContext.HASH_SHA256, data.sha256_buffer(), signature, key)
# Checks # Signing
assert(verified) var signature = crypto.sign(HashingContext.HASH_SHA256, data.sha256_buffer(), key)
assert(data.to_utf8_buffer() == decrypted)
# Verifying
var verified = crypto.verify(HashingContext.HASH_SHA256, data.sha256_buffer(), signature, key)
# Checks
assert(verified)
assert(data.to_utf8_buffer() == decrypted)
[/gdscript] [/gdscript]
[csharp] [csharp]
using Godot; using Godot;
using System.Diagnostics; using System.Diagnostics;
public partial class MyNode : Node Crypto crypto = new Crypto();
{
private Crypto _crypto = new Crypto();
private CryptoKey _key = new CryptoKey();
private X509Certificate _cert = new X509Certificate();
public override void _Ready() // Generate new RSA key.
{ CryptoKey key = crypto.GenerateRsa(4096);
// Generate new RSA key.
_key = _crypto.GenerateRsa(4096); // Generate new self-signed certificate with the given key.
// Generate new self-signed certificate with the given key. X509Certificate cert = crypto.GenerateSelfSignedCertificate(key, "CN=mydomain.com,O=My Game Company,C=IT");
_cert = _crypto.GenerateSelfSignedCertificate(_key, "CN=mydomain.com,O=My Game Company,C=IT");
// Save key and certificate in the user folder. // Save key and certificate in the user folder.
_key.Save("user://generated.key"); key.Save("user://generated.key");
_cert.Save("user://generated.crt"); cert.Save("user://generated.crt");
// Encryption
string data = "Some data"; // Encryption
byte[] encrypted = _crypto.Encrypt(_key, data.ToUtf8Buffer()); string data = "Some data";
// Decryption byte[] encrypted = crypto.Encrypt(key, data.ToUtf8Buffer());
byte[] decrypted = _crypto.Decrypt(_key, encrypted);
// Signing // Decryption
byte[] signature = _crypto.Sign(HashingContext.HashType.Sha256, Data.Sha256Buffer(), _key); byte[] decrypted = crypto.Decrypt(key, encrypted);
// Verifying
bool verified = _crypto.Verify(HashingContext.HashType.Sha256, Data.Sha256Buffer(), signature, _key); // Signing
// Checks byte[] signature = crypto.Sign(HashingContext.HashType.Sha256, Data.Sha256Buffer(), key);
Debug.Assert(verified);
Debug.Assert(data.ToUtf8Buffer() == decrypted); // Verifying
} bool verified = crypto.Verify(HashingContext.HashType.Sha256, Data.Sha256Buffer(), signature, key);
}
// Checks
Debug.Assert(verified);
Debug.Assert(data.ToUtf8Buffer() == decrypted);
[/csharp] [/csharp]
[/codeblocks] [/codeblocks]
</description> </description>