PKIFXSECCryptoKeyHMAC Class Reference
#include <PKIFXSECCryptoKeyHMAC.h>
Detailed Description
Used by the xml security library to process HMAC keysTSP-enforcing: No
Definition at line 26 of file PKIFXSECCryptoKeyHMAC.h.
Public Member Functions | |
| PKIFXSECCryptoKeyHMAC () | |
| PKIFXSECCryptoKeyHMAC (CPKIFKeyMaterialPtr &km) | |
| virtual | ~PKIFXSECCryptoKeyHMAC () |
| virtual void | setKey (unsigned char *inBuf, unsigned int inLength) |
| virtual unsigned int | getKey (safeBuffer &outBuf) const |
| CPKIFKeyMaterialPtr | getPKIFKeyMaterial () |
| void | setPKIFKeyMaterial (CPKIFKeyMaterialPtr &km) |
| virtual XSECCryptoKey * | clone () const |
| virtual const XMLCh * | getProviderName () const |
Protected Attributes | |
| PKIFXSECCryptoKeyRaw * | m_rawKey |
| this serves as a pimpl that's partially shared between this and symmetric key | |
Constructor & Destructor Documentation
| PKIFXSECCryptoKeyHMAC::PKIFXSECCryptoKeyHMAC | ( | ) |
Interface: External
Default Constructor: prepare an empty PKIFXSECCryptoKeyHMAC object.
- Returns:
- None
Definition at line 20 of file PKIFXSECCryptoKeyHMAC.cpp.
Referenced by clone().
| PKIFXSECCryptoKeyHMAC::PKIFXSECCryptoKeyHMAC | ( | CPKIFKeyMaterialPtr & | km | ) |
Interface: External
Construct a PKIFXSECCryptoKeyHMAC object using the supplied key material
- Returns:
- None
Definition at line 32 of file PKIFXSECCryptoKeyHMAC.cpp.
| PKIFXSECCryptoKeyHMAC::~PKIFXSECCryptoKeyHMAC | ( | ) | [virtual] |
Interface: External
free resources used by a PKIFXSECCryptoKeyRaw object
- Returns:
- None
Definition at line 44 of file PKIFXSECCryptoKeyHMAC.cpp.
References m_rawKey.
Member Function Documentation
| void PKIFXSECCryptoKeyHMAC::setKey | ( | 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 73 of file PKIFXSECCryptoKeyHMAC.cpp.
References m_rawKey, and PKIFXSECCryptoKeyRaw::setKey().
| unsigned int PKIFXSECCryptoKeyHMAC::getKey | ( | safeBuffer & | outBuf | ) | const [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 89 of file PKIFXSECCryptoKeyHMAC.cpp.
References PKIFXSECCryptoKeyRaw::getKey(), and m_rawKey.
| CPKIFKeyMaterialPtr PKIFXSECCryptoKeyHMAC::getPKIFKeyMaterial | ( | ) |
Interface: External
Obtain a pointer to the PKIF key material object
- Returns:
- underlying key material object
Definition at line 103 of file PKIFXSECCryptoKeyHMAC.cpp.
References PKIFXSECCryptoKeyRaw::getPKIFKeyMaterial(), and m_rawKey.
Referenced by PKIFXSECCryptoHash::setKey().
| void PKIFXSECCryptoKeyHMAC::setPKIFKeyMaterial | ( | CPKIFKeyMaterialPtr & | km | ) |
Interface: External
Set the underlying key material object
- Returns:
- none
- Parameters:
-
km [in] key material to use
Definition at line 115 of file PKIFXSECCryptoKeyHMAC.cpp.
References m_rawKey, and PKIFXSECCryptoKeyRaw::setPKIFKeyMaterial().
| XSECCryptoKey * PKIFXSECCryptoKeyHMAC::clone | ( | ) | const [virtual] |
Interface: External
called by the xml security library to copy an HMAC key
- Returns:
- None
Definition at line 59 of file PKIFXSECCryptoKeyHMAC.cpp.
References PKIFXSECCryptoKeyRaw::getPKIFKeyMaterial(), m_rawKey, and PKIFXSECCryptoKeyHMAC().
| const XMLCh * PKIFXSECCryptoKeyHMAC::getProviderName | ( | ) | const [virtual] |
Interface: External
Get the name of the provider
- Returns:
- Name of the PKIF XML provider
Definition at line 130 of file PKIFXSECCryptoKeyHMAC.cpp.
References PKIFXSECCryptoKeyRaw::getProviderName(), and m_rawKey.
Member Data Documentation
PKIFXSECCryptoKeyRaw* PKIFXSECCryptoKeyHMAC::m_rawKey [protected] |
this serves as a pimpl that's partially shared between this and symmetric key
Definition at line 44 of file PKIFXSECCryptoKeyHMAC.h.
Referenced by clone(), getKey(), getPKIFKeyMaterial(), getProviderName(), setKey(), setPKIFKeyMaterial(), and ~PKIFXSECCryptoKeyHMAC().
The documentation for this class was generated from the following files:
