mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-21 10:25:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
f2045ba822
godot/doc/classes/AESContext.xml

131 lines
5.2 KiB
XML
Raw Normal View History

Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 16:08:05 +08:00
<class name="AESContext" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
<brief_description>
Overhaul the top sections of the class reference (Core classes)
2023-04-28 07:35:33 +08:00
Provides access to AES encryption/decryption of raw data.
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
</brief_description>
<description>
Overhaul the top sections of the class reference (Core classes)
2023-04-28 07:35:33 +08:00
This class holds the context information required for encryption and decryption operations with AES (Advanced Encryption Standard). Both AES-ECB and AES-CBC modes are supported.
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
[codeblocks]
[gdscript]
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
extends Node
var aes = AESContext.new()
func _ready():
var key = "My secret key!!!" # Key must be either 16 or 32 bytes.
var data = "My secret text!!" # Data size must be multiple of 16 bytes, apply padding if needed.
# Encrypt ECB
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
aes.start(AESContext.MODE_ECB_ENCRYPT, key.to_utf8_buffer())
var encrypted = aes.update(data.to_utf8_buffer())
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
aes.finish()
# Decrypt ECB
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
aes.start(AESContext.MODE_ECB_DECRYPT, key.to_utf8_buffer())
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
var decrypted = aes.update(encrypted)
aes.finish()
# Check ECB
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
assert(decrypted == data.to_utf8_buffer())
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
var iv = "My secret iv!!!!" # IV must be of exactly 16 bytes.
# Encrypt CBC
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
aes.start(AESContext.MODE_CBC_ENCRYPT, key.to_utf8_buffer(), iv.to_utf8_buffer())
encrypted = aes.update(data.to_utf8_buffer())
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
aes.finish()
# Decrypt CBC
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
aes.start(AESContext.MODE_CBC_DECRYPT, key.to_utf8_buffer(), iv.to_utf8_buffer())
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
decrypted = aes.update(encrypted)
aes.finish()
# Check CBC
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
assert(decrypted == data.to_utf8_buffer())
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
[/gdscript]
[csharp]
using Godot;
using System.Diagnostics;
Fix C# examples in documentation - Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
2023-02-01 01:21:09 +08:00
public partial class MyNode : Node
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
{
Fix C# examples in documentation - Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
2023-02-01 01:21:09 +08:00
private AesContext _aes = new AesContext();
Fix invalid C# in crypto docs
2022-09-15 17:04:32 +08:00
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
public override void _Ready()
{
string key = "My secret key!!!"; // Key must be either 16 or 32 bytes.
string data = "My secret text!!"; // Data size must be multiple of 16 bytes, apply padding if needed.
// Encrypt ECB
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
_aes.Start(AesContext.Mode.EcbEncrypt, key.ToUtf8Buffer());
byte[] encrypted = _aes.Update(data.ToUtf8Buffer());
Fix C# examples in documentation - Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
2023-02-01 01:21:09 +08:00
_aes.Finish();
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
// Decrypt ECB
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
_aes.Start(AesContext.Mode.EcbDecrypt, key.ToUtf8Buffer());
Fix C# examples in documentation - Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
2023-02-01 01:21:09 +08:00
byte[] decrypted = _aes.Update(encrypted);
_aes.Finish();
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
// Check ECB
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
Debug.Assert(decrypted == data.ToUtf8Buffer());
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
string iv = "My secret iv!!!!"; // IV must be of exactly 16 bytes.
// Encrypt CBC
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
_aes.Start(AesContext.Mode.EcbEncrypt, key.ToUtf8Buffer(), iv.ToUtf8Buffer());
encrypted = _aes.Update(data.ToUtf8Buffer());
Fix C# examples in documentation - Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
2023-02-01 01:21:09 +08:00
_aes.Finish();
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
// Decrypt CBC
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
_aes.Start(AesContext.Mode.EcbDecrypt, key.ToUtf8Buffer(), iv.ToUtf8Buffer());
Fix C# examples in documentation - Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
2023-02-01 01:21:09 +08:00
decrypted = _aes.Update(encrypted);
_aes.Finish();
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
// Check CBC
Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
2023-03-14 05:58:27 +08:00
Debug.Assert(decrypted == data.ToUtf8Buffer());
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button
2020-07-31 22:07:26 +08:00
}
}
[/csharp]
[/codeblocks]
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="finish">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
<description>
Close this AES context so it can be started again. See [method start].
</description>
</method>
<method name="get_iv_state">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="PackedByteArray" />
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
<description>
Fix spelling & grammar in comments, docs, and messages
2020-07-17 00:54:15 +08:00
Get the current IV state for this context (IV gets updated when calling [method update]). You normally don't need this function.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 20:24:34 +08:00
[b]Note:[/b] This function only makes sense when the context is started with [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT].
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
</description>
</method>
<method name="start">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="mode" type="int" enum="AESContext.Mode" />
<param index="1" name="key" type="PackedByteArray" />
<param index="2" name="iv" type="PackedByteArray" default="PackedByteArray()" />
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (8)
2022-08-13 01:51:01 +08:00
Start the AES context in the given [param mode]. A [param key] of either 16 or 32 bytes must always be provided, while an [param iv] (initialization vector) of exactly 16 bytes, is only needed when [param mode] is either [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT].
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
</description>
</method>
<method name="update">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="PackedByteArray" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="src" type="PackedByteArray" />
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (8)
2022-08-13 01:51:01 +08:00
Run the desired operation for this AES context. Will return a [PackedByteArray] containing the result of encrypting (or decrypting) the given [param src]. See [method start] for mode of operation.
[b]Note:[/b] The size of [param src] must be a multiple of 16. Apply some padding if needed.
Document AES and new Crypto/CryptoKey functions.
2020-06-18 18:39:56 +08:00
</description>
</method>
</methods>
<constants>
<constant name="MODE_ECB_ENCRYPT" value="0" enum="Mode">
AES electronic codebook encryption mode.
</constant>
<constant name="MODE_ECB_DECRYPT" value="1" enum="Mode">
AES electronic codebook decryption mode.
</constant>
<constant name="MODE_CBC_ENCRYPT" value="2" enum="Mode">
AES cipher blocker chaining encryption mode.
</constant>
<constant name="MODE_CBC_DECRYPT" value="3" enum="Mode">
AES cipher blocker chaining decryption mode.
</constant>
<constant name="MODE_MAX" value="4" enum="Mode">
Maximum value for the mode enum.
</constant>
</constants>
</class>
Reference in New Issue Copy Permalink