Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > PlatformCryptoTypes > IPlatformCryptoEncryptor

Light Theme

Dark Theme

IPlatformCryptoEncryptor

Instance of a encryptor used to progressively encrypt a message in chunks.

Windows

MacOS

Linux

References

Module	PlatformCryptoTypes
Header	/Engine/Plugins/Experimental/PlatformCrypto/Source/PlatformCryptoTypes/Public/PlatformCryptoTypes.h
Include	#include "PlatformCryptoTypes.h"

Syntax

class IPlatformCryptoEncryptor

Remarks

Instance of a encryptor used to progressively encrypt a message in chunks. This is useful when you may not have all data loaded available at one time.

Plaintext should be fed into one or more calls to Update, and then Finalize should be called. It is invalid to call Update after Finalize has been called.

Destructors

	Name	Description
	~IPlatformCryptoEncryptor()

Functions

	Name	Description
EPlatformCry...	Finalize ( const TArrayView< uint8 > OutCipher..., int32& OutCiphertextBytesWritten )	Finalizes encryption of data previously passed in Update.
EPlatformCry...	GenerateAuthTag ( const TArrayView< uint8 > OutAuthTa..., int32& OutAuthTagBytesWritten )	For ciphers that support authentication tags, you may call this function to retreive the AuthTag after Finalize is called successfully.
int32	GetCipherAuthTagSizeBytes()	Get the required size in bytes for the GenerateAuthTag call's OutAuthTag buffer
int32	GetCipherBlockSizeBytes()	Get the block size of the encryption cipher for this object.
int32	GetCipherInitializationVectorSizeBytes()	Get the initialization vector size of the encryption cipher for this object.
FName	GetCipherName()	Get the name of the encryption cipher for this object
int32	GetFinalizeBufferSizeBytes()	Get the amount of bytes required to safely store the OutCipherText buffer of a call to Finalize
int32	GetUpdateBufferSizeBytes ( const TArrayView< const uint8 > Pla... )	Get the amount of bytes required to safely store the output of a call to Update for a particular Plaintext value
EPlatformCry...	Update ( const TArrayView< const uint8 > Pla..., const TArrayView< uint8 > OutCipher..., int32& OutCiphertextBytesWritten )	Encrypt one or more blocks of data.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss