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 > IPlatformCryptoEncryptor::GenerateAuthTag

Light Theme

Dark Theme

IPlatformCryptoEncryptor::GenerateAuthTag

For ciphers that support authentication tags, you may call this function to retreive the AuthTag after Finalize is called successfully.

Windows

MacOS

Linux

References

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

Syntax

EPlatformCryptoResult GenerateAuthTag
(
const TArrayView< uint8 > OutAuthTag,
int32 & OutAuthTagBytesWritten
) const

Remarks

For ciphers that support authentication tags, you may call this function to retreive the AuthTag after Finalize is called successfully. This will fail for ciphers that do not support AuthTags.

Parameters

Parameter	Description
OutAuthTag	The Auth Tag used to validate integrity of the the encrypted data during decryption. Must be at least GetAuthTagSizeBytes in size or GetAuthTag will fail.
OutAuthTagBytesWritten	The amount of bytes written to OutAuthTag. This can be from 0 to GetAuthTagSizebytes

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

Take our survey

Dismiss