CPKIFKEKRecipInfoDetails Class Reference
#include <KEKRecipInfoDetails.h>
Detailed Description
CPKIFKEKRecipInfoDetails is used to store information about previously distributed symmetric keys, which can be used to convey content encryption keys to message recipients. The information conveyed via a CPKIFKEKRecipInfoDetails object can be used to identify the key to use when decoding and decrypting a CPKIFEnvelopedData object. When encoding and encrypting a CPKIFEnvelopedData object, the information conveyed via CPKIFKEKRecipInfoDetails is used to encrypt the data and to identify the key in the encoded message.TSP-enforcing: No
Definition at line 28 of file KEKRecipInfoDetails.h.
Public Member Functions | |
| CPKIFKEKRecipInfoDetails () | |
| CPKIFKEKRecipInfoDetails (const CPKIFBufferPtr &kekBuf) | |
| ~CPKIFKEKRecipInfoDetails () | |
| CPKIFKeyMaterialPtr | GetKEK () const |
| void | SetKEK (CPKIFKeyMaterialPtr &kek) |
| CPKIFBufferPtr | GetKeyIdentifier () const |
| void | SetKeyIdentifier (CPKIFBufferPtr &kid) |
| CPKIFBufferPtr | GetEncryptedKey () const |
| CPKIFAlgorithmIdentifierPtr | GetKEKAlgorithm () const |
Constructor & Destructor Documentation
| CPKIFKEKRecipInfoDetails::CPKIFKEKRecipInfoDetails | ( | ) |
Interface: External
Default constructor
- Returns:
- None
Definition at line 37 of file KEKRecipInfoDetails.cpp.
| CPKIFKEKRecipInfoDetails::CPKIFKEKRecipInfoDetails | ( | const CPKIFBufferPtr & | kekBuf | ) |
Interface: External
This constructor is internally used when constructing a CPKIFRecipientInfo whose version is 3.
- Returns:
- None
- Parameters:
-
kekBuf [in] Reference to a CACCMSKEKRecipientInfo structure containing the key encryption key used to populate an instance of CPKIFKEKRecipInfoDetails.
Definition at line 116 of file KEKRecipInfoDetails.cpp.
References CACASNWRAPPER_CREATE, LOG_STRING_DEBUG, and TOOLKIT_CRYPTO_MISC.
| CPKIFKEKRecipInfoDetails::~CPKIFKEKRecipInfoDetails | ( | ) |
Interface: External
This function destroys an instance of CPKIFKEKRecipInfoDetails object.
- Returns:
- None
Definition at line 61 of file KEKRecipInfoDetails.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_MESSAGE_ASN.
Member Function Documentation
| CPKIFKeyMaterialPtr CPKIFKEKRecipInfoDetails::GetKEK | ( | ) | const |
Interface: External
This function returns a smart pointer to a CPKIFKeyMaterial object containing the key encrypting key, or NULL if no key encrypting key has been specified.
- Return values:
-
CPKIFKeyMaterialPtr A smart pointer to a CPKIFKeyMaterial object containing the key encrypting key NULL if no key encrypting key has been specified
Definition at line 50 of file KEKRecipInfoDetails.cpp.
| void CPKIFKEKRecipInfoDetails::SetKEK | ( | CPKIFKeyMaterialPtr & | kek | ) |
Interface: External
This function is used to specify a key encrypting key to use when generating an encrypted CMS message.
- Returns:
- None
- Parameters:
-
kek [in] Reference to a smart pointer to a CPKIFKeyMaterial object containing the key encrypting key to store in this object
Definition at line 75 of file KEKRecipInfoDetails.cpp.
| CPKIFBufferPtr CPKIFKEKRecipInfoDetails::GetKeyIdentifier | ( | ) | const |
Interface: External
This function returns a smart pointer to a CPKIFBuffer object containing the key identifier.
- Returns:
- A smart pointer to a CPKIFBuffer object containing the key identifier
Definition at line 89 of file KEKRecipInfoDetails.cpp.
| void CPKIFKEKRecipInfoDetails::SetKeyIdentifier | ( | CPKIFBufferPtr & | kid | ) |
Interface: External
This function is used to a specify a key identifier that can be used by recipients to determine the key encrypting key used to encrypt the content encryption key.
- Returns:
- None
- Parameters:
-
kid [in] Reference to a smart pointer to a CPKIFBuffer object containing the key identifier
Definition at line 102 of file KEKRecipInfoDetails.cpp.
| CPKIFBufferPtr CPKIFKEKRecipInfoDetails::GetEncryptedKey | ( | ) | const |
Interface: External
This constructor is internally used when constructing a CPKIFRecipientInfo whose version is 3.
- Returns:
- None Interface: External
- Returns:
- A smart pointer to a CPKIFBuffer object, possibly containing a NULL pointer
Definition at line 186 of file KEKRecipInfoDetails.cpp.
| CPKIFAlgorithmIdentifierPtr CPKIFKEKRecipInfoDetails::GetKEKAlgorithm | ( | ) | const |
Interface: External
The algorithm is only available when a KEK has been parsed by this class.
- Returns:
- A smart poiter to CPKIFAlgorithmIdentifier object
Definition at line 197 of file KEKRecipInfoDetails.cpp.
The documentation for this class was generated from the following files:
