PKIFXSECCryptoKeyRaw Class Reference
#include <PKIFXSECCryptoKeyRaw.h>
Detailed Description
A helper class for PKIFXSECCryptoSymmetricKey and PKIFXSECCryptoKeyHMAC. Should not be used by applications but may be used by the XML security library, so it's external anyway.TSP-enforcing: No
Definition at line 28 of file PKIFXSECCryptoKeyRaw.h.
Public Member Functions | |
| PKIFXSECCryptoKeyRaw () | |
| PKIFXSECCryptoKeyRaw (CPKIFKeyMaterialPtr &km) | |
| virtual | ~PKIFXSECCryptoKeyRaw () |
| virtual void | setKey (const unsigned char *inBuf, unsigned int inLength) |
| virtual unsigned int | getKey (safeBuffer &outBuf) |
| CPKIFKeyMaterialPtr | getPKIFKeyMaterial () |
| void | setPKIFKeyMaterial (CPKIFKeyMaterialPtr &km) |
| virtual const XMLCh * | getProviderName () |
Protected Attributes | |
| PKIFXSECCryptoKeyRawImpl * | m_impl |
Constructor & Destructor Documentation
| PKIFXSECCryptoKeyRaw::PKIFXSECCryptoKeyRaw | ( | ) |
Interface: External
Construct an empty PKIFXSECCryptoKeyRaw object
- Returns:
- None
Definition at line 46 of file PKIFXSECCryptoKeyRaw.cpp.
| PKIFXSECCryptoKeyRaw::PKIFXSECCryptoKeyRaw | ( | CPKIFKeyMaterialPtr & | km | ) |
Interface: External
Construct a PKIFXSECCryptoKeyRaw object using the supplied key material
- Returns:
- None
- Parameters:
-
km [in] key material for the object
Definition at line 58 of file PKIFXSECCryptoKeyRaw.cpp.
References m_impl.
| PKIFXSECCryptoKeyRaw::~PKIFXSECCryptoKeyRaw | ( | ) | [virtual] |
Interface: External
free resources used by a PKIFXSECCryptoKeyRaw object
- Returns:
- None
Definition at line 74 of file PKIFXSECCryptoKeyRaw.cpp.
References m_impl.
Member Function Documentation
| void PKIFXSECCryptoKeyRaw::setKey | ( | const unsigned char * | inBuf, | |
| unsigned int | inLength | |||
| ) | [virtual] |
Interface: External
Populate the key material object by copying the caller-supplied buffer into it
- Returns:
- None
- Parameters:
-
inBuf [in] buffer containing key material inLength [in] length of key material
Definition at line 89 of file PKIFXSECCryptoKeyRaw.cpp.
References m_impl.
Referenced by PKIFXSECCryptoSymmetricKey::setKey(), and PKIFXSECCryptoKeyHMAC::setKey().
| unsigned int PKIFXSECCryptoKeyRaw::getKey | ( | safeBuffer & | outBuf | ) | [virtual] |
Interface: External
Copy the key material into the caller-owned buffer
- Returns:
- number of bytes copied
- Parameters:
-
outBuf [out] buffer to receive key material
Definition at line 107 of file PKIFXSECCryptoKeyRaw.cpp.
References m_impl.
Referenced by PKIFXSECCryptoSymmetricKey::getKey(), and PKIFXSECCryptoKeyHMAC::getKey().
| CPKIFKeyMaterialPtr PKIFXSECCryptoKeyRaw::getPKIFKeyMaterial | ( | ) |
Interface: External
Obtain a pointer to the PKIF key material object
- Returns:
- underlying key material object
Definition at line 125 of file PKIFXSECCryptoKeyRaw.cpp.
References m_impl.
Referenced by PKIFXSECCryptoSymmetricKey::clone(), PKIFXSECCryptoKeyHMAC::clone(), PKIFXSECCryptoSymmetricKey::decrypt(), PKIFXSECCryptoSymmetricKey::decryptFinish(), PKIFXSECCryptoSymmetricKey::decryptInit(), PKIFXSECCryptoSymmetricKey::encrypt(), PKIFXSECCryptoSymmetricKey::encryptFinish(), PKIFXSECCryptoSymmetricKey::encryptInit(), PKIFXSECCryptoSymmetricKey::getPKIFKeyMaterial(), PKIFXSECCryptoKeyHMAC::getPKIFKeyMaterial(), PKIFXSECCryptoSymmetricKey::getSymmetricKeyType(), and PKIFXSECCryptoSymmetricKey::setKey().
| void PKIFXSECCryptoKeyRaw::setPKIFKeyMaterial | ( | CPKIFKeyMaterialPtr & | km | ) |
Interface: External
Set the underlying key material object
- Returns:
- none
- Parameters:
-
km [in] key material to use
Definition at line 136 of file PKIFXSECCryptoKeyRaw.cpp.
References m_impl.
Referenced by PKIFXSECCryptoSymmetricKey::setPKIFKeyMaterial(), and PKIFXSECCryptoKeyHMAC::setPKIFKeyMaterial().
| const XMLCh * PKIFXSECCryptoKeyRaw::getProviderName | ( | ) | [virtual] |
Interface: External
Get the name of the provider
- Returns:
- Name of the PKIF XML provider
Definition at line 150 of file PKIFXSECCryptoKeyRaw.cpp.
References m_impl.
Referenced by PKIFXSECCryptoSymmetricKey::getProviderName(), and PKIFXSECCryptoKeyHMAC::getProviderName().
Member Data Documentation
PKIFXSECCryptoKeyRawImpl* PKIFXSECCryptoKeyRaw::m_impl [protected] |
Definition at line 46 of file PKIFXSECCryptoKeyRaw.h.
Referenced by getKey(), getPKIFKeyMaterial(), getProviderName(), PKIFXSECCryptoKeyRaw(), setKey(), setPKIFKeyMaterial(), and ~PKIFXSECCryptoKeyRaw().
The documentation for this class was generated from the following files:
