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

Public function Virtual

~IPlatformCryptoEncryptor()

Functions

Name Description

Public function

EPlatformCry ...

 

Finalize

(
    const TArrayView < uint8 > OutCipher...,
    int32 & OutCiphertextBytesWritten
)

Finalizes encryption of data previously passed in Update.

Public function Const

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.

Public function Const

int32

 

GetCipherAuthTagSizeBytes()

Get the required size in bytes for the GenerateAuthTag call's OutAuthTag buffer

Public function Const

int32

 

GetCipherBlockSizeBytes()

Get the block size of the encryption cipher for this object.

Public function Const

int32

 

GetCipherInitializationVectorSizeBytes()

Get the initialization vector size of the encryption cipher for this object.

Public function Const

FName

 

GetCipherName()

Get the name of the encryption cipher for this object

Public function Const

int32

 

GetFinalizeBufferSizeBytes()

Get the amount of bytes required to safely store the OutCipherText buffer of a call to Finalize

Public function Const

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

Public function

EPlatformCry ...

 

Update

(
    const TArrayView < const uint8 > Pla...,
    const TArrayView < uint8 > OutCipher...,
    int32 & OutCiphertextBytesWritten
)

Encrypt one or more blocks of data.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback