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 > IPlatformCryptoDecryptor

Light Theme

Dark Theme

IPlatformCryptoDecryptor

Instance of a decryptor used to progressively decrypt 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 IPlatformCryptoDecryptor

Remarks

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

Encrypted ciphertext 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
	~IPlatformCryptoDecryptor()

Functions

	Name	Description
EPlatformCry...	Finalize ( const TArrayView< uint8 > OutPlaint..., int32& OutPlaintextBytesWritten )	Finalizes decryption of data previously passed in Update.
int32	GetCipherAuthTagSizeBytes()	Get the required size in bytes for the GenerateAuthTag call's OutAuthTag buffer
int32	GetCipherBlockSizeBytes()	Get the block size of the decryption cipher for this object.
int32	GetCipherInitializationVectorSizeBytes()	Get the initialization vector size of the decryption cipher for this object.
FName	GetCipherName()	Get the name of the decryption cipher for this object
int32	GetFinalizeBufferSizeBytes()	Get the minimum required out-data size for the finalize call
int32	GetUpdateBufferSizeBytes ( const TArrayView< const uint8 > Cip... )	Get the minimum required out-data size for a particular Ciphertext value
EPlatformCry...	SetAuthTag ( const TArrayView< const uint8 > Aut... )	For ciphers that require authentication tags, you must call this function to set the AuthTag for the encrypted data before you may call Finalize.
EPlatformCry...	Update ( const TArrayView< const uint8 > Cip..., const TArrayView< uint8 > OutPlaint..., int32& OutPlaintextBytesWritten )	Decrypt 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