Navigation
API > API/Plugins > API/Plugins/AESGCMHandlerComponent
AES256 GCM block encryption component.
| Name | FAESGCMHandlerComponent |
| Type | class |
| Header File | /Engine/Plugins/Runtime/PacketHandlers/AESGCMHandlerComponent/Source/Public/AESGCMHandlerComponent.h |
| Include Path | #include "AESGCMHandlerComponent.h" |
Syntax
class FAESGCMHandlerComponent : public FEncryptionComponent
Inheritance Hierarchy
- HandlerComponent → FEncryptionComponent → FAESGCMHandlerComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAESGCMHandlerComponent() |
Default constructor that leaves the Key empty, and encryption disabled. | AESGCMHandlerComponent.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AuthTagSizeInBytes | const int32 | AESGCMHandlerComponent.h | |
| BlockSizeInBytes | const int32 | This handler uses AES256, which has 32-byte keys. | AESGCMHandlerComponent.h |
| IVSizeInBytes | const int32 | AESGCMHandlerComponent.h | |
| KeySizeInBytes | const int32 | This handler uses AES256, which has 32-byte keys. | AESGCMHandlerComponent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AESGCMFaultHandler | FAESGCMFaultHandler | Fault handler for AESGCM-specific errors, that may trigger NetConnection Close | AESGCMHandlerComponent.h | |
| bEncryptionEnabled | bool | AESGCMHandlerComponent.h | ||
| Decryptor | TUniquePtr< IPlatformCryptoDecryptor > | AESGCMHandlerComponent.h | ||
| EncryptionContext | TUniquePtr< FEncryptionContext > | AESGCMHandlerComponent.h | ||
| Encryptor | TUniquePtr< IPlatformCryptoEncryptor > | AESGCMHandlerComponent.h | ||
| OutIV | TStaticArray< uint8, IVSizeInBytes > | IV used for encryption. | AESGCMHandlerComponent.h |
Functions
Public
Overridden from FEncryptionComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DisableEncryption() |
After calling this, future outgoing packets will not be encrypted (until a call to DisableEncryption). | AESGCMHandlerComponent.h | |
virtual void EnableEncryption() |
After calling this, future outgoing packets will be encrypted (until a call to DisableEncryption). | AESGCMHandlerComponent.h | |
virtual bool IsEncryptionEnabled() |
Returns true if encryption is currently enabled. | AESGCMHandlerComponent.h | |
virtual void SetEncryptionData
(
const FEncryptionData& EncryptionData |
Replace the key used for encryption with NewKey if NewKey is exactly KeySizeInBytes long. | AESGCMHandlerComponent.h |
Overridden from HandlerComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CountBytes
(
FArchive& Ar |
AESGCMHandlerComponent.h | ||
virtual int32 GetReservedPacketBits() |
AESGCMHandlerComponent.h | ||
virtual void Incoming
(
FIncomingPacketRef PacketRef |
AESGCMHandlerComponent.h | ||
virtual void InitFaultRecovery
(
UE::Net::FNetConnectionFaultRecoveryBase* InFaultRecovery |
AESGCMHandlerComponent.h | ||
virtual void Initialize() |
AESGCMHandlerComponent.h | ||
virtual bool IsValid() |
AESGCMHandlerComponent.h | ||
virtual void Outgoing
(
FBitWriter& Packet, |
AESGCMHandlerComponent.h |