Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

XSECCryptoKeyHMAC Class Reference
[Cryptographic Abstraction Layer]

#include <XSECCryptoKeyHMAC.hpp>

Inheritance diagram for XSECCryptoKeyHMAC:

Inheritance graph
[legend]
Collaboration diagram for XSECCryptoKeyHMAC:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface class for HMAC keys.

The library uses classes derived from this to process HMAC keys.


Public Member Functions

Constructors and Destructors
 XSECCryptoKeyHMAC ()
virtual ~XSECCryptoKeyHMAC ()
Key Interface methods
virtual XSECCryptoKey::KeyType getKeyType ()
 Return the type of this key.
virtual XSECCryptoKeyclone ()=0
 Replicate key.
Optional Interface methods
These functions do not necessarily have to be implmented. They are used by XSECKeyInfoResolverDefault to try to create a key from KeyInfo elements without knowing anything else.

If an interface class does not implement these functions, a simple stub that does nothing should be used.

virtual void setKey (unsigned char *inBuf, unsigned int inLength)=0
 Set the key.
virtual unsigned int getKey (safeBuffer &outBuf)=0
 Get the key value.


Constructor & Destructor Documentation

XSECCryptoKeyHMAC::XSECCryptoKeyHMAC  )  [inline]
 

virtual XSECCryptoKeyHMAC::~XSECCryptoKeyHMAC  )  [inline, virtual]
 


Member Function Documentation

virtual XSECCryptoKey* XSECCryptoKeyHMAC::clone  )  [pure virtual]
 

Replicate key.

Implements XSECCryptoKey.

Implemented in OpenSSLCryptoKeyHMAC, and WinCAPICryptoKeyHMAC.

virtual unsigned int XSECCryptoKeyHMAC::getKey safeBuffer outBuf  )  [pure virtual]
 

Get the key value.

Copy the key into the safeBuffer and return the number of bytes copied.

Parameters:
outBuf Buffer to copy key into
Returns:
number of bytes copied in

Implemented in OpenSSLCryptoKeyHMAC, and WinCAPICryptoKeyHMAC.

virtual XSECCryptoKey::KeyType XSECCryptoKeyHMAC::getKeyType  )  [inline, virtual]
 

Return the type of this key.

For DSA keys, this allows people to determine whether this is a public key, private key or a key pair

Reimplemented from XSECCryptoKey.

Reimplemented in OpenSSLCryptoKeyHMAC, and WinCAPICryptoKeyHMAC.

virtual void XSECCryptoKeyHMAC::setKey unsigned char *  inBuf,
unsigned int  inLength
[pure virtual]
 

Set the key.

Set the key from the buffer

Parameters:
inBuf Buffer containing the key
inLength Number of bytes of key in the buffer

Implemented in OpenSSLCryptoKeyHMAC, and WinCAPICryptoKeyHMAC.


The documentation for this class was generated from the following file:
Generated on Sun Jul 3 17:45:28 2005 for XML-Security-C by  doxygen 1.4.2