Aws::Utils::Crypto::ContentCryptoMaterial Class Reference

#include <ContentCryptoMaterial.h>

Public Member Functions

 ContentCryptoMaterial ()

 

 ContentCryptoMaterial (ContentCryptoScheme contentCryptoScheme)

 

 ContentCryptoMaterial (const Aws::Utils::CryptoBuffer &cek, ContentCryptoScheme contentCryptoScheme)

 

 ContentCryptoMaterial (const char *msg)

 

const Aws::Utils::CryptoBuffer & GetContentEncryptionKey () const

 

const Aws::Utils::CryptoBuffer & GetEncryptedContentEncryptionKey () const

 

const Aws::Utils::CryptoBuffer & GetIV () const

 

const Aws::Map< Aws::String, Aws::String > & GetEncryptionContext () const

 

const Aws::Utils::CryptoBuffer & GetKeyCommitment () const

 

const Aws::Utils::CryptoBuffer & GetMessageID () const

 

size_t GetCryptoTagLength () const

 

const Aws::Map< Aws::String, Aws::String > & GetMaterialsDescription () const

 

const Aws::String & GetMaterialsDescription (const Aws::String &key) const

 

KeyWrapAlgorithm GetKeyWrapAlgorithm () const

 

ContentCryptoScheme GetContentCryptoScheme () const

 

void SetContentEncryptionKey (const Aws::Utils::CryptoBuffer &contentEncryptionKey)

 

void SetEncryptedContentEncryptionKey (const Aws::Utils::CryptoBuffer &encryptedContentEncryptionKey)

 

void SetIV (const Aws::Utils::CryptoBuffer &iv)

 

void SetV3IV ()

 

void SetEncryptionContext (const Aws::Map< Aws::String, Aws::String > &encryptionContext)

 

void SetKeyCommitment (const Aws::Utils::CryptoBuffer &keyCommitment)

 

void SetMessageID (const Aws::Utils::CryptoBuffer &messageId)

 

void SetCryptoTagLength (size_t cryptoTagLength)

 

void AddMaterialsDescription (const Aws::String &key, const Aws::String &value)

 

void SetMaterialsDescription (const Aws::Map< Aws::String, Aws::String > &materialsDescription)

 

void SetKeyWrapAlgorithm (KeyWrapAlgorithm keyWrapAlgorithm)

 

void SetContentCryptoScheme (ContentCryptoScheme contentCryptoScheme)

 

void SetGCMAAD (const Aws::Utils::CryptoBuffer &aad)

 

const Aws::Utils::CryptoBuffer & GetGCMAAD () const

 

void SetCEKGCMTag (const Aws::Utils::CryptoBuffer &tag)

 

const Aws::Utils::CryptoBuffer & GetCEKGCMTag () const

 

void SetCekIV (const Aws::Utils::CryptoBuffer &iv)

 

const Aws::Utils::CryptoBuffer & GetCekIV () const

 

void SetFinalCEK (const Aws::Utils::CryptoBuffer &finalCEK)

 

const Aws::Utils::CryptoBuffer & GetFinalCEK () const

 

const Aws::Utils::CryptoBuffer GetAAD () const

 

bool Ok () const

 

bool Fail () const

 

const Aws::String & Error () const

 

Detailed Description

Definition at line 19 of file ContentCryptoMaterial.h.

Constructor & Destructor Documentation

ContentCryptoMaterial() [1/4]

Aws::Utils::Crypto::ContentCryptoMaterial::ContentCryptoMaterial ( )

ContentCryptoMaterial() [2/4]

Aws::Utils::Crypto::ContentCryptoMaterial::ContentCryptoMaterial ( ContentCryptoScheme  contentCryptoScheme)

ContentCryptoMaterial() [3/4]

Aws::Utils::Crypto::ContentCryptoMaterial::ContentCryptoMaterial ( const Aws::Utils::CryptoBuffer &  cek,

ContentCryptoScheme  contentCryptoScheme 

)

ContentCryptoMaterial() [4/4]

Aws::Utils::Crypto::ContentCryptoMaterial::ContentCryptoMaterial ( const char *  msg)

Member Function Documentation

AddMaterialsDescription()

void Aws::Utils::Crypto::ContentCryptoMaterial::AddMaterialsDescription ( const Aws::String &  key,

const Aws::String &  value 

)

inline

Adds to the current materials description map using a key and a value.

Definition at line 203 of file ContentCryptoMaterial.h.

Error()

const Aws::String & Aws::Utils::Crypto::ContentCryptoMaterial::Error ( ) const

inline

Definition at line 312 of file ContentCryptoMaterial.h.

Fail()

bool Aws::Utils::Crypto::ContentCryptoMaterial::Fail ( ) const

inline

Definition at line 311 of file ContentCryptoMaterial.h.

GetAAD()

const Aws::Utils::CryptoBuffer Aws::Utils::Crypto::ContentCryptoMaterial::GetAAD ( ) const

inline

Definition at line 299 of file ContentCryptoMaterial.h.

GetCEKGCMTag()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetCEKGCMTag ( ) const

inline

Gets the underlying aad for GCM if needed.

Definition at line 257 of file ContentCryptoMaterial.h.

GetCekIV()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetCekIV ( ) const

inline

Gets the underlying CEK initialization vector.

Definition at line 272 of file ContentCryptoMaterial.h.

GetContentCryptoScheme()

ContentCryptoScheme Aws::Utils::Crypto::ContentCryptoMaterial::GetContentCryptoScheme ( ) const

inline

Gets the underlying content crypto scheme.

Definition at line 126 of file ContentCryptoMaterial.h.

GetContentEncryptionKey()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetContentEncryptionKey ( ) const

inline

Gets the underlying content encryption key.

Definition at line 46 of file ContentCryptoMaterial.h.

GetCryptoTagLength()

size_t Aws::Utils::Crypto::ContentCryptoMaterial::GetCryptoTagLength ( ) const

inline

Gets the underlying crypto tag length

Definition at line 94 of file ContentCryptoMaterial.h.

GetEncryptedContentEncryptionKey()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetEncryptedContentEncryptionKey ( ) const

inline

Gets the underlying encrypted content encryption key.

Definition at line 54 of file ContentCryptoMaterial.h.

GetEncryptionContext()

const Aws::Map< Aws::String, Aws::String > & Aws::Utils::Crypto::ContentCryptoMaterial::GetEncryptionContext ( ) const

inline

Gets the underlying encryption context

Definition at line 70 of file ContentCryptoMaterial.h.

GetFinalCEK()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetFinalCEK ( ) const

inline

Gets the underlying final CEK.

Definition at line 287 of file ContentCryptoMaterial.h.

GetGCMAAD()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetGCMAAD ( ) const

inline

Gets the underlying aad for GCM if needed.

Definition at line 242 of file ContentCryptoMaterial.h.

GetIV()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetIV ( ) const

inline

Gets the underlying initialization vector

Definition at line 62 of file ContentCryptoMaterial.h.

GetKeyCommitment()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetKeyCommitment ( ) const

inline

Gets the underlying key commitment

Definition at line 78 of file ContentCryptoMaterial.h.

GetKeyWrapAlgorithm()

KeyWrapAlgorithm Aws::Utils::Crypto::ContentCryptoMaterial::GetKeyWrapAlgorithm ( ) const

inline

Gets the underlying key wrap algorithm

Definition at line 118 of file ContentCryptoMaterial.h.

GetMaterialsDescription() [1/2]

const Aws::Map< Aws::String, Aws::String > & Aws::Utils::Crypto::ContentCryptoMaterial::GetMaterialsDescription ( ) const

inline

Gets the underlying materials description map.

Definition at line 102 of file ContentCryptoMaterial.h.

GetMaterialsDescription() [2/2]

const Aws::String & Aws::Utils::Crypto::ContentCryptoMaterial::GetMaterialsDescription ( const Aws::String &  key) const

inline

Definition at line 110 of file ContentCryptoMaterial.h.

GetMessageID()

const Aws::Utils::CryptoBuffer & Aws::Utils::Crypto::ContentCryptoMaterial::GetMessageID ( ) const

inline

Gets the underlying message ID

Definition at line 86 of file ContentCryptoMaterial.h.

Ok()

bool Aws::Utils::Crypto::ContentCryptoMaterial::Ok ( ) const

inline

Definition at line 310 of file ContentCryptoMaterial.h.

SetCEKGCMTag()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetCEKGCMTag ( const Aws::Utils::CryptoBuffer &  tag)

inline

Sets the underlying tag for decrypting CEK if it's GCM encrypted.

Definition at line 250 of file ContentCryptoMaterial.h.

SetCekIV()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetCekIV ( const Aws::Utils::CryptoBuffer &  iv)

inline

Sets the underlying initialization vector for CEK if it's GCM encrypted.

Definition at line 265 of file ContentCryptoMaterial.h.

SetContentCryptoScheme()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetContentCryptoScheme ( ContentCryptoScheme  contentCryptoScheme)

inline

Sets the underlying content Crypto Scheme. Copies from parameter contentCryptoScheme.

Definition at line 227 of file ContentCryptoMaterial.h.

SetContentEncryptionKey()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetContentEncryptionKey ( const Aws::Utils::CryptoBuffer &  contentEncryptionKey)

inline

Sets the underlying content encryption key. Copies from parameter content encryption key.

Definition at line 134 of file ContentCryptoMaterial.h.

SetCryptoTagLength()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetCryptoTagLength ( size_t  cryptoTagLength)

inline

Sets the underlying crypto Tag Length. Copies from parameter cryptoTagLength.

Definition at line 195 of file ContentCryptoMaterial.h.

SetEncryptedContentEncryptionKey()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetEncryptedContentEncryptionKey ( const Aws::Utils::CryptoBuffer &  encryptedContentEncryptionKey)

inline

Sets the underlying encrypted content encryption key. Copies from parameter encrypted content encryption key.

Definition at line 142 of file ContentCryptoMaterial.h.

SetEncryptionContext()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetEncryptionContext ( const Aws::Map< Aws::String, Aws::String > &  encryptionContext)

inline

Sets the underlying encryption context. Copies from parameter encryptionContext.

Definition at line 171 of file ContentCryptoMaterial.h.

SetFinalCEK()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetFinalCEK ( const Aws::Utils::CryptoBuffer &  finalCEK)

inline

Sets the underlying final CEK

Definition at line 280 of file ContentCryptoMaterial.h.

SetGCMAAD()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetGCMAAD ( const Aws::Utils::CryptoBuffer &  aad)

inline

Sets the underlying AAD for GCM if needed.

Definition at line 235 of file ContentCryptoMaterial.h.

SetIV()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetIV ( const Aws::Utils::CryptoBuffer &  iv)

inline

Sets the underlying iv. Copies from parameter iv.

Definition at line 150 of file ContentCryptoMaterial.h.

SetKeyCommitment()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetKeyCommitment ( const Aws::Utils::CryptoBuffer &  keyCommitment)

inline

Sets the underlying key commitment. Copies from parameter keyCommitment.

Definition at line 179 of file ContentCryptoMaterial.h.

SetKeyWrapAlgorithm()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetKeyWrapAlgorithm ( KeyWrapAlgorithm  keyWrapAlgorithm)

inline

Sets the underlying Key Wrap Algorithm. Copies from parameter keyWrapAlgorithm.

Definition at line 219 of file ContentCryptoMaterial.h.

SetMaterialsDescription()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetMaterialsDescription ( const Aws::Map< Aws::String, Aws::String > &  materialsDescription)

inline

Sets the underlying materials description. Copies from parameter materials description.

Definition at line 211 of file ContentCryptoMaterial.h.

SetMessageID()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetMessageID ( const Aws::Utils::CryptoBuffer &  messageId)

inline

Sets the underlying message ID. Copies from parameter messageId.

Definition at line 187 of file ContentCryptoMaterial.h.

SetV3IV()

void Aws::Utils::Crypto::ContentCryptoMaterial::SetV3IV ( )

inline

Sets the underlying iv to 12 bytes of zero, as needed for V3 encoding

Definition at line 158 of file ContentCryptoMaterial.h.

---

The documentation for this class was generated from the following file:

• src/aws-cpp-sdk-core/include/aws/core/utils/crypto/ContentCryptoMaterial.h